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
11namespace Scintilla::Internal {
12
13class SelectionPosition {
14 Sci::Position position;
15 Sci::Position virtualSpace;
16public:
17 explicit SelectionPosition(Sci::Position position_= Sci::invalidPosition, Sci::Position virtualSpace_=0) noexcept : position(position_), virtualSpace(virtualSpace_) {
18 PLATFORM_ASSERT(virtualSpace < 800000);
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_ < 800000);
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
58struct 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};
85
86struct SelectionRange {
87 SelectionPosition caret;
88 SelectionPosition anchor;
89
90 SelectionRange() noexcept : caret(), anchor() {
91 }
92 explicit SelectionRange(SelectionPosition single) noexcept : caret(single), anchor(single) {
93 }
94 explicit SelectionRange(Sci::Position single) noexcept : caret(single), anchor(single) {
95 }
96 SelectionRange(SelectionPosition caret_, SelectionPosition anchor_) noexcept : caret(caret_), anchor(anchor_) {
97 }
98 SelectionRange(Sci::Position caret_, Sci::Position anchor_) noexcept : caret(caret_), anchor(anchor_) {
99 }
100 bool Empty() const noexcept {
101 return anchor == caret;
102 }
103 Sci::Position Length() const noexcept;
104 // Sci::Position Width() const; // Like Length but takes virtual space into account
105 bool operator ==(const SelectionRange &other) const noexcept {
106 return caret == other.caret && anchor == other.anchor;
107 }
108 bool operator <(const SelectionRange &other) const noexcept {
109 return caret < other.caret || ((caret == other.caret) && (anchor < other.anchor));
110 }
111 void Reset() noexcept {
112 anchor.Reset();
113 caret.Reset();
114 }
115 void ClearVirtualSpace() noexcept {
116 anchor.SetVirtualSpace(0);
117 caret.SetVirtualSpace(0);
118 }
119 void MoveForInsertDelete(bool insertion, Sci::Position startChange, Sci::Position length) noexcept;
120 bool Contains(Sci::Position pos) const noexcept;
121 bool Contains(SelectionPosition sp) const noexcept;
122 bool ContainsCharacter(Sci::Position posCharacter) const noexcept;
123 SelectionSegment Intersect(SelectionSegment check) const noexcept;
124 SelectionPosition Start() const noexcept {
125 return (anchor < caret) ? anchor : caret;
126 }
127 SelectionPosition End() const noexcept {
128 return (anchor < caret) ? caret : anchor;
129 }
130 void Swap() noexcept;
131 bool Trim(SelectionRange range) noexcept;
132 // If range is all virtual collapse to start of virtual space
133 void MinimizeVirtualSpace() noexcept;
134};
135
136// Deliberately an enum rather than an enum class to allow treating as bool
137enum InSelection { inNone, inMain, inAdditional };
138
139class Selection {
140 std::vector<SelectionRange> ranges;
141 std::vector<SelectionRange> rangesSaved;
142 SelectionRange rangeRectangular;
143 size_t mainRange;
144 bool moveExtends;
145 bool tentativeMain;
146public:
147 enum class SelTypes { none, stream, rectangle, lines, thin };
148 SelTypes selType;
149
150 Selection();
151 bool IsRectangular() const noexcept;
152 Sci::Position MainCaret() const noexcept;
153 Sci::Position MainAnchor() const noexcept;
154 SelectionRange &Rectangular() noexcept;
155 SelectionSegment Limits() const noexcept;
156 // This is for when you want to move the caret in response to a
157 // user direction command - for rectangular selections, use the range
158 // that covers all selected text otherwise return the main selection.
159 SelectionSegment LimitsForRectangularElseMain() const;
160 size_t Count() const noexcept;
161 size_t Main() const noexcept;
162 void SetMain(size_t r) noexcept;
163 SelectionRange &Range(size_t r) noexcept;
164 const SelectionRange &Range(size_t r) const noexcept;
165 SelectionRange &RangeMain() noexcept;
166 const SelectionRange &RangeMain() const noexcept;
167 SelectionPosition Start() const noexcept;
168 bool MoveExtends() const noexcept;
169 void SetMoveExtends(bool moveExtends_) noexcept;
170 bool Empty() const noexcept;
171 SelectionPosition Last() const noexcept;
172 Sci::Position Length() const noexcept;
173 void MovePositions(bool insertion, Sci::Position startChange, Sci::Position length) noexcept;
174 void TrimSelection(SelectionRange range) noexcept;
175 void TrimOtherSelections(size_t r, SelectionRange range) noexcept;
176 void SetSelection(SelectionRange range);
177 void AddSelection(SelectionRange range);
178 void AddSelectionWithoutTrim(SelectionRange range);
179 void DropSelection(size_t r);
180 void DropAdditionalRanges();
181 void TentativeSelection(SelectionRange range);
182 void CommitTentative() noexcept;
183 InSelection RangeType(size_t r) const noexcept;
184 InSelection CharacterInSelection(Sci::Position posCharacter) const noexcept;
185 InSelection InSelectionForEOL(Sci::Position pos) const noexcept;
186 Sci::Position VirtualSpaceFor(Sci::Position pos) const noexcept;
187 void Clear();
188 void RemoveDuplicates();
189 void RotateMain() noexcept;
190 bool Tentative() const noexcept { return tentativeMain; }
191 std::vector<SelectionRange> RangesCopy() const {
192 return ranges;
193 }
194};
195
196}
197
198#endif
199