File: variant.h

package info (click to toggle)
chromium 141.0.7390.107-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,246,132 kB
  • sloc: cpp: 35,264,965; ansic: 7,169,920; javascript: 4,250,185; python: 1,460,635; asm: 950,788; xml: 751,751; pascal: 187,972; sh: 89,459; perl: 88,691; objc: 79,953; sql: 53,924; cs: 44,622; fortran: 24,137; makefile: 22,313; tcl: 15,277; php: 14,018; yacc: 8,995; ruby: 7,553; awk: 3,720; lisp: 3,096; lex: 1,330; ada: 727; jsp: 228; sed: 36
file content (211 lines) | stat: -rw-r--r-- 7,091 bytes parent folder | download | duplicates (4)
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
// 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_DBUS_UTILS_VARIANT_H_
#define COMPONENTS_DBUS_UTILS_VARIANT_H_

#include <map>
#include <memory>
#include <optional>
#include <string>
#include <type_traits>
#include <variant>
#include <vector>

#include "base/component_export.h"
#include "base/files/scoped_file.h"
#include "components/dbus/utils/signature.h"
#include "components/dbus/utils/types.h"
#include "dbus/message.h"
#include "dbus/object_path.h"

namespace dbus_utils {

class COMPONENT_EXPORT(COMPONENTS_DBUS) Variant {
 public:
  Variant();

  Variant(Variant&&) noexcept;
  Variant& operator=(Variant&&) noexcept;

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

  ~Variant();

  // Create a new Variant that wraps the given `value`, which is consumed.
  // The `Signature` template parameter is a required string literal that
  // must match the D-Bus signature of `value`. This is intended to prevent
  // ambiguity if `value` is a literal like "42", so an explicit type is
  // required.
  template <internal::StringLiteral Signature, typename T>
    requires internal::IsSupportedDBusType<typename std::decay_t<T>> &&
             (internal::DBusSignature<std::decay_t<T>>::kValue ==
              Signature.value)
  static Variant Wrap(T&& value) {
    return WrapImpl(std::forward<T>(value));
  }

  // Extract the contained value from this variant. Returns std::nullopt if the
  // variant is empty or if the contained type does not match the requested
  // type. The variant is reset to an empty state after Take().
  template <typename T>
    requires internal::IsSupportedDBusType<T>
  std::optional<T> Take() && {
    auto consumed_state = std::move(state_);
    state_.emplace<std::monostate>();
    std::string signature = std::move(signature_);

    if (signature != internal::GetDBusTypeSignature<T>()) {
      return std::nullopt;
    }

    if constexpr (internal::IsSupportedMap<T>::value) {
      CHECK(std::holds_alternative<Dictionary>(consumed_state));
      using K = typename T::key_type;
      using V = typename T::mapped_type;
      std::map<K, V> result;
      for (auto& pair : std::get<Dictionary>(consumed_state)) {
        auto key_opt = std::move(pair.first).Take<K>();
        auto val_opt = std::move(pair.second).Take<V>();
        if (!key_opt || !val_opt) {
          return std::nullopt;
        }
        result.emplace(std::move(*key_opt), std::move(*val_opt));
      }
      return result;
    } else if constexpr (internal::IsSupportedArray<T>::value) {
      CHECK(std::holds_alternative<Sequence>(consumed_state));
      using E = typename T::value_type;
      std::vector<E> result;
      auto& seq = std::get<Sequence>(consumed_state);
      result.reserve(seq.size());
      for (auto& elem_variant : seq) {
        auto elem_opt = std::move(elem_variant).Take<E>();
        if (!elem_opt) {
          return std::nullopt;
        }
        result.push_back(std::move(*elem_opt));
      }
      return result;
    } else if constexpr (internal::IsSupportedStruct<T>::value) {
      CHECK(std::holds_alternative<Sequence>(consumed_state));
      T result_struct{};
      auto& seq = std::get<Sequence>(consumed_state);
      if (std::tuple_size_v<T> != seq.size()) {
        return std::nullopt;
      }
      size_t i = 0;
      bool success = std::apply(
          [&](auto&... members) {
            return ([&](auto& member) {
              auto opt =
                  std::move(seq[i++]).Take<std::decay_t<decltype(member)>>();
              if (!opt) {
                return false;
              }
              member = std::move(*opt);
              return true;
            }(members) &&
                    ...);
          },
          result_struct);
      return success ? std::optional<T>(std::move(result_struct))
                     : std::nullopt;
    } else if constexpr (std::is_same_v<T, Variant>) {
      CHECK(std::holds_alternative<NestedVariant>(consumed_state));
      auto ptr = std::move(std::get<NestedVariant>(consumed_state));
      return ptr ? std::optional<T>(std::move(*ptr)) : std::nullopt;
    } else {
      CHECK(std::holds_alternative<T>(consumed_state));
      return std::move(std::get<T>(consumed_state));
    }
  }

  // Writes `this` to `writer`. The variant must not be empty.
  void Write(dbus::MessageWriter& writer) const;

  // Reads a variant from `reader` into `this`, and returns true on success.
  bool Read(dbus::MessageReader& reader);

  const std::string& signature() const { return signature_; }

 private:
  using Dictionary = std::vector<std::pair<Variant, Variant>>;
  // Either an array or a struct.
  using Sequence = std::vector<Variant>;
  using NestedVariant = std::unique_ptr<Variant>;

  // `T` has already been validated by `Wrap`.
  template <typename T>
  static Variant WrapImpl(T&& value) {
    Variant v;
    using DecayedT = std::decay_t<T>;
    v.signature_ = internal::GetDBusTypeSignature<DecayedT>();

    if constexpr (std::is_same_v<DecayedT, Variant>) {
      v.state_.emplace<NestedVariant>(
          std::make_unique<Variant>(std::forward<T>(value)));
    } else if constexpr (internal::IsSupportedMap<DecayedT>::value) {
      Dictionary dict;
      dict.reserve(value.size());
      for (auto& pair : value) {
        dict.emplace_back(Variant::WrapImpl(std::move(pair.first)),
                          Variant::WrapImpl(std::move(pair.second)));
      }
      v.state_.emplace<Dictionary>(std::move(dict));
    } else if constexpr (internal::IsSupportedStruct<DecayedT>::value) {
      Sequence seq;
      seq.reserve(std::tuple_size_v<DecayedT>);
      auto member_wrapper = [&](auto&... members) {
        (seq.push_back(Variant::WrapImpl(std::move(members))), ...);
      };
      std::apply(member_wrapper, value);
      v.state_.emplace<Sequence>(std::move(seq));
    } else if constexpr (internal::IsSupportedArray<DecayedT>::value) {
      Sequence seq;
      seq.reserve(value.size());
      for (auto& elem : value) {
        seq.push_back(Variant::WrapImpl(std::move(elem)));
      }
      v.state_.emplace<Sequence>(std::move(seq));
    } else {
      v.state_.emplace<DecayedT>(std::forward<T>(value));
    }
    return v;
  }

  // Similar to `Write` and `Read`, but for the contained type.
  void WriteContent(dbus::MessageWriter& writer) const;
  bool ReadContent(dbus::MessageReader& reader);

  // An explicit signature is required for empty arrays or dictionaries.
  std::string signature_;

  std::variant<
      // Default-constructed or moved-from.
      std::monostate,
      // Primitive types.
      bool,
      uint8_t,
      int16_t,
      uint16_t,
      int32_t,
      uint32_t,
      int64_t,
      uint64_t,
      double,
      std::string,
      dbus::ObjectPath,
      base::ScopedFD,
      // Container types.
      Dictionary,
      Sequence,
      NestedVariant>
      state_;
};

}  // namespace dbus_utils

#endif  // COMPONENTS_DBUS_UTILS_VARIANT_H_