File: enum_traits.h

package info (click to toggle)
chromium 138.0.7204.157-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 6,071,864 kB
  • sloc: cpp: 34,936,859; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,967; 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 (58 lines) | stat: -rw-r--r-- 1,930 bytes parent folder | download | duplicates (3)
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
// 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 CHROME_UPDATER_ENUM_TRAITS_H_
#define CHROME_UPDATER_ENUM_TRAITS_H_

#include <concepts>
#include <optional>
#include <ostream>
#include <type_traits>

#include "base/types/cxx23_to_underlying.h"

namespace updater {

// Provides a way to safely convert numeric types to enumerated values. To use
// this facility, the enum definition must be annotated with traits to specify
// the range of the enum values. Due to how specialization of class templates
// works in C++14, the `EnumTraits` specialization of the primary template must
// be defined inside the `updater` namespace, where the primary template is
// defined. Traits for enum types defined inside other scopes, such as nested
// classes or other namespaces, may not work.
//
// enum class MyEnum {
//   kVal1 = -1,
//   kVal2 = 0,
//   kVal3 = 1,
// };
//
// template <>
// struct EnumTraits<MyEnum> {
//   static constexpr MyEnum first_elem = MyEnum::kVal1;
//   static constexpr MyEnum last_elem = MyEnum::kVal3;
// };
//
// MyEnum val = *CheckedCastToEnum<MyEnum>(-1);

template <typename T>
  requires(std::is_enum_v<T>)
struct EnumTraits {};

// Returns an optional value of an enum type T if the conversion from an
// integer value `v` is safe, meaning that `v` is within the bounds of the enum.
// The enum type must be annotated with traits to specify the lower and upper
// bounds of the enum values.
template <typename T>
  requires(std::is_enum_v<T>)
constexpr std::optional<T> CheckedCastToEnum(std::underlying_type_t<T> v) {
  return (base::to_underlying(EnumTraits<T>::first_elem) <= v &&
          v <= base::to_underlying(EnumTraits<T>::last_elem))
             ? std::make_optional(static_cast<T>(v))
             : std::nullopt;
}

}  // namespace updater

#endif  // CHROME_UPDATER_ENUM_TRAITS_H_