ucx/buffer.h

Wed, 10 Oct 2012 09:54:57 +0200

author
Mike Becker <universe@uap-core.de>
date
Wed, 10 Oct 2012 09:54:57 +0200
changeset 60
abae4669fba7
parent 58
ucx/memstream.h@733f22fca61a
child 61
fb07a0ab9a17
permissions
-rw-r--r--

renamed UcxMemstream to UcxBuffer

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

mercurial