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