Mercurial > projects > dwt-addons
annotate dwtx/jface/text/CursorLinePainter.d @ 162:1a5b8f8129df
...
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Mon, 08 Sep 2008 00:51:37 +0200 |
parents | eb21d3dfc767 |
children |
rev | line source |
---|---|
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 |
151 | 15 module dwtx.jface.text.CursorLinePainter; |
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.ITextHoverExtension; // packageimport | |
136 import dwtx.jface.text.IEventConsumer; // packageimport | |
137 import dwtx.jface.text.IDocument; // packageimport | |
138 import dwtx.jface.text.IWidgetTokenKeeper; // packageimport | |
139 import dwtx.jface.text.DocumentCommand; // packageimport | |
140 import dwtx.jface.text.TypedPosition; // packageimport | |
141 import dwtx.jface.text.IEditingSupportRegistry; // packageimport | |
142 import dwtx.jface.text.IDocumentPartitionerExtension; // packageimport | |
143 import dwtx.jface.text.AbstractHoverInformationControlManager; // packageimport | |
144 import dwtx.jface.text.IEditingSupport; // packageimport | |
145 import dwtx.jface.text.IMarkSelection; // packageimport | |
146 import dwtx.jface.text.ISlaveDocumentManager; // 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 | |
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 */ | |
146 | 183 private const ITextViewer fViewer; |
129 | 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 */ | |
162 | 190 private Position fCurrentLine; |
129 | 191 /** Keeps track of the line to be cleared */ |
162 | 192 private Position fLastLine; |
129 | 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 */ | |
133
7d818bd32d63
Fix ctors to this with gvim regexp
Frank Benoit <benoit@tionex.de>
parents:
131
diff
changeset
|
203 public this(ITextViewer textViewer) { |
162 | 204 fCurrentLine= new Position(0, 0); |
205 fLastLine= new Position(0, 0); | |
129 | 206 fViewer= textViewer; |
207 } | |
208 | |
209 /** | |
210 * Sets the color in which to draw the background of the cursor line. | |
211 * | |
212 * @param highlightColor the color in which to draw the background of the cursor line | |
213 */ | |
214 public void setHighlightColor(Color highlightColor) { | |
215 fHighlightColor= highlightColor; | |
216 } | |
217 | |
218 /* | |
219 * @see LineBackgroundListener#lineGetBackground(LineBackgroundEvent) | |
220 */ | |
221 public void lineGetBackground(LineBackgroundEvent event) { | |
222 // don't use cached line information because of asynchronous painting | |
223 | |
224 StyledText textWidget= fViewer.getTextWidget(); | |
225 if (textWidget !is null) { | |
226 | |
227 int caret= textWidget.getCaretOffset(); | |
228 int length= event.lineText.length(); | |
229 | |
230 if (event.lineOffset <= caret && caret <= event.lineOffset + length) | |
231 event.lineBackground= fHighlightColor; | |
232 else | |
233 event.lineBackground= textWidget.getBackground(); | |
234 } | |
235 } | |
236 | |
237 /** | |
238 * Updates all the cached information about the lines to be painted and to be cleared. Returns <code>true</code> | |
239 * if the line number of the cursor line has changed. | |
240 * | |
241 * @return <code>true</code> if cursor line changed | |
242 */ | |
243 private bool updateHighlightLine() { | |
244 try { | |
245 | |
246 IDocument document= fViewer.getDocument(); | |
247 int modelCaret= getModelCaret(); | |
248 int lineNumber= document.getLineOfOffset(modelCaret); | |
249 | |
250 // redraw if the current line number is different from the last line number we painted | |
251 // initially fLastLineNumber is -1 | |
252 if (lineNumber !is fLastLineNumber || !fCurrentLine.overlapsWith(modelCaret, 0)) { | |
253 | |
254 fLastLine.offset= fCurrentLine.offset; | |
255 fLastLine.length= fCurrentLine.length; | |
162 | 256 fLastLine.isDeleted_= fCurrentLine.isDeleted_; |
129 | 257 |
162 | 258 if (fCurrentLine.isDeleted_) { |
259 fCurrentLine.isDeleted_= false; | |
129 | 260 fPositionManager.managePosition(fCurrentLine); |
261 } | |
262 | |
263 fCurrentLine.offset= document.getLineOffset(lineNumber); | |
264 if (lineNumber is document.getNumberOfLines() - 1) | |
265 fCurrentLine.length= document.getLength() - fCurrentLine.offset; | |
266 else | |
267 fCurrentLine.length= document.getLineOffset(lineNumber + 1) - fCurrentLine.offset; | |
268 | |
269 fLastLineNumber= lineNumber; | |
270 return true; | |
271 | |
272 } | |
273 | |
274 } catch (BadLocationException e) { | |
275 } | |
276 | |
277 return false; | |
278 } | |
279 | |
280 /** | |
281 * Returns the location of the caret as offset in the source viewer's | |
282 * input document. | |
283 * | |
284 * @return the caret location | |
285 */ | |
286 private int getModelCaret() { | |
287 int widgetCaret= fViewer.getTextWidget().getCaretOffset(); | |
138 | 288 if ( cast(ITextViewerExtension5)fViewer ) { |
134 | 289 ITextViewerExtension5 extension= cast(ITextViewerExtension5) fViewer; |
129 | 290 return extension.widgetOffset2ModelOffset(widgetCaret); |
291 } | |
292 IRegion visible= fViewer.getVisibleRegion(); | |
293 return widgetCaret + visible.getOffset(); | |
294 } | |
295 | |
296 /** | |
297 * Assumes the given position to specify offset and length of a line to be painted. | |
298 * | |
299 * @param position the specification of the line to be painted | |
300 */ | |
301 private void drawHighlightLine(Position position) { | |
302 | |
303 // if the position that is about to be drawn was deleted then we can't | |
304 if (position.isDeleted()) | |
305 return; | |
306 | |
307 int widgetOffset= 0; | |
138 | 308 if ( cast(ITextViewerExtension5)fViewer ) { |
129 | 309 |
134 | 310 ITextViewerExtension5 extension= cast(ITextViewerExtension5) fViewer; |
129 | 311 widgetOffset= extension.modelOffset2WidgetOffset(position.getOffset()); |
312 if (widgetOffset is -1) | |
313 return; | |
314 | |
315 } else { | |
316 | |
317 IRegion visible= fViewer.getVisibleRegion(); | |
318 widgetOffset= position.getOffset() - visible.getOffset(); | |
319 if (widgetOffset < 0 || visible.getLength() < widgetOffset ) | |
320 return; | |
321 } | |
322 | |
323 StyledText textWidget= fViewer.getTextWidget(); | |
324 // check for https://bugs.eclipse.org/bugs/show_bug.cgi?id=64898 | |
325 // this is a guard against the symptoms but not the actual solution | |
326 if (0 <= widgetOffset && widgetOffset <= textWidget.getCharCount()) { | |
327 Point upperLeft= textWidget.getLocationAtOffset(widgetOffset); | |
328 int width= textWidget.getClientArea().width + textWidget.getHorizontalPixel(); | |
329 int height= textWidget.getLineHeight(widgetOffset); | |
330 textWidget.redraw(0, upperLeft.y, width, height, false); | |
331 } | |
332 } | |
333 | |
334 /* | |
335 * @see IPainter#deactivate(bool) | |
336 */ | |
337 public void deactivate(bool redraw) { | |
338 if (fIsActive) { | |
339 fIsActive= false; | |
340 | |
341 /* on turning off the feature one has to paint the currently | |
342 * highlighted line with the standard background color | |
343 */ | |
344 if (redraw) | |
345 drawHighlightLine(fCurrentLine); | |
346 | |
347 fViewer.getTextWidget().removeLineBackgroundListener(this); | |
348 | |
349 if (fPositionManager !is null) | |
350 fPositionManager.unmanagePosition(fCurrentLine); | |
351 | |
352 fLastLineNumber= -1; | |
353 fCurrentLine.offset= 0; | |
354 fCurrentLine.length= 0; | |
355 } | |
356 } | |
357 | |
358 /* | |
359 * @see IPainter#dispose() | |
360 */ | |
361 public void dispose() { | |
362 } | |
363 | |
364 /* | |
365 * @see IPainter#paint(int) | |
366 */ | |
367 public void paint(int reason) { | |
368 if (fViewer.getDocument() is null) { | |
369 deactivate(false); | |
370 return; | |
371 } | |
372 | |
373 StyledText textWidget= fViewer.getTextWidget(); | |
374 | |
375 // check selection | |
376 Point selection= textWidget.getSelection(); | |
377 int startLine= textWidget.getLineAtOffset(selection.x); | |
378 int endLine= textWidget.getLineAtOffset(selection.y); | |
379 if (startLine !is endLine) { | |
380 deactivate(true); | |
381 return; | |
382 } | |
383 | |
384 // initialization | |
385 if (!fIsActive) { | |
386 textWidget.addLineBackgroundListener(this); | |
387 fPositionManager.managePosition(fCurrentLine); | |
388 fIsActive= true; | |
389 } | |
390 | |
391 //redraw line highlight only if it hasn't been drawn yet on the respective line | |
392 if (updateHighlightLine()) { | |
393 // clear last line | |
394 drawHighlightLine(fLastLine); | |
395 // draw new line | |
396 drawHighlightLine(fCurrentLine); | |
397 } | |
398 } | |
399 | |
400 /* | |
401 * @see IPainter#setPositionManager(IPaintPositionManager) | |
402 */ | |
403 public void setPositionManager(IPaintPositionManager manager) { | |
404 fPositionManager = manager; | |
405 } | |
406 } |