Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / interface / interface.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation 2002-2008, full recode.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/editors/interface/interface.c
27  *  \ingroup edinterface
28  */
29
30
31 #include <float.h>
32 #include <limits.h>
33 #include <math.h>
34 #include <string.h>
35 #include <ctype.h>
36 #include <stddef.h>  /* offsetof() */
37
38 #include "MEM_guardedalloc.h"
39
40 #include "DNA_object_types.h"
41 #include "DNA_scene_types.h"
42 #include "DNA_screen_types.h"
43 #include "DNA_userdef_types.h"
44 #include "DNA_workspace_types.h"
45
46 #include "BLI_math.h"
47 #include "BLI_listbase.h"
48 #include "BLI_string.h"
49 #include "BLI_string_utf8.h"
50 #include "BLI_rect.h"
51
52 #include "BLI_utildefines.h"
53
54 #include "BKE_animsys.h"
55 #include "BKE_context.h"
56 #include "BKE_idprop.h"
57 #include "BKE_main.h"
58 #include "BKE_scene.h"
59 #include "BKE_screen.h"
60 #include "BKE_unit.h"
61
62 #include "GPU_glew.h"
63 #include "GPU_matrix.h"
64 #include "GPU_state.h"
65
66 #include "BLF_api.h"
67 #include "BLT_translation.h"
68
69 #include "UI_interface.h"
70 #include "UI_interface_icons.h"
71
72 #include "IMB_imbuf.h"
73
74 #include "WM_api.h"
75 #include "WM_types.h"
76 #include "WM_message.h"
77
78 #include "RNA_access.h"
79
80 #include "BPY_extern.h"
81
82 #include "ED_screen.h"
83
84 #include "IMB_colormanagement.h"
85
86 #include "DEG_depsgraph_query.h"
87
88 #include "interface_intern.h"
89
90 /* prototypes. */
91 static void ui_but_to_pixelrect(struct rcti *rect, const struct ARegion *ar, struct uiBlock *block, struct uiBut *but);
92
93 /* avoid unneeded calls to ui_but_value_get */
94 #define UI_BUT_VALUE_UNSET DBL_MAX
95 #define UI_GET_BUT_VALUE_INIT(_but, _value) if (_value == DBL_MAX) {  (_value) = ui_but_value_get(_but); } (void)0
96
97 #define B_NOP -1
98
99 /**
100  * a full doc with API notes can be found in 'blender/doc/guides/interface_API.txt'
101  *
102  * `uiBlahBlah()`       external function.
103  * `ui_blah_blah()`     internal function.
104  */
105
106 static void ui_but_free(const bContext *C, uiBut *but);
107
108 static bool ui_but_is_unit_radians_ex(UnitSettings *unit, const int unit_type)
109 {
110         return (unit->system_rotation == USER_UNIT_ROT_RADIANS && unit_type == PROP_UNIT_ROTATION);
111 }
112
113 static bool ui_but_is_unit_radians(const uiBut *but)
114 {
115         UnitSettings *unit = but->block->unit;
116         const int unit_type = UI_but_unit_type_get(but);
117
118         return ui_but_is_unit_radians_ex(unit, unit_type);
119 }
120
121 /* ************* window matrix ************** */
122
123 void ui_block_to_window_fl(const ARegion *ar, uiBlock *block, float *x, float *y)
124 {
125         float gx, gy;
126         int sx, sy, getsizex, getsizey;
127
128         getsizex = BLI_rcti_size_x(&ar->winrct) + 1;
129         getsizey = BLI_rcti_size_y(&ar->winrct) + 1;
130         sx = ar->winrct.xmin;
131         sy = ar->winrct.ymin;
132
133         gx = *x;
134         gy = *y;
135
136         if (block->panel) {
137                 gx += block->panel->ofsx;
138                 gy += block->panel->ofsy;
139         }
140
141         *x = ((float)sx) + ((float)getsizex) * (0.5f + 0.5f * (gx * block->winmat[0][0] + gy * block->winmat[1][0] + block->winmat[3][0]));
142         *y = ((float)sy) + ((float)getsizey) * (0.5f + 0.5f * (gx * block->winmat[0][1] + gy * block->winmat[1][1] + block->winmat[3][1]));
143 }
144
145 void ui_block_to_window(const ARegion *ar, uiBlock *block, int *x, int *y)
146 {
147         float fx, fy;
148
149         fx = *x;
150         fy = *y;
151
152         ui_block_to_window_fl(ar, block, &fx, &fy);
153
154         *x = (int)(fx + 0.5f);
155         *y = (int)(fy + 0.5f);
156 }
157
158 void ui_block_to_window_rctf(const ARegion *ar, uiBlock *block, rctf *rct_dst, const rctf *rct_src)
159 {
160         *rct_dst = *rct_src;
161         ui_block_to_window_fl(ar, block, &rct_dst->xmin, &rct_dst->ymin);
162         ui_block_to_window_fl(ar, block, &rct_dst->xmax, &rct_dst->ymax);
163 }
164
165 void ui_window_to_block_fl(const ARegion *ar, uiBlock *block, float *x, float *y)   /* for mouse cursor */
166 {
167         float a, b, c, d, e, f, px, py;
168         int sx, sy, getsizex, getsizey;
169
170         getsizex = BLI_rcti_size_x(&ar->winrct) + 1;
171         getsizey = BLI_rcti_size_y(&ar->winrct) + 1;
172         sx = ar->winrct.xmin;
173         sy = ar->winrct.ymin;
174
175         a = 0.5f * ((float)getsizex) * block->winmat[0][0];
176         b = 0.5f * ((float)getsizex) * block->winmat[1][0];
177         c = 0.5f * ((float)getsizex) * (1.0f + block->winmat[3][0]);
178
179         d = 0.5f * ((float)getsizey) * block->winmat[0][1];
180         e = 0.5f * ((float)getsizey) * block->winmat[1][1];
181         f = 0.5f * ((float)getsizey) * (1.0f + block->winmat[3][1]);
182
183         px = *x - sx;
184         py = *y - sy;
185
186         *y =  (a * (py - f) + d * (c - px)) / (a * e - d * b);
187         *x = (px - b * (*y) - c) / a;
188
189         if (block->panel) {
190                 *x -= block->panel->ofsx;
191                 *y -= block->panel->ofsy;
192         }
193 }
194
195 void ui_window_to_block(const ARegion *ar, uiBlock *block, int *x, int *y)
196 {
197         float fx, fy;
198
199         fx = *x;
200         fy = *y;
201
202         ui_window_to_block_fl(ar, block, &fx, &fy);
203
204         *x = (int)(fx + 0.5f);
205         *y = (int)(fy + 0.5f);
206 }
207
208 void ui_window_to_region(const ARegion *ar, int *x, int *y)
209 {
210         *x -= ar->winrct.xmin;
211         *y -= ar->winrct.ymin;
212 }
213
214 void ui_region_to_window(const ARegion *ar, int *x, int *y)
215 {
216         *x += ar->winrct.xmin;
217         *y += ar->winrct.ymin;
218 }
219
220 static void ui_update_flexible_spacing(const ARegion *region, uiBlock *block)
221 {
222         int sepr_flex_len = 0;
223         for (uiBut *but = block->buttons.first; but; but = but->next) {
224                 if (but->type == UI_BTYPE_SEPR_SPACER) {
225                         sepr_flex_len++;
226                 }
227         }
228
229         if (sepr_flex_len == 0) {
230                 return;
231         }
232
233         rcti rect;
234         ui_but_to_pixelrect(&rect, region, block, block->buttons.last);
235         const float buttons_width = (float)rect.xmax + UI_HEADER_OFFSET;
236         const float region_width = (float)region->sizex * U.dpi_fac;
237
238         if (region_width <= buttons_width) {
239                 return;
240         }
241
242         /* We could get rid of this loop if we agree on a max number of spacer */
243         int *spacers_pos = alloca(sizeof(*spacers_pos) * (size_t)sepr_flex_len);
244         int i = 0;
245         for (uiBut *but = block->buttons.first; but; but = but->next) {
246                 if (but->type == UI_BTYPE_SEPR_SPACER) {
247                         ui_but_to_pixelrect(&rect, region, block, but);
248                         spacers_pos[i] = rect.xmax + UI_HEADER_OFFSET;
249                         i++;
250                 }
251         }
252
253         const float segment_width = region_width / (float)sepr_flex_len;
254         float offset = 0, remaining_space = region_width - buttons_width;
255         i = 0;
256         for (uiBut *but = block->buttons.first; but; but = but->next) {
257                 BLI_rctf_translate(&but->rect, offset, 0);
258                 if (but->type == UI_BTYPE_SEPR_SPACER) {
259                         /* How much the next block overlap with the current segment */
260                         int overlap = (
261                                 (i == sepr_flex_len - 1) ?
262                                 buttons_width - spacers_pos[i] :
263                                 (spacers_pos[i + 1] - spacers_pos[i]) / 2);
264                         int segment_end = segment_width * (i + 1);
265                         int spacer_end = segment_end - overlap;
266                         int spacer_sta = spacers_pos[i] + offset;
267                         if (spacer_end > spacer_sta) {
268                                 float step = min_ff(remaining_space, spacer_end - spacer_sta);
269                                 remaining_space -= step;
270                                 offset += step;
271                         }
272                         i++;
273                 }
274         }
275         ui_block_bounds_calc(block);
276 }
277
278 static void ui_update_window_matrix(const wmWindow *window, const ARegion *region, uiBlock *block)
279 {
280         /* window matrix and aspect */
281         if (region && region->visible) {
282                 /* Get projection matrix which includes View2D translation and zoom. */
283                 gpuGetProjectionMatrix(block->winmat);
284                 block->aspect = 2.0f / fabsf(region->winx * block->winmat[0][0]);
285         }
286         else {
287                 /* No subwindow created yet, for menus for example, so we use the main
288                  * window instead, since buttons are created there anyway. */
289                 int width = WM_window_pixels_x(window);
290                 int height = WM_window_pixels_y(window);
291                 rcti winrct = {0, width - 1, 0, height - 1};
292
293                 wmGetProjectionMatrix(block->winmat, &winrct);
294                 block->aspect = 2.0f / fabsf(width * block->winmat[0][0]);
295         }
296 }
297
298 /**
299  * Popups will add a margin to #ARegion.winrct for shadow,
300  * for interactivity (point-inside tests for eg), we want the winrct without the margin added.
301  */
302 void ui_region_winrct_get_no_margin(const struct ARegion *ar, struct rcti *r_rect)
303 {
304         uiBlock *block = ar->uiblocks.first;
305         if (block && (block->flag & UI_BLOCK_LOOP) && (block->flag & UI_BLOCK_RADIAL) == 0) {
306                 BLI_rcti_rctf_copy_floor(r_rect, &block->rect);
307                 BLI_rcti_translate(r_rect, ar->winrct.xmin, ar->winrct.ymin);
308         }
309         else {
310                 *r_rect = ar->winrct;
311         }
312 }
313
314 /* ******************* block calc ************************* */
315
316 void UI_block_translate(uiBlock *block, int x, int y)
317 {
318         uiBut *but;
319
320         for (but = block->buttons.first; but; but = but->next) {
321                 BLI_rctf_translate(&but->rect, x, y);
322         }
323
324         BLI_rctf_translate(&block->rect, x, y);
325 }
326
327 static void ui_block_bounds_calc_text(uiBlock *block, float offset)
328 {
329         uiStyle *style = UI_style_get();
330         uiBut *bt, *init_col_bt, *col_bt;
331         int i = 0, j, x1addval = offset;
332
333         UI_fontstyle_set(&style->widget);
334
335         for (init_col_bt = bt = block->buttons.first; bt; bt = bt->next) {
336                 if (!ELEM(bt->type, UI_BTYPE_SEPR, UI_BTYPE_SEPR_LINE, UI_BTYPE_SEPR_SPACER)) {
337                         j = BLF_width(style->widget.uifont_id, bt->drawstr, sizeof(bt->drawstr));
338
339                         if (j > i)
340                                 i = j;
341                 }
342
343                 if (bt->next && bt->rect.xmin < bt->next->rect.xmin) {
344                         /* End of this column, and it's not the last one. */
345                         for (col_bt = init_col_bt; col_bt->prev != bt; col_bt = col_bt->next) {
346                                 col_bt->rect.xmin = x1addval;
347                                 col_bt->rect.xmax = x1addval + i + block->bounds;
348
349                                 ui_but_update(col_bt);  /* clips text again */
350                         }
351
352                         /* And we prepare next column. */
353                         x1addval += i + block->bounds;
354                         i = 0;
355                         init_col_bt = col_bt;
356                 }
357         }
358
359         /* Last column. */
360         for (col_bt = init_col_bt; col_bt; col_bt = col_bt->next) {
361                 col_bt->rect.xmin = x1addval;
362                 col_bt->rect.xmax = max_ff(x1addval + i + block->bounds, offset + block->minbounds);
363
364                 ui_but_update(col_bt);  /* clips text again */
365         }
366 }
367
368 void ui_block_bounds_calc(uiBlock *block)
369 {
370         uiBut *bt;
371         int xof;
372
373         if (BLI_listbase_is_empty(&block->buttons)) {
374                 if (block->panel) {
375                         block->rect.xmin = 0.0; block->rect.xmax = block->panel->sizex;
376                         block->rect.ymin = 0.0; block->rect.ymax = block->panel->sizey;
377                 }
378         }
379         else {
380
381                 BLI_rctf_init_minmax(&block->rect);
382
383                 for (bt = block->buttons.first; bt; bt = bt->next) {
384                         BLI_rctf_union(&block->rect, &bt->rect);
385                 }
386
387                 block->rect.xmin -= block->bounds;
388                 block->rect.ymin -= block->bounds;
389                 block->rect.xmax += block->bounds;
390                 block->rect.ymax += block->bounds;
391         }
392
393         block->rect.xmax = block->rect.xmin + max_ff(BLI_rctf_size_x(&block->rect), block->minbounds);
394
395         /* hardcoded exception... but that one is annoying with larger safety */
396         bt = block->buttons.first;
397         if (bt && STREQLEN(bt->str, "ERROR", 5)) xof = 10;
398         else xof = 40;
399
400         block->safety.xmin = block->rect.xmin - xof;
401         block->safety.ymin = block->rect.ymin - xof;
402         block->safety.xmax = block->rect.xmax + xof;
403         block->safety.ymax = block->rect.ymax + xof;
404 }
405
406 static void ui_block_bounds_calc_centered(wmWindow *window, uiBlock *block)
407 {
408         int xmax, ymax;
409         int startx, starty;
410         int width, height;
411
412         /* note: this is used for the splash where window bounds event has not been
413          * updated by ghost, get the window bounds from ghost directly */
414
415         xmax = WM_window_pixels_x(window);
416         ymax = WM_window_pixels_y(window);
417
418         ui_block_bounds_calc(block);
419
420         width  = BLI_rctf_size_x(&block->rect);
421         height = BLI_rctf_size_y(&block->rect);
422
423         startx = (xmax * 0.5f) - (width * 0.5f);
424         starty = (ymax * 0.5f) - (height * 0.5f);
425
426         UI_block_translate(block, startx - block->rect.xmin, starty - block->rect.ymin);
427
428         /* now recompute bounds and safety */
429         ui_block_bounds_calc(block);
430
431 }
432
433 static void ui_block_bounds_calc_centered_pie(uiBlock *block)
434 {
435         const int xy[2] = {
436             block->pie_data.pie_center_spawned[0],
437             block->pie_data.pie_center_spawned[1]
438         };
439
440         UI_block_translate(block, xy[0], xy[1]);
441
442         /* now recompute bounds and safety */
443         ui_block_bounds_calc(block);
444 }
445
446 static void ui_block_bounds_calc_popup(
447         wmWindow *window, uiBlock *block,
448         eBlockBoundsCalc bounds_calc, const int xy[2], int r_xy[2])
449 {
450         int width, height, oldwidth, oldheight;
451         int oldbounds, xmax, ymax, raw_x, raw_y;
452         const int margin = UI_SCREEN_MARGIN;
453         rcti rect, rect_bounds;
454         int ofs_dummy[2];
455
456         oldbounds = block->bounds;
457
458         /* compute mouse position with user defined offset */
459         ui_block_bounds_calc(block);
460
461         xmax = WM_window_pixels_x(window);
462         ymax = WM_window_pixels_y(window);
463
464         oldwidth  = BLI_rctf_size_x(&block->rect);
465         oldheight = BLI_rctf_size_y(&block->rect);
466
467         /* first we ensure wide enough text bounds */
468         if (bounds_calc == UI_BLOCK_BOUNDS_POPUP_MENU) {
469                 if (block->flag & UI_BLOCK_LOOP) {
470                         block->bounds = 2.5f * UI_UNIT_X;
471                         ui_block_bounds_calc_text(block, block->rect.xmin);
472                 }
473         }
474
475         /* next we recompute bounds */
476         block->bounds = oldbounds;
477         ui_block_bounds_calc(block);
478
479         /* and we adjust the position to fit within window */
480         width  = BLI_rctf_size_x(&block->rect);
481         height = BLI_rctf_size_y(&block->rect);
482
483         /* avoid divide by zero below, caused by calling with no UI, but better not crash */
484         oldwidth = oldwidth > 0 ? oldwidth : MAX2(1, width);
485         oldheight = oldheight > 0 ? oldheight : MAX2(1, height);
486
487         /* offset block based on mouse position, user offset is scaled
488          * along in case we resized the block in ui_block_bounds_calc_text */
489         raw_x = rect.xmin = xy[0] + block->rect.xmin + (block->mx * width) / oldwidth;
490         raw_y = rect.ymin = xy[1] + block->rect.ymin + (block->my * height) / oldheight;
491         rect.xmax = rect.xmin + width;
492         rect.ymax = rect.ymin + height;
493
494         rect_bounds.xmin = margin;
495         rect_bounds.ymin = margin;
496         rect_bounds.xmax = xmax - margin;
497         rect_bounds.ymax = ymax - UI_POPUP_MENU_TOP;
498
499         BLI_rcti_clamp(&rect, &rect_bounds, ofs_dummy);
500         UI_block_translate(block, rect.xmin - block->rect.xmin, rect.ymin - block->rect.ymin);
501
502         /* now recompute bounds and safety */
503         ui_block_bounds_calc(block);
504
505         /* If given, adjust input coordinates such that they would generate real final popup position.
506          * Needed to handle correctly floating panels once they have been dragged around, see T52999. */
507         if (r_xy) {
508                 r_xy[0] = xy[0] + block->rect.xmin - raw_x;
509                 r_xy[1] = xy[1] + block->rect.ymin - raw_y;
510         }
511 }
512
513 /* used for various cases */
514 void UI_block_bounds_set_normal(uiBlock *block, int addval)
515 {
516         if (block == NULL)
517                 return;
518
519         block->bounds = addval;
520         block->bounds_type = UI_BLOCK_BOUNDS;
521 }
522
523 /* used for pulldowns */
524 void UI_block_bounds_set_text(uiBlock *block, int addval)
525 {
526         block->bounds = addval;
527         block->bounds_type = UI_BLOCK_BOUNDS_TEXT;
528 }
529
530 /* used for block popups */
531 void UI_block_bounds_set_popup(uiBlock *block, int addval, int mx, int my)
532 {
533         block->bounds = addval;
534         block->bounds_type = UI_BLOCK_BOUNDS_POPUP_MOUSE;
535         block->mx = mx;
536         block->my = my;
537 }
538
539 /* used for menu popups */
540 void UI_block_bounds_set_menu(uiBlock *block, int addval, int mx, int my)
541 {
542         block->bounds = addval;
543         block->bounds_type = UI_BLOCK_BOUNDS_POPUP_MENU;
544         block->mx = mx;
545         block->my = my;
546 }
547
548 /* used for centered popups, i.e. splash */
549 void UI_block_bounds_set_centered(uiBlock *block, int addval)
550 {
551         block->bounds = addval;
552         block->bounds_type = UI_BLOCK_BOUNDS_POPUP_CENTER;
553 }
554
555 void UI_block_bounds_set_explicit(uiBlock *block, int minx, int miny, int maxx, int maxy)
556 {
557         block->rect.xmin = minx;
558         block->rect.ymin = miny;
559         block->rect.xmax = maxx;
560         block->rect.ymax = maxy;
561         block->bounds_type = UI_BLOCK_BOUNDS_NONE;
562 }
563
564 static int ui_but_calc_float_precision(uiBut *but, double value)
565 {
566         int prec = (int)but->a2;
567
568         /* first check for various special cases:
569          * * If button is radians, we want additional precision (see T39861).
570          * * If prec is not set, we fallback to a simple default */
571         if (ui_but_is_unit_radians(but) && prec < 5) {
572                 prec = 5;
573         }
574         else if (prec == -1) {
575                 prec = (but->hardmax < 10.001f) ? 3 : 2;
576         }
577         else {
578                 CLAMP(prec, 0, UI_PRECISION_FLOAT_MAX);
579         }
580
581         return UI_calc_float_precision(prec, value);
582 }
583
584 /* ************** BLOCK ENDING FUNCTION ************* */
585
586 /* NOTE: if but->poin is allocated memory for every defbut, things fail... */
587 static bool ui_but_equals_old(const uiBut *but, const uiBut *oldbut)
588 {
589         /* various properties are being compared here, hopefully sufficient
590          * to catch all cases, but it is simple to add more checks later */
591         if (but->retval != oldbut->retval) return false;
592         if (but->rnapoin.data != oldbut->rnapoin.data) return false;
593         if (but->rnaprop != oldbut->rnaprop || but->rnaindex != oldbut->rnaindex) return false;
594         if (but->func != oldbut->func) return false;
595         if (but->funcN != oldbut->funcN) return false;
596         if (oldbut->func_arg1 != oldbut && but->func_arg1 != oldbut->func_arg1) return false;
597         if (oldbut->func_arg2 != oldbut && but->func_arg2 != oldbut->func_arg2) return false;
598         if (!but->funcN && ((but->poin != oldbut->poin && (uiBut *)oldbut->poin != oldbut) ||
599                             (but->pointype != oldbut->pointype))) return false;
600         if (but->optype != oldbut->optype) return false;
601
602         return true;
603 }
604
605 uiBut *ui_but_find_old(uiBlock *block_old, const uiBut *but_new)
606 {
607         uiBut *but_old;
608         for (but_old = block_old->buttons.first; but_old; but_old = but_old->next) {
609                 if (ui_but_equals_old(but_new, but_old)) {
610                         break;
611                 }
612         }
613         return but_old;
614 }
615 uiBut *ui_but_find_new(uiBlock *block_new, const uiBut *but_old)
616 {
617         uiBut *but_new;
618         for (but_new = block_new->buttons.first; but_new; but_new = but_new->next) {
619                 if (ui_but_equals_old(but_new, but_old)) {
620                         break;
621                 }
622         }
623         return but_new;
624 }
625
626 /**
627  * \return true when \a but_p is set (only done for active buttons).
628  */
629 static bool ui_but_update_from_old_block(const bContext *C, uiBlock *block, uiBut **but_p, uiBut **but_old_p)
630 {
631         const int drawflag_copy = 0;  /* None currently. */
632
633         uiBlock *oldblock = block->oldblock;
634         uiBut *oldbut = NULL, *but = *but_p;
635         bool found_active = false;
636
637
638 #if 0
639         /* simple/stupid - search every time */
640         oldbut = ui_but_find_old(oldblock, but);
641         (void)but_old_p;
642 #else
643         BLI_assert(*but_old_p == NULL || BLI_findindex(&oldblock->buttons, *but_old_p) != -1);
644
645         /* fastpath - avoid loop-in-loop, calling 'ui_but_find_old'
646          * as long as old/new buttons are aligned */
647         if (LIKELY(*but_old_p && ui_but_equals_old(but, *but_old_p))) {
648                 oldbut = *but_old_p;
649         }
650         else {
651                 /* fallback to block search */
652                 oldbut = ui_but_find_old(oldblock, but);
653         }
654         (*but_old_p) = oldbut ? oldbut->next : NULL;
655 #endif
656
657
658         if (!oldbut) {
659                 return found_active;
660         }
661
662         if (oldbut->active) {
663                 /* flags from the buttons we want to refresh, may want to add more here... */
664                 const int flag_copy = UI_BUT_REDALERT | UI_HAS_ICON;
665
666                 found_active = true;
667
668 #if 0
669                 but->flag = oldbut->flag;
670                 but->active = oldbut->active;
671                 but->pos = oldbut->pos;
672                 but->ofs = oldbut->ofs;
673                 but->editstr = oldbut->editstr;
674                 but->editval = oldbut->editval;
675                 but->editvec = oldbut->editvec;
676                 but->editcoba = oldbut->editcoba;
677                 but->editcumap = oldbut->editcumap;
678                 but->selsta = oldbut->selsta;
679                 but->selend = oldbut->selend;
680                 but->softmin = oldbut->softmin;
681                 but->softmax = oldbut->softmax;
682                 oldbut->active = NULL;
683 #endif
684
685                 /* move button over from oldblock to new block */
686                 BLI_remlink(&oldblock->buttons, oldbut);
687                 BLI_insertlinkafter(&block->buttons, but, oldbut);
688                 oldbut->block = block;
689                 *but_p = oldbut;
690
691                 /* still stuff needs to be copied */
692                 oldbut->rect = but->rect;
693                 oldbut->context = but->context; /* set by Layout */
694
695                 /* drawing */
696                 oldbut->icon = but->icon;
697                 oldbut->iconadd = but->iconadd;
698                 oldbut->alignnr = but->alignnr;
699
700                 /* typically the same pointers, but not on undo/redo */
701                 /* XXX some menu buttons store button itself in but->poin. Ugly */
702                 if (oldbut->poin != (char *)oldbut) {
703                         SWAP(char *, oldbut->poin, but->poin);
704                         SWAP(void *, oldbut->func_argN, but->func_argN);
705                         SWAP(void *, oldbut->tip_argN, but->tip_argN);
706                 }
707
708                 oldbut->flag = (oldbut->flag & ~flag_copy) | (but->flag & flag_copy);
709                 oldbut->drawflag = (oldbut->drawflag & ~drawflag_copy) | (but->drawflag & drawflag_copy);
710
711                 /* copy hardmin for list rows to prevent 'sticking' highlight to mouse position
712                  * when scrolling without moving mouse (see [#28432]) */
713                 if (ELEM(oldbut->type, UI_BTYPE_ROW, UI_BTYPE_LISTROW)) {
714                         oldbut->hardmax = but->hardmax;
715                 }
716
717                 /* Selectively copy a1, a2 since their use differs across all button types
718                  * (and we'll probably split these out later) */
719                 if (ELEM(oldbut->type, UI_BTYPE_PROGRESS_BAR)) {
720                         oldbut->a1 = but->a1;
721                 }
722
723                 if (!BLI_listbase_is_empty(&block->butstore)) {
724                         UI_butstore_register_update(block, oldbut, but);
725                 }
726
727                 /* move/copy string from the new button to the old */
728                 /* needed for alt+mouse wheel over enums */
729                 if (but->str != but->strdata) {
730                         if (oldbut->str != oldbut->strdata) {
731                                 SWAP(char *, but->str, oldbut->str);
732                         }
733                         else {
734                                 oldbut->str = but->str;
735                                 but->str = but->strdata;
736                         }
737                 }
738                 else {
739                         if (oldbut->str != oldbut->strdata) {
740                                 MEM_freeN(oldbut->str);
741                                 oldbut->str = oldbut->strdata;
742                         }
743                         BLI_strncpy(oldbut->strdata, but->strdata, sizeof(oldbut->strdata));
744                 }
745
746                 if (but->dragpoin && (but->dragflag & UI_BUT_DRAGPOIN_FREE)) {
747                         SWAP(void *, but->dragpoin, oldbut->dragpoin);
748                 }
749
750                 BLI_remlink(&block->buttons, but);
751                 ui_but_free(C, but);
752
753                 /* note: if layout hasn't been applied yet, it uses old button pointers... */
754         }
755         else {
756                 const int flag_copy = UI_BUT_DRAG_MULTI;
757
758                 but->flag = (but->flag & ~flag_copy) | (oldbut->flag & flag_copy);
759
760                 /* ensures one button can get activated, and in case the buttons
761                  * draw are the same this gives O(1) lookup for each button */
762                 BLI_remlink(&oldblock->buttons, oldbut);
763                 ui_but_free(C, oldbut);
764         }
765
766         return found_active;
767 }
768
769 /* needed for temporarily rename buttons, such as in outliner or file-select,
770  * they should keep calling uiDefButs to keep them alive */
771 /* returns 0 when button removed */
772 bool UI_but_active_only(const bContext *C, ARegion *ar, uiBlock *block, uiBut *but)
773 {
774         uiBlock *oldblock;
775         uiBut *oldbut;
776         bool activate = false, found = false, isactive = false;
777
778         oldblock = block->oldblock;
779         if (!oldblock) {
780                 activate = true;
781         }
782         else {
783                 oldbut = ui_but_find_old(oldblock, but);
784                 if (oldbut) {
785                         found = true;
786
787                         if (oldbut->active) {
788                                 isactive = true;
789                         }
790                 }
791         }
792         if ((activate == true) || (found == false)) {
793                 ui_but_activate_event((bContext *)C, ar, but);
794         }
795         else if ((found == true) && (isactive == false)) {
796                 BLI_remlink(&block->buttons, but);
797                 ui_but_free(C, but);
798                 return false;
799         }
800
801         return true;
802 }
803
804 /* simulate button click */
805 void UI_but_execute(const bContext *C, uiBut *but)
806 {
807         ARegion *ar = CTX_wm_region(C);
808         void *active_back;
809         ui_but_execute_begin((bContext *)C, ar, but, &active_back);
810         /* Value is applied in begin. No further action required. */
811         ui_but_execute_end((bContext *)C, ar, but, active_back);
812 }
813
814 /* use to check if we need to disable undo, but don't make any changes
815  * returns false if undo needs to be disabled. */
816 static bool ui_but_is_rna_undo(const uiBut *but)
817 {
818         if (but->rnapoin.id.data) {
819                 /* avoid undo push for buttons who's ID are screen or wm level
820                  * we could disable undo for buttons with no ID too but may have
821                  * unforeseen consequences, so best check for ID's we _know_ are not
822                  * handled by undo - campbell */
823                 ID *id = but->rnapoin.id.data;
824                 if (ID_CHECK_UNDO(id) == false) {
825                         return false;
826                 }
827                 else {
828                         return true;
829                 }
830         }
831         else if (but->rnapoin.type && !RNA_struct_undo_check(but->rnapoin.type)) {
832                 return false;
833         }
834
835         return true;
836 }
837
838 /* assigns automatic keybindings to menu items for fast access
839  * (underline key in menu) */
840 static void ui_menu_block_set_keyaccels(uiBlock *block)
841 {
842         uiBut *but;
843
844         unsigned int menu_key_mask = 0;
845         unsigned char menu_key;
846         const char *str_pt;
847         int pass;
848         int tot_missing = 0;
849
850         /* only do it before bounding */
851         if (block->rect.xmin != block->rect.xmax)
852                 return;
853
854         for (pass = 0; pass < 2; pass++) {
855                 /* 2 Passes, on for first letter only, second for any letter if first fails
856                  * fun first pass on all buttons so first word chars always get first priority */
857
858                 for (but = block->buttons.first; but; but = but->next) {
859                         if (!ELEM(but->type,
860                                   UI_BTYPE_BUT,
861                                   UI_BTYPE_BUT_MENU,
862                                   UI_BTYPE_MENU, UI_BTYPE_BLOCK,
863                                   UI_BTYPE_PULLDOWN) ||
864                             (but->flag & UI_HIDDEN))
865                         {
866                                 /* pass */
867                         }
868                         else if (but->menu_key == '\0') {
869                                 if (but->str) {
870                                         for (str_pt = but->str; *str_pt; ) {
871                                                 menu_key = tolower(*str_pt);
872                                                 if ((menu_key >= 'a' && menu_key <= 'z') && !(menu_key_mask & 1 << (menu_key - 'a'))) {
873                                                         menu_key_mask |= 1 << (menu_key - 'a');
874                                                         break;
875                                                 }
876
877                                                 if (pass == 0) {
878                                                         /* Skip to next delimiter on first pass (be picky) */
879                                                         while (isalpha(*str_pt))
880                                                                 str_pt++;
881
882                                                         if (*str_pt)
883                                                                 str_pt++;
884                                                 }
885                                                 else {
886                                                         /* just step over every char second pass and find first usable key */
887                                                         str_pt++;
888                                                 }
889                                         }
890
891                                         if (*str_pt) {
892                                                 but->menu_key = menu_key;
893                                         }
894                                         else {
895                                                 /* run second pass */
896                                                 tot_missing++;
897                                         }
898
899                                         /* if all keys have been used just exit, unlikely */
900                                         if (menu_key_mask == (1 << 26) - 1) {
901                                                 return;
902                                         }
903                                 }
904                         }
905                 }
906
907                 /* check if second pass is needed */
908                 if (!tot_missing) {
909                         break;
910                 }
911         }
912 }
913
914 /* XXX, this code will shorten any allocated string to 'UI_MAX_NAME_STR'
915  * since this is really long its unlikely to be an issue,
916  * but this could be supported */
917 void ui_but_add_shortcut(uiBut *but, const char *shortcut_str, const bool do_strip)
918 {
919         if (do_strip && (but->flag & UI_BUT_HAS_SEP_CHAR)) {
920                 char *cpoin = strrchr(but->str, UI_SEP_CHAR);
921                 if (cpoin) {
922                         *cpoin = '\0';
923                 }
924                 but->flag &= ~UI_BUT_HAS_SEP_CHAR;
925         }
926
927         /* without this, just allow stripping of the shortcut */
928         if (shortcut_str) {
929                 char *butstr_orig;
930
931                 if (but->str != but->strdata) {
932                         butstr_orig = but->str; /* free after using as source buffer */
933                 }
934                 else {
935                         butstr_orig = BLI_strdup(but->str);
936                 }
937                 BLI_snprintf(
938                         but->strdata,
939                         sizeof(but->strdata),
940                         "%s" UI_SEP_CHAR_S "%s",
941                         butstr_orig, shortcut_str);
942                 MEM_freeN(butstr_orig);
943                 but->str = but->strdata;
944                 but->flag |= UI_BUT_HAS_SEP_CHAR;
945                 but->drawflag |= UI_BUT_HAS_SHORTCUT;
946                 ui_but_update(but);
947         }
948 }
949
950 /* -------------------------------------------------------------------- */
951 /** \name Find Key Shortcut for Button
952  *
953  * - #ui_but_event_operator_string (and helpers)
954  * - #ui_but_event_property_operator_string
955  * \{ */
956
957 static bool ui_but_event_operator_string_from_operator(
958         const bContext *C, uiBut *but,
959         char *buf, const size_t buf_len)
960 {
961         BLI_assert(but->optype != NULL);
962         bool found = false;
963         IDProperty *prop = (but->opptr) ? but->opptr->data : NULL;
964
965         if (WM_key_event_operator_string(
966                     C, but->optype->idname, but->opcontext, prop, true,
967                     buf, buf_len))
968         {
969                 found = true;
970         }
971         return found;
972 }
973
974 static bool ui_but_event_operator_string_from_menu(
975         const bContext *C, uiBut *but,
976         char *buf, const size_t buf_len)
977 {
978         MenuType *mt = UI_but_menutype_get(but);
979         BLI_assert(mt != NULL);
980
981         bool found = false;
982         IDProperty *prop_menu, *prop_menu_name;
983
984         /* annoying, create a property */
985         IDPropertyTemplate val = {0};
986         prop_menu = IDP_New(IDP_GROUP, &val, __func__); /* dummy, name is unimportant  */
987         IDP_AddToGroup(prop_menu, (prop_menu_name = IDP_NewString("", "name", sizeof(mt->idname))));
988
989         IDP_AssignString(prop_menu_name, mt->idname, sizeof(mt->idname));
990
991         if (WM_key_event_operator_string(
992                 C, "WM_OT_call_menu", WM_OP_INVOKE_REGION_WIN, prop_menu, true,
993                 buf, buf_len))
994         {
995                 found = true;
996         }
997
998         IDP_FreeProperty(prop_menu);
999         MEM_freeN(prop_menu);
1000         return found;
1001 }
1002
1003 static bool ui_but_event_operator_string(
1004         const bContext *C, uiBut *but,
1005         char *buf, const size_t buf_len)
1006 {
1007         bool found = false;
1008
1009         if (but->optype != NULL) {
1010                 found = ui_but_event_operator_string_from_operator(C, but, buf, buf_len);
1011         }
1012         else if (UI_but_menutype_get(but) != NULL) {
1013                 found = ui_but_event_operator_string_from_menu(C, but, buf, buf_len);
1014         }
1015
1016         return found;
1017 }
1018
1019 static bool ui_but_event_property_operator_string(
1020         const bContext *C, uiBut *but,
1021         char *buf, const size_t buf_len)
1022 {
1023         /* context toggle operator names to check... */
1024         const char *ctx_toggle_opnames[] = {
1025                 "WM_OT_context_toggle",
1026                 "WM_OT_context_toggle_enum",
1027                 "WM_OT_context_cycle_int",
1028                 "WM_OT_context_cycle_enum",
1029                 "WM_OT_context_cycle_array",
1030                 "WM_OT_context_menu_enum",
1031                 NULL
1032         };
1033         const size_t num_ops = sizeof(ctx_toggle_opnames) / sizeof(const char *);
1034
1035         bool found = false;
1036
1037         /* this version is only for finding hotkeys for properties (which get set via context using operators) */
1038         if (but->rnaprop) {
1039                 /* to avoid massive slowdowns on property panels, for now, we only check the
1040                  * hotkeys for Editor / Scene settings...
1041                  *
1042                  * TODO: userpref settings?
1043                  */
1044                 // TODO: value (for enum stuff)?
1045                 char *data_path = NULL;
1046
1047                 if (but->rnapoin.id.data) {
1048                         ID *id = but->rnapoin.id.data;
1049
1050                         if (GS(id->name) == ID_SCR) {
1051                                 /* screen/editor property
1052                                  * NOTE: in most cases, there is actually no info for backwards tracing
1053                                  * how to get back to ID from the editor data we may be dealing with
1054                                  */
1055                                 if (RNA_struct_is_a(but->rnapoin.type, &RNA_Space)) {
1056                                         /* data should be directly on here... */
1057                                         data_path = BLI_sprintfN("space_data.%s", RNA_property_identifier(but->rnaprop));
1058                                 }
1059                                 else {
1060                                         /* special exceptions for common nested data in editors... */
1061                                         if (RNA_struct_is_a(but->rnapoin.type, &RNA_DopeSheet)) {
1062                                                 /* dopesheet filtering options... */
1063                                                 data_path = BLI_sprintfN("space_data.dopesheet.%s", RNA_property_identifier(but->rnaprop));
1064                                         }
1065                                         else if (RNA_struct_is_a(but->rnapoin.type, &RNA_FileSelectParams)) {
1066                                                 /* Filebrowser options... */
1067                                                 data_path = BLI_sprintfN("space_data.params.%s", RNA_property_identifier(but->rnaprop));
1068                                         }
1069                                 }
1070                         }
1071                         else if (GS(id->name) == ID_SCE) {
1072                                 if (RNA_struct_is_a(but->rnapoin.type, &RNA_ToolSettings)) {
1073                                         /* toolsettings property
1074                                          * NOTE: toolsettings is usually accessed directly (i.e. not through scene)
1075                                          */
1076                                         data_path = RNA_path_from_ID_to_property(&but->rnapoin, but->rnaprop);
1077                                 }
1078                                 else {
1079                                         /* scene property */
1080                                         char *path = RNA_path_from_ID_to_property(&but->rnapoin, but->rnaprop);
1081
1082                                         if (path) {
1083                                                 data_path = BLI_sprintfN("scene.%s", path);
1084                                                 MEM_freeN(path);
1085                                         }
1086 #if 0
1087                                         else {
1088                                                 printf("ERROR in %s(): Couldn't get path for scene property - %s\n",
1089                                                        __func__, RNA_property_identifier(but->rnaprop));
1090                                         }
1091 #endif
1092                                 }
1093                         }
1094                         else {
1095                                 //puts("other id");
1096                         }
1097
1098                         //printf("prop shortcut: '%s' (%s)\n", RNA_property_identifier(but->rnaprop), data_path);
1099                 }
1100
1101                 /* we have a datapath! */
1102                 if (data_path) {
1103                         size_t i;
1104
1105                         /* create a property to host the "datapath" property we're sending to the operators */
1106                         IDProperty *prop_path;
1107                         IDProperty *prop_path_value;
1108
1109                         IDPropertyTemplate val = {0};
1110                         prop_path = IDP_New(IDP_GROUP, &val, __func__);
1111                         prop_path_value = IDP_NewString(data_path, "data_path", strlen(data_path) + 1);
1112                         IDP_AddToGroup(prop_path, prop_path_value);
1113
1114                         /* check each until one works... */
1115                         for (i = 0; (i < num_ops) && (ctx_toggle_opnames[i]); i++) {
1116                                 if (WM_key_event_operator_string(
1117                                         C, ctx_toggle_opnames[i], WM_OP_INVOKE_REGION_WIN, prop_path, false,
1118                                         buf, buf_len))
1119                                 {
1120                                         found = true;
1121                                         break;
1122                                 }
1123                         }
1124
1125                         /* cleanup */
1126                         IDP_FreeProperty(prop_path);
1127                         MEM_freeN(prop_path);
1128                         MEM_freeN(data_path);
1129                 }
1130         }
1131
1132         return found;
1133 }
1134
1135 /** \} */
1136
1137 /**
1138  * This goes in a seemingly weird pattern:
1139  *
1140  * <pre>
1141  *     4
1142  *  5     6
1143  * 1       2
1144  *  7     8
1145  *     3
1146  * </pre>
1147  *
1148  * but it's actually quite logical. It's designed to be 'upwards compatible'
1149  * for muscle memory so that the menu item locations are fixed and don't move
1150  * as new items are added to the menu later on. It also optimises efficiency -
1151  * a radial menu is best kept symmetrical, with as large an angle between
1152  * items as possible, so that the gestural mouse movements can be fast and inexact.
1153  *
1154  * It starts off with two opposite sides for the first two items
1155  * then joined by the one below for the third (this way, even with three items,
1156  * the menu seems to still be 'in order' reading left to right). Then the fourth is
1157  * added to complete the compass directions. From here, it's just a matter of
1158  * subdividing the rest of the angles for the last 4 items.
1159  *
1160  * --Matt 07/2006
1161  */
1162 const char ui_radial_dir_order[8] = {
1163     UI_RADIAL_W,  UI_RADIAL_E,  UI_RADIAL_S,  UI_RADIAL_N,
1164     UI_RADIAL_NW, UI_RADIAL_NE, UI_RADIAL_SW, UI_RADIAL_SE};
1165
1166 const char  ui_radial_dir_to_numpad[8] = {8, 9, 6, 3, 2, 1, 4, 7};
1167 const short ui_radial_dir_to_angle[8] =  {90, 45, 0, 315, 270, 225, 180, 135};
1168
1169 static void ui_but_pie_direction_string(uiBut *but, char *buf, int size)
1170 {
1171         BLI_assert(but->pie_dir < ARRAY_SIZE(ui_radial_dir_to_numpad));
1172         BLI_snprintf(buf, size, "%d", ui_radial_dir_to_numpad[but->pie_dir]);
1173 }
1174
1175 static void ui_menu_block_set_keymaps(const bContext *C, uiBlock *block)
1176 {
1177         uiBut *but;
1178         char buf[128];
1179
1180         BLI_assert(block->flag & (UI_BLOCK_LOOP | UI_BLOCK_SHOW_SHORTCUT_ALWAYS));
1181
1182         /* only do it before bounding */
1183         if (block->rect.xmin != block->rect.xmax)
1184                 return;
1185
1186         if (block->flag & UI_BLOCK_RADIAL) {
1187                 for (but = block->buttons.first; but; but = but->next) {
1188                         if (but->pie_dir != UI_RADIAL_NONE) {
1189                                 ui_but_pie_direction_string(but, buf, sizeof(buf));
1190                                 ui_but_add_shortcut(but, buf, false);
1191                         }
1192                 }
1193         }
1194         else {
1195                 for (but = block->buttons.first; but; but = but->next) {
1196                         if (block->flag & UI_BLOCK_SHOW_SHORTCUT_ALWAYS) {
1197                                 /* Skip icon-only buttons (as used in the toolbar). */
1198                                 if (but->drawstr[0] == '\0') {
1199                                         continue;
1200                                 }
1201                         }
1202                         else if (but->dt != UI_EMBOSS_PULLDOWN) {
1203                                 continue;
1204                         }
1205
1206                         if (ui_but_event_operator_string(C, but, buf, sizeof(buf))) {
1207                                 ui_but_add_shortcut(but, buf, false);
1208                         }
1209                         else if (ui_but_event_property_operator_string(C, but, buf, sizeof(buf))) {
1210                                 ui_but_add_shortcut(but, buf, false);
1211                         }
1212                 }
1213         }
1214 }
1215
1216 void ui_but_override_flag(uiBut *but)
1217 {
1218         const int override_status = RNA_property_static_override_status(&but->rnapoin, but->rnaprop, but->rnaindex);
1219
1220         if (override_status & RNA_OVERRIDE_STATUS_OVERRIDDEN) {
1221                 but->flag |= UI_BUT_OVERRIDEN;
1222         }
1223         else {
1224                 but->flag &= ~UI_BUT_OVERRIDEN;
1225         }
1226 }
1227
1228 void UI_block_update_from_old(const bContext *C, uiBlock *block)
1229 {
1230         uiBut *but_old;
1231         uiBut *but;
1232
1233         if (!block->oldblock)
1234                 return;
1235
1236         but_old = block->oldblock->buttons.first;
1237
1238         if (BLI_listbase_is_empty(&block->oldblock->butstore) == false) {
1239                 UI_butstore_update(block);
1240         }
1241
1242         for (but = block->buttons.first; but; but = but->next) {
1243                 if (ui_but_update_from_old_block(C, block, &but, &but_old)) {
1244                         ui_but_update(but);
1245
1246                         /* redraw dynamic tooltip if we have one open */
1247                         if (but->tip_func) {
1248                                 UI_but_tooltip_refresh((bContext *)C, but);
1249                         }
1250                 }
1251         }
1252
1253         block->auto_open = block->oldblock->auto_open;
1254         block->auto_open_last = block->oldblock->auto_open_last;
1255         block->tooltipdisabled = block->oldblock->tooltipdisabled;
1256         BLI_movelisttolist(&block->color_pickers.list, &block->oldblock->color_pickers.list);
1257
1258         block->oldblock = NULL;
1259 }
1260
1261 void UI_block_end_ex(const bContext *C, uiBlock *block, const int xy[2], int r_xy[2])
1262 {
1263         wmWindow *window = CTX_wm_window(C);
1264         Scene *scene = CTX_data_scene(C);
1265         ARegion *region = CTX_wm_region(C);
1266         uiBut *but;
1267
1268         BLI_assert(block->active);
1269
1270         UI_block_update_from_old(C, block);
1271
1272         /* inherit flags from 'old' buttons that was drawn here previous, based
1273          * on matching buttons, we need this to make button event handling non
1274          * blocking, while still allowing buttons to be remade each redraw as it
1275          * is expected by blender code */
1276         for (but = block->buttons.first; but; but = but->next) {
1277                 /* temp? Proper check for graying out */
1278                 if (but->optype) {
1279                         wmOperatorType *ot = but->optype;
1280
1281                         if (but->context)
1282                                 CTX_store_set((bContext *)C, but->context);
1283
1284                         if (ot == NULL || WM_operator_poll_context((bContext *)C, ot, but->opcontext) == 0) {
1285                                 but->flag |= UI_BUT_DISABLED;
1286                         }
1287
1288                         if (but->context)
1289                                 CTX_store_set((bContext *)C, NULL);
1290                 }
1291
1292                 ui_but_anim_flag(but, (scene) ? scene->r.cfra : 0.0f);
1293                 ui_but_override_flag(but);
1294                 if (UI_but_is_decorator(but)) {
1295                         ui_but_anim_decorate_update_from_flag(but);
1296                 }
1297         }
1298
1299
1300
1301         /* handle pending stuff */
1302         if (block->layouts.first) {
1303                 UI_block_layout_resolve(block, NULL, NULL);
1304         }
1305         ui_block_align_calc(block, CTX_wm_region(C));
1306         if ((block->flag & UI_BLOCK_LOOP) && (block->flag & UI_BLOCK_NUMSELECT)) {
1307                 ui_menu_block_set_keyaccels(block); /* could use a different flag to check */
1308         }
1309
1310         if (block->flag & (UI_BLOCK_LOOP | UI_BLOCK_SHOW_SHORTCUT_ALWAYS)) {
1311                 ui_menu_block_set_keymaps(C, block);
1312         }
1313
1314         /* after keymaps! */
1315         switch (block->bounds_type) {
1316                 case UI_BLOCK_BOUNDS_NONE:
1317                         break;
1318                 case UI_BLOCK_BOUNDS:
1319                         ui_block_bounds_calc(block);
1320                         break;
1321                 case UI_BLOCK_BOUNDS_TEXT:
1322                         ui_block_bounds_calc_text(block, 0.0f);
1323                         break;
1324                 case UI_BLOCK_BOUNDS_POPUP_CENTER:
1325                         ui_block_bounds_calc_centered(window, block);
1326                         break;
1327                 case UI_BLOCK_BOUNDS_PIE_CENTER:
1328                         ui_block_bounds_calc_centered_pie(block);
1329                         break;
1330
1331                         /* fallback */
1332                 case UI_BLOCK_BOUNDS_POPUP_MOUSE:
1333                 case UI_BLOCK_BOUNDS_POPUP_MENU:
1334                         ui_block_bounds_calc_popup(window, block, block->bounds_type, xy, r_xy);
1335                         break;
1336         }
1337
1338         if (block->rect.xmin == 0.0f && block->rect.xmax == 0.0f) {
1339                 UI_block_bounds_set_normal(block, 0);
1340         }
1341         if (block->flag & UI_BUT_ALIGN) {
1342                 UI_block_align_end(block);
1343         }
1344
1345         ui_update_flexible_spacing(region, block);
1346
1347         block->endblock = 1;
1348 }
1349
1350 void UI_block_end(const bContext *C, uiBlock *block)
1351 {
1352         wmWindow *window = CTX_wm_window(C);
1353
1354         UI_block_end_ex(C, block, &window->eventstate->x, NULL);
1355 }
1356
1357 /* ************** BLOCK DRAWING FUNCTION ************* */
1358
1359 void ui_fontscale(short *points, float aspect)
1360 {
1361         if (aspect < 0.9f || aspect > 1.1f) {
1362                 float pointsf = *points;
1363
1364                 /* for some reason scaling fonts goes too fast compared to widget size */
1365                 /* XXX not true anymore? (ton) */
1366                 //aspect = sqrt(aspect);
1367                 pointsf /= aspect;
1368
1369                 if (aspect > 1.0f)
1370                         *points = ceilf(pointsf);
1371                 else
1372                         *points = floorf(pointsf);
1373         }
1374 }
1375
1376 /* project button or block (but==NULL) to pixels in regionspace */
1377 static void ui_but_to_pixelrect(rcti *rect, const ARegion *ar, uiBlock *block, uiBut *but)
1378 {
1379         rctf rectf;
1380
1381         ui_block_to_window_rctf(ar, block, &rectf, (but) ? &but->rect : &block->rect);
1382         BLI_rcti_rctf_copy_round(rect, &rectf);
1383         BLI_rcti_translate(rect, -ar->winrct.xmin, -ar->winrct.ymin);
1384 }
1385
1386 /* uses local copy of style, to scale things down, and allow widgets to change stuff */
1387 void UI_block_draw(const bContext *C, uiBlock *block)
1388 {
1389         uiStyle style = *UI_style_get_dpi();  /* XXX pass on as arg */
1390         ARegion *ar;
1391         uiBut *but;
1392         rcti rect;
1393
1394         /* get menu region or area region */
1395         ar = CTX_wm_menu(C);
1396         if (!ar)
1397                 ar = CTX_wm_region(C);
1398
1399         if (!block->endblock)
1400                 UI_block_end(C, block);
1401
1402         /* we set this only once */
1403         GPU_blend_set_func_separate(GPU_SRC_ALPHA, GPU_ONE_MINUS_SRC_ALPHA, GPU_ONE, GPU_ONE_MINUS_SRC_ALPHA);
1404
1405         /* scale fonts */
1406         ui_fontscale(&style.paneltitle.points, block->aspect);
1407         ui_fontscale(&style.grouplabel.points, block->aspect);
1408         ui_fontscale(&style.widgetlabel.points, block->aspect);
1409         ui_fontscale(&style.widget.points, block->aspect);
1410
1411         /* scale block min/max to rect */
1412         ui_but_to_pixelrect(&rect, ar, block, NULL);
1413
1414         /* pixel space for AA widgets */
1415         gpuPushProjectionMatrix();
1416         gpuPushMatrix();
1417         gpuLoadIdentity();
1418
1419         wmOrtho2_region_pixelspace(ar);
1420
1421         /* back */
1422         if (block->flag & UI_BLOCK_RADIAL)
1423                 ui_draw_pie_center(block);
1424         else if (block->flag & UI_BLOCK_POPOVER)
1425                 ui_draw_popover_back(ar, &style, block, &rect);
1426         else if (block->flag & UI_BLOCK_LOOP)
1427                 ui_draw_menu_back(&style, block, &rect);
1428         else if (block->panel)
1429                 ui_draw_aligned_panel(&style, block, &rect, UI_panel_category_is_visible(ar));
1430
1431         BLF_batch_draw_begin();
1432         UI_icon_draw_cache_begin();
1433         UI_widgetbase_draw_cache_begin();
1434
1435         /* widgets */
1436         for (but = block->buttons.first; but; but = but->next) {
1437                 if (!(but->flag & (UI_HIDDEN | UI_SCROLLED))) {
1438                         ui_but_to_pixelrect(&rect, ar, block, but);
1439
1440                         /* XXX: figure out why invalid coordinates happen when closing render window */
1441                         /* and material preview is redrawn in main window (temp fix for bug #23848) */
1442                         if (rect.xmin < rect.xmax && rect.ymin < rect.ymax)
1443                                 ui_draw_but(C, ar, &style, but, &rect);
1444                 }
1445         }
1446
1447         UI_widgetbase_draw_cache_end();
1448         UI_icon_draw_cache_end();
1449         BLF_batch_draw_end();
1450
1451         /* restore matrix */
1452         gpuPopProjectionMatrix();
1453         gpuPopMatrix();
1454 }
1455
1456 static void ui_block_message_subscribe(ARegion *ar, struct wmMsgBus *mbus, uiBlock *block)
1457 {
1458         uiBut *but_prev = NULL;
1459         /* possibly we should keep the region this block is contained in? */
1460         for (uiBut *but = block->buttons.first; but; but = but->next) {
1461                 if (but->rnapoin.type && but->rnaprop) {
1462                         /* quick check to avoid adding buttons representing a vector, multiple times. */
1463                         if ((but_prev &&
1464                             (but_prev->rnaprop == but->rnaprop) &&
1465                             (but_prev->rnapoin.type == but->rnapoin.type) &&
1466                             (but_prev->rnapoin.data == but->rnapoin.data) &&
1467                             (but_prev->rnapoin.id.data == but->rnapoin.id.data)) == false)
1468                         {
1469                                 /* TODO: could make this into utility function. */
1470                                 WM_msg_subscribe_rna(
1471                                         mbus, &but->rnapoin, but->rnaprop,
1472                                         &(const wmMsgSubscribeValue){
1473                                             .owner = ar,
1474                                             .user_data = ar,
1475                                             .notify = ED_region_do_msg_notify_tag_redraw,
1476                                         }, __func__);
1477                                 but_prev = but;
1478                         }
1479                 }
1480         }
1481 }
1482
1483 void UI_region_message_subscribe(ARegion *ar, struct wmMsgBus *mbus)
1484 {
1485         for (uiBlock *block = ar->uiblocks.first; block; block = block->next) {
1486                 ui_block_message_subscribe(ar, mbus, block);
1487         }
1488 }
1489
1490 /* ************* EVENTS ************* */
1491
1492 /**
1493  * Check if the button is pushed, this is only meaningful for some button types.
1494  *
1495  * \return (0 == UNSELECT), (1 == SELECT), (-1 == DO-NOTHING)
1496  */
1497 int ui_but_is_pushed_ex(uiBut *but, double *value)
1498 {
1499         int is_push = 0;
1500
1501         if (but->bit) {
1502                 const bool state = ELEM(but->type, UI_BTYPE_TOGGLE_N, UI_BTYPE_ICON_TOGGLE_N, UI_BTYPE_CHECKBOX_N) ? false : true;
1503                 int lvalue;
1504                 UI_GET_BUT_VALUE_INIT(but, *value);
1505                 lvalue = (int)*value;
1506                 if (UI_BITBUT_TEST(lvalue, (but->bitnr))) {
1507                         is_push = state;
1508                 }
1509                 else {
1510                         is_push = !state;
1511                 }
1512         }
1513         else {
1514                 switch (but->type) {
1515                         case UI_BTYPE_BUT:
1516                         case UI_BTYPE_HOTKEY_EVENT:
1517                         case UI_BTYPE_KEY_EVENT:
1518                         case UI_BTYPE_COLOR:
1519                                 is_push = -1;
1520                                 break;
1521                         case UI_BTYPE_BUT_TOGGLE:
1522                         case UI_BTYPE_TOGGLE:
1523                         case UI_BTYPE_ICON_TOGGLE:
1524                         case UI_BTYPE_CHECKBOX:
1525                                 UI_GET_BUT_VALUE_INIT(but, *value);
1526                                 if (*value != (double)but->hardmin) is_push = true;
1527                                 break;
1528                         case UI_BTYPE_ICON_TOGGLE_N:
1529                         case UI_BTYPE_TOGGLE_N:
1530                         case UI_BTYPE_CHECKBOX_N:
1531                                 UI_GET_BUT_VALUE_INIT(but, *value);
1532                                 if (*value == 0.0) is_push = true;
1533                                 break;
1534                         case UI_BTYPE_ROW:
1535                         case UI_BTYPE_LISTROW:
1536                                 UI_GET_BUT_VALUE_INIT(but, *value);
1537                                 /* support for rna enum buts */
1538                                 if (but->rnaprop && (RNA_property_flag(but->rnaprop) & PROP_ENUM_FLAG)) {
1539                                         if ((int)*value & (int)but->hardmax) is_push = true;
1540                                 }
1541                                 else {
1542                                         if (*value == (double)but->hardmax) is_push = true;
1543                                 }
1544                                 break;
1545                         case UI_BTYPE_TAB:
1546                                 if (but->rnaprop && but->custom_data) {
1547                                         /* uiBut.custom_data points to data this tab represents (e.g. workspace).
1548                                          * uiBut.rnapoin/prop store an active value (e.g. active workspace). */
1549                                         if (RNA_property_type(but->rnaprop) == PROP_POINTER) {
1550                                                 PointerRNA active_ptr = RNA_property_pointer_get(&but->rnapoin, but->rnaprop);
1551                                                 if (active_ptr.data == but->custom_data) {
1552                                                         is_push = true;
1553                                                 }
1554                                         }
1555                                 }
1556                                 break;
1557                         default:
1558                                 is_push = -1;
1559                                 break;
1560                 }
1561         }
1562
1563         return is_push;
1564 }
1565 int ui_but_is_pushed(uiBut *but)
1566 {
1567         double value = UI_BUT_VALUE_UNSET;
1568         return ui_but_is_pushed_ex(but, &value);
1569 }
1570
1571 static void ui_but_update_select_flag(uiBut *but, double *value)
1572 {
1573         switch (ui_but_is_pushed_ex(but, value)) {
1574                 case true:
1575                         but->flag |= UI_SELECT;
1576                         break;
1577                 case false:
1578                         but->flag &= ~UI_SELECT;
1579                         break;
1580         }
1581 }
1582
1583 /* ************************************************ */
1584
1585 void UI_block_lock_set(uiBlock *block, bool val, const char *lockstr)
1586 {
1587         if (val) {
1588                 block->lock = val;
1589                 block->lockstr = lockstr;
1590         }
1591 }
1592
1593 void UI_block_lock_clear(uiBlock *block)
1594 {
1595         block->lock = false;
1596         block->lockstr = NULL;
1597 }
1598
1599 /* *********************** data get/set ***********************
1600  * this either works with the pointed to data, or can work with
1601  * an edit override pointer while dragging for example */
1602
1603 /* Get PointerRNA which will point to a data inside of an evaluated
1604  * ID datablock.
1605  */
1606 static PointerRNA ui_but_evaluated_rnapoin_get(uiBut *but)
1607 {
1608         BLI_assert(but->rnaprop != NULL);
1609         /* TODO(sergey): evil_C sounds.. EVIL! Any clear way to avoid this? */
1610         PointerRNA rnapoin_eval = but->rnapoin;
1611         /* If there is no animation or drivers, it doesn't matter if we read value
1612          * from evaluated datablock or from original one.
1613          *
1614          * Reading from original one is much faster, since we don't need to do any
1615          * PointerRNA remapping or hash lookup.
1616          */
1617         if (BKE_animdata_from_id(but->rnapoin.id.data) == NULL) {
1618                 return rnapoin_eval;
1619         }
1620         /* Same goes for the properties which can not be animated. */
1621         if (!RNA_property_animateable(&but->rnapoin, but->rnaprop)) {
1622                 return rnapoin_eval;
1623         }
1624         Depsgraph *depsgraph = CTX_data_depsgraph(but->block->evil_C);
1625         /* ID pointer we can always remap, they are inside of depsgraph. */
1626         rnapoin_eval.id.data =
1627                 DEG_get_evaluated_id(depsgraph, rnapoin_eval.id.data);
1628         /* Some of ID datablocks do not have their evaluated copy inside
1629          * of dependency graph. If it's such datablock, no need to worry about
1630          * data pointer.
1631          */
1632         if (rnapoin_eval.id.data == but->rnapoin.id.data) {
1633                 return rnapoin_eval;
1634         }
1635         /* For the data pointer it's getting a bit more involved, since it can
1636          * whether be and ID, or can be a property deep inside of ID.
1637          *
1638          * We start from checking if it's an ID, since that is the less involved
1639          * code path, and probably is executed in most of the cases.
1640          */
1641         if (but->rnapoin.data == but->rnapoin.id.data) {
1642                 rnapoin_eval.data = DEG_get_evaluated_id(depsgraph, rnapoin_eval.data);
1643                 return rnapoin_eval;
1644         }
1645         /* We aren't as lucky as we thought we are :(
1646          *
1647          * Since we don't know what the property is, we get it's RNA path
1648          * relative to the original ID, and then we decent down from evaluated
1649          * ID to the same property.
1650          *
1651          * This seems to be most straightforward way to get sub-data pointers
1652          * which can be buried deep inside of ID block.
1653          */
1654         const char *rna_path =
1655                RNA_path_from_ID_to_property(&but->rnapoin, but->rnaprop);
1656         if (rna_path != NULL) {
1657                 PointerRNA id_ptr;
1658                 RNA_id_pointer_create(rnapoin_eval.id.data, &id_ptr);
1659                 if (!RNA_path_resolve_full(&id_ptr,
1660                                            rna_path,
1661                                            &rnapoin_eval,
1662                                            NULL, NULL))
1663                 {
1664                         /* TODO(sergey): Anything to do here to recover? */
1665                 }
1666                 MEM_freeN((void *)rna_path);
1667         }
1668         return rnapoin_eval;
1669 }
1670
1671 /* for buttons pointing to color for example */
1672 void ui_but_v3_get(uiBut *but, float vec[3])
1673 {
1674         PropertyRNA *prop;
1675         int a;
1676
1677         if (but->editvec) {
1678                 copy_v3_v3(vec, but->editvec);
1679         }
1680
1681         if (but->rnaprop) {
1682                 prop = but->rnaprop;
1683
1684                 zero_v3(vec);
1685
1686                 PointerRNA rnapoin_eval = ui_but_evaluated_rnapoin_get(but);
1687
1688                 if (RNA_property_type(prop) == PROP_FLOAT) {
1689                         int tot = RNA_property_array_length(&rnapoin_eval, prop);
1690                         BLI_assert(tot > 0);
1691                         if (tot == 3) {
1692                                 RNA_property_float_get_array(&rnapoin_eval, prop, vec);
1693                         }
1694                         else {
1695                                 tot = min_ii(tot, 3);
1696                                 for (a = 0; a < tot; a++) {
1697                                         vec[a] = RNA_property_float_get_index(&rnapoin_eval, prop, a);
1698                                 }
1699                         }
1700                 }
1701         }
1702         else if (but->pointype == UI_BUT_POIN_CHAR) {
1703                 const char *cp = (char *)but->poin;
1704
1705                 vec[0] = ((float)cp[0]) / 255.0f;
1706                 vec[1] = ((float)cp[1]) / 255.0f;
1707                 vec[2] = ((float)cp[2]) / 255.0f;
1708         }
1709         else if (but->pointype == UI_BUT_POIN_FLOAT) {
1710                 const float *fp = (float *)but->poin;
1711                 copy_v3_v3(vec, fp);
1712         }
1713         else {
1714                 if (but->editvec == NULL) {
1715                         fprintf(stderr, "%s: can't get color, should never happen\n", __func__);
1716                         zero_v3(vec);
1717                 }
1718         }
1719
1720         if (but->type == UI_BTYPE_UNITVEC) {
1721                 normalize_v3(vec);
1722         }
1723 }
1724
1725 /* for buttons pointing to color for example */
1726 void ui_but_v3_set(uiBut *but, const float vec[3])
1727 {
1728         PropertyRNA *prop;
1729
1730         if (but->editvec) {
1731                 copy_v3_v3(but->editvec, vec);
1732         }
1733
1734         if (but->rnaprop) {
1735                 prop = but->rnaprop;
1736
1737                 if (RNA_property_type(prop) == PROP_FLOAT) {
1738                         int tot;
1739                         int a;
1740
1741                         tot = RNA_property_array_length(&but->rnapoin, prop);
1742                         BLI_assert(tot > 0);
1743                         if (tot == 3) {
1744                                 RNA_property_float_set_array(&but->rnapoin, prop, vec);
1745                         }
1746                         else {
1747                                 tot = min_ii(tot, 3);
1748                                 for (a = 0; a < tot; a++) {
1749                                         RNA_property_float_set_index(&but->rnapoin, prop, a, vec[a]);
1750                                 }
1751                         }
1752                 }
1753         }
1754         else if (but->pointype == UI_BUT_POIN_CHAR) {
1755                 char *cp = (char *)but->poin;
1756                 cp[0] = (char)(0.5f + vec[0] * 255.0f);
1757                 cp[1] = (char)(0.5f + vec[1] * 255.0f);
1758                 cp[2] = (char)(0.5f + vec[2] * 255.0f);
1759         }
1760         else if (but->pointype == UI_BUT_POIN_FLOAT) {
1761                 float *fp = (float *)but->poin;
1762                 copy_v3_v3(fp, vec);
1763         }
1764 }
1765
1766 bool ui_but_is_float(const uiBut *but)
1767 {
1768         if (but->pointype == UI_BUT_POIN_FLOAT && but->poin)
1769                 return true;
1770
1771         if (but->rnaprop && RNA_property_type(but->rnaprop) == PROP_FLOAT)
1772                 return true;
1773
1774         return false;
1775 }
1776
1777 bool ui_but_is_bool(const uiBut *but)
1778 {
1779         if (ELEM(but->type, UI_BTYPE_TOGGLE, UI_BTYPE_TOGGLE_N, UI_BTYPE_ICON_TOGGLE, UI_BTYPE_ICON_TOGGLE_N))
1780                 return true;
1781
1782         if (but->rnaprop && RNA_property_type(but->rnaprop) == PROP_BOOLEAN)
1783                 return true;
1784
1785         if ((but->rnaprop && RNA_property_type(but->rnaprop) == PROP_ENUM) && (but->type == UI_BTYPE_ROW))
1786                 return true;
1787
1788         return false;
1789 }
1790
1791
1792 bool ui_but_is_unit(const uiBut *but)
1793 {
1794         UnitSettings *unit = but->block->unit;
1795         const int unit_type = UI_but_unit_type_get(but);
1796
1797         if (unit_type == PROP_UNIT_NONE)
1798                 return false;
1799
1800 #if 1 /* removed so angle buttons get correct snapping */
1801         if (ui_but_is_unit_radians_ex(unit, unit_type))
1802                 return false;
1803 #endif
1804
1805         /* for now disable time unit conversion */
1806         if (unit_type == PROP_UNIT_TIME)
1807                 return false;
1808
1809         if (unit->system == USER_UNIT_NONE) {
1810                 if (unit_type != PROP_UNIT_ROTATION) {
1811                         return false;
1812                 }
1813         }
1814
1815         return true;
1816 }
1817
1818 /**
1819  * Check if this button is similar enough to be grouped with another.
1820  */
1821 bool ui_but_is_compatible(const uiBut *but_a, const uiBut *but_b)
1822 {
1823         if (but_a->type != but_b->type)
1824                 return false;
1825         if (but_a->pointype != but_b->pointype)
1826                 return false;
1827
1828         if (but_a->rnaprop) {
1829                 /* skip 'rnapoin.data', 'rnapoin.id.data'
1830                  * allow different data to have the same props edited at once */
1831                 if (but_a->rnapoin.type != but_b->rnapoin.type)
1832                         return false;
1833                 if (RNA_property_type(but_a->rnaprop) != RNA_property_type(but_b->rnaprop))
1834                         return false;
1835                 if (RNA_property_subtype(but_a->rnaprop) != RNA_property_subtype(but_b->rnaprop))
1836                         return false;
1837         }
1838
1839         return true;
1840 }
1841
1842 bool ui_but_is_rna_valid(uiBut *but)
1843 {
1844         if (but->rnaprop == NULL || RNA_struct_contains_property(&but->rnapoin, but->rnaprop)) {
1845                 return true;
1846         }
1847         else {
1848                 printf("property removed %s: %p\n", but->drawstr, but->rnaprop);
1849                 return false;
1850         }
1851 }
1852
1853 /**
1854  * Checks if the button supports ctrl+mousewheel cycling
1855  */
1856 bool ui_but_supports_cycling(const uiBut *but)
1857 {
1858         return ((ELEM(but->type, UI_BTYPE_ROW, UI_BTYPE_NUM, UI_BTYPE_NUM_SLIDER, UI_BTYPE_LISTBOX)) ||
1859                 (but->type == UI_BTYPE_MENU && ui_but_menu_step_poll(but)) ||
1860                 (but->type == UI_BTYPE_COLOR && but->a1 != -1) ||
1861                 (but->menu_step_func != NULL));
1862 }
1863
1864 double ui_but_value_get(uiBut *but)
1865 {
1866         PropertyRNA *prop;
1867         double value = 0.0;
1868
1869         if (but->editval) { return *(but->editval); }
1870         if (but->poin == NULL && but->rnapoin.data == NULL) return 0.0;
1871
1872         if (but->rnaprop) {
1873                 prop = but->rnaprop;
1874
1875                 BLI_assert(but->rnaindex != -1);
1876
1877                 PointerRNA rnapoin_eval = ui_but_evaluated_rnapoin_get(but);
1878
1879                 switch (RNA_property_type(prop)) {
1880                         case PROP_BOOLEAN:
1881                                 if (RNA_property_array_check(prop))
1882                                         value = RNA_property_boolean_get_index(&rnapoin_eval, prop, but->rnaindex);
1883                                 else
1884                                         value = RNA_property_boolean_get(&rnapoin_eval, prop);
1885                                 break;
1886                         case PROP_INT:
1887                                 if (RNA_property_array_check(prop))
1888                                         value = RNA_property_int_get_index(&rnapoin_eval, prop, but->rnaindex);
1889                                 else
1890                                         value = RNA_property_int_get(&rnapoin_eval, prop);
1891                                 break;
1892                         case PROP_FLOAT:
1893                                 if (RNA_property_array_check(prop))
1894                                         value = RNA_property_float_get_index(&rnapoin_eval, prop, but->rnaindex);
1895                                 else
1896                                         value = RNA_property_float_get(&rnapoin_eval, prop);
1897                                 break;
1898                         case PROP_ENUM:
1899                                 value = RNA_property_enum_get(&rnapoin_eval, prop);
1900                                 break;
1901                         default:
1902                                 value = 0.0;
1903                                 break;
1904                 }
1905         }
1906         else if (but->pointype == UI_BUT_POIN_CHAR) {
1907                 value = *(char *)but->poin;
1908         }
1909         else if (but->pointype == UI_BUT_POIN_SHORT) {
1910                 value = *(short *)but->poin;
1911         }
1912         else if (but->pointype == UI_BUT_POIN_INT) {
1913                 value = *(int *)but->poin;
1914         }
1915         else if (but->pointype == UI_BUT_POIN_FLOAT) {
1916                 value = *(float *)but->poin;
1917         }
1918
1919         return value;
1920 }
1921
1922 void ui_but_value_set(uiBut *but, double value)
1923 {
1924         PropertyRNA *prop;
1925
1926         /* value is a hsv value: convert to rgb */
1927         if (but->rnaprop) {
1928                 prop = but->rnaprop;
1929
1930                 if (RNA_property_editable(&but->rnapoin, prop)) {
1931                         switch (RNA_property_type(prop)) {
1932                                 case PROP_BOOLEAN:
1933                                         if (RNA_property_array_check(prop))
1934                                                 RNA_property_boolean_set_index(&but->rnapoin, prop, but->rnaindex, value);
1935                                         else
1936                                                 RNA_property_boolean_set(&but->rnapoin, prop, value);
1937                                         break;
1938                                 case PROP_INT:
1939                                         if (RNA_property_array_check(prop))
1940                                                 RNA_property_int_set_index(&but->rnapoin, prop, but->rnaindex, (int)value);
1941                                         else
1942                                                 RNA_property_int_set(&but->rnapoin, prop, (int)value);
1943                                         break;
1944                                 case PROP_FLOAT:
1945                                         if (RNA_property_array_check(prop))
1946                                                 RNA_property_float_set_index(&but->rnapoin, prop, but->rnaindex, value);
1947                                         else
1948                                                 RNA_property_float_set(&but->rnapoin, prop, value);
1949                                         break;
1950                                 case PROP_ENUM:
1951                                         if (RNA_property_flag(prop) & PROP_ENUM_FLAG) {
1952                                                 int ivalue = (int)value;
1953                                                 ivalue ^= RNA_property_enum_get(&but->rnapoin, prop); /* toggle for enum/flag buttons */
1954                                                 RNA_property_enum_set(&but->rnapoin, prop, ivalue);
1955                                         }
1956                                         else {
1957                                                 RNA_property_enum_set(&but->rnapoin, prop, value);
1958                                         }
1959                                         break;
1960                                 default:
1961                                         break;
1962                         }
1963                 }
1964
1965                 /* we can't be sure what RNA set functions actually do,
1966                  * so leave this unset */
1967                 value = UI_BUT_VALUE_UNSET;
1968         }
1969         else if (but->pointype == 0) {
1970                 /* pass */
1971         }
1972         else {
1973                 /* first do rounding */
1974                 if (but->pointype == UI_BUT_POIN_CHAR) {
1975                         value = round_db_to_uchar_clamp(value);
1976                 }
1977                 else if (but->pointype == UI_BUT_POIN_SHORT) {
1978                         value = round_db_to_short_clamp(value);
1979                 }
1980                 else if (but->pointype == UI_BUT_POIN_INT) {
1981                         value = round_db_to_int_clamp(value);
1982                 }
1983                 else if (but->pointype == UI_BUT_POIN_FLOAT) {
1984                         float fval = (float)value;
1985                         if (fval >= -0.00001f && fval <= 0.00001f) fval = 0.0f;  /* prevent negative zero */
1986                         value = fval;
1987                 }
1988
1989                 /* then set value with possible edit override */
1990                 if (but->editval)
1991                         value = *but->editval = value;
1992                 else if (but->pointype == UI_BUT_POIN_CHAR)
1993                         value = *((char *)but->poin) = (char)value;
1994                 else if (but->pointype == UI_BUT_POIN_SHORT)
1995                         value = *((short *)but->poin) = (short)value;
1996                 else if (but->pointype == UI_BUT_POIN_INT)
1997                         value = *((int *)but->poin) = (int)value;
1998                 else if (but->pointype == UI_BUT_POIN_FLOAT)
1999                         value = *((float *)but->poin) = (float)value;
2000         }
2001
2002         ui_but_update_select_flag(but, &value);
2003 }
2004
2005 int ui_but_string_get_max_length(uiBut *but)
2006 {
2007         if (ELEM(but->type, UI_BTYPE_TEXT, UI_BTYPE_SEARCH_MENU))
2008                 return but->hardmax;
2009         else
2010                 return UI_MAX_DRAW_STR;
2011 }
2012
2013 uiBut *ui_but_drag_multi_edit_get(uiBut *but)
2014 {
2015         uiBut *but_iter;
2016
2017         BLI_assert(but->flag & UI_BUT_DRAG_MULTI);
2018
2019         for (but_iter = but->block->buttons.first; but_iter; but_iter = but_iter->next) {
2020                 if (but_iter->editstr) {
2021                         break;
2022                 }
2023         }
2024
2025         return but_iter;
2026 }
2027
2028 /** \name Check to show extra icons
2029  *
2030  * Extra icons are shown on the right hand side of buttons.
2031  * This could (should!) definitely become more generic, but for now this is good enough.
2032  * \{ */
2033
2034 static bool ui_but_icon_extra_is_visible_text_clear(const uiBut *but)
2035 {
2036         BLI_assert(but->type == UI_BTYPE_TEXT);
2037         return ((but->flag & UI_BUT_VALUE_CLEAR) && but->drawstr[0]);
2038 }
2039
2040 static bool ui_but_icon_extra_is_visible_search_unlink(const uiBut *but)
2041 {
2042         BLI_assert(ELEM(but->type, UI_BTYPE_SEARCH_MENU, UI_BTYPE_TAB));
2043         return ((but->editstr == NULL) &&
2044                 (but->drawstr[0] != '\0') &&
2045                 (but->flag & UI_BUT_VALUE_CLEAR));
2046 }
2047
2048 static bool ui_but_icon_extra_is_visible_search_eyedropper(uiBut *but)
2049 {
2050         StructRNA *type;
2051         short idcode;
2052
2053         BLI_assert(but->type == UI_BTYPE_SEARCH_MENU && (but->flag & UI_BUT_VALUE_CLEAR));
2054
2055         if (but->rnaprop == NULL) {
2056                 return false;
2057         }
2058
2059         type = RNA_property_pointer_type(&but->rnapoin, but->rnaprop);
2060         idcode = RNA_type_to_ID_code(type);
2061
2062         return ((but->editstr == NULL) &&
2063                 (idcode == ID_OB || OB_DATA_SUPPORT_ID(idcode)));
2064 }
2065
2066 uiButExtraIconType ui_but_icon_extra_get(uiBut *but)
2067 {
2068         switch (but->type) {
2069                 case UI_BTYPE_TEXT:
2070                         if (ui_but_icon_extra_is_visible_text_clear(but)) {
2071                                 return UI_BUT_ICONEXTRA_CLEAR;
2072                         }
2073                         break;
2074                 case UI_BTYPE_SEARCH_MENU:
2075                         if ((but->flag & UI_BUT_VALUE_CLEAR) == 0) {
2076                                 /* pass */
2077                         }
2078                         else if (ui_but_icon_extra_is_visible_search_unlink(but)) {
2079                                 return UI_BUT_ICONEXTRA_CLEAR;
2080                         }
2081                         else if (ui_but_icon_extra_is_visible_search_eyedropper(but)) {
2082                                 return UI_BUT_ICONEXTRA_EYEDROPPER;
2083                         }
2084                         break;
2085                 case UI_BTYPE_TAB:
2086                         if (ui_but_icon_extra_is_visible_search_unlink(but)) {
2087                                 return UI_BUT_ICONEXTRA_CLEAR;
2088                         }
2089                         break;
2090                 default:
2091                         break;
2092         }
2093
2094         return UI_BUT_ICONEXTRA_NONE;
2095 }
2096
2097 /** \} */
2098
2099
2100 static double ui_get_but_scale_unit(uiBut *but, double value)
2101 {
2102         UnitSettings *unit = but->block->unit;
2103         int unit_type = UI_but_unit_type_get(but);
2104
2105         /* Time unit is a bit special, not handled by BKE_scene_unit_scale() for now. */
2106         if (unit_type == PROP_UNIT_TIME) { /* WARNING - using evil_C :| */
2107                 Scene *scene = CTX_data_scene(but->block->evil_C);
2108                 return FRA2TIME(value);
2109         }
2110         else {
2111                 return BKE_scene_unit_scale(unit, RNA_SUBTYPE_UNIT_VALUE(unit_type), value);
2112         }
2113 }
2114
2115 /* str will be overwritten */
2116 void ui_but_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen)
2117 {
2118         if (ui_but_is_unit(but)) {
2119                 UnitSettings *unit = but->block->unit;
2120                 int unit_type = UI_but_unit_type_get(but);
2121                 char *orig_str;
2122
2123                 orig_str = BLI_strdup(str);
2124
2125                 bUnit_ToUnitAltName(str, maxlen, orig_str, unit->system, RNA_SUBTYPE_UNIT_VALUE(unit_type));
2126
2127                 MEM_freeN(orig_str);
2128         }
2129 }
2130
2131 /**
2132  * \param float_precision  Override the button precision.
2133  */
2134 static void ui_get_but_string_unit(uiBut *but, char *str, int len_max, double value, bool pad, int float_precision)
2135 {
2136         UnitSettings *unit = but->block->unit;
2137         const bool do_split = (unit->flag & USER_UNIT_OPT_SPLIT) != 0;
2138         int unit_type = UI_but_unit_type_get(but);
2139         int precision;
2140
2141         if (unit->scale_length < 0.0001f) unit->scale_length = 1.0f;  // XXX do_versions
2142
2143         /* Use precision override? */
2144         if (float_precision == -1) {
2145                 /* Sanity checks */
2146                 precision = (int)but->a2;
2147                 if      (precision > UI_PRECISION_FLOAT_MAX) precision = UI_PRECISION_FLOAT_MAX;
2148                 else if (precision == -1)                    precision = 2;
2149         }
2150         else {
2151                 precision = float_precision;
2152         }
2153
2154         bUnit_AsString(
2155                 str, len_max, ui_get_but_scale_unit(but, value), precision,
2156                 unit->system, RNA_SUBTYPE_UNIT_VALUE(unit_type), do_split, pad);
2157 }
2158
2159 static float ui_get_but_step_unit(uiBut *but, float step_default)
2160 {
2161         int unit_type = RNA_SUBTYPE_UNIT_VALUE(UI_but_unit_type_get(but));
2162         const double step_orig = step_default * UI_PRECISION_FLOAT_SCALE;
2163         /* Scaling up 'step_origg ' here is a bit arbitrary, its just giving better scales from user POV */
2164         const double scale_step = ui_get_but_scale_unit(but, step_orig * 10);
2165         const double step = bUnit_ClosestScalar(scale_step, but->block->unit->system, unit_type);
2166
2167         /* -1 is an error value */
2168         if (step != -1.0) {
2169                 const double scale_unit = ui_get_but_scale_unit(but, 1.0);
2170                 const double step_unit = bUnit_ClosestScalar(scale_unit, but->block->unit->system, unit_type);
2171                 double step_final;
2172
2173                 BLI_assert(step > 0.0);
2174
2175                 step_final = (step / scale_unit) / (double)UI_PRECISION_FLOAT_SCALE;
2176
2177                 if (step == step_unit) {
2178                         /* Logic here is to scale by the original 'step_orig'
2179                          * only when the unit step matches the scaled step.
2180                          *
2181                          * This is needed for units that don't have a wide range of scales (degrees for eg.).
2182                          * Without this we can't select between a single degree, or a 10th of a degree.
2183                          */
2184                         step_final *= step_orig;
2185                 }
2186
2187                 return (float)step_final;
2188         }
2189         else {
2190                 return step_default;
2191         }
2192 }
2193
2194 /**
2195  * \param float_precision  For number buttons the precision to use or -1 to fallback to the button default.
2196  * \param use_exp_float  Use exponent representation of floats when out of reasonable range (outside of 1e3/1e-3).
2197  */
2198 void ui_but_string_get_ex(uiBut *but, char *str, const size_t maxlen, const int float_precision, const bool use_exp_float, bool *r_use_exp_float)
2199 {
2200         if (r_use_exp_float) {
2201                 *r_use_exp_float = false;
2202         }
2203
2204         if (but->rnaprop && ELEM(but->type, UI_BTYPE_TEXT, UI_BTYPE_SEARCH_MENU, UI_BTYPE_TAB)) {
2205                 PropertyType type;
2206                 const char *buf = NULL;
2207                 int buf_len;
2208
2209                 type = RNA_property_type(but->rnaprop);
2210
2211                 if ((but->type == UI_BTYPE_TAB) && (but->custom_data)) {
2212                         StructRNA *ptr_type = RNA_property_pointer_type(&but->rnapoin, but->rnaprop);
2213                         PointerRNA ptr;
2214
2215                         /* uiBut.custom_data points to data this tab represents (e.g. workspace).
2216                          * uiBut.rnapoin/prop store an active value (e.g. active workspace). */
2217                         RNA_pointer_create(but->rnapoin.id.data, ptr_type, but->custom_data, &ptr);
2218                         buf = RNA_struct_name_get_alloc(&ptr, str, maxlen, &buf_len);
2219                 }
2220                 else if (type == PROP_STRING) {
2221                         /* RNA string */
2222                         buf = RNA_property_string_get_alloc(&but->rnapoin, but->rnaprop, str, maxlen, &buf_len);
2223                 }
2224                 else if (type == PROP_ENUM) {
2225                         /* RNA enum */
2226                         int value = RNA_property_enum_get(&but->rnapoin, but->rnaprop);
2227                         if (RNA_property_enum_name(but->block->evil_C, &but->rnapoin, but->rnaprop, value, &buf)) {
2228                                 BLI_strncpy(str, buf, maxlen);
2229                                 buf = str;
2230                         }
2231                 }
2232                 else if (type == PROP_POINTER) {
2233                         /* RNA pointer */
2234                         PointerRNA ptr = RNA_property_pointer_get(&but->rnapoin, but->rnaprop);
2235                         buf = RNA_struct_name_get_alloc(&ptr, str, maxlen, &buf_len);
2236                 }
2237                 else {
2238                         BLI_assert(0);
2239                 }
2240
2241                 if (!buf) {
2242                         str[0] = '\0';
2243                 }
2244                 else if (buf && buf != str) {
2245                         BLI_assert(maxlen <= buf_len + 1);
2246                         /* string was too long, we have to truncate */
2247                         if (ui_but_is_utf8(but)) {
2248                                 BLI_strncpy_utf8(str, buf, maxlen);
2249                         }
2250                         else {
2251                                 BLI_strncpy(str, buf, maxlen);
2252                         }
2253                         MEM_freeN((void *)buf);
2254                 }
2255         }
2256         else if (ELEM(but->type, UI_BTYPE_TEXT, UI_BTYPE_SEARCH_MENU)) {
2257                 /* string */
2258                 BLI_strncpy(str, but->poin, maxlen);
2259                 return;
2260         }
2261         else if (ui_but_anim_expression_get(but, str, maxlen)) {
2262                 /* driver expression */
2263         }
2264         else {
2265                 /* number editing */
2266                 double value;
2267
2268                 value = ui_but_value_get(but);
2269
2270                 if (ui_but_is_float(but)) {
2271                         if (ui_but_is_unit(but)) {
2272                                 ui_get_but_string_unit(but, str, maxlen, value, false, float_precision);
2273                         }
2274                         else {
2275                                 int prec = (float_precision == -1) ? ui_but_calc_float_precision(but, value) : float_precision;
2276                                 if (use_exp_float) {
2277                                         const int int_digits_num = integer_digits_f(value);
2278                                         if (int_digits_num < -6 || int_digits_num > 12) {
2279                                                 BLI_snprintf(str, maxlen, "%.*g", prec, value);
2280                                                 if (r_use_exp_float) {
2281                                                         *r_use_exp_float = true;
2282                                                 }
2283                                         }
2284                                         else {
2285                                                 prec -= int_digits_num;
2286                                                 CLAMP(prec, 0, UI_PRECISION_FLOAT_MAX);
2287                                                 BLI_snprintf(str, maxlen, "%.*f", prec, value);
2288                                         }
2289                                 }
2290                                 else {
2291 #if 0                           /* TODO, but will likely break some stuff, so better after 2.79 release. */
2292                                         prec -= int_digits_num;
2293                                         CLAMP(prec, 0, UI_PRECISION_FLOAT_MAX);
2294 #endif
2295                                         BLI_snprintf(str, maxlen, "%.*f", prec, value);
2296                                 }
2297                         }
2298                 }
2299                 else {
2300                         BLI_snprintf(str, maxlen, "%d", (int)value);
2301                 }
2302         }
2303 }
2304 void ui_but_string_get(uiBut *but, char *str, const size_t maxlen)
2305 {
2306         ui_but_string_get_ex(but, str, maxlen, -1, false, NULL);
2307 }
2308
2309 /**
2310  * A version of #ui_but_string_get_ex for dynamic buffer sizes
2311  * (where #ui_but_string_get_max_length returns 0).
2312  *
2313  * \param r_str_size: size of the returned string (including terminator).
2314  */
2315 char *ui_but_string_get_dynamic(uiBut *but, int *r_str_size)
2316 {
2317         char *str = NULL;
2318         *r_str_size = 1;
2319
2320         if (but->rnaprop && ELEM(but->type, UI_BTYPE_TEXT, UI_BTYPE_SEARCH_MENU)) {
2321                 PropertyType type;
2322
2323                 type = RNA_property_type(but->rnaprop);
2324
2325                 if (type == PROP_STRING) {
2326                         /* RNA string */
2327                         str = RNA_property_string_get_alloc(&but->rnapoin, but->rnaprop, NULL, 0, r_str_size);
2328                         (*r_str_size) += 1;
2329                 }
2330                 else if (type == PROP_ENUM) {
2331                         /* RNA enum */
2332                         int value = RNA_property_enum_get(&but->rnapoin, but->rnaprop);
2333                         const char *value_id;
2334                         if (!RNA_property_enum_name(but->block->evil_C, &but->rnapoin, but->rnaprop, value, &value_id)) {
2335                                 value_id = "";
2336                         }
2337
2338                         *r_str_size = strlen(value_id) + 1;
2339                         str = BLI_strdupn(value_id, *r_str_size);
2340                 }
2341                 else if (type == PROP_POINTER) {
2342                         /* RNA pointer */
2343                         PointerRNA ptr = RNA_property_pointer_get(&but->rnapoin, but->rnaprop);
2344                         str = RNA_struct_name_get_alloc(&ptr, NULL, 0, r_str_size);
2345                         (*r_str_size) += 1;
2346                 }
2347                 else {
2348                         BLI_assert(0);
2349                 }
2350         }
2351         else {
2352                 BLI_assert(0);
2353         }
2354
2355         if (UNLIKELY(str == NULL)) {
2356                 /* should never happen, paranoid check */
2357                 *r_str_size = 1;
2358                 str = BLI_strdup("");
2359                 BLI_assert(0);
2360
2361         }
2362
2363         return str;
2364 }
2365
2366 #ifdef WITH_PYTHON
2367
2368 static bool ui_set_but_string_eval_num_unit(bContext *C, uiBut *but, const char *str, double *r_value)
2369 {
2370         char str_unit_convert[256];
2371         const int unit_type = UI_but_unit_type_get(but);
2372
2373         BLI_strncpy(str_unit_convert, str, sizeof(str_unit_convert));
2374
2375         /* ugly, use the draw string to get the value,
2376          * this could cause problems if it includes some text which resolves to a unit */
2377         bUnit_ReplaceString(
2378                 str_unit_convert, sizeof(str_unit_convert), but->drawstr,
2379                 ui_get_but_scale_unit(but, 1.0), but->block->unit->system, RNA_SUBTYPE_UNIT_VALUE(unit_type));
2380
2381         return BPY_execute_string_as_number(C, str_unit_convert, true, r_value);
2382 }
2383
2384 #endif /* WITH_PYTHON */
2385
2386
2387 bool ui_but_string_set_eval_num(bContext *C, uiBut *but, const char *str, double *r_value)
2388 {
2389         bool ok = false;
2390
2391 #ifdef WITH_PYTHON
2392
2393         if (str[0] != '\0') {
2394                 bool is_unit_but = (ui_but_is_float(but) && ui_but_is_unit(but));
2395                 /* only enable verbose if we won't run again with units */
2396                 if (BPY_execute_string_as_number(C, str, is_unit_but == false, r_value)) {
2397                         /* if the value parsed ok without unit conversion this button may still need a unit multiplier */
2398                         if (is_unit_but) {
2399                                 char str_new[128];
2400
2401                                 BLI_snprintf(str_new, sizeof(str_new), "%f", *r_value);
2402                                 ok = ui_set_but_string_eval_num_unit(C, but, str_new, r_value);
2403                         }
2404                         else {
2405                                 ok = true; /* parse normal string via py (no unit conversion needed) */
2406                         }
2407                 }
2408                 else if (is_unit_but) {
2409                         /* parse failed, this is a unit but so run replacements and parse again */
2410                         ok = ui_set_but_string_eval_num_unit(C, but, str, r_value);
2411                 }
2412         }
2413
2414 #else /* WITH_PYTHON */
2415
2416         *r_value = atof(str);
2417         ok = true;
2418
2419         UNUSED_VARS(C, but);
2420
2421 #endif /* WITH_PYTHON */
2422
2423         return ok;
2424 }
2425
2426 /* just the assignment/free part */
2427 static void ui_but_string_set_internal(uiBut *but, const char *str, size_t str_len)
2428 {
2429         BLI_assert(str_len == strlen(str));
2430         BLI_assert(but->str == NULL);
2431         str_len += 1;
2432
2433         if (str_len > UI_MAX_NAME_STR) {
2434                 but->str = MEM_mallocN(str_len, "ui_def_but str");
2435         }
2436         else {
2437                 but->str = but->strdata;
2438         }
2439         memcpy(but->str, str, str_len);
2440 }
2441
2442 static void ui_but_string_free_internal(uiBut *but)
2443 {
2444         if (but->str) {
2445                 if (but->str != but->strdata) {
2446                         MEM_freeN(but->str);
2447                 }
2448                 /* must call 'ui_but_string_set_internal' after */
2449                 but->str = NULL;
2450         }
2451 }
2452
2453 bool ui_but_string_set(bContext *C, uiBut *but, const char *str)
2454 {
2455         if (but->rnaprop && but->rnapoin.data && ELEM(but->type, UI_BTYPE_TEXT, UI_BTYPE_SEARCH_MENU)) {
2456                 if (RNA_property_editable(&but->rnapoin, but->rnaprop)) {
2457                         PropertyType type;
2458
2459                         type = RNA_property_type(but->rnaprop);
2460
2461                         if (type == PROP_STRING) {
2462                                 /* RNA string */
2463                                 RNA_property_string_set(&but->rnapoin, but->rnaprop, str);
2464                                 return true;
2465                         }
2466                         else if (type == PROP_POINTER) {
2467                                 if (str[0] == '\0') {
2468                                         RNA_property_pointer_set(&but->rnapoin, but->rnaprop, PointerRNA_NULL);
2469                                         return true;
2470                                 }
2471                                 else {
2472                                         /* RNA pointer */
2473                                         PointerRNA rptr;
2474                                         PointerRNA ptr = but->rnasearchpoin;
2475                                         PropertyRNA *prop = but->rnasearchprop;
2476
2477                                         if (prop && RNA_property_collection_lookup_string(&ptr, prop, str, &rptr))
2478                                                 RNA_property_pointer_set(&but->rnapoin, but->rnaprop, rptr);
2479
2480                                         return true;
2481                                 }
2482
2483                                 return false;
2484                         }
2485                         else if (type == PROP_ENUM) {
2486                                 int value;
2487                                 if (RNA_property_enum_value(but->block->evil_C, &but->rnapoin, but->rnaprop, str, &value)) {
2488                                         RNA_property_enum_set(&but->rnapoin, but->rnaprop, value);
2489                                         return true;
2490                                 }
2491                                 return false;
2492                         }
2493                         else {
2494                                 BLI_assert(0);
2495                         }
2496                 }
2497         }
2498         else if (but->type == UI_BTYPE_TAB) {
2499                 if (but->rnaprop && but->custom_data) {
2500                         StructRNA *ptr_type = RNA_property_pointer_type(&but->rnapoin, but->rnaprop);
2501                         PointerRNA ptr;
2502                         PropertyRNA *prop;
2503
2504                         /* uiBut.custom_data points to data this tab represents (e.g. workspace).
2505                          * uiBut.rnapoin/prop store an active value (e.g. active workspace). */
2506                         RNA_pointer_create(but->rnapoin.id.data, ptr_type, but->custom_data, &ptr);
2507                         prop = RNA_struct_name_property(ptr_type);
2508                         if (RNA_property_editable(&ptr, prop)) {
2509                                 RNA_property_string_set(&ptr, prop, str);
2510                         }
2511                 }
2512         }
2513         else if (but->type == UI_BTYPE_TEXT) {
2514                 /* string */
2515                 if (!but->poin || (str[0] == '\0')) {
2516                         str = "";
2517                 }
2518                 else if (ui_but_is_utf8(but)) {
2519                         BLI_strncpy_utf8(but->poin, str, but->hardmax);
2520                 }
2521                 else {
2522                         BLI_strncpy(but->poin, str, but->hardmax);
2523                 }
2524
2525                 return true;
2526         }
2527         else if (but->type == UI_BTYPE_SEARCH_MENU) {
2528                 /* string */
2529                 BLI_strncpy(but->poin, str, but->hardmax);
2530                 return true;
2531         }
2532         else if (ui_but_anim_expression_set(but, str)) {
2533                 /* driver expression */
2534                 return true;
2535         }
2536         else if (str[0] == '#') {
2537                 /* shortcut to create new driver expression (versus immediate Py-execution) */
2538                 return ui_but_anim_expression_create(but, str + 1);
2539         }
2540         else {
2541                 /* number editing */
2542                 double value;
2543
2544                 if (ui_but_string_set_eval_num(C, but, str, &value) == false) {
2545                         WM_report_banner_show();
2546                         return false;
2547                 }
2548
2549                 if (!ui_but_is_float(but)) {
2550                         value = floor(value + 0.5);
2551                 }
2552
2553                 /* not that we use hard limits here */
2554                 if (value < (double)but->hardmin) value = but->hardmin;
2555                 if (value > (double)but->hardmax) value = but->hardmax;
2556
2557                 ui_but_value_set(but, value);
2558                 return true;
2559         }
2560
2561         return false;
2562 }
2563
2564 void ui_but_default_set(bContext *C, const bool all, const bool use_afterfunc)
2565 {
2566         wmOperatorType *ot = WM_operatortype_find("UI_OT_reset_default_button", true);
2567
2568         if (use_afterfunc) {
2569                 PointerRNA *ptr;
2570                 ptr = ui_handle_afterfunc_add_operator(ot, WM_OP_EXEC_DEFAULT, true);
2571                 RNA_boolean_set(ptr, "all", all);
2572         }
2573         else {
2574                 PointerRNA ptr;
2575                 WM_operator_properties_create_ptr(&ptr, ot);
2576                 RNA_boolean_set(&ptr, "all", all);
2577                 WM_operator_name_call_ptr(C, ot, WM_OP_EXEC_DEFAULT, &ptr);
2578                 WM_operator_properties_free(&ptr);
2579         }
2580 }
2581
2582 static double soft_range_round_up(double value, double max)
2583 {
2584         /* round up to .., 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 50, ..
2585          * checking for 0.0 prevents floating point exceptions */
2586         double newmax = (value != 0.0) ? pow(10.0, ceil(log(value) / M_LN10)) : 0.0;
2587
2588         if (newmax * 0.2 >= max && newmax * 0.2 >= value)
2589                 return newmax * 0.2;
2590         else if (newmax * 0.5 >= max && newmax * 0.5 >= value)
2591                 return newmax * 0.5;
2592         else
2593                 return newmax;
2594 }
2595
2596 static double soft_range_round_down(double value, double max)
2597 {
2598         /* round down to .., 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 50, ..
2599          * checking for 0.0 prevents floating point exceptions */
2600         double newmax = (value != 0.0) ? pow(10.0, floor(log(value) / M_LN10)) : 0.0;
2601
2602         if (newmax * 5.0 <= max && newmax * 5.0 <= value)
2603                 return newmax * 5.0;
2604         else if (newmax * 2.0 <= max && newmax * 2.0 <= value)
2605                 return newmax * 2.0;
2606         else
2607                 return newmax;
2608 }
2609
2610 /* note: this could be split up into functions which handle arrays and not */
2611 static void ui_set_but_soft_range(uiBut *but)
2612 {
2613         /* ideally we would not limit this but practically, its more than
2614          * enough worst case is very long vectors wont use a smart soft-range
2615          * which isn't so bad. */
2616
2617         if (but->rnaprop) {
2618                 const PropertyType type = RNA_property_type(but->rnaprop);
2619                 double softmin, softmax /*, step, precision*/;
2620                 double value_min;
2621                 double value_max;
2622
2623                 /* clamp button range to something reasonable in case
2624                  * we get -inf/inf from RNA properties */
2625                 if (type == PROP_INT) {
2626                         const bool is_array = RNA_property_array_check(but->rnaprop);
2627                         int imin, imax, istep;
2628
2629                         RNA_property_int_ui_range(&but->rnapoin, but->rnaprop, &imin, &imax, &istep);
2630                         softmin = (imin == INT_MIN) ? -1e4 : imin;
2631                         softmax = (imin == INT_MAX) ? 1e4 : imax;
2632                         /*step = istep;*/ /*UNUSED*/
2633                         /*precision = 1;*/ /*UNUSED*/
2634
2635                         if (is_array) {
2636                                 int value_range[2];
2637                                 RNA_property_int_get_array_range(&but->rnapoin, but->rnaprop, value_range);
2638                                 value_min = (double)value_range[0];
2639                                 value_max = (double)value_range[1];
2640                         }
2641                         else {
2642                                 value_min = value_max = (double)RNA_property_int_get(&but->rnapoin, but->rnaprop);
2643                         }
2644                 }
2645                 else if (type == PROP_FLOAT) {
2646                         const bool is_array = RNA_property_array_check(but->rnaprop);
2647                         float fmin, fmax, fstep, fprecision;
2648
2649                         RNA_property_float_ui_range(&but->rnapoin, but->rnaprop, &fmin, &fmax, &fstep, &fprecision);
2650                         softmin = (fmin == -FLT_MAX) ? (float)-1e4 : fmin;
2651                         softmax = (fmax == FLT_MAX) ? (float)1e4 : fmax;
2652                         /*step = fstep;*/ /*UNUSED*/
2653                         /*precision = fprecision;*/ /*UNUSED*/
2654
2655                         if (is_array) {
2656                                 float value_range[2];
2657                                 RNA_property_float_get_array_range(&but->rnapoin, but->rnaprop, value_range);
2658                                 value_min = (double)value_range[0];
2659                                 value_max = (double)value_range[1];
2660                         }
2661                         else {
2662                                 value_min = value_max = (double)RNA_property_float_get(&but->rnapoin, but->rnaprop);
2663                         }
2664                 }
2665                 else {
2666                         return;
2667                 }
2668
2669                 /* if the value goes out of the soft/max range, adapt the range */
2670                 if (value_min + 1e-10 < softmin) {
2671                         if (value_min < 0.0)
2672                                 softmin = -soft_range_round_up(-value_min, -softmin);
2673                         else
2674                                 softmin = soft_range_round_down(value_min, softmin);
2675
2676                         if (softmin < (double)but->hardmin)
2677                                 softmin = (double)but->hardmin;
2678                 }
2679                 if (value_max - 1e-10 > softmax) {
2680                         if (value_max < 0.0)
2681                                 softmax = -soft_range_round_down(-value_max, -softmax);
2682                         else
2683                                 softmax = soft_range_round_up(value_max, softmax);
2684
2685                         if (softmax > (double)but->hardmax)
2686                                 softmax = but->hardmax;
2687                 }
2688
2689                 but->softmin = softmin;
2690                 but->softmax = softmax;
2691         }
2692         else if (but->poin && (but->pointype & UI_BUT_POIN_TYPES)) {
2693                 float value = ui_but_value_get(but);
2694                 if (isfinite(value)) {
2695                         CLAMP(value, but->hardmin, but->hardmax);
2696                         but->softmin = min_ff(but->softmin, value);
2697                         but->softmax = max_ff(but->softmax, value);
2698                 }
2699         }
2700         else {
2701                 BLI_assert(0);
2702         }
2703 }
2704
2705 /* ******************* Free ********************/
2706
2707 /* can be called with C==NULL */
2708 static void ui_but_free(const bContext *C, uiBut *but)
2709 {
2710         if (but->opptr) {
2711                 WM_operator_properties_free(but->opptr);
2712                 MEM_freeN(but->opptr);
2713         }
2714
2715         if (but->func_argN) {
2716                 MEM_freeN(but->func_argN);
2717         }
2718
2719         if (but->tip_argN) {
2720                 MEM_freeN(but->tip_argN);
2721         }
2722
2723         if (but->hold_argN) {
2724                 MEM_freeN(but->hold_argN);
2725         }
2726
2727         if (!but->editstr && but->free_search_arg) {
2728                 MEM_SAFE_FREE(but->search_arg);
2729         }
2730
2731         if (but->active) {
2732                 /* XXX solve later, buttons should be free-able without context ideally,
2733                  * however they may have open tooltips or popup windows, which need to
2734                  * be closed using a context pointer */
2735                 if (C) {
2736                         ui_but_active_free(C, but);
2737                 }
2738                 else {
2739                         if (but->active) {
2740                                 MEM_freeN(but->active);
2741                         }
2742                 }
2743         }
2744         if (but->str && but->str != but->strdata) {
2745                 MEM_freeN(but->str);
2746         }
2747
2748         if ((but->type == UI_BTYPE_IMAGE) && but->poin) {
2749                 IMB_freeImBuf((struct ImBuf *)but->poin);
2750         }
2751
2752         if (but->dragpoin && (but->dragflag & UI_BUT_DRAGPOIN_FREE)) {
2753                 MEM_freeN(but->dragpoin);
2754         }
2755
2756         BLI_assert(UI_butstore_is_registered(but->block, but) == false);
2757
2758         MEM_freeN(but);
2759 }
2760
2761 /* can be called with C==NULL */
2762 void UI_block_free(const bContext *C, uiBlock *block)
2763 {
2764         uiBut *but;
2765
2766         UI_butstore_clear(block);
2767
2768         while ((but = BLI_pophead(&block->buttons))) {
2769                 ui_but_free(C, but);
2770         }
2771
2772         if (block->unit) {
2773                 MEM_freeN(block->unit);
2774         }
2775
2776         if (block->func_argN) {
2777                 MEM_freeN(block->func_argN);
2778         }
2779
2780         CTX_store_free_list(&block->contexts);
2781
2782         BLI_freelistN(&block->saferct);
2783         BLI_freelistN(&block->color_pickers.list);
2784
2785         MEM_freeN(block);
2786 }
2787
2788 void UI_blocklist_update_window_matrix(const bContext *C, const ListBase *lb)
2789 {
2790         ARegion *region = CTX_wm_region(C);
2791         wmWindow *window = CTX_wm_window(C);
2792
2793         for (uiBlock *block = lb->first; block; block = block->next) {
2794                 if (block->active) {
2795                         ui_update_window_matrix(window, region, block);
2796                 }
2797         }
2798 }
2799
2800 void UI_blocklist_draw(const bContext *C, const ListBase *lb)
2801 {
2802         for (uiBlock *block = lb->first; block; block = block->next) {
2803                 if (block->active) {
2804                         UI_block_draw(C, block);
2805                 }
2806         }
2807 }
2808
2809 /* can be called with C==NULL */
2810 void UI_blocklist_free(const bContext *C, ListBase *lb)
2811 {
2812         uiBlock *block;
2813
2814         while ((block = BLI_pophead(lb))) {
2815                 UI_block_free(C, block);
2816         }
2817 }
2818
2819 void UI_blocklist_free_inactive(const bContext *C, ListBase *lb)
2820 {
2821         uiBlock *block, *nextblock;
2822
2823         for (block = lb->first; block; block = nextblock) {
2824                 nextblock = block->next;
2825
2826                 if (!block->handle) {
2827                         if (!block->active) {
2828                                 BLI_remlink(lb, block);
2829                                 UI_block_free(C, block);
2830                         }
2831                         else
2832                                 block->active = 0;
2833                 }
2834         }
2835 }
2836
2837 void UI_block_region_set(uiBlock *block, ARegion *region)
2838 {
2839         ListBase *lb = &region->uiblocks;
2840         uiBlock *oldblock = NULL;
2841
2842         /* each listbase only has one block with this name, free block
2843          * if is already there so it can be rebuilt from scratch */
2844         if (lb) {
2845                 oldblock = BLI_findstring(lb, block->name, offsetof(uiBlock, name));
2846
2847                 if (oldblock) {
2848                         oldblock->active = 0;
2849                         oldblock->panel = NULL;
2850                         oldblock->handle = NULL;
2851                 }
2852
2853                 /* at the beginning of the list! for dynamical menus/blocks */
2854                 BLI_addhead(lb, block);
2855         }
2856
2857         block->oldblock = oldblock;
2858 }
2859
2860 uiBlock *UI_block_begin(const bContext *C, ARegion *region, const char *name, short dt)
2861 {
2862         uiBlock *block;
2863         wmWindow *window;
2864         Scene *scn;
2865
2866         window = CTX_wm_window(C);
2867         scn = CTX_data_scene(C);
2868
2869         block = MEM_callocN(sizeof(uiBlock), "uiBlock");
2870         block->active = 1;
2871         block->dt = dt;
2872         block->evil_C = (void *)C;  /* XXX */
2873
2874         if (scn) {
2875                 block->color_profile = true;
2876
2877                 /* store display device name, don't lookup for transformations yet
2878                  * block could be used for non-color displays where looking up for transformation
2879                  * would slow down redraw, so only lookup for actual transform when it's indeed
2880                  * needed
2881                  */
2882                 BLI_strncpy(block->display_device, scn->display_settings.display_device, sizeof(block->display_device));
2883
2884                 /* copy to avoid crash when scene gets deleted with ui still open */
2885                 block->unit = MEM_mallocN(sizeof(scn->unit), "UI UnitSettings");
2886                 memcpy(block->unit, &scn->unit, sizeof(scn->unit));
2887         }
2888
2889         BLI_strncpy(block->name, name, sizeof(block->name));
2890
2891         if (region)
2892                 UI_block_region_set(block, region);
2893
2894         /* Set window matrix and aspect for region and OpenGL state. */
2895         ui_update_window_matrix(window, region, block);
2896
2897         /* Tag as popup menu if not created within a region. */
2898         if (!(region && region->visible)) {
2899                 block->auto_open = true;
2900                 block->flag |= UI_BLOCK_LOOP;
2901         }
2902
2903         return block;
2904 }
2905
2906 void UI_block_emboss_set(uiBlock *block, char dt)
2907 {
2908         block->dt = dt;
2909 }
2910
2911 /**
2912  * \param but: Button to update.
2913  * \param validate: When set, this function may change the button value.
2914  * Otherwise treat the button value as read-only.
2915  */
2916 void ui_but_update_ex(uiBut *but, const bool validate)
2917 {
2918         /* if something changed in the button */
2919         double value = UI_BUT_VALUE_UNSET;
2920 //      float okwidth; // UNUSED
2921
2922         ui_but_update_select_flag(but, &value);
2923
2924         /* only update soft range while not editing */
2925         if (!(but->editval || but->editstr || but->editvec)) {
2926                 if ((but->rnaprop != NULL) ||
2927                     (but->poin && (but->pointype & UI_BUT_POIN_TYPES)))
2928                 {
2929                         ui_set_but_soft_range(but);
2930                 }
2931         }
2932
2933         /* test for min and max, icon sliders, etc */
2934         switch (but->type) {
2935                 case UI_BTYPE_NUM:
2936                 case UI_BTYPE_SCROLL:
2937                 case UI_BTYPE_NUM_SLIDER:
2938                         if (validate) {
2939                                 UI_GET_BUT_VALUE_INIT(but, value);
2940                                 if      (value < (double)but->hardmin) {
2941                                         ui_but_value_set(but, but->hardmin);
2942                                 }
2943                                 else if (value > (double)but->hardmax) {
2944                                         ui_but_value_set(but, but->hardmax);
2945                                 }
2946
2947                                 /* max must never be smaller than min! Both being equal is allowed though */
2948                                 BLI_assert(but->softmin <= but->softmax &&
2949                                            but->hardmin <= but->hardmax);
2950                         }
2951                         break;
2952
2953                 case UI_BTYPE_ICON_TOGGLE:
2954                 case UI_BTYPE_ICON_TOGGLE_N:
2955                         if (!but->rnaprop || (RNA_property_flag(but->rnaprop) & PROP_ICONS_CONSECUTIVE)) {
2956                                 if (but->flag & UI_SELECT) but->iconadd = 1;
2957                                 else but->iconadd = 0;
2958                         }
2959                         break;
2960
2961                         /* quiet warnings for unhandled types */
2962                 default:
2963                         break;
2964         }
2965
2966
2967         /* safety is 4 to enable small number buttons (like 'users') */
2968         // okwidth = -4 + (BLI_rcti_size_x(&but->rect)); // UNUSED
2969
2970         /* name: */
2971         switch (but->type) {
2972
2973                 case UI_BTYPE_MENU:
2974                         if (BLI_rctf_size_x(&but->rect) >= (UI_UNIT_X * 2)) {
2975                                 /* only needed for menus in popup blocks that don't recreate buttons on redraw */
2976                                 if (but->block->flag & UI_BLOCK_LOOP) {
2977                                         if (but->rnaprop && (RNA_property_type(but->rnaprop) == PROP_ENUM)) {
2978                                                 int value_enum = RNA_property_enum_get(&but->rnapoin, but->rnaprop);
2979
2980                                                 EnumPropertyItem item;
2981                                                 if (RNA_property_enum_item_from_value_gettexted(
2982                                                         but->block->evil_C,
2983                                                         &but->rnapoin, but->rnaprop, value_enum, &item))
2984                                                 {
2985                                                         size_t slen = strlen(item.name);
2986                                                         ui_but_string_free_internal(but);
2987                                                         ui_but_string_set_internal(but, item.name, slen);
2988                                                         but->icon = item.icon;
2989                                                 }
2990                                         }
2991                                 }
2992                                 BLI_strncpy(but->drawstr, but->str, sizeof(but->drawstr));
2993                         }
2994                         break;
2995
2996                 case UI_BTYPE_NUM:
2997                 case UI_BTYPE_NUM_SLIDER:
2998
2999                         if (!but->editstr) {
3000                                 const char *drawstr_suffix = NULL;
3001                                 size_t slen;
3002
3003                                 UI_GET_BUT_VALUE_INIT(but, value);
3004
3005                                 slen = BLI_strncpy_rlen(but->drawstr, but->str, sizeof(but->drawstr));
3006
3007                                 if (ui_but_is_float(but)) {
3008                                         if (value == (double) FLT_MAX) {
3009                                                 slen += BLI_strncpy_rlen(but->drawstr + slen, "inf", sizeof(but->drawstr) - slen);
3010                                         }
3011                                         else if (value == (double) -FLT_MAX) {
3012                                                 slen += BLI_strncpy_rlen(but->drawstr + slen, "-inf", sizeof(but->drawstr) - slen);
3013                                         }
3014                                         /* support length type buttons */
3015                                         else if (ui_but_is_unit(but)) {
3016                                                 char new_str[sizeof(but->drawstr)];
3017                                                 ui_get_but_string_unit(but, new_str, sizeof(new_str), value, true, -1);
3018                                                 slen += BLI_strncpy_rlen(but->drawstr + slen, new_str, sizeof(but->drawstr) - slen);
3019                                         }
3020                                         else {
3021                                                 const int prec = ui_but_calc_float_precision(but, value);
3022                                                 slen += BLI_snprintf_rlen(but->drawstr + slen, sizeof(but->drawstr) - slen, "%.*f", prec, value);
3023                                         }
3024                                 }
3025                                 else {
3026                                         slen += BLI_snprintf_rlen(but->drawstr + slen, sizeof(but->drawstr) - slen, "%d", (int)value);
3027                                 }
3028
3029                                 if (but->rnaprop) {
3030                                         PropertySubType pstype = RNA_property_subtype(but->rnaprop);
3031
3032                                         if (pstype == PROP_PERCENTAGE) {
3033                                                 drawstr_suffix = "%";
3034                                         }
3035                                         else if (pstype == PROP_PIXEL) {
3036                                                 drawstr_suffix = " px";
3037                                         }
3038                                 }
3039
3040                                 if (drawstr_suffix) {
3041                                         BLI_strncpy(but->drawstr + slen, drawstr_suffix, sizeof(but->drawstr) - slen);
3042                                 }
3043
3044                         }
3045                         break;
3046
3047                 case UI_BTYPE_LABEL:
3048                         if (ui_but_is_float(but)) {
3049                                 int prec;
3050                                 UI_GET_BUT_VALUE_INIT(but, value);
3051                                 prec = ui_but_calc_float_precision(but, value);
3052                                 BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%.*f", but->str, prec, value);
3053                         }
3054                         else {
3055                                 BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);
3056                         }
3057
3058                         break;
3059
3060                 case UI_BTYPE_TEXT:
3061                 case UI_BTYPE_SEARCH_MENU:
3062                 case UI_BTYPE_TAB:
3063                         if (!but->editstr) {
3064                                 char str[UI_MAX_DRAW_STR];
3065
3066                                 ui_but_string_get(but, str, UI_MAX_DRAW_STR);
3067                                 BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%s", but->str, str);
3068                         }
3069                         break;
3070
3071                 case UI_BTYPE_KEY_EVENT:
3072                 {
3073                         const char *str;
3074                         if (but->flag & UI_SELECT) {
3075                                 str = "Press a key";
3076                         }
3077                         else {
3078                                 UI_GET_BUT_VALUE_INIT(but, value);
3079                                 str = WM_key_event_string((short)value, false);
3080                         }
3081                         BLI_snprintf(but->drawstr, UI_MAX_DRAW_STR, "%s%s", but->str, str);
3082                         break;
3083                 }
3084                 case UI_BTYPE_HOTKEY_EVENT:
3085                         if (but->flag & UI_SELECT) {
3086
3087                                 if (but->modifier_key) {
3088                                         char *str = but->drawstr;
3089                                         but->drawstr[0] = '\0';
3090
3091                                         if (but->modifier_key & KM_SHIFT)
3092                                                 str += BLI_strcpy_rlen(str, "Shift ");
3093                                         if (but->modifier_key & KM_CTRL)
3094                                                 str += BLI_strcpy_rlen(str, "Ctrl ");
3095                                         if (but->modifier_key & KM_ALT)
3096                                                 str += BLI_strcpy_rlen(str, "Alt ");
3097                                         if (but->modifier_key & KM_OSKEY)
3098                                                 str += BLI_strcpy_rlen(str, "Cmd ");
3099
3100                                         (void)str; /* UNUSED */
3101                                 }
3102                                 else {
3103                                         BLI_strncpy(but->drawstr, "Press a key", UI_MAX_DRAW_STR);
3104                                 }
3105                         }
3106                         else
3107                                 BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);
3108
3109                         break;
3110
3111                 case UI_BTYPE_HSVCUBE:
3112                 case UI_BTYPE_HSVCIRCLE:
3113                         break;
3114                 default:
3115                         BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);