code cleanup: quiet rna warnings, remove remove_strict_flags() for cmake/rna.
[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", AT,
362                        RNA_parameter_dynamic_length_get(&list, parm), "filter_flags", len);
363                 RNA_parameter_list_free(&list);
364                 return;
365         }
366         RNA_parameter_get(&list, parm, &ret1);
367         filter_flags = (int *)ret1;
368
369         parm = RNA_function_find_parameter(NULL, func, "filter_neworder");
370         ret_len = RNA_parameter_dynamic_length_get(&list, parm);
371         if (ret_len != len && ret_len != 0) {
372                 printf("%s: Error, py func returned %d items in %s, %d or none were expected.\n", AT,
373                        RNA_parameter_dynamic_length_get(&list, parm), "filter_neworder", len);
374                 RNA_parameter_list_free(&list);
375                 return;
376         }
377         RNA_parameter_get(&list, parm, &ret2);
378         filter_neworder = (int *)ret2;
379
380         /* We have to do some final checks and transforms... */
381         {
382                 int i, filter_exclude = ui_list->filter_flag & UILST_FLT_EXCLUDE;
383                 if (filter_flags) {
384                         flt_data->items_filter_flags = MEM_mallocN(sizeof(int) * len, AT);
385                         memcpy(flt_data->items_filter_flags, filter_flags, sizeof(int) * len);
386
387                         if (filter_neworder) {
388                                 /* For sake of simplicity, py filtering is expected to filter all items, but we actually only want
389                                  * reordering data for shown items!
390                                  */
391                                 int items_shown, shown_idx;
392                                 int t_idx, t_ni, prev_ni;
393                                 flt_data->items_shown = 0;
394                                 for (i = 0, shown_idx = 0; i < len; i++) {
395                                         if ((filter_flags[i] & UILST_FLT_ITEM) ^ filter_exclude) {
396                                                 filter_neworder[shown_idx++] = filter_neworder[i];
397                                         }
398                                 }
399                                 items_shown = flt_data->items_shown = shown_idx;
400                                 flt_data->items_filter_neworder = MEM_mallocN(sizeof(int) * items_shown, AT);
401                                 /* And now, bring back new indices into the [0, items_shown[ range!
402                                  * XXX This is O(N²)... :/
403                                  */
404                                 for (shown_idx = 0, prev_ni = -1; shown_idx < items_shown; shown_idx++) {
405                                         for (i = 0, t_ni = len, t_idx = -1; i < items_shown; i++) {
406                                                 int ni = filter_neworder[i];
407                                                 if (ni > prev_ni && ni < t_ni) {
408                                                         t_idx = i;
409                                                         t_ni = ni;
410                                                 }
411                                         }
412                                         if (t_idx >= 0) {
413                                                 prev_ni = t_ni;
414                                                 flt_data->items_filter_neworder[t_idx] = shown_idx;
415                                         }
416                                 }
417                         }
418                         else {
419                                 /* we still have to set flt_data->items_shown... */
420                                 flt_data->items_shown = 0;
421                                 for (i = 0; i < len; i++) {
422                                         if ((filter_flags[i] & UILST_FLT_ITEM) ^ filter_exclude) {
423                                                 flt_data->items_shown++;
424                                         }
425                                 }
426                         }
427                 }
428                 else {
429                         flt_data->items_shown = len;
430
431                         if (filter_neworder) {
432                                 flt_data->items_filter_neworder = MEM_mallocN(sizeof(int) * len, AT);
433                                 memcpy(flt_data->items_filter_neworder, filter_neworder, sizeof(int) * len);
434                         }
435                 }
436         }
437
438         RNA_parameter_list_free(&list);
439 }
440
441 static void rna_UIList_unregister(Main *UNUSED(bmain), StructRNA *type)
442 {
443         uiListType *ult = RNA_struct_blender_type_get(type);
444
445         if (!ult)
446                 return;
447
448         RNA_struct_free_extension(type, &ult->ext);
449
450         WM_uilisttype_freelink(ult);
451
452         RNA_struct_free(&BLENDER_RNA, type);
453
454         /* update while blender is running */
455         WM_main_add_notifier(NC_WINDOW, NULL);
456 }
457
458 static StructRNA *rna_UIList_register(Main *bmain, ReportList *reports, void *data, const char *identifier,
459                                       StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
460 {
461         uiListType *ult, dummyult = {NULL};
462         uiList dummyuilist = {NULL};
463         PointerRNA dummyul_ptr;
464         int have_function[3];
465         size_t over_alloc = 0; /* warning, if this becomes a bess, we better do another alloc */
466
467         /* setup dummy menu & menu type to store static properties in */
468         dummyuilist.type = &dummyult;
469         RNA_pointer_create(NULL, &RNA_UIList, &dummyuilist, &dummyul_ptr);
470
471         /* validate the python class */
472         if (validate(&dummyul_ptr, data, have_function) != 0)
473                 return NULL;
474
475         if (strlen(identifier) >= sizeof(dummyult.idname)) {
476                 BKE_reportf(reports, RPT_ERROR, "Registering uilist class: '%s' is too long, maximum length is %d",
477                             identifier, (int)sizeof(dummyult.idname));
478                 return NULL;
479         }
480
481         /* check if we have registered this uilist type before, and remove it */
482         ult = WM_uilisttype_find(dummyult.idname, TRUE);
483         if (ult && ult->ext.srna)
484                 rna_UIList_unregister(bmain, ult->ext.srna);
485
486         /* create a new menu type */
487         ult = MEM_callocN(sizeof(uiListType) + over_alloc, "python uilist");
488         memcpy(ult, &dummyult, sizeof(dummyult));
489
490         ult->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, ult->idname, &RNA_UIList);
491         ult->ext.data = data;
492         ult->ext.call = call;
493         ult->ext.free = free;
494         RNA_struct_blender_type_set(ult->ext.srna, ult);
495
496         ult->draw_item = (have_function[0]) ? uilist_draw_item : NULL;
497         ult->draw_filter = (have_function[1]) ? uilist_draw_filter : NULL;
498         ult->filter_items = (have_function[2]) ? uilist_filter_items : NULL;
499
500         WM_uilisttype_add(ult);
501
502         /* update while blender is running */
503         WM_main_add_notifier(NC_WINDOW, NULL);
504
505         return ult->ext.srna;
506 }
507
508 static StructRNA *rna_UIList_refine(PointerRNA *ptr)
509 {
510         uiList *ui_list = (uiList *)ptr->data;
511         return (ui_list->type && ui_list->type->ext.srna) ? ui_list->type->ext.srna : &RNA_UIList;
512 }
513
514 /* Header */
515
516 static void header_draw(const bContext *C, Header *hdr)
517 {
518         extern FunctionRNA rna_Header_draw_func;
519
520         PointerRNA htr;
521         ParameterList list;
522         FunctionRNA *func;
523
524         RNA_pointer_create(&CTX_wm_screen(C)->id, hdr->type->ext.srna, hdr, &htr);
525         func = &rna_Header_draw_func; /* RNA_struct_find_function(&htr, "draw"); */
526
527         RNA_parameter_list_create(&list, &htr, func);
528         RNA_parameter_set_lookup(&list, "context", &C);
529         hdr->type->ext.call((bContext *)C, &htr, func, &list);
530
531         RNA_parameter_list_free(&list);
532 }
533
534 static void rna_Header_unregister(Main *UNUSED(bmain), StructRNA *type)
535 {
536         ARegionType *art;
537         HeaderType *ht = RNA_struct_blender_type_get(type);
538
539         if (!ht)
540                 return;
541         if (!(art = region_type_find(NULL, ht->space_type, RGN_TYPE_HEADER)))
542                 return;
543         
544         RNA_struct_free_extension(type, &ht->ext);
545
546         BLI_freelinkN(&art->headertypes, ht);
547         RNA_struct_free(&BLENDER_RNA, type);
548
549         /* update while blender is running */
550         WM_main_add_notifier(NC_WINDOW, NULL);
551 }
552
553 static StructRNA *rna_Header_register(Main *bmain, ReportList *reports, void *data, const char *identifier,
554                                       StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
555 {
556         ARegionType *art;
557         HeaderType *ht, dummyht = {NULL};
558         Header dummyheader = {NULL};
559         PointerRNA dummyhtr;
560         int have_function[1];
561
562         /* setup dummy header & header type to store static properties in */
563         dummyheader.type = &dummyht;
564         RNA_pointer_create(NULL, &RNA_Header, &dummyheader, &dummyhtr);
565
566         /* validate the python class */
567         if (validate(&dummyhtr, data, have_function) != 0)
568                 return NULL;
569
570         if (strlen(identifier) >= sizeof(dummyht.idname)) {
571                 BKE_reportf(reports, RPT_ERROR, "Registering header class: '%s' is too long, maximum length is %d",
572                             identifier, (int)sizeof(dummyht.idname));
573                 return NULL;
574         }
575
576         if (!(art = region_type_find(reports, dummyht.space_type, RGN_TYPE_HEADER)))
577                 return NULL;
578
579         /* check if we have registered this header type before, and remove it */
580         for (ht = art->headertypes.first; ht; ht = ht->next) {
581                 if (strcmp(ht->idname, dummyht.idname) == 0) {
582                         if (ht->ext.srna)
583                                 rna_Header_unregister(bmain, ht->ext.srna);
584                         break;
585                 }
586         }
587         
588         /* create a new header type */
589         ht = MEM_callocN(sizeof(HeaderType), "python buttons header");
590         memcpy(ht, &dummyht, sizeof(dummyht));
591
592         ht->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, ht->idname, &RNA_Header);
593         ht->ext.data = data;
594         ht->ext.call = call;
595         ht->ext.free = free;
596         RNA_struct_blender_type_set(ht->ext.srna, ht);
597
598         ht->draw = (have_function[0]) ? header_draw : NULL;
599
600         BLI_addtail(&art->headertypes, ht);
601
602         /* update while blender is running */
603         WM_main_add_notifier(NC_WINDOW, NULL);
604         
605         return ht->ext.srna;
606 }
607
608 static StructRNA *rna_Header_refine(PointerRNA *htr)
609 {
610         Header *hdr = (Header *)htr->data;
611         return (hdr->type && hdr->type->ext.srna) ? hdr->type->ext.srna : &RNA_Header;
612 }
613
614 /* Menu */
615
616 static int menu_poll(const bContext *C, MenuType *pt)
617 {
618         extern FunctionRNA rna_Menu_poll_func;
619
620         PointerRNA ptr;
621         ParameterList list;
622         FunctionRNA *func;
623         void *ret;
624         int visible;
625
626         RNA_pointer_create(NULL, pt->ext.srna, NULL, &ptr); /* dummy */
627         func = &rna_Menu_poll_func; /* RNA_struct_find_function(&ptr, "poll"); */
628
629         RNA_parameter_list_create(&list, &ptr, func);
630         RNA_parameter_set_lookup(&list, "context", &C);
631         pt->ext.call((bContext *)C, &ptr, func, &list);
632
633         RNA_parameter_get_lookup(&list, "visible", &ret);
634         visible = *(int *)ret;
635
636         RNA_parameter_list_free(&list);
637
638         return visible;
639 }
640
641 static void menu_draw(const bContext *C, Menu *hdr)
642 {
643         extern FunctionRNA rna_Menu_draw_func;
644
645         PointerRNA mtr;
646         ParameterList list;
647         FunctionRNA *func;
648
649         RNA_pointer_create(&CTX_wm_screen(C)->id, hdr->type->ext.srna, hdr, &mtr);
650         func = &rna_Menu_draw_func; /* RNA_struct_find_function(&mtr, "draw"); */
651
652         RNA_parameter_list_create(&list, &mtr, func);
653         RNA_parameter_set_lookup(&list, "context", &C);
654         hdr->type->ext.call((bContext *)C, &mtr, func, &list);
655
656         RNA_parameter_list_free(&list);
657 }
658
659 static void rna_Menu_unregister(Main *UNUSED(bmain), StructRNA *type)
660 {
661         MenuType *mt = RNA_struct_blender_type_get(type);
662
663         if (!mt)
664                 return;
665         
666         RNA_struct_free_extension(type, &mt->ext);
667
668         WM_menutype_freelink(mt);
669
670         RNA_struct_free(&BLENDER_RNA, type);
671
672         /* update while blender is running */
673         WM_main_add_notifier(NC_WINDOW, NULL);
674 }
675
676 static char _menu_descr[RNA_DYN_DESCR_MAX];
677 static StructRNA *rna_Menu_register(Main *bmain, ReportList *reports, void *data, const char *identifier,
678                                     StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
679 {
680         MenuType *mt, dummymt = {NULL};
681         Menu dummymenu = {NULL};
682         PointerRNA dummymtr;
683         int have_function[2];
684         size_t over_alloc = 0; /* warning, if this becomes a bess, we better do another alloc */
685         size_t description_size = 0;
686
687         /* setup dummy menu & menu type to store static properties in */
688         dummymenu.type = &dummymt;
689         dummymenu.type->description = _menu_descr;
690         RNA_pointer_create(NULL, &RNA_Menu, &dummymenu, &dummymtr);
691
692         /* clear in case they are left unset */
693         _menu_descr[0] = '\0';
694         /* We have to set default context! Else we get a void string... */
695         strcpy(dummymt.translation_context, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
696
697         /* validate the python class */
698         if (validate(&dummymtr, data, have_function) != 0)
699                 return NULL;
700         
701         if (strlen(identifier) >= sizeof(dummymt.idname)) {
702                 BKE_reportf(reports, RPT_ERROR, "Registering menu class: '%s' is too long, maximum length is %d",
703                             identifier, (int)sizeof(dummymt.idname));
704                 return NULL;
705         }
706
707         /* check if we have registered this menu type before, and remove it */
708         mt = WM_menutype_find(dummymt.idname, TRUE);
709         if (mt && mt->ext.srna)
710                 rna_Menu_unregister(bmain, mt->ext.srna);
711         
712         /* create a new menu type */
713         if (_menu_descr[0]) {
714                 description_size = strlen(_menu_descr) + 1;
715                 over_alloc += description_size;
716         }
717
718         mt = MEM_callocN(sizeof(MenuType) + over_alloc, "python buttons menu");
719         memcpy(mt, &dummymt, sizeof(dummymt));
720
721         if (_menu_descr[0]) {
722                 char *buf = (char *)(mt + 1);
723                 memcpy(buf, _menu_descr, description_size);
724                 mt->description = buf;
725         }
726
727         mt->ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, mt->idname, &RNA_Menu);
728         RNA_def_struct_translation_context(mt->ext.srna, mt->translation_context);
729         mt->ext.data = data;
730         mt->ext.call = call;
731         mt->ext.free = free;
732         RNA_struct_blender_type_set(mt->ext.srna, mt);
733         RNA_def_struct_flag(mt->ext.srna, STRUCT_NO_IDPROPERTIES);
734
735         mt->poll = (have_function[0]) ? menu_poll : NULL;
736         mt->draw = (have_function[1]) ? menu_draw : NULL;
737
738         WM_menutype_add(mt);
739
740         /* update while blender is running */
741         WM_main_add_notifier(NC_WINDOW, NULL);
742         
743         return mt->ext.srna;
744 }
745
746 static StructRNA *rna_Menu_refine(PointerRNA *mtr)
747 {
748         Menu *hdr = (Menu *)mtr->data;
749         return (hdr->type && hdr->type->ext.srna) ? hdr->type->ext.srna : &RNA_Menu;
750 }
751
752 static void rna_Menu_bl_description_set(PointerRNA *ptr, const char *value)
753 {
754         Menu *data = (Menu *)(ptr->data);
755         char *str = (char *)data->type->description;
756         if (!str[0]) BLI_strncpy(str, value, RNA_DYN_DESCR_MAX);     /* utf8 already ensured */
757         else assert(!"setting the bl_description on a non-builtin menu");
758 }
759
760 /* UILayout */
761
762 static int rna_UILayout_active_get(PointerRNA *ptr)
763 {
764         return uiLayoutGetActive(ptr->data);
765 }
766
767 static void rna_UILayout_active_set(PointerRNA *ptr, int value)
768 {
769         uiLayoutSetActive(ptr->data, value);
770 }
771
772 static int rna_UILayout_alert_get(PointerRNA *ptr)
773 {
774         return uiLayoutGetRedAlert(ptr->data);
775 }
776
777 static void rna_UILayout_alert_set(PointerRNA *ptr, int value)
778 {
779         uiLayoutSetRedAlert(ptr->data, value);
780 }
781
782 static void rna_UILayout_op_context_set(PointerRNA *ptr, int value)
783 {
784         uiLayoutSetOperatorContext(ptr->data, value);
785 }
786
787 static int rna_UILayout_op_context_get(PointerRNA *ptr)
788 {
789         return uiLayoutGetOperatorContext(ptr->data);
790 }
791
792 static int rna_UILayout_enabled_get(PointerRNA *ptr)
793 {
794         return uiLayoutGetEnabled(ptr->data);
795 }
796
797 static void rna_UILayout_enabled_set(PointerRNA *ptr, int value)
798 {
799         uiLayoutSetEnabled(ptr->data, value);
800 }
801
802 #if 0
803 static int rna_UILayout_red_alert_get(PointerRNA *ptr)
804 {
805         return uiLayoutGetRedAlert(ptr->data);
806 }
807
808 static void rna_UILayout_red_alert_set(PointerRNA *ptr, int value)
809 {
810         uiLayoutSetRedAlert(ptr->data, value);
811 }
812
813 static int rna_UILayout_keep_aspect_get(PointerRNA *ptr)
814 {
815         return uiLayoutGetKeepAspect(ptr->data);
816 }
817
818 static void rna_UILayout_keep_aspect_set(PointerRNA *ptr, int value)
819 {
820         uiLayoutSetKeepAspect(ptr->data, value);
821 }
822 #endif
823
824 static int rna_UILayout_alignment_get(PointerRNA *ptr)
825 {
826         return uiLayoutGetAlignment(ptr->data);
827 }
828
829 static void rna_UILayout_alignment_set(PointerRNA *ptr, int value)
830 {
831         uiLayoutSetAlignment(ptr->data, value);
832 }
833
834 static float rna_UILayout_scale_x_get(PointerRNA *ptr)
835 {
836         return uiLayoutGetScaleX(ptr->data);
837 }
838
839 static void rna_UILayout_scale_x_set(PointerRNA *ptr, float value)
840 {
841         uiLayoutSetScaleX(ptr->data, value);
842 }
843
844 static float rna_UILayout_scale_y_get(PointerRNA *ptr)
845 {
846         return uiLayoutGetScaleY(ptr->data);
847 }
848
849 static void rna_UILayout_scale_y_set(PointerRNA *ptr, float value)
850 {
851         uiLayoutSetScaleY(ptr->data, value);
852 }
853
854 #else /* RNA_RUNTIME */
855
856 static void rna_def_ui_layout(BlenderRNA *brna)
857 {
858         StructRNA *srna;
859         PropertyRNA *prop;
860
861         static EnumPropertyItem alignment_items[] = {
862                 {UI_LAYOUT_ALIGN_EXPAND, "EXPAND", 0, "Expand", ""},
863                 {UI_LAYOUT_ALIGN_LEFT, "LEFT", 0, "Left", ""},
864                 {UI_LAYOUT_ALIGN_CENTER, "CENTER", 0, "Center", ""},
865                 {UI_LAYOUT_ALIGN_RIGHT, "RIGHT", 0, "Right", ""},
866                 {0, NULL, 0, NULL, NULL}
867         };
868         
869         /* layout */
870
871         srna = RNA_def_struct(brna, "UILayout", NULL);
872         RNA_def_struct_sdna(srna, "uiLayout");
873         RNA_def_struct_ui_text(srna, "UI Layout", "User interface layout in a panel or header");
874
875         prop = RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
876         RNA_def_property_boolean_funcs(prop, "rna_UILayout_active_get", "rna_UILayout_active_set");
877         
878         prop = RNA_def_property(srna, "operator_context", PROP_ENUM, PROP_NONE);
879         RNA_def_property_enum_items(prop, operator_context_items);
880         RNA_def_property_enum_funcs(prop, "rna_UILayout_op_context_get", "rna_UILayout_op_context_set", NULL);
881         
882         prop = RNA_def_property(srna, "enabled", PROP_BOOLEAN, PROP_NONE);
883         RNA_def_property_boolean_funcs(prop, "rna_UILayout_enabled_get", "rna_UILayout_enabled_set");
884         RNA_def_property_ui_text(prop, "Enabled", "When false, this (sub)layout is grayed out");
885         
886         prop = RNA_def_property(srna, "alert", PROP_BOOLEAN, PROP_NONE);
887         RNA_def_property_boolean_funcs(prop, "rna_UILayout_alert_get", "rna_UILayout_alert_set");
888
889         prop = RNA_def_property(srna, "alignment", PROP_ENUM, PROP_NONE);
890         RNA_def_property_enum_items(prop, alignment_items);
891         RNA_def_property_enum_funcs(prop, "rna_UILayout_alignment_get", "rna_UILayout_alignment_set", NULL);
892
893 #if 0
894         prop = RNA_def_property(srna, "keep_aspect", PROP_BOOLEAN, PROP_NONE);
895         RNA_def_property_boolean_funcs(prop, "rna_UILayout_keep_aspect_get", "rna_UILayout_keep_aspect_set");
896 #endif
897
898         prop = RNA_def_property(srna, "scale_x", PROP_FLOAT, PROP_UNSIGNED);
899         RNA_def_property_float_funcs(prop, "rna_UILayout_scale_x_get", "rna_UILayout_scale_x_set", NULL);
900         RNA_def_property_ui_text(prop, "Scale X", "Scale factor along the X for items in this (sub)layout");
901         
902         prop = RNA_def_property(srna, "scale_y", PROP_FLOAT, PROP_UNSIGNED);
903         RNA_def_property_float_funcs(prop, "rna_UILayout_scale_y_get", "rna_UILayout_scale_y_set", NULL);
904         RNA_def_property_ui_text(prop, "Scale Y", "Scale factor along the Y for items in this (sub)layout");
905         RNA_api_ui_layout(srna);
906 }
907
908 static void rna_def_panel(BlenderRNA *brna)
909 {
910         StructRNA *srna;
911         PropertyRNA *prop;
912         PropertyRNA *parm;
913         FunctionRNA *func;
914         
915         static EnumPropertyItem panel_flag_items[] = {
916                 {PNL_DEFAULT_CLOSED, "DEFAULT_CLOSED", 0, "Default Closed",
917                                      "Defines if the panel has to be open or collapsed at the time of its creation"},
918                 {PNL_NO_HEADER, "HIDE_HEADER", 0, "Hide Header",
919                                 "If set to False, the panel shows a header, which contains a clickable "
920                                 "arrow to collapse the panel and the label (see bl_label)"},
921                 {0, NULL, 0, NULL, NULL}
922         };
923         
924         srna = RNA_def_struct(brna, "Panel", NULL);
925         RNA_def_struct_ui_text(srna, "Panel", "Panel containing UI elements");
926         RNA_def_struct_sdna(srna, "Panel");
927         RNA_def_struct_refine_func(srna, "rna_Panel_refine");
928         RNA_def_struct_register_funcs(srna, "rna_Panel_register", "rna_Panel_unregister", NULL);
929         RNA_def_struct_translation_context(srna, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
930
931         /* poll */
932         func = RNA_def_function(srna, "poll", NULL);
933         RNA_def_function_ui_description(func, "If this method returns a non-null output, then the panel can be drawn");
934         RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL);
935         RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
936         parm = RNA_def_pointer(func, "context", "Context", "", "");
937         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
938
939         /* draw */
940         func = RNA_def_function(srna, "draw", NULL);
941         RNA_def_function_ui_description(func, "Draw UI elements into the panel UI layout");
942         RNA_def_function_flag(func, FUNC_REGISTER);
943         parm = RNA_def_pointer(func, "context", "Context", "", "");
944         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
945
946         func = RNA_def_function(srna, "draw_header", NULL);
947         RNA_def_function_ui_description(func, "Draw UI elements into the panel's header UI layout");
948         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
949         parm = RNA_def_pointer(func, "context", "Context", "", "");
950         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
951
952         prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
953         RNA_def_property_struct_type(prop, "UILayout");
954         RNA_def_property_ui_text(prop, "Layout", "Defines the structure of the panel in the UI");
955         
956         prop = RNA_def_property(srna, "text", PROP_STRING, PROP_NONE);
957         RNA_def_property_string_sdna(prop, NULL, "drawname");
958         RNA_def_property_ui_text(prop, "Text", "XXX todo");
959         
960         /* registration */
961         prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
962         RNA_def_property_string_sdna(prop, NULL, "type->idname");
963         RNA_def_property_flag(prop, PROP_REGISTER | PROP_NEVER_CLAMP);
964         RNA_def_property_ui_text(prop, "ID Name",
965                                  "If this is set, the panel gets a custom ID, otherwise it takes the "
966                                  "name of the class used to define the panel. For example, if the "
967                                  "class name is \"OBJECT_PT_hello\", and bl_idname is not set by the "
968                                  "script, then bl_idname = \"OBJECT_PT_hello\"");
969
970         prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
971         RNA_def_property_string_sdna(prop, NULL, "type->label");
972         RNA_def_property_flag(prop, PROP_REGISTER);
973         RNA_def_property_ui_text(prop, "Label",
974                                  "The panel label, shows up in the panel header at the right of the "
975                                  "triangle used to collapse the panel");
976
977         prop = RNA_def_property(srna, "bl_translation_context", PROP_STRING, PROP_NONE);
978         RNA_def_property_string_sdna(prop, NULL, "type->translation_context");
979         RNA_def_property_string_default(prop, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
980         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
981         RNA_define_verify_sdna(TRUE);
982
983         prop = RNA_def_property(srna, "bl_space_type", PROP_ENUM, PROP_NONE);
984         RNA_def_property_enum_sdna(prop, NULL, "type->space_type");
985         RNA_def_property_enum_items(prop, space_type_items);
986         RNA_def_property_flag(prop, PROP_REGISTER);
987         RNA_def_property_ui_text(prop, "Space type", "The space where the panel is going to be used in");
988         
989         prop = RNA_def_property(srna, "bl_region_type", PROP_ENUM, PROP_NONE);
990         RNA_def_property_enum_sdna(prop, NULL, "type->region_type");
991         RNA_def_property_enum_items(prop, region_type_items);
992         RNA_def_property_flag(prop, PROP_REGISTER);
993         RNA_def_property_ui_text(prop, "Region Type", "The region where the panel is going to be used in");
994
995         prop = RNA_def_property(srna, "bl_context", PROP_STRING, PROP_NONE);
996         RNA_def_property_string_sdna(prop, NULL, "type->context");
997         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL); /* Only used in Properties Editor and 3D View - Thomas */
998         RNA_def_property_ui_text(prop, "Context",
999                                  "The context in which the panel belongs to. (TODO: explain the "
1000                                  "possible combinations bl_context/bl_region_type/bl_space_type)");
1001         
1002         prop = RNA_def_property(srna, "bl_options", PROP_ENUM, PROP_NONE);
1003         RNA_def_property_enum_sdna(prop, NULL, "type->flag");
1004         RNA_def_property_enum_items(prop, panel_flag_items);
1005         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL | PROP_ENUM_FLAG);
1006         RNA_def_property_ui_text(prop, "Options",  "Options for this panel type");
1007 }
1008
1009 static void rna_def_uilist(BlenderRNA *brna)
1010 {
1011         StructRNA *srna;
1012         PropertyRNA *prop;
1013         PropertyRNA *parm;
1014         FunctionRNA *func;
1015
1016         srna = RNA_def_struct(brna, "UIList", NULL);
1017         RNA_def_struct_ui_text(srna, "UIList", "UI list containing the elements of a collection");
1018         RNA_def_struct_sdna(srna, "uiList");
1019         RNA_def_struct_refine_func(srna, "rna_UIList_refine");
1020         RNA_def_struct_register_funcs(srna, "rna_UIList_register", "rna_UIList_unregister", NULL);
1021         RNA_def_struct_idprops_func(srna, "rna_UIList_idprops");
1022
1023         /* Registration */
1024         prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
1025         RNA_def_property_string_sdna(prop, NULL, "type->idname");
1026         RNA_def_property_flag(prop, PROP_REGISTER | PROP_NEVER_CLAMP);
1027         RNA_def_property_ui_text(prop, "ID Name",
1028                                  "If this is set, the uilist gets a custom ID, otherwise it takes the "
1029                                  "name of the class used to define the uilist (for example, if the "
1030                                  "class name is \"OBJECT_UL_vgroups\", and bl_idname is not set by the "
1031                                  "script, then bl_idname = \"OBJECT_UL_vgroups\")");
1032
1033         /* Data */
1034         prop = RNA_def_property(srna, "layout_type", PROP_ENUM, PROP_NONE);
1035         RNA_def_property_enum_items(prop, uilist_layout_type_items);
1036         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1037
1038         /* Filter options */
1039         prop = RNA_def_property(srna, "use_filter_show", PROP_BOOLEAN, PROP_NONE);
1040         RNA_def_property_boolean_sdna(prop, NULL, "filter_flag", UILST_FLT_SHOW);
1041         RNA_def_property_ui_text(prop, "Show Filter", "Show filtering options");
1042
1043         prop = RNA_def_property(srna, "filter_name", PROP_STRING, PROP_NONE);
1044         RNA_def_property_string_sdna(prop, NULL, "filter_byname");
1045         RNA_def_property_ui_text(prop, "Filter by Name", "Only show items matching this name (use '*' as wildcard)");
1046
1047         prop = RNA_def_property(srna, "use_filter_invert", PROP_BOOLEAN, PROP_NONE);
1048         RNA_def_property_boolean_sdna(prop, NULL, "filter_flag", UILST_FLT_EXCLUDE);
1049         RNA_def_property_ui_text(prop, "Invert", "Invert filtering (show hidden items, and vice-versa)");
1050
1051         prop = RNA_def_property(srna, "use_filter_sort_alpha", PROP_BOOLEAN, PROP_NONE);
1052         RNA_def_property_boolean_sdna(prop, NULL, "filter_sort_flag", UILST_FLT_SORT_ALPHA);
1053         RNA_def_property_ui_icon(prop, ICON_SORTALPHA, 0);
1054         RNA_def_property_ui_text(prop, "Sort by Name", "Sort items by their name");
1055
1056         prop = RNA_def_property(srna, "use_filter_sort_reverse", PROP_BOOLEAN, PROP_NONE);
1057         RNA_def_property_boolean_sdna(prop, NULL, "filter_sort_flag", UILST_FLT_SORT_REVERSE);
1058         RNA_def_property_ui_text(prop, "Invert", "Invert the order of shown items");
1059
1060         /* draw_item */
1061         func = RNA_def_function(srna, "draw_item", NULL);
1062         RNA_def_function_ui_description(func, "Draw an item in the list (NOTE: when you define your own draw_item "
1063                                               "function, you may want to check given 'item' is of the right type...)");
1064         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
1065         parm = RNA_def_pointer(func, "context", "Context", "", "");
1066         RNA_def_property_flag(parm, PROP_REQUIRED);
1067         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Layout to draw the item");
1068         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
1069         parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take Collection property");
1070         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_RNAPTR);
1071         parm = RNA_def_pointer(func, "item", "AnyType", "", "Item of the collection property");
1072         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_RNAPTR);
1073         parm = RNA_def_int(func, "icon", 0, 0, INT_MAX, "", "Icon of the item in the collection", 0, INT_MAX);
1074         RNA_def_property_flag(parm, PROP_REQUIRED);
1075         parm = RNA_def_pointer(func, "active_data", "AnyType", "",
1076                                "Data from which to take property for the active element");
1077         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_RNAPTR | PROP_NEVER_NULL);
1078         parm = RNA_def_string(func, "active_property", "", 0, "",
1079                               "Identifier of property in active_data, for the active element");
1080         RNA_def_property_flag(parm, PROP_REQUIRED);
1081         RNA_def_int(func, "index", 0, 0, INT_MAX, "", "Index of the item in the collection", 0, INT_MAX);
1082         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_PYFUNC_OPTIONAL);
1083         prop = RNA_def_property(func, "flt_flag", PROP_INT, PROP_UNSIGNED);
1084         RNA_def_property_ui_text(prop, "", "The filter-flag result for this item");
1085         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_PYFUNC_OPTIONAL);
1086
1087         /* draw_filter */
1088         func = RNA_def_function(srna, "draw_filter", NULL);
1089         RNA_def_function_ui_description(func, "Draw filtering options");
1090         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
1091         parm = RNA_def_pointer(func, "context", "Context", "", "");
1092         RNA_def_property_flag(parm, PROP_REQUIRED);
1093         parm = RNA_def_pointer(func, "layout", "UILayout", "", "Layout to draw the item");
1094         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL);
1095
1096         /* filter */
1097         func = RNA_def_function(srna, "filter_items", NULL);
1098         RNA_def_function_ui_description(func, "Filter and/or re-order items of the collection (output filter results in "
1099                                               "filter_flags, and reorder results in filter_neworder arrays)");
1100         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
1101         parm = RNA_def_pointer(func, "context", "Context", "", "");
1102         RNA_def_property_flag(parm, PROP_REQUIRED);
1103         parm = RNA_def_pointer(func, "data", "AnyType", "", "Data from which to take Collection property");
1104         RNA_def_property_flag(parm, PROP_REQUIRED | PROP_RNAPTR);
1105         parm = RNA_def_string(func, "property", "", 0, "", "Identifier of property in data, for the collection");
1106         RNA_def_property_flag(parm, PROP_REQUIRED);
1107         prop = RNA_def_property(func, "filter_flags", PROP_INT, PROP_UNSIGNED);
1108         RNA_def_property_flag(prop, PROP_REQUIRED | PROP_DYNAMIC);
1109         RNA_def_property_array(prop, 1);  /* XXX Dummy value, default 0 does not work */
1110         RNA_def_property_ui_text(prop, "", "An array of filter flags, one for each item in the collection (NOTE: "
1111                                            "FILTER_ITEM bit is reserved, it defines whether the item is shown or not)");
1112         RNA_def_function_output(func, prop);
1113         prop = RNA_def_property(func, "filter_neworder", PROP_INT, PROP_UNSIGNED);
1114         RNA_def_property_flag(prop, PROP_REQUIRED | PROP_DYNAMIC);
1115         RNA_def_property_array(prop, 1);  /* XXX Dummy value, default 0 does not work */
1116         RNA_def_property_ui_text(prop, "", "An array of indices, one for each item in the collection, mapping the org "
1117                                            "index to the new one");
1118         RNA_def_function_output(func, prop);
1119
1120         /* "Constants"! */
1121         RNA_define_verify_sdna(0); /* not in sdna */
1122
1123         prop = RNA_def_property(srna, "bitflag_filter_item", PROP_INT, PROP_UNSIGNED);
1124         RNA_def_property_ui_text(prop, "FILTER_ITEM",
1125                                        "The value of the reserved bitflag 'FILTER_ITEM' (in filter_flags values)");
1126         RNA_def_property_int_funcs(prop, "rna_UIList_filter_const_FILTER_ITEM_get", NULL, NULL);
1127         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1128 }
1129
1130 static void rna_def_header(BlenderRNA *brna)
1131 {
1132         StructRNA *srna;
1133         PropertyRNA *prop;
1134         PropertyRNA *parm;
1135         FunctionRNA *func;
1136         
1137         srna = RNA_def_struct(brna, "Header", NULL);
1138         RNA_def_struct_ui_text(srna, "Header", "Editor header containing UI elements");
1139         RNA_def_struct_sdna(srna, "Header");
1140         RNA_def_struct_refine_func(srna, "rna_Header_refine");
1141         RNA_def_struct_register_funcs(srna, "rna_Header_register", "rna_Header_unregister", NULL);
1142
1143         /* draw */
1144         func = RNA_def_function(srna, "draw", NULL);
1145         RNA_def_function_ui_description(func, "Draw UI elements into the header UI layout");
1146         RNA_def_function_flag(func, FUNC_REGISTER);
1147         parm = RNA_def_pointer(func, "context", "Context", "", "");
1148         RNA_def_property_flag(parm, PROP_REQUIRED);
1149
1150         RNA_define_verify_sdna(0); /* not in sdna */
1151
1152         prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
1153         RNA_def_property_pointer_sdna(prop, NULL, "layout");
1154         RNA_def_property_struct_type(prop, "UILayout");
1155         RNA_def_property_ui_text(prop, "Layout", "Structure of the header in the UI");
1156
1157         /* registration */
1158         prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
1159         RNA_def_property_string_sdna(prop, NULL, "type->idname");
1160         RNA_def_property_flag(prop, PROP_REGISTER | PROP_NEVER_CLAMP);
1161         RNA_def_property_ui_text(prop, "ID Name",
1162                                  "If this is set, the header gets a custom ID, otherwise it takes the "
1163                                  "name of the class used to define the panel; for example, if the "
1164                                  "class name is \"OBJECT_HT_hello\", and bl_idname is not set by the "
1165                                  "script, then bl_idname = \"OBJECT_HT_hello\"");
1166
1167         prop = RNA_def_property(srna, "bl_space_type", PROP_ENUM, PROP_NONE);
1168         RNA_def_property_enum_sdna(prop, NULL, "type->space_type");
1169         RNA_def_property_enum_items(prop, space_type_items);
1170         RNA_def_property_flag(prop, PROP_REGISTER);
1171         RNA_def_property_ui_text(prop, "Space type", "The space where the header is going to be used in");
1172
1173         RNA_define_verify_sdna(1);
1174 }
1175
1176 static void rna_def_menu(BlenderRNA *brna)
1177 {
1178         StructRNA *srna;
1179         PropertyRNA *prop;
1180         PropertyRNA *parm;
1181         FunctionRNA *func;
1182         
1183         srna = RNA_def_struct(brna, "Menu", NULL);
1184         RNA_def_struct_ui_text(srna, "Menu", "Editor menu containing buttons");
1185         RNA_def_struct_sdna(srna, "Menu");
1186         RNA_def_struct_refine_func(srna, "rna_Menu_refine");
1187         RNA_def_struct_register_funcs(srna, "rna_Menu_register", "rna_Menu_unregister", NULL);
1188         RNA_def_struct_translation_context(srna, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
1189
1190         /* poll */
1191         func = RNA_def_function(srna, "poll", NULL);
1192         RNA_def_function_ui_description(func, "If this method returns a non-null output, then the menu can be drawn");
1193         RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_REGISTER_OPTIONAL);
1194         RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
1195         parm = RNA_def_pointer(func, "context", "Context", "", "");
1196         RNA_def_property_flag(parm, PROP_REQUIRED);
1197
1198         /* draw */
1199         func = RNA_def_function(srna, "draw", NULL);
1200         RNA_def_function_ui_description(func, "Draw UI elements into the menu UI layout");
1201         RNA_def_function_flag(func, FUNC_REGISTER);
1202         parm = RNA_def_pointer(func, "context", "Context", "", "");
1203         RNA_def_property_flag(parm, PROP_REQUIRED);
1204
1205         RNA_define_verify_sdna(FALSE); /* not in sdna */
1206
1207         prop = RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
1208         RNA_def_property_pointer_sdna(prop, NULL, "layout");
1209         RNA_def_property_struct_type(prop, "UILayout");
1210         RNA_def_property_ui_text(prop, "Layout", "Defines the structure of the menu in the UI");
1211
1212         /* registration */
1213         prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
1214         RNA_def_property_string_sdna(prop, NULL, "type->idname");
1215         RNA_def_property_flag(prop, PROP_REGISTER | PROP_NEVER_CLAMP);
1216         RNA_def_property_ui_text(prop, "ID Name",
1217                                  "If this is set, the menu gets a custom ID, otherwise it takes the "
1218                                  "name of the class used to define the menu (for example, if the "
1219                                  "class name is \"OBJECT_MT_hello\", and bl_idname is not set by the "
1220                                  "script, then bl_idname = \"OBJECT_MT_hello\")");
1221
1222         prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
1223         RNA_def_property_string_sdna(prop, NULL, "type->label");
1224         RNA_def_property_flag(prop, PROP_REGISTER);
1225         RNA_def_property_ui_text(prop, "Label", "The menu label");
1226
1227         prop = RNA_def_property(srna, "bl_translation_context", PROP_STRING, PROP_NONE);
1228         RNA_def_property_string_sdna(prop, NULL, "type->translation_context");
1229         RNA_def_property_string_default(prop, BLF_I18NCONTEXT_DEFAULT_BPYRNA);
1230         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
1231
1232         prop = RNA_def_property(srna, "bl_description", PROP_STRING, PROP_NONE);
1233         RNA_def_property_string_sdna(prop, NULL, "type->description");
1234         RNA_def_property_string_maxlength(prop, RNA_DYN_DESCR_MAX); /* else it uses the pointer size! */
1235         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Menu_bl_description_set");
1236         /* RNA_def_property_clear_flag(prop, PROP_EDITABLE); */
1237         RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
1238         RNA_def_property_clear_flag(prop, PROP_NEVER_NULL); /* check for NULL */
1239
1240         RNA_define_verify_sdna(1);
1241 }
1242
1243 void RNA_def_ui(BlenderRNA *brna)
1244 {
1245         rna_def_ui_layout(brna);
1246         rna_def_panel(brna);
1247         rna_def_uilist(brna);
1248         rna_def_header(brna);
1249         rna_def_menu(brna);
1250 }
1251
1252 #endif /* RNA_RUNTIME */
1253