ab8fbabd3295b3ec3733dc10cc68ae151dd38ec6
[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 "BKE_unit.h"  /* own include */
39
40 #ifdef WIN32
41 #  include "BLI_winstuff.h"
42 #endif
43
44 /* no BKE or DNA includes! */
45
46 #define TEMP_STR_SIZE 256
47
48 #define SEP_CHR         '#'
49 #define SEP_STR         "#"
50
51 #define EPS 0.001
52
53 #define UN_SC_KM        1000.0f
54 #define UN_SC_HM        100.0f
55 #define UN_SC_DAM       10.0f
56 #define UN_SC_M         1.0f
57 #define UN_SC_DM        0.1f
58 #define UN_SC_CM        0.01f
59 #define UN_SC_MM        0.001f
60 #define UN_SC_UM        0.000001f
61
62 #define UN_SC_MI        1609.344f
63 #define UN_SC_FUR       201.168f
64 #define UN_SC_CH        20.1168f
65 #define UN_SC_YD        0.9144f
66 #define UN_SC_FT        0.3048f
67 #define UN_SC_IN        0.0254f
68 #define UN_SC_MIL       0.0000254f
69
70 #define UN_SC_MTON      1000.0f /* metric ton */
71 #define UN_SC_QL        100.0f
72 #define UN_SC_KG        1.0f
73 #define UN_SC_HG        0.1f
74 #define UN_SC_DAG       0.01f
75 #define UN_SC_G         0.001f
76 #define UN_SC_MG        0.000001f
77
78 #define UN_SC_ITON      907.18474f /* imperial ton */
79 #define UN_SC_CWT       45.359237f
80 #define UN_SC_ST        6.35029318f
81 #define UN_SC_LB        0.45359237f
82 #define UN_SC_OZ        0.028349523125f
83
84 /* define a single unit */
85 typedef struct bUnitDef {
86         const char *name;
87         const char *name_plural; /* abused a bit for the display name */
88         const char *name_short; /* this is used for display*/
89         const char *name_alt; /* keyboard-friendly ASCII-only version of name_short, can be NULL */
90         /* if name_short has non-ASCII chars, name_alt should be present */
91
92         const char *name_display; /* can be NULL */
93
94         double scalar;
95         double bias; /* not used yet, needed for converting temperature */
96         int flag;
97 } bUnitDef;
98
99 #define B_UNIT_DEF_NONE 0
100 #define B_UNIT_DEF_SUPPRESS 1 /* Use for units that are not used enough to be translated into for common use */
101 #define B_UNIT_DEF_TENTH 2 /* Display a unit even if its value is 0.1, eg 0.1mm instead of 100um */
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",   "µm",  "um", "Micrometers", UN_SC_UM,  0.0, B_UNIT_DEF_NONE},
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", "µm²",  "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", "µm³",  "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         {"milligram", "milligrams", "mg",  NULL, "Milligrams", UN_SC_MG, 0.0,        B_UNIT_DEF_NONE},
209         {NULL, NULL, NULL,  NULL, NULL, 0.0, 0.0}
210 };
211 static struct bUnitCollection buMetricMassCollection = {buMetricMassDef, 2, 0, sizeof(buMetricMassDef) / sizeof(bUnitDef)};
212
213 static struct bUnitDef buImperialMassDef[] = {
214         {"ton", "tonnes",   "ton", "t", "Tonnes", UN_SC_ITON, 0.0,      B_UNIT_DEF_NONE},
215         {"centum weight", "centum weights", "cwt", NULL, "Centum weights", UN_SC_CWT, 0.0, B_UNIT_DEF_NONE},
216         {"stone", "stones", "st", NULL,     "Stones", UN_SC_ST, 0.0,    B_UNIT_DEF_NONE},
217         {"pound", "pounds", "lb", NULL,     "Pounds", UN_SC_LB, 0.0,    B_UNIT_DEF_NONE}, /* base unit */
218         {"ounce", "ounces", "oz", NULL,     "Ounces", UN_SC_OZ, 0.0,    B_UNIT_DEF_NONE},
219         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
220 };
221 static struct bUnitCollection buImperialMassCollection = {buImperialMassDef, 3, 0, sizeof(buImperialMassDef) / sizeof(bUnitDef)};
222
223 /* Even if user scales the system to a point where km^3 is used, velocity and
224  * acceleration aren't scaled: that's why we have so few units for them */
225
226 /* Velocity */
227 static struct bUnitDef buMetricVelDef[] = {
228         {"meter per second", "meters per second",       "m/s",  NULL,   "Meters per second", UN_SC_M, 0.0,            B_UNIT_DEF_NONE}, /* base unit */
229         {"kilometer per hour", "kilometers per hour",   "km/h", NULL,   "Kilometers per hour", UN_SC_KM / 3600.0f, 0.0, B_UNIT_DEF_SUPPRESS},
230         {NULL, NULL, NULL,  NULL, NULL, 0.0, 0.0}
231 };
232 static struct bUnitCollection buMetricVelCollection = {buMetricVelDef, 0, 0, sizeof(buMetricVelDef) / sizeof(bUnitDef)};
233
234 static struct bUnitDef buImperialVelDef[] = {
235         {"foot per second", "feet per second",  "ft/s", "fps",  "Feet per second", UN_SC_FT, 0.0,       B_UNIT_DEF_NONE}, /* base unit */
236         {"mile per hour", "miles per hour",     "mph", NULL,    "Miles per hour", UN_SC_MI / 3600.0f, 0.0, B_UNIT_DEF_SUPPRESS},
237         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
238 };
239 static struct bUnitCollection buImperialVelCollection = {buImperialVelDef, 0, 0, sizeof(buImperialVelDef) / sizeof(bUnitDef)};
240
241 /* Acceleration */
242 static struct bUnitDef buMetricAclDef[] = {
243         {"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 */
244         {NULL, NULL, NULL,  NULL, NULL, 0.0, 0.0}
245 };
246 static struct bUnitCollection buMetricAclCollection = {buMetricAclDef, 0, 0, sizeof(buMetricAclDef) / sizeof(bUnitDef)};
247
248 static struct bUnitDef buImperialAclDef[] = {
249         {"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 */
250         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
251 };
252 static struct bUnitCollection buImperialAclCollection = {buImperialAclDef, 0, 0, sizeof(buImperialAclDef) / sizeof(bUnitDef)};
253
254 /* Time */
255 static struct bUnitDef buNaturalTimeDef[] = {
256         /* weeks? - probably not needed for blender */
257         {"day", "days",                 "d", NULL,  "Days",         90000.0, 0.0,   B_UNIT_DEF_NONE},
258         {"hour", "hours",               "hr", "h",  "Hours",        3600.0, 0.0,    B_UNIT_DEF_NONE},
259         {"minute", "minutes",           "min", "m", "Minutes",      60.0, 0.0,      B_UNIT_DEF_NONE},
260         {"second", "seconds",           "sec", "s", "Seconds",      1.0, 0.0,       B_UNIT_DEF_NONE}, /* base unit */
261         {"millisecond", "milliseconds", "ms", NULL, "Milliseconds", 0.001, 0.0,     B_UNIT_DEF_NONE},
262         {"microsecond", "microseconds", "µs",  "us", "Microseconds", 0.000001, 0.0, B_UNIT_DEF_NONE},
263         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
264 };
265 static struct bUnitCollection buNaturalTimeCollection = {buNaturalTimeDef, 3, 0, sizeof(buNaturalTimeDef) / sizeof(bUnitDef)};
266
267
268 static struct bUnitDef buNaturalRotDef[] = {
269         {"degree",    "degrees",     "°",  "d",   "Degrees",     M_PI / 180.0,             0.0,  B_UNIT_DEF_NONE},
270         /* arcminutes/arcseconds are used in Astronomy/Navigation areas... */
271         {"arcminute", "arcminutes",  "'",  NULL,  "Arcminutes",  (M_PI / 180.0) / 60.0,    0.0,  B_UNIT_DEF_SUPPRESS},
272         {"arcsecond", "arcseconds",  "\"", NULL,  "Arcseconds",  (M_PI / 180.0) / 3600.0,  0.0,  B_UNIT_DEF_SUPPRESS},
273         {"radian",    "radians",     "r",  NULL,  "Radians",     1.0,                      0.0,  B_UNIT_DEF_NONE},
274 //      {"turn",      "turns",       "t",  NULL,  "Turns",       1.0 / (M_PI * 2.0),       0.0,  B_UNIT_DEF_NONE},
275         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
276 };
277 static struct bUnitCollection buNaturalRotCollection = {buNaturalRotDef, 0, 0, sizeof(buNaturalRotDef) / sizeof(bUnitDef)};
278
279 /* Camera Lengths */
280 static struct bUnitDef buCameraLenDef[] = {
281         {"meter", "meters",             "m",   NULL, "Meters",     UN_SC_KM, 0.0,      B_UNIT_DEF_NONE},     /* base unit */
282         {"decimeter", "decimeters",     "dm",  NULL, "10 Centimeters", UN_SC_HM, 0.0, B_UNIT_DEF_SUPPRESS},
283         {"centimeter", "centimeters",   "cm",  NULL, "Centimeters", UN_SC_DAM, 0.0,    B_UNIT_DEF_SUPPRESS},
284         {"millimeter", "millimeters",   "mm",  NULL, "Millimeters", UN_SC_M, 0.0,    B_UNIT_DEF_NONE},
285         {"micrometer", "micrometers", "µm", "um", "Micrometers",    UN_SC_MM,  0.0, B_UNIT_DEF_SUPPRESS},
286         {NULL, NULL, NULL,      NULL, NULL, 0.0, 0.0}
287 };
288 static struct bUnitCollection buCameraLenCollection = {buCameraLenDef, 3, 0, sizeof(buCameraLenDef) / sizeof(bUnitDef)};
289
290
291 #define UNIT_SYSTEM_TOT (((sizeof(bUnitSystems) / B_UNIT_TYPE_TOT) / sizeof(void *)) - 1)
292 static struct bUnitCollection *bUnitSystems[][B_UNIT_TYPE_TOT] = {
293         {NULL, NULL, NULL, NULL, NULL, &buNaturalRotCollection, &buNaturalTimeCollection, NULL, NULL, NULL},
294         {NULL, &buMetricLenCollection, &buMetricAreaCollection, &buMetricVolCollection, &buMetricMassCollection, &buNaturalRotCollection, &buNaturalTimeCollection, &buMetricVelCollection, &buMetricAclCollection, &buCameraLenCollection}, /* metric */
295         {NULL, &buImperialLenCollection, &buImperialAreaCollection, &buImperialVolCollection, &buImperialMassCollection, &buNaturalRotCollection, &buNaturalTimeCollection, &buImperialVelCollection, &buImperialAclCollection, &buCameraLenCollection}, /* imperial */
296         {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL}
297 };
298
299
300
301 /* internal, has some option not exposed */
302 static bUnitCollection *unit_get_system(int system, int type)
303 {
304         assert((system > -1) && (system < UNIT_SYSTEM_TOT) && (type > -1) && (type < B_UNIT_TYPE_TOT));
305         return bUnitSystems[system][type]; /* select system to use, metric/imperial/other? */
306 }
307
308 static bUnitDef *unit_default(bUnitCollection *usys)
309 {
310         return &usys->units[usys->base_unit];
311 }
312
313 static bUnitDef *unit_best_fit(double value, bUnitCollection *usys, bUnitDef *unit_start, int suppress)
314 {
315         bUnitDef *unit;
316         double value_abs = value > 0.0 ? value : -value;
317
318         for (unit = unit_start ? unit_start : usys->units; unit->name; unit++) {
319
320                 if (suppress && (unit->flag & B_UNIT_DEF_SUPPRESS))
321                         continue;
322
323                 /* scale down scalar so 1cm doesnt convert to 10mm because of float error */
324                 if (UNLIKELY(unit->flag & B_UNIT_DEF_TENTH)) {
325                         if (value_abs >= unit->scalar * (0.1 - EPS)) {
326                                 return unit;
327                         }
328                 }
329                 else {
330                         if (value_abs >= unit->scalar * (1.0 - EPS)) {
331                                 return unit;
332                         }
333                 }
334         }
335
336         return unit_default(usys);
337 }
338
339 /* convert into 2 units and 2 values for "2ft, 3inch" syntax */
340 static void unit_dual_convert(double value, bUnitCollection *usys, bUnitDef **unit_a, bUnitDef **unit_b,
341                               double *value_a, double *value_b)
342 {
343         bUnitDef *unit = unit_best_fit(value, usys, NULL, 1);
344
345         *value_a = (value < 0.0 ? ceil : floor)(value / unit->scalar) * unit->scalar;
346         *value_b = value - (*value_a);
347
348         *unit_a = unit;
349         *unit_b = unit_best_fit(*value_b, usys, *unit_a, 1);
350 }
351
352 static size_t unit_as_string(char *str, int len_max, double value, int prec, bUnitCollection *usys,
353                              /* non exposed options */
354                              const bUnitDef *unit, char pad)
355 {
356         double value_conv;
357         size_t len, i;
358
359         if (unit) {
360                 /* use unit without finding the best one */
361         }
362         else if (value == 0.0) {
363                 /* use the default units since there is no way to convert */
364                 unit = unit_default(usys);
365         }
366         else {
367                 unit = unit_best_fit(value, usys, NULL, 1);
368         }
369
370         value_conv = value / unit->scalar;
371
372         /* Convert to a string */
373         len = BLI_snprintf_rlen(str, len_max, "%.*f", prec, value_conv);
374
375         /* Add unit prefix and strip zeros */
376
377         /* replace trailing zero's with spaces
378          * so the number is less complicated but alignment in a button wont
379          * jump about while dragging */
380         i = len - 1;
381
382         if (prec > 0) {
383                 while (i > 0 && str[i] == '0') { /* 4.300 -> 4.3 */
384                         str[i--] = pad;
385                 }
386
387                 if (i > 0 && str[i] == '.') { /* 10. -> 10 */
388                         str[i--] = pad;
389                 }
390         }
391
392         /* Now add the suffix */
393         if (i < len_max) {
394                 int j = 0;
395                 i++;
396                 while (unit->name_short[j] && (i < len_max)) {
397                         str[i++] = unit->name_short[j++];
398                 }
399 #if 0
400                 if (pad) {
401                         /* this loop only runs if so many zeros were removed that
402                          * the unit name only used padded chars,
403                          * In that case add padding for the name. */
404
405                         while (i <= len + j && (i < len_max)) {
406                                 str[i++] = pad;
407                         }
408                 }
409 #endif
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  * Return the length of the generated string.
422  */
423 size_t bUnit_AsString(char *str, int len_max, double value, int prec, int system, int type, bool split, bool pad)
424 {
425         bUnitCollection *usys = unit_get_system(system, type);
426
427         if (usys == NULL || usys->units[0].name == NULL)
428                 usys = &buDummyCollection;
429
430         /* split output makes sense only for length, mass and time */
431         if (split && (type == B_UNIT_LENGTH || type == B_UNIT_MASS || type == B_UNIT_TIME || type == B_UNIT_CAMERA)) {
432                 bUnitDef *unit_a, *unit_b;
433                 double value_a, value_b;
434
435                 unit_dual_convert(value, usys, &unit_a, &unit_b, &value_a, &value_b);
436
437                 /* check the 2 is a smaller unit */
438                 if (unit_b > unit_a) {
439                         size_t i;
440                         i = unit_as_string(str, len_max, value_a, prec, usys, unit_a, '\0');
441
442                         /* is there enough space for at least 1 char of the next unit? */
443                         if (i + 2 < len_max) {
444                                 str[i++] = ' ';
445
446                                 /* use low precision since this is a smaller unit */
447                                 i += unit_as_string(str + i, len_max - i, value_b, prec ? 1 : 0, usys, unit_b, '\0');
448                         }
449                         return i;
450                 }
451         }
452
453         return unit_as_string(str, len_max, value, prec, usys, NULL, pad ? ' ' : '\0');
454 }
455
456 BLI_INLINE bool isalpha_or_utf8(const int ch)
457 {
458         return (ch >= 128 || isalpha(ch));
459 }
460
461 static const char *unit_find_str(const char *str, const char *substr)
462 {
463         const char *str_found;
464
465         if (substr && substr[0] != '\0') {
466                 str_found = strstr(str, substr);
467                 if (str_found) {
468                         /* previous char cannot be a letter */
469                         if (str_found == str ||
470                             /* weak unicode support!, so "µm" won't match up be replaced by "m"
471                              * since non ascii utf8 values will NEVER return true */
472                             isalpha_or_utf8(*BLI_str_prev_char_utf8(str_found)) == 0)
473                         {
474                                 /* next char cannot be alphanum */
475                                 int len_name = strlen(substr);
476
477                                 if (!isalpha_or_utf8(*(str_found + len_name))) {
478                                         return str_found;
479                                 }
480                         }
481                 }
482
483         }
484         return NULL;
485
486 }
487
488 /* Note that numbers are added within brackets
489  * ") " - is used to detect numbers we added so we can detect if commas need to be added
490  *
491  * "1m1cm+2mm"                          - Original value
492  * "1*1#1*0.01#+2*0.001#"       - Replace numbers
493  * "1*1+1*0.01 +2*0.001 "       - Add add signs if ( + - * / | & ~ < > ^ ! = % ) not found in between
494  *
495  */
496
497 /* not too strict, (+ - * /) are most common  */
498 static bool ch_is_op(char op)
499 {
500         switch (op) {
501                 case '+':
502                 case '-':
503                 case '*':
504                 case '/':
505                 case '|':
506                 case '&':
507                 case '~':
508                 case '<':
509                 case '>':
510                 case '^':
511                 case '!':
512                 case '=':
513                 case '%':
514                         return true;
515                         break;
516                 default:
517                         return false;
518                         break;
519         }
520 }
521
522 static int unit_scale_str(char *str, int len_max, char *str_tmp, double scale_pref, bUnitDef *unit,
523                           const char *replace_str)
524 {
525         char *str_found;
526
527         if ((len_max > 0) && (str_found = (char *)unit_find_str(str, replace_str))) {
528                 /* XXX - investigate, does not respect len_max properly  */
529
530                 int len, len_num, len_name, len_move, found_ofs;
531
532                 found_ofs = (int)(str_found - str);
533
534                 len = strlen(str);
535
536                 len_name = strlen(replace_str);
537                 len_move = (len - (found_ofs + len_name)) + 1; /* 1+ to copy the string terminator */
538                 len_num = BLI_snprintf(str_tmp, TEMP_STR_SIZE, "*%.9g"SEP_STR, unit->scalar / scale_pref); /* # removed later */
539
540                 if (len_num > len_max)
541                         len_num = len_max;
542
543                 if (found_ofs + len_num + len_move > len_max) {
544                         /* can't move the whole string, move just as much as will fit */
545                         len_move -= (found_ofs + len_num + len_move) - len_max;
546                 }
547
548                 if (len_move > 0) {
549                         /* resize the last part of the string */
550                         memmove(str_found + len_num, str_found + len_name, len_move); /* may grow or shrink the string */
551                 }
552
553                 if (found_ofs + len_num > len_max) {
554                         /* not even the number will fit into the string, only copy part of it */
555                         len_num -= (found_ofs + len_num) - len_max;
556                 }
557
558                 if (len_num > 0) {
559                         /* its possible none of the number could be copied in */
560                         memcpy(str_found, str_tmp, len_num); /* without the string terminator */
561                 }
562
563                 /* since the null terminator wont be moved if the stringlen_max
564                  * was not long enough to fit everything in it */
565                 str[len_max - 1] = '\0';
566                 return found_ofs + len_num;
567         }
568         return 0;
569 }
570
571 static int unit_replace(char *str, int len_max, char *str_tmp, double scale_pref, bUnitDef *unit)
572 {
573         int ofs = 0;
574         ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name_short);
575         ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name_plural);
576         ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name_alt);
577         ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name);
578         return ofs;
579 }
580
581 static bool unit_find(const char *str, bUnitDef *unit)
582 {
583         if (unit_find_str(str, unit->name_short))   return true;
584         if (unit_find_str(str, unit->name_plural))  return true;
585         if (unit_find_str(str, unit->name_alt))     return true;
586         if (unit_find_str(str, unit->name))         return true;
587
588         return false;
589 }
590
591 static bUnitDef *unit_detect_from_str(bUnitCollection *usys, const char *str, const char *str_prev)
592 {
593         /* Try to find a default unit from current or previous string.
594          * This allows us to handle cases like 2 + 2mm, people would expect to get 4mm, not 2.002m!
595          * Note this does not handle corner cases like 2 + 2cm + 1 + 2.5mm... We can't support everything. */
596         bUnitDef *unit = NULL;
597
598         /* see which units the new value has */
599         for (unit = usys->units; unit->name; unit++) {
600                 if (unit_find(str, unit))
601                         break;
602         }
603         /* Else, try to infer the default unit from the previous string. */
604         if (str_prev && (unit == NULL || unit->name == NULL)) {
605                 /* see which units the original value had */
606                 for (unit = usys->units; unit->name; unit++) {
607                         if (unit_find(str_prev, unit))
608                                 break;
609                 }
610         }
611         /* Else, fall back to default unit. */
612         if (unit == NULL || unit->name == NULL) {
613                 unit = unit_default(usys);
614         }
615
616         return unit;
617 }
618
619 /* make a copy of the string that replaces the units with numbers
620  * this is used before parsing
621  * This is only used when evaluating user input and can afford to be a bit slower
622  *
623  * This is to be used before python evaluation so..
624  * 10.1km -> 10.1*1000.0
625  * ...will be resolved by python.
626  *
627  * values will be split by an add sign
628  * 5'2" -> 5*0.3048 + 2*0.0254
629  *
630  * str_prev is optional, when valid it is used to get a base unit when none is set.
631  *
632  * return true of a change was made.
633  */
634 bool bUnit_ReplaceString(char *str, int len_max, const char *str_prev, double scale_pref, int system, int type)
635 {
636         bUnitCollection *usys = unit_get_system(system, type);
637
638         bUnitDef *unit = NULL, *default_unit;
639         double scale_pref_base = scale_pref;
640         char str_tmp[TEMP_STR_SIZE];
641         bool changed = false;
642
643         if (usys == NULL || usys->units[0].name == NULL) {
644                 return changed;
645         }
646
647         /* make lowercase */
648         BLI_str_tolower_ascii(str, len_max);
649
650         /* Try to find a default unit from current or previous string. */
651         default_unit = unit_detect_from_str(usys, str, str_prev);
652
653         /* We apply the default unit to the whole expression (default unit is now the reference '1.0' one). */
654         scale_pref_base *= default_unit->scalar;
655
656         /* Apply the default unit on the whole expression, this allows to handle nasty cases like '2+2in'. */
657         if (BLI_snprintf(str_tmp, sizeof(str_tmp), "(%s)*%.9g", str, default_unit->scalar) < sizeof(str_tmp)) {
658                 strncpy(str, str_tmp, len_max);
659         }
660         else {
661                 /* BLI_snprintf would not fit into str_tmp, cant do much in this case
662                  * check for this because otherwise bUnit_ReplaceString could call its self forever */
663                 return changed;
664         }
665
666         for (unit = usys->units; unit->name; unit++) {
667                 /* in case there are multiple instances */
668                 while (unit_replace(str, len_max, str_tmp, scale_pref_base, unit))
669                         changed = true;
670         }
671         unit = NULL;
672
673         {
674                 /* try other unit systems now, so we can evaluate imperial when metric is set for eg. */
675                 /* Note that checking other systems at that point means we do not support their units as 'default' one.
676                  * In other words, when in metrics, typing '2+2in' will give 2 meters 2 inches, not 4 inches.
677                  * I do think this is the desired behavior!
678                  */
679                 bUnitCollection *usys_iter;
680                 int system_iter;
681
682                 for (system_iter = 0; system_iter < UNIT_SYSTEM_TOT; system_iter++) {
683                         if (system_iter != system) {
684                                 usys_iter = unit_get_system(system_iter, type);
685                                 if (usys_iter) {
686                                         for (unit = usys_iter->units; unit->name; unit++) {
687                                                 int ofs = 0;
688                                                 /* in case there are multiple instances */
689                                                 while ((ofs = unit_replace(str + ofs, len_max - ofs, str_tmp, scale_pref_base, unit)))
690                                                         changed = true;
691                                         }
692                                 }
693                         }
694                 }
695         }
696         unit = NULL;
697
698         /* replace # with add sign when there is no operator between it and the next number
699          *
700          * "1*1# 3*100# * 3"  ->  "1*1+ 3*100  * 3"
701          *
702          * */
703         {
704                 char *str_found = str;
705                 const char *ch = str;
706
707                 while ((str_found = strchr(str_found, SEP_CHR))) {
708                         bool op_found = false;
709
710                         /* any operators after this? */
711                         for (ch = str_found + 1; *ch != '\0'; ch++) {
712                                 if (*ch == ' ' || *ch == '\t') {
713                                         continue;
714                                 }
715                                 op_found = (ch_is_op(*ch) || ELEM(*ch, ',', ')'));
716                                 break;
717                         }
718
719                         /* If found an op, comma or closing parenthesis, no need to insert a '+', else we need it. */
720                         *str_found++ = op_found ? ' ' : '+';
721                 }
722         }
723
724         return changed;
725 }
726
727 /* 45µm --> 45um */
728 void bUnit_ToUnitAltName(char *str, int len_max, const char *orig_str, int system, int type)
729 {
730         bUnitCollection *usys = unit_get_system(system, type);
731
732         bUnitDef *unit;
733
734         /* find and substitute all units */
735         for (unit = usys->units; unit->name; unit++) {
736                 if (len_max > 0 && unit->name_alt) {
737                         const char *found = unit_find_str(orig_str, unit->name_short);
738                         if (found) {
739                                 int offset = (int)(found - orig_str);
740                                 int len_name = 0;
741
742                                 /* copy everything before the unit */
743                                 offset = (offset < len_max ? offset : len_max);
744                                 strncpy(str, orig_str, offset);
745
746                                 str += offset;
747                                 orig_str += offset + strlen(unit->name_short);
748                                 len_max -= offset;
749
750                                 /* print the alt_name */
751                                 if (unit->name_alt)
752                                         len_name = BLI_strncpy_rlen(str, unit->name_alt, len_max);
753                                 else
754                                         len_name = 0;
755
756                                 len_name = (len_name < len_max ? len_name : len_max);
757                                 str += len_name;
758                                 len_max -= len_name;
759                         }
760                 }
761         }
762
763         /* finally copy the rest of the string */
764         strncpy(str, orig_str, len_max);
765 }
766
767 double bUnit_ClosestScalar(double value, int system, int type)
768 {
769         bUnitCollection *usys = unit_get_system(system, type);
770         bUnitDef *unit;
771
772         if (usys == NULL)
773                 return -1;
774
775         unit = unit_best_fit(value, usys, NULL, 1);
776         if (unit == NULL)
777                 return -1;
778
779         return unit->scalar;
780 }
781
782 double bUnit_BaseScalar(int system, int type)
783 {
784         bUnitCollection *usys = unit_get_system(system, type);
785         return unit_default(usys)->scalar;
786 }
787
788 /* external access */
789 bool bUnit_IsValid(int system, int type)
790 {
791         return !(system < 0 || system > UNIT_SYSTEM_TOT || type < 0 || type > B_UNIT_TYPE_TOT);
792 }
793
794 void bUnit_GetSystem(void **usys_pt, int *len, int system, int type)
795 {
796         bUnitCollection *usys = unit_get_system(system, type);
797         *usys_pt = usys;
798
799         if (usys == NULL) {
800                 *len = 0;
801                 return;
802         }
803
804         *len = usys->length;
805 }
806
807 int bUnit_GetBaseUnit(void *usys_pt)
808 {
809         return ((bUnitCollection *)usys_pt)->base_unit;
810 }
811
812 const char *bUnit_GetName(void *usys_pt, int index)
813 {
814         return ((bUnitCollection *)usys_pt)->units[index].name;
815 }
816 const char *bUnit_GetNameDisplay(void *usys_pt, int index)
817 {
818         return ((bUnitCollection *)usys_pt)->units[index].name_display;
819 }
820
821 double bUnit_GetScaler(void *usys_pt, int index)
822 {
823         return ((bUnitCollection *)usys_pt)->units[index].scalar;
824 }