libcamera: include/libcamera/base/flags.h Source File

libcamera v0.0.4 Supporting cameras in Linux since 2019

Loading...
Searching...
No Matches
flags.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2020, Google Inc.
4 *
5 * flags.h - Type-safe enum-based bitfields
6 */
7
8#pragma once
9
10#include <type_traits>
11
12namespace libcamera {
13
14template<typename E>
15 class Flags
16{
17public:
18 static_assert(std::is_enum<E>::value,
19 "Flags<> template parameter must be an enum");
20
21 using Type = std::underlying_type_t<E>;
22
23 constexpr Flags()
24 : value_(0)
25 {
26 }
27
28 constexpr Flags(E flag)
29 : value_(static_cast<Type>(flag))
30 {
31 }
32
33 constexpr Flags &operator&=(E flag)
34 {
35 value_ &= static_cast<Type>(flag);
36 return *this;
37 }
38
39 constexpr Flags &operator&=(Flags other)
40 {
41 value_ &= other.value_;
42 return *this;
43 }
44
45 constexpr Flags &operator|=(E flag)
46 {
47 value_ |= static_cast<Type>(flag);
48 return *this;
49 }
50
51 constexpr Flags &operator|=(Flags other)
52 {
53 value_ |= other.value_;
54 return *this;
55 }
56
57 constexpr Flags &operator^=(E flag)
58 {
59 value_ ^= static_cast<Type>(flag);
60 return *this;
61 }
62
63 constexpr Flags &operator^=(Flags other)
64 {
65 value_ ^= other.value_;
66 return *this;
67 }
68
69 constexpr bool operator==(E flag)
70 {
71 return value_ == static_cast<Type>(flag);
72 }
73
74 constexpr bool operator==(Flags other)
75 {
76 return value_ == static_cast<Type>(other);
77 }
78
79 constexpr bool operator!=(E flag)
80 {
81 return value_ != static_cast<Type>(flag);
82 }
83
84 constexpr bool operator!=(Flags other)
85 {
86 return value_ != static_cast<Type>(other);
87 }
88
89 constexpr explicit operator Type() const
90 {
91 return value_;
92 }
93
94 constexpr explicit operator bool() const
95 {
96 return !!value_;
97 }
98
99 constexpr Flags operator&(E flag) const
100 {
101 return Flags(static_cast<E>(value_ & static_cast<Type>(flag)));
102 }
103
104 constexpr Flags operator&(Flags other) const
105 {
106 return Flags(static_cast<E>(value_ & other.value_));
107 }
108
109 constexpr Flags operator|(E flag) const
110 {
111 return Flags(static_cast<E>(value_ | static_cast<Type>(flag)));
112 }
113
114 constexpr Flags operator|(Flags other) const
115 {
116 return Flags(static_cast<E>(value_ | other.value_));
117 }
118
119 constexpr Flags operator^(E flag) const
120 {
121 return Flags(static_cast<E>(value_ ^ static_cast<Type>(flag)));
122 }
123
124 constexpr Flags operator^(Flags other) const
125 {
126 return Flags(static_cast<E>(value_ ^ other.value_));
127 }
128
129 constexpr Flags operator~() const
130 {
131 return Flags(static_cast<E>(~value_));
132 }
133
134 constexpr bool operator!() const
135 {
136 return !value_;
137 }
138
139private:
140 Type value_;
141};
142
143#ifndef __DOXYGEN__
144template<typename E>
145struct flags_enable_operators {
146 static const bool enable = false;
147};
148
149template<typename E>
150std::enable_if_t<flags_enable_operators<E>::enable, Flags<E>>
151 operator|(E lhs, E rhs)
152{
153 using type = std::underlying_type_t<E>;
154 return Flags<E>(static_cast<E>(static_cast<type>(lhs) | static_cast<type>(rhs)));
155}
156
157template<typename E>
158std::enable_if_t<flags_enable_operators<E>::enable, Flags<E>>
159 operator&(E lhs, E rhs)
160{
161 using type = std::underlying_type_t<E>;
162 return Flags<E>(static_cast<E>(static_cast<type>(lhs) & static_cast<type>(rhs)));
163}
164
165template<typename E>
166std::enable_if_t<flags_enable_operators<E>::enable, Flags<E>>
167 operator^(E lhs, E rhs)
168{
169 using type = std::underlying_type_t<E>;
170 return Flags<E>(static_cast<E>(static_cast<type>(lhs) ^ static_cast<type>(rhs)));
171}
172
173template<typename E>
174std::enable_if_t<flags_enable_operators<E>::enable, Flags<E>>
175 operator~(E rhs)
176{
177 using type = std::underlying_type_t<E>;
178 return Flags<E>(static_cast<E>(~static_cast<type>(rhs)));
179}
180
181#define LIBCAMERA_FLAGS_ENABLE_OPERATORS(_enum) \
182template<> \
183struct flags_enable_operators<_enum> { \
184 static const bool enable = true; \
185};
186
187#else /* __DOXYGEN__ */
188
189#define LIBCAMERA_FLAGS_ENABLE_OPERATORS(_enum)
190
191#endif /* __DOXYGEN__ */
192
193} /* namespace libcamera */
libcamera::Flags
Type-safe container for enum-based bitfields.
Definition: flags.h:16
libcamera::Flags::operator&
constexpr Flags operator&(Flags other) const
Compute the bitwise AND of this Flags and the other Flags.
Definition: flags.h:104
libcamera::Flags::operator|
constexpr Flags operator|(Flags other) const
Compute the bitwise OR of this Flags and the other Flags.
Definition: flags.h:114
libcamera::Flags::operator==
constexpr bool operator==(E flag)
Compare flags for equality.
Definition: flags.h:69
libcamera::Flags::operator^=
constexpr Flags & operator^=(E flag)
Store the bitwise XOR of this Flags and the flag in this Flags.
Definition: flags.h:57
libcamera::Flags::operator^=
constexpr Flags & operator^=(Flags other)
Store the bitwise XOR of this Flags and the other Flags in this Flags.
Definition: flags.h:63
libcamera::Flags::operator^
constexpr Flags operator^(E flag) const
Compute the bitwise XOR of this Flags and the flag.
Definition: flags.h:119
libcamera::Flags::operator&=
constexpr Flags & operator&=(E flag)
Store the bitwise AND of this Flags and the flag in this Flags.
Definition: flags.h:33
libcamera::Flags::operator|
constexpr Flags operator|(E flag) const
Compute the bitwise OR of this Flags and the flag.
Definition: flags.h:109
libcamera::Flags::operator==
constexpr bool operator==(Flags other)
Compare flags for equality.
Definition: flags.h:74
libcamera::Flags::operator~
constexpr Flags operator~() const
Compute the bitwise NOT of this Flags.
Definition: flags.h:129
libcamera::Flags::Flags
constexpr Flags(E flag)
Construct a Flags instance storing the flag.
Definition: flags.h:28
libcamera::Flags::operator|=
constexpr Flags & operator|=(Flags other)
Store the bitwise OR of this Flags and the other Flags in this Flags.
Definition: flags.h:51
libcamera::Flags::Type
std::underlying_type_t< E > Type
The underlying data type of the enum.
Definition: flags.h:21
libcamera::Flags::Flags
constexpr Flags()
Construct a Flags instance with a zero value.
Definition: flags.h:23
libcamera::Flags::operator!
constexpr bool operator!() const
Check if flags are set.
Definition: flags.h:134
libcamera::Flags::operator^
constexpr Flags operator^(Flags other) const
Compute the bitwise XOR of this Flags and the other Flags.
Definition: flags.h:124
libcamera::Flags::operator!=
constexpr bool operator!=(Flags other)
Compare flags for non-equality.
Definition: flags.h:84
libcamera::Flags::operator!=
constexpr bool operator!=(E flag)
Compare flags for non-equality.
Definition: flags.h:79
libcamera::Flags::operator|=
constexpr Flags & operator|=(E flag)
Store the bitwise OR of this Flags and the flag in this Flags.
Definition: flags.h:45
libcamera::Flags::operator&
constexpr Flags operator&(E flag) const
Compute the bitwise AND of this Flags and the flag.
Definition: flags.h:99
libcamera::Flags::operator&=
constexpr Flags & operator&=(Flags other)
Store the bitwise AND of this Flags and the other Flags in this Flags.
Definition: flags.h:39
libcamera
Top-level libcamera namespace.
Definition: backtrace.h:17
libcamera::operator&
constexpr Transform operator&(Transform t0, Transform t1)
Apply bitwise AND operator between the bits in the two transforms.
Definition: transform.h:27
libcamera::operator~
constexpr Transform operator~(Transform t)
Return the transform with all the bits inverted individually.
Definition: transform.h:66
libcamera::operator|
constexpr Transform operator|(Transform t0, Transform t1)
Apply bitwise OR operator between the bits in the two transforms.
Definition: transform.h:32
libcamera::operator^
constexpr Transform operator^(Transform t0, Transform t1)
Apply bitwise XOR operator between the bits in the two transforms.
Definition: transform.h:37