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