buffer.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
 *
 * 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 UCX_BUFFER_H
#define UCX_BUFFER_H
 
#include "common.h"
#include "allocator.h"
#include "string.h"

#define CX_BUFFER_DEFAULT 0x00

#define CX_BUFFER_FREE_CONTENTS 0x01

#define CX_BUFFER_AUTO_EXTEND 0x02

#define CX_BUFFER_COPY_ON_WRITE 0x04

#define CX_BUFFER_COPY_ON_EXTEND 0x08

#define CX_BUFFER_DO_NOT_FREE 0x10

#define cxBufferWriteFunc  ((cx_write_func) cxBufferWrite)
#define cxBufferReadFunc  ((cx_read_func) cxBufferRead)
 

struct cx_buffer_s {
    union {
        char *space;
        unsigned char *bytes;
    };
    const CxAllocator *allocator;
    size_t pos;
    size_t capacity;
    size_t max_capacity;
    size_t size;
    int flags;
};

typedef struct cx_buffer_s CxBuffer;

CX_EXTERN CX_NONNULL_ARG(1)
int cxBufferInit(CxBuffer *buffer, const CxAllocator *allocator,
        void *space, size_t capacity, int flags);

CX_EXTERN CX_NONNULL
void cxBufferDestroy(CxBuffer *buffer);

CX_EXTERN
void cxBufferFree(CxBuffer *buffer);

CX_EXTERN CX_MALLOC CX_DEALLOC(cxBufferFree, 1) CX_NODISCARD
CxBuffer *cxBufferCreate(const CxAllocator *allocator, void *space,
                                   size_t capacity, int flags);

CX_EXTERN CX_NONNULL
int cxBufferShift(CxBuffer *buffer, off_t shift);

CX_EXTERN CX_NONNULL
int cxBufferShiftRight(CxBuffer *buffer, size_t shift);

CX_EXTERN CX_NONNULL
int cxBufferShiftLeft(CxBuffer *buffer, size_t shift);
 

CX_EXTERN CX_NONNULL
int cxBufferSeek(CxBuffer *buffer, off_t offset, int whence);

CX_EXTERN CX_NONNULL
size_t cxBufferPop(CxBuffer *buffer, size_t size, size_t nitems);

CX_EXTERN CX_NONNULL
void cxBufferClear(CxBuffer *buffer);

CX_EXTERN CX_NONNULL
void cxBufferReset(CxBuffer *buffer);

CX_EXTERN CX_NONNULL CX_NODISCARD
bool cxBufferEof(const CxBuffer *buffer);

CX_EXTERN CX_NONNULL
int cxBufferReserve(CxBuffer *buffer, size_t capacity);

CX_EXTERN CX_NONNULL
int cxBufferMaximumCapacity(CxBuffer *buffer, size_t capacity);

CX_EXTERN CX_NONNULL
int cxBufferMinimumCapacity(CxBuffer *buffer, size_t capacity);

CX_EXTERN CX_NONNULL
void cxBufferShrink(CxBuffer *buffer, size_t reserve);

CX_EXTERN CX_NONNULL
size_t cxBufferWrite(const void *ptr, size_t size,
        size_t nitems, CxBuffer *buffer);

CX_EXTERN CX_NONNULL
size_t cxBufferAppend(const void *ptr, size_t size,
        size_t nitems, CxBuffer *buffer);

CX_EXTERN CX_NONNULL
size_t cxBufferRead(void *ptr, size_t size,
        size_t nitems, CxBuffer *buffer);

CX_EXTERN CX_NONNULL
int cxBufferPut(CxBuffer *buffer, int c);

CX_EXTERN CX_NONNULL
int cxBufferTerminate(CxBuffer *buffer);

CX_EXTERN CX_NONNULL
size_t cx_buffer_put_string(CxBuffer *buffer, cxstring str);

#define cxBufferPutString(buffer, str) cx_buffer_put_string(buffer, cx_strcast(str))

CX_EXTERN CX_NONNULL
size_t cx_buffer_append_string(CxBuffer *buffer, cxstring str);

#define cxBufferAppendString(buffer, str) cx_buffer_append_string(buffer, cx_strcast(str))

CX_EXTERN CX_NONNULL
int cxBufferGet(CxBuffer *buffer);

CX_NONNULL CX_INLINE
cxstring cx_bstr(CxBuffer *buffer) {
    return cx_strn(buffer->space, buffer->size);
}

CX_NONNULL CX_INLINE
cxmutstr cx_bstr_m(CxBuffer *buffer) {
    return cx_mutstrn(buffer->space, buffer->size);
}
 
#endif // UCX_BUFFER_H