Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenlib / BLI_callbacks.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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 /** \file BLI_callbacks.h
22  *  \ingroup bli
23  */
24
25 #ifndef __BLI_CALLBACKS_H__
26 #define __BLI_CALLBACKS_H__
27
28 struct Main;
29 struct ID;
30
31 /**
32  * Common suffix uses:
33  * - ``_PRE/_POST``:
34  *   For handling discrete non-interactive events.
35  * - ``_INIT/_COMPLETE/_CANCEL``:
36  *   For handling jobs (which may in turn cause other handlers to be called).
37  */
38 typedef enum {
39         BLI_CB_EVT_FRAME_CHANGE_PRE,
40         BLI_CB_EVT_FRAME_CHANGE_POST,
41         BLI_CB_EVT_RENDER_PRE,
42         BLI_CB_EVT_RENDER_POST,
43         BLI_CB_EVT_RENDER_WRITE,
44         BLI_CB_EVT_RENDER_STATS,
45         BLI_CB_EVT_RENDER_INIT,
46         BLI_CB_EVT_RENDER_COMPLETE,
47         BLI_CB_EVT_RENDER_CANCEL,
48         BLI_CB_EVT_LOAD_PRE,
49         BLI_CB_EVT_LOAD_POST,
50         BLI_CB_EVT_SAVE_PRE,
51         BLI_CB_EVT_SAVE_POST,
52         BLI_CB_EVT_VERSION_UPDATE,
53         BLI_CB_EVT_TOT
54 } eCbEvent;
55
56
57 typedef struct bCallbackFuncStore {
58         struct bCallbackFuncStore *next, *prev;
59         void (*func)(struct Main *, struct ID *, void *arg);
60         void *arg;
61         short alloc;
62 } bCallbackFuncStore;
63
64
65 void BLI_callback_exec(struct Main *bmain, struct ID *self, eCbEvent evt);
66 void BLI_callback_add(bCallbackFuncStore *funcstore, eCbEvent evt);
67
68 void BLI_callback_global_init(void);
69 void BLI_callback_global_finalize(void);
70
71 #endif /* __BLI_CALLBACKS_H__ */