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