doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / intern / unit.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup bke
19  */
20
21 #include <stdlib.h>
22 #include <stdio.h>
23 #include <ctype.h>
24 #include <string.h>
25 #include <assert.h>
26
27 #include "BLI_sys_types.h"
28 #include "BLI_math.h"
29 #include "BLI_string.h"
30 #include "BLI_string_utf8.h"
31
32 #include "DNA_scene_types.h"
33
34 #include "BKE_unit.h"  /* own include */
35
36 #ifdef WIN32
37 #  include "BLI_winstuff.h"
38 #endif
39
40 /* no BKE or DNA includes! */
41
42 #define TEMP_STR_SIZE 256
43
44 #define SEP_CHR         '#'
45 #define SEP_STR         "#"
46
47 #define EPS 0.001
48
49 #define UN_SC_KM        1000.0f
50 #define UN_SC_HM        100.0f
51 #define UN_SC_DAM       10.0f
52 #define UN_SC_M         1.0f
53 #define UN_SC_DM        0.1f
54 #define UN_SC_CM        0.01f
55 #define UN_SC_MM        0.001f
56 #define UN_SC_UM        0.000001f
57
58 #define UN_SC_MI        1609.344f
59 #define UN_SC_FUR       201.168f
60 #define UN_SC_CH        20.1168f
61 #define UN_SC_YD        0.9144f
62 #define UN_SC_FT        0.3048f
63 #define UN_SC_IN        0.0254f
64 #define UN_SC_MIL       0.0000254f
65
66 #define UN_SC_MTON      1000.0f /* metric ton */
67 #define UN_SC_QL        100.0f
68 #define UN_SC_KG        1.0f
69 #define UN_SC_HG        0.1f
70 #define UN_SC_DAG       0.01f
71 #define UN_SC_G         0.001f
72 #define UN_SC_MG        0.000001f
73
74 #define UN_SC_ITON      907.18474f /* imperial ton */
75 #define UN_SC_CWT       45.359237f
76 #define UN_SC_ST        6.35029318f
77 #define UN_SC_LB        0.45359237f
78 #define UN_SC_OZ        0.028349523125f
79
80 /* define a single unit */
81 typedef struct bUnitDef {
82         const char *name;
83         /** abused a bit for the display name */
84         const char *name_plural;
85         /** this is used for display*/
86         const char *name_short;
87         /** keyboard-friendly ASCII-only version of name_short, can be NULL */
88         const char *name_alt;
89         /* if name_short has non-ASCII chars, name_alt should be present */
90
91         /** can be NULL */
92         const char *name_display;
93         /** when NULL, a transformed version of the name will be taken */
94         const char *identifier;
95
96         double scalar;
97         /** not used yet, needed for converting temperature */
98         double bias;
99         int flag;
100 } bUnitDef;
101
102 enum {
103         B_UNIT_DEF_NONE = 0,
104         /** Use for units that are not used enough to be translated into for common use */
105         B_UNIT_DEF_SUPPRESS = 1,
106         /** Display a unit even if its value is 0.1, eg 0.1mm instead of 100um */
107         B_UNIT_DEF_TENTH = 2,
108         /** Short unit name is case sensitive, for example to distinguish mW and MW */
109         B_UNIT_DEF_CASE_SENSITIVE = 4,
110 };
111
112 /* define a single unit */
113 typedef struct bUnitCollection {
114         const struct bUnitDef *units;
115         /** basic unit index (when user doesn't specify unit explicitly) */
116         int base_unit;
117         /** options for this system */
118         int flag;
119         /** to quickly find the last item */
120         int length;
121 } bUnitCollection;
122
123 #define UNIT_COLLECTION_LENGTH(def) (sizeof(def) / sizeof(bUnitDef) - 1)
124 #define NULL_UNIT {NULL, NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
125
126 /* Dummy */
127 static struct bUnitDef buDummyDef[] = { {"", NULL, "", NULL, NULL, NULL, 1.0, 0.0}, NULL_UNIT};
128 static struct bUnitCollection buDummyCollection = {buDummyDef, 0, 0, sizeof(buDummyDef)};
129
130 /* Lengths */
131 static struct bUnitDef buMetricLenDef[] = {
132         {"kilometer",  "kilometers",  "km",  NULL, "Kilometers",     "KILOMETERS",  UN_SC_KM,  0.0, B_UNIT_DEF_NONE},
133         {"hectometer", "hectometers", "hm",  NULL, "100 Meters",     "HECTOMETERS", UN_SC_HM,  0.0, B_UNIT_DEF_SUPPRESS},
134         {"dekameter",  "dekameters",  "dam", NULL, "10 Meters",      "DEKAMETERS",  UN_SC_DAM, 0.0, B_UNIT_DEF_SUPPRESS},
135         {"meter",      "meters",      "m",   NULL, "Meters",         "METERS",      UN_SC_M,   0.0, B_UNIT_DEF_NONE},     /* base unit */
136         {"decimeter",  "decimeters",  "dm",  NULL, "10 Centimeters", "DECIMETERS",  UN_SC_DM,  0.0, B_UNIT_DEF_SUPPRESS},
137         {"centimeter", "centimeters", "cm",  NULL, "Centimeters",    "CENTIMETERS", UN_SC_CM,  0.0, B_UNIT_DEF_NONE},
138         {"millimeter", "millimeters", "mm",  NULL, "Millimeters",    "MILLIMETERS", UN_SC_MM,  0.0, B_UNIT_DEF_NONE | B_UNIT_DEF_TENTH},
139         {"micrometer", "micrometers", "µm",  "um", "Micrometers",    "MICROMETERS", UN_SC_UM,  0.0, B_UNIT_DEF_NONE},
140
141         /* These get displayed because of float precision problems in the transform header,
142          * could work around, but for now probably people wont use these */
143 #if 0
144         {"nanometer", "Nanometers",     "nm", NULL, 0.000000001, 0.0,   B_UNIT_DEF_NONE},
145         {"picometer", "Picometers",     "pm", NULL, 0.000000000001, 0.0, B_UNIT_DEF_NONE},
146 #endif
147         NULL_UNIT,
148 };
149 static const struct bUnitCollection buMetricLenCollection = {buMetricLenDef, 3, 0, UNIT_COLLECTION_LENGTH(buMetricLenDef)};
150
151 static struct bUnitDef buImperialLenDef[] = {
152         {"mile",    "miles",    "mi",   "m",  "Miles",    "MILES",    UN_SC_MI,  0.0, B_UNIT_DEF_NONE},
153         {"furlong", "furlongs", "fur",  NULL, "Furlongs", "FURLONGS", UN_SC_FUR, 0.0, B_UNIT_DEF_SUPPRESS},
154         {"chain",   "chains",   "ch",   NULL, "Chains",   "CHAINS",   UN_SC_CH,  0.0, B_UNIT_DEF_SUPPRESS},
155         {"yard",    "yards",    "yd",   NULL, "Yards",    "YARDS",    UN_SC_YD,  0.0, B_UNIT_DEF_SUPPRESS},
156         {"foot",    "feet",     "'",    "ft", "Feet",     "FEET",     UN_SC_FT,  0.0, B_UNIT_DEF_NONE}, /* base unit */
157         {"inch",    "inches",   "\"",   "in", "Inches",   "INCHES",   UN_SC_IN,  0.0, B_UNIT_DEF_NONE},
158         {"thou",    "thou",     "thou", "mil", "Thou",    "THOU",     UN_SC_MIL, 0.0, B_UNIT_DEF_NONE}, /* plural for thou has no 's' */
159         NULL_UNIT,
160 };
161 static struct bUnitCollection buImperialLenCollection = {buImperialLenDef, 4, 0, UNIT_COLLECTION_LENGTH(buImperialLenDef)};
162
163 /* Areas */
164 static struct bUnitDef buMetricAreaDef[] = {
165         {"square kilometer",  "square kilometers",  "km²",  "km2",  "Square Kilometers",  NULL, UN_SC_KM * UN_SC_KM,   0.0, B_UNIT_DEF_NONE},
166         {"square hectometer", "square hectometers", "hm²",  "hm2",  "Square Hectometers", NULL, UN_SC_HM * UN_SC_HM,   0.0, B_UNIT_DEF_SUPPRESS},   /* hectare */
167         {"square dekameter",  "square dekameters",  "dam²", "dam2", "Square Dekameters",  NULL, UN_SC_DAM * UN_SC_DAM, 0.0, B_UNIT_DEF_SUPPRESS},  /* are */
168         {"square meter",      "square meters",      "m²",   "m2",   "Square Meters",      NULL, UN_SC_M * UN_SC_M,     0.0, B_UNIT_DEF_NONE},   /* base unit */
169         {"square decimeter",  "square decimetees",  "dm²",  "dm2",  "Square Decimeters",  NULL, UN_SC_DM * UN_SC_DM,   0.0, B_UNIT_DEF_SUPPRESS},
170         {"square centimeter", "square centimeters", "cm²",  "cm2",  "Square Centimeters", NULL, UN_SC_CM * UN_SC_CM,   0.0, B_UNIT_DEF_NONE},
171         {"square millimeter", "square millimeters", "mm²",  "mm2",  "Square Millimeters", NULL, UN_SC_MM * UN_SC_MM,   0.0, B_UNIT_DEF_NONE | B_UNIT_DEF_TENTH},
172         {"square micrometer", "square micrometers", "µm²",  "um2",  "Square Micrometers", NULL, UN_SC_UM * UN_SC_UM,   0.0, B_UNIT_DEF_NONE},
173         NULL_UNIT,
174 };
175 static struct bUnitCollection buMetricAreaCollection = {buMetricAreaDef, 3, 0, UNIT_COLLECTION_LENGTH(buMetricAreaDef)};
176
177 static struct bUnitDef buImperialAreaDef[] = {
178         {"square mile",    "square miles",    "sq mi", "sq m", "Square Miles",    NULL, UN_SC_MI * UN_SC_MI,   0.0, B_UNIT_DEF_NONE},
179         {"square furlong", "square furlongs", "sq fur", NULL,  "Square Furlongs", NULL, UN_SC_FUR * UN_SC_FUR, 0.0, B_UNIT_DEF_SUPPRESS},
180         {"square chain",   "square chains",   "sq ch",  NULL,  "Square Chains",   NULL, UN_SC_CH * UN_SC_CH,   0.0, B_UNIT_DEF_SUPPRESS},
181         {"square yard",    "square yards",    "sq yd",  NULL,  "Square Yards",    NULL, UN_SC_YD * UN_SC_YD,   0.0, B_UNIT_DEF_NONE},
182         {"square foot",    "square feet",     "sq ft",  NULL,  "Square Feet",     NULL, UN_SC_FT * UN_SC_FT,   0.0, B_UNIT_DEF_NONE}, /* base unit */
183         {"square inch",    "square inches",   "sq in",  NULL,  "Square Inches",   NULL, UN_SC_IN * UN_SC_IN,   0.0, B_UNIT_DEF_NONE},
184         {"square thou",    "square thous",    "sq mil", NULL,  "Square Thous",    NULL, UN_SC_MIL * UN_SC_MIL, 0.0, B_UNIT_DEF_NONE},
185         NULL_UNIT,
186 };
187 static struct bUnitCollection buImperialAreaCollection = {buImperialAreaDef, 4, 0, UNIT_COLLECTION_LENGTH(buImperialAreaDef)};
188
189 /* Volumes */
190 static struct bUnitDef buMetricVolDef[] = {
191         {"cubic kilometer",  "cubic kilometers",  "km³",  "km3",  "Cubic Kilometers",  NULL, UN_SC_KM * UN_SC_KM * UN_SC_KM,    0.0, B_UNIT_DEF_NONE},
192         {"cubic hectometer", "cubic hectometers", "hm³",  "hm3",  "Cubic Hectometers", NULL, UN_SC_HM * UN_SC_HM * UN_SC_HM,    0.0, B_UNIT_DEF_SUPPRESS},
193         {"cubic dekameter",  "cubic dekameters",  "dam³", "dam3", "Cubic Dekameters",  NULL, UN_SC_DAM * UN_SC_DAM * UN_SC_DAM, 0.0, B_UNIT_DEF_SUPPRESS},
194         {"cubic meter",      "cubic meters",      "m³",   "m3",   "Cubic Meters",      NULL, UN_SC_M * UN_SC_M * UN_SC_M,       0.0, B_UNIT_DEF_NONE}, /* base unit */
195         {"cubic decimeter",  "cubic decimeters",  "dm³",  "dm3",  "Cubic Decimeters",  NULL, UN_SC_DM * UN_SC_DM * UN_SC_DM,    0.0, B_UNIT_DEF_SUPPRESS},
196         {"cubic centimeter", "cubic centimeters", "cm³",  "cm3",  "Cubic Centimeters", NULL, UN_SC_CM * UN_SC_CM * UN_SC_CM,    0.0, B_UNIT_DEF_NONE},
197         {"cubic millimeter", "cubic millimeters", "mm³",  "mm3",  "Cubic Millimeters", NULL, UN_SC_MM * UN_SC_MM * UN_SC_MM,    0.0, B_UNIT_DEF_NONE | B_UNIT_DEF_TENTH},
198         {"cubic micrometer", "cubic micrometers", "µm³",  "um3",  "Cubic Micrometers", NULL, UN_SC_UM * UN_SC_UM * UN_SC_UM,    0.0, B_UNIT_DEF_NONE},
199         NULL_UNIT,
200 };
201 static struct bUnitCollection buMetricVolCollection = {buMetricVolDef, 3, 0, UNIT_COLLECTION_LENGTH(buMetricVolDef)};
202
203 static struct bUnitDef buImperialVolDef[] = {
204         {"cubic mile",    "cubic miles",    "cu mi",  "cu m", "Cubic Miles",    NULL, UN_SC_MI * UN_SC_MI * UN_SC_MI,    0.0, B_UNIT_DEF_NONE},
205         {"cubic furlong", "cubic furlongs", "cu fur", NULL,   "Cubic Furlongs", NULL, UN_SC_FUR * UN_SC_FUR * UN_SC_FUR, 0.0, B_UNIT_DEF_SUPPRESS},
206         {"cubic chain",   "cubic chains",   "cu ch",  NULL,   "Cubic Chains",   NULL, UN_SC_CH * UN_SC_CH * UN_SC_CH,    0.0, B_UNIT_DEF_SUPPRESS},
207         {"cubic yard",    "cubic yards",    "cu yd",  NULL,   "Cubic Yards",    NULL, UN_SC_YD * UN_SC_YD * UN_SC_YD,    0.0, B_UNIT_DEF_NONE},
208         {"cubic foot",    "cubic feet",     "cu ft",  NULL,   "Cubic Feet",     NULL, UN_SC_FT * UN_SC_FT * UN_SC_FT,    0.0, B_UNIT_DEF_NONE}, /* base unit */
209         {"cubic inch",    "cubic inches",   "cu in",  NULL,   "Cubic Inches",   NULL, UN_SC_IN * UN_SC_IN * UN_SC_IN,    0.0, B_UNIT_DEF_NONE},
210         {"cubic thou",    "cubic thous",    "cu mil", NULL,   "Cubic Thous",    NULL, UN_SC_MIL * UN_SC_MIL * UN_SC_MIL, 0.0, B_UNIT_DEF_NONE},
211         NULL_UNIT,
212 };
213 static struct bUnitCollection buImperialVolCollection = {buImperialVolDef, 4, 0, UNIT_COLLECTION_LENGTH(buImperialVolDef)};
214
215 /* Mass */
216 static struct bUnitDef buMetricMassDef[] = {
217         {"ton",       "tonnes",     "ton", "t",  "Tonnes",        "TONNES",       UN_SC_MTON, 0.0, B_UNIT_DEF_NONE},
218         {"quintal",   "quintals",   "ql",  "q",  "100 Kilograms", "QUINTALS",   UN_SC_QL,   0.0, B_UNIT_DEF_SUPPRESS},
219         {"kilogram",  "kilograms",  "kg",  NULL, "Kilograms",     "KILOGRAMS",  UN_SC_KG,   0.0, B_UNIT_DEF_NONE}, /* base unit */
220         {"hectogram", "hectograms", "hg",  NULL, "Hectograms",    "HECTOGRAMS", UN_SC_HG,   0.0, B_UNIT_DEF_SUPPRESS},
221         {"dekagram",  "dekagrams",  "dag", NULL, "10 Grams",      "DEKAGRAMS",  UN_SC_DAG,  0.0, B_UNIT_DEF_SUPPRESS},
222         {"gram",      "grams",      "g",   NULL, "Grams",         "GRAMS",      UN_SC_G,    0.0, B_UNIT_DEF_NONE},
223         {"milligram", "milligrams", "mg",  NULL, "Milligrams",    "MILLIGRAMS", UN_SC_MG,   0.0, B_UNIT_DEF_NONE},
224         NULL_UNIT,
225 };
226 static struct bUnitCollection buMetricMassCollection = {buMetricMassDef, 2, 0, UNIT_COLLECTION_LENGTH(buMetricMassDef)};
227
228 static struct bUnitDef buImperialMassDef[] = {
229         {"ton",           "tonnes",         "ton", "t",  "Tonnes",         "TONNES",         UN_SC_ITON, 0.0, B_UNIT_DEF_NONE},
230         {"centum weight", "centum weights", "cwt", NULL, "Centum weights", "CENTUM_WEIGHTS", UN_SC_CWT,  0.0, B_UNIT_DEF_NONE},
231         {"stone",         "stones",         "st",  NULL, "Stones",         "STONES",         UN_SC_ST,   0.0, B_UNIT_DEF_NONE},
232         {"pound",         "pounds",         "lb",  NULL, "Pounds",         "POUNDS",         UN_SC_LB,   0.0, B_UNIT_DEF_NONE}, /* base unit */
233         {"ounce",         "ounces",         "oz",  NULL, "Ounces",         "OUNCES",         UN_SC_OZ,   0.0, B_UNIT_DEF_NONE},
234         NULL_UNIT,
235 };
236 static struct bUnitCollection buImperialMassCollection = {buImperialMassDef, 3, 0, UNIT_COLLECTION_LENGTH(buImperialMassDef)};
237
238 /* Even if user scales the system to a point where km^3 is used, velocity and
239  * acceleration aren't scaled: that's why we have so few units for them */
240
241 /* Velocity */
242 static struct bUnitDef buMetricVelDef[] = {
243         {"meter per second",   "meters per second",   "m/s",  NULL, "Meters per second",   NULL, UN_SC_M,            0.0, B_UNIT_DEF_NONE}, /* base unit */
244         {"kilometer per hour", "kilometers per hour", "km/h", NULL, "Kilometers per hour", NULL, UN_SC_KM / 3600.0f, 0.0, B_UNIT_DEF_SUPPRESS},
245         NULL_UNIT,
246 };
247 static struct bUnitCollection buMetricVelCollection = {buMetricVelDef, 0, 0, UNIT_COLLECTION_LENGTH(buMetricVelDef)};
248
249 static struct bUnitDef buImperialVelDef[] = {
250         {"foot per second", "feet per second", "ft/s", "fps", "Feet per second", NULL, UN_SC_FT,           0.0, B_UNIT_DEF_NONE}, /* base unit */
251         {"mile per hour",   "miles per hour",  "mph",  NULL,  "Miles per hour",  NULL, UN_SC_MI / 3600.0f, 0.0, B_UNIT_DEF_SUPPRESS},
252         NULL_UNIT,
253 };
254 static struct bUnitCollection buImperialVelCollection = {buImperialVelDef, 0, 0, UNIT_COLLECTION_LENGTH(buImperialVelDef)};
255
256 /* Acceleration */
257 static struct bUnitDef buMetricAclDef[] = {
258         {"meter per second squared", "meters per second squared", "m/s²", "m/s2", "Meters per second squared", NULL, UN_SC_M, 0.0, B_UNIT_DEF_NONE}, /* base unit */
259         NULL_UNIT,
260 };
261 static struct bUnitCollection buMetricAclCollection = {buMetricAclDef, 0, 0, UNIT_COLLECTION_LENGTH(buMetricAclDef)};
262
263 static struct bUnitDef buImperialAclDef[] = {
264         {"foot per second squared", "feet per second squared", "ft/s²", "ft/s2", "Feet per second squared", NULL, UN_SC_FT, 0.0, B_UNIT_DEF_NONE}, /* base unit */
265         NULL_UNIT,
266 };
267 static struct bUnitCollection buImperialAclCollection = {buImperialAclDef, 0, 0, UNIT_COLLECTION_LENGTH(buImperialAclDef)};
268
269 /* Time */
270 static struct bUnitDef buNaturalTimeDef[] = {
271         /* weeks? - probably not needed for blender */
272         {"day",         "days",         "d",   NULL, "Days",         "DAYS",     90000.0,      0.0, B_UNIT_DEF_NONE},
273         {"hour",        "hours",        "hr",  "h",  "Hours",        "HOURS",     3600.0,      0.0, B_UNIT_DEF_NONE},
274         {"minute",      "minutes",      "min", "m",  "Minutes",      "MINUTES",     60.0,      0.0, B_UNIT_DEF_NONE},
275         {"second",      "seconds",      "sec", "s",  "Seconds",      "SECONDS",      1.0,      0.0, B_UNIT_DEF_NONE}, /* base unit */
276         {"millisecond", "milliseconds", "ms",  NULL, "Milliseconds", "MILLISECONDS", 0.001,    0.0, B_UNIT_DEF_NONE},
277         {"microsecond", "microseconds", "µs",  "us", "Microseconds", "MICROSECONDS", 0.000001, 0.0, B_UNIT_DEF_NONE},
278         NULL_UNIT,
279 };
280 static struct bUnitCollection buNaturalTimeCollection = {buNaturalTimeDef, 3, 0, UNIT_COLLECTION_LENGTH(buNaturalTimeDef)};
281
282
283 static struct bUnitDef buNaturalRotDef[] = {
284         {"degree",    "degrees",     "°",  "d",   "Degrees",    "DEGREES",    M_PI / 180.0,             0.0,  B_UNIT_DEF_NONE},
285         /* arcminutes/arcseconds are used in Astronomy/Navigation areas... */
286         {"arcminute", "arcminutes",  "'",  NULL,  "Arcminutes", "ARCMINUTES", (M_PI / 180.0) / 60.0,    0.0,  B_UNIT_DEF_SUPPRESS},
287         {"arcsecond", "arcseconds",  "\"", NULL,  "Arcseconds", "ARCSECONDS", (M_PI / 180.0) / 3600.0,  0.0,  B_UNIT_DEF_SUPPRESS},
288         {"radian",    "radians",     "r",  NULL,  "Radians",    "RADIANS",    1.0,                      0.0,  B_UNIT_DEF_NONE},
289 //      {"turn",      "turns",       "t",  NULL,  "Turns",      NULL, 1.0 / (M_PI * 2.0),       0.0,  B_UNIT_DEF_NONE},
290         NULL_UNIT,
291 };
292 static struct bUnitCollection buNaturalRotCollection = {buNaturalRotDef, 0, 0, UNIT_COLLECTION_LENGTH(buNaturalRotDef)};
293
294 /* Camera Lengths */
295 static struct bUnitDef buCameraLenDef[] = {
296         {"meter",      "meters",      "m",   NULL, "Meters",         NULL, UN_SC_KM,  0.0, B_UNIT_DEF_NONE},     /* base unit */
297         {"decimeter",  "decimeters",  "dm",  NULL, "10 Centimeters", NULL, UN_SC_HM,  0.0, B_UNIT_DEF_SUPPRESS},
298         {"centimeter", "centimeters", "cm",  NULL, "Centimeters",    NULL, UN_SC_DAM, 0.0, B_UNIT_DEF_SUPPRESS},
299         {"millimeter", "millimeters", "mm",  NULL, "Millimeters",    NULL, UN_SC_M,   0.0, B_UNIT_DEF_NONE},
300         {"micrometer", "micrometers", "µm", "um",  "Micrometers",    NULL, UN_SC_MM,  0.0, B_UNIT_DEF_SUPPRESS},
301         NULL_UNIT,
302 };
303 static struct bUnitCollection buCameraLenCollection = {buCameraLenDef, 3, 0, UNIT_COLLECTION_LENGTH(buCameraLenDef)};
304
305 /* (Light) Power */
306 static struct bUnitDef buPowerDef[] = {
307         {"gigawatt",  "gigawatts",  "GW", NULL, "Gigawatts",  NULL, 1e9f,  0.0, B_UNIT_DEF_NONE},
308         {"megawatt",  "megawatts",  "MW", NULL, "Megawatts",  NULL, 1e6f,  0.0, B_UNIT_DEF_CASE_SENSITIVE},
309         {"kilowatt",  "kilowatts",  "kW", NULL, "Kilowatts",  NULL, 1e3f,  0.0, B_UNIT_DEF_SUPPRESS},
310         {"watt",      "watts",      "W",  NULL, "Watts",      NULL, 1.0f,  0.0, B_UNIT_DEF_NONE},
311         {"milliwatt", "milliwatts", "mW", NULL, "Milliwatts", NULL, 1e-3f, 0.0, B_UNIT_DEF_CASE_SENSITIVE},
312         {"microwatt", "microwatts", "µW", "uW", "Microwatts", NULL, 1e-6f, 0.0, B_UNIT_DEF_NONE},
313         {"nanowatt",  "nanowatts",  "nW", NULL, "Nannowatts", NULL, 1e-9f, 0.0, B_UNIT_DEF_NONE},
314 };
315 static struct bUnitCollection buPowerCollection = {buPowerDef, 3, 0, UNIT_COLLECTION_LENGTH(buPowerDef)};
316
317
318 #define UNIT_SYSTEM_TOT (((sizeof(bUnitSystems) / B_UNIT_TYPE_TOT) / sizeof(void *)) - 1)
319 static const struct bUnitCollection *bUnitSystems[][B_UNIT_TYPE_TOT] = {
320         {NULL, NULL, NULL, NULL, NULL, &buNaturalRotCollection, &buNaturalTimeCollection, NULL, NULL, NULL, NULL},
321         {NULL, &buMetricLenCollection, &buMetricAreaCollection, &buMetricVolCollection, &buMetricMassCollection, &buNaturalRotCollection, &buNaturalTimeCollection, &buMetricVelCollection, &buMetricAclCollection, &buCameraLenCollection, &buPowerCollection}, /* metric */
322         {NULL, &buImperialLenCollection, &buImperialAreaCollection, &buImperialVolCollection, &buImperialMassCollection, &buNaturalRotCollection, &buNaturalTimeCollection, &buImperialVelCollection, &buImperialAclCollection, &buCameraLenCollection, &buPowerCollection}, /* imperial */
323         {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL},
324 };
325
326
327
328 /* internal, has some option not exposed */
329 static const bUnitCollection *unit_get_system(int system, int type)
330 {
331         assert((system > -1) && (system < UNIT_SYSTEM_TOT) && (type > -1) && (type < B_UNIT_TYPE_TOT));
332         return bUnitSystems[system][type]; /* select system to use, metric/imperial/other? */
333 }
334
335 static const bUnitDef *unit_default(const bUnitCollection *usys)
336 {
337         return &usys->units[usys->base_unit];
338 }
339
340 static const bUnitDef *unit_best_fit(
341         double value, const bUnitCollection *usys, const bUnitDef *unit_start, int suppress)
342 {
343         const bUnitDef *unit;
344         double value_abs = value > 0.0 ? value : -value;
345
346         for (unit = unit_start ? unit_start : usys->units; unit->name; unit++) {
347
348                 if (suppress && (unit->flag & B_UNIT_DEF_SUPPRESS))
349                         continue;
350
351                 /* scale down scalar so 1cm doesn't convert to 10mm because of float error */
352                 if (UNLIKELY(unit->flag & B_UNIT_DEF_TENTH)) {
353                         if (value_abs >= unit->scalar * (0.1 - EPS)) {
354                                 return unit;
355                         }
356                 }
357                 else {
358                         if (value_abs >= unit->scalar * (1.0 - EPS)) {
359                                 return unit;
360                         }
361                 }
362         }
363
364         return unit_default(usys);
365 }
366
367 /* convert into 2 units and 2 values for "2ft, 3inch" syntax */
368 static void unit_dual_convert(
369         double value, const bUnitCollection *usys,
370         bUnitDef const **r_unit_a, bUnitDef const **r_unit_b,
371         double *r_value_a, double *r_value_b,
372         const bUnitDef *main_unit)
373 {
374         const bUnitDef *unit;
375         if (main_unit) unit = main_unit;
376         else unit = unit_best_fit(value, usys, NULL, 1);
377
378         *r_value_a = (value < 0.0 ? ceil : floor)(value / unit->scalar) * unit->scalar;
379         *r_value_b = value - (*r_value_a);
380
381         *r_unit_a = unit;
382         *r_unit_b = unit_best_fit(*r_value_b, usys, *r_unit_a, 1);
383 }
384
385 static size_t unit_as_string(char *str, int len_max, double value, int prec, const bUnitCollection *usys,
386                              /* non exposed options */
387                              const bUnitDef *unit, char pad)
388 {
389         double value_conv;
390         size_t len, i;
391
392         if (unit) {
393                 /* use unit without finding the best one */
394         }
395         else if (value == 0.0) {
396                 /* use the default units since there is no way to convert */
397                 unit = unit_default(usys);
398         }
399         else {
400                 unit = unit_best_fit(value, usys, NULL, 1);
401         }
402
403         value_conv = value / unit->scalar;
404
405         /* Adjust precision to expected number of significant digits.
406          * Note that here, we shall not have to worry about very big/small numbers, units are expected to replace
407          * 'scientific notation' in those cases. */
408         prec -= integer_digits_d(value_conv);
409         CLAMP(prec, 0, 6);
410
411         /* Convert to a string */
412         len = BLI_snprintf_rlen(str, len_max, "%.*f", prec, value_conv);
413
414         /* Add unit prefix and strip zeros */
415
416         /* replace trailing zero's with spaces
417          * so the number is less complicated but alignment in a button wont
418          * jump about while dragging */
419         i = len - 1;
420
421         if (prec > 0) {
422                 while (i > 0 && str[i] == '0') { /* 4.300 -> 4.3 */
423                         str[i--] = pad;
424                 }
425
426                 if (i > 0 && str[i] == '.') { /* 10. -> 10 */
427                         str[i--] = pad;
428                 }
429         }
430
431         /* Now add the suffix */
432         if (i < len_max) {
433                 int j = 0;
434                 i++;
435                 while (unit->name_short[j] && (i < len_max)) {
436                         str[i++] = unit->name_short[j++];
437                 }
438         }
439
440         /* terminate no matter what's done with padding above */
441         if (i >= len_max)
442                 i = len_max - 1;
443
444         str[i] = '\0';
445         return i;
446 }
447
448 static bool unit_should_be_split(int type)
449 {
450         return ELEM(type, B_UNIT_LENGTH, B_UNIT_MASS, B_UNIT_TIME, B_UNIT_CAMERA);
451 }
452
453 typedef struct {
454         int system;
455         int rotation;
456         /* USER_UNIT_ADAPTIVE means none, otherwise the value is the index in the collection */
457         int length;
458         int mass;
459         int time;
460 } PreferredUnits;
461
462 static PreferredUnits preferred_units_from_UnitSettings(const UnitSettings *settings)
463 {
464         PreferredUnits units = { 0 };
465         units.system = settings->system;
466         units.rotation = settings->system_rotation;
467         units.length = settings->length_unit;
468         units.mass = settings->mass_unit;
469         units.time = settings->time_unit;
470         return units;
471 }
472
473 static size_t unit_as_string_splitted(
474         char *str, int len_max, double value, int prec,
475         const bUnitCollection *usys, const bUnitDef *main_unit)
476 {
477         const bUnitDef *unit_a, *unit_b;
478         double value_a, value_b;
479
480         unit_dual_convert(value, usys, &unit_a, &unit_b, &value_a, &value_b, main_unit);
481
482         /* check the 2 is a smaller unit */
483         if (unit_b > unit_a) {
484                 size_t i;
485                 i = unit_as_string(str, len_max, value_a, prec, usys, unit_a, '\0');
486
487                 prec -= integer_digits_d(value_a / unit_b->scalar) - integer_digits_d(value_b / unit_b->scalar);
488                 prec = max_ii(prec, 0);
489
490                 /* is there enough space for at least 1 char of the next unit? */
491                 if (i + 2 < len_max) {
492                         str[i++] = ' ';
493
494                         /* use low precision since this is a smaller unit */
495                         i += unit_as_string(str + i, len_max - i, value_b, prec, usys, unit_b, '\0');
496                 }
497                 return i;
498         }
499
500         return -1;
501 }
502
503 static bool is_valid_unit_collection(const bUnitCollection *usys)
504 {
505         return usys != NULL && usys->units[0].name != NULL;
506 }
507
508 static const bUnitDef *get_preferred_display_unit_if_used(int type, PreferredUnits units)
509 {
510         const bUnitCollection *usys = unit_get_system(units.system, type);
511         if (!is_valid_unit_collection(usys)) return NULL;
512
513         int max_offset = usys->length - 1;
514
515         switch (type) {
516                 case B_UNIT_LENGTH:
517                 case B_UNIT_AREA:
518                 case B_UNIT_VOLUME:
519                         if (units.length == USER_UNIT_ADAPTIVE) return NULL;
520                         return usys->units + MIN2(units.length, max_offset);
521                 case B_UNIT_MASS:
522                         if (units.mass == USER_UNIT_ADAPTIVE) return NULL;
523                         return usys->units + MIN2(units.mass, max_offset);
524                 case B_UNIT_TIME:
525                         if (units.time == USER_UNIT_ADAPTIVE) return NULL;
526                         return usys->units + MIN2(units.time, max_offset);
527                 case B_UNIT_ROTATION:
528                         if (units.rotation == 0) return usys->units + 0;
529                         else if (units.rotation == USER_UNIT_ROT_RADIANS) return usys->units + 3;
530                         break;
531                 default:
532                         break;
533         }
534         return NULL;
535 }
536
537 /* Return the length of the generated string. */
538 static size_t unit_as_string_main(
539         char *str, int len_max, double value, int prec,
540         int type, bool split, bool pad, PreferredUnits units)
541 {
542         const bUnitCollection *usys = unit_get_system(units.system, type);
543         const bUnitDef *main_unit = NULL;
544
545         if (!is_valid_unit_collection(usys)) {
546                 usys = &buDummyCollection;
547         }
548         else {
549                 main_unit = get_preferred_display_unit_if_used(type, units);
550         }
551
552         if (split && unit_should_be_split(type)) {
553                 int length = unit_as_string_splitted(str, len_max, value, prec, usys, main_unit);
554                 /* failed when length is negative, fallback to no split */
555                 if (length >= 0) return length;
556         }
557
558         return unit_as_string(str, len_max, value, prec, usys, main_unit, pad ? ' ' : '\0');
559 }
560
561 size_t bUnit_AsString(char *str, int len_max, double value, int prec, int system, int type, bool split, bool pad)
562 {
563         PreferredUnits units;
564         units.system = system;
565         units.rotation = 0;
566         units.length = USER_UNIT_ADAPTIVE;
567         units.mass = USER_UNIT_ADAPTIVE;
568         units.time = USER_UNIT_ADAPTIVE;
569         return unit_as_string_main(str, len_max, value, prec, type, split, pad, units);
570 }
571
572 size_t bUnit_AsString2(char *str, int len_max, double value, int prec, int type, const UnitSettings *settings, bool pad)
573 {
574         bool do_split = (settings->flag & USER_UNIT_OPT_SPLIT) != 0;
575         PreferredUnits units = preferred_units_from_UnitSettings(settings);
576         return unit_as_string_main(str, len_max, value, prec, type, do_split, pad, units);
577 }
578
579 BLI_INLINE bool isalpha_or_utf8(const int ch)
580 {
581         return (ch >= 128 || isalpha(ch));
582 }
583
584 static const char *unit_find_str(const char *str, const char *substr, bool case_sensitive)
585 {
586         if (substr && substr[0] != '\0') {
587                 while (true) {
588                         /* Unit detection is case insensitive. */
589                         const char *str_found;
590                         if (case_sensitive)
591                                 str_found = strstr(str, substr);
592                         else
593                                 str_found = BLI_strcasestr(str, substr);
594
595                         if (str_found) {
596                                 /* Previous char cannot be a letter. */
597                                 if (str_found == str ||
598                                     /* weak unicode support!, so "µm" won't match up be replaced by "m"
599                                      * since non ascii utf8 values will NEVER return true */
600                                     isalpha_or_utf8(*BLI_str_prev_char_utf8(str_found)) == 0)
601                                 {
602                                         /* next char cannot be alphanum */
603                                         int len_name = strlen(substr);
604
605                                         if (!isalpha_or_utf8(*(str_found + len_name))) {
606                                                 return str_found;
607                                         }
608                                 }
609                                 /* If str_found is not a valid unit, we have to check further in the string... */
610                                 for (str_found++; isalpha_or_utf8(*str_found); str_found++);
611                                 str = str_found;
612                         }
613                         else {
614                                 break;
615                         }
616                 }
617         }
618         return NULL;
619 }
620
621 /* Note that numbers are added within brackets
622  * ") " - is used to detect numbers we added so we can detect if commas need to be added
623  *
624  * "1m1cm+2mm"              - Original value
625  * "1*1#1*0.01#+2*0.001#"   - Replace numbers
626  * "1*1+1*0.01 +2*0.001 "   - Add add signs if ( + - * / | & ~ < > ^ ! = % ) not found in between
627  */
628
629 /* not too strict, (+ - * /) are most common  */
630 static bool ch_is_op(char op)
631 {
632         switch (op) {
633                 case '+':
634                 case '-':
635                 case '*':
636                 case '/':
637                 case '|':
638                 case '&':
639                 case '~':
640                 case '<':
641                 case '>':
642                 case '^':
643                 case '!':
644                 case '=':
645                 case '%':
646                         return true;
647                 default:
648                         return false;
649         }
650 }
651
652 static int unit_scale_str(char *str, int len_max, char *str_tmp, double scale_pref, const bUnitDef *unit,
653                           const char *replace_str, bool case_sensitive)
654 {
655         char *str_found;
656
657         if ((len_max > 0) && (str_found = (char *)unit_find_str(str, replace_str, case_sensitive))) {
658                 /* XXX - investigate, does not respect len_max properly  */
659
660                 int len, len_num, len_name, len_move, found_ofs;
661
662                 found_ofs = (int)(str_found - str);
663
664                 len = strlen(str);
665
666                 len_name = strlen(replace_str);
667                 len_move = (len - (found_ofs + len_name)) + 1; /* 1+ to copy the string terminator */
668                 len_num = BLI_snprintf(str_tmp, TEMP_STR_SIZE, "*%.9g"SEP_STR, unit->scalar / scale_pref); /* # removed later */
669
670                 if (len_num > len_max)
671                         len_num = len_max;
672
673                 if (found_ofs + len_num + len_move > len_max) {
674                         /* can't move the whole string, move just as much as will fit */
675                         len_move -= (found_ofs + len_num + len_move) - len_max;
676                 }
677
678                 if (len_move > 0) {
679                         /* resize the last part of the string */
680                         memmove(str_found + len_num, str_found + len_name, len_move); /* may grow or shrink the string */
681                 }
682
683                 if (found_ofs + len_num > len_max) {
684                         /* not even the number will fit into the string, only copy part of it */
685                         len_num -= (found_ofs + len_num) - len_max;
686                 }
687
688                 if (len_num > 0) {
689                         /* its possible none of the number could be copied in */
690                         memcpy(str_found, str_tmp, len_num); /* without the string terminator */
691                 }
692
693                 /* since the null terminator wont be moved if the stringlen_max
694                  * was not long enough to fit everything in it */
695                 str[len_max - 1] = '\0';
696                 return found_ofs + len_num;
697         }
698         return 0;
699 }
700
701 static int unit_replace(char *str, int len_max, char *str_tmp, double scale_pref, const bUnitDef *unit)
702 {
703         const bool case_sensitive = (unit->flag & B_UNIT_DEF_CASE_SENSITIVE) != 0;
704         int ofs = 0;
705         ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name_short, case_sensitive);
706         ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name_plural, false);
707         ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name_alt, case_sensitive);
708         ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name, false);
709         return ofs;
710 }
711
712 static bool unit_find(const char *str, const bUnitDef *unit)
713 {
714         const bool case_sensitive = (unit->flag & B_UNIT_DEF_CASE_SENSITIVE) != 0;
715         if (unit_find_str(str, unit->name_short, case_sensitive)) return true;
716         if (unit_find_str(str, unit->name_plural, false))  return true;
717         if (unit_find_str(str, unit->name_alt, case_sensitive)) return true;
718         if (unit_find_str(str, unit->name, false)) return true;
719
720         return false;
721 }
722
723 static const bUnitDef *unit_detect_from_str(const bUnitCollection *usys, const char *str, const char *str_prev)
724 {
725         /* Try to find a default unit from current or previous string.
726          * This allows us to handle cases like 2 + 2mm, people would expect to get 4mm, not 2.002m!
727          * Note this does not handle corner cases like 2 + 2cm + 1 + 2.5mm... We can't support everything. */
728         const bUnitDef *unit = NULL;
729
730         /* see which units the new value has */
731         for (unit = usys->units; unit->name; unit++) {
732                 if (unit_find(str, unit))
733                         break;
734         }
735         /* Else, try to infer the default unit from the previous string. */
736         if (str_prev && (unit == NULL || unit->name == NULL)) {
737                 /* see which units the original value had */
738                 for (unit = usys->units; unit->name; unit++) {
739                         if (unit_find(str_prev, unit))
740                                 break;
741                 }
742         }
743         /* Else, fall back to default unit. */
744         if (unit == NULL || unit->name == NULL) {
745                 unit = unit_default(usys);
746         }
747
748         return unit;
749 }
750
751 bool bUnit_ContainsUnit(const char *str, int type)
752 {
753         for (int system = 0; system < UNIT_SYSTEM_TOT; system++) {
754                 const bUnitCollection *usys = unit_get_system(system, type);
755                 if (!is_valid_unit_collection(usys)) continue;
756
757                 for (int i = 0; i < usys->length; i++) {
758                         if (unit_find(str, usys->units + i)) {
759                                 return true;
760                         }
761                 }
762         }
763         return false;
764 }
765
766 double bUnit_PreferredInputUnitScalar(const struct UnitSettings *settings, int type)
767 {
768         PreferredUnits units = preferred_units_from_UnitSettings(settings);
769         const bUnitDef *unit = get_preferred_display_unit_if_used(type, units);
770         if (unit) return unit->scalar;
771         else return bUnit_BaseScalar(units.system, type);
772 }
773
774 /* make a copy of the string that replaces the units with numbers
775  * this is used before parsing
776  * This is only used when evaluating user input and can afford to be a bit slower
777  *
778  * This is to be used before python evaluation so..
779  * 10.1km -> 10.1*1000.0
780  * ...will be resolved by python.
781  *
782  * values will be split by an add sign
783  * 5'2" -> 5*0.3048 + 2*0.0254
784  *
785  * str_prev is optional, when valid it is used to get a base unit when none is set.
786  *
787  * return true of a change was made.
788  */
789 bool bUnit_ReplaceString(char *str, int len_max, const char *str_prev, double scale_pref, int system, int type)
790 {
791         const bUnitCollection *usys = unit_get_system(system, type);
792         if (!is_valid_unit_collection(usys)) return false;
793
794         const bUnitDef *unit = NULL, *default_unit;
795         double scale_pref_base = scale_pref;
796         char str_tmp[TEMP_STR_SIZE];
797         bool changed = false;
798
799         /* Try to find a default unit from current or previous string. */
800         default_unit = unit_detect_from_str(usys, str, str_prev);
801
802         /* We apply the default unit to the whole expression (default unit is now the reference '1.0' one). */
803         scale_pref_base *= default_unit->scalar;
804
805         /* Apply the default unit on the whole expression, this allows to handle nasty cases like '2+2in'. */
806         if (BLI_snprintf(str_tmp, sizeof(str_tmp), "(%s)*%.9g", str, default_unit->scalar) < sizeof(str_tmp)) {
807                 strncpy(str, str_tmp, len_max);
808         }
809         else {
810                 /* BLI_snprintf would not fit into str_tmp, cant do much in this case
811                  * check for this because otherwise bUnit_ReplaceString could call its self forever */
812                 return changed;
813         }
814
815         for (unit = usys->units; unit->name; unit++) {
816                 /* in case there are multiple instances */
817                 while (unit_replace(str, len_max, str_tmp, scale_pref_base, unit))
818                         changed = true;
819         }
820         unit = NULL;
821
822         {
823                 /* try other unit systems now, so we can evaluate imperial when metric is set for eg. */
824                 /* Note that checking other systems at that point means we do not support their units as 'default' one.
825                  * In other words, when in metrics, typing '2+2in' will give 2 meters 2 inches, not 4 inches.
826                  * I do think this is the desired behavior!
827                  */
828                 const bUnitCollection *usys_iter;
829                 int system_iter;
830
831                 for (system_iter = 0; system_iter < UNIT_SYSTEM_TOT; system_iter++) {
832                         if (system_iter != system) {
833                                 usys_iter = unit_get_system(system_iter, type);
834                                 if (usys_iter) {
835                                         for (unit = usys_iter->units; unit->name; unit++) {
836                                                 int ofs = 0;
837                                                 /* in case there are multiple instances */
838                                                 while ((ofs = unit_replace(str + ofs, len_max - ofs, str_tmp, scale_pref_base, unit)))
839                                                         changed = true;
840                                         }
841                                 }
842                         }
843                 }
844         }
845         unit = NULL;
846
847         /* replace # with add sign when there is no operator between it and the next number
848          *
849          * "1*1# 3*100# * 3"  ->  "1*1+ 3*100  * 3"
850          *
851          * */
852         {
853                 char *str_found = str;
854                 const char *ch = str;
855
856                 while ((str_found = strchr(str_found, SEP_CHR))) {
857                         bool op_found = false;
858
859                         /* any operators after this? */
860                         for (ch = str_found + 1; *ch != '\0'; ch++) {
861                                 if (*ch == ' ' || *ch == '\t') {
862                                         continue;
863                                 }
864                                 op_found = (ch_is_op(*ch) || ELEM(*ch, ',', ')'));
865                                 break;
866                         }
867
868                         /* If found an op, comma or closing parenthesis, no need to insert a '+', else we need it. */
869                         *str_found++ = op_found ? ' ' : '+';
870                 }
871         }
872
873         return changed;
874 }
875
876 /* 45µm --> 45um */
877 void bUnit_ToUnitAltName(char *str, int len_max, const char *orig_str, int system, int type)
878 {
879         const bUnitCollection *usys = unit_get_system(system, type);
880
881         const bUnitDef *unit;
882
883         /* find and substitute all units */
884         for (unit = usys->units; unit->name; unit++) {
885                 if (len_max > 0 && unit->name_alt) {
886                         const bool case_sensitive = (unit->flag & B_UNIT_DEF_CASE_SENSITIVE) != 0;
887                         const char *found = unit_find_str(orig_str, unit->name_short, case_sensitive);
888                         if (found) {
889                                 int offset = (int)(found - orig_str);
890                                 int len_name = 0;
891
892                                 /* copy everything before the unit */
893                                 offset = (offset < len_max ? offset : len_max);
894                                 strncpy(str, orig_str, offset);
895
896                                 str += offset;
897                                 orig_str += offset + strlen(unit->name_short);
898                                 len_max -= offset;
899
900                                 /* print the alt_name */
901                                 if (unit->name_alt)
902                                         len_name = BLI_strncpy_rlen(str, unit->name_alt, len_max);
903                                 else
904                                         len_name = 0;
905
906                                 len_name = (len_name < len_max ? len_name : len_max);
907                                 str += len_name;
908                                 len_max -= len_name;
909                         }
910                 }
911         }
912
913         /* finally copy the rest of the string */
914         strncpy(str, orig_str, len_max);
915 }
916
917 double bUnit_ClosestScalar(double value, int system, int type)
918 {
919         const bUnitCollection *usys = unit_get_system(system, type);
920         const bUnitDef *unit;
921
922         if (usys == NULL)
923                 return -1;
924
925         unit = unit_best_fit(value, usys, NULL, 1);
926         if (unit == NULL)
927                 return -1;
928
929         return unit->scalar;
930 }
931
932 double bUnit_BaseScalar(int system, int type)
933 {
934         const bUnitCollection *usys = unit_get_system(system, type);
935         if (usys) return unit_default(usys)->scalar;
936         else return 1.0;
937 }
938
939 /* external access */
940 bool bUnit_IsValid(int system, int type)
941 {
942         return !(system < 0 || system > UNIT_SYSTEM_TOT || type < 0 || type > B_UNIT_TYPE_TOT);
943 }
944
945 void bUnit_GetSystem(int system, int type, void const **r_usys_pt, int *r_len)
946 {
947         const bUnitCollection *usys = unit_get_system(system, type);
948         *r_usys_pt = usys;
949
950         if (usys == NULL) {
951                 *r_len = 0;
952                 return;
953         }
954
955         *r_len = usys->length;
956 }
957
958 int bUnit_GetBaseUnit(const void *usys_pt)
959 {
960         return ((bUnitCollection *)usys_pt)->base_unit;
961 }
962
963 int bUnit_GetBaseUnitOfType(int system, int type)
964 {
965         return unit_get_system(system, type)->base_unit;
966 }
967
968 const char *bUnit_GetName(const void *usys_pt, int index)
969 {
970         return ((bUnitCollection *)usys_pt)->units[index].name;
971 }
972 const char *bUnit_GetNameDisplay(const void *usys_pt, int index)
973 {
974         return ((bUnitCollection *)usys_pt)->units[index].name_display;
975 }
976 const char *bUnit_GetIdentifier(const void *usys_pt, int index)
977 {
978         const bUnitDef *unit = ((const bUnitCollection *)usys_pt)->units + index;
979         if (unit->identifier == NULL) {
980                 BLI_assert(false && "identifier for this unit is not specified yet");
981         }
982         return unit->identifier;
983 }
984
985 double bUnit_GetScaler(const void *usys_pt, int index)
986 {
987         return ((bUnitCollection *)usys_pt)->units[index].scalar;
988 }
989
990 bool bUnit_IsSuppressed(const void *usys_pt, int index)
991 {
992         return (((bUnitCollection *)usys_pt)->units[index].flag & B_UNIT_DEF_SUPPRESS) != 0;
993 }