summaryrefslogtreecommitdiffstats
path: root/dom/base/HighlightRegistry.cpp
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 01:47:29 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 01:47:29 +0000
commit0ebf5bdf043a27fd3dfb7f92e0cb63d88954c44d (patch)
treea31f07c9bcca9d56ce61e9a1ffd30ef350d513aa /dom/base/HighlightRegistry.cpp
parentInitial commit. (diff)
downloadfirefox-esr-upstream/115.8.0esr.tar.xz
firefox-esr-upstream/115.8.0esr.zip
Adding upstream version 115.8.0esr.upstream/115.8.0esr
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/base/HighlightRegistry.cpp')
-rw-r--r--dom/base/HighlightRegistry.cpp216
1 files changed, 216 insertions, 0 deletions
diff --git a/dom/base/HighlightRegistry.cpp b/dom/base/HighlightRegistry.cpp
new file mode 100644
index 0000000000..c6c37d19c4
--- /dev/null
+++ b/dom/base/HighlightRegistry.cpp
@@ -0,0 +1,216 @@
+/* -*- 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<const 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<const 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<const 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<const nsAtom> highlightName = iter.first();
+ RefPtr<Highlight> highlight = iter.second();
+ frameSelection->AddHighlightSelection(highlightName, *highlight);
+ }
+}
+
+void HighlightRegistry::Set(const nsAString& aKey, Highlight& aValue,
+ ErrorResult& aRv) {
+ HighlightRegistry_Binding::MaplikeHelpers::Set(this, aKey, aValue, aRv);
+ if (aRv.Failed()) {
+ return;
+ }
+ RefPtr<nsFrameSelection> frameSelection = GetFrameSelection();
+ RefPtr<nsAtom> highlightNameAtom = NS_AtomizeMainThread(aKey);
+ auto foundIter =
+ std::find_if(mHighlightsOrdered.begin(), mHighlightsOrdered.end(),
+ [&highlightNameAtom](auto const& aElm) {
+ return aElm.first() == highlightNameAtom;
+ });
+ if (foundIter != mHighlightsOrdered.end()) {
+ foundIter->second()->RemoveFromHighlightRegistry(*this, *highlightNameAtom);
+ if (frameSelection) {
+ frameSelection->RemoveHighlightSelection(highlightNameAtom);
+ }
+ foundIter->second() = &aValue;
+ } else {
+ mHighlightsOrdered.AppendElement(
+ CompactPair<RefPtr<const 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<const 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