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