File: token_id.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 (68 lines) | stat: -rw-r--r-- 2,164 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
64
65
66
67
68
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_TAB_GROUPS_TOKEN_ID_H_
#define COMPONENTS_TAB_GROUPS_TOKEN_ID_H_

#include <ostream>

#include "base/component_export.h"
#include "base/token.h"

namespace tab_groups {

// A class template for token based ids. For new use cases, instantiate a new
// class from this template using itself as the argument (CRTP), so that the ids
// are not comparable to other use cases' ids. See tab_groups::TabGroupId for an
// example of this.
template <class T>
class COMPONENT_EXPORT(TAB_GROUPS) TokenId {
 public:
  static T GenerateNew() { return T(TokenId(base::Token::CreateRandom())); }

  // This should only called with |token| returned from a previous |token()|
  // call on a valid TokenId.
  static T FromRawToken(base::Token token) { return T(TokenId(token)); }

  // Should only be used if intending to populate the TokenId by reference,
  // using a valid existing ID. Primarily needed for the extensions API.
  static T CreateEmpty() { return T(TokenId(base::Token())); }

  TokenId(const TokenId<T>& other) = default;

  TokenId<T>& operator=(const TokenId<T>& other) = default;

  friend bool operator==(const TokenId<T>&, const TokenId<T>&) = default;
  friend auto operator<=>(const TokenId<T>&, const TokenId<T>&) = default;

  const base::Token& token() const { return token_; }

  bool is_empty() const { return token_.is_zero(); }

  std::string ToString() const { return token_.ToString(); }

 private:
  explicit TokenId(base::Token token) : token_(token) {}

  base::Token token_;
};

// For use in std::unordered_map.
template <class T>
struct COMPONENT_EXPORT(TAB_GROUPS) TokenIdHash {
 public:
  size_t operator()(const TokenId<T>& token_id) const {
    return base::TokenHash()(token_id.token());
  }
};

// Stream operator so TokenId objects can be used in logging statements.
template <class T>
std::ostream& operator<<(std::ostream& out, const TokenId<T>& token_id) {
  return out << token_id.ToString();
}

}  // namespace tab_groups

#endif  // COMPONENTS_TAB_GROUPS_TOKEN_ID_H_