Cleanup: avoid function call for pointer compare
[blender.git] / source / blender / windowmanager / wm_event_system.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  * The Original Code is Copyright (C) 2007 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/windowmanager/wm_event_system.h
28  *  \ingroup wm
29  */
30
31 #ifndef __WM_EVENT_SYSTEM_H__
32 #define __WM_EVENT_SYSTEM_H__
33
34 /* return value of handler-operator call */
35 #define WM_HANDLER_CONTINUE  0
36 #define WM_HANDLER_BREAK     1
37 #define WM_HANDLER_HANDLED   2
38 #define WM_HANDLER_MODAL     4 /* MODAL|BREAK means unhandled */
39
40 struct ScrArea;
41 struct ARegion;
42
43 /* wmKeyMap is in DNA_windowmanager.h, it's saveable */
44
45 struct wmEventHandler_KeymapFn {
46         void (*handle_post_fn)(wmKeyMap *keymap, wmKeyMapItem *kmi, void *user_data);
47         void  *user_data;
48 };
49
50 typedef struct wmEventHandler {
51         struct wmEventHandler *next, *prev;
52
53         char type;                          /* WM_HANDLER_DEFAULT, ... */
54         char flag;                          /* WM_HANDLER_BLOCKING, ... */
55
56         /* keymap handler */
57         wmKeyMap *keymap;                   /* pointer to builtin/custom keymaps */
58         const rcti *bblocal, *bbwin;              /* optional local and windowspace bb */
59         /* Run after the keymap item runs. */
60         struct wmEventHandler_KeymapFn keymap_callback;
61
62         struct bToolRef *keymap_tool;
63
64         /* modal operator handler */
65         wmOperator *op;                     /* for derived/modal handlers */
66         struct ScrArea *op_area;            /* for derived/modal handlers */
67         struct ARegion *op_region;          /* for derived/modal handlers */
68         short           op_region_type;     /* for derived/modal handlers */
69
70         /* ui handler */
71         wmUIHandlerFunc ui_handle;          /* callback receiving events */
72         wmUIHandlerRemoveFunc ui_remove;    /* callback when handler is removed */
73         void *ui_userdata;                  /* user data pointer */
74         struct ScrArea *ui_area;            /* for derived/modal handlers */
75         struct ARegion *ui_region;          /* for derived/modal handlers */
76         struct ARegion *ui_menu;            /* for derived/modal handlers */
77
78         /* drop box handler */
79         ListBase *dropboxes;
80         /* gizmo handler */
81         struct wmGizmoMap *gizmo_map;
82 } wmEventHandler;
83
84 /* custom types for handlers, for signaling, freeing */
85 enum {
86         WM_HANDLER_DEFAULT,
87         WM_HANDLER_FILESELECT
88 };
89
90 /* wm_event_system.c */
91 void        wm_event_free_all       (wmWindow *win);
92 void        wm_event_free           (wmEvent *event);
93 void        wm_event_free_handler   (wmEventHandler *handler);
94
95             /* goes over entire hierarchy:  events -> window -> screen -> area -> region */
96 void        wm_event_do_handlers    (bContext *C);
97
98 void        wm_event_add_ghostevent (wmWindowManager *wm, wmWindow *win, int type, int time, void *customdata);
99
100 void        wm_event_do_depsgraph(bContext *C);
101 void        wm_event_do_refresh_wm_and_depsgraph(bContext *C);
102 void        wm_event_do_notifiers(bContext *C);
103
104 float       wm_pressure_curve(float raw_pressure);
105
106 /* wm_keymap.c */
107
108 /* wm_dropbox.c */
109 void        wm_dropbox_free(void);
110 void        wm_drags_check_ops(bContext *C, const wmEvent *event);
111 void        wm_drags_draw(bContext *C, wmWindow *win, rcti *rect);
112
113 #endif /* __WM_EVENT_SYSTEM_H__ */