6df54c0a31c052853635898d61e831632f4a9308
[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;
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, IDP_NewString(mt->idname, "name", sizeof(mt->idname)));
988
989         if (WM_key_event_operator_string(
990                 C, "WM_OT_call_menu", WM_OP_INVOKE_REGION_WIN, prop_menu, true,
991                 buf, buf_len))
992         {
993                 found = true;
994         }
995
996         IDP_FreeProperty(prop_menu);
997         MEM_freeN(prop_menu);
998         return found;
999 }
1000
1001 static bool ui_but_event_operator_string(
1002         const bContext *C, uiBut *but,
1003         char *buf, const size_t buf_len)
1004 {
1005         bool found = false;
1006
1007         if (but->optype != NULL) {
1008                 found = ui_but_event_operator_string_from_operator(C, but, buf, buf_len);
1009         }
1010         else if (UI_but_menutype_get(but) != NULL) {
1011                 found = ui_but_event_operator_string_from_menu(C, but, buf, buf_len);
1012         }
1013
1014         return found;
1015 }
1016
1017 static bool ui_but_event_property_operator_string(
1018         const bContext *C, uiBut *but,
1019         char *buf, const size_t buf_len)
1020 {
1021         /* context toggle operator names to check... */
1022         const char *ctx_toggle_opnames[] = {
1023                 "WM_OT_context_toggle",
1024                 "WM_OT_context_toggle_enum",
1025                 "WM_OT_context_cycle_int",
1026                 "WM_OT_context_cycle_enum",
1027                 "WM_OT_context_cycle_array",
1028                 "WM_OT_context_menu_enum",
1029                 NULL
1030         };
1031         const size_t num_ops = sizeof(ctx_toggle_opnames) / sizeof(const char *);
1032
1033         bool found = false;
1034
1035         /* this version is only for finding hotkeys for properties (which get set via context using operators) */
1036         if (but->rnaprop) {
1037                 /* to avoid massive slowdowns on property panels, for now, we only check the
1038                  * hotkeys for Editor / Scene settings...
1039                  *
1040                  * TODO: userpref settings?
1041                  */
1042                 // TODO: value (for enum stuff)?
1043                 char *data_path = NULL;
1044
1045                 if (but->rnapoin.id.data) {
1046                         ID *id = but->rnapoin.id.data;
1047
1048                         if (GS(id->name) == ID_SCR) {
1049                                 /* screen/editor property
1050                                  * NOTE: in most cases, there is actually no info for backwards tracing
1051                                  * how to get back to ID from the editor data we may be dealing with
1052                                  */
1053                                 if (RNA_struct_is_a(but->rnapoin.type, &RNA_Space)) {
1054                                         /* data should be directly on here... */
1055                                         data_path = BLI_sprintfN("space_data.%s", RNA_property_identifier(but->rnaprop));
1056                                 }
1057                                 else {
1058                                         /* special exceptions for common nested data in editors... */
1059                                         if (RNA_struct_is_a(but->rnapoin.type, &RNA_DopeSheet)) {
1060                                                 /* dopesheet filtering options... */
1061                                                 data_path = BLI_sprintfN("space_data.dopesheet.%s", RNA_property_identifier(but->rnaprop));
1062                                         }
1063                                         else if (RNA_struct_is_a(but->rnapoin.type, &RNA_FileSelectParams)) {
1064                                                 /* Filebrowser options... */
1065                                                 data_path = BLI_sprintfN("space_data.params.%s", RNA_property_identifier(but->rnaprop));
1066                                         }
1067                                 }
1068                         }
1069                         else if (GS(id->name) == ID_SCE) {
1070                                 if (RNA_struct_is_a(but->rnapoin.type, &RNA_ToolSettings)) {
1071                                         /* toolsettings property
1072                                          * NOTE: toolsettings is usually accessed directly (i.e. not through scene)
1073                                          */
1074                                         data_path = RNA_path_from_ID_to_property(&but->rnapoin, but->rnaprop);
1075                                 }
1076                                 else {
1077                                         /* scene property */
1078                                         char *path = RNA_path_from_ID_to_property(&but->rnapoin, but->rnaprop);
1079
1080                                         if (path) {
1081                                                 data_path = BLI_sprintfN("scene.%s", path);
1082                                                 MEM_freeN(path);
1083                                         }
1084 #if 0
1085                                         else {
1086                                                 printf("ERROR in %s(): Couldn't get path for scene property - %s\n",
1087                                                        __func__, RNA_property_identifier(but->rnaprop));
1088                                         }
1089 #endif
1090                                 }
1091                         }
1092                         else {
1093                                 //puts("other id");
1094                         }
1095
1096                         //printf("prop shortcut: '%s' (%s)\n", RNA_property_identifier(but->rnaprop), data_path);
1097                 }
1098
1099                 /* we have a datapath! */
1100                 if (data_path) {
1101                         size_t i;
1102
1103                         /* create a property to host the "datapath" property we're sending to the operators */
1104                         IDProperty *prop_path;
1105                         IDProperty *prop_path_value;
1106
1107                         IDPropertyTemplate val = {0};
1108                         prop_path = IDP_New(IDP_GROUP, &val, __func__);
1109                         prop_path_value = IDP_NewString(data_path, "data_path", strlen(data_path) + 1);
1110                         IDP_AddToGroup(prop_path, prop_path_value);
1111
1112                         /* check each until one works... */
1113                         for (i = 0; (i < num_ops) && (ctx_toggle_opnames[i]); i++) {
1114                                 if (WM_key_event_operator_string(
1115                                         C, ctx_toggle_opnames[i], WM_OP_INVOKE_REGION_WIN, prop_path, false,
1116                                         buf, buf_len))
1117                                 {
1118                                         found = true;
1119                                         break;
1120                                 }
1121                         }
1122
1123                         /* cleanup */
1124                         IDP_FreeProperty(prop_path);
1125                         MEM_freeN(prop_path);
1126                         MEM_freeN(data_path);
1127                 }
1128         }
1129
1130         return found;
1131 }
1132
1133 /** \} */
1134
1135 /**
1136  * This goes in a seemingly weird pattern:
1137  *
1138  * <pre>
1139  *     4
1140  *  5     6
1141  * 1       2
1142  *  7     8
1143  *     3
1144  * </pre>
1145  *
1146  * but it's actually quite logical. It's designed to be 'upwards compatible'
1147  * for muscle memory so that the menu item locations are fixed and don't move
1148  * as new items are added to the menu later on. It also optimises efficiency -
1149  * a radial menu is best kept symmetrical, with as large an angle between
1150  * items as possible, so that the gestural mouse movements can be fast and inexact.
1151  *
1152  * It starts off with two opposite sides for the first two items
1153  * then joined by the one below for the third (this way, even with three items,
1154  * the menu seems to still be 'in order' reading left to right). Then the fourth is
1155  * added to complete the compass directions. From here, it's just a matter of
1156  * subdividing the rest of the angles for the last 4 items.
1157  *
1158  * --Matt 07/2006
1159  */
1160 const char ui_radial_dir_order[8] = {
1161     UI_RADIAL_W,  UI_RADIAL_E,  UI_RADIAL_S,  UI_RADIAL_N,
1162     UI_RADIAL_NW, UI_RADIAL_NE, UI_RADIAL_SW, UI_RADIAL_SE};
1163
1164 const char  ui_radial_dir_to_numpad[8] = {8, 9, 6, 3, 2, 1, 4, 7};
1165 const short ui_radial_dir_to_angle[8] =  {90, 45, 0, 315, 270, 225, 180, 135};
1166
1167 static void ui_but_pie_direction_string(uiBut *but, char *buf, int size)
1168 {
1169         BLI_assert(but->pie_dir < ARRAY_SIZE(ui_radial_dir_to_numpad));
1170         BLI_snprintf(buf, size, "%d", ui_radial_dir_to_numpad[but->pie_dir]);
1171 }
1172
1173 static void ui_menu_block_set_keymaps(const bContext *C, uiBlock *block)
1174 {
1175         uiBut *but;
1176         char buf[128];
1177
1178         BLI_assert(block->flag & (UI_BLOCK_LOOP | UI_BLOCK_SHOW_SHORTCUT_ALWAYS));
1179
1180         /* only do it before bounding */
1181         if (block->rect.xmin != block->rect.xmax)
1182                 return;
1183
1184         if (block->flag & UI_BLOCK_RADIAL) {
1185                 for (but = block->buttons.first; but; but = but->next) {
1186                         if (but->pie_dir != UI_RADIAL_NONE) {
1187                                 ui_but_pie_direction_string(but, buf, sizeof(buf));
1188                                 ui_but_add_shortcut(but, buf, false);
1189                         }
1190                 }
1191         }
1192         else {
1193                 for (but = block->buttons.first; but; but = but->next) {
1194                         if (block->flag & UI_BLOCK_SHOW_SHORTCUT_ALWAYS) {
1195                                 /* Skip icon-only buttons (as used in the toolbar). */
1196                                 if (but->drawstr[0] == '\0') {
1197                                         continue;
1198                                 }
1199                         }
1200                         else if (but->dt != UI_EMBOSS_PULLDOWN) {
1201                                 continue;
1202                         }
1203
1204                         if (ui_but_event_operator_string(C, but, buf, sizeof(buf))) {
1205                                 ui_but_add_shortcut(but, buf, false);
1206                         }
1207                         else if (ui_but_event_property_operator_string(C, but, buf, sizeof(buf))) {
1208                                 ui_but_add_shortcut(but, buf, false);
1209                         }
1210                 }
1211         }
1212 }
1213
1214 void ui_but_override_flag(uiBut *but)
1215 {
1216         const int override_status = RNA_property_static_override_status(&but->rnapoin, but->rnaprop, but->rnaindex);
1217
1218         if (override_status & RNA_OVERRIDE_STATUS_OVERRIDDEN) {
1219                 but->flag |= UI_BUT_OVERRIDEN;
1220         }
1221         else {
1222                 but->flag &= ~UI_BUT_OVERRIDEN;
1223         }
1224 }
1225
1226 void UI_block_update_from_old(const bContext *C, uiBlock *block)
1227 {
1228         uiBut *but_old;
1229         uiBut *but;
1230
1231         if (!block->oldblock)
1232                 return;
1233
1234         but_old = block->oldblock->buttons.first;
1235
1236         if (BLI_listbase_is_empty(&block->oldblock->butstore) == false) {
1237                 UI_butstore_update(block);
1238         }
1239
1240         for (but = block->buttons.first; but; but = but->next) {
1241                 if (ui_but_update_from_old_block(C, block, &but, &but_old)) {
1242                         ui_but_update(but);
1243
1244                         /* redraw dynamic tooltip if we have one open */
1245                         if (but->tip_func) {
1246                                 UI_but_tooltip_refresh((bContext *)C, but);
1247                         }
1248                 }
1249         }
1250
1251         block->auto_open = block->oldblock->auto_open;
1252         block->auto_open_last = block->oldblock->auto_open_last;
1253         block->tooltipdisabled = block->oldblock->tooltipdisabled;
1254         BLI_movelisttolist(&block->color_pickers.list, &block->oldblock->color_pickers.list);
1255
1256         block->oldblock = NULL;
1257 }
1258
1259 void UI_block_end_ex(const bContext *C, uiBlock *block, const int xy[2], int r_xy[2])
1260 {
1261         wmWindow *window = CTX_wm_window(C);
1262         Scene *scene = CTX_data_scene(C);
1263         ARegion *region = CTX_wm_region(C);
1264         uiBut *but;
1265
1266         BLI_assert(block->active);
1267
1268         UI_block_update_from_old(C, block);
1269
1270         /* inherit flags from 'old' buttons that was drawn here previous, based
1271          * on matching buttons, we need this to make button event handling non
1272          * blocking, while still allowing buttons to be remade each redraw as it
1273          * is expected by blender code */
1274         for (but = block->buttons.first; but; but = but->next) {
1275                 /* temp? Proper check for graying out */
1276                 if (but->optype) {
1277                         wmOperatorType *ot = but->optype;
1278
1279                         if (but->context)
1280                                 CTX_store_set((bContext *)C, but->context);
1281
1282                         if (ot == NULL || WM_operator_poll_context((bContext *)C, ot, but->opcontext) == 0) {
1283                                 but->flag |= UI_BUT_DISABLED;
1284                         }
1285
1286                         if (but->context)
1287                                 CTX_store_set((bContext *)C, NULL);
1288                 }
1289
1290                 ui_but_anim_flag(but, (scene) ? scene->r.cfra : 0.0f);
1291                 ui_but_override_flag(but);
1292                 if (UI_but_is_decorator(but)) {
1293                         ui_but_anim_decorate_update_from_flag(but);
1294                 }
1295         }
1296
1297
1298
1299         /* handle pending stuff */
1300         if (block->layouts.first) {
1301                 UI_block_layout_resolve(block, NULL, NULL);
1302         }
1303         ui_block_align_calc(block, CTX_wm_region(C));
1304         if ((block->flag & UI_BLOCK_LOOP) && (block->flag & UI_BLOCK_NUMSELECT)) {
1305                 ui_menu_block_set_keyaccels(block); /* could use a different flag to check */
1306         }
1307
1308         if (block->flag & (UI_BLOCK_LOOP | UI_BLOCK_SHOW_SHORTCUT_ALWAYS)) {
1309                 ui_menu_block_set_keymaps(C, block);
1310         }
1311
1312         /* after keymaps! */
1313         switch (block->bounds_type) {
1314                 case UI_BLOCK_BOUNDS_NONE:
1315                         break;
1316                 case UI_BLOCK_BOUNDS:
1317                         ui_block_bounds_calc(block);
1318                         break;
1319                 case UI_BLOCK_BOUNDS_TEXT:
1320                         ui_block_bounds_calc_text(block, 0.0f);
1321                         break;
1322                 case UI_BLOCK_BOUNDS_POPUP_CENTER:
1323                         ui_block_bounds_calc_centered(window, block);
1324                         break;
1325                 case UI_BLOCK_BOUNDS_PIE_CENTER:
1326                         ui_block_bounds_calc_centered_pie(block);
1327                         break;
1328
1329                         /* fallback */
1330                 case UI_BLOCK_BOUNDS_POPUP_MOUSE:
1331                 case UI_BLOCK_BOUNDS_POPUP_MENU:
1332                         ui_block_bounds_calc_popup(window, block, block->bounds_type, xy, r_xy);
1333                         break;
1334         }
1335
1336         if (block->rect.xmin == 0.0f && block->rect.xmax == 0.0f) {
1337                 UI_block_bounds_set_normal(block, 0);
1338         }
1339         if (block->flag & UI_BUT_ALIGN) {
1340                 UI_block_align_end(block);
1341         }
1342
1343         ui_update_flexible_spacing(region, block);
1344
1345         block->endblock = 1;
1346 }
1347
1348 void UI_block_end(const bContext *C, uiBlock *block)
1349 {
1350         wmWindow *window = CTX_wm_window(C);
1351
1352         UI_block_end_ex(C, block, &window->eventstate->x, NULL);
1353 }
1354
1355 /* ************** BLOCK DRAWING FUNCTION ************* */
1356
1357 void ui_fontscale(short *points, float aspect)
1358 {
1359         if (aspect < 0.9f || aspect > 1.1f) {
1360                 float pointsf = *points;
1361
1362                 /* for some reason scaling fonts goes too fast compared to widget size */
1363                 /* XXX not true anymore? (ton) */
1364                 //aspect = sqrt(aspect);
1365                 pointsf /= aspect;
1366
1367                 if (aspect > 1.0f)
1368                         *points = ceilf(pointsf);
1369                 else
1370                         *points = floorf(pointsf);
1371         }
1372 }
1373
1374 /* project button or block (but==NULL) to pixels in regionspace */
1375 static void ui_but_to_pixelrect(rcti *rect, const ARegion *ar, uiBlock *block, uiBut *but)
1376 {
1377         rctf rectf;
1378
1379         ui_block_to_window_rctf(ar, block, &rectf, (but) ? &but->rect : &block->rect);
1380         BLI_rcti_rctf_copy_round(rect, &rectf);
1381         BLI_rcti_translate(rect, -ar->winrct.xmin, -ar->winrct.ymin);
1382 }
1383
1384 /* uses local copy of style, to scale things down, and allow widgets to change stuff */
1385 void UI_block_draw(const bContext *C, uiBlock *block)
1386 {
1387         uiStyle style = *UI_style_get_dpi();  /* XXX pass on as arg */
1388         ARegion *ar;
1389         uiBut *but;
1390         rcti rect;
1391
1392         /* get menu region or area region */
1393         ar = CTX_wm_menu(C);
1394         if (!ar)
1395                 ar = CTX_wm_region(C);
1396
1397         if (!block->endblock)
1398                 UI_block_end(C, block);
1399
1400         /* we set this only once */
1401         GPU_blend_set_func_separate(GPU_SRC_ALPHA, GPU_ONE_MINUS_SRC_ALPHA, GPU_ONE, GPU_ONE_MINUS_SRC_ALPHA);
1402
1403         /* scale fonts */
1404         ui_fontscale(&style.paneltitle.points, block->aspect);
1405         ui_fontscale(&style.grouplabel.points, block->aspect);
1406         ui_fontscale(&style.widgetlabel.points, block->aspect);
1407         ui_fontscale(&style.widget.points, block->aspect);
1408
1409         /* scale block min/max to rect */
1410         ui_but_to_pixelrect(&rect, ar, block, NULL);
1411
1412         /* pixel space for AA widgets */
1413         gpuPushProjectionMatrix();
1414         gpuPushMatrix();
1415         gpuLoadIdentity();
1416
1417         wmOrtho2_region_pixelspace(ar);
1418
1419         /* back */
1420         if (block->flag & UI_BLOCK_RADIAL)
1421                 ui_draw_pie_center(block);
1422         else if (block->flag & UI_BLOCK_POPOVER)
1423                 ui_draw_popover_back(ar, &style, block, &rect);
1424         else if (block->flag & UI_BLOCK_LOOP)
1425                 ui_draw_menu_back(&style, block, &rect);
1426         else if (block->panel)
1427                 ui_draw_aligned_panel(&style, block, &rect, UI_panel_category_is_visible(ar));
1428
1429         BLF_batch_draw_begin();
1430         UI_icon_draw_cache_begin();
1431         UI_widgetbase_draw_cache_begin();
1432
1433         /* widgets */
1434         for (but = block->buttons.first; but; but = but->next) {
1435                 if (!(but->flag & (UI_HIDDEN | UI_SCROLLED))) {
1436                         ui_but_to_pixelrect(&rect, ar, block, but);
1437
1438                         /* XXX: figure out why invalid coordinates happen when closing render window */
1439                         /* and material preview is redrawn in main window (temp fix for bug #23848) */
1440                         if (rect.xmin < rect.xmax && rect.ymin < rect.ymax)
1441                                 ui_draw_but(C, ar, &style, but, &rect);
1442                 }
1443         }
1444
1445         UI_widgetbase_draw_cache_end();
1446         UI_icon_draw_cache_end();
1447         BLF_batch_draw_end();
1448
1449         /* restore matrix */
1450         gpuPopProjectionMatrix();
1451         gpuPopMatrix();
1452 }
1453
1454 static void ui_block_message_subscribe(ARegion *ar, struct wmMsgBus *mbus, uiBlock *block)
1455 {
1456         uiBut *but_prev = NULL;
1457         /* possibly we should keep the region this block is contained in? */
1458         for (uiBut *but = block->buttons.first; but; but = but->next) {
1459                 if (but->rnapoin.type && but->rnaprop) {
1460                         /* quick check to avoid adding buttons representing a vector, multiple times. */
1461                         if ((but_prev &&
1462                             (but_prev->rnaprop == but->rnaprop) &&
1463                             (but_prev->rnapoin.type == but->rnapoin.type) &&
1464                             (but_prev->rnapoin.data == but->rnapoin.data) &&
1465                             (but_prev->rnapoin.id.data == but->rnapoin.id.data)) == false)
1466                         {
1467                                 /* TODO: could make this into utility function. */
1468                                 WM_msg_subscribe_rna(
1469                                         mbus, &but->rnapoin, but->rnaprop,
1470                                         &(const wmMsgSubscribeValue){
1471                                             .owner = ar,
1472                                             .user_data = ar,
1473                                             .notify = ED_region_do_msg_notify_tag_redraw,
1474                                         }, __func__);
1475                                 but_prev = but;
1476                         }
1477                 }
1478         }
1479 }
1480
1481 void UI_region_message_subscribe(ARegion *ar, struct wmMsgBus *mbus)
1482 {
1483         for (uiBlock *block = ar->uiblocks.first; block; block = block->next) {
1484                 ui_block_message_subscribe(ar, mbus, block);
1485         }
1486 }
1487
1488 /* ************* EVENTS ************* */
1489
1490 /**
1491  * Check if the button is pushed, this is only meaningful for some button types.
1492  *
1493  * \return (0 == UNSELECT), (1 == SELECT), (-1 == DO-NOTHING)
1494  */
1495 int ui_but_is_pushed_ex(uiBut *but, double *value)
1496 {
1497         int is_push = 0;
1498
1499         if (but->bit) {
1500                 const bool state = ELEM(but->type, UI_BTYPE_TOGGLE_N, UI_BTYPE_ICON_TOGGLE_N, UI_BTYPE_CHECKBOX_N) ? false : true;
1501                 int lvalue;
1502                 UI_GET_BUT_VALUE_INIT(but, *value);
1503                 lvalue = (int)*value;
1504                 if (UI_BITBUT_TEST(lvalue, (but->bitnr))) {
1505                         is_push = state;
1506                 }
1507                 else {
1508                         is_push = !state;
1509                 }
1510         }
1511         else {
1512                 switch (but->type) {
1513                         case UI_BTYPE_BUT:
1514                         case UI_BTYPE_HOTKEY_EVENT:
1515                         case UI_BTYPE_KEY_EVENT:
1516                         case UI_BTYPE_COLOR:
1517                                 is_push = -1;
1518                                 break;
1519                         case UI_BTYPE_BUT_TOGGLE:
1520                         case UI_BTYPE_TOGGLE:
1521                         case UI_BTYPE_ICON_TOGGLE:
1522                         case UI_BTYPE_CHECKBOX:
1523                                 UI_GET_BUT_VALUE_INIT(but, *value);
1524                                 if (*value != (double)but->hardmin) is_push = true;
1525                                 break;
1526                         case UI_BTYPE_ICON_TOGGLE_N:
1527                         case UI_BTYPE_TOGGLE_N:
1528                         case UI_BTYPE_CHECKBOX_N:
1529                                 UI_GET_BUT_VALUE_INIT(but, *value);
1530                                 if (*value == 0.0) is_push = true;
1531                                 break;
1532                         case UI_BTYPE_ROW:
1533                         case UI_BTYPE_LISTROW:
1534                                 UI_GET_BUT_VALUE_INIT(but, *value);
1535                                 /* support for rna enum buts */
1536                                 if (but->rnaprop && (RNA_property_flag(but->rnaprop) & PROP_ENUM_FLAG)) {
1537                                         if ((int)*value & (int)but->hardmax) is_push = true;
1538                                 }
1539                                 else {
1540                                         if (*value == (double)but->hardmax) is_push = true;
1541                                 }
1542                                 break;
1543                         case UI_BTYPE_TAB:
1544                                 if (but->rnaprop && but->custom_data) {
1545                                         /* uiBut.custom_data points to data this tab represents (e.g. workspace).
1546                                          * uiBut.rnapoin/prop store an active value (e.g. active workspace). */
1547                                         if (RNA_property_type(but->rnaprop) == PROP_POINTER) {
1548                                                 PointerRNA active_ptr = RNA_property_pointer_get(&but->rnapoin, but->rnaprop);
1549                                                 if (active_ptr.data == but->custom_data) {
1550                                                         is_push = true;
1551                                                 }
1552                                         }
1553                                 }
1554                                 break;
1555                         default:
1556                                 is_push = -1;
1557                                 break;
1558                 }
1559         }
1560
1561         return is_push;
1562 }
1563 int ui_but_is_pushed(uiBut *but)
1564 {
1565         double value = UI_BUT_VALUE_UNSET;
1566         return ui_but_is_pushed_ex(but, &value);
1567 }
1568
1569 static void ui_but_update_select_flag(uiBut *but, double *value)
1570 {
1571         switch (ui_but_is_pushed_ex(but, value)) {
1572                 case true:
1573                         but->flag |= UI_SELECT;
1574                         break;
1575                 case false:
1576                         but->flag &= ~UI_SELECT;
1577                         break;
1578         }
1579 }
1580
1581 /* ************************************************ */
1582
1583 void UI_block_lock_set(uiBlock *block, bool val, const char *lockstr)
1584 {
1585         if (val) {
1586                 block->lock = val;
1587                 block->lockstr = lockstr;
1588         }
1589 }
1590
1591 void UI_block_lock_clear(uiBlock *block)
1592 {
1593         block->lock = false;
1594         block->lockstr = NULL;
1595 }
1596
1597 /* *********************** data get/set ***********************
1598  * this either works with the pointed to data, or can work with
1599  * an edit override pointer while dragging for example */
1600
1601 /* Get PointerRNA which will point to a data inside of an evaluated
1602  * ID datablock.
1603  */
1604 static PointerRNA ui_but_evaluated_rnapoin_get(uiBut *but)
1605 {
1606         BLI_assert(but->rnaprop != NULL);
1607         /* TODO(sergey): evil_C sounds.. EVIL! Any clear way to avoid this? */
1608         PointerRNA rnapoin_eval = but->rnapoin;
1609         /* If there is no animation or drivers, it doesn't matter if we read value
1610          * from evaluated datablock or from original one.
1611          *
1612          * Reading from original one is much faster, since we don't need to do any
1613          * PointerRNA remapping or hash lookup.
1614          */
1615         if (BKE_animdata_from_id(but->rnapoin.id.data) == NULL) {
1616                 return rnapoin_eval;
1617         }
1618         /* Same goes for the properties which can not be animated. */
1619         if (!RNA_property_animateable(&but->rnapoin, but->rnaprop)) {
1620                 return rnapoin_eval;
1621         }
1622         Depsgraph *depsgraph = CTX_data_depsgraph(but->block->evil_C);
1623         /* ID pointer we can always remap, they are inside of depsgraph. */
1624         rnapoin_eval.id.data =
1625                 DEG_get_evaluated_id(depsgraph, rnapoin_eval.id.data);
1626         /* Some of ID datablocks do not have their evaluated copy inside
1627          * of dependency graph. If it's such datablock, no need to worry about
1628          * data pointer.
1629          */
1630         if (rnapoin_eval.id.data == but->rnapoin.id.data) {
1631                 return rnapoin_eval;
1632         }
1633         /* For the data pointer it's getting a bit more involved, since it can
1634          * whether be and ID, or can be a property deep inside of ID.
1635          *
1636          * We start from checking if it's an ID, since that is the less involved
1637          * code path, and probably is executed in most of the cases.
1638          */
1639         if (but->rnapoin.data == but->rnapoin.id.data) {
1640                 rnapoin_eval.data = DEG_get_evaluated_id(depsgraph, rnapoin_eval.data);
1641                 return rnapoin_eval;
1642         }
1643         /* We aren't as lucky as we thought we are :(
1644          *
1645          * Since we don't know what the property is, we get it's RNA path
1646          * relative to the original ID, and then we decent down from evaluated
1647          * ID to the same property.
1648          *
1649          * This seems to be most straightforward way to get sub-data pointers
1650          * which can be buried deep inside of ID block.
1651          */
1652         const char *rna_path =
1653                RNA_path_from_ID_to_property(&but->rnapoin, but->rnaprop);
1654         if (rna_path != NULL) {
1655                 PointerRNA id_ptr;
1656                 RNA_id_pointer_create(rnapoin_eval.id.data, &id_ptr);
1657                 if (!RNA_path_resolve_full(&id_ptr,
1658                                            rna_path,
1659                                            &rnapoin_eval,
1660                                            NULL, NULL))
1661                 {
1662                         /* TODO(sergey): Anything to do here to recover? */
1663                 }
1664                 MEM_freeN((void *)rna_path);
1665         }
1666         return rnapoin_eval;
1667 }
1668
1669 /* for buttons pointing to color for example */
1670 void ui_but_v3_get(uiBut *but, float vec[3])
1671 {
1672         PropertyRNA *prop;
1673         int a;
1674
1675         if (but->editvec) {
1676                 copy_v3_v3(vec, but->editvec);
1677         }
1678
1679         if (but->rnaprop) {
1680                 prop = but->rnaprop;
1681
1682                 zero_v3(vec);
1683
1684                 PointerRNA rnapoin_eval = ui_but_evaluated_rnapoin_get(but);
1685
1686                 if (RNA_property_type(prop) == PROP_FLOAT) {
1687                         int tot = RNA_property_array_length(&rnapoin_eval, prop);
1688                         BLI_assert(tot > 0);
1689                         if (tot == 3) {
1690                                 RNA_property_float_get_array(&rnapoin_eval, prop, vec);
1691                         }
1692                         else {
1693                                 tot = min_ii(tot, 3);
1694                                 for (a = 0; a < tot; a++) {
1695                                         vec[a] = RNA_property_float_get_index(&rnapoin_eval, prop, a);
1696                                 }
1697                         }
1698                 }
1699         }
1700         else if (but->pointype == UI_BUT_POIN_CHAR) {
1701                 const char *cp = (char *)but->poin;
1702
1703                 vec[0] = ((float)cp[0]) / 255.0f;
1704                 vec[1] = ((float)cp[1]) / 255.0f;
1705                 vec[2] = ((float)cp[2]) / 255.0f;
1706         }
1707         else if (but->pointype == UI_BUT_POIN_FLOAT) {
1708                 const float *fp = (float *)but->poin;
1709                 copy_v3_v3(vec, fp);
1710         }
1711         else {
1712                 if (but->editvec == NULL) {
1713                         fprintf(stderr, "%s: can't get color, should never happen\n", __func__);
1714                         zero_v3(vec);
1715                 }
1716         }
1717
1718         if (but->type == UI_BTYPE_UNITVEC) {
1719                 normalize_v3(vec);
1720         }
1721 }
1722
1723 /* for buttons pointing to color for example */
1724 void ui_but_v3_set(uiBut *but, const float vec[3])
1725 {
1726         PropertyRNA *prop;
1727
1728         if (but->editvec) {
1729                 copy_v3_v3(but->editvec, vec);
1730         }
1731
1732         if (but->rnaprop) {
1733                 prop = but->rnaprop;
1734
1735                 if (RNA_property_type(prop) == PROP_FLOAT) {
1736                         int tot;
1737                         int a;
1738
1739                         tot = RNA_property_array_length(&but->rnapoin, prop);
1740                         BLI_assert(tot > 0);
1741                         if (tot == 3) {
1742                                 RNA_property_float_set_array(&but->rnapoin, prop, vec);
1743                         }
1744                         else {
1745                                 tot = min_ii(tot, 3);
1746                                 for (a = 0; a < tot; a++) {
1747                                         RNA_property_float_set_index(&but->rnapoin, prop, a, vec[a]);
1748                                 }
1749                         }
1750                 }
1751         }
1752         else if (but->pointype == UI_BUT_POIN_CHAR) {
1753                 char *cp = (char *)but->poin;
1754                 cp[0] = (char)(0.5f + vec[0] * 255.0f);
1755                 cp[1] = (char)(0.5f + vec[1] * 255.0f);
1756                 cp[2] = (char)(0.5f + vec[2] * 255.0f);
1757         }
1758         else if (but->pointype == UI_BUT_POIN_FLOAT) {
1759                 float *fp = (float *)but->poin;
1760                 copy_v3_v3(fp, vec);
1761         }
1762 }
1763
1764 bool ui_but_is_float(const uiBut *but)
1765 {
1766         if (but->pointype == UI_BUT_POIN_FLOAT && but->poin)
1767                 return true;
1768
1769         if (but->rnaprop && RNA_property_type(but->rnaprop) == PROP_FLOAT)
1770                 return true;
1771
1772         return false;
1773 }
1774
1775 bool ui_but_is_bool(const uiBut *but)
1776 {
1777         if (ELEM(but->type, UI_BTYPE_TOGGLE, UI_BTYPE_TOGGLE_N, UI_BTYPE_ICON_TOGGLE, UI_BTYPE_ICON_TOGGLE_N))
1778                 return true;
1779
1780         if (but->rnaprop && RNA_property_type(but->rnaprop) == PROP_BOOLEAN)
1781                 return true;
1782
1783         if ((but->rnaprop && RNA_property_type(but->rnaprop) == PROP_ENUM) && (but->type == UI_BTYPE_ROW))
1784                 return true;
1785
1786         return false;
1787 }
1788
1789
1790 bool ui_but_is_unit(const uiBut *but)
1791 {
1792         UnitSettings *unit = but->block->unit;
1793         const int unit_type = UI_but_unit_type_get(but);
1794
1795         if (unit_type == PROP_UNIT_NONE)
1796                 return false;
1797
1798 #if 1 /* removed so angle buttons get correct snapping */
1799         if (ui_but_is_unit_radians_ex(unit, unit_type))
1800                 return false;
1801 #endif
1802
1803         /* for now disable time unit conversion */
1804         if (unit_type == PROP_UNIT_TIME)
1805                 return false;
1806
1807         if (unit->system == USER_UNIT_NONE) {
1808                 if (unit_type != PROP_UNIT_ROTATION) {
1809                         return false;
1810                 }
1811         }
1812
1813         return true;
1814 }
1815
1816 /**
1817  * Check if this button is similar enough to be grouped with another.
1818  */
1819 bool ui_but_is_compatible(const uiBut *but_a, const uiBut *but_b)
1820 {
1821         if (but_a->type != but_b->type)
1822                 return false;
1823         if (but_a->pointype != but_b->pointype)
1824                 return false;
1825
1826         if (but_a->rnaprop) {
1827                 /* skip 'rnapoin.data', 'rnapoin.id.data'
1828                  * allow different data to have the same props edited at once */
1829                 if (but_a->rnapoin.type != but_b->rnapoin.type)
1830                         return false;
1831                 if (RNA_property_type(but_a->rnaprop) != RNA_property_type(but_b->rnaprop))
1832                         return false;
1833                 if (RNA_property_subtype(but_a->rnaprop) != RNA_property_subtype(but_b->rnaprop))
1834                         return false;
1835         }
1836
1837         return true;
1838 }
1839
1840 bool ui_but_is_rna_valid(uiBut *but)
1841 {
1842         if (but->rnaprop == NULL || RNA_struct_contains_property(&but->rnapoin, but->rnaprop)) {
1843                 return true;
1844         }
1845         else {
1846                 printf("property removed %s: %p\n", but->drawstr, but->rnaprop);
1847                 return false;
1848         }
1849 }
1850
1851 /**
1852  * Checks if the button supports ctrl+mousewheel cycling
1853  */
1854 bool ui_but_supports_cycling(const uiBut *but)
1855 {
1856         return ((ELEM(but->type, UI_BTYPE_ROW, UI_BTYPE_NUM, UI_BTYPE_NUM_SLIDER, UI_BTYPE_LISTBOX)) ||
1857                 (but->type == UI_BTYPE_MENU && ui_but_menu_step_poll(but)) ||
1858                 (but->type == UI_BTYPE_COLOR && but->a1 != -1) ||
1859                 (but->menu_step_func != NULL));
1860 }
1861
1862 double ui_but_value_get(uiBut *but)
1863 {
1864         PropertyRNA *prop;
1865         double value = 0.0;
1866
1867         if (but->editval) { return *(but->editval); }
1868         if (but->poin == NULL && but->rnapoin.data == NULL) return 0.0;
1869
1870         if (but->rnaprop) {
1871                 prop = but->rnaprop;
1872
1873                 BLI_assert(but->rnaindex != -1);
1874
1875                 PointerRNA rnapoin_eval = ui_but_evaluated_rnapoin_get(but);
1876
1877                 switch (RNA_property_type(prop)) {
1878                         case PROP_BOOLEAN:
1879                                 if (RNA_property_array_check(prop))
1880                                         value = RNA_property_boolean_get_index(&rnapoin_eval, prop, but->rnaindex);
1881                                 else
1882                                         value = RNA_property_boolean_get(&rnapoin_eval, prop);
1883                                 break;
1884                         case PROP_INT:
1885                                 if (RNA_property_array_check(prop))
1886                                         value = RNA_property_int_get_index(&rnapoin_eval, prop, but->rnaindex);
1887                                 else
1888                                         value = RNA_property_int_get(&rnapoin_eval, prop);
1889                                 break;
1890                         case PROP_FLOAT:
1891                                 if (RNA_property_array_check(prop))
1892                                         value = RNA_property_float_get_index(&rnapoin_eval, prop, but->rnaindex);
1893                                 else
1894                                         value = RNA_property_float_get(&rnapoin_eval, prop);
1895                                 break;
1896                         case PROP_ENUM:
1897                                 value = RNA_property_enum_get(&rnapoin_eval, prop);
1898                                 break;
1899                         default:
1900                                 value = 0.0;
1901                                 break;
1902                 }
1903         }
1904         else if (but->pointype == UI_BUT_POIN_CHAR) {
1905                 value = *(char *)but->poin;
1906         }
1907         else if (but->pointype == UI_BUT_POIN_SHORT) {
1908                 value = *(short *)but->poin;
1909         }
1910         else if (but->pointype == UI_BUT_POIN_INT) {
1911                 value = *(int *)but->poin;
1912         }
1913         else if (but->pointype == UI_BUT_POIN_FLOAT) {
1914                 value = *(float *)but->poin;
1915         }
1916
1917         return value;
1918 }
1919
1920 void ui_but_value_set(uiBut *but, double value)
1921 {
1922         PropertyRNA *prop;
1923
1924         /* value is a hsv value: convert to rgb */
1925         if (but->rnaprop) {
1926                 prop = but->rnaprop;
1927
1928                 if (RNA_property_editable(&but->rnapoin, prop)) {
1929                         switch (RNA_property_type(prop)) {
1930                                 case PROP_BOOLEAN:
1931                                         if (RNA_property_array_check(prop))
1932                                                 RNA_property_boolean_set_index(&but->rnapoin, prop, but->rnaindex, value);
1933                                         else
1934                                                 RNA_property_boolean_set(&but->rnapoin, prop, value);
1935                                         break;
1936                                 case PROP_INT:
1937                                         if (RNA_property_array_check(prop))
1938                                                 RNA_property_int_set_index(&but->rnapoin, prop, but->rnaindex, (int)value);
1939                                         else
1940                                                 RNA_property_int_set(&but->rnapoin, prop, (int)value);
1941                                         break;
1942                                 case PROP_FLOAT:
1943                                         if (RNA_property_array_check(prop))
1944                                                 RNA_property_float_set_index(&but->rnapoin, prop, but->rnaindex, value);
1945                                         else
1946                                                 RNA_property_float_set(&but->rnapoin, prop, value);
1947                                         break;
1948                                 case PROP_ENUM:
1949                                         if (RNA_property_flag(prop) & PROP_ENUM_FLAG) {
1950                                                 int ivalue = (int)value;
1951                                                 ivalue ^= RNA_property_enum_get(&but->rnapoin, prop); /* toggle for enum/flag buttons */
1952                                                 RNA_property_enum_set(&but->rnapoin, prop, ivalue);
1953                                         }
1954                                         else {
1955                                                 RNA_property_enum_set(&but->rnapoin, prop, value);
1956                                         }
1957                                         break;
1958                                 default:
1959                                         break;
1960                         }
1961                 }
1962
1963                 /* we can't be sure what RNA set functions actually do,
1964                  * so leave this unset */
1965                 value = UI_BUT_VALUE_UNSET;
1966         }
1967         else if (but->pointype == 0) {
1968                 /* pass */
1969         }
1970         else {
1971                 /* first do rounding */
1972                 if (but->pointype == UI_BUT_POIN_CHAR) {
1973                         value = round_db_to_uchar_clamp(value);
1974                 }
1975                 else if (but->pointype == UI_BUT_POIN_SHORT) {
1976                         value = round_db_to_short_clamp(value);
1977                 }
1978                 else if (but->pointype == UI_BUT_POIN_INT) {
1979                         value = round_db_to_int_clamp(value);
1980                 }
1981                 else if (but->pointype == UI_BUT_POIN_FLOAT) {
1982                         float fval = (float)value;
1983                         if (fval >= -0.00001f && fval <= 0.00001f) fval = 0.0f;  /* prevent negative zero */
1984                         value = fval;
1985                 }
1986
1987                 /* then set value with possible edit override */
1988                 if (but->editval)
1989                         value = *but->editval = value;
1990                 else if (but->pointype == UI_BUT_POIN_CHAR)
1991                         value = *((char *)but->poin) = (char)value;
1992                 else if (but->pointype == UI_BUT_POIN_SHORT)
1993                         value = *((short *)but->poin) = (short)value;
1994                 else if (but->pointype == UI_BUT_POIN_INT)
1995                         value = *((int *)but->poin) = (int)value;
1996                 else if (but->pointype == UI_BUT_POIN_FLOAT)
1997                         value = *((float *)but->poin) = (float)value;
1998         }
1999
2000         ui_but_update_select_flag(but, &value);
2001 }
2002
2003 int ui_but_string_get_max_length(uiBut *but)
2004 {
2005         if (ELEM(but->type, UI_BTYPE_TEXT, UI_BTYPE_SEARCH_MENU))
2006                 return but->hardmax;
2007         else
2008                 return UI_MAX_DRAW_STR;
2009 }
2010
2011 uiBut *ui_but_drag_multi_edit_get(uiBut *but)
2012 {
2013         uiBut *but_iter;
2014
2015         BLI_assert(but->flag & UI_BUT_DRAG_MULTI);
2016
2017         for (but_iter = but->block->buttons.first; but_iter; but_iter = but_iter->next) {
2018                 if (but_iter->editstr) {
2019                         break;
2020                 }
2021         }
2022
2023         return but_iter;
2024 }
2025
2026 /** \name Check to show extra icons
2027  *
2028  * Extra icons are shown on the right hand side of buttons.
2029  * This could (should!) definitely become more generic, but for now this is good enough.
2030  * \{ */
2031
2032 static bool ui_but_icon_extra_is_visible_text_clear(const uiBut *but)
2033 {
2034         BLI_assert(but->type == UI_BTYPE_TEXT);
2035         return ((but->flag & UI_BUT_VALUE_CLEAR) && but->drawstr[0]);
2036 }
2037
2038 static bool ui_but_icon_extra_is_visible_search_unlink(const uiBut *but)
2039 {
2040         BLI_assert(ELEM(but->type, UI_BTYPE_SEARCH_MENU, UI_BTYPE_TAB));
2041         return ((but->editstr == NULL) &&
2042                 (but->drawstr[0] != '\0') &&
2043                 (but->flag & UI_BUT_VALUE_CLEAR));
2044 }
2045
2046 static bool ui_but_icon_extra_is_visible_search_eyedropper(uiBut *but)
2047 {
2048         StructRNA *type;
2049         short idcode;
2050
2051         BLI_assert(but->type == UI_BTYPE_SEARCH_MENU && (but->flag & UI_BUT_VALUE_CLEAR));
2052
2053         if (but->rnaprop == NULL) {
2054                 return false;
2055         }
2056
2057         type = RNA_property_pointer_type(&but->rnapoin, but->rnaprop);
2058         idcode = RNA_type_to_ID_code(type);
2059
2060         return ((but->editstr == NULL) &&
2061                 (idcode == ID_OB || OB_DATA_SUPPORT_ID(idcode)));
2062 }
2063
2064 uiButExtraIconType ui_but_icon_extra_get(uiBut *but)
2065 {
2066         switch (but->type) {
2067                 case UI_BTYPE_TEXT:
2068                         if (ui_but_icon_extra_is_visible_text_clear(but)) {
2069                                 return UI_BUT_ICONEXTRA_CLEAR;
2070                         }
2071                         break;
2072                 case UI_BTYPE_SEARCH_MENU:
2073                         if ((but->flag & UI_BUT_VALUE_CLEAR) == 0) {
2074                                 /* pass */
2075                         }
2076                         else if (ui_but_icon_extra_is_visible_search_unlink(but)) {
2077                                 return UI_BUT_ICONEXTRA_CLEAR;
2078                         }
2079                         else if (ui_but_icon_extra_is_visible_search_eyedropper(but)) {
2080                                 return UI_BUT_ICONEXTRA_EYEDROPPER;
2081                         }
2082                         break;
2083                 case UI_BTYPE_TAB:
2084                         if (ui_but_icon_extra_is_visible_search_unlink(but)) {
2085                                 return UI_BUT_ICONEXTRA_CLEAR;
2086                         }
2087                         break;
2088                 default:
2089                         break;
2090         }
2091
2092         return UI_BUT_ICONEXTRA_NONE;
2093 }
2094
2095 /** \} */
2096
2097
2098 static double ui_get_but_scale_unit(uiBut *but, double value)
2099 {
2100         UnitSettings *unit = but->block->unit;
2101         int unit_type = UI_but_unit_type_get(but);
2102
2103         /* Time unit is a bit special, not handled by BKE_scene_unit_scale() for now. */
2104         if (unit_type == PROP_UNIT_TIME) { /* WARNING - using evil_C :| */
2105                 Scene *scene = CTX_data_scene(but->block->evil_C);
2106                 return FRA2TIME(value);
2107         }
2108         else {
2109                 return BKE_scene_unit_scale(unit, RNA_SUBTYPE_UNIT_VALUE(unit_type), value);
2110         }
2111 }
2112
2113 /* str will be overwritten */
2114 void ui_but_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen)
2115 {
2116         if (ui_but_is_unit(but)) {
2117                 UnitSettings *unit = but->block->unit;
2118                 int unit_type = UI_but_unit_type_get(but);
2119                 char *orig_str;
2120
2121                 orig_str = BLI_strdup(str);
2122
2123                 bUnit_ToUnitAltName(str, maxlen, orig_str, unit->system, RNA_SUBTYPE_UNIT_VALUE(unit_type));
2124
2125                 MEM_freeN(orig_str);
2126         }
2127 }
2128
2129 /**
2130  * \param float_precision  Override the button precision.
2131  */
2132 static void ui_get_but_string_unit(uiBut *but, char *str, int len_max, double value, bool pad, int float_precision)
2133 {
2134         UnitSettings *unit = but->block->unit;
2135         const bool do_split = (unit->flag & USER_UNIT_OPT_SPLIT) != 0;
2136         int unit_type = UI_but_unit_type_get(but);
2137         int precision;
2138
2139         if (unit->scale_length < 0.0001f) unit->scale_length = 1.0f;  // XXX do_versions
2140
2141         /* Use precision override? */
2142         if (float_precision == -1) {
2143                 /* Sanity checks */
2144                 precision = (int)but->a2;
2145                 if      (precision > UI_PRECISION_FLOAT_MAX) precision = UI_PRECISION_FLOAT_MAX;
2146                 else if (precision == -1)                    precision = 2;
2147         }
2148         else {
2149                 precision = float_precision;
2150         }
2151
2152         bUnit_AsString(
2153                 str, len_max, ui_get_but_scale_unit(but, value), precision,
2154                 unit->system, RNA_SUBTYPE_UNIT_VALUE(unit_type), do_split, pad);
2155 }
2156
2157 static float ui_get_but_step_unit(uiBut *but, float step_default)
2158 {
2159         int unit_type = RNA_SUBTYPE_UNIT_VALUE(UI_but_unit_type_get(but));
2160         const double step_orig = step_default * UI_PRECISION_FLOAT_SCALE;
2161         /* Scaling up 'step_origg ' here is a bit arbitrary, its just giving better scales from user POV */
2162         const double scale_step = ui_get_but_scale_unit(but, step_orig * 10);
2163         const double step = bUnit_ClosestScalar(scale_step, but->block->unit->system, unit_type);
2164
2165         /* -1 is an error value */
2166         if (step != -1.0) {
2167                 const double scale_unit = ui_get_but_scale_unit(but, 1.0);
2168                 const double step_unit = bUnit_ClosestScalar(scale_unit, but->block->unit->system, unit_type);
2169                 double step_final;
2170
2171                 BLI_assert(step > 0.0);
2172
2173                 step_final = (step / scale_unit) / (double)UI_PRECISION_FLOAT_SCALE;
2174
2175                 if (step == step_unit) {
2176                         /* Logic here is to scale by the original 'step_orig'
2177                          * only when the unit step matches the scaled step.
2178                          *
2179                          * This is needed for units that don't have a wide range of scales (degrees for eg.).
2180                          * Without this we can't select between a single degree, or a 10th of a degree.
2181                          */
2182                         step_final *= step_orig;
2183                 }
2184
2185                 return (float)step_final;
2186         }
2187         else {
2188                 return step_default;
2189         }
2190 }
2191
2192 /**
2193  * \param float_precision  For number buttons the precision to use or -1 to fallback to the button default.
2194  * \param use_exp_float  Use exponent representation of floats when out of reasonable range (outside of 1e3/1e-3).
2195  */
2196 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)
2197 {
2198         if (r_use_exp_float) {
2199                 *r_use_exp_float = false;
2200         }
2201
2202         if (but->rnaprop && ELEM(but->type, UI_BTYPE_TEXT, UI_BTYPE_SEARCH_MENU, UI_BTYPE_TAB)) {
2203                 PropertyType type;
2204                 const char *buf = NULL;
2205                 int buf_len;
2206
2207                 type = RNA_property_type(but->rnaprop);
2208
2209                 if ((but->type == UI_BTYPE_TAB) && (but->custom_data)) {
2210                         StructRNA *ptr_type = RNA_property_pointer_type(&but->rnapoin, but->rnaprop);
2211                         PointerRNA ptr;
2212
2213                         /* uiBut.custom_data points to data this tab represents (e.g. workspace).
2214                          * uiBut.rnapoin/prop store an active value (e.g. active workspace). */
2215                         RNA_pointer_create(but->rnapoin.id.data, ptr_type, but->custom_data, &ptr);
2216                         buf = RNA_struct_name_get_alloc(&ptr, str, maxlen, &buf_len);
2217                 }
2218                 else if (type == PROP_STRING) {
2219                         /* RNA string */
2220                         buf = RNA_property_string_get_alloc(&but->rnapoin, but->rnaprop, str, maxlen, &buf_len);
2221                 }
2222                 else if (type == PROP_ENUM) {
2223                         /* RNA enum */
2224                         int value = RNA_property_enum_get(&but->rnapoin, but->rnaprop);
2225                         if (RNA_property_enum_name(but->block->evil_C, &but->rnapoin, but->rnaprop, value, &buf)) {
2226                                 BLI_strncpy(str, buf, maxlen);
2227                                 buf = str;
2228                         }
2229                 }
2230                 else if (type == PROP_POINTER) {
2231                         /* RNA pointer */
2232                         PointerRNA ptr = RNA_property_pointer_get(&but->rnapoin, but->rnaprop);
2233                         buf = RNA_struct_name_get_alloc(&ptr, str, maxlen, &buf_len);
2234                 }
2235                 else {
2236                         BLI_assert(0);
2237                 }
2238
2239                 if (!buf) {
2240                         str[0] = '\0';
2241                 }
2242                 else if (buf && buf != str) {
2243                         BLI_assert(maxlen <= buf_len + 1);
2244                         /* string was too long, we have to truncate */
2245                         if (ui_but_is_utf8(but)) {
2246                                 BLI_strncpy_utf8(str, buf, maxlen);
2247                         }
2248                         else {
2249                                 BLI_strncpy(str, buf, maxlen);
2250                         }
2251                         MEM_freeN((void *)buf);
2252                 }
2253         }
2254         else if (ELEM(but->type, UI_BTYPE_TEXT, UI_BTYPE_SEARCH_MENU)) {
2255                 /* string */
2256                 BLI_strncpy(str, but->poin, maxlen);
2257                 return;
2258         }
2259         else if (ui_but_anim_expression_get(but, str, maxlen)) {
2260                 /* driver expression */
2261         }
2262         else {
2263                 /* number editing */
2264                 double value;
2265
2266                 value = ui_but_value_get(but);
2267
2268                 if (ui_but_is_float(but)) {
2269                         if (ui_but_is_unit(but)) {
2270                                 ui_get_but_string_unit(but, str, maxlen, value, false, float_precision);
2271                         }
2272                         else {
2273                                 int prec = (float_precision == -1) ? ui_but_calc_float_precision(but, value) : float_precision;
2274                                 if (use_exp_float) {
2275                                         const int int_digits_num = integer_digits_f(value);
2276                                         if (int_digits_num < -6 || int_digits_num > 12) {
2277                                                 BLI_snprintf(str, maxlen, "%.*g", prec, value);
2278                                                 if (r_use_exp_float) {
2279                                                         *r_use_exp_float = true;
2280                                                 }
2281                                         }
2282                                         else {
2283                                                 prec -= int_digits_num;
2284                                                 CLAMP(prec, 0, UI_PRECISION_FLOAT_MAX);
2285                                                 BLI_snprintf(str, maxlen, "%.*f", prec, value);
2286                                         }
2287                                 }
2288                                 else {
2289 #if 0                           /* TODO, but will likely break some stuff, so better after 2.79 release. */
2290                                         prec -= int_digits_num;
2291                                         CLAMP(prec, 0, UI_PRECISION_FLOAT_MAX);
2292 #endif
2293                                         BLI_snprintf(str, maxlen, "%.*f", prec, value);
2294                                 }
2295                         }
2296                 }
2297                 else {
2298                         BLI_snprintf(str, maxlen, "%d", (int)value);
2299                 }
2300         }
2301 }
2302 void ui_but_string_get(uiBut *but, char *str, const size_t maxlen)
2303 {
2304         ui_but_string_get_ex(but, str, maxlen, -1, false, NULL);
2305 }
2306
2307 /**
2308  * A version of #ui_but_string_get_ex for dynamic buffer sizes
2309  * (where #ui_but_string_get_max_length returns 0).
2310  *
2311  * \param r_str_size: size of the returned string (including terminator).
2312  */
2313 char *ui_but_string_get_dynamic(uiBut *but, int *r_str_size)
2314 {
2315         char *str = NULL;
2316         *r_str_size = 1;
2317
2318         if (but->rnaprop && ELEM(but->type, UI_BTYPE_TEXT, UI_BTYPE_SEARCH_MENU)) {
2319                 PropertyType type;
2320
2321                 type = RNA_property_type(but->rnaprop);
2322
2323                 if (type == PROP_STRING) {
2324                         /* RNA string */
2325                         str = RNA_property_string_get_alloc(&but->rnapoin, but->rnaprop, NULL, 0, r_str_size);
2326                         (*r_str_size) += 1;
2327                 }
2328                 else if (type == PROP_ENUM) {
2329                         /* RNA enum */
2330                         int value = RNA_property_enum_get(&but->rnapoin, but->rnaprop);
2331                         const char *value_id;
2332                         if (!RNA_property_enum_name(but->block->evil_C, &but->rnapoin, but->rnaprop, value, &value_id)) {
2333                                 value_id = "";
2334                         }
2335
2336                         *r_str_size = strlen(value_id) + 1;
2337                         str = BLI_strdupn(value_id, *r_str_size);
2338                 }
2339                 else if (type == PROP_POINTER) {
2340                         /* RNA pointer */
2341                         PointerRNA ptr = RNA_property_pointer_get(&but->rnapoin, but->rnaprop);
2342                         str = RNA_struct_name_get_alloc(&ptr, NULL, 0, r_str_size);
2343                         (*r_str_size) += 1;
2344                 }
2345                 else {
2346                         BLI_assert(0);
2347                 }
2348         }
2349         else {
2350                 BLI_assert(0);
2351         }
2352
2353         if (UNLIKELY(str == NULL)) {
2354                 /* should never happen, paranoid check */
2355                 *r_str_size = 1;
2356                 str = BLI_strdup("");
2357                 BLI_assert(0);
2358
2359         }
2360
2361         return str;
2362 }
2363
2364 #ifdef WITH_PYTHON
2365
2366 static bool ui_set_but_string_eval_num_unit(bContext *C, uiBut *but, const char *str, double *r_value)
2367 {
2368         char str_unit_convert[256];
2369         const int unit_type = UI_but_unit_type_get(but);
2370
2371         BLI_strncpy(str_unit_convert, str, sizeof(str_unit_convert));
2372
2373         /* ugly, use the draw string to get the value,
2374          * this could cause problems if it includes some text which resolves to a unit */
2375         bUnit_ReplaceString(
2376                 str_unit_convert, sizeof(str_unit_convert), but->drawstr,
2377                 ui_get_but_scale_unit(but, 1.0), but->block->unit->system, RNA_SUBTYPE_UNIT_VALUE(unit_type));
2378
2379         return BPY_execute_string_as_number(C, str_unit_convert, true, r_value);
2380 }
2381
2382 #endif /* WITH_PYTHON */
2383
2384
2385 bool ui_but_string_set_eval_num(bContext *C, uiBut *but, const char *str, double *r_value)
2386 {
2387         bool ok = false;
2388
2389 #ifdef WITH_PYTHON
2390
2391         if (str[0] != '\0') {
2392                 bool is_unit_but = (ui_but_is_float(but) && ui_but_is_unit(but));
2393                 /* only enable verbose if we won't run again with units */
2394                 if (BPY_execute_string_as_number(C, str, is_unit_but == false, r_value)) {
2395                         /* if the value parsed ok without unit conversion this button may still need a unit multiplier */
2396                         if (is_unit_but) {
2397                                 char str_new[128];
2398
2399                                 BLI_snprintf(str_new, sizeof(str_new), "%f", *r_value);
2400                                 ok = ui_set_but_string_eval_num_unit(C, but, str_new, r_value);
2401                         }
2402                         else {
2403                                 ok = true; /* parse normal string via py (no unit conversion needed) */
2404                         }
2405                 }
2406                 else if (is_unit_but) {
2407                         /* parse failed, this is a unit but so run replacements and parse again */
2408                         ok = ui_set_but_string_eval_num_unit(C, but, str, r_value);
2409                 }
2410         }
2411
2412 #else /* WITH_PYTHON */
2413
2414         *r_value = atof(str);
2415         ok = true;
2416
2417         UNUSED_VARS(C, but);
2418
2419 #endif /* WITH_PYTHON */
2420
2421         return ok;
2422 }
2423
2424 /* just the assignment/free part */
2425 static void ui_but_string_set_internal(uiBut *but, const char *str, size_t str_len)
2426 {
2427         BLI_assert(str_len == strlen(str));
2428         BLI_assert(but->str == NULL);
2429         str_len += 1;
2430
2431         if (str_len > UI_MAX_NAME_STR) {
2432                 but->str = MEM_mallocN(str_len, "ui_def_but str");
2433         }
2434         else {
2435                 but->str = but->strdata;
2436         }
2437         memcpy(but->str, str, str_len);
2438 }
2439
2440 static void ui_but_string_free_internal(uiBut *but)
2441 {
2442         if (but->str) {
2443                 if (but->str != but->strdata) {
2444                         MEM_freeN(but->str);
2445                 }
2446                 /* must call 'ui_but_string_set_internal' after */
2447                 but->str = NULL;
2448         }
2449 }
2450
2451 bool ui_but_string_set(bContext *C, uiBut *but, const char *str)
2452 {
2453         if (but->rnaprop && but->rnapoin.data && ELEM(but->type, UI_BTYPE_TEXT, UI_BTYPE_SEARCH_MENU)) {
2454                 if (RNA_property_editable(&but->rnapoin, but->rnaprop)) {
2455                         PropertyType type;
2456
2457                         type = RNA_property_type(but->rnaprop);
2458
2459                         if (type == PROP_STRING) {
2460                                 /* RNA string */
2461                                 RNA_property_string_set(&but->rnapoin, but->rnaprop, str);
2462                                 return true;
2463                         }
2464                         else if (type == PROP_POINTER) {
2465                                 if (str[0] == '\0') {
2466                                         RNA_property_pointer_set(&but->rnapoin, but->rnaprop, PointerRNA_NULL);
2467                                         return true;
2468                                 }
2469                                 else {
2470                                         /* RNA pointer */
2471                                         PointerRNA rptr;
2472                                         PointerRNA ptr = but->rnasearchpoin;
2473                                         PropertyRNA *prop = but->rnasearchprop;
2474
2475                                         if (prop && RNA_property_collection_lookup_string(&ptr, prop, str, &rptr))
2476                                                 RNA_property_pointer_set(&but->rnapoin, but->rnaprop, rptr);
2477
2478                                         return true;
2479                                 }
2480
2481                                 return false;
2482                         }
2483                         else if (type == PROP_ENUM) {
2484                                 int value;
2485                                 if (RNA_property_enum_value(but->block->evil_C, &but->rnapoin, but->rnaprop, str, &value)) {
2486                                         RNA_property_enum_set(&but->rnapoin, but->rnaprop, value);
2487                                         return true;
2488                                 }
2489                                 return false;
2490                         }
2491                         else {
2492                                 BLI_assert(0);
2493                         }
2494                 }
2495         }
2496         else if (but->type == UI_BTYPE_TAB) {
2497                 if (but->rnaprop && but->custom_data) {
2498                         StructRNA *ptr_type = RNA_property_pointer_type(&but->rnapoin, but->rnaprop);
2499                         PointerRNA ptr;
2500                         PropertyRNA *prop;
2501
2502                         /* uiBut.custom_data points to data this tab represents (e.g. workspace).
2503                          * uiBut.rnapoin/prop store an active value (e.g. active workspace). */
2504                         RNA_pointer_create(but->rnapoin.id.data, ptr_type, but->custom_data, &ptr);
2505                         prop = RNA_struct_name_property(ptr_type);
2506                         if (RNA_property_editable(&ptr, prop)) {
2507                                 RNA_property_string_set(&ptr, prop, str);
2508                         }
2509                 }
2510         }
2511         else if (but->type == UI_BTYPE_TEXT) {
2512                 /* string */
2513                 if (!but->poin || (str[0] == '\0')) {
2514                         str = "";
2515                 }
2516                 else if (ui_but_is_utf8(but)) {
2517                         BLI_strncpy_utf8(but->poin, str, but->hardmax);
2518                 }
2519                 else {
2520                         BLI_strncpy(but->poin, str, but->hardmax);
2521                 }
2522
2523                 return true;
2524         }
2525         else if (but->type == UI_BTYPE_SEARCH_MENU) {
2526                 /* string */
2527                 BLI_strncpy(but->poin, str, but->hardmax);
2528                 return true;
2529         }
2530         else if (ui_but_anim_expression_set(but, str)) {
2531                 /* driver expression */
2532                 return true;
2533         }
2534         else if (str[0] == '#') {
2535                 /* shortcut to create new driver expression (versus immediate Py-execution) */
2536                 return ui_but_anim_expression_create(but, str + 1);
2537         }
2538         else {
2539                 /* number editing */
2540                 double value;
2541
2542                 if (ui_but_string_set_eval_num(C, but, str, &value) == false) {
2543                         WM_report_banner_show();
2544                         return false;
2545                 }
2546
2547                 if (!ui_but_is_float(but)) {
2548                         value = floor(value + 0.5);
2549                 }
2550
2551                 /* not that we use hard limits here */
2552                 if (value < (double)but->hardmin) value = but->hardmin;
2553                 if (value > (double)but->hardmax) value = but->hardmax;
2554
2555                 ui_but_value_set(but, value);
2556                 return true;
2557         }
2558
2559         return false;
2560 }
2561
2562 void ui_but_default_set(bContext *C, const bool all, const bool use_afterfunc)
2563 {
2564         wmOperatorType *ot = WM_operatortype_find("UI_OT_reset_default_button", true);
2565
2566         if (use_afterfunc) {
2567                 PointerRNA *ptr;
2568                 ptr = ui_handle_afterfunc_add_operator(ot, WM_OP_EXEC_DEFAULT, true);
2569                 RNA_boolean_set(ptr, "all", all);
2570         }
2571         else {
2572                 PointerRNA ptr;
2573                 WM_operator_properties_create_ptr(&ptr, ot);
2574                 RNA_boolean_set(&ptr, "all", all);
2575                 WM_operator_name_call_ptr(C, ot, WM_OP_EXEC_DEFAULT, &ptr);
2576                 WM_operator_properties_free(&ptr);
2577         }
2578 }
2579
2580 static double soft_range_round_up(double value, double max)
2581 {
2582         /* round up to .., 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 50, ..
2583          * checking for 0.0 prevents floating point exceptions */
2584         double newmax = (value != 0.0) ? pow(10.0, ceil(log(value) / M_LN10)) : 0.0;
2585
2586         if (newmax * 0.2 >= max && newmax * 0.2 >= value)
2587                 return newmax * 0.2;
2588         else if (newmax * 0.5 >= max && newmax * 0.5 >= value)
2589                 return newmax * 0.5;
2590         else
2591                 return newmax;
2592 }
2593
2594 static double soft_range_round_down(double value, double max)
2595 {
2596         /* round down to .., 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 50, ..
2597          * checking for 0.0 prevents floating point exceptions */
2598         double newmax = (value != 0.0) ? pow(10.0, floor(log(value) / M_LN10)) : 0.0;
2599
2600         if (newmax * 5.0 <= max && newmax * 5.0 <= value)
2601                 return newmax * 5.0;
2602         else if (newmax * 2.0 <= max && newmax * 2.0 <= value)
2603                 return newmax * 2.0;
2604         else
2605                 return newmax;
2606 }
2607
2608 /* note: this could be split up into functions which handle arrays and not */
2609 static void ui_set_but_soft_range(uiBut *but)
2610 {
2611         /* ideally we would not limit this but practically, its more than
2612          * enough worst case is very long vectors wont use a smart soft-range
2613          * which isn't so bad. */
2614
2615         if (but->rnaprop) {
2616                 const PropertyType type = RNA_property_type(but->rnaprop);
2617                 double softmin, softmax /*, step, precision*/;
2618                 double value_min;
2619                 double value_max;
2620
2621                 /* clamp button range to something reasonable in case
2622                  * we get -inf/inf from RNA properties */
2623                 if (type == PROP_INT) {
2624                         const bool is_array = RNA_property_array_check(but->rnaprop);
2625                         int imin, imax, istep;
2626
2627                         RNA_property_int_ui_range(&but->rnapoin, but->rnaprop, &imin, &imax, &istep);
2628                         softmin = (imin == INT_MIN) ? -1e4 : imin;
2629                         softmax = (imin == INT_MAX) ? 1e4 : imax;
2630                         /*step = istep;*/ /*UNUSED*/
2631                         /*precision = 1;*/ /*UNUSED*/
2632
2633                         if (is_array) {
2634                                 int value_range[2];
2635                                 RNA_property_int_get_array_range(&but->rnapoin, but->rnaprop, value_range);
2636                                 value_min = (double)value_range[0];
2637                                 value_max = (double)value_range[1];
2638                         }
2639                         else {
2640                                 value_min = value_max = (double)RNA_property_int_get(&but->rnapoin, but->rnaprop);
2641                         }
2642                 }
2643                 else if (type == PROP_FLOAT) {
2644                         const bool is_array = RNA_property_array_check(but->rnaprop);
2645                         float fmin, fmax, fstep, fprecision;
2646
2647                         RNA_property_float_ui_range(&but->rnapoin, but->rnaprop, &fmin, &fmax, &fstep, &fprecision);
2648                         softmin = (fmin == -FLT_MAX) ? (float)-1e4 : fmin;
2649                         softmax = (fmax == FLT_MAX) ? (float)1e4 : fmax;
2650                         /*step = fstep;*/ /*UNUSED*/
2651                         /*precision = fprecision;*/ /*UNUSED*/
2652
2653                         if (is_array) {
2654                                 float value_range[2];
2655                                 RNA_property_float_get_array_range(&but->rnapoin, but->rnaprop, value_range);
2656                                 value_min = (double)value_range[0];
2657                                 value_max = (double)value_range[1];
2658                         }
2659                         else {
2660                                 value_min = value_max = (double)RNA_property_float_get(&but->rnapoin, but->rnaprop);
2661                         }
2662                 }
2663                 else {
2664                         return;
2665                 }
2666
2667                 /* if the value goes out of the soft/max range, adapt the range */
2668                 if (value_min + 1e-10 < softmin) {
2669                         if (value_min < 0.0)
2670                                 softmin = -soft_range_round_up(-value_min, -softmin);
2671                         else
2672                                 softmin = soft_range_round_down(value_min, softmin);
2673
2674                         if (softmin < (double)but->hardmin)
2675                                 softmin = (double)but->hardmin;
2676                 }
2677                 if (value_max - 1e-10 > softmax) {
2678                         if (value_max < 0.0)
2679                                 softmax = -soft_range_round_down(-value_max, -softmax);
2680                         else
2681                                 softmax = soft_range_round_up(value_max, softmax);
2682
2683                         if (softmax > (double)but->hardmax)
2684                                 softmax = but->hardmax;
2685                 }
2686
2687                 but->softmin = softmin;
2688                 but->softmax = softmax;
2689         }
2690         else if (but->poin && (but->pointype & UI_BUT_POIN_TYPES)) {
2691                 float value = ui_but_value_get(but);
2692                 if (isfinite(value)) {
2693                         CLAMP(value, but->hardmin, but->hardmax);
2694                         but->softmin = min_ff(but->softmin, value);
2695                         but->softmax = max_ff(but->softmax, value);
2696                 }
2697         }
2698         else {
2699                 BLI_assert(0);
2700         }
2701 }
2702
2703 /* ******************* Free ********************/
2704
2705 /* can be called with C==NULL */
2706 static void ui_but_free(const bContext *C, uiBut *but)
2707 {
2708         if (but->opptr) {
2709                 WM_operator_properties_free(but->opptr);
2710                 MEM_freeN(but->opptr);
2711         }
2712
2713         if (but->func_argN) {
2714                 MEM_freeN(but->func_argN);
2715         }
2716
2717         if (but->tip_argN) {
2718                 MEM_freeN(but->tip_argN);
2719         }
2720
2721         if (but->hold_argN) {
2722                 MEM_freeN(but->hold_argN);
2723         }
2724
2725         if (!but->editstr && but->free_search_arg) {
2726                 MEM_SAFE_FREE(but->search_arg);
2727         }
2728
2729         if (but->active) {
2730                 /* XXX solve later, buttons should be free-able without context ideally,
2731                  * however they may have open tooltips or popup windows, which need to
2732                  * be closed using a context pointer */
2733                 if (C) {
2734                         ui_but_active_free(C, but);
2735                 }
2736                 else {
2737                         if (but->active) {
2738                                 MEM_freeN(but->active);
2739                         }
2740                 }
2741         }
2742         if (but->str && but->str != but->strdata) {
2743                 MEM_freeN(but->str);
2744         }
2745
2746         if ((but->type == UI_BTYPE_IMAGE) && but->poin) {
2747                 IMB_freeImBuf((struct ImBuf *)but->poin);
2748         }
2749
2750         if (but->dragpoin && (but->dragflag & UI_BUT_DRAGPOIN_FREE)) {
2751                 MEM_freeN(but->dragpoin);
2752         }
2753
2754         BLI_assert(UI_butstore_is_registered(but->block, but) == false);
2755
2756         MEM_freeN(but);
2757 }
2758
2759 /* can be called with C==NULL */
2760 void UI_block_free(const bContext *C, uiBlock *block)
2761 {
2762         uiBut *but;
2763
2764         UI_butstore_clear(block);
2765
2766         while ((but = BLI_pophead(&block->buttons))) {
2767                 ui_but_free(C, but);
2768         }
2769
2770         if (block->unit) {
2771                 MEM_freeN(block->unit);
2772         }
2773
2774         if (block->func_argN) {
2775                 MEM_freeN(block->func_argN);
2776         }
2777
2778         CTX_store_free_list(&block->contexts);
2779
2780         BLI_freelistN(&block->saferct);
2781         BLI_freelistN(&block->color_pickers.list);
2782
2783         MEM_freeN(block);
2784 }
2785
2786 void UI_blocklist_update_window_matrix(const bContext *C, const ListBase *lb)
2787 {
2788         ARegion *region = CTX_wm_region(C);
2789         wmWindow *window = CTX_wm_window(C);
2790
2791         for (uiBlock *block = lb->first; block; block = block->next) {
2792                 if (block->active) {
2793                         ui_update_window_matrix(window, region, block);
2794                 }
2795         }
2796 }
2797
2798 void UI_blocklist_draw(const bContext *C, const ListBase *lb)
2799 {
2800         for (uiBlock *block = lb->first; block; block = block->next) {
2801                 if (block->active) {
2802                         UI_block_draw(C, block);
2803                 }
2804         }
2805 }
2806
2807 /* can be called with C==NULL */
2808 void UI_blocklist_free(const bContext *C, ListBase *lb)
2809 {
2810         uiBlock *block;
2811
2812         while ((block = BLI_pophead(lb))) {
2813                 UI_block_free(C, block);
2814         }
2815 }
2816
2817 void UI_blocklist_free_inactive(const bContext *C, ListBase *lb)
2818 {
2819         uiBlock *block, *nextblock;
2820
2821         for (block = lb->first; block; block = nextblock) {
2822                 nextblock = block->next;
2823
2824                 if (!block->handle) {
2825                         if (!block->active) {
2826                                 BLI_remlink(lb, block);
2827                                 UI_block_free(C, block);
2828                         }
2829                         else
2830                                 block->active = 0;
2831                 }
2832         }
2833 }
2834
2835 void UI_block_region_set(uiBlock *block, ARegion *region)
2836 {
2837         ListBase *lb = &region->uiblocks;
2838         uiBlock *oldblock = NULL;
2839
2840         /* each listbase only has one block with this name, free block
2841          * if is already there so it can be rebuilt from scratch */
2842         if (lb) {
2843                 oldblock = BLI_findstring(lb, block->name, offsetof(uiBlock, name));
2844
2845                 if (oldblock) {
2846                         oldblock->active = 0;
2847                         oldblock->panel = NULL;
2848                         oldblock->handle = NULL;
2849                 }
2850
2851                 /* at the beginning of the list! for dynamical menus/blocks */
2852                 BLI_addhead(lb, block);
2853         }
2854
2855         block->oldblock = oldblock;
2856 }
2857
2858 uiBlock *UI_block_begin(const bContext *C, ARegion *region, const char *name, short dt)
2859 {
2860         uiBlock *block;
2861         wmWindow *window;
2862         Scene *scn;
2863
2864         window = CTX_wm_window(C);
2865         scn = CTX_data_scene(C);
2866
2867         block = MEM_callocN(sizeof(uiBlock), "uiBlock");
2868         block->active = 1;
2869         block->dt = dt;
2870         block->evil_C = (void *)C;  /* XXX */
2871
2872         if (scn) {
2873                 block->color_profile = true;
2874
2875                 /* store display device name, don't lookup for transformations yet
2876                  * block could be used for non-color displays where looking up for transformation
2877                  * would slow down redraw, so only lookup for actual transform when it's indeed
2878                  * needed
2879                  */
2880                 BLI_strncpy(block->display_device, scn->display_settings.display_device, sizeof(block->display_device));
2881
2882                 /* copy to avoid crash when scene gets deleted with ui still open */
2883                 block->unit = MEM_mallocN(sizeof(scn->unit), "UI UnitSettings");
2884                 memcpy(block->unit, &scn->unit, sizeof(scn->unit));
2885         }
2886
2887         BLI_strncpy(block->name, name, sizeof(block->name));
2888
2889         if (region)
2890                 UI_block_region_set(block, region);
2891
2892         /* Set window matrix and aspect for region and OpenGL state. */
2893         ui_update_window_matrix(window, region, block);
2894
2895         /* Tag as popup menu if not created within a region. */
2896         if (!(region && region->visible)) {
2897                 block->auto_open = true;
2898                 block->flag |= UI_BLOCK_LOOP;
2899         }
2900
2901         return block;
2902 }
2903
2904 void UI_block_emboss_set(uiBlock *block, char dt)
2905 {
2906         block->dt = dt;
2907 }
2908
2909 /**
2910  * \param but: Button to update.
2911  * \param validate: When set, this function may change the button value.
2912  * Otherwise treat the button value as read-only.
2913  */
2914 void ui_but_update_ex(uiBut *but, const bool validate)
2915 {
2916         /* if something changed in the button */
2917         double value = UI_BUT_VALUE_UNSET;
2918 //      float okwidth; // UNUSED
2919
2920         ui_but_update_select_flag(but, &value);
2921
2922         /* only update soft range while not editing */
2923         if (!(but->editval || but->editstr || but->editvec)) {
2924                 if ((but->rnaprop != NULL) ||
2925                     (but->poin && (but->pointype & UI_BUT_POIN_TYPES)))
2926                 {
2927                         ui_set_but_soft_range(but);
2928                 }
2929         }
2930
2931         /* test for min and max, icon sliders, etc */
2932         switch (but->type) {
2933                 case UI_BTYPE_NUM:
2934                 case UI_BTYPE_SCROLL:
2935                 case UI_BTYPE_NUM_SLIDER:
2936                         if (validate) {
2937                                 UI_GET_BUT_VALUE_INIT(but, value);
2938                                 if      (value < (double)but->hardmin) {
2939                                         ui_but_value_set(but, but->hardmin);
2940                                 }
2941                                 else if (value > (double)but->hardmax) {
2942                                         ui_but_value_set(but, but->hardmax);
2943                                 }
2944
2945                                 /* max must never be smaller than min! Both being equal is allowed though */
2946                                 BLI_assert(but->softmin <= but->softmax &&
2947                                            but->hardmin <= but->hardmax);
2948                         }
2949                         break;
2950
2951                 case UI_BTYPE_ICON_TOGGLE:
2952                 case UI_BTYPE_ICON_TOGGLE_N:
2953                         if (!but->rnaprop || (RNA_property_flag(but->rnaprop) & PROP_ICONS_CONSECUTIVE)) {
2954                                 if (but->flag & UI_SELECT) but->iconadd = 1;
2955                                 else but->iconadd = 0;
2956                         }
2957                         break;
2958
2959                         /* quiet warnings for unhandled types */
2960                 default:
2961                         break;
2962         }
2963
2964
2965         /* safety is 4 to enable small number buttons (like 'users') */
2966         // okwidth = -4 + (BLI_rcti_size_x(&but->rect)); // UNUSED
2967
2968         /* name: */
2969         switch (but->type) {
2970
2971                 case UI_BTYPE_MENU:
2972                         if (BLI_rctf_size_x(&but->rect) >= (UI_UNIT_X * 2)) {
2973                                 /* only needed for menus in popup blocks that don't recreate buttons on redraw */
2974                                 if (but->block->flag & UI_BLOCK_LOOP) {
2975                                         if (but->rnaprop && (RNA_property_type(but->rnaprop) == PROP_ENUM)) {
2976                                                 int value_enum = RNA_property_enum_get(&but->rnapoin, but->rnaprop);
2977
2978                                                 EnumPropertyItem item;
2979                                                 if (RNA_property_enum_item_from_value_gettexted(
2980                                                         but->block->evil_C,
2981                                                         &but->rnapoin, but->rnaprop, value_enum, &item))
2982                                                 {
2983                                                         size_t slen = strlen(item.name);
2984                                                         ui_but_string_free_internal(but);
2985                                                         ui_but_string_set_internal(but, item.name, slen);
2986                                                         but->icon = item.icon;
2987                                                 }
2988                                         }
2989                                 }
2990                                 BLI_strncpy(but->drawstr, but->str, sizeof(but->drawstr));
2991                         }
2992                         break;
2993
2994                 case UI_BTYPE_NUM:
2995                 case UI_BTYPE_NUM_SLIDER:
2996
2997                         if (!but->editstr) {
2998                                 const char *drawstr_suffix = NULL;
2999                                 size_t slen;
3000
3001                                 UI_GET_BUT_VALUE_INIT(but, value);
3002
3003                                 slen = BLI_strncpy_rlen(but->drawstr, but->str, sizeof(but->drawstr));
3004
3005                                 if (ui_but_is_float(but)) {
3006                                         if (value == (double) FLT_MAX) {
3007                                                 slen += BLI_strncpy_rlen(but->drawstr + slen, "inf", sizeof(but->drawstr) - slen);
3008                                         }
3009                                         else if (value == (double) -FLT_MAX) {
3010                                                 slen += BLI_strncpy_rlen(but->drawstr + slen, "-inf", sizeof(but->drawstr) - slen);
3011                                         }
3012                                         /* support length type buttons */
3013                                         else if (ui_but_is_unit(but)) {
3014                                                 char new_str[sizeof(but->drawstr)];
3015                                                 ui_get_but_string_unit(but, new_str, sizeof(new_str), value, true, -1);
3016                                                 slen += BLI_strncpy_rlen(but->drawstr + slen, new_str, sizeof(but->drawstr) - slen);
3017                                         }
3018                                         else {
3019                                                 const int prec = ui_but_calc_float_precision(but, value);
3020                                                 slen += BLI_snprintf_rlen(but->drawstr + slen, sizeof(but->drawstr) - slen, "%.*f", prec, value);
3021                                         }
3022                                 }
3023                                 else {
3024                                         slen += BLI_snprintf_rlen(but->drawstr + slen, sizeof(but->drawstr) - slen, "%d", (int)value);
3025                                 }
3026
3027                                 if (but->rnaprop) {
3028                                         PropertySubType pstype = RNA_property_subtype(but->rnaprop);
3029
3030                                         if (pstype == PROP_PERCENTAGE) {
3031                                                 drawstr_suffix = "%";
3032                                         }
3033                                         else if (pstype == PROP_PIXEL) {
3034                                                 drawstr_suffix = " px";
3035                                         }
3036                                 }
3037
3038                                 if (drawstr_suffix) {
3039                                         BLI_strncpy(but->drawstr + slen, drawstr_suffix, sizeof(but->drawstr) - slen);
3040                                 }
3041
3042                         }
3043                         break;
3044
3045                 case UI_BTYPE_LABEL:
3046                         if (ui_but_is_float(but)) {
3047                                 int prec;
3048                                 UI_GET_BUT_VALUE_INIT(but, value);
3049                                 prec = ui_but_calc_float_precision(but, value);
3050                                 BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%.*f", but->str, prec, value);
3051                         }
3052                         else {
3053                                 BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);
3054                         }
3055
3056                         break;
3057
3058                 case UI_BTYPE_TEXT:
3059                 case UI_BTYPE_SEARCH_MENU:
3060                 case UI_BTYPE_TAB:
3061                         if (!but->editstr) {
3062                                 char str[UI_MAX_DRAW_STR];
3063
3064                                 ui_but_string_get(but, str, UI_MAX_DRAW_STR);
3065                                 BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%s", but->str, str);
3066                         }
3067                         break;
3068
3069                 case UI_BTYPE_KEY_EVENT:
3070                 {
3071                         const char *str;
3072                         if (but->flag & UI_SELECT) {
3073                                 str = "Press a key";
3074                         }
3075                         else {
3076                                 UI_GET_BUT_VALUE_INIT(but, value);
3077                                 str = WM_key_event_string((short)value, false);
3078                         }
3079                         BLI_snprintf(but->drawstr, UI_MAX_DRAW_STR, "%s%s", but->str, str);
3080                         break;
3081                 }
3082                 case UI_BTYPE_HOTKEY_EVENT:
3083                         if (but->flag & UI_SELECT) {
3084
3085                                 if (but->modifier_key) {
3086                                         char *str = but->drawstr;
3087                                         but->drawstr[0] = '\0';
3088
3089                                         if (but->modifier_key & KM_SHIFT)
3090                                                 str += BLI_strcpy_rlen(str, "Shift ");
3091                                         if (but->modifier_key & KM_CTRL)
3092                                                 str += BLI_strcpy_rlen(str, "Ctrl ");
3093                                         if (but->modifier_key & KM_ALT)
3094                                                 str += BLI_strcpy_rlen(str, "Alt ");
3095                                         if (but->modifier_key & KM_OSKEY)
3096                                                 str += BLI_strcpy_rlen(str, "Cmd ");
3097
3098                                         (void)str; /* UNUSED */
3099                                 }
3100                                 else {
3101                                         BLI_strncpy(but->drawstr, "Press a key", UI_MAX_DRAW_STR);
3102                                 }
3103                         }
3104                         else
3105                                 BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);
3106
3107                         break;
3108
3109                 case UI_BTYPE_HSVCUBE:
3110                 case UI_BTYPE_HSVCIRCLE: