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