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