File: property_cache.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 (117 lines) | stat: -rw-r--r-- 3,235 bytes parent folder | download | duplicates (8)
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
// Copyright 2020 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_GFX_X_PROPERTY_CACHE_H_
#define UI_GFX_X_PROPERTY_CACHE_H_

#include <optional>
#include <vector>

#include "base/component_export.h"
#include "base/containers/flat_map.h"
#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/ref_counted_memory.h"
#include "base/memory/weak_ptr.h"
#include "ui/gfx/x/event_observer.h"
#include "ui/gfx/x/future.h"
#include "ui/gfx/x/window_event_manager.h"
#include "ui/gfx/x/xproto.h"

namespace x11 {

// Watches properties on an X11 window.  Property values are obtained once upon
// creation and are refreshed after each property change.
class COMPONENT_EXPORT(X11) PropertyCache : public EventObserver {
 public:
  using OnChangeCallback =
      base::RepeatingCallback<void(Atom, const GetPropertyResponse&)>;

  PropertyCache(Connection* connection,
                Window window,
                const std::vector<Atom>& properties,
                OnChangeCallback on_change = {});

  PropertyCache(const PropertyCache&) = delete;
  PropertyCache& operator=(const PropertyCache&) = delete;

  ~PropertyCache() override;

  const GetPropertyResponse& Get(Atom atom);

  template <typename T>
  static const T* GetAs(const GetPropertyResponse& response,
                        size_t* size = nullptr) {
    if (size) {
      *size = 0;
    }
    if (!response || response->format != CHAR_BIT * sizeof(T) ||
        !response->value_len) {
      return nullptr;
    }
    if (size) {
      *size = response->value_len;
    }
    return response->value->cast_to<T>();
  }

  template <typename T>
  const T* GetAs(Atom atom, size_t* size = nullptr) {
    return GetAs<T>(Get(atom), size);
  }

  template <typename T>
  static base::span<const T> GetAsSpan(const GetPropertyResponse& response) {
    size_t len;
    const T* const data = GetAs<const T>(response, &len);
    if (data && len > 0) {
      UNSAFE_TODO(return base::span<const T>(data, len));
    } else {
      return base::span<const T>();
    }
  }

  template <typename T>
  base::span<const T> GetAsSpan(Atom atom) {
    return GetAsSpan<T>(Get(atom));
  }

 private:
  friend class PropertyCacheTest;

  struct PropertyValue {
    PropertyValue();

    PropertyValue(PropertyValue&&);
    PropertyValue& operator=(PropertyValue&&);

    ~PropertyValue();

    Future<GetPropertyReply> future;
    // |response| is nullopt if the request hasn't yet finished.
    std::optional<GetPropertyResponse> response = std::nullopt;
  };

  using PropertiesIterator = base::flat_map<Atom, PropertyValue>::iterator;

  // EventObserver:
  void OnEvent(const Event& xev) override;

  void FetchProperty(PropertiesIterator it);

  void OnGetPropertyResponse(PropertiesIterator it,
                             GetPropertyResponse response);

  raw_ptr<Connection> connection_;
  Window window_;
  ScopedEventSelector event_selector_;
  base::flat_map<Atom, PropertyValue> properties_;
  OnChangeCallback on_change_;

  base::WeakPtrFactory<PropertyCache> weak_factory_{this};
};

}  // namespace x11

#endif  // UI_GFX_X_PROPERTY_CACHE_H_