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,
39                                  const char *filename,
40                                  const char *relabase);
41 struct PackedFile *newPackedFileMemory(void *mem, int memlen);
42
43 void packAll(struct Main *bmain, struct ReportList *reports, bool verbose);
44 void packLibraries(struct Main *bmain, struct ReportList *reports);
45
46 /* unpack */
47 char *unpackFile(struct ReportList *reports,
48                  const char *ref_file_name,
49                  const char *abs_name,
50                  const char *local_name,
51                  struct PackedFile *pf,
52                  int how);
53 int unpackVFont(struct Main *bmain, 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 Main *bmain, struct ReportList *reports, struct Image *ima, int how);
56 void unpackAll(struct Main *bmain, struct ReportList *reports, int how);
57 int unpackLibraries(struct Main *bmain, struct ReportList *reports);
58
59 int writePackedFile(struct ReportList *reports,
60                     const char *ref_file_name,
61                     const char *filename,
62                     struct PackedFile *pf,
63                     const bool guimode);
64
65 /* free */
66 void freePackedFile(struct PackedFile *pf);
67
68 /* info */
69 int countPackedFiles(struct Main *bmain);
70 int checkPackedFile(const char *ref_file_name, const char *filename, struct PackedFile *pf);
71
72 /* read */
73 int seekPackedFile(struct PackedFile *pf, int offset, int whence);
74 void rewindPackedFile(struct PackedFile *pf);
75 int readPackedFile(struct PackedFile *pf, void *data, int size);
76
77 /* ID should be not NULL, return 1 if there's a packed file */
78 bool BKE_pack_check(struct ID *id);
79 /* ID should be not NULL, throws error when ID is Library */
80 void BKE_unpack_id(struct Main *bmain, struct ID *id, struct ReportList *reports, int how);
81
82 #endif