Cleanup: remove redundant doxygen \file argument
[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 \ingroup bke
20  */
21
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25
26 struct BlendFileReadParams;
27 struct ID;
28 struct Main;
29 struct MemFile;
30 struct ReportList;
31 struct UserDef;
32 struct bContext;
33
34 enum {
35         BKE_BLENDFILE_READ_FAIL             = 0, /* no load */
36         BKE_BLENDFILE_READ_OK               = 1, /* OK */
37         BKE_BLENDFILE_READ_OK_USERPREFS     = 2, /* OK, and with new user settings */
38 };
39
40 int BKE_blendfile_read(
41         struct bContext *C, const char *filepath,
42         const struct BlendFileReadParams *params,
43         struct ReportList *reports);
44 bool BKE_blendfile_read_from_memory(
45         struct bContext *C, const void *filebuf, int filelength, bool update_defaults,
46         const struct BlendFileReadParams *params,
47         struct ReportList *reports);
48 bool BKE_blendfile_read_from_memfile(
49         struct bContext *C, struct MemFile *memfile,
50         const struct BlendFileReadParams *params,
51         struct ReportList *reports);
52 void BKE_blendfile_read_make_empty(struct bContext *C);
53
54 struct UserDef *BKE_blendfile_userdef_read(
55         const char *filepath, struct ReportList *reports);
56 struct UserDef *BKE_blendfile_userdef_read_from_memory(
57         const void *filebuf, int filelength,
58         struct ReportList *reports);
59
60 bool BKE_blendfile_userdef_write(const char *filepath, struct ReportList *reports);
61 bool BKE_blendfile_userdef_write_app_template(const char *filepath, struct ReportList *reports);
62
63 struct WorkspaceConfigFileData *BKE_blendfile_workspace_config_read(
64         const char *filepath,
65         const void *filebuf, int filelength,
66         struct ReportList *reports);
67 bool BKE_blendfile_workspace_config_write(struct Main *bmain, const char *filepath, struct ReportList *reports);
68 void BKE_blendfile_workspace_config_data_free(struct WorkspaceConfigFileData *workspace_config);
69
70 /* partial blend file writing */
71 void BKE_blendfile_write_partial_tag_ID(struct ID *id, bool set);
72 void BKE_blendfile_write_partial_begin(struct Main *bmain_src);
73 bool BKE_blendfile_write_partial(
74         struct Main *bmain_src, const char *filepath, const int write_flags, struct ReportList *reports);
75 void BKE_blendfile_write_partial_end(struct Main *bmain_src);
76
77 #ifdef __cplusplus
78 }
79 #endif
80
81 #endif  /* __BKE_BLENDFILE_H__ */