projects/dwt2: org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/ContentFormatter.d annotate

author	Frank Benoit <benoit@tionex.de>
date	Sat, 14 Mar 2009 18:23:29 +0100
parents
children	634e4380db78

rev	line source
12 bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	1 /*******************************************************************************
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	2 * Copyright (c) 2000, 2006 IBM Corporation and others.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	3 * All rights reserved. This program and the accompanying materials
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	4 * are made available under the terms of the Eclipse Public License v1.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	5 * which accompanies this distribution, and is available at
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	6 * http://www.eclipse.org/legal/epl-v10.html
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	7 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	8 * Contributors:
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	9 * IBM Corporation - initial API and implementation
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	10 * Port to the D programming language:
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	11 * Frank Benoit <benoit@tionex.de>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	12 *******************************************************************************/
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	13
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	14
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	15 module org.eclipse.jface.text.formatter.ContentFormatter;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	16
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	17 import org.eclipse.jface.text.formatter.MultiPassContentFormatter; // packageimport
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	18 import org.eclipse.jface.text.formatter.ContextBasedFormattingStrategy; // packageimport
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	19 import org.eclipse.jface.text.formatter.FormattingContext; // packageimport
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	20 import org.eclipse.jface.text.formatter.IFormattingStrategy; // packageimport
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	21 import org.eclipse.jface.text.formatter.IContentFormatterExtension; // packageimport
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	22 import org.eclipse.jface.text.formatter.IFormattingStrategyExtension; // packageimport
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	23 import org.eclipse.jface.text.formatter.IContentFormatter; // packageimport
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	24 import org.eclipse.jface.text.formatter.FormattingContextProperties; // packageimport
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	25 import org.eclipse.jface.text.formatter.IFormattingContext; // packageimport
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	26
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	27 import java.lang.all;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	28 import java.util.Collections;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	29 import java.util.List;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	30 import java.util.ArrayList;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	31 import java.util.Map;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	32 import java.util.HashMap;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	33 import java.util.Set;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	34
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	35
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	36
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	37
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	38
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	39
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	40
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	41 import org.eclipse.core.runtime.Assert;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	42 import org.eclipse.jface.text.BadLocationException;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	43 import org.eclipse.jface.text.BadPositionCategoryException;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	44 import org.eclipse.jface.text.DefaultPositionUpdater;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	45 import org.eclipse.jface.text.DocumentEvent;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	46 import org.eclipse.jface.text.IDocument;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	47 import org.eclipse.jface.text.IDocumentExtension3;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	48 import org.eclipse.jface.text.IPositionUpdater;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	49 import org.eclipse.jface.text.IRegion;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	50 import org.eclipse.jface.text.ITypedRegion;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	51 import org.eclipse.jface.text.Position;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	52 import org.eclipse.jface.text.TextUtilities;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	53 import org.eclipse.jface.text.TypedPosition;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	54
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	55
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	56 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	57 * Standard implementation of <code>IContentFormatter</code>.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	58 * The formatter supports two operation modes: partition aware and
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	59 * partition unaware. <p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	60 * In the partition aware mode, the formatter determines the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	61 * partitioning of the document region to be formatted. For each
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	62 * partition it determines all document positions which are affected
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	63 * when text changes are applied to the partition. Those which overlap
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	64 * with the partition are remembered as character positions. These
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	65 * character positions are passed over to the formatting strategy
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	66 * registered for the partition's content type. The formatting strategy
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	67 * returns a string containing the formatted document partition as well
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	68 * as the adapted character positions. The formatted partition replaces
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	69 * the old content of the partition. The remembered document positions
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	70 * are updated with the adapted character positions. In addition, all
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	71 * other document positions are accordingly adapted to the formatting
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	72 * changes.<p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	73 * In the partition unaware mode, the document's partitioning is ignored
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	74 * and the document is considered consisting of only one partition of
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	75 * the content type <code>IDocument.DEFAULT_CONTENT_TYPE</code>. The
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	76 * formatting process is similar to the partition aware mode, with the
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	77 * exception of having only one partition.<p>
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	78 * Usually, clients instantiate this class and configure it before using it.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	79 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	80 * @see IContentFormatter
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	81 * @see IDocument
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	82 * @see ITypedRegion
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	83 * @see Position
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	84 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	85 public class ContentFormatter : IContentFormatter {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	86
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	87 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	88 * Defines a reference to either the offset or the end offset of
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	89 * a particular position.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	90 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	91 static class PositionReference : Comparable {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	92
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	93 /** The referenced position */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	94 protected Position fPosition;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	95 /** The reference to either the offset or the end offset */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	96 protected bool fRefersToOffset;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	97 /** The original category of the referenced position */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	98 protected String fCategory;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	99
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	100 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	101 * Creates a new position reference.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	102 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	103 * @param position the position to be referenced
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	104 * @param refersToOffset <code>true</code> if position offset should be referenced
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	105 * @param category the category the given position belongs to
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	106 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	107 protected this(Position position, bool refersToOffset, String category) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	108 fPosition= position;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	109 fRefersToOffset= refersToOffset;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	110 fCategory= category;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	111 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	112
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	113 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	114 * Returns the offset of the referenced position.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	115 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	116 * @return the offset of the referenced position
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	117 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	118 protected int getOffset() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	119 return fPosition.getOffset();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	120 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	121
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	122 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	123 * Manipulates the offset of the referenced position.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	124 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	125 * @param offset the new offset of the referenced position
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	126 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	127 protected void setOffset(int offset) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	128 fPosition.setOffset(offset);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	129 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	130
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	131 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	132 * Returns the length of the referenced position.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	133 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	134 * @return the length of the referenced position
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	135 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	136 protected int getLength() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	137 return fPosition.getLength();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	138 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	139
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	140 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	141 * Manipulates the length of the referenced position.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	142 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	143 * @param length the new length of the referenced position
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	144 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	145 protected void setLength(int length) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	146 fPosition.setLength(length);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	147 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	148
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	149 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	150 * Returns whether this reference points to the offset or end offset
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	151 * of the references position.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	152 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	153 * @return <code>true</code> if the offset of the position is referenced, <code>false</code> otherwise
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	154 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	155 protected bool refersToOffset() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	156 return fRefersToOffset;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	157 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	158
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	159 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	160 * Returns the category of the referenced position.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	161 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	162 * @return the category of the referenced position
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	163 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	164 protected String getCategory() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	165 return fCategory;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	166 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	167
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	168 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	169 * Returns the referenced position.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	170 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	171 * @return the referenced position
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	172 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	173 protected Position getPosition() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	174 return fPosition;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	175 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	176
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	177 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	178 * Returns the referenced character position
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	179 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	180 * @return the referenced character position
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	181 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	182 protected int getCharacterPosition() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	183 if (fRefersToOffset)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	184 return getOffset();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	185 return getOffset() + getLength();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	186 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	187
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	188 /*
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	189 * @see Comparable#compareTo(Object)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	190 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	191 public int compareTo(Object obj) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	192
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	193 if ( cast(PositionReference)obj ) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	194 PositionReference r= cast(PositionReference) obj;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	195 return getCharacterPosition() - r.getCharacterPosition();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	196 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	197
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	198 throw new ClassCastException();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	199 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	200 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	201
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	202 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	203 * The position updater used to update the remembered partitions.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	204 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	205 * @see IPositionUpdater
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	206 * @see DefaultPositionUpdater
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	207 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	208 class NonDeletingPositionUpdater : DefaultPositionUpdater {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	209
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	210 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	211 * Creates a new updater for the given category.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	212 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	213 * @param category the category
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	214 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	215 protected this(String category) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	216 super(category);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	217 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	218
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	219 /*
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	220 * @see DefaultPositionUpdater#notDeleted()
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	221 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	222 protected bool notDeleted() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	223 return true;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	224 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	225 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	226
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	227 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	228 * The position updater which runs as first updater on the document's positions.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	229 * Used to remove all affected positions from their categories to avoid them
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	230 * from being regularly updated.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	231 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	232 * @see IPositionUpdater
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	233 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	234 class RemoveAffectedPositions : IPositionUpdater {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	235 /*
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	236 * @see IPositionUpdater#update(DocumentEvent)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	237 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	238 public void update(DocumentEvent event) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	239 removeAffectedPositions(event.getDocument());
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	240 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	241 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	242
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	243 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	244 * The position updater which runs as last updater on the document's positions.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	245 * Used to update all affected positions and adding them back to their
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	246 * original categories.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	247 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	248 * @see IPositionUpdater
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	249 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	250 class UpdateAffectedPositions : IPositionUpdater {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	251
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	252 /** The affected positions */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	253 private int[] fPositions;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	254 /** The offset */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	255 private int fOffset;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	256
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	257 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	258 * Creates a new updater.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	259 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	260 * @param positions the affected positions
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	261 * @param offset the offset
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	262 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	263 public this(int[] positions, int offset) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	264 fPositions= positions;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	265 fOffset= offset;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	266 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	267
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	268 /*
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	269 * @see IPositionUpdater#update(DocumentEvent)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	270 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	271 public void update(DocumentEvent event) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	272 updateAffectedPositions(event.getDocument(), fPositions, fOffset);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	273 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	274 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	275
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	276
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	277 /** Internal position category used for the formatter partitioning */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	278 private const static String PARTITIONING= "__formatter_partitioning"; //$NON-NLS-1$
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	279
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	280 /** The map of <code>IFormattingStrategy</code> objects */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	281 private Map fStrategies;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	282 /** The indicator of whether the formatter operates in partition aware mode or not */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	283 private bool fIsPartitionAware= true;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	284
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	285 /** The partition information managing document position categories */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	286 private String[] fPartitionManagingCategories;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	287 /** The list of references to offset and end offset of all overlapping positions */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	288 private List fOverlappingPositionReferences;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	289 /** Position updater used for partitioning positions */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	290 private IPositionUpdater fPartitioningUpdater;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	291 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	292 * The document partitioning used by this formatter.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	293 * @since 3.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	294 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	295 private String fPartitioning;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	296 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	297 * The document this formatter works on.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	298 * @since 3.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	299 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	300 private IDocument fDocument;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	301 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	302 * The external partition managing categories.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	303 * @since 3.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	304 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	305 private String[] fExternalPartitonManagingCategories;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	306 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	307 * Indicates whether <code>fPartitionManagingCategories</code> must be computed.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	308 * @since 3.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	309 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	310 private bool fNeedsComputation= true;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	311
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	312
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	313 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	314 * Creates a new content formatter. The content formatter operates by default
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	315 * in the partition-aware mode. There are no preconfigured formatting strategies.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	316 * Will use the default document partitioning if not further configured.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	317 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	318 public this() {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	319 fPartitioning= IDocumentExtension3.DEFAULT_PARTITIONING;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	320 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	321
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	322 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	323 * Registers a strategy for a particular content type. If there is already a strategy
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	324 * registered for this type, the new strategy is registered instead of the old one.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	325 * If the given content type is <code>null</code> the given strategy is registered for
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	326 * all content types as is called only once per formatting session.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	327 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	328 * @param strategy the formatting strategy to register, or <code>null</code> to remove an existing one
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	329 * @param contentType the content type under which to register
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	330 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	331 public void setFormattingStrategy(IFormattingStrategy strategy, String contentType) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	332
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	333 Assert.isNotNull(contentType);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	334
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	335 if (fStrategies is null)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	336 fStrategies= new HashMap();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	337
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	338 if (strategy is null)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	339 fStrategies.remove(contentType);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	340 else
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	341 fStrategies.put(contentType, cast(Object)strategy);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	342 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	343
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	344 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	345 * Informs this content formatter about the names of those position categories
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	346 * which are used to manage the document's partitioning information and thus should
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	347 * be ignored when this formatter updates positions.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	348 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	349 * @param categories the categories to be ignored
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	350 * @deprecated incompatible with an open set of document partitionings. The provided information is only used
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	351 * if this formatter can not compute the partition managing position categories.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	352 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	353 public void setPartitionManagingPositionCategories(String[] categories) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	354 fExternalPartitonManagingCategories= TextUtilities.copy(categories);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	355 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	356
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	357 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	358 * Sets the document partitioning to be used by this formatter.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	359 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	360 * @param partitioning the document partitioning
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	361 * @since 3.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	362 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	363 public void setDocumentPartitioning(String partitioning) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	364 fPartitioning= partitioning;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	365 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	366
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	367 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	368 * Sets the formatter's operation mode.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	369 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	370 * @param enable indicates whether the formatting process should be partition ware
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	371 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	372 public void enablePartitionAwareFormatting(bool enable) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	373 fIsPartitionAware= enable;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	374 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	375
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	376 /*
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	377 * @see IContentFormatter#getFormattingStrategy(String)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	378 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	379 public IFormattingStrategy getFormattingStrategy(String contentType) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	380
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	381 Assert.isNotNull(contentType);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	382
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	383 if (fStrategies is null)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	384 return null;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	385
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	386 return cast(IFormattingStrategy) fStrategies.get(contentType);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	387 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	388
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	389 /*
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	390 * @see IContentFormatter#format(IDocument, IRegion)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	391 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	392 public void format(IDocument document, IRegion region) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	393 fNeedsComputation= true;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	394 fDocument= document;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	395 try {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	396
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	397 if (fIsPartitionAware)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	398 formatPartitions(region);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	399 else
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	400 formatRegion(region);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	401
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	402 } finally {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	403 fNeedsComputation= true;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	404 fDocument= null;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	405 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	406 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	407
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	408 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	409 * Determines the partitioning of the given region of the document.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	410 * Informs the formatting strategies of each partition about the start,
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	411 * the process, and the termination of the formatting session.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	412 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	413 * @param region the document region to be formatted
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	414 * @since 3.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	415 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	416 private void formatPartitions(IRegion region) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	417
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	418 addPartitioningUpdater();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	419
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	420 try {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	421
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	422 TypedPosition[] ranges= getPartitioning(region);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	423 if (ranges !is null) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	424 start(ranges, getIndentation(region.getOffset()));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	425 format(ranges);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	426 stop(ranges);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	427 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	428
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	429 } catch (BadLocationException x) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	430 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	431
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	432 removePartitioningUpdater();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	433 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	434
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	435 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	436 * Formats the given region with the strategy registered for the default
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	437 * content type. The strategy is informed about the start, the process, and
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	438 * the termination of the formatting session.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	439 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	440 * @param region the region to be formatted
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	441 * @since 3.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	442 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	443 private void formatRegion(IRegion region) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	444
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	445 IFormattingStrategy strategy= getFormattingStrategy(IDocument.DEFAULT_CONTENT_TYPE);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	446 if (strategy !is null) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	447 strategy.formatterStarts(getIndentation(region.getOffset()));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	448 format(strategy, new TypedPosition(region.getOffset(), region.getLength(), IDocument.DEFAULT_CONTENT_TYPE));
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	449 strategy.formatterStops();
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	450 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	451 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	452
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	453 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	454 * Returns the partitioning of the given region of the document to be formatted.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	455 * As one partition after the other will be formatted and formatting will
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	456 * probably change the length of the formatted partition, it must be kept
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	457 * track of the modifications in order to submit the correct partition to all
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	458 * formatting strategies. For this, all partitions are remembered as positions
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	459 * in a dedicated position category. (As formatting strategies might rely on each
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	460 * other, calling them in reversed order is not an option.)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	461 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	462 * @param region the region for which the partitioning must be determined
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	463 * @return the partitioning of the specified region
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	464 * @exception BadLocationException of region is invalid in the document
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	465 * @since 3.0
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	466 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	467 private TypedPosition[] getPartitioning(IRegion region) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	468
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	469 ITypedRegion[] regions= TextUtilities.computePartitioning(fDocument, fPartitioning, region.getOffset(), region.getLength(), false);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	470 TypedPosition[] positions= new TypedPosition[regions.length];
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	471
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	472 for (int i= 0; i < regions.length; i++) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	473 positions[i]= new TypedPosition(regions[i]);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	474 try {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	475 fDocument.addPosition(PARTITIONING, positions[i]);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	476 } catch (BadPositionCategoryException x) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	477 // should not happen
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	478 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	479 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	480
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	481 return positions;
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	482 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	483
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	484 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	485 * Fires <code>formatterStarts</code> to all formatter strategies
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	486 * which will be involved in the forthcoming formatting process.
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	487 *
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	488 * @param regions the partitioning of the document to be formatted
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	489 * @param indentation the initial indentation
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	490 */
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	491 private void start(TypedPosition[] regions, String indentation) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	492 for (int i= 0; i < regions.length; i++) {
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	493 IFormattingStrategy s= getFormattingStrategy(regions[i].getType());
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	494 if (s !is null)
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	495 s.formatterStarts(indentation);
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	496 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	497 }
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	498
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	499 /**
bc29606a740c Added dwt-addons in original directory structure of eclipse.org Frank Benoit <benoit@tionex.de> parents: diff changeset	500 * Formats one partition after the other using the formatter strategy registered for

12

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

1 /*******************************************************************************

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

4 * are made available under the terms of the Eclipse Public License v1.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

5 * which accompanies this distribution, and is available at

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

6 * http://www.eclipse.org/legal/epl-v10.html

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

7 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

8 * Contributors:

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

9 * IBM Corporation - initial API and implementation

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

10 * Port to the D programming language:

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

11 * Frank Benoit <benoit@tionex.de>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

12 *******************************************************************************/

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

13

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

14

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

15 module org.eclipse.jface.text.formatter.ContentFormatter;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

16

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

17 import org.eclipse.jface.text.formatter.MultiPassContentFormatter; // packageimport

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

18 import org.eclipse.jface.text.formatter.ContextBasedFormattingStrategy; // packageimport

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

19 import org.eclipse.jface.text.formatter.FormattingContext; // packageimport

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

20 import org.eclipse.jface.text.formatter.IFormattingStrategy; // packageimport

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

21 import org.eclipse.jface.text.formatter.IContentFormatterExtension; // packageimport

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

22 import org.eclipse.jface.text.formatter.IFormattingStrategyExtension; // packageimport

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

23 import org.eclipse.jface.text.formatter.IContentFormatter; // packageimport

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

24 import org.eclipse.jface.text.formatter.FormattingContextProperties; // packageimport

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

25 import org.eclipse.jface.text.formatter.IFormattingContext; // packageimport

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

26

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

27 import java.lang.all;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

28 import java.util.Collections;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

29 import java.util.List;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

30 import java.util.ArrayList;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

31 import java.util.Map;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

32 import java.util.HashMap;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

33 import java.util.Set;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

34

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

35

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

36

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

37

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

38

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

39

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

40

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

41 import org.eclipse.core.runtime.Assert;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

42 import org.eclipse.jface.text.BadLocationException;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

43 import org.eclipse.jface.text.BadPositionCategoryException;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

44 import org.eclipse.jface.text.DefaultPositionUpdater;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

45 import org.eclipse.jface.text.DocumentEvent;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

46 import org.eclipse.jface.text.IDocument;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

47 import org.eclipse.jface.text.IDocumentExtension3;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

48 import org.eclipse.jface.text.IPositionUpdater;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

49 import org.eclipse.jface.text.IRegion;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

50 import org.eclipse.jface.text.ITypedRegion;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

51 import org.eclipse.jface.text.Position;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

52 import org.eclipse.jface.text.TextUtilities;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

53 import org.eclipse.jface.text.TypedPosition;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

54

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

55

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

56 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

57 * Standard implementation of <code>IContentFormatter</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

58 * The formatter supports two operation modes: partition aware and

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

59 * partition unaware. <p>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

60 * In the partition aware mode, the formatter determines the

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

61 * partitioning of the document region to be formatted. For each

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

62 * partition it determines all document positions which are affected

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

63 * when text changes are applied to the partition. Those which overlap

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

64 * with the partition are remembered as character positions. These

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

65 * character positions are passed over to the formatting strategy

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

66 * registered for the partition's content type. The formatting strategy

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

67 * returns a string containing the formatted document partition as well

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

68 * as the adapted character positions. The formatted partition replaces

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

69 * the old content of the partition. The remembered document positions

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

70 * are updated with the adapted character positions. In addition, all

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

71 * other document positions are accordingly adapted to the formatting

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

72 * changes.<p>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

73 * In the partition unaware mode, the document's partitioning is ignored

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

74 * and the document is considered consisting of only one partition of

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

75 * the content type <code>IDocument.DEFAULT_CONTENT_TYPE</code>. The

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

76 * formatting process is similar to the partition aware mode, with the

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

77 * exception of having only one partition.<p>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

78 * Usually, clients instantiate this class and configure it before using it.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

79 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

80 * @see IContentFormatter

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

81 * @see IDocument

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

82 * @see ITypedRegion

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

83 * @see Position

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

84 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

85 public class ContentFormatter : IContentFormatter {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

86

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

87 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

88 * Defines a reference to either the offset or the end offset of

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

89 * a particular position.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

90 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

91 static class PositionReference : Comparable {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

92

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

93 /** The referenced position */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

94 protected Position fPosition;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

95 /** The reference to either the offset or the end offset */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

96 protected bool fRefersToOffset;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

97 /** The original category of the referenced position */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

98 protected String fCategory;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

99

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

100 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

101 * Creates a new position reference.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

102 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

103 * @param position the position to be referenced

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

104 * @param refersToOffset <code>true</code> if position offset should be referenced

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

105 * @param category the category the given position belongs to

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

106 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

107 protected this(Position position, bool refersToOffset, String category) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

108 fPosition= position;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

109 fRefersToOffset= refersToOffset;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

110 fCategory= category;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

111 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

112

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

113 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

114 * Returns the offset of the referenced position.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

115 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

116 * @return the offset of the referenced position

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

117 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

118 protected int getOffset() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

119 return fPosition.getOffset();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

120 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

121

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

122 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

123 * Manipulates the offset of the referenced position.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

124 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

125 * @param offset the new offset of the referenced position

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

126 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

127 protected void setOffset(int offset) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

128 fPosition.setOffset(offset);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

129 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

130

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

131 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

132 * Returns the length of the referenced position.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

133 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

134 * @return the length of the referenced position

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

135 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

136 protected int getLength() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

137 return fPosition.getLength();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

138 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

139

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

140 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

141 * Manipulates the length of the referenced position.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

142 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

143 * @param length the new length of the referenced position

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

144 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

145 protected void setLength(int length) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

146 fPosition.setLength(length);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

147 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

148

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

149 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

150 * Returns whether this reference points to the offset or end offset

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

151 * of the references position.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

152 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

153 * @return <code>true</code> if the offset of the position is referenced, <code>false</code> otherwise

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

154 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

155 protected bool refersToOffset() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

156 return fRefersToOffset;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

157 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

158

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

159 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

160 * Returns the category of the referenced position.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

161 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

162 * @return the category of the referenced position

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

163 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

164 protected String getCategory() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

165 return fCategory;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

166 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

167

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

168 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

169 * Returns the referenced position.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

170 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

171 * @return the referenced position

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

172 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

173 protected Position getPosition() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

174 return fPosition;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

175 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

176

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

177 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

178 * Returns the referenced character position

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

179 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

180 * @return the referenced character position

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

181 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

182 protected int getCharacterPosition() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

183 if (fRefersToOffset)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

184 return getOffset();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

185 return getOffset() + getLength();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

186 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

187

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

188 /*

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

189 * @see Comparable#compareTo(Object)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

190 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

191 public int compareTo(Object obj) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

192

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

193 if ( cast(PositionReference)obj ) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

194 PositionReference r= cast(PositionReference) obj;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

195 return getCharacterPosition() - r.getCharacterPosition();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

196 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

197

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

198 throw new ClassCastException();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

199 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

200 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

201

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

202 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

203 * The position updater used to update the remembered partitions.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

204 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

205 * @see IPositionUpdater

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

206 * @see DefaultPositionUpdater

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

207 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

208 class NonDeletingPositionUpdater : DefaultPositionUpdater {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

209

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

210 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

211 * Creates a new updater for the given category.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

212 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

213 * @param category the category

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

214 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

215 protected this(String category) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

216 super(category);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

217 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

218

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

219 /*

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

220 * @see DefaultPositionUpdater#notDeleted()

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

221 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

222 protected bool notDeleted() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

223 return true;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

224 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

225 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

226

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

227 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

228 * The position updater which runs as first updater on the document's positions.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

229 * Used to remove all affected positions from their categories to avoid them

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

230 * from being regularly updated.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

231 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

232 * @see IPositionUpdater

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

233 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

234 class RemoveAffectedPositions : IPositionUpdater {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

235 /*

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

236 * @see IPositionUpdater#update(DocumentEvent)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

237 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

238 public void update(DocumentEvent event) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

239 removeAffectedPositions(event.getDocument());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

240 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

241 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

242

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

243 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

244 * The position updater which runs as last updater on the document's positions.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

245 * Used to update all affected positions and adding them back to their

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

246 * original categories.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

247 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

248 * @see IPositionUpdater

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

249 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

250 class UpdateAffectedPositions : IPositionUpdater {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

251

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

252 /** The affected positions */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

253 private int[] fPositions;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

254 /** The offset */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

255 private int fOffset;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

256

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

257 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

258 * Creates a new updater.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

259 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

260 * @param positions the affected positions

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

261 * @param offset the offset

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

262 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

263 public this(int[] positions, int offset) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

264 fPositions= positions;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

265 fOffset= offset;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

266 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

267

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

268 /*

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

269 * @see IPositionUpdater#update(DocumentEvent)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

270 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

271 public void update(DocumentEvent event) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

272 updateAffectedPositions(event.getDocument(), fPositions, fOffset);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

273 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

274 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

275

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

276

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

277 /** Internal position category used for the formatter partitioning */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

278 private const static String PARTITIONING= "__formatter_partitioning"; //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

279

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

280 /** The map of <code>IFormattingStrategy</code> objects */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

281 private Map fStrategies;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

282 /** The indicator of whether the formatter operates in partition aware mode or not */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

283 private bool fIsPartitionAware= true;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

284

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

285 /** The partition information managing document position categories */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

286 private String[] fPartitionManagingCategories;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

287 /** The list of references to offset and end offset of all overlapping positions */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

288 private List fOverlappingPositionReferences;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

289 /** Position updater used for partitioning positions */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

290 private IPositionUpdater fPartitioningUpdater;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

291 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

292 * The document partitioning used by this formatter.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

293 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

294 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

295 private String fPartitioning;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

296 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

297 * The document this formatter works on.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

298 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

299 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

300 private IDocument fDocument;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

301 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

302 * The external partition managing categories.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

303 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

304 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

305 private String[] fExternalPartitonManagingCategories;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

306 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

307 * Indicates whether <code>fPartitionManagingCategories</code> must be computed.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

308 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

309 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

310 private bool fNeedsComputation= true;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

311

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

312

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

313 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

314 * Creates a new content formatter. The content formatter operates by default

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

315 * in the partition-aware mode. There are no preconfigured formatting strategies.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

316 * Will use the default document partitioning if not further configured.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

317 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

318 public this() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

319 fPartitioning= IDocumentExtension3.DEFAULT_PARTITIONING;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

320 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

321

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

322 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

323 * Registers a strategy for a particular content type. If there is already a strategy

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

324 * registered for this type, the new strategy is registered instead of the old one.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

325 * If the given content type is <code>null</code> the given strategy is registered for

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

326 * all content types as is called only once per formatting session.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

327 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

328 * @param strategy the formatting strategy to register, or <code>null</code> to remove an existing one

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

329 * @param contentType the content type under which to register

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

330 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

331 public void setFormattingStrategy(IFormattingStrategy strategy, String contentType) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

332

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

333 Assert.isNotNull(contentType);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

334

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

335 if (fStrategies is null)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

336 fStrategies= new HashMap();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

337

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

338 if (strategy is null)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

339 fStrategies.remove(contentType);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

340 else

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

341 fStrategies.put(contentType, cast(Object)strategy);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

342 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

343

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

344 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

345 * Informs this content formatter about the names of those position categories

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

346 * which are used to manage the document's partitioning information and thus should

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

347 * be ignored when this formatter updates positions.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

348 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

349 * @param categories the categories to be ignored

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

350 * @deprecated incompatible with an open set of document partitionings. The provided information is only used

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

351 * if this formatter can not compute the partition managing position categories.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

352 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

353 public void setPartitionManagingPositionCategories(String[] categories) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

354 fExternalPartitonManagingCategories= TextUtilities.copy(categories);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

355 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

356

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

357 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

358 * Sets the document partitioning to be used by this formatter.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

359 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

360 * @param partitioning the document partitioning

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

361 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

362 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

363 public void setDocumentPartitioning(String partitioning) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

364 fPartitioning= partitioning;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

365 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

366

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

367 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

368 * Sets the formatter's operation mode.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

369 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

370 * @param enable indicates whether the formatting process should be partition ware

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

371 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

372 public void enablePartitionAwareFormatting(bool enable) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

373 fIsPartitionAware= enable;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

374 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

375

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

376 /*

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

377 * @see IContentFormatter#getFormattingStrategy(String)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

378 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

379 public IFormattingStrategy getFormattingStrategy(String contentType) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

380

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

381 Assert.isNotNull(contentType);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

382

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

383 if (fStrategies is null)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

384 return null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

385

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

386 return cast(IFormattingStrategy) fStrategies.get(contentType);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

387 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

388

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

389 /*

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

390 * @see IContentFormatter#format(IDocument, IRegion)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

391 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

392 public void format(IDocument document, IRegion region) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

393 fNeedsComputation= true;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

394 fDocument= document;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

395 try {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

396

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

397 if (fIsPartitionAware)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

398 formatPartitions(region);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

399 else

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

400 formatRegion(region);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

401

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

402 } finally {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

403 fNeedsComputation= true;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

404 fDocument= null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

405 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

406 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

407

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

408 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

409 * Determines the partitioning of the given region of the document.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

410 * Informs the formatting strategies of each partition about the start,

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

411 * the process, and the termination of the formatting session.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

412 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

413 * @param region the document region to be formatted

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

414 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

415 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

416 private void formatPartitions(IRegion region) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

417

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

418 addPartitioningUpdater();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

419

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

420 try {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

421

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

422 TypedPosition[] ranges= getPartitioning(region);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

423 if (ranges !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

424 start(ranges, getIndentation(region.getOffset()));

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

425 format(ranges);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

426 stop(ranges);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

427 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

428

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

429 } catch (BadLocationException x) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

430 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

431

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

432 removePartitioningUpdater();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

433 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

434

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

435 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

436 * Formats the given region with the strategy registered for the default

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

437 * content type. The strategy is informed about the start, the process, and

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

438 * the termination of the formatting session.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

439 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

440 * @param region the region to be formatted

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

441 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

442 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

443 private void formatRegion(IRegion region) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

444

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

445 IFormattingStrategy strategy= getFormattingStrategy(IDocument.DEFAULT_CONTENT_TYPE);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

446 if (strategy !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

447 strategy.formatterStarts(getIndentation(region.getOffset()));

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

448 format(strategy, new TypedPosition(region.getOffset(), region.getLength(), IDocument.DEFAULT_CONTENT_TYPE));

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

449 strategy.formatterStops();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

450 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

451 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

452

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

453 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

454 * Returns the partitioning of the given region of the document to be formatted.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

455 * As one partition after the other will be formatted and formatting will

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

456 * probably change the length of the formatted partition, it must be kept

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

457 * track of the modifications in order to submit the correct partition to all

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

458 * formatting strategies. For this, all partitions are remembered as positions

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

459 * in a dedicated position category. (As formatting strategies might rely on each

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

460 * other, calling them in reversed order is not an option.)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

461 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

462 * @param region the region for which the partitioning must be determined

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

463 * @return the partitioning of the specified region

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

464 * @exception BadLocationException of region is invalid in the document

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

465 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

466 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

467 private TypedPosition[] getPartitioning(IRegion region) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

468

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

469 ITypedRegion[] regions= TextUtilities.computePartitioning(fDocument, fPartitioning, region.getOffset(), region.getLength(), false);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

470 TypedPosition[] positions= new TypedPosition[regions.length];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

471

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

472 for (int i= 0; i < regions.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

473 positions[i]= new TypedPosition(regions[i]);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

474 try {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

475 fDocument.addPosition(PARTITIONING, positions[i]);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

476 } catch (BadPositionCategoryException x) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

477 // should not happen

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

478 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

479 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

480

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

481 return positions;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

482 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

483

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

484 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

485 * Fires <code>formatterStarts</code> to all formatter strategies

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

486 * which will be involved in the forthcoming formatting process.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

487 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

488 * @param regions the partitioning of the document to be formatted

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

489 * @param indentation the initial indentation

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

490 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

491 private void start(TypedPosition[] regions, String indentation) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

492 for (int i= 0; i < regions.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

493 IFormattingStrategy s= getFormattingStrategy(regions[i].getType());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

494 if (s !is null)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

495 s.formatterStarts(indentation);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

496 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

497 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

498

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

499 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

500 * Formats one partition after the other using the formatter strategy registered for

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

501 * the partition's content type.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

502 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

503 * @param ranges the partitioning of the document region to be formatted

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

504 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

505 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

506 private void format(TypedPosition[] ranges) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

507 for (int i= 0; i < ranges.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

508 IFormattingStrategy s= getFormattingStrategy(ranges[i].getType());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

509 if (s !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

510 format(s, ranges[i]);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

511 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

512 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

513 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

514

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

515 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

516 * Formats the given region of the document using the specified formatting

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

517 * strategy. In order to maintain positions correctly, first all affected

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

518 * positions determined, after all document listeners have been informed about

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

519 * the coming change, the affected positions are removed to avoid that they

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

520 * are regularly updated. After all position updaters have run, the affected

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

521 * positions are updated with the formatter's information and added back to

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

522 * their categories, right before the first document listener is informed about

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

523 * that a change happened.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

524 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

525 * @param strategy the strategy to be used

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

526 * @param region the region to be formatted

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

527 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

528 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

529 private void format(IFormattingStrategy strategy, TypedPosition region) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

530 try {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

531

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

532 final int offset= region.getOffset();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

533 int length= region.getLength();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

534

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

535 String content= fDocument.get(offset, length);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

536 final int[] positions= getAffectedPositions(offset, length);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

537 String formatted= strategy.format(content, isLineStart(offset), getIndentation(offset), positions);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

538

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

539 if (formatted !is null && !formatted.equals(content)) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

540

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

541 IPositionUpdater first= new RemoveAffectedPositions();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

542 fDocument.insertPositionUpdater(first, 0);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

543 IPositionUpdater last= new UpdateAffectedPositions(positions, offset);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

544 fDocument.addPositionUpdater(last);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

545

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

546 fDocument.replace(offset, length, formatted);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

547

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

548 fDocument.removePositionUpdater(first);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

549 fDocument.removePositionUpdater(last);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

550 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

551

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

552 } catch (BadLocationException x) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

553 // should not happen

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

554 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

555 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

556

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

557 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

558 * Fires <code>formatterStops</code> to all formatter strategies which were

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

559 * involved in the formatting process which is about to terminate.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

560 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

561 * @param regions the partitioning of the document which has been formatted

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

562 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

563 private void stop(TypedPosition[] regions) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

564 for (int i= 0; i < regions.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

565 IFormattingStrategy s= getFormattingStrategy(regions[i].getType());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

566 if (s !is null)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

567 s.formatterStops();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

568 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

569 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

570

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

571 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

572 * Installs those updaters which the formatter needs to keep track of the partitions.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

573 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

574 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

575 private void addPartitioningUpdater() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

576 fPartitioningUpdater= new NonDeletingPositionUpdater(PARTITIONING);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

577 fDocument.addPositionCategory(PARTITIONING);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

578 fDocument.addPositionUpdater(fPartitioningUpdater);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

579 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

580

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

581 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

582 * Removes the formatter's internal position updater and category.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

583 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

584 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

585 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

586 private void removePartitioningUpdater() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

587

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

588 try {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

589

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

590 fDocument.removePositionUpdater(fPartitioningUpdater);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

591 fDocument.removePositionCategory(PARTITIONING);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

592 fPartitioningUpdater= null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

593

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

594 } catch (BadPositionCategoryException x) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

595 // should not happen

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

596 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

597 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

598

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

599 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

600 * Returns the partition managing position categories for the formatted document.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

601 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

602 * @return the position managing position categories

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

603 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

604 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

605 private String[] getPartitionManagingCategories() {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

606 if (fNeedsComputation) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

607 fNeedsComputation= false;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

608 fPartitionManagingCategories= TextUtilities.computePartitionManagingCategories(fDocument);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

609 if (fPartitionManagingCategories is null)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

610 fPartitionManagingCategories= fExternalPartitonManagingCategories;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

611 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

612 return fPartitionManagingCategories;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

613 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

614

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

615 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

616 * Determines whether the given document position category should be ignored

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

617 * by this formatter's position updating.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

618 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

619 * @param category the category to check

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

620 * @return <code>true</code> if the category should be ignored, <code>false</code> otherwise

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

621 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

622 private bool ignoreCategory(String category) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

623

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

624 if (PARTITIONING.equals(category))

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

625 return true;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

626

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

627 String[] categories= getPartitionManagingCategories();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

628 if (categories !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

629 for (int i= 0; i < categories.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

630 if (categories[i].equals(category))

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

631 return true;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

632 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

633 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

634

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

635 return false;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

636 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

637

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

638 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

639 * Determines all embracing, overlapping, and follow up positions

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

640 * for the given region of the document.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

641 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

642 * @param offset the offset of the document region to be formatted

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

643 * @param length the length of the document to be formatted

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

644 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

645 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

646 private void determinePositionsToUpdate(int offset, int length) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

647

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

648 String[] categories= fDocument.getPositionCategories();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

649 if (categories !is null) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

650 for (int i= 0; i < categories.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

651

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

652 if (ignoreCategory(categories[i]))

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

653 continue;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

654

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

655 try {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

656

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

657 Position[] positions= fDocument.getPositions(categories[i]);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

658

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

659 for (int j= 0; j < positions.length; j++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

660

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

661 Position p= positions[j];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

662 if (p.overlapsWith(offset, length)) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

663

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

664 if (offset < p.getOffset())

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

665 fOverlappingPositionReferences.add(new PositionReference(p, true, categories[i]));

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

666

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

667 if (p.getOffset() + p.getLength() < offset + length)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

668 fOverlappingPositionReferences.add(new PositionReference(p, false, categories[i]));

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

669 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

670 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

671

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

672 } catch (BadPositionCategoryException x) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

673 // can not happen

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

674 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

675 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

676 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

677 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

678

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

679 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

680 * Returns all offset and the end offset of all positions overlapping with the

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

681 * specified document range.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

682 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

683 * @param offset the offset of the document region to be formatted

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

684 * @param length the length of the document to be formatted

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

685 * @return all character positions of the interleaving positions

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

686 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

687 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

688 private int[] getAffectedPositions(int offset, int length) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

689

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

690 fOverlappingPositionReferences= new ArrayList();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

691

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

692 determinePositionsToUpdate(offset, length);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

693

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

694 Collections.sort(fOverlappingPositionReferences);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

695

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

696 int[] positions= new int[fOverlappingPositionReferences.size()];

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

697 for (int i= 0; i < positions.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

698 PositionReference r= cast(PositionReference) fOverlappingPositionReferences.get(i);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

699 positions[i]= r.getCharacterPosition() - offset;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

700 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

701

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

702 return positions;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

703 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

704

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

705 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

706 * Removes the affected positions from their categories to avoid

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

707 * that they are invalidly updated.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

708 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

709 * @param document the document

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

710 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

711 private void removeAffectedPositions(IDocument document) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

712 int size= fOverlappingPositionReferences.size();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

713 for (int i= 0; i < size; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

714 PositionReference r= cast(PositionReference) fOverlappingPositionReferences.get(i);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

715 try {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

716 document.removePosition(r.getCategory(), r.getPosition());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

717 } catch (BadPositionCategoryException x) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

718 // can not happen

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

719 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

720 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

721 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

722

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

723 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

724 * Updates all the overlapping positions. Note, all other positions are

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

725 * automatically updated by their document position updaters.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

726 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

727 * @param document the document to has been formatted

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

728 * @param positions the adapted character positions to be used to update the document positions

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

729 * @param offset the offset of the document region that has been formatted

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

730 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

731 protected void updateAffectedPositions(IDocument document, int[] positions, int offset) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

732

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

733 if (document !is fDocument)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

734 return;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

735

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

736 if (positions.length is 0)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

737 return;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

738

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

739 for (int i= 0; i < positions.length; i++) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

740

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

741 PositionReference r= cast(PositionReference) fOverlappingPositionReferences.get(i);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

742

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

743 if (r.refersToOffset())

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

744 r.setOffset(offset + positions[i]);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

745 else

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

746 r.setLength((offset + positions[i]) - r.getOffset());

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

747

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

748 Position p= r.getPosition();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

749 String category= r.getCategory();

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

750 if (!document.containsPosition(category, p.offset, p.length)) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

751 try {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

752 if (positionAboutToBeAdded(document, category, p))

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

753 document.addPosition(r.getCategory(), p);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

754 } catch (BadPositionCategoryException x) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

755 // can not happen

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

756 } catch (BadLocationException x) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

757 // should not happen

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

758 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

759 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

760

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

761 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

762

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

763 fOverlappingPositionReferences= null;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

764 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

765

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

766 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

767 * The given position is about to be added to the given position category of the given document. <p>

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

768 * This default implementation return <code>true</code>.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

769 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

770 * @param document the document

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

771 * @param category the position category

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

772 * @param position the position that will be added

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

773 * @return <code>true</code> if the position can be added, <code>false</code> if it should be ignored

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

774 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

775 protected bool positionAboutToBeAdded(IDocument document, String category, Position position) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

776 return true;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

777 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

778

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

779 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

780 * Returns the indentation of the line of the given offset.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

781 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

782 * @param offset the offset

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

783 * @return the indentation of the line of the offset

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

784 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

785 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

786 private String getIndentation(int offset) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

787

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

788 try {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

789 int start= fDocument.getLineOfOffset(offset);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

790 start= fDocument.getLineOffset(start);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

791

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

792 int end= start;

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

793 char c= fDocument.getChar(end);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

794 while ('\t' is c || ' ' is c)

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

795 c= fDocument.getChar(++end);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

796

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

797 return fDocument.get(start, end - start);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

798 } catch (BadLocationException x) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

799 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

800

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

801 return ""; //$NON-NLS-1$

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

802 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

803

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

804 /**

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

805 * Determines whether the offset is the beginning of a line in the given document.

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

806 *

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

807 * @param offset the offset

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

808 * @return <code>true</code> if offset is the beginning of a line

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

809 * @exception BadLocationException if offset is invalid in document

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

810 * @since 3.0

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

811 */

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

812 private bool isLineStart(int offset) {

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

813 int start= fDocument.getLineOfOffset(offset);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

814 start= fDocument.getLineOffset(start);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

815 return (start is offset);

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

816 }

bc29606a740c Added dwt-addons in original directory structure of eclipse.org

Frank Benoit <benoit@tionex.de>

parents:

diff changeset

817 }

Mercurial > projects > dwt2

annotate org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/ContentFormatter.d @ 12:bc29606a740c