129
|
1 /*******************************************************************************
|
|
2 * Copyright (c) 2000, 2007 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.Document;
|
|
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.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 * Default document implementation. Uses a {@link dwtx.jface.text.GapTextStore} wrapped
|
|
162 * inside a {@link dwtx.jface.text.CopyOnWriteTextStore} as text store.
|
|
163 * <p>
|
|
164 * The used line tracker considers the following strings as line delimiters: "\n", "\r", "\r\n".
|
|
165 * </p>
|
|
166 * <p>
|
|
167 * The document is ready to use. It has a default position category for which a default position
|
|
168 * updater is installed.
|
|
169 * </p>
|
|
170 * <p>
|
|
171 * <strong>Performance:</strong> The implementation should perform reasonably well for typical
|
|
172 * source code documents. It is not designed for very large documents of a size of several
|
|
173 * megabytes. Space-saving implementations are initially used for both the text store and the line
|
|
174 * tracker; the first modification after a {@link #set(String) set} incurs the cost to transform the
|
|
175 * document structures to efficiently handle updates.
|
|
176 * </p>
|
|
177 * <p>
|
|
178 * See {@link GapTextStore} and <code>TreeLineTracker</code> for algorithmic behavior of the used
|
|
179 * document structures.
|
|
180 * </p>
|
|
181 *
|
|
182 * @see dwtx.jface.text.GapTextStore
|
|
183 * @see dwtx.jface.text.CopyOnWriteTextStore
|
|
184 */
|
|
185 public class Document : AbstractDocument {
|
|
186 /**
|
|
187 * Creates a new empty document.
|
|
188 */
|
|
189 public Document() {
|
|
190 super();
|
|
191 setTextStore(new CopyOnWriteTextStore(new GapTextStore()));
|
|
192 setLineTracker(new DefaultLineTracker());
|
|
193 completeInitialization();
|
|
194 }
|
|
195
|
|
196 /**
|
|
197 * Creates a new document with the given initial content.
|
|
198 *
|
|
199 * @param initialContent the document's initial content
|
|
200 */
|
|
201 public Document(String initialContent) {
|
|
202 super();
|
|
203 setTextStore(new CopyOnWriteTextStore(new GapTextStore()));
|
|
204 setLineTracker(new DefaultLineTracker());
|
|
205 getStore().set(initialContent);
|
|
206 getTracker().set(initialContent);
|
|
207 completeInitialization();
|
|
208 }
|
|
209
|
|
210 /*
|
|
211 * @see dwtx.jface.text.IRepairableDocumentExtension#isLineInformationRepairNeeded(int, int, java.lang.String)
|
|
212 * @since 3.4
|
|
213 */
|
|
214 public bool isLineInformationRepairNeeded(int offset, int length, String text) throws BadLocationException {
|
|
215 if ((0 > offset) || (0 > length) || (offset + length > getLength()))
|
|
216 throw new BadLocationException();
|
|
217
|
|
218 return isLineInformationRepairNeeded(text) || isLineInformationRepairNeeded(get(offset, length));
|
|
219 }
|
|
220
|
|
221 /**
|
|
222 * Checks whether the line information needs to be repaired.
|
|
223 *
|
|
224 * @param text the text to check
|
|
225 * @return <code>true</code> if the line information must be repaired
|
|
226 * @since 3.4
|
|
227 */
|
|
228 private bool isLineInformationRepairNeeded(String text) {
|
|
229 if (text is null)
|
|
230 return false;
|
|
231
|
|
232 int length= text.length();
|
|
233 if (length is 0)
|
|
234 return false;
|
|
235
|
|
236 int rIndex= text.indexOf('\r');
|
|
237 int nIndex= text.indexOf('\n');
|
|
238 if (rIndex is -1 && nIndex is -1)
|
|
239 return false;
|
|
240
|
|
241 if (rIndex > 0 && rIndex < length-1 && nIndex > 1 && rIndex < length-2)
|
|
242 return false;
|
|
243
|
|
244 String defaultLD= null;
|
|
245 try {
|
|
246 defaultLD= getLineDelimiter(0);
|
|
247 } catch (BadLocationException x) {
|
|
248 return true;
|
|
249 }
|
|
250
|
|
251 if (defaultLD is null)
|
|
252 return false;
|
|
253
|
|
254 defaultLD= getDefaultLineDelimiter();
|
|
255
|
|
256 if (defaultLD.length() is 1) {
|
|
257 if (rIndex !is -1 && !"\r".equals(defaultLD)) //$NON-NLS-1$
|
|
258 return true;
|
|
259 if (nIndex !is -1 && !"\n".equals(defaultLD)) //$NON-NLS-1$
|
|
260 return true;
|
|
261 } else if (defaultLD.length() is 2)
|
|
262 return rIndex is -1 || nIndex - rIndex !is 1;
|
|
263
|
|
264 return false;
|
|
265 }
|
|
266
|
|
267 }
|