1/*
2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23/*-
24 * Copyright (c) 1990, 1993
25 *	The Regents of the University of California.  All rights reserved.
26 *
27 * Redistribution and use in source and binary forms, with or without
28 * modification, are permitted provided that the following conditions
29 * are met:
30 * 1. Redistributions of source code must retain the above copyright
31 *    notice, this list of conditions and the following disclaimer.
32 * 2. Redistributions in binary form must reproduce the above copyright
33 *    notice, this list of conditions and the following disclaimer in the
34 *    documentation and/or other materials provided with the distribution.
35 * 3. All advertising materials mentioning features or use of this software
36 *    must display the following acknowledgement:
37 *	This product includes software developed by the University of
38 *	California, Berkeley and its contributors.
39 * 4. Neither the name of the University nor the names of its contributors
40 *    may be used to endorse or promote products derived from this software
41 *    without specific prior written permission.
42 *
43 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * SUCH DAMAGE.
54 *
55 *	@(#)vis.h	8.1 (Berkeley) 6/2/93
56 */
57
58#ifndef _VIS_H_
59#define	_VIS_H_
60
61#include <_types.h>
62#include <sys/_types/_size_t.h>
63
64/*
65 * to select alternate encoding format
66 */
67#define	VIS_OCTAL	0x01	/* use octal \ddd format */
68#define	VIS_CSTYLE	0x02	/* use \[nrft0..] where appropriate */
69
70/*
71 * to alter set of characters encoded (default is to encode all
72 * non-graphic except space, tab, and newline).
73 */
74#define	VIS_SP		0x04	/* also encode space */
75#define	VIS_TAB		0x08	/* also encode tab */
76#define	VIS_NL		0x10	/* also encode newline */
77#define	VIS_WHITE	(VIS_SP | VIS_TAB | VIS_NL)
78#define	VIS_SAFE	0x20	/* only encode "unsafe" characters */
79
80/*
81 * other
82 */
83#define	VIS_NOSLASH	0x40	/* inhibit printing '\' */
84#define	VIS_HTTPSTYLE	0x80	/* http-style escape % HEX HEX */
85#define	VIS_GLOB	0x100	/* encode glob(3) magics */
86
87/*
88 * unvis return codes
89 */
90#define	UNVIS_VALID	 1	/* character valid */
91#define	UNVIS_VALIDPUSH	 2	/* character valid, push back passed char */
92#define	UNVIS_NOCHAR	 3	/* valid sequence, no character produced */
93#define	UNVIS_SYNBAD	-1	/* unrecognized escape sequence */
94#define	UNVIS_ERROR	-2	/* decoder in unknown state (unrecoverable) */
95
96/*
97 * unvis flags
98 */
99#define	UNVIS_END	1	/* no more characters */
100
101#include <sys/cdefs.h>
102
103__BEGIN_DECLS
104char	*vis(char *, int, int, int);
105int	strvis(char *, const char *, int);
106int	strvisx(char *, const char *, size_t, int);
107int	strunvis(char *, const char *);
108int	strunvisx(char *, const char *, int);
109int	unvis(char *, int, int *, int);
110__END_DECLS
111
112#endif /* !_VIS_H_ */
113