Sun, 01 May 2022 11:44:23 +0200
#170 complete write tests for status quo
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
29 #include "cx/buffer.h"
30 #include "cx/utils.h"
32 #include <stdlib.h>
33 #include <stdio.h>
34 #include <string.h>
35 #include <stdint.h>
37 int cxBufferInit(
38 CxBuffer *buffer,
39 void *space,
40 size_t capacity,
41 CxAllocator const *allocator,
42 int flags
43 ) {
44 buffer->allocator = allocator;
45 buffer->flags = flags;
46 if (!space) {
47 buffer->bytes = cxMalloc(allocator, capacity);
48 if (buffer->bytes == NULL) {
49 return 1;
50 }
51 buffer->flags |= CX_BUFFER_FREE_CONTENTS;
52 } else {
53 buffer->bytes = space;
54 }
55 buffer->capacity = capacity;
56 buffer->size = 0;
57 buffer->pos = 0;
59 buffer->flush_func = NULL;
60 buffer->flush_target = NULL;
61 buffer->flush_blkmax = 0;
62 buffer->flush_blksize = 4096;
63 buffer->flush_threshold = SIZE_MAX;
65 return 0;
66 }
68 void cxBufferDestroy(CxBuffer *buffer) {
69 if ((buffer->flags & CX_BUFFER_FREE_CONTENTS) == CX_BUFFER_FREE_CONTENTS) {
70 cxFree(buffer->allocator, buffer->bytes);
71 }
72 }
74 int cxBufferSeek(
75 CxBuffer *buffer,
76 off_t offset,
77 int whence
78 ) {
79 size_t npos;
80 switch (whence) {
81 case SEEK_CUR:
82 npos = buffer->pos;
83 break;
84 case SEEK_END:
85 npos = buffer->size;
86 break;
87 case SEEK_SET:
88 npos = 0;
89 break;
90 default:
91 return -1;
92 }
94 size_t opos = npos;
95 npos += offset;
97 if ((offset > 0 && npos < opos) || (offset < 0 && npos > opos)) {
98 return -1;
99 }
101 if (npos >= buffer->size) {
102 return -1;
103 } else {
104 buffer->pos = npos;
105 return 0;
106 }
108 }
110 void cxBufferClear(CxBuffer *buffer) {
111 memset(buffer->bytes, 0, buffer->size);
112 buffer->size = 0;
113 buffer->pos = 0;
114 }
116 int cxBufferEof(CxBuffer const *buffer) {
117 return buffer->pos >= buffer->size;
118 }
120 int cxBufferMinimumCapacity(
121 CxBuffer *buffer,
122 size_t newcap
123 ) {
124 if (newcap <= buffer->capacity) {
125 return 0;
126 }
128 if (cxReallocate(buffer->allocator,
129 (void **) &buffer->bytes, newcap) == 0) {
130 buffer->capacity = newcap;
131 return 0;
132 } else {
133 return -1;
134 }
135 }
137 size_t cxBufferWrite(
138 void const *ptr,
139 size_t size,
140 size_t nitems,
141 CxBuffer *buffer
142 ) {
143 // TODO: optimize for special case size == nitems == 1
144 size_t len;
145 if (cx_szmul(size, nitems, &len)) {
146 return 0;
147 }
148 size_t required = buffer->pos + len;
149 if (buffer->pos > required) {
150 return 0;
151 }
153 bool perform_flush = false;
154 if (required > buffer->capacity) {
155 if ((buffer->flags & CX_BUFFER_AUTO_EXTEND) == CX_BUFFER_AUTO_EXTEND && required) {
156 if (buffer->flush_blkmax > 0 && required > buffer->flush_threshold) {
157 perform_flush = true;
158 } else {
159 if (cxBufferMinimumCapacity(buffer, required)) {
160 return 0;
161 }
162 }
163 } else {
164 if (buffer->flush_blkmax > 0) {
165 perform_flush = true;
166 } else {
167 // truncate data to be written, if we can neither extend nor flush
168 len = buffer->capacity - buffer->pos;
169 if (size > 1) {
170 // TODO: this is bugged - it would only discard one element and not as many as required
171 len -= len % size;
172 }
173 nitems = len / size;
174 }
175 }
176 }
178 if (len == 0) {
179 return len;
180 }
182 if (perform_flush) {
183 // TODO: implement flushing
184 // (1) determine how many bytes to flush (use flushmax = blkmax * blksize)
185 // (2) if len is larger than the number computed in (1) we need more flush cycles, compute how many
186 // (3) determine how many bytes from the buffer shall be flushed
187 // (4) if something remains in the buffer, shift the buffer to the left
188 // (4a) if buffer was shifted, append the new data to the buffer
189 // (4b) if the buffer was flushed entirely AND the new data also fits into flushmax,
190 // directly write the new data to the flush sink
191 return 0; // remove this after implementation
192 } else {
193 memcpy(buffer->bytes + buffer->pos, ptr, len);
194 buffer->pos += len;
195 if (buffer->pos > buffer->size) {
196 buffer->size = buffer->pos;
197 }
198 }
200 return nitems;
201 }
203 int cxBufferPut(
204 CxBuffer *buffer,
205 int c
206 ) {
207 c &= 0xFF;
208 unsigned char const ch = c;
209 if (cxBufferWrite(&ch, 1, 1, buffer) == 1) {
210 return c;
211 } else {
212 return EOF;
213 }
214 }
216 size_t cxBufferPutString(
217 CxBuffer *buffer,
218 const char *str
219 ) {
220 return cxBufferWrite(str, 1, strlen(str), buffer);
221 }
223 size_t cxBufferRead(
224 void *ptr,
225 size_t size,
226 size_t nitems,
227 CxBuffer *buffer
228 ) {
229 size_t len;
230 if (cx_szmul(size, nitems, &len)) {
231 return 0;
232 }
233 if (buffer->pos + len > buffer->size) {
234 len = buffer->size - buffer->pos;
235 if (size > 1) len -= len % size;
236 }
238 if (len <= 0) {
239 return len;
240 }
242 memcpy(ptr, buffer->bytes + buffer->pos, len);
243 buffer->pos += len;
245 return len / size;
246 }
248 int cxBufferGet(CxBuffer *buffer) {
249 if (cxBufferEof(buffer)) {
250 return EOF;
251 } else {
252 int c = buffer->bytes[buffer->pos];
253 buffer->pos++;
254 return c;
255 }
256 }
258 int cxBufferShiftLeft(
259 CxBuffer *buffer,
260 size_t shift
261 ) {
262 if (shift >= buffer->size) {
263 buffer->pos = buffer->size = 0;
264 } else {
265 memmove(buffer->bytes, buffer->bytes + shift, buffer->size - shift);
266 buffer->size -= shift;
268 if (buffer->pos >= shift) {
269 buffer->pos -= shift;
270 } else {
271 buffer->pos = 0;
272 }
273 }
274 return 0;
275 }
277 int cxBufferShiftRight(
278 CxBuffer *buffer,
279 size_t shift
280 ) {
281 size_t req_capacity = buffer->size + shift;
282 size_t movebytes;
284 // auto extend buffer, if required and enabled
285 if (buffer->capacity < req_capacity) {
286 if ((buffer->flags & CX_BUFFER_AUTO_EXTEND) == CX_BUFFER_AUTO_EXTEND) {
287 if (cxBufferMinimumCapacity(buffer, req_capacity)) {
288 return 1;
289 }
290 movebytes = buffer->size;
291 } else {
292 movebytes = buffer->capacity - shift;
293 }
294 } else {
295 movebytes = buffer->size;
296 }
298 memmove(buffer->bytes + shift, buffer->bytes, movebytes);
299 buffer->size = shift + movebytes;
301 buffer->pos += shift;
302 if (buffer->pos > buffer->size) {
303 buffer->pos = buffer->size;
304 }
306 return 0;
307 }
309 int cxBufferShift(
310 CxBuffer *buffer,
311 off_t shift
312 ) {
313 if (shift < 0) {
314 return cxBufferShiftLeft(buffer, (size_t) (-shift));
315 } else if (shift > 0) {
316 return cxBufferShiftRight(buffer, (size_t) shift);
317 } else {
318 return 0;
319 }
320 }