aboutsummaryrefslogtreecommitdiff
path: root/sys/sys/sbuf.h
blob: 995e7450da8cafd2badb627574497f23f121d3a1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*-
 * Copyright (c) 2000 Poul-Henning Kamp and Dag-Erling Codan Smrgrav
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer
 *    in this position and unchanged.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *      $FreeBSD$
 */

#ifndef _SYS_SBUF_H_
#define _SYS_SBUF_H_

/*
 * Structure definition
 */
struct sbuf {
	char		*s_buf;		/* storage buffer */
	struct sbuf	*s_next;        /* next in chain */
	int		 s_size;	/* size of storage buffer */
	int		 s_len;		/* current length of string */
#define SBUF_AUTOEXTEND	0x00000001	/* automatically extend buffer */
#define SBUF_DYNAMIC	0x00010000	/* s_buf must be freed */
#define SBUF_FINISHED	0x00020000	/* set by sbuf_finish() */
#define SBUF_OVERFLOWED	0x00040000	/* sbuf overflowed */
#define SBUF_DYNSTRUCT	0x00080000	/* sbuf must be freed */
	int		 s_flags;	/* flags */
};

__BEGIN_DECLS
/*
 * API functions
 */
struct sbuf	*sbuf_new(struct sbuf *s, char *buf, int length, int flags);
void		 sbuf_clear(struct sbuf *s);
int		 sbuf_setpos(struct sbuf *s, int pos);
int		 sbuf_bcat(struct sbuf *s, const char *str, size_t len);
int		 sbuf_bcpy(struct sbuf *s, const char *str, size_t len);
int		 sbuf_cat(struct sbuf *s, const char *str);
int		 sbuf_cpy(struct sbuf *s, const char *str);
int		 sbuf_printf(struct sbuf *s, const char *fmt, ...) __printflike(2, 3);
int		 sbuf_putc(struct sbuf *s, int c);
int		 sbuf_trim(struct sbuf *s);
int		 sbuf_overflowed(struct sbuf *s);
void		 sbuf_finish(struct sbuf *s);
char		*sbuf_data(struct sbuf *s);
int		 sbuf_len(struct sbuf *s);
void		 sbuf_delete(struct sbuf *s);

#ifdef _KERNEL
struct uio;
struct sbuf	*sbuf_uionew(struct sbuf *s, struct uio *uio, int *error);
int		 sbuf_bcopyin(struct sbuf *s, const void *uaddr, size_t len);
int		 sbuf_copyin(struct sbuf *s, const void *uaddr, size_t len);
#endif
__END_DECLS

#endif