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"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#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 cxBufferWriteFunc  ((cx_write_func) cxBufferWrite)
#define cxBufferReadFunc  ((cx_read_func) cxBufferRead)
 
struct cx_buffer_flush_config_s {
    size_t threshold;
    size_t blksize;
    size_t blkmax;
 
    void *target;
 
    cx_write_func wfunc;
};
 
typedef struct cx_buffer_flush_config_s CxBufferFlushConfig;
 
struct cx_buffer_s {
    union {
        char *space;
        unsigned char *bytes;
    };
    const CxAllocator *allocator;
    CxBufferFlushConfig *flush;
    size_t pos;
    size_t capacity;
    size_t size;
    int flags;
};
 
typedef struct cx_buffer_s CxBuffer;
 
cx_attr_nonnull_arg(1)
cx_attr_export
int cxBufferInit(
        CxBuffer *buffer,
        void *space,
        size_t capacity,
        const CxAllocator *allocator,
        int flags
);
 
cx_attr_nonnull
cx_attr_export
int cxBufferEnableFlushing(
    CxBuffer *buffer,
    CxBufferFlushConfig config
);
 
cx_attr_nonnull
cx_attr_export
void cxBufferDestroy(CxBuffer *buffer);
 
cx_attr_export
void cxBufferFree(CxBuffer *buffer);
 
cx_attr_malloc
cx_attr_dealloc(cxBufferFree, 1)
cx_attr_nodiscard
cx_attr_export
CxBuffer *cxBufferCreate(
        void *space,
        size_t capacity,
        const CxAllocator *allocator,
        int flags
);
 
cx_attr_nonnull
cx_attr_export
int cxBufferShift(
        CxBuffer *buffer,
        off_t shift
);
 
cx_attr_nonnull
cx_attr_export
int cxBufferShiftRight(
        CxBuffer *buffer,
        size_t shift
);
 
cx_attr_nonnull
cx_attr_export
int cxBufferShiftLeft(
        CxBuffer *buffer,
        size_t shift
);
 
 
cx_attr_nonnull
cx_attr_export
int cxBufferSeek(
        CxBuffer *buffer,
        off_t offset,
        int whence
);
 
cx_attr_nonnull
cx_attr_export
void cxBufferClear(CxBuffer *buffer);
 
cx_attr_nonnull
cx_attr_export
void cxBufferReset(CxBuffer *buffer);
 
cx_attr_nonnull
cx_attr_nodiscard
cx_attr_export
bool cxBufferEof(const CxBuffer *buffer);
 
 
cx_attr_nonnull
cx_attr_export
int cxBufferMinimumCapacity(
        CxBuffer *buffer,
        size_t capacity
);
 
cx_attr_nonnull
cx_attr_export
size_t cxBufferWrite(
        const void *ptr,
        size_t size,
        size_t nitems,
        CxBuffer *buffer
);
 
cx_attr_nonnull
cx_attr_export
size_t cxBufferAppend(
        const void *ptr,
        size_t size,
        size_t nitems,
        CxBuffer *buffer
);
 
cx_attr_nonnull
cx_attr_export
size_t cxBufferFlush(CxBuffer *buffer);
 
cx_attr_nonnull
cx_attr_export
size_t cxBufferRead(
        void *ptr,
        size_t size,
        size_t nitems,
        CxBuffer *buffer
);
 
cx_attr_nonnull
cx_attr_export
int cxBufferPut(
        CxBuffer *buffer,
        int c
);
 
cx_attr_nonnull
cx_attr_export
int cxBufferTerminate(CxBuffer *buffer);
 
cx_attr_nonnull
cx_attr_cstr_arg(2)
cx_attr_export
size_t cxBufferPutString(
        CxBuffer *buffer,
        const char *str
);
 
cx_attr_nonnull
cx_attr_export
int cxBufferGet(CxBuffer *buffer);
 
#ifdef __cplusplus
}
#endif
 
#endif // UCX_BUFFER_H