scintilla/src/PerLine.h

   1 // Scintilla source code edit control
   2 /** @file PerLine.h
   3  ** Manages data associated with each line of the document
   4  **/
   5 // Copyright 1998-2009 by Neil Hodgson <neilh@scintilla.org>
   6 // The License.txt file describes the conditions under which this software may be distributed.
   7
   8 #ifndef PERLINE_H
   9 #define PERLINE_H
  10
  11 namespace Scintilla::Internal {
  12
  13 /**
  14  * This holds the marker identifier and the marker type to display.
  15  * MarkerHandleNumbers are members of lists.
  16  */
  17 struct MarkerHandleNumber {
  18         int handle;
  19         int number;
  20         MarkerHandleNumber(int handle_, int number_) noexcept : handle(handle_), number(number_) {}
  21 };
  22
  23 /**
  24  * A marker handle set contains any number of MarkerHandleNumbers.
  25  */
  26 class MarkerHandleSet {
  27         std::forward_list<MarkerHandleNumber> mhList;
  28
  29 public:
  30         MarkerHandleSet();
  31         bool Empty() const noexcept;
  32         int MarkValue() const noexcept; ///< Bit set of marker numbers.
  33         bool Contains(int handle) const noexcept;
  34         bool InsertHandle(int handle, int markerNum);
  35         void RemoveHandle(int handle);
  36         bool RemoveNumber(int markerNum, bool all);
  37         void CombineWith(MarkerHandleSet *other) noexcept;
  38         MarkerHandleNumber const *GetMarkerHandleNumber(int which) const noexcept;
  39 };
  40
  41 class LineMarkers : public PerLine {
  42         SplitVector<std::unique_ptr<MarkerHandleSet>> markers;
  43         /// Handles are allocated sequentially and should never have to be reused as 32 bit ints are very big.
  44         int handleCurrent;
  45 public:
  46         LineMarkers() : handleCurrent(0) {
  47         }
  48         void Init() override;
  49         void InsertLine(Sci::Line line) override;
  50         void InsertLines(Sci::Line line, Sci::Line lines) override;
  51         void RemoveLine(Sci::Line line) override;
  52
  53         int MarkValue(Sci::Line line) const noexcept;
  54         Sci::Line MarkerNext(Sci::Line lineStart, int mask) const noexcept;
  55         int AddMark(Sci::Line line, int markerNum, Sci::Line lines);
  56         void MergeMarkers(Sci::Line line);
  57         bool DeleteMark(Sci::Line line, int markerNum, bool all);
  58         void DeleteMarkFromHandle(int markerHandle);
  59         Sci::Line LineFromHandle(int markerHandle) const noexcept;
  60         int HandleFromLine(Sci::Line line, int which) const noexcept;
  61         int NumberFromLine(Sci::Line line, int which) const noexcept;
  62 };
  63
  64 class LineLevels : public PerLine {
  65         SplitVector<int> levels;
  66 public:
  67         LineLevels() {
  68         }
  69         void Init() override;
  70         void InsertLine(Sci::Line line) override;
  71         void InsertLines(Sci::Line line, Sci::Line lines) override;
  72         void RemoveLine(Sci::Line line) override;
  73
  74         void ExpandLevels(Sci::Line sizeNew=-1);
  75         void ClearLevels();
  76         int SetLevel(Sci::Line line, int level, Sci::Line lines);
  77         int GetLevel(Sci::Line line) const noexcept;
  78         FoldLevel GetFoldLevel(Sci::Line line) const noexcept;
  79         Sci::Line GetFoldParent(Sci::Line line) const noexcept;
  80 };
  81
  82 class LineState : public PerLine {
  83         SplitVector<int> lineStates;
  84 public:
  85         LineState() {
  86         }
  87         void Init() override;
  88         void InsertLine(Sci::Line line) override;
  89         void InsertLines(Sci::Line line, Sci::Line lines) override;
  90         void RemoveLine(Sci::Line line) override;
  91
  92         int SetLineState(Sci::Line line, int state, Sci::Line lines);
  93         int GetLineState(Sci::Line line);
  94         Sci::Line GetMaxLineState() const noexcept;
  95 };
  96
  97 class LineAnnotation : public PerLine {
  98         SplitVector<std::unique_ptr<char []>> annotations;
  99 public:
 100         LineAnnotation() {
 101         }
 102
 103         [[nodiscard]] bool Empty() const noexcept;
 104         void Init() override;
 105         void InsertLine(Sci::Line line) override;
 106         void InsertLines(Sci::Line line, Sci::Line lines) override;
 107         void RemoveLine(Sci::Line line) override;
 108
 109         bool MultipleStyles(Sci::Line line) const noexcept;
 110         int Style(Sci::Line line) const noexcept;
 111         const char *Text(Sci::Line line) const noexcept;
 112         const unsigned char *Styles(Sci::Line line) const noexcept;
 113         void SetText(Sci::Line line, const char *text);
 114         void ClearAll();
 115         void SetStyle(Sci::Line line, int style);
 116         void SetStyles(Sci::Line line, const unsigned char *styles);
 117         int Length(Sci::Line line) const noexcept;
 118         int Lines(Sci::Line line) const noexcept;
 119 };
 120
 121 typedef std::vector<int> TabstopList;
 122
 123 class LineTabstops : public PerLine {
 124         SplitVector<std::unique_ptr<TabstopList>> tabstops;
 125 public:
 126         LineTabstops() {
 127         }
 128         void Init() override;
 129         void InsertLine(Sci::Line line) override;
 130         void InsertLines(Sci::Line line, Sci::Line lines) override;
 131         void RemoveLine(Sci::Line line) override;
 132
 133         bool ClearTabstops(Sci::Line line) noexcept;
 134         bool AddTabstop(Sci::Line line, int x);
 135         int GetNextTabstop(Sci::Line line, int x) const noexcept;
 136 };
 137
 138 }
 139
 140 #endif