File: scoped_observation_traits.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 (80 lines) | stat: -rw-r--r-- 2,658 bytes parent folder | download | duplicates (10)
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
// 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.

#ifndef BASE_SCOPED_OBSERVATION_TRAITS_H_
#define BASE_SCOPED_OBSERVATION_TRAITS_H_

namespace base {

// `ScopedObservationTraits` is used to control the behavior of
// `ScopedObservation` on sources without AddObserver()/RemoveObserver()
// methods.
//
// The implementation of `ScopedObservation<Source, Observer>` will look up the
// most specialized version of `ScopedObservationTraits<Source, Observer>` and
// use the corresponding `Traits::AddObserver` and `Traits::RemoveObserver`.
//
// The default specialization takes care of any Source that exposes
// `AddObserver(Observer*)` and `RemoveObserver(Observer*)` methods -- if that's
// the case, then `ScopedObservation<Source, Observer>` will work out of the
// box.
//
// However, if your `CustomSource` features custom method names -- say,
// `AddFoo(FooObserver*)` and `RemoveFoo(FooObserver*)`, then you'll have to
// define a new traits specialization like this:
//
// `custom_source.h`:
//    #include "base/scoped_observation_traits.h"
//
//    class FooObserver;
//    class CustomSource {
//     public:
//      void AddFoo(FooObserver*);
//      void RemoveFoo(FooObserver*);
//    };
//
//    namespace base {
//
//    template<>
//    struct ScopedObservationTraits<CustomSource, FooObserver> {
//      static void AddObserver(CustomSource* source,
//                              FooObserver* observer) {
//        source->AddFoo(observer);
//      }
//      static void RemoveObserver(CustomSource* source,
//                                 FooObserver* observer) {
//        source->RemoveFoo(observer);
//      }
//    };
//
//    }  // namespace base
//
// `some_important_file.cc`:
//    // Now this works out of the box.
//    base::ScopedObservation<CustomSource, FooObserver> obs...
//

template <class Source, class Observer>
struct ScopedObservationTraits {
  static_assert(
      requires(Source& source, Observer* observer) {
        source.AddObserver(observer);
        source.RemoveObserver(observer);
      },
      "The given Source is missing "
      "AddObserver(Observer*) and/or RemoveObserver(Observer*) "
      "methods. Please provide a custom specialization of "
      "ScopedObservationTraits<> for this Source/Observer pair.");

  static void AddObserver(Source* source, Observer* observer) {
    source->AddObserver(observer);
  }
  static void RemoveObserver(Source* source, Observer* observer) {
    source->RemoveObserver(observer);
  }
};

}  // namespace base

#endif  // BASE_SCOPED_OBSERVATION_TRAITS_H_