14d97dd883e1afd6227330427f91d16f96599c95
[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 "BLF_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                                 UI_but_flag_enable(but, UI_BUT_TEXTEDIT_UPDATE);
124                         }
125                         break;
126                 case PROP_POINTER:
127                 {
128                         PointerRNA pptr;
129
130                         pptr = RNA_property_pointer_get(ptr, prop);
131                         if (!pptr.type)
132                                 pptr.type = RNA_property_pointer_type(ptr, prop);
133                         icon = RNA_struct_ui_icon(pptr.type);
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(uiLayout *layout, PointerRNA *ptr,
161                      bool (*check_prop)(PointerRNA *, PropertyRNA *),
162                      const char label_align)
163 {
164         uiLayout *split, *col;
165         int flag;
166         const char *name;
167         int tot = 0;
168
169         assert(ELEM(label_align, '\0', 'H', 'V'));
170
171         RNA_STRUCT_BEGIN (ptr, prop)
172         {
173                 flag = RNA_property_flag(prop);
174                 if (flag & PROP_HIDDEN || (check_prop && check_prop(ptr, prop) == 0))
175                         continue;
176
177                 if (label_align != '\0') {
178                         PropertyType type = RNA_property_type(prop);
179                         const bool is_boolean = (type == PROP_BOOLEAN && !RNA_property_array_check(prop));
180
181                         name = RNA_property_ui_name(prop);
182
183                         if (label_align == 'V') {
184                                 col = uiLayoutColumn(layout, true);
185
186                                 if (!is_boolean)
187                                         uiItemL(col, name, ICON_NONE);
188                         }
189                         else {  /* (label_align == 'H') */
190                                 BLI_assert(label_align == 'H');
191                                 split = uiLayoutSplit(layout, 0.5f, false);
192
193                                 col = uiLayoutColumn(split, false);
194                                 uiItemL(col, (is_boolean) ? "" : name, ICON_NONE);
195                                 col = uiLayoutColumn(split, false);
196                         }
197
198                         /* may meed to add more cases here.
199                          * don't override enum flag names */
200
201                         /* name is shown above, empty name for button below */
202                         name = (flag & PROP_ENUM_FLAG || is_boolean) ? NULL : "";
203                 }
204                 else {
205                         col = layout;
206                         name = NULL; /* no smart label alignment, show default name with button */
207                 }
208
209                 uiItemFullR(col, ptr, prop, -1, 0, 0, name, ICON_NONE);
210                 tot++;
211         }
212         RNA_STRUCT_END;
213
214         return tot;
215 }
216
217 /***************************** ID Utilities *******************************/
218
219 int UI_icon_from_id(ID *id)
220 {
221         Object *ob;
222         PointerRNA ptr;
223         short idcode;
224
225         if (id == NULL)
226                 return ICON_NONE;
227         
228         idcode = GS(id->name);
229
230         /* exception for objects */
231         if (idcode == ID_OB) {
232                 ob = (Object *)id;
233
234                 if (ob->type == OB_EMPTY)
235                         return ICON_EMPTY_DATA;
236                 else
237                         return UI_icon_from_id(ob->data);
238         }
239
240         /* otherwise get it through RNA, creating the pointer
241          * will set the right type, also with subclassing */
242         RNA_id_pointer_create(id, &ptr);
243
244         return (ptr.type) ? RNA_struct_ui_icon(ptr.type) : ICON_NONE;
245 }
246
247 /* see: report_type_str */
248 int UI_icon_from_report_type(int type)
249 {
250         if (type & RPT_ERROR_ALL)
251                 return ICON_ERROR;
252         else if (type & RPT_WARNING_ALL)
253                 return ICON_ERROR;
254         else if (type & RPT_INFO_ALL)
255                 return ICON_INFO;
256         else
257                 return ICON_NONE;
258 }
259
260 /********************************** Misc **************************************/
261
262 /**
263  * Returns the best "UI" precision for given floating value, so that e.g. 10.000001 rather gets drawn as '10'...
264  */
265 int UI_calc_float_precision(int prec, double value)
266 {
267         static const double pow10_neg[UI_PRECISION_FLOAT_MAX + 1] = {1e0, 1e-1, 1e-2, 1e-3, 1e-4, 1e-5, 1e-6, 1e-7};
268         static const double max_pow = 10000000.0;  /* pow(10, UI_PRECISION_FLOAT_MAX) */
269
270         BLI_assert(prec <= UI_PRECISION_FLOAT_MAX);
271         BLI_assert(fabs(pow10_neg[prec] - pow(10, -prec)) < 1e-16);
272
273         /* check on the number of decimal places need to display the number, this is so 0.00001 is not displayed as 0.00,
274          * _but_, this is only for small values si 10.0001 will not get the same treatment.
275          */
276         value = ABS(value);
277         if ((value < pow10_neg[prec]) && (value > (1.0 / max_pow))) {
278                 int value_i = (int)((value * max_pow) + 0.5);
279                 if (value_i != 0) {
280                         const int prec_span = 3; /* show: 0.01001, 5 would allow 0.0100001 for eg. */
281                         int test_prec;
282                         int prec_min = -1;
283                         int dec_flag = 0;
284                         int i = UI_PRECISION_FLOAT_MAX;
285                         while (i && value_i) {
286                                 if (value_i % 10) {
287                                         dec_flag |= 1 << i;
288                                         prec_min = i;
289                                 }
290                                 value_i /= 10;
291                                 i--;
292                         }
293
294                         /* even though its a small value, if the second last digit is not 0, use it */
295                         test_prec = prec_min;
296
297                         dec_flag = (dec_flag >> (prec_min + 1)) & ((1 << prec_span) - 1);
298
299                         while (dec_flag) {
300                                 test_prec++;
301                                 dec_flag = dec_flag >> 1;
302                         }
303
304                         if (test_prec > prec) {
305                                 prec = test_prec;
306                         }
307                 }
308         }
309
310         CLAMP(prec, 0, UI_PRECISION_FLOAT_MAX);
311
312         return prec;
313 }
314
315 bool UI_but_online_manual_id(const uiBut *but, char *r_str, size_t maxlength)
316 {
317         if (but->rnapoin.id.data && but->rnapoin.data && but->rnaprop) {
318                 BLI_snprintf(r_str, maxlength, "%s.%s", RNA_struct_identifier(but->rnapoin.type),
319                              RNA_property_identifier(but->rnaprop));
320                 return true;
321         }
322         else if (but->optype) {
323                 WM_operator_py_idname(r_str, but->optype->idname);
324                 return true;
325         }
326
327         *r_str = '\0';
328         return false;
329 }
330
331 bool UI_but_online_manual_id_from_active(const struct bContext *C, char *r_str, size_t maxlength)
332 {
333         uiBut *but = UI_context_active_but_get(C);
334
335         if (but) {
336                 return UI_but_online_manual_id(but, r_str, maxlength);
337         }
338
339         *r_str = '\0';
340         return false;
341 }
342
343
344 /* -------------------------------------------------------------------- */
345 /* Modal Button Store API */
346
347 /** \name Button Store
348  *
349  * Store for modal operators & handlers to register button pointers
350  * which are maintained while drawing or NULL when removed.
351  *
352  * This is needed since button pointers are continuously freed and re-allocated.
353  *
354  * \{ */
355
356 struct uiButStore {
357         struct uiButStore *next, *prev;
358         uiBlock *block;
359         ListBase items;
360 };
361
362 struct uiButStoreElem {
363         struct uiButStoreElem *next, *prev;
364         uiBut **but_p;
365 };
366
367 /**
368  * Create a new button store, the caller must manage and run #UI_butstore_free
369  */
370 uiButStore *UI_butstore_create(uiBlock *block)
371 {
372         uiButStore *bs_handle = MEM_callocN(sizeof(uiButStore), __func__);
373
374         bs_handle->block = block;
375         BLI_addtail(&block->butstore, bs_handle);
376
377         return bs_handle;
378 }
379
380 void UI_butstore_free(uiBlock *block, uiButStore *bs_handle)
381 {
382         BLI_freelistN(&bs_handle->items);
383         BLI_remlink(&block->butstore, bs_handle);
384
385         MEM_freeN(bs_handle);
386 }
387
388 bool UI_butstore_is_valid(uiButStore *bs)
389 {
390         return (bs->block != NULL);
391 }
392
393 bool UI_butstore_is_registered(uiBlock *block, uiBut *but)
394 {
395         uiButStore *bs_handle;
396
397         for (bs_handle = block->butstore.first; bs_handle; bs_handle = bs_handle->next) {
398                 uiButStoreElem *bs_elem;
399
400                 for (bs_elem = bs_handle->items.first; bs_elem; bs_elem = bs_elem->next) {
401                         if (*bs_elem->but_p == but) {
402                                 return true;
403                         }
404                 }
405         }
406
407         return false;
408 }
409
410 void UI_butstore_register(uiButStore *bs_handle, uiBut **but_p)
411 {
412         uiButStoreElem *bs_elem = MEM_callocN(sizeof(uiButStoreElem), __func__);
413         BLI_assert(*but_p);
414         bs_elem->but_p = but_p;
415
416         BLI_addtail(&bs_handle->items, bs_elem);
417
418 }
419
420 void UI_butstore_unregister(uiButStore *bs_handle, uiBut **but_p)
421 {
422         uiButStoreElem *bs_elem, *bs_elem_next;
423
424         for (bs_elem = bs_handle->items.first; bs_elem; bs_elem = bs_elem_next) {
425                 bs_elem_next = bs_elem->next;
426                 if (bs_elem->but_p == but_p) {
427                         BLI_remlink(&bs_handle->items, bs_elem);
428                         MEM_freeN(bs_elem);
429                 }
430         }
431
432         BLI_assert(0);
433 }
434
435 /**
436  * Update the pointer for a registered button.
437  */
438 bool UI_butstore_register_update(uiBlock *block, uiBut *but_dst, const uiBut *but_src)
439 {
440         uiButStore *bs_handle;
441         bool found = false;
442
443         for (bs_handle = block->butstore.first; bs_handle; bs_handle = bs_handle->next) {
444                 uiButStoreElem *bs_elem;
445                 for (bs_elem = bs_handle->items.first; bs_elem; bs_elem = bs_elem->next) {
446                         if (*bs_elem->but_p == but_src) {
447                                 *bs_elem->but_p = but_dst;
448                                 found = true;
449                         }
450                 }
451         }
452
453         return found;
454 }
455
456 /**
457  * NULL all pointers, don't free since the owner needs to be able to inspect.
458  */
459 void UI_butstore_clear(uiBlock *block)
460 {
461         uiButStore *bs_handle;
462
463         for (bs_handle = block->butstore.first; bs_handle; bs_handle = bs_handle->next) {
464                 uiButStoreElem *bs_elem;
465
466                 bs_handle->block = NULL;
467
468                 for (bs_elem = bs_handle->items.first; bs_elem; bs_elem = bs_elem->next) {
469                         *bs_elem->but_p = NULL;
470                 }
471         }
472 }
473
474 /**
475  * Map freed buttons from the old block and update pointers.
476  */
477 void UI_butstore_update(uiBlock *block)
478 {
479         uiButStore *bs_handle;
480
481         /* move this list to the new block */
482         if (block->oldblock) {
483                 if (block->oldblock->butstore.first) {
484                         block->butstore = block->oldblock->butstore;
485                         BLI_listbase_clear(&block->oldblock->butstore);
486                 }
487         }
488
489         if (LIKELY(block->butstore.first == NULL))
490                 return;
491
492         /* warning, loop-in-loop, in practice we only store <10 buttons at a time,
493          * so this isn't going to be a problem, if that changes old-new mapping can be cached first */
494         for (bs_handle = block->butstore.first; bs_handle; bs_handle = bs_handle->next) {
495
496                 BLI_assert((bs_handle->block == NULL) ||
497                            (bs_handle->block == block) ||
498                            (block->oldblock && block->oldblock == bs_handle->block));
499
500                 if (bs_handle->block == block->oldblock) {
501                         uiButStoreElem *bs_elem;
502
503                         bs_handle->block = block;
504
505                         for (bs_elem = bs_handle->items.first; bs_elem; bs_elem = bs_elem->next) {
506                                 if (*bs_elem->but_p) {
507                                         uiBut *but_new = ui_but_find_new(block, *bs_elem->but_p);
508
509                                         /* can be NULL if the buttons removed,
510                                          * note: we could allow passing in a callback when buttons are removed
511                                          * so the caller can cleanup */
512                                         *bs_elem->but_p = but_new;
513                                 }
514                         }
515                 }
516         }
517 }
518
519 /** \} */