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
|
/* -*- 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 mozilla_RangeUtils_h
#define mozilla_RangeUtils_h
#include "mozilla/Maybe.h"
#include "mozilla/RangeBoundary.h"
#include "nsContentUtils.h"
#include "nsIContent.h"
#include "nsINode.h"
namespace mozilla {
namespace dom {
class AbstractRange;
/**
* ShadowDOMSelectionHelpers contains the static methods to help extra values
* based on whether or not the iterator allows to iterate nodes cross the shadow
* boundary.
*/
struct ShadowDOMSelectionHelpers {
ShadowDOMSelectionHelpers() = delete;
static nsINode* GetStartContainer(
const AbstractRange* aRange,
AllowRangeCrossShadowBoundary aAllowCrossShadowBoundary);
static uint32_t StartOffset(
const AbstractRange* aRange,
AllowRangeCrossShadowBoundary aAllowCrossShadowBoundary);
static nsINode* GetEndContainer(
const AbstractRange* aRange,
AllowRangeCrossShadowBoundary aAllowCrossShadowBoundary);
static uint32_t EndOffset(
const AbstractRange* aRange,
AllowRangeCrossShadowBoundary aAllowCrossShadowBoundary);
static nsINode* GetParentNodeInSameSelection(
const nsINode& aNode,
AllowRangeCrossShadowBoundary aAllowCrossShadowBoundary);
static ShadowRoot* GetShadowRoot(
const nsINode* aNode,
AllowRangeCrossShadowBoundary aAllowCrossShadowBoundary);
};
} // namespace dom
class RangeUtils final {
using AbstractRange = dom::AbstractRange;
public:
/**
* GetRawRangeBoundaryBefore() and GetRawRangeBoundaryAfter() retrieve
* RawRangeBoundary which points before or after aNode.
*/
static const RawRangeBoundary GetRawRangeBoundaryAfter(nsINode* aNode) {
MOZ_ASSERT(aNode);
if (NS_WARN_IF(!aNode->IsContent())) {
return RawRangeBoundary();
}
nsINode* parentNode = aNode->GetParentNode();
if (!parentNode) {
return RawRangeBoundary();
}
RawRangeBoundary afterNode(parentNode, aNode->AsContent());
// If aNode isn't in the child nodes of its parent node, we hit this case.
// This may occur when we're called by a mutation observer while aNode is
// removed from the parent node.
if (NS_WARN_IF(
!afterNode.Offset(RawRangeBoundary::OffsetFilter::kValidOffsets))) {
return RawRangeBoundary();
}
return afterNode;
}
static const RawRangeBoundary GetRawRangeBoundaryBefore(nsINode* aNode) {
MOZ_ASSERT(aNode);
if (NS_WARN_IF(!aNode->IsContent())) {
return RawRangeBoundary();
}
nsINode* parentNode = aNode->GetParentNode();
if (!parentNode) {
return RawRangeBoundary();
}
// If aNode isn't in the child nodes of its parent node, we hit this case.
// This may occur when we're called by a mutation observer while aNode is
// removed from the parent node.
const Maybe<uint32_t> indexInParent = parentNode->ComputeIndexOf(aNode);
if (MOZ_UNLIKELY(NS_WARN_IF(indexInParent.isNothing()))) {
return RawRangeBoundary();
}
return RawRangeBoundary(parentNode, *indexInParent);
}
/**
* Compute the root node of aNode for initializing range classes.
* When aNode is in an anonymous subtree, this returns the shadow root or
* binding parent. Otherwise, the root node of the document or document
* fragment. If this returns nullptr, that means aNode can be neither the
* start container nor end container of any range.
*/
static nsINode* ComputeRootNode(nsINode* aNode);
/**
* XXX nsRange should accept 0 - UINT32_MAX as offset. However, users of
* nsRange treat offset as int32_t. Additionally, some other internal
* APIs like nsINode::ComputeIndexOf_Deprecated() use int32_t. Therefore,
* nsRange should accept only 0 - INT32_MAX as valid offset for now.
*/
static bool IsValidOffset(uint32_t aOffset) { return aOffset <= INT32_MAX; }
/**
* Return true if aStartContainer/aStartOffset and aEndContainer/aEndOffset
* are valid start and end points for a range. Otherwise, return false.
*/
static bool IsValidPoints(nsINode* aStartContainer, uint32_t aStartOffset,
nsINode* aEndContainer, uint32_t aEndOffset) {
return IsValidPoints(RawRangeBoundary(aStartContainer, aStartOffset),
RawRangeBoundary(aEndContainer, aEndOffset));
}
template <typename SPT, typename SRT, typename EPT, typename ERT>
static bool IsValidPoints(const RangeBoundaryBase<SPT, SRT>& aStartBoundary,
const RangeBoundaryBase<EPT, ERT>& aEndBoundary);
/**
* The caller needs to ensure aNode is in the same doc like aAbstractRange.
*/
template <TreeKind aKind = TreeKind::ShadowIncludingDOM,
typename = std::enable_if_t<aKind == TreeKind::ShadowIncludingDOM ||
aKind == TreeKind::Flat>>
static Maybe<bool> IsNodeContainedInRange(nsINode& aNode,
AbstractRange* aAbstractRange);
/**
* Utility routine to detect if a content node starts before a range and/or
* ends after a range. If neither it is contained inside the range.
* Note that callers responsibility to ensure node in same doc as range.
*/
template <TreeKind aKind = TreeKind::ShadowIncludingDOM,
typename = std::enable_if_t<aKind == TreeKind::ShadowIncludingDOM ||
aKind == TreeKind::Flat>>
static nsresult CompareNodeToRange(nsINode* aNode,
AbstractRange* aAbstractRange,
bool* aNodeIsBeforeRange,
bool* aNodeIsAfterRange);
template <TreeKind aKind, typename SPT, typename SRT, typename EPT,
typename ERT,
typename = std::enable_if_t<aKind == TreeKind::ShadowIncludingDOM ||
aKind == TreeKind::Flat>>
static nsresult CompareNodeToRangeBoundaries(
nsINode* aNode, const RangeBoundaryBase<SPT, SRT>& aStartBoundary,
const RangeBoundaryBase<EPT, ERT>& aEndBoundary, bool* aNodeIsBeforeRange,
bool* aNodeIsAfterRange);
};
} // namespace mozilla
#endif // #ifndef mozilla_RangeUtils_h
|
