Cleanup: avoid function call for pointer compare
[blender.git] / source / blender / windowmanager / wm_event_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/windowmanager/wm_event_types.h
24  *  \ingroup wm
25  */
26
27
28 /*
29  * These define have its origin at sgi, where all device defines were written down in device.h.
30  * Blender copied the conventions quite some, and expanded it with internal new defines (ton)
31  */
32
33
34 #ifndef __WM_EVENT_TYPES_H__
35 #define __WM_EVENT_TYPES_H__
36
37 /* customdata type */
38 enum {
39         EVT_DATA_GESTURE     = 1,
40         EVT_DATA_TIMER       = 2,
41         EVT_DATA_DRAGDROP    = 3,
42         EVT_DATA_NDOF_MOTION = 4,
43 };
44
45 /* tablet active, matches GHOST_TTabletMode */
46 enum {
47         EVT_TABLET_NONE   = 0,
48         EVT_TABLET_STYLUS = 1,
49         EVT_TABLET_ERASER = 2,
50 };
51
52 /* ********** wmEvent.type ********** */
53 enum {
54         /* non-event, for example disabled timer */
55         EVENT_NONE = 0x0000,
56
57         /* ********** Start of Input devices. ********** */
58
59         /* MOUSE : 0x000x, 0x001x */
60         LEFTMOUSE           = 0x0001,
61         MIDDLEMOUSE         = 0x0002,
62         RIGHTMOUSE          = 0x0003,
63         MOUSEMOVE           = 0x0004,
64         /* Extra mouse buttons */
65         BUTTON4MOUSE        = 0x0007,
66         BUTTON5MOUSE        = 0x0008,
67         /* More mouse buttons - can't use 9 and 10 here (wheel) */
68         BUTTON6MOUSE        = 0x0012,
69         BUTTON7MOUSE        = 0x0013,
70         /* Extra trackpad gestures */
71         MOUSEPAN            = 0x000e,
72         MOUSEZOOM           = 0x000f,
73         MOUSEROTATE         = 0x0010,
74         /* defaults from ghost */
75         WHEELUPMOUSE        = 0x000a,
76         WHEELDOWNMOUSE      = 0x000b,
77         /* mapped with userdef */
78         WHEELINMOUSE        = 0x000c,
79         WHEELOUTMOUSE       = 0x000d,
80         /* Successive MOUSEMOVE's are converted to this, so we can easily
81          * ignore all but the most recent MOUSEMOVE (for better performance),
82          * paint and drawing tools however will want to handle these. */
83         INBETWEEN_MOUSEMOVE = 0x0011,
84
85 /* IME event, GHOST_kEventImeCompositionStart in ghost */
86         WM_IME_COMPOSITE_START = 0x0014,
87 /* IME event, GHOST_kEventImeComposition in ghost */
88         WM_IME_COMPOSITE_EVENT      = 0x0015,
89 /* IME event, GHOST_kEventImeCompositionEnd in ghost */
90         WM_IME_COMPOSITE_END   = 0x0016,
91
92         /* Tablet/Pen Specific Events */
93         TABLET_STYLUS       = 0x001a,
94         TABLET_ERASER       = 0x001b,
95
96         /* *** Start of keyboard codes. *** */
97
98         /* standard keyboard.
99          * XXX from 0x0020 to 0x00ff, and 0x012c to 0x013f for function keys! */
100
101         /* NOTE: these values are saved in keymap files, do not change them but just add new ones */
102         AKEY            = 0x0061,  /* 'a' */
103         BKEY            = 0x0062,  /* 'b' */
104         CKEY            = 0x0063,  /* 'c' */
105         DKEY            = 0x0064,  /* 'd' */
106         EKEY            = 0x0065,  /* 'e' */
107         FKEY            = 0x0066,  /* 'f' */
108         GKEY            = 0x0067,  /* 'g' */
109 #ifndef WIN32
110         HKEY            = 0x0068,  /* 'h' */
111 #else
112 #define HKEY 0x0068
113 #endif
114         IKEY            = 0x0069,  /* 'i' */
115         JKEY            = 0x006a,  /* 'j' */
116         KKEY            = 0x006b,  /* 'k' */
117         LKEY            = 0x006c,  /* 'l' */
118         MKEY            = 0x006d,  /* 'm' */
119         NKEY            = 0x006e,  /* 'n' */
120         OKEY            = 0x006f,  /* 'o' */
121         PKEY            = 0x0070,  /* 'p' */
122         QKEY            = 0x0071,  /* 'q' */
123         RKEY            = 0x0072,  /* 'r' */
124         SKEY            = 0x0073,  /* 's' */
125         TKEY            = 0x0074,  /* 't' */
126         UKEY            = 0x0075,  /* 'u' */
127         VKEY            = 0x0076,  /* 'v' */
128         WKEY            = 0x0077,  /* 'w' */
129         XKEY            = 0x0078,  /* 'x' */
130         YKEY            = 0x0079,  /* 'y' */
131         ZKEY            = 0x007a,  /* 'z' */
132
133         ZEROKEY         = 0x0030,  /* '0' */
134         ONEKEY          = 0x0031,  /* '1' */
135         TWOKEY          = 0x0032,  /* '2' */
136         THREEKEY        = 0x0033,  /* '3' */
137         FOURKEY         = 0x0034,  /* '4' */
138         FIVEKEY         = 0x0035,  /* '5' */
139         SIXKEY          = 0x0036,  /* '6' */
140         SEVENKEY        = 0x0037,  /* '7' */
141         EIGHTKEY        = 0x0038,  /* '8' */
142         NINEKEY         = 0x0039,  /* '9' */
143
144         CAPSLOCKKEY     = 0x00d3,  /* 211 */
145
146         LEFTCTRLKEY     = 0x00d4,  /* 212 */
147         LEFTALTKEY      = 0x00d5,  /* 213 */
148         RIGHTALTKEY     = 0x00d6,  /* 214 */
149         RIGHTCTRLKEY    = 0x00d7,  /* 215 */
150         RIGHTSHIFTKEY   = 0x00d8,  /* 216 */
151         LEFTSHIFTKEY    = 0x00d9,  /* 217 */
152
153         ESCKEY          = 0x00da,  /* 218 */
154         TABKEY          = 0x00db,  /* 219 */
155         RETKEY          = 0x00dc,  /* 220 */
156         SPACEKEY        = 0x00dd,  /* 221 */
157         LINEFEEDKEY     = 0x00de,  /* 222 */
158         BACKSPACEKEY    = 0x00df,  /* 223 */
159         DELKEY          = 0x00e0,  /* 224 */
160         SEMICOLONKEY    = 0x00e1,  /* 225 */
161         PERIODKEY       = 0x00e2,  /* 226 */
162         COMMAKEY        = 0x00e3,  /* 227 */
163         QUOTEKEY        = 0x00e4,  /* 228 */
164         ACCENTGRAVEKEY  = 0x00e5,  /* 229 */
165         MINUSKEY        = 0x00e6,  /* 230 */
166         PLUSKEY         = 0x00e7,  /* 231 */
167         SLASHKEY        = 0x00e8,  /* 232 */
168         BACKSLASHKEY    = 0x00e9,  /* 233 */
169         EQUALKEY        = 0x00ea,  /* 234 */
170         LEFTBRACKETKEY  = 0x00eb,  /* 235 */
171         RIGHTBRACKETKEY = 0x00ec,  /* 236 */
172
173         LEFTARROWKEY    = 0x0089,  /* 137 */
174         DOWNARROWKEY    = 0x008a,  /* 138 */
175         RIGHTARROWKEY   = 0x008b,  /* 139 */
176         UPARROWKEY      = 0x008c,  /* 140 */
177
178         PAD0            = 0x0096,  /* 150 */
179         PAD1            = 0x0097,  /* 151 */
180         PAD2            = 0x0098,  /* 152 */
181         PAD3            = 0x0099,  /* 153 */
182         PAD4            = 0x009a,  /* 154 */
183         PAD5            = 0x009b,  /* 155 */
184         PAD6            = 0x009c,  /* 156 */
185         PAD7            = 0x009d,  /* 157 */
186         PAD8            = 0x009e,  /* 158 */
187         PAD9            = 0x009f,  /* 159 */
188
189         PADPERIOD       = 0x00c7,  /* 199 */
190         PADASTERKEY     = 0x00a0,  /* 160 */
191         PADSLASHKEY     = 0x00a1,  /* 161 */
192         PADMINUS        = 0x00a2,  /* 162 */
193         PADENTER        = 0x00a3,  /* 163 */
194         PADPLUSKEY      = 0x00a4,  /* 164 */
195
196         PAUSEKEY        = 0x00a5,  /* 165 */
197         INSERTKEY       = 0x00a6,  /* 166 */
198         HOMEKEY         = 0x00a7,  /* 167 */
199         PAGEUPKEY       = 0x00a8,  /* 168 */
200         PAGEDOWNKEY     = 0x00a9,  /* 169 */
201         ENDKEY          = 0x00aa,  /* 170 */
202
203         UNKNOWNKEY      = 0x00ab,  /* 171 */
204         OSKEY           = 0x00ac,  /* 172 */
205         GRLESSKEY       = 0x00ad,  /* 173 */
206
207         /* XXX: are these codes ok? */
208         MEDIAPLAY       = 0x00ae,  /* 174 */
209         MEDIASTOP       = 0x00af,  /* 175 */
210         MEDIAFIRST      = 0x00b0,  /* 176 */
211         MEDIALAST       = 0x00b1,  /* 177 */
212
213         F1KEY           = 0x012c,  /* 300 */
214         F2KEY           = 0x012d,  /* 301 */
215         F3KEY           = 0x012e,  /* 302 */
216         F4KEY           = 0x012f,  /* 303 */
217         F5KEY           = 0x0130,  /* 304 */
218         F6KEY           = 0x0131,  /* 305 */
219         F7KEY           = 0x0132,  /* 306 */
220         F8KEY           = 0x0133,  /* 307 */
221         F9KEY           = 0x0134,  /* 308 */
222         F10KEY          = 0x0135,  /* 309 */
223         F11KEY          = 0x0136,  /* 310 */
224         F12KEY          = 0x0137,  /* 311 */
225         F13KEY          = 0x0138,  /* 312 */
226         F14KEY          = 0x0139,  /* 313 */
227         F15KEY          = 0x013a,  /* 314 */
228         F16KEY          = 0x013b,  /* 315 */
229         F17KEY          = 0x013c,  /* 316 */
230         F18KEY          = 0x013d,  /* 317 */
231         F19KEY          = 0x013e,  /* 318 */
232
233         /* *** End of keyboard codes. *** */
234
235         /* NDOF (from SpaceNavigator & friends)
236          * These should be kept in sync with GHOST_NDOFManager.h
237          * Ordering matters, exact values do not. */
238         NDOF_MOTION = 0x0190,
239         /* used internally, never sent */
240         NDOF_BUTTON_NONE = NDOF_MOTION,
241         /* these two are available from any 3Dconnexion device */
242         NDOF_BUTTON_MENU,
243         NDOF_BUTTON_FIT,
244         /* standard views */
245         NDOF_BUTTON_TOP,
246         NDOF_BUTTON_BOTTOM,
247         NDOF_BUTTON_LEFT,
248         NDOF_BUTTON_RIGHT,
249         NDOF_BUTTON_FRONT,
250         NDOF_BUTTON_BACK,
251         /* more views */
252         NDOF_BUTTON_ISO1,
253         NDOF_BUTTON_ISO2,
254         /* 90 degree rotations */
255         NDOF_BUTTON_ROLL_CW,
256         NDOF_BUTTON_ROLL_CCW,
257         NDOF_BUTTON_SPIN_CW,
258         NDOF_BUTTON_SPIN_CCW,
259         NDOF_BUTTON_TILT_CW,
260         NDOF_BUTTON_TILT_CCW,
261         /* device control */
262         NDOF_BUTTON_ROTATE,
263         NDOF_BUTTON_PANZOOM,
264         NDOF_BUTTON_DOMINANT,
265         NDOF_BUTTON_PLUS,
266         NDOF_BUTTON_MINUS,
267         /* keyboard emulation */
268         NDOF_BUTTON_ESC,
269         NDOF_BUTTON_ALT,
270         NDOF_BUTTON_SHIFT,
271         NDOF_BUTTON_CTRL,
272         /* general-purpose buttons */
273         NDOF_BUTTON_1,
274         NDOF_BUTTON_2,
275         NDOF_BUTTON_3,
276         NDOF_BUTTON_4,
277         NDOF_BUTTON_5,
278         NDOF_BUTTON_6,
279         NDOF_BUTTON_7,
280         NDOF_BUTTON_8,
281         NDOF_BUTTON_9,
282         NDOF_BUTTON_10,
283         /* more general-purpose buttons */
284         NDOF_BUTTON_A,
285         NDOF_BUTTON_B,
286         NDOF_BUTTON_C,
287         /* the end */
288         NDOF_LAST,
289
290         /* ********** End of Input devices. ********** */
291
292         /* ********** Start of Blender internal events. ********** */
293
294         /* XXX Those are mixed inside keyboard 'area'! */
295         /* System: 0x010x */
296         INPUTCHANGE           = 0x0103,  /* input connected or disconnected */
297         WINDEACTIVATE         = 0x0104,  /* window is deactivated, focus lost */
298         /* Timer: 0x011x */
299         TIMER                 = 0x0110,  /* timer event, passed on to all queues */
300         TIMER0                = 0x0111,  /* timer event, slot for internal use */
301         TIMER1                = 0x0112,  /* timer event, slot for internal use */
302         TIMER2                = 0x0113,  /* timer event, slot for internal use */
303         TIMERJOBS             = 0x0114,  /* timer event, jobs system */
304         TIMERAUTOSAVE         = 0x0115,  /* timer event, autosave */
305         TIMERREPORT           = 0x0116,  /* timer event, reports */
306         TIMERREGION           = 0x0117,  /* timer event, region slide in/out */
307         TIMERNOTIFIER         = 0x0118,  /* timer event, notifier sender */
308         TIMERF                = 0x011F,  /* last timer */
309
310         /* Actionzones, tweak, gestures: 0x500x, 0x501x */
311 #define EVT_ACTIONZONE_FIRST EVT_ACTIONZONE_AREA
312         EVT_ACTIONZONE_AREA   = 0x5000,
313         EVT_ACTIONZONE_REGION = 0x5001,
314         EVT_ACTIONZONE_FULLSCREEN = 0x5011,
315 #define EVT_ACTIONZONE_LAST (EVT_ACTIONZONE_FULLSCREEN + 1)
316
317         /* NOTE: these values are saved in keymap files, do not change them but just add new ones */
318
319         /* Tweak events:
320          * Sent as additional event with the mouse coordinates from where the initial click was placed. */
321
322         /* tweak events for L M R mousebuttons */
323         EVT_TWEAK_L           = 0x5002,
324         EVT_TWEAK_M           = 0x5003,
325         EVT_TWEAK_R           = 0x5004,
326         EVT_GESTURE           = 0x5010,
327
328         /* 0x5011 is taken, see EVT_ACTIONZONE_FULLSCREEN */
329
330         /* Misc Blender internals: 0x502x */
331         EVT_FILESELECT        = 0x5020,
332         EVT_BUT_OPEN          = 0x5021,
333         EVT_MODAL_MAP         = 0x5022,
334         EVT_DROP              = 0x5023,
335         EVT_BUT_CANCEL        = 0x5024,
336
337         /* could become gizmo callback */
338         EVT_GIZMO_UPDATE     = 0x5025,
339         /* ********** End of Blender internal events. ********** */
340 };
341
342
343 /* *********** wmEvent.type helpers. ********** */
344
345 /* test whether the event is timer event */
346 #define ISTIMER(event_type)     ((event_type) >= TIMER && (event_type) <= TIMERF)
347
348 /* for event checks */
349 /* only used for KM_TEXTINPUT, so assume that we want all user-inputtable ascii codes included */
350 /* UNUSED - see wm_eventmatch - BUG [#30479] */
351 /* #define ISTEXTINPUT(event_type)  ((event_type) >= ' ' && (event_type) <= 255) */
352 /* note, an alternative could be to check 'event->utf8_buf' */
353
354 /* test whether the event is a key on the keyboard */
355 #define ISKEYBOARD(event_type)                          \
356         (((event_type) >= 0x0020 && (event_type) <= 0x00ff) ||  \
357          ((event_type) >= 0x012c && (event_type) <= 0x013f))
358
359 /* test whether the event is a modifier key */
360 #define ISKEYMODIFIER(event_type) \
361         (((event_type) >= LEFTCTRLKEY && (event_type) <= LEFTSHIFTKEY) || (event_type) == OSKEY)
362
363 /* test whether the event is a mouse button */
364 #define ISMOUSE(event_type)  ((event_type) >= LEFTMOUSE && (event_type) <= BUTTON7MOUSE)
365
366 #define ISMOUSE_WHEEL(event_type)  ((event_type) >= WHEELUPMOUSE && (event_type) <= WHEELOUTMOUSE)
367 #define ISMOUSE_GESTURE(event_type)  ((event_type) >= MOUSEPAN && (event_type) <= MOUSEROTATE)
368 #define ISMOUSE_BUTTON(event_type) \
369         (ELEM(event_type, \
370               LEFTMOUSE, MIDDLEMOUSE, RIGHTMOUSE, \
371               BUTTON4MOUSE, BUTTON5MOUSE, BUTTON6MOUSE, BUTTON7MOUSE))
372
373 /* test whether the event is tweak event */
374 #define ISTWEAK(event_type)  ((event_type) >= EVT_TWEAK_L && (event_type) <= EVT_GESTURE)
375
376 /* test whether the event is a NDOF event */
377 #define ISNDOF(event_type)  ((event_type) >= NDOF_MOTION && (event_type) < NDOF_LAST)
378
379 #define IS_EVENT_ACTIONZONE(event_type)  ((event_type) >= EVT_ACTIONZONE_FIRST && (event_type) < EVT_ACTIONZONE_LAST)
380
381 /* test whether event type is acceptable as hotkey, excluding modifiers */
382 #define ISHOTKEY(event_type)                                                  \
383         ((ISKEYBOARD(event_type) || ISMOUSE(event_type) || ISNDOF(event_type)) && \
384          (ISKEYMODIFIER(event_type) == false))
385
386 /* internal helpers*/
387 #define _VA_IS_EVENT_MOD2(v, a) (CHECK_TYPE_INLINE(v, wmEvent *), \
388        ((v)->a))
389 #define _VA_IS_EVENT_MOD3(v, a, b) \
390        (_VA_IS_EVENT_MOD2(v, a) || ((v)->b))
391 #define _VA_IS_EVENT_MOD4(v, a, b, c) \
392        (_VA_IS_EVENT_MOD3(v, a, b) || ((v)->c))
393 #define _VA_IS_EVENT_MOD5(v, a, b, c, d) \
394        (_VA_IS_EVENT_MOD4(v, a, b, c) || ((v)->d))
395
396 /* reusable IS_EVENT_MOD(event, shift, ctrl, alt, oskey), macro */
397 #define IS_EVENT_MOD(...) VA_NARGS_CALL_OVERLOAD(_VA_IS_EVENT_MOD, __VA_ARGS__)
398
399 enum eEventType_Mask {
400         /* ISKEYMODIFIER */
401         EVT_TYPE_MASK_KEYBOARD_MODIFIER = (1 << 0),
402         /* ISKEYBOARD */
403         EVT_TYPE_MASK_KEYBOARD = (1 << 1),
404         /* ISMOUSE_WHEEL */
405         EVT_TYPE_MASK_MOUSE_WHEEL = (1 << 2),
406         /* ISMOUSE_BUTTON */
407         EVT_TYPE_MASK_MOUSE_GESTURE = (1 << 3),
408         /* ISMOUSE_GESTURE */
409         EVT_TYPE_MASK_MOUSE_BUTTON = (1 << 4),
410         /* ISMOUSE */
411         EVT_TYPE_MASK_MOUSE = (1 << 5),
412         /* ISNDOF */
413         EVT_TYPE_MASK_NDOF = (1 << 6),
414         /* ISTWEAK */
415         EVT_TYPE_MASK_TWEAK = (1 << 7),
416         /* IS_EVENT_ACTIONZONE */
417         EVT_TYPE_MASK_ACTIONZONE = (1 << 8),
418 };
419 #define EVT_TYPE_MASK_ALL \
420         (EVT_TYPE_MASK_KEYBOARD | \
421          EVT_TYPE_MASK_MOUSE | \
422          EVT_TYPE_MASK_NDOF | \
423          EVT_TYPE_MASK_TWEAK | \
424          EVT_TYPE_MASK_ACTIONZONE)
425
426 #define EVT_TYPE_MASK_HOTKEY_INCLUDE \
427         (EVT_TYPE_MASK_KEYBOARD | EVT_TYPE_MASK_MOUSE | EVT_TYPE_MASK_NDOF)
428 #define EVT_TYPE_MASK_HOTKEY_EXCLUDE \
429         EVT_TYPE_MASK_KEYBOARD_MODIFIER
430
431 bool WM_event_type_mask_test(const int event_type, const enum eEventType_Mask mask);
432
433
434 /* ********** wmEvent.val ********** */
435
436 /* Gestures */
437 /* NOTE: these values are saved in keymap files, do not change them but just add new ones */
438 enum {
439         /* value of tweaks and line gestures, note, KM_ANY (-1) works for this case too */
440         EVT_GESTURE_N   = 1,
441         EVT_GESTURE_NE  = 2,
442         EVT_GESTURE_E   = 3,
443         EVT_GESTURE_SE  = 4,
444         EVT_GESTURE_S   = 5,
445         EVT_GESTURE_SW  = 6,
446         EVT_GESTURE_W   = 7,
447         EVT_GESTURE_NW  = 8,
448         /* value of corner gestures */
449         EVT_GESTURE_N_E = 9,
450         EVT_GESTURE_N_W = 10,
451         EVT_GESTURE_E_N = 11,
452         EVT_GESTURE_E_S = 12,
453         EVT_GESTURE_S_E = 13,
454         EVT_GESTURE_S_W = 14,
455         EVT_GESTURE_W_S = 15,
456         EVT_GESTURE_W_N = 16,
457 };
458
459 /* File select */
460 enum {
461         EVT_FILESELECT_FULL_OPEN        = 1,
462         EVT_FILESELECT_EXEC             = 2,
463         EVT_FILESELECT_CANCEL           = 3,
464         EVT_FILESELECT_EXTERNAL_CANCEL  = 4,
465 };
466
467 /* Gesture */
468 /* NOTE: these values are saved in keymap files, do not change them but just add new ones */
469 enum {
470         GESTURE_MODAL_CANCEL      = 1,
471         GESTURE_MODAL_CONFIRM     = 2,
472
473         /* Uses 'deselect' operator property. */
474         GESTURE_MODAL_SELECT      = 3,
475         GESTURE_MODAL_DESELECT    = 4,
476
477         GESTURE_MODAL_NOP         = 5, /* circle select when no mouse button is pressed */
478
479         GESTURE_MODAL_CIRCLE_ADD  = 6, /* circle sel: larger brush */
480         GESTURE_MODAL_CIRCLE_SUB  = 7, /* circle sel: smaller brush */
481
482         GESTURE_MODAL_BEGIN       = 8, /* box select/straight line, activate, use release to detect which button */
483
484         /* Uses 'zoom_out' operator property. */
485         GESTURE_MODAL_IN          = 9,
486         GESTURE_MODAL_OUT         = 10,
487
488         GESTURE_MODAL_CIRCLE_SIZE = 11, /* circle sel: size brush (for trackpad event) */
489 };
490
491
492 #endif  /* __WM_EVENT_TYPES_H__ */