svn merge ^/trunk/blender -r43436:43443
[blender.git] / source / blender / blenkernel / BKE_packedFile.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 BKE_PACKEDFILE_H
28 #define BKE_PACKEDFILE_H
29
30 /** \file BKE_packedFile.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  */
35 #define RET_OK          0
36 #define RET_ERROR       1
37
38 struct bSound;
39 struct Image;
40 struct Main;
41 struct PackedFile;
42 struct ReportList;
43 struct VFont;
44
45 /* pack */
46 struct PackedFile *newPackedFile(struct ReportList *reports, const char *filename, const char *relabase);
47 struct PackedFile *newPackedFileMemory(void *mem, int memlen);
48
49 void packAll(struct Main *bmain, struct ReportList *reports);
50
51 /* unpack */
52 char *unpackFile(struct ReportList *reports, const char *abs_name, const char *local_name, struct PackedFile *pf, int how);
53 int unpackVFont(struct ReportList *reports, struct VFont *vfont, int how);
54 int unpackSound(struct Main *bmain, struct ReportList *reports, struct bSound *sound, int how);
55 int unpackImage(struct ReportList *reports, struct Image *ima, int how);
56 void unpackAll(struct Main *bmain, struct ReportList *reports, int how);
57
58 int writePackedFile(struct ReportList *reports, const char *filename, struct PackedFile *pf, int guimode);
59
60 /* free */
61 void freePackedFile(struct PackedFile *pf);
62
63 /* info */
64 int countPackedFiles(struct Main *bmain);
65 int checkPackedFile(const char *filename, struct PackedFile *pf);
66
67 /* read */
68 int seekPackedFile(struct PackedFile *pf, int offset, int whence);
69 void rewindPackedFile(struct PackedFile *pf);
70 int readPackedFile(struct PackedFile *pf, void *data, int size);
71
72 #endif
73