28aecc14035980b2dfcf330f4e5ad34997fa85c6
[blender.git] / source / blender / editors / interface / interface_utils.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/editors/interface/interface_utils.c
27  *  \ingroup edinterface
28  */
29
30
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <string.h>
34 #include <assert.h>
35
36 #include "DNA_object_types.h"
37 #include "DNA_screen_types.h"
38
39 #include "BLI_utildefines.h"
40 #include "BLI_math.h"
41 #include "BLI_string.h"
42 #include "BLI_listbase.h"
43
44 #include "BLT_translation.h"
45
46 #include "BKE_report.h"
47
48 #include "MEM_guardedalloc.h"
49
50 #include "RNA_access.h"
51
52 #include "UI_interface.h"
53 #include "UI_resources.h"
54
55 #include "WM_api.h"
56 #include "WM_types.h"
57
58 #include "interface_intern.h"
59
60
61 /*************************** RNA Utilities ******************************/
62
63 uiBut *uiDefAutoButR(uiBlock *block, PointerRNA *ptr, PropertyRNA *prop, int index, const char *name, int icon, int x1, int y1, int x2, int y2)
64 {
65         uiBut *but = NULL;
66
67         switch (RNA_property_type(prop)) {
68                 case PROP_BOOLEAN:
69                 {
70                         int arraylen = RNA_property_array_length(ptr, prop);
71
72                         if (arraylen && index == -1)
73                                 return NULL;
74
75                         if (icon && name && name[0] == '\0')
76                                 but = uiDefIconButR_prop(block, UI_BTYPE_ICON_TOGGLE, 0, icon, x1, y1, x2, y2, ptr, prop, index, 0, 0, -1, -1, NULL);
77                         else if (icon)
78                                 but = uiDefIconTextButR_prop(block, UI_BTYPE_ICON_TOGGLE, 0, icon, name, x1, y1, x2, y2, ptr, prop, index, 0, 0, -1, -1, NULL);
79                         else
80                                 but = uiDefButR_prop(block, UI_BTYPE_CHECKBOX, 0, name, x1, y1, x2, y2, ptr, prop, index, 0, 0, -1, -1, NULL);
81                         break;
82                 }
83                 case PROP_INT:
84                 case PROP_FLOAT:
85                 {
86                         int arraylen = RNA_property_array_length(ptr, prop);
87
88                         if (arraylen && index == -1) {
89                                 if (ELEM(RNA_property_subtype(prop), PROP_COLOR, PROP_COLOR_GAMMA)) {
90                                         but = uiDefButR_prop(block, UI_BTYPE_COLOR, 0, name, x1, y1, x2, y2, ptr, prop, -1, 0, 0, -1, -1, NULL);
91                                 }
92                                 else {
93                                         return NULL;
94                                 }
95                         }
96                         else if (RNA_property_subtype(prop) == PROP_PERCENTAGE || RNA_property_subtype(prop) == PROP_FACTOR)
97                                 but = uiDefButR_prop(block, UI_BTYPE_NUM_SLIDER, 0, name, x1, y1, x2, y2, ptr, prop, index, 0, 0, -1, -1, NULL);
98                         else
99                                 but = uiDefButR_prop(block, UI_BTYPE_NUM, 0, name, x1, y1, x2, y2, ptr, prop, index, 0, 0, -1, -1, NULL);
100
101                         if (RNA_property_flag(prop) & PROP_TEXTEDIT_UPDATE) {
102                                 UI_but_flag_enable(but, UI_BUT_TEXTEDIT_UPDATE);
103                         }
104                         break;
105                 }
106                 case PROP_ENUM:
107                         if (icon && name && name[0] == '\0')
108                                 but = uiDefIconButR_prop(block, UI_BTYPE_MENU, 0, icon, x1, y1, x2, y2, ptr, prop, index, 0, 0, -1, -1, NULL);
109                         else if (icon)
110                                 but = uiDefIconTextButR_prop(block, UI_BTYPE_MENU, 0, icon, NULL, x1, y1, x2, y2, ptr, prop, index, 0, 0, -1, -1, NULL);
111                         else
112                                 but = uiDefButR_prop(block, UI_BTYPE_MENU, 0, name, x1, y1, x2, y2, ptr, prop, index, 0, 0, -1, -1, NULL);
113                         break;
114                 case PROP_STRING:
115                         if (icon && name && name[0] == '\0')
116                                 but = uiDefIconButR_prop(block, UI_BTYPE_TEXT, 0, icon, x1, y1, x2, y2, ptr, prop, index, 0, 0, -1, -1, NULL);
117                         else if (icon)
118                                 but = uiDefIconTextButR_prop(block, UI_BTYPE_TEXT, 0, icon, name, x1, y1, x2, y2, ptr, prop, index, 0, 0, -1, -1, NULL);
119                         else
120                                 but = uiDefButR_prop(block, UI_BTYPE_TEXT, 0, name, x1, y1, x2, y2, ptr, prop, index, 0, 0, -1, -1, NULL);
121
122                         if (RNA_property_flag(prop) & PROP_TEXTEDIT_UPDATE) {
123                                 /* TEXTEDIT_UPDATE is usally used for search buttons. For these we also want
124                                  * the 'x' icon to clear search string, so setting VALUE_CLEAR flag, too. */
125                                 UI_but_flag_enable(but, UI_BUT_TEXTEDIT_UPDATE | UI_BUT_VALUE_CLEAR);
126                         }
127                         break;
128                 case PROP_POINTER:
129                 {
130                         if (icon == 0) {
131                                 PointerRNA pptr = RNA_property_pointer_get(ptr, prop);
132                                 icon = RNA_struct_ui_icon(pptr.type ? pptr.type : RNA_property_pointer_type(ptr, prop));
133                         }
134                         if (icon == ICON_DOT)
135                                 icon = 0;
136
137                         but = uiDefIconTextButR_prop(block, UI_BTYPE_SEARCH_MENU, 0, icon, name, x1, y1, x2, y2, ptr, prop, index, 0, 0, -1, -1, NULL);
138                         break;
139                 }
140                 case PROP_COLLECTION:
141                 {
142                         char text[256];
143                         BLI_snprintf(text, sizeof(text), IFACE_("%d items"), RNA_property_collection_length(ptr, prop));
144                         but = uiDefBut(block, UI_BTYPE_LABEL, 0, text, x1, y1, x2, y2, NULL, 0, 0, 0, 0, NULL);
145                         UI_but_flag_enable(but, UI_BUT_DISABLED);
146                         break;
147                 }
148                 default:
149                         but = NULL;
150                         break;
151         }
152
153         return but;
154 }
155
156 /**
157  * \a check_prop callback filters functions to avoid drawing certain properties,
158  * in cases where PROP_HIDDEN flag can't be used for a property.
159  */
160 int uiDefAutoButsRNA(
161         uiLayout *layout, PointerRNA *ptr,
162         bool (*check_prop)(PointerRNA *, PropertyRNA *),
163         const char label_align)
164 {
165         uiLayout *split, *col;
166         int flag;
167         const char *name;
168         int tot = 0;
169
170         assert(ELEM(label_align, '\0', 'H', 'V'));
171
172         RNA_STRUCT_BEGIN (ptr, prop)
173         {
174                 flag = RNA_property_flag(prop);
175                 if (flag & PROP_HIDDEN || (check_prop && check_prop(ptr, prop) == 0))
176                         continue;
177
178                 if (label_align != '\0') {
179                         PropertyType type = RNA_property_type(prop);
180                         const bool is_boolean = (type == PROP_BOOLEAN && !RNA_property_array_check(prop));
181
182                         name = RNA_property_ui_name(prop);
183
184                         if (label_align == 'V') {
185                                 col = uiLayoutColumn(layout, true);
186
187                                 if (!is_boolean)
188                                         uiItemL(col, name, ICON_NONE);
189                         }
190                         else {  /* (label_align == 'H') */
191                                 BLI_assert(label_align == 'H');
192                                 split = uiLayoutSplit(layout, 0.5f, false);
193
194                                 col = uiLayoutColumn(split, false);
195                                 uiItemL(col, (is_boolean) ? "" : name, ICON_NONE);
196                                 col = uiLayoutColumn(split, false);
197                         }
198
199                         /* may meed to add more cases here.
200                          * don't override enum flag names */
201
202                         /* name is shown above, empty name for button below */
203                         name = (flag & PROP_ENUM_FLAG || is_boolean) ? NULL : "";
204                 }
205                 else {
206                         col = layout;
207                         name = NULL; /* no smart label alignment, show default name with button */
208                 }
209
210                 uiItemFullR(col, ptr, prop, -1, 0, 0, name, ICON_NONE);
211                 tot++;
212         }
213         RNA_STRUCT_END;
214
215         return tot;
216 }
217
218 /***************************** ID Utilities *******************************/
219
220 int UI_icon_from_id(ID *id)
221 {
222         Object *ob;
223         PointerRNA ptr;
224         short idcode;
225
226         if (id == NULL)
227                 return ICON_NONE;
228
229         idcode = GS(id->name);
230
231         /* exception for objects */
232         if (idcode == ID_OB) {
233                 ob = (Object *)id;
234
235                 if (ob->type == OB_EMPTY)
236                         return ICON_EMPTY_DATA;
237                 else
238                         return UI_icon_from_id(ob->data);
239         }
240
241         /* otherwise get it through RNA, creating the pointer
242          * will set the right type, also with subclassing */
243         RNA_id_pointer_create(id, &ptr);
244
245         return (ptr.type) ? RNA_struct_ui_icon(ptr.type) : ICON_NONE;
246 }
247
248 /* see: report_type_str */
249 int UI_icon_from_report_type(int type)
250 {
251         if (type & RPT_ERROR_ALL)
252                 return ICON_ERROR;
253         else if (type & RPT_WARNING_ALL)
254                 return ICON_ERROR;
255         else if (type & RPT_INFO_ALL)
256                 return ICON_INFO;
257         else
258                 return ICON_NONE;
259 }
260
261 /********************************** Misc **************************************/
262
263 /**
264  * Returns the best "UI" precision for given floating value, so that e.g. 10.000001 rather gets drawn as '10'...
265  */
266 int UI_calc_float_precision(int prec, double value)
267 {
268         static const double pow10_neg[UI_PRECISION_FLOAT_MAX + 1] = {1e0, 1e-1, 1e-2, 1e-3, 1e-4, 1e-5, 1e-6};
269         static const double max_pow = 10000000.0;  /* pow(10, UI_PRECISION_FLOAT_MAX) */
270
271         BLI_assert(prec <= UI_PRECISION_FLOAT_MAX);
272         BLI_assert(fabs(pow10_neg[prec] - pow(10, -prec)) < 1e-16);
273
274         /* check on the number of decimal places need to display the number, this is so 0.00001 is not displayed as 0.00,
275          * _but_, this is only for small values si 10.0001 will not get the same treatment.
276          */
277         value = ABS(value);
278         if ((value < pow10_neg[prec]) && (value > (1.0 / max_pow))) {
279                 int value_i = (int)((value * max_pow) + 0.5);
280                 if (value_i != 0) {
281                         const int prec_span = 3; /* show: 0.01001, 5 would allow 0.0100001 for eg. */
282                         int test_prec;
283                         int prec_min = -1;
284                         int dec_flag = 0;
285                         int i = UI_PRECISION_FLOAT_MAX;
286                         while (i && value_i) {
287                                 if (value_i % 10) {
288                                         dec_flag |= 1 << i;
289                                         prec_min = i;
290                                 }
291                                 value_i /= 10;
292                                 i--;
293                         }
294
295                         /* even though its a small value, if the second last digit is not 0, use it */
296                         test_prec = prec_min;
297
298                         dec_flag = (dec_flag >> (prec_min + 1)) & ((1 << prec_span) - 1);
299
300                         while (dec_flag) {
301                                 test_prec++;
302                                 dec_flag = dec_flag >> 1;
303                         }
304
305                         if (test_prec > prec) {
306                                 prec = test_prec;
307                         }
308                 }
309         }
310
311         CLAMP(prec, 0, UI_PRECISION_FLOAT_MAX);
312
313         return prec;
314 }
315
316 bool UI_but_online_manual_id(const uiBut *but, char *r_str, size_t maxlength)
317 {
318         if (but->rnapoin.id.data && but->rnapoin.data && but->rnaprop) {
319                 BLI_snprintf(r_str, maxlength, "%s.%s", RNA_struct_identifier(but->rnapoin.type),
320                              RNA_property_identifier(but->rnaprop));
321                 return true;
322         }
323         else if (but->optype) {
324                 WM_operator_py_idname(r_str, but->optype->idname);
325                 return true;
326         }
327
328         *r_str = '\0';
329         return false;
330 }
331
332 bool UI_but_online_manual_id_from_active(const struct bContext *C, char *r_str, size_t maxlength)
333 {
334         uiBut *but = UI_context_active_but_get(C);
335
336         if (but) {
337                 return UI_but_online_manual_id(but, r_str, maxlength);
338         }
339
340         *r_str = '\0';
341         return false;
342 }
343
344
345 /* -------------------------------------------------------------------- */
346 /* Modal Button Store API */
347
348 /** \name Button Store
349  *
350  * Store for modal operators & handlers to register button pointers
351  * which are maintained while drawing or NULL when removed.
352  *
353  * This is needed since button pointers are continuously freed and re-allocated.
354  *
355  * \{ */
356
357 struct uiButStore {
358         struct uiButStore *next, *prev;
359         uiBlock *block;
360         ListBase items;
361 };
362
363 struct uiButStoreElem {
364         struct uiButStoreElem *next, *prev;
365         uiBut **but_p;
366 };
367
368 /**
369  * Create a new button store, the caller must manage and run #UI_butstore_free
370  */
371 uiButStore *UI_butstore_create(uiBlock *block)
372 {
373         uiButStore *bs_handle = MEM_callocN(sizeof(uiButStore), __func__);
374
375         bs_handle->block = block;
376         BLI_addtail(&block->butstore, bs_handle);
377
378         return bs_handle;
379 }
380
381 void UI_butstore_free(uiBlock *block, uiButStore *bs_handle)
382 {
383         /* Workaround for button store being moved into new block,
384          * which then can't use the previous buttons state ('ui_but_update_from_old_block' fails to find a match),
385          * keeping the active button in the old block holding a reference to the button-state in the new block: see T49034.
386          *
387          * Ideally we would manage moving the 'uiButStore', keeping a correct state.
388          * All things considered this is the most straightforward fix - Campbell.
389          */
390         if (block != bs_handle->block && bs_handle->block != NULL) {
391                 block = bs_handle->block;
392         }
393
394         BLI_freelistN(&bs_handle->items);
395         BLI_remlink(&block->butstore, bs_handle);
396
397         MEM_freeN(bs_handle);
398 }
399
400 bool UI_butstore_is_valid(uiButStore *bs)
401 {
402         return (bs->block != NULL);
403 }
404
405 bool UI_butstore_is_registered(uiBlock *block, uiBut *but)
406 {
407         uiButStore *bs_handle;
408
409         for (bs_handle = block->butstore.first; bs_handle; bs_handle = bs_handle->next) {
410                 uiButStoreElem *bs_elem;
411
412                 for (bs_elem = bs_handle->items.first; bs_elem; bs_elem = bs_elem->next) {
413                         if (*bs_elem->but_p == but) {
414                                 return true;
415                         }
416                 }
417         }
418
419         return false;
420 }
421
422 void UI_butstore_register(uiButStore *bs_handle, uiBut **but_p)
423 {
424         uiButStoreElem *bs_elem = MEM_callocN(sizeof(uiButStoreElem), __func__);
425         BLI_assert(*but_p);
426         bs_elem->but_p = but_p;
427
428         BLI_addtail(&bs_handle->items, bs_elem);
429
430 }
431
432 void UI_butstore_unregister(uiButStore *bs_handle, uiBut **but_p)
433 {
434         uiButStoreElem *bs_elem, *bs_elem_next;
435
436         for (bs_elem = bs_handle->items.first; bs_elem; bs_elem = bs_elem_next) {
437                 bs_elem_next = bs_elem->next;
438                 if (bs_elem->but_p == but_p) {
439                         BLI_remlink(&bs_handle->items, bs_elem);
440                         MEM_freeN(bs_elem);
441                 }
442         }
443
444         BLI_assert(0);
445 }
446
447 /**
448  * Update the pointer for a registered button.
449  */
450 bool UI_butstore_register_update(uiBlock *block, uiBut *but_dst, const uiBut *but_src)
451 {
452         uiButStore *bs_handle;
453         bool found = false;
454
455         for (bs_handle = block->butstore.first; bs_handle; bs_handle = bs_handle->next) {
456                 uiButStoreElem *bs_elem;
457                 for (bs_elem = bs_handle->items.first; bs_elem; bs_elem = bs_elem->next) {
458                         if (*bs_elem->but_p == but_src) {
459                                 *bs_elem->but_p = but_dst;
460                                 found = true;
461                         }
462                 }
463         }
464
465         return found;
466 }
467
468 /**
469  * NULL all pointers, don't free since the owner needs to be able to inspect.
470  */
471 void UI_butstore_clear(uiBlock *block)
472 {
473         uiButStore *bs_handle;
474
475         for (bs_handle = block->butstore.first; bs_handle; bs_handle = bs_handle->next) {
476                 uiButStoreElem *bs_elem;
477
478                 bs_handle->block = NULL;
479
480                 for (bs_elem = bs_handle->items.first; bs_elem; bs_elem = bs_elem->next) {
481                         *bs_elem->but_p = NULL;
482                 }
483         }
484 }
485
486 /**
487  * Map freed buttons from the old block and update pointers.
488  */
489 void UI_butstore_update(uiBlock *block)
490 {
491         uiButStore *bs_handle;
492
493         /* move this list to the new block */
494         if (block->oldblock) {
495                 if (block->oldblock->butstore.first) {
496                         block->butstore = block->oldblock->butstore;
497                         BLI_listbase_clear(&block->oldblock->butstore);
498                 }
499         }
500
501         if (LIKELY(block->butstore.first == NULL))
502                 return;
503
504         /* warning, loop-in-loop, in practice we only store <10 buttons at a time,
505          * so this isn't going to be a problem, if that changes old-new mapping can be cached first */
506         for (bs_handle = block->butstore.first; bs_handle; bs_handle = bs_handle->next) {
507
508                 BLI_assert((bs_handle->block == NULL) ||
509                            (bs_handle->block == block) ||
510                            (block->oldblock && block->oldblock == bs_handle->block));
511
512                 if (bs_handle->block == block->oldblock) {
513                         uiButStoreElem *bs_elem;
514
515                         bs_handle->block = block;
516
517                         for (bs_elem = bs_handle->items.first; bs_elem; bs_elem = bs_elem->next) {
518                                 if (*bs_elem->but_p) {
519                                         uiBut *but_new = ui_but_find_new(block, *bs_elem->but_p);
520
521                                         /* can be NULL if the buttons removed,
522                                          * note: we could allow passing in a callback when buttons are removed
523                                          * so the caller can cleanup */
524                                         *bs_elem->but_p = but_new;
525                                 }
526                         }
527                 }
528         }
529 }
530
531 /** \} */