doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / BKE_blendfile.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16 #ifndef __BKE_BLENDFILE_H__
17 #define __BKE_BLENDFILE_H__
18
19 /** \file
20  * \ingroup bke
21  */
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 struct BlendFileReadParams;
28 struct ID;
29 struct Main;
30 struct MemFile;
31 struct ReportList;
32 struct UserDef;
33 struct bContext;
34
35 enum {
36         BKE_BLENDFILE_READ_FAIL             = 0, /* no load */
37         BKE_BLENDFILE_READ_OK               = 1, /* OK */
38         BKE_BLENDFILE_READ_OK_USERPREFS     = 2, /* OK, and with new user settings */
39 };
40
41 int BKE_blendfile_read(
42         struct bContext *C, const char *filepath,
43         const struct BlendFileReadParams *params,
44         struct ReportList *reports);
45 bool BKE_blendfile_read_from_memory(
46         struct bContext *C, const void *filebuf, int filelength, bool update_defaults,
47         const struct BlendFileReadParams *params,
48         struct ReportList *reports);
49 bool BKE_blendfile_read_from_memfile(
50         struct bContext *C, struct MemFile *memfile,
51         const struct BlendFileReadParams *params,
52         struct ReportList *reports);
53 void BKE_blendfile_read_make_empty(struct bContext *C);
54
55 struct UserDef *BKE_blendfile_userdef_read(
56         const char *filepath, struct ReportList *reports);
57 struct UserDef *BKE_blendfile_userdef_read_from_memory(
58         const void *filebuf, int filelength,
59         struct ReportList *reports);
60
61 bool BKE_blendfile_userdef_write(const char *filepath, struct ReportList *reports);
62 bool BKE_blendfile_userdef_write_app_template(const char *filepath, struct ReportList *reports);
63
64 struct WorkspaceConfigFileData *BKE_blendfile_workspace_config_read(
65         const char *filepath,
66         const void *filebuf, int filelength,
67         struct ReportList *reports);
68 bool BKE_blendfile_workspace_config_write(struct Main *bmain, const char *filepath, struct ReportList *reports);
69 void BKE_blendfile_workspace_config_data_free(struct WorkspaceConfigFileData *workspace_config);
70
71 /* partial blend file writing */
72 void BKE_blendfile_write_partial_tag_ID(struct ID *id, bool set);
73 void BKE_blendfile_write_partial_begin(struct Main *bmain_src);
74 bool BKE_blendfile_write_partial(
75         struct Main *bmain_src, const char *filepath, const int write_flags, struct ReportList *reports);
76 void BKE_blendfile_write_partial_end(struct Main *bmain_src);
77
78 #ifdef __cplusplus
79 }
80 #endif
81
82 #endif  /* __BKE_BLENDFILE_H__ */