File: scoped_unowned_user_data.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; 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,811; 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 (73 lines) | stat: -rw-r--r-- 2,226 bytes parent folder | download | duplicates (2)
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
// 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 CHROME_BROWSER_UI_UNOWNED_USER_DATA_SCOPED_UNOWNED_USER_DATA_H_
#define CHROME_BROWSER_UI_UNOWNED_USER_DATA_SCOPED_UNOWNED_USER_DATA_H_

#include "base/memory/raw_ptr.h"
#include "base/memory/raw_ref.h"
#include "base/types/pass_key.h"

class UnownedUserDataHost;

namespace internal {

// Internal base class for handling setting / unsetting the UnownedUserData
// on the UnownedUserDataHost. Should not be used directly outside of this
// file.
class ScopedUnownedUserDataBase {
 protected:
  ScopedUnownedUserDataBase(UnownedUserDataHost& host,
                            const char* key,
                            void* data);
  virtual ~ScopedUnownedUserDataBase();

  static void* GetInternal(UnownedUserDataHost& host, const char* key);

 private:
  using PassKey = base::PassKey<ScopedUnownedUserDataBase>;

  raw_ref<UnownedUserDataHost> host_;
  const char* key_;
  raw_ptr<void> data_;
};

}  // namespace internal

// A scoped class to set and unset an UnownedUserData entry on an
// UnownedUserDataHost.
//
// Example Usage:
//   class MyFeature {
//    public:
//     static const char* kDataKey;
//
//     explicit MyFeature(UnownedUserDataHost& host)
//         : scoped_data_holder_(host) {}
//
//     static MyFeature* FromHost(UnownedUserDataHost& host) {
//       return ScopedUnownedUserData<MyFeature>::Get(host);
//     }
//
//    private:
//     ScopedUnowneduserData<MyFeature> scoped_data_holder_;
//   };
//
//   const char* MyFeature::kDataKey = "MyFeature";
//
// Note: See also UnownedUserDataInterface, if you prefer an inheritance pattern
// and want slightly less boilerplate.
template <class T>
class ScopedUnownedUserData : public internal::ScopedUnownedUserDataBase {
 public:
  ScopedUnownedUserData(UnownedUserDataHost& host, T* data)
      : ScopedUnownedUserDataBase(host, T::kDataKey, data) {}
  ~ScopedUnownedUserData() override = default;

  static T* Get(UnownedUserDataHost& host) {
    return static_cast<T*>(GetInternal(host, T::kDataKey));
  }
};

#endif  // CHROME_BROWSER_UI_UNOWNED_USER_DATA_SCOPED_UNOWNED_USER_DATA_H_