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