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
 
typedef struct {
    union {
        char *space;
        unsigned char *bytes;
    };
    CxAllocator const *allocator;
    size_t pos;
    size_t capacity;
    size_t size;
    size_t flush_threshold;
    size_t flush_blksize;
    size_t flush_blkmax;
 
    cx_write_func flush_func;
 
    void *flush_target;
 
    int flags;
} cx_buffer_s;
 
typedef cx_buffer_s CxBuffer;
 
__attribute__((__nonnull__(1)))
int cxBufferInit(
        CxBuffer *buffer,
        void *space,
        size_t capacity,
        CxAllocator const *allocator,
        int flags
);
 
CxBuffer *cxBufferCreate(
        void *space,
        size_t capacity,
        CxAllocator const *allocator,
        int flags
);
 
__attribute__((__nonnull__))
void cxBufferDestroy(CxBuffer *buffer);
 
__attribute__((__nonnull__))
void cxBufferFree(CxBuffer *buffer);
 
__attribute__((__nonnull__))
int cxBufferShift(
        CxBuffer *buffer,
        off_t shift
);
 
__attribute__((__nonnull__))
int cxBufferShiftRight(
        CxBuffer *buffer,
        size_t shift
);
 
__attribute__((__nonnull__))
int cxBufferShiftLeft(
        CxBuffer *buffer,
        size_t shift
);
 
 
__attribute__((__nonnull__))
int cxBufferSeek(
        CxBuffer *buffer,
        off_t offset,
        int whence
);
 
__attribute__((__nonnull__))
void cxBufferClear(CxBuffer *buffer);
 
__attribute__((__nonnull__))
int cxBufferEof(CxBuffer const *buffer);
 
 
__attribute__((__nonnull__))
int cxBufferMinimumCapacity(
        CxBuffer *buffer,
        size_t capacity
);
 
__attribute__((__nonnull__))
size_t cxBufferWrite(
        void const *ptr,
        size_t size,
        size_t nitems,
        CxBuffer *buffer
);
 
__attribute__((__nonnull__))
size_t cxBufferRead(
        void *ptr,
        size_t size,
        size_t nitems,
        CxBuffer *buffer
);
 
__attribute__((__nonnull__))
int cxBufferPut(
        CxBuffer *buffer,
        int c
);
 
__attribute__((__nonnull__))
size_t cxBufferPutString(
        CxBuffer *buffer,
        const char *str
);
 
__attribute__((__nonnull__))
int cxBufferGet(CxBuffer *buffer);
 
#ifdef __cplusplus
}
#endif
 
#endif // UCX_BUFFER_H