ext/scintilla/src/Editor.h

   1 // Scintilla source code edit control
   2 /** @file Editor.h
   3  ** Defines the main editor class.
   4  **/
   5 // Copyright 1998-2003 by Neil Hodgson <neilh@scintilla.org>
   6 // The License.txt file describes the conditions under which this software may be distributed.
   7
   8 #ifndef EDITOR_H
   9 #define EDITOR_H
  10
  11 #ifdef SCI_NAMESPACE
  12 namespace Scintilla {
  13 #endif
  14
  15 /**
  16  */
  17 class Caret {
  18 public:
  19         bool active;
  20         bool on;
  21         int period;
  22
  23         Caret();
  24 };
  25
  26 /**
  27  */
  28 class Timer {
  29 public:
  30         bool ticking;
  31         int ticksToWait;
  32         enum {tickSize = 100};
  33         TickerID tickerID;
  34
  35         Timer();
  36 };
  37
  38 /**
  39  */
  40 class Idler {
  41 public:
  42         bool state;
  43         IdlerID idlerID;
  44
  45         Idler();
  46 };
  47
  48 /**
  49  * Hold a piece of text selected for copying or dragging.
  50  * The text is expected to hold a terminating '\0' and this is counted in len.
  51  */
  52 class SelectionText {
  53 public:
  54         char *s;
  55         int len;
  56         bool rectangular;
  57         bool lineCopy;
  58         int codePage;
  59         int characterSet;
  60         SelectionText() : s(0), len(0), rectangular(false), lineCopy(false), codePage(0), characterSet(0) {}
  61         ~SelectionText() {
  62                 Free();
  63         }
  64         void Free() {
  65                 Set(0, 0, 0, 0, false, false);
  66         }
  67         void Set(char *s_, int len_, int codePage_, int characterSet_, bool rectangular_, bool lineCopy_) {
  68                 delete []s;
  69                 s = s_;
  70                 if (s)
  71                         len = len_;
  72                 else
  73                         len = 0;
  74                 codePage = codePage_;
  75                 characterSet = characterSet_;
  76                 rectangular = rectangular_;
  77                 lineCopy = lineCopy_;
  78         }
  79         void Copy(const char *s_, int len_, int codePage_, int characterSet_, bool rectangular_, bool lineCopy_) {
  80                 delete []s;
  81                 s = new char[len_];
  82                 if (s) {
  83                         len = len_;
  84                         for (int i = 0; i < len_; i++) {
  85                                 s[i] = s_[i];
  86                         }
  87                 } else {
  88                         len = 0;
  89                 }
  90                 codePage = codePage_;
  91                 characterSet = characterSet_;
  92                 rectangular = rectangular_;
  93                 lineCopy = lineCopy_;
  94         }
  95         void Copy(const SelectionText &other) {
  96                 Copy(other.s, other.len, other.codePage, other.characterSet, other.rectangular, other.lineCopy);
  97         }
  98 };
  99
 100 /**
 101  */
 102 class Editor : public DocWatcher {
 103         // Private so Editor objects can not be copied
 104         Editor(const Editor &) : DocWatcher() {}
 105         Editor &operator=(const Editor &) { return *this; }
 106
 107 protected:      // ScintillaBase subclass needs access to much of Editor
 108
 109         /** On GTK+, Scintilla is a container widget holding two scroll bars
 110          * whereas on Windows there is just one window with both scroll bars turned on. */
 111         Window wMain;   ///< The Scintilla parent window
 112
 113         /** Style resources may be expensive to allocate so are cached between uses.
 114          * When a style attribute is changed, this cache is flushed. */
 115         bool stylesValid;
 116         ViewStyle vs;
 117         Palette palette;
 118
 119         int printMagnification;
 120         int printColourMode;
 121         int printWrapState;
 122         int cursorMode;
 123         int controlCharSymbol;
 124
 125         bool hasFocus;
 126         bool hideSelection;
 127         bool inOverstrike;
 128         int errorStatus;
 129         bool mouseDownCaptures;
 130
 131         /** In bufferedDraw mode, graphics operations are drawn to a pixmap and then copied to
 132          * the screen. This avoids flashing but is about 30% slower. */
 133         bool bufferedDraw;
 134         /** In twoPhaseDraw mode, drawing is performed in two phases, first the background
 135         * and then the foreground. This avoids chopping off characters that overlap the next run. */
 136         bool twoPhaseDraw;
 137
 138         int xOffset;            ///< Horizontal scrolled amount in pixels
 139         int xCaretMargin;       ///< Ensure this many pixels visible on both sides of caret
 140         bool horizontalScrollBarVisible;
 141         int scrollWidth;
 142         bool trackLineWidth;
 143         int lineWidthMaxSeen;
 144         bool verticalScrollBarVisible;
 145         bool endAtLastLine;
 146         bool caretSticky;
 147
 148         Surface *pixmapLine;
 149         Surface *pixmapSelMargin;
 150         Surface *pixmapSelPattern;
 151         Surface *pixmapIndentGuide;
 152         Surface *pixmapIndentGuideHighlight;
 153
 154         LineLayoutCache llc;
 155         PositionCache posCache;
 156
 157         KeyMap kmap;
 158
 159         Caret caret;
 160         Timer timer;
 161         Timer autoScrollTimer;
 162         enum { autoScrollDelay = 200 };
 163
 164         Idler idler;
 165
 166         Point lastClick;
 167         unsigned int lastClickTime;
 168         int dwellDelay;
 169         int ticksToDwell;
 170         bool dwelling;
 171         enum { selChar, selWord, selLine } selectionType;
 172         Point ptMouseLast;
 173         enum { ddNone, ddInitial, ddDragging } inDragDrop;
 174         bool dropWentOutside;
 175         int posDrag;
 176         int posDrop;
 177         int lastXChosen;
 178         int lineAnchor;
 179         int originalAnchorPos;
 180         int currentPos;
 181         int anchor;
 182         int targetStart;
 183         int targetEnd;
 184         int searchFlags;
 185         int topLine;
 186         int posTopLine;
 187         int lengthForEncode;
 188
 189         bool needUpdateUI;
 190         Position braces[2];
 191         int bracesMatchStyle;
 192         int highlightGuideColumn;
 193
 194         int theEdge;
 195
 196         enum { notPainting, painting, paintAbandoned } paintState;
 197         PRectangle rcPaint;
 198         bool paintingAllText;
 199
 200         int modEventMask;
 201
 202         SelectionText drag;
 203         enum selTypes { noSel, selStream, selRectangle, selLines };
 204         selTypes selType;
 205         bool moveExtendsSelection;
 206         int xStartSelect;       ///< x position of start of rectangular selection
 207         int xEndSelect;         ///< x position of end of rectangular selection
 208         bool primarySelection;
 209
 210         int caretXPolicy;
 211         int caretXSlop; ///< Ensure this many pixels visible on both sides of caret
 212
 213         int caretYPolicy;
 214         int caretYSlop; ///< Ensure this many lines visible on both sides of caret
 215
 216         int visiblePolicy;
 217         int visibleSlop;
 218
 219         int searchAnchor;
 220
 221         bool recordingMacro;
 222
 223         int foldFlags;
 224         ContractionState cs;
 225
 226         // Hotspot support
 227         int hsStart;
 228         int hsEnd;
 229
 230         // Wrapping support
 231         enum { eWrapNone, eWrapWord, eWrapChar } wrapState;
 232         enum { wrapLineLarge = 0x7ffffff };
 233         int wrapWidth;
 234         int wrapStart;
 235         int wrapEnd;
 236         int wrapVisualFlags;
 237         int wrapVisualFlagsLocation;
 238         int wrapVisualStartIndent;
 239         int actualWrapVisualStartIndent;
 240
 241         bool convertPastes;
 242
 243         Document *pdoc;
 244
 245         Editor();
 246         virtual ~Editor();
 247         virtual void Initialise() = 0;
 248         virtual void Finalise();
 249
 250         void InvalidateStyleData();
 251         void InvalidateStyleRedraw();
 252         virtual void RefreshColourPalette(Palette &pal, bool want);
 253         void RefreshStyleData();
 254         void DropGraphics();
 255
 256         virtual PRectangle GetClientRectangle();
 257         PRectangle GetTextRectangle();
 258
 259         int LinesOnScreen();
 260         int LinesToScroll();
 261         int MaxScrollPos();
 262         Point LocationFromPosition(int pos);
 263         int XFromPosition(int pos);
 264         int PositionFromLocation(Point pt);
 265         int PositionFromLocationClose(Point pt);
 266         int PositionFromLineX(int line, int x);
 267         int LineFromLocation(Point pt);
 268         void SetTopLine(int topLineNew);
 269
 270         bool AbandonPaint();
 271         void RedrawRect(PRectangle rc);
 272         void Redraw();
 273         void RedrawSelMargin(int line=-1);
 274         PRectangle RectangleFromRange(int start, int end);
 275         void InvalidateRange(int start, int end);
 276
 277         int CurrentPosition();
 278         bool SelectionEmpty();
 279         int SelectionStart();
 280         int SelectionEnd();
 281         void SetRectangularRange();
 282         void InvalidateSelection(int currentPos_, int anchor_, bool invalidateWholeSelection);
 283         void SetSelection(int currentPos_, int anchor_);
 284         void SetSelection(int currentPos_);
 285         void SetEmptySelection(int currentPos_);
 286         bool RangeContainsProtected(int start, int end) const;
 287         bool SelectionContainsProtected();
 288         int MovePositionOutsideChar(int pos, int moveDir, bool checkLineEnd=true);
 289         int MovePositionTo(int newPos, selTypes sel=noSel, bool ensureVisible=true);
 290         int MovePositionSoVisible(int pos, int moveDir);
 291         void SetLastXChosen();
 292
 293         void ScrollTo(int line, bool moveThumb=true);
 294         virtual void ScrollText(int linesToMove);
 295         void HorizontalScrollTo(int xPos);
 296         void MoveCaretInsideView(bool ensureVisible=true);
 297         int DisplayFromPosition(int pos);
 298         void EnsureCaretVisible(bool useMargin=true, bool vert=true, bool horiz=true);
 299         void ShowCaretAtCurrentPosition();
 300         void DropCaret();
 301         void InvalidateCaret();
 302         virtual void UpdateSystemCaret();
 303
 304         void NeedWrapping(int docLineStart = 0, int docLineEnd = wrapLineLarge);
 305         bool WrapOneLine(Surface *surface, int lineToWrap);
 306         bool WrapLines(bool fullWrap, int priorityWrapLineStart);
 307         void LinesJoin();
 308         void LinesSplit(int pixelWidth);
 309
 310         int SubstituteMarkerIfEmpty(int markerCheck, int markerDefault);
 311         void PaintSelMargin(Surface *surface, PRectangle &rc);
 312         LineLayout *RetrieveLineLayout(int lineNumber);
 313         void LayoutLine(int line, Surface *surface, ViewStyle &vstyle, LineLayout *ll,
 314                 int width=LineLayout::wrapWidthInfinite);
 315         ColourAllocated SelectionBackground(ViewStyle &vsDraw);
 316         ColourAllocated TextBackground(ViewStyle &vsDraw, bool overrideBackground, ColourAllocated background, bool inSelection, bool inHotspot, int styleMain, int i, LineLayout *ll);
 317         void DrawIndentGuide(Surface *surface, int lineVisible, int lineHeight, int start, PRectangle rcSegment, bool highlight);
 318         void DrawWrapMarker(Surface *surface, PRectangle rcPlace, bool isEndMarker, ColourAllocated wrapColour);
 319         void DrawEOL(Surface *surface, ViewStyle &vsDraw, PRectangle rcLine, LineLayout *ll,
 320                 int line, int lineEnd, int xStart, int subLine, int subLineStart,
 321                 bool overrideBackground, ColourAllocated background,
 322                 bool drawWrapMark, ColourAllocated wrapColour);
 323         void DrawIndicators(Surface *surface, ViewStyle &vsDraw, int line, int xStart,
 324                 PRectangle rcLine, LineLayout *ll, int subLine, int lineEnd, bool under);
 325         void DrawLine(Surface *surface, ViewStyle &vsDraw, int line, int lineVisible, int xStart,
 326                 PRectangle rcLine, LineLayout *ll, int subLine=0);
 327         void DrawBlockCaret(Surface *surface, ViewStyle &vsDraw, LineLayout *ll, int subLine, int xStart, int offset, int posCaret, PRectangle rcCaret);
 328         void RefreshPixMaps(Surface *surfaceWindow);
 329         void Paint(Surface *surfaceWindow, PRectangle rcArea);
 330         long FormatRange(bool draw, RangeToFormat *pfr);
 331         int TextWidth(int style, const char *text);
 332
 333         virtual void SetVerticalScrollPos() = 0;
 334         virtual void SetHorizontalScrollPos() = 0;
 335         virtual bool ModifyScrollBars(int nMax, int nPage) = 0;
 336         virtual void ReconfigureScrollBars();
 337         void SetScrollBars();
 338         void ChangeSize();
 339
 340         void AddChar(char ch);
 341         virtual void AddCharUTF(char *s, unsigned int len, bool treatAsDBCS=false);
 342         void ClearSelection();
 343         void ClearAll();
 344         void ClearDocumentStyle();
 345         void Cut();
 346         void PasteRectangular(int pos, const char *ptr, int len);
 347         virtual void Copy() = 0;
 348         virtual void CopyAllowLine();
 349         virtual bool CanPaste();
 350         virtual void Paste() = 0;
 351         void Clear();
 352         void SelectAll();
 353         void Undo();
 354         void Redo();
 355         void DelChar();
 356         void DelCharBack(bool allowLineStartDeletion);
 357         virtual void ClaimSelection() = 0;
 358
 359         virtual void NotifyChange() = 0;
 360         virtual void NotifyFocus(bool focus);
 361         virtual int GetCtrlID() { return ctrlID; }
 362         virtual void NotifyParent(SCNotification scn) = 0;
 363         virtual void NotifyParent(SCNotification * scn) = 0;
 364         virtual void NotifyStyleToNeeded(int endStyleNeeded);
 365         void NotifyChar(int ch);
 366         void NotifyMove(int position);
 367         void NotifySavePoint(bool isSavePoint);
 368         void NotifyModifyAttempt();
 369         virtual void NotifyDoubleClick(Point pt, bool shift, bool ctrl, bool alt);
 370         void NotifyHotSpotClicked(int position, bool shift, bool ctrl, bool alt);
 371         void NotifyHotSpotDoubleClicked(int position, bool shift, bool ctrl, bool alt);
 372         void NotifyUpdateUI();
 373         void NotifyPainted();
 374         void NotifyIndicatorClick(bool click, int position, bool shift, bool ctrl, bool alt);
 375         bool NotifyMarginClick(Point pt, bool shift, bool ctrl, bool alt);
 376         void NotifyNeedShown(int pos, int len);
 377         void NotifyDwelling(Point pt, bool state);
 378         void NotifyZoom();
 379
 380         void NotifyModifyAttempt(Document *document, void *userData);
 381         void NotifySavePoint(Document *document, void *userData, bool atSavePoint);
 382         void CheckModificationForWrap(DocModification mh);
 383         void NotifyModified(Document *document, DocModification mh, void *userData);
 384         void NotifyDeleted(Document *document, void *userData);
 385         void NotifyStyleNeeded(Document *doc, void *userData, int endPos);
 386         void NotifyMacroRecord(unsigned int iMessage, uptr_t wParam, sptr_t lParam);
 387
 388         void PageMove(int direction, selTypes sel=noSel, bool stuttered = false);
 389         void ChangeCaseOfSelection(bool makeUpperCase);
 390         void LineTranspose();
 391         void Duplicate(bool forLine);
 392         virtual void CancelModes();
 393         void NewLine();
 394         void CursorUpOrDown(int direction, selTypes sel=noSel);
 395         void ParaUpOrDown(int direction, selTypes sel=noSel);
 396         int StartEndDisplayLine(int pos, bool start);
 397         virtual int KeyCommand(unsigned int iMessage);
 398         virtual int KeyDefault(int /* key */, int /*modifiers*/);
 399         int KeyDown(int key, bool shift, bool ctrl, bool alt, bool *consumed=0);
 400
 401         int GetWhitespaceVisible();
 402         void SetWhitespaceVisible(int view);
 403
 404         void Indent(bool forwards);
 405
 406         long FindText(uptr_t wParam, sptr_t lParam);
 407         void SearchAnchor();
 408         long SearchText(unsigned int iMessage, uptr_t wParam, sptr_t lParam);
 409         long SearchInTarget(const char *text, int length);
 410         void GoToLine(int lineNo);
 411
 412         virtual void CopyToClipboard(const SelectionText &selectedText) = 0;
 413         char *CopyRange(int start, int end);
 414         void CopySelectionFromRange(SelectionText *ss, bool allowLineCopy, int start, int end);
 415         void CopySelectionRange(SelectionText *ss, bool allowLineCopy=false);
 416         void CopyRangeToClipboard(int start, int end);
 417         void CopyText(int length, const char *text);
 418         void SetDragPosition(int newPos);
 419         virtual void DisplayCursor(Window::Cursor c);
 420         virtual bool DragThreshold(Point ptStart, Point ptNow);
 421         virtual void StartDrag();
 422         void DropAt(int position, const char *value, bool moving, bool rectangular);
 423         /** PositionInSelection returns 0 if position in selection, -1 if position before selection, and 1 if after.
 424          * Before means either before any line of selection or before selection on its line, with a similar meaning to after. */
 425         int PositionInSelection(int pos);
 426         bool PointInSelection(Point pt);
 427         bool PointInSelMargin(Point pt);
 428         void LineSelection(int lineCurrent_, int lineAnchor_);
 429         void DwellEnd(bool mouseMoved);
 430         virtual void ButtonDown(Point pt, unsigned int curTime, bool shift, bool ctrl, bool alt);
 431         void ButtonMove(Point pt);
 432         void ButtonUp(Point pt, unsigned int curTime, bool ctrl);
 433
 434         void Tick();
 435         bool Idle();
 436         virtual void SetTicking(bool on) = 0;
 437         virtual bool SetIdle(bool) { return false; }
 438         virtual void SetMouseCapture(bool on) = 0;
 439         virtual bool HaveMouseCapture() = 0;
 440         void SetFocusState(bool focusState);
 441
 442         virtual bool PaintContains(PRectangle rc);
 443         bool PaintContainsMargin();
 444         void CheckForChangeOutsidePaint(Range r);
 445         void SetBraceHighlight(Position pos0, Position pos1, int matchStyle);
 446
 447         void SetDocPointer(Document *document);
 448
 449         void Expand(int &line, bool doExpand);
 450         void ToggleContraction(int line);
 451         void EnsureLineVisible(int lineDoc, bool enforcePolicy);
 452         int ReplaceTarget(bool replacePatterns, const char *text, int length=-1);
 453
 454         bool PositionIsHotspot(int position);
 455         bool PointIsHotspot(Point pt);
 456         void SetHotSpotRange(Point *pt);
 457         void GetHotSpotRange(int& hsStart, int& hsEnd);
 458
 459         int CodePage() const;
 460         virtual bool ValidCodePage(int /* codePage */) const { return true; }
 461         int WrapCount(int line);
 462         void AddStyledText(char *buffer, int appendLength);
 463
 464         virtual sptr_t DefWndProc(unsigned int iMessage, uptr_t wParam, sptr_t lParam) = 0;
 465         void StyleSetMessage(unsigned int iMessage, uptr_t wParam, sptr_t lParam);
 466         sptr_t StyleGetMessage(unsigned int iMessage, uptr_t wParam, sptr_t lParam);
 467
 468         static const char *StringFromEOLMode(int eolMode);
 469
 470 public:
 471         // Public so the COM thunks can access it.
 472         bool IsUnicodeMode() const;
 473         // Public so scintilla_send_message can use it.
 474         virtual sptr_t WndProc(unsigned int iMessage, uptr_t wParam, sptr_t lParam);
 475         // Public so scintilla_set_id can use it.
 476         int ctrlID;
 477         friend class AutoSurface;
 478         friend class SelectionLineIterator;
 479 };
 480
 481 /**
 482  * A smart pointer class to ensure Surfaces are set up and deleted correctly.
 483  */
 484 class AutoSurface {
 485 private:
 486         Surface *surf;
 487 public:
 488         AutoSurface(Editor *ed) : surf(0) {
 489                 if (ed->wMain.GetID()) {
 490                         surf = Surface::Allocate();
 491                         if (surf) {
 492                                 surf->Init(ed->wMain.GetID());
 493                                 surf->SetUnicodeMode(SC_CP_UTF8 == ed->CodePage());
 494                                 surf->SetDBCSMode(ed->CodePage());
 495                         }
 496                 }
 497         }
 498         AutoSurface(SurfaceID sid, Editor *ed) : surf(0) {
 499                 if (ed->wMain.GetID()) {
 500                         surf = Surface::Allocate();
 501                         if (surf) {
 502                                 surf->Init(sid, ed->wMain.GetID());
 503                                 surf->SetUnicodeMode(SC_CP_UTF8 == ed->CodePage());
 504                                 surf->SetDBCSMode(ed->CodePage());
 505                         }
 506                 }
 507         }
 508         ~AutoSurface() {
 509                 delete surf;
 510         }
 511         Surface *operator->() const {
 512                 return surf;
 513         }
 514         operator Surface *() const {
 515                 return surf;
 516         }
 517 };
 518
 519 #ifdef SCI_NAMESPACE
 520 }
 521 #endif
 522
 523 #endif