Codebase list swi-prolog / fresh-snapshots/main src / pl-zip.h
fresh-snapshots/main

Tree @fresh-snapshots/main (Download .tar.gz)

pl-zip.h @fresh-snapshots/mainraw · history · blame

/*  Part of SWI-Prolog

    Author:        Jan Wielemaker
    E-mail:        J.Wielemaker@vu.nl
    WWW:           http://www.swi-prolog.org
    Copyright (c)  2018, University of Amsterdam
                         VU University Amsterdam
		         CWI, Amsterdam
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

    1. Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.

    2. Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in
       the documentation and/or other materials provided with the
       distribution.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef H_PLZIP_INCLUDED
#define H_PLZIP_INCLUDED 1

#include "minizip/zip.h"
#include "minizip/unzip.h"

typedef enum zipper_state
{ ZIP_IDLE = 0,
  ZIP_SCAN,					/* goto executing */
  ZIP_READ_ENTRY,				/* Entry open for reading */
  ZIP_WRITE_ENTRY,				/* Entry open for writing */
  ZIP_CLOSE,					/* Close called */
  ZIP_END = -1					/* end of list */
} zipper_state;

typedef enum zipper_input
{ ZIP_FILE,
  ZIP_STREAM,
  ZIP_MEMORY
} zipper_input;

/* flags */
#define ZIP_RELEASE_ON_CLOSE		0x0001
#define ZIP_CLOSE_STREAM_ON_CLOSE	0x0002

typedef struct zipper
{ atom_t	 symbol;			/* <zipper>(address) blob */
  zipFile	 writer;			/* zip.h zipper */
  unzFile	 reader;			/* unzip.h unzipper */
  union
  { IOSTREAM   *stream;
    struct mem_stream *memory;
    void       *any;
  } input;
  const char    *path;
  zipper_input	 input_type;
  zipper_state	 state;
  unsigned int	 flags;
  int		 owner;				/* owning thread id */
  int		 lock_count;			/* times locked */
#ifdef O_PLMT
  simpleMutex    lock;				/* basic lock */
#endif
} zipper;

#define RC_RDONLY	0x01
#define RC_WRONLY	0x02
#define RC_CREATE	0x04
#define RC_TRUNC	0x08
#define RC_RDWR		(RC_RDONLY|RC_WRONLY)

extern int rc_errno;

COMMON(zipper *)	zip_open_archive(const char *file, int flags);
COMMON(zipper *)	zip_open_archive_mem(const unsigned char *mem,
					     size_t mem_size, int flags);

COMMON(int)		zip_close_archive(zipper *z);
COMMON(IOSTREAM *)	SopenZIP(zipper *z, const char *name, int flags);
COMMON(char *)		rc_strerror(int);
COMMON(const char *)    zipper_file(const zipper *z);

#endif /*H_PLZIP_INCLUDED*/