UI:
[blender.git] / source / blender / makesrna / intern / rna_ui.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Blender Foundation (2009)
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31 #include "RNA_enum_types.h"
32
33 #ifdef RNA_RUNTIME
34
35 #include "MEM_guardedalloc.h"
36
37 #include "RNA_access.h"
38
39 #include "DNA_screen_types.h"
40
41 #include "BLI_dynstr.h"
42
43 #include "BKE_context.h"
44 #include "BKE_report.h"
45 #include "BKE_screen.h"
46
47 #include "UI_interface.h"
48
49 #include "WM_api.h"
50 #include "WM_types.h"
51
52 static ARegionType *region_type_find(ReportList *reports, int space_type, int region_type)
53 {
54         SpaceType *st;
55         ARegionType *art;
56
57         st= BKE_spacetype_from_id(space_type);
58
59         for(art= (st)? st->regiontypes.first: NULL; art; art= art->next) {
60                 if (art->regionid==region_type)
61                         break;
62         }
63         
64         /* region type not found? abort */
65         if (art==NULL) {
66                 BKE_report(reports, RPT_ERROR, "Region not found in spacetype.");
67                 return NULL;
68         }
69
70         return art;
71 }
72
73 /* Panel */
74
75 static int panel_poll(const bContext *C, PanelType *pt)
76 {
77         PointerRNA ptr;
78         ParameterList *list;
79         FunctionRNA *func;
80         void *ret;
81         int visible;
82
83         RNA_pointer_create(NULL, pt->py_srna, NULL, &ptr); /* dummy */
84         func= RNA_struct_find_function(&ptr, "poll");
85
86         list= RNA_parameter_list_create(&ptr, func);
87         RNA_parameter_set_lookup(list, "context", &C);
88         pt->py_call(&ptr, func, list);
89
90         RNA_parameter_get_lookup(list, "visible", &ret);
91         visible= *(int*)ret;
92
93         RNA_parameter_list_free(list);
94
95         return visible;
96 }
97
98 static void panel_draw(const bContext *C, Panel *pnl)
99 {
100         PointerRNA ptr;
101         ParameterList *list;
102         FunctionRNA *func;
103
104         RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->py_srna, pnl, &ptr);
105         func= RNA_struct_find_function(&ptr, "draw");
106
107         list= RNA_parameter_list_create(&ptr, func);
108         RNA_parameter_set_lookup(list, "context", &C);
109         pnl->type->py_call(&ptr, func, list);
110
111         RNA_parameter_list_free(list);
112 }
113
114 static void panel_draw_header(const bContext *C, Panel *pnl)
115 {
116         PointerRNA ptr;
117         ParameterList *list;
118         FunctionRNA *func;
119
120         RNA_pointer_create(&CTX_wm_screen(C)->id, pnl->type->py_srna, pnl, &ptr);
121         func= RNA_struct_find_function(&ptr, "draw_header");
122
123         list= RNA_parameter_list_create(&ptr, func);
124         RNA_parameter_set_lookup(list, "context", &C);
125         pnl->type->py_call(&ptr, func, list);
126
127         RNA_parameter_list_free(list);
128 }
129
130 static void rna_Panel_unregister(const bContext *C, StructRNA *type)
131 {
132         ARegionType *art;
133         PanelType *pt= RNA_struct_blender_type_get(type);
134
135         if(!pt)
136                 return;
137         if(!(art=region_type_find(NULL, pt->space_type, pt->region_type)))
138                 return;
139         
140         BLI_freelinkN(&art->paneltypes, pt);
141         RNA_struct_free(&BLENDER_RNA, type);
142
143         /* update while blender is running */
144         if(C)
145                 WM_event_add_notifier(C, NC_SCREEN|NA_EDITED, NULL);
146 }
147
148 static StructRNA *rna_Panel_register(const bContext *C, ReportList *reports, void *data, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
149 {
150         ARegionType *art;
151         PanelType *pt, dummypt = {0};
152         Panel dummypanel= {0};
153         PointerRNA dummyptr;
154         int have_function[3];
155
156         /* setup dummy panel & panel type to store static properties in */
157         dummypanel.type= &dummypt;
158         RNA_pointer_create(NULL, &RNA_Panel, &dummypanel, &dummyptr);
159
160         /* validate the python class */
161         if(validate(&dummyptr, data, have_function) != 0)
162                 return NULL;
163         
164         if(!(art=region_type_find(reports, dummypt.space_type, dummypt.region_type)))
165                 return NULL;
166
167         /* check if we have registered this panel type before, and remove it */
168         for(pt=art->paneltypes.first; pt; pt=pt->next) {
169                 if(strcmp(pt->idname, dummypt.idname) == 0) {
170                         if(pt->py_srna)
171                                 rna_Panel_unregister(C, pt->py_srna);
172                         break;
173                 }
174         }
175         
176         /* create a new panel type */
177         pt= MEM_callocN(sizeof(PanelType), "python buttons panel");
178         memcpy(pt, &dummypt, sizeof(dummypt));
179
180         pt->py_srna= RNA_def_struct(&BLENDER_RNA, pt->idname, "Panel"); 
181         pt->py_data= data;
182         pt->py_call= call;
183         pt->py_free= free;
184         RNA_struct_blender_type_set(pt->py_srna, pt);
185
186         pt->poll= (have_function[0])? panel_poll: NULL;
187         pt->draw= (have_function[1])? panel_draw: NULL;
188         pt->draw_header= (have_function[2])? panel_draw_header: NULL;
189
190         BLI_addtail(&art->paneltypes, pt);
191
192         /* update while blender is running */
193         if(C)
194                 WM_event_add_notifier(C, NC_SCREEN|NA_EDITED, NULL);
195         
196         return pt->py_srna;
197 }
198
199 static StructRNA* rna_Panel_refine(struct PointerRNA *ptr)
200 {
201         Panel *hdr= (Panel*)ptr->data;
202         return (hdr->type)? hdr->type->py_srna: &RNA_Panel;
203 }
204
205 /* Header */
206
207 static void header_draw(const bContext *C, Header *hdr)
208 {
209         PointerRNA htr;
210         ParameterList *list;
211         FunctionRNA *func;
212
213         RNA_pointer_create(&CTX_wm_screen(C)->id, hdr->type->py_srna, hdr, &htr);
214         func= RNA_struct_find_function(&htr, "draw");
215
216         list= RNA_parameter_list_create(&htr, func);
217         RNA_parameter_set_lookup(list, "context", &C);
218         hdr->type->py_call(&htr, func, list);
219
220         RNA_parameter_list_free(list);
221 }
222
223 static void rna_Header_unregister(const bContext *C, StructRNA *type)
224 {
225         ARegionType *art;
226         HeaderType *ht= RNA_struct_blender_type_get(type);
227
228         if(!ht)
229                 return;
230         if(!(art=region_type_find(NULL, ht->space_type, RGN_TYPE_HEADER)))
231                 return;
232         
233         BLI_freelinkN(&art->headertypes, ht);
234         RNA_struct_free(&BLENDER_RNA, type);
235
236         /* update while blender is running */
237         if(C)
238                 WM_event_add_notifier(C, NC_SCREEN|NA_EDITED, NULL);
239 }
240
241 static StructRNA *rna_Header_register(const bContext *C, ReportList *reports, void *data, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
242 {
243         ARegionType *art;
244         HeaderType *ht, dummyht = {0};
245         Header dummyheader= {0};
246         PointerRNA dummyhtr;
247         int have_function[1];
248
249         /* setup dummy header & header type to store static properties in */
250         dummyheader.type= &dummyht;
251         RNA_pointer_create(NULL, &RNA_Header, &dummyheader, &dummyhtr);
252
253         /* validate the python class */
254         if(validate(&dummyhtr, data, have_function) != 0)
255                 return NULL;
256         
257         if(!(art=region_type_find(reports, dummyht.space_type, RGN_TYPE_HEADER)))
258                 return NULL;
259
260         /* check if we have registered this header type before, and remove it */
261         for(ht=art->headertypes.first; ht; ht=ht->next) {
262                 if(strcmp(ht->idname, dummyht.idname) == 0) {
263                         if(ht->py_srna)
264                                 rna_Header_unregister(C, ht->py_srna);
265                         break;
266                 }
267         }
268         
269         /* create a new header type */
270         ht= MEM_callocN(sizeof(HeaderType), "python buttons header");
271         memcpy(ht, &dummyht, sizeof(dummyht));
272
273         ht->py_srna= RNA_def_struct(&BLENDER_RNA, ht->idname, "Header"); 
274         ht->py_data= data;
275         ht->py_call= call;
276         ht->py_free= free;
277         RNA_struct_blender_type_set(ht->py_srna, ht);
278
279         ht->draw= (have_function[0])? header_draw: NULL;
280
281         BLI_addtail(&art->headertypes, ht);
282
283         /* update while blender is running */
284         if(C)
285                 WM_event_add_notifier(C, NC_SCREEN|NA_EDITED, NULL);
286         
287         return ht->py_srna;
288 }
289
290 static StructRNA* rna_Header_refine(struct PointerRNA *htr)
291 {
292         Header *hdr= (Header*)htr->data;
293         return (hdr->type)? hdr->type->py_srna: &RNA_Header;
294 }
295
296 /* Menu */
297
298 static int menu_poll(const bContext *C, MenuType *pt)
299 {
300         PointerRNA ptr;
301         ParameterList *list;
302         FunctionRNA *func;
303         void *ret;
304         int visible;
305
306         RNA_pointer_create(NULL, pt->py_srna, NULL, &ptr); /* dummy */
307         func= RNA_struct_find_function(&ptr, "poll");
308
309         list= RNA_parameter_list_create(&ptr, func);
310         RNA_parameter_set_lookup(list, "context", &C);
311         pt->py_call(&ptr, func, list);
312
313         RNA_parameter_get_lookup(list, "visible", &ret);
314         visible= *(int*)ret;
315
316         RNA_parameter_list_free(list);
317
318         return visible;
319 }
320
321 static void menu_draw(const bContext *C, Menu *hdr)
322 {
323         PointerRNA mtr;
324         ParameterList *list;
325         FunctionRNA *func;
326
327         RNA_pointer_create(&CTX_wm_screen(C)->id, hdr->type->py_srna, hdr, &mtr);
328         func= RNA_struct_find_function(&mtr, "draw");
329
330         list= RNA_parameter_list_create(&mtr, func);
331         RNA_parameter_set_lookup(list, "context", &C);
332         hdr->type->py_call(&mtr, func, list);
333
334         RNA_parameter_list_free(list);
335 }
336
337 static void rna_Menu_unregister(const bContext *C, StructRNA *type)
338 {
339         ARegionType *art;
340         MenuType *mt= RNA_struct_blender_type_get(type);
341
342         if(!mt)
343                 return;
344         if(!(art=region_type_find(NULL, mt->space_type, RGN_TYPE_HEADER)))
345                 return;
346         
347         BLI_freelinkN(&art->menutypes, mt);
348         RNA_struct_free(&BLENDER_RNA, type);
349
350         /* update while blender is running */
351         if(C)
352                 WM_event_add_notifier(C, NC_SCREEN|NA_EDITED, NULL);
353 }
354
355 static StructRNA *rna_Menu_register(const bContext *C, ReportList *reports, void *data, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
356 {
357         ARegionType *art;
358         MenuType *mt, dummymt = {0};
359         Menu dummymenu= {0};
360         PointerRNA dummymtr;
361         int have_function[2];
362
363         /* setup dummy menu & menu type to store static properties in */
364         dummymenu.type= &dummymt;
365         RNA_pointer_create(NULL, &RNA_Menu, &dummymenu, &dummymtr);
366
367         /* validate the python class */
368         if(validate(&dummymtr, data, have_function) != 0)
369                 return NULL;
370         
371         if(!(art=region_type_find(reports, dummymt.space_type, RGN_TYPE_HEADER)))
372                 return NULL;
373
374         /* check if we have registered this menu type before, and remove it */
375         for(mt=art->menutypes.first; mt; mt=mt->next) {
376                 if(strcmp(mt->idname, dummymt.idname) == 0) {
377                         if(mt->py_srna)
378                                 rna_Menu_unregister(C, mt->py_srna);
379                         break;
380                 }
381         }
382         
383         /* create a new menu type */
384         mt= MEM_callocN(sizeof(MenuType), "python buttons menu");
385         memcpy(mt, &dummymt, sizeof(dummymt));
386
387         mt->py_srna= RNA_def_struct(&BLENDER_RNA, mt->idname, "Menu"); 
388         mt->py_data= data;
389         mt->py_call= call;
390         mt->py_free= free;
391         RNA_struct_blender_type_set(mt->py_srna, mt);
392
393         mt->poll= (have_function[0])? menu_poll: NULL;
394         mt->draw= (have_function[1])? menu_draw: NULL;
395
396         BLI_addtail(&art->menutypes, mt);
397
398         /* update while blender is running */
399         if(C)
400                 WM_event_add_notifier(C, NC_SCREEN|NA_EDITED, NULL);
401         
402         return mt->py_srna;
403 }
404
405 static StructRNA* rna_Menu_refine(struct PointerRNA *mtr)
406 {
407         Menu *hdr= (Menu*)mtr->data;
408         return (hdr->type)? hdr->type->py_srna: &RNA_Menu;
409 }
410
411 #else
412
413 static void rna_def_ui_layout(BlenderRNA *brna)
414 {
415         StructRNA *srna;
416
417         srna= RNA_def_struct(brna, "UILayout", NULL);
418         RNA_def_struct_sdna(srna, "uiLayout");
419         RNA_def_struct_ui_text(srna, "UI Layout", "User interface layout in a panel or header.");
420
421         RNA_api_ui_layout(srna);
422 }
423
424 static void rna_def_panel(BlenderRNA *brna)
425 {
426         StructRNA *srna;
427         PropertyRNA *prop;
428         FunctionRNA *func;
429         
430         srna= RNA_def_struct(brna, "Panel", NULL);
431         RNA_def_struct_ui_text(srna, "Panel", "Panel containing buttons.");
432         RNA_def_struct_sdna(srna, "Panel");
433         RNA_def_struct_refine_func(srna, "rna_Panel_refine");
434         RNA_def_struct_register_funcs(srna, "rna_Panel_register", "rna_Panel_unregister");
435
436         /* poll */
437         func= RNA_def_function(srna, "poll", NULL);
438         RNA_def_function_ui_description(func, "Test if the panel is visible or not.");
439         RNA_def_function_flag(func, FUNC_REGISTER|FUNC_REGISTER_OPTIONAL);
440         RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
441         RNA_def_pointer(func, "context", "Context", "", "");
442
443         /* draw */
444         func= RNA_def_function(srna, "draw", NULL);
445         RNA_def_function_ui_description(func, "Draw buttons into the panel UI layout.");
446         RNA_def_function_flag(func, FUNC_REGISTER);
447         RNA_def_pointer(func, "context", "Context", "", "");
448
449         func= RNA_def_function(srna, "draw_header", NULL);
450         RNA_def_function_ui_description(func, "Draw buttons into the panel header UI layout.");
451         RNA_def_function_flag(func, FUNC_REGISTER);
452         RNA_def_pointer(func, "context", "Context", "", "");
453
454         prop= RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
455         RNA_def_property_struct_type(prop, "UILayout");
456
457         /* registration */
458         prop= RNA_def_property(srna, "idname", PROP_STRING, PROP_NONE);
459         RNA_def_property_string_sdna(prop, NULL, "type->idname");
460         RNA_def_property_flag(prop, PROP_REGISTER);
461
462         prop= RNA_def_property(srna, "label", PROP_STRING, PROP_NONE);
463         RNA_def_property_string_sdna(prop, NULL, "type->label");
464         RNA_def_property_flag(prop, PROP_REGISTER);
465
466         prop= RNA_def_property(srna, "space_type", PROP_ENUM, PROP_NONE);
467         RNA_def_property_enum_sdna(prop, NULL, "type->space_type");
468         RNA_def_property_enum_items(prop, space_type_items);
469         RNA_def_property_flag(prop, PROP_REGISTER);
470
471         prop= RNA_def_property(srna, "region_type", PROP_ENUM, PROP_NONE);
472         RNA_def_property_enum_sdna(prop, NULL, "type->region_type");
473         RNA_def_property_enum_items(prop, region_type_items);
474         RNA_def_property_flag(prop, PROP_REGISTER);
475
476         prop= RNA_def_property(srna, "context", PROP_STRING, PROP_NONE);
477         RNA_def_property_string_sdna(prop, NULL, "type->context");
478         RNA_def_property_flag(prop, PROP_REGISTER);
479 }
480
481 static void rna_def_header(BlenderRNA *brna)
482 {
483         StructRNA *srna;
484         PropertyRNA *prop;
485         FunctionRNA *func;
486         
487         srna= RNA_def_struct(brna, "Header", NULL);
488         RNA_def_struct_ui_text(srna, "Header", "Editor header containing buttons.");
489         RNA_def_struct_sdna(srna, "Header");
490         RNA_def_struct_refine_func(srna, "rna_Header_refine");
491         RNA_def_struct_register_funcs(srna, "rna_Header_register", "rna_Header_unregister");
492
493         /* draw */
494         func= RNA_def_function(srna, "draw", NULL);
495         RNA_def_function_ui_description(func, "Draw buttons into the header UI layout.");
496         RNA_def_function_flag(func, FUNC_REGISTER);
497         RNA_def_pointer(func, "context", "Context", "", "");
498
499         prop= RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
500         RNA_def_property_struct_type(prop, "UILayout");
501
502         /* registration */
503         prop= RNA_def_property(srna, "idname", PROP_STRING, PROP_NONE);
504         RNA_def_property_string_sdna(prop, NULL, "type->idname");
505         RNA_def_property_flag(prop, PROP_REGISTER);
506
507         prop= RNA_def_property(srna, "space_type", PROP_ENUM, PROP_NONE);
508         RNA_def_property_enum_sdna(prop, NULL, "type->space_type");
509         RNA_def_property_enum_items(prop, space_type_items);
510         RNA_def_property_flag(prop, PROP_REGISTER);
511 }
512
513 static void rna_def_menu(BlenderRNA *brna)
514 {
515         StructRNA *srna;
516         PropertyRNA *prop;
517         FunctionRNA *func;
518         
519         srna= RNA_def_struct(brna, "Menu", NULL);
520         RNA_def_struct_ui_text(srna, "Menu", "Editor menu containing buttons.");
521         RNA_def_struct_sdna(srna, "Menu");
522         RNA_def_struct_refine_func(srna, "rna_Menu_refine");
523         RNA_def_struct_register_funcs(srna, "rna_Menu_register", "rna_Menu_unregister");
524
525         /* poll */
526         func= RNA_def_function(srna, "poll", NULL);
527         RNA_def_function_ui_description(func, "Test if the menu is visible or not.");
528         RNA_def_function_flag(func, FUNC_REGISTER|FUNC_REGISTER_OPTIONAL);
529         RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
530         RNA_def_pointer(func, "context", "Context", "", "");
531
532         /* draw */
533         func= RNA_def_function(srna, "draw", NULL);
534         RNA_def_function_ui_description(func, "Draw buttons into the menu UI layout.");
535         RNA_def_function_flag(func, FUNC_REGISTER);
536         RNA_def_pointer(func, "context", "Context", "", "");
537
538         prop= RNA_def_property(srna, "layout", PROP_POINTER, PROP_NONE);
539         RNA_def_property_struct_type(prop, "UILayout");
540
541         /* registration */
542         prop= RNA_def_property(srna, "idname", PROP_STRING, PROP_NONE);
543         RNA_def_property_string_sdna(prop, NULL, "type->idname");
544         RNA_def_property_flag(prop, PROP_REGISTER);
545
546         prop= RNA_def_property(srna, "label", PROP_STRING, PROP_NONE);
547         RNA_def_property_string_sdna(prop, NULL, "type->label");
548         RNA_def_property_flag(prop, PROP_REGISTER);
549
550         prop= RNA_def_property(srna, "space_type", PROP_ENUM, PROP_NONE);
551         RNA_def_property_enum_sdna(prop, NULL, "type->space_type");
552         RNA_def_property_enum_items(prop, space_type_items);
553         RNA_def_property_flag(prop, PROP_REGISTER);
554 }
555
556 void RNA_def_ui(BlenderRNA *brna)
557 {
558         rna_def_ui_layout(brna);
559         rna_def_panel(brna);
560         rna_def_header(brna);
561         rna_def_menu(brna);
562 }
563
564 #endif
565