1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
|
// Scintilla source code edit control
/** @file ContractionState.cxx
** Manages visibility of lines for folding and wrapping.
**/
// Copyright 1998-2007 by Neil Hodgson <neilh@scintilla.org>
// The License.txt file describes the conditions under which this software may be distributed.
#include <cstddef>
#include <cassert>
#include <cstring>
#include <stdexcept>
#include <string_view>
#include <vector>
#include <algorithm>
#include <memory>
#include "Platform.h"
#include "Position.h"
#include "UniqueString.h"
#include "SplitVector.h"
#include "Partitioning.h"
#include "RunStyles.h"
#include "SparseVector.h"
#include "ContractionState.h"
using namespace Scintilla;
namespace {
template <typename LINE>
class ContractionState final : public IContractionState {
// These contain 1 element for every document line.
std::unique_ptr<RunStyles<LINE, char>> visible;
std::unique_ptr<RunStyles<LINE, char>> expanded;
std::unique_ptr<RunStyles<LINE, int>> heights;
std::unique_ptr<SparseVector<UniqueString>> foldDisplayTexts;
std::unique_ptr<Partitioning<LINE>> displayLines;
LINE linesInDocument;
void EnsureData();
bool OneToOne() const noexcept {
// True when each document line is exactly one display line so need for
// complex data structures.
return visible == nullptr;
}
void InsertLine(Sci::Line lineDoc);
void DeleteLine(Sci::Line lineDoc);
public:
ContractionState() noexcept;
// Deleted so ContractionState objects can not be copied.
ContractionState(const ContractionState &) = delete;
void operator=(const ContractionState &) = delete;
ContractionState(ContractionState &&) = delete;
void operator=(ContractionState &&) = delete;
~ContractionState() override;
void Clear() noexcept override;
Sci::Line LinesInDoc() const override;
Sci::Line LinesDisplayed() const override;
Sci::Line DisplayFromDoc(Sci::Line lineDoc) const override;
Sci::Line DisplayLastFromDoc(Sci::Line lineDoc) const override;
Sci::Line DocFromDisplay(Sci::Line lineDisplay) const override;
void InsertLines(Sci::Line lineDoc, Sci::Line lineCount) override;
void DeleteLines(Sci::Line lineDoc, Sci::Line lineCount) override;
bool GetVisible(Sci::Line lineDoc) const override;
bool SetVisible(Sci::Line lineDocStart, Sci::Line lineDocEnd, bool isVisible) override;
bool HiddenLines() const override;
const char *GetFoldDisplayText(Sci::Line lineDoc) const override;
bool GetFoldDisplayTextShown(Sci::Line lineDoc) const override;
bool SetFoldDisplayText(Sci::Line lineDoc, const char *text) override;
bool GetExpanded(Sci::Line lineDoc) const override;
bool SetExpanded(Sci::Line lineDoc, bool isExpanded) override;
Sci::Line ContractedNext(Sci::Line lineDocStart) const override;
int GetHeight(Sci::Line lineDoc) const override;
bool SetHeight(Sci::Line lineDoc, int height) override;
void ShowAll() override;
void Check() const;
};
template <typename LINE>
ContractionState<LINE>::ContractionState() noexcept : linesInDocument(1) {
}
template <typename LINE>
ContractionState<LINE>::~ContractionState() {
Clear();
}
template <typename LINE>
void ContractionState<LINE>::EnsureData() {
if (OneToOne()) {
visible = std::make_unique<RunStyles<LINE, char>>();
expanded = std::make_unique<RunStyles<LINE, char>>();
heights = std::make_unique<RunStyles<LINE, int>>();
foldDisplayTexts = std::make_unique<SparseVector<UniqueString>>();
displayLines = std::make_unique<Partitioning<LINE>>(4);
InsertLines(0, linesInDocument);
}
}
template <typename LINE>
void ContractionState<LINE>::InsertLine(Sci::Line lineDoc) {
if (OneToOne()) {
linesInDocument++;
} else {
const LINE lineDocCast = static_cast<LINE>(lineDoc);
visible->InsertSpace(lineDocCast, 1);
visible->SetValueAt(lineDocCast, 1);
expanded->InsertSpace(lineDocCast, 1);
expanded->SetValueAt(lineDocCast, 1);
heights->InsertSpace(lineDocCast, 1);
heights->SetValueAt(lineDocCast, 1);
foldDisplayTexts->InsertSpace(lineDocCast, 1);
foldDisplayTexts->SetValueAt(lineDocCast, nullptr);
const Sci::Line lineDisplay = DisplayFromDoc(lineDoc);
displayLines->InsertPartition(lineDocCast, static_cast<LINE>(lineDisplay));
displayLines->InsertText(lineDocCast, 1);
}
}
template <typename LINE>
void ContractionState<LINE>::DeleteLine(Sci::Line lineDoc) {
if (OneToOne()) {
linesInDocument--;
} else {
const LINE lineDocCast = static_cast<LINE>(lineDoc);
if (GetVisible(lineDoc)) {
displayLines->InsertText(lineDocCast, -heights->ValueAt(lineDocCast));
}
displayLines->RemovePartition(lineDocCast);
visible->DeleteRange(lineDocCast, 1);
expanded->DeleteRange(lineDocCast, 1);
heights->DeleteRange(lineDocCast, 1);
foldDisplayTexts->DeletePosition(lineDocCast);
}
}
template <typename LINE>
void ContractionState<LINE>::Clear() noexcept {
visible.reset();
expanded.reset();
heights.reset();
foldDisplayTexts.reset();
displayLines.reset();
linesInDocument = 1;
}
template <typename LINE>
Sci::Line ContractionState<LINE>::LinesInDoc() const {
if (OneToOne()) {
return linesInDocument;
} else {
return displayLines->Partitions() - 1;
}
}
template <typename LINE>
Sci::Line ContractionState<LINE>::LinesDisplayed() const {
if (OneToOne()) {
return linesInDocument;
} else {
return displayLines->PositionFromPartition(static_cast<LINE>(LinesInDoc()));
}
}
template <typename LINE>
Sci::Line ContractionState<LINE>::DisplayFromDoc(Sci::Line lineDoc) const {
if (OneToOne()) {
return (lineDoc <= linesInDocument) ? lineDoc : linesInDocument;
} else {
if (lineDoc > displayLines->Partitions())
lineDoc = displayLines->Partitions();
return displayLines->PositionFromPartition(static_cast<LINE>(lineDoc));
}
}
template <typename LINE>
Sci::Line ContractionState<LINE>::DisplayLastFromDoc(Sci::Line lineDoc) const {
return DisplayFromDoc(lineDoc) + GetHeight(lineDoc) - 1;
}
template <typename LINE>
Sci::Line ContractionState<LINE>::DocFromDisplay(Sci::Line lineDisplay) const {
if (OneToOne()) {
return lineDisplay;
} else {
if (lineDisplay <= 0) {
return 0;
}
if (lineDisplay > LinesDisplayed()) {
return displayLines->PartitionFromPosition(static_cast<LINE>(LinesDisplayed()));
}
const Sci::Line lineDoc = displayLines->PartitionFromPosition(static_cast<LINE>(lineDisplay));
PLATFORM_ASSERT(GetVisible(lineDoc));
return lineDoc;
}
}
template <typename LINE>
void ContractionState<LINE>::InsertLines(Sci::Line lineDoc, Sci::Line lineCount) {
for (int l = 0; l < lineCount; l++) {
InsertLine(lineDoc + l);
}
Check();
}
template <typename LINE>
void ContractionState<LINE>::DeleteLines(Sci::Line lineDoc, Sci::Line lineCount) {
for (Sci::Line l = 0; l < lineCount; l++) {
DeleteLine(lineDoc);
}
Check();
}
template <typename LINE>
bool ContractionState<LINE>::GetVisible(Sci::Line lineDoc) const {
if (OneToOne()) {
return true;
} else {
if (lineDoc >= visible->Length())
return true;
return visible->ValueAt(static_cast<LINE>(lineDoc)) == 1;
}
}
template <typename LINE>
bool ContractionState<LINE>::SetVisible(Sci::Line lineDocStart, Sci::Line lineDocEnd, bool isVisible) {
if (OneToOne() && isVisible) {
return false;
} else {
EnsureData();
Sci::Line delta = 0;
Check();
if ((lineDocStart <= lineDocEnd) && (lineDocStart >= 0) && (lineDocEnd < LinesInDoc())) {
for (Sci::Line line = lineDocStart; line <= lineDocEnd; line++) {
if (GetVisible(line) != isVisible) {
const int heightLine = heights->ValueAt(static_cast<LINE>(line));
const int difference = isVisible ? heightLine : -heightLine;
visible->SetValueAt(static_cast<LINE>(line), isVisible ? 1 : 0);
displayLines->InsertText(static_cast<LINE>(line), difference);
delta += difference;
}
}
} else {
return false;
}
Check();
return delta != 0;
}
}
template <typename LINE>
bool ContractionState<LINE>::HiddenLines() const {
if (OneToOne()) {
return false;
} else {
return !visible->AllSameAs(1);
}
}
template <typename LINE>
const char *ContractionState<LINE>::GetFoldDisplayText(Sci::Line lineDoc) const {
Check();
return foldDisplayTexts->ValueAt(lineDoc).get();
}
template <typename LINE>
bool ContractionState<LINE>::GetFoldDisplayTextShown(Sci::Line lineDoc) const {
return !GetExpanded(lineDoc) && GetFoldDisplayText(lineDoc);
}
template <typename LINE>
bool ContractionState<LINE>::SetFoldDisplayText(Sci::Line lineDoc, const char *text) {
EnsureData();
const char *foldText = foldDisplayTexts->ValueAt(lineDoc).get();
if (!foldText || !text || 0 != strcmp(text, foldText)) {
UniqueString uns = UniqueStringCopy(text);
foldDisplayTexts->SetValueAt(lineDoc, std::move(uns));
Check();
return true;
} else {
Check();
return false;
}
}
template <typename LINE>
bool ContractionState<LINE>::GetExpanded(Sci::Line lineDoc) const {
if (OneToOne()) {
return true;
} else {
Check();
return expanded->ValueAt(static_cast<LINE>(lineDoc)) == 1;
}
}
template <typename LINE>
bool ContractionState<LINE>::SetExpanded(Sci::Line lineDoc, bool isExpanded) {
if (OneToOne() && isExpanded) {
return false;
} else {
EnsureData();
if (isExpanded != (expanded->ValueAt(static_cast<LINE>(lineDoc)) == 1)) {
expanded->SetValueAt(static_cast<LINE>(lineDoc), isExpanded ? 1 : 0);
Check();
return true;
} else {
Check();
return false;
}
}
}
template <typename LINE>
Sci::Line ContractionState<LINE>::ContractedNext(Sci::Line lineDocStart) const {
if (OneToOne()) {
return -1;
} else {
Check();
if (!expanded->ValueAt(static_cast<LINE>(lineDocStart))) {
return lineDocStart;
} else {
const Sci::Line lineDocNextChange = expanded->EndRun(static_cast<LINE>(lineDocStart));
if (lineDocNextChange < LinesInDoc())
return lineDocNextChange;
else
return -1;
}
}
}
template <typename LINE>
int ContractionState<LINE>::GetHeight(Sci::Line lineDoc) const {
if (OneToOne()) {
return 1;
} else {
return heights->ValueAt(static_cast<LINE>(lineDoc));
}
}
// Set the number of display lines needed for this line.
// Return true if this is a change.
template <typename LINE>
bool ContractionState<LINE>::SetHeight(Sci::Line lineDoc, int height) {
if (OneToOne() && (height == 1)) {
return false;
} else if (lineDoc < LinesInDoc()) {
EnsureData();
if (GetHeight(lineDoc) != height) {
if (GetVisible(lineDoc)) {
displayLines->InsertText(static_cast<LINE>(lineDoc), height - GetHeight(lineDoc));
}
heights->SetValueAt(static_cast<LINE>(lineDoc), height);
Check();
return true;
} else {
Check();
return false;
}
} else {
return false;
}
}
template <typename LINE>
void ContractionState<LINE>::ShowAll() {
const LINE lines = static_cast<LINE>(LinesInDoc());
Clear();
linesInDocument = lines;
}
// Debugging checks
template <typename LINE>
void ContractionState<LINE>::Check() const {
#ifdef CHECK_CORRECTNESS
for (Sci::Line vline = 0; vline < LinesDisplayed(); vline++) {
const Sci::Line lineDoc = DocFromDisplay(vline);
PLATFORM_ASSERT(GetVisible(lineDoc));
}
for (Sci::Line lineDoc = 0; lineDoc < LinesInDoc(); lineDoc++) {
const Sci::Line displayThis = DisplayFromDoc(lineDoc);
const Sci::Line displayNext = DisplayFromDoc(lineDoc + 1);
const Sci::Line height = displayNext - displayThis;
PLATFORM_ASSERT(height >= 0);
if (GetVisible(lineDoc)) {
PLATFORM_ASSERT(GetHeight(lineDoc) == height);
} else {
PLATFORM_ASSERT(0 == height);
}
}
#endif
}
}
namespace Scintilla {
std::unique_ptr<IContractionState> ContractionStateCreate(bool largeDocument) {
if (largeDocument)
return std::make_unique<ContractionState<Sci::Line>>();
else
return std::make_unique<ContractionState<int>>();
}
}
|
