minor include cleanup, add GPL header (copied from BKE_animsys.h
[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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): mar 2001 Nzc
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenlib/BLI_callbacks.h
29  *  \ingroup bli
30  */
31
32 #ifndef BLI_CALLBACKS_H
33 #define BLI_CALLBACKS_H
34
35 struct bContext;
36 struct Main;
37 struct ID;
38
39 typedef enum {
40         BLI_CB_EVT_FRAME_CHANGE_PRE,
41         BLI_CB_EVT_FRAME_CHANGE_POST,
42         BLI_CB_EVT_RENDER_PRE,
43         BLI_CB_EVT_RENDER_POST,
44         BLI_CB_EVT_RENDER_STATS,
45         BLI_CB_EVT_LOAD_PRE,
46         BLI_CB_EVT_LOAD_POST,
47         BLI_CB_EVT_SAVE_PRE,
48         BLI_CB_EVT_SAVE_POST,
49         BLI_CB_EVT_SCENE_UPDATE_PRE,
50         BLI_CB_EVT_SCENE_UPDATE_POST,
51         BLI_CB_EVT_TOT
52 } eCbEvent;
53
54
55 typedef struct {
56         struct bCallbackFuncStore *next, *prev;
57         void (* func)(struct Main *, struct ID *, void *arg);
58         void *arg;
59         short alloc;
60 } bCallbackFuncStore;
61
62
63 void BLI_exec_cb(struct Main *main, struct ID *self, eCbEvent evt);
64 void BLI_add_cb(bCallbackFuncStore *funcstore, eCbEvent evt);
65
66 void BLI_cb_init(void);
67 void BLI_cb_finalize(void);
68
69
70 /* This is blenlib internal only, unrelated to above */
71 void callLocalErrorCallBack(const char* msg);
72
73 #endif /* BLI_CALLBACKS_H */