Mercurial > projects > dwt-addons
annotate dwtx/jface/text/IDocumentExtension4.d @ 172:d994a8b2cdf7
again compile fixes
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Wed, 10 Sep 2008 23:14:02 +0200 |
parents | 7926b636c282 |
children |
rev | line source |
---|---|
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.IDocumentExtension4; | |
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.IDocumentPartitioner; // packageimport | |
23 import dwtx.jface.text.DefaultIndentLineAutoEditStrategy; // packageimport | |
24 import dwtx.jface.text.ITextSelection; // packageimport | |
25 import dwtx.jface.text.Document; // packageimport | |
26 import dwtx.jface.text.FindReplaceDocumentAdapterContentProposalProvider; // packageimport | |
27 import dwtx.jface.text.ITextListener; // packageimport | |
28 import dwtx.jface.text.BadPartitioningException; // packageimport | |
29 import dwtx.jface.text.ITextViewerExtension5; // packageimport | |
30 import dwtx.jface.text.IDocumentPartitionerExtension3; // packageimport | |
31 import dwtx.jface.text.IUndoManager; // packageimport | |
32 import dwtx.jface.text.ITextHoverExtension2; // packageimport | |
33 import dwtx.jface.text.IRepairableDocument; // packageimport | |
34 import dwtx.jface.text.IRewriteTarget; // packageimport | |
35 import dwtx.jface.text.DefaultPositionUpdater; // packageimport | |
36 import dwtx.jface.text.RewriteSessionEditProcessor; // packageimport | |
37 import dwtx.jface.text.TextViewerHoverManager; // packageimport | |
38 import dwtx.jface.text.DocumentRewriteSession; // packageimport | |
39 import dwtx.jface.text.TextViewer; // packageimport | |
40 import dwtx.jface.text.ITextViewerExtension8; // packageimport | |
41 import dwtx.jface.text.RegExMessages; // packageimport | |
42 import dwtx.jface.text.IDelayedInputChangeProvider; // packageimport | |
43 import dwtx.jface.text.ITextOperationTargetExtension; // packageimport | |
44 import dwtx.jface.text.IWidgetTokenOwner; // packageimport | |
45 import dwtx.jface.text.IViewportListener; // packageimport | |
46 import dwtx.jface.text.GapTextStore; // packageimport | |
47 import dwtx.jface.text.MarkSelection; // packageimport | |
48 import dwtx.jface.text.IDocumentPartitioningListenerExtension; // packageimport | |
49 import dwtx.jface.text.IDocumentAdapterExtension; // packageimport | |
50 import dwtx.jface.text.IInformationControlExtension; // packageimport | |
51 import dwtx.jface.text.IDocumentPartitioningListenerExtension2; // packageimport | |
52 import dwtx.jface.text.DefaultDocumentAdapter; // packageimport | |
53 import dwtx.jface.text.ITextViewerExtension3; // packageimport | |
54 import dwtx.jface.text.IInformationControlCreator; // packageimport | |
55 import dwtx.jface.text.TypedRegion; // packageimport | |
56 import dwtx.jface.text.ISynchronizable; // packageimport | |
57 import dwtx.jface.text.IMarkRegionTarget; // packageimport | |
58 import dwtx.jface.text.TextViewerUndoManager; // packageimport | |
59 import dwtx.jface.text.IRegion; // packageimport | |
60 import dwtx.jface.text.IInformationControlExtension2; // 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 * Extension interface for {@link dwtx.jface.text.IDocument}. It adds the | |
161 * following concepts: | |
162 * <ul> | |
163 * <li>Rewrite sessions. A rewrite session is a sequence of replace operations | |
159 | 164 * that form a semantic unit.</li> |
129 | 165 * <li>A modification stamp on the document</li> |
166 * <li>The ability to set the initial line delimiter and to query the default | |
167 * line delimiter</li> | |
168 * </ul> | |
159 | 169 * |
129 | 170 * @since 3.1 |
171 */ | |
172 public interface IDocumentExtension4 { | |
173 | |
174 /** | |
175 * Tells the document that it is about to be rewritten. That is, a sequence | |
176 * of replace operations that form a semantic unit will be performed on this | |
177 * document. A specification of the nature of the operation sequence is | |
178 * given in form of the session type. | |
179 * <p> | |
180 * The document is considered being in rewrite mode as long as | |
181 * <code>stopRewriteSession</code> has not been called. | |
182 * | |
183 * @param sessionType the session type | |
184 * @return the started rewrite session | |
185 * @throws IllegalStateException in case there is already an active rewrite session | |
186 */ | |
139
93a6ec48fd28
Regexp throws removal in interfaces
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
187 DocumentRewriteSession startRewriteSession(DocumentRewriteSessionType sessionType) ; |
129 | 188 |
189 /** | |
190 * Tells the document to stop the rewrite session. This method has only any | |
191 * effect if <code>startRewriteSession</code> has been called before. | |
192 * <p> | |
193 * This method does not have any effect if the given session is not the | |
194 * active rewrite session. | |
195 * | |
196 * @param session the session to stop | |
197 */ | |
198 void stopRewriteSession(DocumentRewriteSession session); | |
199 | |
200 /** | |
201 * Returns the active rewrite session of this document or <code>null</code>. | |
202 * | |
203 * @return the active rewrite session or <code>null</code> | |
204 */ | |
205 DocumentRewriteSession getActiveRewriteSession(); | |
206 | |
207 /** | |
208 * Registers the document rewrite session listener with the document. After | |
209 * registration the <code>IDocumentRewriteSessionListener</code> is | |
210 * informed about each state change of rewrite sessions performed on this | |
211 * document. | |
212 * <p> | |
213 * If the listener is already registered nothing happens. | |
214 * <p> | |
215 * An <code>IRewriteSessionDocumentListener</code> may call back to this | |
216 * document when being inside a document notification. | |
217 * | |
218 * @param listener the listener to be registered | |
219 */ | |
220 void addDocumentRewriteSessionListener(IDocumentRewriteSessionListener listener); | |
221 | |
222 /** | |
223 * Removes the listener from the document's list of document rewrite session | |
224 * listeners. If the listener is not registered with the document nothing | |
225 * happens. | |
226 * <p> | |
227 * An <code>IDocumentRewriteSessionListener</code> may call back to this | |
228 * document when being inside a document notification. | |
229 * | |
230 * @param listener the listener to be removed | |
231 */ | |
232 void removeDocumentRewriteSessionListener(IDocumentRewriteSessionListener listener); | |
233 | |
234 /** | |
235 * Substitutes the given text for the specified document range. | |
236 * Sends a <code>DocumentEvent</code> to all registered <code>IDocumentListener</code>. | |
237 * | |
238 * @param offset the document offset | |
239 * @param length the length of the specified range | |
240 * @param text the substitution text | |
241 * @param modificationStamp of the document after replacing | |
242 * @exception BadLocationException if the offset is invalid in this document | |
243 * | |
244 * @see DocumentEvent | |
245 * @see IDocumentListener | |
246 */ | |
139
93a6ec48fd28
Regexp throws removal in interfaces
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
247 void replace(int offset, int length, String text, long modificationStamp) ; |
129 | 248 |
249 /** | |
250 * Replaces the content of the document with the given text. | |
251 * Sends a <code>DocumentEvent</code> to all registered <code>IDocumentListener</code>. | |
252 * This method is a convenience method for <code>replace(0, getLength(), text)</code>. | |
253 * | |
254 * @param text the new content of the document | |
255 * @param modificationStamp of the document after setting the content | |
256 * | |
257 * @see DocumentEvent | |
258 * @see IDocumentListener | |
259 */ | |
260 void set(String text, long modificationStamp); | |
261 | |
262 /** | |
263 * The unknown modification stamp. | |
264 */ | |
159 | 265 static const long UNKNOWN_MODIFICATION_STAMP= -1; |
129 | 266 |
267 /** | |
268 * Returns the modification stamp of this document. The modification stamp | |
269 * is updated each time a modifying operation is called on this document. If | |
270 * two modification stamps of the same document are identical then the document | |
271 * content is too, however, same content does not imply same modification stamp. | |
272 * <p> | |
273 * The magnitude or sign of the numerical difference between two modification stamps | |
274 * is not significant. | |
275 * </p> | |
276 * | |
277 * @return the modification stamp of this document or <code>UNKNOWN_MODIFICATION_STAMP</code> | |
278 */ | |
279 long getModificationStamp(); | |
159 | 280 |
129 | 281 /** |
282 * Returns this document's default line delimiter. | |
283 * <p> | |
284 * This default line delimiter should be used by clients who | |
159 | 285 * want unique delimiters (e.g. 'CR's) in the document.</p> |
129 | 286 * |
287 * @return the default line delimiter or <code>null</code> if none | |
288 */ | |
289 String getDefaultLineDelimiter(); | |
159 | 290 |
129 | 291 /** |
292 * Sets this document's initial line delimiter i.e. the one | |
293 * which is returned by <code>getDefaultLineDelimiter</code> | |
294 * if the document does not yet contain any line delimiter. | |
295 * | |
296 * @param lineDelimiter the default line delimiter | |
297 */ | |
298 void setInitialLineDelimiter(String lineDelimiter); | |
299 } |