diff options
Diffstat (limited to 'source/blender/blenloader/BLO_readfile.h')
| -rw-r--r-- | source/blender/blenloader/BLO_readfile.h | 201 |
1 files changed, 18 insertions, 183 deletions
diff --git a/source/blender/blenloader/BLO_readfile.h b/source/blender/blenloader/BLO_readfile.h index 77bdb99b54b..bf47682297d 100644 --- a/source/blender/blenloader/BLO_readfile.h +++ b/source/blender/blenloader/BLO_readfile.h @@ -44,6 +44,7 @@ struct MemFile; struct ReportList; struct Scene; struct UserDef; +struct View3D; struct bContext; struct BHead; struct FileData; @@ -70,186 +71,39 @@ typedef struct BlendFileData { BlenFileType type; } BlendFileData; -/** - * Open a blender file from a pathname. The function - * returns NULL and sets a report in the list if - * it cannot open the file. - * - * \param filepath The path of the file to open. - * \param reports If the return value is NULL, errors - * indicating the cause of the failure. - * \return The data of the file. - */ -BlendFileData *BLO_read_from_file( - const char *filepath, - struct ReportList *reports); - -/** - * Open a blender file from memory. The function - * returns NULL and sets a report in the list if - * it cannot open the file. - * - * \param mem The file data. - * \param memsize The length of \a mem. - * \param reports If the return value is NULL, errors - * indicating the cause of the failure. - * \return The data of the file. - */ -BlendFileData *BLO_read_from_memory( - const void *mem, int memsize, - struct ReportList *reports); - -/** - * oldmain is old main, from which we will keep libraries, images, .. - * file name is current file, only for retrieving library data */ - +BlendFileData *BLO_read_from_file(const char *filepath, struct ReportList *reports); +BlendFileData *BLO_read_from_memory(const void *mem, int memsize, struct ReportList *reports); BlendFileData *BLO_read_from_memfile( struct Main *oldmain, const char *filename, struct MemFile *memfile, struct ReportList *reports); -/** - * Free's a BlendFileData structure and _all_ the - * data associated with it (the userdef data, and - * the main libblock data). - * - * \param bfd The structure to free. - */ -void -BLO_blendfiledata_free(BlendFileData *bfd); - -/** - * Open a blendhandle from a file path. - * - * \param filepath: The file path to open. - * \param reports: Report errors in opening the file (can be NULL). - * \return A handle on success, or NULL on failure. - */ -BlendHandle *BLO_blendhandle_from_file( - const char *filepath, - struct ReportList *reports); - -/** - * Open a blendhandle from memory. - * - * \param mem The data to load from. - * \param memsize The size of the data. - * \return A handle on success, or NULL on failure. - */ - -BlendHandle *BLO_blendhandle_from_memory( - const void *mem, int memsize); - -/** - * Gets the names of all the datablocks in a file - * of a certain type (ie. All the scene names in - * a file). - * - * \param bh The blendhandle to access. - * \param ofblocktype The type of names to get. - * \param tot_names The length of the returned list. - * \return A BLI_linklist of strings. The string links - * should be freed with malloc. - */ -struct LinkNode *BLO_blendhandle_get_datablock_names( - BlendHandle *bh, - int ofblocktype, int *tot_names); +void BLO_blendfiledata_free(BlendFileData *bfd); -/** - * Gets the previews of all the datablocks in a file - * of a certain type (ie. All the scene names in - * a file). - * - * \param bh The blendhandle to access. - * \param ofblocktype The type of names to get. - * \param tot_prev The length of the returned list. - * \return A BLI_linklist of PreviewImage. The PreviewImage links - * should be freed with malloc. - */ -struct LinkNode *BLO_blendhandle_get_previews( - BlendHandle *bh, - int ofblocktype, int *tot_prev); +BlendHandle *BLO_blendhandle_from_file(const char *filepath, struct ReportList *reports); +BlendHandle *BLO_blendhandle_from_memory(const void *mem, int memsize); -/** - * Gets the names of all the datablock groups in a - * file. (ie. file contains Scene, Mesh, and Lamp - * datablocks). - * - * \param bh The blendhandle to access. - * \return A BLI_linklist of strings. The string links - * should be freed with malloc. - */ +struct LinkNode *BLO_blendhandle_get_datablock_names(BlendHandle *bh, int ofblocktype, int *tot_names); +struct LinkNode *BLO_blendhandle_get_previews(BlendHandle *bh, int ofblocktype, int *tot_prev); struct LinkNode *BLO_blendhandle_get_linkable_groups(BlendHandle *bh); -/** - * Close and free a blendhandle. The handle - * becomes invalid after this call. - * - * \param bh The handle to close. - */ -void -BLO_blendhandle_close(BlendHandle *bh); +void BLO_blendhandle_close(BlendHandle *bh); /***/ #define BLO_GROUP_MAX 32 bool BLO_has_bfile_extension(const char *str); - -/** - * \param path the full path to explode. - * \param r_dir the string that'll contain path up to blend file itself ('library' path). - * \param r_group the string that'll contain 'group' part of the path, if any. May be NULL. - * \param r_name the string that'll contain data's name part of the path, if any. May be NULL. - * \return true if path contains a blend file. - */ bool BLO_library_path_explode(const char *path, char *r_dir, char **r_group, char **r_name); - -/** - * Initialize the BlendHandle for appending or linking library data. - * - * \param mainvar The current main database eg G.main or CTX_data_main(C). - * \param bh A blender file handle as returned by BLO_blendhandle_from_file or BLO_blendhandle_from_memory. - * \param filepath Used for relative linking, copied to the lib->name - * \return the library Main, to be passed to BLO_library_append_named_part as mainl. - */ -struct Main *BLO_library_append_begin( - struct Main *mainvar, BlendHandle **bh, - const char *filepath); - - -/** - * Link/Append a named datablock from an external blend file. - * - * \param mainl The main database to link from (not the active one). - * \param bh The blender file handle. - * \param idname The name of the datablock (without the 2 char ID prefix) - * \param idcode The kind of datablock to link. - * \return the appended ID when found. - */ -struct ID *BLO_library_append_named_part( +struct Main *BLO_library_link_begin(struct Main *mainvar, BlendHandle **bh, const char *filepath); +struct ID *BLO_library_link_named_part(struct Main *mainl, BlendHandle **bh, const short idcode, const char *name); +struct ID *BLO_library_link_named_part_ex( struct Main *mainl, BlendHandle **bh, - const char *idname, const int idcode); - -/** - * Link/Append a named datablock from an external blend file. - * optionally instance the object in the scene when the flags are set. - * - * \param C The context, when NULL instancing object in the scene isn't done. - * \param mainl The main database to link from (not the active one). - * \param bh The blender file handle. - * \param idname The name of the datablock (without the 2 char ID prefix) - * \param idcode The kind of datablock to link. - * \param flag Options for linking, used for instancing. - * \return the appended ID when found. - */ -struct ID *BLO_library_append_named_part_ex( - const struct bContext *C, struct Main *mainl, BlendHandle **bh, - const char *idname, const int idcode, const short flag); - -void BLO_library_append_end(const struct bContext *C, struct Main *mainl, BlendHandle **bh, int idcode, short flag); + const short idcode, const char *name, const short flag, + struct Scene *scene, struct View3D *v3d); +void BLO_library_link_end(struct Main *mainl, BlendHandle **bh, short flag, struct Scene *scene, struct View3D *v3d); -void BLO_library_append_all(struct Main *mainl, BlendHandle *bh); +void BLO_library_link_copypaste(struct Main *mainl, BlendHandle *bh); void *BLO_library_read_struct(struct FileData *fd, struct BHead *bh, const char *blockname); @@ -258,34 +112,15 @@ BlendFileData *blo_read_blendafterruntime(int file, const char *name, int actual /* internal function but we need to expose it */ void blo_lib_link_screen_restore(struct Main *newmain, struct bScreen *curscreen, struct Scene *curscene); -/** - * BLO_expand_main() loops over all ID data in Main to mark relations. - * Set (id->flag & LIB_NEED_EXPAND) to mark expanding. Flags get cleared after expanding. - * - * \param expand_doit_func() gets called for each ID block it finds - */ -void BLO_main_expander(void (*expand_doit_func)(void *, struct Main *, void *)); +typedef void (*BLOExpandDoitCallback) (void *fdhandle, struct Main *mainvar, void *idv); -/** - * BLO_expand_main() loops over all ID data in Main to mark relations. - * Set (id->flag & LIB_NEED_EXPAND) to mark expanding. Flags get cleared after expanding. - * - * \param fdhandle usually filedata, or own handle - * \param mainvar the Main database to expand - */ +void BLO_main_expander(BLOExpandDoitCallback expand_doit_func); void BLO_expand_main(void *fdhandle, struct Main *mainvar); /* Update defaults in startup.blend & userprefs.blend, without having to save and embed it */ void BLO_update_defaults_userpref_blend(void); void BLO_update_defaults_startup_blend(struct Main *mainvar); -/** - * Does a very light reading of given .blend file to extract its stored thumbnail. - * - * \param filepath The path of the file to extract thumbnail from. - * \return The raw thumbnail - * (MEM-allocated, as stored in file, use BKE_main_thumbnail_to_imbuf() to convert it to ImBuf image). - */ struct BlendThumbnail *BLO_thumbnail_from_file(const char *filepath); #ifdef __cplusplus |