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