File: ns_ax_tree_validator.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (52 lines) | stat: -rw-r--r-- 1,603 bytes parent folder | download | duplicates (6)
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
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_BASE_TEST_NS_AX_TREE_VALIDATOR_H_
#define UI_BASE_TEST_NS_AX_TREE_VALIDATOR_H_

#include <optional>
#include <string>

@protocol NSAccessibility;

namespace ui {

struct NSAXTreeProblemDetails {
  enum ProblemType {
    // `node_a` (the child node) is not a child of `node_b` (its "parent").
    NSAX_NOT_CHILD_OF_PARENT,

    // `node_a` (a supplied root node) is non-nil but does not conform to
    // NSAccessibility.
    NSAX_NOT_NSACCESSIBILITY,

    // `node_a` (the child node)'s parent `node_b` is non-nil but does not
    // conform to NSAccessibility.
    NSAX_PARENT_NOT_NSACCESSIBILITY,
  };

  NSAXTreeProblemDetails(ProblemType type, id node_a, id node_b);

  ProblemType type;
  // These aren't id<NSAccessibility> because some kinds of problem are caused
  // by them not conforming to NSAccessibility.
  id node_a;
  id node_b;

  std::string ToString();
};

// Validates the accessibility tree rooted at `root`. If at least one problem is
// found, returns an `AXTreeProblemDetails` as described above; if not, returns
// std::nullopt.
std::optional<NSAXTreeProblemDetails> ValidateNSAXTree(id<NSAccessibility> root,
                                                       size_t* nodes_visited);

// Prints the accessibility tree rooted at `root`. This function is useful for
// debugging failures of ValidateNSAXTree tests.
void PrintNSAXTree(id<NSAccessibility> root);

}  // ui

#endif  // UI_BASE_TEST_NS_AX_TREE_VALIDATOR_H_