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
|
/*
* (C) 1999 Lars Knoll (knoll@kde.org)
* (C) 2000 Gunnstein Lye (gunnstein@netcom.no)
* (C) 2000 Frederik Holljen (frederik.holljen@hig.no)
* (C) 2001 Peter Kelly (pmk@post.com)
* Copyright (C) 2004-2020 Apple Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#pragma once
#include "AbstractRange.h"
#include "RangeBoundaryPoint.h"
#include <wtf/WeakPtr.h>
namespace WebCore {
class DOMRect;
class DOMRectList;
class DocumentFragment;
class LocalDOMWindow;
class NodeWithIndex;
class Text;
struct SimpleRange;
class Range final : public AbstractRange, public CanMakeWeakPtr<Range> {
WTF_MAKE_ISO_ALLOCATED(Range);
public:
WEBCORE_EXPORT static Ref<Range> create(Document&);
WEBCORE_EXPORT ~Range();
Node& startContainer() const final { return m_start.container(); }
unsigned startOffset() const final { return m_start.offset(); }
Node& endContainer() const final { return m_end.container(); }
unsigned endOffset() const final { return m_end.offset(); }
bool collapsed() const final { return m_start == m_end; }
WEBCORE_EXPORT Node* commonAncestorContainer() const;
void resetDidChangeHighlight() { m_didChangeHighlight = false; }
bool didChangeHighlight() const { return m_didChangeHighlight; }
WEBCORE_EXPORT ExceptionOr<void> setStart(Ref<Node>&&, unsigned offset);
WEBCORE_EXPORT ExceptionOr<void> setEnd(Ref<Node>&&, unsigned offset);
WEBCORE_EXPORT ExceptionOr<void> setStartBefore(Node&);
WEBCORE_EXPORT ExceptionOr<void> setStartAfter(Node&);
WEBCORE_EXPORT ExceptionOr<void> setEndBefore(Node&);
WEBCORE_EXPORT ExceptionOr<void> setEndAfter(Node&);
WEBCORE_EXPORT void collapse(bool toStart);
WEBCORE_EXPORT ExceptionOr<void> selectNode(Node&);
WEBCORE_EXPORT ExceptionOr<void> selectNodeContents(Node&);
enum CompareHow : unsigned short { START_TO_START, START_TO_END, END_TO_END, END_TO_START };
WEBCORE_EXPORT ExceptionOr<short> compareBoundaryPoints(unsigned short compareHow, const Range& sourceRange) const;
WEBCORE_EXPORT ExceptionOr<void> deleteContents();
WEBCORE_EXPORT ExceptionOr<Ref<DocumentFragment>> extractContents();
WEBCORE_EXPORT ExceptionOr<Ref<DocumentFragment>> cloneContents();
WEBCORE_EXPORT ExceptionOr<void> insertNode(Ref<Node>&&);
WEBCORE_EXPORT ExceptionOr<void> surroundContents(Node&);
WEBCORE_EXPORT Ref<Range> cloneRange() const;
static void detach() { }
WEBCORE_EXPORT ExceptionOr<bool> isPointInRange(Node&, unsigned offset);
WEBCORE_EXPORT ExceptionOr<short> comparePoint(Node&, unsigned offset) const;
WEBCORE_EXPORT bool intersectsNode(Node&) const;
WEBCORE_EXPORT String toString() const;
Ref<DOMRectList> getClientRects() const;
Ref<DOMRect> getBoundingClientRect() const;
WEBCORE_EXPORT ExceptionOr<Ref<DocumentFragment>> createContextualFragment(const String& fragment);
// Expand range to a unit (word or sentence or block or document) boundary.
// Please refer to https://bugs.webkit.org/show_bug.cgi?id=27632 comment #5 for details.
WEBCORE_EXPORT ExceptionOr<void> expand(const String&);
enum CompareResults : uint8_t { NODE_BEFORE, NODE_AFTER, NODE_BEFORE_AND_AFTER, NODE_INSIDE };
WEBCORE_EXPORT ExceptionOr<CompareResults> compareNode(Node&) const;
void nodeChildrenChanged(ContainerNode&);
void nodeChildrenWillBeRemoved(ContainerNode&);
void nodeWillBeRemoved(Node&);
bool parentlessNodeMovedToNewDocumentAffectsRange(Node&);
void updateRangeForParentlessNodeMovedToNewDocument(Node&);
void textInserted(Node&, unsigned offset, unsigned length);
void textRemoved(Node&, unsigned offset, unsigned length);
void textNodesMerged(NodeWithIndex& oldNode, unsigned offset);
void textNodeSplit(Text& oldNode);
void didAssociateWithSelection() { m_isAssociatedWithSelection = true; }
void didDisassociateFromSelection() { m_isAssociatedWithSelection = false; }
void updateFromSelection(const SimpleRange&);
// For use by garbage collection. Returns nullptr for ranges not assocated with selection.
LocalDOMWindow* window() const;
static ExceptionOr<Node*> checkNodeOffsetPair(Node&, unsigned offset);
#if ENABLE(TREE_DEBUGGING)
String debugDescription() const;
#endif
void visitNodesConcurrently(JSC::AbstractSlotVisitor&) const;
enum ActionType : uint8_t { Delete, Extract, Clone };
private:
explicit Range(Document&);
bool isLiveRange() const final { return true; }
void updateDocument();
void updateAssociatedSelection();
ExceptionOr<RefPtr<DocumentFragment>> processContents(ActionType);
Ref<Document> m_ownerDocument;
RangeBoundaryPoint m_start;
RangeBoundaryPoint m_end;
bool m_isAssociatedWithSelection { false };
bool m_didChangeHighlight { false };
};
WEBCORE_EXPORT SimpleRange makeSimpleRange(const Range&);
WEBCORE_EXPORT SimpleRange makeSimpleRange(const Ref<Range>&);
WEBCORE_EXPORT std::optional<SimpleRange> makeSimpleRange(const Range*);
WEBCORE_EXPORT std::optional<SimpleRange> makeSimpleRange(const RefPtr<Range>&);
WEBCORE_EXPORT Ref<Range> createLiveRange(const SimpleRange&);
WEBCORE_EXPORT RefPtr<Range> createLiveRange(const std::optional<SimpleRange>&);
} // namespace WebCore
#if ENABLE(TREE_DEBUGGING)
// Outside the WebCore namespace for ease of invocation from the debugger.
void showTree(const WebCore::Range*);
#endif
SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Range)
static bool isType(const WebCore::AbstractRange& range) { return range.isLiveRange(); }
SPECIALIZE_TYPE_TRAITS_END()
|
