xref: /freebsd/crypto/openssh/openbsd-compat/vis.h (revision 7660b554bc59a07be0431c17e0e33815818baa69)
1 /*	$OpenBSD: vis.h,v 1.5 2002/02/16 21:27:17 millert Exp $	*/
2 /*	$NetBSD: vis.h,v 1.4 1994/10/26 00:56:41 cgd Exp $	*/
3 
4 /*-
5  * Copyright (c) 1990 The Regents of the University of California.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. 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 #include "config.h"
39 #if !defined(HAVE_STRNVIS)
40 
41 #ifndef _VIS_H_
42 #define	_VIS_H_
43 
44 #include <sys/types.h>
45 #include <limits.h>
46 
47 /*
48  * to select alternate encoding format
49  */
50 #define	VIS_OCTAL	0x01	/* use octal \ddd format */
51 #define	VIS_CSTYLE	0x02	/* use \[nrft0..] where appropriate */
52 
53 /*
54  * to alter set of characters encoded (default is to encode all
55  * non-graphic except space, tab, and newline).
56  */
57 #define	VIS_SP		0x04	/* also encode space */
58 #define	VIS_TAB		0x08	/* also encode tab */
59 #define	VIS_NL		0x10	/* also encode newline */
60 #define	VIS_WHITE	(VIS_SP | VIS_TAB | VIS_NL)
61 #define	VIS_SAFE	0x20	/* only encode "unsafe" characters */
62 
63 /*
64  * other
65  */
66 #define	VIS_NOSLASH	0x40	/* inhibit printing '\' */
67 
68 /*
69  * unvis return codes
70  */
71 #define	UNVIS_VALID	 1	/* character valid */
72 #define	UNVIS_VALIDPUSH	 2	/* character valid, push back passed char */
73 #define	UNVIS_NOCHAR	 3	/* valid sequence, no character produced */
74 #define	UNVIS_SYNBAD	-1	/* unrecognized escape sequence */
75 #define	UNVIS_ERROR	-2	/* decoder in unknown state (unrecoverable) */
76 
77 /*
78  * unvis flags
79  */
80 #define	UNVIS_END	1	/* no more characters */
81 
82 char	*vis(char *, int, int, int);
83 int	strvis(char *, const char *, int);
84 int	strnvis(char *, const char *, size_t, int);
85 int	strvisx(char *, const char *, size_t, int);
86 int	strunvis(char *, const char *);
87 int	unvis(char *, char, int *, int);
88 
89 #endif /* !_VIS_H_ */
90 
91 #endif /* !HAVE_STRNVIS */
92