129
|
1 /*******************************************************************************
|
|
2 * Copyright (c) 2000, 2008 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
|
|
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.IDocumentExtension4; // packageimport
|
|
62 import dwtx.jface.text.IDocumentExtension2; // packageimport
|
|
63 import dwtx.jface.text.IDocumentPartitionerExtension2; // packageimport
|
|
64 import dwtx.jface.text.Assert; // packageimport
|
|
65 import dwtx.jface.text.DefaultInformationControl; // packageimport
|
|
66 import dwtx.jface.text.IWidgetTokenOwnerExtension; // packageimport
|
|
67 import dwtx.jface.text.DocumentClone; // packageimport
|
|
68 import dwtx.jface.text.DefaultUndoManager; // packageimport
|
|
69 import dwtx.jface.text.IFindReplaceTarget; // packageimport
|
|
70 import dwtx.jface.text.IAutoEditStrategy; // packageimport
|
|
71 import dwtx.jface.text.ILineTrackerExtension; // packageimport
|
|
72 import dwtx.jface.text.IUndoManagerExtension; // packageimport
|
|
73 import dwtx.jface.text.TextSelection; // packageimport
|
|
74 import dwtx.jface.text.DefaultAutoIndentStrategy; // packageimport
|
|
75 import dwtx.jface.text.IAutoIndentStrategy; // packageimport
|
|
76 import dwtx.jface.text.IPainter; // packageimport
|
|
77 import dwtx.jface.text.IInformationControl; // packageimport
|
|
78 import dwtx.jface.text.IInformationControlExtension3; // packageimport
|
|
79 import dwtx.jface.text.ITextViewerExtension6; // packageimport
|
|
80 import dwtx.jface.text.IInformationControlExtension4; // packageimport
|
|
81 import dwtx.jface.text.DefaultLineTracker; // packageimport
|
|
82 import dwtx.jface.text.IDocumentInformationMappingExtension; // packageimport
|
|
83 import dwtx.jface.text.IRepairableDocumentExtension; // packageimport
|
|
84 import dwtx.jface.text.ITextHover; // packageimport
|
|
85 import dwtx.jface.text.FindReplaceDocumentAdapter; // packageimport
|
|
86 import dwtx.jface.text.ILineTracker; // packageimport
|
|
87 import dwtx.jface.text.Line; // packageimport
|
|
88 import dwtx.jface.text.ITextViewerExtension; // packageimport
|
|
89 import dwtx.jface.text.IDocumentAdapter; // packageimport
|
|
90 import dwtx.jface.text.TextEvent; // packageimport
|
|
91 import dwtx.jface.text.BadLocationException; // packageimport
|
|
92 import dwtx.jface.text.AbstractDocument; // packageimport
|
|
93 import dwtx.jface.text.AbstractLineTracker; // packageimport
|
|
94 import dwtx.jface.text.TreeLineTracker; // packageimport
|
|
95 import dwtx.jface.text.ITextPresentationListener; // packageimport
|
|
96 import dwtx.jface.text.Region; // packageimport
|
|
97 import dwtx.jface.text.ITextViewer; // packageimport
|
|
98 import dwtx.jface.text.IDocumentInformationMapping; // packageimport
|
|
99 import dwtx.jface.text.MarginPainter; // packageimport
|
|
100 import dwtx.jface.text.IPaintPositionManager; // packageimport
|
|
101 import dwtx.jface.text.TextPresentation; // packageimport
|
|
102 import dwtx.jface.text.IFindReplaceTargetExtension; // packageimport
|
|
103 import dwtx.jface.text.ISlaveDocumentManagerExtension; // packageimport
|
|
104 import dwtx.jface.text.ISelectionValidator; // packageimport
|
|
105 import dwtx.jface.text.IDocumentExtension; // packageimport
|
|
106 import dwtx.jface.text.PropagatingFontFieldEditor; // packageimport
|
|
107 import dwtx.jface.text.ConfigurableLineTracker; // packageimport
|
|
108 import dwtx.jface.text.SlaveDocumentEvent; // packageimport
|
|
109 import dwtx.jface.text.IDocumentListener; // packageimport
|
|
110 import dwtx.jface.text.PaintManager; // packageimport
|
|
111 import dwtx.jface.text.IFindReplaceTargetExtension3; // packageimport
|
|
112 import dwtx.jface.text.ITextDoubleClickStrategy; // packageimport
|
|
113 import dwtx.jface.text.IDocumentExtension3; // packageimport
|
|
114 import dwtx.jface.text.Position; // packageimport
|
|
115 import dwtx.jface.text.TextMessages; // packageimport
|
|
116 import dwtx.jface.text.CopyOnWriteTextStore; // packageimport
|
|
117 import dwtx.jface.text.WhitespaceCharacterPainter; // packageimport
|
|
118 import dwtx.jface.text.IPositionUpdater; // packageimport
|
|
119 import dwtx.jface.text.DefaultTextDoubleClickStrategy; // packageimport
|
|
120 import dwtx.jface.text.ListLineTracker; // packageimport
|
|
121 import dwtx.jface.text.ITextInputListener; // packageimport
|
|
122 import dwtx.jface.text.BadPositionCategoryException; // packageimport
|
|
123 import dwtx.jface.text.IWidgetTokenKeeperExtension; // packageimport
|
|
124 import dwtx.jface.text.IInputChangedListener; // packageimport
|
|
125 import dwtx.jface.text.ITextOperationTarget; // packageimport
|
|
126 import dwtx.jface.text.IDocumentInformationMappingExtension2; // packageimport
|
|
127 import dwtx.jface.text.ITextViewerExtension7; // packageimport
|
|
128 import dwtx.jface.text.IInformationControlExtension5; // packageimport
|
|
129 import dwtx.jface.text.IDocumentRewriteSessionListener; // packageimport
|
|
130 import dwtx.jface.text.JFaceTextUtil; // packageimport
|
|
131 import dwtx.jface.text.AbstractReusableInformationControlCreator; // packageimport
|
|
132 import dwtx.jface.text.TabsToSpacesConverter; // packageimport
|
|
133 import dwtx.jface.text.CursorLinePainter; // packageimport
|
|
134 import dwtx.jface.text.ITextHoverExtension; // packageimport
|
|
135 import dwtx.jface.text.IEventConsumer; // packageimport
|
|
136 import dwtx.jface.text.IDocument; // packageimport
|
|
137 import dwtx.jface.text.IWidgetTokenKeeper; // packageimport
|
|
138 import dwtx.jface.text.DocumentCommand; // packageimport
|
|
139 import dwtx.jface.text.TypedPosition; // packageimport
|
|
140 import dwtx.jface.text.IEditingSupportRegistry; // packageimport
|
|
141 import dwtx.jface.text.IDocumentPartitionerExtension; // packageimport
|
|
142 import dwtx.jface.text.AbstractHoverInformationControlManager; // packageimport
|
|
143 import dwtx.jface.text.IEditingSupport; // packageimport
|
|
144 import dwtx.jface.text.IMarkSelection; // packageimport
|
|
145 import dwtx.jface.text.ISlaveDocumentManager; // 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
|
129
|
156 module dwtx.jface.text.DocumentEvent;
|
|
157
|
|
158 import dwt.dwthelper.utils;
|
|
159
|
|
160 import dwtx.core.runtime.Assert;
|
|
161
|
|
162
|
|
163 /**
|
|
164 * Specification of changes applied to documents. All changes are represented as
|
|
165 * replace commands, i.e. specifying a document range whose text gets replaced
|
|
166 * with different text. In addition to this information, the event also contains
|
|
167 * the changed document.
|
|
168 *
|
|
169 * @see dwtx.jface.text.IDocument
|
|
170 */
|
|
171 public class DocumentEvent {
|
|
172
|
|
173 /**
|
|
174 * Debug option for asserting that text is not null.
|
|
175 * If the <code>dwtx.text/debug/DocumentEvent/assertTextNotNull</code>
|
|
176 * system property is <code>true</code>
|
|
177 *
|
|
178 * @since 3.3
|
|
179 */
|
|
180 private static final bool ASSERT_TEXT_NOT_NULL= Boolean.getBoolean("dwtx.text/debug/DocumentEvent/assertTextNotNull"); //$NON-NLS-1$
|
|
181
|
|
182 /** The changed document */
|
|
183 public IDocument fDocument;
|
|
184 /** The document offset */
|
|
185 public int fOffset;
|
|
186 /** Length of the replaced document text */
|
|
187 public int fLength;
|
|
188 /** Text inserted into the document */
|
|
189 public String fText= ""; //$NON-NLS-1$
|
|
190 /**
|
|
191 * The modification stamp of the document when firing this event.
|
|
192 * @since 3.1 and public since 3.3
|
|
193 */
|
|
194 public long fModificationStamp;
|
|
195
|
|
196 /**
|
|
197 * Creates a new document event.
|
|
198 *
|
|
199 * @param doc the changed document
|
|
200 * @param offset the offset of the replaced text
|
|
201 * @param length the length of the replaced text
|
|
202 * @param text the substitution text
|
|
203 */
|
|
204 public DocumentEvent(IDocument doc, int offset, int length, String text) {
|
|
205
|
|
206 Assert.isNotNull(doc);
|
|
207 Assert.isTrue(offset >= 0);
|
|
208 Assert.isTrue(length >= 0);
|
|
209
|
|
210 if (ASSERT_TEXT_NOT_NULL)
|
|
211 Assert.isNotNull(text);
|
|
212
|
|
213 fDocument= doc;
|
|
214 fOffset= offset;
|
|
215 fLength= length;
|
|
216 fText= text;
|
|
217
|
|
218 if (fDocument instanceof IDocumentExtension4)
|
|
219 fModificationStamp= ((IDocumentExtension4)fDocument).getModificationStamp();
|
|
220 else
|
|
221 fModificationStamp= IDocumentExtension4.UNKNOWN_MODIFICATION_STAMP;
|
|
222 }
|
|
223
|
|
224 /**
|
|
225 * Creates a new, not initialized document event.
|
|
226 */
|
|
227 public DocumentEvent() {
|
|
228 }
|
|
229
|
|
230 /**
|
|
231 * Returns the changed document.
|
|
232 *
|
|
233 * @return the changed document
|
|
234 */
|
|
235 public IDocument getDocument() {
|
|
236 return fDocument;
|
|
237 }
|
|
238
|
|
239 /**
|
|
240 * Returns the offset of the change.
|
|
241 *
|
|
242 * @return the offset of the change
|
|
243 */
|
|
244 public int getOffset() {
|
|
245 return fOffset;
|
|
246 }
|
|
247
|
|
248 /**
|
|
249 * Returns the length of the replaced text.
|
|
250 *
|
|
251 * @return the length of the replaced text
|
|
252 */
|
|
253 public int getLength() {
|
|
254 return fLength;
|
|
255 }
|
|
256
|
|
257 /**
|
|
258 * Returns the text that has been inserted.
|
|
259 *
|
|
260 * @return the text that has been inserted
|
|
261 */
|
|
262 public String getText() {
|
|
263 return fText;
|
|
264 }
|
|
265
|
|
266 /**
|
|
267 * Returns the document's modification stamp at the
|
|
268 * time when this event was sent.
|
|
269 *
|
|
270 * @return the modification stamp or {@link IDocumentExtension4#UNKNOWN_MODIFICATION_STAMP}.
|
|
271 * @see IDocumentExtension4#getModificationStamp()
|
|
272 * @since 3.1
|
|
273 */
|
|
274 public long getModificationStamp() {
|
|
275 return fModificationStamp;
|
|
276 }
|
|
277
|
|
278 /*
|
|
279 * @see java.lang.Object#toString()
|
|
280 * @since 3.4
|
|
281 */
|
|
282 public String toString() {
|
|
283 StringBuffer buffer= new StringBuffer();
|
|
284 buffer.append("offset: " ); //$NON-NLS-1$
|
|
285 buffer.append(fOffset);
|
|
286 buffer.append(", length: " ); //$NON-NLS-1$
|
|
287 buffer.append(fLength);
|
|
288 buffer.append(", timestamp: " ); //$NON-NLS-1$
|
|
289 buffer.append(fModificationStamp);
|
|
290 buffer.append("\ntext:>" ); //$NON-NLS-1$
|
|
291 buffer.append(fText);
|
|
292 buffer.append("<\n" ); //$NON-NLS-1$
|
|
293 return buffer.toString();
|
|
294 }
|
|
295 }
|