|
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 module dwtx.jface.text.IDocumentPartitioner;
|
|
|
14
|
|
131
|
15 import dwtx.jface.text.IDocumentPartitioningListener; // packageimport
|
|
|
16 import dwtx.jface.text.DefaultTextHover; // packageimport
|
|
|
17 import dwtx.jface.text.AbstractInformationControl; // packageimport
|
|
|
18 import dwtx.jface.text.TextUtilities; // packageimport
|
|
|
19 import dwtx.jface.text.IInformationControlCreatorExtension; // packageimport
|
|
|
20 import dwtx.jface.text.AbstractInformationControlManager; // packageimport
|
|
|
21 import dwtx.jface.text.ITextViewerExtension2; // packageimport
|
|
|
22 import dwtx.jface.text.DefaultIndentLineAutoEditStrategy; // packageimport
|
|
|
23 import dwtx.jface.text.ITextSelection; // packageimport
|
|
|
24 import dwtx.jface.text.Document; // packageimport
|
|
|
25 import dwtx.jface.text.FindReplaceDocumentAdapterContentProposalProvider; // packageimport
|
|
|
26 import dwtx.jface.text.ITextListener; // packageimport
|
|
|
27 import dwtx.jface.text.BadPartitioningException; // packageimport
|
|
|
28 import dwtx.jface.text.ITextViewerExtension5; // packageimport
|
|
|
29 import dwtx.jface.text.IDocumentPartitionerExtension3; // packageimport
|
|
|
30 import dwtx.jface.text.IUndoManager; // packageimport
|
|
|
31 import dwtx.jface.text.ITextHoverExtension2; // packageimport
|
|
|
32 import dwtx.jface.text.IRepairableDocument; // packageimport
|
|
|
33 import dwtx.jface.text.IRewriteTarget; // packageimport
|
|
|
34 import dwtx.jface.text.DefaultPositionUpdater; // packageimport
|
|
|
35 import dwtx.jface.text.RewriteSessionEditProcessor; // packageimport
|
|
|
36 import dwtx.jface.text.TextViewerHoverManager; // packageimport
|
|
|
37 import dwtx.jface.text.DocumentRewriteSession; // packageimport
|
|
|
38 import dwtx.jface.text.TextViewer; // packageimport
|
|
|
39 import dwtx.jface.text.ITextViewerExtension8; // packageimport
|
|
|
40 import dwtx.jface.text.RegExMessages; // packageimport
|
|
|
41 import dwtx.jface.text.IDelayedInputChangeProvider; // packageimport
|
|
|
42 import dwtx.jface.text.ITextOperationTargetExtension; // packageimport
|
|
|
43 import dwtx.jface.text.IWidgetTokenOwner; // packageimport
|
|
|
44 import dwtx.jface.text.IViewportListener; // packageimport
|
|
|
45 import dwtx.jface.text.GapTextStore; // packageimport
|
|
|
46 import dwtx.jface.text.MarkSelection; // packageimport
|
|
|
47 import dwtx.jface.text.IDocumentPartitioningListenerExtension; // packageimport
|
|
|
48 import dwtx.jface.text.IDocumentAdapterExtension; // packageimport
|
|
|
49 import dwtx.jface.text.IInformationControlExtension; // packageimport
|
|
|
50 import dwtx.jface.text.IDocumentPartitioningListenerExtension2; // packageimport
|
|
|
51 import dwtx.jface.text.DefaultDocumentAdapter; // packageimport
|
|
|
52 import dwtx.jface.text.ITextViewerExtension3; // packageimport
|
|
|
53 import dwtx.jface.text.IInformationControlCreator; // packageimport
|
|
|
54 import dwtx.jface.text.TypedRegion; // packageimport
|
|
|
55 import dwtx.jface.text.ISynchronizable; // packageimport
|
|
|
56 import dwtx.jface.text.IMarkRegionTarget; // packageimport
|
|
|
57 import dwtx.jface.text.TextViewerUndoManager; // packageimport
|
|
|
58 import dwtx.jface.text.IRegion; // packageimport
|
|
|
59 import dwtx.jface.text.IInformationControlExtension2; // packageimport
|
|
|
60 import dwtx.jface.text.IDocumentExtension4; // packageimport
|
|
|
61 import dwtx.jface.text.IDocumentExtension2; // packageimport
|
|
|
62 import dwtx.jface.text.IDocumentPartitionerExtension2; // packageimport
|
|
|
63 import dwtx.jface.text.Assert; // packageimport
|
|
|
64 import dwtx.jface.text.DefaultInformationControl; // packageimport
|
|
|
65 import dwtx.jface.text.IWidgetTokenOwnerExtension; // packageimport
|
|
|
66 import dwtx.jface.text.DocumentClone; // packageimport
|
|
|
67 import dwtx.jface.text.DefaultUndoManager; // packageimport
|
|
|
68 import dwtx.jface.text.IFindReplaceTarget; // packageimport
|
|
|
69 import dwtx.jface.text.IAutoEditStrategy; // packageimport
|
|
|
70 import dwtx.jface.text.ILineTrackerExtension; // packageimport
|
|
|
71 import dwtx.jface.text.IUndoManagerExtension; // packageimport
|
|
|
72 import dwtx.jface.text.TextSelection; // packageimport
|
|
|
73 import dwtx.jface.text.DefaultAutoIndentStrategy; // packageimport
|
|
|
74 import dwtx.jface.text.IAutoIndentStrategy; // packageimport
|
|
|
75 import dwtx.jface.text.IPainter; // packageimport
|
|
|
76 import dwtx.jface.text.IInformationControl; // packageimport
|
|
|
77 import dwtx.jface.text.IInformationControlExtension3; // packageimport
|
|
|
78 import dwtx.jface.text.ITextViewerExtension6; // packageimport
|
|
|
79 import dwtx.jface.text.IInformationControlExtension4; // packageimport
|
|
|
80 import dwtx.jface.text.DefaultLineTracker; // packageimport
|
|
|
81 import dwtx.jface.text.IDocumentInformationMappingExtension; // packageimport
|
|
|
82 import dwtx.jface.text.IRepairableDocumentExtension; // packageimport
|
|
|
83 import dwtx.jface.text.ITextHover; // packageimport
|
|
|
84 import dwtx.jface.text.FindReplaceDocumentAdapter; // packageimport
|
|
|
85 import dwtx.jface.text.ILineTracker; // packageimport
|
|
|
86 import dwtx.jface.text.Line; // packageimport
|
|
|
87 import dwtx.jface.text.ITextViewerExtension; // packageimport
|
|
|
88 import dwtx.jface.text.IDocumentAdapter; // packageimport
|
|
|
89 import dwtx.jface.text.TextEvent; // packageimport
|
|
|
90 import dwtx.jface.text.BadLocationException; // packageimport
|
|
|
91 import dwtx.jface.text.AbstractDocument; // packageimport
|
|
|
92 import dwtx.jface.text.AbstractLineTracker; // packageimport
|
|
|
93 import dwtx.jface.text.TreeLineTracker; // packageimport
|
|
|
94 import dwtx.jface.text.ITextPresentationListener; // packageimport
|
|
|
95 import dwtx.jface.text.Region; // packageimport
|
|
|
96 import dwtx.jface.text.ITextViewer; // packageimport
|
|
|
97 import dwtx.jface.text.IDocumentInformationMapping; // packageimport
|
|
|
98 import dwtx.jface.text.MarginPainter; // packageimport
|
|
|
99 import dwtx.jface.text.IPaintPositionManager; // packageimport
|
|
|
100 import dwtx.jface.text.TextPresentation; // packageimport
|
|
|
101 import dwtx.jface.text.IFindReplaceTargetExtension; // packageimport
|
|
|
102 import dwtx.jface.text.ISlaveDocumentManagerExtension; // packageimport
|
|
|
103 import dwtx.jface.text.ISelectionValidator; // packageimport
|
|
|
104 import dwtx.jface.text.IDocumentExtension; // packageimport
|
|
|
105 import dwtx.jface.text.PropagatingFontFieldEditor; // packageimport
|
|
|
106 import dwtx.jface.text.ConfigurableLineTracker; // packageimport
|
|
|
107 import dwtx.jface.text.SlaveDocumentEvent; // packageimport
|
|
|
108 import dwtx.jface.text.IDocumentListener; // packageimport
|
|
|
109 import dwtx.jface.text.PaintManager; // packageimport
|
|
|
110 import dwtx.jface.text.IFindReplaceTargetExtension3; // packageimport
|
|
|
111 import dwtx.jface.text.ITextDoubleClickStrategy; // packageimport
|
|
|
112 import dwtx.jface.text.IDocumentExtension3; // packageimport
|
|
|
113 import dwtx.jface.text.Position; // packageimport
|
|
|
114 import dwtx.jface.text.TextMessages; // packageimport
|
|
|
115 import dwtx.jface.text.CopyOnWriteTextStore; // packageimport
|
|
|
116 import dwtx.jface.text.WhitespaceCharacterPainter; // packageimport
|
|
|
117 import dwtx.jface.text.IPositionUpdater; // packageimport
|
|
|
118 import dwtx.jface.text.DefaultTextDoubleClickStrategy; // packageimport
|
|
|
119 import dwtx.jface.text.ListLineTracker; // packageimport
|
|
|
120 import dwtx.jface.text.ITextInputListener; // packageimport
|
|
|
121 import dwtx.jface.text.BadPositionCategoryException; // packageimport
|
|
|
122 import dwtx.jface.text.IWidgetTokenKeeperExtension; // packageimport
|
|
|
123 import dwtx.jface.text.IInputChangedListener; // packageimport
|
|
|
124 import dwtx.jface.text.ITextOperationTarget; // packageimport
|
|
|
125 import dwtx.jface.text.IDocumentInformationMappingExtension2; // packageimport
|
|
|
126 import dwtx.jface.text.ITextViewerExtension7; // packageimport
|
|
|
127 import dwtx.jface.text.IInformationControlExtension5; // packageimport
|
|
|
128 import dwtx.jface.text.IDocumentRewriteSessionListener; // packageimport
|
|
|
129 import dwtx.jface.text.JFaceTextUtil; // packageimport
|
|
|
130 import dwtx.jface.text.AbstractReusableInformationControlCreator; // packageimport
|
|
|
131 import dwtx.jface.text.TabsToSpacesConverter; // packageimport
|
|
|
132 import dwtx.jface.text.CursorLinePainter; // packageimport
|
|
|
133 import dwtx.jface.text.ITextHoverExtension; // packageimport
|
|
|
134 import dwtx.jface.text.IEventConsumer; // packageimport
|
|
|
135 import dwtx.jface.text.IDocument; // packageimport
|
|
|
136 import dwtx.jface.text.IWidgetTokenKeeper; // packageimport
|
|
|
137 import dwtx.jface.text.DocumentCommand; // packageimport
|
|
|
138 import dwtx.jface.text.TypedPosition; // packageimport
|
|
|
139 import dwtx.jface.text.IEditingSupportRegistry; // packageimport
|
|
|
140 import dwtx.jface.text.IDocumentPartitionerExtension; // packageimport
|
|
|
141 import dwtx.jface.text.AbstractHoverInformationControlManager; // packageimport
|
|
|
142 import dwtx.jface.text.IEditingSupport; // packageimport
|
|
|
143 import dwtx.jface.text.IMarkSelection; // packageimport
|
|
|
144 import dwtx.jface.text.ISlaveDocumentManager; // packageimport
|
|
|
145 import dwtx.jface.text.DocumentEvent; // packageimport
|
|
|
146 import dwtx.jface.text.DocumentPartitioningChangedEvent; // packageimport
|
|
|
147 import dwtx.jface.text.ITextStore; // packageimport
|
|
|
148 import dwtx.jface.text.JFaceTextMessages; // packageimport
|
|
|
149 import dwtx.jface.text.DocumentRewriteSessionEvent; // packageimport
|
|
|
150 import dwtx.jface.text.SequentialRewriteTextStore; // packageimport
|
|
|
151 import dwtx.jface.text.DocumentRewriteSessionType; // packageimport
|
|
|
152 import dwtx.jface.text.TextAttribute; // packageimport
|
|
|
153 import dwtx.jface.text.ITextViewerExtension4; // packageimport
|
|
|
154 import dwtx.jface.text.ITypedRegion; // packageimport
|
|
|
155
|
|
|
156
|
|
129
|
157 import dwt.dwthelper.utils;
|
|
|
158
|
|
|
159
|
|
|
160
|
|
|
161 /**
|
|
|
162 * A document partitioner divides a document into a set
|
|
|
163 * of disjoint text partitions. Each partition has a content type, an
|
|
|
164 * offset, and a length. The document partitioner is connected to one document
|
|
|
165 * and informed about all changes of this document before any of the
|
|
|
166 * document's document listeners. A document partitioner can thus
|
|
|
167 * incrementally update on the receipt of a document change event.<p>
|
|
|
168 *
|
|
|
169 * In order to provided backward compatibility for clients of <code>IDocumentPartitioner</code>, extension
|
|
|
170 * interfaces are used to provide a means of evolution. The following extension interfaces
|
|
|
171 * exist:
|
|
|
172 * <ul>
|
|
|
173 * <li> {@link dwtx.jface.text.IDocumentPartitionerExtension} since version 2.0 replacing
|
|
|
174 * the <code>documentChanged</code> method with a new one returning the minimal document region
|
|
|
175 * comprising all partition changes.</li>
|
|
|
176 * <li> {@link dwtx.jface.text.IDocumentPartitionerExtension2} since version 3.0
|
|
|
177 * introducing zero-length partitions in conjunction with the distinction between
|
|
|
178 * open and closed partitions. Also provides inside in the implementation of the partitioner
|
|
|
179 * by exposing the position category used for managing the partitioning information.</li>
|
|
|
180 * <li> {@link dwtx.jface.text.IDocumentPartitionerExtension3} since version 3.1 introducing
|
|
|
181 * rewrite session. It also replaces the existing {@link #connect(IDocument)} method with
|
|
|
182 * a new one: {@link dwtx.jface.text.IDocumentPartitionerExtension3#connect(IDocument, bool)}.
|
|
|
183 * </ul>
|
|
|
184 * <p>
|
|
|
185 * Clients may implement this interface and its extension interfaces or use the standard
|
|
|
186 * implementation <code>DefaultPartitioner</code>.
|
|
|
187 * </p>
|
|
|
188 *
|
|
|
189 * @see dwtx.jface.text.IDocumentPartitionerExtension
|
|
|
190 * @see dwtx.jface.text.IDocumentPartitionerExtension2
|
|
|
191 * @see dwtx.jface.text.IDocument
|
|
|
192 */
|
|
|
193 public interface IDocumentPartitioner {
|
|
|
194
|
|
|
195 /**
|
|
|
196 * Connects the partitioner to a document.
|
|
|
197 * Connect indicates the begin of the usage of the receiver
|
|
|
198 * as partitioner of the given document. Thus, resources the partitioner
|
|
|
199 * needs to be operational for this document should be allocated.<p>
|
|
|
200 *
|
|
|
201 * The caller of this method must ensure that this partitioner is
|
|
|
202 * also set as the document's document partitioner.<p>
|
|
|
203 *
|
|
|
204 * This method has been replaced with {@link IDocumentPartitionerExtension3#connect(IDocument, bool)}.
|
|
|
205 * Implementers should default a call <code>connect(document)</code> to
|
|
|
206 * <code>connect(document, false)</code> in order to sustain the same semantics.
|
|
|
207 *
|
|
|
208 * @param document the document to be connected to
|
|
|
209 */
|
|
|
210 void connect(IDocument document);
|
|
|
211
|
|
|
212 /**
|
|
|
213 * Disconnects the partitioner from the document it is connected to.
|
|
|
214 * Disconnect indicates the end of the usage of the receiver as
|
|
|
215 * partitioner of the connected document. Thus, resources the partitioner
|
|
|
216 * needed to be operation for its connected document should be deallocated.<p>
|
|
|
217 * The caller of this method should also must ensure that this partitioner is
|
|
|
218 * no longer the document's partitioner.
|
|
|
219 */
|
|
|
220 void disconnect();
|
|
|
221
|
|
|
222 /**
|
|
|
223 * Informs about a forthcoming document change. Will be called by the
|
|
|
224 * connected document and is not intended to be used by clients
|
|
|
225 * other than the connected document.
|
|
|
226 *
|
|
|
227 * @param event the event describing the forthcoming change
|
|
|
228 */
|
|
|
229 void documentAboutToBeChanged(DocumentEvent event);
|
|
|
230
|
|
|
231 /**
|
|
|
232 * The document has been changed. The partitioner updates
|
|
|
233 * the document's partitioning and returns whether the structure of the
|
|
|
234 * document partitioning has been changed, i.e. whether partitions
|
|
|
235 * have been added or removed. Will be called by the connected document and
|
|
|
236 * is not intended to be used by clients other than the connected document.<p>
|
|
|
237 *
|
|
|
238 * This method has been replaced by {@link IDocumentPartitionerExtension#documentChanged2(DocumentEvent)}.
|
|
|
239 *
|
|
|
240 * @param event the event describing the document change
|
|
|
241 * @return <code>true</code> if partitioning changed
|
|
|
242 */
|
|
|
243 bool documentChanged(DocumentEvent event);
|
|
|
244
|
|
|
245 /**
|
|
|
246 * Returns the set of all legal content types of this partitioner.
|
|
|
247 * I.e. any result delivered by this partitioner may not contain a content type
|
|
|
248 * which would not be included in this method's result.
|
|
|
249 *
|
|
|
250 * @return the set of legal content types
|
|
|
251 */
|
|
|
252 String[] getLegalContentTypes();
|
|
|
253
|
|
|
254 /**
|
|
|
255 * Returns the content type of the partition containing the
|
|
|
256 * given offset in the connected document. There must be a
|
|
|
257 * document connected to this partitioner.<p>
|
|
|
258 *
|
|
|
259 * Use {@link IDocumentPartitionerExtension2#getContentType(int, bool)} when
|
|
|
260 * zero-length partitions are supported. In that case this method is
|
|
|
261 * equivalent:
|
|
|
262 * <pre>
|
|
|
263 * IDocumentPartitionerExtension2 extension= (IDocumentPartitionerExtension2) partitioner;
|
|
|
264 * return extension.getContentType(offset, false);
|
|
|
265 * </pre>
|
|
|
266 *
|
|
|
267 * @param offset the offset in the connected document
|
|
|
268 * @return the content type of the offset's partition
|
|
|
269 */
|
|
|
270 String getContentType(int offset);
|
|
|
271
|
|
|
272 /**
|
|
|
273 * Returns the partitioning of the given range of the connected
|
|
|
274 * document. There must be a document connected to this partitioner.<p>
|
|
|
275 *
|
|
|
276 * Use {@link IDocumentPartitionerExtension2#computePartitioning(int, int, bool)} when
|
|
|
277 * zero-length partitions are supported. In that case this method is
|
|
|
278 * equivalent:
|
|
|
279 * <pre>
|
|
|
280 * IDocumentPartitionerExtension2 extension= (IDocumentPartitionerExtension2) partitioner;
|
|
|
281 * return extension.computePartitioning(offset, length, false);
|
|
|
282 * </pre>
|
|
|
283 *
|
|
|
284 * @param offset the offset of the range of interest
|
|
|
285 * @param length the length of the range of interest
|
|
|
286 * @return the partitioning of the range
|
|
|
287 */
|
|
|
288 ITypedRegion[] computePartitioning(int offset, int length);
|
|
|
289
|
|
|
290 /**
|
|
|
291 * Returns the partition containing the given offset of
|
|
|
292 * the connected document. There must be a document connected to this
|
|
|
293 * partitioner.<p>
|
|
|
294 *
|
|
|
295 * Use {@link IDocumentPartitionerExtension2#getPartition(int, bool)} when
|
|
|
296 * zero-length partitions are supported. In that case this method is
|
|
|
297 * equivalent:
|
|
|
298 * <pre>
|
|
|
299 * IDocumentPartitionerExtension2 extension= (IDocumentPartitionerExtension2) partitioner;
|
|
|
300 * return extension.getPartition(offset, false);
|
|
|
301 * </pre>
|
|
|
302 *
|
|
|
303 * @param offset the offset for which to determine the partition
|
|
|
304 * @return the partition containing the offset
|
|
|
305 */
|
|
|
306 ITypedRegion getPartition(int offset);
|
|
|
307 }
|
