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