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