ucx: ucx/buffer.h@27e67e725d35 (annotated)

ucx/buffer.h@27e67e725d35 (annotated)

ucx/buffer.h

Thu, 11 Oct 2012 11:42:31 +0200

author: Mike Becker <universe@uap-core.de>
date: Thu, 11 Oct 2012 11:42:31 +0200
changeset 67: 27e67e725d35
parent 64: 16590c9c497c
child 69: fb59270b1de3
permissions: -rw-r--r--

added some qualifiers + removed pointer alias in mergesort

 #ifndef BUFFER_H
 #define	BUFFER_H
 #include <sys/types.h>
 #include <stdio.h>
 #ifdef	__cplusplus
 extern "C" {
 #endif
 #define UCX_BUFFER_DEFAULT      0x00
 #define UCX_BUFFER_AUTOFREE     0x01
 /* the buffer may automatically double its size on write operations */
 #define UCX_BUFFER_AUTOEXTEND   0x02
 /* the user shall not modify values, but may get the latest pointer */
 typedef struct {
     void *space;
     size_t pos;
     size_t size;
     int flags;
 } UcxBuffer;
 /* if space is NULL, new space is allocated and the autofree flag is enforced */
 UcxBuffer *ucx_buffer_new(void *space, size_t length, int flags);
 void ucx_buffer_free(UcxBuffer* buffer);
 /*
  * the autofree flag is enforced for the new buffer
  * if length is zero, the whole remaining buffer shall be extracted
  * the position of the new buffer is set to zero
  */
 UcxBuffer *restrict ucx_buffer_extract(UcxBuffer *restrict src,
         size_t start, size_t length, int flags);
 #define ucx_buffer_clone(src,flags) \
     ucx_buffer_extract(src, 0, 0, flags)
 /*
  * Moves the position of the buffer to a new position relative to whence.
  *
  * SEEK_SET marks the start of the buffer
  * SEEK_CUR marks the current position
  * SEEK_END marks the first 0-byte in the buffer
  *
  * ucx_memseek returns 0 on success and -1 if the new position is beyond the
  * bounds of the allocated buffer. In that case the position of the buffer
  * remains unchanged.
  *
  */
 int ucx_buffer_seek(UcxBuffer *buffer, off_t offset, int whence);
 /*
  * returns non-zero, iff the current buffer position has exceeded the last
  * available byte of the underlying buffer
  *
  */
 int ucx_buffer_eof(UcxBuffer *buffer);
 size_t ucx_bufio(void *d, size_t s, size_t n, UcxBuffer* b, _Bool read);
 /* when autoextend is enabled, ensure you get the latest pointer to the data */
 #define ucx_buffer_write(data, itemsize, nitems, buffer) \
     ucx_bufio(data, itemsize, nitems, buffer, 0)
 #define ucx_buffer_read(data, itemsize, nitems, buffer) \
         ucx_bufio(data, itemsize, nitems, buffer, 1)
 int ucx_buffer_putc(UcxBuffer *b, int c);
 int ucx_buffer_getc(UcxBuffer *b);
 #ifdef	__cplusplus
 }
 #endif
 #endif	/* BUFFER_H */

Mercurial > hg > ucx / annotate

ucx/buffer.h@27e67e725d35 (annotated)

ucx/buffer.h