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