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