Tue, 16 Jan 2024 23:13:01 +0100
add cx_sprintf() variants - fixes #353
universe@483 | 1 | /* |
universe@483 | 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
universe@483 | 3 | * |
universe@483 | 4 | * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. |
universe@483 | 5 | * |
universe@483 | 6 | * Redistribution and use in source and binary forms, with or without |
universe@483 | 7 | * modification, are permitted provided that the following conditions are met: |
universe@483 | 8 | * |
universe@483 | 9 | * 1. Redistributions of source code must retain the above copyright |
universe@483 | 10 | * notice, this list of conditions and the following disclaimer. |
universe@483 | 11 | * |
universe@483 | 12 | * 2. Redistributions in binary form must reproduce the above copyright |
universe@483 | 13 | * notice, this list of conditions and the following disclaimer in the |
universe@483 | 14 | * documentation and/or other materials provided with the distribution. |
universe@483 | 15 | * |
universe@483 | 16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
universe@483 | 17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
universe@483 | 18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
universe@483 | 19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
universe@483 | 20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
universe@483 | 21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
universe@483 | 22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
universe@483 | 23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
universe@483 | 24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
universe@483 | 25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
universe@483 | 26 | * POSSIBILITY OF SUCH DAMAGE. |
universe@483 | 27 | */ |
universe@483 | 28 | |
universe@483 | 29 | #include "cx/buffer.h" |
universe@483 | 30 | #include "cx/utils.h" |
universe@483 | 31 | |
universe@530 | 32 | #include <stdio.h> |
universe@483 | 33 | #include <string.h> |
universe@483 | 34 | |
universe@501 | 35 | int cxBufferInit( |
universe@501 | 36 | CxBuffer *buffer, |
universe@483 | 37 | void *space, |
universe@483 | 38 | size_t capacity, |
universe@529 | 39 | CxAllocator const *allocator, |
universe@483 | 40 | int flags |
universe@483 | 41 | ) { |
universe@673 | 42 | if (allocator == NULL) allocator = cxDefaultAllocator; |
universe@501 | 43 | buffer->allocator = allocator; |
universe@501 | 44 | buffer->flags = flags; |
universe@501 | 45 | if (!space) { |
universe@501 | 46 | buffer->bytes = cxMalloc(allocator, capacity); |
universe@501 | 47 | if (buffer->bytes == NULL) { |
universe@501 | 48 | return 1; |
universe@483 | 49 | } |
universe@501 | 50 | buffer->flags |= CX_BUFFER_FREE_CONTENTS; |
universe@501 | 51 | } else { |
universe@501 | 52 | buffer->bytes = space; |
universe@501 | 53 | } |
universe@501 | 54 | buffer->capacity = capacity; |
universe@501 | 55 | buffer->size = 0; |
universe@539 | 56 | buffer->pos = 0; |
universe@483 | 57 | |
universe@539 | 58 | buffer->flush_func = NULL; |
universe@541 | 59 | buffer->flush_target = NULL; |
universe@539 | 60 | buffer->flush_blkmax = 0; |
universe@539 | 61 | buffer->flush_blksize = 4096; |
universe@539 | 62 | buffer->flush_threshold = SIZE_MAX; |
universe@483 | 63 | |
universe@501 | 64 | return 0; |
universe@483 | 65 | } |
universe@483 | 66 | |
universe@500 | 67 | void cxBufferDestroy(CxBuffer *buffer) { |
universe@483 | 68 | if ((buffer->flags & CX_BUFFER_FREE_CONTENTS) == CX_BUFFER_FREE_CONTENTS) { |
universe@501 | 69 | cxFree(buffer->allocator, buffer->bytes); |
universe@483 | 70 | } |
universe@483 | 71 | } |
universe@483 | 72 | |
universe@683 | 73 | CxBuffer *cxBufferCreate( |
universe@683 | 74 | void *space, |
universe@683 | 75 | size_t capacity, |
universe@683 | 76 | CxAllocator const *allocator, |
universe@683 | 77 | int flags |
universe@683 | 78 | ) { |
universe@683 | 79 | CxBuffer *buf = cxMalloc(allocator, sizeof(CxBuffer)); |
universe@683 | 80 | if (buf == NULL) return NULL; |
universe@683 | 81 | if (0 == cxBufferInit(buf, space, capacity, allocator, flags)) { |
universe@683 | 82 | return buf; |
universe@683 | 83 | } else { |
universe@683 | 84 | cxFree(allocator, buf); |
universe@683 | 85 | return NULL; |
universe@683 | 86 | } |
universe@683 | 87 | } |
universe@683 | 88 | |
universe@683 | 89 | void cxBufferFree(CxBuffer *buffer) { |
universe@683 | 90 | if ((buffer->flags & CX_BUFFER_FREE_CONTENTS) == CX_BUFFER_FREE_CONTENTS) { |
universe@683 | 91 | cxFree(buffer->allocator, buffer->bytes); |
universe@683 | 92 | } |
universe@683 | 93 | cxFree(buffer->allocator, buffer); |
universe@683 | 94 | } |
universe@683 | 95 | |
universe@483 | 96 | int cxBufferSeek( |
universe@500 | 97 | CxBuffer *buffer, |
universe@483 | 98 | off_t offset, |
universe@483 | 99 | int whence |
universe@483 | 100 | ) { |
universe@483 | 101 | size_t npos; |
universe@483 | 102 | switch (whence) { |
universe@483 | 103 | case SEEK_CUR: |
universe@483 | 104 | npos = buffer->pos; |
universe@483 | 105 | break; |
universe@483 | 106 | case SEEK_END: |
universe@483 | 107 | npos = buffer->size; |
universe@483 | 108 | break; |
universe@483 | 109 | case SEEK_SET: |
universe@483 | 110 | npos = 0; |
universe@483 | 111 | break; |
universe@483 | 112 | default: |
universe@483 | 113 | return -1; |
universe@483 | 114 | } |
universe@483 | 115 | |
universe@483 | 116 | size_t opos = npos; |
universe@483 | 117 | npos += offset; |
universe@483 | 118 | |
universe@483 | 119 | if ((offset > 0 && npos < opos) || (offset < 0 && npos > opos)) { |
universe@483 | 120 | return -1; |
universe@483 | 121 | } |
universe@483 | 122 | |
universe@483 | 123 | if (npos >= buffer->size) { |
universe@483 | 124 | return -1; |
universe@483 | 125 | } else { |
universe@483 | 126 | buffer->pos = npos; |
universe@483 | 127 | return 0; |
universe@483 | 128 | } |
universe@483 | 129 | |
universe@483 | 130 | } |
universe@483 | 131 | |
universe@529 | 132 | void cxBufferClear(CxBuffer *buffer) { |
universe@529 | 133 | memset(buffer->bytes, 0, buffer->size); |
universe@529 | 134 | buffer->size = 0; |
universe@529 | 135 | buffer->pos = 0; |
universe@529 | 136 | } |
universe@529 | 137 | |
universe@761 | 138 | void cxBufferReset(CxBuffer *buffer) { |
universe@761 | 139 | buffer->size = 0; |
universe@761 | 140 | buffer->pos = 0; |
universe@761 | 141 | } |
universe@761 | 142 | |
universe@529 | 143 | int cxBufferEof(CxBuffer const *buffer) { |
universe@483 | 144 | return buffer->pos >= buffer->size; |
universe@483 | 145 | } |
universe@483 | 146 | |
universe@483 | 147 | int cxBufferMinimumCapacity( |
universe@500 | 148 | CxBuffer *buffer, |
universe@532 | 149 | size_t newcap |
universe@483 | 150 | ) { |
universe@532 | 151 | if (newcap <= buffer->capacity) { |
universe@532 | 152 | return 0; |
universe@483 | 153 | } |
universe@483 | 154 | |
universe@536 | 155 | if (cxReallocate(buffer->allocator, |
universe@536 | 156 | (void **) &buffer->bytes, newcap) == 0) { |
universe@483 | 157 | buffer->capacity = newcap; |
universe@533 | 158 | return 0; |
universe@483 | 159 | } else { |
universe@483 | 160 | return -1; |
universe@483 | 161 | } |
universe@483 | 162 | } |
universe@483 | 163 | |
universe@544 | 164 | /** |
universe@544 | 165 | * Helps flushing data to the flush target of a buffer. |
universe@544 | 166 | * |
universe@544 | 167 | * @param buffer the buffer containing the config |
universe@544 | 168 | * @param space the data to flush |
universe@544 | 169 | * @param size the element size |
universe@544 | 170 | * @param nitems the number of items |
universe@544 | 171 | * @return the number of items flushed |
universe@544 | 172 | */ |
universe@544 | 173 | static size_t cx_buffer_write_flush_helper( |
universe@544 | 174 | CxBuffer *buffer, |
universe@544 | 175 | unsigned char const *space, |
universe@544 | 176 | size_t size, |
universe@544 | 177 | size_t nitems |
universe@544 | 178 | ) { |
universe@544 | 179 | size_t pos = 0; |
universe@544 | 180 | size_t remaining = nitems; |
universe@544 | 181 | size_t max_items = buffer->flush_blksize / size; |
universe@544 | 182 | while (remaining > 0) { |
universe@544 | 183 | size_t items = remaining > max_items ? max_items : remaining; |
universe@544 | 184 | size_t flushed = buffer->flush_func( |
universe@544 | 185 | space + pos, |
universe@544 | 186 | size, items, |
universe@544 | 187 | buffer->flush_target); |
universe@544 | 188 | if (flushed > 0) { |
universe@544 | 189 | pos += (flushed * size); |
universe@544 | 190 | remaining -= flushed; |
universe@544 | 191 | } else { |
universe@544 | 192 | // if no bytes can be flushed out anymore, we give up |
universe@544 | 193 | break; |
universe@544 | 194 | } |
universe@544 | 195 | } |
universe@544 | 196 | return nitems - remaining; |
universe@544 | 197 | } |
universe@544 | 198 | |
universe@483 | 199 | size_t cxBufferWrite( |
universe@489 | 200 | void const *ptr, |
universe@483 | 201 | size_t size, |
universe@483 | 202 | size_t nitems, |
universe@500 | 203 | CxBuffer *buffer |
universe@483 | 204 | ) { |
universe@543 | 205 | // optimize for easy case |
universe@543 | 206 | if (size == 1 && (buffer->capacity - buffer->pos) >= nitems) { |
universe@543 | 207 | memcpy(buffer->bytes + buffer->pos, ptr, nitems); |
universe@543 | 208 | buffer->pos += nitems; |
universe@543 | 209 | if (buffer->pos > buffer->size) { |
universe@543 | 210 | buffer->size = buffer->pos; |
universe@543 | 211 | } |
universe@543 | 212 | return nitems; |
universe@543 | 213 | } |
universe@543 | 214 | |
universe@483 | 215 | size_t len; |
universe@544 | 216 | size_t nitems_out = nitems; |
universe@483 | 217 | if (cx_szmul(size, nitems, &len)) { |
universe@483 | 218 | return 0; |
universe@483 | 219 | } |
universe@483 | 220 | size_t required = buffer->pos + len; |
universe@483 | 221 | if (buffer->pos > required) { |
universe@483 | 222 | return 0; |
universe@483 | 223 | } |
universe@483 | 224 | |
universe@539 | 225 | bool perform_flush = false; |
universe@483 | 226 | if (required > buffer->capacity) { |
universe@539 | 227 | if ((buffer->flags & CX_BUFFER_AUTO_EXTEND) == CX_BUFFER_AUTO_EXTEND && required) { |
universe@539 | 228 | if (buffer->flush_blkmax > 0 && required > buffer->flush_threshold) { |
universe@539 | 229 | perform_flush = true; |
universe@539 | 230 | } else { |
universe@539 | 231 | if (cxBufferMinimumCapacity(buffer, required)) { |
universe@539 | 232 | return 0; |
universe@539 | 233 | } |
universe@483 | 234 | } |
universe@483 | 235 | } else { |
universe@539 | 236 | if (buffer->flush_blkmax > 0) { |
universe@539 | 237 | perform_flush = true; |
universe@539 | 238 | } else { |
universe@539 | 239 | // truncate data to be written, if we can neither extend nor flush |
universe@539 | 240 | len = buffer->capacity - buffer->pos; |
universe@539 | 241 | if (size > 1) { |
universe@539 | 242 | len -= len % size; |
universe@539 | 243 | } |
universe@544 | 244 | nitems_out = len / size; |
universe@483 | 245 | } |
universe@483 | 246 | } |
universe@483 | 247 | } |
universe@483 | 248 | |
universe@483 | 249 | if (len == 0) { |
universe@483 | 250 | return len; |
universe@483 | 251 | } |
universe@483 | 252 | |
universe@539 | 253 | if (perform_flush) { |
universe@544 | 254 | size_t flush_max; |
universe@544 | 255 | if (cx_szmul(buffer->flush_blkmax, buffer->flush_blksize, &flush_max)) { |
universe@544 | 256 | return 0; |
universe@544 | 257 | } |
universe@544 | 258 | size_t flush_pos = buffer->flush_func == NULL || buffer->flush_target == NULL |
universe@544 | 259 | ? buffer->pos |
universe@544 | 260 | : cx_buffer_write_flush_helper(buffer, buffer->bytes, 1, buffer->pos); |
universe@544 | 261 | if (flush_pos == buffer->pos) { |
universe@544 | 262 | // entire buffer has been flushed, we can reset |
universe@544 | 263 | buffer->size = buffer->pos = 0; |
universe@544 | 264 | |
universe@544 | 265 | size_t items_flush; // how many items can also be directly flushed |
universe@544 | 266 | size_t items_keep; // how many items have to be written to the buffer |
universe@544 | 267 | |
universe@544 | 268 | items_flush = flush_max >= required ? nitems : (flush_max - flush_pos) / size; |
universe@544 | 269 | if (items_flush > 0) { |
universe@544 | 270 | items_flush = cx_buffer_write_flush_helper(buffer, ptr, size, items_flush / size); |
universe@544 | 271 | // in case we could not flush everything, keep the rest |
universe@544 | 272 | } |
universe@544 | 273 | items_keep = nitems - items_flush; |
universe@544 | 274 | if (items_keep > 0) { |
universe@544 | 275 | // try again with the remaining stuff |
universe@544 | 276 | unsigned char const *new_ptr = ptr; |
universe@544 | 277 | new_ptr += items_flush * size; |
universe@567 | 278 | // report the directly flushed items as written plus the remaining stuff |
universe@567 | 279 | return items_flush + cxBufferWrite(new_ptr, size, items_keep, buffer); |
universe@544 | 280 | } else { |
universe@544 | 281 | // all items have been flushed - report them as written |
universe@544 | 282 | return nitems; |
universe@544 | 283 | } |
universe@544 | 284 | } else if (flush_pos == 0) { |
universe@544 | 285 | // nothing could be flushed at all, we immediately give up without writing any data |
universe@544 | 286 | return 0; |
universe@544 | 287 | } else { |
universe@567 | 288 | // we were partially successful, we shift left and try again |
universe@544 | 289 | cxBufferShiftLeft(buffer, flush_pos); |
universe@544 | 290 | return cxBufferWrite(ptr, size, nitems, buffer); |
universe@544 | 291 | } |
universe@539 | 292 | } else { |
universe@539 | 293 | memcpy(buffer->bytes + buffer->pos, ptr, len); |
universe@539 | 294 | buffer->pos += len; |
universe@539 | 295 | if (buffer->pos > buffer->size) { |
universe@539 | 296 | buffer->size = buffer->pos; |
universe@539 | 297 | } |
universe@544 | 298 | return nitems_out; |
universe@483 | 299 | } |
universe@483 | 300 | |
universe@483 | 301 | } |
universe@483 | 302 | |
universe@538 | 303 | int cxBufferPut( |
universe@538 | 304 | CxBuffer *buffer, |
universe@538 | 305 | int c |
universe@538 | 306 | ) { |
universe@538 | 307 | c &= 0xFF; |
universe@538 | 308 | unsigned char const ch = c; |
universe@538 | 309 | if (cxBufferWrite(&ch, 1, 1, buffer) == 1) { |
universe@538 | 310 | return c; |
universe@538 | 311 | } else { |
universe@538 | 312 | return EOF; |
universe@538 | 313 | } |
universe@538 | 314 | } |
universe@538 | 315 | |
universe@538 | 316 | size_t cxBufferPutString( |
universe@538 | 317 | CxBuffer *buffer, |
universe@538 | 318 | const char *str |
universe@538 | 319 | ) { |
universe@538 | 320 | return cxBufferWrite(str, 1, strlen(str), buffer); |
universe@538 | 321 | } |
universe@538 | 322 | |
universe@483 | 323 | size_t cxBufferRead( |
universe@483 | 324 | void *ptr, |
universe@483 | 325 | size_t size, |
universe@483 | 326 | size_t nitems, |
universe@500 | 327 | CxBuffer *buffer |
universe@483 | 328 | ) { |
universe@483 | 329 | size_t len; |
universe@483 | 330 | if (cx_szmul(size, nitems, &len)) { |
universe@483 | 331 | return 0; |
universe@483 | 332 | } |
universe@483 | 333 | if (buffer->pos + len > buffer->size) { |
universe@483 | 334 | len = buffer->size - buffer->pos; |
universe@483 | 335 | if (size > 1) len -= len % size; |
universe@483 | 336 | } |
universe@483 | 337 | |
universe@483 | 338 | if (len <= 0) { |
universe@483 | 339 | return len; |
universe@483 | 340 | } |
universe@483 | 341 | |
universe@483 | 342 | memcpy(ptr, buffer->bytes + buffer->pos, len); |
universe@483 | 343 | buffer->pos += len; |
universe@483 | 344 | |
universe@483 | 345 | return len / size; |
universe@483 | 346 | } |
universe@483 | 347 | |
universe@500 | 348 | int cxBufferGet(CxBuffer *buffer) { |
universe@483 | 349 | if (cxBufferEof(buffer)) { |
universe@483 | 350 | return EOF; |
universe@483 | 351 | } else { |
universe@483 | 352 | int c = buffer->bytes[buffer->pos]; |
universe@483 | 353 | buffer->pos++; |
universe@483 | 354 | return c; |
universe@483 | 355 | } |
universe@483 | 356 | } |
universe@483 | 357 | |
universe@483 | 358 | int cxBufferShiftLeft( |
universe@500 | 359 | CxBuffer *buffer, |
universe@483 | 360 | size_t shift |
universe@483 | 361 | ) { |
universe@483 | 362 | if (shift >= buffer->size) { |
universe@483 | 363 | buffer->pos = buffer->size = 0; |
universe@483 | 364 | } else { |
universe@483 | 365 | memmove(buffer->bytes, buffer->bytes + shift, buffer->size - shift); |
universe@483 | 366 | buffer->size -= shift; |
universe@483 | 367 | |
universe@483 | 368 | if (buffer->pos >= shift) { |
universe@483 | 369 | buffer->pos -= shift; |
universe@483 | 370 | } else { |
universe@483 | 371 | buffer->pos = 0; |
universe@483 | 372 | } |
universe@483 | 373 | } |
universe@483 | 374 | return 0; |
universe@483 | 375 | } |
universe@483 | 376 | |
universe@483 | 377 | int cxBufferShiftRight( |
universe@500 | 378 | CxBuffer *buffer, |
universe@483 | 379 | size_t shift |
universe@483 | 380 | ) { |
universe@483 | 381 | size_t req_capacity = buffer->size + shift; |
universe@483 | 382 | size_t movebytes; |
universe@483 | 383 | |
universe@483 | 384 | // auto extend buffer, if required and enabled |
universe@483 | 385 | if (buffer->capacity < req_capacity) { |
universe@483 | 386 | if ((buffer->flags & CX_BUFFER_AUTO_EXTEND) == CX_BUFFER_AUTO_EXTEND) { |
universe@483 | 387 | if (cxBufferMinimumCapacity(buffer, req_capacity)) { |
universe@483 | 388 | return 1; |
universe@483 | 389 | } |
universe@483 | 390 | movebytes = buffer->size; |
universe@483 | 391 | } else { |
universe@483 | 392 | movebytes = buffer->capacity - shift; |
universe@483 | 393 | } |
universe@483 | 394 | } else { |
universe@483 | 395 | movebytes = buffer->size; |
universe@483 | 396 | } |
universe@483 | 397 | |
universe@483 | 398 | memmove(buffer->bytes + shift, buffer->bytes, movebytes); |
universe@483 | 399 | buffer->size = shift + movebytes; |
universe@483 | 400 | |
universe@483 | 401 | buffer->pos += shift; |
universe@483 | 402 | if (buffer->pos > buffer->size) { |
universe@483 | 403 | buffer->pos = buffer->size; |
universe@483 | 404 | } |
universe@483 | 405 | |
universe@483 | 406 | return 0; |
universe@483 | 407 | } |
universe@483 | 408 | |
universe@483 | 409 | int cxBufferShift( |
universe@500 | 410 | CxBuffer *buffer, |
universe@483 | 411 | off_t shift |
universe@483 | 412 | ) { |
universe@483 | 413 | if (shift < 0) { |
universe@483 | 414 | return cxBufferShiftLeft(buffer, (size_t) (-shift)); |
universe@483 | 415 | } else if (shift > 0) { |
universe@483 | 416 | return cxBufferShiftRight(buffer, (size_t) shift); |
universe@483 | 417 | } else { |
universe@483 | 418 | return 0; |
universe@483 | 419 | } |
universe@483 | 420 | } |