pintos-os.org Git - pspp/blob - 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 void zm_dump (const struct zip_member *zm);
  26
  27 /* Create zip reader to read the file called FILENAME.
  28    If ERRS is non-null if will be used to contain any error messages
  29    which the reader wishes to report.
  30  */
  31 struct zip_reader *zip_reader_create (const char *filename, struct string *errs);
  32
  33 /* Destroy the zip reader */
  34 void zip_reader_destroy (struct zip_reader *zr);
  35
  36 /* Return the zip member in the reader ZR, called MEMBER */
  37 struct zip_member *zip_member_open (struct zip_reader *zr, const char *member);
  38
  39 /* Read up to N bytes from ZM, storing them in BUF.
  40    Returns the number of bytes read, or -1 on error */
  41 int zip_member_read (struct zip_member *zm, void *buf, size_t n);
  42
  43 /* Unref (and possibly destroy) the zip member ZM */
  44 void zip_member_unref (struct zip_member *zm);
  45
  46 /* Ref the zip member */
  47 void zip_member_ref (struct zip_member *zm);
  48
  49 void zip_member_finish (struct zip_member *zm);
  50
  51
  52 #endif