BLO_readfile.h

Go to the documentation of this file.

/*
 * ***** 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

#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[240]; /* 240 = FILE_MAX */
    
    struct bScreen* curscreen;
    struct Scene*   curscene;
    
    BlenFileType    type;
} BlendFileData;

BlendFileData*  BLO_read_from_file(const char *filepath, struct ReportList *reports);

BlendFileData*  BLO_read_from_memory(void *mem, int memsize, struct ReportList *reports);

BlendFileData *BLO_read_from_memfile(struct Main *oldmain, const char *filename, struct MemFile *memfile, struct ReportList *reports);

    void
BLO_blendfiledata_free(
    BlendFileData *bfd);
    
    BlendHandle*
BLO_blendhandle_from_file(
    char *file,
    struct ReportList *reports);

    BlendHandle*
BLO_blendhandle_from_memory(
    void *mem,
    int memsize);

    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);

    void
BLO_blendhandle_close(
    BlendHandle *bh);
    
    /***/

#define GROUP_MAX 32

int BLO_has_bfile_extension(const char *str);

/* return ok when a blenderfile, in dir is the filename,
 * in group the type of libdata
 */
int BLO_is_a_library(const char *path, char *dir, char *group);


struct Main* BLO_library_append_begin(struct Main *mainvar, BlendHandle** bh, const char *filepath);


struct ID *BLO_library_append_named_part(struct Main *mainl, BlendHandle** bh, const char *idname, const int idcode);

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_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);

#ifdef __cplusplus
} 
#endif

#endif