1 /* $Id: vis_compat.h,v 1.9 2013/04/24 21:44:44 karls Exp $ */
2 #if HAVE_STRVIS
3 #include <vis.h>
4 #else
5 /*	$OpenBSD: vis.h,v 1.11 2005/08/09 19:38:31 millert Exp $	*/
6 /*	$NetBSD: vis.h,v 1.4 1994/10/26 00:56:41 cgd Exp $	*/
7 
8 /*-
9  * Copyright (c) 1990 The Regents of the University of California.
10  * All rights reserved.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	@(#)vis.h	5.9 (Berkeley) 4/3/91
37  */
38 
39 #ifndef _VIS_H_
40 #define	_VIS_H_
41 
42 /*
43  * to select alternate encoding format
44  */
45 #define	VIS_OCTAL	0x01	/* use octal \ddd format */
46 #define	VIS_CSTYLE	0x02	/* use \[nrft0..] where appropriate */
47 
48 /*
49  * to alter set of characters encoded (default is to encode all
50  * non-graphic except space, tab, and newline).
51  */
52 #define	VIS_SP		0x04	/* also encode space */
53 #define	VIS_TAB		0x08	/* also encode tab */
54 #define	VIS_NL		0x10	/* also encode newline */
55 #define	VIS_WHITE	(VIS_SP | VIS_TAB | VIS_NL)
56 #define	VIS_SAFE	0x20	/* only encode "unsafe" characters */
57 
58 /*
59  * other
60  */
61 #define	VIS_NOSLASH	0x40	/* inhibit printing '\' */
62 #define	VIS_GLOB	0x100	/* encode glob(3) magics and '#' */
63 
64 /*
65  * unvis return codes
66  */
67 #define	UNVIS_VALID	 1	/* character valid */
68 #define	UNVIS_VALIDPUSH	 2	/* character valid, push back passed char */
69 #define	UNVIS_NOCHAR	 3	/* valid sequence, no character produced */
70 #define	UNVIS_SYNBAD	-1	/* unrecognized escape sequence */
71 #define	UNVIS_ERROR	-2	/* decoder in unknown state (unrecoverable) */
72 
73 /*
74  * unvis flags
75  */
76 #define	UNVIS_END	1	/* no more characters */
77 
78 #if 0
79 #include <sys/cdefs.h>
80 __BEGIN_DECLS
81 #endif
82 
83 char	*vis(char *, int, int, int);
84 int	strvis(char *, const char *, int);
85 int	strnvis(char *, const char *, size_t, int)
86 		__ATTRIBUTE__ ((__BOUNDED__(__string__,1,3)));
87 int	strvisx(char *, const char *, size_t, int)
88 		__ATTRIBUTE__ ((__BOUNDED__(__string__,1,3)));
89 int	strunvis(char *, const char *);
90 #if 0 /* only vis and strvis,strvisx included */
91 int	unvis(char *, char, int *, int);
92 ssize_t strnunvis(char *, const char *, size_t)
93 		__ATTRIBUTE__ ((__BOUNDED__(__string__,1,3)));
94 #endif
95 
96 #if 0
97 __END_DECLS
98 #endif
99 
100 #endif /* !_VIS_H_ */
101 
102 #endif /* !HAVE_STRVIS */
103