5 button mouse support from b333rt in IRC with some edits for X11.
[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, GRLESSKEY */
44 EnumPropertyItem event_type_items[] = {
45
46         {LEFTMOUSE, "LEFTMOUSE", 0, "Left Mouse", ""},
47         {MIDDLEMOUSE, "MIDDLEMOUSE", 0, "Middle Mouse", ""},
48         {RIGHTMOUSE, "RIGHTMOUSE", 0, "Right Mouse", ""},
49         {BUTTON4MOUSE, "BUTTON4MOUSE", 0, "Button4 Mouse", ""},
50         {BUTTON5MOUSE, "BUTTON5MOUSE", 0, "Button5 Mouse", ""},
51         {ACTIONMOUSE, "ACTIONMOUSE", 0, "Action Mouse", ""},
52         {SELECTMOUSE, "SELECTMOUSE", 0, "Select Mouse", ""},
53
54         {MOUSEMOVE, "MOUSEMOVE", 0, "Mouse Move", ""},
55
56         {WHEELUPMOUSE, "WHEELUPMOUSE", 0, "Wheel Up", ""},
57         {WHEELDOWNMOUSE, "WHEELDOWNMOUSE", 0, "Wheel Down", ""},
58         {WHEELINMOUSE, "WHEELINMOUSE", 0, "Wheel In", ""},
59         {WHEELOUTMOUSE, "WHEELOUTMOUSE", 0, "Wheel Out", ""},
60
61         {EVT_TWEAK_L, "EVT_TWEAK_L", 0, "Tweak Left", ""},
62         {EVT_TWEAK_M, "EVT_TWEAK_M", 0, "Tweak Middle", ""},
63         {EVT_TWEAK_R, "EVT_TWEAK_R", 0, "Tweak Right", ""},
64         {EVT_TWEAK_A, "EVT_TWEAK_A", 0, "Tweak Action", ""},
65         {EVT_TWEAK_S, "EVT_TWEAK_S", 0, "Tweak Select", ""},
66
67         {AKEY, "A", 0, "A", ""},
68         {BKEY, "B", 0, "B", ""},
69         {CKEY, "C", 0, "C", ""},
70         {DKEY, "D", 0, "D", ""},
71         {EKEY, "E", 0, "E", ""},
72         {FKEY, "F", 0, "F", ""},
73         {GKEY, "G", 0, "G", ""},
74         {HKEY, "H", 0, "H", ""},
75         {IKEY, "I", 0, "I", ""},
76         {JKEY, "J", 0, "J", ""},
77         {KKEY, "K", 0, "K", ""},
78         {LKEY, "L", 0, "L", ""},
79         {MKEY, "M", 0, "M", ""},
80         {NKEY, "N", 0, "N", ""},
81         {OKEY, "O", 0, "O", ""},
82         {PKEY, "P", 0, "P", ""},
83         {QKEY, "Q", 0, "Q", ""},
84         {RKEY, "R", 0, "R", ""},
85         {SKEY, "S", 0, "S", ""},
86         {TKEY, "T", 0, "T", ""},
87         {UKEY, "U", 0, "U", ""},
88         {VKEY, "V", 0, "V", ""},
89         {WKEY, "W", 0, "W", ""},
90         {XKEY, "X", 0, "X", ""},
91         {YKEY, "Y", 0, "Y", ""},
92         {ZKEY, "Z", 0, "Z", ""},
93         
94         {ZEROKEY, "ZERO",       0, "0", ""},
95         {ONEKEY, "ONE",         0, "1", ""},
96         {TWOKEY, "TWO",         0, "2", ""},
97         {THREEKEY, "THREE",     0, "3", ""},
98         {FOURKEY, "FOUR",       0, "4", ""},
99         {FIVEKEY, "FIVE",       0, "5", ""},
100         {SIXKEY, "SIX",         0, "6", ""},
101         {SEVENKEY, "SEVEN",     0, "7", ""},
102         {EIGHTKEY, "EIGHT",     0, "8", ""},
103         {NINEKEY, "NINE",       0, "9", ""},
104         
105         {LEFTCTRLKEY,   "LEFT_CTRL",    0, "Left Ctrl", ""},
106         {LEFTALTKEY,    "LEFT_ALT",             0, "Left Alt", ""},
107         {LEFTSHIFTKEY,  "LEFT_SHIFT",   0, "Left Shift", ""},
108         {RIGHTALTKEY,   "RIGHT_ALT",    0, "Right Alt", ""},
109         {RIGHTCTRLKEY,  "RIGHT_CTRL",   0, "Right Ctrl", ""},
110         {RIGHTSHIFTKEY, "RIGHT_SHIFT",  0, "Right Shift", ""},
111
112         {COMMANDKEY,    "COMMAND",      0, "Command", ""},
113         
114         {ESCKEY, "ESC", 0, "Esc", ""},
115         {TABKEY, "TAB", 0, "Tab", ""},
116         {RETKEY, "RET", 0, "Return", ""},
117         {SPACEKEY, "SPACE", 0, "Spacebar", ""},
118         {LINEFEEDKEY, "LINE_FEED", 0, "Line Feed", ""},
119         {BACKSPACEKEY, "BACK_SPACE", 0, "Back Space", ""},
120         {DELKEY, "DEL", 0, "Delete", ""},
121         {SEMICOLONKEY, "SEMI_COLON", 0, ";", ""},
122         {PERIODKEY, "PERIOD", 0, ".", ""},
123         {COMMAKEY, "COMMA", 0, ",", ""},
124         {QUOTEKEY, "QUOTE", 0, "\"", ""},
125         {ACCENTGRAVEKEY, "ACCENT_GRAVE", 0, "`", ""},
126         {MINUSKEY, "MINUS", 0, "-", ""},
127         {SLASHKEY, "SLASH", 0, "/", ""},
128         {BACKSLASHKEY, "BACK_SLASH", 0, "\\", ""},
129         {EQUALKEY, "EQUAL", 0, "=", ""},
130         {LEFTBRACKETKEY, "LEFT_BRACKET", 0, "]", ""},
131         {RIGHTBRACKETKEY, "RIGHT_BRACKET", 0, "[", ""},
132         {LEFTARROWKEY, "LEFT_ARROW", 0, "Left Arrow", ""},
133         {DOWNARROWKEY, "DOWN_ARROW", 0, "Down Arrow", ""},
134         {RIGHTARROWKEY, "RIGHT_ARROW", 0, "Right Arrow", ""},
135         {UPARROWKEY, "UP_ARROW", 0, "Up Arrow", ""},
136         {PAD2, "NUMPAD_2", 0, "Numpad 2", ""},
137         {PAD4, "NUMPAD_4", 0, "Numpad 4", ""},
138         {PAD6, "NUMPAD_6", 0, "Numpad 6", ""},
139         {PAD8, "NUMPAD_8", 0, "Numpad 8", ""},
140         {PAD1, "NUMPAD_1", 0, "Numpad 1", ""},
141         {PAD3, "NUMPAD_3", 0, "Numpad 3", ""},
142         {PAD5, "NUMPAD_5", 0, "Numpad 5", ""},
143         {PAD7, "NUMPAD_7", 0, "Numpad 7", ""},
144         {PAD9, "NUMPAD_9", 0, "Numpad 9", ""},
145         {PADPERIOD, "NUMPAD_PERIOD", 0, "Numpad .", ""},
146         {PADSLASHKEY, "NUMPAD_SLASH", 0, "Numpad /", ""},
147         {PADASTERKEY, "NUMPAD_ASTERIX", 0, "Numpad *", ""},
148         {PAD0, "NUMPAD_0", 0, "Numpad 0", ""},
149         {PADMINUS, "NUMPAD_MINUS", 0, "Numpad -", ""},
150         {PADENTER, "NUMPAD_ENTER", 0, "Numpad Enter", ""},
151         {PADPLUSKEY, "NUMPAD_PLUS", 0, "Numpad +", ""},
152         {F1KEY, "F1", 0, "F1", ""},
153         {F2KEY, "F2", 0, "F2", ""},
154         {F3KEY, "F3", 0, "F3", ""},
155         {F4KEY, "F4", 0, "F4", ""},
156         {F5KEY, "F5", 0, "F5", ""},
157         {F6KEY, "F6", 0, "F6", ""},
158         {F7KEY, "F7", 0, "F7", ""},
159         {F8KEY, "F8", 0, "F8", ""},
160         {F9KEY, "F9", 0, "F9", ""},
161         {F10KEY, "F10", 0, "F10", ""},
162         {F11KEY, "F11", 0, "F11", ""},
163         {F12KEY, "F12", 0, "F12", ""},
164         {PAUSEKEY, "PAUSE", 0, "Pause", ""},
165         {INSERTKEY, "INSERT", 0, "Insert", ""},
166         {HOMEKEY, "HOME", 0, "Home", ""},
167         {PAGEUPKEY, "PAGE_UP", 0, "Page Up", ""},
168         {PAGEDOWNKEY, "PAGE_DOWN", 0, "Page Down", ""},
169         {ENDKEY, "END", 0, "End", ""},
170         {0, NULL, 0, NULL, NULL}};      
171
172 #ifdef RNA_RUNTIME
173
174 #include "WM_api.h"
175
176 #include "BKE_idprop.h"
177
178 static wmOperator *rna_OperatorProperties_find_operator(PointerRNA *ptr)
179 {
180         wmWindowManager *wm= ptr->id.data;
181         IDProperty *properties= (IDProperty*)ptr->data;
182         wmOperator *op;
183
184         if(wm)
185                 for(op=wm->operators.first; op; op=op->next)
186                         if(op->properties == properties)
187                                 return op;
188         
189         return NULL;
190 }
191
192 static StructRNA *rna_OperatorProperties_refine(PointerRNA *ptr)
193 {
194         wmOperator *op= rna_OperatorProperties_find_operator(ptr);
195
196         if(op)
197                 return op->type->srna;
198         else
199                 return ptr->type;
200 }
201
202 static IDProperty *rna_OperatorProperties_idproperties(PointerRNA *ptr, int create)
203 {
204         if(create && !ptr->data) {
205                 IDPropertyTemplate val = {0};
206                 ptr->data= IDP_New(IDP_GROUP, val, "RNA_OperatorProperties group");
207         }
208
209         return ptr->data;
210 }
211
212 static void rna_Operator_name_get(PointerRNA *ptr, char *value)
213 {
214         wmOperator *op= (wmOperator*)ptr->data;
215         strcpy(value, op->type->name);
216 }
217
218 static int rna_Operator_name_length(PointerRNA *ptr)
219 {
220         wmOperator *op= (wmOperator*)ptr->data;
221         return strlen(op->type->name);
222 }
223
224 static PointerRNA rna_Operator_properties_get(PointerRNA *ptr)
225 {
226         wmOperator *op= (wmOperator*)ptr->data;
227         return rna_pointer_inherit_refine(ptr, &RNA_OperatorProperties, op->properties);
228 }
229
230
231 static void rna_Event_ascii_get(PointerRNA *ptr, char *value)
232 {
233         wmEvent *event= (wmEvent*)ptr->id.data;
234         value[0]= event->ascii;
235         value[1]= '\0';
236 }
237
238 static int rna_Event_ascii_length(PointerRNA *ptr)
239 {
240         wmEvent *event= (wmEvent*)ptr->id.data;
241         return (event->ascii)? 1 : 0;
242 }
243
244 static void rna_Window_screen_set(PointerRNA *ptr, PointerRNA value)
245 {
246         wmWindow *win= (wmWindow*)ptr->data;
247
248         if(value.data == NULL)
249                 return;
250
251         /* exception: can't set screens inside of area/region handers */
252         win->newscreen= value.data;
253 }
254
255 static void rna_Window_screen_update(bContext *C, PointerRNA *ptr)
256 {
257         wmWindow *win= (wmWindow*)ptr->data;
258
259         /* exception: can't set screens inside of area/region handers */
260         if(win->newscreen) {
261                 WM_event_add_notifier(C, NC_SCREEN|ND_SCREENBROWSE, win->newscreen);
262                 win->newscreen= NULL;
263         }
264 }
265
266 #else
267
268 static void rna_def_operator(BlenderRNA *brna)
269 {
270         StructRNA *srna;
271         PropertyRNA *prop;
272
273         srna= RNA_def_struct(brna, "Operator", NULL);
274         RNA_def_struct_ui_text(srna, "Operator", "Storage of an operator being executed, or registered after execution.");
275         RNA_def_struct_sdna(srna, "wmOperator");
276
277         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
278         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
279         RNA_def_property_string_funcs(prop, "rna_Operator_name_get", "rna_Operator_name_length", NULL);
280         RNA_def_property_ui_text(prop, "Name", "");
281         RNA_def_struct_name_property(srna, prop);
282
283         prop= RNA_def_property(srna, "properties", PROP_POINTER, PROP_NONE);
284         RNA_def_property_flag(prop, PROP_NEVER_NULL);
285         RNA_def_property_struct_type(prop, "OperatorProperties");
286         RNA_def_property_ui_text(prop, "Properties", "");
287         RNA_def_property_pointer_funcs(prop, "rna_Operator_properties_get", NULL, NULL);
288
289         srna= RNA_def_struct(brna, "OperatorProperties", NULL);
290         RNA_def_struct_ui_text(srna, "Operator Properties", "Input properties of an Operator.");
291         RNA_def_struct_refine_func(srna, "rna_OperatorProperties_refine");
292         RNA_def_struct_idproperties_func(srna, "rna_OperatorProperties_idproperties");
293 }
294
295 static void rna_def_operator_utils(BlenderRNA *brna)
296 {
297         StructRNA *srna;
298         PropertyRNA *prop;
299
300         srna= RNA_def_struct(brna, "OperatorMousePath", "IDPropertyGroup");
301         RNA_def_struct_ui_text(srna, "Operator Mouse Path", "Mouse path values for operators that record such paths.");
302
303         prop= RNA_def_property(srna, "loc", PROP_FLOAT, PROP_XYZ);
304         RNA_def_property_flag(prop, PROP_IDPROPERTY);
305         RNA_def_property_array(prop, 2);
306         RNA_def_property_ui_text(prop, "Location", "Mouse location.");
307
308         prop= RNA_def_property(srna, "time", PROP_FLOAT, PROP_NONE);
309         RNA_def_property_flag(prop, PROP_IDPROPERTY);
310         RNA_def_property_ui_text(prop, "Time", "Time of mouse location.");
311 }
312
313 static void rna_def_operator_filelist_element(BlenderRNA *brna)
314 {
315         StructRNA *srna;
316         PropertyRNA *prop;
317
318         srna= RNA_def_struct(brna, "OperatorFileListElement", "IDPropertyGroup");
319         RNA_def_struct_ui_text(srna, "Operator File List Element", "");
320         
321         
322         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
323         RNA_def_property_flag(prop, PROP_IDPROPERTY);
324         RNA_def_property_ui_text(prop, "Name", "the name of a file or directory within a file list");
325 }
326         
327 static void rna_def_event(BlenderRNA *brna)
328 {
329         StructRNA *srna;
330         PropertyRNA *prop;
331         
332         srna= RNA_def_struct(brna, "Event", NULL);
333         RNA_def_struct_ui_text(srna, "Event", "Window Manager Event");
334         RNA_def_struct_sdna(srna, "wmEvent");
335
336         /* strings */
337         prop= RNA_def_property(srna, "ascii", PROP_STRING, PROP_NONE);
338         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
339         RNA_def_property_string_funcs(prop, "rna_Event_ascii_get", "rna_Event_ascii_length", NULL);
340         RNA_def_property_ui_text(prop, "ASCII", "Single ASCII character for this event.");
341
342
343         /* enums */
344         prop= RNA_def_property(srna, "value", PROP_ENUM, PROP_NONE);
345         RNA_def_property_enum_sdna(prop, NULL, "val");
346         RNA_def_property_enum_items(prop, event_value_items);
347         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
348         RNA_def_property_ui_text(prop, "Value",  "The type of event, only applies to some.");
349         
350         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
351         RNA_def_property_enum_sdna(prop, NULL, "type");
352         RNA_def_property_enum_items(prop, event_type_items);
353         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
354         RNA_def_property_ui_text(prop, "Type",  "");
355
356
357         /* mouse */
358         prop= RNA_def_property(srna, "mouse_x", PROP_INT, PROP_NONE);
359         RNA_def_property_int_sdna(prop, NULL, "x");
360         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
361         RNA_def_property_ui_text(prop, "Mouse X Position", "The window relative vertical location of the mouse.");
362         
363         prop= RNA_def_property(srna, "mouse_y", PROP_INT, PROP_NONE);
364         RNA_def_property_int_sdna(prop, NULL, "y");
365         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
366         RNA_def_property_ui_text(prop, "Mouse Y Position", "The window relative horizontal location of the mouse.");
367         
368         prop= RNA_def_property(srna, "mouse_prev_x", PROP_INT, PROP_NONE);
369         RNA_def_property_int_sdna(prop, NULL, "prevx");
370         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
371         RNA_def_property_ui_text(prop, "Mouse Previous X Position", "The window relative vertical location of the mouse.");
372         
373         prop= RNA_def_property(srna, "mouse_prev_y", PROP_INT, PROP_NONE);
374         RNA_def_property_int_sdna(prop, NULL, "prevy");
375         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
376         RNA_def_property_ui_text(prop, "Mouse Previous Y Position", "The window relative horizontal location of the mouse.");   
377
378
379         /* modifiers */
380         prop= RNA_def_property(srna, "shift", PROP_BOOLEAN, PROP_NONE);
381         RNA_def_property_boolean_sdna(prop, NULL, "shift", 1);
382         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
383         RNA_def_property_ui_text(prop, "Shift", "True when the Shift key is held.");
384         
385         prop= RNA_def_property(srna, "ctrl", PROP_BOOLEAN, PROP_NONE);
386         RNA_def_property_boolean_sdna(prop, NULL, "ctrl", 1);
387         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
388         RNA_def_property_ui_text(prop, "Ctrl", "True when the Ctrl key is held.");
389         
390         prop= RNA_def_property(srna, "alt", PROP_BOOLEAN, PROP_NONE);
391         RNA_def_property_boolean_sdna(prop, NULL, "alt", 1);
392         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
393         RNA_def_property_ui_text(prop, "Alt", "True when the Alt/Option key is held.");
394         
395         prop= RNA_def_property(srna, "oskey", PROP_BOOLEAN, PROP_NONE);
396         RNA_def_property_boolean_sdna(prop, NULL, "oskey", 1);
397         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
398         RNA_def_property_ui_text(prop, "OS Key", "True when the Cmd key is held.");
399 }
400
401 static void rna_def_window(BlenderRNA *brna)
402 {
403         StructRNA *srna;
404         PropertyRNA *prop;
405
406         srna= RNA_def_struct(brna, "Window", NULL);
407         RNA_def_struct_ui_text(srna, "Window", "Open window.");
408         RNA_def_struct_sdna(srna, "wmWindow");
409
410         prop= RNA_def_property(srna, "screen", PROP_POINTER, PROP_NONE);
411         RNA_def_property_flag(prop, PROP_NEVER_NULL);
412         RNA_def_property_struct_type(prop, "Screen");
413         RNA_def_property_ui_text(prop, "Screen", "Active screen showing in the window.");
414         RNA_def_property_flag(prop, PROP_EDITABLE);
415         RNA_def_property_pointer_funcs(prop, NULL, "rna_Window_screen_set", NULL);
416         RNA_def_property_update(prop, 0, "rna_Window_screen_update");
417 }
418
419 static void rna_def_windowmanager(BlenderRNA *brna)
420 {
421         StructRNA *srna;
422         PropertyRNA *prop;
423
424         srna= RNA_def_struct(brna, "WindowManager", "ID");
425         RNA_def_struct_ui_text(srna, "Window Manager", "Window manager datablock defining open windows and other user interface data.");
426         RNA_def_struct_clear_flag(srna, STRUCT_ID_REFCOUNT);
427         RNA_def_struct_sdna(srna, "wmWindowManager");
428
429         prop= RNA_def_property(srna, "operators", PROP_COLLECTION, PROP_NONE);
430         RNA_def_property_struct_type(prop, "Operator");
431         RNA_def_property_ui_text(prop, "Operators", "Operator registry.");
432
433         prop= RNA_def_property(srna, "windows", PROP_COLLECTION, PROP_NONE);
434         RNA_def_property_struct_type(prop, "Window");
435         RNA_def_property_ui_text(prop, "Windows", "Open windows.");
436
437         RNA_api_wm(srna);
438 }
439
440 void RNA_def_wm(BlenderRNA *brna)
441 {
442         rna_def_operator(brna);
443         rna_def_operator_utils(brna);
444         rna_def_operator_filelist_element(brna);
445         rna_def_event(brna);
446         rna_def_window(brna);
447         rna_def_windowmanager(brna);
448 }
449
450 #endif
451