File: expected.h

package info (click to toggle)
dolphin-emu 2512%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 76,328 kB
  • sloc: cpp: 499,023; ansic: 119,674; python: 6,547; sh: 2,338; makefile: 1,093; asm: 726; pascal: 257; javascript: 183; perl: 97; objc: 75; xml: 30
file content (392 lines) | stat: -rw-r--r-- 12,403 bytes parent folder | download
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
/**
 * \file libipc/expected.h
 * \author mutouyun (orz@orzz.org)
 * \brief Provides a way to store either of two values.
 */
#pragma once

#include <type_traits>
#include <utility>  // std::exchange
#include <array>
#include <memory>   // std::addressof
#include <cstddef>  // std::nullptr_t

#include "libipc/imp/uninitialized.h"
#include "libipc/imp/generic.h"
#include "libipc/imp/byte.h"

namespace ipc {

/**
 * \brief In-place construction tag for unexpected value in expected.
 * \see https://en.cppreference.com/w/cpp/utility/expected/unexpect_t
 */
struct unexpected_t {
  explicit unexpected_t() = default;
};
constexpr unexpected_t unexpected{};

/**
 * \class template <typename T, typename E> expected
 * \brief Provides a way to store either of two values.
 * \see https://en.cppreference.com/w/cpp/utility/expected
 * \tparam T - the type of the expected value.
 * \tparam E - the type of the unexpected value.
 */
template <typename T, typename E>
class expected;

namespace detail_expected {

template <typename T, typename E>
struct data_union {
  using const_value_t = typename std::add_const<T>::type;
  using const_error_t = typename std::add_const<E>::type;

  union {
    T value_;  ///< the expected value
    E error_;  ///< the unexpected value
  };

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

  data_union(std::nullptr_t) noexcept {}
  ~data_union() {}

  template <typename... A>
  data_union(in_place_t, A &&...args) : value_{std::forward<A>(args)...} {}
  template <typename... A>
  data_union(unexpected_t, A &&...args) : error_{std::forward<A>(args)...} {}

  void destruct_value() noexcept { destroy(&value_); }
  void destruct_error() noexcept { destroy(&error_); }

  const_value_t & value() const &  noexcept { return value_; }
  T &             value() &        noexcept { return value_; }
  const_value_t &&value() const && noexcept { return std::move(value_); }
  T &&            value() &&       noexcept { return std::move(value_); }

  const_error_t & error() const &  noexcept { return error_; }
  E &             error() &        noexcept { return error_; }
  const_error_t &&error() const && noexcept { return std::move(error_); }
  E &&            error() &&       noexcept { return std::move(error_); }
};

template <typename E>
struct data_union<void, E> {
  using const_error_t = typename std::add_const<E>::type;

  alignas(E) std::array<byte, sizeof(E)> error_;  ///< the unexpected value

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

  data_union(std::nullptr_t) noexcept {}

  template <typename... A>
  data_union(in_place_t, A &&...) noexcept {}
  template <typename... A>
  data_union(unexpected_t, A &&...args) {
    construct<E>(&error_, std::forward<A>(args)...);
  }

  void destruct_value() noexcept {}
  void destruct_error() noexcept { destroy(reinterpret_cast<E *>(&error_)); }

  const_error_t & error() const &  noexcept { return *reinterpret_cast<E *>(error_.data()); }
  E &             error() &        noexcept { return *reinterpret_cast<E *>(error_.data()); }
  const_error_t &&error() const && noexcept { return std::move(*reinterpret_cast<E *>(error_.data())); }
  E &&            error() &&       noexcept { return std::move(*reinterpret_cast<E *>(error_.data())); }
};

template <typename T, typename E>
auto destruct(bool /*has_value*/, data_union<T, E> &/*data*/) noexcept
  -> typename std::enable_if<std::is_trivially_destructible<T>::value &&
                             std::is_trivially_destructible<E>::value>::type {
  // Do nothing.
}

template <typename T, typename E>
auto destruct(bool has_value, data_union<T, E> &data) noexcept
  -> typename std::enable_if<!std::is_trivially_destructible<T>::value &&
                              std::is_trivially_destructible<E>::value>::type {
  if (has_value) data.destruct_value();
}

template <typename T, typename E>
auto destruct(bool has_value, data_union<T, E> &data) noexcept
  -> typename std::enable_if< std::is_trivially_destructible<T>::value &&
                             !std::is_trivially_destructible<E>::value>::type {
  if (!has_value) data.destruct_error();
}

template <typename T, typename E>
auto destruct(bool has_value, data_union<T, E> &data) noexcept
  -> typename std::enable_if<!std::is_trivially_destructible<T>::value &&
                             !std::is_trivially_destructible<E>::value>::type {
  if (has_value) {
    data.destruct_value();
  } else {
    data.destruct_error();
  }
}

template <typename S, typename T, typename E>
struct value_getter : data_union<T, E> {
  using data_union<T, E>::data_union;

  template <typename U>
  value_getter(U &&other) : data_union<T, E>(nullptr) {
    if (other) {
      construct<data_union<T, E>>(this, in_place, std::forward<U>(other).value());
    } else {
      construct<data_union<T, E>>(this, unexpected, std::forward<U>(other).error());
    }
  }

  T const *operator->() const noexcept { return std::addressof(this->value()); }
  T *      operator->()       noexcept { return std::addressof(this->value()); }

  T const & operator*() const &  noexcept { return this->value(); }
  T &       operator*()       &  noexcept { return this->value(); }
  T const &&operator*() const && noexcept { return std::move(this->value()); }
  T &&      operator*()       && noexcept { return std::move(this->value()); }

  template <typename U>
  T value_or(U &&def) const & {
    return bool(*static_cast<S *>(this)) ? **this : static_cast<T>(std::forward<U>(def));
  }
  template <typename U>
  T value_or(U &&def) && {
    return bool(*static_cast<S *>(this)) ? std::move(**this) : static_cast<T>(std::forward<U>(def));
  }

  template <typename... A>
  T &emplace(A &&...args) {
    static_cast<S *>(this)->reconstruct(in_place, std::forward<A>(args)...);
    return this->value();
  }

  void swap(S &other) {
    if (bool(*static_cast<S *>(this)) && bool(other)) {
      std::swap(this->value(), other.value());
    } else if (!*static_cast<S *>(this) && !other) {
      std::swap(this->error(), other.error());
    } else if (!*static_cast<S *>(this) && bool(other)) {
      E err(std::move(this->error()));
      this->emplace(std::move(other.value()));
      other.reconstruct(unexpected, std::move(err));
    } else /*if (bool(*this) && !other)*/ {
      E err(std::move(other.error()));
      other.emplace(std::move(this->value()));
      static_cast<S *>(this)->reconstruct(unexpected, std::move(err));
    }
  }
};

template <typename S, typename E>
struct value_getter<S, void, E> : data_union<void, E> {
  using data_union<void, E>::data_union;

  template <typename U>
  value_getter(U &&other) : data_union<void, E>(nullptr) {
    if (other) {
      construct<data_union<void, E>>(this, in_place);
    } else {
      construct<data_union<void, E>>(this, unexpected, std::forward<U>(other).error());
    }
  }

  void emplace() noexcept {
    static_cast<S *>(this)->reconstruct(in_place);
  }

  void swap(S &other) {
    if (bool(*static_cast<S *>(this)) && bool(other)) {
      return;
    } else if (!*static_cast<S *>(this) && !other) {
      std::swap(this->error(), other.error());
    } else if (!*static_cast<S *>(this) && bool(other)) {
      E err(std::move(this->error()));
      this->emplace();
      other.reconstruct(unexpected, std::move(err));
    } else /*if (bool(*this) && !other)*/ {
      E err(std::move(other.error()));
      other.emplace();
      static_cast<S *>(this)->reconstruct(unexpected, std::move(err));
    }
  }
};

/**
 * \brief Define the expected storage.
 */
template <typename T, typename E>
struct storage : value_getter<storage<T, E>, T, E> {
  using getter_t = value_getter<storage<T, E>, T, E>;

  bool has_value_;

  template <typename... A>
  storage(in_place_t, A &&...args)
    : getter_t(in_place, std::forward<A>(args)...)
    , has_value_(true) {}

  template <typename... A>
  storage(unexpected_t, A &&...args)
    : getter_t(unexpected, std::forward<A>(args)...)
    , has_value_(false) {}

  storage(storage const &other)
    : getter_t(other)
    , has_value_(other.has_value_) {}

  storage(storage &&other)
    : getter_t(std::move(other))
    /// After construction, has_value() is equal to other.has_value().
    , has_value_(other.has_value_) {}

  template <typename T_, typename E_>
  storage(storage<T_, E_> const &other)
    : getter_t(other)
    , has_value_(other.has_value_) {}

  template <typename T_, typename E_>
  storage(storage<T_, E_> &&other)
    : getter_t(std::move(other))
    /// After construction, has_value() is equal to other.has_value().
    , has_value_(other.has_value_) {}

  bool has_value() const noexcept {
    return has_value_;
  }

  explicit operator bool() const noexcept {
    return this->has_value();
  }

protected:
  friend getter_t;

  template <typename... A>
  void reconstruct(A &&...args) {
    destroy(this);
    construct<storage>(this, std::forward<A>(args)...);
  }
};

/// \brief The invoke forwarding helper.

template <typename F, typename... A>
auto invoke(F &&f, A &&...args) noexcept(
     noexcept(std::forward<F>(f)(std::forward<A>(args)...)))
  -> decltype(std::forward<F>(f)(std::forward<A>(args)...)) {
  return std::forward<F>(f)(std::forward<A>(args)...);
}

template <typename F, typename... A>
auto invoke(F &&f, A &&...args) noexcept(
     noexcept(std::forward<F>(f)()))
  -> decltype(std::forward<F>(f)()) {
  return std::forward<F>(f)();
}

/// \brief and_then helper.

template <typename E, typename F,
          typename R = decltype(invoke(std::declval<F>(), *std::declval<E>()))>
R and_then(E &&exp, F &&f) {
  static_assert(is_specialized<expected, R>::value, "F must return an `expected`.");
  return bool(exp) ? invoke(std::forward<F>(f), *std::forward<E>(exp))
                   : R(unexpected, std::forward<E>(exp).error());
}

/// \brief or_else helper.

template <typename E, typename F,
          typename R = decltype(invoke(std::declval<F>(), std::declval<E>().error()))>
R or_else(E &&exp, F &&f) {
  static_assert(is_specialized<expected, R>::value, "F must return an `expected`.");
  return bool(exp) ? std::forward<E>(exp)
                   : invoke(std::forward<F>(f), std::forward<E>(exp).error());
}

} // namespace detail_expected

/**
 * \class template <typename T, typename E> expected
 * \brief Provides a way to store either of two values.
 */
template <typename T, typename E>
class expected : public detail_expected::storage<typename std::remove_cv<T>::type, E> {
public:
  using value_type = typename std::remove_cv<T>::type;
  using error_type = E;

  using detail_expected::storage<value_type, E>::storage;

  expected(expected const &) = default;
  expected(expected &&) = default;

  expected()
    : detail_expected::storage<value_type, E>(in_place) {}

  expected &operator=(expected other) {
    this->swap(other);
    return *this;
  }

  // Monadic operations

  template <typename F>
  auto and_then(F &&f) & {
    return detail_expected::and_then(*this, std::forward<F>(f));
  }

  template <typename F>
  auto and_then(F &&f) const & {
    return detail_expected::and_then(*this, std::forward<F>(f));
  }

  template <typename F>
  auto and_then(F &&f) && {
    return detail_expected::and_then(std::move(*this), std::forward<F>(f));
  }

  template <typename F>
  auto or_else(F &&f) & {
    return detail_expected::or_else(*this, std::forward<F>(f));
  }

  template <typename F>
  auto or_else(F &&f) const & {
    return detail_expected::or_else(*this, std::forward<F>(f));
  }

  template <typename F>
  auto or_else(F &&f) && {
    return detail_expected::or_else(std::move(*this), std::forward<F>(f));
  }
};

// Compares

template <typename T1, typename E1, typename T2, typename E2>
bool operator==(expected<T1, E1> const &lhs, expected<T2, E2> const &rhs) {
  return (lhs.has_value() == rhs.has_value())
      && (lhs.has_value() ? *lhs == *rhs : lhs.error() == rhs.error());
}

template <typename E1, typename E2>
bool operator==(expected<void, E1> const &lhs, expected<void, E2> const &rhs) {
  return (lhs.has_value() == rhs.has_value())
      && (lhs.has_value() || lhs.error() == rhs.error());
}

template <typename T1, typename E1, typename T2, typename E2>
bool operator!=(expected<T1, E1> const &lhs, expected<T2, E2> const &rhs) {
  return !(lhs == rhs);
}

} // namespace ipc