Merge branch 'master' into blender2.8
[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 blender/windowmanager/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 #include "BLI_compiler_attrs.h"
44
45 /* Include external manipulator API's */
46 #include "manipulators/WM_manipulator_api.h"
47
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51
52 struct bContext;
53 struct GHashIterator;
54 struct IDProperty;
55 struct wmEvent;
56 struct wmEventHandler;
57 struct wmGesture;
58 struct wmJob;
59 struct wmOperatorType;
60 struct wmOperator;
61 struct rcti;
62 struct PointerRNA;
63 struct PropertyRNA;
64 struct MenuType;
65 struct wmDropBox;
66 struct wmDrag;
67 struct ImBuf;
68 struct ImageFormatData;
69 struct ARegion;
70 struct ScrArea;
71
72 #ifdef WITH_INPUT_NDOF
73 struct wmNDOFMotionData;
74 #endif
75
76 typedef struct wmJob wmJob;
77 typedef struct wmManipulator wmManipulator;
78 typedef struct wmManipulatorMap wmManipulatorMap;
79 typedef struct wmManipulatorMapType wmManipulatorMapType;
80
81 /* general API */
82 void            WM_init_state_size_set          (int stax, int stay, int sizx, int sizy);
83 void            WM_init_state_fullscreen_set(void);
84 void            WM_init_state_normal_set(void);
85 void            WM_init_native_pixels(bool do_it);
86
87 void            WM_init                         (struct bContext *C, int argc, const char **argv);
88 void            WM_exit_ext                     (struct bContext *C, const bool do_python);
89
90 void            WM_exit                         (struct bContext *C) ATTR_NORETURN;
91
92 void            WM_main                         (struct bContext *C) ATTR_NORETURN;
93
94 bool            WM_init_game            (struct bContext *C);
95 void            WM_init_splash          (struct bContext *C);
96
97
98 void            WM_check                        (struct bContext *C);
99
100 int                     WM_window_pixels_x              (struct wmWindow *win);
101 int                     WM_window_pixels_y              (struct wmWindow *win);
102 bool            WM_window_is_fullscreen (struct wmWindow *win);
103
104 void WM_windows_scene_data_sync(const ListBase *win_lb, struct Scene *scene) ATTR_NONNULL();
105 struct Scene *WM_windows_scene_get_from_screen(const struct wmWindowManager *wm, const struct bScreen *screen) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
106
107 struct Scene *WM_window_get_active_scene(const struct wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
108 void          WM_window_change_active_scene(struct Main *bmain, struct bContext *C, struct wmWindow *win,
109                                             struct Scene *scene_new) ATTR_NONNULL();
110 struct WorkSpace *WM_window_get_active_workspace(const struct wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
111 void              WM_window_set_active_workspace(struct wmWindow *win, struct WorkSpace *workspace) ATTR_NONNULL(1);
112 struct WorkSpaceLayout *WM_window_get_active_layout(const struct wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
113 void                    WM_window_set_active_layout(
114         struct wmWindow *win, struct WorkSpace *workspace, struct WorkSpaceLayout *layout) ATTR_NONNULL(1);
115 struct bScreen *WM_window_get_active_screen(const struct wmWindow *win) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
116 void            WM_window_set_active_screen(struct wmWindow *win, struct WorkSpace *workspace, struct bScreen *screen) ATTR_NONNULL(1);
117 bool WM_window_is_temp_screen(const struct wmWindow *win) ATTR_WARN_UNUSED_RESULT;
118
119 /* defines for 'type' WM_window_open_temp */
120 enum {
121         WM_WINDOW_RENDER = 1,
122         WM_WINDOW_USERPREFS,
123         // WM_WINDOW_FILESEL // UNUSED
124 };
125
126 struct wmWindow *WM_window_open(struct bContext *C, const struct rcti *rect);
127 struct wmWindow *WM_window_open_temp(struct bContext *C, int x, int y, int sizex, int sizey, int type);
128 void             WM_window_set_dpi(wmWindow *win);
129                         
130                         /* returns true if draw method is triple buffer */
131 bool            WM_is_draw_triple(struct wmWindow *win);
132
133 bool            WM_stereo3d_enabled(struct wmWindow *win, bool only_fullscreen_test);
134
135
136                         /* files */
137 void            WM_file_autoexec_init(const char *filepath);
138 bool            WM_file_read(struct bContext *C, const char *filepath, struct ReportList *reports);
139 void            WM_autosave_init(struct wmWindowManager *wm);
140 void            WM_recover_last_session(struct bContext *C, struct ReportList *reports);
141 void            WM_file_tag_modified(const struct bContext *C);
142
143 void        WM_lib_reload(struct Library *lib, struct bContext *C, struct ReportList *reports);
144
145                         /* mouse cursors */
146 void            WM_cursor_set(struct wmWindow *win, int curs);
147 void            WM_cursor_modal_set(struct wmWindow *win, int curs);
148 void            WM_cursor_modal_restore(struct wmWindow *win);
149 void            WM_cursor_wait          (bool val);
150 void            WM_cursor_grab_enable(struct wmWindow *win, bool wrap, bool hide, int bounds[4]);
151 void            WM_cursor_grab_disable(struct wmWindow *win, const int mouse_ungrab_xy[2]);
152 void            WM_cursor_time          (struct wmWindow *win, int nr);
153
154 void            *WM_paint_cursor_activate(struct wmWindowManager *wm,
155                                       int (*poll)(struct bContext *C),
156                                       void (*draw)(struct bContext *C, int, int, void *customdata),
157                                       void *customdata);
158
159 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
160 void            WM_paint_cursor_tag_redraw(struct wmWindow *win, struct ARegion *ar);
161
162 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
163 void            WM_cursor_compatible_xy(wmWindow *win, int *x, int *y);
164 float           WM_cursor_pressure      (const struct wmWindow *win);
165
166                         /* event map */
167 int                     WM_userdef_event_map(int kmitype);
168
169                         /* handlers */
170
171 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
172                                                 /* boundbox, optional subwindow boundbox for offset */
173 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, const rcti *bb, const rcti *swinbb);
174                                                 /* priority not implemented, it adds in begin */
175 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
176
177 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
178
179 typedef int (*wmUIHandlerFunc)(struct bContext *C, const struct wmEvent *event, void *userdata);
180 typedef void (*wmUIHandlerRemoveFunc)(struct bContext *C, void *userdata);
181
182 struct wmEventHandler *WM_event_add_ui_handler(
183         const struct bContext *C, ListBase *handlers,
184         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove,
185         void *userdata, const char flag);
186 void WM_event_remove_ui_handler(
187         ListBase *handlers,
188         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove,
189         void *userdata, const bool postpone);
190 void WM_event_remove_area_handler(
191         struct ListBase *handlers, void *area);
192 void WM_event_free_ui_handler_all(
193         struct bContext *C, ListBase *handlers,
194         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove);
195
196 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
197 void WM_event_modal_handler_area_replace(wmWindow *win, const struct ScrArea *old_area, struct ScrArea *new_area);
198 void WM_event_modal_handler_region_replace(wmWindow *win, const struct ARegion *old_region, struct ARegion *new_region);
199
200 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
201
202 /* handler flag */
203 enum {
204         WM_HANDLER_BLOCKING             = (1 << 0),  /* after this handler all others are ignored */
205         WM_HANDLER_ACCEPT_DBL_CLICK     = (1 << 1),  /* handler accepts double key press events */
206
207         /* internal */
208         WM_HANDLER_DO_FREE              = (1 << 7),  /* handler tagged to be freed in wm_handlers_do() */
209 };
210
211 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
212
213                         /* mouse */
214 void            WM_event_add_mousemove(struct bContext *C);
215 bool            WM_event_is_modal_tweak_exit(const struct wmEvent *event, int tweak_event);
216 bool            WM_event_is_absolute(const struct wmEvent *event);
217 bool            WM_event_is_last_mousemove(const struct wmEvent *event);
218
219 #ifdef WITH_INPUT_NDOF
220                         /* 3D mouse */
221 void            WM_ndof_deadzone_set(float deadzone);
222 #endif
223                         /* notifiers */
224 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
225 void            WM_main_add_notifier(unsigned int type, void *reference);
226 void            WM_main_remove_notifier_reference(const void *reference);
227 void            WM_main_remap_editor_id_reference(struct ID *old_id, struct ID *new_id);
228
229                         /* reports */
230 void        WM_report_banner_show(void);
231 void        WM_report(ReportType type, const char *message);
232 void        WM_reportf(ReportType type, const char *format, ...) ATTR_PRINTF_FORMAT(2, 3);
233
234 void wm_event_add_ex(
235         struct wmWindow *win, const struct wmEvent *event_to_add,
236         const struct wmEvent *event_to_add_after)
237         ATTR_NONNULL(1, 2);
238 void wm_event_add(
239         struct wmWindow *win, const struct wmEvent *event_to_add)
240         ATTR_NONNULL(1, 2);
241
242 void wm_event_init_from_window(struct wmWindow *win, struct wmEvent *event);
243
244
245                         /* at maximum, every timestep seconds it triggers event_type events */
246 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
247 struct wmTimer *WM_event_add_timer_notifier(struct wmWindowManager *wm, struct wmWindow *win, unsigned int type, double timestep);
248 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
249 void            WM_event_remove_timer_notifier(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
250 void        WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, bool do_sleep);
251
252                 /* operator api, default callbacks */
253                         /* invoke callback, uses enum property named "type" */
254 void            WM_operator_view3d_unit_defaults(struct bContext *C, struct wmOperator *op);
255 int                     WM_operator_smooth_viewtx_get(const struct wmOperator *op);
256 int                     WM_menu_invoke_ex(struct bContext *C, struct wmOperator *op, int opcontext);
257 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
258 int         WM_enum_search_invoke_previews(struct bContext *C, struct wmOperator *op, short prv_cols, short prv_rows);
259 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
260                         /* invoke callback, confirm menu + exec */
261 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
262                 /* invoke callback, file selector "filepath" unset + exec */
263 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
264 bool        WM_operator_filesel_ensure_ext_imtype(wmOperator *op, const struct ImageFormatData *im_format);
265                         /* poll callback, context checks */
266 int                     WM_operator_winactive   (struct bContext *C);
267                         /* invoke callback, exec + redo popup */
268 int                     WM_operator_props_popup_confirm(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
269 int                     WM_operator_props_popup_call(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
270 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
271 int             WM_operator_props_dialog_popup(struct bContext *C, struct wmOperator *op, int width, int height);
272 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
273 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
274
275 int         WM_operator_confirm_message_ex(struct bContext *C, struct wmOperator *op,
276                                            const char *title, const int icon,
277                                            const char *message);
278 int         WM_operator_confirm_message(struct bContext *C, struct wmOperator *op,
279                                         const char *message);
280
281                 /* operator api */
282 void            WM_operator_free                (struct wmOperator *op);
283 void            WM_operator_free_all_after(wmWindowManager *wm, struct wmOperator *op);
284 void            WM_operator_type_set(struct wmOperator *op, struct wmOperatorType *ot);
285 void            WM_operator_stack_clear(struct wmWindowManager *wm);
286 void            WM_operator_handlers_clear(wmWindowManager *wm, struct wmOperatorType *ot);
287
288 struct wmOperatorType *WM_operatortype_find(const char *idname, bool quiet);
289 void        WM_operatortype_iter(struct GHashIterator *ghi);
290 void            WM_operatortype_append(void (*opfunc)(struct wmOperatorType *));
291 void            WM_operatortype_append_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
292 void            WM_operatortype_append_macro_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
293 void        WM_operatortype_remove_ptr(struct wmOperatorType *ot);
294 bool        WM_operatortype_remove(const char *idname);
295 void        WM_operatortype_last_properties_clear_all(void);
296
297 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, const char *description, int flag);
298 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
299
300
301 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
302 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, short context);
303 int         WM_operator_call_ex(struct bContext *C, struct wmOperator *op, const bool store);
304 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
305 int                     WM_operator_call_notest(struct bContext *C, struct wmOperator *op);
306 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
307 bool        WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
308 bool        WM_operator_is_repeat(const struct bContext *C, const struct wmOperator *op);
309 int         WM_operator_name_call_ptr(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties);
310 int                     WM_operator_name_call(struct bContext *C, const char *opstring, short context, struct PointerRNA *properties);
311 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties, struct ReportList *reports, const bool is_undo);
312
313 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
314 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const bool no_context); /* make props context sensitive or not */
315 bool        WM_operator_properties_default(struct PointerRNA *ptr, const bool do_update);
316 void        WM_operator_properties_reset(struct wmOperator *op);
317 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
318 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
319 void        WM_operator_properties_clear(struct PointerRNA *ptr);
320 void            WM_operator_properties_free(struct PointerRNA *ptr);
321
322 bool        WM_operator_check_ui_enabled(const struct bContext *C, const char *idname);
323 wmOperator *WM_operator_last_redo(const struct bContext *C);
324 ID         *WM_operator_drop_load_path(struct bContext *C, struct wmOperator *op, const short idcode);
325
326 bool        WM_operator_last_properties_init(struct wmOperator *op);
327 bool        WM_operator_last_properties_store(struct wmOperator *op);
328
329
330 /* wm_operator_props.c */
331 void        WM_operator_properties_filesel(
332         struct wmOperatorType *ot, int filter, short type, short action,
333         short flag, short display, short sort);
334 void        WM_operator_properties_border(struct wmOperatorType *ot);
335 void        WM_operator_properties_border_to_rcti(struct wmOperator *op, struct rcti *rect);
336 void        WM_operator_properties_border_to_rctf(struct wmOperator *op, rctf *rect);
337 void        WM_operator_properties_gesture_border(struct wmOperatorType *ot, bool extend);
338 void        WM_operator_properties_mouse_select(struct wmOperatorType *ot);
339 void        WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
340 void        WM_operator_properties_select_all(struct wmOperatorType *ot);
341 void        WM_operator_properties_select_action(struct wmOperatorType *ot, int default_action);
342 void        WM_operator_properties_select_action_simple(struct wmOperatorType *ot, int default_action);
343 void        WM_operator_properties_select_random(struct wmOperatorType *ot);
344 int         WM_operator_properties_select_random_seed_increment_get(wmOperator *op);
345 struct CheckerIntervalParams {
346         int nth;  /* bypass when set to zero */
347         int skip;
348         int offset;
349 };
350 void        WM_operator_properties_checker_interval(struct wmOperatorType *ot, bool nth_can_disable);
351 void        WM_operator_properties_checker_interval_from_op(
352         struct wmOperator *op, struct CheckerIntervalParams *op_params);
353 bool        WM_operator_properties_checker_interval_test(
354         const struct CheckerIntervalParams *op_params, int depth);
355
356
357 /* MOVE THIS SOMEWHERE ELSE */
358 #define SEL_TOGGLE              0
359 #define SEL_SELECT              1
360 #define SEL_DESELECT    2
361 #define SEL_INVERT              3
362
363
364 /* flags for WM_operator_properties_filesel */
365 #define WM_FILESEL_RELPATH              (1 << 0)
366
367 #define WM_FILESEL_DIRECTORY    (1 << 1)
368 #define WM_FILESEL_FILENAME             (1 << 2)
369 #define WM_FILESEL_FILEPATH             (1 << 3)
370 #define WM_FILESEL_FILES                (1 << 4)
371
372
373                 /* operator as a python command (resultuing string must be freed) */
374 char            *WM_operator_pystring_ex(struct bContext *C, struct wmOperator *op,
375                                      const bool all_args, const bool macro_args,
376                                      struct wmOperatorType *ot, struct PointerRNA *opptr);
377 char            *WM_operator_pystring(struct bContext *C, struct wmOperator *op,
378                                   const bool all_args, const bool macro_args);
379 bool         WM_operator_pystring_abbreviate(char *str, int str_len_max);
380 char            *WM_prop_pystring_assign(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
381 void            WM_operator_bl_idname(char *to, const char *from);
382 void            WM_operator_py_idname(char *to, const char *from);
383
384 /* *************** uilist types ******************** */
385 void                WM_uilisttype_init(void);
386 struct uiListType  *WM_uilisttype_find(const char *idname, bool quiet);
387 bool                WM_uilisttype_add(struct uiListType *ult);
388 void                WM_uilisttype_freelink(struct uiListType *ult);
389 void                WM_uilisttype_free(void);
390
391 /* *************** menu types ******************** */
392 void                WM_menutype_init(void);
393 struct MenuType    *WM_menutype_find(const char *idname, bool quiet);
394 bool                WM_menutype_add(struct MenuType *mt);
395 void                WM_menutype_freelink(struct MenuType *mt);
396 void                WM_menutype_free(void);
397
398                         /* default operator callbacks for border/circle/lasso */
399 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
400 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
401 void            WM_border_select_cancel(struct bContext *C, struct wmOperator *op);
402 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
403 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
404 void            WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
405 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
406 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
407 void            WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
408 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
409 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
410 void            WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
411 const int (*WM_gesture_lasso_path_to_array(struct bContext *C, struct wmOperator *op, int *mcords_tot))[2];
412 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
413 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
414 void            WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
415
416                         /* Gesture manager API */
417 struct wmGesture *WM_gesture_new(struct bContext *C, const struct wmEvent *event, int type);
418 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
419 void            WM_gestures_remove(struct bContext *C);
420
421                         /* fileselecting support */
422 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
423 void            WM_event_fileselect_event(struct wmWindowManager *wm, void *ophandle, int eventval);
424 void            WM_event_print(const struct wmEvent *event);
425
426 void            WM_operator_region_active_win_set(struct bContext *C);
427
428                         /* drag and drop */
429 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value, unsigned int flags);
430 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
431 void                WM_drag_free(struct wmDrag *drag);
432 void                WM_drag_free_list(struct ListBase *lb);
433
434 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, const struct wmEvent *event),
435                                     void (*copy)(struct wmDrag *, struct wmDropBox *));
436 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
437
438                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
439 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
440 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, const struct rcti *srct, bool srct_pad);
441
442                         /* OpenGL utilities with safety check */
443 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
444                         /* use for conventions (avoid hard-coded offsets all over) */
445 void            wmOrtho2_region_pixelspace(const struct ARegion *ar);
446 void            wmOrtho2_pixelspace(const float x, const float y);
447
448                         /* threaded Jobs Manager */
449 enum {
450         WM_JOB_PRIORITY     = (1 << 0),
451         WM_JOB_EXCL_RENDER  = (1 << 1),
452         WM_JOB_PROGRESS     = (1 << 2),
453         WM_JOB_SUSPEND      = (1 << 3)
454 };
455
456 /* identifying jobs by owner alone is unreliable, this isnt saved, order can change (keep 0 for 'any') */
457 enum {
458         WM_JOB_TYPE_ANY = 0,
459         WM_JOB_TYPE_COMPOSITE,
460         WM_JOB_TYPE_RENDER,
461         WM_JOB_TYPE_RENDER_PREVIEW,  /* UI preview */
462         WM_JOB_TYPE_SCREENCAST,
463         WM_JOB_TYPE_OBJECT_SIM_OCEAN,
464         WM_JOB_TYPE_OBJECT_SIM_FLUID,
465         WM_JOB_TYPE_OBJECT_BAKE_TEXTURE,
466         WM_JOB_TYPE_OBJECT_BAKE,
467         WM_JOB_TYPE_FILESEL_READDIR,
468         WM_JOB_TYPE_CLIP_BUILD_PROXY,
469         WM_JOB_TYPE_CLIP_TRACK_MARKERS,
470         WM_JOB_TYPE_CLIP_SOLVE_CAMERA,
471         WM_JOB_TYPE_CLIP_PREFETCH,
472         WM_JOB_TYPE_SEQ_BUILD_PROXY,
473         WM_JOB_TYPE_SEQ_BUILD_PREVIEW,
474         WM_JOB_TYPE_POINTCACHE,
475         WM_JOB_TYPE_DPAINT_BAKE,
476         WM_JOB_TYPE_ALEMBIC,
477         /* add as needed, screencast, seq proxy build
478          * if having hard coded values is a problem */
479 };
480
481 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag, int job_type);
482
483 bool        WM_jobs_test(struct wmWindowManager *wm, void *owner, int job_type);
484 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
485 char       *WM_jobs_name(struct wmWindowManager *wm, void *owner);
486 double      WM_jobs_starttime(struct wmWindowManager *wm, void *owner);
487 void       *WM_jobs_customdata(struct wmWindowManager *wm, void *owner);
488 void       *WM_jobs_customdata_from_type(struct wmWindowManager *wm, int job_type);
489
490 bool        WM_jobs_is_running(struct wmJob *);
491 bool            WM_jobs_is_stopped(wmWindowManager *wm, void *owner);
492 void       *WM_jobs_customdata_get(struct wmJob *);
493 void        WM_jobs_customdata_set(struct wmJob *, void *customdata, void (*free)(void *));
494 void        WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
495 void        WM_jobs_callbacks(struct wmJob *,
496                               void (*startjob)(void *, short *, short *, float *),
497                               void (*initjob)(void *),
498                               void (*update)(void *),
499                               void (*endjob)(void *));
500
501 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
502 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
503 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
504 void            WM_jobs_kill_all(struct wmWindowManager *wm);
505 void            WM_jobs_kill_all_except(struct wmWindowManager *wm, void *owner);
506 void            WM_jobs_kill_type(struct wmWindowManager *wm, void *owner, int job_type);
507
508 bool        WM_jobs_has_running(struct wmWindowManager *wm);
509
510 void            WM_job_main_thread_lock_acquire(struct wmJob *job);
511 void            WM_job_main_thread_lock_release(struct wmJob *job);
512
513                         /* clipboard */
514 char       *WM_clipboard_text_get(bool selection, int *r_len);
515 char       *WM_clipboard_text_get_firstline(bool selection, int *r_len);
516 void        WM_clipboard_text_set(const char *buf, bool selection);
517
518                         /* progress */
519 void            WM_progress_set(struct wmWindow *win, float progress);
520 void            WM_progress_clear(struct wmWindow *win);
521
522                         /* Draw (for screenshot) */
523 void            WM_redraw_windows(struct bContext *C);
524
525 void        WM_main_playanim(int argc, const char **argv);
526
527 /* debugging only, convenience function to write on crash */
528 bool write_crash_blend(void);
529
530                         /* Lock the interface for any communication */
531 void        WM_set_locked_interface(struct wmWindowManager *wm, bool lock);
532
533 #ifdef WITH_INPUT_NDOF
534 void        WM_event_ndof_pan_get(const struct wmNDOFMotionData *ndof, float r_pan[3], const bool use_zoom);
535 void        WM_event_ndof_rotate_get(const struct wmNDOFMotionData *ndof, float r_rot[3]);
536
537 float       WM_event_ndof_to_axis_angle(const struct wmNDOFMotionData *ndof, float axis[3]);
538 void        WM_event_ndof_to_quat(const struct wmNDOFMotionData *ndof, float q[4]);
539 #endif /* WITH_INPUT_NDOF */
540
541 float       WM_event_tablet_data(const struct wmEvent *event, int *pen_flip, float tilt[2]);
542 bool        WM_event_is_tablet(const struct wmEvent *event);
543
544 #ifdef WITH_INPUT_IME
545 bool        WM_event_is_ime_switch(const struct wmEvent *event);
546 #endif
547
548 #ifdef __cplusplus
549 }
550 #endif
551
552 #endif /* __WM_API_H__ */
553