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