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
|
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef THIRD_PARTY_BLINK_RENDERER_MODULES_ACCESSIBILITY_INSPECTOR_ACCESSIBILITY_AGENT_H_
#define THIRD_PARTY_BLINK_RENDERER_MODULES_ACCESSIBILITY_INSPECTOR_ACCESSIBILITY_AGENT_H_
#include "third_party/blink/renderer/core/accessibility/ax_context.h"
#include "third_party/blink/renderer/core/inspector/inspector_base_agent.h"
#include "third_party/blink/renderer/core/inspector/protocol/accessibility.h"
#include "third_party/blink/renderer/modules/modules_export.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_map.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_set.h"
#include "third_party/blink/renderer/platform/heap/disallow_new_wrapper.h"
#include "ui/accessibility/ax_enums.mojom-blink.h"
namespace blink {
class AXObject;
class AXObjectCacheImpl;
class InspectorDOMAgent;
class InspectedFrames;
class LocalFrame;
using protocol::Accessibility::AXNode;
using protocol::Accessibility::AXNodeId;
typedef blink::protocol::Accessibility::Backend::QueryAXTreeCallback
QueryAXTreeCallback;
class MODULES_EXPORT InspectorAccessibilityAgent
: public InspectorBaseAgent<protocol::Accessibility::Metainfo> {
public:
InspectorAccessibilityAgent(InspectedFrames*, InspectorDOMAgent*);
InspectorAccessibilityAgent(const InspectorAccessibilityAgent&) = delete;
InspectorAccessibilityAgent& operator=(const InspectorAccessibilityAgent&) =
delete;
static void ProvideTo(LocalFrame* frame);
// Base agent methods.
void Trace(Visitor*) const override;
void Restore() override;
// Protocol methods.
protocol::Response enable() override;
protocol::Response disable() override;
protocol::Response getPartialAXTree(
std::optional<int> dom_node_id,
std::optional<int> backend_node_id,
std::optional<String> object_id,
std::optional<bool> fetch_relatives,
std::unique_ptr<protocol::Array<protocol::Accessibility::AXNode>>*)
override;
protocol::Response getFullAXTree(
std::optional<int> depth,
std::optional<String> frame_id,
std::unique_ptr<protocol::Array<protocol::Accessibility::AXNode>>*)
override;
protocol::Response getRootAXNode(
std::optional<String> frame_id,
std::unique_ptr<protocol::Accessibility::AXNode>* node) override;
protocol::Response getAXNodeAndAncestors(
std::optional<int> dom_node_id,
std::optional<int> backend_node_id,
std::optional<String> object_id,
std::unique_ptr<protocol::Array<protocol::Accessibility::AXNode>>*
out_nodes) override;
protocol::Response getChildAXNodes(
const String& in_id,
std::optional<String> frame_id,
std::unique_ptr<protocol::Array<protocol::Accessibility::AXNode>>*
out_nodes) override;
// Invoked by CDP clients such as Puppeteer. See
// third_party/blink/public/devtools_protocol/browser_protocol.pdl for me
// details.
void queryAXTree(std::optional<int> dom_node_id,
std::optional<int> backend_node_id,
std::optional<String> object_id,
std::optional<String> accessibleName,
std::optional<String> role,
std::unique_ptr<QueryAXTreeCallback>) override;
// An event was fired on the given AXObject, which should now also be
// considered modified (as if AXObjectModified was called on it).
void AXEventFired(AXObject* object, ax::mojom::blink::Event event);
// The given AXObject (and possibly entire |subtree|) has changed.
void AXObjectModified(AXObject* object, bool subtree);
// Called by the AXObjectCache when a11y is clean and it is safe to traverse
// the a11y tree and fetch object properties.
void AXReadyCallback(Document& document);
void ScheduleAXUpdateIfNeeded(TimerBase*, Document*);
private:
// Timer bound to a Document and an InspectorAccessibilityAgent instance,
// similar to HeapTaskRunnerTimer
// (third_party/blink/renderer/platform/timer.h).
class DocumentTimer final : public TimerBase {
DISALLOW_NEW();
public:
using TimerFiredFunction = void (InspectorAccessibilityAgent::*)(TimerBase*,
Document*);
explicit DocumentTimer(Document* document,
InspectorAccessibilityAgent* agent,
TimerFiredFunction function)
: TimerBase(document->GetTaskRunner(TaskType::kInternalInspector)),
agent_(agent),
document_(document),
function_(function) {}
void Trace(Visitor* visitor) const {
visitor->Trace(document_);
visitor->Trace(agent_);
}
~DocumentTimer() final = default;
protected:
void Fired() override { (agent_->*function_)(this, document_); }
base::OnceClosure BindTimerClosure() final {
return WTF::BindOnce(&DocumentTimer::RunInternalTrampoline,
WTF::Unretained(this),
WrapWeakPersistent(agent_.Get()),
WrapWeakPersistent(document_.Get()));
}
private:
static void RunInternalTrampoline(DocumentTimer* timer,
InspectorAccessibilityAgent* agent,
Document* document) {
// If both the document and the agent have been garbage collected,
// the timer does not fire.
if (agent && document)
timer->RunInternal();
}
WeakMember<InspectorAccessibilityAgent> agent_;
WeakMember<Document> document_;
TimerFiredFunction function_;
};
void CompleteQuery(Node* root_dom_node,
std::optional<String> accessible_name,
std::optional<String> role,
std::unique_ptr<QueryAXTreeCallback> callback);
bool MarkAXObjectDirty(AXObject* ax_object);
// Unconditionally enables the agent, even if |enabled_.Get()==true|.
// For idempotence, call enable().
void EnableAndReset();
LocalFrame* FrameFromIdOrRoot(const std::optional<String>& frame_id);
void ScheduleAXChangeNotification(Document* document);
AXObjectCacheImpl& AttachToAXObjectCache(Document*);
void ProcessPendingDirtyNodes(Document&);
Member<InspectedFrames> inspected_frames_;
Member<InspectorDOMAgent> dom_agent_;
InspectorAgentState::Boolean enabled_;
HashSet<AXID> nodes_requested_;
// The collected dirty AXObjects that should be refreshed in the AX tree view
// in DevTools.
HeapHashMap<WeakMember<Document>,
Member<GCedHeapHashSet<WeakMember<AXObject>>>>
dirty_nodes_;
// Time when every document was synced.
HeapHashMap<WeakMember<Document>, base::Time> last_sync_times_;
// The agent needs to keep AXContext because it enables caching of a11y nodes.
HeapHashMap<WeakMember<Document>, std::unique_ptr<AXContext>>
document_to_context_map_;
// The agent keeps timers per document to make sure throttling of updates
// happens per document.
HeapHashMap<WeakMember<Document>, Member<DisallowNewWrapper<DocumentTimer>>>
timers_;
HeapHashSet<WeakMember<Document>> load_complete_needs_processing_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_MODULES_ACCESSIBILITY_INSPECTOR_ACCESSIBILITY_AGENT_H_
|
