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