Merging r58701 through r58746 from trunk into soc-2013-depsgraph_mt
[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 /* dna-savable wmStructs here */
41 #include "DNA_windowmanager_types.h"
42 #include "WM_keymap.h"
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48 struct bContext;
49 struct IDProperty;
50 struct wmEvent;
51 struct wmEventHandler;
52 struct wmGesture;
53 struct wmJob;
54 struct wmNotifier;
55 struct wmOperatorType;
56 struct wmOperator;
57 struct rcti;
58 struct PointerRNA;
59 struct PropertyRNA;
60 struct EnumPropertyItem;
61 struct MenuType;
62 struct wmDropBox;
63 struct wmDrag;
64 struct ImBuf;
65 struct ImageFormatData;
66 struct ARegion;
67
68 typedef struct wmJob wmJob;
69
70 /* general API */
71 void            WM_init_state_size_set          (int stax, int stay, int sizx, int sizy);
72 void            WM_init_state_fullscreen_set(void);
73 void            WM_init_state_normal_set(void);
74 void            WM_init_native_pixels(bool do_it);
75
76 void            WM_init                         (struct bContext *C, int argc, const char **argv);
77 void            WM_exit_ext                     (struct bContext *C, const short do_python);
78
79 void            WM_exit                         (struct bContext *C)
80 #if defined(__GNUC__) || defined(__clang__)
81 __attribute__((noreturn))
82 #endif
83 ;
84
85 void            WM_main                         (struct bContext *C)
86 #if defined(__GNUC__) || defined(__clang__)
87 __attribute__((noreturn))
88 #endif
89 ;
90
91 bool            WM_init_game            (struct bContext *C);
92 void            WM_init_splash          (struct bContext *C);
93
94
95 void            WM_check                        (struct bContext *C);
96
97 struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect);
98
99 int                     WM_window_pixels_x              (struct wmWindow *win);
100 int                     WM_window_pixels_y              (struct wmWindow *win);
101
102 /* defines for 'type' WM_window_open_temp */
103 #define WM_WINDOW_RENDER                0
104 #define WM_WINDOW_USERPREFS             1
105 // #define WM_WINDOW_FILESEL            2  // UNUSED
106
107 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
108                         
109                         /* returns true if draw method is triple buffer */
110 bool            WM_is_draw_triple(struct wmWindow *win);
111
112
113
114                         /* files */
115 void            WM_file_autoexec_init(const char *filepath);
116 void            WM_file_read(struct bContext *C, const char *filepath, struct ReportList *reports);
117 void            WM_autosave_init(struct wmWindowManager *wm);
118 void            WM_recover_last_session(struct bContext *C, struct ReportList *reports);
119
120                         /* mouse cursors */
121 void            WM_cursor_set           (struct wmWindow *win, int curs);
122 void            WM_cursor_modal         (struct wmWindow *win, int curs);
123 void            WM_cursor_restore       (struct wmWindow *win);
124 void            WM_cursor_wait          (bool val);
125 void            WM_cursor_grab_enable(struct wmWindow *win, bool wrap, bool hide, int bounds[4]);
126 void            WM_cursor_grab_disable(struct wmWindow *win, int mouse_ungrab_xy[2]);
127 void            WM_cursor_time          (struct wmWindow *win, int nr);
128
129 void            *WM_paint_cursor_activate(struct wmWindowManager *wm,
130                                       int (*poll)(struct bContext *C),
131                                       void (*draw)(struct bContext *C, int, int, void *customdata),
132                                       void *customdata);
133
134 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
135 void            WM_paint_cursor_tag_redraw(struct wmWindow *win, struct ARegion *ar);
136
137 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
138 float           WM_cursor_pressure      (const struct wmWindow *win);
139
140                         /* event map */
141 int                     WM_userdef_event_map(int kmitype);
142
143                         /* handlers */
144
145 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
146                                                 /* boundbox, optional subwindow boundbox for offset */
147 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
148                                                 /* priority not implemented, it adds in begin */
149 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
150
151 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
152
153 struct wmEventHandler *WM_event_add_ui_handler(
154                 const struct bContext *C, ListBase *handlers,
155                 int (*func)(struct bContext *C, const struct wmEvent *event, void *userdata),
156                 void (*remove)(struct bContext *C, void *userdata), void *userdata);
157
158 void            WM_event_remove_ui_handler(ListBase *handlers,
159                                        int (*func)(struct bContext *C, const struct wmEvent *event, void *userdata),
160                                        void (*remove)(struct bContext *C, void *userdata),
161                                        void *userdata, const bool postpone);
162 void            WM_event_remove_area_handler(struct ListBase *handlers, void *area);
163 void            WM_event_free_ui_handler_all(struct bContext *C, ListBase *handlers,
164                                          int (*func)(struct bContext *C, const struct wmEvent *event, void *userdata),
165                                          void (*remove)(struct bContext *C, void *userdata));
166
167 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
168 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
169
170 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
171
172                         /* mouse */
173 void            WM_event_add_mousemove(struct bContext *C);
174 int                     WM_modal_tweak_exit(const struct wmEvent *event, int tweak_event);
175
176                         /* notifiers */
177 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
178 void            WM_main_add_notifier(unsigned int type, void *reference);
179 void            WM_main_remove_notifier_reference(const void *reference);
180
181                         /* reports */
182 void        WM_report(const struct bContext *C, ReportType type, const char *message);
183 void        WM_reportf(const struct bContext *C, ReportType type, const char *format, ...)
184 #ifdef __GNUC__
185 __attribute__ ((format(printf, 3, 4)))
186 #endif
187 ;
188
189 void            wm_event_add(struct wmWindow *win, const struct wmEvent *event_to_add);
190 void            wm_event_init_from_window(struct wmWindow *win, struct wmEvent *event);
191
192
193                         /* at maximum, every timestep seconds it triggers event_type events */
194 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
195 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
196 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
197
198                 /* operator api, default callbacks */
199                         /* invoke callback, uses enum property named "type" */
200 int                     WM_operator_view3d_distance_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
201 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
202 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
203                         /* invoke callback, confirm menu + exec */
204 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
205                 /* invoke callback, file selector "filepath" unset + exec */
206 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
207 bool        WM_operator_filesel_ensure_ext_imtype(wmOperator *op, const struct ImageFormatData *im_format);
208                         /* poll callback, context checks */
209 int                     WM_operator_winactive   (struct bContext *C);
210                         /* invoke callback, exec + redo popup */
211 int                     WM_operator_props_popup_call(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
212 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
213 int             WM_operator_props_dialog_popup(struct bContext *C, struct wmOperator *op, int width, int height);
214 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
215 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
216
217 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, const char *message);
218
219                 /* operator api */
220 void            WM_operator_free                (struct wmOperator *op);
221 void            WM_operator_type_set(struct wmOperator *op, struct wmOperatorType *ot);
222 void            WM_operator_stack_clear(struct wmWindowManager *wm);
223 void            WM_operator_handlers_clear(wmWindowManager *wm, struct wmOperatorType *ot);
224
225 struct wmOperatorType *WM_operatortype_find(const char *idname, bool quiet);
226 struct GHashIterator  *WM_operatortype_iter(void);
227 void            WM_operatortype_append(void (*opfunc)(struct wmOperatorType *));
228 void            WM_operatortype_append_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
229 void            WM_operatortype_append_macro_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
230 int                     WM_operatortype_remove(const char *idname);
231
232 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, const char *description, int flag);
233 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
234
235
236 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
237 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, short context);
238 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
239 int                     WM_operator_call_notest(struct bContext *C, struct wmOperator *op);
240 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
241 int                     WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
242 int                     WM_operator_name_call   (struct bContext *C, const char *opstring, short context, struct PointerRNA *properties);
243 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties, struct ReportList *reports, short is_undo);
244
245 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
246 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const bool no_context); /* make props context sensitive or not */
247 int         WM_operator_properties_default(struct PointerRNA *ptr, const bool do_update);
248 void        WM_operator_properties_reset(struct wmOperator *op);
249 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
250 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
251 void            WM_operator_properties_free(struct PointerRNA *ptr);
252 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type, short action, short flag, short display);
253 void        WM_operator_properties_border(struct wmOperatorType *ot);
254 void        WM_operator_properties_border_to_rcti(struct wmOperator *op, struct rcti *rect);
255 void            WM_operator_properties_gesture_border(struct wmOperatorType *ot, bool extend);
256 void        WM_operator_properties_mouse_select(struct wmOperatorType *ot);
257 void            WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
258 void            WM_operator_properties_select_all(struct wmOperatorType *ot);
259 void            WM_operator_properties_select_action(struct wmOperatorType *ot, int default_action);
260
261 bool        WM_operator_check_ui_enabled(const struct bContext *C, const char *idname);
262 wmOperator *WM_operator_last_redo(const struct bContext *C);
263
264 bool        WM_operator_last_properties_init(struct wmOperator *op);
265 bool        WM_operator_last_properties_store(struct wmOperator *op);
266
267 /* MOVE THIS SOMEWHERE ELSE */
268 #define SEL_TOGGLE              0
269 #define SEL_SELECT              1
270 #define SEL_DESELECT    2
271 #define SEL_INVERT              3
272
273
274 /* flags for WM_operator_properties_filesel */
275 #define WM_FILESEL_RELPATH              (1 << 0)
276
277 #define WM_FILESEL_DIRECTORY    (1 << 1)
278 #define WM_FILESEL_FILENAME             (1 << 2)
279 #define WM_FILESEL_FILEPATH             (1 << 3)
280 #define WM_FILESEL_FILES                (1 << 4)
281
282
283                 /* operator as a python command (resultuing string must be freed) */
284 char            *WM_operator_pystring(struct bContext *C, struct wmOperatorType *ot, struct PointerRNA *opptr, int all_args);
285 char            *WM_prop_pystring_assign(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
286 void            WM_operator_bl_idname(char *to, const char *from);
287 void            WM_operator_py_idname(char *to, const char *from);
288
289 /* *************** uilist types ******************** */
290 void                WM_uilisttype_init(void);
291 struct uiListType  *WM_uilisttype_find(const char *idname, bool quiet);
292 int                 WM_uilisttype_add(struct uiListType *ult);
293 void                WM_uilisttype_freelink(struct uiListType *ult);
294 void                WM_uilisttype_free(void);
295
296 /* *************** menu types ******************** */
297 void                WM_menutype_init(void);
298 struct MenuType    *WM_menutype_find(const char *idname, bool quiet);
299 int                 WM_menutype_add(struct MenuType *mt);
300 void                WM_menutype_freelink(struct MenuType *mt);
301 void                WM_menutype_free(void);
302
303                         /* default operator callbacks for border/circle/lasso */
304 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
305 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
306 int                     WM_border_select_cancel(struct bContext *C, struct wmOperator *op);
307 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
308 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
309 int                     WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
310 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
311 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
312 int                     WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
313 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
314 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
315 int                     WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
316 const int (*WM_gesture_lasso_path_to_array(struct bContext *C, struct wmOperator *op, int *mcords_tot))[2];
317 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
318 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
319 int                     WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
320
321                         /* Gesture manager API */
322 struct wmGesture *WM_gesture_new(struct bContext *C, const struct wmEvent *event, int type);
323 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
324 void            WM_gestures_remove(struct bContext *C);
325
326                         /* fileselecting support */
327 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
328 void            WM_event_fileselect_event(struct wmWindowManager *wm, void *ophandle, int eventval);
329 #ifndef NDEBUG
330 void            WM_event_print(const struct wmEvent *event);
331 #endif
332
333 void            WM_operator_region_active_win_set(struct bContext *C);
334
335                         /* drag and drop */
336 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value);
337 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
338
339 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, const struct wmEvent *event),
340                                     void (*copy)(struct wmDrag *, struct wmDropBox *));
341 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
342
343                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
344 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
345 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, struct rcti *srct);
346
347                         /* OpenGL utilities with safety check + working in modelview matrix mode */
348 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
349 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
350 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
351
352                         /* utilities */
353 void            WM_framebuffer_index_set(int index);
354 int                     WM_framebuffer_to_index(unsigned int col);
355
356                         /* threaded Jobs Manager */
357 enum {
358         WM_JOB_PRIORITY     = (1 << 0),
359         WM_JOB_EXCL_RENDER  = (1 << 1),
360         WM_JOB_PROGRESS     = (1 << 2),
361         WM_JOB_SUSPEND      = (1 << 3)
362 };
363
364 /* identifying jobs by owner alone is unreliable, this isnt saved, order can change (keep 0 for 'any') */
365 enum {
366         WM_JOB_TYPE_ANY = 0,
367         WM_JOB_TYPE_COMPOSITE,
368         WM_JOB_TYPE_RENDER,
369         WM_JOB_TYPE_RENDER_PREVIEW,  /* UI preview */
370         WM_JOB_TYPE_SCREENCAST,
371         WM_JOB_TYPE_OBJECT_SIM_OCEAN,
372         WM_JOB_TYPE_OBJECT_SIM_FLUID,
373         WM_JOB_TYPE_OBJECT_BAKE_TEXTURE,
374         WM_JOB_TYPE_FILESEL_THUMBNAIL,
375         WM_JOB_TYPE_CLIP_BUILD_PROXY,
376         WM_JOB_TYPE_CLIP_TRACK_MARKERS,
377         WM_JOB_TYPE_CLIP_SOLVE_CAMERA,
378         WM_JOB_TYPE_CLIP_PREFETCH,
379         WM_JOB_TYPE_SEQ_BUILD_PROXY,
380         /* add as needed, screencast, seq proxy build
381          * if having hard coded values is a problem */
382 };
383
384 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag, int job_type);
385
386 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner, int job_type);
387 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
388 char       *WM_jobs_name(struct wmWindowManager *wm, void *owner);
389
390 int         WM_jobs_is_running(struct wmJob *);
391 void       *WM_jobs_customdata_get(struct wmJob *);
392 void        WM_jobs_customdata_set(struct wmJob *, void *customdata, void (*free)(void *));
393 void        WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
394 void        WM_jobs_callbacks(struct wmJob *,
395                               void (*startjob)(void *, short *, short *, float *),
396                               void (*initjob)(void *),
397                               void (*update)(void *),
398                               void (*endjob)(void *));
399
400 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
401 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
402 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
403 void            WM_jobs_kill_all(struct wmWindowManager *wm);
404 void            WM_jobs_kill_all_except(struct wmWindowManager *wm, void *owner);
405 void            WM_jobs_kill_type(struct wmWindowManager *wm, int job_type);
406
407 int                     WM_jobs_has_running(struct wmWindowManager *wm);
408
409 void            WM_job_main_thread_lock_acquire(struct wmJob *job);
410 void            WM_job_main_thread_lock_release(struct wmJob *job);
411
412                         /* clipboard */
413 char       *WM_clipboard_text_get(int selection);
414 void        WM_clipboard_text_set(char *buf, int selection);
415
416                         /* progress */
417 void            WM_progress_set(struct wmWindow *win, float progress);
418 void            WM_progress_clear(struct wmWindow *win);
419
420                         /* Draw (for screenshot) */
421 void            WM_redraw_windows(struct bContext *C);
422
423 void        WM_main_playanim(int argc, const char **argv);
424
425 /* debugging only, convenience function to write on crash */
426 int write_crash_blend(void);
427
428                         /* Lock the interface for any communication */
429 void        WM_set_locked_interface(struct wmWindowManager *wm, bool lock);
430
431 #ifdef __cplusplus
432 }
433 #endif
434
435 #endif /* __WM_API_H__ */
436