keymap editor
[blender.git] / source / blender / makesdna / DNA_windowmanager_types.h
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) 2007 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 #ifndef DNA_WINDOWMANAGER_TYPES_H
29 #define DNA_WINDOWMANAGER_TYPES_H
30
31 #include "DNA_listBase.h"
32 #include "DNA_vec_types.h"
33
34 #include "DNA_ID.h"
35
36 /* defined here: */
37 struct wmWindowManager;
38 struct wmWindow;
39
40 struct wmEvent;
41 struct wmGesture;
42 struct wmOperatorType;
43 struct wmOperator;
44 struct wmKeyMap;
45 struct wmKeyConfig;
46
47 /* forwards */
48 struct bContext;
49 struct wmLocal;
50 struct bScreen;
51 struct uiBlock;
52 struct wmSubWindow;
53 struct wmTimer;
54 struct StructRNA;
55 struct PointerRNA;
56 struct ReportList;
57 struct Report;
58 struct uiLayout;
59
60 #define OP_MAX_TYPENAME 64
61 #define KMAP_MAX_NAME   64
62
63 /* keep in sync with 'wm_report_items' in wm_rna.c */
64 typedef enum ReportType {
65         RPT_DEBUG                                       = 1<<0,
66         RPT_INFO                                        = 1<<1,
67         RPT_OPERATOR                            = 1<<2,
68         RPT_WARNING                                     = 1<<3,
69         RPT_ERROR                                       = 1<<4,
70         RPT_ERROR_INVALID_INPUT         = 1<<5,
71         RPT_ERROR_INVALID_CONTEXT       = 1<<6,
72         RPT_ERROR_OUT_OF_MEMORY         = 1<<7
73 } ReportType;
74
75 #define RPT_DEBUG_ALL           (RPT_DEBUG)
76 #define RPT_INFO_ALL            (RPT_INFO)
77 #define RPT_OPERATOR_ALL        (RPT_OPERATOR)
78 #define RPT_WARNING_ALL         (RPT_WARNING)
79 #define RPT_ERROR_ALL           (RPT_ERROR|RPT_ERROR_INVALID_INPUT|RPT_ERROR_INVALID_CONTEXT|RPT_ERROR_OUT_OF_MEMORY)
80
81 enum ReportListFlags {
82         RPT_PRINT = 1,
83         RPT_STORE = 2,
84         RPT_FREE = 4,
85 };
86 typedef struct Report {
87         struct Report *next, *prev;
88         short type; /* ReportType */
89         short flag;
90         int len; /* strlen(message), saves some time calculating the word wrap  */
91         char *typestr;
92         char *message;
93 } Report;
94 typedef struct ReportList {
95         ListBase list;
96         int printlevel; /* ReportType */
97         int storelevel; /* ReportType */
98         int flag, pad;
99 } ReportList;
100 /* reports need to be before wmWindowManager */
101
102
103 /* windowmanager is saved, tag WMAN */
104 typedef struct wmWindowManager {
105         ID id;
106         
107         struct wmWindow *windrawable, *winactive;               /* separate active from drawable */
108         ListBase windows;
109         
110         int initialized;                /* set on file read */
111         short file_saved;               /* indicator whether data was saved */
112         short pad;
113         
114         ListBase operators;             /* operator registry */
115         
116         ListBase queue;                 /* refresh/redraw wmNotifier structs */
117         
118         struct ReportList reports;      /* information and error reports */
119         
120         ListBase jobs;                  /* threaded jobs manager */
121         
122         ListBase paintcursors;  /* extra overlay cursors to draw, like circles */
123         
124         ListBase keyconfigs;                            /* known key configurations */
125         struct wmKeyConfig *defaultconf;        /* default configuration, not saved */
126
127         ListBase timers;                                        /* active timers */
128         struct wmTimer *autosavetimer;          /* timer for auto save */
129 } wmWindowManager;
130
131 /* wmWindowManager.initialized */
132 #define WM_INIT_WINDOW          1<<0
133 #define WM_INIT_KEYMAP          1<<1
134
135 /* the savable part, rest of data is local in ghostwinlay */
136 typedef struct wmWindow {
137         struct wmWindow *next, *prev;
138         
139         void *ghostwin;         /* dont want to include ghost.h stuff */
140         
141         int winid;              /* winid also in screens, is for retrieving this window after read */
142
143         short grabcursor; /* cursor grab mode */
144         short pad;
145         
146         struct bScreen *screen;         /* active screen */
147         struct bScreen *newscreen;      /* temporary when switching */
148         char screenname[32];    /* MAX_ID_NAME for matching window with active screen after file read */
149         
150         short posx, posy, sizex, sizey; /* window coords */
151         short windowstate;      /* borderless, full */
152         short monitor;          /* multiscreen... no idea how to store yet */
153         short active;           /* set to 1 if an active window, for quick rejects */
154         short cursor;           /* current mouse cursor type */
155         short lastcursor;       /* for temp waitcursor */
156         short addmousemove;     /* internal: tag this for extra mousemove event, makes cursors/buttons active on UI switching */
157         
158         short last_type; /* last event information, used for click */
159         short last_val;
160         double last_click_time; /* for double click */
161
162         struct wmEvent *eventstate;     /* storage for event system */
163         
164         struct wmSubWindow *curswin;    /* internal for wm_subwindow.c only */
165
166         struct wmGesture *tweak;        /* internal for wm_operators.c */
167         
168         int drawmethod, drawfail;       /* internal for wm_draw.c only */
169         void *drawdata;                         /* internal for wm_draw.c only */
170         
171         ListBase queue;                         /* all events (ghost level events were handled) */
172         ListBase handlers;                      /* window+screen handlers, handled last */
173         ListBase modalhandlers;         /* priority handlers, handled first */
174         
175         ListBase subwindows;    /* opengl stuff for sub windows, see notes in wm_subwindow.c */
176         ListBase gesture;               /* gesture stuff */
177 } wmWindow;
178
179 /* should be somthing like DNA_EXCLUDE 
180  * but the preprocessor first removes all comments, spaces etc */
181
182 #
183 #
184 typedef struct wmOperatorTypeMacro {
185         struct wmOperatorTypeMacro *next, *prev;
186         
187         /* operator id */
188         char idname[MAX_ID_NAME];
189         /* rna pointer to access properties, like keymap */
190         struct IDProperty *properties;  /* operator properties, assigned to ptr->data and can be written to a file */
191         struct PointerRNA *ptr; 
192
193 } wmOperatorTypeMacro;
194
195 #
196 #
197 typedef struct wmOperatorType {
198         struct wmOperatorType *next, *prev;
199         
200         char *name;             /* text for ui, undo */
201         char *idname;           /* unique identifier */
202         char *description;      /* tooltips and python docs */
203         
204         /* this callback executes the operator without any interactive input,
205          * parameters may be provided through operator properties. cannot use
206          * any interface code or input device state.
207          * - see defines below for return values */
208         int (*exec)(struct bContext *, struct wmOperator *);
209
210         /* for modal temporary operators, initially invoke is called. then
211          * any further events are handled in modal. if the operation is
212          * cancelled due to some external reason, cancel is called
213          * - see defines below for return values */
214         int (*invoke)(struct bContext *, struct wmOperator *, struct wmEvent *);
215         int (*cancel)(struct bContext *, struct wmOperator *);
216         int (*modal)(struct bContext *, struct wmOperator *, struct wmEvent *);
217
218         /* verify if the operator can be executed in the current context, note
219          * that the operator might still fail to execute even if this return true */
220         int (*poll)(struct bContext *);
221         
222         /* optional panel for redo and repeat, autogenerated if not set */
223         void (*ui)(struct bContext *, struct wmOperator *, struct uiLayout *);
224         
225         /* rna for properties */
226         struct StructRNA *srna;
227         
228         /* struct wmOperatorTypeMacro */
229         ListBase macro;
230         
231         short flag;
232         
233         /* pointer to modal keymap, do not free! */
234         struct wmKeyMap *modalkeymap;
235         
236         /* only used for operators defined with python
237          * use to store pointers to python functions */
238         void *pyop_data;
239         int (*pyop_poll)(struct bContext *, struct wmOperatorType *ot);
240
241 } wmOperatorType;
242
243
244 /* partial copy of the event, for matching by eventhandler */
245 typedef struct wmKeyMapItem {
246         struct wmKeyMapItem *next, *prev;
247         
248         /* operator */
249         char idname[64];                                /* used to retrieve operator type pointer */
250         IDProperty *properties;                 /* operator properties, assigned to ptr->data and can be written to a file */
251         
252         /* modal */
253         short propvalue;                                /* if used, the item is from modal map */
254
255         /* event */
256         short type;                                             /* event code itself */
257         short val;                                              /* KM_ANY, KM_PRESS, KM_NOTHING etc */
258         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
259         short keymodifier;                              /* rawkey modifier */
260         
261         /* flag: inactive, expanded */
262         short flag;
263
264         /* runtime */
265         short maptype;                                  /* keymap editor */
266         short id;                                               /* unique identifier */
267         short pad;
268         struct PointerRNA *ptr;                 /* rna pointer to access properties */
269 } wmKeyMapItem;
270
271 /* wmKeyMapItem.flag */
272 #define KMI_INACTIVE    1
273 #define KMI_EXPANDED    2
274
275 /* stored in WM, the actively used keymaps */
276 typedef struct wmKeyMap {
277         struct wmKeyMap *next, *prev;
278         
279         ListBase items;
280         
281         char idname[64];        /* global editor keymaps, or for more per space/region */
282         short spaceid;          /* same IDs as in DNA_space_types.h */
283         short regionid;         /* see above */
284         
285         short flag;                     /* general flags */
286         short kmi_id;           /* last kmi id */
287         
288         /* runtime */
289         int (*poll)(struct bContext *); /* verify if enabled in the current context */
290         void *modal_items;                              /* for modal, EnumPropertyItem for now */
291 } wmKeyMap;
292
293 /* wmKeyMap.flag */
294 #define KEYMAP_MODAL                            1       /* modal map, not using operatornames */
295 #define KEYMAP_USER                                     2       /* user created keymap */
296 #define KEYMAP_EXPANDED                         4
297 #define KEYMAP_CHILDREN_EXPANDED        8
298
299 typedef struct wmKeyConfig {
300         struct wmKeyConfig *next, *prev;
301
302         char idname[64];                /* unique name */
303         char basename[64];              /* idname of configuration this is derives from, "" if none */
304
305         char filter[64];                /* search term for filtering in the UI */
306         
307         ListBase keymaps;
308         int actkeymap, flag;
309 } wmKeyConfig;
310
311 /* wmKeyConfig.flag */
312 #define KEYCONF_TWOBUTTONMOUSE  (1 << 1)
313 #define KEYCONF_LMOUSESELECT    (1 << 2)
314 #define KEYCONF_NONUMPAD                (1 << 3)
315
316 /* this one is the operator itself, stored in files for macros etc */
317 /* operator + operatortype should be able to redo entirely, but for different contextes */
318 typedef struct wmOperator {
319         struct wmOperator *next, *prev;
320
321         /* saved */
322         char idname[64];                        /* used to retrieve type pointer */
323         IDProperty *properties;         /* saved, user-settable properties */
324         
325         /* runtime */
326         wmOperatorType *type;           /* operator type definition from idname */
327         void *customdata;                       /* custom storage, only while operator runs */
328         
329         struct PointerRNA *ptr;         /* rna pointer to access properties */
330         struct ReportList *reports;     /* errors and warnings storage */
331         
332         ListBase macro;                         /* list of operators, can be a tree */
333         struct wmOperator *opm;         /* current running macro, not saved */
334         short flag, pad[3];
335         
336 } wmOperator;
337
338 /* operator type exec(), invoke() modal(), return values */
339 #define OPERATOR_RUNNING_MODAL  1
340 #define OPERATOR_CANCELLED              2
341 #define OPERATOR_FINISHED               4
342 /* add this flag if the event should pass through */
343 #define OPERATOR_PASS_THROUGH   8
344
345 /* wmOperator flag */
346 #define OP_GRAB_POINTER                 1
347
348 /* ************** wmEvent ************************ */
349 /* for read-only rna access, dont save this */
350
351 /* each event should have full modifier state */
352 /* event comes from eventmanager and from keymap */
353 typedef struct wmEvent {
354         struct wmEvent *next, *prev;
355         
356         short type;                     /* event code itself (short, is also in keymap) */
357         short val;                      /* press, release, scrollvalue */
358         short x, y;                     /* mouse pointer position, screen coord */
359         short mval[2];          /* region mouse position, name convention pre 2.5 :) */
360         short prevx, prevy;     /* previous mouse pointer position */
361         short unicode;          /* future, ghost? */
362         char ascii;                     /* from ghost */
363         char pad;
364         
365         /* modifier states */
366         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
367         short keymodifier;                              /* rawkey modifier */
368         
369         short pad1;
370         
371         /* keymap item, set by handler (weak?) */
372         const char *keymap_idname;
373         
374         /* custom data */
375         short custom;           /* custom data type, stylus, 6dof, see wm_event_types.h */
376         short customdatafree;
377         int pad2;
378         void *customdata;       /* ascii, unicode, mouse coords, angles, vectors, dragdrop info */
379         
380 } wmEvent;
381
382 typedef enum wmRadialControlMode {
383         WM_RADIALCONTROL_SIZE,
384         WM_RADIALCONTROL_STRENGTH,
385         WM_RADIALCONTROL_ANGLE
386 } wmRadialControlMode;
387
388 #endif /* DNA_WINDOWMANAGER_TYPES_H */
389