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
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Computational Engine *
* *
* Copyright (c) 1999-2008, 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 engine.h
* \brief Provides global routines for interfacing with the Regina
* calculation engine.
*/
#ifndef __ENGINE_H
#ifndef __DOXYGEN
#define __ENGINE_H
#endif
/**
* Contains the entire Regina calculation engine.
*
* \todo \prob Derive from regina::boost::noncopyable where appropriate.
* \todo \featurelong Enhance the test suite for the calculation engine.
*/
namespace regina {
/**
* \addtogroup engine Engine Structure
* Overall structure of the calculation engine.
* @{
*/
/**
* Returns the full version number of this calculation engine.
* For instance, version 2.3.1 would have full version <tt>"2.3.1"</tt>.
*
* @return the version of this calculation engine.
*/
const char* getVersionString();
/**
* Returns the major version number of this calculation engine.
* For instance, version 2.3.1 would have major version 2.
*
* @return the major version number of this calculation engine.
*/
int getVersionMajor();
/**
* Returns the minor version number of this calculation engine.
* For instance, version 2.3.1 would have minor version 3.
*
* @return the minor version number of this calculation engine.
*/
int getVersionMinor();
/**
* Did the given version of Regina consistently use UTF-8 in its data
* files?
*
* In Regina versions 4.4 and below, no particular attention was paid to
* character encodings. As a result, the GUI typically stored data in
* LATIN1 (the default for the Qt libraries).
*
* As of Regina 4.5, all strings are now stored in UTF-8 where possible.
*
* This routine allows programs to determine which regime a particular
* version of Regina belongs to. This can be useful when working with
* Regina data files on a low-level basis.
*
* Any whitespace in the version string will confuse the result, and the
* return value will be undefined.
*
* As a special case, an empty string is treated as belonging to the
* UTF-8 regime.
*
* @param version a version string from some release of Regina, such as "4.2".
* This must not contain any whitespace padding.
* @return \c true if the given version uses UTF-8 consistently, or
* \c false if the given version is an older version that did not pay
* attention to character encodings.
*/
bool versionUsesUTF8(const char* version);
/**
* Tests to see if an interface can successfully communicate with the
* underlying C++ calculation engine.
*
* This routine simply uses the engine to return the same value that is
* passed to it; it can be used to test whether communications between
* the interface and the C++ engine are working properly.
*
* @param value any integer; this same integer will be returned.
* @return the same integer that was passed as \a value.
*/
int testEngine(int value);
/*@}*/
} // namespace regina
#endif
|
