code cleanup:
[blender.git] / source / blender / editors / interface / interface.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation 2002-2008, full recode.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/editors/interface/interface.c
27  *  \ingroup edinterface
28  */
29
30
31 #include <float.h>
32 #include <limits.h>
33 #include <math.h>
34 #include <string.h>
35 #include <ctype.h>
36 #include <stddef.h>  /* offsetof() */
37
38 #include "MEM_guardedalloc.h"
39
40 #include "DNA_scene_types.h"
41 #include "DNA_screen_types.h"
42 #include "DNA_userdef_types.h"
43
44 #include "BLI_math.h"
45 #include "BLI_listbase.h"
46 #include "BLI_string.h"
47 #include "BLI_string_utf8.h"
48 #include "BLI_path_util.h"
49 #include "BLI_rect.h"
50
51 #include "BLI_dynstr.h"
52 #include "BLI_utildefines.h"
53
54 #include "BKE_context.h"
55 #include "BKE_library.h"
56 #include "BKE_unit.h"
57 #include "BKE_screen.h"
58 #include "BKE_idprop.h"
59
60 #include "BIF_gl.h"
61
62 #include "BLF_api.h"
63 #include "BLF_translation.h"
64
65 #include "UI_interface.h"
66
67 #include "IMB_imbuf.h"
68
69 #include "WM_api.h"
70 #include "WM_types.h"
71 #include "wm_subwindow.h"
72 #include "wm_window.h"
73
74 #include "RNA_access.h"
75
76 #include "BPY_extern.h"
77
78 #include "interface_intern.h"
79
80 #define MENU_WIDTH          120
81 #define MENU_ITEM_HEIGHT    20
82 #define MENU_SEP_HEIGHT     6
83
84 #define PRECISION_FLOAT_MAX 6
85 #define PRECISION_FLOAT_MAX_POW 1000000 /* pow(10, PRECISION_FLOAT_MAX)  */
86
87 /* avoid unneeded calls to ui_get_but_val */
88 #define UI_BUT_VALUE_UNSET DBL_MAX
89 #define UI_GET_BUT_VALUE_INIT(_but, _value) if (_value == DBL_MAX) {  (_value) = ui_get_but_val(_but); } (void)0
90
91 /* 
92  * a full doc with API notes can be found in bf-blender/trunk/blender/doc/guides/interface_API.txt
93  * 
94  * uiBlahBlah()         external function
95  * ui_blah_blah()       internal function
96  */
97
98 static void ui_free_but(const bContext *C, uiBut *but);
99
100 /* ************* window matrix ************** */
101
102 void ui_block_to_window_fl(const ARegion *ar, uiBlock *block, float *x, float *y)
103 {
104         float gx, gy;
105         int sx, sy, getsizex, getsizey;
106
107         getsizex = BLI_RCT_SIZE_X(&ar->winrct) + 1;
108         getsizey = BLI_RCT_SIZE_Y(&ar->winrct) + 1;
109         sx = ar->winrct.xmin;
110         sy = ar->winrct.ymin;
111
112         gx = *x;
113         gy = *y;
114
115         if (block->panel) {
116                 gx += block->panel->ofsx;
117                 gy += block->panel->ofsy;
118         }
119
120         *x = ((float)sx) + ((float)getsizex) * (0.5f + 0.5f * (gx * block->winmat[0][0] + gy * block->winmat[1][0] + block->winmat[3][0]));
121         *y = ((float)sy) + ((float)getsizey) * (0.5f + 0.5f * (gx * block->winmat[0][1] + gy * block->winmat[1][1] + block->winmat[3][1]));
122 }
123
124 void ui_block_to_window(const ARegion *ar, uiBlock *block, int *x, int *y)
125 {
126         float fx, fy;
127
128         fx = *x;
129         fy = *y;
130
131         ui_block_to_window_fl(ar, block, &fx, &fy);
132
133         *x = (int)(fx + 0.5f);
134         *y = (int)(fy + 0.5f);
135 }
136
137 void ui_block_to_window_rct(const ARegion *ar, uiBlock *block, const rctf *graph, rcti *winr)
138 {
139         rctf tmpr;
140
141         tmpr = *graph;
142         ui_block_to_window_fl(ar, block, &tmpr.xmin, &tmpr.ymin);
143         ui_block_to_window_fl(ar, block, &tmpr.xmax, &tmpr.ymax);
144
145         BLI_rcti_rctf_copy(winr, &tmpr);
146 }
147
148 void ui_window_to_block_fl(const ARegion *ar, uiBlock *block, float *x, float *y)   /* for mouse cursor */
149 {
150         float a, b, c, d, e, f, px, py;
151         int sx, sy, getsizex, getsizey;
152
153         getsizex = BLI_RCT_SIZE_X(&ar->winrct) + 1;
154         getsizey = BLI_RCT_SIZE_Y(&ar->winrct) + 1;
155         sx = ar->winrct.xmin;
156         sy = ar->winrct.ymin;
157
158         a = 0.5f * ((float)getsizex) * block->winmat[0][0];
159         b = 0.5f * ((float)getsizex) * block->winmat[1][0];
160         c = 0.5f * ((float)getsizex) * (1.0f + block->winmat[3][0]);
161
162         d = 0.5f * ((float)getsizey) * block->winmat[0][1];
163         e = 0.5f * ((float)getsizey) * block->winmat[1][1];
164         f = 0.5f * ((float)getsizey) * (1.0f + block->winmat[3][1]);
165
166         px = *x - sx;
167         py = *y - sy;
168
169         *y =  (a * (py - f) + d * (c - px)) / (a * e - d * b);
170         *x = (px - b * (*y) - c) / a;
171
172         if (block->panel) {
173                 *x -= block->panel->ofsx;
174                 *y -= block->panel->ofsy;
175         }
176 }
177
178 void ui_window_to_block(const ARegion *ar, uiBlock *block, int *x, int *y)
179 {
180         float fx, fy;
181
182         fx = *x;
183         fy = *y;
184
185         ui_window_to_block_fl(ar, block, &fx, &fy);
186
187         *x = (int)(fx + 0.5f);
188         *y = (int)(fy + 0.5f);
189 }
190
191 void ui_window_to_region(const ARegion *ar, int *x, int *y)
192 {
193         *x -= ar->winrct.xmin;
194         *y -= ar->winrct.ymin;
195 }
196
197 /* ******************* block calc ************************* */
198
199 void ui_block_translate(uiBlock *block, int x, int y)
200 {
201         uiBut *but;
202
203         for (but = block->buttons.first; but; but = but->next) {
204                 BLI_rctf_translate(&but->rect, x, y);
205         }
206
207         BLI_rctf_translate(&block->rect, x, y);
208 }
209
210 static void ui_text_bounds_block(uiBlock *block, float offset)
211 {
212         uiStyle *style = UI_GetStyle();
213         uiBut *bt;
214         int i = 0, j, x1addval = offset, nextcol;
215         int lastcol = 0, col = 0;
216         
217         uiStyleFontSet(&style->widget);
218         
219         for (bt = block->buttons.first; bt; bt = bt->next) {
220                 if (bt->type != SEPR) {
221                         j = BLF_width(style->widget.uifont_id, bt->drawstr);
222
223                         if (j > i) i = j;
224                 }
225
226                 if (bt->next && bt->rect.xmin < bt->next->rect.xmin)
227                         lastcol++;
228         }
229
230         /* cope with multi collumns */
231         bt = block->buttons.first;
232         while (bt) {
233                 if (bt->next && bt->rect.xmin < bt->next->rect.xmin) {
234                         nextcol = 1;
235                         col++;
236                 }
237                 else nextcol = 0;
238                 
239                 bt->rect.xmin = x1addval;
240                 bt->rect.xmax = bt->rect.xmin + i + block->bounds;
241                 
242                 if (col == lastcol) {
243                         bt->rect.xmax = maxf(bt->rect.xmax, offset + block->minbounds);
244                 }
245
246                 ui_check_but(bt);  /* clips text again */
247                 
248                 if (nextcol)
249                         x1addval += i + block->bounds;
250                 
251                 bt = bt->next;
252         }
253 }
254
255 void ui_bounds_block(uiBlock *block)
256 {
257         uiBut *bt;
258         int xof;
259         
260         if (block->buttons.first == NULL) {
261                 if (block->panel) {
262                         block->rect.xmin = 0.0; block->rect.xmax = block->panel->sizex;
263                         block->rect.ymin = 0.0; block->rect.ymax = block->panel->sizey;
264                 }
265         }
266         else {
267         
268                 BLI_rctf_init_minmax(&block->rect);
269
270                 for (bt = block->buttons.first; bt; bt = bt->next) {
271                         BLI_rctf_union(&block->rect, &bt->rect);
272                 }
273                 
274                 block->rect.xmin -= block->bounds;
275                 block->rect.ymin -= block->bounds;
276                 block->rect.xmax += block->bounds;
277                 block->rect.ymax += block->bounds;
278         }
279
280         block->rect.xmax = block->rect.xmin + maxf(BLI_RCT_SIZE_X(&block->rect), block->minbounds);
281
282         /* hardcoded exception... but that one is annoying with larger safety */ 
283         bt = block->buttons.first;
284         if (bt && strncmp(bt->str, "ERROR", 5) == 0) xof = 10;
285         else xof = 40;
286
287         block->safety.xmin = block->rect.xmin - xof;
288         block->safety.ymin = block->rect.ymin - xof;
289         block->safety.xmax = block->rect.xmax + xof;
290         block->safety.ymax = block->rect.ymax + xof;
291 }
292
293 static void ui_centered_bounds_block(const bContext *C, uiBlock *block)
294 {
295         wmWindow *window = CTX_wm_window(C);
296         int xmax, ymax;
297         int startx, starty;
298         int width, height;
299         
300         /* note: this is used for the splash where window bounds event has not been
301          * updated by ghost, get the window bounds from ghost directly */
302
303         // wm_window_get_size(window, &xmax, &ymax);
304         wm_window_get_size_ghost(window, &xmax, &ymax);
305         
306         ui_bounds_block(block);
307         
308         width  = BLI_RCT_SIZE_X(&block->rect);
309         height = BLI_RCT_SIZE_Y(&block->rect);
310         
311         startx = (xmax * 0.5f) - (width * 0.5f);
312         starty = (ymax * 0.5f) - (height * 0.5f);
313         
314         ui_block_translate(block, startx - block->rect.xmin, starty - block->rect.ymin);
315         
316         /* now recompute bounds and safety */
317         ui_bounds_block(block);
318         
319 }
320 static void ui_popup_bounds_block(const bContext *C, uiBlock *block, int bounds_calc)
321 {
322         wmWindow *window = CTX_wm_window(C);
323         int startx, starty, endx, endy, width, height, oldwidth, oldheight;
324         int oldbounds, xmax, ymax;
325
326         oldbounds = block->bounds;
327
328         /* compute mouse position with user defined offset */
329         ui_bounds_block(block);
330         
331         wm_window_get_size(window, &xmax, &ymax);
332
333         oldwidth  = BLI_RCT_SIZE_X(&block->rect);
334         oldheight = BLI_RCT_SIZE_Y(&block->rect);
335
336         /* first we ensure wide enough text bounds */
337         if (bounds_calc == UI_BLOCK_BOUNDS_POPUP_MENU) {
338                 if (block->flag & UI_BLOCK_LOOP) {
339                         block->bounds = 50;
340                         ui_text_bounds_block(block, block->rect.xmin);
341                 }
342         }
343
344         /* next we recompute bounds */
345         block->bounds = oldbounds;
346         ui_bounds_block(block);
347
348         /* and we adjust the position to fit within window */
349         width  = BLI_RCT_SIZE_X(&block->rect);
350         height = BLI_RCT_SIZE_Y(&block->rect);
351
352         /* avoid divide by zero below, caused by calling with no UI, but better not crash */
353         oldwidth = oldwidth > 0 ? oldwidth : MAX2(1, width);
354         oldheight = oldheight > 0 ? oldheight : MAX2(1, height);
355
356         /* offset block based on mouse position, user offset is scaled
357          * along in case we resized the block in ui_text_bounds_block */
358         startx = window->eventstate->x + block->rect.xmin + (block->mx * width) / oldwidth;
359         starty = window->eventstate->y + block->rect.ymin + (block->my * height) / oldheight;
360
361         if (startx < 10)
362                 startx = 10;
363         if (starty < 10)
364                 starty = 10;
365
366         endx = startx + width;
367         endy = starty + height;
368
369         if (endx > xmax) {
370                 endx = xmax - 10;
371                 startx = endx - width;
372         }
373         if (endy > ymax - 20) {
374                 endy = ymax - 20;
375                 starty = endy - height;
376         }
377
378         ui_block_translate(block, startx - block->rect.xmin, starty - block->rect.ymin);
379
380         /* now recompute bounds and safety */
381         ui_bounds_block(block);
382 }
383
384 /* used for various cases */
385 void uiBoundsBlock(uiBlock *block, int addval)
386 {
387         if (block == NULL)
388                 return;
389         
390         block->bounds = addval;
391         block->dobounds = UI_BLOCK_BOUNDS;
392 }
393
394 /* used for pulldowns */
395 void uiTextBoundsBlock(uiBlock *block, int addval)
396 {
397         block->bounds = addval;
398         block->dobounds = UI_BLOCK_BOUNDS_TEXT;
399 }
400
401 /* used for block popups */
402 void uiPopupBoundsBlock(uiBlock *block, int addval, int mx, int my)
403 {
404         block->bounds = addval;
405         block->dobounds = UI_BLOCK_BOUNDS_POPUP_MOUSE;
406         block->mx = mx;
407         block->my = my;
408 }
409
410 /* used for menu popups */
411 void uiMenuPopupBoundsBlock(uiBlock *block, int addval, int mx, int my)
412 {
413         block->bounds = addval;
414         block->dobounds = UI_BLOCK_BOUNDS_POPUP_MENU;
415         block->mx = mx;
416         block->my = my;
417 }
418
419 /* used for centered popups, i.e. splash */
420 void uiCenteredBoundsBlock(uiBlock *block, int addval)
421 {
422         block->bounds = addval;
423         block->dobounds = UI_BLOCK_BOUNDS_POPUP_CENTER;
424 }
425
426 void uiExplicitBoundsBlock(uiBlock *block, int minx, int miny, int maxx, int maxy)
427 {
428         block->rect.xmin = minx;
429         block->rect.ymin = miny;
430         block->rect.xmax = maxx;
431         block->rect.ymax = maxy;
432         block->dobounds = 0;
433 }
434
435 /* ************** LINK LINE DRAWING  ************* */
436
437 /* link line drawing is not part of buttons or theme.. so we stick with it here */
438
439 static int ui_but_float_precision(uiBut *but, double value)
440 {
441         int prec;
442
443         /* first check if prec is 0 and fallback to a simple default */
444         if ((prec = (int)but->a2) == 0) {
445                 prec = (but->hardmax < 10.001f) ? 3 : 2;
446         }
447
448         /* check on the number of decimal places need to display
449          * the number, this is so 0.00001 is not displayed as 0.00,
450          * _but_, this is only for small values si 10.0001 will not get
451          * the same treatment */
452         if (value != 0.0 && (value = ABS(value)) < 0.1) {
453                 int value_i = (int)((value * PRECISION_FLOAT_MAX_POW) + 0.5);
454                 if (value_i != 0) {
455                         const int prec_span = 3; /* show: 0.01001, 5 would allow 0.0100001 for eg. */
456                         int test_prec;
457                         int prec_min = -1;
458                         int dec_flag = 0;
459                         int i = PRECISION_FLOAT_MAX;
460                         while (i && value_i) {
461                                 if (value_i % 10) {
462                                         dec_flag |= 1 << i;
463                                         prec_min = i;
464                                 }
465                                 value_i /= 10;
466                                 i--;
467                         }
468
469                         /* even though its a small value, if the second last digit is not 0, use it */
470                         test_prec = prec_min;
471
472                         dec_flag = (dec_flag >> (prec_min + 1)) & ((1 << prec_span) - 1);
473
474                         while (dec_flag) {
475                                 test_prec++;
476                                 dec_flag = dec_flag >> 1;
477                         }
478
479                         if (test_prec > prec) {
480                                 prec = test_prec;
481                         }
482                 }
483         }
484
485         CLAMP(prec, 1, PRECISION_FLOAT_MAX);
486
487         return prec;
488 }
489
490 static void ui_draw_linkline(uiLinkLine *line, int highlightActiveLines)
491 {
492         rcti rect;
493
494         if (line->from == NULL || line->to == NULL) return;
495         
496         rect.xmin = BLI_RCT_CENTER_X(&line->from->rect);
497         rect.ymin = BLI_RCT_CENTER_Y(&line->from->rect);
498         rect.xmax = BLI_RCT_CENTER_X(&line->to->rect);
499         rect.ymax = BLI_RCT_CENTER_Y(&line->to->rect);
500         
501         if (line->flag & UI_SELECT)
502                 glColor3ub(100, 100, 100);
503         else if (highlightActiveLines && ((line->from->flag & UI_ACTIVE) || (line->to->flag & UI_ACTIVE)))
504                 UI_ThemeColor(TH_TEXT_HI);
505         else 
506                 glColor3ub(0, 0, 0);
507
508         ui_draw_link_bezier(&rect);
509 }
510
511 static void ui_draw_links(uiBlock *block)
512 {
513         uiBut *but;
514         uiLinkLine *line;
515
516         /* Draw the inactive lines (lines with neither button being hovered over).
517          * As we go, remember if we see any active or selected lines. */
518         int foundselectline = FALSE;
519         int foundactiveline = FALSE;
520         for (but = block->buttons.first; but; but = but->next) {
521                 if (but->type == LINK && but->link) {
522                         for (line = but->link->lines.first; line; line = line->next) {
523                                 if (!(line->from->flag & UI_ACTIVE) && !(line->to->flag & UI_ACTIVE))
524                                         ui_draw_linkline(line, 0);
525                                 else
526                                         foundactiveline = TRUE;
527
528                                 if ((line->from->flag & UI_SELECT) || (line->to->flag & UI_SELECT))
529                                         foundselectline = TRUE;
530                         }
531                 }
532         }       
533
534         /* Draw any active lines (lines with either button being hovered over).
535          * Do this last so they appear on top of inactive lines. */
536         if (foundactiveline) {
537                 for (but = block->buttons.first; but; but = but->next) {
538                         if (but->type == LINK && but->link) {
539                                 for (line = but->link->lines.first; line; line = line->next) {
540                                         if ((line->from->flag & UI_ACTIVE) || (line->to->flag & UI_ACTIVE))
541                                                 ui_draw_linkline(line, !foundselectline);
542                                 }
543                         }
544                 }       
545         }
546 }
547
548 /* ************** BLOCK ENDING FUNCTION ************* */
549
550 /* NOTE: if but->poin is allocated memory for every defbut, things fail... */
551 static int ui_but_equals_old(uiBut *but, uiBut *oldbut)
552 {
553         /* various properties are being compared here, hopefully sufficient
554          * to catch all cases, but it is simple to add more checks later */
555         if (but->retval != oldbut->retval) return 0;
556         if (but->rnapoin.data != oldbut->rnapoin.data) return 0;
557         if (but->rnaprop != oldbut->rnaprop)
558                 if (but->rnaindex != oldbut->rnaindex) return 0;
559         if (but->func != oldbut->func) return 0;
560         if (but->funcN != oldbut->funcN) return 0;
561         if (oldbut->func_arg1 != oldbut && but->func_arg1 != oldbut->func_arg1) return 0;
562         if (oldbut->func_arg2 != oldbut && but->func_arg2 != oldbut->func_arg2) return 0;
563         if (!but->funcN && ((but->poin != oldbut->poin && (uiBut *)oldbut->poin != oldbut) || but->pointype != oldbut->pointype)) return 0;
564         if (but->optype != oldbut->optype) return 0;
565
566         return 1;
567 }
568
569 /* oldbut is being inserted in new block, so we use the lines from new button, and replace button pointers */
570 static void ui_but_update_linklines(uiBlock *block, uiBut *oldbut, uiBut *newbut)
571 {
572         uiLinkLine *line;
573         uiBut *but;
574         
575         /* if active button is LINK */
576         if (newbut->type == LINK && newbut->link) {
577                 
578                 SWAP(uiLink *, oldbut->link, newbut->link);
579                 
580                 for (line = oldbut->link->lines.first; line; line = line->next) {
581                         if (line->to == newbut)
582                                 line->to = oldbut;
583                         if (line->from == newbut)
584                                 line->from = oldbut;
585                 }
586         }               
587         
588         /* check all other button links */
589         for (but = block->buttons.first; but; but = but->next) {
590                 if (but != newbut && but->type == LINK && but->link) {
591                         for (line = but->link->lines.first; line; line = line->next) {
592                                 if (line->to == newbut)
593                                         line->to = oldbut;
594                                 if (line->from == newbut)
595                                         line->from = oldbut;
596                         }
597                 }
598         }
599 }
600
601 static int ui_but_update_from_old_block(const bContext *C, uiBlock *block, uiBut **butpp)
602 {
603         uiBlock *oldblock;
604         uiBut *oldbut, *but = *butpp;
605         int found = 0;
606
607         oldblock = block->oldblock;
608         if (!oldblock)
609                 return found;
610
611         for (oldbut = oldblock->buttons.first; oldbut; oldbut = oldbut->next) {
612                 if (ui_but_equals_old(oldbut, but)) {
613                         if (oldbut->active) {
614 #if 0
615 //                              but->flag= oldbut->flag;
616 #else
617                                 /* exception! redalert flag can't be update from old button. 
618                                  * perhaps it should only copy specific flags rather than all. */
619 //                              but->flag= (oldbut->flag & ~UI_BUT_REDALERT) | (but->flag & UI_BUT_REDALERT);
620 #endif
621 //                              but->active= oldbut->active;
622 //                              but->pos= oldbut->pos;
623 //                              but->ofs= oldbut->ofs;
624 //                              but->editstr= oldbut->editstr;
625 //                              but->editval= oldbut->editval;
626 //                              but->editvec= oldbut->editvec;
627 //                              but->editcoba= oldbut->editcoba;
628 //                              but->editcumap= oldbut->editcumap;
629 //                              but->selsta= oldbut->selsta;
630 //                              but->selend= oldbut->selend;
631 //                              but->softmin= oldbut->softmin;
632 //                              but->softmax= oldbut->softmax;
633 //                              but->linkto[0]= oldbut->linkto[0];
634 //                              but->linkto[1]= oldbut->linkto[1];
635                                 found = 1;
636 //                              oldbut->active= NULL;
637                         
638                                 /* move button over from oldblock to new block */
639                                 BLI_remlink(&oldblock->buttons, oldbut);
640                                 BLI_insertlink(&block->buttons, but, oldbut);
641                                 oldbut->block = block;
642                                 *butpp = oldbut;
643                                 
644                                 /* still stuff needs to be copied */
645                                 oldbut->rect = but->rect;
646                                 oldbut->context = but->context; /* set by Layout */
647                                 
648                                 /* typically the same pointers, but not on undo/redo */
649                                 /* XXX some menu buttons store button itself in but->poin. Ugly */
650                                 if (oldbut->poin != (char *)oldbut) {
651                                         SWAP(char *, oldbut->poin, but->poin);
652                                         SWAP(void *, oldbut->func_argN, but->func_argN);
653                                 }
654                                 
655                                 /* copy hardmin for list rows to prevent 'sticking' highlight to mouse position
656                                  * when scrolling without moving mouse (see [#28432]) */
657                                 if (ELEM(oldbut->type, ROW, LISTROW))
658                                         oldbut->hardmax = but->hardmax;
659                                 
660                                 ui_but_update_linklines(block, oldbut, but);
661                                 
662                                 BLI_remlink(&block->buttons, but);
663                                 ui_free_but(C, but);
664                                 
665                                 /* note: if layout hasn't been applied yet, it uses old button pointers... */
666                         }
667                         else {
668                                 /* ensures one button can get activated, and in case the buttons
669                                  * draw are the same this gives O(1) lookup for each button */
670                                 BLI_remlink(&oldblock->buttons, oldbut);
671                                 ui_free_but(C, oldbut);
672                         }
673                         
674                         break;
675                 }
676         }
677         
678         return found;
679 }
680
681 /* needed for temporarily rename buttons, such as in outliner or file-select,
682  * they should keep calling uiDefButs to keep them alive */
683 /* returns 0 when button removed */
684 int uiButActiveOnly(const bContext *C, uiBlock *block, uiBut *but)
685 {
686         uiBlock *oldblock;
687         uiBut *oldbut;
688         int activate = FALSE, found = FALSE, isactive = FALSE;
689         
690         oldblock = block->oldblock;
691         if (!oldblock)
692                 activate = TRUE;
693         else {
694                 for (oldbut = oldblock->buttons.first; oldbut; oldbut = oldbut->next) {
695                         if (ui_but_equals_old(oldbut, but)) {
696                                 found = TRUE;
697                                 
698                                 if (oldbut->active)
699                                         isactive = TRUE;
700                                 
701                                 break;
702                         }
703                 }
704         }
705         if ((activate == TRUE) || (found == FALSE)) {
706                 ui_button_activate_do((bContext *)C, CTX_wm_region(C), but);
707         }
708         else if ((found == TRUE) && (isactive == FALSE)) {
709                 BLI_remlink(&block->buttons, but);
710                 ui_free_but(C, but);
711                 return 0;
712         }
713         
714         return 1;
715 }
716
717 /* use to check if we need to disable undo, but don't make any changes
718  * returns FALSE if undo needs to be disabled. */
719 static int ui_but_is_rna_undo(uiBut *but)
720 {
721         if (but->rnapoin.id.data) {
722                 /* avoid undo push for buttons who's ID are screen or wm level
723                  * we could disable undo for buttons with no ID too but may have
724                  * unforeseen consequences, so best check for ID's we _know_ are not
725                  * handled by undo - campbell */
726                 ID *id = but->rnapoin.id.data;
727                 if (ID_CHECK_UNDO(id) == FALSE) {
728                         return FALSE;
729                 }
730                 else {
731                         return TRUE;
732                 }
733         }
734         else if (but->rnapoin.type && !RNA_struct_undo_check(but->rnapoin.type)) {
735                 return FALSE;
736         }
737
738         return TRUE;
739 }
740
741 /* assigns automatic keybindings to menu items for fast access
742  * (underline key in menu) */
743 static void ui_menu_block_set_keyaccels(uiBlock *block)
744 {
745         uiBut *but;
746
747         unsigned int menu_key_mask = 0;
748         unsigned char menu_key;
749         const char *str_pt;
750         int pass;
751         int tot_missing = 0;
752
753         /* only do it before bounding */
754         if (block->rect.xmin != block->rect.xmax)
755                 return;
756
757         for (pass = 0; pass < 2; pass++) {
758                 /* 2 Passes, on for first letter only, second for any letter if first fails
759                  * fun first pass on all buttons so first word chars always get first priority */
760
761                 for (but = block->buttons.first; but; but = but->next) {
762                         if (!ELEM4(but->type, BUT, MENU, BLOCK, PULLDOWN) || (but->flag & UI_HIDDEN)) {
763                                 /* pass */
764                         }
765                         else if (but->menu_key == '\0') {
766                                 if (but->str) {
767                                         for (str_pt = but->str; *str_pt; ) {
768                                                 menu_key = tolower(*str_pt);
769                                                 if ((menu_key >= 'a' && menu_key <= 'z') && !(menu_key_mask & 1 << (menu_key - 'a'))) {
770                                                         menu_key_mask |= 1 << (menu_key - 'a');
771                                                         break;
772                                                 }
773
774                                                 if (pass == 0) {
775                                                         /* Skip to next delimiter on first pass (be picky) */
776                                                         while (isalpha(*str_pt))
777                                                                 str_pt++;
778
779                                                         if (*str_pt)
780                                                                 str_pt++;
781                                                 }
782                                                 else {
783                                                         /* just step over every char second pass and find first usable key */
784                                                         str_pt++;
785                                                 }
786                                         }
787
788                                         if (*str_pt) {
789                                                 but->menu_key = menu_key;
790                                         }
791                                         else {
792                                                 /* run second pass */
793                                                 tot_missing++;
794                                         }
795
796                                         /* if all keys have been used just exit, unlikely */
797                                         if (menu_key_mask == (1 << 26) - 1) {
798                                                 return;
799                                         }
800                                 }
801                         }
802                 }
803
804                 /* check if second pass is needed */
805                 if (!tot_missing) {
806                         break;
807                 }
808         }
809 }
810
811 /* XXX, this code will shorten any allocated string to 'UI_MAX_NAME_STR'
812  * since this is really long its unlikely to be an issue,
813  * but this could be supported */
814 void ui_but_add_shortcut(uiBut *but, const char *shortcut_str, const short do_strip)
815 {
816
817         if (do_strip) {
818                 char *cpoin = strchr(but->str, '|');
819                 if (cpoin) {
820                         *cpoin = '\0';
821                 }
822         }
823
824         /* without this, just allow stripping of the shortcut */
825         if (shortcut_str) {
826                 char *butstr_orig;
827
828                 if (but->str != but->strdata) {
829                         butstr_orig = but->str; /* free after using as source buffer */
830                 }
831                 else {
832                         butstr_orig = BLI_strdup(but->str);
833                 }
834                 BLI_snprintf(but->strdata,
835                              sizeof(but->strdata),
836                              "%s|%s",
837                              butstr_orig, shortcut_str);
838                 MEM_freeN(butstr_orig);
839                 but->str = but->strdata;
840                 ui_check_but(but);
841         }
842 }
843
844 static void ui_menu_block_set_keymaps(const bContext *C, uiBlock *block)
845 {
846         uiBut *but;
847         char buf[128];
848
849         /* for menu's */
850         MenuType *mt;
851         IDProperty *prop_menu = NULL;
852         IDProperty *prop_menu_name = NULL;
853
854         /* only do it before bounding */
855         if (block->rect.xmin != block->rect.xmax)
856                 return;
857
858         for (but = block->buttons.first; but; but = but->next) {
859                 if (but->optype) {
860                         IDProperty *prop = (but->opptr) ? but->opptr->data : NULL;
861
862                         if (WM_key_event_operator_string(C, but->optype->idname, but->opcontext, prop, TRUE,
863                                                          buf, sizeof(buf)))
864                         {
865                                 ui_but_add_shortcut(but, buf, FALSE);
866                         }
867                 }
868                 else if ((mt = uiButGetMenuType(but))) {
869                         /* only allocate menu property once */
870                         if (prop_menu == NULL) {
871                                 /* annoying, create a property */
872                                 IDPropertyTemplate val = {0};
873                                 prop_menu = IDP_New(IDP_GROUP, &val, __func__); /* dummy, name is unimportant  */
874                                 IDP_AddToGroup(prop_menu, (prop_menu_name = IDP_NewString("", "name", sizeof(mt->idname))));
875                         }
876
877                         IDP_AssignString(prop_menu_name, mt->idname, sizeof(mt->idname));
878
879                         if (WM_key_event_operator_string(C, "WM_OT_call_menu", WM_OP_INVOKE_REGION_WIN, prop_menu, FALSE,
880                                                          buf, sizeof(buf)))
881                         {
882                                 ui_but_add_shortcut(but, buf, FALSE);
883                         }
884                 }
885         }
886
887         if (prop_menu) {
888                 IDP_FreeProperty(prop_menu);
889                 MEM_freeN(prop_menu);
890         }
891
892 #undef UI_MENU_KEY_STR_CAT
893
894 }
895
896 void uiEndBlock(const bContext *C, uiBlock *block)
897 {
898         uiBut *but;
899         Scene *scene = CTX_data_scene(C);
900
901         /* inherit flags from 'old' buttons that was drawn here previous, based
902          * on matching buttons, we need this to make button event handling non
903          * blocking, while still allowing buttons to be remade each redraw as it
904          * is expected by blender code */
905         for (but = block->buttons.first; but; but = but->next) {
906                 if (ui_but_update_from_old_block(C, block, &but))
907                         ui_check_but(but);
908                 
909                 /* temp? Proper check for graying out */
910                 if (but->optype) {
911                         wmOperatorType *ot = but->optype;
912
913                         if (but->context)
914                                 CTX_store_set((bContext *)C, but->context);
915
916                         if (ot == NULL || WM_operator_poll_context((bContext *)C, ot, but->opcontext) == 0) {
917                                 but->flag |= UI_BUT_DISABLED;
918                                 but->lock = TRUE;
919                         }
920
921                         if (but->context)
922                                 CTX_store_set((bContext *)C, NULL);
923                 }
924
925                 ui_but_anim_flag(but, (scene) ? scene->r.cfra : 0.0f);
926         }
927
928         if (block->oldblock) {
929                 block->auto_open = block->oldblock->auto_open;
930                 block->auto_open_last = block->oldblock->auto_open_last;
931                 block->tooltipdisabled = block->oldblock->tooltipdisabled;
932
933                 block->oldblock = NULL;
934         }
935
936         /* handle pending stuff */
937         if (block->layouts.first) uiBlockLayoutResolve(block, NULL, NULL);
938         ui_block_do_align(block);
939         if ((block->flag & UI_BLOCK_LOOP) && (block->flag & UI_BLOCK_NUMSELECT)) {
940                 ui_menu_block_set_keyaccels(block); /* could use a different flag to check */
941         }
942         if (block->flag & UI_BLOCK_LOOP) ui_menu_block_set_keymaps(C, block);
943         
944         /* after keymaps! */
945         if (block->dobounds == UI_BLOCK_BOUNDS) ui_bounds_block(block);
946         else if (block->dobounds == UI_BLOCK_BOUNDS_TEXT) ui_text_bounds_block(block, 0.0f);
947         else if (block->dobounds == UI_BLOCK_BOUNDS_POPUP_CENTER) ui_centered_bounds_block(C, block);
948         else if (block->dobounds) ui_popup_bounds_block(C, block, block->dobounds);
949
950         if (block->rect.xmin == 0.0f && block->rect.xmax == 0.0f) uiBoundsBlock(block, 0);
951         if (block->flag & UI_BUT_ALIGN) uiBlockEndAlign(block);
952
953         block->endblock = 1;
954 }
955
956 /* ************** BLOCK DRAWING FUNCTION ************* */
957
958 void ui_fontscale(short *points, float aspect)
959 {
960         if (aspect < 0.9f || aspect > 1.1f) {
961                 float pointsf = *points;
962                 
963                 /* for some reason scaling fonts goes too fast compared to widget size */
964                 aspect = sqrt(aspect);
965                 pointsf /= aspect;
966                 
967                 if (aspect > 1.0f)
968                         *points = ceilf(pointsf);
969                 else
970                         *points = floorf(pointsf);
971         }
972 }
973
974 /* project button or block (but==NULL) to pixels in regionspace */
975 static void ui_but_to_pixelrect(rcti *rect, const ARegion *ar, uiBlock *block, uiBut *but)
976 {
977         float gx, gy;
978         float getsizex, getsizey;
979         
980         getsizex = ar->winx;
981         getsizey = ar->winy;
982
983         gx = (but ? but->rect.xmin : block->rect.xmin) + (block->panel ? block->panel->ofsx : 0.0f);
984         gy = (but ? but->rect.ymin : block->rect.ymin) + (block->panel ? block->panel->ofsy : 0.0f);
985         
986         rect->xmin = floorf(getsizex * (0.5f + 0.5f * (gx * block->winmat[0][0] + gy * block->winmat[1][0] + block->winmat[3][0])));
987         rect->ymin = floorf(getsizey * (0.5f + 0.5f * (gx * block->winmat[0][1] + gy * block->winmat[1][1] + block->winmat[3][1])));
988         
989         gx = (but ? but->rect.xmax : block->rect.xmax) + (block->panel ? block->panel->ofsx : 0.0f);
990         gy = (but ? but->rect.ymax : block->rect.ymax) + (block->panel ? block->panel->ofsy : 0.0f);
991         
992         rect->xmax = floorf(getsizex * (0.5f + 0.5f * (gx * block->winmat[0][0] + gy * block->winmat[1][0] + block->winmat[3][0])));
993         rect->ymax = floorf(getsizey * (0.5f + 0.5f * (gx * block->winmat[0][1] + gy * block->winmat[1][1] + block->winmat[3][1])));
994
995 }
996
997 /* uses local copy of style, to scale things down, and allow widgets to change stuff */
998 void uiDrawBlock(const bContext *C, uiBlock *block)
999 {
1000         uiStyle style = *UI_GetStyle();  /* XXX pass on as arg */
1001         ARegion *ar;
1002         uiBut *but;
1003         rcti rect;
1004         int multisample_enabled;
1005         
1006         /* get menu region or area region */
1007         ar = CTX_wm_menu(C);
1008         if (!ar)
1009                 ar = CTX_wm_region(C);
1010
1011         if (!block->endblock)
1012                 uiEndBlock(C, block);
1013
1014         /* disable AA, makes widgets too blurry */
1015         multisample_enabled = glIsEnabled(GL_MULTISAMPLE_ARB);
1016         if (multisample_enabled)
1017                 glDisable(GL_MULTISAMPLE_ARB);
1018
1019         /* we set this only once */
1020         glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
1021         
1022         /* scale fonts */
1023         ui_fontscale(&style.paneltitle.points, block->aspect);
1024         ui_fontscale(&style.grouplabel.points, block->aspect);
1025         ui_fontscale(&style.widgetlabel.points, block->aspect);
1026         ui_fontscale(&style.widget.points, block->aspect);
1027         
1028         /* scale block min/max to rect */
1029         ui_but_to_pixelrect(&rect, ar, block, NULL);
1030         
1031         /* pixel space for AA widgets */
1032         glMatrixMode(GL_PROJECTION);
1033         glPushMatrix();
1034         glMatrixMode(GL_MODELVIEW);
1035         glPushMatrix();
1036         glLoadIdentity();
1037         
1038         wmOrtho2(-0.01f, ar->winx - 0.01f, -0.01f, ar->winy - 0.01f);
1039         
1040         /* back */
1041         if (block->flag & UI_BLOCK_LOOP)
1042                 ui_draw_menu_back(&style, block, &rect);
1043         else if (block->panel)
1044                 ui_draw_aligned_panel(&style, block, &rect);
1045
1046         /* widgets */
1047         for (but = block->buttons.first; but; but = but->next) {
1048                 if (!(but->flag & (UI_HIDDEN | UI_SCROLLED))) {
1049                         ui_but_to_pixelrect(&rect, ar, block, but);
1050                 
1051                         /* XXX: figure out why invalid coordinates happen when closing render window */
1052                         /* and material preview is redrawn in main window (temp fix for bug #23848) */
1053                         if (rect.xmin < rect.xmax && rect.ymin < rect.ymax)
1054                                 ui_draw_but(C, ar, &style, but, &rect);
1055                 }
1056         }
1057         
1058         /* restore matrix */
1059         glMatrixMode(GL_PROJECTION);
1060         glPopMatrix();
1061         glMatrixMode(GL_MODELVIEW);
1062         glPopMatrix();
1063
1064         if (multisample_enabled)
1065                 glEnable(GL_MULTISAMPLE_ARB);
1066         
1067         ui_draw_links(block);
1068 }
1069
1070 /* ************* EVENTS ************* */
1071
1072 static void ui_is_but_sel(uiBut *but, double *value)
1073 {
1074         short is_push = 0;  /* (0 == UNSELECT), (1 == SELECT), (2 == DO-NOHING) */
1075         short is_true = TRUE;
1076
1077         if (ELEM3(but->type, TOGN, ICONTOGN, OPTIONN)) {
1078                 is_true = FALSE;
1079         }
1080
1081         if (but->bit) {
1082                 int lvalue;
1083                 UI_GET_BUT_VALUE_INIT(but, *value);
1084                 lvalue = (int)*value;
1085                 if (UI_BITBUT_TEST(lvalue, (but->bitnr))) {
1086                         is_push = is_true;
1087                 }
1088                 else {
1089                         is_push = !is_true;
1090                 }
1091         }
1092         else {
1093                 switch (but->type) {
1094                         case BUT:
1095                                 is_push = 2;
1096                                 break;
1097                         case HOTKEYEVT:
1098                         case KEYEVT:
1099                                 is_push = 2;
1100                                 break;
1101                         case TOGBUT:
1102                         case TOG:
1103                         case TOGR:
1104                         case TOG3:
1105                         case BUT_TOGDUAL:
1106                         case ICONTOG:
1107                         case OPTION:
1108                                 UI_GET_BUT_VALUE_INIT(but, *value);
1109                                 if (*value != (double)but->hardmin) is_push = 1;
1110                                 break;
1111                         case ICONTOGN:
1112                         case TOGN:
1113                         case OPTIONN:
1114                                 UI_GET_BUT_VALUE_INIT(but, *value);
1115                                 if (*value == 0.0) is_push = 1;
1116                                 break;
1117                         case ROW:
1118                         case LISTROW:
1119                                 UI_GET_BUT_VALUE_INIT(but, *value);
1120                                 /* support for rna enum buts */
1121                                 if (but->rnaprop && (RNA_property_flag(but->rnaprop) & PROP_ENUM_FLAG)) {
1122                                         if ((int)*value & (int)but->hardmax) is_push = 1;
1123                                 }
1124                                 else {
1125                                         if (*value == (double)but->hardmax) is_push = 1;
1126                                 }
1127                                 break;
1128                         case COL:
1129                                 is_push = 2;
1130                                 break;
1131                         default:
1132                                 is_push = 2;
1133                                 break;
1134                 }
1135         }
1136         
1137         if (is_push == 2) ;
1138         else if (is_push == 1) but->flag |= UI_SELECT;
1139         else but->flag &= ~UI_SELECT;
1140 }
1141
1142 static uiBut *ui_find_inlink(uiBlock *block, void *poin)
1143 {
1144         uiBut *but;
1145         
1146         but = block->buttons.first;
1147         while (but) {
1148                 if (but->type == INLINK) {
1149                         if (but->poin == poin) return but;
1150                 }
1151                 but = but->next;
1152         }
1153         return NULL;
1154 }
1155
1156 static void ui_add_link_line(ListBase *listb, uiBut *but, uiBut *bt)
1157 {
1158         uiLinkLine *line;
1159         
1160         line = MEM_callocN(sizeof(uiLinkLine), "linkline");
1161         BLI_addtail(listb, line);
1162         line->from = but;
1163         line->to = bt;
1164 }
1165
1166 uiBut *uiFindInlink(uiBlock *block, void *poin)
1167 {
1168         return ui_find_inlink(block, poin);
1169 }
1170
1171 void uiComposeLinks(uiBlock *block)
1172 {
1173         uiBut *but, *bt;
1174         uiLink *link;
1175         void ***ppoin;
1176         int a;
1177         
1178         but = block->buttons.first;
1179         while (but) {
1180                 if (but->type == LINK) {
1181                         link = but->link;
1182                         
1183                         /* for all pointers in the array */
1184                         if (link) {
1185                                 if (link->ppoin) {
1186                                         ppoin = link->ppoin;
1187                                         for (a = 0; a < *(link->totlink); a++) {
1188                                                 bt = ui_find_inlink(block, (*ppoin)[a]);
1189                                                 if (bt) {
1190                                                         ui_add_link_line(&link->lines, but, bt);
1191                                                 }
1192                                         }
1193                                 }
1194                                 else if (link->poin) {
1195                                         bt = ui_find_inlink(block, *(link->poin) );
1196                                         if (bt) {
1197                                                 ui_add_link_line(&link->lines, but, bt);
1198                                         }
1199                                 }
1200                         }
1201                 }
1202                 but = but->next;
1203         }
1204 }
1205
1206
1207 /* ************************************************ */
1208
1209 void uiBlockSetButLock(uiBlock *block, int val, const char *lockstr)
1210 {
1211         if (val) {
1212                 block->lock = val ? TRUE : FALSE;
1213                 block->lockstr = lockstr;
1214         }
1215 }
1216
1217 void uiBlockClearButLock(uiBlock *block)
1218 {
1219         block->lock = FALSE;
1220         block->lockstr = NULL;
1221 }
1222
1223 /* *************************************************************** */
1224
1225 void ui_delete_linkline(uiLinkLine *line, uiBut *but)
1226 {
1227         uiLink *link;
1228         int a, b;
1229         
1230         BLI_remlink(&but->link->lines, line);
1231
1232         link = line->from->link;
1233
1234         /* are there more pointers allowed? */
1235         if (link->ppoin) {
1236                 
1237                 if (*(link->totlink) == 1) {
1238                         *(link->totlink) = 0;
1239                         MEM_freeN(*(link->ppoin));
1240                         *(link->ppoin) = NULL;
1241                 }
1242                 else {
1243                         b = 0;
1244                         for (a = 0; a < (*(link->totlink)); a++) {
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                         /* quiet warnings for unhandled types */
2220                 default:
2221                         break;
2222         }
2223         
2224         
2225         /* safety is 4 to enable small number buttons (like 'users') */
2226         // okwidth= -4 + (BLI_RCT_SIZE_X(&but->rect)); // UNUSED
2227         
2228         /* name: */
2229         switch (but->type) {
2230         
2231                 case MENU:
2232                 case ICONTEXTROW:
2233                 
2234                         if (BLI_RCT_SIZE_X(&but->rect) > 24.0f) {
2235                                 UI_GET_BUT_VALUE_INIT(but, value);
2236                                 ui_set_name_menu(but, (int)value);
2237                         }
2238                         break;
2239         
2240                 case NUM:
2241                 case NUMSLI:
2242                 case HSVSLI:
2243                 case NUMABS:
2244
2245                         UI_GET_BUT_VALUE_INIT(but, value);
2246
2247                         if (ui_is_but_float(but)) {
2248                                 if (value == (double) FLT_MAX) {
2249                                         BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%sinf", but->str);
2250                                 }
2251                                 else if (value == (double) -FLT_MAX) {
2252                                         BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s-inf", but->str);
2253                                 }
2254                                 /* support length type buttons */
2255                                 else if (ui_is_but_unit(but)) {
2256                                         char new_str[sizeof(but->drawstr)];
2257                                         ui_get_but_string_unit(but, new_str, sizeof(new_str), value, TRUE);
2258                                         BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%s", but->str, new_str);
2259                                 }
2260                                 else {
2261                                         const int prec = ui_but_float_precision(but, value);
2262                                         BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%.*f", but->str, prec, value);
2263                                 }
2264                         }
2265                         else {
2266                                 BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%d", but->str, (int)value);
2267                         }
2268                         
2269                         if (but->rnaprop) {
2270                                 PropertySubType pstype = RNA_property_subtype(but->rnaprop);
2271                         
2272                                 if (pstype == PROP_PERCENTAGE)
2273                                         strcat(but->drawstr, "%");
2274                         }
2275                         break;
2276
2277                 case LABEL:
2278                         if (ui_is_but_float(but)) {
2279                                 int prec;
2280                                 UI_GET_BUT_VALUE_INIT(but, value);
2281                                 prec = ui_but_float_precision(but, value);
2282                                 BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%.*f", but->str, prec, value);
2283                         }
2284                         else {
2285                                 BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);
2286                         }
2287                 
2288                         break;
2289
2290                 case IDPOIN:
2291                 case TEX:
2292                 case SEARCH_MENU:
2293                         if (!but->editstr) {
2294                                 char str[UI_MAX_DRAW_STR];
2295
2296                                 ui_get_but_string(but, str, UI_MAX_DRAW_STR - strlen(but->str));
2297
2298                                 BLI_snprintf(but->drawstr, sizeof(but->drawstr), "%s%s", but->str, str);
2299                         }
2300                         break;
2301         
2302                 case KEYEVT:
2303                         BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);
2304                         if (but->flag & UI_SELECT) {
2305                                 strcat(but->drawstr, "Press a key");
2306                         }
2307                         else {
2308                                 UI_GET_BUT_VALUE_INIT(but, value);
2309                                 strcat(but->drawstr, WM_key_event_string((short)value));
2310                         }
2311                         break;
2312                 
2313                 case HOTKEYEVT:
2314                         if (but->flag & UI_SELECT) {
2315                                 but->drawstr[0] = '\0';
2316
2317                                 if (but->modifier_key) {
2318                                         char *str = but->drawstr;
2319
2320                                         if (but->modifier_key & KM_SHIFT)
2321                                                 str = strcat(str, "Shift ");
2322                                         if (but->modifier_key & KM_CTRL)
2323                                                 str = strcat(str, "Ctrl ");
2324                                         if (but->modifier_key & KM_ALT)
2325                                                 str = strcat(str, "Alt ");
2326                                         if (but->modifier_key & KM_OSKEY)
2327                                                 str = strcat(str, "Cmd ");
2328
2329                                         (void)str; /* UNUSED */
2330                                 }
2331                                 else
2332                                         strcat(but->drawstr, "Press a key  ");
2333                         }
2334                         else
2335                                 BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);
2336
2337                         break;
2338
2339                 case BUT_TOGDUAL:
2340                         /* trying to get the dual-icon to left of text... not very nice */
2341                         if (but->str[0]) {
2342                                 BLI_strncpy(but->drawstr, "  ", UI_MAX_DRAW_STR);
2343                                 BLI_strncpy(but->drawstr + 2, but->str, UI_MAX_DRAW_STR - 2);
2344                         }
2345                         break;
2346                 
2347                 case HSVCUBE:
2348                 case HSVCIRCLE:
2349                         break;
2350                 default:
2351                         BLI_strncpy(but->drawstr, but->str, UI_MAX_DRAW_STR);
2352                 
2353         }
2354
2355         /* if we are doing text editing, this will override the drawstr */
2356         if (but->editstr)
2357                 BLI_strncpy(but->drawstr, but->editstr, UI_MAX_DRAW_STR);
2358         
2359         /* text clipping moved to widget drawing code itself */
2360 }
2361
2362
2363 void uiBlockBeginAlign(uiBlock *block)
2364 {
2365         /* if other align was active, end it */
2366         if (block->flag & UI_BUT_ALIGN) uiBlockEndAlign(block);
2367
2368         block->flag |= UI_BUT_ALIGN_DOWN;       
2369         block->alignnr++;
2370
2371         /* buttons declared after this call will get this align nr */ // XXX flag?
2372 }
2373
2374 static int buts_are_horiz(uiBut *but1, uiBut *but2)
2375 {
2376         float dx, dy;
2377         
2378         dx = fabs(but1->rect.xmax - but2->rect.xmin);
2379         dy = fabs(but1->rect.ymin - but2->rect.ymax);
2380         
2381         if (dx > dy) return 0;
2382         return 1;
2383 }
2384
2385 void uiBlockEndAlign(uiBlock *block)
2386 {
2387         block->flag &= ~UI_BUT_ALIGN;  /* all 4 flags */
2388 }
2389
2390 int ui_but_can_align(uiBut *but)
2391 {
2392         return !ELEM3(but->type, LABEL, OPTION, OPTIONN);
2393 }
2394
2395 static void ui_block_do_align_but(uiBut *first, short nr)
2396 {
2397         uiBut *prev, *but = NULL, *next;
2398         int flag = 0, cols = 0, rows = 0;
2399         
2400         /* auto align */
2401
2402         for (but = first; but && but->alignnr == nr; but = but->next) {
2403                 if (but->next && but->next->alignnr == nr) {
2404                         if (buts_are_horiz(but, but->next)) cols++;
2405                         else rows++;
2406                 }
2407         }
2408
2409         /* rows==0: 1 row, cols==0: 1 column */
2410         
2411         /* note;  how it uses 'flag' in loop below (either set it, or OR it) is confusing */
2412         for (but = first, prev = NULL; but && but->alignnr == nr; prev = but, but = but->next) {
2413                 next = but->next;
2414                 if (next && next->alignnr != nr)
2415                         next = NULL;
2416
2417                 /* clear old flag */
2418                 but->flag &= ~UI_BUT_ALIGN;
2419                         
2420                 if (flag == 0) {  /* first case */
2421                         if (next) {
2422                                 if (buts_are_horiz(but, next)) {
2423                                         if (rows == 0)
2424                                                 flag = UI_BUT_ALIGN_RIGHT;
2425                                         else 
2426                                                 flag = UI_BUT_ALIGN_DOWN | UI_BUT_ALIGN_RIGHT;
2427                                 }
2428                                 else {
2429                                         flag = UI_BUT_ALIGN_DOWN;
2430                                 }
2431                         }
2432                 }
2433                 else if (next == NULL) {  /* last case */
2434                         if (prev) {
2435                                 if (buts_are_horiz(prev, but)) {
2436                                         if (rows == 0)
2437                                                 flag = UI_BUT_ALIGN_LEFT;
2438                                         else
2439                                                 flag = UI_BUT_ALIGN_TOP | UI_BUT_ALIGN_LEFT;
2440                                 }
2441                                 else flag = UI_BUT_ALIGN_TOP;
2442                         }
2443                 }
2444                 else if (buts_are_horiz(but, next)) {
2445                         /* check if this is already second row */
2446                         if (prev && buts_are_horiz(prev, but) == 0) {
2447                                 flag &= ~UI_BUT_ALIGN_LEFT;
2448                                 flag |= UI_BUT_ALIGN_TOP;
2449                                 /* exception case: bottom row */
2450                                 if (rows > 0) {
2451                                         uiBut *bt = but;
2452                                         while (bt && bt->alignnr == nr) {
2453                                                 if (bt->next && bt->next->alignnr == nr && buts_are_horiz(bt, bt->next) == 0) break;
2454                                                 bt = bt->next;
2455                                         }
2456                                         if (bt == NULL || bt->alignnr != nr) flag = UI_BUT_ALIGN_TOP | UI_BUT_ALIGN_RIGHT;
2457                                 }
2458                         }
2459                         else flag |= UI_BUT_ALIGN_LEFT;
2460                 }
2461                 else {
2462                         if (cols == 0) {
2463                                 flag |= UI_BUT_ALIGN_TOP;
2464                         }
2465                         else {  /* next button switches to new row */
2466                                 
2467                                 if (prev && buts_are_horiz(prev, but))
2468                                         flag |= UI_BUT_ALIGN_LEFT;
2469                                 else {
2470                                         flag &= ~UI_BUT_ALIGN_LEFT;
2471                                         flag |= UI_BUT_ALIGN_TOP;
2472                                 }
2473                                 
2474                                 if ((flag & UI_BUT_ALIGN_TOP) == 0) {  /* stil top row */
2475                                         if (prev) {
2476                                                 if (next && buts_are_horiz(but, next))
2477                                                         flag = UI_BUT_ALIGN_DOWN | UI_BUT_ALIGN_LEFT | UI_BUT_ALIGN_RIGHT;
2478                                                 else {
2479                                                         /* last button in top row */
2480                                                         flag = UI_BUT_ALIGN_DOWN | UI_BUT_ALIGN_LEFT;
2481                                                 }
2482                                         }
2483                                         else 
2484                                                 flag |= UI_BUT_ALIGN_DOWN;
2485                                 }
2486                                 else 
2487                                         flag |= UI_BUT_ALIGN_TOP;
2488                         }
2489                 }
2490                 
2491                 but->flag |= flag;
2492                 
2493                 /* merge coordinates */
2494                 if (prev) {
2495                         /* simple cases */
2496                         if (rows == 0) {
2497                                 but->rect.xmin = (prev->rect.xmax + but->rect.xmin) / 2.0f;
2498                                 prev->rect.xmax = but->rect.xmin;
2499                         }
2500                         else if (cols == 0) {
2501                                 but->rect.ymax = (prev->rect.ymin + but->rect.ymax) / 2.0f;
2502                                 prev->rect.ymin = but->rect.ymax;
2503                         }
2504                         else {
2505                                 if (buts_are_horiz(prev, but)) {
2506                                         but->rect.xmin = (prev->rect.xmax + but->rect.xmin) / 2.0f;
2507                                         prev->rect.xmax = but->rect.xmin;
2508                                         /* copy height too */
2509                                         but->rect.ymax = prev->rect.ymax;
2510                                 }
2511                                 else if (prev->prev && buts_are_horiz(prev->prev, prev) == 0) {
2512                                         /* the previous button is a single one in its row */
2513                                         but->rect.ymax = (prev->rect.ymin + but->rect.ymax) / 2.0f;
2514                                         prev->rect.ymin = but->rect.ymax;
2515                                         
2516                                         but->rect.xmin = prev->rect.xmin;
2517                                         if (next && buts_are_horiz(but, next) == 0)
2518                                                 but->rect.xmax = prev->rect.xmax;
2519                                 }
2520                                 else {
2521                                         /* the previous button is not a single one in its row */
2522                                         but->rect.ymax = prev->rect.ymin;
2523                                 }
2524                         }
2525                 }
2526         }
2527 }
2528
2529 void ui_block_do_align(uiBlock *block)
2530 {
2531         uiBut *but;
2532         short nr;
2533
2534         /* align buttons with same align nr */
2535         for (but = block->buttons.first; but; ) {
2536                 if (but->alignnr) {
2537                         nr = but->alignnr;
2538                         ui_block_do_align_but(but, nr);
2539
2540                         /* skip with same number */
2541                         for (; but && but->alignnr == nr; but = but->next) ;
2542
2543                         if (!but)
2544                                 break;
2545                 }
2546                 else
2547                         but = but->next;
2548         }
2549 }
2550
2551 /**
2552  * \brief ui_def_but is the function that draws many button types
2553  *
2554  * \param x,y The lower left hand corner of the button (X axis)
2555  * \param width,height The size of the button.
2556  *
2557  * for float buttons:
2558  * - \a a1 Click Step (how much to change the value each click)
2559  * - \a a2 Number of decimal point values to display. 0 defaults to 3 (0.000)
2560  *      1,2,3, and a maximum of 4, all greater values will be clamped to 4.
2561  */
2562 static uiBut *ui_def_but(uiBlock *block, int type, int retval, const char *str,
2563                          int x, int y, short width, short height,
2564                          void *poin, float min, float max, float a1, float a2, const char *tip)
2565 {
2566         uiBut *but;
2567         int slen;
2568         
2569         if (type & BUTPOIN) {       /* a pointer is required */
2570                 if (poin == NULL)
2571                         return NULL;
2572         }
2573
2574         but = MEM_callocN(sizeof(uiBut), "uiBut");
2575
2576         but->type = type & BUTTYPE;
2577         but->pointype = type & BUTPOIN;
2578         but->bit = type & BIT;
2579         but->bitnr = type & 31;
2580         but->icon = ICON_NONE;
2581         but->iconadd = 0;
2582
2583         but->retval = retval;
2584
2585         slen = strlen(str);
2586         if (slen >= UI_MAX_NAME_STR - 1) {
2587                 but->str = MEM_mallocN(slen + 2, "ui_def_but str"); /* why +2 ? */
2588         }
2589         else {
2590                 but->str = but->strdata;
2591         }
2592         memcpy(but->str, str, slen + 1);
2593
2594         but->rect.xmin = x;
2595         but->rect.ymin = y;
2596         but->rect.xmax = but->rect.xmin + width;
2597         but->rect.ymax = but->rect.ymin + height;
2598
2599         but->poin = poin;
2600         but->hardmin = but->softmin = min;
2601         but->hardmax = but->softmax = max;
2602         but->a1 = a1;
2603         but->a2 = a2;
2604         but->tip = tip;
2605
2606         but->lock = block->lock;
2607         but->lockstr = block->lockstr;
2608         but->dt = block->dt;
2609
2610         but->aspect = 1.0f;  /* XXX block->aspect; */
2611         but->block = block;  /* pointer back, used for frontbuffer status, and picker */
2612
2613         if ((block->flag & UI_BUT_ALIGN) && ui_but_can_align(but))
2614                 but->alignnr = block->alignnr;
2615
2616         but->func = block->func;
2617         but->func_arg1 = block->func_arg1;
2618         but->func_arg2 = block->func_arg2;
2619
2620         but->funcN = block->funcN;
2621         if (block->func_argN)
2622                 but->func_argN = MEM_dupallocN(block->func_argN);
2623         
2624         but->pos = -1;   /* cursor invisible */
2625
2626         if (ELEM4(but->type, NUM, NUMABS, NUMSLI, HSVSLI)) {    /* add a space to name */
2627                 /* slen remains unchanged from previous assignment, ensure this stays true */
2628                 if (slen > 0 && slen < UI_MAX_NAME_STR - 2) {
2629                         if (but->str[slen - 1] != ' ') {
2630                                 but->str[slen] = ' ';
2631                                 but->str[slen + 1] = 0;
2632                         }
2633                 }
2634         }
2635
2636         if ((block->flag & UI_BLOCK_LOOP) ||
2637             ELEM8(but->type, MENU, TEX, LABEL, IDPOIN, BLOCK, BUTM, SEARCH_MENU, PROGRESSBAR))
2638         {
2639                 but->flag |= (UI_TEXT_LEFT | UI_ICON_LEFT);
2640         }
2641         else if (but->type == BUT_TOGDUAL) {
2642                 but->flag |= UI_ICON_LEFT;
2643         }
2644
2645         but->flag |= (block->flag & UI_BUT_ALIGN);
2646
2647         if (but->lock == TRUE) {
2648                 if (but->lockstr) {
2649                         but->flag |= UI_BUT_DISABLED;
2650                 }
2651         }
2652
2653         /* keep track of UI_interface.h */
2654         if (ELEM7(but->type, BLOCK, BUT, LABEL, PULLDOWN, ROUNDBOX, LISTBOX, BUTM)) ;
2655         else if (ELEM(but->type, SCROLL, SEPR /* , FTPREVIEW */ )) ;
2656         else if (but->type >= SEARCH_MENU) ;
2657         else but->flag |= UI_BUT_UNDO;
2658
2659         BLI_addtail(&block->buttons, but);
2660         
2661         if (block->curlayout)
2662                 ui_layout_add_but(block->curlayout, but);
2663
2664 #ifdef WITH_PYTHON
2665         /* if the 'UI_OT_editsource' is running, extract the source info from the button  */
2666         if (UI_editsource_enable_check()) {
2667                 UI_editsource_active_but_test(but);
2668         }
2669 #endif
2670
2671         return but;
2672 }
2673
2674 /* ui_def_but_rna_propname and ui_def_but_rna
2675  * both take the same args except for propname vs prop, this is done so we can
2676  * avoid an extra lookup on 'prop' when its already available.
2677  *
2678  * When this kind of change won't disrupt branches, best look into making more
2679  * of our UI functions take prop rather then propname.
2680  */
2681
2682 #define UI_DEF_BUT_RNA_DISABLE(but)  { \
2683                 but->flag |= UI_BUT_DISABLED;  \
2684                 but->lock = TRUE;              \
2685                 but->lockstr = "";             \
2686         } (void)0
2687
2688
2689 static uiBut *ui_def_but_rna(uiBlock *block, int type, int retval, const char *str,
2690                                                          int x, int y, short width, short height,
2691                              PointerRNA *ptr, PropertyRNA *prop, int index,
2692                              float min, float max, float a1, float a2,  const char *tip)
2693 {
2694         const PropertyType proptype = RNA_property_type(prop);
2695         uiBut *but;
2696         int freestr = 0, icon = 0;
2697
2698         /* use rna values if parameters are not specified */
2699         if (!str) {
2700                 if (type == MENU && proptype == PROP_ENUM) {
2701                         EnumPropertyItem *item;
2702                         DynStr *dynstr;
2703                         int i, totitem, value, free;
2704
2705                         RNA_property_enum_items_gettexted(block->evil_C, ptr, prop, &item, &totitem, &free);
2706                         value = RNA_property_enum_get(ptr, prop);
2707
2708                         dynstr = BLI_dynstr_new();
2709                         BLI_dynstr_appendf(dynstr, "%s%%t", RNA_property_ui_name(prop));
2710                         for (i = 0; i < totitem; i++) {
2711                                 if (!item[i].identifier[0]) {
2712                                         if (item[i].name)
2713                                                 BLI_dynstr_appendf(dynstr, "|%s%%l", item[i].name);
2714                                         else
2715                                                 BLI_dynstr_append(dynstr, "|%l");
2716                                 }
2717                                 else if (item[i].icon)
2718                                         BLI_dynstr_appendf(dynstr, "|%s %%i%d %%x%d", item[i].name, item[i].icon, item[i].value);
2719                                 else
2720                                         BLI_dynstr_appendf(dynstr, "|%s %%x%d", item[i].name, item[i].value);
2721
2722                                 if (value == item[i].value)
2723                                         icon = item[i].icon;
2724                         }
2725                         str = BLI_dynstr_get_cstring(dynstr);
2726                         BLI_dynstr_free(dynstr);
2727
2728                         if (free) {
2729                                 MEM_freeN(item);
2730                         }
2731
2732                         freestr = 1;
2733                 }
2734                 else if (ELEM(type, ROW, LISTROW) && proptype == PROP_ENUM) {
2735                         EnumPropertyItem *item;
2736                         int i, totitem, free;
2737
2738                         RNA_property_enum_items_gettexted(block->evil_C, ptr, prop, &item, &totitem, &free);
2739                         for (i = 0; i < totitem; i++) {
2740                                 if (item[i].identifier[0] && item[i].value == (int)max) {
2741                                         str = item[i].name;
2742                                         icon = item[i].icon;
2743                                 }
2744                         }
2745
2746                         if (!str) {
2747                                 str = RNA_property_ui_name(prop);
2748                         }
2749                         if (free) {
2750                                 MEM_freeN(item);
2751                         }
2752                 }
2753                 else {
2754                         str = RNA_property_ui_name(prop);
2755                         icon = RNA_property_ui_icon(prop);
2756                 }
2757         }
2758
2759         if (!tip && proptype != PROP_ENUM)
2760                 tip = RNA_property_ui_description(prop);
2761
2762         if (min == max || a1 == -1 || a2 == -1) {
2763                 if (proptype == PROP_INT) {
2764                         int hardmin, hardmax, softmin, softmax, step;
2765
2766                         RNA_property_int_range(ptr, prop, &hardmin, &hardmax);
2767                         RNA_property_int_ui_range(ptr, prop, &softmin, &softmax, &step);
2768
2769                         if (!ELEM(type, ROW, LISTROW) && min == max) {
2770                                 min = hardmin;
2771                                 max = hardmax;
2772                         }
2773                         if (a1 == -1)
2774                                 a1 = step;
2775                         if (a2 == -1)
2776                                 a2 = 0;
2777                 }
2778                 else if (proptype == PROP_FLOAT) {
2779                         float hardmin, hardmax, softmin, softmax, step, precision;
2780
2781                         RNA_property_float_range(ptr, prop, &hardmin, &hardmax);
2782                         RNA_property_float_ui_range(ptr, prop, &softmin, &softmax, &step, &precision);
2783
2784                         if (!ELEM(type, ROW, LISTROW) && min == max) {
2785                                 min = hardmin;
2786                                 max = hardmax;
2787                         }
2788                         if (a1 == -1)
2789                                 a1 = step;
2790                         if (a2 == -1)
2791                                 a2 = precision;
2792                 }
2793                 else if (proptype == PROP_STRING) {
2794                         min = 0;
2795                         max = RNA_property_string_maxlength(prop);
2796                         if (max == 0) /* interface code should ideally support unlimited length */
2797                                 max = UI_MAX_DRAW_STR;
2798                 }
2799         }
2800
2801         /* now create button */
2802         but = ui_def_but(block, type, retval, str, x, y, width, height, NULL, min, max, a1, a2, tip);
2803
2804         but->rnapoin = *ptr;
2805         but->rnaprop = prop;
2806
2807         if (RNA_property_array_length(&but->rnapoin, but->rnaprop))
2808                 but->rnaindex = index;
2809         else
2810                 but->rnaindex = 0;
2811
2812         if (icon) {
2813                 but->icon = (BIFIconID)icon;
2814                 but->flag |= UI_HAS_ICON;
2815                 but->flag |= UI_ICON_LEFT;
2816         }
2817         
2818         if (!RNA_property_editable(&but->rnapoin, prop)) {
2819                 UI_DEF_BUT_RNA_DISABLE(but);
2820         }
2821
2822         if (but->flag & UI_BUT_UNDO && (ui_but_is_rna_undo(but) == FALSE)) {
2823                 but->flag &= ~UI_BUT_UNDO;
2824         }
2825
2826         /* If this button uses units, calculate the step from this */
2827         if ((proptype == PROP_FLOAT) && ui_is_but_unit(but)) {
2828                 but->a1 = ui_get_but_step_unit(but, but->a1);
2829         }
2830
2831         if (freestr) {
2832                 MEM_freeN((void *)str);
2833         }
2834
2835         return but;
2836 }
2837
2838 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)
2839 {
2840         PropertyRNA *prop = RNA_struct_find_property(ptr, propname);
2841         uiBut *but;
2842
2843         if (prop) {
2844                 but = ui_def_but_rna(block, type, retval, str, x, y, width, height, ptr, prop, index, min, max, a1, a2,  tip);
2845         }
2846         else {
2847                 but = ui_def_but(block, type, retval, propname, x, y, width, height, NULL, min, max, a1, a2, tip);
2848
2849                 UI_DEF_BUT_RNA_DISABLE(but);
2850         }
2851
2852         return but;
2853 }
2854
2855 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)
2856 {
2857         uiBut *but;
2858
2859         if (!str) {
2860                 if (ot && ot->srna)
2861                         str = RNA_struct_ui_name(ot->srna);
2862                 else
2863                         str = "";
2864         }
2865
2866         if ((!tip || tip[0] == '\0') && ot && ot->srna) {
2867                 tip = RNA_struct_ui_description(ot->srna);
2868         }
2869
2870         but = ui_def_but(block, type, -1, str, x, y, width, height, NULL, 0, 0, 0, 0, tip);
2871         but->optype = ot;
2872         but->opcontext = opcontext;
2873         but->flag &= ~UI_BUT_UNDO; /* no need for ui_but_is_undo(), we never need undo here */
2874
2875         if (!ot) {
2876                 but->flag |= UI_BUT_DISABLED;
2877                 but->lock = TRUE;
2878                 but->lockstr = "";
2879         }
2880
2881         return but;
2882 }
2883
2884 #if 0 /* UNUSED */
2885 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)
2886 {
2887         wmOperatorType *ot = WM_operatortype_find(opname, 0);
2888         if (str == NULL && ot == NULL) str = opname;
2889         return ui_def_but_operator_ptr(block, type, ot, opcontext, str, x, y, width, height, tip);
2890 }
2891 #endif
2892
2893 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)
2894 {
2895         uiBut *but;
2896         wmOperatorType *ot;
2897         
2898         ot = WM_operatortype_find(opname, 0);
2899
2900         if (!str) {
2901                 if (ot) str = ot->name;
2902                 else str = opname;
2903         }
2904         
2905         if ((!tip || tip[0] == '\0') && ot && ot->description) {
2906                 tip = ot->description;
2907         }
2908
2909         but = ui_def_but(block, type, -1, str, x, y, width, height, poin, min, max, a1, a2, tip);
2910         but->optype = ot;
2911         but->opcontext = opcontext;
2912         but->flag &= ~UI_BUT_UNDO; /* no need for ui_but_is_undo(), we never need undo here */
2913
2914         if (!ot) {
2915                 but->flag |= UI_BUT_DISABLED;
2916                 but->lock = TRUE;
2917                 but->lockstr = "";
2918         }
2919
2920         return but;
2921 }
2922
2923 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)
2924 {
2925         uiBut *but = ui_def_but(block, type, retval, str, x, y, width, height, poin, min, max, a1, a2, tip);
2926
2927         ui_check_but(but);
2928         
2929         return but;
2930 }
2931
2932 /* if _x_ is a power of two (only one bit) return the power,
2933  * otherwise return -1.
2934  * (1<<findBitIndex(x))==x for powers of two.
2935  */
2936 static int findBitIndex(unsigned int x)
2937 {
2938         if (!x || !is_power_of_2_i(x)) { /* is_power_of_2_i(x) strips lowest bit */
2939                 return -1;
2940         }
2941         else {
2942                 int idx = 0;
2943
2944                 if (x & 0xFFFF0000) idx += 16, x >>= 16;
2945                 if (x & 0xFF00) idx += 8, x >>= 8;
2946                 if (x & 0xF0) idx += 4, x >>= 4;
2947                 if (x & 0xC) idx += 2, x >>= 2;
2948                 if (x & 0x2) idx += 1;
2949
2950                 return idx;
2951         }
2952 }
2953
2954 /* autocomplete helper functions */
2955 struct AutoComplete {
2956         size_t maxlen;
2957         char *truncate;
2958         const char *startname;
2959 };
2960
2961 AutoComplete *autocomplete_begin(const char *startname, size_t maxlen)
2962 {
2963         AutoComplete *autocpl;
2964         
2965         autocpl = MEM_callocN(sizeof(AutoComplete), "AutoComplete");
2966         autocpl->maxlen = maxlen;
2967         autocpl->truncate = MEM_callocN(sizeof(char) * maxlen, "AutoCompleteTruncate");
2968         autocpl->startname = startname;
2969
2970         return autocpl;
2971 }
2972
2973 void autocomplete_do_name(AutoComplete *autocpl, const char *name)
2974 {
2975         char *truncate = autocpl->truncate;
2976         const char *startname = autocpl->startname;
2977         int a;
2978
2979         for (a = 0; a < autocpl->maxlen - 1; a++) {
2980                 if (startname[a] == 0 || startname[a] != name[a])
2981                         break;
2982         }
2983         /* found a match */
2984         if (startname[a] == 0) {
2985                 /* first match */
2986                 if (truncate[0] == 0)
2987                         BLI_strncpy(truncate, name, autocpl->maxlen);
2988                 else {
2989                         /* remove from truncate what is not in bone->name */
2990                         for (a = 0; a < autocpl->maxlen - 1; a++) {
2991                                 if (name[a] == 0) {
2992                                         truncate[a] = 0;
2993                                         break;
2994                                 }
2995                                 else if (truncate[a] != name[a])
2996                                         truncate[a] = 0;
2997                         }
2998                 }
2999         }
3000 }
3001
3002 void autocomplete_end(AutoComplete *autocpl, char *autoname)
3003 {       
3004         if (autocpl->truncate[0])
3005                 BLI_strncpy(autoname, autocpl->truncate, autocpl->maxlen);
3006         else {
3007                 if (autoname != autocpl->startname) /* don't copy a string over its self */
3008                         BLI_strncpy(autoname, autocpl->startname, autocpl->maxlen);
3009         }
3010         MEM_freeN(autocpl->truncate);
3011         MEM_freeN(autocpl);
3012 }
3013
3014 /* autocomplete callback for ID buttons */
3015 static void autocomplete_id(bContext *C, char *str, void *arg_v)
3016 {
3017         int blocktype = (intptr_t)arg_v;
3018         ListBase *listb = which_libbase(CTX_data_main(C), blocktype);
3019         
3020         if (listb == NULL) return;
3021         
3022         /* search if str matches the beginning of an ID struct */
3023         if (str[0]) {
3024                 AutoComplete *autocpl = autocomplete_begin(str, MAX_ID_NAME - 2);
3025                 ID *id;
3026                 
3027                 for (id = listb->first; id; id = id->next)
3028                         autocomplete_do_name(autocpl, id->name + 2);
3029
3030                 autocomplete_end(autocpl, str);
3031         }
3032 }
3033
3034 static void ui_check_but_and_iconize(uiBut *but, int icon)
3035 {
3036         if (icon) {
3037                 but->icon = (BIFIconID) icon;
3038                 but->flag |= UI_HAS_ICON;
3039         }
3040
3041         ui_check_but(but);
3042 }
3043
3044 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)
3045 {
3046         int bitIdx = findBitIndex(bit);
3047         if (bitIdx == -1) {
3048                 return NULL;
3049         }
3050         else {
3051                 return uiDefBut(block, type | BIT | bitIdx, retval, str, x, y, width, height, poin, min, max, a1, a2, tip);
3052         }
3053 }
3054 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)
3055 {
3056         return uiDefBut(block, type | FLO, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3057 }
3058 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)
3059 {
3060         return uiDefButBit(block, type | FLO, bit, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3061 }
3062 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)
3063 {
3064         return uiDefBut(block, type | INT, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3065 }
3066 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)
3067 {
3068         return uiDefButBit(block, type | INT, bit, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3069 }
3070 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)
3071 {
3072         return uiDefBut(block, type | SHO, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3073 }
3074 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)
3075 {
3076         return uiDefButBit(block, type | SHO, bit, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3077 }
3078 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)
3079 {
3080         return uiDefBut(block, type | CHA, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);
3081 }
3082 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)
3083 {
3084         return uiDefButBit(block, type | CHA, bit, retval, str, x, y, width, height, (void *) poin, min, max, a1, a2, tip);