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