Code cleanup: remove TRUE/FALSE & WITH_BOOL_COMPAT define
[blender.git] / source / blender / makesrna / intern / rna_ui.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  * Contributor(s): Blender Foundation (2009)
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_ui.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29
30 #include "DNA_screen_types.h"
31
32 #include "BLF_translation.h"
33
34 #include "BKE_idprop.h"
35
36 #include "RNA_define.h"
37
38 #include "rna_internal.h"
39 #include "RNA_enum_types.h"
40
41 #include "UI_interface.h"
42
43 #include "WM_types.h"
44
45 /* see WM_types.h */
46 EnumPropertyItem operator_context_items[] = {
47         {WM_OP_INVOKE_DEFAULT, "INVOKE_DEFAULT", 0, "Invoke Default", ""},
48         {WM_OP_INVOKE_REGION_WIN, "INVOKE_REGION_WIN", 0, "Invoke Region Window", ""},
49         {WM_OP_INVOKE_REGION_CHANNELS, "INVOKE_REGION_CHANNELS", 0, "Invoke Region Channels", ""},
50         {WM_OP_INVOKE_REGION_PREVIEW, "INVOKE_REGION_PREVIEW", 0, "Invoke Region Preview", ""},
51         {WM_OP_INVOKE_AREA, "INVOKE_AREA", 0, "Invoke Area", ""},
52         {WM_OP_INVOKE_SCREEN, "INVOKE_SCREEN", 0, "Invoke Screen", ""},
53         {WM_OP_EXEC_DEFAULT, "EXEC_DEFAULT", 0, "Exec Default", ""},
54         {WM_OP_EXEC_REGION_WIN, "EXEC_REGION_WIN", 0, "Exec Region Window", ""},
55         {WM_OP_EXEC_REGION_CHANNELS, "EXEC_REGION_CHANNELS", 0, "Exec Region Channels", ""},
56         {WM_OP_EXEC_REGION_PREVIEW, "EXEC_REGION_PREVIEW", 0, "Exec Region Preview", ""},
57         {WM_OP_EXEC_AREA, "EXEC_AREA", 0, "Exec Area", ""},
58         {WM_OP_EXEC_SCREEN, "EXEC_SCREEN", 0, "Exec Screen", ""},
59         {0, NULL, 0, NULL, NULL}
60 };
61
62 EnumPropertyItem uilist_layout_type_items[] = {
63         {UILST_LAYOUT_DEFAULT, "DEFAULT", 0, "Default Layout", "Use the default, multi-rows layout"},
64         {UILST_LAYOUT_COMPACT, "COMPACT", 0, "Compact Layout", "Use the compact, single-row layout"},
65         {UILST_LAYOUT_GRID, "GRID", 0, "Grid Layout", "Use the grid-based layout"},
66         {0, NULL, 0, NULL, NULL}
67 };
68
69 #ifdef RNA_RUNTIME
70
71 #include <assert.h>
72
73 #include "MEM_guardedalloc.h"
74
75 #include "RNA_access.h"
76
77 #include "BLI_dynstr.h"
78
79 #include "BKE_context.h"
80 #include "BKE_report.h"
81 #include "BKE_screen.h"
82
83 #include "WM_api.h"
84
85 static ARegionType *region_type_find(ReportList *reports, int space_type, int region_type)
86 {
87         SpaceType *st;
88         ARegionType *art;
89
90         st = BKE_spacetype_from_id(space_type);
91
92         for (art = (st) ? st->regiontypes.first : NULL; art; art = art->next) {
93                 if (art->regionid == region_type)
94                         break;
95         }
96         
97         /* region type not found? abort */
98         if (art == NULL) {
99                 BKE_report(reports, RPT_ERROR, "Region not found in space type");
100                 return NULL;
101         }
102
103         return art;
104 }
105
106 /* Panel */
107
108 static int panel_poll(const bContext *C, PanelType *pt)
109 {
110         extern FunctionRNA rna_Panel_poll_func;
111
112         PointerRNA ptr;
113         ParameterList list;
114         FunctionRNA *func;
115         void *ret;
116         int visible;
117
118         RNA_pointer_create(NULL, pt->ext.srna, NULL, &ptr); /* dummy */
119         func = &rna_Panel_poll_func; /* RNA_struct_find_function(&ptr, "poll"); */
120
121         RNA_parameter_list_create(&list, &ptr, func);
122         RNA_parameter_set_lookup(&list, "context", &C);
123         pt->ext.call((bContext *)C, &ptr, func, &list);
124
125         RNA_parameter_get_lookup(&list, "visible", &ret);
126         visible = *(int *)ret;
127
128         RNA_parameter_list_free(&list);
129
130         return visible;
131 }
132
133 static void panel_draw(const bContext *C, Panel *pnl)
134 {
135         extern FunctionRNA rna_Panel_draw_func;
136
137         PointerRNA ptr;
138         ParameterList list;
139         FunctionRNA *func;
140
141         RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->ext.srna, pnl, &ptr);
142         func = &rna_Panel_draw_func; /* RNA_struct_find_function(&ptr, "draw"); */
143
144         RNA_parameter_list_create(&list, &ptr, func);
145         RNA_parameter_set_lookup(&list, "context", &C);
146         pnl->type->ext.call((bContext *)C, &ptr, func, &list);
147
148         RNA_parameter_list_free(&list);
149 }
150
151 static void panel_draw_header(const bContext *C, Panel *pnl)
152 {
153         extern FunctionRNA rna_Panel_draw_header_func;
154
155         PointerRNA ptr;
156         ParameterList list;
157         FunctionRNA *func;
158
159         RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->ext.srna, pnl, &ptr);
160         func = &rna_Panel_draw_header_func; /* RNA_struct_find_function(&ptr, "draw_header"); */
161
162         RNA_parameter_list_create(&list, &ptr, func);
163         RNA_parameter_set_lookup(&list, "context", &C);
164         pnl->type->ext.call((bContext *)C, &ptr, func, &list);
165
166         RNA_parameter_list_free(&list);
167 }
168
169 static void rna_Panel_unregister(Main *UNUSED(bmain), StructRNA *type)
170 {
171         ARegionType *art;
172         PanelType *pt = RNA_struct_blender_type_get(type);
173
174         if (!pt)
175                 return;
176         if (!(art = region_type_find(NULL, pt->space_type, pt->region_type)))
177                 return;
178         
179         RNA_struct_free_extension(type, &pt->ext);
180
181         BLI_freelinkN(&art->paneltypes, pt);
182         RNA_struct_free(&BLENDER_RNA, type);
183
184         /* update while blender is running */
185         WM_main_add_notifier(NC_WINDOW, NULL);
186 }
187
188 static StructRNA *rna_Panel_register(Main *bmain, ReportList *reports, void *data, const char *identifier,
189                                      StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
190 {
191         ARegionType *art;
192         PanelType *pt, dummypt = {NULL};
193         Panel dummypanel = {NULL};
194         PointerRNA dummyptr;
195         int have_function[3];
196
197         /* setup dummy panel & panel type to store static properties in */
198         dummypanel.type = &dummypt;
199         RNA_pointer_create(NULL, &RNA_Panel, &dummypanel, &dummyptr);
200
201         /* We have to set default context! Else we get a void string... */
202         strcpy(dummypt.translation_context, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
203
204         /* validate the python class */
205         if (validate(&dummyptr, data, have_function) != 0)
206                 return NULL;
207                 
208         if (strlen(identifier) >= sizeof(dummypt.idname)) {
209                 BKE_reportf(reports, RPT_ERROR, "Registering panel class: '%s' is too long, maximum length is %d",
210                             identifier, (int)sizeof(dummypt.idname));
211                 return NULL;
212         }
213         
214         if (!(art = region_type_find(reports, dummypt.space_type, dummypt.region_type)))
215                 return NULL;
216
217         /* check if we have registered this panel type before, and remove it */
218         for (pt = art->paneltypes.first; pt; pt = pt->next) {
219                 if (strcmp(pt->idname, dummypt.idname) == 0) {
220                         if (pt->ext.srna)
221                                 rna_Panel_unregister(bmain, pt->ext.srna);
222                         else
223                                 BLI_freelinkN(&art->paneltypes, pt);
224                         break;
225                 }
226         }
227         
228         /* create a new panel type */
229         pt = MEM_callocN(sizeof(PanelType), "python buttons panel");
230         memcpy(pt, &dummypt, sizeof(dummypt));
231
232         pt->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, pt->idname, &RNA_Panel);
233         RNA_def_struct_translation_context(pt->ext.srna, pt->translation_context);
234         pt->ext.data = data;
235         pt->ext.call = call;
236         pt->ext.free = free;
237         RNA_struct_blender_type_set(pt->ext.srna, pt);
238         RNA_def_struct_flag(pt->ext.srna, STRUCT_NO_IDPROPERTIES);
239
240         pt->poll = (have_function[0]) ? panel_poll : NULL;
241         pt->draw = (have_function[1]) ? panel_draw : NULL;
242         pt->draw_header = (have_function[2]) ? panel_draw_header : NULL;
243
244         /* XXX use "no header" flag for some ordering of panels until we have real panel ordering */
245         if (pt->flag & PNL_NO_HEADER) {
246                 PanelType *pth = art->paneltypes.first;
247                 while (pth && pth->flag & PNL_NO_HEADER)
248                         pth = pth->next;
249
250                 if (pth)
251                         BLI_insertlinkbefore(&art->paneltypes, pth, pt);
252                 else
253                         BLI_addtail(&art->paneltypes, pt);
254         }
255         else
256                 BLI_addtail(&art->paneltypes, pt);
257
258         /* update while blender is running */
259         WM_main_add_notifier(NC_WINDOW, NULL);
260         
261         return pt->ext.srna;
262 }
263
264 static StructRNA *rna_Panel_refine(PointerRNA *ptr)
265 {
266         Panel *hdr = (Panel *)ptr->data;
267         return (hdr->type && hdr->type->ext.srna) ? hdr->type->ext.srna : &RNA_Panel;
268 }
269
270 /* UIList */
271 static unsigned int rna_UIList_filter_const_FILTER_ITEM_get(PointerRNA *UNUSED(ptr))
272 {
273         return UILST_FLT_ITEM;
274 }
275
276 static IDProperty *rna_UIList_idprops(PointerRNA *ptr, bool create)
277 {
278         uiList *ui_list = (uiList *)ptr->data;
279         if (create && !ui_list->properties) {
280                 IDPropertyTemplate val = {0};
281                 ui_list->properties = IDP_New(IDP_GROUP, &val, "RNA_UIList IDproperties group");
282         }
283
284         return ui_list->properties;
285 }
286
287 static void uilist_draw_item(uiList *ui_list, bContext *C, uiLayout *layout, PointerRNA *dataptr, PointerRNA *itemptr,
288                              int icon, PointerRNA *active_dataptr, const char *active_propname, int index, int flt_flag)
289 {
290         extern FunctionRNA rna_UIList_draw_item_func;
291
292         PointerRNA ul_ptr;
293         ParameterList list;
294         FunctionRNA *func;
295
296         RNA_pointer_create(&CTX_wm_screen(C)->id, ui_list->type->ext.srna, ui_list, &ul_ptr);
297         func = &rna_UIList_draw_item_func; /* RNA_struct_find_function(&ul_ptr, "draw_item"); */
298
299         RNA_parameter_list_create(&list, &ul_ptr, func);
300         RNA_parameter_set_lookup(&list, "context", &C);
301         RNA_parameter_set_lookup(&list, "layout", &layout);
302         RNA_parameter_set_lookup(&list, "data", dataptr);
303         RNA_parameter_set_lookup(&list, "item", itemptr);
304         RNA_parameter_set_lookup(&list, "icon", &icon);
305         RNA_parameter_set_lookup(&list, "active_data", active_dataptr);
306         RNA_parameter_set_lookup(&list, "active_property", &active_propname);
307         RNA_parameter_set_lookup(&list, "index", &index);
308         RNA_parameter_set_lookup(&list, "flt_flag", &flt_flag);
309         ui_list->type->ext.call((bContext *)C, &ul_ptr, func, &list);
310
311         RNA_parameter_list_free(&list);
312 }
313
314 static void uilist_draw_filter(uiList *ui_list, bContext *C, uiLayout *layout)
315 {
316         extern FunctionRNA rna_UIList_draw_filter_func;
317
318         PointerRNA ul_ptr;
319         ParameterList list;
320         FunctionRNA *func;
321
322         RNA_pointer_create(&CTX_wm_screen(C)->id, ui_list->type->ext.srna, ui_list, &ul_ptr);
323         func = &rna_UIList_draw_filter_func; /* RNA_struct_find_function(&ul_ptr, "draw_filter"); */
324
325         RNA_parameter_list_create(&list, &ul_ptr, func);
326         RNA_parameter_set_lookup(&list, "context", &C);
327         RNA_parameter_set_lookup(&list, "layout", &layout);
328         ui_list->type->ext.call((bContext *)C, &ul_ptr, func, &list);
329
330         RNA_parameter_list_free(&list);
331 }
332
333 static void uilist_filter_items(uiList *ui_list, bContext *C, PointerRNA *dataptr, const char *propname)
334 {
335         extern FunctionRNA rna_UIList_filter_items_func;
336
337         PointerRNA ul_ptr;
338         ParameterList list;
339         FunctionRNA *func;
340         PropertyRNA *parm;
341
342         uiListDyn *flt_data = ui_list->dyn_data;
343         int *filter_flags, *filter_neworder;
344         void *ret1, *ret2;
345         int ret_len;
346         int len = flt_data->items_len = RNA_collection_length(dataptr, propname);
347
348         RNA_pointer_create(&CTX_wm_screen(C)->id, ui_list->type->ext.srna, ui_list, &ul_ptr);
349         func = &rna_UIList_filter_items_func; /* RNA_struct_find_function(&ul_ptr, "filter_items"); */
350
351         RNA_parameter_list_create(&list, &ul_ptr, func);
352         RNA_parameter_set_lookup(&list, "context", &C);
353         RNA_parameter_set_lookup(&list, "data", dataptr);
354         RNA_parameter_set_lookup(&list, "property", &propname);
355
356         ui_list->type->ext.call((bContext *)C, &ul_ptr, func, &list);
357
358         parm = RNA_function_find_parameter(NULL, func, "filter_flags");
359         ret_len = RNA_parameter_dynamic_length_get(&list, parm);
360         if (ret_len != len && ret_len != 0) {
361                 printf("%s: Error, py func returned %d items in %s, %d or none were expected.\n", __func__,
362                        RNA_parameter_dynamic_length_get(&list, parm), "filter_flags", len);
363                 /* Note: we cannot return here, we would let flt_data in inconsistent state... see T38356. */
364                 filter_flags = NULL;
365         }
366         else {
367                 RNA_parameter_get(&list, parm, &ret1);
368                 filter_flags = (int *)ret1;
369         }
370
371         parm = RNA_function_find_parameter(NULL, func, "filter_neworder");
372         ret_len = RNA_parameter_dynamic_length_get(&list, parm);
373         if (ret_len != len && ret_len != 0) {
374                 printf("%s: Error, py func returned %d items in %s, %d or none were expected.\n", __func__,
375                        RNA_parameter_dynamic_length_get(&list, parm), "filter_neworder", len);
376                 /* Note: we cannot return here, we would let flt_data in inconsistent state... see T38356. */
377                 filter_neworder = NULL;
378         }
379         else {
380                 RNA_parameter_get(&list, parm, &ret2);
381                 filter_neworder = (int *)ret2;
382         }
383
384         /* We have to do some final checks and transforms... */
385         {
386                 int i, filter_exclude = ui_list->filter_flag & UILST_FLT_EXCLUDE;
387                 if (filter_flags) {
388                         flt_data->items_filter_flags = MEM_mallocN(sizeof(int) * len, __func__);
389                         memcpy(flt_data->items_filter_flags, filter_flags, sizeof(int) * len);
390
391                         if (filter_neworder) {
392                                 /* For sake of simplicity, py filtering is expected to filter all items, but we actually only want
393                                  * reordering data for shown items!
394                                  */
395                                 int items_shown, shown_idx;
396                                 int t_idx, t_ni, prev_ni;
397                                 flt_data->items_shown = 0;
398                                 for (i = 0, shown_idx = 0; i < len; i++) {
399                                         if ((filter_flags[i] & UILST_FLT_ITEM) ^ filter_exclude) {
400                                                 filter_neworder[shown_idx++] = filter_neworder[i];
401                                         }
402                                 }
403                                 items_shown = flt_data->items_shown = shown_idx;
404                                 flt_data->items_filter_neworder = MEM_mallocN(sizeof(int) * items_shown, __func__);
405                                 /* And now, bring back new indices into the [0, items_shown[ range!
406                                  * XXX This is O(N²)... :/
407                                  */
408                                 for (shown_idx = 0, prev_ni = -1; shown_idx < items_shown; shown_idx++) {
409                                         for (i = 0, t_ni = len, t_idx = -1; i < items_shown; i++) {
410                                                 int ni = filter_neworder[i];
411                                                 if (ni > prev_ni && ni < t_ni) {
412                                                         t_idx = i;
413                                                         t_ni = ni;
414                                                 }
415                                         }
416                                         if (t_idx >= 0) {
417                                                 prev_ni = t_ni;
418                                                 flt_data->items_filter_neworder[t_idx] = shown_idx;
419                                         }
420                                 }
421                         }
422                         else {
423                                 /* we still have to set flt_data->items_shown... */
424                                 flt_data->items_shown = 0;
425                                 for (i = 0; i < len; i++) {
426                                         if ((filter_flags[i] & UILST_FLT_ITEM) ^ filter_exclude) {
427                                                 flt_data->items_shown++;
428                                         }
429                                 }
430                         }
431                 }
432                 else {
433                         flt_data->items_shown = len;
434
435                         if (filter_neworder) {
436                                 flt_data->items_filter_neworder = MEM_mallocN(sizeof(int) * len, __func__);
437                                 memcpy(flt_data->items_filter_neworder, filter_neworder, sizeof(int) * len);
438                         }
439                 }
440         }
441
442         RNA_parameter_list_free(&list);
443 }
444
445 static void rna_UIList_unregister(Main *UNUSED(bmain), StructRNA *type)
446 {
447         uiListType *ult = RNA_struct_blender_type_get(type);
448
449         if (!ult)
450                 return;
451
452         RNA_struct_free_extension(type, &ult->ext);
453
454         WM_uilisttype_freelink(ult);
455
456         RNA_struct_free(&BLENDER_RNA, type);
457
458         /* update while blender is running */
459         WM_main_add_notifier(NC_WINDOW, NULL);
460 }
461
462 static StructRNA *rna_UIList_register(Main *bmain, ReportList *reports, void *data, const char *identifier,
463                                       StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
464 {
465         uiListType *ult, dummyult = {NULL};
466         uiList dummyuilist = {NULL};
467         PointerRNA dummyul_ptr;
468         int have_function[3];
469         size_t over_alloc = 0; /* warning, if this becomes a bess, we better do another alloc */
470
471         /* setup dummy menu & menu type to store static properties in */
472         dummyuilist.type = &dummyult;
473         RNA_pointer_create(NULL, &RNA_UIList, &dummyuilist, &dummyul_ptr);
474
475         /* validate the python class */
476         if (validate(&dummyul_ptr, data, have_function) != 0)
477                 return NULL;
478
479         if (strlen(identifier) >= sizeof(dummyult.idname)) {
480                 BKE_reportf(reports, RPT_ERROR, "Registering uilist class: '%s' is too long, maximum length is %d",
481                             identifier, (int)sizeof(dummyult.idname));
482                 return NULL;
483         }
484
485         /* check if we have registered this uilist type before, and remove it */
486         ult = WM_uilisttype_find(dummyult.idname, true);
487         if (ult && ult->ext.srna)
488                 rna_UIList_unregister(bmain, ult->ext.srna);
489
490         /* create a new menu type */
491         ult = MEM_callocN(sizeof(uiListType) + over_alloc, "python uilist");
492         memcpy(ult, &dummyult, sizeof(dummyult));
493
494         ult->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, ult->idname, &RNA_UIList);
495         ult->ext.data = data;
496         ult->ext.call = call;
497         ult->ext.free = free;
498         RNA_struct_blender_type_set(ult->ext.srna, ult);
499
500         ult->draw_item = (have_function[0]) ? uilist_draw_item : NULL;
501         ult->draw_filter = (have_function[1]) ? uilist_draw_filter : NULL;
502         ult->filter_items = (have_function[2]) ? uilist_filter_items : NULL;
503
504         WM_uilisttype_add(ult);
505
506         /* update while blender is running */
507         WM_main_add_notifier(NC_WINDOW, NULL);
508
509         return ult->ext.srna;
510 }
511
512 static StructRNA *rna_UIList_refine(PointerRNA *ptr)
513 {
514         uiList *ui_list = (uiList *)ptr->data;
515         return (ui_list->type && ui_list->type->ext.srna) ? ui_list->type->ext.srna : &RNA_UIList;
516 }
517
518 /* Header */
519
520 static void header_draw(const bContext *C, Header *hdr)
521 {
522         extern FunctionRNA rna_Header_draw_func;
523
524         PointerRNA htr;
525         ParameterList list;
526         FunctionRNA *func;
527
528         RNA_pointer_create(&CTX_wm_screen(C)->id, hdr->type->ext.srna, hdr, &htr);
529         func = &rna_Header_draw_func; /* RNA_struct_find_function(&htr, "draw"); */
530
531         RNA_parameter_list_create(&list, &htr, func);
532         RNA_parameter_set_lookup(&list, "context", &C);
533         hdr->type->ext.call((bContext *)C, &htr, func, &list);
534
535         RNA_parameter_list_free(&list);
536 }
537
538 static void rna_Header_unregister(Main *UNUSED(bmain), StructRNA *type)
539 {
540         ARegionType *art;
541         HeaderType *ht = RNA_struct_blender_type_get(type);
542
543         if (!ht)
544                 return;
545         if (!(art = region_type_find(NULL, ht->space_type, RGN_TYPE_HEADER)))
546                 return;
547         
548         RNA_struct_free_extension(type, &ht->ext);
549
550         BLI_freelinkN(&art->headertypes, ht);
551         RNA_struct_free(&BLENDER_RNA, type);
552
553         /* update while blender is running */
554         WM_main_add_notifier(NC_WINDOW, NULL);
555 }
556
557 static StructRNA *rna_Header_register(Main *bmain, ReportList *reports, void *data, const char *identifier,
558                                       StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
559 {
560         ARegionType *art;
561         HeaderType *ht, dummyht = {NULL};
562         Header dummyheader = {NULL};
563         PointerRNA dummyhtr;
564         int have_function[1];
565
566         /* setup dummy header & header type to store static properties in */
567         dummyheader.type = &dummyht;
568         RNA_pointer_create(NULL, &RNA_Header, &dummyheader, &dummyhtr);
569
570         /* validate the python class */
571         if (validate(&dummyhtr, data, have_function) != 0)
572                 return NULL;
573
574         if (strlen(identifier) >= sizeof(dummyht.idname)) {
575                 BKE_reportf(reports, RPT_ERROR, "Registering header class: '%s' is too long, maximum length is %d",
576                             identifier, (int)sizeof(dummyht.idname));
577                 return NULL;
578         }
579
580         if (!(art = region_type_find(reports, dummyht.space_type, RGN_TYPE_HEADER)))
581                 return NULL;
582
583         /* check if we have registered this header type before, and remove it */
584         for (ht = art->headertypes.first; ht; ht = ht->next) {
585                 if (strcmp(ht->idname, dummyht.idname) == 0) {
586                         if (ht->ext.srna)
587                                 rna_Header_unregister(bmain, ht->ext.srna);
588                         break;
589                 }
590         }
591         
592         /* create a new header type */
593         ht = MEM_callocN(sizeof(HeaderType), "python buttons header");
594         memcpy(ht, &dummyht, sizeof(dummyht));
595
596         ht->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, ht->idname, &RNA_Header);
597         ht->ext.data = data;
598         ht->ext.call = call;
599         ht->ext.free = free;
600         RNA_struct_blender_type_set(ht->ext.srna, ht);
601
602         ht->draw = (have_function[0]) ? header_draw : NULL;
603
604         BLI_addtail(&art->headertypes, ht);
605
606         /* update while blender is running */
607         WM_main_add_notifier(NC_WINDOW, NULL);
608         
609         return ht->ext.srna;
610 }
611
612 static StructRNA *rna_Header_refine(PointerRNA *htr)
613 {
614         Header *hdr = (Header *)htr->data;
615         return (hdr->type && hdr->type->ext.srna) ? hdr->type->ext.srna : &RNA_Header;
616 }
617
618 /* Menu */
619
620 static int menu_poll(const bContext *C, MenuType *pt)
621 {
622         extern FunctionRNA rna_Menu_poll_func;
623
624         PointerRNA ptr;
625         ParameterList list;
626         FunctionRNA *func;
627         void *ret;
628         int visible;
629
630         RNA_pointer_create(NULL, pt->ext.srna, NULL, &ptr); /* dummy */
631         func = &rna_Menu_poll_func; /* RNA_struct_find_function(&ptr, "poll"); */
632
633         RNA_parameter_list_create(&list, &ptr, func);
634         RNA_parameter_set_lookup(&list, "context", &C);
635         pt->ext.call((bContext *)C, &ptr, func, &list);
636
637         RNA_parameter_get_lookup(&list, "visible", &ret);
638         visible = *(int *)ret;
639
640         RNA_parameter_list_free(&list);
641
642         return visible;
643 }
644
645 static void menu_draw(const bContext *C, Menu *hdr)
646 {
647         extern FunctionRNA rna_Menu_draw_func;
648
649         PointerRNA mtr;
650         ParameterList list;
651         FunctionRNA *func;
652
653         RNA_pointer_create(&CTX_wm_screen(C)->id, hdr->type->ext.srna, hdr, &mtr);
654         func = &rna_Menu_draw_func; /* RNA_struct_find_function(&mtr, "draw"); */
655
656         RNA_parameter_list_create(&list, &mtr, func);
657         RNA_parameter_set_lookup(&list, "context", &C);
658         hdr->type->ext.call((bContext *)C, &mtr, func, &list);
659
660         RNA_parameter_list_free(&list);
661 }
662
663 static void rna_Menu_unregister(Main *UNUSED(bmain), StructRNA *type)
664 {
665         MenuType *mt = RNA_struct_blender_type_get(type);
666
667         if (!mt)
668                 return;
669         
670         RNA_struct_free_extension(type, &mt->ext);
671
672         WM_menutype_freelink(mt);
673
674         RNA_struct_free(&BLENDER_RNA, type);
675
676         /* update while blender is running */
677         WM_main_add_notifier(NC_WINDOW, NULL);
678 }
679
680 static StructRNA *rna_Menu_register(Main *bmain, ReportList *reports, void *data, const char *identifier,
681                                     StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
682 {
683         MenuType *mt, dummymt = {NULL};
684         Menu dummymenu = {NULL};
685         PointerRNA dummymtr;
686         int have_function[2];
687         size_t over_alloc = 0; /* warning, if this becomes a bess, we better do another alloc */
688         size_t description_size = 0;
689         char _menu_descr[RNA_DYN_DESCR_MAX];
690
691         /* setup dummy menu & menu type to store static properties in */
692         dummymenu.type = &dummymt;
693         _menu_descr[0] = '\0';
694         dummymenu.type->description = _menu_descr;
695         RNA_pointer_create(NULL, &RNA_Menu, &dummymenu, &dummymtr);
696
697         /* We have to set default context! Else we get a void string... */
698         strcpy(dummymt.translation_context, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
699
700         /* validate the python class */
701         if (validate(&dummymtr, data, have_function) != 0)
702                 return NULL;
703         
704         if (strlen(identifier) >= sizeof(dummymt.idname)) {
705                 BKE_reportf(reports, RPT_ERROR, "Registering menu class: '%s' is too long, maximum length is %d",
706                             identifier, (int)sizeof(dummymt.idname));
707                 return NULL;
708         }
709
710         /* check if we have registered this menu type before, and remove it */
711         mt = WM_menutype_find(dummymt.idname, true);
712         if (mt && mt->ext.srna)
713                 rna_Menu_unregister(bmain, mt->ext.srna);
714         
715         /* create a new menu type */
716         if (_menu_descr[0]) {
717                 description_size = strlen(_menu_descr) + 1;
718                 over_alloc += description_size;
719         }
720
721         mt = MEM_callocN(sizeof(MenuType) + over_alloc, "python buttons menu");
722         memcpy(mt, &dummymt, sizeof(dummymt));
723
724         if (_menu_descr[0]) {
725                 char *buf = (char *)(mt + 1);
726                 memcpy(buf, _menu_descr, description_size);
727                 mt->description = buf;
728         }
729         else
730                 mt->description = "";
731
732         mt->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, mt->idname, &RNA_Menu);
733         RNA_def_struct_translation_context(mt->ext.srna, mt->translation_context);
734         mt->ext.data = data;
735         mt->ext.call = call;
736         mt->ext.free = free;
737         RNA_struct_blender_type_set(mt->ext.srna, mt);
738         RNA_def_struct_flag(mt->ext.srna, STRUCT_NO_IDPROPERTIES);
739
740         mt->poll = (have_function[0]) ? menu_poll : NULL;
741         mt->draw = (have_function[1]) ? menu_draw : NULL;
742
743         WM_menutype_add(mt);
744
745         /* update while blender is running */
746         WM_main_add_notifier(NC_WINDOW, NULL);
747         
748         return mt->ext.srna;
749 }
750
751 static StructRNA *rna_Menu_refine(PointerRNA *mtr)
752 {
753         Menu *hdr = (Menu *)mtr->data;
754         return (hdr->type && hdr->type->ext.srna) ? hdr->type->ext.srna : &RNA_Menu;
755 }
756
757 static void rna_Menu_bl_description_set(PointerRNA *ptr, const char *value)
758 {
759         Menu *data = (Menu *)(ptr->data);
760         char *str = (char *)data->type->description;
761         if (!str[0]) BLI_strncpy(str, value, RNA_DYN_DESCR_MAX);     /* utf8 already ensured */
762         else assert(!"setting the bl_description on a non-builtin menu");
763 }
764
765 /* UILayout */
766
767 static int rna_UILayout_active_get(PointerRNA *ptr)
768 {
769         return uiLayoutGetActive(ptr->data);
770 }
771
772 static void rna_UILayout_active_set(PointerRNA *ptr, int value)
773 {
774         uiLayoutSetActive(ptr->data, value);
775 }
776
777 static int rna_UILayout_alert_get(PointerRNA *ptr)
778 {
779         return uiLayoutGetRedAlert(ptr->data);
780 }
781
782 static void rna_UILayout_alert_set(PointerRNA *ptr, int value)
783 {
784         uiLayoutSetRedAlert(ptr->data, value);
785 }
786
787 static void rna_UILayout_op_context_set(PointerRNA *ptr, int value)
788 {
789         uiLayoutSetOperatorContext(ptr->data, value);
790 }
791
792 static int rna_UILayout_op_context_get(PointerRNA *ptr)
793 {
794         return uiLayoutGetOperatorContext(ptr->data);
795 }
796
797 static int rna_UILayout_enabled_get(PointerRNA *ptr)
798 {
799         return uiLayoutGetEnabled(ptr->data);
800 }
801
802 static void rna_UILayout_enabled_set(PointerRNA *ptr, int value)
803 {
804         uiLayoutSetEnabled(ptr->data, value);
805 }
806
807 #if 0
808 static int rna_UILayout_red_alert_get(PointerRNA *ptr)
809 {
810         return uiLayoutGetRedAlert(ptr->data);
811 }
812
813 static void rna_UILayout_red_alert_set(PointerRNA *ptr, int value)
814 {
815         uiLayoutSetRedAlert(ptr->data, value);
816 }
817
818 static int rna_UILayout_keep_aspect_get(PointerRNA *ptr)
819 {
820         return uiLayoutGetKeepAspect(ptr->data);
821 }
822
823 static void rna_UILayout_keep_aspect_set(PointerRNA *ptr, int value)
824 {
825         uiLayoutSetKeepAspect(ptr->data, value);
826 }
827 #endif
828
829 static int rna_UILayout_alignment_get(PointerRNA *ptr)
830 {
831         return uiLayoutGetAlignment(ptr->data);
832 }
833
834 static void rna_UILayout_alignment_set(PointerRNA *ptr, int value)
835 {
836         uiLayoutSetAlignment(ptr->data, value);
837 }
838
839 static float rna_UILayout_scale_x_get(PointerRNA *ptr)
840 {
841         return uiLayoutGetScaleX(ptr->data);
842 }
843
844 static void rna_UILayout_scale_x_set(PointerRNA *ptr, float value)
845 {
846         uiLayoutSetScaleX(ptr->data, value);
847 }
848
849 static float rna_UILayout_scale_y_get(PointerRNA *ptr)
850 {
851         return uiLayoutGetScaleY(ptr->data);
852 }
853
854 static void rna_UILayout_scale_y_set(PointerRNA *ptr, float value)
855 {
856         uiLayoutSetScaleY(ptr->data, value);
857 }
858
859 #else /* RNA_RUNTIME */
860
861 static void rna_def_ui_layout(BlenderRNA *brna)
862 {
863         StructRNA *srna;
864         PropertyRNA *prop;
865
866         static EnumPropertyItem alignment_items[] = {
867                 {UI_LAYOUT_ALIGN_EXPAND, "EXPAND", 0, "Expand", ""},
868                 {UI_LAYOUT_ALIGN_LEFT, "LEFT", 0, "Left", ""},
869                 {UI_LAYOUT_ALIGN_CENTER, "CENTER", 0, "Center", ""},
870                 {UI_LAYOUT_ALIGN_RIGHT, "RIGHT", 0, "Right", ""},
871                 {0, NULL, 0, NULL, NULL}
872         };
873         
874         /* layout */
875
876         srna = RNA_def_struct(brna, "UILayout", NULL);
877         RNA_def_struct_sdna(srna, "uiLayout");
878         RNA_def_struct_ui_text(srna, "UI Layout", "User interface layout in a panel or header");
879
880         prop = RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
881         RNA_def_property_boolean_funcs(prop, "rna_UILayout_active_get", "rna_UILayout_active_set");
882         
883         prop = RNA_def_property(srna, "operator_context", PROP_ENUM, PROP_NONE);
884         RNA_def_property_enum_items(prop, operator_context_items);
885         RNA_def_property_enum_funcs(prop, "rna_UILayout_op_context_get", "rna_UILayout_op_context_set", NULL);
886         
887         prop = RNA_def_property(srna, "enabled", PROP_BOOLEAN, PROP_NONE);
888         RNA_def_property_boolean_funcs(prop, "rna_UILayout_enabled_get", "rna_UILayout_enabled_set");
889         RNA_def_property_ui_text(prop, "Enabled", "When false, this (sub)layout is grayed out");
890         
891         prop = RNA_def_property(srna, "alert", PROP_BOOLEAN, PROP_NONE);
892         RNA_def_property_boolean_funcs(prop, "rna_UILayout_alert_get", "rna_UILayout_alert_set");
893
894         prop = RNA_def_property(srna, "alignment", PROP_ENUM, PROP_NONE);
895         RNA_def_property_enum_items(prop, alignment_items);
896         RNA_def_property_enum_funcs(prop, "rna_UILayout_alignment_get", "rna_UILayout_alignment_set", NULL);
897
898 #if 0
899         prop = RNA_def_property(srna, "keep_aspect", PROP_BOOLEAN, PROP_NONE);
900         RNA_def_property_boolean_funcs(prop, "rna_UILayout_keep_aspect_get", "rna_UILayout_keep_aspect_set");
901 #endif
902
903         prop = RNA_def_property(srna, "scale_x", PROP_FLOAT, PROP_UNSIGNED);
904         RNA_def_property_float_funcs(prop, "rna_UILayout_scale_x_get", "rna_UILayout_scale_x_set", NULL);
905         RNA_def_property_ui_text(prop, "Scale X", "Scale factor along the X for items in this (sub)layout");
906         
907         prop = RNA_def_property(srna, "scale_y", PROP_FLOAT, PROP_UNSIGNED);
908         RNA_def_property_float_funcs(prop, "rna_UILayout_scale_y_get", "rna_UILayout_scale_y_set", NULL);
909         RNA_def_property_ui_text(prop, "Scale Y", "Scale factor along the Y for items in this (sub)layout");
910         RNA_api_ui_layout(srna);
911 }
912
913 static void rna_def_panel(BlenderRNA *brna)
914 {
915         StructRNA *srna;
916         PropertyRNA *prop;
917         PropertyRNA *parm;
918         FunctionRNA *func;
919         
920         static EnumPropertyItem panel_flag_items[] = {
921                 {PNL_DEFAULT_CLOSED, "DEFAULT_CLOSED", 0, "Default Closed",
922                                      "Defines if the panel has to be open or collapsed at the time of its creation"},
923                 {PNL_NO_HEADER, "HIDE_HEADER", 0, "Hide Header",
924                                 "If set to False, the panel shows a header, which contains a clickable "
925                                 "arrow to collapse the panel and the label (see bl_label)"},
926                 {0, NULL, 0, NULL, NULL}
927         };
928         
929         srna = RNA_def_struct(brna, "Panel", NULL);
930         RNA_def_struct_ui_text(srna, "Panel", "Panel containing UI elements");
931         RNA_def_struct_sdna(srna, "Panel");
932         RNA_def_struct_refine_func(srna, "rna_Panel_refine");
933         RNA_def_struct_register_funcs(srna, "rna_Panel_register", "rna_Panel_unregister", NULL);
934         RNA_def_struct_translation_context(srna, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
935
936         /* poll */
937         func = RNA_def_function(srna, "poll", NULL);
938         RNA_def_function_ui_description(func, "If this method returns a non-null output, then the panel can be drawn");
939         RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL);
940         RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
941         parm = RNA_def_pointer(func, "context", "Context", "", "");
942         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
943
944         /* draw */
945         func = RNA_def_function(srna, "draw", NULL);
946         RNA_def_function_ui_description(func, "Draw UI elements into the panel UI layout");
947         RNA_def_function_flag(func, FUNC_REGISTER);
948         parm = RNA_def_pointer(func, "context", "Context", "", "");
949         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
950
951         func = RNA_def_function(srna, "draw_header", NULL);
952         RNA_def_function_ui_description(func, "Draw UI elements into the panel's header UI layout");
953         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
954         parm = RNA_def_pointer(func, "context", "Context", "", "");
955         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
956
957         prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
958         RNA_def_property_struct_type(prop, "UILayout");
959         RNA_def_property_ui_text(prop, "Layout", "Defines the structure of the panel in the UI");
960         
961         prop = RNA_def_property(srna, "text", PROP_STRING, PROP_NONE);
962         RNA_def_property_string_sdna(prop, NULL, "drawname");
963         RNA_def_property_ui_text(prop, "Text", "XXX todo");
964         
965         /* registration */
966         prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
967         RNA_def_property_string_sdna(prop, NULL, "type->idname");
968         RNA_def_property_flag(prop, PROP_REGISTER);
969         RNA_def_property_ui_text(prop, "ID Name",
970                                  "If this is set, the panel gets a custom ID, otherwise it takes the "
971                                  "name of the class used to define the panel. For example, if the "
972                                  "class name is \"OBJECT_PT_hello\", and bl_idname is not set by the "
973                                  "script, then bl_idname = \"OBJECT_PT_hello\"");
974
975         prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
976         RNA_def_property_string_sdna(prop, NULL, "type->label");
977         RNA_def_property_flag(prop, PROP_REGISTER);
978         RNA_def_property_ui_text(prop, "Label",
979                                  "The panel label, shows up in the panel header at the right of the "
980                                  "triangle used to collapse the panel");
981
982         prop = RNA_def_property(srna, "bl_translation_context", PROP_STRING, PROP_NONE);
983         RNA_def_property_string_sdna(prop, NULL, "type->translation_context");
984         RNA_def_property_string_default(prop, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
985         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
986         RNA_define_verify_sdna(true);
987
988         prop = RNA_def_property(srna, "bl_category", PROP_STRING, PROP_NONE);
989         RNA_def_property_string_sdna(prop, NULL, "type->category");
990         RNA_def_property_string_default(prop, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
991         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
992
993         prop = RNA_def_property(srna, "bl_space_type", PROP_ENUM, PROP_NONE);
994         RNA_def_property_enum_sdna(prop, NULL, "type->space_type");
995         RNA_def_property_enum_items(prop, space_type_items);
996         RNA_def_property_flag(prop, PROP_REGISTER);
997         RNA_def_property_ui_text(prop, "Space type", "The space where the panel is going to be used in");
998         
999         prop = RNA_def_property(srna, "bl_region_type", PROP_ENUM, PROP_NONE);
1000         RNA_def_property_enum_sdna(prop, NULL, "type->region_type");
1001         RNA_def_property_enum_items(prop, region_type_items);
1002         RNA_def_property_flag(prop, PROP_REGISTER);
1003         RNA_def_property_ui_text(prop, "Region Type", "The region where the panel is going to be used in");
1004
1005         prop = RNA_def_property(srna, "bl_context", PROP_STRING, PROP_NONE);
1006         RNA_def_property_string_sdna(prop, NULL, "type->context");
1007         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); /* Only used in Properties Editor and 3D View - Thomas */
1008         RNA_def_property_ui_text(prop, "Context",
1009                                  "The context in which the panel belongs to. (TODO: explain the "
1010                                  "possible combinations bl_context/bl_region_type/bl_space_type)");
1011         
1012         prop = RNA_def_property(srna, "bl_options", PROP_ENUM, PROP_NONE);
1013         RNA_def_property_enum_sdna(prop, NULL, "type->flag");
1014         RNA_def_property_enum_items(prop, panel_flag_items);
1015         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL | PROP_ENUM_FLAG);
1016         RNA_def_property_ui_text(prop, "Options",  "Options for this panel type");
1017
1018         prop = RNA_def_property(srna, "use_pin", PROP_BOOLEAN, PROP_NONE);
1019         RNA_def_property_boolean_sdna(prop, NULL, "flag", PNL_PIN);
1020         RNA_def_property_ui_text(prop, "Pin",  "");
1021         /* XXX, should only tag region for redraw */
1022         RNA_def_property_update(prop, NC_WINDOW, NULL);
1023 }
1024
1025 static void rna_def_uilist(BlenderRNA *brna)
1026 {
1027         StructRNA *srna;
1028         PropertyRNA *prop;
1029         PropertyRNA *parm;
1030         FunctionRNA *func;
1031
1032         srna = RNA_def_struct(brna, "UIList", NULL);
1033         RNA_def_struct_ui_text(srna, "UIList", "UI list containing the elements of a collection");
1034         RNA_def_struct_sdna(srna, "uiList");
1035         RNA_def_struct_refine_func(srna, "rna_UIList_refine");
1036         RNA_def_struct_register_funcs(srna, "rna_UIList_register", "rna_UIList_unregister", NULL);
1037         RNA_def_struct_idprops_func(srna, "rna_UIList_idprops");
1038
1039         /* Registration */
1040         prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
1041         RNA_def_property_string_sdna(prop, NULL, "type->idname");
1042         RNA_def_property_flag(prop, PROP_REGISTER);
1043         RNA_def_property_ui_text(prop, "ID Name",
1044                                  "If this is set, the uilist gets a custom ID, otherwise it takes the "
1045                                  "name of the class used to define the uilist (for example, if the "
1046                                  "class name is \"OBJECT_UL_vgroups\", and bl_idname is not set by the "
1047                                  "script, then bl_idname = \"OBJECT_UL_vgroups\")");
1048
1049         /* Data */
1050         prop = RNA_def_property(srna, "layout_type", PROP_ENUM, PROP_NONE);
1051         RNA_def_property_enum_items(prop, uilist_layout_type_items);
1052         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1053
1054         /* Filter options */
1055         prop = RNA_def_property(srna, "use_filter_show", PROP_BOOLEAN, PROP_NONE);
1056         RNA_def_property_boolean_sdna(prop, NULL, "filter_flag", UILST_FLT_SHOW);
1057         RNA_def_property_ui_text(prop, "Show Filter", "Show filtering options");
1058
1059         prop = RNA_def_property(srna, "filter_name", PROP_STRING, PROP_NONE);
1060         RNA_def_property_string_sdna(prop, NULL, "filter_byname");
1061         RNA_def_property_ui_text(prop, "Filter by Name", "Only show items matching this name (use '*' as wildcard)");
1062
1063         prop = RNA_def_property(srna, "use_filter_invert", PROP_BOOLEAN, PROP_NONE);
1064         RNA_def_property_boolean_sdna(prop, NULL, "filter_flag", UILST_FLT_EXCLUDE);
1065         RNA_def_property_ui_text(prop, "Invert", "Invert filtering (show hidden items, and vice-versa)");
1066
1067         prop = RNA_def_property(srna, "use_filter_sort_alpha", PROP_BOOLEAN, PROP_NONE);
1068         RNA_def_property_boolean_sdna(prop, NULL, "filter_sort_flag", UILST_FLT_SORT_ALPHA);
1069         RNA_def_property_ui_icon(prop, ICON_SORTALPHA, 0);
1070         RNA_def_property_ui_text(prop, "Sort by Name", "Sort items by their name");
1071
1072         prop = RNA_def_property(srna, "use_filter_sort_reverse", PROP_BOOLEAN, PROP_NONE);
1073         RNA_def_property_boolean_sdna(prop, NULL, "filter_sort_flag", UILST_FLT_SORT_REVERSE);
1074         RNA_def_property_ui_text(prop, "Invert", "Invert the order of shown items");
1075
1076         /* draw_item */
1077         func = RNA_def_function(srna, "draw_item", NULL);
1078         RNA_def_function_ui_description(func, "Draw an item in the list (NOTE: when you define your own draw_item "
1079                                               "function, you may want to check given 'item' is of the right type...)");
1080         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
1081         parm = RNA_def_pointer(func, "context", "Context", "", "");
1082         RNA_def_property_flag(parm, PROP_REQUIRED);
1083         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Layout to draw the item");
1084         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
1085         parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take Collection property");
1086         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_RNAPTR);
1087         parm = RNA_def_pointer(func, "item", "AnyType", "", "Item of the collection property");
1088         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_RNAPTR);
1089         parm = RNA_def_int(func, "icon", 0, 0, INT_MAX, "", "Icon of the item in the collection", 0, INT_MAX);
1090         RNA_def_property_flag(parm, PROP_REQUIRED);
1091         parm = RNA_def_pointer(func, "active_data", "AnyType", "",
1092                                "Data from which to take property for the active element");
1093         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_RNAPTR | PROP_NEVER_NULL);
1094         parm = RNA_def_string(func, "active_property", NULL, 0, "",
1095                               "Identifier of property in active_data, for the active element");
1096         RNA_def_property_flag(parm, PROP_REQUIRED);
1097         RNA_def_int(func, "index", 0, 0, INT_MAX, "", "Index of the item in the collection", 0, INT_MAX);
1098         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_PYFUNC_OPTIONAL);
1099         prop = RNA_def_property(func, "flt_flag", PROP_INT, PROP_UNSIGNED);
1100         RNA_def_property_ui_text(prop, "", "The filter-flag result for this item");
1101         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_PYFUNC_OPTIONAL);
1102
1103         /* draw_filter */
1104         func = RNA_def_function(srna, "draw_filter", NULL);
1105         RNA_def_function_ui_description(func, "Draw filtering options");
1106         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
1107         parm = RNA_def_pointer(func, "context", "Context", "", "");
1108         RNA_def_property_flag(parm, PROP_REQUIRED);
1109         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Layout to draw the item");
1110         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
1111
1112         /* filter */
1113         func = RNA_def_function(srna, "filter_items", NULL);
1114         RNA_def_function_ui_description(func, "Filter and/or re-order items of the collection (output filter results in "
1115                                               "filter_flags, and reorder results in filter_neworder arrays)");
1116         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
1117         parm = RNA_def_pointer(func, "context", "Context", "", "");
1118         RNA_def_property_flag(parm, PROP_REQUIRED);
1119         parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take Collection property");
1120         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_RNAPTR);
1121         parm = RNA_def_string(func, "property", NULL, 0, "", "Identifier of property in data, for the collection");
1122         RNA_def_property_flag(parm, PROP_REQUIRED);
1123         prop = RNA_def_property(func, "filter_flags", PROP_INT, PROP_UNSIGNED);
1124         RNA_def_property_flag(prop, PROP_REQUIRED | PROP_DYNAMIC);
1125         RNA_def_property_array(prop, 1);  /* XXX Dummy value, default 0 does not work */
1126         RNA_def_property_ui_text(prop, "", "An array of filter flags, one for each item in the collection (NOTE: "
1127                                            "FILTER_ITEM bit is reserved, it defines whether the item is shown or not)");
1128         RNA_def_function_output(func, prop);
1129         prop = RNA_def_property(func, "filter_neworder", PROP_INT, PROP_UNSIGNED);
1130         RNA_def_property_flag(prop, PROP_REQUIRED | PROP_DYNAMIC);
1131         RNA_def_property_array(prop, 1);  /* XXX Dummy value, default 0 does not work */
1132         RNA_def_property_ui_text(prop, "", "An array of indices, one for each item in the collection, mapping the org "
1133                                            "index to the new one");
1134         RNA_def_function_output(func, prop);
1135
1136         /* "Constants"! */
1137         RNA_define_verify_sdna(0); /* not in sdna */
1138
1139         prop = RNA_def_property(srna, "bitflag_filter_item", PROP_INT, PROP_UNSIGNED);
1140         RNA_def_property_ui_text(prop, "FILTER_ITEM",
1141                                        "The value of the reserved bitflag 'FILTER_ITEM' (in filter_flags values)");
1142         RNA_def_property_int_funcs(prop, "rna_UIList_filter_const_FILTER_ITEM_get", NULL, NULL);
1143         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1144 }
1145
1146 static void rna_def_header(BlenderRNA *brna)
1147 {
1148         StructRNA *srna;
1149         PropertyRNA *prop;
1150         PropertyRNA *parm;
1151         FunctionRNA *func;
1152         
1153         srna = RNA_def_struct(brna, "Header", NULL);
1154         RNA_def_struct_ui_text(srna, "Header", "Editor header containing UI elements");
1155         RNA_def_struct_sdna(srna, "Header");
1156         RNA_def_struct_refine_func(srna, "rna_Header_refine");
1157         RNA_def_struct_register_funcs(srna, "rna_Header_register", "rna_Header_unregister", NULL);
1158
1159         /* draw */
1160         func = RNA_def_function(srna, "draw", NULL);
1161         RNA_def_function_ui_description(func, "Draw UI elements into the header UI layout");
1162         RNA_def_function_flag(func, FUNC_REGISTER);
1163         parm = RNA_def_pointer(func, "context", "Context", "", "");
1164         RNA_def_property_flag(parm, PROP_REQUIRED);
1165
1166         RNA_define_verify_sdna(0); /* not in sdna */
1167
1168         prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
1169         RNA_def_property_pointer_sdna(prop, NULL, "layout");
1170         RNA_def_property_struct_type(prop, "UILayout");
1171         RNA_def_property_ui_text(prop, "Layout", "Structure of the header in the UI");
1172
1173         /* registration */
1174         prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
1175         RNA_def_property_string_sdna(prop, NULL, "type->idname");
1176         RNA_def_property_flag(prop, PROP_REGISTER);
1177         RNA_def_property_ui_text(prop, "ID Name",
1178                                  "If this is set, the header gets a custom ID, otherwise it takes the "
1179                                  "name of the class used to define the panel; for example, if the "
1180                                  "class name is \"OBJECT_HT_hello\", and bl_idname is not set by the "
1181                                  "script, then bl_idname = \"OBJECT_HT_hello\"");
1182
1183         prop = RNA_def_property(srna, "bl_space_type", PROP_ENUM, PROP_NONE);
1184         RNA_def_property_enum_sdna(prop, NULL, "type->space_type");
1185         RNA_def_property_enum_items(prop, space_type_items);
1186         RNA_def_property_flag(prop, PROP_REGISTER);
1187         RNA_def_property_ui_text(prop, "Space type", "The space where the header is going to be used in");
1188
1189         RNA_define_verify_sdna(1);
1190 }
1191
1192 static void rna_def_menu(BlenderRNA *brna)
1193 {
1194         StructRNA *srna;
1195         PropertyRNA *prop;
1196         PropertyRNA *parm;
1197         FunctionRNA *func;
1198         
1199         srna = RNA_def_struct(brna, "Menu", NULL);
1200         RNA_def_struct_ui_text(srna, "Menu", "Editor menu containing buttons");
1201         RNA_def_struct_sdna(srna, "Menu");
1202         RNA_def_struct_refine_func(srna, "rna_Menu_refine");
1203         RNA_def_struct_register_funcs(srna, "rna_Menu_register", "rna_Menu_unregister", NULL);
1204         RNA_def_struct_translation_context(srna, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
1205
1206         /* poll */
1207         func = RNA_def_function(srna, "poll", NULL);
1208         RNA_def_function_ui_description(func, "If this method returns a non-null output, then the menu can be drawn");
1209         RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL);
1210         RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
1211         parm = RNA_def_pointer(func, "context", "Context", "", "");
1212         RNA_def_property_flag(parm, PROP_REQUIRED);
1213
1214         /* draw */
1215         func = RNA_def_function(srna, "draw", NULL);
1216         RNA_def_function_ui_description(func, "Draw UI elements into the menu UI layout");
1217         RNA_def_function_flag(func, FUNC_REGISTER);
1218         parm = RNA_def_pointer(func, "context", "Context", "", "");
1219         RNA_def_property_flag(parm, PROP_REQUIRED);
1220
1221         RNA_define_verify_sdna(false); /* not in sdna */
1222
1223         prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
1224         RNA_def_property_pointer_sdna(prop, NULL, "layout");
1225         RNA_def_property_struct_type(prop, "UILayout");
1226         RNA_def_property_ui_text(prop, "Layout", "Defines the structure of the menu in the UI");
1227
1228         /* registration */
1229         prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
1230         RNA_def_property_string_sdna(prop, NULL, "type->idname");
1231         RNA_def_property_flag(prop, PROP_REGISTER);
1232         RNA_def_property_ui_text(prop, "ID Name",
1233                                  "If this is set, the menu gets a custom ID, otherwise it takes the "
1234                                  "name of the class used to define the menu (for example, if the "
1235                                  "class name is \"OBJECT_MT_hello\", and bl_idname is not set by the "
1236                                  "script, then bl_idname = \"OBJECT_MT_hello\")");
1237
1238         prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
1239         RNA_def_property_string_sdna(prop, NULL, "type->label");
1240         RNA_def_property_flag(prop, PROP_REGISTER);
1241         RNA_def_property_ui_text(prop, "Label", "The menu label");
1242
1243         prop = RNA_def_property(srna, "bl_translation_context", PROP_STRING, PROP_NONE);
1244         RNA_def_property_string_sdna(prop, NULL, "type->translation_context");
1245         RNA_def_property_string_default(prop, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
1246         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
1247
1248         prop = RNA_def_property(srna, "bl_description", PROP_STRING, PROP_NONE);
1249         RNA_def_property_string_sdna(prop, NULL, "type->description");
1250         RNA_def_property_string_maxlength(prop, RNA_DYN_DESCR_MAX); /* else it uses the pointer size! */
1251         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Menu_bl_description_set");
1252         /* RNA_def_property_clear_flag(prop, PROP_EDITABLE); */
1253         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
1254         RNA_def_property_clear_flag(prop, PROP_NEVER_NULL); /* check for NULL */
1255
1256         RNA_define_verify_sdna(1);
1257 }
1258
1259 void RNA_def_ui(BlenderRNA *brna)
1260 {
1261         rna_def_ui_layout(brna);
1262         rna_def_panel(brna);
1263         rna_def_uilist(brna);
1264         rna_def_header(brna);
1265         rna_def_menu(brna);
1266 }
1267
1268 #endif /* RNA_RUNTIME */
1269