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