ucx/buffer.h@6814aea8462d (annotated)
ucx/buffer.h
Wed, 10 Oct 2012 10:46:20 +0200
- author
- Mike Becker <universe@uap-core.de>
- date
- Wed, 10 Oct 2012 10:46:20 +0200
- changeset 62
- 6814aea8462d
- parent 61
- fb07a0ab9a17
- child 63
- 1d3500806565
- permissions
- -rw-r--r--
added extract function
| 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@56 | 13 | |
| universe@60 | 14 | /* the user shall not modify values */ |
| universe@60 | 15 | typedef struct UcxBuffer UcxBuffer; |
| universe@56 | 16 | |
| universe@61 | 17 | /* if space is NULL, new space is allocated and the autofree flag is enforced */ |
| universe@61 | 18 | UcxBuffer *ucx_buffer_new(void *space, size_t length, int flags); |
| universe@60 | 19 | void ucx_buffer_free(UcxBuffer* buffer); |
| universe@56 | 20 | |
| universe@56 | 21 | /* |
| universe@62 | 22 | * the autofree flag is enforced for the new buffer |
| universe@62 | 23 | * if length is zero, the whole remaining buffer shall be extracted |
| universe@62 | 24 | * the position of the new buffer is set to zero |
| universe@62 | 25 | */ |
| universe@62 | 26 | UcxBuffer *ucx_buffer_extract(UcxBuffer *src, |
| universe@62 | 27 | size_t start, size_t length, int flags); |
| universe@62 | 28 | #define ucx_buffer_clone(src,flags) \ |
| universe@62 | 29 | ucx_buffer_extract(src, 0, 0, flags) |
| universe@62 | 30 | |
| universe@62 | 31 | /* |
| universe@60 | 32 | * Moves the position of the buffer to a new position relative to whence. |
| universe@56 | 33 | * |
| universe@56 | 34 | * SEEK_SET marks the start of the buffer |
| universe@56 | 35 | * SEEK_CUR marks the current position |
| universe@56 | 36 | * SEEK_END marks the first 0-byte in the buffer |
| universe@56 | 37 | * |
| universe@56 | 38 | * ucx_memseek returns 0 on success and -1 if the new position is beyond the |
| universe@60 | 39 | * bounds of the allocated buffer. In that case the position of the buffer |
| universe@56 | 40 | * remains unchanged. |
| universe@56 | 41 | * |
| universe@56 | 42 | */ |
| universe@60 | 43 | int ucx_buffer_seek(UcxBuffer *buffer, off_t offset, int whence); |
| universe@60 | 44 | size_t ucx_buffer_tell(UcxBuffer *buffer); |
| universe@62 | 45 | size_t ucx_buffer_size(UcxBuffer *buffer); |
| universe@62 | 46 | /* returns non-zero, if at least the specified flags are set */ |
| universe@62 | 47 | int ucx_buffer_testflags(UcxBuffer *buffer, int flags); |
| universe@56 | 48 | |
| universe@56 | 49 | /* |
| universe@60 | 50 | * returns non-zero, iff the current buffer position has exceeded the last |
| universe@56 | 51 | * available byte of the underlying buffer |
| universe@56 | 52 | * |
| universe@56 | 53 | */ |
| universe@60 | 54 | int ucx_buffer_eof(UcxBuffer *buffer); |
| universe@56 | 55 | |
| universe@60 | 56 | size_t ucx_bufio(void *d, size_t s, size_t n, UcxBuffer* b, _Bool read); |
| universe@60 | 57 | #define ucx_buffer_write(data, itemsize, nitems, buffer) \ |
| universe@60 | 58 | ucx_bufio(data, itemsize, nitems, buffer, 0) |
| universe@60 | 59 | #define ucx_buffer_read(data, itemsize, nitems, buffer) \ |
| universe@60 | 60 | ucx_bufio(data, itemsize, nitems, buffer, 1) |
| universe@60 | 61 | int ucx_buffer_putc(UcxBuffer *b, int c); |
| universe@60 | 62 | int ucx_buffer_getc(UcxBuffer *b); |
| universe@56 | 63 | |
| universe@56 | 64 | #ifdef __cplusplus |
| universe@56 | 65 | } |
| universe@56 | 66 | #endif |
| universe@56 | 67 | |
| universe@60 | 68 | #endif /* BUFFER_H */ |
| universe@56 | 69 |
