Commenting out code from commit 22457 by Genscher for PointCache.
[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 #if defined(WIN32) && (!(defined snprintf))
31 #define snprintf _snprintf
32 #endif
33
34 #define TEMP_STR_SIZE 256
35
36 /* define a single unit */
37 typedef struct bUnitDef {
38         char *name;
39         char *name_plural;      /* abused a bit for the display name */
40         char *name_short;       /* this is used for display*/
41         char *name_alt;         /* can be NULL */
42         
43         double scalar;
44         double bias;            /* not used yet, needed for converting temperature */
45         int flag;
46 } bUnitDef;
47
48 #define B_UNIT_DEF_NONE 0
49 #define B_UNIT_DEF_SUPPRESS 1 /* Use for units that are not used enough to be translated into for common use */
50
51 /* define a single unit */
52 typedef struct bUnitCollection {
53         struct bUnitDef *units;
54         int base_unit;                          /* use for 0.0, or none given */
55         int flag;                                       /* options for this system */
56         int length;                                     /* to quickly find the last item */
57 } bUnitCollection;
58
59 /* Dummy */
60 static struct bUnitDef buDummyDef[] = {
61         {"", NULL, "", NULL,    1.0, 0.0},
62         {NULL, NULL, NULL,      NULL, 0.0, 0.0}
63 };
64 static struct bUnitCollection buDummyCollecton = {buDummyDef, 0, 0, sizeof(buDummyDef)};
65
66
67 /* Lengths */
68 static struct bUnitDef buMetricLenDef[] = {
69         {"kilometer", "Kilometers",             "km", NULL,     1000.0, 0.0,            B_UNIT_DEF_NONE},
70         {"hectometer", "100 Meters",    "hm", NULL,     100.0, 0.0,                     B_UNIT_DEF_SUPPRESS},
71         {"dekameter", "10 Meters",              "dkm",NULL,     10.0, 0.0,                      B_UNIT_DEF_SUPPRESS},
72         {"meter", "Meters",                             "m",  NULL,     1.0, 0.0,                       B_UNIT_DEF_NONE}, /* base unit */
73         {"decimetre", "10 Centimeters", "dm", NULL,     0.1, 0.0,                       B_UNIT_DEF_SUPPRESS},
74         {"centimeter", "Centimeters",   "cm", NULL,     0.01, 0.0,                      B_UNIT_DEF_NONE},
75         {"millimeter", "Millimeters",   "mm", NULL,     0.001, 0.0,                     B_UNIT_DEF_NONE},
76         {"micrometer", "Micrometers",   "um", "┬Ám",    0.000001, 0.0,          B_UNIT_DEF_NONE}, // micron too?
77
78         /* These get displayed because of float precision problems in the transform header,
79          * could work around, but for now probably people wont use these */
80         /*
81         {"nanometer", "Nanometers",             "nm", NULL,     0.000000001, 0.0,       B_UNIT_DEF_NONE},
82         {"picometer", "Picometers",             "pm", NULL,     0.000000000001, 0.0,B_UNIT_DEF_NONE},
83         */
84         {NULL, NULL, NULL,      NULL, 0.0, 0.0}
85 };
86 static struct bUnitCollection buMetricLenCollecton = {buMetricLenDef, 3, 0, sizeof(buMetricLenDef)/sizeof(bUnitDef)};
87
88 static struct bUnitDef buImperialLenDef[] = {
89         {"mile", "Miles",                               "mi", "m",      1609.344, 0.0,  B_UNIT_DEF_NONE},
90         {"furlong", "Furlongs",                 "fur", NULL,201.168, 0.0,       B_UNIT_DEF_SUPPRESS},
91         {"chain", "Chains",                             "ch", NULL,     0.9144*22.0, 0.0,       B_UNIT_DEF_SUPPRESS},
92         {"yard", "Yards",                               "yd", NULL,     0.9144, 0.0,    B_UNIT_DEF_NONE},
93         {"foot", "Feet",                                "'", "ft",      0.3048, 0.0,    B_UNIT_DEF_NONE},
94         {"inch", "Inches",                              "\"", "in",     0.0254, 0.0,    B_UNIT_DEF_NONE}, /* base unit */
95         {"thou", "Thous",                               "mil", NULL,0.0000254, 0.0,     B_UNIT_DEF_NONE},
96         {NULL, NULL, NULL, NULL, 0.0, 0.0}
97 };
98 static struct bUnitCollection buImperialLenCollecton = {buImperialLenDef, 4, 0, sizeof(buImperialLenDef)/sizeof(bUnitDef)};
99
100
101 /* Time */
102 static struct bUnitDef buNaturalTimeDef[] = {
103         /* weeks? - probably not needed for blender */
104         {"day", "Days",                                 "d", NULL,      90000.0, 0.0,   B_UNIT_DEF_NONE},
105         {"hour", "Hours",                               "hr", "h",      3600.0, 0.0,    B_UNIT_DEF_NONE},
106         {"minute", "Minutes",                   "min", "m",     60.0, 0.0,              B_UNIT_DEF_NONE},
107         {"second", "Seconds",                   "sec", "s",     1.0, 0.0,               B_UNIT_DEF_NONE}, /* base unit */
108         {"millisecond", "Milliseconds", "ms", NULL,     0.001, 0.0      ,       B_UNIT_DEF_NONE},
109         {"microsecond", "Microseconds", "us", NULL,     0.000001, 0.0,  B_UNIT_DEF_NONE},
110         {NULL, NULL, NULL, NULL, 0.0, 0.0}
111 };
112 static struct bUnitCollection buNaturalTimeCollecton = {buNaturalTimeDef, 3, 0, sizeof(buNaturalTimeDef)/sizeof(bUnitDef)};
113
114 #define UNIT_SYSTEM_MAX 3
115 static struct bUnitCollection *bUnitSystems[][8] = {
116         {0,0,0,0,0,0,0,0},
117         {0,&buMetricLenCollecton, 0,0,0,0, &buNaturalTimeCollecton,0}, /* metric */
118         {0,&buImperialLenCollecton, 0,0,0,0, &buNaturalTimeCollecton,0}, /* imperial */
119         {0,0,0,0,0,0,0,0}
120 };
121
122 /* internal, has some option not exposed */
123 static bUnitCollection *unit_get_system(int system, int type)
124 {
125         return bUnitSystems[system][type]; /* select system to use, metric/imperial/other? */
126 }
127
128 static bUnitDef *unit_default(bUnitCollection *usys)
129 {
130         return &usys->units[usys->base_unit];
131 }
132
133 static bUnitDef *unit_best_fit(double value, bUnitCollection *usys, bUnitDef *unit_start, int suppress)
134 {
135         bUnitDef *unit;
136         double value_abs= value>0.0?value:-value;
137
138         for(unit= unit_start ? unit_start:usys->units; unit->name; unit++) {
139
140                 if(suppress && (unit->flag & B_UNIT_DEF_SUPPRESS))
141                         continue;
142
143                 if (value_abs >= unit->scalar*0.9999) /* scale down scalar so 1cm doesnt convert to 10mm because of float error */
144                         return unit;
145         }
146
147         return unit_default(usys);
148 }
149
150
151
152 /* convert into 2 units and 2 values for "2ft, 3inch" syntax */
153 static void unit_dual_convert(double value, bUnitCollection *usys,
154                 bUnitDef **unit_a, bUnitDef **unit_b, double *value_a, double *value_b)
155 {
156         bUnitDef *unit= unit_best_fit(value, usys, NULL, 1);
157
158         *value_a= floor(value/unit->scalar) * unit->scalar;
159         *value_b= value - (*value_a);
160
161         *unit_a=        unit;
162         *unit_b=        unit_best_fit(*value_b, usys, *unit_a, 1);
163 }
164
165 static int unit_as_string(char *str, int len_max, double value, int prec, bUnitCollection *usys,
166                 /* non exposed options */
167                 bUnitDef *unit, char pad)
168 {
169         double value_conv;
170         int len, i;
171         
172         if(unit) {
173                 /* use unit without finding the best one */
174         }
175         else if(value == 0.0) {
176                 /* use the default units since there is no way to convert */
177                 unit= unit_default(usys);
178         }
179         else {
180                 unit= unit_best_fit(value, usys, NULL, 1);
181         }
182
183         value_conv= value/unit->scalar;
184
185         /* Convert to a string */
186         {
187                 char conv_str[6] = {'%', '.', '0'+prec, 'l', 'f', '\0'}; /* "%.2lf" when prec is 2, must be under 10 */
188                 len= snprintf(str, len_max, conv_str, (float)value_conv);
189
190                 if(len >= len_max)
191                         len= len_max;
192         }
193         
194         /* Add unit prefix and strip zeros */
195
196         /* replace trailing zero's with spaces
197          * so the number is less complicated but allignment in a button wont
198          * jump about while dragging */
199         i= len-1;
200
201         while(i>0 && str[i]=='0') { /* 4.300 -> 4.3 */
202                 str[i--]= pad;
203         }
204
205         if(i>0 && str[i]=='.') { /* 10. -> 10 */
206                 str[i--]= pad;
207         }
208         
209         /* Now add the suffix */
210         if(i<len_max) {
211                 int j=0;
212                 i++;
213                 while(unit->name_short[j] && (i < len_max)) {
214                         str[i++]= unit->name_short[j++];
215                 }
216
217                 if(pad) {
218                         /* this loop only runs if so many zeros were removed that
219                          * the unit name only used padded chars,
220                          * In that case add padding for the name. */
221
222                         while(i<=len+j && (i < len_max)) {
223                                 str[i++]= pad;
224                         }
225                 }
226         }
227
228         /* terminate no matter whats done with padding above */
229         if(i >= len_max)
230                 i= len_max-1;
231
232         str[i] = '\0';
233         return i;
234 }
235
236
237 /* Used for drawing number buttons, try keep fast */
238 void bUnit_AsString(char *str, int len_max, double value, int prec, int system, int type, int split, int pad)
239 {
240         bUnitCollection *usys = unit_get_system(system, type);
241
242         if(usys==NULL || usys->units[0].name==NULL)
243                 usys= &buDummyCollecton;
244
245         if(split) {
246                 int i;
247                 bUnitDef *unit_a, *unit_b;
248                 double value_a, value_b;
249
250                 unit_dual_convert(value, usys,          &unit_a, &unit_b, &value_a, &value_b);
251
252                 /* check the 2 is a smaller unit */
253                 if(unit_b > unit_a) {
254                         i= unit_as_string(str, len_max, value_a, prec, usys,  unit_a, '\0');
255
256                         /* is there enough space for at least 1 char of the next unit? */
257                         if(i+3 < len_max) {
258                                 str[i++]= ',';
259                                 str[i++]= ' ';
260
261                                 /* use low precision since this is a smaller unit */
262                                 unit_as_string(str+i, len_max-i, value_b, prec?1:0, usys,  unit_b, '\0');
263                         }
264                         return;
265                 }
266         }
267
268         unit_as_string(str, len_max, value, prec, usys,    NULL, pad?' ':'\0');
269 }
270
271
272 static char *unit_find_str(char *str, char *substr)
273 {
274         char *str_found;
275
276         if(substr && substr[0] != '\0') {
277                 str_found= strstr(str, substr);
278                 if(str_found) {
279                         /* previous char cannot be a letter */
280                         if (str_found == str || isalpha(*(str_found-1))==0) {
281                                 /* next char cannot be alphanum */
282                                 int len_name = strlen(substr);
283
284                                 if (!isalpha(*(str_found+len_name))) {
285                                         return str_found;
286                                 }
287                         }
288                 }
289
290         }
291         return NULL;
292
293 }
294
295 static int unit_scale_str(char *str, int len_max, char *str_tmp, double scale_pref, bUnitDef *unit, char *replace_str)
296 {
297         char *str_found;
298
299         if((len_max>0) && (str_found= unit_find_str(str, replace_str))) { /* XXX - investigate, does not respect len_max properly  */
300                 int len, len_num, len_name, len_move, found_ofs;
301
302                 found_ofs = (int)(str_found-str);
303
304                 len= strlen(str);
305
306                 len_name = strlen(replace_str);
307                 len_move= (len - (found_ofs+len_name)) + 1; /* 1+ to copy the string terminator */
308                 len_num= snprintf(str_tmp, TEMP_STR_SIZE, "*%lg", unit->scalar/scale_pref);
309
310                 if(len_num > len_max)
311                         len_num= len_max;
312
313                 if(found_ofs+len_num+len_move > len_max) {
314                         /* can't move the whole string, move just as much as will fit */
315                         len_move -= (found_ofs+len_num+len_move) - len_max;
316                 }
317
318                 if(len_move>0) {
319                         /* resize the last part of the string */
320                         memmove(str_found+len_num, str_found+len_name, len_move); /* may grow or shrink the string */
321                 }
322
323                 if(found_ofs+len_num > len_max) {
324                         /* not even the number will fit into the string, only copy part of it */
325                         len_num -= (found_ofs+len_num) - len_max;
326                 }
327
328                 if(len_num > 0) {
329                         /* its possible none of the number could be copied in */
330                         memcpy(str_found, str_tmp, len_num); /* without the string terminator */
331                 }
332
333                 /* since the null terminator wont be moved if the stringlen_max
334                  * was not long enough to fit everything in it */
335                 str[len_max-1]= '\0';
336                 return found_ofs + len_num;
337         }
338         return 0;
339 }
340
341 static int unit_replace(char *str, int len_max, char *str_tmp, double scale_pref, bUnitDef *unit)
342 {       
343         int ofs= 0;
344         ofs += unit_scale_str(str+ofs, len_max-ofs, str_tmp, scale_pref, unit, unit->name_short);
345         ofs += unit_scale_str(str+ofs, len_max-ofs, str_tmp, scale_pref, unit, unit->name_plural);
346         ofs += unit_scale_str(str+ofs, len_max-ofs, str_tmp, scale_pref, unit, unit->name_alt);
347         ofs += unit_scale_str(str+ofs, len_max-ofs, str_tmp, scale_pref, unit, unit->name);
348         return ofs;
349 }
350
351 static int unit_find(char *str, bUnitDef *unit)
352 {
353         if (unit_find_str(str, unit->name_short))       return 1;
354         if (unit_find_str(str, unit->name_plural))      return 1;
355         if (unit_find_str(str, unit->name_alt))         return 1;
356         if (unit_find_str(str, unit->name))                     return 1;
357
358         return 0;
359 }
360
361 /* make a copy of the string that replaces the units with numbers
362  * this is used before parsing
363  * This is only used when evaluating user input and can afford to be a bit slower
364  * 
365  * This is to be used before python evaluation so..
366  * 10.1km -> 10.1*1000.0
367  * ...will be resolved by python.
368  * 
369  * str_prev is optional, when valid it is used to get a base unit when none is set.
370  *
371  * return true of a change was made.
372  */
373 int bUnit_ReplaceString(char *str, int len_max, char *str_prev, double scale_pref, int system, int type)
374 {
375         bUnitCollection *usys = unit_get_system(system, type);
376
377         bUnitDef *unit;
378         char str_tmp[TEMP_STR_SIZE];
379         int change= 0;
380
381         if(usys==NULL || usys->units[0].name==NULL) {
382                 return 0;
383         }
384         
385         for(unit= usys->units; unit->name; unit++) {
386
387                 if(unit->flag & B_UNIT_DEF_SUPPRESS)
388                         continue;
389
390                 /* incase there are multiple instances */
391                 while(unit_replace(str, len_max, str_tmp, scale_pref, unit))
392                         change= 1;
393         }
394         unit= NULL;
395
396         {
397                 /* try other unit systems now, so we can evaluate imperial when metric is set for eg. */
398                 bUnitCollection *usys_iter;
399                 int system_iter;
400
401                 for(system_iter= 1; system_iter<UNIT_SYSTEM_MAX; system_iter++) {
402                         if (system_iter != system) {
403                                 usys_iter= unit_get_system(system_iter, type);
404                                 for(unit= usys_iter->units; unit->name; unit++) {
405
406                                         if((unit->flag & B_UNIT_DEF_SUPPRESS) == 0) {
407                                                 int ofs = 0;
408                                                 /* incase there are multiple instances */
409                                                 while((ofs=unit_replace(str+ofs, len_max-ofs, str_tmp, scale_pref, unit)))
410                                                         change= 1;
411                                         }
412                                 }
413                         }
414                 }
415         }
416         unit= NULL;
417
418         if(change==0) {
419                 /* no units given so infer a unit from the previous string or default */
420                 if(str_prev) {
421                         /* see which units the original value had */
422                         for(unit= usys->units; unit->name; unit++) {
423
424                                 if(unit->flag & B_UNIT_DEF_SUPPRESS)
425                                         continue;
426
427                                 if (unit_find(str_prev, unit))
428                                         break;
429                         }
430                 }
431
432                 if(unit==NULL)
433                         unit= unit_default(usys);
434
435                 /* add the unit prefic and re-run */
436                 snprintf(str_tmp, sizeof(str_tmp), "%s %s", str, unit->name);
437                 strncpy(str, str_tmp, len_max);
438
439                 return bUnit_ReplaceString(str, len_max, NULL, scale_pref, system, type);
440         }
441
442         // printf("replace %s\n", str);
443         return change;
444 }
445
446
447 double bUnit_ClosestScalar(double value, int system, int type)
448 {
449         bUnitCollection *usys = unit_get_system(system, type);
450         bUnitDef *unit;
451
452         if(usys==NULL)
453                 return -1;
454
455         unit= unit_best_fit(value, usys, NULL, 1);
456         if(unit==NULL)
457                 return -1;
458
459         return unit->scalar;
460 }
461
462 double bUnit_BaseScalar(int system, int type)
463 {
464         bUnitCollection *usys = unit_get_system(system, type);
465         return unit_default(usys)->scalar;
466 }
467
468 /* external access */
469 void bUnit_GetSystem(void **usys_pt, int *len, int system, int type)
470 {
471         bUnitCollection *usys = unit_get_system(system, type);
472         *usys_pt= usys;
473
474         if(usys==NULL) {
475                 *len= 0;
476                 return;
477         }
478
479         *len= usys->length;
480 }
481
482 char *bUnit_GetName(void *usys_pt, int index)
483 {
484         return ((bUnitCollection *)usys_pt)->units[index].name;
485 }
486 char *bUnit_GetNamePlural(void *usys_pt, int index)
487 {
488         return ((bUnitCollection *)usys_pt)->units[index].name_plural;
489 }
490
491 double bUnit_GetScaler(void *usys_pt, int index)
492 {
493         return ((bUnitCollection *)usys_pt)->units[index].scalar;
494 }