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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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_a11y_HyperTextAccessible_h__
#define mozilla_a11y_HyperTextAccessible_h__
#include "AccessibleWrap.h"
#include "mozilla/a11y/HyperTextAccessibleBase.h"
#include "nsIAccessibleText.h"
#include "nsIAccessibleTypes.h"
#include "nsIFrame.h" // only for nsSelectionAmount
#include "nsISelectionController.h"
class nsFrameSelection;
class nsIFrame;
class nsRange;
class nsIWidget;
namespace mozilla {
class EditorBase;
namespace dom {
class Selection;
}
namespace a11y {
class TextLeafPoint;
class TextRange;
struct DOMPoint {
DOMPoint() : node(nullptr), idx(0) {}
DOMPoint(nsINode* aNode, int32_t aIdx) : node(aNode), idx(aIdx) {}
nsINode* node;
int32_t idx;
};
/**
* Special Accessible that knows how contain both text and embedded objects
*/
class HyperTextAccessible : public AccessibleWrap,
public HyperTextAccessibleBase {
public:
HyperTextAccessible(nsIContent* aContent, DocAccessible* aDoc);
NS_INLINE_DECL_REFCOUNTING_INHERITED(HyperTextAccessible, AccessibleWrap)
// LocalAccessible
virtual already_AddRefed<AccAttributes> NativeAttributes() override;
virtual mozilla::a11y::role NativeRole() const override;
virtual uint64_t NativeState() const override;
virtual void Shutdown() override;
virtual bool RemoveChild(LocalAccessible* aAccessible) override;
virtual bool InsertChildAt(uint32_t aIndex, LocalAccessible* aChild) override;
virtual Relation RelationByType(RelationType aType) const override;
/**
* Return whether the associated content is editable.
*/
bool IsEditable() const;
// HyperTextAccessible (static helper method)
// Convert content offset to rendered text offset
nsresult ContentToRenderedOffset(nsIFrame* aFrame, int32_t aContentOffset,
uint32_t* aRenderedOffset) const;
// Convert rendered text offset to content offset
nsresult RenderedToContentOffset(nsIFrame* aFrame, uint32_t aRenderedOffset,
int32_t* aContentOffset) const;
//////////////////////////////////////////////////////////////////////////////
// HyperLinkAccessible
/**
* Return link accessible at the given index.
*/
LocalAccessible* LinkAt(uint32_t aIndex) {
Accessible* child = EmbeddedChildAt(aIndex);
return child ? child->AsLocal() : nullptr;
}
//////////////////////////////////////////////////////////////////////////////
// HyperTextAccessible: DOM point to text offset conversions.
/**
* Turn a DOM point (node and offset) into a character offset of this
* hypertext. Will look for closest match when the DOM node does not have
* an accessible object associated with it. Will return an offset for the end
* of the string if the node is not found.
*
* @param aNode [in] the node to look for
* @param aNodeOffset [in] the offset to look for
* if -1 just look directly for the node
* if >=0 and aNode is text, this represents a char
* offset if >=0 and aNode is not text, this represents a child node offset
* @param aIsEndOffset [in] if true, then this offset is not inclusive. The
* character indicated by the offset returned is at [offset - 1]. This means
* if the passed-in offset is really in a descendant, then the offset
* returned will come just after the relevant embedded object characer. If
* false, then the offset is inclusive. The character indicated by the offset
* returned is at [offset]. If the passed-in offset in inside a descendant,
* then the returned offset will be on the relevant embedded object char.
*/
uint32_t DOMPointToOffset(nsINode* aNode, int32_t aNodeOffset,
bool aIsEndOffset = false) const;
/**
* Transform the given a11y point into the offset relative this hypertext.
*/
uint32_t TransformOffset(LocalAccessible* aDescendant, uint32_t aOffset,
bool aIsEndOffset) const;
/**
* Convert the given offset into DOM point.
*
* If offset is at text leaf then DOM point is (text node, offsetInTextNode),
* if before embedded object then (parent node, indexInParent), if after then
* (parent node, indexInParent + 1).
*/
DOMPoint OffsetToDOMPoint(int32_t aOffset) const;
//////////////////////////////////////////////////////////////////////////////
// TextAccessible
virtual already_AddRefed<AccAttributes> DefaultTextAttributes() override;
// HyperTextAccessibleBase provides an overload which takes an Accessible.
using HyperTextAccessibleBase::GetChildOffset;
virtual LocalAccessible* GetChildAtOffset(uint32_t aOffset) const override {
return LocalChildAt(GetChildIndexAtOffset(aOffset));
}
/**
* Return an offset at the given point.
*/
int32_t OffsetAtPoint(int32_t aX, int32_t aY, uint32_t aCoordType) override;
/**
* Get/set caret offset, if no caret then -1.
*/
virtual int32_t CaretOffset() const override;
virtual void SetCaretOffset(int32_t aOffset) override;
virtual int32_t CaretLineNumber() override;
/**
* Return the caret rect and the widget containing the caret within this
* text accessible.
*
* @param [out] the widget containing the caret
* @return the caret rect
*/
mozilla::LayoutDeviceIntRect GetCaretRect(nsIWidget** aWidget);
/**
* Return true if caret is at end of line.
*/
bool IsCaretAtEndOfLine() const;
virtual int32_t SelectionCount() override;
virtual bool SelectionBoundsAt(int32_t aSelectionNum, int32_t* aStartOffset,
int32_t* aEndOffset) override;
MOZ_CAN_RUN_SCRIPT_BOUNDARY virtual bool RemoveFromSelection(
int32_t aSelectionNum) override;
virtual void ScrollSubstringToPoint(int32_t aStartOffset, int32_t aEndOffset,
uint32_t aCoordinateType, int32_t aX,
int32_t aY) override;
virtual void SelectionRanges(nsTArray<TextRange>* aRanges) const override;
//////////////////////////////////////////////////////////////////////////////
// EditableTextAccessible
MOZ_CAN_RUN_SCRIPT_BOUNDARY virtual void ReplaceText(
const nsAString& aText) override;
MOZ_CAN_RUN_SCRIPT_BOUNDARY virtual void InsertText(
const nsAString& aText, int32_t aPosition) override;
MOZ_CAN_RUN_SCRIPT_BOUNDARY virtual void CopyText(int32_t aStartPos,
int32_t aEndPos) override;
MOZ_CAN_RUN_SCRIPT_BOUNDARY virtual void CutText(int32_t aStartPos,
int32_t aEndPos) override;
MOZ_CAN_RUN_SCRIPT_BOUNDARY virtual void DeleteText(int32_t aStartPos,
int32_t aEndPos) override;
MOZ_CAN_RUN_SCRIPT virtual void PasteText(int32_t aPosition) override;
/**
* Return the editor associated with the accessible.
* The result may be either TextEditor or HTMLEditor.
*/
virtual already_AddRefed<EditorBase> GetEditor() const;
/**
* Return DOM selection object for the accessible.
*/
dom::Selection* DOMSelection() const;
protected:
virtual ~HyperTextAccessible() {}
// LocalAccessible
virtual ENameValueFlag NativeName(nsString& aName) const override;
// HyperTextAccessible
// Selection helpers
/**
* Return frame selection object for the accessible.
*/
already_AddRefed<nsFrameSelection> FrameSelection() const;
/**
* Return selection ranges within the accessible subtree.
*/
void GetSelectionDOMRanges(SelectionType aSelectionType,
nsTArray<nsRange*>* aRanges);
// TODO: annotate this with `MOZ_CAN_RUN_SCRIPT` instead.
MOZ_CAN_RUN_SCRIPT_BOUNDARY nsresult SetSelectionRange(int32_t aStartPos,
int32_t aEndPos);
// Helpers
/**
* Set xml-roles attributes for MathML elements.
* @param aAttributes
*/
void SetMathMLXMLRoles(AccAttributes* aAttributes);
// HyperTextAccessibleBase
virtual const Accessible* Acc() const override { return this; }
virtual nsTArray<int32_t>& GetCachedHyperTextOffsets() override {
return mOffsets;
}
private:
/**
* End text offsets array.
*/
mutable nsTArray<int32_t> mOffsets;
};
////////////////////////////////////////////////////////////////////////////////
// LocalAccessible downcasting method
inline HyperTextAccessible* LocalAccessible::AsHyperText() {
return IsHyperText() ? static_cast<HyperTextAccessible*>(this) : nullptr;
}
inline HyperTextAccessibleBase* LocalAccessible::AsHyperTextBase() {
return AsHyperText();
}
} // namespace a11y
} // namespace mozilla
#endif
|
