Mercurial > projects > dwt2

comparison org.eclipse.text/src/org/eclipse/jface/text/IDocumentExtension4.d @ 12:bc29606a740c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added dwt-addons in original directory structure of eclipse.org
author Frank Benoit <benoit@tionex.de>
date Sat, 14 Mar 2009 18:23:29 +0100
parents
children 5feec68b4556
comparison
equal deleted inserted replaced
11:43904fec5dca 12:bc29606a740c
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 org.eclipse.jface.text.IDocumentExtension4;
14
15 import org.eclipse.jface.text.IDocumentPartitioningListener; // packageimport
16 import org.eclipse.jface.text.DefaultTextHover; // packageimport
17 import org.eclipse.jface.text.AbstractInformationControl; // packageimport
18 import org.eclipse.jface.text.TextUtilities; // packageimport
19 import org.eclipse.jface.text.IInformationControlCreatorExtension; // packageimport
20 import org.eclipse.jface.text.AbstractInformationControlManager; // packageimport
21 import org.eclipse.jface.text.ITextViewerExtension2; // packageimport
22 import org.eclipse.jface.text.IDocumentPartitioner; // packageimport
23 import org.eclipse.jface.text.DefaultIndentLineAutoEditStrategy; // packageimport
24 import org.eclipse.jface.text.ITextSelection; // packageimport
25 import org.eclipse.jface.text.Document; // packageimport
26 import org.eclipse.jface.text.FindReplaceDocumentAdapterContentProposalProvider; // packageimport
27 import org.eclipse.jface.text.ITextListener; // packageimport
28 import org.eclipse.jface.text.BadPartitioningException; // packageimport
29 import org.eclipse.jface.text.ITextViewerExtension5; // packageimport
30 import org.eclipse.jface.text.IDocumentPartitionerExtension3; // packageimport
31 import org.eclipse.jface.text.IUndoManager; // packageimport
32 import org.eclipse.jface.text.ITextHoverExtension2; // packageimport
33 import org.eclipse.jface.text.IRepairableDocument; // packageimport
34 import org.eclipse.jface.text.IRewriteTarget; // packageimport
35 import org.eclipse.jface.text.DefaultPositionUpdater; // packageimport
36 import org.eclipse.jface.text.RewriteSessionEditProcessor; // packageimport
37 import org.eclipse.jface.text.TextViewerHoverManager; // packageimport
38 import org.eclipse.jface.text.DocumentRewriteSession; // packageimport
39 import org.eclipse.jface.text.TextViewer; // packageimport
40 import org.eclipse.jface.text.ITextViewerExtension8; // packageimport
41 import org.eclipse.jface.text.RegExMessages; // packageimport
42 import org.eclipse.jface.text.IDelayedInputChangeProvider; // packageimport
43 import org.eclipse.jface.text.ITextOperationTargetExtension; // packageimport
44 import org.eclipse.jface.text.IWidgetTokenOwner; // packageimport
45 import org.eclipse.jface.text.IViewportListener; // packageimport
46 import org.eclipse.jface.text.GapTextStore; // packageimport
47 import org.eclipse.jface.text.MarkSelection; // packageimport
48 import org.eclipse.jface.text.IDocumentPartitioningListenerExtension; // packageimport
49 import org.eclipse.jface.text.IDocumentAdapterExtension; // packageimport
50 import org.eclipse.jface.text.IInformationControlExtension; // packageimport
51 import org.eclipse.jface.text.IDocumentPartitioningListenerExtension2; // packageimport
52 import org.eclipse.jface.text.DefaultDocumentAdapter; // packageimport
53 import org.eclipse.jface.text.ITextViewerExtension3; // packageimport
54 import org.eclipse.jface.text.IInformationControlCreator; // packageimport
55 import org.eclipse.jface.text.TypedRegion; // packageimport
56 import org.eclipse.jface.text.ISynchronizable; // packageimport
57 import org.eclipse.jface.text.IMarkRegionTarget; // packageimport
58 import org.eclipse.jface.text.TextViewerUndoManager; // packageimport
59 import org.eclipse.jface.text.IRegion; // packageimport
60 import org.eclipse.jface.text.IInformationControlExtension2; // packageimport
61 import org.eclipse.jface.text.IDocumentExtension2; // packageimport
62 import org.eclipse.jface.text.IDocumentPartitionerExtension2; // packageimport
63 import org.eclipse.jface.text.Assert; // packageimport
64 import org.eclipse.jface.text.DefaultInformationControl; // packageimport
65 import org.eclipse.jface.text.IWidgetTokenOwnerExtension; // packageimport
66 import org.eclipse.jface.text.DocumentClone; // packageimport
67 import org.eclipse.jface.text.DefaultUndoManager; // packageimport
68 import org.eclipse.jface.text.IFindReplaceTarget; // packageimport
69 import org.eclipse.jface.text.IAutoEditStrategy; // packageimport
70 import org.eclipse.jface.text.ILineTrackerExtension; // packageimport
71 import org.eclipse.jface.text.IUndoManagerExtension; // packageimport
72 import org.eclipse.jface.text.TextSelection; // packageimport
73 import org.eclipse.jface.text.DefaultAutoIndentStrategy; // packageimport
74 import org.eclipse.jface.text.IAutoIndentStrategy; // packageimport
75 import org.eclipse.jface.text.IPainter; // packageimport
76 import org.eclipse.jface.text.IInformationControl; // packageimport
77 import org.eclipse.jface.text.IInformationControlExtension3; // packageimport
78 import org.eclipse.jface.text.ITextViewerExtension6; // packageimport
79 import org.eclipse.jface.text.IInformationControlExtension4; // packageimport
80 import org.eclipse.jface.text.DefaultLineTracker; // packageimport
81 import org.eclipse.jface.text.IDocumentInformationMappingExtension; // packageimport
82 import org.eclipse.jface.text.IRepairableDocumentExtension; // packageimport
83 import org.eclipse.jface.text.ITextHover; // packageimport
84 import org.eclipse.jface.text.FindReplaceDocumentAdapter; // packageimport
85 import org.eclipse.jface.text.ILineTracker; // packageimport
86 import org.eclipse.jface.text.Line; // packageimport
87 import org.eclipse.jface.text.ITextViewerExtension; // packageimport
88 import org.eclipse.jface.text.IDocumentAdapter; // packageimport
89 import org.eclipse.jface.text.TextEvent; // packageimport
90 import org.eclipse.jface.text.BadLocationException; // packageimport
91 import org.eclipse.jface.text.AbstractDocument; // packageimport
92 import org.eclipse.jface.text.AbstractLineTracker; // packageimport
93 import org.eclipse.jface.text.TreeLineTracker; // packageimport
94 import org.eclipse.jface.text.ITextPresentationListener; // packageimport
95 import org.eclipse.jface.text.Region; // packageimport
96 import org.eclipse.jface.text.ITextViewer; // packageimport
97 import org.eclipse.jface.text.IDocumentInformationMapping; // packageimport
98 import org.eclipse.jface.text.MarginPainter; // packageimport
99 import org.eclipse.jface.text.IPaintPositionManager; // packageimport
100 import org.eclipse.jface.text.TextPresentation; // packageimport
101 import org.eclipse.jface.text.IFindReplaceTargetExtension; // packageimport
102 import org.eclipse.jface.text.ISlaveDocumentManagerExtension; // packageimport
103 import org.eclipse.jface.text.ISelectionValidator; // packageimport
104 import org.eclipse.jface.text.IDocumentExtension; // packageimport
105 import org.eclipse.jface.text.PropagatingFontFieldEditor; // packageimport
106 import org.eclipse.jface.text.ConfigurableLineTracker; // packageimport
107 import org.eclipse.jface.text.SlaveDocumentEvent; // packageimport
108 import org.eclipse.jface.text.IDocumentListener; // packageimport
109 import org.eclipse.jface.text.PaintManager; // packageimport
110 import org.eclipse.jface.text.IFindReplaceTargetExtension3; // packageimport
111 import org.eclipse.jface.text.ITextDoubleClickStrategy; // packageimport
112 import org.eclipse.jface.text.IDocumentExtension3; // packageimport
113 import org.eclipse.jface.text.Position; // packageimport
114 import org.eclipse.jface.text.TextMessages; // packageimport
115 import org.eclipse.jface.text.CopyOnWriteTextStore; // packageimport
116 import org.eclipse.jface.text.WhitespaceCharacterPainter; // packageimport
117 import org.eclipse.jface.text.IPositionUpdater; // packageimport
118 import org.eclipse.jface.text.DefaultTextDoubleClickStrategy; // packageimport
119 import org.eclipse.jface.text.ListLineTracker; // packageimport
120 import org.eclipse.jface.text.ITextInputListener; // packageimport
121 import org.eclipse.jface.text.BadPositionCategoryException; // packageimport
122 import org.eclipse.jface.text.IWidgetTokenKeeperExtension; // packageimport
123 import org.eclipse.jface.text.IInputChangedListener; // packageimport
124 import org.eclipse.jface.text.ITextOperationTarget; // packageimport
125 import org.eclipse.jface.text.IDocumentInformationMappingExtension2; // packageimport
126 import org.eclipse.jface.text.ITextViewerExtension7; // packageimport
127 import org.eclipse.jface.text.IInformationControlExtension5; // packageimport
128 import org.eclipse.jface.text.IDocumentRewriteSessionListener; // packageimport
129 import org.eclipse.jface.text.JFaceTextUtil; // packageimport
130 import org.eclipse.jface.text.AbstractReusableInformationControlCreator; // packageimport
131 import org.eclipse.jface.text.TabsToSpacesConverter; // packageimport
132 import org.eclipse.jface.text.CursorLinePainter; // packageimport
133 import org.eclipse.jface.text.ITextHoverExtension; // packageimport
134 import org.eclipse.jface.text.IEventConsumer; // packageimport
135 import org.eclipse.jface.text.IDocument; // packageimport
136 import org.eclipse.jface.text.IWidgetTokenKeeper; // packageimport
137 import org.eclipse.jface.text.DocumentCommand; // packageimport
138 import org.eclipse.jface.text.TypedPosition; // packageimport
139 import org.eclipse.jface.text.IEditingSupportRegistry; // packageimport
140 import org.eclipse.jface.text.IDocumentPartitionerExtension; // packageimport
141 import org.eclipse.jface.text.AbstractHoverInformationControlManager; // packageimport
142 import org.eclipse.jface.text.IEditingSupport; // packageimport
143 import org.eclipse.jface.text.IMarkSelection; // packageimport
144 import org.eclipse.jface.text.ISlaveDocumentManager; // packageimport
145 import org.eclipse.jface.text.DocumentEvent; // packageimport
146 import org.eclipse.jface.text.DocumentPartitioningChangedEvent; // packageimport
147 import org.eclipse.jface.text.ITextStore; // packageimport
148 import org.eclipse.jface.text.JFaceTextMessages; // packageimport
149 import org.eclipse.jface.text.DocumentRewriteSessionEvent; // packageimport
150 import org.eclipse.jface.text.SequentialRewriteTextStore; // packageimport
151 import org.eclipse.jface.text.DocumentRewriteSessionType; // packageimport
152 import org.eclipse.jface.text.TextAttribute; // packageimport
153 import org.eclipse.jface.text.ITextViewerExtension4; // packageimport
154 import org.eclipse.jface.text.ITypedRegion; // packageimport
155
156
157 import java.lang.all;
158 import java.util.Set;
159
160 /**
161 * Extension interface for {@link org.eclipse.jface.text.IDocument}. It adds the
162 * following concepts:
163 * <ul>
164 * <li>Rewrite sessions. A rewrite session is a sequence of replace operations
165 * that form a semantic unit.</li>
166 * <li>A modification stamp on the document</li>
167 * <li>The ability to set the initial line delimiter and to query the default
168 * line delimiter</li>
169 * </ul>
170 *
171 * @since 3.1
172 */
173 public interface IDocumentExtension4 {
174
175 /**
176 * Tells the document that it is about to be rewritten. That is, a sequence
177 * of replace operations that form a semantic unit will be performed on this
178 * document. A specification of the nature of the operation sequence is
179 * given in form of the session type.
180 * <p>
181 * The document is considered being in rewrite mode as long as
182 * <code>stopRewriteSession</code> has not been called.
183 *
184 * @param sessionType the session type
185 * @return the started rewrite session
186 * @throws IllegalStateException in case there is already an active rewrite session
187 */
188 DocumentRewriteSession startRewriteSession(DocumentRewriteSessionType sessionType) ;
189
190 /**
191 * Tells the document to stop the rewrite session. This method has only any
192 * effect if <code>startRewriteSession</code> has been called before.
193 * <p>
194 * This method does not have any effect if the given session is not the
195 * active rewrite session.
196 *
197 * @param session the session to stop
198 */
199 void stopRewriteSession(DocumentRewriteSession session);
200
201 /**
202 * Returns the active rewrite session of this document or <code>null</code>.
203 *
204 * @return the active rewrite session or <code>null</code>
205 */
206 DocumentRewriteSession getActiveRewriteSession();
207
208 /**
209 * Registers the document rewrite session listener with the document. After
210 * registration the <code>IDocumentRewriteSessionListener</code> is
211 * informed about each state change of rewrite sessions performed on this
212 * document.
213 * <p>
214 * If the listener is already registered nothing happens.
215 * <p>
216 * An <code>IRewriteSessionDocumentListener</code> may call back to this
217 * document when being inside a document notification.
218 *
219 * @param listener the listener to be registered
220 */
221 void addDocumentRewriteSessionListener(IDocumentRewriteSessionListener listener);
222
223 /**
224 * Removes the listener from the document's list of document rewrite session
225 * listeners. If the listener is not registered with the document nothing
226 * happens.
227 * <p>
228 * An <code>IDocumentRewriteSessionListener</code> may call back to this
229 * document when being inside a document notification.
230 *
231 * @param listener the listener to be removed
232 */
233 void removeDocumentRewriteSessionListener(IDocumentRewriteSessionListener listener);
234
235 /**
236 * Substitutes the given text for the specified document range.
237 * Sends a <code>DocumentEvent</code> to all registered <code>IDocumentListener</code>.
238 *
239 * @param offset the document offset
240 * @param length the length of the specified range
241 * @param text the substitution text
242 * @param modificationStamp of the document after replacing
243 * @exception BadLocationException if the offset is invalid in this document
244 *
245 * @see DocumentEvent
246 * @see IDocumentListener
247 */
248 void replace(int offset, int length, String text, long modificationStamp) ;
249
250 /**
251 * Replaces the content of the document with the given text.
252 * Sends a <code>DocumentEvent</code> to all registered <code>IDocumentListener</code>.
253 * This method is a convenience method for <code>replace(0, getLength(), text)</code>.
254 *
255 * @param text the new content of the document
256 * @param modificationStamp of the document after setting the content
257 *
258 * @see DocumentEvent
259 * @see IDocumentListener
260 */
261 void set(String text, long modificationStamp);
262
263 /**
264 * The unknown modification stamp.
265 */
266 static const long UNKNOWN_MODIFICATION_STAMP= -1;
267
268 /**
269 * Returns the modification stamp of this document. The modification stamp
270 * is updated each time a modifying operation is called on this document. If
271 * two modification stamps of the same document are identical then the document
272 * content is too, however, same content does not imply same modification stamp.
273 * <p>
274 * The magnitude or sign of the numerical difference between two modification stamps
275 * is not significant.
276 * </p>
277 *
278 * @return the modification stamp of this document or <code>UNKNOWN_MODIFICATION_STAMP</code>
279 */
280 long getModificationStamp();
281
282 /**
283 * Returns this document's default line delimiter.
284 * <p>
285 * This default line delimiter should be used by clients who
286 * want unique delimiters (e.g. 'CR's) in the document.</p>
287 *
288 * @return the default line delimiter or <code>null</code> if none
289 */
290 String getDefaultLineDelimiter();
291
292 /**
293 * Sets this document's initial line delimiter i.e. the one
294 * which is returned by <code>getDefaultLineDelimiter</code>
295 * if the document does not yet contain any line delimiter.
296 *
297 * @param lineDelimiter the default line delimiter
298 */
299 void setInitialLineDelimiter(String lineDelimiter);
300 }