1 // Scintilla source code edit control
3 ** Defines the main editor class.
5 // Copyright 1998-2011 by Neil Hodgson <neilh@scintilla.org>
6 // The License.txt file describes the conditions under which this software may be distributed.
21 enum {tickSize
= 100};
38 * When platform has a way to generate an event before painting,
39 * accumulate needed styling range and other work items in
40 * WorkNeeded to avoid unnecessary work inside paint handler
53 WorkNeeded() : active(false), items(workNone
), upTo(0) {}
59 void Need(workItems items_
, Position pos
) {
60 if ((items_
& workStyle
) && (upTo
< pos
))
62 items
= static_cast<workItems
>(items
| items_
);
67 * Hold a piece of text selected for copying or dragging, along with encoding and selection format information.
76 SelectionText() : rectangular(false), lineCopy(false), codePage(0), characterSet(0) {}
86 void Copy(const std::string
&s_
, int codePage_
, int characterSet_
, bool rectangular_
, bool lineCopy_
) {
89 characterSet
= characterSet_
;
90 rectangular
= rectangular_
;
92 FixSelectionForClipboard();
94 void Copy(const SelectionText
&other
) {
95 Copy(other
.s
, other
.codePage
, other
.characterSet
, other
.rectangular
, other
.lineCopy
);
97 const char *Data() const {
100 size_t Length() const {
103 size_t LengthWithTerminator() const {
104 return s
.length() + 1;
110 void FixSelectionForClipboard() {
111 // To avoid truncating the contents of the clipboard when pasted where the
112 // clipboard contains NUL characters, replace NUL characters by spaces.
113 std::replace(s
.begin(), s
.end(), '\0', ' ');
118 // The range of lines that need to be wrapped
119 enum { lineLarge
= 0x7ffffff };
120 int start
; // When there are wraps pending, will be in document range
121 int end
; // May be lineLarge to indicate all of document after start
130 void Wrapped(int line
) {
134 bool NeedsWrap() const {
137 bool AddRange(int lineStart
, int lineEnd
) {
138 const bool neededWrap
= NeedsWrap();
139 bool changed
= false;
140 if (start
> lineStart
) {
144 if ((end
< lineEnd
) || !neededWrap
) {
154 class Editor
: public EditModel
, public DocWatcher
{
155 // Private so Editor objects can not be copied
156 explicit Editor(const Editor
&);
157 Editor
&operator=(const Editor
&);
159 protected: // ScintillaBase subclass needs access to much of Editor
161 /** On GTK+, Scintilla is a container widget holding two scroll bars
162 * whereas on Windows there is just one window with both scroll bars turned on. */
163 Window wMain
; ///< The Scintilla parent window
164 Window wMargin
; ///< May be separate when using a scroll view for wMain
166 /** Style resources may be expensive to allocate so are cached between uses.
167 * When a style attribute is changed, this cache is flushed. */
172 float scaleRGBAImage
;
174 MarginView marginView
;
180 bool mouseDownCaptures
;
182 int xCaretMargin
; ///< Ensure this many pixels visible on both sides of caret
183 bool horizontalScrollBarVisible
;
185 bool verticalScrollBarVisible
;
189 bool mouseSelectionRectangularSwitch
;
190 bool multipleSelection
;
191 bool additionalSelectionTyping
;
194 int virtualSpaceOptions
;
199 Timer autoScrollTimer
;
200 enum { autoScrollDelay
= 200 };
205 unsigned int lastClickTime
;
206 Point doubleClickCloseThreshold
;
210 enum { selChar
, selWord
, selSubLine
, selWholeLine
} selectionType
;
212 enum { ddNone
, ddInitial
, ddDragging
} inDragDrop
;
213 bool dropWentOutside
;
214 SelectionPosition posDrop
;
218 int originalAnchorPos
;
219 int wordSelectAnchorStartPos
;
220 int wordSelectAnchorEndPos
;
221 int wordSelectInitialCaretPos
;
231 enum { notPainting
, painting
, paintAbandoned
} paintState
;
232 bool paintAbandonedByStyling
;
234 bool paintingAllText
;
236 WorkNeeded workNeeded
;
238 bool needIdleStyling
;
245 int caretXSlop
; ///< Ensure this many pixels visible on both sides of caret
248 int caretYSlop
; ///< Ensure this many lines visible on both sides of caret
260 WrapPending wrapPending
;
266 virtual void Initialise() = 0;
267 virtual void Finalise();
269 void InvalidateStyleData();
270 void InvalidateStyleRedraw();
271 void RefreshStyleData();
272 void SetRepresentations();
273 void DropGraphics(bool freeObjects
);
274 void AllocateGraphics();
276 // The top left visible point in main window coordinates. Will be 0,0 except for
277 // scroll views where it will be equivalent to the current scroll position.
278 virtual Point
GetVisibleOriginInMain() const;
279 Point
DocumentPointFromView(Point ptView
) const; // Convert a point from view space to document
280 int TopLineOfMain() const; // Return the line at Main's y coordinate 0
281 virtual PRectangle
GetClientRectangle() const;
282 virtual PRectangle
GetClientDrawingRectangle();
283 PRectangle
GetTextRectangle() const;
285 virtual int LinesOnScreen() const;
286 int LinesToScroll() const;
287 int MaxScrollPos() const;
288 SelectionPosition
ClampPositionIntoDocument(SelectionPosition sp
) const;
289 Point
LocationFromPosition(SelectionPosition pos
);
290 Point
LocationFromPosition(int pos
);
291 int XFromPosition(int pos
);
292 int XFromPosition(SelectionPosition sp
);
293 SelectionPosition
SPositionFromLocation(Point pt
, bool canReturnInvalid
=false, bool charPosition
=false, bool virtualSpace
=true);
294 int PositionFromLocation(Point pt
, bool canReturnInvalid
= false, bool charPosition
= false);
295 SelectionPosition
SPositionFromLineX(int lineDoc
, int x
);
296 int PositionFromLineX(int line
, int x
);
297 int LineFromLocation(Point pt
) const;
298 void SetTopLine(int topLineNew
);
300 virtual bool AbandonPaint();
301 virtual void RedrawRect(PRectangle rc
);
302 virtual void DiscardOverdraw();
303 virtual void Redraw();
304 void RedrawSelMargin(int line
=-1, bool allAfter
=false);
305 PRectangle
RectangleFromRange(Range r
, int overlap
);
306 void InvalidateRange(int start
, int end
);
308 bool UserVirtualSpace() const {
309 return ((virtualSpaceOptions
& SCVS_USERACCESSIBLE
) != 0);
311 int CurrentPosition() const;
312 bool SelectionEmpty() const;
313 SelectionPosition
SelectionStart();
314 SelectionPosition
SelectionEnd();
315 void SetRectangularRange();
316 void ThinRectangularRange();
317 void InvalidateSelection(SelectionRange newMain
, bool invalidateWholeSelection
=false);
318 void InvalidateWholeSelection();
319 void SetSelection(SelectionPosition currentPos_
, SelectionPosition anchor_
);
320 void SetSelection(int currentPos_
, int anchor_
);
321 void SetSelection(SelectionPosition currentPos_
);
322 void SetSelection(int currentPos_
);
323 void SetEmptySelection(SelectionPosition currentPos_
);
324 void SetEmptySelection(int currentPos_
);
325 enum AddNumber
{ addOne
, addEach
};
326 void MultipleSelectAdd(AddNumber addNumber
);
327 bool RangeContainsProtected(int start
, int end
) const;
328 bool SelectionContainsProtected();
329 int MovePositionOutsideChar(int pos
, int moveDir
, bool checkLineEnd
=true) const;
330 SelectionPosition
MovePositionOutsideChar(SelectionPosition pos
, int moveDir
, bool checkLineEnd
=true) const;
331 void MovedCaret(SelectionPosition newPos
, SelectionPosition previousPos
, bool ensureVisible
);
332 void MovePositionTo(SelectionPosition newPos
, Selection::selTypes selt
=Selection::noSel
, bool ensureVisible
=true);
333 void MovePositionTo(int newPos
, Selection::selTypes selt
=Selection::noSel
, bool ensureVisible
=true);
334 SelectionPosition
MovePositionSoVisible(SelectionPosition pos
, int moveDir
);
335 SelectionPosition
MovePositionSoVisible(int pos
, int moveDir
);
336 Point
PointMainCaret();
337 void SetLastXChosen();
339 void ScrollTo(int line
, bool moveThumb
=true);
340 virtual void ScrollText(int linesToMove
);
341 void HorizontalScrollTo(int xPos
);
342 void VerticalCentreCaret();
343 void MoveSelectedLines(int lineDelta
);
344 void MoveSelectedLinesUp();
345 void MoveSelectedLinesDown();
346 void MoveCaretInsideView(bool ensureVisible
=true);
347 int DisplayFromPosition(int pos
);
349 struct XYScrollPosition
{
352 XYScrollPosition(int xOffset_
, int topLine_
) : xOffset(xOffset_
), topLine(topLine_
) {}
353 bool operator==(const XYScrollPosition
&other
) const {
354 return (xOffset
== other
.xOffset
) && (topLine
== other
.topLine
);
357 enum XYScrollOptions
{
361 xysDefault
=xysUseMargin
|xysVertical
|xysHorizontal
};
362 XYScrollPosition
XYScrollToMakeVisible(const SelectionRange
&range
, const XYScrollOptions options
);
363 void SetXYScroll(XYScrollPosition newXY
);
364 void EnsureCaretVisible(bool useMargin
=true, bool vert
=true, bool horiz
=true);
365 void ScrollRange(SelectionRange range
);
366 void ShowCaretAtCurrentPosition();
368 void CaretSetPeriod(int period
);
369 void InvalidateCaret();
370 virtual void UpdateSystemCaret();
372 bool Wrapping() const;
373 void NeedWrapping(int docLineStart
=0, int docLineEnd
=WrapPending::lineLarge
);
374 bool WrapOneLine(Surface
*surface
, int lineToWrap
);
375 enum wrapScope
{wsAll
, wsVisible
, wsIdle
};
376 bool WrapLines(enum wrapScope ws
);
378 void LinesSplit(int pixelWidth
);
380 void PaintSelMargin(Surface
*surface
, PRectangle
&rc
);
381 void RefreshPixMaps(Surface
*surfaceWindow
);
382 void Paint(Surface
*surfaceWindow
, PRectangle rcArea
);
383 long FormatRange(bool draw
, Sci_RangeToFormat
*pfr
);
384 int TextWidth(int style
, const char *text
);
386 virtual void SetVerticalScrollPos() = 0;
387 virtual void SetHorizontalScrollPos() = 0;
388 virtual bool ModifyScrollBars(int nMax
, int nPage
) = 0;
389 virtual void ReconfigureScrollBars();
390 void SetScrollBars();
393 void FilterSelections();
394 int InsertSpace(int position
, unsigned int spaces
);
395 void AddChar(char ch
);
396 virtual void AddCharUTF(const char *s
, unsigned int len
, bool treatAsDBCS
=false);
397 void ClearBeforeTentativeStart();
398 void InsertPaste(const char *text
, int len
);
399 enum PasteShape
{ pasteStream
=0, pasteRectangular
= 1, pasteLine
= 2 };
400 void InsertPasteShape(const char *text
, int len
, PasteShape shape
);
401 void ClearSelection(bool retainMultipleSelections
= false);
403 void ClearDocumentStyle();
405 void PasteRectangular(SelectionPosition pos
, const char *ptr
, int len
);
406 virtual void Copy() = 0;
407 virtual void CopyAllowLine();
408 virtual bool CanPaste();
409 virtual void Paste() = 0;
414 void DelCharBack(bool allowLineStartDeletion
);
415 virtual void ClaimSelection() = 0;
417 static int ModifierFlags(bool shift
, bool ctrl
, bool alt
, bool meta
=false, bool super
=false);
418 virtual void NotifyChange() = 0;
419 virtual void NotifyFocus(bool focus
);
420 virtual void SetCtrlID(int identifier
);
421 virtual int GetCtrlID() { return ctrlID
; }
422 virtual void NotifyParent(SCNotification scn
) = 0;
423 virtual void NotifyStyleToNeeded(int endStyleNeeded
);
424 void NotifyChar(int ch
);
425 void NotifySavePoint(bool isSavePoint
);
426 void NotifyModifyAttempt();
427 virtual void NotifyDoubleClick(Point pt
, int modifiers
);
428 virtual void NotifyDoubleClick(Point pt
, bool shift
, bool ctrl
, bool alt
);
429 void NotifyHotSpotClicked(int position
, int modifiers
);
430 void NotifyHotSpotClicked(int position
, bool shift
, bool ctrl
, bool alt
);
431 void NotifyHotSpotDoubleClicked(int position
, int modifiers
);
432 void NotifyHotSpotDoubleClicked(int position
, bool shift
, bool ctrl
, bool alt
);
433 void NotifyHotSpotReleaseClick(int position
, int modifiers
);
434 void NotifyHotSpotReleaseClick(int position
, bool shift
, bool ctrl
, bool alt
);
435 bool NotifyUpdateUI();
436 void NotifyPainted();
437 void NotifyIndicatorClick(bool click
, int position
, int modifiers
);
438 void NotifyIndicatorClick(bool click
, int position
, bool shift
, bool ctrl
, bool alt
);
439 bool NotifyMarginClick(Point pt
, int modifiers
);
440 bool NotifyMarginClick(Point pt
, bool shift
, bool ctrl
, bool alt
);
441 void NotifyNeedShown(int pos
, int len
);
442 void NotifyDwelling(Point pt
, bool state
);
445 void NotifyModifyAttempt(Document
*document
, void *userData
);
446 void NotifySavePoint(Document
*document
, void *userData
, bool atSavePoint
);
447 void CheckModificationForWrap(DocModification mh
);
448 void NotifyModified(Document
*document
, DocModification mh
, void *userData
);
449 void NotifyDeleted(Document
*document
, void *userData
);
450 void NotifyStyleNeeded(Document
*doc
, void *userData
, int endPos
);
451 void NotifyLexerChanged(Document
*doc
, void *userData
);
452 void NotifyErrorOccurred(Document
*doc
, void *userData
, int status
);
453 void NotifyMacroRecord(unsigned int iMessage
, uptr_t wParam
, sptr_t lParam
);
455 void ContainerNeedsUpdate(int flags
);
456 void PageMove(int direction
, Selection::selTypes selt
=Selection::noSel
, bool stuttered
= false);
457 enum { cmSame
, cmUpper
, cmLower
};
458 virtual std::string
CaseMapString(const std::string
&s
, int caseMapping
);
459 void ChangeCaseOfSelection(int caseMapping
);
460 void LineTranspose();
461 void Duplicate(bool forLine
);
462 virtual void CancelModes();
464 SelectionPosition
PositionUpOrDown(SelectionPosition spStart
, int direction
, int lastX
);
465 void CursorUpOrDown(int direction
, Selection::selTypes selt
);
466 void ParaUpOrDown(int direction
, Selection::selTypes selt
);
467 int StartEndDisplayLine(int pos
, bool start
);
468 int VCHomeDisplayPosition(int position
);
469 int VCHomeWrapPosition(int position
);
470 int LineEndWrapPosition(int position
);
471 int HorizontalMove(unsigned int iMessage
);
472 int DelWordOrLine(unsigned int iMessage
);
473 virtual int KeyCommand(unsigned int iMessage
);
474 virtual int KeyDefault(int /* key */, int /*modifiers*/);
475 int KeyDownWithModifiers(int key
, int modifiers
, bool *consumed
);
476 int KeyDown(int key
, bool shift
, bool ctrl
, bool alt
, bool *consumed
=0);
478 void Indent(bool forwards
);
480 virtual CaseFolder
*CaseFolderForEncoding();
481 long FindText(uptr_t wParam
, sptr_t lParam
);
483 long SearchText(unsigned int iMessage
, uptr_t wParam
, sptr_t lParam
);
484 long SearchInTarget(const char *text
, int length
);
485 void GoToLine(int lineNo
);
487 virtual void CopyToClipboard(const SelectionText
&selectedText
) = 0;
488 std::string
RangeText(int start
, int end
) const;
489 void CopySelectionRange(SelectionText
*ss
, bool allowLineCopy
=false);
490 void CopyRangeToClipboard(int start
, int end
);
491 void CopyText(int length
, const char *text
);
492 void SetDragPosition(SelectionPosition newPos
);
493 virtual void DisplayCursor(Window::Cursor c
);
494 virtual bool DragThreshold(Point ptStart
, Point ptNow
);
495 virtual void StartDrag();
496 void DropAt(SelectionPosition position
, const char *value
, size_t lengthValue
, bool moving
, bool rectangular
);
497 void DropAt(SelectionPosition position
, const char *value
, bool moving
, bool rectangular
);
498 /** PositionInSelection returns true if position in selection. */
499 bool PositionInSelection(int pos
);
500 bool PointInSelection(Point pt
);
501 bool PointInSelMargin(Point pt
) const;
502 Window::Cursor
GetMarginCursor(Point pt
) const;
503 void TrimAndSetSelection(int currentPos_
, int anchor_
);
504 void LineSelection(int lineCurrentPos_
, int lineAnchorPos_
, bool wholeLine
);
505 void WordSelection(int pos
);
506 void DwellEnd(bool mouseMoved
);
508 virtual void ButtonDownWithModifiers(Point pt
, unsigned int curTime
, int modifiers
);
509 virtual void ButtonDown(Point pt
, unsigned int curTime
, bool shift
, bool ctrl
, bool alt
);
510 void ButtonMoveWithModifiers(Point pt
, int modifiers
);
511 void ButtonMove(Point pt
);
512 void ButtonUp(Point pt
, unsigned int curTime
, bool ctrl
);
516 virtual void SetTicking(bool on
);
517 enum TickReason
{ tickCaret
, tickScroll
, tickWiden
, tickDwell
, tickPlatform
};
518 virtual void TickFor(TickReason reason
);
519 virtual bool FineTickerAvailable();
520 virtual bool FineTickerRunning(TickReason reason
);
521 virtual void FineTickerStart(TickReason reason
, int millis
, int tolerance
);
522 virtual void FineTickerCancel(TickReason reason
);
523 virtual bool SetIdle(bool) { return false; }
524 virtual void SetMouseCapture(bool on
) = 0;
525 virtual bool HaveMouseCapture() = 0;
526 void SetFocusState(bool focusState
);
528 int PositionAfterArea(PRectangle rcArea
) const;
529 void StyleToPositionInView(Position pos
);
530 int PositionAfterMaxStyling(int posMax
, bool scrolling
) const;
531 void StartIdleStyling(bool truncatedLastStyling
);
532 void StyleAreaBounded(PRectangle rcArea
, bool scrolling
);
534 virtual void IdleWork();
535 virtual void QueueIdleWork(WorkNeeded::workItems items
, int upTo
=0);
537 virtual bool PaintContains(PRectangle rc
);
538 bool PaintContainsMargin();
539 void CheckForChangeOutsidePaint(Range r
);
540 void SetBraceHighlight(Position pos0
, Position pos1
, int matchStyle
);
542 void SetAnnotationHeights(int start
, int end
);
543 virtual void SetDocPointer(Document
*document
);
545 void SetAnnotationVisible(int visible
);
547 int ExpandLine(int line
);
548 void SetFoldExpanded(int lineDoc
, bool expanded
);
549 void FoldLine(int line
, int action
);
550 void FoldExpand(int line
, int action
, int level
);
551 int ContractedFoldNext(int lineStart
) const;
552 void EnsureLineVisible(int lineDoc
, bool enforcePolicy
);
553 void FoldChanged(int line
, int levelNow
, int levelPrev
);
554 void NeedShown(int pos
, int len
);
555 void FoldAll(int action
);
557 int GetTag(char *tagValue
, int tagNumber
);
558 int ReplaceTarget(bool replacePatterns
, const char *text
, int length
=-1);
560 bool PositionIsHotspot(int position
) const;
561 bool PointIsHotspot(Point pt
);
562 void SetHotSpotRange(Point
*pt
);
563 Range
GetHotSpotRange() const;
564 void SetHoverIndicatorPosition(int position
);
565 void SetHoverIndicatorPoint(Point pt
);
567 int CodePage() const;
568 virtual bool ValidCodePage(int /* codePage */) const { return true; }
569 int WrapCount(int line
);
570 void AddStyledText(char *buffer
, int appendLength
);
572 virtual sptr_t
DefWndProc(unsigned int iMessage
, uptr_t wParam
, sptr_t lParam
) = 0;
573 void StyleSetMessage(unsigned int iMessage
, uptr_t wParam
, sptr_t lParam
);
574 sptr_t
StyleGetMessage(unsigned int iMessage
, uptr_t wParam
, sptr_t lParam
);
576 static const char *StringFromEOLMode(int eolMode
);
578 static sptr_t
StringResult(sptr_t lParam
, const char *val
);
579 static sptr_t
BytesResult(sptr_t lParam
, const unsigned char *val
, size_t len
);
582 // Public so the COM thunks can access it.
583 bool IsUnicodeMode() const;
584 // Public so scintilla_send_message can use it.
585 virtual sptr_t
WndProc(unsigned int iMessage
, uptr_t wParam
, sptr_t lParam
);
586 // Public so scintilla_set_id can use it.
588 // Public so COM methods for drag and drop can set it.
590 friend class AutoSurface
;
591 friend class SelectionLineIterator
;
595 * A smart pointer class to ensure Surfaces are set up and deleted correctly.
601 AutoSurface(Editor
*ed
, int technology
= -1) : surf(0) {
602 if (ed
->wMain
.GetID()) {
603 surf
= Surface::Allocate(technology
!= -1 ? technology
: ed
->technology
);
605 surf
->Init(ed
->wMain
.GetID());
606 surf
->SetUnicodeMode(SC_CP_UTF8
== ed
->CodePage());
607 surf
->SetDBCSMode(ed
->CodePage());
611 AutoSurface(SurfaceID sid
, Editor
*ed
, int technology
= -1) : surf(0) {
612 if (ed
->wMain
.GetID()) {
613 surf
= Surface::Allocate(technology
!= -1 ? technology
: ed
->technology
);
615 surf
->Init(sid
, ed
->wMain
.GetID());
616 surf
->SetUnicodeMode(SC_CP_UTF8
== ed
->CodePage());
617 surf
->SetDBCSMode(ed
->CodePage());
624 Surface
*operator->() const {
627 operator Surface
*() const {