Campbell Barton
f88593df69
Rename UI_init_userdef_factory to BLO_update_defaults_userpref_blend This closely matches BLO_update_defaults_startup_blend so makes sense for them to be together.
287 lines
8.5 KiB
C++
287 lines
8.5 KiB
C++
/*
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
|
|
* All rights reserved.
|
|
*
|
|
* The Original Code is: all of this file.
|
|
*
|
|
* Contributor(s): none yet.
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
#ifndef __BLO_READFILE_H__
|
|
#define __BLO_READFILE_H__
|
|
|
|
/** \file BLO_readfile.h
|
|
* \ingroup blenloader
|
|
* \brief external readfile function prototypes.
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct bScreen;
|
|
struct direntry;
|
|
struct LinkNode;
|
|
struct Main;
|
|
struct MemFile;
|
|
struct ReportList;
|
|
struct Scene;
|
|
struct SpaceFile;
|
|
struct UserDef;
|
|
struct bContext;
|
|
struct BHead;
|
|
struct FileData;
|
|
|
|
typedef struct BlendHandle BlendHandle;
|
|
|
|
typedef enum BlenFileType {
|
|
BLENFILETYPE_BLEND = 1,
|
|
BLENFILETYPE_PUB = 2,
|
|
BLENFILETYPE_RUNTIME = 3
|
|
} BlenFileType;
|
|
|
|
typedef struct BlendFileData {
|
|
struct Main *main;
|
|
struct UserDef *user;
|
|
|
|
int winpos;
|
|
int fileflags;
|
|
int displaymode;
|
|
int globalf;
|
|
char filename[1024]; /* 1024 = FILE_MAX */
|
|
|
|
struct bScreen *curscreen;
|
|
struct Scene *curscene;
|
|
|
|
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_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 file 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);
|
|
|
|
/**
|
|
* 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);
|
|
|
|
/**
|
|
* 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_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);
|
|
|
|
/***/
|
|
|
|
#define BLO_GROUP_MAX 32
|
|
|
|
bool BLO_has_bfile_extension(const char *str);
|
|
|
|
/**
|
|
* return ok when a blenderfile, in dir is the filename,
|
|
* in group the type of libdata
|
|
*/
|
|
bool BLO_is_a_library(const char *path, char *dir, char *group);
|
|
|
|
|
|
/**
|
|
* 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 *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);
|
|
|
|
void BLO_library_append_all(struct Main *mainl, BlendHandle *bh);
|
|
|
|
void *BLO_library_read_struct(struct FileData *fd, struct BHead *bh, const char *blockname);
|
|
|
|
BlendFileData *blo_read_blendafterruntime(int file, const char *name, int actualsize, struct ReportList *reports);
|
|
|
|
/* 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 *));
|
|
|
|
/**
|
|
* 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_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);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __BLO_READFILE_H__ */
|