Source code
Revision control
Copy as Markdown
Other Tools
/* -*- 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
#include "mozilla/dom/CrossShadowBoundaryRange.h"
#include "nsContentUtils.h"
#include "nsINode.h"
#include "nsRange.h"
#include "nsIContentInlines.h"
namespace mozilla::dom {
template already_AddRefed<CrossShadowBoundaryRange>
CrossShadowBoundaryRange::Create(const RangeBoundary& aStartBoundary,
const RangeBoundary& aEndBoundary,
nsRange* aOwner);
template already_AddRefed<CrossShadowBoundaryRange>
CrossShadowBoundaryRange::Create(const RangeBoundary& aStartBoundary,
const RawRangeBoundary& aEndBoundary,
nsRange* aOwner);
template already_AddRefed<CrossShadowBoundaryRange>
CrossShadowBoundaryRange::Create(const RawRangeBoundary& aStartBoundary,
const RangeBoundary& aEndBoundary,
nsRange* aOwner);
template already_AddRefed<CrossShadowBoundaryRange>
CrossShadowBoundaryRange::Create(const RawRangeBoundary& aStartBoundary,
const RawRangeBoundary& aEndBoundary,
nsRange* aOwner);
template void CrossShadowBoundaryRange::DoSetRange(
const RangeBoundary& aStartBoundary, const RangeBoundary& aEndBoundary,
nsINode* aRootNode, nsRange* aOwner);
template void CrossShadowBoundaryRange::DoSetRange(
const RangeBoundary& aStartBoundary, const RawRangeBoundary& aEndBoundary,
nsINode* aRootNode, nsRange* aOwner);
template void CrossShadowBoundaryRange::DoSetRange(
const RawRangeBoundary& aStartBoundary, const RangeBoundary& aEndBoundary,
nsINode* aRootNode, nsRange* aOwner);
template void CrossShadowBoundaryRange::DoSetRange(
const RawRangeBoundary& aStartBoundary,
const RawRangeBoundary& aEndBoundary, nsINode* aRootNode, nsRange* aOwner);
template nsresult CrossShadowBoundaryRange::SetStartAndEnd(
const RangeBoundary& aStartBoundary, const RangeBoundary& aEndBoundary);
template nsresult CrossShadowBoundaryRange::SetStartAndEnd(
const RangeBoundary& aStartBoundary, const RawRangeBoundary& aEndBoundary);
template nsresult CrossShadowBoundaryRange::SetStartAndEnd(
const RawRangeBoundary& aStartBoundary, const RangeBoundary& aEndBoundary);
template nsresult CrossShadowBoundaryRange::SetStartAndEnd(
const RawRangeBoundary& aStartBoundary,
const RawRangeBoundary& aEndBoundary);
nsTArray<RefPtr<CrossShadowBoundaryRange>>*
CrossShadowBoundaryRange::sCachedRanges = nullptr;
NS_IMPL_CYCLE_COLLECTING_ADDREF(CrossShadowBoundaryRange)
NS_IMPL_CYCLE_COLLECTING_RELEASE_WITH_INTERRUPTABLE_LAST_RELEASE(
CrossShadowBoundaryRange,
DoSetRange(RawRangeBoundary(), RawRangeBoundary(), nullptr, nullptr),
AbstractRange::MaybeCacheToReuse(*this))
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(CrossShadowBoundaryRange)
NS_INTERFACE_MAP_END_INHERITING(CrossShadowBoundaryRange)
NS_IMPL_CYCLE_COLLECTION_CLASS(CrossShadowBoundaryRange)
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN_INHERITED(CrossShadowBoundaryRange,
StaticRange)
if (tmp->mCommonAncestor) {
tmp->mCommonAncestor->RemoveMutationObserver(tmp);
}
NS_IMPL_CYCLE_COLLECTION_UNLINK(mCommonAncestor)
NS_IMPL_CYCLE_COLLECTION_UNLINK_END
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED(CrossShadowBoundaryRange,
StaticRange)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mCommonAncestor)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
NS_IMPL_CYCLE_COLLECTION_TRACE_BEGIN_INHERITED(CrossShadowBoundaryRange,
StaticRange)
NS_IMPL_CYCLE_COLLECTION_TRACE_END
/* static */
template <typename SPT, typename SRT, typename EPT, typename ERT>
already_AddRefed<CrossShadowBoundaryRange> CrossShadowBoundaryRange::Create(
const RangeBoundaryBase<SPT, SRT>& aStartBoundary,
const RangeBoundaryBase<EPT, ERT>& aEndBoundary, nsRange* aOwner) {
RefPtr<CrossShadowBoundaryRange> range;
if (!sCachedRanges || sCachedRanges->IsEmpty()) {
range = new CrossShadowBoundaryRange(aStartBoundary.Container(), aOwner);
} else {
range = sCachedRanges->PopLastElement().forget();
}
range->Init(aStartBoundary.Container());
range->DoSetRange(aStartBoundary, aEndBoundary, nullptr, aOwner);
return range.forget();
}
template <typename SPT, typename SRT, typename EPT, typename ERT>
void CrossShadowBoundaryRange::DoSetRange(
const RangeBoundaryBase<SPT, SRT>& aStartBoundary,
const RangeBoundaryBase<EPT, ERT>& aEndBoundary, nsINode* aRootNode,
nsRange* aOwner) {
// aRootNode is useless to CrossShadowBoundaryRange because aStartBoundary
// and aEndBoundary could have different roots.
StaticRange::DoSetRange(aStartBoundary, aEndBoundary, nullptr);
nsINode* startRoot = RangeUtils::ComputeRootNode(mStart.Container());
nsINode* endRoot = RangeUtils::ComputeRootNode(mEnd.Container());
nsINode* previousCommonAncestor = mCommonAncestor;
if (startRoot == endRoot) {
MOZ_ASSERT(!startRoot && !endRoot);
MOZ_ASSERT(!aOwner);
// This should be the case when Release() is called.
mCommonAncestor = startRoot;
mOwner = nullptr;
} else {
mCommonAncestor =
nsContentUtils::GetClosestCommonShadowIncludingInclusiveAncestor(
mStart.Container(), mEnd.Container());
MOZ_ASSERT_IF(mOwner, mOwner == aOwner);
if (!mOwner) {
mOwner = aOwner;
}
}
if (previousCommonAncestor != mCommonAncestor) {
if (previousCommonAncestor) {
previousCommonAncestor->RemoveMutationObserver(this);
}
if (mCommonAncestor) {
mCommonAncestor->AddMutationObserver(this);
}
}
}
void CrossShadowBoundaryRange::ContentWillBeRemoved(nsIContent* aChild) {
// It's unclear from the spec about what should the selection be after
//
// For now, we just clear the selection if the removed node is related
// to mStart or mEnd.
MOZ_DIAGNOSTIC_ASSERT(mOwner);
MOZ_DIAGNOSTIC_ASSERT(mOwner->GetCrossShadowBoundaryRange() == this);
RefPtr<CrossShadowBoundaryRange> kungFuDeathGrip(this);
const nsINode* startContainer = mStart.Container();
const nsINode* endContainer = mEnd.Container();
if (startContainer == aChild || endContainer == aChild) {
mOwner->ResetCrossShadowBoundaryRange();
return;
}
if (const auto* shadowRoot = aChild->GetShadowRoot()) {
if (startContainer == shadowRoot || endContainer == shadowRoot) {
mOwner->ResetCrossShadowBoundaryRange();
return;
}
}
if (mStart.Container()->IsShadowIncludingInclusiveDescendantOf(aChild) ||
mEnd.Container()->IsShadowIncludingInclusiveDescendantOf(aChild)) {
mOwner->ResetCrossShadowBoundaryRange();
return;
}
nsINode* container = aChild->GetParentNode();
auto MaybeCreateNewBoundary =
[container, aChild](
const nsINode* aContainer,
const RangeBoundary& aBoundary) -> Maybe<RawRangeBoundary> {
if (container == aContainer) {
// We're only interested if our boundary reference was removed, otherwise
// we can just invalidate the offset.
if (aChild == aBoundary.Ref()) {
return Some<RawRangeBoundary>(
{container, aChild->GetPreviousSibling()});
}
RawRangeBoundary newBoundary;
newBoundary.CopyFrom(aBoundary, RangeBoundaryIsMutationObserved::Yes);
newBoundary.InvalidateOffset();
return Some(newBoundary);
}
return Nothing();
};
const Maybe<RawRangeBoundary> newStartBoundary =
MaybeCreateNewBoundary(startContainer, mStart);
const Maybe<RawRangeBoundary> newEndBoundary =
MaybeCreateNewBoundary(endContainer, mEnd);
if (newStartBoundary || newEndBoundary) {
SetStartAndEnd(newStartBoundary ? newStartBoundary.ref() : mStart.AsRaw(),
newEndBoundary ? newEndBoundary.ref() : mEnd.AsRaw());
}
}
// For now CrossShadowBoundaryRange::CharacterDataChanged is only meant
// to handle the character removal initiated by nsRange::CutContents.
void CrossShadowBoundaryRange::CharacterDataChanged(
nsIContent* aContent, const CharacterDataChangeInfo& aInfo) {
// When aInfo.mDetails is present, it means the character data was
// changed due to splitText() or normalize(), which shouldn't be the
// case for nsRange::CutContents, so we return early.
if (aInfo.mDetails) {
return;
}
MOZ_ASSERT(aContent);
MOZ_ASSERT(mIsPositioned);
auto MaybeCreateNewBoundary =
[aContent,
&aInfo](const RangeBoundary& aBoundary) -> Maybe<RawRangeBoundary> {
// If the changed node contains our start boundary and the change starts
// before the boundary we'll need to adjust the offset.
if (aContent == aBoundary.Container() &&
// aInfo.mChangeStart is the offset where the change starts, if it's
// smaller than the offset of aBoundary, it means the characters
// before the selected content is changed (i.e, removed), so the
// offset of aBoundary needs to be adjusted.
aInfo.mChangeStart <
*aBoundary.Offset(
RangeBoundary::OffsetFilter::kValidOrInvalidOffsets)) {
RawRangeBoundary newStart =
nsRange::ComputeNewBoundaryWhenBoundaryInsideChangedText(
aInfo, aBoundary.AsRaw());
return Some(newStart);
}
return Nothing();
};
const Maybe<RawRangeBoundary> newStartBoundary =
MaybeCreateNewBoundary(mStart);
const Maybe<RawRangeBoundary> newEndBoundary = MaybeCreateNewBoundary(mEnd);
if (newStartBoundary || newEndBoundary) {
DoSetRange(newStartBoundary ? newStartBoundary.ref() : mStart.AsRaw(),
newEndBoundary ? newEndBoundary.ref() : mEnd.AsRaw(), nullptr,
mOwner);
}
}
// DOM mutation for shadow-crossing selection is not specified.
void CrossShadowBoundaryRange::ParentChainChanged(nsIContent* aContent) {
MOZ_DIAGNOSTIC_ASSERT(mCommonAncestor == aContent,
"Wrong ParentChainChanged notification");
MOZ_DIAGNOSTIC_ASSERT(mOwner);
mOwner->ResetCrossShadowBoundaryRange();
}
} // namespace mozilla::dom