zip-reader: Read the whole central directory at .zip open time.
[pspp] / src / libpspp / zip-reader.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2011, 2013 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (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, see <http://www.gnu.org/licenses/>. */
16
17
18 #ifndef ZIP_READER_H
19 #define ZIP_READER_H 1
20
21 struct zip_member;
22 struct zip_reader;
23 struct string;
24
25 /* Create zip reader to read the file called FILENAME.
26    If ERRS is non-null if will be used to contain any error messages
27    which the reader wishes to report.
28  */
29 struct zip_reader *zip_reader_create (const char *filename, struct string *errs);
30
31 /* Destroy the zip reader */
32 void zip_reader_destroy (struct zip_reader *zr);
33
34 /* Return the zip member in the reader ZR, called MEMBER */
35 struct zip_member *zip_member_open (struct zip_reader *zr, const char *member);
36
37 /* Read up to N bytes from ZM, storing them in BUF.
38    Returns the number of bytes read, or -1 on error */
39 int zip_member_read (struct zip_member *zm, void *buf, size_t n);
40
41 void zip_member_finish (struct zip_member *zm);
42
43
44 #endif