Cleanup: move enum unto BKE_packedFile.h
[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 enum ePF_FileStatus {
37   PF_EQUAL = 0,
38   PF_DIFFERS = 1,
39   PF_NOFILE = 2,
40
41   PF_WRITE_ORIGINAL = 3,
42   PF_WRITE_LOCAL = 4,
43   PF_USE_LOCAL = 5,
44   PF_USE_ORIGINAL = 6,
45   PF_KEEP = 7,
46   PF_REMOVE = 8,
47   PF_NOOP = 9,
48
49   PF_ASK = 10,
50 };
51
52 /* pack */
53 struct PackedFile *BKE_packedfile_duplicate(const struct PackedFile *pf_src);
54 struct PackedFile *BKE_packedfile_new(struct ReportList *reports,
55                                       const char *filename,
56                                       const char *relabase);
57 struct PackedFile *BKE_packedfile_new_from_memory(void *mem, int memlen);
58
59 void BKE_packedfile_pack_all(struct Main *bmain, struct ReportList *reports, bool verbose);
60 void BKE_packedfile_pack_all_libraries(struct Main *bmain, struct ReportList *reports);
61
62 /* unpack */
63 char *BKE_packedfile_unpack_to_file(struct ReportList *reports,
64                                     const char *ref_file_name,
65                                     const char *abs_name,
66                                     const char *local_name,
67                                     struct PackedFile *pf,
68                                     enum ePF_FileStatus how);
69 int BKE_packedfile_unpack_vfont(struct Main *bmain,
70                                 struct ReportList *reports,
71                                 struct VFont *vfont,
72                                 enum ePF_FileStatus how);
73 int BKE_packedfile_unpack_sound(struct Main *bmain,
74                                 struct ReportList *reports,
75                                 struct bSound *sound,
76                                 enum ePF_FileStatus how);
77 int BKE_packedfile_unpack_image(struct Main *bmain,
78                                 struct ReportList *reports,
79                                 struct Image *ima,
80                                 enum ePF_FileStatus how);
81 void BKE_packedfile_unpack_all(struct Main *bmain,
82                                struct ReportList *reports,
83                                enum ePF_FileStatus how);
84 int BKE_packedfile_unpack_all_libraries(struct Main *bmain, struct ReportList *reports);
85
86 int BKE_packedfile_write_to_file(struct ReportList *reports,
87                                  const char *ref_file_name,
88                                  const char *filename,
89                                  struct PackedFile *pf,
90                                  const bool guimode);
91
92 /* free */
93 void BKE_packedfile_free(struct PackedFile *pf);
94
95 /* info */
96 int BKE_packedfile_count_all(struct Main *bmain);
97 int BKE_packedfile_compare_to_file(const char *ref_file_name,
98                                    const char *filename,
99                                    struct PackedFile *pf);
100
101 /* read */
102 int BKE_packedfile_seek(struct PackedFile *pf, int offset, int whence);
103 void BKE_packedfile_rewind(struct PackedFile *pf);
104 int BKE_packedfile_read(struct PackedFile *pf, void *data, int size);
105
106 /* ID should be not NULL, return 1 if there's a packed file */
107 bool BKE_packedfile_id_check(struct ID *id);
108 /* ID should be not NULL, throws error when ID is Library */
109 void BKE_packedfile_id_unpack(struct Main *bmain,
110                               struct ID *id,
111                               struct ReportList *reports,
112                               enum ePF_FileStatus how);
113
114 #endif