summaryrefslogtreecommitdiff
path: root/include/o3tl/typed_flags_set.hxx
blob: 4b6e4f5909b1819ba1e599cf67f9f2f963ca1d29 (plain)
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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_O3TL_TYPED_FLAGS_SET_HXX
#define INCLUDED_O3TL_TYPED_FLAGS_SET_HXX

#include <sal/config.h>

#include <cassert>

#include <o3tl/underlying_type.hxx>

namespace o3tl {

template<typename T> struct typed_flags {};

/// Mark a (scoped) enumeration as a set of bit flags, with accompanying
/// operations.
///
///   template<>
///   struct o3tl::typed_flags<TheE>: o3tl::is_typed_flags<TheE, TheM> {};
///
/// All relevant values must be non-negative.  (Typically, the enumeration's
/// underlying type will either be fixed and unsigned, or it will be unfixed---
/// and can thus default to a signed type---and all enumerators will have non-
/// negative values.)
///
/// \param E the enumeration type.
/// \param M the all-bits-set value for the bit flags.
template<typename E, typename underlying_type<E>::type M>
struct is_typed_flags {
    static_assert(
        M >= 0, "is_typed_flags expects only non-negative bit values");

    typedef E Self;

    class Wrap {
    public:
        explicit Wrap(typename underlying_type<E>::type value):
            value_(value)
        { assert(value >= 0); }

        operator E() { return static_cast<E>(value_); }

#if !defined _MSC_VER || _MSC_VER > 1700
        explicit
#endif
        operator typename underlying_type<E>::type() { return value_; }

#if !defined _MSC_VER || _MSC_VER > 1700
        explicit
#endif
        operator bool() { return value_ != 0; }

    private:
        typename underlying_type<E>::type value_;
    };

    static typename underlying_type<E>::type const mask = M;
};

}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator ~(E rhs) {
    assert(static_cast<typename o3tl::underlying_type<E>::type>(rhs) >= 0);
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        o3tl::typed_flags<E>::mask
        & ~static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator ~(
    typename o3tl::typed_flags<E>::Wrap rhs)
{
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        o3tl::typed_flags<E>::mask
        & ~static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator ^(E lhs, E rhs) {
    assert(static_cast<typename o3tl::underlying_type<E>::type>(lhs) >= 0);
    assert(static_cast<typename o3tl::underlying_type<E>::type>(rhs) >= 0);
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        static_cast<typename o3tl::underlying_type<E>::type>(lhs)
        ^ static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator ^(
    E lhs, typename o3tl::typed_flags<E>::Wrap rhs)
{
    assert(static_cast<typename o3tl::underlying_type<E>::type>(lhs) >= 0);
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        static_cast<typename o3tl::underlying_type<E>::type>(lhs)
        ^ static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator ^(
    typename o3tl::typed_flags<E>::Wrap lhs, E rhs)
{
    assert(static_cast<typename o3tl::underlying_type<E>::type>(rhs) >= 0);
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        static_cast<typename o3tl::underlying_type<E>::type>(lhs)
        ^ static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator ^(
    typename o3tl::typed_flags<E>::Wrap lhs,
    typename o3tl::typed_flags<E>::Wrap rhs)
{
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        static_cast<typename o3tl::underlying_type<E>::type>(lhs)
        ^ static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator &(E lhs, E rhs) {
    assert(static_cast<typename o3tl::underlying_type<E>::type>(lhs) >= 0);
    assert(static_cast<typename o3tl::underlying_type<E>::type>(rhs) >= 0);
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        static_cast<typename o3tl::underlying_type<E>::type>(lhs)
        & static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator &(
    E lhs, typename o3tl::typed_flags<E>::Wrap rhs)
{
    assert(static_cast<typename o3tl::underlying_type<E>::type>(lhs) >= 0);
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        static_cast<typename o3tl::underlying_type<E>::type>(lhs)
        & static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator &(
    typename o3tl::typed_flags<E>::Wrap lhs, E rhs)
{
    assert(static_cast<typename o3tl::underlying_type<E>::type>(rhs) >= 0);
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        static_cast<typename o3tl::underlying_type<E>::type>(lhs)
        & static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator &(
    typename o3tl::typed_flags<E>::Wrap lhs,
    typename o3tl::typed_flags<E>::Wrap rhs)
{
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        static_cast<typename o3tl::underlying_type<E>::type>(lhs)
        & static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator |(E lhs, E rhs) {
    assert(static_cast<typename o3tl::underlying_type<E>::type>(lhs) >= 0);
    assert(static_cast<typename o3tl::underlying_type<E>::type>(rhs) >= 0);
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        static_cast<typename o3tl::underlying_type<E>::type>(lhs)
        | static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator |(
    E lhs, typename o3tl::typed_flags<E>::Wrap rhs)
{
    assert(static_cast<typename o3tl::underlying_type<E>::type>(lhs) >= 0);
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        static_cast<typename o3tl::underlying_type<E>::type>(lhs)
        | static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator |(
    typename o3tl::typed_flags<E>::Wrap lhs, E rhs)
{
    assert(static_cast<typename o3tl::underlying_type<E>::type>(rhs) >= 0);
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        static_cast<typename o3tl::underlying_type<E>::type>(lhs)
        | static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Wrap operator |(
    typename o3tl::typed_flags<E>::Wrap lhs,
    typename o3tl::typed_flags<E>::Wrap rhs)
{
    return static_cast<typename o3tl::typed_flags<E>::Wrap>(
        static_cast<typename o3tl::underlying_type<E>::type>(lhs)
        | static_cast<typename o3tl::underlying_type<E>::type>(rhs));
}

template<typename E>
inline typename o3tl::typed_flags<E>::Self operator &=(E & lhs, E rhs) {
    assert(static_cast<typename o3tl::underlying_type<E>::type>(lhs) >= 0);
    assert(static_cast<typename o3tl::underlying_type<E>::type>(rhs) >= 0);
    lhs = lhs & rhs;
    return lhs;
}

template<typename E>
inline typename o3tl::typed_flags<E>::Self operator &=(
    E & lhs, typename o3tl::typed_flags<E>::Wrap rhs)
{
    assert(static_cast<typename o3tl::underlying_type<E>::type>(lhs) >= 0);
    lhs = lhs & rhs;
    return lhs;
}

template<typename E>
inline typename o3tl::typed_flags<E>::Self operator |=(E & lhs, E rhs) {
    assert(static_cast<typename o3tl::underlying_type<E>::type>(lhs) >= 0);
    assert(static_cast<typename o3tl::underlying_type<E>::type>(rhs) >= 0);
    lhs = lhs | rhs;
    return lhs;
}

template<typename E>
inline typename o3tl::typed_flags<E>::Self operator |=(
    E & lhs, typename o3tl::typed_flags<E>::Wrap rhs)
{
    assert(static_cast<typename o3tl::underlying_type<E>::type>(lhs) >= 0);
    lhs = lhs | rhs;
    return lhs;
}

template<typename E>
inline typename o3tl::typed_flags<E>::Self operator ^=(E & lhs, E rhs) {
    assert(static_cast<typename o3tl::underlying_type<E>::type>(lhs) >= 0);
    assert(static_cast<typename o3tl::underlying_type<E>::type>(rhs) >= 0);
    lhs = lhs ^ rhs;
    return lhs;
}

template<typename E>
inline typename o3tl::typed_flags<E>::Self operator ^=(
    E & lhs, typename o3tl::typed_flags<E>::Wrap rhs)
{
    assert(static_cast<typename o3tl::underlying_type<E>::type>(lhs) >= 0);
    lhs = lhs ^ rhs;
    return lhs;
}

#endif /* INCLUDED_O3TL_TYPED_FLAGS_SET_HXX */

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */