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
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Python Interface *
* *
* Copyright (c) 1999-2025, Ben Burton *
* For further details contact Ben Burton (bab@debian.org). *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License as *
* published by the Free Software Foundation; either version 2 of the *
* License, or (at your option) any later version. *
* *
* As an exception, when this program is distributed through (i) the *
* App Store by Apple Inc.; (ii) the Mac App Store by Apple Inc.; or *
* (iii) Google Play by Google Inc., then that store may impose any *
* digital rights management, device limits and/or redistribution *
* restrictions that are required by its terms of service. *
* *
* This program is distributed in the hope that it will be useful, but *
* WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <https://www.gnu.org/licenses/>. *
* *
**************************************************************************/
/*! \file python/helpers/flags.h
* \brief Assists with wrapping Regina's flag constants and related classes.
*
* This header is _not_ included automatically by python/helpers.h.
* If you need it, you will need to include it yourself.
*/
#include "regina-config.h" // for REGINA_PYBIND11_VERSION
#include <iomanip>
#include <sstream>
#include "../helpers.h"
#if REGINA_PYBIND11_VERSION == 3
#include <pybind11/native_enum.h>
#endif
#include <pybind11/operators.h>
#include "utilities/flags.h"
#include "../helpers/docstrings.h"
#include "../docstrings/utilities/flags.h"
namespace regina::python {
/**
* Adds Python bindings for a flag enumeration type, as well as a
* full-featured regina::Flags class type built upon it.
*
* The argument \c Enum should be a C++ enumeration type, and will be
* given the Python enum name \a enumName and docstring \a enumDoc.
* The individual flag constants should be passed in the list \a values:
* each tuple is of the form (\a python_name, \a real_value, \a docstring).
* The extra string \a borDoc is the docstring that will be used for the
* bitwise OR of two individual flags.
*
* The corresponding flags class is assumed to be regina::Flags<Enum>,
* and will be given the Python class name `Flags_enumName`.
*
* This routine will define __str__ and __repr__ functions for the flags class,
* so that users can easily see what value a combination of flags holds. The
* flag will be written in hexadecimal, using a minimum of \a hexWidth digits.
*/
template <typename Enum, int hexWidth = 4>
void add_flags(pybind11::module_& m, const std::string& enumName,
std::initializer_list<std::tuple<const char*, Enum, const char*>>
values,
const char* enumDoc, const char* borDoc) {
using Flags = regina::Flags<Enum>;
#if REGINA_PYBIND11_VERSION == 3
auto e = pybind11::native_enum<Enum>(m, enumName.c_str(), "enum.Flag",
enumDoc);
#elif REGINA_PYBIND11_VERSION == 2
auto e = pybind11::enum_<Enum>(m, enumName.c_str(), enumDoc);
#else
#error "Unsupported pybind11 version"
#endif
for (const auto& v : values) {
// This should be a job for std::apply, except that e.value() is
// a non-static member function.
e.value(std::get<0>(v), std::get<1>(v), std::get<2>(v));
}
#if REGINA_PYBIND11_VERSION == 3
e.finalize();
#endif
// We define some additional operators on the enum type later,
// once we have bound Flags<Enum>. (This means that docstrings will
// get the abbreviated typenames.)
RDOC_SCOPE_BEGIN(Flags)
auto f = pybind11::class_<Flags>(m,
("Flags_" + enumName).c_str(), rdoc_scope)
.def(pybind11::init<>(), rdoc::__default)
.def(pybind11::init<Enum>(), rdoc::__init)
.def(pybind11::init<const Flags&>(), rdoc::__copy)
.def("has", pybind11::overload_cast<const Flags&>(
&Flags::has, pybind11::const_), rdoc::has_2)
.def("intValue", &Flags::intValue, rdoc::intValue)
.def_static("fromInt", &Flags::fromInt, rdoc::fromInt)
.def("__bool__", &Flags::operator bool, rdoc::__as_bool)
.def(pybind11::self |= pybind11::self, rdoc::__ior_2)
.def(pybind11::self &= pybind11::self, rdoc::__iand_2)
.def(pybind11::self ^= pybind11::self, rdoc::__ixor_2)
.def(pybind11::self | pybind11::self, rdoc::__bor_2)
.def(pybind11::self & pybind11::self, rdoc::__band_2)
.def(pybind11::self ^ pybind11::self, rdoc::__bxor_2)
.def("clear", pybind11::overload_cast<const Flags&>(&Flags::clear),
rdoc::clear_2)
.def("ensureOne", pybind11::overload_cast<Enum, Enum>(
&Flags::ensureOne), rdoc::ensureOne)
.def("ensureOne", pybind11::overload_cast<Enum, Enum, Enum>(
&Flags::ensureOne), rdoc::ensureOne_2)
.def("ensureOne", pybind11::overload_cast<Enum, Enum, Enum, Enum>(
&Flags::ensureOne), rdoc::ensureOne_3)
.def("__str__", [](Flags f) {
std::ostringstream out;
out << "0x" << std::hex << std::setw(hexWidth) << std::setfill('0')
<< f.intValue();
return out.str();
})
.def("__repr__", [](Flags f) {
std::ostringstream out;
out << "<regina."
<< pybind11::str(pybind11::type::handle_of<Flags>().attr(
"__name__")).cast<std::string_view>()
<< ": 0x" << std::hex << std::setw(hexWidth)
<< std::setfill('0') << f.intValue() << '>';
return out.str();
})
;
regina::python::add_eq_operators(f, rdoc::__eq_2);
RDOC_SCOPE_END
// Additional operators for Enum:
#if REGINA_PYBIND11_VERSION == 3
// Logical operations are provided on the Python side by enum.Flag.
#elif REGINA_PYBIND11_VERSION == 2
e.def("__or__", [](Enum lhs, Enum rhs) {
return Flags(lhs) | rhs;
}, borDoc);
e.def("__bool__", [](Enum val) {
return static_cast<int>(val) != 0;
}, doc::common::bool_enum_for_flags);
#endif
// Type conversions:
pybind11::implicitly_convertible<Enum, Flags>();
}
} // namespace regina::python
|
