ucx: comparison src/cx/buffer.h

-:4fbfac557df8
+:814d51173f20
 * Data is interpreted as binary.
 */
 unsigned char *bytes;
 };
 /** The allocator to use for automatic memory management. */
-CxAllocator *allocator;
+CxAllocator const *allocator;
 /** Current position of the buffer. */
 size_t pos;
 /** Current capacity (i.e. maximum size) of the buffer. */
 size_t capacity;
 /** Current size of the buffer content. */
 * @param capacity the capacity of the buffer
 * @param allocator the allocator this buffer shall use for automatic memory management
 * @param flags buffer features (see cx_buffer_s.flags)
 * @return zero on success, non-zero if a required allocation failed
 */
+__attribute__((__nonnull__(1, 4)))
 int cxBufferInit(
 CxBuffer *buffer,
 void *space,
 size_t capacity,
-CxAllocator *allocator,
+CxAllocator const *allocator,
 int flags
 );
 /**
 * Destroys the buffer contents.
 *
 * Has no effect if the #CX_BUFFER_FREE_CONTENTS feature is not enabled.
 *
 * @param buffer the buffer which contents shall be destroyed
 */
+__attribute__((__nonnull__))
 void cxBufferDestroy(CxBuffer *buffer);
-/**
-* Creates a new buffer and fills it with content copied from another buffer.
-*
-* \note The #CX_BUFFER_FREE_CONTENTS feature is enforced for the new buffer.
-*
-* @param src the source buffer
-* @param start the start position of extraction
-* @param length the count of bytes to extract (must not be zero)
-* @param flags features for the new buffer (#CX_BUFFER_FREE_CONTENTS will always be enabled)
-* @return a new buffer containing the extraction
-*/
-CxBuffer *cxBufferExtract(
-CxBuffer *src,
-size_t start,
-size_t length,
-int flags
-);
-/**
-* A shorthand macro for copying an entire buffer.
-*
-* @param src the source buffer
-* @param flags features for the new buffer (#CX_BUFFER_FREE_CONTENTS will always be enabled)
-* @return a new buffer with the copied content
-*/
-#define cxBufferClone(src, flags) cxBufferExtract(src, 0, (src)->capacity, flags)
 /**
 * Shifts the contents of the buffer by the given offset.
 *
 * If the offset is positive, the contents are shifted to the right.
 *
 * @param buffer the buffer
 * @param shift the shift offset (negative means left shift)
 * @return 0 on success, non-zero if a required auto-extension fails
 */
+__attribute__((__nonnull__))
 int cxBufferShift(
 CxBuffer *buffer,
 off_t shift
 );
 * @param buffer the buffer
 * @param shift the shift offset
 * @return 0 on success, non-zero if a required auto-extension fails
 * @see cxBufferShift()
 */
+__attribute__((__nonnull__))
 int cxBufferShiftRight(
 CxBuffer *buffer,
 size_t shift
 );
 * @param buffer the buffer
 * @param shift the positive shift offset
 * @return always zero
 * @see cxBufferShift()
 */
+__attribute__((__nonnull__))
 int cxBufferShiftLeft(
 CxBuffer *buffer,
 size_t shift
 );
 * @param offset position offset relative to \p whence
 * @param whence one of \c SEEK_SET, \c SEEK_CUR or \c SEEK_END
 * @return 0 on success, non-zero if the position is invalid
 *
 */
+__attribute__((__nonnull__))
 int cxBufferSeek(
 CxBuffer *buffer,
 off_t offset,
 int whence
 );
 *
 * The data is deleted by zeroing it with a call to memset().
 *
 * @param buffer the buffer to be cleared
 */
-#define cxBufferClear(buffer) memset((buffer)->bytes, 0, (buffer)->size); \
+__attribute__((__nonnull__))
-(buffer)->size = 0; (buffer)->pos = 0;
+void cxBufferClear(CxBuffer *buffer);
 /**
 * Tests, if the buffer position has exceeded the buffer capacity.
 *
 * @param buffer the buffer to test
 * @return non-zero, if the current buffer position has exceeded the last
 * available byte of the buffer.
 */
-int cxBufferEof(CxBuffer *buffer);
+__attribute__((__nonnull__))
+int cxBufferEof(CxBuffer const *buffer);
 /**
 * Ensures that the buffer has a minimum capacity.
 *
 *
 * @param buffer the buffer
 * @param capacity the minimum required capacity for this buffer
 * @return 0 on success or a non-zero value on failure
 */
+__attribute__((__nonnull__))
 int cxBufferMinimumCapacity(
 CxBuffer *buffer,
 size_t capacity
 );
 * @param size the length of one element
 * @param nitems the element count
 * @param buffer the CxBuffer to write to
 * @return the total count of bytes written
 */
+__attribute__((__nonnull__))
 size_t cxBufferWrite(
 void const *ptr,
 size_t size,
 size_t nitems,
 CxBuffer *buffer
 * @param size the length of one element
 * @param nitems the element count
 * @param buffer the CxBuffer to read from
 * @return the total number of elements read
 */
+__attribute__((__nonnull__))
 size_t cxBufferRead(
 void *ptr,
 size_t size,
 size_t nitems,
 CxBuffer *buffer
 * @param buffer the buffer to write to
 * @param c the character to write
 * @return the byte that has bean written or \c EOF when the end of the stream is
 * reached and automatic extension is not enabled or not possible
 */
+__attribute__((__nonnull__))
 int cxBufferPut(
 CxBuffer *buffer,
 int c
+);
+/**
+* Writes a string to a buffer.
+*
+* @param buffer the buffer
+* @param str the zero-terminated string
+* @return the number of bytes written
+*/
+__attribute__((__nonnull__))
+size_t cxBufferPutString(
+CxBuffer *buffer,
+const char *str
 );
 /**
 * Gets a character from a buffer.
 *
 * The current position of the buffer is increased after a successful read.
 *
 * @param buffer the buffer to read from
 * @return the character or \c EOF, if the end of the buffer is reached
 */
+__attribute__((__nonnull__))
 int cxBufferGet(CxBuffer *buffer);
-/**
-* Writes a string to a buffer.
-*
-* @param buffer the buffer
-* @param str the zero-terminated string
-* @return the number of bytes written
-*/
-size_t cxBufferPutString(
-CxBuffer *buffer,
-const char *str
-);
 #ifdef __cplusplus
 }
 #endif

Mercurial > hg > ucx / file comparison

comparison: src/cx/buffer.h

src/cx/buffer.h