65685a7a419e3ca4d879a5720be34873588c1f00
[blender.git] / source / blender / makesdna / DNA_windowmanager_types.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 DNA_windowmanager_types.h
28  *  \ingroup DNA
29  */
30
31 #ifndef __DNA_WINDOWMANAGER_TYPES_H__
32 #define __DNA_WINDOWMANAGER_TYPES_H__
33
34 #include "DNA_color_types.h"  /* for color management */
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         RPT_OP_HOLD = 8 /* don't move them into the operator global list (caller will use) */
90 };
91 #
92 #
93 typedef struct Report {
94         struct Report *next, *prev;
95         short type; /* ReportType */
96         short flag;
97         int len; /* strlen(message), saves some time calculating the word wrap  */
98         const char *typestr;
99         const char *message;
100 } Report;
101
102 /* saved in the wm, don't remove */
103 typedef struct ReportList {
104         ListBase list;
105         int printlevel; /* ReportType */
106         int storelevel; /* ReportType */
107         int flag, pad;
108         struct wmTimer *reporttimer;
109 } ReportList;
110
111 /* timer customdata to control reports display */
112 #
113 #
114 typedef struct ReportTimerInfo {
115         float col[3];
116         float greyscale;
117         float widthfac;
118 } ReportTimerInfo;
119
120 /* reports need to be before wmWindowManager */
121
122
123 /* windowmanager is saved, tag WMAN */
124 typedef struct wmWindowManager {
125         ID id;
126         
127         struct wmWindow *windrawable, *winactive;               /* separate active from drawable */
128         ListBase windows;
129         
130         int initialized;                /* set on file read */
131         short file_saved;               /* indicator whether data was saved */
132         short op_undo_depth;    /* operator stack depth to avoid nested undo pushes */
133         
134         ListBase operators;             /* operator registry */
135         
136         ListBase queue;                 /* refresh/redraw wmNotifier structs */
137         
138         struct ReportList reports;      /* information and error reports */
139         
140         ListBase jobs;                  /* threaded jobs manager */
141         
142         ListBase paintcursors;  /* extra overlay cursors to draw, like circles */
143         
144         ListBase drags;                 /* active dragged items */
145         
146         ListBase keyconfigs;                            /* known key configurations */
147         struct wmKeyConfig *defaultconf;        /* default configuration */
148         struct wmKeyConfig *addonconf;          /* addon configuration */
149         struct wmKeyConfig *userconf;           /* user configuration */
150
151         ListBase timers;                                        /* active timers */
152         struct wmTimer *autosavetimer;          /* timer for auto save */
153 } wmWindowManager;
154
155 /* wmWindowManager.initialized */
156 #define WM_INIT_WINDOW          (1<<0)
157 #define WM_INIT_KEYMAP          (1<<1)
158
159 /* the savable part, rest of data is local in ghostwinlay */
160 typedef struct wmWindow {
161         struct wmWindow *next, *prev;
162         
163         void *ghostwin;         /* don't want to include ghost.h stuff */
164         
165         int winid;              /* winid also in screens, is for retrieving this window after read */
166
167         short grabcursor; /* cursor grab mode */
168         short pad;
169         
170         struct bScreen *screen;         /* active screen */
171         struct bScreen *newscreen;      /* temporary when switching */
172         char screenname[64];    /* MAX_ID_NAME for matching window with active screen after file read */
173         
174         short posx, posy, sizex, sizey; /* window coords */
175         short windowstate;      /* borderless, full */
176         short monitor;          /* multiscreen... no idea how to store yet */
177         short active;           /* set to 1 if an active window, for quick rejects */
178         short cursor;           /* current mouse cursor type */
179         short lastcursor;       /* previous cursor when setting modal one */
180         short modalcursor;      /* the current modal cursor */
181         short addmousemove;     /* internal: tag this for extra mousemove event, makes cursors/buttons active on UI switching */
182         short pad2;
183
184         struct wmEvent *eventstate;     /* storage for event system */
185         
186         struct wmSubWindow *curswin;    /* internal for wm_subwindow.c only */
187
188         struct wmGesture *tweak;        /* internal for wm_operators.c */
189         
190         int drawmethod, drawfail;       /* internal for wm_draw.c only */
191         void *drawdata;                         /* internal for wm_draw.c only */
192         
193         ListBase queue;                         /* all events (ghost level events were handled) */
194         ListBase handlers;                      /* window+screen handlers, handled last */
195         ListBase modalhandlers;         /* priority handlers, handled first */
196         
197         ListBase subwindows;    /* opengl stuff for sub windows, see notes in wm_subwindow.c */
198         ListBase gesture;               /* gesture stuff */
199
200         /* color management */
201
202         char display_device[64];        /* color managed display device name */
203         ColorManagedViewSettings view_settings;  /* global view settings */
204         int pad1;
205 } wmWindow;
206
207 /* should be something like DNA_EXCLUDE 
208  * but the preprocessor first removes all comments, spaces etc */
209
210 #
211 #
212 typedef struct wmOperatorTypeMacro {
213         struct wmOperatorTypeMacro *next, *prev;
214
215         /* operator id */
216         char idname[64];
217         /* rna pointer to access properties, like keymap */
218         struct IDProperty *properties;  /* operator properties, assigned to ptr->data and can be written to a file */
219         struct PointerRNA *ptr;
220
221 } wmOperatorTypeMacro;
222
223 /* partial copy of the event, for matching by eventhandler */
224 typedef struct wmKeyMapItem {
225         struct wmKeyMapItem *next, *prev;
226         
227         /* operator */
228         char idname[64];        /* used to retrieve operator type pointer */
229         IDProperty *properties;                 /* operator properties, assigned to ptr->data and can be written to a file */
230         
231         /* modal */
232         char propvalue_str[64];                 /* runtime temporary storage for loading */
233         short propvalue;                                /* if used, the item is from modal map */
234
235         /* event */
236         short type;                                             /* event code itself */
237         short val;                                              /* KM_ANY, KM_PRESS, KM_NOTHING etc */
238         short shift, ctrl, alt, oskey;  /* oskey is apple or windowskey, value denotes order of pressed */
239         short keymodifier;                              /* rawkey modifier */
240         
241         /* flag: inactive, expanded */
242         short flag;
243
244         /* runtime */
245         short maptype;                                  /* keymap editor */
246         short id;                                               /* unique identifier. Positive for kmi that override builtins, negative otherwise */
247         short pad;
248         struct PointerRNA *ptr;                 /* rna pointer to access properties */
249 } wmKeyMapItem;
250
251 /* used instead of wmKeyMapItem for diff keymaps */
252 typedef struct wmKeyMapDiffItem {
253         struct wmKeyMapDiffItem *next, *prev;
254
255         wmKeyMapItem *remove_item;
256         wmKeyMapItem *add_item;
257 } wmKeyMapDiffItem;
258
259 /* wmKeyMapItem.flag */
260 #define KMI_INACTIVE            1
261 #define KMI_EXPANDED            2
262 #define KMI_USER_MODIFIED       4
263 #define KMI_UPDATE                      8
264
265 /* stored in WM, the actively used keymaps */
266 typedef struct wmKeyMap {
267         struct wmKeyMap *next, *prev;
268         
269         ListBase items;
270         ListBase diff_items;
271         
272         char idname[64];        /* global editor keymaps, or for more per space/region */
273         short spaceid;          /* same IDs as in DNA_space_types.h */
274         short regionid;         /* see above */
275         
276         short flag;                     /* general flags */
277         short kmi_id;           /* last kmi id */
278         
279         /* runtime */
280         int (*poll)(struct bContext *); /* verify if enabled in the current context */
281         void *modal_items;                              /* for modal, EnumPropertyItem for now */
282 } wmKeyMap;
283
284 /* wmKeyMap.flag */
285 #define KEYMAP_MODAL                            1       /* modal map, not using operatornames */
286 #define KEYMAP_USER                                     2       /* user keymap */
287 #define KEYMAP_EXPANDED                         4
288 #define KEYMAP_CHILDREN_EXPANDED        8
289 #define KEYMAP_DIFF                                     16      /* diff keymap for user preferences */
290 #define KEYMAP_USER_MODIFIED            32      /* keymap has user modifications */
291 #define KEYMAP_UPDATE                           64
292
293 typedef struct wmKeyConfig {
294         struct wmKeyConfig *next, *prev;
295
296         char idname[64];                /* unique name */
297         char basename[64];              /* idname of configuration this is derives from, "" if none */
298         
299         ListBase keymaps;
300         int actkeymap, flag;
301 } wmKeyConfig;
302
303 /* wmKeyConfig.flag */
304 #define KEYCONF_USER                    (1 << 1)
305 #define KEYCONF_INIT_DEFAULT    (1 << 2)
306
307 /* this one is the operator itself, stored in files for macros etc */
308 /* operator + operatortype should be able to redo entirely, but for different contextes */
309 typedef struct wmOperator {
310         struct wmOperator *next, *prev;
311
312         /* saved */
313         char idname[64];/* used to retrieve type pointer */
314         IDProperty *properties;         /* saved, user-settable properties */
315
316         /* runtime */
317         struct wmOperatorType *type;/* operator type definition from idname */
318         void *customdata;                       /* custom storage, only while operator runs */
319         void *py_instance;                      /* python stores the class instance here */
320
321         struct PointerRNA *ptr;         /* rna pointer to access properties */
322         struct ReportList *reports;     /* errors and warnings storage */
323
324         ListBase macro;                         /* list of operators, can be a tree */
325         struct wmOperator *opm;         /* current running macro, not saved */
326         struct uiLayout *layout;        /* runtime for drawing */
327         short flag, pad[3];
328
329 } wmOperator;
330
331
332 /* operator type return flags: exec(), invoke() modal(), return values */
333 #define OPERATOR_RUNNING_MODAL  (1<<0)
334 #define OPERATOR_CANCELLED              (1<<1)
335 #define OPERATOR_FINISHED               (1<<2)
336 /* add this flag if the event should pass through */
337 #define OPERATOR_PASS_THROUGH   (1<<3)
338 /* in case operator got executed outside WM code... like via fileselect */
339 #define OPERATOR_HANDLED                (1<<4)
340
341 #define OPERATOR_FLAGS_ALL              ((1<<5)-1)
342
343 /* sanity checks for debug mode only */
344 #define OPERATOR_RETVAL_CHECK(ret) BLI_assert(ret != 0 && (ret & OPERATOR_FLAGS_ALL) == ret)
345
346 /* wmOperator flag */
347 #define OP_GRAB_POINTER                 1
348
349 #endif /* __DNA_WINDOWMANAGER_TYPES_H__ */