py/rna Operator.cancel method didnt have return defined.
[blender.git] / source / blender / makesrna / intern / rna_wm_api.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file blender/makesrna/intern/rna_wm_api.c
30  *  \ingroup RNA
31  */
32
33
34 #include <stdlib.h>
35 #include <stdio.h>
36
37 #include "RNA_define.h"
38 #include "RNA_enum_types.h"
39
40 #include "DNA_screen_types.h"
41 #include "DNA_space_types.h"
42 #include "DNA_windowmanager_types.h"
43
44 #ifdef RNA_RUNTIME
45
46 #include "BKE_context.h"
47
48 static wmKeyMap *rna_keymap_active(wmKeyMap *km, bContext *C)
49 {
50         wmWindowManager *wm = CTX_wm_manager(C);
51         return WM_keymap_active(wm, km);
52 }
53
54 static void rna_keymap_restore_item_to_default(wmKeyMap *km, bContext *C, wmKeyMapItem *kmi)
55 {
56         WM_keymap_restore_item_to_default(C, km, kmi);
57 }
58
59 static void rna_Operator_report(wmOperator *op, int type, const char *msg)
60 {
61         BKE_report(op->reports, type, msg);
62 }
63
64 /* since event isnt needed... */
65 static void rna_Operator_enum_search_invoke(bContext *C, wmOperator *op)
66 {
67         WM_enum_search_invoke(C, op, NULL);
68         
69 }
70
71 static int rna_event_modal_handler_add(struct bContext *C, struct wmOperator *operator)
72 {
73         return WM_event_add_modal_handler(C, operator) != NULL;
74 }
75
76 /* XXX, need a way for python to know event types, 0x0110 is hard coded */
77 struct wmTimer *rna_event_timer_add(struct wmWindowManager *wm, float time_step, wmWindow *win)
78 {
79         return WM_event_add_timer(wm, win, 0x0110, time_step);
80 }
81
82 void rna_event_timer_remove(struct wmWindowManager *wm, wmTimer *timer)
83 {
84         return WM_event_remove_timer(wm, timer->win, timer);
85 }
86
87 #else
88
89 #define WM_GEN_INVOKE_EVENT (1<<0)
90 #define WM_GEN_INVOKE_SIZE (1<<1)
91 #define WM_GEN_INVOKE_RETURN (1<<2)
92
93 static void rna_generic_op_invoke(FunctionRNA *func, int flag)
94 {
95         PropertyRNA *parm;
96
97         RNA_def_function_flag(func, FUNC_NO_SELF|FUNC_USE_CONTEXT);
98         parm= RNA_def_pointer(func, "operator", "Operator", "", "Operator to call.");
99         RNA_def_property_flag(parm, PROP_REQUIRED);
100
101         if(flag & WM_GEN_INVOKE_EVENT) {
102                 parm= RNA_def_pointer(func, "event", "Event", "", "Event.");
103                 RNA_def_property_flag(parm, PROP_REQUIRED);
104         }
105
106         if(flag & WM_GEN_INVOKE_SIZE) {
107                 RNA_def_int(func, "width", 300, 0, INT_MAX, "", "Width of the popup.", 0, INT_MAX);
108                 RNA_def_int(func, "height", 20, 0, INT_MAX, "", "Height of the popup.", 0, INT_MAX);
109         }
110
111         if(flag & WM_GEN_INVOKE_RETURN) {
112                 parm= RNA_def_enum_flag(func, "result", operator_return_items, OPERATOR_CANCELLED, "result", "");
113                 RNA_def_function_return(func, parm);
114         }
115 }
116
117 void RNA_api_wm(StructRNA *srna)
118 {
119         FunctionRNA *func;
120         PropertyRNA *parm;
121
122         func= RNA_def_function(srna, "fileselect_add", "WM_event_add_fileselect");
123         RNA_def_function_ui_description(func, "Show up the file selector.");
124         rna_generic_op_invoke(func, 0);
125
126         func= RNA_def_function(srna, "modal_handler_add", "rna_event_modal_handler_add");
127         RNA_def_function_flag(func, FUNC_NO_SELF|FUNC_USE_CONTEXT);
128         parm= RNA_def_pointer(func, "operator", "Operator", "", "Operator to call.");
129         RNA_def_property_flag(parm, PROP_REQUIRED);
130         RNA_def_function_return(func, RNA_def_boolean(func, "handle", 1, "", ""));
131
132
133         func= RNA_def_function(srna, "event_timer_add", "rna_event_timer_add");
134         parm= RNA_def_property(func, "time_step", PROP_FLOAT, PROP_NONE);
135         RNA_def_property_flag(parm, PROP_REQUIRED);
136         RNA_def_property_range(parm, 0.0, FLT_MAX);
137         RNA_def_property_ui_text(parm, "Time Step", "Interval in seconds between timer events");
138         parm= RNA_def_pointer(func, "window", "Window", "", "Window to attach the timer to or None.");
139         parm= RNA_def_pointer(func, "result", "Timer", "", "");
140         RNA_def_function_return(func, parm);
141
142
143         func= RNA_def_function(srna, "event_timer_remove", "rna_event_timer_remove");
144         parm= RNA_def_pointer(func, "timer", "Timer", "", "");
145         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
146
147
148         /* invoke functions, for use with python */
149         func= RNA_def_function(srna, "invoke_props_popup", "WM_operator_props_popup");
150         RNA_def_function_ui_description(func, "Operator popup invoke.");
151         rna_generic_op_invoke(func, WM_GEN_INVOKE_EVENT|WM_GEN_INVOKE_RETURN);
152
153         /* invoked dialog opens popup with OK button, does not auto-exec operator. */
154         func= RNA_def_function(srna, "invoke_props_dialog", "WM_operator_props_dialog_popup");
155         RNA_def_function_ui_description(func, "Operator dialog (non-autoexec popup) invoke.");
156         rna_generic_op_invoke(func, WM_GEN_INVOKE_SIZE|WM_GEN_INVOKE_RETURN);
157
158         /* invoke enum */
159         func= RNA_def_function(srna, "invoke_search_popup", "rna_Operator_enum_search_invoke");
160         rna_generic_op_invoke(func, 0);
161
162         /* invoke functions, for use with python */
163         func= RNA_def_function(srna, "invoke_popup", "WM_operator_ui_popup");
164         RNA_def_function_ui_description(func, "Operator popup invoke.");
165         rna_generic_op_invoke(func, WM_GEN_INVOKE_SIZE|WM_GEN_INVOKE_RETURN);
166
167         func= RNA_def_function(srna, "invoke_confirm", "WM_operator_confirm");
168         RNA_def_function_ui_description(func, "Operator confirmation.");
169         rna_generic_op_invoke(func, WM_GEN_INVOKE_EVENT|WM_GEN_INVOKE_RETURN);
170         
171 }
172
173 void RNA_api_operator(StructRNA *srna)
174 {
175         FunctionRNA *func;
176         PropertyRNA *parm;
177
178         /* utility, not for registering */
179         func= RNA_def_function(srna, "report", "rna_Operator_report");
180         parm= RNA_def_enum_flag(func, "type", wm_report_items, 0, "Type", "");
181         RNA_def_property_flag(parm, PROP_REQUIRED);
182         parm= RNA_def_string(func, "message", "", 0, "Report Message", "");
183         RNA_def_property_flag(parm, PROP_REQUIRED);
184
185
186         /* Registration */
187
188         /* poll */
189         func= RNA_def_function(srna, "poll", NULL);
190         RNA_def_function_ui_description(func, "Test if the operator can be called or not.");
191         RNA_def_function_flag(func, FUNC_NO_SELF|FUNC_REGISTER_OPTIONAL);
192         RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
193         parm= RNA_def_pointer(func, "context", "Context", "", "");
194         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
195
196         /* exec */
197         func= RNA_def_function(srna, "execute", NULL);
198         RNA_def_function_ui_description(func, "Execute the operator.");
199         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
200         parm= RNA_def_pointer(func, "context", "Context", "", "");
201         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
202
203         parm= RNA_def_enum_flag(func, "result", operator_return_items, OPERATOR_CANCELLED, "result", ""); // better name?
204         RNA_def_function_return(func, parm);
205
206         /* check */
207         func= RNA_def_function(srna, "check", NULL);
208         RNA_def_function_ui_description(func, "Check the operator settings.");
209         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
210         parm= RNA_def_pointer(func, "context", "Context", "", "");
211         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
212
213         parm= RNA_def_boolean(func, "result", 0, "result", ""); // better name?
214         RNA_def_function_return(func, parm);
215         
216         /* invoke */
217         func= RNA_def_function(srna, "invoke", NULL);
218         RNA_def_function_ui_description(func, "Invoke the operator.");
219         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
220         parm= RNA_def_pointer(func, "context", "Context", "", "");
221         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
222         parm= RNA_def_pointer(func, "event", "Event", "", "");
223         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
224
225         parm= RNA_def_enum_flag(func, "result", operator_return_items, OPERATOR_CANCELLED, "result", ""); // better name?
226         RNA_def_function_return(func, parm);
227
228         func= RNA_def_function(srna, "modal", NULL); /* same as invoke */
229         RNA_def_function_ui_description(func, "Modal operator function.");
230         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
231         parm= RNA_def_pointer(func, "context", "Context", "", "");
232         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
233         parm= RNA_def_pointer(func, "event", "Event", "", "");
234         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
235
236         parm= RNA_def_enum_flag(func, "result", operator_return_items, OPERATOR_CANCELLED, "result", ""); // better name?
237         RNA_def_function_return(func, parm);
238
239         /* draw */
240         func= RNA_def_function(srna, "draw", NULL);
241         RNA_def_function_ui_description(func, "Draw function for the operator.");
242         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
243         parm= RNA_def_pointer(func, "context", "Context", "", "");
244         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
245
246         /* cancel */
247         func= RNA_def_function(srna, "cancel", NULL);
248         RNA_def_function_ui_description(func, "Called when the operator is cancelled.");
249         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
250         parm= RNA_def_pointer(func, "context", "Context", "", "");
251         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
252
253         parm= RNA_def_enum_flag(func, "result", operator_return_items, OPERATOR_CANCELLED, "result", ""); // better name?
254         RNA_def_function_return(func, parm);
255 }
256
257 void RNA_api_macro(StructRNA *srna)
258 {
259         FunctionRNA *func;
260         PropertyRNA *parm;
261
262         /* utility, not for registering */
263         func= RNA_def_function(srna, "report", "rna_Operator_report");
264         parm= RNA_def_enum_flag(func, "type", wm_report_items, 0, "Type", "");
265         RNA_def_property_flag(parm, PROP_REQUIRED);
266         parm= RNA_def_string(func, "message", "", 0, "Report Message", "");
267         RNA_def_property_flag(parm, PROP_REQUIRED);
268
269
270         /* Registration */
271
272         /* poll */
273         func= RNA_def_function(srna, "poll", NULL);
274         RNA_def_function_ui_description(func, "Test if the operator can be called or not.");
275         RNA_def_function_flag(func, FUNC_NO_SELF|FUNC_REGISTER_OPTIONAL);
276         RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
277         parm= RNA_def_pointer(func, "context", "Context", "", "");
278         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
279
280         /* draw */
281         func= RNA_def_function(srna, "draw", NULL);
282         RNA_def_function_ui_description(func, "Draw function for the operator.");
283         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
284         parm= RNA_def_pointer(func, "context", "Context", "", "");
285         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
286 }
287
288 void RNA_api_keyconfig(StructRNA *srna)
289 {
290         // FunctionRNA *func;
291         // PropertyRNA *parm;
292 }
293
294 void RNA_api_keymap(StructRNA *srna)
295 {
296         FunctionRNA *func;
297         PropertyRNA *parm;
298
299         func= RNA_def_function(srna, "active", "rna_keymap_active");
300         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
301         parm= RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Active key map.");
302         RNA_def_function_return(func, parm);
303
304         func= RNA_def_function(srna, "copy_to_user", "WM_keymap_copy_to_user");
305         parm= RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "User editable key map.");
306         RNA_def_function_return(func, parm);
307
308         RNA_def_function(srna, "restore_to_default", "WM_keymap_restore_to_default");
309
310         func= RNA_def_function(srna, "restore_item_to_default", "rna_keymap_restore_item_to_default");
311         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
312         parm= RNA_def_pointer(func, "item", "KeyMapItem", "Item", "");
313         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
314 }
315
316 void RNA_api_keymapitem(StructRNA *srna)
317 {
318         FunctionRNA *func;
319         PropertyRNA *parm;
320
321         func= RNA_def_function(srna, "compare", "WM_keymap_item_compare");
322         parm= RNA_def_pointer(func, "item", "KeyMapItem", "Item", "");
323         RNA_def_property_flag(parm, PROP_REQUIRED);
324         parm= RNA_def_boolean(func, "result", 0, "Comparison result", "");
325         RNA_def_function_return(func, parm);
326 }
327 #endif
328