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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* Inkscape Units
* These classes are used for defining different unit systems.
*
* Authors:
* Matthew Petroff <matthew@mpetroff.net>
*
* Copyright (C) 2013 Matthew Petroff
*
* Released under GNU GPL v2+, read the file 'COPYING' for more information.
*/
#ifndef INKSCAPE_UTIL_UNITS_H
#define INKSCAPE_UTIL_UNITS_H
#include <unordered_map>
#include <boost/operators.hpp>
#include <glibmm/ustring.h>
#include <2geom/coord.h>
#include "svg/svg-length.h"
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#define DEFAULT_UNIT_NAME "mm"
namespace std {
template <>
struct hash<Glib::ustring> : public std::unary_function<Glib::ustring, std::size_t> {
std::size_t operator()(Glib::ustring const &s) const {
return hash<std::string>()(s.raw());
}
};
} // namespace std
#endif
namespace Inkscape {
namespace Util {
enum UnitType {
UNIT_TYPE_DIMENSIONLESS, /* Percentage */
UNIT_TYPE_LINEAR,
UNIT_TYPE_LINEAR_SCALED,
UNIT_TYPE_RADIAL,
UNIT_TYPE_TIME,
UNIT_TYPE_FONT_HEIGHT,
UNIT_TYPE_QTY,
UNIT_TYPE_NONE = -1
};
const char DEG[] = "°";
class Unit
: boost::equality_comparable<Unit>
{
public:
Unit();
Unit(UnitType type,
double factor,
Glib::ustring name,
Glib::ustring name_plural,
Glib::ustring abbr,
Glib::ustring description);
void clear();
bool isAbsolute() const { return type != UNIT_TYPE_DIMENSIONLESS; }
/**
* Returns the suggested precision to use for displaying numbers
* of this unit.
*/
int defaultDigits() const;
/** Checks if a unit is compatible with the specified unit. */
bool compatibleWith(Unit const *u) const;
bool compatibleWith(Glib::ustring const &) const;
bool compatibleWith(char const *) const;
UnitType type;
double factor;
Glib::ustring name;
Glib::ustring name_plural;
Glib::ustring abbr;
Glib::ustring description;
/** Check if units are equal. */
bool operator==(Unit const &other) const;
/** Get SVG unit code. */
int svgUnit() const;
/** Convert value from this unit **/
double convert(double from_dist, Unit const *to) const;
double convert(double from_dist, Glib::ustring const &to) const;
double convert(double from_dist, char const *to) const;
};
class Quantity
: boost::totally_ordered<Quantity>
{
public:
Unit const *unit;
double quantity;
/** Initialize a quantity. */
Quantity(double q, Unit const *u);
Quantity(double q, Glib::ustring const &u);
Quantity(double q, char const *u);
/** Checks if a quantity is compatible with the specified unit. */
bool compatibleWith(Unit const *u) const;
bool compatibleWith(Glib::ustring const &u) const;
bool compatibleWith(char const *u) const;
/** Return the quantity's value in the specified unit. */
double value(Unit const *u) const;
double value(Glib::ustring const &u) const;
double value(char const *u) const;
/** Return a printable string of the value in the specified unit. */
Glib::ustring string(Unit const *u) const;
Glib::ustring string(Glib::ustring const &u) const;
Glib::ustring string() const;
/** Convert distances.
no NULL check is performed on the passed pointers to Unit objects! */
static double convert(double from_dist, Unit const *from, Unit const *to);
static double convert(double from_dist, Glib::ustring const &from, Unit const *to);
static double convert(double from_dist, Unit const *from, Glib::ustring const &to);
static double convert(double from_dist, Glib::ustring const &from, Glib::ustring const &to);
static double convert(double from_dist, char const *from, char const *to);
/** Comparison operators. */
bool operator<(Quantity const &rhs) const;
bool operator==(Quantity const &other) const;
};
inline bool are_near(Quantity const &a, Quantity const &b, double eps=Geom::EPSILON)
{
return Geom::are_near(a.quantity, b.value(a.unit), eps);
}
class UnitTable {
public:
/**
* Initializes the unit tables and identifies the primary unit types.
*
* The primary unit's conversion factor is required to be 1.00
*/
UnitTable();
virtual ~UnitTable();
typedef std::unordered_map<Glib::ustring, Unit> UnitMap;
typedef std::unordered_map<unsigned, Unit*> UnitCodeMap;
/** Add a new unit to the table */
void addUnit(Unit const &u, bool primary);
/** Retrieve a given unit based on its string identifier */
Unit const *getUnit(Glib::ustring const &name) const;
Unit const *getUnit(char const *name) const;
/** Try to find a unit based on its conversion factor to the primary */
Unit const *findUnit(double factor, UnitType type) const;
/** Retrieve a given unit based on its SVGLength unit */
Unit const *getUnit(SVGLength::Unit u) const;
/** Retrieve a quantity based on its string identifier */
Quantity parseQuantity(Glib::ustring const &q) const;
/** Remove a unit definition from the given unit type table * /
* DISABLED, unsafe with the current passing around pointers to Unit objects in this table */
//bool deleteUnit(Unit const &u);
/** Returns true if the given string 'name' is a valid unit in the table */
bool hasUnit(Glib::ustring const &name) const;
/** Provides an iterable list of items in the given unit table */
UnitMap units(UnitType type) const;
/** Returns the default unit abbr for the given type */
Glib::ustring primary(UnitType type) const;
double getScale() const;
void setScale();
/** Load units from an XML file.
*
* Loads and merges the contents of the given file into the UnitTable,
* possibly overwriting existing unit definitions.
*
* @param filename file to be loaded
*/
bool load(std::string const &filename);
/* * Saves the current UnitTable to the given file. */
//bool save(std::string const &filename);
protected:
UnitCodeMap _unit_map;
Glib::ustring _primary_unit[UNIT_TYPE_QTY];
double _linear_scale;
static Unit _empty_unit;
private:
UnitTable(UnitTable const &t);
UnitTable operator=(UnitTable const &t);
};
extern UnitTable unit_table;
} // namespace Util
} // namespace Inkscape
#endif // define INKSCAPE_UTIL_UNITS_H
/*
Local Variables:
mode:c++
c-file-style:"stroustrup"
c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
indent-tabs-mode:nil
fill-column:99
End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :
|
