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
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* 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/. */
#include "HighlightRegistry.h"
#include "mozilla/ErrorResult.h"
#include "mozilla/CompactPair.h"
#include "Document.h"
#include "Highlight.h"
#include "mozilla/dom/HighlightBinding.h"
#include "PresShell.h"
#include "nsAtom.h"
#include "nsCycleCollectionParticipant.h"
#include "nsFrameSelection.h"
namespace mozilla::dom {
NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(HighlightRegistry)
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(HighlightRegistry)
NS_IMPL_CYCLE_COLLECTION_UNLINK(mDocument)
for (auto const& iter : tmp->mHighlightsOrdered) {
iter.second()->RemoveFromHighlightRegistry(*tmp, *iter.first());
}
NS_IMPL_CYCLE_COLLECTION_UNLINK(mHighlightsOrdered)
NS_IMPL_CYCLE_COLLECTION_UNLINK_PRESERVED_WRAPPER
NS_IMPL_CYCLE_COLLECTION_UNLINK_END
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(HighlightRegistry)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mDocument)
for (size_t i = 0; i < tmp->mHighlightsOrdered.Length(); ++i) {
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mHighlightsOrdered[i].second())
}
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
NS_IMPL_CYCLE_COLLECTING_ADDREF(HighlightRegistry)
NS_IMPL_CYCLE_COLLECTING_RELEASE(HighlightRegistry)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(HighlightRegistry)
NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
NS_INTERFACE_MAP_ENTRY(nsISupports)
NS_INTERFACE_MAP_END
HighlightRegistry::HighlightRegistry(Document* aDocument)
: mDocument(aDocument) {}
HighlightRegistry::~HighlightRegistry() {
for (auto const& iter : mHighlightsOrdered) {
iter.second()->RemoveFromHighlightRegistry(*this, *iter.first());
}
}
JSObject* HighlightRegistry::WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) {
return HighlightRegistry_Binding::Wrap(aCx, this, aGivenProto);
}
void HighlightRegistry::MaybeAddRangeToHighlightSelection(
AbstractRange& aRange, Highlight& aHighlight) {
RefPtr<nsFrameSelection> frameSelection = GetFrameSelection();
if (!frameSelection) {
return;
}
MOZ_ASSERT(frameSelection->GetPresShell());
if (!frameSelection->GetPresShell()->GetDocument() ||
frameSelection->GetPresShell()->GetDocument() !=
aRange.GetComposedDocOfContainers()) {
// ranges that belong to a different document must not be added.
return;
}
for (auto const& iter : mHighlightsOrdered) {
if (iter.second() != &aHighlight) {
continue;
}
const RefPtr<nsAtom> highlightName = iter.first();
frameSelection->AddHighlightSelectionRange(highlightName, aHighlight,
aRange);
}
}
void HighlightRegistry::MaybeRemoveRangeFromHighlightSelection(
AbstractRange& aRange, Highlight& aHighlight) {
RefPtr<nsFrameSelection> frameSelection = GetFrameSelection();
if (!frameSelection) {
return;
}
MOZ_ASSERT(frameSelection->GetPresShell());
for (auto const& iter : mHighlightsOrdered) {
if (iter.second() != &aHighlight) {
continue;
}
const RefPtr<nsAtom> highlightName = iter.first();
frameSelection->RemoveHighlightSelectionRange(highlightName, aRange);
}
}
void HighlightRegistry::RemoveHighlightSelection(Highlight& aHighlight) {
RefPtr<nsFrameSelection> frameSelection = GetFrameSelection();
if (!frameSelection) {
return;
}
for (auto const& iter : mHighlightsOrdered) {
if (iter.second() != &aHighlight) {
continue;
}
const RefPtr<nsAtom> highlightName = iter.first();
frameSelection->RemoveHighlightSelection(highlightName);
}
}
void HighlightRegistry::AddHighlightSelectionsToFrameSelection() {
if (mHighlightsOrdered.IsEmpty()) {
return;
}
RefPtr<nsFrameSelection> frameSelection = GetFrameSelection();
if (!frameSelection) {
return;
}
for (auto const& iter : mHighlightsOrdered) {
RefPtr<nsAtom> highlightName = iter.first();
RefPtr<Highlight> highlight = iter.second();
frameSelection->AddHighlightSelection(highlightName, *highlight);
}
}
void HighlightRegistry::Set(const nsAString& aKey, Highlight& aValue,
ErrorResult& aRv) {
// manually check if the highlight `aKey` is already registered to be able to
// provide a fast path later that avoids calling `std::find_if()`.
const bool highlightAlreadyPresent =
HighlightRegistry_Binding::MaplikeHelpers::Has(this, aKey, aRv);
if (aRv.Failed()) {
return;
}
HighlightRegistry_Binding::MaplikeHelpers::Set(this, aKey, aValue, aRv);
if (aRv.Failed()) {
return;
}
RefPtr<nsFrameSelection> frameSelection = GetFrameSelection();
RefPtr<nsAtom> highlightNameAtom = NS_AtomizeMainThread(aKey);
if (highlightAlreadyPresent) {
// If the highlight named `aKey` was present before, replace its value.
auto foundIter =
std::find_if(mHighlightsOrdered.begin(), mHighlightsOrdered.end(),
[&highlightNameAtom](auto const& aElm) {
return aElm.first() == highlightNameAtom;
});
MOZ_ASSERT(foundIter != mHighlightsOrdered.end(),
"webIDL maplike and DOM mirror are not in sync");
foundIter->second()->RemoveFromHighlightRegistry(*this, *highlightNameAtom);
if (frameSelection) {
frameSelection->RemoveHighlightSelection(highlightNameAtom);
}
foundIter->second() = &aValue;
} else {
mHighlightsOrdered.AppendElement(
CompactPair<RefPtr<nsAtom>, RefPtr<Highlight>>(highlightNameAtom,
&aValue));
}
aValue.AddToHighlightRegistry(*this, *highlightNameAtom);
if (frameSelection) {
frameSelection->AddHighlightSelection(highlightNameAtom, aValue);
}
}
void HighlightRegistry::Clear(ErrorResult& aRv) {
HighlightRegistry_Binding::MaplikeHelpers::Clear(this, aRv);
if (aRv.Failed()) {
return;
}
auto frameSelection = GetFrameSelection();
AutoFrameSelectionBatcher batcher(__FUNCTION__);
batcher.AddFrameSelection(frameSelection);
for (auto const& iter : mHighlightsOrdered) {
const RefPtr<nsAtom>& highlightName = iter.first();
const RefPtr<Highlight>& highlight = iter.second();
highlight->RemoveFromHighlightRegistry(*this, *highlightName);
if (frameSelection) {
// The selection batcher makes sure that no script is run in this call.
// However, `nsFrameSelection::RemoveHighlightSelection` is marked
// `MOZ_CAN_RUN_SCRIPT`, therefore `MOZ_KnownLive` is needed regardless.
frameSelection->RemoveHighlightSelection(MOZ_KnownLive(highlightName));
}
}
mHighlightsOrdered.Clear();
}
bool HighlightRegistry::Delete(const nsAString& aKey, ErrorResult& aRv) {
if (!HighlightRegistry_Binding::MaplikeHelpers::Delete(this, aKey, aRv)) {
return false;
}
RefPtr<nsAtom> highlightNameAtom = NS_AtomizeMainThread(aKey);
auto foundIter =
std::find_if(mHighlightsOrdered.cbegin(), mHighlightsOrdered.cend(),
[&highlightNameAtom](auto const& aElm) {
return aElm.first() == highlightNameAtom;
});
MOZ_ASSERT(foundIter != mHighlightsOrdered.cend(),
"HighlightRegistry: maplike and internal data are out of sync!");
RefPtr<Highlight> highlight = foundIter->second();
mHighlightsOrdered.RemoveElementAt(foundIter);
if (auto frameSelection = GetFrameSelection()) {
frameSelection->RemoveHighlightSelection(highlightNameAtom);
}
highlight->RemoveFromHighlightRegistry(*this, *highlightNameAtom);
return true;
}
RefPtr<nsFrameSelection> HighlightRegistry::GetFrameSelection() {
return RefPtr<nsFrameSelection>(
mDocument->GetPresShell() ? mDocument->GetPresShell()->FrameSelection()
: nullptr);
}
} // namespace mozilla::dom
|
