a1b9c0d6d077db024dc0f8e0d039bbc0fcc27662
[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  
37 #include "MEM_guardedalloc.h"
38
39 #include "DNA_scene_types.h"
40 #include "DNA_screen_types.h"
41 #include "DNA_userdef_types.h"
42
43 #include "BLI_math.h"
44 #include "BLI_listbase.h"
45 #include "BLI_string.h"
46 #include "BLI_string_utf8.h"
47 #include "BLI_path_util.h"
48 #include "BLI_rect.h"
49
50 #include "BLI_dynstr.h"
51 #include "BLI_utildefines.h"
52
53 #include "BKE_context.h"
54 #include "BKE_library.h"
55 #include "BKE_unit.h"
56 #include "BKE_screen.h"
57 #include "BKE_idprop.h"
58
59 #include "BIF_gl.h"
60
61 #include "BLF_api.h"
62 #include "BLF_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 #include "wm_window.h"
72
73 #include "RNA_access.h"
74
75 #include "BPY_extern.h"
76
77 #include "interface_intern.h"
78
79 #define MENU_WIDTH          120
80 #define MENU_ITEM_HEIGHT    20
81 #define MENU_SEP_HEIGHT     6
82
83 #define PRECISION_FLOAT_MAX 6
84 #define PRECISION_FLOAT_MAX_POW 1000000 /* pow(10, PRECISION_FLOAT_MAX)  */
85
86 /* avoid unneeded calls to ui_get_but_val */
87 #define UI_BUT_VALUE_UNSET DBL_MAX
88 #define UI_GET_BUT_VALUE_INIT(_but, _value) if (_value == DBL_MAX) {  (_value) = ui_get_but_val(_but); } (void)0
89
90 /* 
91  * a full doc with API notes can be found in bf-blender/trunk/blender/doc/guides/interface_API.txt
92  * 
93  * uiBlahBlah()         external function
94  * ui_blah_blah()       internal function
95  */
96
97 static void ui_free_but(const bContext *C, uiBut *but);
98
99 /* ************* window matrix ************** */
100
101 void ui_block_to_window_fl(const ARegion *ar, uiBlock *block, float *x, float *y)
102 {
103         float gx, gy;
104         int sx, sy, getsizex, getsizey;
105
106         getsizex = BLI_RCT_SIZE_X(&ar->winrct) + 1;
107         getsizey = BLI_RCT_SIZE_Y(&ar->winrct) + 1;
108         sx = ar->winrct.xmin;
109         sy = ar->winrct.ymin;
110
111         gx = *x;
112         gy = *y;
113
114         if (block->panel) {
115                 gx += block->panel->ofsx;
116                 gy += block->panel->ofsy;
117         }
118
119         *x = ((float)sx) + ((float)getsizex) * (0.5f + 0.5f * (gx * block->winmat[0][0] + gy * block->winmat[1][0] + block->winmat[3][0]));
120         *y = ((float)sy) + ((float)getsizey) * (0.5f + 0.5f * (gx * block->winmat[0][1] + gy * block->winmat[1][1] + block->winmat[3][1]));
121 }
122
123 void ui_block_to_window(const ARegion *ar, uiBlock *block, int *x, int *y)
124 {
125         float fx, fy;
126
127         fx = *x;
128         fy = *y;
129
130         ui_block_to_window_fl(ar, block, &fx, &fy);
131
132         *x = (int)(fx + 0.5f);
133         *y = (int)(fy + 0.5f);
134 }
135
136 void ui_block_to_window_rct(const ARegion *ar, uiBlock *block, rctf *graph, rcti *winr)
137 {
138         rctf tmpr;
139
140         tmpr = *graph;
141         ui_block_to_window_fl(ar, block, &tmpr.xmin, &tmpr.ymin);
142         ui_block_to_window_fl(ar, block, &tmpr.xmax, &tmpr.ymax);
143
144         BLI_rcti_rctf_copy(winr, &tmpr);
145 }
146
147 void ui_window_to_block_fl(const ARegion *ar, uiBlock *block, float *x, float *y)   /* for mouse cursor */
148 {
149         float a, b, c, d, e, f, px, py;
150         int sx, sy, getsizex, getsizey;
151
152         getsizex = BLI_RCT_SIZE_X(&ar->winrct) + 1;
153         getsizey = BLI_RCT_SIZE_Y(&ar->winrct) + 1;
154         sx = ar->winrct.xmin;
155         sy = ar->winrct.ymin;
156
157         a = 0.5f * ((float)getsizex) * block->winmat[0][0];
158         b = 0.5f * ((float)getsizex) * block->winmat[1][0];
159         c = 0.5f * ((float)getsizex) * (1.0f + block->winmat[3][0]);
160
161         d = 0.5f * ((float)getsizey) * block->winmat[0][1];
162         e = 0.5f * ((float)getsizey) * block->winmat[1][1];
163         f = 0.5f * ((float)getsizey) * (1.0f + block->winmat[3][1]);
164
165         px = *x - sx;
166         py = *y - sy;
167
168         *y =  (a * (py - f) + d * (c - px)) / (a * e - d * b);
169         *x = (px - b * (*y) - c) / a;
170
171         if (block->panel) {
172                 *x -= block->panel->ofsx;
173                 *y -= block->panel->ofsy;
174         }
175 }
176
177 void ui_window_to_block(const ARegion *ar, uiBlock *block, int *x, int *y)
178 {
179         float fx, fy;
180
181         fx = *x;
182         fy = *y;
183
184         ui_window_to_block_fl(ar, block, &fx, &fy);
185
186         *x = (int)(fx + 0.5f);
187         *y = (int)(fy + 0.5f);
188 }
189
190 void ui_window_to_region(const ARegion *ar, int *x, int *y)
191 {
192         *x -= ar->winrct.xmin;
193         *y -= ar->winrct.ymin;
194 }
195
196 /* ******************* block calc ************************* */
197
198 void ui_block_translate(uiBlock *block, int x, int y)
199 {
200         uiBut *but;
201
202         for (but = block->buttons.first; but; but = but->next) {
203                 BLI_rctf_translate(&but->rect, x, y);
204         }
205
206         BLI_rctf_translate(&block->rect, x, y);
207 }
208
209 static void ui_text_bounds_block(uiBlock *block, float offset)
210 {
211         uiStyle *style = UI_GetStyle();
212         uiBut *bt;
213         int i = 0, j, x1addval = offset, nextcol;
214         int lastcol = 0, col = 0;
215         
216         uiStyleFontSet(&style->widget);
217         
218         for (bt = block->buttons.first; bt; bt = bt->next) {
219                 if (bt->type != SEPR) {
220                         j = BLF_width(style->widget.uifont_id, bt->drawstr);
221
222                         if (j > i) i = j;
223                 }
224
225                 if (bt->next && bt->rect.xmin < bt->next->rect.xmin)
226                         lastcol++;
227         }
228
229         /* cope with multi collumns */
230         bt = block->buttons.first;
231         while (bt) {
232                 if (bt->next && bt->rect.xmin < bt->next->rect.xmin) {
233                         nextcol = 1;
234                         col++;
235                 }
236                 else nextcol = 0;
237                 
238                 bt->rect.xmin = x1addval;
239                 bt->rect.xmax = bt->rect.xmin + i + block->bounds;
240                 
241                 if (col == lastcol) {
242                         bt->rect.xmax = maxf(bt->rect.xmax, offset + block->minbounds);
243                 }
244
245                 ui_check_but(bt);  /* clips text again */
246                 
247                 if (nextcol)
248                         x1addval += i + block->bounds;
249                 
250                 bt = bt->next;
251         }
252 }
253
254 void ui_bounds_block(uiBlock *block)
255 {
256         uiBut *bt;
257         int xof;
258         
259         if (block->buttons.first == NULL) {
260                 if (block->panel) {
261                         block->rect.xmin = 0.0; block->rect.xmax = block->panel->sizex;
262                         block->rect.ymin = 0.0; block->rect.ymax = block->panel->sizey;
263                 }
264         }
265         else {
266         
267                 BLI_rctf_init_minmax(&block->rect);
268
269                 for (bt = block->buttons.first; bt; bt = bt->next) {
270                         BLI_rctf_union(&block->rect, &bt->rect);
271                 }
272                 
273                 block->rect.xmin -= block->bounds;
274                 block->rect.ymin -= block->bounds;
275                 block->rect.xmax += block->bounds;
276                 block->rect.ymax += block->bounds;
277         }
278
279         block->rect.xmax = block->rect.xmin + maxf(BLI_RCT_SIZE_X(&block->rect), block->minbounds);
280
281         /* hardcoded exception... but that one is annoying with larger safety */ 
282         bt = block->buttons.first;
283         if (bt && strncmp(bt->str, "ERROR", 5) == 0) xof = 10;
284         else xof = 40;
285
286         block->safety.xmin = block->rect.xmin - xof;
287         block->safety.ymin = block->rect.ymin - xof;
288         block->safety.xmax = block->rect.xmax + xof;
289         block->safety.ymax = block->rect.ymax + xof;
290 }
291
292 static void ui_centered_bounds_block(const bContext *C, uiBlock *block)
293 {
294         wmWindow *window = CTX_wm_window(C);
295         int xmax, ymax;
296         int startx, starty;
297         int width, height;
298         
299         /* note: this is used for the splash where window bounds event has not been
300          * updated by ghost, get the window bounds from ghost directly */
301
302         // wm_window_get_size(window, &xmax, &ymax);
303         wm_window_get_size_ghost(window, &xmax, &ymax);
304         
305         ui_bounds_block(block);
306         
307         width  = BLI_RCT_SIZE_X(&block->rect);
308         height = BLI_RCT_SIZE_Y(&block->rect);
309         
310         startx = (xmax * 0.5f) - (width * 0.5f);
311         starty = (ymax * 0.5f) - (height * 0.5f);
312         
313         ui_block_translate(block, startx - block->rect.xmin, starty - block->rect.ymin);
314         
315         /* now recompute bounds and safety */
316         ui_bounds_block(block);
317         
318 }
319 static void ui_popup_bounds_block(const bContext *C, uiBlock *block, int bounds_calc)
320 {
321         wmWindow *window = CTX_wm_window(C);
322         int startx, starty, endx, endy, width, height, oldwidth, oldheight;
323         int oldbounds, xmax, ymax;
324
325         oldbounds = block->bounds;
326
327         /* compute mouse position with user defined offset */
328         ui_bounds_block(block);
329         
330         wm_window_get_size(window, &xmax, &ymax);
331
332         oldwidth  = BLI_RCT_SIZE_X(&block->rect);
333         oldheight = BLI_RCT_SIZE_Y(&block->rect);
334
335         /* first we ensure wide enough text bounds */
336         if (bounds_calc == UI_BLOCK_BOUNDS_POPUP_MENU) {
337                 if (block->flag & UI_BLOCK_LOOP) {
338                         block->bounds = 50;
339                         ui_text_bounds_block(block, block->rect.xmin);
340                 }
341         }
342
343         /* next we recompute bounds */
344         block->bounds = oldbounds;
345         ui_bounds_block(block);
346
347         /* and we adjust the position to fit within window */
348         width  = BLI_RCT_SIZE_X(&block->rect);
349         height = BLI_RCT_SIZE_Y(&block->rect);
350
351         /* avoid divide by zero below, caused by calling with no UI, but better not crash */
352         oldwidth = oldwidth > 0 ? oldwidth : MAX2(1, width);
353         oldheight = oldheight > 0 ? oldheight : MAX2(1, height);
354
355         /* offset block based on mouse position, user offset is scaled
356          * along in case we resized the block in ui_text_bounds_block */
357         startx = window->eventstate->x + block->rect.xmin + (block->mx * width) / oldwidth;
358         starty = window->eventstate->y + block->rect.ymin + (block->my * height) / oldheight;
359
360         if (startx < 10)
361                 startx = 10;
362         if (starty < 10)
363                 starty = 10;
364
365         endx = startx + width;
366         endy = starty + height;
367
368         if (endx > xmax) {
369                 endx = xmax - 10;
370                 startx = endx - width;
371         }
372         if (endy > ymax - 20) {
373                 endy = ymax - 20;
374                 starty = endy - height;
375         }
376
377         ui_block_translate(block, startx - block->rect.xmin, starty - block->rect.ymin);
378
379         /* now recompute bounds and safety */
380         ui_bounds_block(block);
381 }
382
383 /* used for various cases */
384 void uiBoundsBlock(uiBlock *block, int addval)
385 {
386         if (block == NULL)
387                 return;
388         
389         block->bounds = addval;
390         block->dobounds = UI_BLOCK_BOUNDS;
391 }
392
393 /* used for pulldowns */
394 void uiTextBoundsBlock(uiBlock *block, int addval)
395 {
396         block->bounds = addval;
397         block->dobounds = UI_BLOCK_BOUNDS_TEXT;
398 }
399
400 /* used for block popups */
401 void uiPopupBoundsBlock(uiBlock *block, int addval, int mx, int my)
402 {
403         block->bounds = addval;
404         block->dobounds = UI_BLOCK_BOUNDS_POPUP_MOUSE;
405         block->mx = mx;
406         block->my = my;
407 }
408
409 /* used for menu popups */
410 void uiMenuPopupBoundsBlock(uiBlock *block, int addval, int mx, int my)
411 {
412         block->bounds = addval;
413         block->dobounds = UI_BLOCK_BOUNDS_POPUP_MENU;
414         block->mx = mx;
415         block->my = my;
416 }
417
418 /* used for centered popups, i.e. splash */
419 void uiCenteredBoundsBlock(uiBlock *block, int addval)
420 {
421         block->bounds = addval;
422         block->dobounds = UI_BLOCK_BOUNDS_POPUP_CENTER;
423 }
424
425 void uiExplicitBoundsBlock(uiBlock *block, int minx, int miny, int maxx, int maxy)
426 {
427         block->rect.xmin = minx;
428         block->rect.ymin = miny;
429         block->rect.xmax = maxx;
430         block->rect.ymax = maxy;
431         block->dobounds = 0;
432 }
433
434 /* ************** LINK LINE DRAWING  ************* */
435
436 /* link line drawing is not part of buttons or theme.. so we stick with it here */
437
438 static int ui_but_float_precision(uiBut *but, double value)
439 {
440         int prec;
441
442         /* first check if prec is 0 and fallback to a simple default */
443         if ((prec = (int)but->a2) == 0) {
444                 prec = (but->hardmax < 10.001f) ? 3 : 2;
445         }
446
447         /* check on the number of decimal places need to display
448          * the number, this is so 0.00001 is not displayed as 0.00,
449          * _but_, this is only for small values si 10.0001 will not get
450          * the same treatment */
451         if (value != 0.0 && (value = ABS(value)) < 0.1) {
452                 int value_i = (int)((value * PRECISION_FLOAT_MAX_POW) + 0.5);
453                 if (value_i != 0) {
454                         const int prec_span = 3; /* show: 0.01001, 5 would allow 0.0100001 for eg. */
455                         int test_prec;
456                         int prec_min = -1;
457                         int dec_flag = 0;
458                         int i = PRECISION_FLOAT_MAX;
459                         while (i && value_i) {
460                                 if (value_i % 10) {
461                                         dec_flag |= 1 << i;
462                                         prec_min = i;
463                                 }
464                                 value_i /= 10;
465                                 i--;
466                         }
467
468                         /* even though its a small value, if the second last digit is not 0, use it */
469                         test_prec = prec_min;
470
471                         dec_flag = (dec_flag >> (prec_min + 1)) & ((1 << prec_span) - 1);
472
473                         while (dec_flag) {
474                                 test_prec++;
475                                 dec_flag = dec_flag >> 1;
476                         }
477
478                         if (test_prec > prec) {
479                                 prec = test_prec;
480                         }
481                 }
482         }
483
484         CLAMP(prec, 1, PRECISION_FLOAT_MAX);
485
486         return prec;
487 }
488
489 static void ui_draw_linkline(uiLinkLine *line, int highlightActiveLines)
490 {
491         rcti rect;
492
493         if (line->from == NULL || line->to == NULL) return;
494         
495         rect.xmin = BLI_RCT_CENTER_X(&line->from->rect);
496         rect.ymin = BLI_RCT_CENTER_Y(&line->from->rect);
497         rect.xmax = BLI_RCT_CENTER_X(&line->to->rect);
498         rect.ymax = BLI_RCT_CENTER_Y(&line->to->rect);
499         
500         if (line->flag & UI_SELECT)
501                 glColor3ub(100, 100, 100);
502         else if (highlightActiveLines && ((line->from->flag & UI_ACTIVE) || (line->to->flag & UI_ACTIVE)))
503                 UI_ThemeColor(TH_TEXT_HI);
504         else 
505                 glColor3ub(0, 0, 0);
506
507         ui_draw_link_bezier(&rect);
508 }
509
510 static void ui_draw_links(uiBlock *block)
511 {
512         uiBut *but;
513         uiLinkLine *line;
514
515         /* Draw the inactive lines (lines with neither button being hovered over).
516          * As we go, remember if we see any active or selected lines. */
517         int foundselectline = FALSE;
518         int foundactiveline = FALSE;
519         for (but = block->buttons.first; but; but = but->next) {
520                 if (but->type == LINK && but->link) {
521                         for (line = but->link->lines.first; line; line = line->next) {
522                                 if (!(line->from->flag & UI_ACTIVE) && !(line->to->flag & UI_ACTIVE))
523                                         ui_draw_linkline(line, 0);
524                                 else
525                                         foundactiveline = TRUE;
526
527                                 if ((line->from->flag & UI_SELECT) || (line->to->flag & UI_SELECT))
528                                         foundselectline = TRUE;
529                         }
530                 }
531         }       
532
533         /* Draw any active lines (lines with either button being hovered over).
534          * Do this last so they appear on top of inactive lines. */
535         if (foundactiveline) {
536                 for (but = block->buttons.first; but; but = but->next) {
537                         if (but->type == LINK && but->link) {
538                                 for (line = but->link->lines.first; line; line = line->next) {
539                                         if ((line->from->flag & UI_ACTIVE) || (line->to->flag & UI_ACTIVE))
540                                                 ui_draw_linkline(line, !foundselectline);
541                                 }
542                         }
543                 }       
544         }
545 }
546
547 /* ************** BLOCK ENDING FUNCTION ************* */
548
549 /* NOTE: if but->poin is allocated memory for every defbut, things fail... */
550 static int ui_but_equals_old(uiBut *but, uiBut *oldbut)
551 {
552         /* various properties are being compared here, hopefully sufficient
553          * to catch all cases, but it is simple to add more checks later */
554         if (but->retval != oldbut->retval) return 0;
555         if (but->rnapoin.data != oldbut->rnapoin.data) return 0;
556         if (but->rnaprop != oldbut->rnaprop)
557                 if (but->rnaindex != oldbut->rnaindex) return 0;
558         if (but->func != oldbut->func) return 0;
559         if (but->funcN != oldbut->funcN) return 0;
560         if (oldbut->func_arg1 != oldbut && but->func_arg1 != oldbut->func_arg1) return 0;
561         if (oldbut->func_arg2 != oldbut && but->func_arg2 != oldbut->func_arg2) return 0;
562         if (!but->funcN && ((but->poin != oldbut->poin && (uiBut *)oldbut->poin != oldbut) || but->pointype != oldbut->pointype)) return 0;
563         if (but->optype != oldbut->optype) return 0;
564
565         return 1;
566 }
567
568 /* oldbut is being inserted in new block, so we use the lines from new button, and replace button pointers */
569 static void ui_but_update_linklines(uiBlock *block, uiBut *oldbut, uiBut *newbut)
570 {
571         uiLinkLine *line;
572         uiBut *but;
573         
574         /* if active button is LINK */
575         if (newbut->type == LINK && newbut->link) {
576                 
577                 SWAP(uiLink *, oldbut->link, newbut->link);
578                 
579                 for (line = oldbut->link->lines.first; line; line = line->next) {
580                         if (line->to == newbut)
581                                 line->to = oldbut;
582                         if (line->from == newbut)
583                                 line->from = oldbut;
584                 }
585         }               
586         
587         /* check all other button links */
588         for (but = block->buttons.first; but; but = but->next) {
589                 if (but != newbut && but->type == LINK && but->link) {
590                         for (line = but->link->lines.first; line; line = line->next) {
591                                 if (line->to == newbut)
592                                         line->to = oldbut;
593                                 if (line->from == newbut)
594                                         line->from = oldbut;
595                         }
596                 }
597         }
598 }
599
600 static int ui_but_update_from_old_block(const bContext *C, uiBlock *block, uiBut **butpp)
601 {
602         uiBlock *oldblock;
603         uiBut *oldbut, *but = *butpp;
604         int found = 0;
605
606         oldblock = block->oldblock;
607         if (!oldblock)
608                 return found;
609
610         for (oldbut = oldblock->buttons.first; oldbut; oldbut = oldbut->next) {
611                 if (ui_but_equals_old(oldbut, but)) {
612                         if (oldbut->active) {
613 #if 0
614 //                              but->flag= oldbut->flag;
615 #else
616                                 /* exception! redalert flag can't be update from old button. 
617                                  * perhaps it should only copy specific flags rather than all. */
618 //                              but->flag= (oldbut->flag & ~UI_BUT_REDALERT) | (but->flag & UI_BUT_REDALERT);
619 #endif
620 //                              but->active= oldbut->active;
621 //                              but->pos= oldbut->pos;
622 //                              but->ofs= oldbut->ofs;
623 //                              but->editstr= oldbut->editstr;
624 //                              but->editval= oldbut->editval;
625 //                              but->editvec= oldbut->editvec;
626 //                              but->editcoba= oldbut->editcoba;
627 //                              but->editcumap= oldbut->editcumap;
628 //                              but->selsta= oldbut->selsta;
629 //                              but->selend= oldbut->selend;
630 //                              but->softmin= oldbut->softmin;
631 //                              but->softmax= oldbut->softmax;
632 //                              but->linkto[0]= oldbut->linkto[0];
633 //                              but->linkto[1]= oldbut->linkto[1];
634                                 found = 1;
635 //                              oldbut->active= NULL;
636                         
637                                 /* move button over from oldblock to new block */
638                                 BLI_remlink(&oldblock->buttons, oldbut);
639                                 BLI_insertlink(&block->buttons, but, oldbut);
640                                 oldbut->block = block;
641                                 *butpp = oldbut;
642                                 
643                                 /* still stuff needs to be copied */
644                                 oldbut->rect = but->rect;
645                                 oldbut->context = but->context; /* set by Layout */
646                                 
647                                 /* typically the same pointers, but not on undo/redo */
648                                 /* XXX some menu buttons store button itself in but->poin. Ugly */
649                                 if (oldbut->poin != (char *)oldbut) {
650                                         SWAP(char *, oldbut->poin, but->poin);
651                                         SWAP(void *, oldbut->func_argN, but->func_argN);
652                                 }
653                                 
654                                 /* copy hardmin for list rows to prevent 'sticking' highlight to mouse position
655                                  * when scrolling without moving mouse (see [#28432]) */
656                                 if (ELEM(oldbut->type, ROW, LISTROW))
657                                         oldbut->hardmax = but->hardmax;
658                                 
659                                 ui_but_update_linklines(block, oldbut, but);
660                                 
661                                 BLI_remlink(&block->buttons, but);
662                                 ui_free_but(C, but);
663                                 
664                                 /* note: if layout hasn't been applied yet, it uses old button pointers... */
665                         }
666                         else {
667                                 /* ensures one button can get activated, and in case the buttons
668                                  * draw are the same this gives O(1) lookup for each button */
669                                 BLI_remlink(&oldblock->buttons, oldbut);
670                                 ui_free_but(C, oldbut);
671                         }
672                         
673                         break;
674                 }
675         }
676         
677         return found;
678 }
679
680 /* needed for temporarily rename buttons, such as in outliner or file-select,
681  * they should keep calling uiDefButs to keep them alive */
682 /* returns 0 when button removed */
683 int uiButActiveOnly(const bContext *C, uiBlock *block, uiBut *but)
684 {
685         uiBlock *oldblock;
686         uiBut *oldbut;
687         int activate = FALSE, found = FALSE, isactive = FALSE;
688         
689         oldblock = block->oldblock;
690         if (!oldblock)
691                 activate = TRUE;
692         else {
693                 for (oldbut = oldblock->buttons.first; oldbut; oldbut = oldbut->next) {
694                         if (ui_but_equals_old(oldbut, but)) {
695                                 found = TRUE;
696                                 
697                                 if (oldbut->active)
698                                         isactive = TRUE;
699                                 
700                                 break;
701                         }
702                 }
703         }
704         if ((activate == TRUE) || (found == FALSE)) {
705                 ui_button_activate_do((bContext *)C, CTX_wm_region(C), but);
706         }
707         else if ((found == TRUE) && (isactive == FALSE)) {
708                 BLI_remlink(&block->buttons, but);
709                 ui_free_but(C, but);
710                 return 0;
711         }
712         
713         return 1;
714 }
715
716 /* use to check if we need to disable undo, but don't make any changes
717  * returns FALSE if undo needs to be disabled. */
718 static int ui_but_is_rna_undo(uiBut *but)
719 {
720         if (but->rnapoin.id.data) {
721                 /* avoid undo push for buttons who's ID are screen or wm level
722                  * we could disable undo for buttons with no ID too but may have
723                  * unforeseen consequences, so best check for ID's we _know_ are not
724                  * handled by undo - campbell */
725                 ID *id = but->rnapoin.id.data;
726                 if (ID_CHECK_UNDO(id) == FALSE) {
727                         return FALSE;
728                 }
729                 else {
730                         return TRUE;
731                 }
732         }
733         else if (but->rnapoin.type && !RNA_struct_undo_check(but->rnapoin.type)) {
734                 return FALSE;
735         }
736
737         return TRUE;
738 }
739
740 /* assigns automatic keybindings to menu items for fast access
741  * (underline key in menu) */
742 static void ui_menu_block_set_keyaccels(uiBlock *block)
743 {
744         uiBut *but;
745
746         unsigned int menu_key_mask = 0;
747         unsigned char menu_key;
748         const char *str_pt;
749         int pass;
750         int tot_missing = 0;
751
752         /* only do it before bounding */
753         if (block->rect.xmin != block->rect.xmax)
754                 return;
755
756         for (pass = 0; pass < 2; pass++) {
757                 /* 2 Passes, on for first letter only, second for any letter if first fails
758                  * fun first pass on all buttons so first word chars always get first priority */
759
760                 for (but = block->buttons.first; but; but = but->next) {
761                         if (!ELEM4(but->type, BUT, MENU, BLOCK, PULLDOWN) || (but->flag & UI_HIDDEN)) {
762                                 /* pass */
763                         }
764                         else if (but->menu_key == '\0') {
765                                 if (but->str) {
766                                         for (str_pt = but->str; *str_pt; ) {
767                                                 menu_key = tolower(*str_pt);
768                                                 if ((menu_key >= 'a' && menu_key <= 'z') && !(menu_key_mask & 1 << (menu_key - 'a'))) {
769                                                         menu_key_mask |= 1 << (menu_key - 'a');
770                                                         break;
771                                                 }
772
773                                                 if (pass == 0) {
774                                                         /* Skip to next delimiter on first pass (be picky) */
775                                                         while (isalpha(*str_pt))
776                                                                 str_pt++;
777
778                                                         if (*str_pt)
779                                                                 str_pt++;
780                                                 }
781                                                 else {
782                                                         /* just step over every char second pass and find first usable key */
783                                                         str_pt++;
784                                                 }
785                                         }
786
787                                         if (*str_pt) {
788                                                 but->menu_key = menu_key;
789                                         }
790                                         else {
791                                                 /* run second pass */
792                                                 tot_missing++;
793                                         }
794
795                                         /* if all keys have been used just exit, unlikely */
796                                         if (menu_key_mask == (1 << 26) - 1) {
797                                                 return;
798                                         }
799                                 }
800                         }
801                 }
802
803                 /* check if second pass is needed */
804                 if (!tot_missing) {
805                         break;
806                 }
807         }
808 }
809
810 /* XXX, this code will shorten any allocated string to 'UI_MAX_NAME_STR'
811  * since this is really long its unlikely to be an issue,
812  * but this could be supported */
813 void ui_but_add_shortcut(uiBut *but, const char *shortcut_str, const short do_strip)
814 {
815
816         if (do_strip) {
817                 char *cpoin = strchr(but->str, '|');
818                 if (cpoin) {
819                         *cpoin = '\0';
820                 }
821         }
822
823         /* without this, just allow stripping of the shortcut */
824         if (shortcut_str) {
825                 char *butstr_orig;
826
827                 if (but->str != but->strdata) {
828                         butstr_orig = but->str; /* free after using as source buffer */
829                 }
830                 else {
831                         butstr_orig = BLI_strdup(but->str);
832                 }
833                 BLI_snprintf(but->strdata,
834                              sizeof(but->strdata),
835                              "%s|%s",
836                              butstr_orig, shortcut_str);
837                 MEM_freeN(butstr_orig);
838                 but->str = but->strdata;
839                 ui_check_but(but);
840         }
841 }
842
843 static void ui_menu_block_set_keymaps(const bContext *C, uiBlock *block)
844 {
845         uiBut *but;
846         char buf[128];
847
848         /* for menu's */
849         MenuType *mt;
850         IDProperty *prop_menu = NULL;
851         IDProperty *prop_menu_name = NULL;
852
853         /* only do it before bounding */
854         if (block->rect.xmin != block->rect.xmax)
855                 return;
856
857         for (but = block->buttons.first; but; but = but->next) {
858                 if (but->optype) {
859                         IDProperty *prop = (but->opptr) ? but->opptr->data : NULL;
860
861                         if (WM_key_event_operator_string(C, but->optype->idname, but->opcontext, prop, TRUE,
862                                                          buf, sizeof(buf)))
863                         {
864                                 ui_but_add_shortcut(but, buf, FALSE);
865                         }
866                 }
867                 else if ((mt = uiButGetMenuType(but))) {
868                         /* only allocate menu property once */
869                         if (prop_menu == NULL) {
870                                 /* annoying, create a property */
871                                 IDPropertyTemplate val = {0};
872                                 prop_menu = IDP_New(IDP_GROUP, &val, __func__); /* dummy, name is unimportant  */
873                                 IDP_AddToGroup(prop_menu, (prop_menu_name = IDP_NewString("", "name", sizeof(mt->idname))));
874                         }
875
876                         IDP_AssignString(prop_menu_name, mt->idname, sizeof(mt->idname));
877
878                         if (WM_key_event_operator_string(C, "WM_OT_call_menu", WM_OP_INVOKE_REGION_WIN, prop_menu, FALSE,
879                                                          buf, sizeof(buf)))
880                         {
881                                 ui_but_add_shortcut(but, buf, FALSE);
882                         }
883                 }
884         }
885
886         if (prop_menu) {
887                 IDP_FreeProperty(prop_menu);
888                 MEM_freeN(prop_menu);
889         }
890
891 #undef UI_MENU_KEY_STR_CAT
892
893 }
894
895 void uiEndBlock(const bContext *C, uiBlock *block)
896 {
897         uiBut *but;
898         Scene *scene = CTX_data_scene(C);
899
900         /* inherit flags from 'old' buttons that was drawn here previous, based
901          * on matching buttons, we need this to make button event handling non
902          * blocking, while still allowing buttons to be remade each redraw as it
903          * is expected by blender code */
904         for (but = block->buttons.first; but; but = but->next) {
905                 if (ui_but_update_from_old_block(C, block, &but))
906                         ui_check_but(but);
907                 
908                 /* temp? Proper check for graying out */
909                 if (but->optype) {
910                         wmOperatorType *ot = but->optype;
911
912                         if (but->context)
913                                 CTX_store_set((bContext *)C, but->context);
914
915                         if (ot == NULL || WM_operator_poll_context((bContext *)C, ot, but->opcontext) == 0) {
916                                 but->flag |= UI_BUT_DISABLED;
917                                 but->lock = TRUE;
918                         }
919
920                         if (but->context)
921                                 CTX_store_set((bContext *)C, NULL);
922                 }
923
924                 ui_but_anim_flag(but, (scene) ? scene->r.cfra : 0.0f);
925         }
926
927         if (block->oldblock) {
928                 block->auto_open = block->oldblock->auto_open;
929                 block->auto_open_last = block->oldblock->auto_open_last;
930                 block->tooltipdisabled = block->oldblock->tooltipdisabled;
931
932                 block->oldblock = NULL;
933         }
934
935         /* handle pending stuff */
936         if (block->layouts.first) uiBlockLayoutResolve(block, NULL, NULL);
937         ui_block_do_align(block);
938         if ((block->flag & UI_BLOCK_LOOP) && (block->flag & UI_BLOCK_NUMSELECT)) {
939                 ui_menu_block_set_keyaccels(block); /* could use a different flag to check */
940         }
941         if (block->flag & UI_BLOCK_LOOP) ui_menu_block_set_keymaps(C, block);
942         
943         /* after keymaps! */
944         if (block->dobounds == UI_BLOCK_BOUNDS) ui_bounds_block(block);
945         else if (block->dobounds == UI_BLOCK_BOUNDS_TEXT) ui_text_bounds_block(block, 0.0f);
946         else if (block->dobounds == UI_BLOCK_BOUNDS_POPUP_CENTER) ui_centered_bounds_block(C, block);
947         else if (block->dobounds) ui_popup_bounds_block(C, block, block->dobounds);
948
949         if (block->rect.xmin == 0.0f && block->rect.xmax == 0.0f) uiBoundsBlock(block, 0);
950         if (block->flag & UI_BUT_ALIGN) uiBlockEndAlign(block);
951
952         block->endblock = 1;
953 }
954
955 /* ************** BLOCK DRAWING FUNCTION ************* */
956
957 void ui_fontscale(short *points, float aspect)
958 {
959         if (aspect < 0.9f || aspect > 1.1f) {
960                 float pointsf = *points;
961                 
962                 /* for some reason scaling fonts goes too fast compared to widget size */
963                 aspect = sqrt(aspect);
964                 pointsf /= aspect;
965                 
966                 if (aspect > 1.0f)
967                         *points = ceilf(pointsf);
968                 else
969                         *points = floorf(pointsf);
970         }
971 }
972
973 /* project button or block (but==NULL) to pixels in regionspace */
974 static void ui_but_to_pixelrect(rcti *rect, const ARegion *ar, uiBlock *block, uiBut *but)
975 {
976         float gx, gy;
977         float getsizex, getsizey;
978         
979         getsizex = ar->winx;
980         getsizey = ar->winy;
981
982         gx = (but ? but->rect.xmin : block->rect.xmin) + (block->panel ? block->panel->ofsx : 0.0f);
983         gy = (but ? but->rect.ymin : block->rect.ymin) + (block->panel ? block->panel->ofsy : 0.0f);
984         
985         rect->xmin = floorf(getsizex * (0.5f + 0.5f * (gx * block->winmat[0][0] + gy * block->winmat[1][0] + block->winmat[3][0])));
986         rect->ymin = floorf(getsizey * (0.5f + 0.5f * (gx * block->winmat[0][1] + gy * block->winmat[1][1] + block->winmat[3][1])));
987         
988         gx = (but ? but->rect.xmax : block->rect.xmax) + (block->panel ? block->panel->ofsx : 0.0f);
989         gy = (but ? but->rect.ymax : block->rect.ymax) + (block->panel ? block->panel->ofsy : 0.0f);
990         
991         rect->xmax = floorf(getsizex * (0.5f + 0.5f * (gx * block->winmat[0][0] + gy * block->winmat[1][0] + block->winmat[3][0])));
992         rect->ymax = floorf(getsizey * (0.5f + 0.5f * (gx * block->winmat[0][1] + gy * block->winmat[1][1] + block->winmat[3][1])));
993
994 }
995
996 /* uses local copy of style, to scale things down, and allow widgets to change stuff */
997 void uiDrawBlock(const bContext *C, uiBlock *block)
998 {
999         uiStyle style = *UI_GetStyle();  /* XXX pass on as arg */
1000         ARegion *ar;
1001         uiBut *but;
1002         rcti rect;
1003         int multisample_enabled;
1004         
1005         /* get menu region or area region */
1006         ar = CTX_wm_menu(C);
1007         if (!ar)
1008                 ar = CTX_wm_region(C);
1009
1010         if (!block->endblock)
1011                 uiEndBlock(C, block);
1012
1013         /* disable AA, makes widgets too blurry */
1014         multisample_enabled = glIsEnabled(GL_MULTISAMPLE_ARB);
1015         if (multisample_enabled)
1016                 glDisable(GL_MULTISAMPLE_ARB);
1017
1018         /* we set this only once */
1019         glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
1020         
1021         /* scale fonts */
1022         ui_fontscale(&style.paneltitle.points, block->aspect);
1023         ui_fontscale(&style.grouplabel.points, block->aspect);
1024         ui_fontscale(&style.widgetlabel.points, block->aspect);
1025         ui_fontscale(&style.widget.points, block->aspect);
1026         
1027         /* scale block min/max to rect */
1028         ui_but_to_pixelrect(&rect, ar, block, NULL);
1029         
1030         /* pixel space for AA widgets */
1031         glMatrixMode(GL_PROJECTION);
1032         glPushMatrix();
1033         glMatrixMode(GL_MODELVIEW);
1034         glPushMatrix();
1035         glLoadIdentity();
1036         
1037         wmOrtho2(-0.01f, ar->winx - 0.01f, -0.01f, ar->winy - 0.01f);
1038         
1039         /* back */
1040         if (block->flag & UI_BLOCK_LOOP)
1041                 ui_draw_menu_back(&style, block, &rect);
1042         else if (block->panel)
1043                 ui_draw_aligned_panel(&style, block, &rect);
1044
1045         /* widgets */
1046         for (but = block->buttons.first; but; but = but->next) {
1047                 if (!(but->flag & (UI_HIDDEN | UI_SCROLLED))) {
1048                         ui_but_to_pixelrect(&rect, ar, block, but);
1049                 
1050                         /* XXX: figure out why invalid coordinates happen when closing render window */
1051                         /* and material preview is redrawn in main window (temp fix for bug #23848) */
1052                         if (rect.xmin < rect.xmax && rect.ymin < rect.ymax)
1053                                 ui_draw_but(C, ar, &style, but, &rect);
1054                 }
1055         }
1056         
1057         /* restore matrix */
1058         glMatrixMode(GL_PROJECTION);
1059         glPopMatrix();
1060         glMatrixMode(GL_MODELVIEW);
1061         glPopMatrix();
1062
1063         if (multisample_enabled)
1064                 glEnable(GL_MULTISAMPLE_ARB);
1065         
1066         ui_draw_links(block);
1067 }
1068
1069 /* ************* EVENTS ************* */
1070
1071 static void ui_is_but_sel(uiBut *but, double *value)
1072 {
1073         short is_push = 0;  /* (0 == UNSELECT), (1 == SELECT), (2 == DO-NOHING) */
1074         short is_true = TRUE;
1075
1076         if (ELEM3(but->type, TOGN, ICONTOGN, OPTIONN)) {
1077                 is_true = FALSE;
1078         }
1079
1080         if (but->bit) {
1081                 int lvalue;
1082                 UI_GET_BUT_VALUE_INIT(but, *value);
1083                 lvalue = (int)*value;
1084                 if (UI_BITBUT_TEST(lvalue, (but->bitnr))) {
1085                         is_push = is_true;
1086                 }
1087                 else {
1088                         is_push = !is_true;
1089                 }
1090         }
1091         else {
1092                 switch (but->type) {
1093                         case BUT:
1094                                 is_push = 2;
1095                                 break;
1096                         case HOTKEYEVT:
1097                         case KEYEVT:
1098                                 is_push = 2;
1099                                 break;
1100                         case TOGBUT:
1101                         case TOG:
1102                         case TOGR:
1103                         case TOG3:
1104                         case BUT_TOGDUAL:
1105                         case ICONTOG:
1106                         case OPTION:
1107                                 UI_GET_BUT_VALUE_INIT(but, *value);
1108                                 if (*value != (double)but->hardmin) is_push = 1;
1109                                 break;
1110                         case ICONTOGN:
1111                         case TOGN:
1112                         case OPTIONN:
1113                                 UI_GET_BUT_VALUE_INIT(but, *value);
1114                                 if (*value == 0.0) is_push = 1;
1115                                 break;
1116                         case ROW:
1117                         case LISTROW:
1118                                 UI_GET_BUT_VALUE_INIT(but, *value);
1119                                 /* support for rna enum buts */
1120                                 if (but->rnaprop && (RNA_property_flag(but->rnaprop) & PROP_ENUM_FLAG)) {
1121                                         if ((int)*value & (int)but->hardmax) is_push = 1;
1122                                 }
1123                                 else {
1124                                         if (*value == (double)but->hardmax) is_push = 1;
1125                                 }
1126                                 break;
1127                         case COL:
1128                                 is_push = 2;
1129                                 break;
1130                         default:
1131                                 is_push = 2;
1132                                 break;
1133                 }
1134         }
1135         
1136         if (is_push == 2) ;
1137         else if (is_push == 1) but->flag |= UI_SELECT;
1138         else but->flag &= ~UI_SELECT;
1139 }
1140
1141 static uiBut *ui_find_inlink(uiBlock *block, void *poin)
1142 {
1143         uiBut *but;
1144         
1145         but = block->buttons.first;
1146         while (but) {
1147                 if (but->type == INLINK) {
1148                         if (but->poin == poin) return but;
1149                 }
1150                 but = but->next;
1151         }
1152         return NULL;
1153 }
1154
1155 static void ui_add_link_line(ListBase *listb, uiBut *but, uiBut *bt)
1156 {
1157         uiLinkLine *line;
1158         
1159         line = MEM_callocN(sizeof(uiLinkLine), "linkline");
1160         BLI_addtail(listb, line);
1161         line->from = but;
1162         line->to = bt;
1163 }
1164
1165 uiBut *uiFindInlink(uiBlock *block, void *poin)
1166 {
1167         return ui_find_inlink(block, poin);
1168 }
1169
1170 void uiComposeLinks(uiBlock *block)
1171 {
1172         uiBut *but, *bt;
1173         uiLink *link;
1174         void ***ppoin;
1175         int a;
1176         
1177         but = block->buttons.first;
1178         while (but) {
1179                 if (but->type == LINK) {
1180                         link = but->link;
1181                         
1182                         /* for all pointers in the array */
1183                         if (link) {
1184                                 if (link->ppoin) {
1185                                         ppoin = link->ppoin;
1186                                         for (a = 0; a < *(link->totlink); a++) {
1187                                                 bt = ui_find_inlink(block, (*ppoin)[a]);
1188                                                 if (bt) {
1189                                                         ui_add_link_line(&link->lines, but, bt);
1190                                                 }
1191                                         }
1192                                 }
1193                                 else if (link->poin) {
1194                                         bt = ui_find_inlink(block, *(link->poin) );
1195                                         if (bt) {
1196                                                 ui_add_link_line(&link->lines, but, bt);
1197                                         }
1198                                 }
1199                         }
1200                 }
1201                 but = but->next;
1202         }
1203 }
1204
1205
1206 /* ************************************************ */
1207
1208 void uiBlockSetButLock(uiBlock *block, int val, const char *lockstr)
1209 {
1210         if (val) {
1211                 block->lock = val ? TRUE : FALSE;
1212                 block->lockstr = lockstr;
1213         }
1214 }
1215
1216 void uiBlockClearButLock(uiBlock *block)
1217 {
1218         block->lock = FALSE;
1219         block->lockstr = NULL;
1220 }
1221
1222 /* *************************************************************** */
1223
1224 void ui_delete_linkline(uiLinkLine *line, uiBut *but)
1225 {
1226         uiLink *link;
1227         int a, b;
1228         
1229         BLI_remlink(&but->link->lines, line);
1230
1231         link = line->from->link;
1232
1233         /* are there more pointers allowed? */
1234         if (link->ppoin) {
1235                 
1236                 if (*(link->totlink) == 1) {
1237                         *(link->totlink) = 0;
1238                         MEM_freeN(*(link->ppoin));
1239                         *(link->ppoin) = NULL;
1240                 }
1241                 else {
1242                         b = 0;
1243                         for (a = 0; a < (*(link->totlink)); a++) {
1244                                 
1245                                 if ( (*(link->ppoin))[a] != line->to->poin) {
1246                                         (*(link->ppoin))[b] = (*(link->ppoin))[a];
1247                                         b++;
1248                                 }
1249                         }       
1250                         (*(link->totlink))--;
1251                 }
1252         }
1253         else {
1254                 *(link->poin) = NULL;
1255         }
1256
1257         MEM_freeN(line);
1258         //REDRAW
1259 }
1260
1261 /* *********************** data get/set ***********************
1262  * this either works with the pointed to data, or can work with
1263  * an edit override pointer while dragging for example */
1264
1265 /* for buttons pointing to color for example */
1266 void ui_get_but_vectorf(uiBut *but, float vec[3])
1267 {
1268         PropertyRNA *prop;
1269         int a, tot;
1270
1271         if (but->editvec) {
1272                 copy_v3_v3(vec, but->editvec);
1273         }
1274
1275         if (but->rnaprop) {
1276                 prop = but->rnaprop;
1277
1278                 vec[0] = vec[1] = vec[2] = 0.0f;
1279
1280                 if (RNA_property_type(prop) == PROP_FLOAT) {
1281                         tot = RNA_property_array_length(&but->rnapoin, prop);
1282                         tot = MIN2(tot, 3);
1283
1284                         for (a = 0; a < tot; a++)
1285                                 vec[a] = RNA_property_float_get_index(&but->rnapoin, prop, a);
1286                 }
1287         }
1288         else if (but->pointype == CHA) {
1289                 char *cp = (char *)but->poin;
1290                 vec[0] = ((float)cp[0]) / 255.0f;
1291                 vec[1] = ((float)cp[1]) / 255.0f;
1292                 vec[2] = ((float)cp[2]) / 255.0f;
1293         }
1294         else if (but->pointype == FLO) {
1295                 float *fp = (float *)but->poin;
1296                 copy_v3_v3(vec, fp);
1297         }
1298         else {
1299                 if (but->editvec == NULL) {
1300                         fprintf(stderr, "ui_get_but_vectorf: can't get color, should never happen\n");
1301                         vec[0] = vec[1] = vec[2] = 0.0f;
1302                 }
1303         }
1304
1305         if (but->type == BUT_NORMAL) {
1306                 normalize_v3(vec);
1307         }
1308 }
1309
1310 /* for buttons pointing to color for example */
1311 void ui_set_but_vectorf(uiBut *but, const float vec[3])
1312 {
1313         PropertyRNA *prop;
1314
1315         if (but->editvec) {
1316                 copy_v3_v3(but->editvec, vec);
1317         }
1318
1319         if (but->rnaprop) {
1320                 prop = but->rnaprop;
1321
1322                 if (RNA_property_type(prop) == PROP_FLOAT) {
1323                         int tot;
1324                         int a;
1325
1326                         tot = RNA_property_array_length(&but->rnapoin, prop);
1327                         tot = MIN2(tot, 3);
1328
1329                         for (a = 0; a < tot; a++) {
1330                                 RNA_property_float_set_index(&but->rnapoin, prop, a, vec[a]);
1331                         }
1332                 }
1333         }
1334         else if (but->pointype == CHA) {
1335                 char *cp = (char *)but->poin;
1336                 cp[0] = (char)(0.5f + vec[0] * 255.0f);
1337                 cp[1] = (char)(0.5f + vec[1] * 255.0f);
1338                 cp[2] = (char)(0.5f + vec[2] * 255.0f);
1339         }
1340         else if (but->pointype == FLO) {
1341                 float *fp = (float *)but->poin;
1342                 copy_v3_v3(fp, vec);
1343         }
1344 }
1345
1346 int ui_is_but_float(uiBut *but)
1347 {
1348         if (but->pointype == FLO && but->poin)
1349                 return 1;
1350         
1351         if (but->rnaprop && RNA_property_type(but->rnaprop) == PROP_FLOAT)
1352                 return 1;
1353         
1354         return 0;
1355 }
1356
1357 int ui_is_but_unit(uiBut *but)
1358 {
1359         UnitSettings *unit = but->block->unit;
1360         const int unit_type = uiButGetUnitType(but);
1361
1362         if (unit_type == PROP_UNIT_NONE)
1363                 return 0;
1364
1365 #if 1 /* removed so angle buttons get correct snapping */
1366         if (unit->system_rotation == USER_UNIT_ROT_RADIANS && unit_type == PROP_UNIT_ROTATION)
1367                 return 0;
1368 #endif
1369         
1370         /* for now disable time unit conversion */      
1371         if (unit_type == PROP_UNIT_TIME)
1372                 return 0;
1373
1374         if (unit->system == USER_UNIT_NONE) {
1375                 if (unit_type != PROP_UNIT_ROTATION) {
1376                         return 0;
1377                 }
1378         }
1379
1380         return 1;
1381 }
1382
1383 int ui_is_but_rna_valid(uiBut *but)
1384 {
1385         if (but->rnaprop == NULL || RNA_struct_contains_property(&but->rnapoin, but->rnaprop)) {
1386                 return TRUE;
1387         }
1388         else {
1389                 printf("property removed %s: %p\n", but->drawstr, but->rnaprop);
1390                 return FALSE;
1391         }
1392 }
1393
1394 double ui_get_but_val(uiBut *but)
1395 {
1396         PropertyRNA *prop;
1397         double value = 0.0;
1398
1399         if (but->editval) { return *(but->editval); }
1400         if (but->poin == NULL && but->rnapoin.data == NULL) return 0.0;
1401
1402         if (but->rnaprop) {
1403                 prop = but->rnaprop;
1404
1405                 switch (RNA_property_type(prop)) {
1406                         case PROP_BOOLEAN:
1407                                 if (RNA_property_array_check(prop))
1408                                         value = RNA_property_boolean_get_index(&but->rnapoin, prop, but->rnaindex);
1409                                 else
1410                                         value = RNA_property_boolean_get(&but->rnapoin, prop);
1411                                 break;
1412                         case PROP_INT:
1413                                 if (RNA_property_array_check(prop))
1414                                         value = RNA_property_int_get_index(&but->rnapoin, prop, but->rnaindex);
1415                                 else
1416                                         value = RNA_property_int_get(&but->rnapoin, prop);
1417                                 break;
1418                         case PROP_FLOAT:
1419                                 if (RNA_property_array_check(prop))
1420                                         value = RNA_property_float_get_index(&but->rnapoin, prop, but->rnaindex);
1421                                 else
1422                                         value = RNA_property_float_get(&but->rnapoin, prop);
1423                                 break;
1424                         case PROP_ENUM:
1425                                 value = RNA_property_enum_get(&but->rnapoin, prop);
1426                                 break;
1427                         default:
1428                                 value = 0.0;
1429                                 break;
1430                 }
1431         }
1432         else if (but->type == HSVSLI) {
1433                 float *fp, hsv[3];
1434                 
1435                 fp = (but->editvec) ? but->editvec : (float *)but->poin;
1436                 rgb_to_hsv_v(fp, hsv);
1437
1438                 switch (but->str[0]) {
1439                         case 'H': value = hsv[0]; break;
1440                         case 'S': value = hsv[1]; break;
1441                         case 'V': value = hsv[2]; break;
1442                 }
1443         } 
1444         else if (but->pointype == CHA) {
1445                 value = *(char *)but->poin;
1446         }
1447         else if (but->pointype == SHO) {
1448                 value = *(short *)but->poin;
1449         } 
1450         else if (but->pointype == INT) {
1451                 value = *(int *)but->poin;
1452         } 
1453         else if (but->pointype == FLO) {
1454                 value = *(float *)but->poin;
1455         }
1456
1457         return value;
1458 }
1459
1460 void ui_set_but_val(uiBut *but, double value)
1461 {
1462         PropertyRNA *prop;
1463
1464         /* value is a hsv value: convert to rgb */
1465         if (but->rnaprop) {
1466                 prop = but->rnaprop;
1467
1468                 if (RNA_property_editable(&but->rnapoin, prop)) {
1469                         switch (RNA_property_type(prop)) {
1470                                 case PROP_BOOLEAN:
1471                                         if (RNA_property_array_length(&but->rnapoin, prop))
1472                                                 RNA_property_boolean_set_index(&but->rnapoin, prop, but->rnaindex, value);
1473                                         else
1474                                                 RNA_property_boolean_set(&but->rnapoin, prop, value);
1475                                         break;
1476                                 case PROP_INT:
1477                                         if (RNA_property_array_length(&but->rnapoin, prop))
1478                                                 RNA_property_int_set_index(&but->rnapoin, prop, but->rnaindex, (int)value);
1479                                         else
1480                                                 RNA_property_int_set(&but->rnapoin, prop, (int)value);
1481                                         break;
1482                                 case PROP_FLOAT:
1483                                         if (RNA_property_array_length(&but->rnapoin, prop))
1484                                                 RNA_property_float_set_index(&but->rnapoin, prop, but->rnaindex, value);
1485                                         else
1486                                                 RNA_property_float_set(&but->rnapoin, prop, value);
1487                                         break;
1488                                 case PROP_ENUM:
1489                                         if (RNA_property_flag(prop) & PROP_ENUM_FLAG) {
1490                                                 int ivalue = (int)value;
1491                                                 ivalue ^= RNA_property_enum_get(&but->rnapoin, prop); /* toggle for enum/flag buttons */
1492                                                 RNA_property_enum_set(&but->rnapoin, prop, ivalue);
1493                                         }
1494                                         else {
1495                                                 RNA_property_enum_set(&but->rnapoin, prop, value);
1496                                         }
1497                                         break;
1498                                 default:
1499                                         break;
1500                         }
1501                 }
1502
1503                 /* we can't be sure what RNA set functions actually do,
1504                  * so leave this unset */
1505                 value = UI_BUT_VALUE_UNSET;
1506         }
1507         else if (but->pointype == 0) ;
1508         else if (but->type == HSVSLI) {
1509                 float *fp, hsv[3];
1510                 
1511                 fp = (but->editvec) ? but->editvec : (float *)but->poin;
1512                 rgb_to_hsv_v(fp, hsv);
1513                 
1514                 switch (but->str[0]) {
1515                         case 'H': hsv[0] = value; break;
1516                         case 'S': hsv[1] = value; break;
1517                         case 'V': hsv[2] = value; break;
1518                 }
1519                 
1520                 hsv_to_rgb_v(hsv, fp);
1521                 
1522         }
1523         else {
1524                 /* first do rounding */
1525                 if (but->pointype == CHA)
1526                         value = (char)floor(value + 0.5);
1527                 else if (but->pointype == SHO) {
1528                         /* gcc 3.2.1 seems to have problems
1529                          * casting a double like 32772.0 to
1530                          * a short so we cast to an int, then
1531                          * to a short.
1532                          *
1533                          * Update: even in gcc.4.6 using intermediate int cast gives -32764,
1534                          * where as a direct cast from double to short gives -32768,
1535                          * if this difference isn't important we could remove this hack,
1536                          * since we dont support gcc3 anymore - Campbell */
1537                         int gcckludge;
1538                         gcckludge = (int) floor(value + 0.5);
1539                         value = (short)gcckludge;
1540                 }
1541                 else if (but->pointype == INT)
1542                         value = (int)floor(value + 0.5);
1543                 else if (but->pointype == FLO) {
1544                         float fval = (float)value;
1545                         if (fval >= -0.00001f && fval <= 0.00001f) fval = 0.0f;  /* prevent negative zero */
1546                         value = fval;
1547                 }
1548                 
1549                 /* then set value with possible edit override */
1550                 if (but->editval)
1551                         value = *but->editval = value;
1552                 else if (but->pointype == CHA)
1553                         value = *((char *)but->poin) = (char)value;
1554                 else if (but->pointype == SHO)
1555                         value = *((short *)but->poin) = (short)value;
1556                 else if (but->pointype == INT)
1557                         value = *((int *)but->poin) = (int)value;
1558                 else if (but->pointype == FLO)
1559                         value = *((float *)but->poin) = (float)value;
1560         }
1561
1562         /* update select flag */
1563         ui_is_but_sel(but, &value);
1564 }
1565
1566 int ui_get_but_string_max_length(uiBut *but)
1567 {
1568         if (ELEM(but->type, TEX, SEARCH_MENU))
1569                 return but->hardmax;
1570         else if (but->type == IDPOIN)
1571                 return MAX_ID_NAME - 2;
1572         else
1573                 return UI_MAX_DRAW_STR;
1574 }
1575
1576 static double ui_get_but_scale_unit(uiBut *but, double value)
1577 {
1578         UnitSettings *unit = but->block->unit;
1579         int unit_type = uiButGetUnitType(but);
1580
1581         if (unit_type == PROP_UNIT_LENGTH) {
1582                 return value * (double)unit->scale_length;
1583         }
1584         else if (unit_type == PROP_UNIT_AREA) {
1585                 return value * pow(unit->scale_length, 2);
1586         }
1587         else if (unit_type == PROP_UNIT_VOLUME) {
1588                 return value * pow(unit->scale_length, 3);
1589         }
1590         else if (unit_type == PROP_UNIT_TIME) { /* WARNING - using evil_C :| */
1591                 Scene *scene = CTX_data_scene(but->block->evil_C);
1592                 return FRA2TIME(value);
1593         }
1594         else {
1595                 return value;
1596         }
1597 }
1598
1599 /* str will be overwritten */
1600 void ui_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen)
1601 {
1602         if (ui_is_but_unit(but)) {
1603                 UnitSettings *unit = but->block->unit;
1604                 int unit_type = uiButGetUnitType(but);
1605                 char *orig_str;
1606                 
1607                 orig_str = MEM_callocN(sizeof(char) * maxlen + 1, "textedit sub str");
1608                 memcpy(orig_str, str, maxlen);
1609                 
1610                 bUnit_ToUnitAltName(str, maxlen, orig_str, unit->system, RNA_SUBTYPE_UNIT_VALUE(unit_type));
1611                 
1612                 MEM_freeN(orig_str);
1613         }
1614 }
1615
1616 static void ui_get_but_string_unit(uiBut *but, char *str, int len_max, double value, int pad)
1617 {
1618         UnitSettings *unit = but->block->unit;
1619         int do_split = unit->flag & USER_UNIT_OPT_SPLIT;
1620         int unit_type = uiButGetUnitType(but);
1621         int precision = but->a2;
1622
1623         if (unit->scale_length < 0.0001f) unit->scale_length = 1.0f;  // XXX do_versions
1624
1625         /* Sanity checks */
1626         if (precision > PRECISION_FLOAT_MAX) precision = PRECISION_FLOAT_MAX;
1627         else if (precision == 0) precision = 2;
1628
1629         bUnit_AsString(str, len_max, ui_get_but_scale_unit(but, value), precision,
1630                        unit->system, RNA_SUBTYPE_UNIT_VALUE(unit_type), do_split, pad);
1631 }
1632
1633 static float ui_get_but_step_unit(uiBut *but, float step_default)
1634 {
1635         int unit_type = RNA_SUBTYPE_UNIT_VALUE(uiButGetUnitType(but));
1636         float step;
1637
1638         step = bUnit_ClosestScalar(ui_get_but_scale_unit(but, step_default), but->block->unit->system, unit_type);
1639
1640         if (step > 0.0f) { /* -1 is an error value */
1641                 return (float)((double)step / ui_get_but_scale_unit(but, 1.0)) * 100.0f;
1642         }
1643         else {
1644                 return step_default;
1645         }
1646 }
1647
1648
1649 void ui_get_but_string(uiBut *but, char *str, size_t maxlen)
1650 {
1651         if (but->rnaprop && ELEM3(but->type, TEX, IDPOIN, SEARCH_MENU)) {
1652                 PropertyType type;
1653                 char *buf = NULL;
1654                 int buf_len;
1655
1656                 type = RNA_property_type(but->rnaprop);
1657
1658                 if (type == PROP_STRING) {
1659                         /* RNA string */
1660                         buf = RNA_property_string_get_alloc(&but->rnapoin, but->rnaprop, str, maxlen, &buf_len);
1661                 }
1662                 else if (type == PROP_POINTER) {
1663                         /* RNA pointer */
1664                         PointerRNA ptr = RNA_property_pointer_get(&but->rnapoin, but->rnaprop);
1665                         buf = RNA_struct_name_get_alloc(&ptr, str, maxlen, &buf_len);
1666                 }
1667
1668                 if (!buf) {
1669                         str[0] = '\0';
1670                 }
1671                 else if (buf && buf != str) {
1672                         /* string was too long, we have to truncate */
1673                         memcpy(str, buf, MIN2(maxlen, buf_len + 1));
1674                         MEM_freeN(buf);
1675                 }
1676         }
1677         else if (but->type == IDPOIN) {
1678                 /* ID pointer */
1679                 if (but->idpoin_idpp) { /* Can be NULL for ID properties by python */
1680                         ID *id = *(but->idpoin_idpp);
1681                         if (id) {
1682                                 BLI_strncpy(str, id->name + 2, maxlen);
1683                                 return;
1684                         }
1685                 }
1686                 str[0] = '\0';
1687                 return;
1688         }
1689         else if (but->type == TEX) {
1690                 /* string */
1691                 BLI_strncpy(str, but->poin, maxlen);
1692                 return;
1693         }
1694         else if (but->type == SEARCH_MENU) {
1695                 /* string */
1696                 BLI_strncpy(str, but->poin, maxlen);
1697                 return;
1698         }
1699         else if (ui_but_anim_expression_get(but, str, maxlen))
1700                 ;  /* driver expression */
1701         else {
1702                 /* number editing */
1703                 double value;
1704
1705                 value = ui_get_but_val(but);
1706
1707                 if (ui_is_but_float(but)) {
1708                         if (ui_is_but_unit(but)) {
1709                                 ui_get_but_string_unit(but, str, maxlen, value, 0);
1710                         }
1711                         else {
1712                                 const int prec = ui_but_float_precision(but, value);
1713                                 BLI_snprintf(str, maxlen, "%.*f", prec, value);
1714                         }
1715                 }
1716                 else
1717                         BLI_snprintf(str, maxlen, "%d", (int)value);
1718         }
1719 }
1720
1721 #ifdef WITH_PYTHON
1722
1723 static int ui_set_but_string_eval_num_unit(bContext *C, uiBut *but, const char *str, double *value)
1724 {
1725         char str_unit_convert[256];
1726         const int unit_type = uiButGetUnitType(but);
1727
1728         BLI_strncpy(str_unit_convert, str, sizeof(str_unit_convert));
1729
1730         /* ugly, use the draw string to get the value,
1731          * this could cause problems if it includes some text which resolves to a unit */
1732         bUnit_ReplaceString(str_unit_convert, sizeof(str_unit_convert), but->drawstr,
1733                             ui_get_but_scale_unit(but, 1.0), but->block->unit->system, RNA_SUBTYPE_UNIT_VALUE(unit_type));
1734
1735         return (BPY_button_exec(C, str_unit_convert, value, TRUE) != -1);
1736 }
1737
1738 #endif /* WITH_PYTHON */
1739
1740
1741 int ui_set_but_string_eval_num(bContext *C, uiBut *but, const char *str, double *value)
1742 {
1743         int ok = FALSE;
1744
1745 #ifdef WITH_PYTHON
1746
1747         if (str[0] != '\0') {
1748                 int is_unit_but = ui_is_but_unit(but);
1749                 /* only enable verbose if we won't run again with units */
1750                 if (BPY_button_exec(C, str, value, is_unit_but == FALSE) != -1) {
1751                         /* if the value parsed ok without unit conversion this button may still need a unit multiplier */
1752                         if (is_unit_but) {
1753                                 char str_new[128];
1754
1755                                 BLI_snprintf(str_new, sizeof(str_new), "%f", *value);
1756                                 ok = ui_set_but_string_eval_num_unit(C, but, str_new, value);
1757                         }
1758                         else {
1759                                 ok = TRUE; /* parse normal string via py (no unit conversion needed) */
1760                         }
1761                 }
1762                 else if (is_unit_but) {
1763                         /* parse failed, this is a unit but so run replacements and parse again */
1764                         ok = ui_set_but_string_eval_num_unit(C, but, str, value);
1765                 }
1766         }
1767
1768 #else /* WITH_PYTHON */
1769
1770         *value = atof(str);
1771         ok = TRUE;
1772
1773         (void)C;
1774         (void)but;
1775
1776 #endif /* WITH_PYTHON */
1777
1778         return ok;
1779 }
1780
1781
1782 int ui_set_but_string(bContext *C, uiBut *but, const char *str)
1783 {
1784         if (but->rnaprop && ELEM3(but->type, TEX, IDPOIN, SEARCH_MENU)) {
1785                 if (RNA_property_editable(&but->rnapoin, but->rnaprop)) {
1786                         PropertyType type;
1787
1788                         type = RNA_property_type(but->rnaprop);
1789
1790                         if (type == PROP_STRING) {
1791                                 /* RNA string */
1792                                 RNA_property_string_set(&but->rnapoin, but->rnaprop, str);
1793                                 return 1;
1794                         }
1795                         else if (type == PROP_POINTER) {
1796                                 /* RNA pointer */
1797                                 PointerRNA ptr, rptr;
1798                                 PropertyRNA *prop;
1799
1800                                 if (str == NULL || str[0] == '\0') {
1801                                         RNA_property_pointer_set(&but->rnapoin, but->rnaprop, PointerRNA_NULL);
1802                                         return 1;
1803                                 }
1804                                 else {
1805                                         ptr = but->rnasearchpoin;
1806                                         prop = but->rnasearchprop;
1807                                         
1808                                         if (prop && RNA_property_collection_lookup_string(&ptr, prop, str, &rptr))
1809                                                 RNA_property_pointer_set(&but->rnapoin, but->rnaprop, rptr);
1810
1811                                         return 1;
1812                                 }
1813
1814                                 return 0;
1815                         }
1816                 }
1817         }
1818         else if (but->type == IDPOIN) {
1819                 /* ID pointer */
1820                 but->idpoin_func(C, str, but->idpoin_idpp);
1821                 return 1;
1822         }
1823         else if (but->type == TEX) {
1824                 /* string */
1825                 if (ui_is_but_utf8(but)) BLI_strncpy_utf8(but->poin, str, but->hardmax);
1826                 else BLI_strncpy(but->poin, str, but->hardmax);
1827
1828                 return 1;
1829         }
1830         else if (but->type == SEARCH_MENU) {
1831                 /* string */
1832                 BLI_strncpy(but->poin, str, but->hardmax);
1833                 return 1;
1834         }
1835         else if (ui_but_anim_expression_set(but, str)) {
1836                 /* driver expression */
1837                 return 1;
1838         }
1839         else if (str[0] == '#') {
1840                 /* shortcut to create new driver expression (versus immediate Py-execution) */
1841                 return ui_but_anim_expression_create(but, str + 1);
1842         }
1843         else {
1844                 /* number editing */
1845                 double value;
1846
1847                 if (ui_set_but_string_eval_num(C, but, str, &value) == FALSE) {
1848                         return 0;
1849                 }
1850
1851                 if (!ui_is_but_float(but)) value = (int)floor(value + 0.5);
1852                 if (but->type == NUMABS) value = fabs(value);
1853
1854                 /* not that we use hard limits here */
1855                 if (value < (double)but->hardmin) value = but->hardmin;
1856                 if (value > (double)but->hardmax) value = but->hardmax;
1857
1858                 ui_set_but_val(but, value);
1859                 return 1;
1860         }
1861
1862         return 0;
1863 }
1864
1865 void ui_set_but_default(bContext *C, short all)
1866 {
1867         PointerRNA ptr;
1868
1869         WM_operator_properties_create(&ptr, "UI_OT_reset_default_button");
1870         RNA_boolean_set(&ptr, "all", all);
1871         WM_operator_name_call(C, "UI_OT_reset_default_button", WM_OP_EXEC_DEFAULT, &ptr);
1872         WM_operator_properties_free(&ptr);
1873 }
1874
1875 static double soft_range_round_up(double value, double max)
1876 {
1877         /* round up to .., 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 50, .. */
1878         double newmax = pow(10.0, ceil(log(value) / M_LN10));
1879
1880         if (newmax * 0.2 >= max && newmax * 0.2 >= value)
1881                 return newmax * 0.2;
1882         else if (newmax * 0.5 >= max && newmax * 0.5 >= value)
1883                 return newmax * 0.5;
1884         else
1885                 return newmax;
1886 }
1887
1888 static double soft_range_round_down(double value, double max)
1889 {
1890         /* round down to .., 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 50, .. */
1891         double newmax = pow(10.0, floor(log(value) / M_LN10));
1892
1893         if (newmax * 5.0 <= max && newmax * 5.0 <= value)
1894                 return newmax * 5.0;
1895         else if (newmax * 2.0 <= max && newmax * 2.0 <= value)
1896                 return newmax * 2.0;
1897         else
1898                 return newmax;
1899 }
1900
1901 void ui_set_but_soft_range(uiBut *but, double value)
1902 {
1903         /* ideally we would not limit this but practically, its more then
1904          * enough worst case is very long vectors wont use a smart soft-range
1905          * which isn't so bad. */
1906
1907         if (but->rnaprop) {
1908                 const PropertyType type = RNA_property_type(but->rnaprop);
1909                 double softmin, softmax /*, step, precision*/;
1910                 double value_min = value;
1911                 double value_max = value;
1912
1913                 /* clamp button range to something reasonable in case
1914                  * we get -inf/inf from RNA properties */
1915                 if (type == PROP_INT) {
1916                         int imin, imax, istep;
1917                         const int array_len = RNA_property_array_length(&but->rnapoin, but->rnaprop);
1918
1919                         RNA_property_int_ui_range(&but->rnapoin, but->rnaprop, &imin, &imax, &istep);
1920                         softmin = (imin == INT_MIN) ? -1e4 : imin;
1921                         softmax = (imin == INT_MAX) ? 1e4 : imax;
1922                         /*step= istep;*/ /*UNUSED*/
1923                         /*precision= 1;*/ /*UNUSED*/
1924
1925                         if (array_len >= 2) {
1926                                 int value_range[2];
1927                                 RNA_property_int_get_array_range(&but->rnapoin, but->rnaprop, value_range);
1928                                 value_min = (double)value_range[0];
1929                                 value_max = (double)value_range[1];
1930                         }
1931                 }
1932                 else if (type == PROP_FLOAT) {
1933                         float fmin, fmax, fstep, fprecision;
1934                         const int array_len = RNA_property_array_length(&but->rnapoin, but->rnaprop);
1935
1936                         RNA_property_float_ui_range(&but->rnapoin, but->rnaprop, &fmin, &fmax, &fstep, &fprecision);
1937                         softmin = (fmin == -FLT_MAX) ? (float)-1e4 : fmin;
1938                         softmax = (fmax == FLT_MAX) ? (float)1e4 : fmax;
1939                         /*step= fstep;*/ /*UNUSED*/
1940                         /*precision= fprecision;*/ /*UNUSED*/
1941
1942                         if (array_len >= 2) {
1943                                 float value_range[2];
1944                                 RNA_property_float_get_array_range(&but->rnapoin, but->rnaprop, value_range);
1945                                 value_min = (double)value_range[0];
1946                                 value_max = (double)value_range[1];
1947                         }
1948                 }
1949                 else
1950                         return;
1951
1952                 /* if the value goes out of the soft/max range, adapt the range */
1953                 if (value_min + 1e-10 < softmin) {
1954                         if (value_min < 0.0)
1955                                 softmin = -soft_range_round_up(-value_min, -softmin);
1956                         else
1957                                 softmin = soft_range_round_down(value_min, softmin);
1958
1959                         if (softmin < (double)but->hardmin)
1960                                 softmin = (double)but->hardmin;
1961                 }
1962                 if (value_max - 1e-10 > softmax) {
1963                         if (value_max < 0.0)
1964                                 softmax = -soft_range_round_down(-value_max, -softmax);
1965                         else
1966                                 softmax = soft_range_round_up(value_max, softmax);
1967
1968                         if (softmax > (double)but->hardmax)
1969                                 softmax = but->hardmax;
1970                 }
1971
1972                 but->softmin = softmin;
1973                 but->softmax = softmax;
1974         }
1975 }
1976
1977 /* ******************* Free ********************/
1978
1979 static void ui_free_link(uiLink *link)
1980 {
1981         if (link) {     
1982                 BLI_freelistN(&link->lines);
1983                 MEM_freeN(link);
1984         }
1985 }
1986
1987 /* can be called with C==NULL */
1988 static void ui_free_but(const bContext *C, uiBut *but)
1989 {
1990         if (but->opptr) {
1991                 WM_operator_properties_free(but->opptr);
1992                 MEM_freeN(but->opptr);
1993         }
1994
1995         if (but->func_argN) {
1996                 MEM_freeN(but->func_argN);
1997         }
1998
1999         if (but->active) {
2000                 /* XXX solve later, buttons should be free-able without context ideally,
2001                  * however they may have open tooltips or popup windows, which need to
2002                  * be closed using a context pointer */
2003                 if (C) {
2004                         ui_button_active_free(C, but);
2005                 }
2006                 else {
2007                         if (but->active) {
2008                                 MEM_freeN(but->active);
2009                         }
2010                 }
2011         }
2012         if (but->str && but->str != but->strdata) {
2013                 MEM_freeN(but->str);
2014         }
2015         ui_free_link(but->link);
2016
2017         if ((but->type == BUT_IMAGE) && but->poin) {
2018                 IMB_freeImBuf((struct ImBuf *)but->poin);
2019         }
2020
2021         MEM_freeN(but);
2022 }
2023
2024 /* can be called with C==NULL */
2025 void uiFreeBlock(const bContext *C, uiBlock *block)
2026 {
2027         uiBut *but;
2028
2029         while ( (but = block->buttons.first) ) {
2030                 BLI_remlink(&block->buttons, but);      
2031                 ui_free_but(C, but);
2032         }
2033
2034         if (block->unit) {
2035                 MEM_freeN(block->unit);
2036         }
2037
2038         if (block->func_argN) {
2039                 MEM_freeN(block->func_argN);
2040         }
2041
2042         CTX_store_free_list(&block->contexts);
2043
2044         BLI_freelistN(&block->saferct);
2045         
2046         MEM_freeN(block);
2047 }
2048
2049 /* can be called with C==NULL */
2050 void uiFreeBlocks(const bContext *C, ListBase *lb)
2051 {
2052         uiBlock *block;
2053         
2054         while ( (block = lb->first) ) {
2055                 BLI_remlink(lb, block);
2056                 uiFreeBlock(C, block);
2057         }
2058 }
2059
2060 void uiFreeInactiveBlocks(const bContext *C, ListBase *lb)
2061 {
2062         uiBlock *block, *nextblock;
2063
2064         for (block = lb->first; block; block = nextblock) {
2065                 nextblock = block->next;
2066         
2067                 if (!block->handle) {
2068                         if (!block->active) {
2069                                 BLI_remlink(lb, block);
2070                                 uiFreeBlock(C, block);
2071                         }
2072                         else
2073                                 block->active = 0;
2074                 }
2075         }
2076 }
2077
2078 void uiBlockSetRegion(uiBlock *block, ARegion *region)
2079 {
2080         ListBase *lb = &region->uiblocks;
2081         uiBlock *oldblock = NULL;
2082
2083         /* each listbase only has one block with this name, free block
2084          * if is already there so it can be rebuilt from scratch */
2085         if (lb) {
2086                 oldblock = BLI_findstring(lb, block->name, offsetof(uiBlock, name));
2087
2088                 if (oldblock) {
2089                         oldblock->active = 0;
2090                         oldblock->panel = NULL;
2091                 }
2092
2093                 /* at the beginning of the list! for dynamical menus/blocks */
2094                 BLI_addhead(lb, block);
2095         }
2096
2097         block->oldblock = oldblock;
2098 }
2099
2100 uiBlock *uiBeginBlock(const bContext *C, ARegion *region, const char *name, short dt)
2101 {
2102         uiBlock *block;
2103         wmWindow *window;
2104         Scene *scn;
2105         int getsizex, getsizey;
2106
2107         window = CTX_wm_window(C);
2108         scn = CTX_data_scene(C);
2109
2110         block = MEM_callocN(sizeof(uiBlock), "uiBlock");
2111         block->active = 1;
2112         block->dt = dt;
2113         block->evil_C = (void *)C;  /* XXX */
2114
2115         if (scn) {
2116                 block->color_profile = (scn->r.color_mgt_flag & R_COLOR_MANAGEMENT);
2117
2118                 /* copy to avoid crash when scene gets deleted with ui still open */
2119                 block->unit = MEM_mallocN(sizeof(scn->unit), "UI UnitSettings");
2120                 memcpy(block->unit, &scn->unit, sizeof(scn->unit));
2121         }
2122
2123         BLI_strncpy(block->name, name, sizeof(block->name));
2124
2125         if (region)
2126                 uiBlockSetRegion(block, region);
2127
2128         /* window matrix and aspect */
2129         if (region && region->swinid) {
2130                 wm_subwindow_getmatrix(window, region->swinid, block->winmat);
2131                 wm_subwindow_getsize(window, region->swinid, &getsizex, &getsizey);
2132
2133                 /* TODO - investigate why block->winmat[0][0] is negative
2134                  * in the image view when viewRedrawForce is called */
2135                 block->aspect = 2.0f / fabsf(getsizex * block->winmat[0][0]);
2136         }
2137         else {
2138                 /* no subwindow created yet, for menus for example, so we
2139                  * use the main window instead, since buttons are created
2140                  * there anyway */
2141                 wm_subwindow_getmatrix(window, window->screen->mainwin, block->winmat);
2142                 wm_subwindow_getsize(window, window->screen->mainwin, &getsizex, &getsizey);
2143
2144                 block->aspect = 2.0f / fabsf(getsizex * block->winmat[0][0]);
2145                 block->auto_open = TRUE;
2146                 block->flag |= UI_BLOCK_LOOP; /* tag as menu */
2147         }
2148
2149         return block;
2150 }
2151
2152 uiBlock *uiGetBlock(const char *name, ARegion *ar)
2153 {
2154         return BLI_findstring(&ar->uiblocks, name, offsetof(uiBlock, name));
2155 }
2156
2157 void uiBlockSetEmboss(uiBlock *block, char dt)
2158 {
2159         block->dt = dt;
2160 }
2161
2162 void ui_check_but(uiBut *but)
2163 {
2164         /* if something changed in the button */
2165         double value = UI_BUT_VALUE_UNSET;
2166 //      float okwidth; // UNUSED
2167         
2168         ui_is_but_sel(but, &value);
2169         
2170         /* only update soft range while not editing */
2171         if (but->rnaprop && !(but->editval || but->editstr || but->editvec)) {
2172                 UI_GET_BUT_VALUE_INIT(but, value);
2173                 ui_set_but_soft_range(but, value);
2174         }
2175
2176         /* test for min and max, icon sliders, etc */
2177         switch (but->type) {
2178                 case NUM:
2179                 case SLI:
2180                 case SCROLL:
2181                 case NUMSLI:
2182                 case HSVSLI:
2183                         UI_GET_BUT_VALUE_INIT(but, value);
2184                         if (value < (double)but->hardmin) ui_set_but_val(but, but->hardmin);
2185                         else if (value > (double)but->hardmax) ui_set_but_val(but, but->hardmax);
2186                         break;
2187                         
2188                 case NUMABS:
2189                 {
2190                         double value_abs;
2191                         UI_GET_BUT_VALUE_INIT(but, value);
2192                         value_abs = fabs(value);
2193                         if (value_abs < (double)but->hardmin) ui_set_but_val(but, but->hardmin);
2194                         else if (value_abs > (double)but->hardmax) ui_set_but_val(but, but->hardmax);
2195                         break;
2196                 }
2197                 case ICONTOG: 
2198                 case ICONTOGN:
2199                         if (!but->rnaprop || (RNA_property_flag(but->rnaprop) & PROP_ICONS_CONSECUTIVE)) {
2200                                 if (but->flag & UI_SELECT) but->iconadd = 1;
2201                                 else but->iconadd = 0;
2202                         }
2203                         break;
2204                         
2205                 case ICONROW:
2206                         if (!but->rnaprop || (RNA_property_flag(but->rnaprop) & PROP_ICONS_CONSECUTIVE)) {
2207                                 UI_GET_BUT_VALUE_INIT(but, value);
2208                                 but->iconadd = (int)value - (int)(but->hardmin);
2209                         }
2210                         break;
2211                         
2212                 case ICONTEXTROW:
2213                         if (!but->rnaprop || (RNA_property_flag(but->rnaprop) & PROP_ICONS_CONSECUTIVE)) {
2214                                 UI_GET_BUT_VALUE_INIT(but, value);
2215                                 but->iconadd = (int)value - (int)(but->hardmin);
2216                         }
2217                         break;
2218         }
2219         
2220         
2221         /* safety is 4 to enable small number buttons (like 'users') */
2222         // okwidth= -4 + (BLI_RCT_SIZE_X(&but->rect)); // UNUSED
2223         
2224         /* name: */
2225         switch (but->type) {
2226         
2227                 case MENU:
2228                 case ICONTEXTROW:
2229                 
2230                         if (BLI_RCT_SIZE_X(&but->rect) > 24.0f) {
2231                                 UI_GET_BUT_VALUE_INIT(but, value);
2232                                 ui_set_name_menu(but, (int)value);
2233                         }
2234                         break;
2235         
2236                 case NUM:
2237                 case NUMSLI:
2238                 case HSVSLI:
2239                 case NUMABS:
2240
2241                         UI_GET_BUT_VALUE_INIT(but, value);
2242
2243                         if (ui_is_but_float(but)) {
2244                                 if (value == (double) FLT_MAX) {
2245                                         BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%sinf", but->str);
2246                                 }
2247                                 else if (value == (double) -FLT_MAX) {
2248                                         BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s-inf", but->str);
2249                                 }
2250                                 /* support length type buttons */
2251                                 else if (ui_is_but_unit(but)) {
2252                                         char new_str[sizeof(but->drawstr)];
2253                                         ui_get_but_string_unit(but, new_str, sizeof(new_str), value, TRUE);
2254                                         BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%s", but->str, new_str);
2255                                 }
2256                                 else {
2257                                         const int prec = ui_but_float_precision(but, value);
2258                                         BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%.*f", but->str, prec, value);
2259                                 }
2260                         }
2261                         else {
2262                                 BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%d", but->str, (int)value);
2263                         }
2264                         
2265                         if (but->rnaprop) {
2266                                 PropertySubType pstype = RNA_property_subtype(but->rnaprop);
2267                         
2268                                 if (pstype == PROP_PERCENTAGE)
2269                                         strcat(but->drawstr, "%");
2270                         }
2271                         break;
2272
2273                 case LABEL:
2274                         if (ui_is_but_float(but)) {
2275                                 int prec;
2276                                 UI_GET_BUT_VALUE_INIT(but, value);
2277                                 prec = ui_but_float_precision(but, value);
2278                                 BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%.*f", but->str, prec, value);
2279                         }
2280                         else {
2281                                 BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);
2282                         }
2283                 
2284                         break;
2285
2286                 case IDPOIN:
2287                 case TEX:
2288                 case SEARCH_MENU:
2289                         if (!but->editstr) {
2290                                 char str[UI_MAX_DRAW_STR];
2291
2292                                 ui_get_but_string(but, str, UI_MAX_DRAW_STR - strlen(but->str));
2293
2294                                 BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%s", but->str, str);
2295                         }
2296                         break;
2297         
2298                 case KEYEVT:
2299                         BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);
2300                         if (but->flag & UI_SELECT) {
2301                                 strcat(but->drawstr, "Press a key");
2302                         }
2303                         else {
2304                                 UI_GET_BUT_VALUE_INIT(but, value);
2305                                 strcat(but->drawstr, WM_key_event_string((short)value));
2306                         }
2307                         break;
2308                 
2309                 case HOTKEYEVT:
2310                         if (but->flag & UI_SELECT) {
2311                                 but->drawstr[0] = '\0';
2312
2313                                 if (but->modifier_key) {
2314                                         char *str = but->drawstr;
2315
2316                                         if (but->modifier_key & KM_SHIFT)
2317                                                 str = strcat(str, "Shift ");
2318                                         if (but->modifier_key & KM_CTRL)
2319                                                 str = strcat(str, "Ctrl ");
2320                                         if (but->modifier_key & KM_ALT)
2321                                                 str = strcat(str, "Alt ");
2322                                         if (but->modifier_key & KM_OSKEY)
2323                                                 str = strcat(str, "Cmd ");
2324
2325                                         (void)str; /* UNUSED */
2326                                 }
2327                                 else
2328                                         strcat(but->drawstr, "Press a key  ");
2329                         }
2330                         else
2331                                 BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);
2332
2333                         break;
2334
2335                 case BUT_TOGDUAL:
2336                         /* trying to get the dual-icon to left of text... not very nice */
2337                         if (but->str[0]) {
2338                                 BLI_strncpy(but->drawstr, "  ", UI_MAX_DRAW_STR);
2339                                 BLI_strncpy(but->drawstr + 2, but->str, UI_MAX_DRAW_STR - 2);
2340                         }
2341                         break;
2342                 
2343                 case HSVCUBE:
2344                 case HSVCIRCLE:
2345                         break;
2346                 default:
2347                         BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);
2348                 
2349         }
2350
2351         /* if we are doing text editing, this will override the drawstr */
2352         if (but->editstr)
2353                 BLI_strncpy(but->drawstr, but->editstr, UI_MAX_DRAW_STR);
2354         
2355         /* text clipping moved to widget drawing code itself */
2356 }
2357
2358
2359 void uiBlockBeginAlign(uiBlock *block)
2360 {
2361         /* if other align was active, end it */
2362         if (block->flag & UI_BUT_ALIGN) uiBlockEndAlign(block);
2363
2364         block->flag |= UI_BUT_ALIGN_DOWN;       
2365         block->alignnr++;
2366
2367         /* buttons declared after this call will get this align nr */ // XXX flag?
2368 }
2369
2370 static int buts_are_horiz(uiBut *but1, uiBut *but2)
2371 {
2372         float dx, dy;
2373         
2374         dx = fabs(but1->rect.xmax - but2->rect.xmin);
2375         dy = fabs(but1->rect.ymin - but2->rect.ymax);
2376         
2377         if (dx > dy) return 0;
2378         return 1;
2379 }
2380
2381 void uiBlockEndAlign(uiBlock *block)
2382 {
2383         block->flag &= ~UI_BUT_ALIGN;  /* all 4 flags */
2384 }
2385
2386 int ui_but_can_align(uiBut *but)
2387 {
2388         return !ELEM3(but->type, LABEL, OPTION, OPTIONN);
2389 }
2390
2391 static void ui_block_do_align_but(uiBut *first, short nr)
2392 {
2393         uiBut *prev, *but = NULL, *next;
2394         int flag = 0, cols = 0, rows = 0;
2395         
2396         /* auto align */
2397
2398         for (but = first; but && but->alignnr == nr; but = but->next) {
2399                 if (but->next && but->next->alignnr == nr) {
2400                         if (buts_are_horiz(but, but->next)) cols++;
2401                         else rows++;
2402                 }
2403         }
2404
2405         /* rows==0: 1 row, cols==0: 1 column */
2406         
2407         /* note;  how it uses 'flag' in loop below (either set it, or OR it) is confusing */
2408         for (but = first, prev = NULL; but && but->alignnr == nr; prev = but, but = but->next) {
2409                 next = but->next;
2410                 if (next && next->alignnr != nr)
2411                         next = NULL;
2412
2413                 /* clear old flag */
2414                 but->flag &= ~UI_BUT_ALIGN;
2415                         
2416                 if (flag == 0) {  /* first case */
2417                         if (next) {
2418                                 if (buts_are_horiz(but, next)) {
2419                                         if (rows == 0)
2420                                                 flag = UI_BUT_ALIGN_RIGHT;
2421                                         else 
2422                                                 flag = UI_BUT_ALIGN_DOWN | UI_BUT_ALIGN_RIGHT;
2423                                 }
2424                                 else {
2425                                         flag = UI_BUT_ALIGN_DOWN;
2426                                 }
2427                         }
2428                 }
2429                 else if (next == NULL) {  /* last case */
2430                         if (prev) {
2431                                 if (buts_are_horiz(prev, but)) {
2432                                         if (rows == 0)
2433                                                 flag = UI_BUT_ALIGN_LEFT;
2434                                         else
2435                                                 flag = UI_BUT_ALIGN_TOP | UI_BUT_ALIGN_LEFT;
2436                                 }
2437                                 else flag = UI_BUT_ALIGN_TOP;
2438                         }
2439                 }
2440                 else if (buts_are_horiz(but, next)) {
2441                         /* check if this is already second row */
2442                         if (prev && buts_are_horiz(prev, but) == 0) {
2443                                 flag &= ~UI_BUT_ALIGN_LEFT;
2444                                 flag |= UI_BUT_ALIGN_TOP;
2445                                 /* exception case: bottom row */
2446                                 if (rows > 0) {
2447                                         uiBut *bt = but;
2448                                         while (bt && bt->alignnr == nr) {
2449                                                 if (bt->next && bt->next->alignnr == nr && buts_are_horiz(bt, bt->next) == 0) break;
2450                                                 bt = bt->next;
2451                                         }
2452                                         if (bt == NULL || bt->alignnr != nr) flag = UI_BUT_ALIGN_TOP | UI_BUT_ALIGN_RIGHT;
2453                                 }
2454                         }
2455                         else flag |= UI_BUT_ALIGN_LEFT;
2456                 }
2457                 else {
2458                         if (cols == 0) {
2459                                 flag |= UI_BUT_ALIGN_TOP;
2460                         }
2461                         else {  /* next button switches to new row */
2462                                 
2463                                 if (prev && buts_are_horiz(prev, but))
2464                                         flag |= UI_BUT_ALIGN_LEFT;
2465                                 else {
2466                                         flag &= ~UI_BUT_ALIGN_LEFT;
2467                                         flag |= UI_BUT_ALIGN_TOP;
2468                                 }
2469                                 
2470                                 if ( (flag & UI_BUT_ALIGN_TOP) == 0) {    /* stil top row */
2471                                         if (prev) {
2472                                                 if (next && buts_are_horiz(but, next))
2473                                                         flag = UI_BUT_ALIGN_DOWN | UI_BUT_ALIGN_LEFT | UI_BUT_ALIGN_RIGHT;
2474                                                 else {
2475                                                         /* last button in top row */
2476                                                         flag = UI_BUT_ALIGN_DOWN | UI_BUT_ALIGN_LEFT;
2477                                                 }
2478                                         }
2479                                         else 
2480                                                 flag |= UI_BUT_ALIGN_DOWN;
2481                                 }
2482                                 else 
2483                                         flag |= UI_BUT_ALIGN_TOP;
2484                         }
2485                 }
2486                 
2487                 but->flag |= flag;
2488                 
2489                 /* merge coordinates */
2490                 if (prev) {
2491                         /* simple cases */
2492                         if (rows == 0) {
2493                                 but->rect.xmin = (prev->rect.xmax + but->rect.xmin) / 2.0f;
2494                                 prev->rect.xmax = but->rect.xmin;
2495                         }
2496                         else if (cols == 0) {
2497                                 but->rect.ymax = (prev->rect.ymin + but->rect.ymax) / 2.0f;
2498                                 prev->rect.ymin = but->rect.ymax;
2499                         }
2500                         else {
2501                                 if (buts_are_horiz(prev, but)) {
2502                                         but->rect.xmin = (prev->rect.xmax + but->rect.xmin) / 2.0f;
2503                                         prev->rect.xmax = but->rect.xmin;
2504                                         /* copy height too */
2505                                         but->rect.ymax = prev->rect.ymax;
2506                                 }
2507                                 else if (prev->prev && buts_are_horiz(prev->prev, prev) == 0) {
2508                                         /* the previous button is a single one in its row */
2509                                         but->rect.ymax = (prev->rect.ymin + but->rect.ymax) / 2.0f;
2510                                         prev->rect.ymin = but->rect.ymax;
2511                                         
2512                                         but->rect.xmin = prev->rect.xmin;
2513                                         if (next && buts_are_horiz(but, next) == 0)
2514                                                 but->rect.xmax = prev->rect.xmax;
2515                                 }
2516                                 else {
2517                                         /* the previous button is not a single one in its row */
2518                                         but->rect.ymax = prev->rect.ymin;
2519                                 }
2520                         }
2521                 }
2522         }
2523 }
2524
2525 void ui_block_do_align(uiBlock *block)
2526 {
2527         uiBut *but;
2528         short nr;
2529
2530         /* align buttons with same align nr */
2531         for (but = block->buttons.first; but; ) {
2532                 if (but->alignnr) {
2533                         nr = but->alignnr;
2534                         ui_block_do_align_but(but, nr);
2535
2536                         /* skip with same number */
2537                         for (; but && but->alignnr == nr; but = but->next) ;
2538
2539                         if (!but)
2540                                 break;
2541                 }
2542                 else
2543                         but = but->next;
2544         }
2545 }
2546
2547 /**
2548  * \brief ui_def_but is the function that draws many button types
2549  *
2550  * \param x,y The lower left hand corner of the button (X axis)
2551  * \param width,height The size of the button.
2552  *
2553  * for float buttons:
2554  * - \a a1 Click Step (how much to change the value each click)
2555  * - \a a2 Number of decimal point values to display. 0 defaults to 3 (0.000)
2556  *      1,2,3, and a maximum of 4, all greater values will be clamped to 4.
2557  */
2558 static uiBut *ui_def_but(uiBlock *block, int type, int retval, const char *str,
2559                                                  int x, int y, short width, short height,
2560                          void *poin, float min, float max, float a1, float a2, const char *tip)
2561 {
2562         uiBut *but;
2563         int slen;
2564         
2565         if (type & BUTPOIN) {       /* a pointer is required */
2566                 if (poin == NULL)
2567                         return NULL;
2568         }
2569
2570         but = MEM_callocN(sizeof(uiBut), "uiBut");
2571
2572         but->type = type & BUTTYPE;
2573         but->pointype = type & BUTPOIN;
2574         but->bit = type & BIT;
2575         but->bitnr = type & 31;
2576         but->icon = ICON_NONE;
2577         but->iconadd = 0;
2578
2579         but->retval = retval;
2580
2581         slen = strlen(str);
2582         if (slen >= UI_MAX_NAME_STR - 1) {
2583                 but->str = MEM_mallocN(slen + 2, "ui_def_but str"); /* why +2 ? */
2584         }
2585         else {
2586                 but->str = but->strdata;
2587         }
2588         memcpy(but->str, str, slen + 1);
2589
2590         but->rect.xmin = x;
2591         but->rect.ymin = y;
2592         but->rect.xmax = but->rect.xmin + width;
2593         but->rect.ymax = but->rect.ymin + height;
2594
2595         but->poin = poin;
2596         but->hardmin = but->softmin = min;
2597         but->hardmax = but->softmax = max;
2598         but->a1 = a1;
2599         but->a2 = a2;
2600         but->tip = tip;
2601
2602         but->lock = block->lock;
2603         but->lockstr = block->lockstr;
2604         but->dt = block->dt;
2605
2606         but->aspect = 1.0f;  /* XXX block->aspect; */
2607         but->block = block;  /* pointer back, used for frontbuffer status, and picker */
2608
2609         if ((block->flag & UI_BUT_ALIGN) && ui_but_can_align(but))
2610                 but->alignnr = block->alignnr;
2611
2612         but->func = block->func;
2613         but->func_arg1 = block->func_arg1;
2614         but->func_arg2 = block->func_arg2;
2615
2616         but->funcN = block->funcN;
2617         if (block->func_argN)
2618                 but->func_argN = MEM_dupallocN(block->func_argN);
2619         
2620         but->pos = -1;   /* cursor invisible */
2621
2622         if (ELEM4(but->type, NUM, NUMABS, NUMSLI, HSVSLI)) {    /* add a space to name */
2623                 /* slen remains unchanged from previous assignment, ensure this stays true */
2624                 if (slen > 0 && slen < UI_MAX_NAME_STR - 2) {
2625                         if (but->str[slen - 1] != ' ') {
2626                                 but->str[slen] = ' ';
2627                                 but->str[slen + 1] = 0;
2628                         }
2629                 }
2630         }
2631
2632         if ((block->flag & UI_BLOCK_LOOP) ||
2633             ELEM8(but->type, MENU, TEX, LABEL, IDPOIN, BLOCK, BUTM, SEARCH_MENU, PROGRESSBAR))
2634         {
2635                 but->flag |= (UI_TEXT_LEFT | UI_ICON_LEFT);
2636         }
2637         else if (but->type == BUT_TOGDUAL) {
2638                 but->flag |= UI_ICON_LEFT;
2639         }
2640
2641         but->flag |= (block->flag & UI_BUT_ALIGN);
2642
2643         if (but->lock == TRUE) {
2644                 if (but->lockstr) {
2645                         but->flag |= UI_BUT_DISABLED;
2646                 }
2647         }
2648
2649         /* keep track of UI_interface.h */
2650         if (ELEM7(but->type, BLOCK, BUT, LABEL, PULLDOWN, ROUNDBOX, LISTBOX, BUTM)) ;
2651         else if (ELEM3(but->type, SCROLL, SEPR, FTPREVIEW)) ;
2652         else if (but->type >= SEARCH_MENU) ;
2653         else but->flag |= UI_BUT_UNDO;
2654
2655         BLI_addtail(&block->buttons, but);
2656         
2657         if (block->curlayout)
2658                 ui_layout_add_but(block->curlayout, but);
2659
2660 #ifdef WITH_PYTHON
2661         /* if the 'UI_OT_editsource' is running, extract the source info from the button  */
2662         if (UI_editsource_enable_check()) {
2663                 UI_editsource_active_but_test(but);
2664         }
2665 #endif
2666
2667         return but;
2668 }
2669
2670 /* ui_def_but_rna_propname and ui_def_but_rna
2671  * both take the same args except for propname vs prop, this is done so we can
2672  * avoid an extra lookup on 'prop' when its already available.
2673  *
2674  * When this kind of change won't disrupt branches, best look into making more
2675  * of our UI functions take prop rather then propname.
2676  */
2677
2678 #define UI_DEF_BUT_RNA_DISABLE(but)  { \
2679                 but->flag |= UI_BUT_DISABLED;  \
2680                 but->lock = TRUE;              \
2681                 but->lockstr = "";             \
2682         } (void)0
2683
2684
2685 static uiBut *ui_def_but_rna(uiBlock *block, int type, int retval, const char *str,
2686                                                          int x, int y, short width, short height,
2687                              PointerRNA *ptr, PropertyRNA *prop, int index,
2688                              float min, float max, float a1, float a2,  const char *tip)
2689 {
2690         const PropertyType proptype = RNA_property_type(prop);
2691         uiBut *but;
2692         int freestr = 0, icon = 0;
2693
2694         /* use rna values if parameters are not specified */
2695         if (!str) {
2696                 if (type == MENU && proptype == PROP_ENUM) {
2697                         EnumPropertyItem *item;
2698                         DynStr *dynstr;
2699                         int i, totitem, value, free;
2700
2701                         RNA_property_enum_items_gettexted(block->evil_C, ptr, prop, &item, &totitem, &free);
2702                         value = RNA_property_enum_get(ptr, prop);
2703
2704                         dynstr = BLI_dynstr_new();
2705                         BLI_dynstr_appendf(dynstr, "%s%%t", RNA_property_ui_name(prop));
2706                         for (i = 0; i < totitem; i++) {
2707                                 if (!item[i].identifier[0]) {
2708                                         if (item[i].name)
2709                                                 BLI_dynstr_appendf(dynstr, "|%s%%l", item[i].name);
2710                                         else
2711                                                 BLI_dynstr_append(dynstr, "|%l");
2712                                 }
2713                                 else if (item[i].icon)
2714                                         BLI_dynstr_appendf(dynstr, "|%s %%i%d %%x%d", item[i].name, item[i].icon, item[i].value);
2715                                 else
2716                                         BLI_dynstr_appendf(dynstr, "|%s %%x%d", item[i].name, item[i].value);
2717
2718                                 if (value == item[i].value)
2719                                         icon = item[i].icon;
2720                         }
2721                         str = BLI_dynstr_get_cstring(dynstr);
2722                         BLI_dynstr_free(dynstr);
2723
2724                         if (free) {
2725                                 MEM_freeN(item);
2726                         }
2727
2728                         freestr = 1;
2729                 }
2730                 else if (ELEM(type, ROW, LISTROW) && proptype == PROP_ENUM) {
2731                         EnumPropertyItem *item;
2732                         int i, totitem, free;
2733
2734                         RNA_property_enum_items_gettexted(block->evil_C, ptr, prop, &item, &totitem, &free);
2735                         for (i = 0; i < totitem; i++) {
2736                                 if (item[i].identifier[0] && item[i].value == (int)max) {
2737                                         str = item[i].name;
2738                                         icon = item[i].icon;
2739                                 }
2740                         }
2741
2742                         if (!str) {
2743                                 str = RNA_property_ui_name(prop);
2744                         }
2745                         if (free) {
2746                                 MEM_freeN(item);
2747                         }
2748                 }
2749                 else {
2750                         str = RNA_property_ui_name(prop);
2751                         icon = RNA_property_ui_icon(prop);
2752                 }
2753         }
2754
2755         if (!tip && proptype != PROP_ENUM)
2756                 tip = RNA_property_ui_description(prop);
2757
2758         if (min == max || a1 == -1 || a2 == -1) {
2759                 if (proptype == PROP_INT) {
2760                         int hardmin, hardmax, softmin, softmax, step;
2761
2762                         RNA_property_int_range(ptr, prop, &hardmin, &hardmax);
2763                         RNA_property_int_ui_range(ptr, prop, &softmin, &softmax, &step);
2764
2765                         if (!ELEM(type, ROW, LISTROW) && min == max) {
2766                                 min = hardmin;
2767                                 max = hardmax;
2768                         }
2769                         if (a1 == -1)
2770                                 a1 = step;
2771                         if (a2 == -1)
2772                                 a2 = 0;
2773                 }
2774                 else if (proptype == PROP_FLOAT) {
2775                         float hardmin, hardmax, softmin, softmax, step, precision;
2776
2777                         RNA_property_float_range(ptr, prop, &hardmin, &hardmax);
2778                         RNA_property_float_ui_range(ptr, prop, &softmin, &softmax, &step, &precision);
2779
2780                         if (!ELEM(type, ROW, LISTROW) && min == max) {
2781                                 min = hardmin;
2782                                 max = hardmax;
2783                         }
2784                         if (a1 == -1)
2785                                 a1 = step;
2786                         if (a2 == -1)
2787                                 a2 = precision;
2788                 }
2789                 else if (proptype == PROP_STRING) {
2790                         min = 0;
2791                         max = RNA_property_string_maxlength(prop);
2792                         if (max == 0) /* interface code should ideally support unlimited length */
2793                                 max = UI_MAX_DRAW_STR;
2794                 }
2795         }
2796
2797         /* now create button */
2798         but = ui_def_but(block, type, retval, str, x, y, width, height, NULL, min, max, a1, a2, tip);
2799
2800         but->rnapoin = *ptr;
2801         but->rnaprop = prop;
2802
2803         if (RNA_property_array_length(&but->rnapoin, but->rnaprop))
2804                 but->rnaindex = index;
2805         else
2806                 but->rnaindex = 0;
2807
2808         if (icon) {
2809                 but->icon = (BIFIconID)icon;
2810                 but->flag |= UI_HAS_ICON;
2811                 but->flag |= UI_ICON_LEFT;
2812         }
2813         
2814         if (!RNA_property_editable(&but->rnapoin, prop)) {
2815                 UI_DEF_BUT_RNA_DISABLE(but);
2816         }
2817
2818         if (but->flag & UI_BUT_UNDO && (ui_but_is_rna_undo(but) == FALSE)) {
2819                 but->flag &= ~UI_BUT_UNDO;
2820         }
2821
2822         /* If this button uses units, calculate the step from this */
2823         if ((proptype == PROP_FLOAT) && ui_is_but_unit(but)) {
2824                 but->a1 = ui_get_but_step_unit(but, but->a1);
2825         }
2826
2827         if (freestr) {
2828                 MEM_freeN((void *)str);
2829         }
2830
2831         return but;
2832 }
2833
2834 static uiBut *ui_def_but_rna_propname(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, PointerRNA *ptr, const char *propname, int index, float min, float max, float a1, float a2,  const char *tip)
2835 {
2836         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
2837         uiBut *but;
2838
2839         if (prop) {
2840                 but = ui_def_but_rna(block, type, retval, str, x, y, width, height, ptr, prop, index, min, max, a1, a2,  tip);
2841         }
2842         else {
2843                 but = ui_def_but(block, type, retval, propname, x, y, width, height, NULL, min, max, a1, a2, tip);
2844
2845                 UI_DEF_BUT_RNA_DISABLE(but);
2846         }
2847
2848         return but;
2849 }
2850
2851 static uiBut *ui_def_but_operator_ptr(uiBlock *block, int type, wmOperatorType *ot, int opcontext, const char *str, int x, int y, short width, short height, const char *tip)
2852 {
2853         uiBut *but;
2854
2855         if (!str) {
2856                 if (ot && ot->srna)
2857                         str = RNA_struct_ui_name(ot->srna);
2858                 else
2859                         str = "";
2860         }
2861
2862         if ((!tip || tip[0] == '\0') && ot && ot->srna) {
2863                 tip = RNA_struct_ui_description(ot->srna);
2864         }
2865
2866         but = ui_def_but(block, type, -1, str, x, y, width, height, NULL, 0, 0, 0, 0, tip);
2867         but->optype = ot;
2868         but->opcontext = opcontext;
2869         but->flag &= ~UI_BUT_UNDO; /* no need for ui_but_is_undo(), we never need undo here */
2870
2871         if (!ot) {
2872                 but->flag |= UI_BUT_DISABLED;
2873                 but->lock = TRUE;
2874                 but->lockstr = "";
2875         }
2876
2877         return but;
2878 }
2879
2880 #if 0 /* UNUSED */
2881 static uiBut *UNUSED_FUNCTION(ui_def_but_operator) (uiBlock * block, int type, const char *opname, int opcontext, const char *str, int x, int y, short width, short height, const char *tip)
2882 {
2883         wmOperatorType *ot = WM_operatortype_find(opname, 0);
2884         if (str == NULL && ot == NULL) str = opname;
2885         return ui_def_but_operator_ptr(block, type, ot, opcontext, str, x, y, width, height, tip);
2886 }
2887 #endif
2888
2889 static uiBut *ui_def_but_operator_text(uiBlock *block, int type, const char *opname, int opcontext, const char *str, int x, int y, short width, short height, void *poin, float min, float max, float a1, float a2, const char *tip)
2890 {
2891         uiBut *but;
2892         wmOperatorType *ot;
2893         
2894         ot = WM_operatortype_find(opname, 0);
2895
2896         if (!str) {
2897                 if (ot) str = ot->name;
2898                 else str = opname;
2899         }
2900         
2901         if ((!tip || tip[0] == '\0') && ot && ot->description) {
2902                 tip = ot->description;
2903         }
2904
2905         but = ui_def_but(block, type, -1, str, x, y, width, height, poin, min, max, a1, a2, tip);
2906         but->optype = ot;
2907         but->opcontext = opcontext;
2908         but->flag &= ~UI_BUT_UNDO; /* no need for ui_but_is_undo(), we never need undo here */
2909
2910         if (!ot) {
2911                 but->flag |= UI_BUT_DISABLED;
2912                 but->lock = TRUE;
2913                 but->lockstr = "";
2914         }
2915
2916         return but;
2917 }
2918
2919 uiBut *uiDefBut(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, void *poin, float min, float max, float a1, float a2, const char *tip)
2920 {
2921         uiBut *but = ui_def_but(block, type, retval, str, x, y, width, height, poin, min, max, a1, a2, tip);
2922
2923         ui_check_but(but);
2924         
2925         return but;
2926 }
2927
2928 /* if _x_ is a power of two (only one bit) return the power,
2929  * otherwise return -1.
2930  * (1<<findBitIndex(x))==x for powers of two.
2931  */
2932 static int findBitIndex(unsigned int x)
2933 {
2934         if (!x || !is_power_of_2_i(x)) { /* is_power_of_2_i(x) strips lowest bit */
2935                 return -1;
2936         }
2937         else {
2938                 int idx = 0;
2939
2940                 if (x & 0xFFFF0000) idx += 16, x >>= 16;
2941                 if (x & 0xFF00) idx += 8, x >>= 8;
2942                 if (x & 0xF0) idx += 4, x >>= 4;
2943                 if (x & 0xC) idx += 2, x >>= 2;
2944                 if (x & 0x2) idx += 1;
2945
2946                 return idx;
2947         }
2948 }
2949
2950 /* autocomplete helper functions */
2951 struct AutoComplete {
2952         size_t maxlen;
2953         char *truncate;
2954         const char *startname;
2955 };
2956
2957 AutoComplete *autocomplete_begin(const char *startname, size_t maxlen)
2958 {
2959         AutoComplete *autocpl;
2960         
2961         autocpl = MEM_callocN(sizeof(AutoComplete), "AutoComplete");
2962         autocpl->maxlen = maxlen;
2963         autocpl->truncate = MEM_callocN(sizeof(char) * maxlen, "AutoCompleteTruncate");
2964         autocpl->startname = startname;
2965
2966         return autocpl;
2967 }
2968
2969 void autocomplete_do_name(AutoComplete *autocpl, const char *name)
2970 {
2971         char *truncate = autocpl->truncate;
2972         const char *startname = autocpl->startname;
2973         int a;
2974
2975         for (a = 0; a < autocpl->maxlen - 1; a++) {
2976                 if (startname[a] == 0 || startname[a] != name[a])
2977                         break;
2978         }
2979         /* found a match */
2980         if (startname[a] == 0) {
2981                 /* first match */
2982                 if (truncate[0] == 0)
2983                         BLI_strncpy(truncate, name, autocpl->maxlen);
2984                 else {
2985                         /* remove from truncate what is not in bone->name */
2986                         for (a = 0; a < autocpl->maxlen - 1; a++) {
2987                                 if (name[a] == 0) {
2988                                         truncate[a] = 0;
2989                                         break;
2990                                 }
2991                                 else if (truncate[a] != name[a])
2992                                         truncate[a] = 0;
2993                         }
2994                 }
2995         }
2996 }
2997
2998 void autocomplete_end(AutoComplete *autocpl, char *autoname)
2999 {       
3000         if (autocpl->truncate[0])
3001                 BLI_strncpy(autoname, autocpl->truncate, autocpl->maxlen);
3002         else {
3003                 if (autoname != autocpl->startname) /* don't copy a string over its self */
3004                         BLI_strncpy(autoname, autocpl->startname, autocpl->maxlen);
3005         }
3006         MEM_freeN(autocpl->truncate);
3007         MEM_freeN(autocpl);
3008 }
3009
3010 /* autocomplete callback for ID buttons */
3011 static void autocomplete_id(bContext *C, char *str, void *arg_v)
3012 {
3013         int blocktype = (intptr_t)arg_v;
3014         ListBase *listb = which_libbase(CTX_data_main(C), blocktype);
3015         
3016         if (listb == NULL) return;
3017         
3018         /* search if str matches the beginning of an ID struct */
3019         if (str[0]) {
3020                 AutoComplete *autocpl = autocomplete_begin(str, MAX_ID_NAME - 2);
3021                 ID *id;
3022                 
3023                 for (id = listb->first; id; id = id->next)
3024                         autocomplete_do_name(autocpl, id->name + 2);
3025
3026                 autocomplete_end(autocpl, str);
3027         }
3028 }
3029
3030 static void ui_check_but_and_iconize(uiBut *but, int icon)
3031 {
3032         if (icon) {
3033                 but->icon = (BIFIconID) icon;
3034                 but->flag |= UI_HAS_ICON;
3035         }
3036
3037         ui_check_but(but);
3038 }
3039
3040 static uiBut *uiDefButBit(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, void *poin, float min, float max, float a1, float a2,  const char *tip)
3041 {
3042         int bitIdx = findBitIndex(bit);
3043         if (bitIdx == -1) {
3044                 return NULL;
3045         }
3046         else {
3047                 return uiDefBut(block, type | BIT | bitIdx, retval, str, x, y, width, height, poin, min, max, a1, a2, tip);
3048         }
3049 }
3050 uiBut *uiDefButF(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2,  const char *tip)
3051 {
3052         return uiDefBut(block, type | FLO, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3053 }
3054 uiBut *uiDefButBitF(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, float *poin, float min, float max, float a1, float a2,  const char *tip)
3055 {
3056         return uiDefButBit(block, type | FLO, bit, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3057 }
3058 uiBut *uiDefButI(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2,  const char *tip)
3059 {
3060         return uiDefBut(block, type | INT, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3061 }
3062 uiBut *uiDefButBitI(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, int *poin, float min, float max, float a1, float a2,  const char *tip)
3063 {
3064         return uiDefButBit(block, type | INT, bit, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3065 }
3066 uiBut *uiDefButS(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2,  const char *tip)
3067 {
3068         return uiDefBut(block, type | SHO, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3069 }
3070 uiBut *uiDefButBitS(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, short *poin, float min, float max, float a1, float a2,  const char *tip)
3071 {
3072         return uiDefButBit(block, type | SHO, bit, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3073 }
3074 uiBut *uiDefButC(uiBlock *block, int type, int retval, const char *str, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2,  const char *tip)
3075 {
3076         return uiDefBut(block, type | CHA, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3077 }
3078 uiBut *uiDefButBitC(uiBlock *block, int type, int bit, int retval, const char *str, int x, int y, short width, short height, char *poin, float min, float max, float a1, float a2,  const char *tip)
3079 {