Annotation of src/usr.bin/cvs/buf.h, Revision 1.1
1.1 ! jfb 1: /* $OpenBSD$ */
! 2: /*
! 3: * Copyright (c) 2003 Jean-Francois Brousseau <jfb@fugusec.net>
! 4: * All rights reserved.
! 5: *
! 6: * Redistribution and use in source and binary forms, with or without
! 7: * modification, are permitted provided that the following conditions
! 8: * are met:
! 9: *
! 10: * 1. Redistributions of source code must retain the above copyright
! 11: * notice, this list of conditions and the following disclaimer.
! 12: * 2. The name of the author may not be used to endorse or promote products
! 13: * derived from this software without specific prior written permission.
! 14: *
! 15: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
! 16: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
! 17: * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
! 18: * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
! 19: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
! 20: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
! 21: * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
! 22: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
! 23: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
! 24: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
! 25: *
! 26: * Buffer management
! 27: * -----------------
! 28: *
! 29: * This code provides an API to generic memory buffer management. All
! 30: * operations are performed on a cvs_buf structure, which is kept opaque to the
! 31: * API user in order to avoid corruption of the fields and make sure that only
! 32: * the internals can modify the fields.
! 33: *
! 34: * The first step is to allocate a new buffer using the cvs_buf_create()
! 35: * function, which returns a pointer to a new buffer.
! 36: */
! 37:
! 38: #ifndef BUF_H
! 39: #define BUF_H
! 40:
! 41: #include <sys/types.h>
! 42:
! 43:
! 44: /* flags */
! 45: #define BUF_AUTOEXT 1 /* autoextend on append */
! 46:
! 47:
! 48: typedef struct cvs_buf BUF;
! 49:
! 50:
! 51: BUF* cvs_buf_alloc (size_t, u_int);
! 52: BUF* cvs_buf_load (const char *, u_int);
! 53: void cvs_buf_free (BUF *);
! 54: void* cvs_buf_release (BUF *);
! 55: void cvs_buf_empty (BUF *);
! 56: ssize_t cvs_buf_copy (BUF *, size_t, void *, size_t);
! 57: int cvs_buf_set (BUF *, const void *, size_t, size_t);
! 58: int cvs_buf_append (BUF *, const void *, size_t);
! 59: int cvs_buf_fappend (BUF *, const char *, ...);
! 60: int cvs_buf_putc (BUF *, int);
! 61: size_t cvs_buf_size (BUF *);
! 62: const void* cvs_buf_peek (BUF *, size_t);
! 63: int cvs_buf_write (BUF *, const char *, mode_t);
! 64:
! 65: #define cvs_buf_get(b) cvs_buf_peek(b, 0)
! 66:
! 67: #endif /* BUF_H */