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