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
|
/*
* Copyright (C) 2023 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "AccessibilityObject.h"
namespace WebCore {
struct CharacterOffset;
struct TextMarkerData {
unsigned treeID;
unsigned objectID;
Node* node;
unsigned offset;
Position::AnchorType anchorType;
Affinity affinity;
unsigned characterStart;
unsigned characterOffset;
bool ignored;
// Constructors of TextMarkerData must zero the struct's block of memory because platform client code may rely on a byte-comparison to determine instances equality.
// Members initialization alone is not enough to guaranty that all bytes in the struct memeory are initialized, and may cause random inequalities when doing byte-comparisons.
// For an exampel of such byte-comparison, see the TestRunner WTR::AccessibilityTextMarker::isEqual.
TextMarkerData()
{
memset(static_cast<void*>(this), 0, sizeof(*this));
}
TextMarkerData(AXID axTreeID, AXID axObjectID,
Node* nodeParam = nullptr, unsigned offsetParam = 0,
Position::AnchorType anchorTypeParam = Position::PositionIsOffsetInAnchor,
Affinity affinityParam = Affinity::Downstream,
unsigned charStart = 0, unsigned charOffset = 0, bool ignoredParam = false)
{
memset(static_cast<void*>(this), 0, sizeof(*this));
treeID = axTreeID.toUInt64();
objectID = axObjectID.toUInt64();
node = nodeParam;
offset = offsetParam;
anchorType = anchorTypeParam;
affinity = affinityParam;
characterStart = charStart;
characterOffset = charOffset;
ignored = ignoredParam;
}
TextMarkerData(AXObjectCache&, Node*, const VisiblePosition&, int charStart = 0, int charOffset = 0, bool ignoredParam = false);
TextMarkerData(AXObjectCache&, const CharacterOffset&, bool ignoredParam = false);
AXID axTreeID() const
{
return ObjectIdentifier<AXIDType>(treeID);
}
AXID axObjectID() const
{
return ObjectIdentifier<AXIDType>(objectID);
}
private:
void initializeAXIDs(AXObjectCache&, Node*);
};
#if PLATFORM(MAC)
using PlatformTextMarkerData = AXTextMarkerRef;
#elif PLATFORM(IOS_FAMILY)
using PlatformTextMarkerData = NSData *;;
#endif
class AXTextMarker {
WTF_MAKE_FAST_ALLOCATED;
friend class AXTextMarkerRange;
friend std::partial_ordering partialOrder(const AXTextMarker&, const AXTextMarker&);
public:
// Constructors
AXTextMarker(const VisiblePosition&);
AXTextMarker(const CharacterOffset&);
AXTextMarker(const TextMarkerData& data)
: m_data(data)
{ }
AXTextMarker(TextMarkerData&& data)
: m_data(data)
{ }
#if PLATFORM(COCOA)
AXTextMarker(PlatformTextMarkerData);
#endif
AXTextMarker() = default;
operator bool() const { return !isNull(); }
operator VisiblePosition() const;
operator CharacterOffset() const;
std::optional<BoundaryPoint> boundaryPoint() const;
#if PLATFORM(COCOA)
RetainPtr<PlatformTextMarkerData> platformData() const;
operator PlatformTextMarkerData() const { return platformData().autorelease(); }
#endif
AXID treeID() const { return m_data.axTreeID(); }
AXID objectID() const { return m_data.axObjectID(); }
bool isNull() const { return !treeID().isValid() || !objectID().isValid(); }
RefPtr<AXCoreObject> object() const;
bool isValid() const { return object(); }
Node* node() const;
bool isIgnored() const { return m_data.ignored; }
#if ENABLE(TREE_DEBUGGING)
String debugDescription() const;
#endif
// Sets m_data.node when the marker was created with a PlatformTextMarkerData that lacks the node pointer because it was created off the main thread.
void setNodeIfNeeded() const;
private:
TextMarkerData m_data;
};
class AXTextMarkerRange {
WTF_MAKE_FAST_ALLOCATED;
public:
// Constructors.
AXTextMarkerRange(const VisiblePositionRange&);
AXTextMarkerRange(const std::optional<SimpleRange>&);
AXTextMarkerRange(const AXTextMarker&, const AXTextMarker&);
#if PLATFORM(MAC)
AXTextMarkerRange(AXTextMarkerRangeRef);
#endif
AXTextMarkerRange(AXID treeID, AXID objectID, unsigned offset, unsigned length);
AXTextMarkerRange() = default;
operator bool() const { return m_start && m_end; }
operator VisiblePositionRange() const;
std::optional<SimpleRange> simpleRange() const;
std::optional<CharacterRange> characterRange() const;
#if PLATFORM(MAC)
RetainPtr<AXTextMarkerRangeRef> platformData() const;
operator AXTextMarkerRangeRef() const { return platformData().autorelease(); }
#endif
#if PLATFORM(COCOA)
std::optional<NSRange> nsRange() const;
#endif
AXTextMarker start() const { return m_start; }
AXTextMarker end() const { return m_end; }
bool isConfinedTo(AXID) const;
private:
AXTextMarker m_start;
AXTextMarker m_end;
};
inline Node* AXTextMarker::node() const
{
ASSERT(isMainThread());
return m_data.node;
}
} // namespace WebCore
|
