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