remove unused rna includes
[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 #include <stdlib.h>
30 #include <stdio.h>
31
32 #include "RNA_define.h"
33 #include "RNA_enum_types.h"
34
35 #include "DNA_screen_types.h"
36 #include "DNA_space_types.h"
37
38 #ifdef RNA_RUNTIME
39
40 #include "BKE_context.h"
41
42 #include "WM_api.h"
43 #include "WM_types.h"
44
45 static wmKeyMap *rna_keymap_add(wmKeyConfig *keyconf, char *idname, int spaceid, int regionid, int modal)
46 {
47         if (modal == 0) {
48                 return WM_keymap_find(keyconf, idname, spaceid, regionid);
49         } else {
50                 return WM_modalkeymap_add(keyconf, idname, NULL); /* items will be lazy init */
51         }
52 }
53
54 static wmKeyMap *rna_keymap_find(wmKeyConfig *keyconf, char *idname, int spaceid, int regionid)
55 {
56         return WM_keymap_list_find(&keyconf->keymaps, idname, spaceid, regionid);
57 }
58
59 static wmKeyMap *rna_keymap_find_modal(wmKeyConfig *keyconf, char *idname)
60 {
61         wmOperatorType *ot = WM_operatortype_find(idname, 0);
62
63         if (!ot)
64                 return NULL;
65         else
66                 return ot->modalkeymap;
67 }
68
69 static wmKeyMap *rna_keymap_active(wmKeyMap *km, bContext *C)
70 {
71         wmWindowManager *wm = CTX_wm_manager(C);
72         return WM_keymap_active(wm, km);
73 }
74
75
76 static wmKeyMapItem *rna_KeyMap_add_modal_item(wmKeyMap *km, bContext *C, ReportList *reports, char* propvalue_str, int type, int value, int any, int shift, int ctrl, int alt, int oskey, int keymodifier)
77 {
78         wmWindowManager *wm = CTX_wm_manager(C);
79         int modifier= 0;
80         int propvalue = 0;
81
82         /* only modal maps */
83         if ((km->flag & KEYMAP_MODAL) == 0) {
84                 BKE_report(reports, RPT_ERROR, "Not a modal keymap.");
85                 return NULL;
86         }
87
88         if (!km->modal_items) {
89                 if(!WM_keymap_user_init(wm, km)) {
90                         BKE_report(reports, RPT_ERROR, "User defined keymap doesn't correspond to a system keymap.");
91                         return NULL;
92                 }
93         }
94
95         if (!km->modal_items) {
96                 BKE_report(reports, RPT_ERROR, "No property values defined.");
97                 return NULL;
98         }
99
100
101         if(RNA_enum_value_from_id(km->modal_items, propvalue_str, &propvalue)==0) {
102                 BKE_report(reports, RPT_WARNING, "Property value not in enumeration.");
103         }
104
105         if(shift) modifier |= KM_SHIFT;
106         if(ctrl) modifier |= KM_CTRL;
107         if(alt) modifier |= KM_ALT;
108         if(oskey) modifier |= KM_OSKEY;
109
110         if(any) modifier = KM_ANY;
111
112         return WM_modalkeymap_add_item(km, type, value, modifier, keymodifier, propvalue);
113 }
114
115 static void rna_keymap_restore_item_to_default(wmKeyMap *km, bContext *C, wmKeyMapItem *kmi)
116 {
117         WM_keymap_restore_item_to_default(C, km, kmi);
118 }
119
120 static wmKeyMapItem *rna_KeyMap_add_item(wmKeyMap *km, ReportList *reports, char *idname, int type, int value, int any, int shift, int ctrl, int alt, int oskey, int keymodifier)
121 {
122 //      wmWindowManager *wm = CTX_wm_manager(C);
123         int modifier= 0;
124
125         /* only on non-modal maps */
126         if (km->flag & KEYMAP_MODAL) {
127                 BKE_report(reports, RPT_ERROR, "Not a non-modal keymap.");
128                 return NULL;
129         }
130
131         if(shift) modifier |= KM_SHIFT;
132         if(ctrl) modifier |= KM_CTRL;
133         if(alt) modifier |= KM_ALT;
134         if(oskey) modifier |= KM_OSKEY;
135
136         if(any) modifier = KM_ANY;
137
138         return WM_keymap_add_item(km, idname, type, value, modifier, keymodifier);
139 }
140
141 static void rna_Operator_report(wmOperator *op, int type, char *msg)
142 {
143         BKE_report(op->reports, type, msg);
144 }
145
146 /* since event isnt needed... */
147 static void rna_Operator_enum_search_invoke(bContext *C, wmOperator *op)
148 {
149         WM_enum_search_invoke(C, op, NULL);
150         
151 }
152
153 static int rna_event_add_modal_handler(struct bContext *C, struct wmOperator *operator)
154 {
155         return WM_event_add_modal_handler(C, operator) != NULL;
156 }
157
158 #else
159
160 #define WM_GEN_INVOKE_EVENT (1<<0)
161 #define WM_GEN_INVOKE_SIZE (1<<1)
162 #define WM_GEN_INVOKE_RETURN (1<<2)
163
164 static void rna_generic_op_invoke(FunctionRNA *func, int flag)
165 {
166         PropertyRNA *parm;
167
168         RNA_def_function_flag(func, FUNC_NO_SELF|FUNC_USE_CONTEXT);
169         parm= RNA_def_pointer(func, "operator", "Operator", "", "Operator to call.");
170         RNA_def_property_flag(parm, PROP_REQUIRED);
171
172         if(flag & WM_GEN_INVOKE_EVENT) {
173                 parm= RNA_def_pointer(func, "event", "Event", "", "Event.");
174                 RNA_def_property_flag(parm, PROP_REQUIRED);
175         }
176
177         if(flag & WM_GEN_INVOKE_SIZE) {
178                 parm= RNA_def_int(func, "width", 300, 0, INT_MAX, "", "Width of the popup.", 0, INT_MAX);
179                 parm= RNA_def_int(func, "height", 20, 0, INT_MAX, "", "Height of the popup.", 0, INT_MAX);
180         }
181
182         if(flag & WM_GEN_INVOKE_RETURN) {
183                 parm= RNA_def_enum(func, "result", operator_return_items, 0, "result", "");
184                 RNA_def_property_flag(parm, PROP_ENUM_FLAG);
185                 RNA_def_function_return(func, parm);
186         }
187 }
188
189 void RNA_api_wm(StructRNA *srna)
190 {
191         FunctionRNA *func;
192         PropertyRNA *parm;
193
194         func= RNA_def_function(srna, "add_fileselect", "WM_event_add_fileselect");
195         RNA_def_function_ui_description(func, "Show up the file selector.");
196         rna_generic_op_invoke(func, 0);
197
198         func= RNA_def_function(srna, "add_keyconfig", "WM_keyconfig_add_user");
199         parm= RNA_def_string(func, "name", "", 0, "Name", "");
200         RNA_def_property_flag(parm, PROP_REQUIRED);
201         parm= RNA_def_pointer(func, "keyconfig", "KeyConfig", "Key Configuration", "Added key configuration.");
202         RNA_def_function_return(func, parm);
203         
204         func= RNA_def_function(srna, "remove_keyconfig", "WM_keyconfig_remove");
205         parm= RNA_def_pointer(func, "keyconfig", "KeyConfig", "Key Configuration", "Removed key configuration.");
206         RNA_def_property_flag(parm, PROP_REQUIRED);
207
208         func= RNA_def_function(srna, "add_modal_handler", "rna_event_add_modal_handler");
209         RNA_def_function_flag(func, FUNC_NO_SELF|FUNC_USE_CONTEXT);
210         parm= RNA_def_pointer(func, "operator", "Operator", "", "Operator to call.");
211         RNA_def_property_flag(parm, PROP_REQUIRED);
212         RNA_def_function_return(func, RNA_def_boolean(func, "handle", 1, "", ""));
213
214         /* invoke functions, for use with python */
215         func= RNA_def_function(srna, "invoke_props_popup", "WM_operator_props_popup");
216         RNA_def_function_ui_description(func, "Operator popup invoke.");
217         rna_generic_op_invoke(func, WM_GEN_INVOKE_EVENT|WM_GEN_INVOKE_RETURN);
218
219         /* invoked dialog opens popup with OK button, does not auto-exec operator. */
220         func= RNA_def_function(srna, "invoke_props_dialog", "WM_operator_props_dialog_popup");
221         RNA_def_function_ui_description(func, "Operator dialog (non-autoexec popup) invoke.");
222         rna_generic_op_invoke(func, WM_GEN_INVOKE_SIZE|WM_GEN_INVOKE_RETURN);
223
224         /* invoke enum */
225         func= RNA_def_function(srna, "invoke_search_popup", "rna_Operator_enum_search_invoke");
226         rna_generic_op_invoke(func, 0);
227
228         /* invoke functions, for use with python */
229         func= RNA_def_function(srna, "invoke_popup", "WM_operator_ui_popup");
230         RNA_def_function_ui_description(func, "Operator popup invoke.");
231         rna_generic_op_invoke(func, WM_GEN_INVOKE_SIZE|WM_GEN_INVOKE_RETURN);
232 }
233
234 void RNA_api_operator(StructRNA *srna)
235 {
236         FunctionRNA *func;
237         PropertyRNA *parm;
238
239         /* utility, not for registering */
240         func= RNA_def_function(srna, "report", "rna_Operator_report");
241         parm= RNA_def_enum(func, "type", wm_report_items, 0, "Type", "");
242         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_ENUM_FLAG);
243         parm= RNA_def_string(func, "message", "", 0, "Report Message", "");
244         RNA_def_property_flag(parm, PROP_REQUIRED);
245
246
247         /* Registration */
248
249         /* poll */
250         func= RNA_def_function(srna, "poll", NULL);
251         RNA_def_function_ui_description(func, "Test if the operator can be called or not.");
252         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
253         RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
254         RNA_def_pointer(func, "context", "Context", "", "");
255
256         /* exec */
257         func= RNA_def_function(srna, "execute", NULL);
258         RNA_def_function_ui_description(func, "Execute the operator.");
259         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
260         RNA_def_pointer(func, "context", "Context", "", "");
261
262         parm= RNA_def_enum(func, "result", operator_return_items, 0, "result", ""); // better name?
263         RNA_def_property_flag(parm, PROP_ENUM_FLAG);
264         RNA_def_function_return(func, parm);
265
266         /* invoke */
267         func= RNA_def_function(srna, "invoke", NULL);
268         RNA_def_function_ui_description(func, "Invoke the operator.");
269         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
270         RNA_def_pointer(func, "context", "Context", "", "");
271         RNA_def_pointer(func, "event", "Event", "", "");
272
273         parm= RNA_def_enum(func, "result", operator_return_items, 0, "result", ""); // better name?
274         RNA_def_property_flag(parm, PROP_ENUM_FLAG);
275         RNA_def_function_return(func, parm);
276
277         func= RNA_def_function(srna, "modal", NULL); /* same as invoke */
278         RNA_def_function_ui_description(func, "Modal operator function.");
279         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
280         RNA_def_pointer(func, "context", "Context", "", "");
281         RNA_def_pointer(func, "event", "Event", "", "");
282
283         parm= RNA_def_enum(func, "result", operator_return_items, 0, "result", ""); // better name?
284         RNA_def_property_flag(parm, PROP_ENUM_FLAG);
285         RNA_def_function_return(func, parm);
286
287         /* draw */
288         func= RNA_def_function(srna, "draw", NULL);
289         RNA_def_function_ui_description(func, "Draw function for the operator.");
290         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
291         RNA_def_pointer(func, "context", "Context", "", "");
292 }
293
294 void RNA_api_macro(StructRNA *srna)
295 {
296         FunctionRNA *func;
297         PropertyRNA *parm;
298
299         /* utility, not for registering */
300         func= RNA_def_function(srna, "report", "rna_Operator_report");
301         parm= RNA_def_enum(func, "type", wm_report_items, 0, "Type", "");
302         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_ENUM_FLAG);
303         parm= RNA_def_string(func, "message", "", 0, "Report Message", "");
304         RNA_def_property_flag(parm, PROP_REQUIRED);
305
306
307         /* Registration */
308
309         /* poll */
310         func= RNA_def_function(srna, "poll", NULL);
311         RNA_def_function_ui_description(func, "Test if the operator can be called or not.");
312         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
313         RNA_def_function_return(func, RNA_def_boolean(func, "visible", 1, "", ""));
314         RNA_def_pointer(func, "context", "Context", "", "");
315
316         /* draw */
317         func= RNA_def_function(srna, "draw", NULL);
318         RNA_def_function_ui_description(func, "Draw function for the operator.");
319         RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
320         RNA_def_pointer(func, "context", "Context", "", "");
321 }
322
323 void RNA_api_keyconfig(StructRNA *srna)
324 {
325         FunctionRNA *func;
326         PropertyRNA *parm;
327
328         func= RNA_def_function(srna, "add_keymap", "rna_keymap_add");
329         parm= RNA_def_string(func, "name", "", 0, "Name", "");
330         RNA_def_property_flag(parm, PROP_REQUIRED);
331         RNA_def_enum(func, "space_type", space_type_items, SPACE_EMPTY, "Space Type", "");
332         RNA_def_enum(func, "region_type", region_type_items, RGN_TYPE_WINDOW, "Region Type", "");
333         RNA_def_boolean(func, "modal", 0, "Modal", "");
334         parm= RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Added key map.");
335         RNA_def_function_return(func, parm);
336
337         func= RNA_def_function(srna, "find_keymap", "rna_keymap_find");
338         parm= RNA_def_string(func, "name", "", 0, "Name", "");
339         RNA_def_property_flag(parm, PROP_REQUIRED);
340         RNA_def_enum(func, "space_type", space_type_items, SPACE_EMPTY, "Space Type", "");
341         RNA_def_enum(func, "region_type", region_type_items, RGN_TYPE_WINDOW, "Region Type", "");
342         parm= RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Corresponding key map.");
343         RNA_def_function_return(func, parm);
344
345         func= RNA_def_function(srna, "find_keymap_modal", "rna_keymap_find_modal");
346         parm= RNA_def_string(func, "name", "", 0, "Operator Name", "");
347         RNA_def_property_flag(parm, PROP_REQUIRED);
348         parm= RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Corresponding key map.");
349         RNA_def_function_return(func, parm);
350 }
351
352 void RNA_api_keymap(StructRNA *srna)
353 {
354         FunctionRNA *func;
355         PropertyRNA *parm;
356
357         func= RNA_def_function(srna, "add_item", "rna_KeyMap_add_item");
358         RNA_def_function_flag(func, FUNC_USE_REPORTS);
359         parm= RNA_def_string(func, "idname", "", 0, "Operator Identifier", "");
360         RNA_def_property_flag(parm, PROP_REQUIRED);
361         parm= RNA_def_enum(func, "type", event_type_items, 0, "Type", "");
362         RNA_def_property_flag(parm, PROP_REQUIRED);
363         parm= RNA_def_enum(func, "value", event_value_items, 0, "Value", "");
364         RNA_def_property_flag(parm, PROP_REQUIRED);
365         RNA_def_boolean(func, "any", 0, "Any", "");
366         RNA_def_boolean(func, "shift", 0, "Shift", "");
367         RNA_def_boolean(func, "ctrl", 0, "Ctrl", "");
368         RNA_def_boolean(func, "alt", 0, "Alt", "");
369         RNA_def_boolean(func, "oskey", 0, "OS Key", "");
370         RNA_def_enum(func, "key_modifier", event_type_items, 0, "Key Modifier", "");
371         parm= RNA_def_pointer(func, "item", "KeyMapItem", "Item", "Added key map item.");
372         RNA_def_function_return(func, parm);
373
374         func= RNA_def_function(srna, "add_modal_item", "rna_KeyMap_add_modal_item");
375         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
376         parm= RNA_def_string(func, "propvalue", "", 0, "Property Value", "");
377         RNA_def_property_flag(parm, PROP_REQUIRED);
378         parm= RNA_def_enum(func, "type", event_type_items, 0, "Type", "");
379         RNA_def_property_flag(parm, PROP_REQUIRED);
380         parm= RNA_def_enum(func, "value", event_value_items, 0, "Value", "");
381         RNA_def_property_flag(parm, PROP_REQUIRED);
382         RNA_def_boolean(func, "any", 0, "Any", "");
383         RNA_def_boolean(func, "shift", 0, "Shift", "");
384         RNA_def_boolean(func, "ctrl", 0, "Ctrl", "");
385         RNA_def_boolean(func, "alt", 0, "Alt", "");
386         RNA_def_boolean(func, "oskey", 0, "OS Key", "");
387         RNA_def_enum(func, "key_modifier", event_type_items, 0, "Key Modifier", "");
388         parm= RNA_def_pointer(func, "item", "KeyMapItem", "Item", "Added key map item.");
389         RNA_def_function_return(func, parm);
390
391         func= RNA_def_function(srna, "active", "rna_keymap_active");
392         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
393         parm= RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Active key map.");
394         RNA_def_function_return(func, parm);
395
396         func= RNA_def_function(srna, "remove_item", "WM_keymap_remove_item");
397         parm= RNA_def_pointer(func, "item", "KeyMapItem", "Item", "");
398         RNA_def_property_flag(parm, PROP_REQUIRED);
399
400         func= RNA_def_function(srna, "item_from_id", "WM_keymap_item_find_id");
401         parm= RNA_def_property(func, "id", PROP_INT, PROP_NONE);
402         RNA_def_property_flag(parm, PROP_REQUIRED);
403         RNA_def_property_ui_text(parm, "id", "ID of the item");
404         parm= RNA_def_pointer(func, "item", "KeyMapItem", "Item", "");
405         RNA_def_function_return(func, parm);
406
407         func= RNA_def_function(srna, "copy_to_user", "WM_keymap_copy_to_user");
408         parm= RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "User editable key map.");
409         RNA_def_function_return(func, parm);
410
411         func= RNA_def_function(srna, "restore_to_default", "WM_keymap_restore_to_default");
412
413         func= RNA_def_function(srna, "restore_item_to_default", "rna_keymap_restore_item_to_default");
414         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
415         parm= RNA_def_pointer(func, "item", "KeyMapItem", "Item", "");
416         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
417 }
418
419 void RNA_api_keymapitem(StructRNA *srna)
420 {
421         FunctionRNA *func;
422         PropertyRNA *parm;
423
424         func= RNA_def_function(srna, "compare", "WM_keymap_item_compare");
425         parm= RNA_def_pointer(func, "item", "KeyMapItem", "Item", "");
426         RNA_def_property_flag(parm, PROP_REQUIRED);
427         parm= RNA_def_boolean(func, "result", 0, "Comparison result", "");
428         RNA_def_function_return(func, parm);
429 }
430 #endif
431