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