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
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Computational Engine *
* *
* Copyright (c) 1999-2016, 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, write to the Free *
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
* MA 02110-1301, USA. *
* *
**************************************************************************/
/*! \file triangulation/xmltrireader2.h
* \brief Deals with parsing XML data for 2-dimensional triangulation packets.
*/
#ifndef __XMLTRIREADER2_H
#ifndef __DOXYGEN
#define __XMLTRIREADER2_H
#endif
#include "regina-core.h"
#include "triangulation/xmltrireader.h"
namespace regina {
/**
* \weakgroup triangulation
* @{
*/
/**
* An XML packet reader that reads a single 2-dimensional triangulation.
*
* This is a specialisation of the generic XMLTriangulationReader class
* template; see the XMLTriangulationReader documentation for an
* overview of how this class works.
*
* This 2-dimensional specialisation contains no extra functionality,
* though this may change in future releases of Regina.
*/
template <>
class REGINA_API XMLTriangulationReader<2> :
public detail::XMLTriangulationReaderBase<2> {
public:
/**
* Creates a new triangulation reader.
*
* @param resolver the master resolver that will be used to fix
* dangling packet references after the entire XML file has been read.
*/
XMLTriangulationReader(XMLTreeResolver& resolver);
/**
* Returns an XML element reader for the given optional property of a
* <i>dim</i>-dimensional triangulation.
*
* If \a subTagName names an XML element that describes an optional
* property of a triangulation (such as \c H1 or \c fundgroup for
* 3-manifold triangulations), then this function should return
* a corresponding element reader.
*
* Otherwise this function should return a new XMLElementReader,
* which will cause the XML element to be ignored.
*
* @param subTagName the name of the XML subelement opening tag.
* @param subTagProps the properties associated with the
* subelement opening tag.
* @return a newly created element reader that will be used to
* parse the subelement. This class should not take care of the
* new reader's destruction; that will be done by the parser.
*/
XMLElementReader* startPropertySubElement(
const std::string& subTagName,
const regina::xml::XMLPropertyDict& subTagProps);
};
/*@}*/
// Inline functions for XMLTriangulationReader<2>
inline XMLTriangulationReader<2>::XMLTriangulationReader(
XMLTreeResolver& resolver) :
detail::XMLTriangulationReaderBase<2>(resolver) {
}
inline XMLElementReader* XMLTriangulationReader<2>::startPropertySubElement(
const std::string&, const regina::xml::XMLPropertyDict&) {
return new XMLElementReader();
}
} // namespace regina
#endif
|
