xref: /illumos-gate/usr/src/lib/libmail/inc/s_string.h (revision d87d03b4)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*	Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T	*/
23 /*	  All Rights Reserved  	*/
24 
25 
26 /*
27  * Copyright (c) 1999, by Sun Microsystems, Inc.
28  * All rights reserved.
29  */
30 
31 /* This is a private header file.				*/
32 
33 /* extensible strings */
34 
35 #ifndef _S_STRING_H
36 #define	_S_STRING_H
37 
38 #include <string.h>
39 
40 typedef struct string {
41 	char *base;	/* base of string */
42 	char *end;	/* end of allocated space+1 */
43 	char *ptr;	/* ptr into string */
44 } string;
45 
46 /*
47  * LINT:  expect lint warnings from the following macros
48  * Some macros have an integer at the end, which has null effect according
49  * to lint, but causes the last expression to be evaluated as an int (didn't
50  * change this).
51  */
52 #define	s_clone(s)	s_copy((s)->ptr)
53 #define	s_curlen(s)	((s)->ptr - (s)->base)
54 #define	s_dup(s)	s_copy((s)->base)
55 #define	s_getc(s)	(*((s)->ptr++))
56 #define	s_peek(s)	(*((s)->ptr))
57 #define	s_putc(s, c)	(((s)->ptr < (s)->end) ? \
58 	(*((s)->ptr)++ = (char)(c)) : s_grow((s), (c)))
59 #define	s_reset(s)	((s) ? (*((s)->ptr = (s)->base) = '\0', (s)) : s_new())
60 #define	s_restart(s)	((s)->ptr = (s)->base)
61 #define	s_skipc(s)	((s)->ptr++)
62 #define	s_space(s)	((s)->end - (s)->base)
63 #define	s_terminate(s)  (((s)->ptr < (s)->end) ? \
64 	(*(s)->ptr = 0) : (s_grow((s), 0), (s)->ptr--, 0))
65 #define	s_to_c(s)	((s)->base)
66 #define	s_ptr_to_c(s)	((s)->ptr)
67 
68 #ifdef __STDC__
69 extern string *s_append(string *to, char *from);
70 extern string *s_array(char *, size_t len);
71 extern string *s_copy(char *);
72 extern void s_free(string *);
73 extern int s_grow(string *sp, int c);
74 extern string *s_new(void);
75 extern string *s_parse(string *from, string *to);
76 extern char *s_read_line(FILE *fp, string *to);
77 extern size_t s_read_to_eof(FILE *fp, string *to);
78 extern string *s_seq_read(FILE *fp, string *to, int lineortoken);
79 extern void s_skipwhite(string *from);
80 extern string *s_tok(string *, char *);
81 extern void s_tolower(string *);
82 #else
83 extern string *s_append();
84 extern string *s_array();
85 extern string *s_copy();
86 extern void s_free();
87 extern int s_grow();
88 extern string *s_new();
89 extern string *s_parse();
90 extern char *s_read_line();
91 extern size_t s_read_to_eof();
92 extern string *s_seq_read();
93 extern void s_skipwhite();
94 extern string *s_tok();
95 extern void s_tolower();
96 #endif
97 
98 /* controlling the action of s_seq_read */
99 #define	TOKEN 0		/* read the next whitespace delimited token */
100 #define	LINE 1		/* read the next logical input line */
101 #define	s_getline(a, b) s_seq_read(a, b, LINE)
102 #define	s_gettoken(a, b) s_seq_read(a, b, TOKEN)
103 
104 #endif /* _S_STRING_H */
105