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