|
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
|
|
131
|
14
|
|
151
|
15 module dwtx.jface.text.ISlaveDocumentManager;
|
|
|
16
|
|
131
|
17 import dwtx.jface.text.IDocumentPartitioningListener; // packageimport
|
|
|
18 import dwtx.jface.text.DefaultTextHover; // packageimport
|
|
|
19 import dwtx.jface.text.AbstractInformationControl; // packageimport
|
|
|
20 import dwtx.jface.text.TextUtilities; // packageimport
|
|
|
21 import dwtx.jface.text.IInformationControlCreatorExtension; // packageimport
|
|
|
22 import dwtx.jface.text.AbstractInformationControlManager; // packageimport
|
|
|
23 import dwtx.jface.text.ITextViewerExtension2; // packageimport
|
|
|
24 import dwtx.jface.text.IDocumentPartitioner; // packageimport
|
|
|
25 import dwtx.jface.text.DefaultIndentLineAutoEditStrategy; // packageimport
|
|
|
26 import dwtx.jface.text.ITextSelection; // packageimport
|
|
|
27 import dwtx.jface.text.Document; // packageimport
|
|
|
28 import dwtx.jface.text.FindReplaceDocumentAdapterContentProposalProvider; // packageimport
|
|
|
29 import dwtx.jface.text.ITextListener; // packageimport
|
|
|
30 import dwtx.jface.text.BadPartitioningException; // packageimport
|
|
|
31 import dwtx.jface.text.ITextViewerExtension5; // packageimport
|
|
|
32 import dwtx.jface.text.IDocumentPartitionerExtension3; // packageimport
|
|
|
33 import dwtx.jface.text.IUndoManager; // packageimport
|
|
|
34 import dwtx.jface.text.ITextHoverExtension2; // packageimport
|
|
|
35 import dwtx.jface.text.IRepairableDocument; // packageimport
|
|
|
36 import dwtx.jface.text.IRewriteTarget; // packageimport
|
|
|
37 import dwtx.jface.text.DefaultPositionUpdater; // packageimport
|
|
|
38 import dwtx.jface.text.RewriteSessionEditProcessor; // packageimport
|
|
|
39 import dwtx.jface.text.TextViewerHoverManager; // packageimport
|
|
|
40 import dwtx.jface.text.DocumentRewriteSession; // packageimport
|
|
|
41 import dwtx.jface.text.TextViewer; // packageimport
|
|
|
42 import dwtx.jface.text.ITextViewerExtension8; // packageimport
|
|
|
43 import dwtx.jface.text.RegExMessages; // packageimport
|
|
|
44 import dwtx.jface.text.IDelayedInputChangeProvider; // packageimport
|
|
|
45 import dwtx.jface.text.ITextOperationTargetExtension; // packageimport
|
|
|
46 import dwtx.jface.text.IWidgetTokenOwner; // packageimport
|
|
|
47 import dwtx.jface.text.IViewportListener; // packageimport
|
|
|
48 import dwtx.jface.text.GapTextStore; // packageimport
|
|
|
49 import dwtx.jface.text.MarkSelection; // packageimport
|
|
|
50 import dwtx.jface.text.IDocumentPartitioningListenerExtension; // packageimport
|
|
|
51 import dwtx.jface.text.IDocumentAdapterExtension; // packageimport
|
|
|
52 import dwtx.jface.text.IInformationControlExtension; // packageimport
|
|
|
53 import dwtx.jface.text.IDocumentPartitioningListenerExtension2; // packageimport
|
|
|
54 import dwtx.jface.text.DefaultDocumentAdapter; // packageimport
|
|
|
55 import dwtx.jface.text.ITextViewerExtension3; // packageimport
|
|
|
56 import dwtx.jface.text.IInformationControlCreator; // packageimport
|
|
|
57 import dwtx.jface.text.TypedRegion; // packageimport
|
|
|
58 import dwtx.jface.text.ISynchronizable; // packageimport
|
|
|
59 import dwtx.jface.text.IMarkRegionTarget; // packageimport
|
|
|
60 import dwtx.jface.text.TextViewerUndoManager; // packageimport
|
|
|
61 import dwtx.jface.text.IRegion; // packageimport
|
|
|
62 import dwtx.jface.text.IInformationControlExtension2; // packageimport
|
|
|
63 import dwtx.jface.text.IDocumentExtension4; // packageimport
|
|
|
64 import dwtx.jface.text.IDocumentExtension2; // packageimport
|
|
|
65 import dwtx.jface.text.IDocumentPartitionerExtension2; // packageimport
|
|
|
66 import dwtx.jface.text.Assert; // packageimport
|
|
|
67 import dwtx.jface.text.DefaultInformationControl; // packageimport
|
|
|
68 import dwtx.jface.text.IWidgetTokenOwnerExtension; // packageimport
|
|
|
69 import dwtx.jface.text.DocumentClone; // packageimport
|
|
|
70 import dwtx.jface.text.DefaultUndoManager; // packageimport
|
|
|
71 import dwtx.jface.text.IFindReplaceTarget; // packageimport
|
|
|
72 import dwtx.jface.text.IAutoEditStrategy; // packageimport
|
|
|
73 import dwtx.jface.text.ILineTrackerExtension; // packageimport
|
|
|
74 import dwtx.jface.text.IUndoManagerExtension; // packageimport
|
|
|
75 import dwtx.jface.text.TextSelection; // packageimport
|
|
|
76 import dwtx.jface.text.DefaultAutoIndentStrategy; // packageimport
|
|
|
77 import dwtx.jface.text.IAutoIndentStrategy; // packageimport
|
|
|
78 import dwtx.jface.text.IPainter; // packageimport
|
|
|
79 import dwtx.jface.text.IInformationControl; // packageimport
|
|
|
80 import dwtx.jface.text.IInformationControlExtension3; // packageimport
|
|
|
81 import dwtx.jface.text.ITextViewerExtension6; // packageimport
|
|
|
82 import dwtx.jface.text.IInformationControlExtension4; // packageimport
|
|
|
83 import dwtx.jface.text.DefaultLineTracker; // packageimport
|
|
|
84 import dwtx.jface.text.IDocumentInformationMappingExtension; // packageimport
|
|
|
85 import dwtx.jface.text.IRepairableDocumentExtension; // packageimport
|
|
|
86 import dwtx.jface.text.ITextHover; // packageimport
|
|
|
87 import dwtx.jface.text.FindReplaceDocumentAdapter; // packageimport
|
|
|
88 import dwtx.jface.text.ILineTracker; // packageimport
|
|
|
89 import dwtx.jface.text.Line; // packageimport
|
|
|
90 import dwtx.jface.text.ITextViewerExtension; // packageimport
|
|
|
91 import dwtx.jface.text.IDocumentAdapter; // packageimport
|
|
|
92 import dwtx.jface.text.TextEvent; // packageimport
|
|
|
93 import dwtx.jface.text.BadLocationException; // packageimport
|
|
|
94 import dwtx.jface.text.AbstractDocument; // packageimport
|
|
|
95 import dwtx.jface.text.AbstractLineTracker; // packageimport
|
|
|
96 import dwtx.jface.text.TreeLineTracker; // packageimport
|
|
|
97 import dwtx.jface.text.ITextPresentationListener; // packageimport
|
|
|
98 import dwtx.jface.text.Region; // packageimport
|
|
|
99 import dwtx.jface.text.ITextViewer; // packageimport
|
|
|
100 import dwtx.jface.text.IDocumentInformationMapping; // packageimport
|
|
|
101 import dwtx.jface.text.MarginPainter; // packageimport
|
|
|
102 import dwtx.jface.text.IPaintPositionManager; // packageimport
|
|
|
103 import dwtx.jface.text.TextPresentation; // packageimport
|
|
|
104 import dwtx.jface.text.IFindReplaceTargetExtension; // packageimport
|
|
|
105 import dwtx.jface.text.ISlaveDocumentManagerExtension; // packageimport
|
|
|
106 import dwtx.jface.text.ISelectionValidator; // packageimport
|
|
|
107 import dwtx.jface.text.IDocumentExtension; // packageimport
|
|
|
108 import dwtx.jface.text.PropagatingFontFieldEditor; // packageimport
|
|
|
109 import dwtx.jface.text.ConfigurableLineTracker; // packageimport
|
|
|
110 import dwtx.jface.text.SlaveDocumentEvent; // packageimport
|
|
|
111 import dwtx.jface.text.IDocumentListener; // packageimport
|
|
|
112 import dwtx.jface.text.PaintManager; // packageimport
|
|
|
113 import dwtx.jface.text.IFindReplaceTargetExtension3; // packageimport
|
|
|
114 import dwtx.jface.text.ITextDoubleClickStrategy; // packageimport
|
|
|
115 import dwtx.jface.text.IDocumentExtension3; // packageimport
|
|
|
116 import dwtx.jface.text.Position; // packageimport
|
|
|
117 import dwtx.jface.text.TextMessages; // packageimport
|
|
|
118 import dwtx.jface.text.CopyOnWriteTextStore; // packageimport
|
|
|
119 import dwtx.jface.text.WhitespaceCharacterPainter; // packageimport
|
|
|
120 import dwtx.jface.text.IPositionUpdater; // packageimport
|
|
|
121 import dwtx.jface.text.DefaultTextDoubleClickStrategy; // packageimport
|
|
|
122 import dwtx.jface.text.ListLineTracker; // packageimport
|
|
|
123 import dwtx.jface.text.ITextInputListener; // packageimport
|
|
|
124 import dwtx.jface.text.BadPositionCategoryException; // packageimport
|
|
|
125 import dwtx.jface.text.IWidgetTokenKeeperExtension; // packageimport
|
|
|
126 import dwtx.jface.text.IInputChangedListener; // packageimport
|
|
|
127 import dwtx.jface.text.ITextOperationTarget; // packageimport
|
|
|
128 import dwtx.jface.text.IDocumentInformationMappingExtension2; // packageimport
|
|
|
129 import dwtx.jface.text.ITextViewerExtension7; // packageimport
|
|
|
130 import dwtx.jface.text.IInformationControlExtension5; // packageimport
|
|
|
131 import dwtx.jface.text.IDocumentRewriteSessionListener; // packageimport
|
|
|
132 import dwtx.jface.text.JFaceTextUtil; // packageimport
|
|
|
133 import dwtx.jface.text.AbstractReusableInformationControlCreator; // packageimport
|
|
|
134 import dwtx.jface.text.TabsToSpacesConverter; // packageimport
|
|
|
135 import dwtx.jface.text.CursorLinePainter; // packageimport
|
|
|
136 import dwtx.jface.text.ITextHoverExtension; // packageimport
|
|
|
137 import dwtx.jface.text.IEventConsumer; // packageimport
|
|
|
138 import dwtx.jface.text.IDocument; // packageimport
|
|
|
139 import dwtx.jface.text.IWidgetTokenKeeper; // packageimport
|
|
|
140 import dwtx.jface.text.DocumentCommand; // packageimport
|
|
|
141 import dwtx.jface.text.TypedPosition; // packageimport
|
|
|
142 import dwtx.jface.text.IEditingSupportRegistry; // packageimport
|
|
|
143 import dwtx.jface.text.IDocumentPartitionerExtension; // packageimport
|
|
|
144 import dwtx.jface.text.AbstractHoverInformationControlManager; // packageimport
|
|
|
145 import dwtx.jface.text.IEditingSupport; // packageimport
|
|
|
146 import dwtx.jface.text.IMarkSelection; // packageimport
|
|
|
147 import dwtx.jface.text.DocumentEvent; // packageimport
|
|
|
148 import dwtx.jface.text.DocumentPartitioningChangedEvent; // packageimport
|
|
|
149 import dwtx.jface.text.ITextStore; // packageimport
|
|
|
150 import dwtx.jface.text.JFaceTextMessages; // packageimport
|
|
|
151 import dwtx.jface.text.DocumentRewriteSessionEvent; // packageimport
|
|
|
152 import dwtx.jface.text.SequentialRewriteTextStore; // packageimport
|
|
|
153 import dwtx.jface.text.DocumentRewriteSessionType; // packageimport
|
|
|
154 import dwtx.jface.text.TextAttribute; // packageimport
|
|
|
155 import dwtx.jface.text.ITextViewerExtension4; // packageimport
|
|
|
156 import dwtx.jface.text.ITypedRegion; // packageimport
|
|
|
157
|
|
129
|
158 import dwt.dwthelper.utils;
|
|
|
159
|
|
|
160 /**
|
|
|
161 * Slave documents are documents whose contents is defined in terms of a master
|
|
|
162 * document. Thus, slave documents usually reflect a projection of the master document.
|
|
|
163 * Slave documents are causally connected to the master document. This means, changes
|
|
|
164 * of the master document have immediate effect on the slave document and vice versa.
|
|
|
165 * <p>
|
|
|
166 * A slave document manager creates slave documents for given master documents, manages the
|
|
|
167 * life cycle of the slave documents, and keeps track of the information flow between
|
|
|
168 * master and slave documents. The slave document manager defines the construction rules of the
|
|
|
169 * slave documents in terms of the master document.</p>
|
|
|
170 * <p>
|
|
|
171 * In order to provided backward compatibility for clients of <code>ISlaveDocumentManager</code>, extension
|
|
|
172 * interfaces are used to provide a means of evolution. The following extension interfaces
|
|
|
173 * exist:
|
|
|
174 * <ul>
|
|
|
175 * <li> {@link dwtx.jface.text.ISlaveDocumentManagerExtension} since version 3.0 extending the protocol
|
|
|
176 * with an access to all managed slave document for a given master document. </li>
|
|
|
177 * </ul>
|
|
|
178 * </p>
|
|
|
179 *
|
|
|
180 * @see dwtx.jface.text.IDocument
|
|
|
181 * @since 2.1
|
|
|
182 */
|
|
|
183 public interface ISlaveDocumentManager {
|
|
|
184
|
|
|
185 /**
|
|
|
186 * Creates a new slave document for the given master document. The slave document
|
|
|
187 * is causally connected to its master document until <code>freeSlaveDocument</code>
|
|
|
188 * is called. The connection between the newly created slave document and the master
|
|
|
189 * document is managed by this slave document manager.
|
|
|
190 *
|
|
|
191 * @param master the master document
|
|
|
192 * @return the newly created slave document
|
|
|
193 * @see #freeSlaveDocument(IDocument)
|
|
|
194 */
|
|
|
195 IDocument createSlaveDocument(IDocument master);
|
|
|
196
|
|
|
197 /**
|
|
|
198 * Frees the given slave document. If the given document is not a slave document known
|
|
|
199 * to this slave document manager, this call does not have any effect. A slave
|
|
|
200 * document is known to this slave document manager if it has been created by
|
|
|
201 * this manager using <code>createSlaveDocument</code>.
|
|
|
202 *
|
|
|
203 * @param slave the slave document to be freed
|
|
|
204 * @see #createSlaveDocument(IDocument)
|
|
|
205 */
|
|
|
206 void freeSlaveDocument(IDocument slave);
|
|
|
207
|
|
|
208 /**
|
|
|
209 * Creates a new document information mapping between the given slave document and
|
|
|
210 * its master document. Returns <code>null</code> if the given document is unknown
|
|
|
211 * to this slave document manager.
|
|
|
212 *
|
|
|
213 * @param slave the slave document
|
|
|
214 * @return a document information mapping between the slave document and its master document or
|
|
|
215 * <code>null</code>
|
|
|
216 */
|
|
|
217 IDocumentInformationMapping createMasterSlaveMapping(IDocument slave);
|
|
|
218
|
|
|
219 /**
|
|
|
220 * Returns the master document of the given slave document or <code>null</code> if the
|
|
|
221 * given document is unknown to this slave document manager.
|
|
|
222 *
|
|
|
223 * @param slave the slave document
|
|
|
224 * @return the master document of the given slave document or <code>null</code>
|
|
|
225 */
|
|
|
226 IDocument getMasterDocument(IDocument slave);
|
|
|
227
|
|
|
228 /**
|
|
|
229 * Returns whether the given document is a slave document known to this slave document manager. A slave document
|
|
|
230 * is known to this slave document manager, if the document has been created by this manager.
|
|
|
231 *
|
|
|
232 * @param document the document to be checked whether it is a slave document known to this manager
|
|
|
233 * @return <code>true</code> if the document is a slave document, <code>false</code> otherwise
|
|
|
234 */
|
|
|
235 bool isSlaveDocument(IDocument document);
|
|
|
236
|
|
|
237 /**
|
|
|
238 * Sets the given slave document's auto expand mode. In auto expand mode, a
|
|
|
239 * slave document is automatically adapted to reflect all changes applied to it's master document.
|
|
|
240 * Assume a master document contains 30 lines and the slave is defined to contain the lines 11-20.
|
|
|
241 * In auto expand mode, when the master document is changed at line 8, the slave document is expanded
|
|
|
242 * to contain the lines 8-20.<p>
|
|
|
243 * This call is without effect if the given document is unknown to this slave document manager.
|
|
|
244 *
|
|
|
245 * @param slave the slave whose auto expand mode should be set
|
|
|
246 * @param autoExpand <code>true</code> for auto expand, <code>false</code> otherwise
|
|
|
247 */
|
|
|
248 void setAutoExpandMode(IDocument slave, bool autoExpand);
|
|
|
249 }
|
