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
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef DOM_BASE_STYLED_RANGE_H_
#define DOM_BASE_STYLED_RANGE_H_
#include "mozilla/RefPtr.h"
#include "mozilla/TextRange.h"
#include "nsTArray.h"
#include "nsTHashMap.h"
class nsCycleCollectionTraversalCallback;
namespace mozilla::dom {
class AbstractRange;
struct StyledRange {
explicit StyledRange(AbstractRange* aRange, TextRangeStyle aStyle = {});
RefPtr<AbstractRange> mRange;
TextRangeStyle mTextRangeStyle;
};
/**
* An container of ranges with associated styles, containing both a sorted array
* of ranges and an optimized lookup for the associated `TextRangeStyle`.
*/
class StyledRangeCollection {
friend void ImplCycleCollectionTraverse(
nsCycleCollectionTraversalCallback& aCallback,
StyledRangeCollection& aField, const char* aName, uint32_t aFlags);
friend void ImplCycleCollectionUnlink(StyledRangeCollection& aField);
public:
StyledRangeCollection() = default;
~StyledRangeCollection() = default;
StyledRangeCollection(StyledRangeCollection&& aOther) = default;
StyledRangeCollection& operator=(StyledRangeCollection&& aOther) = default;
StyledRangeCollection(const StyledRangeCollection&) = delete;
StyledRangeCollection& operator=(const StyledRangeCollection&) = delete;
size_t Length() const { return mRanges.Length(); }
bool IsEmpty() const { return mRanges.IsEmpty(); }
/**
* Returns the `AbstractRange` at the given index.
* Release asserts if out of bounds.
*/
AbstractRange* GetAbstractRangeAt(size_t aIndex) const {
return mRanges[aIndex];
}
/**
* Returns the `StyledRange` at the given index.
* Release asserts if out of bounds.
* Note that each call creates a new object, which increments the refcount
* of the underlying `AbstractRange` and copies the `TextRangeStyle`.
*/
StyledRange GetStyledRangeAt(size_t aIndex) {
AbstractRange* range = GetAbstractRangeAt(aIndex);
const TextRangeStyle* style = GetTextRangeStyleIfNotDefault(range);
if (style) {
return StyledRange{range, *style};
}
return StyledRange{range};
}
/**
* Returns a span of the `AbstractRange`s, ordered by start point.
*/
Span<RefPtr<AbstractRange>> Ranges() { return mRanges; }
Span<const RefPtr<AbstractRange>> Ranges() const { return mRanges; }
// Add, insert, remove elements.
void AppendElement(StyledRange&& aRange);
void InsertElementAt(size_t aIndex, StyledRange&& aRange);
void AppendElement(const StyledRange& aRange);
void InsertElementAt(size_t aIndex, const StyledRange& aRange);
void InsertElementsAt(size_t aIndex,
const nsTArray<StyledRange>& aStyledRanges);
/**
* Removes the element associated with the given `AbstractRange`.
* Returns true if an element was removed, false otherwise.
*/
bool RemoveElement(const AbstractRange* aRange);
void RemoveElementAt(size_t aIndex);
void RemoveElementsAt(size_t aStart, size_t aCount);
/**
* Removes the element at `aIndex` and returns its value (including style
* data) as `StyledRange`.
*/
StyledRange ExtractElementAt(size_t aIndex);
void Clear();
/**
* Sorts ranges by the given comparator.
* This does not invalidate the style lookup.
*/
template <typename Comparator>
void Sort(const Comparator& aComp) {
mRanges.Sort(aComp);
}
// O(1) style lookup.
const TextRangeStyle* GetTextRangeStyleIfNotDefault(
const AbstractRange* aRange);
// Sets the style data associated with `aRange`.
void SetTextRangeStyle(const AbstractRange* aRange,
const TextRangeStyle& aStyle);
private:
// Removes any style associated with `aRange`.
void RemoveStyle(const AbstractRange* aRange);
// Ranges, sorted by start point.
AutoTArray<RefPtr<AbstractRange>, 1> mRanges;
// Lookup table for the TextRangeStyle associated with each range.
nsTHashMap<const AbstractRange*, TextRangeStyle> mRangeStyleData;
};
inline void ImplCycleCollectionUnlink(StyledRangeCollection& aField) {
aField.Clear();
}
void ImplCycleCollectionTraverse(nsCycleCollectionTraversalCallback& aCallback,
StyledRangeCollection& aField,
const char* aName, uint32_t aFlags);
} // namespace mozilla::dom
#endif // DOM_BASE_STYLED_RANGE_H_
|
