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