Cleanup: style, use braces for blenkernel
[blender.git] / source / blender / blenkernel / intern / unit.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup bke
19  */
20
21 #include <stdlib.h>
22 #include <stdio.h>
23 #include <ctype.h>
24 #include <string.h>
25 #include <assert.h>
26
27 #include "BLI_sys_types.h"
28 #include "BLI_math.h"
29 #include "BLI_string.h"
30 #include "BLI_string_utf8.h"
31
32 #include "DNA_scene_types.h"
33
34 #include "BKE_unit.h" /* own include */
35
36 #ifdef WIN32
37 #  include "BLI_winstuff.h"
38 #endif
39
40 /* no BKE or DNA includes! */
41
42 /* Keep alignment. */
43 /* clang-format off */
44
45 #define TEMP_STR_SIZE 256
46
47 #define SEP_CHR     '#'
48 #define SEP_STR     "#"
49
50 #define EPS 0.001
51
52 #define UN_SC_KM    1000.0f
53 #define UN_SC_HM    100.0f
54 #define UN_SC_DAM   10.0f
55 #define UN_SC_M     1.0f
56 #define UN_SC_DM    0.1f
57 #define UN_SC_CM    0.01f
58 #define UN_SC_MM    0.001f
59 #define UN_SC_UM    0.000001f
60
61 #define UN_SC_MI    1609.344f
62 #define UN_SC_FUR   201.168f
63 #define UN_SC_CH    20.1168f
64 #define UN_SC_YD    0.9144f
65 #define UN_SC_FT    0.3048f
66 #define UN_SC_IN    0.0254f
67 #define UN_SC_MIL   0.0000254f
68
69 #define UN_SC_MTON  1000.0f /* metric ton */
70 #define UN_SC_QL    100.0f
71 #define UN_SC_KG    1.0f
72 #define UN_SC_HG    0.1f
73 #define UN_SC_DAG   0.01f
74 #define UN_SC_G     0.001f
75 #define UN_SC_MG    0.000001f
76
77 #define UN_SC_ITON  907.18474f /* imperial ton */
78 #define UN_SC_CWT   45.359237f
79 #define UN_SC_ST    6.35029318f
80 #define UN_SC_LB    0.45359237f
81 #define UN_SC_OZ    0.028349523125f
82
83 /* clang-format on */
84
85 /* define a single unit */
86 typedef struct bUnitDef {
87   const char *name;
88   /** abused a bit for the display name */
89   const char *name_plural;
90   /** this is used for display*/
91   const char *name_short;
92   /** keyboard-friendly ASCII-only version of name_short, can be NULL */
93   const char *name_alt;
94   /* if name_short has non-ASCII chars, name_alt should be present */
95
96   /** can be NULL */
97   const char *name_display;
98   /** when NULL, a transformed version of the name will be taken */
99   const char *identifier;
100
101   double scalar;
102   /** not used yet, needed for converting temperature */
103   double bias;
104   int flag;
105 } bUnitDef;
106
107 enum {
108   B_UNIT_DEF_NONE = 0,
109   /** Use for units that are not used enough to be translated into for common use */
110   B_UNIT_DEF_SUPPRESS = 1,
111   /** Display a unit even if its value is 0.1, eg 0.1mm instead of 100um */
112   B_UNIT_DEF_TENTH = 2,
113   /** Short unit name is case sensitive, for example to distinguish mW and MW */
114   B_UNIT_DEF_CASE_SENSITIVE = 4,
115 };
116
117 /* define a single unit */
118 typedef struct bUnitCollection {
119   const struct bUnitDef *units;
120   /** basic unit index (when user doesn't specify unit explicitly) */
121   int base_unit;
122   /** options for this system */
123   int flag;
124   /** to quickly find the last item */
125   int length;
126 } bUnitCollection;
127
128 /* Keep table lignment. */
129 /* clang-format off */
130
131 #define UNIT_COLLECTION_LENGTH(def) (sizeof(def) / sizeof(bUnitDef) - 1)
132 #define NULL_UNIT {NULL, NULL, NULL, NULL, NULL, NULL, 0.0, 0.0}
133
134 /* Dummy */
135 static struct bUnitDef buDummyDef[] = { {"", NULL, "", NULL, NULL, NULL, 1.0, 0.0}, NULL_UNIT};
136 static struct bUnitCollection buDummyCollection = {buDummyDef, 0, 0, sizeof(buDummyDef)};
137
138 /* Lengths */
139 static struct bUnitDef buMetricLenDef[] = {
140   {"kilometer",  "kilometers",  "km",  NULL, "Kilometers",     "KILOMETERS",  UN_SC_KM,  0.0, B_UNIT_DEF_NONE},
141   {"hectometer", "hectometers", "hm",  NULL, "100 Meters",     "HECTOMETERS", UN_SC_HM,  0.0, B_UNIT_DEF_SUPPRESS},
142   {"dekameter",  "dekameters",  "dam", NULL, "10 Meters",      "DEKAMETERS",  UN_SC_DAM, 0.0, B_UNIT_DEF_SUPPRESS},
143   {"meter",      "meters",      "m",   NULL, "Meters",         "METERS",      UN_SC_M,   0.0, B_UNIT_DEF_NONE},     /* base unit */
144   {"decimeter",  "decimeters",  "dm",  NULL, "10 Centimeters", "DECIMETERS",  UN_SC_DM,  0.0, B_UNIT_DEF_SUPPRESS},
145   {"centimeter", "centimeters", "cm",  NULL, "Centimeters",    "CENTIMETERS", UN_SC_CM,  0.0, B_UNIT_DEF_NONE},
146   {"millimeter", "millimeters", "mm",  NULL, "Millimeters",    "MILLIMETERS", UN_SC_MM,  0.0, B_UNIT_DEF_NONE | B_UNIT_DEF_TENTH},
147   {"micrometer", "micrometers", "µm",  "um", "Micrometers",    "MICROMETERS", UN_SC_UM,  0.0, B_UNIT_DEF_NONE},
148
149   /* These get displayed because of float precision problems in the transform header,
150    * could work around, but for now probably people wont use these */
151 #if 0
152   {"nanometer", "Nanometers",     "nm", NULL, 0.000000001, 0.0,   B_UNIT_DEF_NONE},
153   {"picometer", "Picometers",     "pm", NULL, 0.000000000001, 0.0, B_UNIT_DEF_NONE},
154 #endif
155   NULL_UNIT,
156 };
157 static const struct bUnitCollection buMetricLenCollection = {buMetricLenDef, 3, 0, UNIT_COLLECTION_LENGTH(buMetricLenDef)};
158
159 static struct bUnitDef buImperialLenDef[] = {
160   {"mile",    "miles",    "mi",   "m",  "Miles",    "MILES",    UN_SC_MI,  0.0, B_UNIT_DEF_NONE},
161   {"furlong", "furlongs", "fur",  NULL, "Furlongs", "FURLONGS", UN_SC_FUR, 0.0, B_UNIT_DEF_SUPPRESS},
162   {"chain",   "chains",   "ch",   NULL, "Chains",   "CHAINS",   UN_SC_CH,  0.0, B_UNIT_DEF_SUPPRESS},
163   {"yard",    "yards",    "yd",   NULL, "Yards",    "YARDS",    UN_SC_YD,  0.0, B_UNIT_DEF_SUPPRESS},
164   {"foot",    "feet",     "'",    "ft", "Feet",     "FEET",     UN_SC_FT,  0.0, B_UNIT_DEF_NONE}, /* base unit */
165   {"inch",    "inches",   "\"",   "in", "Inches",   "INCHES",   UN_SC_IN,  0.0, B_UNIT_DEF_NONE},
166   {"thou",    "thou",     "thou", "mil", "Thou",    "THOU",     UN_SC_MIL, 0.0, B_UNIT_DEF_NONE}, /* plural for thou has no 's' */
167   NULL_UNIT,
168 };
169 static struct bUnitCollection buImperialLenCollection = {buImperialLenDef, 4, 0, UNIT_COLLECTION_LENGTH(buImperialLenDef)};
170
171 /* Areas */
172 static struct bUnitDef buMetricAreaDef[] = {
173   {"square kilometer",  "square kilometers",  "km²",  "km2",  "Square Kilometers",  NULL, UN_SC_KM * UN_SC_KM,   0.0, B_UNIT_DEF_NONE},
174   {"square hectometer", "square hectometers", "hm²",  "hm2",  "Square Hectometers", NULL, UN_SC_HM * UN_SC_HM,   0.0, B_UNIT_DEF_SUPPRESS},   /* hectare */
175   {"square dekameter",  "square dekameters",  "dam²", "dam2", "Square Dekameters",  NULL, UN_SC_DAM * UN_SC_DAM, 0.0, B_UNIT_DEF_SUPPRESS},  /* are */
176   {"square meter",      "square meters",      "m²",   "m2",   "Square Meters",      NULL, UN_SC_M * UN_SC_M,     0.0, B_UNIT_DEF_NONE},   /* base unit */
177   {"square decimeter",  "square decimetees",  "dm²",  "dm2",  "Square Decimeters",  NULL, UN_SC_DM * UN_SC_DM,   0.0, B_UNIT_DEF_SUPPRESS},
178   {"square centimeter", "square centimeters", "cm²",  "cm2",  "Square Centimeters", NULL, UN_SC_CM * UN_SC_CM,   0.0, B_UNIT_DEF_NONE},
179   {"square millimeter", "square millimeters", "mm²",  "mm2",  "Square Millimeters", NULL, UN_SC_MM * UN_SC_MM,   0.0, B_UNIT_DEF_NONE | B_UNIT_DEF_TENTH},
180   {"square micrometer", "square micrometers", "µm²",  "um2",  "Square Micrometers", NULL, UN_SC_UM * UN_SC_UM,   0.0, B_UNIT_DEF_NONE},
181   NULL_UNIT,
182 };
183 static struct bUnitCollection buMetricAreaCollection = {buMetricAreaDef, 3, 0, UNIT_COLLECTION_LENGTH(buMetricAreaDef)};
184
185 static struct bUnitDef buImperialAreaDef[] = {
186   {"square mile",    "square miles",    "sq mi", "sq m", "Square Miles",    NULL, UN_SC_MI * UN_SC_MI,   0.0, B_UNIT_DEF_NONE},
187   {"square furlong", "square furlongs", "sq fur", NULL,  "Square Furlongs", NULL, UN_SC_FUR * UN_SC_FUR, 0.0, B_UNIT_DEF_SUPPRESS},
188   {"square chain",   "square chains",   "sq ch",  NULL,  "Square Chains",   NULL, UN_SC_CH * UN_SC_CH,   0.0, B_UNIT_DEF_SUPPRESS},
189   {"square yard",    "square yards",    "sq yd",  NULL,  "Square Yards",    NULL, UN_SC_YD * UN_SC_YD,   0.0, B_UNIT_DEF_NONE},
190   {"square foot",    "square feet",     "sq ft",  NULL,  "Square Feet",     NULL, UN_SC_FT * UN_SC_FT,   0.0, B_UNIT_DEF_NONE}, /* base unit */
191   {"square inch",    "square inches",   "sq in",  NULL,  "Square Inches",   NULL, UN_SC_IN * UN_SC_IN,   0.0, B_UNIT_DEF_NONE},
192   {"square thou",    "square thou",     "sq mil", NULL,  "Square Thou",     NULL, UN_SC_MIL * UN_SC_MIL, 0.0, B_UNIT_DEF_NONE},
193   NULL_UNIT,
194 };
195 static struct bUnitCollection buImperialAreaCollection = {buImperialAreaDef, 4, 0, UNIT_COLLECTION_LENGTH(buImperialAreaDef)};
196
197 /* Volumes */
198 static struct bUnitDef buMetricVolDef[] = {
199   {"cubic kilometer",  "cubic kilometers",  "km³",  "km3",  "Cubic Kilometers",  NULL, UN_SC_KM * UN_SC_KM * UN_SC_KM,    0.0, B_UNIT_DEF_NONE},
200   {"cubic hectometer", "cubic hectometers", "hm³",  "hm3",  "Cubic Hectometers", NULL, UN_SC_HM * UN_SC_HM * UN_SC_HM,    0.0, B_UNIT_DEF_SUPPRESS},
201   {"cubic dekameter",  "cubic dekameters",  "dam³", "dam3", "Cubic Dekameters",  NULL, UN_SC_DAM * UN_SC_DAM * UN_SC_DAM, 0.0, B_UNIT_DEF_SUPPRESS},
202   {"cubic meter",      "cubic meters",      "m³",   "m3",   "Cubic Meters",      NULL, UN_SC_M * UN_SC_M * UN_SC_M,       0.0, B_UNIT_DEF_NONE}, /* base unit */
203   {"cubic decimeter",  "cubic decimeters",  "dm³",  "dm3",  "Cubic Decimeters",  NULL, UN_SC_DM * UN_SC_DM * UN_SC_DM,    0.0, B_UNIT_DEF_SUPPRESS},
204   {"cubic centimeter", "cubic centimeters", "cm³",  "cm3",  "Cubic Centimeters", NULL, UN_SC_CM * UN_SC_CM * UN_SC_CM,    0.0, B_UNIT_DEF_NONE},
205   {"cubic millimeter", "cubic millimeters", "mm³",  "mm3",  "Cubic Millimeters", NULL, UN_SC_MM * UN_SC_MM * UN_SC_MM,    0.0, B_UNIT_DEF_NONE | B_UNIT_DEF_TENTH},
206   {"cubic micrometer", "cubic micrometers", "µm³",  "um3",  "Cubic Micrometers", NULL, UN_SC_UM * UN_SC_UM * UN_SC_UM,    0.0, B_UNIT_DEF_NONE},
207   NULL_UNIT,
208 };
209 static struct bUnitCollection buMetricVolCollection = {buMetricVolDef, 3, 0, UNIT_COLLECTION_LENGTH(buMetricVolDef)};
210
211 static struct bUnitDef buImperialVolDef[] = {
212   {"cubic mile",    "cubic miles",    "cu mi",  "cu m", "Cubic Miles",    NULL, UN_SC_MI * UN_SC_MI * UN_SC_MI,    0.0, B_UNIT_DEF_NONE},
213   {"cubic furlong", "cubic furlongs", "cu fur", NULL,   "Cubic Furlongs", NULL, UN_SC_FUR * UN_SC_FUR * UN_SC_FUR, 0.0, B_UNIT_DEF_SUPPRESS},
214   {"cubic chain",   "cubic chains",   "cu ch",  NULL,   "Cubic Chains",   NULL, UN_SC_CH * UN_SC_CH * UN_SC_CH,    0.0, B_UNIT_DEF_SUPPRESS},
215   {"cubic yard",    "cubic yards",    "cu yd",  NULL,   "Cubic Yards",    NULL, UN_SC_YD * UN_SC_YD * UN_SC_YD,    0.0, B_UNIT_DEF_NONE},
216   {"cubic foot",    "cubic feet",     "cu ft",  NULL,   "Cubic Feet",     NULL, UN_SC_FT * UN_SC_FT * UN_SC_FT,    0.0, B_UNIT_DEF_NONE}, /* base unit */
217   {"cubic inch",    "cubic inches",   "cu in",  NULL,   "Cubic Inches",   NULL, UN_SC_IN * UN_SC_IN * UN_SC_IN,    0.0, B_UNIT_DEF_NONE},
218   {"cubic thou",    "cubic thou",     "cu mil", NULL,   "Cubic Thou",     NULL, UN_SC_MIL * UN_SC_MIL * UN_SC_MIL, 0.0, B_UNIT_DEF_NONE},
219   NULL_UNIT,
220 };
221 static struct bUnitCollection buImperialVolCollection = {buImperialVolDef, 4, 0, UNIT_COLLECTION_LENGTH(buImperialVolDef)};
222
223 /* Mass */
224 static struct bUnitDef buMetricMassDef[] = {
225   {"ton",       "tonnes",     "ton", "t",  "Tonnes",        "TONNES",       UN_SC_MTON, 0.0, B_UNIT_DEF_NONE},
226   {"quintal",   "quintals",   "ql",  "q",  "100 Kilograms", "QUINTALS",   UN_SC_QL,   0.0, B_UNIT_DEF_SUPPRESS},
227   {"kilogram",  "kilograms",  "kg",  NULL, "Kilograms",     "KILOGRAMS",  UN_SC_KG,   0.0, B_UNIT_DEF_NONE}, /* base unit */
228   {"hectogram", "hectograms", "hg",  NULL, "Hectograms",    "HECTOGRAMS", UN_SC_HG,   0.0, B_UNIT_DEF_SUPPRESS},
229   {"dekagram",  "dekagrams",  "dag", NULL, "10 Grams",      "DEKAGRAMS",  UN_SC_DAG,  0.0, B_UNIT_DEF_SUPPRESS},
230   {"gram",      "grams",      "g",   NULL, "Grams",         "GRAMS",      UN_SC_G,    0.0, B_UNIT_DEF_NONE},
231   {"milligram", "milligrams", "mg",  NULL, "Milligrams",    "MILLIGRAMS", UN_SC_MG,   0.0, B_UNIT_DEF_NONE},
232   NULL_UNIT,
233 };
234 static struct bUnitCollection buMetricMassCollection = {buMetricMassDef, 2, 0, UNIT_COLLECTION_LENGTH(buMetricMassDef)};
235
236 static struct bUnitDef buImperialMassDef[] = {
237   {"ton",           "tonnes",         "ton", "t",  "Tonnes",         "TONNES",         UN_SC_ITON, 0.0, B_UNIT_DEF_NONE},
238   {"centum weight", "centum weights", "cwt", NULL, "Centum weights", "CENTUM_WEIGHTS", UN_SC_CWT,  0.0, B_UNIT_DEF_NONE},
239   {"stone",         "stones",         "st",  NULL, "Stones",         "STONES",         UN_SC_ST,   0.0, B_UNIT_DEF_NONE},
240   {"pound",         "pounds",         "lb",  NULL, "Pounds",         "POUNDS",         UN_SC_LB,   0.0, B_UNIT_DEF_NONE}, /* base unit */
241   {"ounce",         "ounces",         "oz",  NULL, "Ounces",         "OUNCES",         UN_SC_OZ,   0.0, B_UNIT_DEF_NONE},
242   NULL_UNIT,
243 };
244 static struct bUnitCollection buImperialMassCollection = {buImperialMassDef, 3, 0, UNIT_COLLECTION_LENGTH(buImperialMassDef)};
245
246 /* Even if user scales the system to a point where km^3 is used, velocity and
247  * acceleration aren't scaled: that's why we have so few units for them */
248
249 /* Velocity */
250 static struct bUnitDef buMetricVelDef[] = {
251   {"meter per second",   "meters per second",   "m/s",  NULL, "Meters per second",   NULL, UN_SC_M,            0.0, B_UNIT_DEF_NONE}, /* base unit */
252   {"kilometer per hour", "kilometers per hour", "km/h", NULL, "Kilometers per hour", NULL, UN_SC_KM / 3600.0f, 0.0, B_UNIT_DEF_SUPPRESS},
253   NULL_UNIT,
254 };
255 static struct bUnitCollection buMetricVelCollection = {buMetricVelDef, 0, 0, UNIT_COLLECTION_LENGTH(buMetricVelDef)};
256
257 static struct bUnitDef buImperialVelDef[] = {
258   {"foot per second", "feet per second", "ft/s", "fps", "Feet per second", NULL, UN_SC_FT,           0.0, B_UNIT_DEF_NONE}, /* base unit */
259   {"mile per hour",   "miles per hour",  "mph",  NULL,  "Miles per hour",  NULL, UN_SC_MI / 3600.0f, 0.0, B_UNIT_DEF_SUPPRESS},
260   NULL_UNIT,
261 };
262 static struct bUnitCollection buImperialVelCollection = {buImperialVelDef, 0, 0, UNIT_COLLECTION_LENGTH(buImperialVelDef)};
263
264 /* Acceleration */
265 static struct bUnitDef buMetricAclDef[] = {
266   {"meter per second squared", "meters per second squared", "m/s²", "m/s2", "Meters per second squared", NULL, UN_SC_M, 0.0, B_UNIT_DEF_NONE}, /* base unit */
267   NULL_UNIT,
268 };
269 static struct bUnitCollection buMetricAclCollection = {buMetricAclDef, 0, 0, UNIT_COLLECTION_LENGTH(buMetricAclDef)};
270
271 static struct bUnitDef buImperialAclDef[] = {
272   {"foot per second squared", "feet per second squared", "ft/s²", "ft/s2", "Feet per second squared", NULL, UN_SC_FT, 0.0, B_UNIT_DEF_NONE}, /* base unit */
273   NULL_UNIT,
274 };
275 static struct bUnitCollection buImperialAclCollection = {buImperialAclDef, 0, 0, UNIT_COLLECTION_LENGTH(buImperialAclDef)};
276
277 /* Time */
278 static struct bUnitDef buNaturalTimeDef[] = {
279   /* weeks? - probably not needed for blender */
280   {"day",         "days",         "d",   NULL, "Days",         "DAYS",     90000.0,      0.0, B_UNIT_DEF_NONE},
281   {"hour",        "hours",        "hr",  "h",  "Hours",        "HOURS",     3600.0,      0.0, B_UNIT_DEF_NONE},
282   {"minute",      "minutes",      "min", "m",  "Minutes",      "MINUTES",     60.0,      0.0, B_UNIT_DEF_NONE},
283   {"second",      "seconds",      "sec", "s",  "Seconds",      "SECONDS",      1.0,      0.0, B_UNIT_DEF_NONE}, /* base unit */
284   {"millisecond", "milliseconds", "ms",  NULL, "Milliseconds", "MILLISECONDS", 0.001,    0.0, B_UNIT_DEF_NONE},
285   {"microsecond", "microseconds", "µs",  "us", "Microseconds", "MICROSECONDS", 0.000001, 0.0, B_UNIT_DEF_NONE},
286   NULL_UNIT,
287 };
288 static struct bUnitCollection buNaturalTimeCollection = {buNaturalTimeDef, 3, 0, UNIT_COLLECTION_LENGTH(buNaturalTimeDef)};
289
290
291 static struct bUnitDef buNaturalRotDef[] = {
292   {"degree",    "degrees",     "°",  "d",   "Degrees",    "DEGREES",    M_PI / 180.0,             0.0,  B_UNIT_DEF_NONE},
293   /* arcminutes/arcseconds are used in Astronomy/Navigation areas... */
294   {"arcminute", "arcminutes",  "'",  NULL,  "Arcminutes", "ARCMINUTES", (M_PI / 180.0) / 60.0,    0.0,  B_UNIT_DEF_SUPPRESS},
295   {"arcsecond", "arcseconds",  "\"", NULL,  "Arcseconds", "ARCSECONDS", (M_PI / 180.0) / 3600.0,  0.0,  B_UNIT_DEF_SUPPRESS},
296   {"radian",    "radians",     "r",  NULL,  "Radians",    "RADIANS",    1.0,                      0.0,  B_UNIT_DEF_NONE},
297 //  {"turn",      "turns",       "t",  NULL,  "Turns",      NULL, 1.0 / (M_PI * 2.0),       0.0,  B_UNIT_DEF_NONE},
298   NULL_UNIT,
299 };
300 static struct bUnitCollection buNaturalRotCollection = {buNaturalRotDef, 0, 0, UNIT_COLLECTION_LENGTH(buNaturalRotDef)};
301
302 /* Camera Lengths */
303 static struct bUnitDef buCameraLenDef[] = {
304   {"meter",      "meters",      "m",   NULL, "Meters",         NULL, UN_SC_KM,  0.0, B_UNIT_DEF_NONE},     /* base unit */
305   {"decimeter",  "decimeters",  "dm",  NULL, "10 Centimeters", NULL, UN_SC_HM,  0.0, B_UNIT_DEF_SUPPRESS},
306   {"centimeter", "centimeters", "cm",  NULL, "Centimeters",    NULL, UN_SC_DAM, 0.0, B_UNIT_DEF_SUPPRESS},
307   {"millimeter", "millimeters", "mm",  NULL, "Millimeters",    NULL, UN_SC_M,   0.0, B_UNIT_DEF_NONE},
308   {"micrometer", "micrometers", "µm", "um",  "Micrometers",    NULL, UN_SC_MM,  0.0, B_UNIT_DEF_SUPPRESS},
309   NULL_UNIT,
310 };
311 static struct bUnitCollection buCameraLenCollection = {buCameraLenDef, 3, 0, UNIT_COLLECTION_LENGTH(buCameraLenDef)};
312
313 /* (Light) Power */
314 static struct bUnitDef buPowerDef[] = {
315   {"gigawatt",  "gigawatts",  "GW", NULL, "Gigawatts",  NULL, 1e9f,  0.0, B_UNIT_DEF_NONE},
316   {"megawatt",  "megawatts",  "MW", NULL, "Megawatts",  NULL, 1e6f,  0.0, B_UNIT_DEF_CASE_SENSITIVE},
317   {"kilowatt",  "kilowatts",  "kW", NULL, "Kilowatts",  NULL, 1e3f,  0.0, B_UNIT_DEF_SUPPRESS},
318   {"watt",      "watts",      "W",  NULL, "Watts",      NULL, 1.0f,  0.0, B_UNIT_DEF_NONE}, /* base unit */
319   {"milliwatt", "milliwatts", "mW", NULL, "Milliwatts", NULL, 1e-3f, 0.0, B_UNIT_DEF_CASE_SENSITIVE},
320   {"microwatt", "microwatts", "µW", "uW", "Microwatts", NULL, 1e-6f, 0.0, B_UNIT_DEF_NONE},
321   {"nanowatt",  "nanowatts",  "nW", NULL, "Nanowatts",  NULL, 1e-9f, 0.0, B_UNIT_DEF_NONE},
322   NULL_UNIT,
323 };
324 static struct bUnitCollection buPowerCollection = {buPowerDef, 3, 0, UNIT_COLLECTION_LENGTH(buPowerDef)};
325
326
327 #define UNIT_SYSTEM_TOT (((sizeof(bUnitSystems) / B_UNIT_TYPE_TOT) / sizeof(void *)) - 1)
328 static const struct bUnitCollection *bUnitSystems[][B_UNIT_TYPE_TOT] = {
329   {NULL, NULL, NULL, NULL, NULL, &buNaturalRotCollection, &buNaturalTimeCollection, NULL, NULL, NULL, NULL},
330   {NULL, &buMetricLenCollection, &buMetricAreaCollection, &buMetricVolCollection, &buMetricMassCollection, &buNaturalRotCollection, &buNaturalTimeCollection, &buMetricVelCollection, &buMetricAclCollection, &buCameraLenCollection, &buPowerCollection}, /* metric */
331   {NULL, &buImperialLenCollection, &buImperialAreaCollection, &buImperialVolCollection, &buImperialMassCollection, &buNaturalRotCollection, &buNaturalTimeCollection, &buImperialVelCollection, &buImperialAclCollection, &buCameraLenCollection, &buPowerCollection}, /* imperial */
332   {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL},
333 };
334
335 /* clang-format on */
336
337 /* internal, has some option not exposed */
338 static const bUnitCollection *unit_get_system(int system, int type)
339 {
340   assert((system > -1) && (system < UNIT_SYSTEM_TOT) && (type > -1) && (type < B_UNIT_TYPE_TOT));
341   return bUnitSystems[system][type]; /* select system to use, metric/imperial/other? */
342 }
343
344 static const bUnitDef *unit_default(const bUnitCollection *usys)
345 {
346   return &usys->units[usys->base_unit];
347 }
348
349 static const bUnitDef *unit_best_fit(double value,
350                                      const bUnitCollection *usys,
351                                      const bUnitDef *unit_start,
352                                      int suppress)
353 {
354   const bUnitDef *unit;
355   double value_abs = value > 0.0 ? value : -value;
356
357   for (unit = unit_start ? unit_start : usys->units; unit->name; unit++) {
358
359     if (suppress && (unit->flag & B_UNIT_DEF_SUPPRESS)) {
360       continue;
361     }
362
363     /* scale down scalar so 1cm doesn't convert to 10mm because of float error */
364     if (UNLIKELY(unit->flag & B_UNIT_DEF_TENTH)) {
365       if (value_abs >= unit->scalar * (0.1 - EPS)) {
366         return unit;
367       }
368     }
369     else {
370       if (value_abs >= unit->scalar * (1.0 - EPS)) {
371         return unit;
372       }
373     }
374   }
375
376   return unit_default(usys);
377 }
378
379 /* convert into 2 units and 2 values for "2ft, 3inch" syntax */
380 static void unit_dual_convert(double value,
381                               const bUnitCollection *usys,
382                               bUnitDef const **r_unit_a,
383                               bUnitDef const **r_unit_b,
384                               double *r_value_a,
385                               double *r_value_b,
386                               const bUnitDef *main_unit)
387 {
388   const bUnitDef *unit;
389   if (main_unit) {
390     unit = main_unit;
391   }
392   else {
393     unit = unit_best_fit(value, usys, NULL, 1);
394   }
395
396   *r_value_a = (value < 0.0 ? ceil : floor)(value / unit->scalar) * unit->scalar;
397   *r_value_b = value - (*r_value_a);
398
399   *r_unit_a = unit;
400   *r_unit_b = unit_best_fit(*r_value_b, usys, *r_unit_a, 1);
401 }
402
403 static size_t unit_as_string(char *str,
404                              int len_max,
405                              double value,
406                              int prec,
407                              const bUnitCollection *usys,
408                              /* non exposed options */
409                              const bUnitDef *unit,
410                              char pad)
411 {
412   double value_conv;
413   size_t len, i;
414
415   if (unit) {
416     /* use unit without finding the best one */
417   }
418   else if (value == 0.0) {
419     /* use the default units since there is no way to convert */
420     unit = unit_default(usys);
421   }
422   else {
423     unit = unit_best_fit(value, usys, NULL, 1);
424   }
425
426   value_conv = value / unit->scalar;
427
428   /* Adjust precision to expected number of significant digits.
429    * Note that here, we shall not have to worry about very big/small numbers, units are expected to replace
430    * 'scientific notation' in those cases. */
431   prec -= integer_digits_d(value_conv);
432   CLAMP(prec, 0, 6);
433
434   /* Convert to a string */
435   len = BLI_snprintf_rlen(str, len_max, "%.*f", prec, value_conv);
436
437   /* Add unit prefix and strip zeros */
438
439   /* replace trailing zero's with spaces
440    * so the number is less complicated but alignment in a button wont
441    * jump about while dragging */
442   i = len - 1;
443
444   if (prec > 0) {
445     while (i > 0 && str[i] == '0') { /* 4.300 -> 4.3 */
446       str[i--] = pad;
447     }
448
449     if (i > 0 && str[i] == '.') { /* 10. -> 10 */
450       str[i--] = pad;
451     }
452   }
453
454   /* Now add the suffix */
455   if (i < len_max) {
456     int j = 0;
457     i++;
458     while (unit->name_short[j] && (i < len_max)) {
459       str[i++] = unit->name_short[j++];
460     }
461   }
462
463   /* terminate no matter what's done with padding above */
464   if (i >= len_max) {
465     i = len_max - 1;
466   }
467
468   str[i] = '\0';
469   return i;
470 }
471
472 static bool unit_should_be_split(int type)
473 {
474   return ELEM(type, B_UNIT_LENGTH, B_UNIT_MASS, B_UNIT_TIME, B_UNIT_CAMERA);
475 }
476
477 typedef struct {
478   int system;
479   int rotation;
480   /* USER_UNIT_ADAPTIVE means none, otherwise the value is the index in the collection */
481   int length;
482   int mass;
483   int time;
484 } PreferredUnits;
485
486 static PreferredUnits preferred_units_from_UnitSettings(const UnitSettings *settings)
487 {
488   PreferredUnits units = {0};
489   units.system = settings->system;
490   units.rotation = settings->system_rotation;
491   units.length = settings->length_unit;
492   units.mass = settings->mass_unit;
493   units.time = settings->time_unit;
494   return units;
495 }
496
497 static size_t unit_as_string_splitted(char *str,
498                                       int len_max,
499                                       double value,
500                                       int prec,
501                                       const bUnitCollection *usys,
502                                       const bUnitDef *main_unit)
503 {
504   const bUnitDef *unit_a, *unit_b;
505   double value_a, value_b;
506
507   unit_dual_convert(value, usys, &unit_a, &unit_b, &value_a, &value_b, main_unit);
508
509   /* check the 2 is a smaller unit */
510   if (unit_b > unit_a) {
511     size_t i;
512     i = unit_as_string(str, len_max, value_a, prec, usys, unit_a, '\0');
513
514     prec -= integer_digits_d(value_a / unit_b->scalar) -
515             integer_digits_d(value_b / unit_b->scalar);
516     prec = max_ii(prec, 0);
517
518     /* is there enough space for at least 1 char of the next unit? */
519     if (i + 2 < len_max) {
520       str[i++] = ' ';
521
522       /* use low precision since this is a smaller unit */
523       i += unit_as_string(str + i, len_max - i, value_b, prec, usys, unit_b, '\0');
524     }
525     return i;
526   }
527
528   return -1;
529 }
530
531 static bool is_valid_unit_collection(const bUnitCollection *usys)
532 {
533   return usys != NULL && usys->units[0].name != NULL;
534 }
535
536 static const bUnitDef *get_preferred_display_unit_if_used(int type, PreferredUnits units)
537 {
538   const bUnitCollection *usys = unit_get_system(units.system, type);
539   if (!is_valid_unit_collection(usys)) {
540     return NULL;
541   }
542
543   int max_offset = usys->length - 1;
544
545   switch (type) {
546     case B_UNIT_LENGTH:
547     case B_UNIT_AREA:
548     case B_UNIT_VOLUME:
549       if (units.length == USER_UNIT_ADAPTIVE) {
550         return NULL;
551       }
552       return usys->units + MIN2(units.length, max_offset);
553     case B_UNIT_MASS:
554       if (units.mass == USER_UNIT_ADAPTIVE) {
555         return NULL;
556       }
557       return usys->units + MIN2(units.mass, max_offset);
558     case B_UNIT_TIME:
559       if (units.time == USER_UNIT_ADAPTIVE) {
560         return NULL;
561       }
562       return usys->units + MIN2(units.time, max_offset);
563     case B_UNIT_ROTATION:
564       if (units.rotation == 0) {
565         return usys->units + 0;
566       }
567       else if (units.rotation == USER_UNIT_ROT_RADIANS) {
568         return usys->units + 3;
569       }
570       break;
571     default:
572       break;
573   }
574   return NULL;
575 }
576
577 /* Return the length of the generated string. */
578 static size_t unit_as_string_main(char *str,
579                                   int len_max,
580                                   double value,
581                                   int prec,
582                                   int type,
583                                   bool split,
584                                   bool pad,
585                                   PreferredUnits units)
586 {
587   const bUnitCollection *usys = unit_get_system(units.system, type);
588   const bUnitDef *main_unit = NULL;
589
590   if (!is_valid_unit_collection(usys)) {
591     usys = &buDummyCollection;
592   }
593   else {
594     main_unit = get_preferred_display_unit_if_used(type, units);
595   }
596
597   if (split && unit_should_be_split(type)) {
598     int length = unit_as_string_splitted(str, len_max, value, prec, usys, main_unit);
599     /* failed when length is negative, fallback to no split */
600     if (length >= 0) {
601       return length;
602     }
603   }
604
605   return unit_as_string(str, len_max, value, prec, usys, main_unit, pad ? ' ' : '\0');
606 }
607
608 size_t bUnit_AsString(
609     char *str, int len_max, double value, int prec, int system, int type, bool split, bool pad)
610 {
611   PreferredUnits units;
612   units.system = system;
613   units.rotation = 0;
614   units.length = USER_UNIT_ADAPTIVE;
615   units.mass = USER_UNIT_ADAPTIVE;
616   units.time = USER_UNIT_ADAPTIVE;
617   return unit_as_string_main(str, len_max, value, prec, type, split, pad, units);
618 }
619
620 size_t bUnit_AsString2(char *str,
621                        int len_max,
622                        double value,
623                        int prec,
624                        int type,
625                        const UnitSettings *settings,
626                        bool pad)
627 {
628   bool do_split = (settings->flag & USER_UNIT_OPT_SPLIT) != 0;
629   PreferredUnits units = preferred_units_from_UnitSettings(settings);
630   return unit_as_string_main(str, len_max, value, prec, type, do_split, pad, units);
631 }
632
633 BLI_INLINE bool isalpha_or_utf8(const int ch)
634 {
635   return (ch >= 128 || isalpha(ch));
636 }
637
638 static const char *unit_find_str(const char *str, const char *substr, bool case_sensitive)
639 {
640   if (substr && substr[0] != '\0') {
641     while (true) {
642       /* Unit detection is case insensitive. */
643       const char *str_found;
644       if (case_sensitive) {
645         str_found = strstr(str, substr);
646       }
647       else {
648         str_found = BLI_strcasestr(str, substr);
649       }
650
651       if (str_found) {
652         /* Previous char cannot be a letter. */
653         if (str_found == str ||
654             /* weak unicode support!, so "µm" won't match up be replaced by "m"
655              * since non ascii utf8 values will NEVER return true */
656             isalpha_or_utf8(*BLI_str_prev_char_utf8(str_found)) == 0) {
657           /* next char cannot be alphanum */
658           int len_name = strlen(substr);
659
660           if (!isalpha_or_utf8(*(str_found + len_name))) {
661             return str_found;
662           }
663         }
664         /* If str_found is not a valid unit, we have to check further in the string... */
665         for (str_found++; isalpha_or_utf8(*str_found); str_found++) {
666           ;
667         }
668         str = str_found;
669       }
670       else {
671         break;
672       }
673     }
674   }
675   return NULL;
676 }
677
678 /* Note that numbers are added within brackets
679  * ") " - is used to detect numbers we added so we can detect if commas need to be added
680  *
681  * "1m1cm+2mm"              - Original value
682  * "1*1#1*0.01#+2*0.001#"   - Replace numbers
683  * "1*1+1*0.01 +2*0.001 "   - Add add signs if ( + - * / | & ~ < > ^ ! = % ) not found in between
684  */
685
686 /* not too strict, (+ - * /) are most common  */
687 static bool ch_is_op(char op)
688 {
689   switch (op) {
690     case '+':
691     case '-':
692     case '*':
693     case '/':
694     case '|':
695     case '&':
696     case '~':
697     case '<':
698     case '>':
699     case '^':
700     case '!':
701     case '=':
702     case '%':
703       return true;
704     default:
705       return false;
706   }
707 }
708
709 static int unit_scale_str(char *str,
710                           int len_max,
711                           char *str_tmp,
712                           double scale_pref,
713                           const bUnitDef *unit,
714                           const char *replace_str,
715                           bool case_sensitive)
716 {
717   char *str_found;
718
719   if ((len_max > 0) && (str_found = (char *)unit_find_str(str, replace_str, case_sensitive))) {
720     /* XXX - investigate, does not respect len_max properly  */
721
722     int len, len_num, len_name, len_move, found_ofs;
723
724     found_ofs = (int)(str_found - str);
725
726     len = strlen(str);
727
728     len_name = strlen(replace_str);
729     len_move = (len - (found_ofs + len_name)) + 1; /* 1+ to copy the string terminator */
730     len_num = BLI_snprintf(
731         str_tmp, TEMP_STR_SIZE, "*%.9g" SEP_STR, unit->scalar / scale_pref); /* # removed later */
732
733     if (len_num > len_max) {
734       len_num = len_max;
735     }
736
737     if (found_ofs + len_num + len_move > len_max) {
738       /* can't move the whole string, move just as much as will fit */
739       len_move -= (found_ofs + len_num + len_move) - len_max;
740     }
741
742     if (len_move > 0) {
743       /* resize the last part of the string */
744       memmove(
745           str_found + len_num, str_found + len_name, len_move); /* may grow or shrink the string */
746     }
747
748     if (found_ofs + len_num > len_max) {
749       /* not even the number will fit into the string, only copy part of it */
750       len_num -= (found_ofs + len_num) - len_max;
751     }
752
753     if (len_num > 0) {
754       /* its possible none of the number could be copied in */
755       memcpy(str_found, str_tmp, len_num); /* without the string terminator */
756     }
757
758     /* since the null terminator wont be moved if the stringlen_max
759      * was not long enough to fit everything in it */
760     str[len_max - 1] = '\0';
761     return found_ofs + len_num;
762   }
763   return 0;
764 }
765
766 static int unit_replace(
767     char *str, int len_max, char *str_tmp, double scale_pref, const bUnitDef *unit)
768 {
769   const bool case_sensitive = (unit->flag & B_UNIT_DEF_CASE_SENSITIVE) != 0;
770   int ofs = 0;
771   ofs += unit_scale_str(
772       str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name_short, case_sensitive);
773   ofs += unit_scale_str(
774       str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name_plural, false);
775   ofs += unit_scale_str(
776       str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name_alt, case_sensitive);
777   ofs += unit_scale_str(str + ofs, len_max - ofs, str_tmp, scale_pref, unit, unit->name, false);
778   return ofs;
779 }
780
781 static bool unit_find(const char *str, const bUnitDef *unit)
782 {
783   const bool case_sensitive = (unit->flag & B_UNIT_DEF_CASE_SENSITIVE) != 0;
784   if (unit_find_str(str, unit->name_short, case_sensitive)) {
785     return true;
786   }
787   if (unit_find_str(str, unit->name_plural, false)) {
788     return true;
789   }
790   if (unit_find_str(str, unit->name_alt, case_sensitive)) {
791     return true;
792   }
793   if (unit_find_str(str, unit->name, false)) {
794     return true;
795   }
796
797   return false;
798 }
799
800 static const bUnitDef *unit_detect_from_str(const bUnitCollection *usys,
801                                             const char *str,
802                                             const char *str_prev)
803 {
804   /* Try to find a default unit from current or previous string.
805    * This allows us to handle cases like 2 + 2mm, people would expect to get 4mm, not 2.002m!
806    * Note this does not handle corner cases like 2 + 2cm + 1 + 2.5mm... We can't support everything. */
807   const bUnitDef *unit = NULL;
808
809   /* see which units the new value has */
810   for (unit = usys->units; unit->name; unit++) {
811     if (unit_find(str, unit)) {
812       break;
813     }
814   }
815   /* Else, try to infer the default unit from the previous string. */
816   if (str_prev && (unit == NULL || unit->name == NULL)) {
817     /* see which units the original value had */
818     for (unit = usys->units; unit->name; unit++) {
819       if (unit_find(str_prev, unit)) {
820         break;
821       }
822     }
823   }
824   /* Else, fall back to default unit. */
825   if (unit == NULL || unit->name == NULL) {
826     unit = unit_default(usys);
827   }
828
829   return unit;
830 }
831
832 bool bUnit_ContainsUnit(const char *str, int type)
833 {
834   for (int system = 0; system < UNIT_SYSTEM_TOT; system++) {
835     const bUnitCollection *usys = unit_get_system(system, type);
836     if (!is_valid_unit_collection(usys)) {
837       continue;
838     }
839
840     for (int i = 0; i < usys->length; i++) {
841       if (unit_find(str, usys->units + i)) {
842         return true;
843       }
844     }
845   }
846   return false;
847 }
848
849 double bUnit_PreferredInputUnitScalar(const struct UnitSettings *settings, int type)
850 {
851   PreferredUnits units = preferred_units_from_UnitSettings(settings);
852   const bUnitDef *unit = get_preferred_display_unit_if_used(type, units);
853   if (unit) {
854     return unit->scalar;
855   }
856   else {
857     return bUnit_BaseScalar(units.system, type);
858   }
859 }
860
861 /* make a copy of the string that replaces the units with numbers
862  * this is used before parsing
863  * This is only used when evaluating user input and can afford to be a bit slower
864  *
865  * This is to be used before python evaluation so..
866  * 10.1km -> 10.1*1000.0
867  * ...will be resolved by python.
868  *
869  * values will be split by an add sign
870  * 5'2" -> 5*0.3048 + 2*0.0254
871  *
872  * str_prev is optional, when valid it is used to get a base unit when none is set.
873  *
874  * return true of a change was made.
875  */
876 bool bUnit_ReplaceString(
877     char *str, int len_max, const char *str_prev, double scale_pref, int system, int type)
878 {
879   const bUnitCollection *usys = unit_get_system(system, type);
880   if (!is_valid_unit_collection(usys)) {
881     return false;
882   }
883
884   const bUnitDef *unit = NULL, *default_unit;
885   double scale_pref_base = scale_pref;
886   char str_tmp[TEMP_STR_SIZE];
887   bool changed = false;
888
889   /* Try to find a default unit from current or previous string. */
890   default_unit = unit_detect_from_str(usys, str, str_prev);
891
892   /* We apply the default unit to the whole expression (default unit is now the reference '1.0' one). */
893   scale_pref_base *= default_unit->scalar;
894
895   /* Apply the default unit on the whole expression, this allows to handle nasty cases like '2+2in'. */
896   if (BLI_snprintf(str_tmp, sizeof(str_tmp), "(%s)*%.9g", str, default_unit->scalar) <
897       sizeof(str_tmp)) {
898     strncpy(str, str_tmp, len_max);
899   }
900   else {
901     /* BLI_snprintf would not fit into str_tmp, cant do much in this case
902      * check for this because otherwise bUnit_ReplaceString could call its self forever */
903     return changed;
904   }
905
906   for (unit = usys->units; unit->name; unit++) {
907     /* in case there are multiple instances */
908     while (unit_replace(str, len_max, str_tmp, scale_pref_base, unit)) {
909       changed = true;
910     }
911   }
912   unit = NULL;
913
914   {
915     /* try other unit systems now, so we can evaluate imperial when metric is set for eg. */
916     /* Note that checking other systems at that point means we do not support their units as 'default' one.
917      * In other words, when in metrics, typing '2+2in' will give 2 meters 2 inches, not 4 inches.
918      * I do think this is the desired behavior!
919      */
920     const bUnitCollection *usys_iter;
921     int system_iter;
922
923     for (system_iter = 0; system_iter < UNIT_SYSTEM_TOT; system_iter++) {
924       if (system_iter != system) {
925         usys_iter = unit_get_system(system_iter, type);
926         if (usys_iter) {
927           for (unit = usys_iter->units; unit->name; unit++) {
928             int ofs = 0;
929             /* in case there are multiple instances */
930             while (
931                 (ofs = unit_replace(str + ofs, len_max - ofs, str_tmp, scale_pref_base, unit))) {
932               changed = true;
933             }
934           }
935         }
936       }
937     }
938   }
939   unit = NULL;
940
941   /* replace # with add sign when there is no operator between it and the next number
942    *
943    * "1*1# 3*100# * 3"  ->  "1*1+ 3*100  * 3"
944    *
945    * */
946   {
947     char *str_found = str;
948     const char *ch = str;
949
950     while ((str_found = strchr(str_found, SEP_CHR))) {
951       bool op_found = false;
952
953       /* any operators after this? */
954       for (ch = str_found + 1; *ch != '\0'; ch++) {
955         if (*ch == ' ' || *ch == '\t') {
956           continue;
957         }
958         op_found = (ch_is_op(*ch) || ELEM(*ch, ',', ')'));
959         break;
960       }
961
962       /* If found an op, comma or closing parenthesis, no need to insert a '+', else we need it. */
963       *str_found++ = op_found ? ' ' : '+';
964     }
965   }
966
967   return changed;
968 }
969
970 /* 45µm --> 45um */
971 void bUnit_ToUnitAltName(char *str, int len_max, const char *orig_str, int system, int type)
972 {
973   const bUnitCollection *usys = unit_get_system(system, type);
974
975   const bUnitDef *unit;
976
977   /* find and substitute all units */
978   for (unit = usys->units; unit->name; unit++) {
979     if (len_max > 0 && unit->name_alt) {
980       const bool case_sensitive = (unit->flag & B_UNIT_DEF_CASE_SENSITIVE) != 0;
981       const char *found = unit_find_str(orig_str, unit->name_short, case_sensitive);
982       if (found) {
983         int offset = (int)(found - orig_str);
984         int len_name = 0;
985
986         /* copy everything before the unit */
987         offset = (offset < len_max ? offset : len_max);
988         strncpy(str, orig_str, offset);
989
990         str += offset;
991         orig_str += offset + strlen(unit->name_short);
992         len_max -= offset;
993
994         /* print the alt_name */
995         if (unit->name_alt) {
996           len_name = BLI_strncpy_rlen(str, unit->name_alt, len_max);
997         }
998         else {
999           len_name = 0;
1000         }
1001
1002         len_name = (len_name < len_max ? len_name : len_max);
1003         str += len_name;
1004         len_max -= len_name;
1005       }
1006     }
1007   }
1008
1009   /* finally copy the rest of the string */
1010   strncpy(str, orig_str, len_max);
1011 }
1012
1013 double bUnit_ClosestScalar(double value, int system, int type)
1014 {
1015   const bUnitCollection *usys = unit_get_system(system, type);
1016   const bUnitDef *unit;
1017
1018   if (usys == NULL) {
1019     return -1;
1020   }
1021
1022   unit = unit_best_fit(value, usys, NULL, 1);
1023   if (unit == NULL) {
1024     return -1;
1025   }
1026
1027   return unit->scalar;
1028 }
1029
1030 double bUnit_BaseScalar(int system, int type)
1031 {
1032   const bUnitCollection *usys = unit_get_system(system, type);
1033   if (usys) {
1034     return unit_default(usys)->scalar;
1035   }
1036   else {
1037     return 1.0;
1038   }
1039 }
1040
1041 /* external access */
1042 bool bUnit_IsValid(int system, int type)
1043 {
1044   return !(system < 0 || system > UNIT_SYSTEM_TOT || type < 0 || type > B_UNIT_TYPE_TOT);
1045 }
1046
1047 void bUnit_GetSystem(int system, int type, void const **r_usys_pt, int *r_len)
1048 {
1049   const bUnitCollection *usys = unit_get_system(system, type);
1050   *r_usys_pt = usys;
1051
1052   if (usys == NULL) {
1053     *r_len = 0;
1054     return;
1055   }
1056
1057   *r_len = usys->length;
1058 }
1059
1060 int bUnit_GetBaseUnit(const void *usys_pt)
1061 {
1062   return ((bUnitCollection *)usys_pt)->base_unit;
1063 }
1064
1065 int bUnit_GetBaseUnitOfType(int system, int type)
1066 {
1067   return unit_get_system(system, type)->base_unit;
1068 }
1069
1070 const char *bUnit_GetName(const void *usys_pt, int index)
1071 {
1072   return ((bUnitCollection *)usys_pt)->units[index].name;
1073 }
1074 const char *bUnit_GetNameDisplay(const void *usys_pt, int index)
1075 {
1076   return ((bUnitCollection *)usys_pt)->units[index].name_display;
1077 }
1078 const char *bUnit_GetIdentifier(const void *usys_pt, int index)
1079 {
1080   const bUnitDef *unit = ((const bUnitCollection *)usys_pt)->units + index;
1081   if (unit->identifier == NULL) {
1082     BLI_assert(false && "identifier for this unit is not specified yet");
1083   }
1084   return unit->identifier;
1085 }
1086
1087 double bUnit_GetScaler(const void *usys_pt, int index)
1088 {
1089   return ((bUnitCollection *)usys_pt)->units[index].scalar;
1090 }
1091
1092 bool bUnit_IsSuppressed(const void *usys_pt, int index)
1093 {
1094   return (((bUnitCollection *)usys_pt)->units[index].flag & B_UNIT_DEF_SUPPRESS) != 0;
1095 }