Fix [#37393] Input dimensions are case sensitive in the property panel, uppercase...
[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 #include "BKE_unit.h"
33
34 #include "BLI_math.h"
35 #include "BLI_string.h"
36 #include "BLI_string_utf8.h"
37
38 #ifdef WIN32
39 #  include "BLI_winstuff.h"
40 #endif
41
42 #define TEMP_STR_SIZE 256
43
44 #define SEP_CHR         '#'
45 #define SEP_STR         "#"
46
47 #define EPS 0.00001
48
49 #define UN_SC_KM        1000.0f
50 #define UN_SC_HM        100.0f
51 #define UN_SC_DAM       10.0f
52 #define UN_SC_M         1.0f
53 #define UN_SC_DM        0.1f
54 #define UN_SC_CM        0.01f
55 #define UN_SC_MM        0.001f
56 #define UN_SC_UM        0.000001f
57
58 #define UN_SC_MI        1609.344f
59 #define UN_SC_FUR       201.168f
60 #define UN_SC_CH        20.1168f
61 #define UN_SC_YD        0.9144f
62 #define UN_SC_FT        0.3048f
63 #define UN_SC_IN        0.0254f
64 #define UN_SC_MIL       0.0000254f
65
66 #define UN_SC_MTON      1000.0f /* metric ton */
67 #define UN_SC_QL        100.0f
68 #define UN_SC_KG        1.0f
69 #define UN_SC_HG        0.1f
70 #define UN_SC_DAG       0.01f
71 #define UN_SC_G         0.001f
72
73 #define UN_SC_ITON      907.18474f /* imperial ton */
74 #define UN_SC_CWT       45.359237f
75 #define UN_SC_ST        6.35029318f
76 #define UN_SC_LB        0.45359237f
77 #define UN_SC_OZ        0.028349523125f
78
79 /* define a single unit */
80 typedef struct bUnitDef {
81         const char *name;
82         const char *name_plural; /* abused a bit for the display name */
83         const char *name_short; /* this is used for display*/
84         const char *name_alt; /* keyboard-friendly ASCII-only version of name_short, can be NULL */
85         /* if name_short has non-ASCII chars, name_alt should be present */
86
87         const char *name_display; /* can be NULL */
88
89         double scalar;
90         double bias; /* not used yet, needed for converting temperature */
91         int flag;
92 } bUnitDef;
93
94 #define B_UNIT_DEF_NONE 0
95 #define B_UNIT_DEF_SUPPRESS 1 /* Use for units that are not used enough to be translated into for common use */
96 #define B_UNIT_DEF_TENTH 2 /* Display a unit even if its value is 0.1, eg 0.1mm instead of 100um */
97
98 /* define a single unit */
99 typedef struct bUnitCollection {
100         struct bUnitDef *units;
101         int base_unit; /* basic unit index (when user doesn't specify unit explicitly) */
102         int flag; /* options for this system */
103         int length; /* to quickly find the last item */
104 } bUnitCollection;
105
106 /* Dummy */
107 static struct bUnitDef buDummyDef[] = { {"", NULL, "", NULL, NULL, 1.0, 0.0}, {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}};
108 static struct bUnitCollection buDummyCollection = {buDummyDef, 0, 0, sizeof(buDummyDef)};
109
110 /* Lengths */
111 static struct bUnitDef buMetricLenDef[] = {
112         {"kilometer", "kilometers",     "km",  NULL, "Kilometers", UN_SC_KM, 0.0,     B_UNIT_DEF_NONE},
113         {"hectometer", "hectometers",   "hm",  NULL, "100 Meters", UN_SC_HM, 0.0,     B_UNIT_DEF_SUPPRESS},
114         {"dekameter", "dekameters",     "dam", NULL, "10 Meters",  UN_SC_DAM, 0.0,    B_UNIT_DEF_SUPPRESS},
115         {"meter", "meters",             "m",   NULL, "Meters",     UN_SC_M, 0.0,      B_UNIT_DEF_NONE},     /* base unit */
116         {"decimeter", "decimeters",     "dm",  NULL, "10 Centimeters", UN_SC_DM, 0.0, B_UNIT_DEF_SUPPRESS},
117         {"centimeter", "centimeters",   "cm",  NULL, "Centimeters", UN_SC_CM, 0.0,    B_UNIT_DEF_NONE},
118         {"millimeter", "millimeters",   "mm",  NULL, "Millimeters", UN_SC_MM, 0.0,    B_UNIT_DEF_NONE | B_UNIT_DEF_TENTH},
119         {"micrometer", "micrometers",   "µm",  "um", "Micrometers", UN_SC_UM,  0.0, B_UNIT_DEF_NONE},
120
121         /* These get displayed because of float precision problems in the transform header,
122          * could work around, but for now probably people wont use these */
123 #if 0
124         {"nanometer", "Nanometers",     "nm", NULL, 0.000000001, 0.0,   B_UNIT_DEF_NONE},
125         {"picometer", "Picometers",     "pm", NULL, 0.000000000001, 0.0, B_UNIT_DEF_NONE},
126 #endif
127         {NULL, NULL, NULL,      NULL, NULL, 0.0, 0.0}
128 };
129 static struct bUnitCollection buMetricLenCollection = {buMetricLenDef, 3, 0, sizeof(buMetricLenDef) / sizeof(bUnitDef)};
130
131 static struct bUnitDef buImperialLenDef[] = {
132         {"mile", "miles",       "mi", "m", "Miles",      UN_SC_MI, 0.0,  B_UNIT_DEF_NONE},
133         {"furlong", "furlongs", "fur", NULL, "Furlongs", UN_SC_FUR, 0.0, B_UNIT_DEF_SUPPRESS},
134         {"chain", "chains",     "ch", NULL, "Chains",    UN_SC_CH, 0.0,  B_UNIT_DEF_SUPPRESS},
135         {"yard", "yards",       "yd", NULL, "Yards",     UN_SC_YD, 0.0,  B_UNIT_DEF_SUPPRESS},
136         {"foot", "feet",        "'", "ft", "Feet",       UN_SC_FT, 0.0,  B_UNIT_DEF_NONE}, /* base unit */
137         {"inch", "inches",      "\"", "in", "Inches",    UN_SC_IN, 0.0,  B_UNIT_DEF_NONE},
138         {"thou", "thou",        "thou", "mil", "Thou",   UN_SC_MIL, 0.0, B_UNIT_DEF_NONE}, /* plural for thou has no 's' */
139         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
140 };
141 static struct bUnitCollection buImperialLenCollection = {buImperialLenDef, 4, 0, sizeof(buImperialLenDef) / sizeof(bUnitDef)};
142
143 /* Areas */
144 static struct bUnitDef buMetricAreaDef[] = {
145         {"square kilometer",  "square kilometers",  "km²", "km2",   "Square Kilometers", UN_SC_KM * UN_SC_KM, 0.0,    B_UNIT_DEF_NONE},
146         {"square hectometer", "square hectometers", "hm²", "hm2",   "Square Hectometers", UN_SC_HM * UN_SC_HM, 0.0,   B_UNIT_DEF_SUPPRESS},   /* hectare */
147         {"square dekameter",  "square dekameters",  "dam²", "dam2",  "Square Dekameters", UN_SC_DAM * UN_SC_DAM, 0.0, B_UNIT_DEF_SUPPRESS},  /* are */
148         {"square meter",      "square meters",      "m²",  "m2",    "Square Meters", UN_SC_M * UN_SC_M, 0.0,          B_UNIT_DEF_NONE},   /* base unit */
149         {"square decimeter",  "square decimetees",  "dm²", "dm2",   "Square Decimeters", UN_SC_DM * UN_SC_DM, 0.0,    B_UNIT_DEF_SUPPRESS},
150         {"square centimeter", "square centimeters", "cm²", "cm2",   "Square Centimeters", UN_SC_CM * UN_SC_CM, 0.0,   B_UNIT_DEF_NONE},
151         {"square millimeter", "square millimeters", "mm²", "mm2",   "Square Millimeters", UN_SC_MM * UN_SC_MM, 0.0,   B_UNIT_DEF_NONE | B_UNIT_DEF_TENTH},
152         {"square micrometer", "square micrometers", "µm²",  "um2",   "Square Micrometers", UN_SC_UM * UN_SC_UM,   0.0, B_UNIT_DEF_NONE},
153         {NULL, NULL, NULL,  NULL, NULL, 0.0, 0.0}
154 };
155 static struct bUnitCollection buMetricAreaCollection = {buMetricAreaDef, 3, 0, sizeof(buMetricAreaDef) / sizeof(bUnitDef)};
156
157 static struct bUnitDef buImperialAreaDef[] = {
158         {"square mile", "square miles",       "sq mi", "sq m", "Square Miles", UN_SC_MI * UN_SC_MI, 0.0,      B_UNIT_DEF_NONE},
159         {"square furlong", "square furlongs", "sq fur", NULL,  "Square Furlongs", UN_SC_FUR * UN_SC_FUR, 0.0, B_UNIT_DEF_SUPPRESS},
160         {"square chain", "square chains",     "sq ch",  NULL,  "Square Chains", UN_SC_CH * UN_SC_CH, 0.0,     B_UNIT_DEF_SUPPRESS},
161         {"square yard", "square yards",       "sq yd",  NULL,  "Square Yards", UN_SC_YD * UN_SC_YD, 0.0,      B_UNIT_DEF_NONE},
162         {"square foot", "square feet",        "sq ft",  NULL,  "Square Feet", UN_SC_FT * UN_SC_FT, 0.0,       B_UNIT_DEF_NONE}, /* base unit */
163         {"square inch", "square inches",      "sq in",  NULL,  "Square Inches", UN_SC_IN * UN_SC_IN, 0.0,     B_UNIT_DEF_NONE},
164         {"square thou", "square thous",       "sq mil", NULL,  "Square Thous", UN_SC_MIL * UN_SC_MIL, 0.0,    B_UNIT_DEF_NONE},
165         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
166 };
167 static struct bUnitCollection buImperialAreaCollection = {buImperialAreaDef, 4, 0, sizeof(buImperialAreaDef) / sizeof(bUnitDef)};
168
169 /* Volumes */
170 static struct bUnitDef buMetricVolDef[] = {
171         {"cubic kilometer",  "cubic kilometers",  "km³",  "km3",  "Cubic Kilometers", UN_SC_KM * UN_SC_KM * UN_SC_KM, 0.0,    B_UNIT_DEF_NONE},
172         {"cubic hectometer", "cubic hectometers", "hm³",  "hm3",  "Cubic Hectometers", UN_SC_HM * UN_SC_HM * UN_SC_HM, 0.0,   B_UNIT_DEF_SUPPRESS},
173         {"cubic dekameter",  "cubic dekameters",  "dam³", "dam3", "Cubic Dekameters", UN_SC_DAM * UN_SC_DAM * UN_SC_DAM, 0.0, B_UNIT_DEF_SUPPRESS},
174         {"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 */
175         {"cubic decimeter",  "cubic decimeters",  "dm³",  "dm3",  "Cubic Decimeters", UN_SC_DM * UN_SC_DM * UN_SC_DM, 0.0,    B_UNIT_DEF_SUPPRESS},
176         {"cubic centimeter", "cubic centimeters", "cm³",  "cm3",  "Cubic Centimeters", UN_SC_CM * UN_SC_CM * UN_SC_CM, 0.0,   B_UNIT_DEF_NONE},
177         {"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},
178         {"cubic micrometer", "cubic micrometers", "µm³",  "um3",  "Cubic Micrometers", UN_SC_UM * UN_SC_UM * UN_SC_UM,    0.0, B_UNIT_DEF_NONE},
179         {NULL, NULL, NULL,  NULL, NULL, 0.0, 0.0}
180 };
181 static struct bUnitCollection buMetricVolCollection = {buMetricVolDef, 3, 0, sizeof(buMetricVolDef) / sizeof(bUnitDef)};
182
183 static struct bUnitDef buImperialVolDef[] = {
184         {"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},
185         {"cubic furlong", "cubic furlongs", "cu fur", NULL,   "Cubic Furlongs", UN_SC_FUR * UN_SC_FUR * UN_SC_FUR, 0.0, B_UNIT_DEF_SUPPRESS},
186         {"cubic chain", "cubic chains",     "cu ch",  NULL,   "Cubic Chains", UN_SC_CH * UN_SC_CH * UN_SC_CH, 0.0,    B_UNIT_DEF_SUPPRESS},
187         {"cubic yard", "cubic yards",       "cu yd",  NULL,   "Cubic Yards", UN_SC_YD * UN_SC_YD * UN_SC_YD, 0.0,     B_UNIT_DEF_NONE},
188         {"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 */
189         {"cubic inch", "cubic inches",      "cu in",  NULL,   "Cubic Inches", UN_SC_IN * UN_SC_IN * UN_SC_IN, 0.0,    B_UNIT_DEF_NONE},
190         {"cubic thou", "cubic thous",       "cu mil", NULL,   "Cubic Thous", UN_SC_MIL * UN_SC_MIL * UN_SC_MIL, 0.0,  B_UNIT_DEF_NONE},
191         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
192 };
193 static struct bUnitCollection buImperialVolCollection = {buImperialVolDef, 4, 0, sizeof(buImperialVolDef) / sizeof(bUnitDef)};
194
195 /* Mass */
196 static struct bUnitDef buMetricMassDef[] = {
197         {"ton", "tonnes",           "ton", "t",  "1000 Kilograms", UN_SC_MTON, 0.0,  B_UNIT_DEF_NONE},
198         {"quintal", "quintals",     "ql",  "q",  "100 Kilograms", UN_SC_QL, 0.0,     B_UNIT_DEF_SUPPRESS},
199         {"kilogram", "kilograms",   "kg",  NULL, "Kilograms", UN_SC_KG, 0.0,         B_UNIT_DEF_NONE}, /* base unit */
200         {"hectogram", "hectograms", "hg",  NULL, "Hectograms", UN_SC_HG, 0.0,        B_UNIT_DEF_SUPPRESS},
201         {"dekagram", "dekagrams",   "dag", NULL, "10 Grams", UN_SC_DAG, 0.0,         B_UNIT_DEF_SUPPRESS},
202         {"gram", "grams",           "g",   NULL, "Grams", UN_SC_G, 0.0,              B_UNIT_DEF_NONE},
203         {NULL, NULL, NULL,  NULL, NULL, 0.0, 0.0}
204 };
205 static struct bUnitCollection buMetricMassCollection = {buMetricMassDef, 2, 0, sizeof(buMetricMassDef) / sizeof(bUnitDef)};
206
207 static struct bUnitDef buImperialMassDef[] = {
208         {"ton", "tonnes",   "ton", "t", "Tonnes", UN_SC_ITON, 0.0,      B_UNIT_DEF_NONE},
209         {"centum weight", "centum weights", "cwt", NULL, "Centum weights", UN_SC_CWT, 0.0, B_UNIT_DEF_NONE},
210         {"stone", "stones", "st", NULL,     "Stones", UN_SC_ST, 0.0,    B_UNIT_DEF_NONE},
211         {"pound", "pounds", "lb", NULL,     "Pounds", UN_SC_LB, 0.0,    B_UNIT_DEF_NONE}, /* base unit */
212         {"ounce", "ounces", "oz", NULL,     "Ounces", UN_SC_OZ, 0.0,    B_UNIT_DEF_NONE},
213         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
214 };
215 static struct bUnitCollection buImperialMassCollection = {buImperialMassDef, 3, 0, sizeof(buImperialMassDef) / sizeof(bUnitDef)};
216
217 /* Even if user scales the system to a point where km^3 is used, velocity and
218  * acceleration aren't scaled: that's why we have so few units for them */
219
220 /* Velocity */
221 static struct bUnitDef buMetricVelDef[] = {
222         {"meter per second", "meters per second",       "m/s",  NULL,   "Meters per second", UN_SC_M, 0.0,            B_UNIT_DEF_NONE}, /* base unit */
223         {"kilometer per hour", "kilometers per hour",   "km/h", NULL,   "Kilometers per hour", UN_SC_KM / 3600.0f, 0.0, B_UNIT_DEF_SUPPRESS},
224         {NULL, NULL, NULL,  NULL, NULL, 0.0, 0.0}
225 };
226 static struct bUnitCollection buMetricVelCollection = {buMetricVelDef, 0, 0, sizeof(buMetricVelDef) / sizeof(bUnitDef)};
227
228 static struct bUnitDef buImperialVelDef[] = {
229         {"foot per second", "feet per second",  "ft/s", "fps",  "Feet per second", UN_SC_FT, 0.0,       B_UNIT_DEF_NONE}, /* base unit */
230         {"mile per hour", "miles per hour",     "mph", NULL,    "Miles per hour", UN_SC_MI / 3600.0f, 0.0, B_UNIT_DEF_SUPPRESS},
231         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
232 };
233 static struct bUnitCollection buImperialVelCollection = {buImperialVelDef, 0, 0, sizeof(buImperialVelDef) / sizeof(bUnitDef)};
234
235 /* Acceleration */
236 static struct bUnitDef buMetricAclDef[] = {
237         {"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 */
238         {NULL, NULL, NULL,  NULL, NULL, 0.0, 0.0}
239 };
240 static struct bUnitCollection buMetricAclCollection = {buMetricAclDef, 0, 0, sizeof(buMetricAclDef) / sizeof(bUnitDef)};
241
242 static struct bUnitDef buImperialAclDef[] = {
243         {"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 */
244         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
245 };
246 static struct bUnitCollection buImperialAclCollection = {buImperialAclDef, 0, 0, sizeof(buImperialAclDef) / sizeof(bUnitDef)};
247
248 /* Time */
249 static struct bUnitDef buNaturalTimeDef[] = {
250         /* weeks? - probably not needed for blender */
251         {"day", "days",                 "d", NULL,  "Days",         90000.0, 0.0,   B_UNIT_DEF_NONE},
252         {"hour", "hours",               "hr", "h",  "Hours",        3600.0, 0.0,    B_UNIT_DEF_NONE},
253         {"minute", "minutes",           "min", "m", "Minutes",      60.0, 0.0,      B_UNIT_DEF_NONE},
254         {"second", "seconds",           "sec", "s", "Seconds",      1.0, 0.0,       B_UNIT_DEF_NONE}, /* base unit */
255         {"millisecond", "milliseconds", "ms", NULL, "Milliseconds", 0.001, 0.0,     B_UNIT_DEF_NONE},
256         {"microsecond", "microseconds", "µs",  "us", "Microseconds", 0.000001, 0.0, B_UNIT_DEF_NONE},
257         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
258 };
259 static struct bUnitCollection buNaturalTimeCollection = {buNaturalTimeDef, 3, 0, sizeof(buNaturalTimeDef) / sizeof(bUnitDef)};
260
261
262 static struct bUnitDef buNaturalRotDef[] = {
263         {"degree", "degrees",                   "°", NULL, "Degrees",          M_PI / 180.0, 0.0,      B_UNIT_DEF_NONE},
264 //      {"radian", "radians",                   "r", NULL, "Radians",           1.0, 0.0,                       B_UNIT_DEF_NONE},
265 //      {"turn", "turns",                               "t", NULL, "Turns",                     1.0/(M_PI*2.0), 0.0,B_UNIT_DEF_NONE},
266         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
267 };
268 static struct bUnitCollection buNaturalRotCollection = {buNaturalRotDef, 0, 0, sizeof(buNaturalRotDef) / sizeof(bUnitDef)};
269
270 /* Camera Lengths */
271 static struct bUnitDef buCameraLenDef[] = {
272         {"meter", "meters",             "m",   NULL, "Meters",     UN_SC_KM, 0.0,      B_UNIT_DEF_NONE},     /* base unit */
273         {"decimeter", "decimeters",     "dm",  NULL, "10 Centimeters", UN_SC_HM, 0.0, B_UNIT_DEF_SUPPRESS},
274         {"centimeter", "centimeters",   "cm",  NULL, "Centimeters", UN_SC_DAM, 0.0,    B_UNIT_DEF_SUPPRESS},
275         {"millimeter", "millimeters",   "mm",  NULL, "Millimeters", UN_SC_M, 0.0,    B_UNIT_DEF_NONE},
276         {"micrometer", "micrometers", "µm", "um", "Micrometers",    UN_SC_MM,  0.0, B_UNIT_DEF_SUPPRESS},
277         {NULL, NULL, NULL,      NULL, NULL, 0.0, 0.0}
278 };
279 static struct bUnitCollection buCameraLenCollection = {buCameraLenDef, 3, 0, sizeof(buCameraLenDef) / sizeof(bUnitDef)};
280
281
282 #define UNIT_SYSTEM_TOT (((sizeof(bUnitSystems) / B_UNIT_TYPE_TOT) / sizeof(void *)) - 1)
283 static struct bUnitCollection *bUnitSystems[][B_UNIT_TYPE_TOT] = {
284         {NULL, NULL, NULL, NULL, NULL, &buNaturalRotCollection, &buNaturalTimeCollection, NULL, NULL, NULL},
285         {NULL, &buMetricLenCollection, &buMetricAreaCollection, &buMetricVolCollection, &buMetricMassCollection, &buNaturalRotCollection, &buNaturalTimeCollection, &buMetricVelCollection, &buMetricAclCollection, &buCameraLenCollection}, /* metric */
286         {NULL, &buImperialLenCollection, &buImperialAreaCollection, &buImperialVolCollection, &buImperialMassCollection, &buNaturalRotCollection, &buNaturalTimeCollection, &buImperialVelCollection, &buImperialAclCollection, &buCameraLenCollection}, /* imperial */
287         {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
288 };
289
290
291
292 /* internal, has some option not exposed */
293 static bUnitCollection *unit_get_system(int system, int type)
294 {
295         assert((system > -1) && (system < UNIT_SYSTEM_TOT) && (type > -1) && (type < B_UNIT_TYPE_TOT));
296         return bUnitSystems[system][type]; /* select system to use, metric/imperial/other? */
297 }
298
299 static bUnitDef *unit_default(bUnitCollection *usys)
300 {
301         return &usys->units[usys->base_unit];
302 }
303
304 static bUnitDef *unit_best_fit(double value, bUnitCollection *usys, bUnitDef *unit_start, int suppress)
305 {
306         bUnitDef *unit;
307         double value_abs = value > 0.0 ? value : -value;
308
309         for (unit = unit_start ? unit_start : usys->units; unit->name; unit++) {
310
311                 if (suppress && (unit->flag & B_UNIT_DEF_SUPPRESS))
312                         continue;
313
314                 /* scale down scalar so 1cm doesnt convert to 10mm because of float error */
315                 if (UNLIKELY(unit->flag & B_UNIT_DEF_TENTH)) {
316                         if (value_abs >= unit->scalar * (0.1 - EPS)) {
317                                 return unit;
318                         }
319                 }
320                 else {
321                         if (value_abs >= unit->scalar * (1.0 - EPS)) {
322                                 return unit;
323                         }
324                 }
325         }
326
327         return unit_default(usys);
328 }
329
330 /* convert into 2 units and 2 values for "2ft, 3inch" syntax */
331 static void unit_dual_convert(double value, bUnitCollection *usys, bUnitDef **unit_a, bUnitDef **unit_b,
332                               double *value_a, double *value_b)
333 {
334         bUnitDef *unit = unit_best_fit(value, usys, NULL, 1);
335
336         *value_a = (value < 0.0 ? ceil : floor)(value / unit->scalar) * unit->scalar;
337         *value_b = value - (*value_a);
338
339         *unit_a = unit;
340         *unit_b = unit_best_fit(*value_b, usys, *unit_a, 1);
341 }
342
343 static int unit_as_string(char *str, int len_max, double value, int prec, bUnitCollection *usys,
344                           /* non exposed options */
345                           bUnitDef *unit, char pad)
346 {
347         double value_conv;
348         int len, i;
349
350         if (unit) {
351                 /* use unit without finding the best one */
352         }
353         else if (value == 0.0) {
354                 /* use the default units since there is no way to convert */
355                 unit = unit_default(usys);
356         }
357         else {
358                 unit = unit_best_fit(value, usys, NULL, 1);
359         }
360
361         value_conv = value / unit->scalar;
362
363         /* Convert to a string */
364         {
365                 len = BLI_snprintf(str, len_max, "%.*f", prec, value_conv);
366
367                 if (len >= len_max)
368                         len = len_max;
369         }
370
371         /* Add unit prefix and strip zeros */
372
373         /* replace trailing zero's with spaces
374          * so the number is less complicated but alignment in a button wont
375          * jump about while dragging */
376         i = len - 1;
377
378         if (prec > 0) {
379                 while (i > 0 && str[i] == '0') { /* 4.300 -> 4.3 */
380                         str[i--] = pad;
381                 }
382
383                 if (i > 0 && str[i] == '.') { /* 10. -> 10 */
384                         str[i--] = pad;
385                 }
386         }
387
388         /* Now add the suffix */
389         if (i < len_max) {
390                 int j = 0;
391                 i++;
392                 while (unit->name_short[j] && (i < len_max)) {
393                         str[i++] = unit->name_short[j++];
394                 }
395
396                 if (pad) {
397                         /* this loop only runs if so many zeros were removed that
398                          * the unit name only used padded chars,
399                          * In that case add padding for the name. */
400
401                         while (i <= len + j && (i < len_max)) {
402                                 str[i++] = pad;
403                         }
404                 }
405         }
406
407         /* terminate no matter whats done with padding above */
408         if (i >= len_max)
409                 i = len_max - 1;
410
411         str[i] = '\0';
412         return i;
413 }
414
415 /* Used for drawing number buttons, try keep fast */
416 void bUnit_AsString(char *str, int len_max, double value, int prec, int system, int type, int split, int pad)
417 {
418         bUnitCollection *usys = unit_get_system(system, type);
419
420         if (usys == NULL || usys->units[0].name == NULL)
421                 usys = &buDummyCollection;
422
423         /* split output makes sense only for length, mass and time */
424         if (split && (type == B_UNIT_LENGTH || type == B_UNIT_MASS || type == B_UNIT_TIME || type == B_UNIT_CAMERA)) {
425                 bUnitDef *unit_a, *unit_b;
426                 double value_a, value_b;
427
428                 unit_dual_convert(value, usys, &unit_a, &unit_b, &value_a, &value_b);
429
430                 /* check the 2 is a smaller unit */
431                 if (unit_b > unit_a) {
432                         int i = unit_as_string(str, len_max, value_a, prec, usys, unit_a, '\0');
433
434                         /* is there enough space for at least 1 char of the next unit? */
435                         if (i + 2 < len_max) {
436                                 str[i++] = ' ';
437
438                                 /* use low precision since this is a smaller unit */
439                                 unit_as_string(str + i, len_max - i, value_b, prec ? 1 : 0, usys, unit_b, '\0');
440                         }
441                         return;
442                 }
443         }
444
445         unit_as_string(str, len_max, value, prec, usys, NULL, pad ? ' ' : '\0');
446 }
447
448 BLI_INLINE int isalpha_or_utf8(const int ch)
449 {
450         return (ch >= 128 || isalpha(ch));
451 }
452
453 static const char *unit_find_str(const char *str, const char *substr)
454 {
455         const char *str_found;
456
457         if (substr && substr[0] != '\0') {
458                 str_found = strstr(str, substr);
459                 if (str_found) {
460                         /* previous char cannot be a letter */
461                         if (str_found == str ||
462                             /* weak unicode support!, so "µm" won't match up be replaced by "m"
463                              * since non ascii utf8 values will NEVER return TRUE */
464                             isalpha_or_utf8(*BLI_str_prev_char_utf8(str_found)) == 0)
465                         {
466                                 /* next char cannot be alphanum */
467                                 int len_name = strlen(substr);
468
469                                 if (!isalpha_or_utf8(*(str_found + len_name))) {
470                                         return str_found;
471                                 }
472                         }
473                 }
474
475         }
476         return NULL;
477
478 }
479
480 /* Note that numbers are added within brackets
481  * ") " - is used to detect numbers we added so we can detect if commas need to be added
482  *
483  * "1m1cm+2mm"                          - Original value
484  * "1*1#1*0.01#+2*0.001#"       - Replace numbers
485  * "1*1,1*0.01 +2*0.001 "       - Add comma's if ( - + * / % ^ < > ) not found in between
486  *
487  */
488
489 /* not too strict, (- = * /) are most common  */
490 static int ch_is_op(char op)
491 {
492         switch (op) {
493                 case '+':
494                 case '-':
495                 case '*':
496                 case '/':
497                 case '|':
498                 case '&':
499                 case '~':
500                 case '<':
501                 case '>':
502                 case '^':
503                 case '!':
504                 case '=':
505                 case '%':
506                         return 1;
507                 default:
508                         return 0;
509         }
510 }
511
512 static int unit_scale_str(char *str, int len_max, char *str_tmp, double scale_pref, bUnitDef *unit,
513                           const char *replace_str)
514 {
515         char *str_found;
516
517         if ((len_max > 0) && (str_found = (char *)unit_find_str(str, replace_str))) {
518                 /* XXX - investigate, does not respect len_max properly  */
519
520                 int len, len_num, len_name, len_move, found_ofs;
521
522                 found_ofs = (int)(str_found - str);
523
524                 len = strlen(str);
525
526                 len_name = strlen(replace_str);
527                 len_move = (len - (found_ofs + len_name)) + 1; /* 1+ to copy the string terminator */
528                 len_num = BLI_snprintf(str_tmp, TEMP_STR_SIZE, "*%g"SEP_STR, unit->scalar / scale_pref); /* # removed later */
529
530                 if (len_num > len_max)
531                         len_num = len_max;
532
533                 if (found_ofs + len_num + len_move > len_max) {
534                         /* can't move the whole string, move just as much as will fit */
535                         len_move -= (found_ofs + len_num + len_move) - len_max;
536                 }
537
538                 if (len_move > 0) {
539                         /* resize the last part of the string */
540                         memmove(str_found + len_num, str_found + len_name, len_move); /* may grow or shrink the string */
541                 }
542
543                 if (found_ofs + len_num > len_max) {
544                         /* not even the number will fit into the string, only copy part of it */
545                         len_num -= (found_ofs + len_num) - len_max;
546                 }
547
548                 if (len_num > 0) {
549                         /* its possible none of the number could be copied in */
550                         memcpy(str_found, str_tmp, len_num); /* without the string terminator */
551                 }
552
553                 /* since the null terminator wont be moved if the stringlen_max
554                  * was not long enough to fit everything in it */
555                 str[len_max - 1] = '\0';
556                 return found_ofs + len_num;
557         }
558         return 0;
559 }
560
561 static int unit_replace(char *str, int len_max, char *str_tmp, double scale_pref, bUnitDef *unit)
562 {
563         int ofs = 0;
564         ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name_short);
565         ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name_plural);
566         ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name_alt);
567         ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name);
568         return ofs;
569 }
570
571 static int unit_find(const char *str, bUnitDef *unit)
572 {
573         if (unit_find_str(str, unit->name_short))   return 1;
574         if (unit_find_str(str, unit->name_plural))  return 1;
575         if (unit_find_str(str, unit->name_alt))     return 1;
576         if (unit_find_str(str, unit->name))         return 1;
577
578         return 0;
579 }
580
581 /* make a copy of the string that replaces the units with numbers
582  * this is used before parsing
583  * This is only used when evaluating user input and can afford to be a bit slower
584  *
585  * This is to be used before python evaluation so..
586  * 10.1km -> 10.1*1000.0
587  * ...will be resolved by python.
588  *
589  * values will be split by a comma's
590  * 5'2" -> 5'0.0254, 2*0.3048
591  *
592  * str_prev is optional, when valid it is used to get a base unit when none is set.
593  *
594  * return true of a change was made.
595  */
596 int bUnit_ReplaceString(char *str, int len_max, const char *str_prev, double scale_pref, int system, int type)
597 {
598         bUnitCollection *usys = unit_get_system(system, type);
599
600         bUnitDef *unit;
601         char str_tmp[TEMP_STR_SIZE];
602         int change = 0;
603
604         if (usys == NULL || usys->units[0].name == NULL) {
605                 return 0;
606         }
607
608         { /* make lowercase */
609                 int i;
610                 char *ch = str;
611
612                 for (i = 0; (i < len_max || *ch != '\0'); i++, ch++) {
613                         if ((*ch >= 'A') && (*ch <= 'Z'))
614                                 *ch += ('a' - 'A');
615                 }
616         }
617
618         for (unit = usys->units; unit->name; unit++) {
619                 /* in case there are multiple instances */
620                 while (unit_replace(str, len_max, str_tmp, scale_pref, unit))
621                         change = 1;
622         }
623         unit = NULL;
624
625         {
626                 /* try other unit systems now, so we can evaluate imperial when metric is set for eg. */
627                 bUnitCollection *usys_iter;
628                 int system_iter;
629
630                 for (system_iter = 0; system_iter < UNIT_SYSTEM_TOT; system_iter++) {
631                         if (system_iter != system) {
632                                 usys_iter = unit_get_system(system_iter, type);
633                                 if (usys_iter) {
634                                         for (unit = usys_iter->units; unit->name; unit++) {
635                                                 int ofs = 0;
636                                                 /* in case there are multiple instances */
637                                                 while ((ofs = unit_replace(str + ofs, len_max - ofs, str_tmp, scale_pref, unit)))
638                                                         change = 1;
639                                         }
640                                 }
641                         }
642                 }
643         }
644         unit = NULL;
645
646         if (change == 0) {
647                 /* no units given so infer a unit from the previous string or default */
648                 if (str_prev) {
649                         /* see which units the original value had */
650                         for (unit = usys->units; unit->name; unit++) {
651                                 if (unit_find(str_prev, unit))
652                                         break;
653                         }
654                 }
655
656                 if (unit == NULL || unit->name == NULL)
657                         unit = unit_default(usys);
658
659                 /* add the unit prefix and re-run, use brackets in case there was an expression given */
660                 if (BLI_snprintf(str_tmp, sizeof(str_tmp), "(%s)%s", str, unit->name) < sizeof(str_tmp)) {
661                         strncpy(str, str_tmp, len_max);
662                         return bUnit_ReplaceString(str, len_max, NULL, scale_pref, system, type);
663                 }
664                 else {
665                         /* BLI_snprintf would not fit into str_tmp, cant do much in this case
666                          * check for this because otherwise bUnit_ReplaceString could call its self forever */
667                         return 0;
668                 }
669
670         }
671
672         /* replace # with commas when there is no operator between it and the next number
673          *
674          * "1*1# 3*100# * 3"  ->  "1 *1, 3 *100  * 3"
675          *
676          * */
677         {
678                 char *str_found = str;
679                 char *ch = str;
680
681                 while ((str_found = strchr(str_found, SEP_CHR))) {
682
683                         int op_found = 0;
684                         /* any operators after this?*/
685                         for (ch = str_found + 1; *ch != '\0'; ch++) {
686
687                                 if (*ch == ' ' || *ch == '\t') {
688                                         /* do nothing */
689                                 }
690                                 else if (ch_is_op(*ch) || *ch == ',') { /* found an op, no need to insert a ',' */
691                                         op_found = 1;
692                                         break;
693                                 }
694                                 else { /* found a non-op character */
695                                         op_found = 0;
696                                         break;
697                                 }
698                         }
699
700                         *str_found++ = op_found ? ' ' : ',';
701                 }
702         }
703
704         return change;
705 }
706
707 /* 45µm --> 45um */
708 void bUnit_ToUnitAltName(char *str, int len_max, const char *orig_str, int system, int type)
709 {
710         bUnitCollection *usys = unit_get_system(system, type);
711
712         bUnitDef *unit;
713         bUnitDef *unit_def = unit_default(usys);
714
715         /* find and substitute all units */
716         for (unit = usys->units; unit->name; unit++) {
717                 if (len_max > 0 && (unit->name_alt || unit == unit_def)) {
718                         const char *found = unit_find_str(orig_str, unit->name_short);
719                         if (found) {
720                                 int offset = (int)(found - orig_str);
721                                 int len_name = 0;
722
723                                 /* copy everything before the unit */
724                                 offset = (offset < len_max ? offset : len_max);
725                                 strncpy(str, orig_str, offset);
726
727                                 str += offset;
728                                 orig_str += offset + strlen(unit->name_short);
729                                 len_max -= offset;
730
731                                 /* print the alt_name */
732                                 if (unit->name_alt)
733                                         len_name = BLI_strncpy_rlen(str, unit->name_alt, len_max);
734                                 else
735                                         len_name = 0;
736
737                                 len_name = (len_name < len_max ? len_name : len_max);
738                                 str += len_name;
739                                 len_max -= len_name;
740                         }
741                 }
742         }
743
744         /* finally copy the rest of the string */
745         strncpy(str, orig_str, len_max);
746 }
747
748 double bUnit_ClosestScalar(double value, int system, int type)
749 {
750         bUnitCollection *usys = unit_get_system(system, type);
751         bUnitDef *unit;
752
753         if (usys == NULL)
754                 return -1;
755
756         unit = unit_best_fit(value, usys, NULL, 1);
757         if (unit == NULL)
758                 return -1;
759
760         return unit->scalar;
761 }
762
763 double bUnit_BaseScalar(int system, int type)
764 {
765         bUnitCollection *usys = unit_get_system(system, type);
766         return unit_default(usys)->scalar;
767 }
768
769 /* external access */
770 int bUnit_IsValid(int system, int type)
771 {
772         return !(system < 0 || system > UNIT_SYSTEM_TOT || type < 0 || type > B_UNIT_TYPE_TOT);
773 }
774
775 void bUnit_GetSystem(void **usys_pt, int *len, int system, int type)
776 {
777         bUnitCollection *usys = unit_get_system(system, type);
778         *usys_pt = usys;
779
780         if (usys == NULL) {
781                 *len = 0;
782                 return;
783         }
784
785         *len = usys->length;
786 }
787
788 int bUnit_GetBaseUnit(void *usys_pt)
789 {
790         return ((bUnitCollection *)usys_pt)->base_unit;
791 }
792
793 const char *bUnit_GetName(void *usys_pt, int index)
794 {
795         return ((bUnitCollection *)usys_pt)->units[index].name;
796 }
797 const char *bUnit_GetNameDisplay(void *usys_pt, int index)
798 {
799         return ((bUnitCollection *)usys_pt)->units[index].name_display;
800 }
801
802 double bUnit_GetScaler(void *usys_pt, int index)
803 {
804         return ((bUnitCollection *)usys_pt)->units[index].scalar;
805 }