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
|
/**************************************************************************
* *
* 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/>. *
* *
**************************************************************************/
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
#include "utilities/sigutils.h"
#include "../helpers.h"
#include "../docstrings/utilities/sigutils.h"
using regina::Base64SigEncoder;
using regina::Base64SigEncoding;
using Decoder = regina::Base64SigDecoder<std::string::const_iterator>;
namespace regina::python {
// For Python (but not C++), we need Base64SigDecoder to keep a deep copy
// of the base64 string.
//
// Awkwardly, we need to copy the string _before_ passing its iterators to
// the Base64Decoder constructor, which means we can't just keep the string
// as member variable (since base classes are initialised first).
// Instead we use _another_ base class holding the string, which is
// initialised before Base64Decoder. Bleh.
struct StringStorage {
std::string str_;
StringStorage(std::string&& str) : str_(std::move(str)) {}
};
class Base64SigDecoder_Copy : private StringStorage, public Decoder {
public:
Base64SigDecoder_Copy(std::string str, bool skipInitialWhitespace) :
StringStorage(std::move(str)),
Decoder(str_.begin(), str_.end(), skipInitialWhitespace) {
}
};
}
void addSigUtils(pybind11::module_& m) {
RDOC_SCOPE_BEGIN(Base64SigEncoding)
#if defined(__GNUC__)
// The class Base64SigEncoding is deprecated, but we still need to bind it.
// Silence the inevitable deprecation warning that will occur.
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma GCC diagnostic ignored "-Wdeprecated"
#else
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
#endif
auto c = pybind11::class_<Base64SigEncoding>(m, "Base64SigEncoding",
rdoc_scope)
.def_static("decodeSingle", &Base64SigEncoding::decodeSingle,
rdoc::decodeSingle)
.def_static("encodeSingle", &Base64SigEncoding::encodeSingle,
rdoc::encodeSingle)
.def_static("isValid", &Base64SigEncoding::isValid, rdoc::isValid)
.def_static("encodeInt", &Base64SigEncoding::encodeInt<long>,
rdoc::encodeInt)
.def_static("decodeInt", &Base64SigEncoding::decodeInt<long>,
rdoc::decodeInt)
.def_static("encodeTrits",
pybind11::overload_cast<const std::array<uint8_t, 0>&>(
&Base64SigEncoding::encodeTrits<0>),
rdoc::encodeTrits)
.def_static("encodeTrits",
pybind11::overload_cast<const std::array<uint8_t, 1>&>(
&Base64SigEncoding::encodeTrits<1>),
rdoc::encodeTrits)
.def_static("encodeTrits",
pybind11::overload_cast<const std::array<uint8_t, 2>&>(
&Base64SigEncoding::encodeTrits<2>),
rdoc::encodeTrits)
.def_static("encodeTrits",
pybind11::overload_cast<const std::array<uint8_t, 3>&>(
&Base64SigEncoding::encodeTrits<3>),
rdoc::encodeTrits)
// overload_cast cannot handle template vs non-template overloads.
.def_static("decodeTrits", static_cast<std::array<uint8_t, 3>(&)(char)>(
Base64SigEncoding::decodeTrits),
rdoc::decodeTrits)
;
regina::python::no_eq_static(c);
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
RDOC_SCOPE_SWITCH(Base64SigEncoder)
auto e = pybind11::class_<Base64SigEncoder>(m, "Base64SigEncoder",
rdoc_scope)
.def(pybind11::init<>(), rdoc::__default)
.def("str",
static_cast<const std::string&(Base64SigEncoder::*)() const &>(
&Base64SigEncoder::str),
rdoc::str)
.def("encodeSingle", &Base64SigEncoder::encodeSingle<long>,
rdoc::encodeSingle)
.def("encodeSize", &Base64SigEncoder::encodeSize, rdoc::encodeSize)
.def("encodeInt", &Base64SigEncoder::encodeInt<long>, rdoc::encodeInt)
.def("encodeInts",
[](Base64SigEncoder& enc, const std::vector<long>& v, int nChars) {
enc.encodeInts(v.begin(), v.end(), nChars);
}, rdoc::encodeInts)
.def("encodeTrits",
[](Base64SigEncoder& enc, const std::vector<uint8_t>& v) {
enc.encodeTrits(v.begin(), v.end());
}, rdoc::encodeTrits)
.def("append", &Base64SigEncoder::append, rdoc::append)
.def_readonly_static("spare", &Base64SigEncoder::spare)
;
regina::python::add_eq_operators(e);
RDOC_SCOPE_SWITCH(Base64SigDecoder)
auto d = pybind11::class_<regina::python::Base64SigDecoder_Copy>(m,
"Base64SigDecoder", rdoc_scope)
.def(pybind11::init<const std::string&, bool>(),
pybind11::arg(), pybind11::arg("skipInitialWhitespace") = true,
rdoc::__init)
.def("skipWhitespace", &Decoder::skipWhitespace, rdoc::skipWhitespace)
.def("done", &Decoder::done,
pybind11::arg("ignoreWhitespace") = true, rdoc::done)
.def("peek", &Decoder::peek, rdoc::peek)
.def("skip", &Decoder::skip, rdoc::skip)
.def("decodeSingle", &Decoder::decodeSingle<long>, rdoc::decodeSingle)
.def("decodeSize", &Decoder::decodeSize, rdoc::decodeSize)
.def("decodeInt", &Decoder::decodeInt<long>, rdoc::decodeInt)
.def("decodeInts", [](regina::python::Base64SigDecoder_Copy& dec,
size_t count, int nChars) {
// Reimplement this using decodeInt(), since the iterators for
// pybind11::list have the wrong value type.
pybind11::list ans;
for (size_t i = 0; i < count; ++i)
ans.append(dec.decodeInt<long>(nChars));
return ans;
})
// overload_cast cannot handle template vs non-template overloads.
.def("decodeTrits", static_cast<std::array<uint8_t, 3>(Decoder::*)()>(
&Decoder::decodeTrits),
rdoc::decodeTrits)
.def_static("isValid", &Decoder::isValid, rdoc::isValid)
;
regina::python::add_eq_operators(d);
RDOC_SCOPE_END
}
|
