4a7080034ee82d293ff79b03533c1cd089eed433
[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 drags;                 /* active dragged items */
125         
126         ListBase keyconfigs;                            /* known key configurations */
127         struct wmKeyConfig *defaultconf;        /* default configuration, not saved */
128
129         ListBase timers;                                        /* active timers */
130         struct wmTimer *autosavetimer;          /* timer for auto save */
131 } wmWindowManager;
132
133 /* wmWindowManager.initialized */
134 #define WM_INIT_WINDOW          1<<0
135 #define WM_INIT_KEYMAP          1<<1
136
137 /* the savable part, rest of data is local in ghostwinlay */
138 typedef struct wmWindow {
139         struct wmWindow *next, *prev;
140         
141         void *ghostwin;         /* dont want to include ghost.h stuff */
142         
143         int winid;              /* winid also in screens, is for retrieving this window after read */
144
145         short grabcursor; /* cursor grab mode */
146         short pad;
147         
148         struct bScreen *screen;         /* active screen */
149         struct bScreen *newscreen;      /* temporary when switching */
150         char screenname[32];    /* MAX_ID_NAME for matching window with active screen after file read */
151         
152         short posx, posy, sizex, sizey; /* window coords */
153         short windowstate;      /* borderless, full */
154         short monitor;          /* multiscreen... no idea how to store yet */
155         short active;           /* set to 1 if an active window, for quick rejects */
156         short cursor;           /* current mouse cursor type */
157         short lastcursor;       /* for temp waitcursor */
158         short addmousemove;     /* internal: tag this for extra mousemove event, makes cursors/buttons active on UI switching */
159         short pad2[2];
160
161         struct wmEvent *eventstate;     /* storage for event system */
162         
163         struct wmSubWindow *curswin;    /* internal for wm_subwindow.c only */
164
165         struct wmGesture *tweak;        /* internal for wm_operators.c */
166         
167         int drawmethod, drawfail;       /* internal for wm_draw.c only */
168         void *drawdata;                         /* internal for wm_draw.c only */
169         
170         ListBase queue;                         /* all events (ghost level events were handled) */
171         ListBase handlers;                      /* window+screen handlers, handled last */
172         ListBase modalhandlers;         /* priority handlers, handled first */
173         
174         ListBase subwindows;    /* opengl stuff for sub windows, see notes in wm_subwindow.c */
175         ListBase gesture;               /* gesture stuff */
176 } wmWindow;
177
178 /* should be somthing like DNA_EXCLUDE 
179  * but the preprocessor first removes all comments, spaces etc */
180
181 #
182 #
183 typedef struct wmOperatorTypeMacro {
184         struct wmOperatorTypeMacro *next, *prev;
185
186         /* operator id */
187         char idname[64];
188         /* rna pointer to access properties, like keymap */
189         struct IDProperty *properties;  /* operator properties, assigned to ptr->data and can be written to a file */
190         struct PointerRNA *ptr;
191
192 } wmOperatorTypeMacro;
193
194 /* partial copy of the event, for matching by eventhandler */
195 typedef struct wmKeyMapItem {
196         struct wmKeyMapItem *next, *prev;
197         
198         /* operator */
199         char idname[64];        /* used to retrieve operator type pointer */
200         IDProperty *properties;                 /* operator properties, assigned to ptr->data and can be written to a file */
201         
202         /* modal */
203         short propvalue;                                /* if used, the item is from modal map */
204
205         /* event */
206         short type;                                             /* event code itself */
207         short val;                                              /* KM_ANY, KM_PRESS, KM_NOTHING etc */
208         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
209         short keymodifier;                              /* rawkey modifier */
210         
211         /* flag: inactive, expanded */
212         short flag;
213
214         /* runtime */
215         short maptype;                                  /* keymap editor */
216         short id;                                               /* unique identifier */
217         short pad;
218         struct PointerRNA *ptr;                 /* rna pointer to access properties */
219 } wmKeyMapItem;
220
221 /* wmKeyMapItem.flag */
222 #define KMI_INACTIVE    1
223 #define KMI_EXPANDED    2
224
225 /* stored in WM, the actively used keymaps */
226 typedef struct wmKeyMap {
227         struct wmKeyMap *next, *prev;
228         
229         ListBase items;
230         
231         char idname[64];        /* global editor keymaps, or for more per space/region */
232         short spaceid;          /* same IDs as in DNA_space_types.h */
233         short regionid;         /* see above */
234         
235         short flag;                     /* general flags */
236         short kmi_id;           /* last kmi id */
237         
238         /* runtime */
239         int (*poll)(struct bContext *); /* verify if enabled in the current context */
240         void *modal_items;                              /* for modal, EnumPropertyItem for now */
241 } wmKeyMap;
242
243 /* wmKeyMap.flag */
244 #define KEYMAP_MODAL                            1       /* modal map, not using operatornames */
245 #define KEYMAP_USER                                     2       /* user created keymap */
246 #define KEYMAP_EXPANDED                         4
247 #define KEYMAP_CHILDREN_EXPANDED        8
248
249 typedef struct wmKeyConfig {
250         struct wmKeyConfig *next, *prev;
251
252         char idname[64];                /* unique name */
253         char basename[64];              /* idname of configuration this is derives from, "" if none */
254
255         char filter[64];                /* search term for filtering in the UI */
256         
257         ListBase keymaps;
258         int actkeymap, flag;
259 } wmKeyConfig;
260
261 /* wmKeyConfig.flag */
262 #define KEYCONF_USER                    (1 << 1)
263
264 /* this one is the operator itself, stored in files for macros etc */
265 /* operator + operatortype should be able to redo entirely, but for different contextes */
266 typedef struct wmOperator {
267         struct wmOperator *next, *prev;
268
269         /* saved */
270         char idname[64];/* used to retrieve type pointer */
271         IDProperty *properties;         /* saved, user-settable properties */
272
273         /* runtime */
274         struct wmOperatorType *type;            /* operator type definition from idname */
275         void *customdata;                       /* custom storage, only while operator runs */
276
277         struct PointerRNA *ptr;         /* rna pointer to access properties */
278         struct ReportList *reports;     /* errors and warnings storage */
279
280         ListBase macro;                         /* list of operators, can be a tree */
281         struct wmOperator *opm;         /* current running macro, not saved */
282         struct uiLayout *layout;        /* runtime for drawing */
283         short flag, pad[3];
284
285 } wmOperator;
286
287 /* operator type exec(), invoke() modal(), return values */
288 #define OPERATOR_RUNNING_MODAL  1
289 #define OPERATOR_CANCELLED              2
290 #define OPERATOR_FINISHED               4
291 /* add this flag if the event should pass through */
292 #define OPERATOR_PASS_THROUGH   8
293 /* in case operator got executed outside WM code... like via fileselect */
294 #define OPERATOR_HANDLED                16
295
296 /* wmOperator flag */
297 #define OP_GRAB_POINTER                 1
298
299 typedef enum wmRadialControlMode {
300         WM_RADIALCONTROL_SIZE,
301         WM_RADIALCONTROL_STRENGTH,
302         WM_RADIALCONTROL_ANGLE
303 } wmRadialControlMode;
304
305 #endif /* DNA_WINDOWMANAGER_TYPES_H */
306