ucx/buffer.h

Wed, 10 Oct 2012 13:58:51 +0200

author
Mike Becker <universe@uap-core.de>
date
Wed, 10 Oct 2012 13:58:51 +0200
changeset 63
1d3500806565
parent 62
6814aea8462d
child 64
16590c9c497c
permissions
-rw-r--r--

discarded fascism from buffer

universe@60 1 #ifndef BUFFER_H
universe@60 2 #define BUFFER_H
universe@56 3
universe@62 4 #include <sys/types.h>
universe@56 5 #include <stdio.h>
universe@56 6
universe@56 7 #ifdef __cplusplus
universe@56 8 extern "C" {
universe@56 9 #endif
universe@56 10
universe@61 11 #define UCX_BUFFER_DEFAULT 0x00
universe@61 12 #define UCX_BUFFER_AUTOFREE 0x01
universe@63 13 #define UCX_BUFFER_AUTOEXTEND 0x02
universe@56 14
universe@63 15 /* the user shall not modify values, but can get an up to date space pointer */
universe@63 16 typedef struct {
universe@63 17 void *space;
universe@63 18 size_t pos;
universe@63 19 size_t size;
universe@63 20 int flags;
universe@63 21 } UcxBuffer;
universe@56 22
universe@61 23 /* if space is NULL, new space is allocated and the autofree flag is enforced */
universe@61 24 UcxBuffer *ucx_buffer_new(void *space, size_t length, int flags);
universe@60 25 void ucx_buffer_free(UcxBuffer* buffer);
universe@56 26
universe@56 27 /*
universe@62 28 * the autofree flag is enforced for the new buffer
universe@62 29 * if length is zero, the whole remaining buffer shall be extracted
universe@62 30 * the position of the new buffer is set to zero
universe@62 31 */
universe@62 32 UcxBuffer *ucx_buffer_extract(UcxBuffer *src,
universe@62 33 size_t start, size_t length, int flags);
universe@62 34 #define ucx_buffer_clone(src,flags) \
universe@62 35 ucx_buffer_extract(src, 0, 0, flags)
universe@62 36
universe@62 37 /*
universe@60 38 * Moves the position of the buffer to a new position relative to whence.
universe@56 39 *
universe@56 40 * SEEK_SET marks the start of the buffer
universe@56 41 * SEEK_CUR marks the current position
universe@56 42 * SEEK_END marks the first 0-byte in the buffer
universe@56 43 *
universe@56 44 * ucx_memseek returns 0 on success and -1 if the new position is beyond the
universe@60 45 * bounds of the allocated buffer. In that case the position of the buffer
universe@56 46 * remains unchanged.
universe@56 47 *
universe@56 48 */
universe@60 49 int ucx_buffer_seek(UcxBuffer *buffer, off_t offset, int whence);
universe@56 50
universe@56 51 /*
universe@60 52 * returns non-zero, iff the current buffer position has exceeded the last
universe@56 53 * available byte of the underlying buffer
universe@56 54 *
universe@56 55 */
universe@60 56 int ucx_buffer_eof(UcxBuffer *buffer);
universe@56 57
universe@60 58 size_t ucx_bufio(void *d, size_t s, size_t n, UcxBuffer* b, _Bool read);
universe@60 59 #define ucx_buffer_write(data, itemsize, nitems, buffer) \
universe@60 60 ucx_bufio(data, itemsize, nitems, buffer, 0)
universe@60 61 #define ucx_buffer_read(data, itemsize, nitems, buffer) \
universe@60 62 ucx_bufio(data, itemsize, nitems, buffer, 1)
universe@60 63 int ucx_buffer_putc(UcxBuffer *b, int c);
universe@60 64 int ucx_buffer_getc(UcxBuffer *b);
universe@56 65
universe@56 66 #ifdef __cplusplus
universe@56 67 }
universe@56 68 #endif
universe@56 69
universe@60 70 #endif /* BUFFER_H */
universe@56 71

mercurial