Fix [#21895] Incorrect calculations for measurement system
[blender.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 #ifdef WIN32
28 #define _USE_MATH_DEFINES
29 #endif
30 #include <math.h>
31
32 #include "BLI_winstuff.h"
33
34 #define TEMP_STR_SIZE 256
35
36 #define SEP_CHR         '#'
37 #define SEP_STR         "#"
38
39 #define EPS 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",   "µm", "um",    "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
123 static struct bUnitDef buNaturalRotDef[] = {
124         {"degree", "degrees",                   "°", NULL, "Degrees",          M_PI/180.0, 0.0,        B_UNIT_DEF_NONE},
125         {NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
126 };
127 static struct bUnitCollection buNaturalRotCollection = {buNaturalRotDef, 0, 0, sizeof(buNaturalRotDef)/sizeof(bUnitDef)};
128
129 #define UNIT_SYSTEM_MAX 3
130 static struct bUnitCollection *bUnitSystems[][8] = {
131         {0,0,0,0,0,&buNaturalRotCollection,&buNaturalTimeCollecton,0},
132         {0,&buMetricLenCollecton, 0,0,0, &buNaturalRotCollection, &buNaturalTimeCollecton,0}, /* metric */
133         {0,&buImperialLenCollecton, 0,0,0,&buNaturalRotCollection, &buNaturalTimeCollecton,0}, /* imperial */
134         {0,0,0,0,0,0,0,0}
135 };
136
137 /* internal, has some option not exposed */
138 static bUnitCollection *unit_get_system(int system, int type)
139 {
140         return bUnitSystems[system][type]; /* select system to use, metric/imperial/other? */
141 }
142
143 static bUnitDef *unit_default(bUnitCollection *usys)
144 {
145         return &usys->units[usys->base_unit];
146 }
147
148 static bUnitDef *unit_best_fit(double value, bUnitCollection *usys, bUnitDef *unit_start, int suppress)
149 {
150         bUnitDef *unit;
151         double value_abs= value>0.0?value:-value;
152
153         for(unit= unit_start ? unit_start:usys->units; unit->name; unit++) {
154
155                 if(suppress && (unit->flag & B_UNIT_DEF_SUPPRESS))
156                         continue;
157
158                 if (value_abs >= unit->scalar*(1.0-EPS)) /* scale down scalar so 1cm doesnt convert to 10mm because of float error */
159                         return unit;
160         }
161
162         return unit_default(usys);
163 }
164
165
166
167 /* convert into 2 units and 2 values for "2ft, 3inch" syntax */
168 static void unit_dual_convert(double value, bUnitCollection *usys,
169                 bUnitDef **unit_a, bUnitDef **unit_b, double *value_a, double *value_b)
170 {
171         bUnitDef *unit= unit_best_fit(value, usys, NULL, 1);
172
173         *value_a=  (value < 0.0 ? ceil:floor)(value/unit->scalar) * unit->scalar;
174         *value_b= value - (*value_a);
175
176         *unit_a=        unit;
177         *unit_b=        unit_best_fit(*value_b, usys, *unit_a, 1);
178 }
179
180 static int unit_as_string(char *str, int len_max, double value, int prec, bUnitCollection *usys,
181                 /* non exposed options */
182                 bUnitDef *unit, char pad)
183 {
184         double value_conv;
185         int len, i;
186         
187         if(unit) {
188                 /* use unit without finding the best one */
189         }
190         else if(value == 0.0) {
191                 /* use the default units since there is no way to convert */
192                 unit= unit_default(usys);
193         }
194         else {
195                 unit= unit_best_fit(value, usys, NULL, 1);
196         }
197
198         value_conv= value/unit->scalar;
199
200         /* Convert to a string */
201         {
202                 char conv_str[6] = {'%', '.', '0'+prec, 'l', 'f', '\0'}; /* "%.2lf" when prec is 2, must be under 10 */
203                 len= snprintf(str, len_max, conv_str, (float)value_conv);
204
205                 if(len >= len_max)
206                         len= len_max;
207         }
208         
209         /* Add unit prefix and strip zeros */
210
211         /* replace trailing zero's with spaces
212          * so the number is less complicated but allignment in a button wont
213          * jump about while dragging */
214         i= len-1;
215
216         while(i>0 && str[i]=='0') { /* 4.300 -> 4.3 */
217                 str[i--]= pad;
218         }
219
220         if(i>0 && str[i]=='.') { /* 10. -> 10 */
221                 str[i--]= pad;
222         }
223         
224         /* Now add the suffix */
225         if(i<len_max) {
226                 int j=0;
227                 i++;
228                 while(unit->name_short[j] && (i < len_max)) {
229                         str[i++]= unit->name_short[j++];
230                 }
231
232                 if(pad) {
233                         /* this loop only runs if so many zeros were removed that
234                          * the unit name only used padded chars,
235                          * In that case add padding for the name. */
236
237                         while(i<=len+j && (i < len_max)) {
238                                 str[i++]= pad;
239                         }
240                 }
241         }
242
243         /* terminate no matter whats done with padding above */
244         if(i >= len_max)
245                 i= len_max-1;
246
247         str[i] = '\0';
248         return i;
249 }
250
251
252 /* Used for drawing number buttons, try keep fast */
253 void bUnit_AsString(char *str, int len_max, double value, int prec, int system, int type, int split, int pad)
254 {
255         bUnitCollection *usys = unit_get_system(system, type);
256
257         if(usys==NULL || usys->units[0].name==NULL)
258                 usys= &buDummyCollecton;
259
260         if(split) {
261                 int i;
262                 bUnitDef *unit_a, *unit_b;
263                 double value_a, value_b;
264
265                 unit_dual_convert(value, usys,          &unit_a, &unit_b, &value_a, &value_b);
266
267                 /* check the 2 is a smaller unit */
268                 if(unit_b > unit_a) {
269                         i= unit_as_string(str, len_max, value_a, prec, usys,  unit_a, '\0');
270
271                         /* is there enough space for at least 1 char of the next unit? */
272                         if(i+2 < len_max) {
273                                 str[i++]= ' ';
274
275                                 /* use low precision since this is a smaller unit */
276                                 unit_as_string(str+i, len_max-i, value_b, prec?1:0, usys,  unit_b, '\0');
277                         }
278                         return;
279                 }
280         }
281
282         unit_as_string(str, len_max, value, prec, usys,    NULL, pad?' ':'\0');
283 }
284
285
286 static char *unit_find_str(char *str, char *substr)
287 {
288         char *str_found;
289
290         if(substr && substr[0] != '\0') {
291                 str_found= strstr(str, substr);
292                 if(str_found) {
293                         /* previous char cannot be a letter */
294                         if (str_found == str || isalpha(*(str_found-1))==0) {
295                                 /* next char cannot be alphanum */
296                                 int len_name = strlen(substr);
297
298                                 if (!isalpha(*(str_found+len_name))) {
299                                         return str_found;
300                                 }
301                         }
302                 }
303
304         }
305         return NULL;
306
307 }
308
309 /* Note that numbers are added within brackets
310  * ") " - is used to detect numbers we added so we can detect if commas need to be added
311  *
312  * "1m1cm+2mm"                          - Original value
313  * "1*1#1*0.01#+2*0.001#"       - Replace numbers
314  * "1*1,1*0.01 +2*0.001 "       - Add comma's if ( - + * / % ^ < > ) not found in between
315  *
316  */
317
318 /* not too strict, (- = * /) are most common  */
319 static int ch_is_op(char op)
320 {
321         switch(op) {
322         case '+':
323         case '-':
324         case '*':
325         case '/':
326         case '|':
327         case '&':
328         case '~':
329         case '<':
330         case '>':
331         case '^':
332         case '!':
333         case '=':
334         case '%':
335                 return 1;
336         default:
337                 return 0;
338         }
339 }
340
341 static int unit_scale_str(char *str, int len_max, char *str_tmp, double scale_pref, bUnitDef *unit, char *replace_str)
342 {
343         char *str_found;
344
345         if((len_max>0) && (str_found= unit_find_str(str, replace_str))) { /* XXX - investigate, does not respect len_max properly  */
346                 int len, len_num, len_name, len_move, found_ofs;
347
348                 found_ofs = (int)(str_found-str);
349
350                 len= strlen(str);
351
352                 len_name = strlen(replace_str);
353                 len_move= (len - (found_ofs+len_name)) + 1; /* 1+ to copy the string terminator */
354                 len_num= snprintf(str_tmp, TEMP_STR_SIZE, "*%lg"SEP_STR, unit->scalar/scale_pref); /* # removed later */
355
356                 if(len_num > len_max)
357                         len_num= len_max;
358
359                 if(found_ofs+len_num+len_move > len_max) {
360                         /* can't move the whole string, move just as much as will fit */
361                         len_move -= (found_ofs+len_num+len_move) - len_max;
362                 }
363
364                 if(len_move>0) {
365                         /* resize the last part of the string */
366                         memmove(str_found+len_num, str_found+len_name, len_move); /* may grow or shrink the string */
367                 }
368
369                 if(found_ofs+len_num > len_max) {
370                         /* not even the number will fit into the string, only copy part of it */
371                         len_num -= (found_ofs+len_num) - len_max;
372                 }
373
374                 if(len_num > 0) {
375                         /* its possible none of the number could be copied in */
376                         memcpy(str_found, str_tmp, len_num); /* without the string terminator */
377                 }
378
379                 /* since the null terminator wont be moved if the stringlen_max
380                  * was not long enough to fit everything in it */
381                 str[len_max-1]= '\0';
382                 return found_ofs + len_num;
383         }
384         return 0;
385 }
386
387 static int unit_replace(char *str, int len_max, char *str_tmp, double scale_pref, bUnitDef *unit)
388 {       
389         int ofs= 0;
390         ofs += unit_scale_str(str+ofs, len_max-ofs, str_tmp, scale_pref, unit, unit->name_short);
391         ofs += unit_scale_str(str+ofs, len_max-ofs, str_tmp, scale_pref, unit, unit->name_plural);
392         ofs += unit_scale_str(str+ofs, len_max-ofs, str_tmp, scale_pref, unit, unit->name_alt);
393         ofs += unit_scale_str(str+ofs, len_max-ofs, str_tmp, scale_pref, unit, unit->name);
394         return ofs;
395 }
396
397 static int unit_find(char *str, bUnitDef *unit)
398 {
399         if (unit_find_str(str, unit->name_short))       return 1;
400         if (unit_find_str(str, unit->name_plural))      return 1;
401         if (unit_find_str(str, unit->name_alt))         return 1;
402         if (unit_find_str(str, unit->name))                     return 1;
403
404         return 0;
405 }
406
407 /* make a copy of the string that replaces the units with numbers
408  * this is used before parsing
409  * This is only used when evaluating user input and can afford to be a bit slower
410  * 
411  * This is to be used before python evaluation so..
412  * 10.1km -> 10.1*1000.0
413  * ...will be resolved by python.
414  * 
415  * values will be split by a comma's
416  * 5'2" -> 5'0.0254, 2*0.3048
417  *
418  * str_prev is optional, when valid it is used to get a base unit when none is set.
419  *
420  * return true of a change was made.
421  */
422 int bUnit_ReplaceString(char *str, int len_max, char *str_prev, double scale_pref, int system, int type)
423 {
424         bUnitCollection *usys = unit_get_system(system, type);
425
426         bUnitDef *unit;
427         char str_tmp[TEMP_STR_SIZE];
428         int change= 0;
429
430         if(usys==NULL || usys->units[0].name==NULL) {
431                 return 0;
432         }
433         
434
435         {       /* make lowercase */
436                 int i;
437                 char *ch= str;
438
439                 for(i=0; (i>=len_max || *ch=='\0'); i++, ch++)
440                         if((*ch>='A') && (*ch<='Z'))
441                                 *ch += ('a'-'A');
442         }
443
444
445         for(unit= usys->units; unit->name; unit++) {
446
447                 if(unit->flag & B_UNIT_DEF_SUPPRESS)
448                         continue;
449
450                 /* incase there are multiple instances */
451                 while(unit_replace(str, len_max, str_tmp, scale_pref, unit))
452                         change= 1;
453         }
454         unit= NULL;
455
456         {
457                 /* try other unit systems now, so we can evaluate imperial when metric is set for eg. */
458                 bUnitCollection *usys_iter;
459                 int system_iter;
460
461                 for(system_iter= 0; system_iter<UNIT_SYSTEM_MAX; system_iter++) {
462                         if (system_iter != system) {
463                                 usys_iter= unit_get_system(system_iter, type);
464                                 if (usys_iter) {
465                                         for(unit= usys_iter->units; unit->name; unit++) {
466
467                                                 if((unit->flag & B_UNIT_DEF_SUPPRESS) == 0) {
468                                                         int ofs = 0;
469                                                         /* incase there are multiple instances */
470                                                         while((ofs=unit_replace(str+ofs, len_max-ofs, str_tmp, scale_pref, unit)))
471                                                                 change= 1;
472                                                 }
473                                         }
474                                 }
475                         }
476                 }
477         }
478         unit= NULL;
479         
480         if(change==0) {
481                 /* no units given so infer a unit from the previous string or default */
482                 if(str_prev) {
483                         /* see which units the original value had */
484                         for(unit= usys->units; unit->name; unit++) {
485
486                                 if(unit->flag & B_UNIT_DEF_SUPPRESS)
487                                         continue;
488
489                                 if (unit_find(str_prev, unit))
490                                         break;
491                         }
492                 }
493
494                 if(unit==NULL || unit->name == NULL)
495                         unit= unit_default(usys);
496
497
498                 /* add the unit prefix and re-run, use brackets incase there was an expression given */
499                 if(snprintf(str_tmp, sizeof(str_tmp), "(%s)%s", str, unit->name) < sizeof(str_tmp)) {
500                         strncpy(str, str_tmp, len_max);
501                         return bUnit_ReplaceString(str, len_max, NULL, scale_pref, system, type);
502                 }
503                 else {
504                         /* snprintf would not fit into str_tmp, cant do much in this case
505                          * check for this because otherwise bUnit_ReplaceString could call its self forever */
506                         return 0;
507                 }
508
509         }
510
511         /* replace # with commas when there is no operator between it and the next number
512          *
513          * "1*1# 3*100# * 3"  ->  "1 *1, 3 *100  * 3"
514          *
515          * */
516         {
517                 char *str_found= str;
518                 char *ch= str;
519
520                 while((str_found= strchr(str_found, SEP_CHR))) {
521
522                         int op_found= 0;
523                         /* any operators after this?*/
524                         for(ch= str_found+1; *ch!='\0'; ch++) {
525
526                                 if(*ch==' ' || *ch=='\t') {
527                                         /* do nothing */
528                                 }
529                                 else if (ch_is_op(*ch) || *ch==',') { /* found an op, no need to insert a ,*/
530                                         op_found= 1;
531                                         break;
532                                 }
533                                 else { /* found a non-op character */
534                                         op_found= 0;
535                                         break;
536                                 }
537                         }
538
539                         *str_found++ = op_found ? ' ':',';
540                 }
541         }
542
543         return change;
544 }
545
546
547 double bUnit_ClosestScalar(double value, int system, int type)
548 {
549         bUnitCollection *usys = unit_get_system(system, type);
550         bUnitDef *unit;
551
552         if(usys==NULL)
553                 return -1;
554
555         unit= unit_best_fit(value, usys, NULL, 1);
556         if(unit==NULL)
557                 return -1;
558
559         return unit->scalar;
560 }
561
562 double bUnit_BaseScalar(int system, int type)
563 {
564         bUnitCollection *usys = unit_get_system(system, type);
565         return unit_default(usys)->scalar;
566 }
567
568 /* external access */
569 void bUnit_GetSystem(void **usys_pt, int *len, int system, int type)
570 {
571         bUnitCollection *usys = unit_get_system(system, type);
572         *usys_pt= usys;
573
574         if(usys==NULL) {
575                 *len= 0;
576                 return;
577         }
578
579         *len= usys->length;
580 }
581
582 char *bUnit_GetName(void *usys_pt, int index)
583 {
584         return ((bUnitCollection *)usys_pt)->units[index].name;
585 }
586 char *bUnit_GetNameDisplay(void *usys_pt, int index)
587 {
588         return ((bUnitCollection *)usys_pt)->units[index].name_display;
589 }
590
591 double bUnit_GetScaler(void *usys_pt, int index)
592 {
593         return ((bUnitCollection *)usys_pt)->units[index].scalar;
594 }