Fixing keymap export:
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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_types.h"
34 #include "RNA_enum_types.h"
35
36 #include "DNA_screen_types.h"
37 #include "DNA_space_types.h"
38
39 #ifdef RNA_RUNTIME
40
41 #include "BKE_context.h"
42
43 #include "WM_api.h"
44 #include "WM_types.h"
45
46 static wmKeyMap *rna_keymap_add(wmKeyConfig *keyconf, char *idname, int spaceid, int regionid, int modal)
47 {
48         if (modal == 0) {
49                 return WM_keymap_find(keyconf, idname, spaceid, regionid);
50         } else {
51                 return WM_modalkeymap_add(keyconf, idname, NULL); /* items will be lazy init */
52         }
53 }
54
55 static wmKeyMap *rna_keymap_active(wmKeyMap *km, bContext *C)
56 {
57         wmWindowManager *wm = CTX_wm_manager(C);
58         return WM_keymap_active(wm, km);
59 }
60
61
62 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)
63 {
64         wmWindowManager *wm = CTX_wm_manager(C);
65         int modifier= 0;
66         int propvalue = 0;
67
68         /* only modal maps */
69         if ((km->flag & KEYMAP_MODAL) == 0) {
70                 BKE_report(reports, RPT_ERROR, "Not a modal keymap.");
71                 return NULL;
72         }
73
74         if (!km->modal_items) {
75                 if(!WM_keymap_user_init(wm, km)) {
76                         BKE_report(reports, RPT_ERROR, "User defined keymap doesn't correspond to a system keymap.");
77                         return NULL;
78                 }
79         }
80
81         if (!km->modal_items) {
82                 BKE_report(reports, RPT_ERROR, "No property values defined.");
83                 return NULL;
84         }
85
86
87         if(RNA_enum_value_from_id(km->modal_items, propvalue_str, &propvalue)==0) {
88                 BKE_report(reports, RPT_WARNING, "Property value not in enumeration.");
89         }
90
91         if(shift) modifier |= KM_SHIFT;
92         if(ctrl) modifier |= KM_CTRL;
93         if(alt) modifier |= KM_ALT;
94         if(oskey) modifier |= KM_OSKEY;
95
96         if(any) modifier = KM_ANY;
97
98         return WM_modalkeymap_add_item(km, type, value, modifier, keymodifier, propvalue);
99 }
100
101 static wmKeyMapItem *rna_KeyMap_add_item(wmKeyMap *km, ReportList *reports, char *idname, int type, int any, int value, int shift, int ctrl, int alt, int oskey, int keymodifier)
102 {
103 //      wmWindowManager *wm = CTX_wm_manager(C);
104         int modifier= 0;
105
106         /* only on non-modal maps */
107         if (km->flag & KEYMAP_MODAL) {
108                 BKE_report(reports, RPT_ERROR, "Not a non-modal keymap.");
109                 return NULL;
110         }
111
112         if(shift) modifier |= KM_SHIFT;
113         if(ctrl) modifier |= KM_CTRL;
114         if(alt) modifier |= KM_ALT;
115         if(oskey) modifier |= KM_OSKEY;
116
117         if(any) modifier = KM_ANY;
118
119         return WM_keymap_add_item(km, idname, type, value, modifier, keymodifier);
120 }
121
122 #else
123
124 void RNA_api_wm(StructRNA *srna)
125 {
126         FunctionRNA *func;
127         PropertyRNA *parm;
128
129         func= RNA_def_function(srna, "add_fileselect", "WM_event_add_fileselect");
130         RNA_def_function_flag(func, FUNC_NO_SELF|FUNC_USE_CONTEXT);
131         RNA_def_function_ui_description(func, "Show up the file selector.");
132         parm= RNA_def_pointer(func, "operator", "Operator", "", "Operator to call.");
133         RNA_def_property_flag(parm, PROP_REQUIRED);
134
135         func= RNA_def_function(srna, "add_keyconfig", "WM_keyconfig_add");
136         parm= RNA_def_string(func, "name", "", 0, "Name", "");
137         RNA_def_property_flag(parm, PROP_REQUIRED);
138         parm= RNA_def_pointer(func, "keyconfig", "KeyConfig", "Key Configuration", "Added key configuration.");
139         RNA_def_function_return(func, parm);
140         
141         /* invoke functions, for use with python */
142         func= RNA_def_function(srna, "invoke_props_popup", "WM_operator_props_popup");
143         RNA_def_function_flag(func, FUNC_NO_SELF|FUNC_USE_CONTEXT);
144         RNA_def_function_ui_description(func, "Operator popup invoke.");
145         parm= RNA_def_pointer(func, "operator", "Operator", "", "Operator to call.");
146         RNA_def_property_flag(parm, PROP_REQUIRED);
147         parm= RNA_def_pointer(func, "event", "Event", "", "Event.");
148         RNA_def_property_flag(parm, PROP_REQUIRED);
149         RNA_def_function_return(func, RNA_def_int(func, "mode",  0, 0, INT_MAX, "Mode", "", 0, INT_MAX)); // XXX, should be an enum/flag thingo
150 }
151
152 void RNA_api_keyconfig(StructRNA *srna)
153 {
154         FunctionRNA *func;
155         PropertyRNA *parm;
156
157         func= RNA_def_function(srna, "add_keymap", "rna_keymap_add");
158         parm= RNA_def_string(func, "name", "", 0, "Name", "");
159         RNA_def_property_flag(parm, PROP_REQUIRED);
160         RNA_def_enum(func, "space_type", space_type_items, SPACE_EMPTY, "Space Type", "");
161         RNA_def_enum(func, "region_type", region_type_items, RGN_TYPE_WINDOW, "Region Type", "");
162         RNA_def_boolean(func, "modal", 0, "Modal", "");
163         parm= RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Added key map.");
164         RNA_def_function_return(func, parm);
165 }
166
167 void RNA_api_keymap(StructRNA *srna)
168 {
169         FunctionRNA *func;
170         PropertyRNA *parm;
171
172         func= RNA_def_function(srna, "add_item", "rna_KeyMap_add_item");
173         RNA_def_function_flag(func, FUNC_USE_REPORTS);
174         parm= RNA_def_string(func, "idname", "", 0, "Operator Identifier", "");
175         RNA_def_property_flag(parm, PROP_REQUIRED);
176         parm= RNA_def_enum(func, "type", event_type_items, 0, "Type", "");
177         RNA_def_property_flag(parm, PROP_REQUIRED);
178         parm= RNA_def_enum(func, "value", event_value_items, 0, "Value", "");
179         RNA_def_property_flag(parm, PROP_REQUIRED);
180         RNA_def_boolean(func, "any", 0, "Any", "");
181         RNA_def_boolean(func, "shift", 0, "Shift", "");
182         RNA_def_boolean(func, "ctrl", 0, "Ctrl", "");
183         RNA_def_boolean(func, "alt", 0, "Alt", "");
184         RNA_def_boolean(func, "oskey", 0, "OS Key", "");
185         RNA_def_enum(func, "key_modifier", event_type_items, 0, "Key Modifier", "");
186         parm= RNA_def_pointer(func, "item", "KeyMapItem", "Item", "Added key map item.");
187         RNA_def_function_return(func, parm);
188
189         func= RNA_def_function(srna, "add_modal_item", "rna_KeyMap_add_modal_item");
190         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
191         parm= RNA_def_string(func, "propvalue", "", 0, "Property Value", "");
192         RNA_def_property_flag(parm, PROP_REQUIRED);
193         parm= RNA_def_enum(func, "type", event_type_items, 0, "Type", "");
194         RNA_def_property_flag(parm, PROP_REQUIRED);
195         parm= RNA_def_enum(func, "value", event_value_items, 0, "Value", "");
196         RNA_def_property_flag(parm, PROP_REQUIRED);
197         RNA_def_boolean(func, "any", 0, "Any", "");
198         RNA_def_boolean(func, "shift", 0, "Shift", "");
199         RNA_def_boolean(func, "ctrl", 0, "Ctrl", "");
200         RNA_def_boolean(func, "alt", 0, "Alt", "");
201         RNA_def_boolean(func, "oskey", 0, "OS Key", "");
202         RNA_def_enum(func, "key_modifier", event_type_items, 0, "Key Modifier", "");
203         parm= RNA_def_pointer(func, "item", "KeyMapItem", "Item", "Added key map item.");
204         RNA_def_function_return(func, parm);
205
206         func= RNA_def_function(srna, "active", "rna_keymap_active");
207         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
208         parm= RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "Active key map.");
209         RNA_def_function_return(func, parm);
210
211         func= RNA_def_function(srna, "remove_item", "WM_keymap_remove_item");
212         parm= RNA_def_pointer(func, "item", "KeyMapItem", "Item", "");
213         RNA_def_property_flag(parm, PROP_REQUIRED);
214
215         func= RNA_def_function(srna, "copy_to_user", "WM_keymap_copy_to_user");
216         parm= RNA_def_pointer(func, "keymap", "KeyMap", "Key Map", "User editable key map.");
217         RNA_def_function_return(func, parm);
218
219         func= RNA_def_function(srna, "restore_to_default", "WM_keymap_restore_to_default");
220 }
221
222 #endif
223