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