summaryrefslogtreecommitdiffstatshomepage
path: root/src/lib/util/unzip.h
blob: fa3956be8c3ae10e4dd814181f2c4015e7a150d4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
// license:BSD-3-Clause
// copyright-holders:Aaron Giles
/***************************************************************************

    unzip.h

    ZIP file management.

***************************************************************************/

#pragma once

#ifndef __UNZIP_H__
#define __UNZIP_H__

#include "osdcore.h"


/***************************************************************************
    CONSTANTS
***************************************************************************/

#define ZIP_DECOMPRESS_BUFSIZE  16384

/* Error types */
enum zip_error
{
	ZIPERR_NONE = 0,
	ZIPERR_OUT_OF_MEMORY,
	ZIPERR_FILE_ERROR,
	ZIPERR_BAD_SIGNATURE,
	ZIPERR_DECOMPRESS_ERROR,
	ZIPERR_FILE_TRUNCATED,
	ZIPERR_FILE_CORRUPT,
	ZIPERR_UNSUPPORTED,
	ZIPERR_BUFFER_TOO_SMALL
};



/***************************************************************************
    TYPE DEFINITIONS
***************************************************************************/

/* contains extracted file header information */
struct zip_file_header
{
	UINT32          signature;              /* central file header signature */
	UINT16          version_created;        /* version made by */
	UINT16          version_needed;         /* version needed to extract */
	UINT16          bit_flag;               /* general purpose bit flag */
	UINT16          compression;            /* compression method */
	UINT16          file_time;              /* last mod file time */
	UINT16          file_date;              /* last mod file date */
	UINT32          crc;                    /* crc-32 */
	UINT32          compressed_length;      /* compressed size */
	UINT32          uncompressed_length;    /* uncompressed size */
	UINT16          filename_length;        /* filename length */
	UINT16          extra_field_length;     /* extra field length */
	UINT16          file_comment_length;    /* file comment length */
	UINT16          start_disk_number;      /* disk number start */
	UINT16          internal_attributes;    /* internal file attributes */
	UINT32          external_attributes;    /* external file attributes */
	UINT32          local_header_offset;    /* relative offset of local header */
	const char *    filename;               /* filename */

	UINT8 *         raw;                    /* pointer to the raw data */
	UINT32          rawlength;              /* length of the raw data */
	UINT8           saved;                  /* saved byte from after filename */
};


/* contains extracted end of central directory information */
struct zip_ecd
{
	UINT32          signature;              /* end of central dir signature */
	UINT16          disk_number;            /* number of this disk */
	UINT16          cd_start_disk_number;   /* number of the disk with the start of the central directory */
	UINT16          cd_disk_entries;        /* total number of entries in the central directory on this disk */
	UINT16          cd_total_entries;       /* total number of entries in the central directory */
	UINT32          cd_size;                /* size of the central directory */
	UINT32          cd_start_disk_offset;   /* offset of start of central directory with respect to the starting disk number */
	UINT16          comment_length;         /* .ZIP file comment length */
	const char *    comment;                /* .ZIP file comment */

	UINT8 *         raw;                    /* pointer to the raw data */
	UINT32          rawlength;              /* length of the raw data */
};


/* describes an open ZIP file */
struct zip_file
{
	const char *    filename;               /* copy of ZIP filename (for caching) */
	osd_file *      file;                   /* OSD file handle */
	UINT64          length;                 /* length of zip file */

	zip_ecd         ecd;                    /* end of central directory */

	UINT8 *         cd;                     /* central directory raw data */
	UINT32          cd_pos;                 /* position in central directory */
	zip_file_header header;                 /* current file header */

	UINT8           buffer[ZIP_DECOMPRESS_BUFSIZE]; /* buffer for decompression */
};



/***************************************************************************
    FUNCTION PROTOTYPES
***************************************************************************/


/* ----- ZIP file access ----- */

/* open a ZIP file and parse its central directory */
zip_error zip_file_open(const char *filename, zip_file **zip);

/* close a ZIP file (may actually be left open due to caching) */
void zip_file_close(zip_file *zip);

/* clear out all open ZIP files from the cache */
void zip_file_cache_clear(void);


/* ----- contained file access ----- */

/* find the first file in the ZIP */
const zip_file_header *zip_file_first_file(zip_file *zip);

/* find the next file in the ZIP */
const zip_file_header *zip_file_next_file(zip_file *zip);

/* decompress the most recently found file in the ZIP */
zip_error zip_file_decompress(zip_file *zip, void *buffer, UINT32 length);


#endif  /* __UNZIP_H__ */