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