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