5a1c479f45050e802072d72f728bc13cc4ff2786
[blender.git] / source / blender / blenloader / BLO_readfile.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 __BLO_READFILE_H__
28 #define __BLO_READFILE_H__
29
30 /** \file BLO_readfile.h
31  *  \ingroup blenloader
32  *  \brief external readfile function prototypes.
33  */
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct BlendThumbnail;
40 struct bScreen;
41 struct LinkNode;
42 struct Main;
43 struct MemFile;
44 struct ReportList;
45 struct Scene;
46 struct UserDef;
47 struct View3D;
48 struct bContext;
49 struct BHead;
50 struct FileData;
51 struct BlendFileReadParams;
52
53 typedef struct BlendHandle BlendHandle;
54
55 typedef enum eBlenFileType {
56         BLENFILETYPE_BLEND = 1,
57         BLENFILETYPE_PUB = 2,
58         BLENFILETYPE_RUNTIME = 3
59 } eBlenFileType;
60
61 typedef struct BlendFileData {
62         struct Main *main;
63         struct UserDef *user;
64
65         int fileflags;
66         int globalf;
67         char filename[1024];    /* 1024 = FILE_MAX */
68
69         struct bScreen *curscreen;
70         struct Scene *curscene;
71
72         eBlenFileType type;
73 } BlendFileData;
74
75 struct BlendFileReadParams {
76         uint skip_flags : 2;  /* eBLOReadSkip */
77         uint is_startup : 1;
78 };
79
80 /* skip reading some data-block types (may want to skip screen data too). */
81 typedef enum eBLOReadSkip {
82         BLO_READ_SKIP_NONE          = 0,
83         BLO_READ_SKIP_USERDEF       = (1 << 0),
84         BLO_READ_SKIP_DATA          = (1 << 1),
85 } eBLOReadSkip;
86 #define BLO_READ_SKIP_ALL \
87         (BLO_READ_SKIP_USERDEF | BLO_READ_SKIP_DATA)
88
89 BlendFileData *BLO_read_from_file(
90         const char *filepath,
91         eBLOReadSkip skip_flags,
92         struct ReportList *reports);
93 BlendFileData *BLO_read_from_memory(
94         const void *mem, int memsize,
95         eBLOReadSkip skip_flags,
96         struct ReportList *reports);
97 BlendFileData *BLO_read_from_memfile(
98         struct Main *oldmain, const char *filename, struct MemFile *memfile,
99         eBLOReadSkip skip_flags,
100         struct ReportList *reports);
101
102 void BLO_blendfiledata_free(BlendFileData *bfd);
103
104 BlendHandle *BLO_blendhandle_from_file(const char *filepath, struct ReportList *reports);
105 BlendHandle *BLO_blendhandle_from_memory(const void *mem, int memsize);
106
107 struct LinkNode *BLO_blendhandle_get_datablock_names(BlendHandle *bh, int ofblocktype, int *tot_names);
108 struct LinkNode *BLO_blendhandle_get_previews(BlendHandle *bh, int ofblocktype, int *tot_prev);
109 struct LinkNode *BLO_blendhandle_get_linkable_groups(BlendHandle *bh);
110
111 void BLO_blendhandle_close(BlendHandle *bh);
112
113 /***/
114
115 #define BLO_GROUP_MAX 32
116
117 bool BLO_has_bfile_extension(const char *str);
118 bool BLO_library_path_explode(const char *path, char *r_dir, char **r_group, char **r_name);
119
120 /* Options controlling behavior of append/link code.
121  * Note: merged with 'user-level' options from operators etc. in 16 lower bits
122  *       (see eFileSel_Params_Flag in DNA_space_types.h). */
123 typedef enum BLO_LibLinkFlags {
124         /* Generate a placeholder (empty ID) if not found in current lib file. */
125         BLO_LIBLINK_USE_PLACEHOLDERS = 1 << 16,
126         /* Force loaded ID to be tagged as LIB_TAG_INDIRECT (used in reload context only). */
127         BLO_LIBLINK_FORCE_INDIRECT   = 1 << 17,
128 } BLO_LinkFlags;
129
130 struct Main *BLO_library_link_begin(struct Main *mainvar, BlendHandle **bh, const char *filepath);
131 struct ID *BLO_library_link_named_part(struct Main *mainl, BlendHandle **bh, const short idcode, const char *name);
132 struct ID *BLO_library_link_named_part_ex(
133         struct Main *mainl, BlendHandle **bh,
134         const short idcode, const char *name, const int flag,
135         struct Scene *scene, struct View3D *v3d);
136 void BLO_library_link_end(struct Main *mainl, BlendHandle **bh, short flag, struct Scene *scene, struct View3D *v3d);
137
138 void BLO_library_link_copypaste(struct Main *mainl, BlendHandle *bh);
139
140 void *BLO_library_read_struct(struct FileData *fd, struct BHead *bh, const char *blockname);
141
142 BlendFileData *blo_read_blendafterruntime(int file, const char *name, int actualsize, struct ReportList *reports);
143
144 /* internal function but we need to expose it */
145 void blo_lib_link_screen_restore(struct Main *newmain, struct bScreen *curscreen, struct Scene *curscene);
146
147 typedef void (*BLOExpandDoitCallback) (void *fdhandle, struct Main *mainvar, void *idv);
148
149 void BLO_main_expander(BLOExpandDoitCallback expand_doit_func);
150 void BLO_expand_main(void *fdhandle, struct Main *mainvar);
151
152 /* Update defaults in startup.blend & userprefs.blend, without having to save and embed it */
153 void BLO_update_defaults_userpref_blend(void);
154 void BLO_update_defaults_startup_blend(struct Main *mainvar);
155
156 struct BlendThumbnail *BLO_thumbnail_from_file(const char *filepath);
157
158 struct Main *BLO_main_from_memfile(struct MemFile *memfile, struct Main *bmain, struct Scene **r_scene);
159
160 #ifdef __cplusplus
161 }
162 #endif
163
164 #endif  /* __BLO_READFILE_H__ */