iobuffer/iobuffer.h at main · Stepainpy/iobuffer · GitHub

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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/* * * * * * * * * * * * * * * * * * * * * *
 * Dynamic buffer with API like as std IO. *
 * Support standard C89 and later.         *
 * * * * * * * * For example * * * * * * * *
 *        fwrite -> write to  file         *
 *        bwrite -> write to buffer        *
 * * * * * * * * * * * * * * * * * * * * * */

#ifndef IO_DYNAMIC_BUFFER_H
#define IO_DYNAMIC_BUFFER_H

#include <stdarg.h>
#include <stddef.h>

/* =========== Version macros ============ */

#define __btostr_(x) # x
#define __btostr(x) __btostr_(x)

#define IOBUFFER_VERSION_MAJOR 2
#define IOBUFFER_VERSION_MINOR 1
#define IOBUFFER_VERSION_PATCH 3
#define IOBUFFER_VERSION \
    __btostr(IOBUFFER_VERSION_MAJOR) "." \
    __btostr(IOBUFFER_VERSION_MINOR) "." \
    __btostr(IOBUFFER_VERSION_PATCH)

/* ======= Preprocessor conditions ======= */

#if __STDC_VERSION__ < 199901L
#  define restrict __restrict
#endif

#ifdef __GNUC__
#  define __battrformat(va_i) __attribute__((format(printf, 2, va_i)))
#  ifdef __clang__
#    define __battrmalloc __attribute__((malloc))
#  else
#    define __battrmalloc __attribute__((malloc, malloc(bclose, 1)))
#  endif
#else
#  define __battrformat(va_i)
#  define __battrmalloc
#endif

#ifdef IOBUFFER_AS_DLL
#  ifdef IOBUFFER_SOURCE
#    define IOBUFFER_API __declspec(dllexport)
#  else
#    define IOBUFFER_API __declspec(dllimport)
#  endif
#else
#  define IOBUFFER_API extern
#endif

#ifdef __cplusplus
extern "C" {
#endif

/* =========== Macro constants =========== */

#define EOB (-1)
#define BSEEK_SET 0
#define BSEEK_CUR 1
#define BSEEK_END 2

/* ================ Types ================ */

typedef struct BUFFER BUFFER;
typedef size_t bpos_t;
typedef void* (*balloc_t)(void* ptr, size_t size, void* userdata);

/* ============= Allocation ============== */

IOBUFFER_API int bsetalloc(balloc_t allocator, void* userdata);

/* ============ Buffer access ============ */

IOBUFFER_API int bclose(BUFFER* buffer);
IOBUFFER_API BUFFER* bopen   (const void* restrict data, size_t size, const char* restrict mode) __battrmalloc;
IOBUFFER_API BUFFER* bmemopen(      void* restrict data, size_t size, const char* restrict mode) __battrmalloc;

/* ======== Operations on buffer ========= */

IOBUFFER_API int berase(BUFFER* buffer, size_t count);
IOBUFFER_API int breset(BUFFER* buffer);

/* ========= Buffer positioning ========== */

IOBUFFER_API int bgetpos(BUFFER* restrict buffer,       bpos_t* restrict pos);
IOBUFFER_API int bsetpos(BUFFER*          buffer, const bpos_t*          pos);

IOBUFFER_API long btell(BUFFER* buffer);
IOBUFFER_API int  bseek(BUFFER* buffer, long offset, int origin);

IOBUFFER_API void brewind(BUFFER* buffer);

/* ========= Direct input/output ========= */

IOBUFFER_API size_t bread (      void* restrict data, size_t size, size_t count, BUFFER* restrict buffer);
IOBUFFER_API size_t bwrite(const void* restrict data, size_t size, size_t count, BUFFER* restrict buffer);

/* ====== Unformatted input/output ======= */

IOBUFFER_API int bgetc(BUFFER* buffer);
IOBUFFER_API int bpeek(BUFFER* buffer);
IOBUFFER_API char* bgets(char* restrict str, int count, BUFFER* restrict buffer);

IOBUFFER_API int bputc(int byte, BUFFER* buffer);
IOBUFFER_API int bputs(const char* restrict string, BUFFER* restrict buffer);

IOBUFFER_API int bungetc(int byte, BUFFER* buffer);

/* ======= Formatted input/output ======== */

IOBUFFER_API int  bprintf(BUFFER* restrict buffer, const char* restrict format, ...         ) __battrformat(3);
IOBUFFER_API int vbprintf(BUFFER* restrict buffer, const char* restrict format, va_list list) __battrformat(0);

/* =========== Error handling ============ */

IOBUFFER_API int beob(BUFFER* buffer);

/* =========== View extension ============ */

typedef struct BUFVIEW {
    const void* base;
    const void* head;
    const void* stop;
} BUFVIEW;

IOBUFFER_API BUFVIEW bview(BUFFER* buffer);

#define BV_FMT "%.*s"
#define BV_ARG( view, begin, end) (int)BV_SIZE(view, begin, end), (const char*)(view).begin
#define BV_SIZE(view, begin, end) ((char*)(view).end - (char*)(view).begin)

#ifdef __cplusplus
}
#endif

#endif /* IO_DYNAMIC_BUFFER_H */