fix for errors evaluating user input when units are disabled
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18  *
19  * Contributor(s): Campbell Barton
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23
24 #include <stdlib.h>
25 #include <stdio.h>
26 #include <ctype.h>
27 #include <string.h>
28 #include <math.h>
29
30 /* define a single unit */
31 typedef struct bUnitDef {
32         char *name;
33         char *name_plural;      /* can be NULL */
34         char *name_short;       /* this is used for display*/
35         char *name_alt;         /* can be NULL */
36         
37         double mul;
38         double bias;            /* not used yet, needed for converting temperature */
39 } bUnitDef;
40
41 /* define a single unit */
42 typedef struct bUnitCollection {
43         struct bUnitDef *units;
44         int base_unit;                          /* use for 0.0, or none given */
45         int flag;                                       /* options for this system */
46 } bUnitCollection;
47
48 /* Dummy */
49 static struct bUnitDef buDummyDef[] = {
50         {"", NULL, "", NULL,    1.0, 0.0},
51         {NULL, NULL, NULL,      NULL, 0.0, 0.0}
52 };
53 static struct bUnitCollection buDummyCollecton = {buDummyDef, 0, 0};
54
55
56 /* Lengths */
57 static struct bUnitDef buMetricLenDef[] = {
58         {"kilometer", "kilometers",             "km", NULL,     1000.0, 0.0},
59         {"meter", "meters",                             "m",  NULL,     1.0, 0.0}, /* base unit */
60         {"centimeter", "centimeters",   "cm", NULL,     0.01, 0.0},
61         {"millimeter", "millimeters",   "mm", NULL,     0.001, 0.0},
62         {"micrometer", "micrometers",   "um", "┬Ám",    0.000001, 0.0}, // micron too?
63         {"nanometer", "nanometers",             "nm", NULL,     0.000000001, 0.0},
64         {"picometer", "picometers",             "pm", NULL,     0.000000000001, 0.0},
65         {NULL, NULL, NULL,      NULL, 0.0, 0.0}
66 };
67 static struct bUnitCollection buMetricLenCollecton = {buMetricLenDef, 1, 0};
68
69 static struct bUnitDef buImperialLenDef[] = {
70         {"mile", "miles",                               "mi", "m",      1609.344, 0.0},
71         {"yard", "yards",                               "yd", NULL,     0.9144, 0.0},
72         {"foot", "feet",                                "'", "ft",      0.3048, 0.0},
73         {"inch", "inches",                              "\"", "in",     0.0254, 0.0}, /* base unit */
74         {"thou", "thous",                               "mil", NULL,0.0000254, 0.0},
75         {NULL, NULL, NULL, NULL, 0.0, 0.0}
76 };
77 static struct bUnitCollection buImperialLenCollecton = {buImperialLenDef, 2, 0};
78
79
80 /* Time */
81 static struct bUnitDef buNaturalTimeDef[] = {
82         /* weeks? - probably not needed for blender */
83         {"day", "days",                                 "d", NULL,      90000.0, 0.0},
84         {"hour", "hours",                               "hr", "h",      3600.0, 0.0},
85         {"minute", "minutes",                   "min", "m",     60.0, 0.0},
86         {"second", "seconds",                   "sec", "s",     1.0, 0.0}, /* base unit */
87         {"millisecond", "milliseconds", "ms", NULL,     0.001, 0.0},
88         {"microsecond", "microseconds", "us", NULL,     0.000001, 0.0},
89         {NULL, NULL, NULL, NULL, 0.0, 0.0}
90 };
91 static struct bUnitCollection buNaturalTimeCollecton = {buNaturalTimeDef, 3, 0};
92
93 static struct bUnitCollection *bUnitSystems[][8] = {
94         {0,0,0,0,0,0,0,0},
95         {0,&buMetricLenCollecton, 0,0,0,0, &buNaturalTimeCollecton,0}, /* metric */
96         {0,&buImperialLenCollecton, 0,0,0,0, &buNaturalTimeCollecton,0}, /* imperial */
97         {0,0,0,0,0,0,0,0}
98 };
99
100 /* internal, has some option not exposed */
101 static bUnitCollection *unit_get_system(int system, int type)
102 {
103         return bUnitSystems[system][type]; /* select system to use, metric/imperial/other? */
104 }
105
106 static bUnitDef *unit_best_fit(double value, bUnitCollection *usys, bUnitDef *unit_start)
107 {
108         bUnitDef *unit;
109         double value_abs= value>0.0?value:-value;
110
111         for(unit= unit_start ? unit_start:usys->units; unit->name; unit++)
112                 if (value_abs >= unit->mul)
113                         return unit;
114
115         return &usys->units[usys->base_unit];
116 }
117
118 /* convert into 2 units and 2 values for "2ft, 3inch" syntax */
119 static void unit_dual_convert(double value, bUnitCollection *usys,
120                 bUnitDef **unit_a, bUnitDef **unit_b, double *value_a, double *value_b)
121 {
122         bUnitDef *unit= unit_best_fit(value, usys, NULL);
123
124         *value_a= floor(value/unit->mul) * unit->mul;
125         *value_b= value - (*value_a);
126
127         *unit_a=        unit;
128         *unit_b=        unit_best_fit(*value_b, usys, *unit_a);
129 }
130
131 static int unit_as_string(char *str, double value, int prec, bUnitCollection *usys,
132                 /* non exposed options */
133                 bUnitDef *unit, char pad)
134 {
135         double value_conv;
136         int len, i;
137         
138         if(unit) {
139                 /* use unit without finding the best one */
140         }
141         else if(value == 0.0) {
142                 /* use the default units since there is no way to convert */
143                 unit= &usys->units[usys->base_unit];
144         }
145         else {
146                 unit= unit_best_fit(value, usys, NULL);
147         }
148
149         value_conv= value/unit->mul;
150
151         /* Convert to a string */
152         {
153                 char conv_str[5] = {'%', '.', '0'+prec, 'f', '\0'}; /* "%.2f" when prec is 2, must be under 10 */
154                 len= sprintf(str, conv_str, (float)value_conv);
155         }
156         
157         
158         /* Add unit prefix and strip zeros */
159         {
160                 /* replace trailing zero's with spaces 
161                  * so the number is less complicated but allignment in a button wont
162                  * jump about while dragging */
163                 int j;
164                 i= len-1;
165
166         
167                 while(i>0 && str[i]=='0') { /* 4.300 -> 4.3 */
168                         str[i--]= pad;
169                 }
170                 
171                 if(i>0 && str[i]=='.') { /* 10. -> 10 */
172                         str[i--]= pad;
173                 }
174                 
175                 /* Now add the suffix */
176                 i++;
177                 j=0;
178                 while(unit->name_short[j]) {
179                         str[i++]= unit->name_short[j++];
180                 }
181
182                 if(pad) {
183                         /* this loop only runs if so many zeros were removed that
184                          * the unit name only used padded chars,
185                          * In that case add padding for the name. */
186
187                         while(i<=len+j) {
188                                 str[i++]= pad;
189                         }
190                 }
191                 
192                 /* terminate no matter whats done with padding above */
193                 str[i] = '\0';
194         }
195
196         return i;
197 }
198
199
200 /* Used for drawing number buttons, try keep fast */
201 void bUnit_AsString(char *str, double value, int prec, int system, int type, int split, int pad)
202 {
203         bUnitCollection *usys = unit_get_system(system, type);
204
205         if(usys==NULL || usys->units[0].name==NULL)
206                 usys= &buDummyCollecton;
207
208         if(split) {
209                 int i;
210                 bUnitDef *unit_a, *unit_b;
211                 double value_a, value_b;
212
213                 unit_dual_convert(value, usys,          &unit_a, &unit_b, &value_a, &value_b);
214
215                 /* check the 2 is a smaller unit */
216                 if(unit_b > unit_a) {
217                         i= unit_as_string(str, value_a, prec, usys,  unit_a, '\0');
218                         str[i++]= ',';
219                         str[i++]= ' ';
220
221                         /* use low precision since this is a smaller unit */
222                         unit_as_string(str+i, value_b, prec?1:0, usys,  unit_b, '\0');
223                         return;
224                 }
225         }
226
227         unit_as_string(str, value, prec, usys,    NULL, pad?' ':'\0');
228 }
229
230
231 static int unit_scale_str(char *str, char *str_tmp, double scale_pref, bUnitDef *unit, char *replace_str)
232 {
233         char *str_found;
234         int change= 0;
235
236         if(replace_str==NULL || replace_str[0] == '\0')
237                 return 0;
238
239         if((str_found= strstr(str, replace_str))) {
240                 /* previous char cannot be a letter */
241                 if (str_found == str || isalpha(*(str_found-1))==0) {
242                         int len_name = strlen(replace_str);
243
244                         /* next char cannot be alphanum */
245                         if (!isalpha(*(str_found+len_name))) {
246                                 int len= strlen(str);
247                                 int len_num= sprintf(str_tmp, "*%g", scale_pref*unit->mul);
248                                 memmove(str_found+len_num, str_found+len_name, (len+1)-(int)((str_found+len_name)-str)); /* may grow or shrink the string, 1+ to copy the string terminator */
249                                 memcpy(str_found, str_tmp, len_num); /* without the string terminator */
250                                 change= 1;
251                         }
252                 }
253         }
254         return change;
255 }
256
257 static int unit_replace(char *str, char *str_tmp, double scale_pref, bUnitDef *unit)
258 {       
259         //unit_replace_delimit(str, str_tmp);
260         int change= 0;
261         change |= unit_scale_str(str, str_tmp, scale_pref, unit, unit->name_short);
262         change |= unit_scale_str(str, str_tmp, scale_pref, unit, unit->name_plural);
263         change |= unit_scale_str(str, str_tmp, scale_pref, unit, unit->name_alt);
264         change |= unit_scale_str(str, str_tmp, scale_pref, unit, unit->name);
265         return change;
266 }
267
268 /* make a copy of the string that replaces the units with numbers
269  * this is used before parsing
270  * This is only used when evaluating user input and can afford to be a bit slower
271  * 
272  * This is to be used before python evaluation so..
273  * 10.1km -> 10.1*1000.0
274  * ...will be resolved by python.
275  * 
276  * return true of a change was made.
277  */
278 int bUnit_ReplaceString(char *str, char *str_orig, double scale_pref, int system, int type)
279 {
280         bUnitCollection *usys = unit_get_system(system, type);
281         bUnitDef *unit;
282         char str_tmp[256];
283         int change= 0;
284         
285         strcpy(str, str_orig);
286
287         if(usys==NULL || usys->units[0].name==NULL) {
288                 return 0;
289         }
290
291         scale_pref= 1.0/scale_pref;
292         
293         for(unit= usys->units; unit->name; unit++) {
294                 /* incase there are multiple instances */
295                 while(unit_replace(str, str_tmp, scale_pref, unit))
296                         change= 1;
297         }
298         // printf("replace %s\n", str);
299         return change;
300 }