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