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