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