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.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
|
129
|
156 module dwtx.jface.text.CursorLinePainter;
|
|
157
|
|
158 import dwt.dwthelper.utils;
|
|
159
|
|
160
|
|
161
|
|
162
|
|
163 import dwt.custom.LineBackgroundEvent;
|
|
164 import dwt.custom.LineBackgroundListener;
|
|
165 import dwt.custom.StyledText;
|
|
166 import dwt.graphics.Color;
|
|
167 import dwt.graphics.Point;
|
|
168
|
|
169
|
|
170 /**
|
|
171 * A painter the draws the background of the caret line in a configured color.
|
|
172 * <p>
|
|
173 * Clients usually instantiate and configure object of this class.</p>
|
|
174 * <p>
|
|
175 * This class is not intended to be subclassed.</p>
|
|
176 *
|
|
177 * @since 2.1
|
|
178 * @noextend This class is not intended to be subclassed by clients.
|
|
179 */
|
|
180 public class CursorLinePainter : IPainter, LineBackgroundListener {
|
|
181
|
|
182 /** The viewer the painter works on */
|
|
183 private final ITextViewer fViewer;
|
|
184 /** The cursor line back ground color */
|
|
185 private Color fHighlightColor;
|
|
186 /** The paint position manager for managing the line coordinates */
|
|
187 private IPaintPositionManager fPositionManager;
|
|
188
|
|
189 /** Keeps track of the line to be painted */
|
|
190 private Position fCurrentLine= new Position(0, 0);
|
|
191 /** Keeps track of the line to be cleared */
|
|
192 private Position fLastLine= new Position(0, 0);
|
|
193 /** Keeps track of the line number of the last painted line */
|
|
194 private int fLastLineNumber= -1;
|
|
195 /** Indicates whether this painter is active */
|
|
196 private bool fIsActive;
|
|
197
|
|
198 /**
|
|
199 * Creates a new painter for the given source viewer.
|
|
200 *
|
|
201 * @param textViewer the source viewer for which to create a painter
|
|
202 */
|
|
203 public CursorLinePainter(ITextViewer textViewer) {
|
|
204 fViewer= textViewer;
|
|
205 }
|
|
206
|
|
207 /**
|
|
208 * Sets the color in which to draw the background of the cursor line.
|
|
209 *
|
|
210 * @param highlightColor the color in which to draw the background of the cursor line
|
|
211 */
|
|
212 public void setHighlightColor(Color highlightColor) {
|
|
213 fHighlightColor= highlightColor;
|
|
214 }
|
|
215
|
|
216 /*
|
|
217 * @see LineBackgroundListener#lineGetBackground(LineBackgroundEvent)
|
|
218 */
|
|
219 public void lineGetBackground(LineBackgroundEvent event) {
|
|
220 // don't use cached line information because of asynchronous painting
|
|
221
|
|
222 StyledText textWidget= fViewer.getTextWidget();
|
|
223 if (textWidget !is null) {
|
|
224
|
|
225 int caret= textWidget.getCaretOffset();
|
|
226 int length= event.lineText.length();
|
|
227
|
|
228 if (event.lineOffset <= caret && caret <= event.lineOffset + length)
|
|
229 event.lineBackground= fHighlightColor;
|
|
230 else
|
|
231 event.lineBackground= textWidget.getBackground();
|
|
232 }
|
|
233 }
|
|
234
|
|
235 /**
|
|
236 * Updates all the cached information about the lines to be painted and to be cleared. Returns <code>true</code>
|
|
237 * if the line number of the cursor line has changed.
|
|
238 *
|
|
239 * @return <code>true</code> if cursor line changed
|
|
240 */
|
|
241 private bool updateHighlightLine() {
|
|
242 try {
|
|
243
|
|
244 IDocument document= fViewer.getDocument();
|
|
245 int modelCaret= getModelCaret();
|
|
246 int lineNumber= document.getLineOfOffset(modelCaret);
|
|
247
|
|
248 // redraw if the current line number is different from the last line number we painted
|
|
249 // initially fLastLineNumber is -1
|
|
250 if (lineNumber !is fLastLineNumber || !fCurrentLine.overlapsWith(modelCaret, 0)) {
|
|
251
|
|
252 fLastLine.offset= fCurrentLine.offset;
|
|
253 fLastLine.length= fCurrentLine.length;
|
|
254 fLastLine.isDeleted= fCurrentLine.isDeleted;
|
|
255
|
|
256 if (fCurrentLine.isDeleted) {
|
|
257 fCurrentLine.isDeleted= false;
|
|
258 fPositionManager.managePosition(fCurrentLine);
|
|
259 }
|
|
260
|
|
261 fCurrentLine.offset= document.getLineOffset(lineNumber);
|
|
262 if (lineNumber is document.getNumberOfLines() - 1)
|
|
263 fCurrentLine.length= document.getLength() - fCurrentLine.offset;
|
|
264 else
|
|
265 fCurrentLine.length= document.getLineOffset(lineNumber + 1) - fCurrentLine.offset;
|
|
266
|
|
267 fLastLineNumber= lineNumber;
|
|
268 return true;
|
|
269
|
|
270 }
|
|
271
|
|
272 } catch (BadLocationException e) {
|
|
273 }
|
|
274
|
|
275 return false;
|
|
276 }
|
|
277
|
|
278 /**
|
|
279 * Returns the location of the caret as offset in the source viewer's
|
|
280 * input document.
|
|
281 *
|
|
282 * @return the caret location
|
|
283 */
|
|
284 private int getModelCaret() {
|
|
285 int widgetCaret= fViewer.getTextWidget().getCaretOffset();
|
|
286 if (fViewer instanceof ITextViewerExtension5) {
|
|
287 ITextViewerExtension5 extension= (ITextViewerExtension5) fViewer;
|
|
288 return extension.widgetOffset2ModelOffset(widgetCaret);
|
|
289 }
|
|
290 IRegion visible= fViewer.getVisibleRegion();
|
|
291 return widgetCaret + visible.getOffset();
|
|
292 }
|
|
293
|
|
294 /**
|
|
295 * Assumes the given position to specify offset and length of a line to be painted.
|
|
296 *
|
|
297 * @param position the specification of the line to be painted
|
|
298 */
|
|
299 private void drawHighlightLine(Position position) {
|
|
300
|
|
301 // if the position that is about to be drawn was deleted then we can't
|
|
302 if (position.isDeleted())
|
|
303 return;
|
|
304
|
|
305 int widgetOffset= 0;
|
|
306 if (fViewer instanceof ITextViewerExtension5) {
|
|
307
|
|
308 ITextViewerExtension5 extension= (ITextViewerExtension5) fViewer;
|
|
309 widgetOffset= extension.modelOffset2WidgetOffset(position.getOffset());
|
|
310 if (widgetOffset is -1)
|
|
311 return;
|
|
312
|
|
313 } else {
|
|
314
|
|
315 IRegion visible= fViewer.getVisibleRegion();
|
|
316 widgetOffset= position.getOffset() - visible.getOffset();
|
|
317 if (widgetOffset < 0 || visible.getLength() < widgetOffset )
|
|
318 return;
|
|
319 }
|
|
320
|
|
321 StyledText textWidget= fViewer.getTextWidget();
|
|
322 // check for https://bugs.eclipse.org/bugs/show_bug.cgi?id=64898
|
|
323 // this is a guard against the symptoms but not the actual solution
|
|
324 if (0 <= widgetOffset && widgetOffset <= textWidget.getCharCount()) {
|
|
325 Point upperLeft= textWidget.getLocationAtOffset(widgetOffset);
|
|
326 int width= textWidget.getClientArea().width + textWidget.getHorizontalPixel();
|
|
327 int height= textWidget.getLineHeight(widgetOffset);
|
|
328 textWidget.redraw(0, upperLeft.y, width, height, false);
|
|
329 }
|
|
330 }
|
|
331
|
|
332 /*
|
|
333 * @see IPainter#deactivate(bool)
|
|
334 */
|
|
335 public void deactivate(bool redraw) {
|
|
336 if (fIsActive) {
|
|
337 fIsActive= false;
|
|
338
|
|
339 /* on turning off the feature one has to paint the currently
|
|
340 * highlighted line with the standard background color
|
|
341 */
|
|
342 if (redraw)
|
|
343 drawHighlightLine(fCurrentLine);
|
|
344
|
|
345 fViewer.getTextWidget().removeLineBackgroundListener(this);
|
|
346
|
|
347 if (fPositionManager !is null)
|
|
348 fPositionManager.unmanagePosition(fCurrentLine);
|
|
349
|
|
350 fLastLineNumber= -1;
|
|
351 fCurrentLine.offset= 0;
|
|
352 fCurrentLine.length= 0;
|
|
353 }
|
|
354 }
|
|
355
|
|
356 /*
|
|
357 * @see IPainter#dispose()
|
|
358 */
|
|
359 public void dispose() {
|
|
360 }
|
|
361
|
|
362 /*
|
|
363 * @see IPainter#paint(int)
|
|
364 */
|
|
365 public void paint(int reason) {
|
|
366 if (fViewer.getDocument() is null) {
|
|
367 deactivate(false);
|
|
368 return;
|
|
369 }
|
|
370
|
|
371 StyledText textWidget= fViewer.getTextWidget();
|
|
372
|
|
373 // check selection
|
|
374 Point selection= textWidget.getSelection();
|
|
375 int startLine= textWidget.getLineAtOffset(selection.x);
|
|
376 int endLine= textWidget.getLineAtOffset(selection.y);
|
|
377 if (startLine !is endLine) {
|
|
378 deactivate(true);
|
|
379 return;
|
|
380 }
|
|
381
|
|
382 // initialization
|
|
383 if (!fIsActive) {
|
|
384 textWidget.addLineBackgroundListener(this);
|
|
385 fPositionManager.managePosition(fCurrentLine);
|
|
386 fIsActive= true;
|
|
387 }
|
|
388
|
|
389 //redraw line highlight only if it hasn't been drawn yet on the respective line
|
|
390 if (updateHighlightLine()) {
|
|
391 // clear last line
|
|
392 drawHighlightLine(fLastLine);
|
|
393 // draw new line
|
|
394 drawHighlightLine(fCurrentLine);
|
|
395 }
|
|
396 }
|
|
397
|
|
398 /*
|
|
399 * @see IPainter#setPositionManager(IPaintPositionManager)
|
|
400 */
|
|
401 public void setPositionManager(IPaintPositionManager manager) {
|
|
402 fPositionManager = manager;
|
|
403 }
|
|
404 }
|