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