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