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
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Computational Engine *
* *
* Copyright (c) 1999-2011, 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. *
* *
* 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. *
* *
**************************************************************************/
/* end stub */
/*! \file foreign/snappea.h
* \brief Allows reading and writing SnapPea files.
*/
#ifndef __SNAPPEA_H
#ifndef __DOXYGEN
#define __SNAPPEA_H
#endif
#include <string>
#include "regina-core.h"
namespace regina {
class NTriangulation;
/**
* \addtogroup foreign Foreign File Formats
* Reading and writing foreign file formats.
* @{
*/
/**
* Reads a triangulation from the given SnapPea file. A newly allocated
* triangulation will be returned; it is the user's responsibility to
* deallocate this when it is finished with.
*
* The packet label of the new triangulation will be the manifold name
* read from the second line of the SnapPea file. The first line of the
* SnapPea file must simply be ``<tt>% Triangulation</tt>.
*
* If the file could not be read or if the data was not in the correct
* format, 0 will be returned.
*
* \pre The first two lines of the SnapPea file each contain at most
* 1000 characters.
*
* \i18n This routine makes no assumptions about the
* \ref i18n "character encoding" used in the given file \e name, and
* simply passes it through unchanged to low-level C/C++ file I/O routines.
* It assumes however that the \e contents of the file are in UTF-8.
*
* @param filename the name of the SnapPea file from which to read.
* @return a new triangulation containing the data read from the SnapPea
* file, or 0 on error.
*/
REGINA_API NTriangulation* readSnapPea(const char *filename);
/**
* Writes the given triangulation to the given file in SnapPea format.
* All information aside from tetrahedron gluings will be flagged as
* unknown for SnapPea to recalculate.
* The manifold name written in the file will be derived from the packet
* label.
*
* \pre The given triangulation is not invalid, and does not contain any
* boundary faces.
*
* \i18n This routine makes no assumptions about the
* \ref i18n "character encoding" used in the given file \e name, and
* simply passes it through unchanged to low-level C/C++ file I/O routines.
* The \e contents of the file will be written using UTF-8.
*
* @param filename the name of the SnapPea file to which to write.
* @param tri the triangulation to write to the SnapPea file.
* @return \c true if the export was successful, or \c false otherwise.
*/
REGINA_API bool writeSnapPea(const char* filename, NTriangulation& tri);
/**
* Returns a token derived from the given string.
* All whitespace characters in the given string will be replaced with
* an underscore.
*
* @param str the string on which to base the token.
* @return the corresponding token.
*/
REGINA_API std::string stringToToken(const char* str);
/**
* Returns a token derived from the given string.
* All whitespace characters in the given string will be replaced with
* an underscore.
*
* @param str the string on which to base the token.
* @return the corresponding token.
*/
REGINA_API std::string stringToToken(const std::string& str);
/*@}*/
} // namespace regina
#endif
|
