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