1 /*- 2 * Copyright (c) 2000 Poul-Henning Kamp and Dag-Erling Co�dan Sm�rgrav 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer 10 * in this position and unchanged. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 * $FreeBSD: src/sys/sys/sbuf.h,v 1.7.2.2 2002/03/12 01:00:28 archie Exp $ 29 * $DragonFly: src/sys/sys/sbuf.h,v 1.4 2006/05/20 02:42:13 dillon Exp $ 30 */ 31 32 #ifndef _SYS_SBUF_H_ 33 #define _SYS_SBUF_H_ 34 35 #ifndef _SYS_CDEFS_H_ 36 #include <sys/cdefs.h> 37 #endif 38 #ifndef _MACHINE_STDINT_H_ 39 #include <machine/stdint.h> 40 #endif 41 #ifndef _MACHINE_STDARG_H_ 42 #include <machine/stdarg.h> 43 #endif 44 45 /* 46 * Structure definition 47 */ 48 struct sbuf { 49 char *s_buf; /* storage buffer */ 50 void *s_unused; /* binary compatibility. */ 51 int s_size; /* size of storage buffer */ 52 int s_len; /* current length of string */ 53 #define SBUF_FIXEDLEN 0x00000000 /* fixed length buffer (default) */ 54 #define SBUF_AUTOEXTEND 0x00000001 /* automatically extend buffer */ 55 #define SBUF_USRFLAGMSK 0x0000ffff /* mask of flags the user may specify */ 56 #define SBUF_DYNAMIC 0x00010000 /* s_buf must be freed */ 57 #define SBUF_FINISHED 0x00020000 /* set by sbuf_finish() */ 58 #define SBUF_OVERFLOWED 0x00040000 /* sbuf overflowed */ 59 #define SBUF_DYNSTRUCT 0x00080000 /* sbuf must be freed */ 60 int s_flags; /* flags */ 61 }; 62 63 __BEGIN_DECLS 64 /* 65 * API functions 66 */ 67 struct sbuf *sbuf_new(struct sbuf *, char *, int, int); 68 #define sbuf_new_auto() sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND) 69 void sbuf_clear(struct sbuf *); 70 int sbuf_setpos(struct sbuf *, int); 71 int sbuf_bcat(struct sbuf *, const char *, __size_t); 72 int sbuf_bcpy(struct sbuf *, const char *, __size_t); 73 int sbuf_cat(struct sbuf *, const char *); 74 int sbuf_cpy(struct sbuf *, const char *); 75 int sbuf_printf(struct sbuf *, const char *, ...) __printflike(2, 3); 76 int sbuf_vprintf(struct sbuf *, const char *, __va_list) __printflike(2, 0); 77 int sbuf_putc(struct sbuf *, int); 78 int sbuf_trim(struct sbuf *); 79 int sbuf_overflowed(struct sbuf *); 80 void sbuf_finish(struct sbuf *); 81 char *sbuf_data(struct sbuf *); 82 int sbuf_len(struct sbuf *); 83 void sbuf_delete(struct sbuf *); 84 85 #ifdef _KERNEL 86 struct uio; 87 struct sbuf *sbuf_uionew(struct sbuf *, struct uio *, int *); 88 int sbuf_bcopyin(struct sbuf *, const void *, __size_t); 89 int sbuf_copyin(struct sbuf *, const void *, __size_t); 90 #endif 91 __END_DECLS 92 93 #endif 94