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