NLA SoC: Merge from 2.5
[blender.git] / source / blender / makesrna / intern / rna_wm.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  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_windowmanager_types.h"
33 #include "WM_types.h" /* wmEvent */
34
35
36 EnumPropertyItem event_value_items[] = {
37         {KM_ANY, "ANY", 0, "Any", ""},
38         {KM_NOTHING, "NOTHING", 0, "Nothing", ""},
39         {KM_PRESS, "PRESS", 0, "Press", ""},
40         {KM_RELEASE, "RELEASE", 0, "Release", ""},
41         {0, NULL, 0, NULL, NULL}};
42
43 /* not returned: CAPSLOCKKEY, UNKNOWNKEY, COMMANDKEY, GRLESSKEY */
44 EnumPropertyItem event_type_items[] = {
45         {AKEY, "A", 0, "A", ""},
46         {BKEY, "B", 0, "B", ""},
47         {CKEY, "C", 0, "C", ""},
48         {DKEY, "D", 0, "D", ""},
49         {EKEY, "E", 0, "E", ""},
50         {FKEY, "F", 0, "F", ""},
51         {GKEY, "G", 0, "G", ""},
52         {HKEY, "H", 0, "H", ""},
53         {IKEY, "I", 0, "I", ""},
54         {JKEY, "J", 0, "J", ""},
55         {KKEY, "K", 0, "K", ""},
56         {LKEY, "L", 0, "L", ""},
57         {MKEY, "M", 0, "M", ""},
58         {NKEY, "N", 0, "N", ""},
59         {OKEY, "O", 0, "O", ""},
60         {PKEY, "P", 0, "P", ""},
61         {QKEY, "Q", 0, "Q", ""},
62         {RKEY, "R", 0, "R", ""},
63         {SKEY, "S", 0, "S", ""},
64         {TKEY, "T", 0, "T", ""},
65         {UKEY, "U", 0, "U", ""},
66         {VKEY, "V", 0, "V", ""},
67         {WKEY, "W", 0, "W", ""},
68         {XKEY, "X", 0, "X", ""},
69         {YKEY, "Y", 0, "Y", ""},
70         {ZKEY, "Z", 0, "Z", ""},
71         
72         {ZEROKEY, "ZERO",       0, "Zero Key", ""},
73         {ONEKEY, "ONE",         0, "One Key", ""},
74         {TWOKEY, "TWO",         0, "Two Key", ""},
75         {THREEKEY, "THREE",     0, "Three Key", ""},
76         {FOURKEY, "FOUR",       0, "Four Key", ""},
77         {FIVEKEY, "FIVE",       0, "Five Key", ""},
78         {SIXKEY, "SIX",         0, "Six Key", ""},
79         {SEVENKEY, "SEVEN",     0, "Seven Key", ""},
80         {EIGHTKEY, "EIGHT",     0, "Eight Key", ""},
81         {NINEKEY, "NINE",       0, "Nine Key", ""},
82         
83         {LEFTCTRLKEY,   "LEFT_CTRL",    0, "Left Ctrl", ""},
84         {LEFTALTKEY,    "LEFT_ALT",             0, "Left Alt", ""},
85         {RIGHTALTKEY,   "RIGHT_ALT",    0, "Right Alt", ""},
86         {RIGHTCTRLKEY,  "RIGHT_CTRL",   0, "Rightctrl", ""},
87         {RIGHTSHIFTKEY, "RIGHT_SHIFT",  0, "Rightshift", ""},
88         {LEFTSHIFTKEY,  "LEFT_SHIFT",   0, "Leftshift", ""},
89         
90         {ESCKEY, "ESC", 0, "Esc", ""},
91         {TABKEY, "TAB", 0, "Tab", ""},
92         {RETKEY, "RET", 0, "Return", ""},
93         {SPACEKEY, "SPACE", 0, "Spacebar", ""},
94         {LINEFEEDKEY, "LINE_FEED", 0, "Line Feed", ""},
95         {BACKSPACEKEY, "BACK_SPACE", 0, "Back Space", ""},
96         {DELKEY, "DEL", 0, "Delete", ""},
97         {SEMICOLONKEY, "SEMI_COLON", 0, "Semicolon", ""},
98         {PERIODKEY, "PERIOD", 0, "Period", ""},
99         {COMMAKEY, "COMMA", 0, "Comma", ""},
100         {QUOTEKEY, "QUOTE", 0, "Quote", ""},
101         {ACCENTGRAVEKEY, "ACCENT_GRAVE", 0, "Accentgrave", ""},
102         {MINUSKEY, "MINUS", 0, "Minus", ""},
103         {SLASHKEY, "SLASH", 0, "Slash", ""},
104         {BACKSLASHKEY, "BACK_SLASH", 0, "Backslash", ""},
105         {EQUALKEY, "EQUAL", 0, "Equal", ""},
106         {LEFTBRACKETKEY, "LEFT_BRACKET", 0, "Leftbracket", ""},
107         {RIGHTBRACKETKEY, "RIGHT_BRACKET", 0, "Rightbracket", ""},
108         {LEFTARROWKEY, "LEFT_ARROW", 0, "Left Arrow", ""},
109         {DOWNARROWKEY, "DOWN_ARROW", 0, "Down Arrow", ""},
110         {RIGHTARROWKEY, "RIGHT_ARROW", 0, "Right Arrow", ""},
111         {UPARROWKEY, "UP_ARROW", 0, "Up Arrow", ""},
112         {PAD2, "NUMPAD_2", 0, "Numpad 2", ""},
113         {PAD4, "NUMPAD_4", 0, "Numpad 4", ""},
114         {PAD6, "NUMPAD_6", 0, "Numpad 6", ""},
115         {PAD8, "NUMPAD_8", 0, "Numpad 8", ""},
116         {PAD1, "NUMPAD_1", 0, "Numpad 1", ""},
117         {PAD3, "NUMPAD_3", 0, "Numpad 3", ""},
118         {PAD5, "NUMPAD_5", 0, "Numpad 5", ""},
119         {PAD7, "NUMPAD_7", 0, "Numpad 7", ""},
120         {PAD9, "NUMPAD_9", 0, "Numpad 9", ""},
121         {PADPERIOD, "NUMPAD_PERIOD", 0, "Numpad .", ""},
122         {PADSLASHKEY, "NUMPAD_SLASH", 0, "Numpad /", ""},
123         {PADASTERKEY, "NUMPAD_ASTERIX", 0, "Numpad *", ""},
124         {PAD0, "NUMPAD_0", 0, "Numpad 0", ""},
125         {PADMINUS, "NUMPAD_MINUS", 0, "Numpad -", ""},
126         {PADENTER, "NUMPAD_ENTER", 0, "Numpad Enter", ""},
127         {PADPLUSKEY, "NUMPAD_PLUS", 0, "Numpad +", ""},
128         {F1KEY, "F1", 0, "F1", ""},
129         {F2KEY, "F2", 0, "F2", ""},
130         {F3KEY, "F3", 0, "F3", ""},
131         {F4KEY, "F4", 0, "F4", ""},
132         {F5KEY, "F5", 0, "F5", ""},
133         {F6KEY, "F6", 0, "F6", ""},
134         {F7KEY, "F7", 0, "F7", ""},
135         {F8KEY, "F8", 0, "F8", ""},
136         {F9KEY, "F9", 0, "F9", ""},
137         {F10KEY, "F10", 0, "F10", ""},
138         {F11KEY, "F11", 0, "F11", ""},
139         {F12KEY, "F12", 0, "F12", ""},
140         {PAUSEKEY, "PAUSE", 0, "Pause", ""},
141         {INSERTKEY, "INSERT", 0, "Insert", ""},
142         {HOMEKEY, "HOME", 0, "Home", ""},
143         {PAGEUPKEY, "PAGE_UP", 0, "Page Up", ""},
144         {PAGEDOWNKEY, "PAGE_DOWN", 0, "Page Down", ""},
145         {ENDKEY, "END", 0, "End", ""},
146         {0, NULL, 0, NULL, NULL}};      
147
148 #ifdef RNA_RUNTIME
149
150 #include "BKE_idprop.h"
151
152 static wmOperator *rna_OperatorProperties_find_operator(PointerRNA *ptr)
153 {
154         wmWindowManager *wm= ptr->id.data;
155         IDProperty *properties= (IDProperty*)ptr->data;
156         wmOperator *op;
157
158         if(wm)
159                 for(op=wm->operators.first; op; op=op->next)
160                         if(op->properties == properties)
161                                 return op;
162         
163         return NULL;
164 }
165
166 static StructRNA *rna_OperatorProperties_refine(PointerRNA *ptr)
167 {
168         wmOperator *op= rna_OperatorProperties_find_operator(ptr);
169
170         if(op)
171                 return op->type->srna;
172         else
173                 return ptr->type;
174 }
175
176 IDProperty *rna_OperatorProperties_idproperties(PointerRNA *ptr, int create)
177 {
178         if(create && !ptr->data) {
179                 IDPropertyTemplate val = {0};
180                 ptr->data= IDP_New(IDP_GROUP, val, "RNA_OperatorProperties group");
181         }
182
183         return ptr->data;
184 }
185
186 static void rna_Operator_name_get(PointerRNA *ptr, char *value)
187 {
188         wmOperator *op= (wmOperator*)ptr->data;
189         strcpy(value, op->type->name);
190 }
191
192 static int rna_Operator_name_length(PointerRNA *ptr)
193 {
194         wmOperator *op= (wmOperator*)ptr->data;
195         return strlen(op->type->name);
196 }
197
198 static PointerRNA rna_Operator_properties_get(PointerRNA *ptr)
199 {
200         wmOperator *op= (wmOperator*)ptr->data;
201         return rna_pointer_inherit_refine(ptr, &RNA_OperatorProperties, op->properties);
202 }
203
204
205 static int rna_Event_ascii_get(PointerRNA *ptr, char *value)
206 {
207         wmEvent *event= (wmEvent*)ptr->id.data;
208         value[0]= event->ascii;
209         value[1]= '\0';
210 }
211
212 static int rna_Event_ascii_length(PointerRNA *ptr)
213 {
214         wmEvent *event= (wmEvent*)ptr->id.data;
215         return (event->ascii)? 1 : 0;
216 }
217
218 #else
219
220 static void rna_def_operator(BlenderRNA *brna)
221 {
222         StructRNA *srna;
223         PropertyRNA *prop;
224
225         srna= RNA_def_struct(brna, "Operator", NULL);
226         RNA_def_struct_ui_text(srna, "Operator", "Storage of an operator being executed, or registered after execution.");
227         RNA_def_struct_sdna(srna, "wmOperator");
228
229         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
230         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
231         RNA_def_property_string_funcs(prop, "rna_Operator_name_get", "rna_Operator_name_length", NULL);
232         RNA_def_property_ui_text(prop, "Name", "");
233         RNA_def_struct_name_property(srna, prop);
234
235         prop= RNA_def_property(srna, "properties", PROP_POINTER, PROP_NEVER_NULL);
236         RNA_def_property_struct_type(prop, "OperatorProperties");
237         RNA_def_property_ui_text(prop, "Properties", "");
238         RNA_def_property_pointer_funcs(prop, "rna_Operator_properties_get", NULL, NULL);
239
240         srna= RNA_def_struct(brna, "OperatorProperties", NULL);
241         RNA_def_struct_ui_text(srna, "Operator Properties", "Input properties of an Operator.");
242         RNA_def_struct_refine_func(srna, "rna_OperatorProperties_refine");
243         RNA_def_struct_idproperties_func(srna, "rna_OperatorProperties_idproperties");
244 }
245
246 static void rna_def_operator_utils(BlenderRNA *brna)
247 {
248         StructRNA *srna;
249         PropertyRNA *prop;
250
251         srna= RNA_def_struct(brna, "OperatorMousePath", "IDPropertyGroup");
252         RNA_def_struct_ui_text(srna, "Operator Mouse Path", "Mouse path values for operators that record such paths.");
253
254         prop= RNA_def_property(srna, "loc", PROP_FLOAT, PROP_VECTOR);
255         RNA_def_property_flag(prop, PROP_IDPROPERTY);
256         RNA_def_property_array(prop, 2);
257         RNA_def_property_ui_text(prop, "Location", "Mouse location.");
258
259         prop= RNA_def_property(srna, "time", PROP_FLOAT, PROP_NONE);
260         RNA_def_property_flag(prop, PROP_IDPROPERTY);
261         RNA_def_property_ui_text(prop, "Time", "Time of mouse location.");
262 }
263
264 static void rna_def_operator_filelist_element(BlenderRNA *brna)
265 {
266         StructRNA *srna;
267         PropertyRNA *prop;
268
269         srna= RNA_def_struct(brna, "OperatorFileListElement", "IDPropertyGroup");
270         RNA_def_struct_ui_text(srna, "Operator File List Element", "");
271         
272         
273         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
274         RNA_def_property_flag(prop, PROP_IDPROPERTY);
275         RNA_def_property_ui_text(prop, "Name", "the name of a file or directory within a file list");
276 }
277         
278 static void rna_def_event(BlenderRNA *brna)
279 {
280         StructRNA *srna;
281         PropertyRNA *prop;
282         
283         srna= RNA_def_struct(brna, "Event", NULL);
284         RNA_def_struct_ui_text(srna, "Event", "Window Manager Event");
285         RNA_def_struct_sdna(srna, "wmEvent");
286
287         /* strings */
288         prop= RNA_def_property(srna, "ascii", PROP_STRING, PROP_NONE);
289         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
290         RNA_def_property_string_funcs(prop, "rna_Event_ascii_get", "rna_Event_ascii_length", NULL);
291         RNA_def_property_ui_text(prop, "ASCII", "Single ASCII character for this event.");
292
293
294         /* enums */
295         prop= RNA_def_property(srna, "value", PROP_ENUM, PROP_NONE);
296         RNA_def_property_enum_sdna(prop, NULL, "val");
297         RNA_def_property_enum_items(prop, event_value_items);
298         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
299         RNA_def_property_ui_text(prop, "Value",  "The type of event, only applies to some.");
300         
301         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
302         RNA_def_property_enum_sdna(prop, NULL, "type");
303         RNA_def_property_enum_items(prop, event_type_items);
304         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
305         RNA_def_property_ui_text(prop, "Type",  "");
306
307
308         /* mouse */
309         prop= RNA_def_property(srna, "mouse_x", PROP_INT, PROP_NONE);
310         RNA_def_property_int_sdna(prop, NULL, "x");
311         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
312         RNA_def_property_ui_text(prop, "Mouse X Position", "The window relative vertical location of the mouse.");
313         
314         prop= RNA_def_property(srna, "mouse_y", PROP_INT, PROP_NONE);
315         RNA_def_property_int_sdna(prop, NULL, "y");
316         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
317         RNA_def_property_ui_text(prop, "Mouse Y Position", "The window relative horizontal location of the mouse.");
318         
319         prop= RNA_def_property(srna, "mouse_prev_x", PROP_INT, PROP_NONE);
320         RNA_def_property_int_sdna(prop, NULL, "prevx");
321         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
322         RNA_def_property_ui_text(prop, "Mouse Previous X Position", "The window relative vertical location of the mouse.");
323         
324         prop= RNA_def_property(srna, "mouse_prev_y", PROP_INT, PROP_NONE);
325         RNA_def_property_int_sdna(prop, NULL, "prevy");
326         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
327         RNA_def_property_ui_text(prop, "Mouse Previous Y Position", "The window relative horizontal location of the mouse.");   
328
329
330         /* modifiers */
331         prop= RNA_def_property(srna, "shift", PROP_BOOLEAN, PROP_NONE);
332         RNA_def_property_boolean_sdna(prop, NULL, "shift", 1);
333         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
334         RNA_def_property_ui_text(prop, "Shift", "True when the shift key is held.");
335         
336         prop= RNA_def_property(srna, "ctrl", PROP_BOOLEAN, PROP_NONE);
337         RNA_def_property_boolean_sdna(prop, NULL, "ctrl", 1);
338         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
339         RNA_def_property_ui_text(prop, "Ctrl", "True when the shift key is held.");
340         
341         prop= RNA_def_property(srna, "alt", PROP_BOOLEAN, PROP_NONE);
342         RNA_def_property_boolean_sdna(prop, NULL, "alt", 1);
343         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
344         RNA_def_property_ui_text(prop, "Alt", "True when the shift key is held.");
345         
346         prop= RNA_def_property(srna, "oskey", PROP_BOOLEAN, PROP_NONE);
347         RNA_def_property_boolean_sdna(prop, NULL, "oskey", 1);
348         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
349         RNA_def_property_ui_text(prop, "OS Key", "True when the shift key is held.");
350 }
351
352 static void rna_def_windowmanager(BlenderRNA *brna)
353 {
354         StructRNA *srna;
355         PropertyRNA *prop;
356
357         srna= RNA_def_struct(brna, "WindowManager", "ID");
358         RNA_def_struct_ui_text(srna, "Window Manager", "Window manager datablock defining open windows and other user interface data.");
359         RNA_def_struct_sdna(srna, "wmWindowManager");
360
361         prop= RNA_def_property(srna, "operators", PROP_COLLECTION, PROP_NONE);
362         RNA_def_property_struct_type(prop, "Operator");
363         RNA_def_property_ui_text(prop, "Operators", "Operator registry.");
364
365         RNA_api_wm(srna);
366 }
367
368 void RNA_def_wm(BlenderRNA *brna)
369 {
370         rna_def_operator(brna);
371         rna_def_operator_utils(brna);
372         rna_def_operator_filelist_element(brna);
373         rna_def_event(brna);
374         rna_def_windowmanager(brna);
375 }
376
377 #endif
378