Change version cycle to 'alpha'
[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         276
45 #define BLENDER_SUBVERSION      1
46 /* Several breakages with 270, e.g. constraint deg vs rad */
47 #define BLENDER_MINVERSION      270
48 #define BLENDER_MINSUBVERSION   5
49
50 /* used by packaging tools */
51 /* can be left blank, otherwise a,b,c... etc with no quotes */
52 #define BLENDER_VERSION_CHAR   
53 /* alpha/beta/rc/release, docs use this */
54 #define BLENDER_VERSION_CYCLE   alpha
55
56 extern char versionstr[]; /* from blender.c */
57
58 struct MemFile;
59 struct bContext;
60 struct ReportList;
61 struct Scene;
62 struct Main;
63 struct ID;
64
65 int BKE_read_file(struct bContext *C, const char *filepath, struct ReportList *reports);
66
67 #define BKE_READ_FILE_FAIL              0 /* no load */
68 #define BKE_READ_FILE_OK                1 /* OK */
69 #define BKE_READ_FILE_OK_USERPREFS      2 /* OK, and with new user settings */
70
71 bool BKE_read_file_from_memory(
72         struct bContext *C, const void *filebuf,
73         int filelength, struct ReportList *reports, bool update_defaults);
74 bool BKE_read_file_from_memfile(
75         struct bContext *C, struct MemFile *memfile,
76         struct ReportList *reports);
77
78 int BKE_read_file_userdef(const char *filepath, struct ReportList *reports);
79 int BKE_write_file_userdef(const char *filepath, struct ReportList *reports);
80
81 void free_blender(void);
82 void initglobals(void);
83
84 /* load new userdef from file, exit blender */
85 void BKE_userdef_free(void);
86 /* handle changes in userdef */
87 void BKE_userdef_state(void);
88         
89 /* set this callback when a UI is running */
90 void BKE_blender_callback_test_break_set(void (*func)(void));
91 int blender_test_break(void);
92
93 #define BKE_UNDO_STR_MAX 64
94
95 /* global undo */
96 extern void          BKE_undo_write(struct bContext *C, const char *name);
97 extern void          BKE_undo_step(struct bContext *C, int step);
98 extern void          BKE_undo_name(struct bContext *C, const char *name);
99 extern bool          BKE_undo_is_valid(const char *name);
100 extern void          BKE_undo_reset(void);
101 extern void          BKE_undo_number(struct bContext *C, int nr);
102 extern const char   *BKE_undo_get_name(int nr, bool *r_active);
103 extern bool          BKE_undo_save_file(const char *filename);
104 extern struct Main  *BKE_undo_get_main(struct Scene **r_scene);
105
106 /* copybuffer */
107 void BKE_copybuffer_begin(struct Main *bmain);
108 void BKE_copybuffer_tag_ID(struct ID *id);
109 int BKE_copybuffer_save(const char *filename, struct ReportList *reports);
110 int BKE_copybuffer_paste(struct bContext *C, const char *libname, struct ReportList *reports);
111
112 #ifdef __cplusplus
113 }
114 #endif
115
116 #endif
117