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
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Computational Engine *
* *
* 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 file/xml/xmlsurfacereader.h
* \brief Deals with parsing XML data for normal surface lists.
*/
#ifndef __REGINA_XMLSURFACEREADER_H
#ifndef __DOXYGEN
#define __REGINA_XMLSURFACEREADER_H
#endif
#include <optional>
#include "regina-core.h"
#include "file/xml/xmlpacketreader.h"
#include "surface/normalsurfaces.h"
namespace regina {
/**
* An XML element reader that reads a single normal surface.
*
* \nopython
*/
class XMLNormalSurfaceReader : public XMLElementReader {
private:
std::optional<NormalSurface> surface_;
/**< The normal surface currently being read. */
SnapshotRef<Triangulation<3>> tri_;
/**< The triangulation in which this surface lives. */
NormalCoords coords_;
/**< The coordinate system used by this surface. */
int vecEnc_;
/**< The integer encoding used for the normal surface vector,
or 0 if this is unknown. */
long vecLen_;
/**< The length of the normal surface vector, or -1 if this
is unknown (since 0 is a valid vector length). */
std::string name_;
/**< The optional name associated with this normal surface. */
public:
/**
* Creates a new normal surface reader.
*
* \param tri the triangulation in which this normal surface lives.
* \param coords the coordinate system used by this normal surface.
*/
XMLNormalSurfaceReader(const SnapshotRef<Triangulation<3>>& tri,
NormalCoords coords);
/**
* Returns a reference to the normal surface that has been read.
*
* \return the normal surface, or \nullopt if an error occurred.
*/
std::optional<NormalSurface>& surface();
void startElement(const std::string& tagName,
const regina::xml::XMLPropertyDict& tagProps,
XMLElementReader* parentReader) override;
void initialChars(const std::string& chars) override;
XMLElementReader* startSubElement(const std::string& subTagName,
const regina::xml::XMLPropertyDict& subTagProps) override;
};
/**
* An XML packet reader that reads a single normal surface list.
*
* \nopython
*/
class XMLNormalSurfacesReader : public XMLPacketReader {
private:
std::shared_ptr<PacketOf<NormalSurfaces>> list_;
/**< The normal surface list currently being read. */
const Triangulation<3>* tri_;
/**< The triangulation in which these normal surfaces live. */
public:
/**
* Creates a new normal surface list reader.
*
* All parameters not explained here are the same as for the
* parent class XMLPacketReader.
*
* \param props the attributes of the \c surfaces XML element.
*/
XMLNormalSurfacesReader(XMLTreeResolver& resolver,
std::shared_ptr<Packet> parent, bool anon, std::string label,
std::string id, const regina::xml::XMLPropertyDict& props);
std::shared_ptr<Packet> packetToCommit() override;
XMLElementReader* startContentSubElement(const std::string& subTagName,
const regina::xml::XMLPropertyDict& subTagProps) override;
void endContentSubElement(const std::string& subTagName,
XMLElementReader* subReader) override;
};
/**
* An XML packet reader that reads a single normal surface list using
* the older second-generation file format.
*
* \nopython
*/
class XMLLegacyNormalSurfacesReader : public XMLPacketReader {
private:
std::shared_ptr<PacketOf<NormalSurfaces>> list_;
/**< The normal surface list currently being read. */
const Triangulation<3>& tri_;
/**< The triangulation in which these normal surfaces live. */
public:
/**
* Creates a new normal surface list reader.
*
* All parameters not explained here are the same as for the
* parent class XMLPacketReader.
*
* \param tri the triangulation in which these normal surfaces live.
*/
XMLLegacyNormalSurfacesReader(XMLTreeResolver& resolver,
std::shared_ptr<Packet> parent, bool anon, std::string label,
std::string id, const Triangulation<3>& tri);
std::shared_ptr<Packet> packetToCommit() override;
XMLElementReader* startContentSubElement(const std::string& subTagName,
const regina::xml::XMLPropertyDict& subTagProps) override;
void endContentSubElement(const std::string& subTagName,
XMLElementReader* subReader) override;
};
// Inline functions for XMLNormalSurfaceReader
inline XMLNormalSurfaceReader::XMLNormalSurfaceReader(
const SnapshotRef<Triangulation<3>>& tri, NormalCoords coords) :
tri_(tri), coords_(coords), vecLen_(-1), vecEnc_(0) {
}
inline std::optional<NormalSurface>& XMLNormalSurfaceReader::surface() {
return surface_;
}
// Inline functions for XMLNormalSurfacesReader
inline std::shared_ptr<Packet> XMLNormalSurfacesReader::packetToCommit() {
return list_;
}
// Inline functions for XMLLegacyNormalSurfacesReader
inline XMLLegacyNormalSurfacesReader::XMLLegacyNormalSurfacesReader(
XMLTreeResolver& res, std::shared_ptr<Packet> parent, bool anon,
std::string label, std::string id, const Triangulation<3>& tri) :
XMLPacketReader(res, std::move(parent), anon, std::move(label),
std::move(id)),
list_(nullptr), tri_(tri) {
}
inline std::shared_ptr<Packet> XMLLegacyNormalSurfacesReader::packetToCommit() {
return list_;
}
} // namespace regina
#endif
|
