zipc.h 3.31 KB
Newer Older
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
/*
 * Header file for ZIP container mini-library.
 *
 *     https://github.com/michaelrsweet/zipc
 *
 * Copyright 2017 by Michael R Sweet.
 *
 * 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 HOLDER 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 ZIPC_H
#  define ZIPC_H

/*
 * Include necessary headers...
 */

37
#  include <stdlib.h>
38 39 40 41 42 43 44
#  include <sys/types.h>


/*
 * Types...
 */

45 46 47 48
#  ifdef WIN32
typedef long ssize_t;
#  endif /* WIN32 */

49 50 51 52 53 54 55 56
typedef struct _zipc_s zipc_t;		/* ZIP container */
typedef struct _zipc_file_s zipc_file_t;/* File/directory in ZIP container */


/*
 * Functions...
 */

57 58 59 60
#  ifdef __cplusplus
extern "C" {
#  endif /* __cplusplus */

61
extern int		zipcClose(zipc_t *zc);
62
extern int              zipcCopyFile(zipc_t *zc, const char *dstname, const char *srcname, int text, int compressed);
63
extern int		zipcCreateDirectory(zipc_t *zc, const char *filename);
64 65 66 67
extern zipc_file_t	*zipcCreateFile(zipc_t *zc, const char *filename, int compressed);
extern int		zipcCreateFileWithString(zipc_t *zc, const char *filename, const char *contents);
extern const char	*zipcError(zipc_t *zc);
extern int		zipcFileFinish(zipc_file_t *zf);
68
extern int              zipcFileGets(zipc_file_t *zf, char *line, size_t linesize);
69
extern int		zipcFilePrintf(zipc_file_t *zf, const char *format, ...)
70
#  ifdef __GNUC__
71
__attribute__ ((__format__ (__printf__, 2, 3)))
72
#  endif /* __GNUC__ */
73 74
;
extern int		zipcFilePuts(zipc_file_t *zf, const char *s);
75
extern ssize_t		zipcFileRead(zipc_file_t *zf, void *data, size_t bytes);
76
extern int		zipcFileWrite(zipc_file_t *zf, const void *data, size_t bytes);
77
extern int              zipcFileXMLGets(zipc_file_t *zf, char *fragment, size_t fragsize);
78
extern int		zipcFileXMLPrintf(zipc_file_t *zf, const char *format, ...)
79
#  ifdef __GNUC__
80
__attribute__ ((__format__ (__printf__, 2, 3)))
81
#  endif /* __GNUC__ */
82 83
;
extern zipc_t		*zipcOpen(const char *filename, const char *mode);
84 85
extern zipc_file_t      *zipcOpenFile(zipc_t *zc, const char *filename);
extern const char       *zipcXMLGetAttribute(const char *element, const char *attrname, char *buffer, size_t bufsize);
86

87 88 89 90
#  ifdef __cplusplus
}
#  endif /* __cplusplus */

91
#endif /* !ZIPC_H */