scintilla/src/Selection.h

   1 // Scintilla source code edit control
   2 /** @file Selection.h
   3  ** Classes maintaining the selection.
   4  **/
   5 // Copyright 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 SELECTION_H
   9 #define SELECTION_H
  10
  11 namespace Scintilla::Internal {
  12
  13 class SelectionPosition {
  14         Sci::Position position;
  15         Sci::Position virtualSpace;
  16 public:
  17         explicit SelectionPosition(Sci::Position position_= Sci::invalidPosition, Sci::Position virtualSpace_=0) noexcept : position(position_), virtualSpace(virtualSpace_) {
  18                 PLATFORM_ASSERT(virtualSpace < 800000000);
  19                 if (virtualSpace < 0)
  20                         virtualSpace = 0;
  21         }
  22         void Reset() noexcept {
  23                 position = 0;
  24                 virtualSpace = 0;
  25         }
  26         void MoveForInsertDelete(bool insertion, Sci::Position startChange, Sci::Position length, bool moveForEqual) noexcept;
  27         bool operator ==(const SelectionPosition &other) const noexcept {
  28                 return position == other.position && virtualSpace == other.virtualSpace;
  29         }
  30         bool operator <(const SelectionPosition &other) const noexcept;
  31         bool operator >(const SelectionPosition &other) const noexcept;
  32         bool operator <=(const SelectionPosition &other) const noexcept;
  33         bool operator >=(const SelectionPosition &other) const noexcept;
  34         Sci::Position Position() const noexcept {
  35                 return position;
  36         }
  37         void SetPosition(Sci::Position position_) noexcept {
  38                 position = position_;
  39                 virtualSpace = 0;
  40         }
  41         Sci::Position VirtualSpace() const noexcept {
  42                 return virtualSpace;
  43         }
  44         void SetVirtualSpace(Sci::Position virtualSpace_) noexcept {
  45                 PLATFORM_ASSERT(virtualSpace_ < 800000000);
  46                 if (virtualSpace_ >= 0)
  47                         virtualSpace = virtualSpace_;
  48         }
  49         void Add(Sci::Position increment) noexcept {
  50                 position = position + increment;
  51         }
  52         bool IsValid() const noexcept {
  53                 return position >= 0;
  54         }
  55 };
  56
  57 // Ordered range to make drawing simpler
  58 struct SelectionSegment {
  59         SelectionPosition start;
  60         SelectionPosition end;
  61         SelectionSegment() noexcept : start(), end() {
  62         }
  63         SelectionSegment(SelectionPosition a, SelectionPosition b) noexcept {
  64                 if (a < b) {
  65                         start = a;
  66                         end = b;
  67                 } else {
  68                         start = b;
  69                         end = a;
  70                 }
  71         }
  72         bool Empty() const noexcept {
  73                 return start == end;
  74         }
  75         Sci::Position Length() const noexcept {
  76                 return end.Position() - start.Position();
  77         }
  78         void Extend(SelectionPosition p) noexcept {
  79                 if (start > p)
  80                         start = p;
  81                 if (end < p)
  82                         end = p;
  83         }
  84         SelectionSegment Subtract(Sci::Position increment) const noexcept {
  85                 SelectionSegment ret(start, end);
  86                 ret.start.Add(-increment);
  87                 ret.end.Add(-increment);
  88                 return ret;
  89         }
  90 };
  91
  92 struct SelectionRange {
  93         SelectionPosition caret;
  94         SelectionPosition anchor;
  95
  96         SelectionRange() noexcept : caret(), anchor() {
  97         }
  98         explicit SelectionRange(SelectionPosition single) noexcept : caret(single), anchor(single) {
  99         }
 100         explicit SelectionRange(Sci::Position single) noexcept : caret(single), anchor(single) {
 101         }
 102         SelectionRange(SelectionPosition caret_, SelectionPosition anchor_) noexcept : caret(caret_), anchor(anchor_) {
 103         }
 104         SelectionRange(Sci::Position caret_, Sci::Position anchor_) noexcept : caret(caret_), anchor(anchor_) {
 105         }
 106         bool Empty() const noexcept {
 107                 return anchor == caret;
 108         }
 109         Sci::Position Length() const noexcept;
 110         // Sci::Position Width() const; // Like Length but takes virtual space into account
 111         bool operator ==(const SelectionRange &other) const noexcept {
 112                 return caret == other.caret && anchor == other.anchor;
 113         }
 114         bool operator <(const SelectionRange &other) const noexcept {
 115                 return caret < other.caret || ((caret == other.caret) && (anchor < other.anchor));
 116         }
 117         void Reset() noexcept {
 118                 anchor.Reset();
 119                 caret.Reset();
 120         }
 121         void ClearVirtualSpace() noexcept {
 122                 anchor.SetVirtualSpace(0);
 123                 caret.SetVirtualSpace(0);
 124         }
 125         void MoveForInsertDelete(bool insertion, Sci::Position startChange, Sci::Position length) noexcept;
 126         bool Contains(Sci::Position pos) const noexcept;
 127         bool Contains(SelectionPosition sp) const noexcept;
 128         bool ContainsCharacter(Sci::Position posCharacter) const noexcept;
 129         SelectionSegment Intersect(SelectionSegment check) const noexcept;
 130         SelectionPosition Start() const noexcept {
 131                 return (anchor < caret) ? anchor : caret;
 132         }
 133         SelectionPosition End() const noexcept {
 134                 return (anchor < caret) ? caret : anchor;
 135         }
 136         void Swap() noexcept;
 137         bool Trim(SelectionRange range) noexcept;
 138         // If range is all virtual collapse to start of virtual space
 139         void MinimizeVirtualSpace() noexcept;
 140 };
 141
 142 // Deliberately an enum rather than an enum class to allow treating as bool
 143 enum InSelection { inNone, inMain, inAdditional };
 144
 145 class Selection {
 146         std::vector<SelectionRange> ranges;
 147         std::vector<SelectionRange> rangesSaved;
 148         SelectionRange rangeRectangular;
 149         size_t mainRange;
 150         bool moveExtends;
 151         bool tentativeMain;
 152 public:
 153         enum class SelTypes { none, stream, rectangle, lines, thin };
 154         SelTypes selType;
 155
 156         Selection();
 157         bool IsRectangular() const noexcept;
 158         Sci::Position MainCaret() const noexcept;
 159         Sci::Position MainAnchor() const noexcept;
 160         SelectionRange &Rectangular() noexcept;
 161         SelectionSegment Limits() const noexcept;
 162         // This is for when you want to move the caret in response to a
 163         // user direction command - for rectangular selections, use the range
 164         // that covers all selected text otherwise return the main selection.
 165         SelectionSegment LimitsForRectangularElseMain() const;
 166         size_t Count() const noexcept;
 167         size_t Main() const noexcept;
 168         void SetMain(size_t r) noexcept;
 169         SelectionRange &Range(size_t r) noexcept;
 170         const SelectionRange &Range(size_t r) const noexcept;
 171         SelectionRange &RangeMain() noexcept;
 172         const SelectionRange &RangeMain() const noexcept;
 173         SelectionPosition Start() const noexcept;
 174         bool MoveExtends() const noexcept;
 175         void SetMoveExtends(bool moveExtends_) noexcept;
 176         bool Empty() const noexcept;
 177         SelectionPosition Last() const noexcept;
 178         Sci::Position Length() const noexcept;
 179         void MovePositions(bool insertion, Sci::Position startChange, Sci::Position length) noexcept;
 180         void TrimSelection(SelectionRange range) noexcept;
 181         void TrimOtherSelections(size_t r, SelectionRange range) noexcept;
 182         void SetSelection(SelectionRange range);
 183         void AddSelection(SelectionRange range);
 184         void AddSelectionWithoutTrim(SelectionRange range);
 185         void DropSelection(size_t r);
 186         void DropAdditionalRanges();
 187         void TentativeSelection(SelectionRange range);
 188         void CommitTentative() noexcept;
 189         InSelection RangeType(size_t r) const noexcept;
 190         InSelection CharacterInSelection(Sci::Position posCharacter) const noexcept;
 191         InSelection InSelectionForEOL(Sci::Position pos) const noexcept;
 192         Sci::Position VirtualSpaceFor(Sci::Position pos) const noexcept;
 193         void Clear();
 194         void RemoveDuplicates();
 195         void RotateMain() noexcept;
 196         bool Tentative() const noexcept { return tentativeMain; }
 197         std::vector<SelectionRange> RangesCopy() const {
 198                 return ranges;
 199         }
 200 };
 201
 202 }
 203
 204 #endif