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