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
|
/*
Ousía
Copyright (C) 2014, 2015 Benjamin Paaßen, Andreas Stöckel
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 3 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, see <http://www.gnu.org/licenses/>.
*/
#ifndef _OUSIA_VARIANT_CONVERTER_HPP_
#define _OUSIA_VARIANT_CONVERTER_HPP_
namespace ousia {
// Forward declaration
class Logger;
class RttiType;
class Variant;
enum class VariantType : int16_t;
/**
* The VariantConverter class is used to convert a variant to a certain
* prespecified type. The functions ensure that the variant has the requested
* type, even if the conversion fails.
*/
class VariantConverter {
public:
/**
* Enumeration used to define the mode of conversion -- either only safe
* conversions (without any data loss) are performed, or all possible
* conversions are tried (with possible data loss).
*/
enum class Mode { SAFE, ALL };
/**
* Converts the given variant to a boolean. If the "mode" parameter is set
* to Mode::SAFE, only booleans can be converted to booleans. For all other
* types the conversion fails. If "mode" is set to Mode::ALL, nullptr
* values and zero numeric values are treated as "false", all other values
* are treated as "true".
*
* @param var is instance of the Variant class that should be converted to
* the requested type.
* @param logger is a reference to the logger instance into which messages
* should be logged.
* @param mode is the conversion mode. See method description for the exact
* effect.
*/
static bool toBool(Variant &var, Logger &logger, Mode mode = Mode::SAFE);
/**
* Converts the given variant to an integer. If the "mode" parameter is set
* to Mode::SAFE, only integers can be converted to integers. For all other
* types the conversion fails. If "mode" is set to Mode::ALL, booleans are
* converted to 0, 1, nullptr is converted to 0, doubles are truncated,
* strings are parsed and truncated, arrays with one element are converted
* to an integer. Conversion fails for objects, functions, maps and arrays
* with zero or more than one entry.
*
* @param var is instance of the Variant class that should be converted to
* the requested type.
* @param logger is a reference to the logger instance into which messages
* should be logged.
* @param mode is the conversion mode. See method description for the exact
* effect.
*/
static bool toInt(Variant &var, Logger &logger, Mode mode = Mode::SAFE);
/**
* Converts the given variant to a double. If the "mode" parameter is set
* to Mode::SAFE, only integers and doubles can be converted to doubles. For
* all other types the conversion fails. If "mode" is set to Mode::ALL,
* booleans are converted to 0.0, 1.0, nullptr is converted to 0.0, strings
* are parsed, arrays with one element are converted to a double.
* Conversion fails for objects, functions, maps and arrays with zero or
* more than one entry.
*
* @param var is instance of the Variant class that should be converted to
* the requested type.
* @param logger is a reference to the logger instance into which messages
* should be logged.
* @param mode is the conversion mode. See method description for the exact
* effect.
*/
static bool toDouble(Variant &var, Logger &logger, Mode mode = Mode::SAFE);
/**
* Converts the given variant to a double. If the "mode" parameter is set
* to Mode::SAFE, all primitive types can be converted to strings. For
* all other types the conversion fails. If "mode" is set to Mode::ALL,
* maps and arrays are converted to a JSON representation, objects and
* functions are converted to an informative string containing their pointer
* and type.
*
* @param var is instance of the Variant class that should be converted to
* the requested type.
* @param logger is a reference to the logger instance into which messages
* should be logged.
* @param mode is the conversion mode. See method description for the exact
* effect.
*/
static bool toString(Variant &var, Logger &logger, Mode mode = Mode::SAFE);
static bool convert(Variant &var, VariantType requestedType,
const RttiType &rttiType, Logger &logger,
Mode mode = Mode::SAFE);
static bool convert(Variant &var, VariantType requestedType,
Logger &logger, Mode mode = Mode::SAFE);
};
}
#endif /* _OUSIA_VARIANT_CONVERTER_HPP_ */
|
