File: ax_platform_node_id.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (63 lines) | stat: -rw-r--r-- 2,460 bytes parent folder | download | duplicates (5)
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
// Copyright 2024 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_ACCESSIBILITY_PLATFORM_AX_PLATFORM_NODE_ID_H_
#define UI_ACCESSIBILITY_PLATFORM_AX_PLATFORM_NODE_ID_H_

#include <stdint.h>

#include "base/types/pass_key.h"
#include "base/types/strong_alias.h"

namespace ui {

class AXNodeIdDelegate;

// The underlying type of a uniquely-generated accessibility node identifier for
// use with the platform. The actual id store can only a accommodate 32 bit
// integers on Windows, because IAccessible2 uses LONG for get_uniqueID() and
// for event target ids. In addition, the signed values have special meaning, so
// the id must be between 1 and 2^31-1.
//
// These ids must not be conflated with the int id or AXNodeId, that comes with
// web node data, which are only unique within their source frame.
//
// Instances may only be created by AXUniqueId. Take care when storing an
// instance, as its value is not guaranteed to be unique once the AXUniqueId
// from whence it came is destroyed.
//
// Instances are implicitly convertible to (but not from) the platform's node
// identifier type so that they may be used directly when calling the
// platform's accessibility APIs.
class AXPlatformNodeId
    : public base::StrongAlias<class AXPlatformNodeIdTag, int32_t> {
 public:
  // An invalid id -- the value of which matches that of kInvalidAXNodeID (0).
  constexpr AXPlatformNodeId()
      : base::StrongAlias<class AXPlatformNodeIdTag, int32_t>::StrongAlias(0) {}

  // Allow implementations of AXNodeIdDelegate to create instances, as they are
  // responsible for per-window allocation of unique identifiers.
  constexpr explicit AXPlatformNodeId(base::PassKey<AXNodeIdDelegate>,
                                      int32_t v)
      : base::StrongAlias<class AXPlatformNodeIdTag, int32_t>::StrongAlias(v) {}

  // Allow implicit conversion to the platform's node id type.
  constexpr operator const int32_t&() const { return value_; }

 private:
  friend class AXUniqueId;

  constexpr explicit AXPlatformNodeId(int32_t v)
      : base::StrongAlias<class AXPlatformNodeIdTag, int32_t>::StrongAlias(v) {}
};

}  // namespace ui

namespace std {
template <>
struct std::hash<ui::AXPlatformNodeId>
    : std::hash<base::StrongAlias<class ui::AXPlatformNodeIdTag, int32_t>> {};
}  // namespace std
#endif  // UI_ACCESSIBILITY_PLATFORM_AX_PLATFORM_NODE_ID_H_