Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_packedFile.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19 #ifndef __BKE_PACKEDFILE_H__
20 #define __BKE_PACKEDFILE_H__
21
22 /** \file
23  * \ingroup bke
24  */
25 #define RET_OK      0
26 #define RET_ERROR   1
27
28 struct ID;
29 struct Image;
30 struct Main;
31 struct PackedFile;
32 struct ReportList;
33 struct VFont;
34 struct bSound;
35
36 /* pack */
37 struct PackedFile *dupPackedFile(const struct PackedFile *pf_src);
38 struct PackedFile *newPackedFile(struct ReportList *reports, const char *filename, const char *relabase);
39 struct PackedFile *newPackedFileMemory(void *mem, int memlen);
40
41 void packAll(struct Main *bmain, struct ReportList *reports, bool verbose);
42 void packLibraries(struct Main *bmain, struct ReportList *reports);
43
44 /* unpack */
45 char *unpackFile(
46         struct ReportList *reports, const char *ref_file_name,
47         const char *abs_name, const char *local_name, struct PackedFile *pf, int how);
48 int unpackVFont(struct Main *bmain, struct ReportList *reports, struct VFont *vfont, int how);
49 int unpackSound(struct Main *bmain, struct ReportList *reports, struct bSound *sound, int how);
50 int unpackImage(struct Main *bmain, struct ReportList *reports, struct Image *ima, int how);
51 void unpackAll(struct Main *bmain, struct ReportList *reports, int how);
52 int unpackLibraries(struct Main *bmain, struct ReportList *reports);
53
54 int writePackedFile(
55         struct ReportList *reports, const char *ref_file_name,
56         const char *filename, struct PackedFile *pf, const bool guimode);
57
58 /* free */
59 void freePackedFile(struct PackedFile *pf);
60
61 /* info */
62 int countPackedFiles(struct Main *bmain);
63 int checkPackedFile(const char *ref_file_name, const char *filename, struct PackedFile *pf);
64
65 /* read */
66 int seekPackedFile(struct PackedFile *pf, int offset, int whence);
67 void rewindPackedFile(struct PackedFile *pf);
68 int readPackedFile(struct PackedFile *pf, void *data, int size);
69
70 /* ID should be not NULL, return 1 if there's a packed file */
71 bool BKE_pack_check(struct ID *id);
72 /* ID should be not NULL, throws error when ID is Library */
73 void BKE_unpack_id(struct Main *bmain, struct ID *id, struct ReportList *reports, int how);
74
75 #endif