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