|
129
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
|
|
|
3 * All rights reserved. This program and the accompanying materials
|
|
|
4 * are made available under the terms of the Eclipse Public License v1.0
|
|
|
5 * which accompanies this distribution, and is available at
|
|
|
6 * http://www.eclipse.org/legal/epl-v10.html
|
|
|
7 *
|
|
|
8 * Contributors:
|
|
|
9 * IBM Corporation - initial API and implementation
|
|
|
10 * Port to the D programming language:
|
|
|
11 * Frank Benoit <benoit@tionex.de>
|
|
|
12 *******************************************************************************/
|
|
|
13
|
|
131
|
14
|
|
151
|
15 module dwtx.jface.text.IDocumentPartitionerExtension2;
|
|
|
16
|
|
131
|
17 import dwtx.jface.text.IDocumentPartitioningListener; // packageimport
|
|
|
18 import dwtx.jface.text.DefaultTextHover; // packageimport
|
|
|
19 import dwtx.jface.text.AbstractInformationControl; // packageimport
|
|
|
20 import dwtx.jface.text.TextUtilities; // packageimport
|
|
|
21 import dwtx.jface.text.IInformationControlCreatorExtension; // packageimport
|
|
|
22 import dwtx.jface.text.AbstractInformationControlManager; // packageimport
|
|
|
23 import dwtx.jface.text.ITextViewerExtension2; // packageimport
|
|
|
24 import dwtx.jface.text.IDocumentPartitioner; // packageimport
|
|
|
25 import dwtx.jface.text.DefaultIndentLineAutoEditStrategy; // packageimport
|
|
|
26 import dwtx.jface.text.ITextSelection; // packageimport
|
|
|
27 import dwtx.jface.text.Document; // packageimport
|
|
|
28 import dwtx.jface.text.FindReplaceDocumentAdapterContentProposalProvider; // packageimport
|
|
|
29 import dwtx.jface.text.ITextListener; // packageimport
|
|
|
30 import dwtx.jface.text.BadPartitioningException; // packageimport
|
|
|
31 import dwtx.jface.text.ITextViewerExtension5; // packageimport
|
|
|
32 import dwtx.jface.text.IDocumentPartitionerExtension3; // packageimport
|
|
|
33 import dwtx.jface.text.IUndoManager; // packageimport
|
|
|
34 import dwtx.jface.text.ITextHoverExtension2; // packageimport
|
|
|
35 import dwtx.jface.text.IRepairableDocument; // packageimport
|
|
|
36 import dwtx.jface.text.IRewriteTarget; // packageimport
|
|
|
37 import dwtx.jface.text.DefaultPositionUpdater; // packageimport
|
|
|
38 import dwtx.jface.text.RewriteSessionEditProcessor; // packageimport
|
|
|
39 import dwtx.jface.text.TextViewerHoverManager; // packageimport
|
|
|
40 import dwtx.jface.text.DocumentRewriteSession; // packageimport
|
|
|
41 import dwtx.jface.text.TextViewer; // packageimport
|
|
|
42 import dwtx.jface.text.ITextViewerExtension8; // packageimport
|
|
|
43 import dwtx.jface.text.RegExMessages; // packageimport
|
|
|
44 import dwtx.jface.text.IDelayedInputChangeProvider; // packageimport
|
|
|
45 import dwtx.jface.text.ITextOperationTargetExtension; // packageimport
|
|
|
46 import dwtx.jface.text.IWidgetTokenOwner; // packageimport
|
|
|
47 import dwtx.jface.text.IViewportListener; // packageimport
|
|
|
48 import dwtx.jface.text.GapTextStore; // packageimport
|
|
|
49 import dwtx.jface.text.MarkSelection; // packageimport
|
|
|
50 import dwtx.jface.text.IDocumentPartitioningListenerExtension; // packageimport
|
|
|
51 import dwtx.jface.text.IDocumentAdapterExtension; // packageimport
|
|
|
52 import dwtx.jface.text.IInformationControlExtension; // packageimport
|
|
|
53 import dwtx.jface.text.IDocumentPartitioningListenerExtension2; // packageimport
|
|
|
54 import dwtx.jface.text.DefaultDocumentAdapter; // packageimport
|
|
|
55 import dwtx.jface.text.ITextViewerExtension3; // packageimport
|
|
|
56 import dwtx.jface.text.IInformationControlCreator; // packageimport
|
|
|
57 import dwtx.jface.text.TypedRegion; // packageimport
|
|
|
58 import dwtx.jface.text.ISynchronizable; // packageimport
|
|
|
59 import dwtx.jface.text.IMarkRegionTarget; // packageimport
|
|
|
60 import dwtx.jface.text.TextViewerUndoManager; // packageimport
|
|
|
61 import dwtx.jface.text.IRegion; // packageimport
|
|
|
62 import dwtx.jface.text.IInformationControlExtension2; // packageimport
|
|
|
63 import dwtx.jface.text.IDocumentExtension4; // packageimport
|
|
|
64 import dwtx.jface.text.IDocumentExtension2; // packageimport
|
|
|
65 import dwtx.jface.text.Assert; // packageimport
|
|
|
66 import dwtx.jface.text.DefaultInformationControl; // packageimport
|
|
|
67 import dwtx.jface.text.IWidgetTokenOwnerExtension; // packageimport
|
|
|
68 import dwtx.jface.text.DocumentClone; // packageimport
|
|
|
69 import dwtx.jface.text.DefaultUndoManager; // packageimport
|
|
|
70 import dwtx.jface.text.IFindReplaceTarget; // packageimport
|
|
|
71 import dwtx.jface.text.IAutoEditStrategy; // packageimport
|
|
|
72 import dwtx.jface.text.ILineTrackerExtension; // packageimport
|
|
|
73 import dwtx.jface.text.IUndoManagerExtension; // packageimport
|
|
|
74 import dwtx.jface.text.TextSelection; // packageimport
|
|
|
75 import dwtx.jface.text.DefaultAutoIndentStrategy; // packageimport
|
|
|
76 import dwtx.jface.text.IAutoIndentStrategy; // packageimport
|
|
|
77 import dwtx.jface.text.IPainter; // packageimport
|
|
|
78 import dwtx.jface.text.IInformationControl; // packageimport
|
|
|
79 import dwtx.jface.text.IInformationControlExtension3; // packageimport
|
|
|
80 import dwtx.jface.text.ITextViewerExtension6; // packageimport
|
|
|
81 import dwtx.jface.text.IInformationControlExtension4; // packageimport
|
|
|
82 import dwtx.jface.text.DefaultLineTracker; // packageimport
|
|
|
83 import dwtx.jface.text.IDocumentInformationMappingExtension; // packageimport
|
|
|
84 import dwtx.jface.text.IRepairableDocumentExtension; // packageimport
|
|
|
85 import dwtx.jface.text.ITextHover; // packageimport
|
|
|
86 import dwtx.jface.text.FindReplaceDocumentAdapter; // packageimport
|
|
|
87 import dwtx.jface.text.ILineTracker; // packageimport
|
|
|
88 import dwtx.jface.text.Line; // packageimport
|
|
|
89 import dwtx.jface.text.ITextViewerExtension; // packageimport
|
|
|
90 import dwtx.jface.text.IDocumentAdapter; // packageimport
|
|
|
91 import dwtx.jface.text.TextEvent; // packageimport
|
|
|
92 import dwtx.jface.text.BadLocationException; // packageimport
|
|
|
93 import dwtx.jface.text.AbstractDocument; // packageimport
|
|
|
94 import dwtx.jface.text.AbstractLineTracker; // packageimport
|
|
|
95 import dwtx.jface.text.TreeLineTracker; // packageimport
|
|
|
96 import dwtx.jface.text.ITextPresentationListener; // packageimport
|
|
|
97 import dwtx.jface.text.Region; // packageimport
|
|
|
98 import dwtx.jface.text.ITextViewer; // packageimport
|
|
|
99 import dwtx.jface.text.IDocumentInformationMapping; // packageimport
|
|
|
100 import dwtx.jface.text.MarginPainter; // packageimport
|
|
|
101 import dwtx.jface.text.IPaintPositionManager; // packageimport
|
|
|
102 import dwtx.jface.text.TextPresentation; // packageimport
|
|
|
103 import dwtx.jface.text.IFindReplaceTargetExtension; // packageimport
|
|
|
104 import dwtx.jface.text.ISlaveDocumentManagerExtension; // packageimport
|
|
|
105 import dwtx.jface.text.ISelectionValidator; // packageimport
|
|
|
106 import dwtx.jface.text.IDocumentExtension; // packageimport
|
|
|
107 import dwtx.jface.text.PropagatingFontFieldEditor; // packageimport
|
|
|
108 import dwtx.jface.text.ConfigurableLineTracker; // packageimport
|
|
|
109 import dwtx.jface.text.SlaveDocumentEvent; // packageimport
|
|
|
110 import dwtx.jface.text.IDocumentListener; // packageimport
|
|
|
111 import dwtx.jface.text.PaintManager; // packageimport
|
|
|
112 import dwtx.jface.text.IFindReplaceTargetExtension3; // packageimport
|
|
|
113 import dwtx.jface.text.ITextDoubleClickStrategy; // packageimport
|
|
|
114 import dwtx.jface.text.IDocumentExtension3; // packageimport
|
|
|
115 import dwtx.jface.text.Position; // packageimport
|
|
|
116 import dwtx.jface.text.TextMessages; // packageimport
|
|
|
117 import dwtx.jface.text.CopyOnWriteTextStore; // packageimport
|
|
|
118 import dwtx.jface.text.WhitespaceCharacterPainter; // packageimport
|
|
|
119 import dwtx.jface.text.IPositionUpdater; // packageimport
|
|
|
120 import dwtx.jface.text.DefaultTextDoubleClickStrategy; // packageimport
|
|
|
121 import dwtx.jface.text.ListLineTracker; // packageimport
|
|
|
122 import dwtx.jface.text.ITextInputListener; // packageimport
|
|
|
123 import dwtx.jface.text.BadPositionCategoryException; // packageimport
|
|
|
124 import dwtx.jface.text.IWidgetTokenKeeperExtension; // packageimport
|
|
|
125 import dwtx.jface.text.IInputChangedListener; // packageimport
|
|
|
126 import dwtx.jface.text.ITextOperationTarget; // packageimport
|
|
|
127 import dwtx.jface.text.IDocumentInformationMappingExtension2; // packageimport
|
|
|
128 import dwtx.jface.text.ITextViewerExtension7; // packageimport
|
|
|
129 import dwtx.jface.text.IInformationControlExtension5; // packageimport
|
|
|
130 import dwtx.jface.text.IDocumentRewriteSessionListener; // packageimport
|
|
|
131 import dwtx.jface.text.JFaceTextUtil; // packageimport
|
|
|
132 import dwtx.jface.text.AbstractReusableInformationControlCreator; // packageimport
|
|
|
133 import dwtx.jface.text.TabsToSpacesConverter; // packageimport
|
|
|
134 import dwtx.jface.text.CursorLinePainter; // packageimport
|
|
|
135 import dwtx.jface.text.ITextHoverExtension; // packageimport
|
|
|
136 import dwtx.jface.text.IEventConsumer; // packageimport
|
|
|
137 import dwtx.jface.text.IDocument; // packageimport
|
|
|
138 import dwtx.jface.text.IWidgetTokenKeeper; // packageimport
|
|
|
139 import dwtx.jface.text.DocumentCommand; // packageimport
|
|
|
140 import dwtx.jface.text.TypedPosition; // packageimport
|
|
|
141 import dwtx.jface.text.IEditingSupportRegistry; // packageimport
|
|
|
142 import dwtx.jface.text.IDocumentPartitionerExtension; // packageimport
|
|
|
143 import dwtx.jface.text.AbstractHoverInformationControlManager; // packageimport
|
|
|
144 import dwtx.jface.text.IEditingSupport; // packageimport
|
|
|
145 import dwtx.jface.text.IMarkSelection; // packageimport
|
|
|
146 import dwtx.jface.text.ISlaveDocumentManager; // packageimport
|
|
|
147 import dwtx.jface.text.DocumentEvent; // packageimport
|
|
|
148 import dwtx.jface.text.DocumentPartitioningChangedEvent; // packageimport
|
|
|
149 import dwtx.jface.text.ITextStore; // packageimport
|
|
|
150 import dwtx.jface.text.JFaceTextMessages; // packageimport
|
|
|
151 import dwtx.jface.text.DocumentRewriteSessionEvent; // packageimport
|
|
|
152 import dwtx.jface.text.SequentialRewriteTextStore; // packageimport
|
|
|
153 import dwtx.jface.text.DocumentRewriteSessionType; // packageimport
|
|
|
154 import dwtx.jface.text.TextAttribute; // packageimport
|
|
|
155 import dwtx.jface.text.ITextViewerExtension4; // packageimport
|
|
|
156 import dwtx.jface.text.ITypedRegion; // packageimport
|
|
|
157
|
|
129
|
158 import dwt.dwthelper.utils;
|
|
|
159
|
|
|
160
|
|
|
161 /**
|
|
|
162 * Extension interface for {@link dwtx.jface.text.IDocumentPartitioner}.
|
|
|
163 * <p>
|
|
|
164 * Extends the original concept of a document partitioner to answer the position
|
|
|
165 * categories that are used to manage the partitioning information.
|
|
|
166 * <p>
|
|
|
167 * This extension also introduces the concept of open and delimited partitions.
|
|
|
168 * A delimited partition has a predefined textual token delimiting its start and
|
|
|
169 * end, while an open partition can fill any space between two delimited
|
|
|
170 * partitions.
|
|
|
171 * </p>
|
|
|
172 * <p>
|
|
|
173 * An open partition of length zero can occur between two delimited partitions,
|
|
|
174 * thus having the same offset as the following delimited partition. The
|
|
|
175 * document start and end are considered to be delimiters of open partitions,
|
|
|
176 * i.e. there may be a zero-length partition between the document start and a
|
|
|
177 * delimited partition starting at offset 0.
|
|
|
178 * </p>
|
|
|
179 *
|
|
|
180 * @since 3.0
|
|
|
181 */
|
|
|
182 public interface IDocumentPartitionerExtension2 {
|
|
|
183
|
|
|
184 /**
|
|
|
185 * Returns the position categories that this partitioners uses in order to manage
|
|
|
186 * the partitioning information of the documents. Returns <code>null</code> if
|
|
|
187 * no position category is used.
|
|
|
188 *
|
|
|
189 * @return the position categories used to manage partitioning information or <code>null</code>
|
|
|
190 */
|
|
|
191 String[] getManagingPositionCategories();
|
|
|
192
|
|
|
193
|
|
|
194 /* zero-length partition support */
|
|
|
195
|
|
|
196 /**
|
|
|
197 * Returns the content type of the partition containing the given offset in
|
|
|
198 * the connected document. There must be a document connected to this
|
|
|
199 * partitioner.
|
|
|
200 * <p>
|
|
|
201 * If <code>preferOpenPartitions</code> is <code>true</code>,
|
|
|
202 * precedence is given to an open partition ending at <code>offset</code>
|
|
|
203 * over a delimited partition starting at <code>offset</code>.
|
|
|
204 * <p>
|
|
|
205 * This method replaces {@link IDocumentPartitioner#getContentType(int)}and
|
|
|
206 * behaves like it when <code>prepreferOpenPartitions</code> is
|
|
|
207 * <code>false</code>, i.e. precedence is always given to the partition
|
|
|
208 * that does not end at <code>offset</code>.
|
|
|
209 * </p>
|
|
|
210 *
|
|
|
211 * @param offset the offset in the connected document
|
|
|
212 * @param preferOpenPartitions <code>true</code> if precedence should be
|
|
|
213 * given to a open partition ending at <code>offset</code> over
|
|
|
214 * a delimited partition starting at <code>offset</code>
|
|
|
215 * @return the content type of the offset's partition
|
|
|
216 */
|
|
|
217 String getContentType(int offset, bool preferOpenPartitions);
|
|
|
218
|
|
|
219 /**
|
|
|
220 * Returns the partition containing the given offset of the connected
|
|
|
221 * document. There must be a document connected to this partitioner.
|
|
|
222 * <p>
|
|
|
223 * If <code>preferOpenPartitions</code> is <code>true</code>,
|
|
|
224 * precedence is given to an open partition ending at <code>offset</code>
|
|
|
225 * over a delimited partition starting at <code>offset</code>.
|
|
|
226 * <p>
|
|
|
227 * This method replaces {@link IDocumentPartitioner#getPartition(int)}and
|
|
|
228 * behaves like it when <preferOpenPartitions</code> is <code>false
|
|
|
229 * </code>, i.e. precedence is always given to the partition that does not
|
|
|
230 * end at <code>offset</code>.
|
|
|
231 * </p>
|
|
|
232 *
|
|
|
233 * @param offset the offset for which to determine the partition
|
|
|
234 * @param preferOpenPartitions <code>true</code> if precedence should be
|
|
|
235 * given to a open partition ending at <code>offset</code> over
|
|
|
236 * a delimited partition starting at <code>offset</code>
|
|
|
237 * @return the partition containing the offset
|
|
|
238 */
|
|
|
239 ITypedRegion getPartition(int offset, bool preferOpenPartitions);
|
|
|
240
|
|
|
241 /**
|
|
|
242 * Returns the partitioning of the given range of the connected document.
|
|
|
243 * There must be a document connected to this partitioner.
|
|
|
244 * <p>
|
|
|
245 * If <code>includeZeroLengthPartitions</code> is <code>true</code>, a
|
|
|
246 * zero-length partition of an open partition type (usually the default
|
|
|
247 * partition) is included between two delimited partitions. If it is
|
|
|
248 * <code>false</code>, no zero-length partitions are included.
|
|
|
249 * </p>
|
|
|
250 * <p>
|
|
|
251 * This method replaces
|
|
|
252 * {@link IDocumentPartitioner#computePartitioning(int, int)}and behaves
|
|
|
253 * like it when <code>includeZeroLengthPartitions</code> is
|
|
|
254 * <code>false</code>.
|
|
|
255 * </p>
|
|
|
256 *
|
|
|
257 * @param offset the offset of the range of interest
|
|
|
258 * @param length the length of the range of interest
|
|
|
259 * @param includeZeroLengthPartitions <code>true</code> if zero-length
|
|
|
260 * partitions should be returned as part of the computed
|
|
|
261 * partitioning
|
|
|
262 * @return the partitioning of the range
|
|
|
263 */
|
|
|
264 ITypedRegion[] computePartitioning(int offset, int length, bool includeZeroLengthPartitions);
|
|
|
265 }
|
