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