Merging r58464 through r58474 from trunk into soc-2013-depsgraph_mt
[blender.git] / source / blender / blenkernel / BKE_blender.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): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_BLENDER_H__
28 #define __BKE_BLENDER_H__
29
30 /** \file BKE_blender.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  *  \brief Blender util stuff
35  */
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /* these lines are grep'd, watch out for our not-so-awesome regex
42  * and keep comment above the defines.
43  * Use STRINGIFY() rather than defining with quotes */
44 #define BLENDER_VERSION         268
45 #define BLENDER_SUBVERSION      0
46
47 /* 262 was the last editmesh release but it has compatibility code for bmesh data */
48 #define BLENDER_MINVERSION      262
49 #define BLENDER_MINSUBVERSION   0
50
51 /* used by packaging tools */
52 /* can be left blank, otherwise a,b,c... etc with no quotes */
53 #define BLENDER_VERSION_CHAR   
54 /* alpha/beta/rc/release, docs use this */
55 #define BLENDER_VERSION_CYCLE   alpha
56
57 extern char versionstr[]; /* from blender.c */
58
59 struct ListBase;
60 struct MemFile;
61 struct bContext;
62 struct ReportList;
63 struct Scene;
64 struct Main;
65 struct ID;
66
67 int BKE_read_file(struct bContext *C, const char *filepath, struct ReportList *reports);
68
69 #define BKE_READ_FILE_FAIL              0 /* no load */
70 #define BKE_READ_FILE_OK                1 /* OK */
71 #define BKE_READ_FILE_OK_USERPREFS      2 /* OK, and with new user settings */
72
73 int BKE_read_file_from_memory(struct bContext *C, const void *filebuf, int filelength, struct ReportList *reports);
74 int BKE_read_file_from_memfile(struct bContext *C, struct MemFile *memfile, struct ReportList *reports);
75
76 int BKE_read_file_userdef(const char *filepath, struct ReportList *reports);
77 int BKE_write_file_userdef(const char *filepath, struct ReportList *reports);
78
79 void free_blender(void);
80 void initglobals(void);
81
82 /* load new userdef from file, exit blender */
83 void BKE_userdef_free(void);
84 /* handle changes in userdef */
85 void BKE_userdef_state(void);
86         
87 /* set this callback when a UI is running */
88 void set_blender_test_break_cb(void (*func)(void) );
89 int blender_test_break(void);
90
91 #define BKE_UNDO_STR_MAX 64
92
93 /* global undo */
94 extern void BKE_write_undo(struct bContext *C, const char *name);
95 extern void BKE_undo_step(struct bContext *C, int step);
96 extern void BKE_undo_name(struct bContext *C, const char *name);
97 extern int BKE_undo_valid(const char *name);
98 extern void BKE_reset_undo(void);
99 extern void BKE_undo_number(struct bContext *C, int nr);
100 extern const char *BKE_undo_get_name(int nr, int *active);
101 extern int BKE_undo_save_file(const char *filename);
102 extern struct Main *BKE_undo_get_main(struct Scene **scene);
103
104         /* copybuffer */
105 void BKE_copybuffer_begin(void);
106 void BKE_copybuffer_tag_ID(struct ID *id);
107 int BKE_copybuffer_save(const char *filename, struct ReportList *reports);
108         int BKE_copybuffer_paste(struct bContext *C, const char *libname, struct ReportList *reports);
109
110 #ifdef __cplusplus
111 }
112 #endif
113
114 #endif
115