ucx/buffer.h

Wed, 10 Oct 2012 10:04:01 +0200

author
Mike Becker <universe@uap-core.de>
date
Wed, 10 Oct 2012 10:04:01 +0200
changeset 61
fb07a0ab9a17
parent 60
abae4669fba7
child 62
6814aea8462d
permissions
-rw-r--r--

added flag field to buffer

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

mercurial