merge with/from trunk at r35190
[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 /** \file DNA_windowmanager_types.h
32  *  \ingroup DNA
33  */
34
35 #include "DNA_listBase.h"
36 #include "DNA_vec_types.h"
37
38 #include "DNA_ID.h"
39
40 /* defined here: */
41 struct wmWindowManager;
42 struct wmWindow;
43
44 struct wmEvent;
45 struct wmGesture;
46 struct wmOperatorType;
47 struct wmOperator;
48 struct wmKeyMap;
49 struct wmKeyConfig;
50
51 /* forwards */
52 struct bContext;
53 struct wmLocal;
54 struct bScreen;
55 struct uiBlock;
56 struct wmSubWindow;
57 struct wmTimer;
58 struct StructRNA;
59 struct PointerRNA;
60 struct ReportList;
61 struct Report;
62 struct uiLayout;
63
64 #define OP_MAX_TYPENAME 64
65 #define KMAP_MAX_NAME   64
66
67 /* keep in sync with 'wm_report_items' in wm_rna.c */
68 typedef enum ReportType {
69         RPT_DEBUG                                       = 1<<0,
70         RPT_INFO                                        = 1<<1,
71         RPT_OPERATOR                            = 1<<2,
72         RPT_WARNING                                     = 1<<3,
73         RPT_ERROR                                       = 1<<4,
74         RPT_ERROR_INVALID_INPUT         = 1<<5,
75         RPT_ERROR_INVALID_CONTEXT       = 1<<6,
76         RPT_ERROR_OUT_OF_MEMORY         = 1<<7
77 } ReportType;
78
79 #define RPT_DEBUG_ALL           (RPT_DEBUG)
80 #define RPT_INFO_ALL            (RPT_INFO)
81 #define RPT_OPERATOR_ALL        (RPT_OPERATOR)
82 #define RPT_WARNING_ALL         (RPT_WARNING)
83 #define RPT_ERROR_ALL           (RPT_ERROR|RPT_ERROR_INVALID_INPUT|RPT_ERROR_INVALID_CONTEXT|RPT_ERROR_OUT_OF_MEMORY)
84
85 enum ReportListFlags {
86         RPT_PRINT = 1,
87         RPT_STORE = 2,
88         RPT_FREE = 4
89 };
90 #
91 #
92 typedef struct Report {
93         struct Report *next, *prev;
94         short type; /* ReportType */
95         short flag;
96         int len; /* strlen(message), saves some time calculating the word wrap  */
97         const char *typestr;
98         const char *message;
99 } Report;
100
101 /* saved in the wm, dont remove */
102 typedef struct ReportList {
103         ListBase list;
104         int printlevel; /* ReportType */
105         int storelevel; /* ReportType */
106         int flag, pad;
107         struct wmTimer *reporttimer;
108 } ReportList;
109
110 /* timer customdata to control reports display */
111 #
112 #
113 typedef struct ReportTimerInfo {
114         float col[3];
115         float greyscale;
116         float widthfac;
117 } ReportTimerInfo;
118
119 /* reports need to be before wmWindowManager */
120
121
122 /* windowmanager is saved, tag WMAN */
123 typedef struct wmWindowManager {
124         ID id;
125         
126         struct wmWindow *windrawable, *winactive;               /* separate active from drawable */
127         ListBase windows;
128         
129         int initialized;                /* set on file read */
130         short file_saved;               /* indicator whether data was saved */
131         short op_undo_depth;    /* operator stack depth to avoid nested undo pushes */
132         
133         ListBase operators;             /* operator registry */
134         
135         ListBase queue;                 /* refresh/redraw wmNotifier structs */
136         
137         struct ReportList reports;      /* information and error reports */
138         
139         ListBase jobs;                  /* threaded jobs manager */
140         
141         ListBase paintcursors;  /* extra overlay cursors to draw, like circles */
142         
143         ListBase drags;                 /* active dragged items */
144         
145         ListBase keyconfigs;                            /* known key configurations */
146         struct wmKeyConfig *defaultconf;        /* default configuration, not saved */
147
148         ListBase timers;                                        /* active timers */
149         struct wmTimer *autosavetimer;          /* timer for auto save */
150 } wmWindowManager;
151
152 /* wmWindowManager.initialized */
153 #define WM_INIT_WINDOW          (1<<0)
154 #define WM_INIT_KEYMAP          (1<<1)
155
156 /* the savable part, rest of data is local in ghostwinlay */
157 typedef struct wmWindow {
158         struct wmWindow *next, *prev;
159         
160         void *ghostwin;         /* dont want to include ghost.h stuff */
161         
162         int winid;              /* winid also in screens, is for retrieving this window after read */
163
164         short grabcursor; /* cursor grab mode */
165         short pad;
166         
167         struct bScreen *screen;         /* active screen */
168         struct bScreen *newscreen;      /* temporary when switching */
169         char screenname[32];    /* MAX_ID_NAME for matching window with active screen after file read */
170         
171         short posx, posy, sizex, sizey; /* window coords */
172         short windowstate;      /* borderless, full */
173         short monitor;          /* multiscreen... no idea how to store yet */
174         short active;           /* set to 1 if an active window, for quick rejects */
175         short cursor;           /* current mouse cursor type */
176         short lastcursor;       /* previous cursor when setting modal one */
177         short modalcursor;      /* the current modal cursor */
178         short addmousemove;     /* internal: tag this for extra mousemove event, makes cursors/buttons active on UI switching */
179         short pad2;
180
181         struct wmEvent *eventstate;     /* storage for event system */
182         
183         struct wmSubWindow *curswin;    /* internal for wm_subwindow.c only */
184
185         struct wmGesture *tweak;        /* internal for wm_operators.c */
186         
187         int drawmethod, drawfail;       /* internal for wm_draw.c only */
188         void *drawdata;                         /* internal for wm_draw.c only */
189         
190         ListBase queue;                         /* all events (ghost level events were handled) */
191         ListBase handlers;                      /* window+screen handlers, handled last */
192         ListBase modalhandlers;         /* priority handlers, handled first */
193         
194         ListBase subwindows;    /* opengl stuff for sub windows, see notes in wm_subwindow.c */
195         ListBase gesture;               /* gesture stuff */
196         double lasttime;
197 } wmWindow;
198
199 /* should be somthing like DNA_EXCLUDE 
200  * but the preprocessor first removes all comments, spaces etc */
201
202 #
203 #
204 typedef struct wmOperatorTypeMacro {
205         struct wmOperatorTypeMacro *next, *prev;
206
207         /* operator id */
208         char idname[64];
209         /* rna pointer to access properties, like keymap */
210         struct IDProperty *properties;  /* operator properties, assigned to ptr->data and can be written to a file */
211         struct PointerRNA *ptr;
212
213 } wmOperatorTypeMacro;
214
215 /* partial copy of the event, for matching by eventhandler */
216 typedef struct wmKeyMapItem {
217         struct wmKeyMapItem *next, *prev;
218         
219         /* operator */
220         char idname[64];        /* used to retrieve operator type pointer */
221         IDProperty *properties;                 /* operator properties, assigned to ptr->data and can be written to a file */
222         
223         /* modal */
224         short propvalue;                                /* if used, the item is from modal map */
225
226         /* event */
227         short type;                                             /* event code itself */
228         short val;                                              /* KM_ANY, KM_PRESS, KM_NOTHING etc */
229         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
230         short keymodifier;                              /* rawkey modifier */
231         
232         /* flag: inactive, expanded */
233         short flag;
234
235         /* runtime */
236         short maptype;                                  /* keymap editor */
237         short id;                                               /* unique identifier. Positive for kmi that override builtins, negative otherwise */
238         short pad;
239         struct PointerRNA *ptr;                 /* rna pointer to access properties */
240 } wmKeyMapItem;
241
242 /* wmKeyMapItem.flag */
243 #define KMI_INACTIVE    1
244 #define KMI_EXPANDED    2
245
246 /* stored in WM, the actively used keymaps */
247 typedef struct wmKeyMap {
248         struct wmKeyMap *next, *prev;
249         
250         ListBase items;
251         
252         char idname[64];        /* global editor keymaps, or for more per space/region */
253         short spaceid;          /* same IDs as in DNA_space_types.h */
254         short regionid;         /* see above */
255         
256         short flag;                     /* general flags */
257         short kmi_id;           /* last kmi id */
258         
259         /* runtime */
260         int (*poll)(struct bContext *); /* verify if enabled in the current context */
261         void *modal_items;                              /* for modal, EnumPropertyItem for now */
262 } wmKeyMap;
263
264 /* wmKeyMap.flag */
265 #define KEYMAP_MODAL                            1       /* modal map, not using operatornames */
266 #define KEYMAP_USER                                     2       /* user created keymap */
267 #define KEYMAP_EXPANDED                         4
268 #define KEYMAP_CHILDREN_EXPANDED        8
269
270 typedef struct wmKeyConfig {
271         struct wmKeyConfig *next, *prev;
272
273         char idname[64];                /* unique name */
274         char basename[64];              /* idname of configuration this is derives from, "" if none */
275         
276         ListBase keymaps;
277         int actkeymap, flag;
278 } wmKeyConfig;
279
280 /* wmKeyConfig.flag */
281 #define KEYCONF_USER                    (1 << 1)
282
283 /* this one is the operator itself, stored in files for macros etc */
284 /* operator + operatortype should be able to redo entirely, but for different contextes */
285 typedef struct wmOperator {
286         struct wmOperator *next, *prev;
287
288         /* saved */
289         char idname[64];/* used to retrieve type pointer */
290         IDProperty *properties;         /* saved, user-settable properties */
291
292         /* runtime */
293         struct wmOperatorType *type;/* operator type definition from idname */
294         void *customdata;                       /* custom storage, only while operator runs */
295         void *py_instance;                      /* python stores the class instance here */
296
297         struct PointerRNA *ptr;         /* rna pointer to access properties */
298         struct ReportList *reports;     /* errors and warnings storage */
299
300         ListBase macro;                         /* list of operators, can be a tree */
301         struct wmOperator *opm;         /* current running macro, not saved */
302         struct uiLayout *layout;        /* runtime for drawing */
303         short flag, pad[3];
304
305 } wmOperator;
306
307 /* operator type exec(), invoke() modal(), return values */
308 #define OPERATOR_RUNNING_MODAL  1
309 #define OPERATOR_CANCELLED              2
310 #define OPERATOR_FINISHED               4
311 /* add this flag if the event should pass through */
312 #define OPERATOR_PASS_THROUGH   8
313 /* in case operator got executed outside WM code... like via fileselect */
314 #define OPERATOR_HANDLED                16
315
316 /* wmOperator flag */
317 #define OP_GRAB_POINTER                 1
318
319 typedef enum wmRadialControlMode {
320         WM_RADIALCONTROL_SIZE,
321         WM_RADIALCONTROL_STRENGTH,
322         WM_RADIALCONTROL_ANGLE
323 } wmRadialControlMode;
324
325 #endif /* DNA_WINDOWMANAGER_TYPES_H */