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 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ui/accessibility/ax_tree_manager_base.h"
#include <set>
#include <utility>
#include "base/check_op.h"
#include "base/no_destructor.h"
#include "base/notreached.h"
#include "ui/accessibility/ax_node.h"
namespace ui {
// static
AXTreeManagerBase* AXTreeManagerBase::GetManager(const AXTreeID& tree_id) {
if (tree_id.type() == ax::mojom::AXTreeIDType::kUnknown)
return nullptr;
auto iter = GetTreeManagerMapInstance().find(tree_id);
if (iter == GetTreeManagerMapInstance().end())
return nullptr;
return iter->second;
}
// static
std::unordered_map<AXTreeID, AXTreeManagerBase*, AXTreeIDHash>&
AXTreeManagerBase::GetTreeManagerMapInstance() {
static base::NoDestructor<
std::unordered_map<AXTreeID, AXTreeManagerBase*, AXTreeIDHash>>
map_instance;
return *map_instance;
}
AXTreeManagerBase::AXTreeManagerBase() = default;
AXTreeManagerBase::AXTreeManagerBase(std::unique_ptr<AXTree> tree) {
if (!tree)
return;
const AXTreeID& tree_id = tree->GetAXTreeID();
if (tree_id.type() == ax::mojom::AXTreeIDType::kUnknown) {
NOTREACHED() << "Invalid tree ID.\n" << tree->ToString();
return;
}
tree_ = std::move(tree);
GetTreeManagerMapInstance()[tree_id] = this;
}
AXTreeManagerBase::AXTreeManagerBase(const AXTreeUpdate& initial_state)
: AXTreeManagerBase(std::make_unique<AXTree>(initial_state)) {}
AXTreeManagerBase::~AXTreeManagerBase() {
if (!tree_)
return;
DCHECK_NE(GetTreeID().type(), ax::mojom::AXTreeIDType::kUnknown);
tree_->NotifyTreeManagerWillBeRemoved(GetTreeID());
GetTreeManagerMapInstance().erase(GetTreeID());
}
AXTreeManagerBase::AXTreeManagerBase(AXTreeManagerBase&& manager) {
if (!manager.tree_) {
ReleaseTree();
return;
}
manager.tree_->NotifyTreeManagerWillBeRemoved(manager.GetTreeID());
GetTreeManagerMapInstance().erase(manager.GetTreeID());
SetTree(std::move(manager.tree_));
}
AXTreeManagerBase& AXTreeManagerBase::operator=(AXTreeManagerBase&& manager) {
if (this == &manager)
return *this;
if (manager.tree_) {
manager.tree_->NotifyTreeManagerWillBeRemoved(manager.GetTreeID());
GetTreeManagerMapInstance().erase(manager.GetTreeID());
SetTree(std::move(manager.tree_));
} else {
ReleaseTree();
}
return *this;
}
AXTree* AXTreeManagerBase::GetTree() const {
return tree_.get();
}
std::unique_ptr<AXTree> AXTreeManagerBase::SetTree(
std::unique_ptr<AXTree> tree) {
if (!tree) {
NOTREACHED()
<< "Attempting to set a new tree, but no tree has been provided.";
return {};
}
if (tree->GetAXTreeID().type() == ax::mojom::AXTreeIDType::kUnknown) {
NOTREACHED() << "Invalid tree ID.\n" << tree->ToString();
return {};
}
if (tree_) {
tree_->NotifyTreeManagerWillBeRemoved(GetTreeID());
GetTreeManagerMapInstance().erase(GetTreeID());
}
std::swap(tree_, tree);
GetTreeManagerMapInstance()[GetTreeID()] = this;
return tree;
}
std::unique_ptr<AXTree> AXTreeManagerBase::SetTree(
const AXTreeUpdate& initial_state) {
return SetTree(std::make_unique<AXTree>(initial_state));
}
std::unique_ptr<AXTree> AXTreeManagerBase::ReleaseTree() {
if (!tree_)
return {};
tree_->NotifyTreeManagerWillBeRemoved(GetTreeID());
GetTreeManagerMapInstance().erase(GetTreeID());
return std::move(tree_);
}
AXTreeUpdate AXTreeManagerBase::SnapshotTree() const {
NOTIMPLEMENTED();
return {};
}
bool AXTreeManagerBase::ApplyTreeUpdate(const AXTreeUpdate& update) {
if (tree_)
return tree_->Unserialize(update);
return false;
}
const AXTreeID& AXTreeManagerBase::GetTreeID() const {
if (tree_)
return tree_->GetAXTreeID();
return AXTreeIDUnknown();
}
const AXTreeID& AXTreeManagerBase::GetParentTreeID() const {
if (tree_)
return GetTreeData().parent_tree_id;
return AXTreeIDUnknown();
}
const AXTreeData& AXTreeManagerBase::GetTreeData() const {
static const base::NoDestructor<AXTreeData> empty_tree_data;
if (tree_)
return tree_->data();
return *empty_tree_data;
}
// static
AXNode* AXTreeManagerBase::GetNodeFromTree(const AXTreeID& tree_id,
const AXNodeID& node_id) {
const AXTreeManagerBase* manager = GetManager(tree_id);
if (manager)
return manager->GetNode(node_id);
return nullptr;
}
AXNode* AXTreeManagerBase::GetNode(const AXNodeID& node_id) const {
if (tree_)
return tree_->GetFromId(node_id);
return nullptr;
}
AXNode* AXTreeManagerBase::GetRoot() const {
if (!tree_)
return nullptr;
// tree_->root() can be nullptr during `AXTreeObserver` callbacks.
return tree_->root();
}
AXNode* AXTreeManagerBase::GetRootOfChildTree(
const AXNodeID& host_node_id) const {
const AXNode* host_node = GetNode(host_node_id);
if (host_node)
return GetRootOfChildTree(*host_node);
return nullptr;
}
AXNode* AXTreeManagerBase::GetRootOfChildTree(const AXNode& host_node) const {
const AXTreeID& child_tree_id = AXTreeID::FromString(
host_node.GetStringAttribute(ax::mojom::StringAttribute::kChildTreeId));
const AXTreeManagerBase* child_manager = GetManager(child_tree_id);
if (!child_manager || !child_manager->GetTree())
return nullptr;
// `AXTree::root()` can be nullptr during `AXTreeObserver` callbacks.
return child_manager->GetTree()->root();
}
AXNode* AXTreeManagerBase::GetHostNode() const {
const AXTreeID& parent_tree_id = GetParentTreeID();
const AXTreeManagerBase* parent_manager = GetManager(parent_tree_id);
if (!parent_manager || !parent_manager->GetTree())
return nullptr; // The parent tree is not present or is empty.
const std::set<AXNodeID>& host_node_ids =
parent_manager->GetTree()->GetNodeIdsForChildTreeId(GetTreeID());
if (host_node_ids.empty()) {
// The parent tree is present but is still not connected. A connection will
// be established when it updates one of its nodes, turning it into a host
// node pointing to this child tree.
return nullptr;
}
DCHECK_EQ(host_node_ids.size(), 1u)
<< "Multiple nodes claim the same child tree ID.";
const AXNodeID& host_node_id = *host_node_ids.begin();
AXNode* parent_node = parent_manager->GetNode(host_node_id);
DCHECK(parent_node);
DCHECK_EQ(GetTreeID(), AXTreeID::FromString(parent_node->GetStringAttribute(
ax::mojom::StringAttribute::kChildTreeId)))
<< "A node that hosts a child tree should expose its tree ID in its "
"`kChildTreeId` attribute.";
return parent_node;
}
bool AXTreeManagerBase::AttachChildTree(const AXNodeID& host_node_id,
AXTreeManagerBase& child_manager) {
AXNode* host_node = GetNode(host_node_id);
if (host_node)
return AttachChildTree(*host_node, child_manager);
return false;
}
bool AXTreeManagerBase::AttachChildTree(AXNode& host_node,
AXTreeManagerBase& child_manager) {
if (!tree_ || !child_manager.GetTree())
return false;
if (child_manager.GetParentTreeID().type() !=
ax::mojom::AXTreeIDType::kUnknown) {
return false; // Child manager already attached to another host node.
}
DCHECK_EQ(GetNode(host_node.id()), &host_node)
<< "`host_node` should belong to this manager.";
DCHECK(host_node.tree())
<< "A node should always be attached to its owning tree.";
DCHECK_NE(GetTreeID().type(), ax::mojom::AXTreeIDType::kUnknown);
DCHECK_NE(child_manager.GetTreeID().type(),
ax::mojom::AXTreeIDType::kUnknown);
if (!host_node.IsLeaf()) {
// For now, child trees can only be attached on leaf nodes, otherwise
// behavior would be ambiguous.
return false;
}
{
AXNodeData host_node_data = host_node.data();
DCHECK(
!host_node.HasStringAttribute(ax::mojom::StringAttribute::kChildTreeId))
<< "`AXNode::IsLeaf()` should mark all nodes with child tree IDs as "
"leaves.\n"
<< host_node;
host_node_data.AddChildTreeId(child_manager.GetTreeID());
AXTreeUpdate update;
update.nodes = {host_node_data};
CHECK(ApplyTreeUpdate(update)) << GetTree()->error();
}
{
AXTreeData tree_data = child_manager.GetTreeData();
tree_data.parent_tree_id = GetTreeID();
AXTreeUpdate update;
update.has_tree_data = true;
update.tree_data = tree_data;
CHECK(child_manager.ApplyTreeUpdate(update))
<< child_manager.GetTree()->error();
}
return true;
}
absl::optional<AXTreeManagerBase> AXTreeManagerBase::AttachChildTree(
const AXNodeID& host_node_id,
const AXTreeUpdate& initial_state) {
AXNode* host_node = GetNode(host_node_id);
if (host_node)
return AttachChildTree(*host_node, initial_state);
return absl::nullopt;
}
absl::optional<AXTreeManagerBase> AXTreeManagerBase::AttachChildTree(
AXNode& host_node,
const AXTreeUpdate& initial_state) {
AXTreeManagerBase child_manager(initial_state);
if (AttachChildTree(host_node, child_manager))
return child_manager;
return absl::nullopt;
}
AXTreeManagerBase* AXTreeManagerBase::DetachChildTree(
const AXNodeID& host_node_id) {
AXNode* host_node = GetNode(host_node_id);
if (host_node)
return DetachChildTree(*host_node);
return nullptr;
}
AXTreeManagerBase* AXTreeManagerBase::DetachChildTree(AXNode& host_node) {
if (!tree_)
return nullptr;
DCHECK_EQ(GetNode(host_node.id()), &host_node)
<< "`host_node` should belong to this manager.";
DCHECK(host_node.tree())
<< "A node should always be attached to its owning tree.";
DCHECK_NE(GetTreeID().type(), ax::mojom::AXTreeIDType::kUnknown);
if (!host_node.IsLeaf()) {
// For now, child trees are only allowed to be attached on leaf nodes,
// otherwise behavior would be ambiguous.
return nullptr;
}
const AXTreeID& child_tree_id = AXTreeID::FromString(
host_node.GetStringAttribute(ax::mojom::StringAttribute::kChildTreeId));
AXTreeManagerBase* child_manager = GetManager(child_tree_id);
if (!child_manager || !child_manager->GetTree())
return nullptr;
DCHECK_NE(child_manager->GetTreeID().type(),
ax::mojom::AXTreeIDType::kUnknown);
{
AXNodeData host_node_data = host_node.data();
DCHECK_NE(child_manager->GetTreeData().parent_tree_id.type(),
ax::mojom::AXTreeIDType::kUnknown)
<< "Child tree should be attached to its host node.\n"
<< host_node;
host_node_data.RemoveStringAttribute(
ax::mojom::StringAttribute::kChildTreeId);
AXTreeUpdate update;
update.nodes = {host_node_data};
CHECK(ApplyTreeUpdate(update)) << GetTree()->error();
}
{
AXTreeData tree_data = child_manager->GetTreeData();
tree_data.parent_tree_id = AXTreeIDUnknown();
AXTreeUpdate update;
update.has_tree_data = true;
update.tree_data = tree_data;
CHECK(child_manager->ApplyTreeUpdate(update))
<< child_manager->GetTree()->error();
}
return child_manager;
}
} // namespace ui
|