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