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