55783c3b9809e8ce399f332bbabee615b46a2f77
[blender.git] / source / blender / windowmanager / WM_api.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 #ifndef __WM_API_H__
27 #define __WM_API_H__
28
29 /** \file WM_api.h
30  *  \ingroup wm
31  *
32  *  \page wmpage windowmanager
33  *  \section wmabout About windowmanager
34  *  \ref wm handles events received from \ref GHOST and manages
35  *  the screens, areas and input for Blender
36  *  \section wmnote NOTE
37  *  \todo document
38  */
39
40
41 /* dna-savable wmStructs here */
42 #include "DNA_windowmanager_types.h"
43 #include "WM_keymap.h"
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 struct bContext;
50 struct IDProperty;
51 struct wmEvent;
52 struct wmEventHandler;
53 struct wmGesture;
54 struct wmJob;
55 struct wmNotifier;
56 struct wmOperatorType;
57 struct wmOperator;
58 struct rcti;
59 struct PointerRNA;
60 struct EnumPropertyItem;
61 struct MenuType;
62 struct wmDropBox;
63 struct wmDrag;
64 struct ImBuf;
65
66 typedef struct wmJob wmJob;
67
68 /* general API */
69 void            WM_init_state_size_set          (int stax, int stay, int sizx, int sizy);
70 void            WM_init_state_fullscreen_set(void);
71 void            WM_init_state_normal_set(void);
72
73 void            WM_init                         (struct bContext *C, int argc, const char **argv);
74 void            WM_exit_ext                     (struct bContext *C, const short do_python);
75 void            WM_exit                         (struct bContext *C);
76 void            WM_main                         (struct bContext *C);
77
78 int             WM_init_game            (struct bContext *C);
79 void            WM_init_splash          (struct bContext *C);
80
81
82 void            WM_check                        (struct bContext *C);
83
84 struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect);
85
86                         /* defines for 'type' WM_window_open_temp */
87 #define WM_WINDOW_RENDER                0
88 #define WM_WINDOW_USERPREFS             1
89 #define WM_WINDOW_FILESEL               2
90
91 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
92
93
94
95                         /* files */
96 int                     WM_homefile_read_exec(struct bContext *C, struct wmOperator *op);
97 int                     WM_homefile_read(struct bContext *C, struct ReportList *reports, short from_memory);
98 int                     WM_homefile_write_exec(struct bContext *C, struct wmOperator *op);
99 void            WM_file_read(struct bContext *C, const char *filepath, struct ReportList *reports);
100 int                     WM_file_write(struct bContext *C, const char *target, int fileflags, struct ReportList *reports, int copy);
101 void            WM_autosave_init(struct wmWindowManager *wm);
102
103                         /* mouse cursors */
104 void            WM_cursor_set           (struct wmWindow *win, int curs);
105 void            WM_cursor_modal         (struct wmWindow *win, int curs);
106 void            WM_cursor_restore       (struct wmWindow *win);
107 void            WM_cursor_wait          (int val);
108 void            WM_cursor_grab_enable(struct wmWindow *win, int wrap, int hide, int *bounds);
109 void            WM_cursor_grab_disable(struct wmWindow *win);
110 void            WM_cursor_time          (struct wmWindow *win, int nr);
111
112 void            *WM_paint_cursor_activate(struct wmWindowManager *wm,
113                                       int (*poll)(struct bContext *C),
114                                       void (*draw)(struct bContext *C, int, int, void *customdata),
115                                       void *customdata);
116
117 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
118
119 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
120
121                         /* event map */
122 int                     WM_userdef_event_map(int kmitype);
123
124                         /* handlers */
125
126 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
127                                                 /* boundbox, optional subwindow boundbox for offset */
128 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
129                                                 /* priority not implemented, it adds in begin */
130 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
131
132 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
133
134 struct wmEventHandler *WM_event_add_ui_handler(const struct bContext *C, ListBase *handlers,
135                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
136                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
137 void            WM_event_remove_ui_handler(ListBase *handlers,
138                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
139                         void (*remove)(struct bContext *C, void *userdata), void *userdata, int postpone);
140 void            WM_event_remove_area_handler(struct ListBase *handlers, void *area);
141
142 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
143 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
144
145 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
146
147                         /* mouse */
148 void            WM_event_add_mousemove(struct bContext *C);
149 int                     WM_modal_tweak_exit(struct wmEvent *evt, int tweak_event);
150
151                         /* notifiers */
152 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
153 void            WM_main_add_notifier(unsigned int type, void *reference);
154
155 void            wm_event_add            (struct wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
156
157                         /* at maximum, every timestep seconds it triggers event_type events */
158 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
159 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
160 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
161
162                 /* operator api, default callbacks */
163                         /* invoke callback, uses enum property named "type" */
164 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
165 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
166                         /* invoke callback, confirm menu + exec */
167 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
168                 /* invoke callback, file selector "filepath" unset + exec */
169 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
170 int         WM_operator_filesel_ensure_ext_imtype(wmOperator *op, const char imtype);
171                         /* poll callback, context checks */
172 int                     WM_operator_winactive   (struct bContext *C);
173                         /* invoke callback, exec + redo popup */
174 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
175 int             WM_operator_props_dialog_popup (struct bContext *C, struct wmOperator *op, int width, int height);
176 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
177 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
178
179 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, const char *message);
180
181                 /* operator api */
182 void            WM_operator_free                (struct wmOperator *op);
183 void            WM_operator_stack_clear(struct wmWindowManager *wm);
184
185 struct wmOperatorType *WM_operatortype_find(const char *idnamem, int quiet);
186 struct GHashIterator *WM_operatortype_iter(void);
187 void            WM_operatortype_append  (void (*opfunc)(struct wmOperatorType*));
188 void            WM_operatortype_append_ptr      (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
189 void            WM_operatortype_append_macro_ptr        (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
190 int                     WM_operatortype_remove(const char *idname);
191
192 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, const char *description, int flag);
193 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
194
195
196 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
197 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, short context);
198 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
199 int                     WM_operator_call_notest(struct bContext *C, struct wmOperator *op);
200 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
201 int                     WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
202 int                     WM_operator_name_call   (struct bContext *C, const char *opstring, short context, struct PointerRNA *properties);
203 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties, struct ReportList *reports, short is_undo);
204
205 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
206 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const short no_context); /* make props context sensitive or not */
207 void        WM_operator_properties_reset(struct wmOperator *op);
208 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
209 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
210 void            WM_operator_properties_free(struct PointerRNA *ptr);
211 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type, short action, short flag, short display);
212 void        WM_operator_properties_border(struct wmOperatorType *ot);
213 void        WM_operator_properties_border_to_rcti(struct wmOperator *op, struct rcti *rect);
214 void            WM_operator_properties_gesture_border(struct wmOperatorType *ot, int extend);
215 void        WM_operator_properties_mouse_select(struct wmOperatorType *ot);
216 void            WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
217 void            WM_operator_properties_select_all(struct wmOperatorType *ot);
218
219 int         WM_operator_check_ui_enabled(const struct bContext *C, const char *idname);
220 wmOperator *WM_operator_last_redo(const struct bContext *C);
221
222 int         WM_operator_last_properties_init(struct wmOperator *op);
223 int         WM_operator_last_properties_store(struct wmOperator *op);
224
225 /* MOVE THIS SOMEWHERE ELSE */
226 #define SEL_TOGGLE              0
227 #define SEL_SELECT              1
228 #define SEL_DESELECT    2
229 #define SEL_INVERT              3
230
231
232 /* flags for WM_operator_properties_filesel */
233 #define WM_FILESEL_RELPATH              (1 << 0)
234
235 #define WM_FILESEL_DIRECTORY    (1 << 1)
236 #define WM_FILESEL_FILENAME             (1 << 2)
237 #define WM_FILESEL_FILEPATH             (1 << 3)
238 #define WM_FILESEL_FILES                (1 << 4)
239
240
241                 /* operator as a python command (resultuing string must be freed) */
242 char            *WM_operator_pystring(struct bContext *C, struct wmOperatorType *ot, struct PointerRNA *opptr, int all_args);
243 void            WM_operator_bl_idname(char *to, const char *from);
244 void            WM_operator_py_idname(char *to, const char *from);
245
246 /* *************** menu types ******************** */
247 void                WM_menutype_init(void);
248 struct MenuType    *WM_menutype_find(const char *idname, int quiet);
249 int                 WM_menutype_add(struct MenuType* mt);
250 void                WM_menutype_freelink(struct MenuType* mt);
251 void                WM_menutype_free(void);
252
253                         /* default operator callbacks for border/circle/lasso */
254 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
255 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
256 int                     WM_border_select_cancel(struct bContext *C, struct wmOperator *op);
257 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
258 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
259 int                     WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
260 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
261 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
262 int                     WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
263 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
264 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
265 int                     WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
266 int       (*WM_gesture_lasso_path_to_array(struct bContext *C, struct wmOperator *op, int *mcords_tot))[2];
267 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
268 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
269 int                     WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
270
271                         /* Gesture manager API */
272 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
273 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
274 void            WM_gestures_remove(struct bContext *C);
275
276                         /* fileselecting support */
277 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
278 void            WM_event_fileselect_event(struct bContext *C, void *ophandle, int eventval);
279 #ifndef NDEBUG
280 void            WM_event_print(struct wmEvent *event);
281 #endif
282
283                         /* drag and drop */
284 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value);
285 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
286
287 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, struct wmEvent *event),
288                                                   void (*copy)(struct wmDrag *, struct wmDropBox *));
289 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
290
291                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
292 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
293 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, struct rcti *srct);
294
295                         /* OpenGL utilities with safety check + working in modelview matrix mode */
296 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
297 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
298 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
299
300                         /* utilities */
301 void            WM_framebuffer_index_set(int index);
302 int                     WM_framebuffer_to_index(unsigned int col);
303
304                         /* threaded Jobs Manager */
305 #define WM_JOB_PRIORITY         1
306 #define WM_JOB_EXCL_RENDER      2
307 #define WM_JOB_PROGRESS         4
308 #define WM_JOB_SUSPEND          8
309
310 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag);
311
312 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner);
313 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
314 char            *WM_jobs_name(struct wmWindowManager *wm, void *owner);
315
316 int         WM_jobs_is_running(struct wmJob *);
317 void *      WM_jobs_customdata_get(struct wmJob *);
318 void        WM_jobs_customdata_set(struct wmJob *, void *customdata, void (*free)(void *));
319 void        WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
320 void        WM_jobs_callbacks(struct wmJob *,
321                               void (*startjob)(void *, short *, short *, float *),
322                               void (*initjob)(void *),
323                               void (*update)(void *),
324                               void (*endjob)(void *));
325
326 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
327 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
328 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
329 void            WM_jobs_stop_all(struct wmWindowManager *wm);
330
331 int                     WM_jobs_has_running(struct wmWindowManager *wm);
332
333                         /* clipboard */
334 char            *WM_clipboard_text_get(int selection);
335 void            WM_clipboard_text_set(char *buf, int selection);
336
337                         /* progress */
338 void            WM_progress_set(struct wmWindow *win, float progress);
339 void            WM_progress_clear(struct wmWindow *win);
340
341                         /* Draw (for screenshot) */
342 void            WM_redraw_windows(struct bContext *C);
343
344 /* debugging only, convenience function to write on crash */
345 int write_crash_blend(void);
346
347 #ifdef __cplusplus
348 }
349 #endif
350
351 #endif /* __WM_API_H__ */
352