Holiday coding log :)
[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 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
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48 struct bContext;
49 struct IDProperty;
50 struct wmEvent;
51 struct wmEventHandler;
52 struct wmGesture;
53 struct wmJob;
54 struct wmNotifier;
55 struct wmOperatorType;
56 struct wmOperator;
57 struct rcti;
58 struct PointerRNA;
59 struct EnumPropertyItem;
60 struct MenuType;
61 struct wmDropBox;
62 struct wmDrag;
63 struct ImBuf;
64
65 typedef struct wmJob wmJob;
66
67 /* general API */
68 void            WM_init_state_size_set          (int stax, int stay, int sizx, int sizy);
69 void            WM_init_state_fullscreen_set(void);
70 void            WM_init_state_normal_set(void);
71 void            WM_init_native_pixels(int do_it);
72
73 void            WM_init                         (struct bContext *C, int argc, const char **argv);
74 void            WM_exit_ext                     (struct bContext *C, const short do_python);
75
76 void            WM_exit                         (struct bContext *C)
77 #if defined(__GNUC__) || defined(__clang__)
78 __attribute__((noreturn))
79 #endif
80 ;
81
82 void            WM_main                         (struct bContext *C)
83 #if defined(__GNUC__) || defined(__clang__)
84 __attribute__((noreturn))
85 #endif
86 ;
87
88 int             WM_init_game            (struct bContext *C);
89 void            WM_init_splash          (struct bContext *C);
90
91
92 void            WM_check                        (struct bContext *C);
93
94 struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect);
95
96 int                     WM_window_pixels_x              (struct wmWindow *win);
97 int                     WM_window_pixels_y              (struct wmWindow *win);
98
99                 /* defines for 'type' WM_window_open_temp */
100 #define WM_WINDOW_RENDER                0
101 #define WM_WINDOW_USERPREFS             1
102 #define WM_WINDOW_FILESEL               2
103
104 void            WM_window_open_temp     (struct bContext *C, struct rcti *position, int type);
105                         
106                         /* returns true if draw method is triple buffer */
107 int                     WM_is_draw_triple(struct wmWindow *win);
108
109
110
111                         /* files */
112 void            WM_file_read(struct bContext *C, const char *filepath, struct ReportList *reports);
113 void            WM_autosave_init(struct wmWindowManager *wm);
114
115                         /* mouse cursors */
116 void            WM_cursor_set           (struct wmWindow *win, int curs);
117 void            WM_cursor_modal         (struct wmWindow *win, int curs);
118 void            WM_cursor_restore       (struct wmWindow *win);
119 void            WM_cursor_wait          (int val);
120 void            WM_cursor_grab_enable(struct wmWindow *win, int wrap, int hide, int bounds[4]);
121 void            WM_cursor_grab_disable(struct wmWindow *win, int mouse_ungrab_xy[2]);
122 void            WM_cursor_time          (struct wmWindow *win, int nr);
123
124 void            *WM_paint_cursor_activate(struct wmWindowManager *wm,
125                                       int (*poll)(struct bContext *C),
126                                       void (*draw)(struct bContext *C, int, int, void *customdata),
127                                       void *customdata);
128
129 void            WM_paint_cursor_end(struct wmWindowManager *wm, void *handle);
130
131 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
132
133                         /* event map */
134 int                     WM_userdef_event_map(int kmitype);
135
136                         /* handlers */
137
138 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
139                                                 /* boundbox, optional subwindow boundbox for offset */
140 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb);
141                                                 /* priority not implemented, it adds in begin */
142 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
143
144 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
145
146 struct wmEventHandler *WM_event_add_ui_handler(const struct bContext *C, ListBase *handlers,
147                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
148                         void (*remove)(struct bContext *C, void *userdata), void *userdata);
149 void            WM_event_remove_ui_handler(ListBase *handlers,
150                         int (*func)(struct bContext *C, struct wmEvent *event, void *userdata),
151                         void (*remove)(struct bContext *C, void *userdata), void *userdata, int postpone);
152 void            WM_event_remove_area_handler(struct ListBase *handlers, void *area);
153
154 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
155 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
156
157 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
158
159                         /* mouse */
160 void            WM_event_add_mousemove(struct bContext *C);
161 void            WM_event_add_mousemove_window(struct wmWindow *window);
162 int                     WM_modal_tweak_exit(struct wmEvent *evt, int tweak_event);
163
164                         /* notifiers */
165 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
166 void            WM_main_add_notifier(unsigned int type, void *reference);
167
168 void            wm_event_add            (struct wmWindow *win, struct wmEvent *event_to_add); /* XXX only for warning */
169
170                         /* at maximum, every timestep seconds it triggers event_type events */
171 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
172 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
173 void            WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, int dosleep);
174
175                 /* operator api, default callbacks */
176                         /* invoke callback, uses enum property named "type" */
177 int                     WM_operator_view3d_distance_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
178 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
179 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
180                         /* invoke callback, confirm menu + exec */
181 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
182                 /* invoke callback, file selector "filepath" unset + exec */
183 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
184 int         WM_operator_filesel_ensure_ext_imtype(wmOperator *op, const char imtype);
185                         /* poll callback, context checks */
186 int                     WM_operator_winactive   (struct bContext *C);
187                         /* invoke callback, exec + redo popup */
188 int                     WM_operator_props_popup_call(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
189 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
190 int             WM_operator_props_dialog_popup (struct bContext *C, struct wmOperator *op, int width, int height);
191 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
192 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
193
194 int                     WM_operator_confirm_message(struct bContext *C, struct wmOperator *op, const char *message);
195
196                 /* operator api */
197 void            WM_operator_free                (struct wmOperator *op);
198 void            WM_operator_stack_clear(struct wmWindowManager *wm);
199
200 struct wmOperatorType *WM_operatortype_find(const char *idnamem, int quiet);
201 struct GHashIterator  *WM_operatortype_iter(void);
202 void            WM_operatortype_append  (void (*opfunc)(struct wmOperatorType*));
203 void            WM_operatortype_append_ptr      (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
204 void            WM_operatortype_append_macro_ptr        (void (*opfunc)(struct wmOperatorType*, void *), void *userdata);
205 int                     WM_operatortype_remove(const char *idname);
206
207 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, const char *description, int flag);
208 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
209
210
211 int                     WM_operator_poll                (struct bContext *C, struct wmOperatorType *ot);
212 int                     WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, short context);
213 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
214 int                     WM_operator_call_notest(struct bContext *C, struct wmOperator *op);
215 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
216 int                     WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
217 int                     WM_operator_name_call   (struct bContext *C, const char *opstring, short context, struct PointerRNA *properties);
218 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties, struct ReportList *reports, short is_undo);
219
220 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
221 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const short no_context); /* make props context sensitive or not */
222 int         WM_operator_properties_default(struct PointerRNA *ptr, const int do_update);
223 void        WM_operator_properties_reset(struct wmOperator *op);
224 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
225 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
226 void            WM_operator_properties_free(struct PointerRNA *ptr);
227 void            WM_operator_properties_filesel(struct wmOperatorType *ot, int filter, short type, short action, short flag, short display);
228 void        WM_operator_properties_border(struct wmOperatorType *ot);
229 void        WM_operator_properties_border_to_rcti(struct wmOperator *op, struct rcti *rect);
230 void            WM_operator_properties_gesture_border(struct wmOperatorType *ot, int extend);
231 void        WM_operator_properties_mouse_select(struct wmOperatorType *ot);
232 void            WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
233 void            WM_operator_properties_select_all(struct wmOperatorType *ot);
234
235 int         WM_operator_check_ui_enabled(const struct bContext *C, const char *idname);
236 wmOperator *WM_operator_last_redo(const struct bContext *C);
237
238 int         WM_operator_last_properties_init(struct wmOperator *op);
239 int         WM_operator_last_properties_store(struct wmOperator *op);
240
241 /* MOVE THIS SOMEWHERE ELSE */
242 #define SEL_TOGGLE              0
243 #define SEL_SELECT              1
244 #define SEL_DESELECT    2
245 #define SEL_INVERT              3
246
247
248 /* flags for WM_operator_properties_filesel */
249 #define WM_FILESEL_RELPATH              (1 << 0)
250
251 #define WM_FILESEL_DIRECTORY    (1 << 1)
252 #define WM_FILESEL_FILENAME             (1 << 2)
253 #define WM_FILESEL_FILEPATH             (1 << 3)
254 #define WM_FILESEL_FILES                (1 << 4)
255
256
257                 /* operator as a python command (resultuing string must be freed) */
258 char            *WM_operator_pystring(struct bContext *C, struct wmOperatorType *ot, struct PointerRNA *opptr, int all_args);
259 void            WM_operator_bl_idname(char *to, const char *from);
260 void            WM_operator_py_idname(char *to, const char *from);
261
262 /* *************** menu types ******************** */
263 void                WM_menutype_init(void);
264 struct MenuType    *WM_menutype_find(const char *idname, int quiet);
265 int                 WM_menutype_add(struct MenuType *mt);
266 void                WM_menutype_freelink(struct MenuType *mt);
267 void                WM_menutype_free(void);
268
269                         /* default operator callbacks for border/circle/lasso */
270 int                     WM_border_select_invoke (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
271 int                     WM_border_select_modal  (struct bContext *C, struct wmOperator *op, struct wmEvent *event);
272 int                     WM_border_select_cancel(struct bContext *C, struct wmOperator *op);
273 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
274 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
275 int                     WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
276 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
277 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
278 int                     WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
279 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
280 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
281 int                     WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
282 const int (*WM_gesture_lasso_path_to_array(struct bContext *C, struct wmOperator *op, int *mcords_tot))[2];
283 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
284 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, struct wmEvent *event);
285 int                     WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
286
287                         /* Gesture manager API */
288 struct wmGesture *WM_gesture_new(struct bContext *C, struct wmEvent *event, int type);
289 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
290 void            WM_gestures_remove(struct bContext *C);
291
292                         /* fileselecting support */
293 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
294 void            WM_event_fileselect_event(struct bContext *C, void *ophandle, int eventval);
295 #ifndef NDEBUG
296 void            WM_event_print(struct wmEvent *event);
297 #endif
298
299                         /* drag and drop */
300 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value);
301 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
302
303 struct wmDropBox        *WM_dropbox_add(ListBase *lb, const char *idname, int (*poll)(struct bContext *, struct wmDrag *, struct wmEvent *event),
304                                                   void (*copy)(struct wmDrag *, struct wmDropBox *));
305 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
306
307                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
308 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
309 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, struct rcti *srct);
310
311                         /* OpenGL utilities with safety check + working in modelview matrix mode */
312 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
313 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
314 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
315
316                         /* utilities */
317 void            WM_framebuffer_index_set(int index);
318 int                     WM_framebuffer_to_index(unsigned int col);
319
320                         /* threaded Jobs Manager */
321 enum {
322         WM_JOB_PRIORITY     = (1 << 0),
323         WM_JOB_EXCL_RENDER  = (1 << 1),
324         WM_JOB_PROGRESS     = (1 << 2),
325         WM_JOB_SUSPEND      = (1 << 3)
326 };
327
328 /* identifying jobs by owner alone is unreliable, this isnt saved, order can change (keep 0 for 'any') */
329 enum {
330         WM_JOB_TYPE_ANY = 0,
331         WM_JOB_TYPE_COMPOSITE,
332         WM_JOB_TYPE_RENDER,
333         WM_JOB_TYPE_RENDER_PREVIEW,  /* UI preview */
334         WM_JOB_TYPE_SCREENCAST,
335         WM_JOB_TYPE_OBJECT_SIM_OCEAN,
336         WM_JOB_TYPE_OBJECT_SIM_FLUID,
337         WM_JOB_TYPE_OBJECT_BAKE_TEXTURE,
338         WM_JOB_TYPE_FILESEL_THUMBNAIL,
339         WM_JOB_TYPE_CLIP_BUILD_PROXY,
340         WM_JOB_TYPE_CLIP_TRACK_MARKERS,
341         WM_JOB_TYPE_CLIP_SOLVE_CAMERA,
342         WM_JOB_TYPE_SEQ_BUILD_PROXY,
343         /* add as needed, screencast, seq proxy build
344          * if having hard coded values is a problem */
345 };
346
347 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag, int job_type);
348
349 int                     WM_jobs_test(struct wmWindowManager *wm, void *owner, int job_type);
350 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
351 char       *WM_jobs_name(struct wmWindowManager *wm, void *owner);
352
353 int         WM_jobs_is_running(struct wmJob *);
354 void       *WM_jobs_customdata_get(struct wmJob *);
355 void        WM_jobs_customdata_set(struct wmJob *, void *customdata, void (*free)(void *));
356 void        WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
357 void        WM_jobs_callbacks(struct wmJob *,
358                               void (*startjob)(void *, short *, short *, float *),
359                               void (*initjob)(void *),
360                               void (*update)(void *),
361                               void (*endjob)(void *));
362
363 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
364 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
365 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
366 void            WM_jobs_kill_all(struct wmWindowManager *wm);
367 void            WM_jobs_kill_all_except(struct wmWindowManager *wm, void *owner);
368 void            WM_jobs_kill_type(struct wmWindowManager *wm, int job_type);
369
370 int                     WM_jobs_has_running(struct wmWindowManager *wm);
371
372                         /* clipboard */
373 char       *WM_clipboard_text_get(int selection);
374 void        WM_clipboard_text_set(char *buf, int selection);
375
376                         /* progress */
377 void            WM_progress_set(struct wmWindow *win, float progress);
378 void            WM_progress_clear(struct wmWindow *win);
379
380                         /* Draw (for screenshot) */
381 void            WM_redraw_windows(struct bContext *C);
382
383 void        WM_main_playanim(int argc, const char **argv);
384
385 /* debugging only, convenience function to write on crash */
386 int write_crash_blend(void);
387
388 #ifdef __cplusplus
389 }
390 #endif
391
392 #endif /* __WM_API_H__ */
393