]> git.draconx.ca Git - liblbx.git/blob - src/lbx.h
liblbx: Parameterise I/O functions to allow custom streams.
[liblbx.git] / src / lbx.h
1 #ifndef LBX_H_
2 #define LBX_H_
3
4 #include <stdio.h>
5
6 /* Errors */
7 enum {
8         LBX_ESUCCESS,
9         LBX_EMAGIC,
10         LBX_EEOF,
11         LBX_ERANGE,
12         LBX_EFORMAT,
13 };
14 extern int lbx_errno;
15
16 struct lbx_file_ops {
17         size_t (*read)(void *buf, size_t size, void *handle);
18         int    (*seek)(void *handle, long offset, int whence);
19         long   (*tell)(void *handle);
20         int    (*eof) (void *handle);
21 };
22
23 struct lbx_pipe_state {
24         FILE *f;
25         long offset;
26 };
27
28 /* Default I/O operations for ordinary files. */
29 extern const struct lbx_file_ops lbx_default_fops;
30
31 /* I/O operations for un-seekable files (e.g. pipes). */
32 extern const struct lbx_file_ops lbx_pipe_fops;
33
34 /* Opaque */
35 typedef struct lbx_state LBX;
36
37 struct lbx_statbuf {
38         const char *name;
39         size_t size;
40 };
41
42 /* Archive operations */
43 LBX   *lbx_open(void *handle, const struct lbx_file_ops *fops,
44                 int (*destructor)(void *handle), const char *name);
45 LBX   *lbx_fopen(FILE *, const char *);
46 LBX   *lbx_mopen(void *, size_t, const char *);
47 int    lbx_close(LBX *);
48 size_t lbx_numfiles(LBX *);
49
50 /* File operations */
51 int    lbx_stat(LBX *, size_t, struct lbx_statbuf *);
52 size_t lbx_extract(LBX *, size_t, FILE *);
53
54 /* Misc operations */
55 const char *lbx_strerror(void);
56
57 #endif