vis.hin revision 178825 
1/*	$NetBSD: vis.h,v 1.11 1999/11/25 16:55:50 wennmach Exp $	*/
2/*	$Id: vis.hin 19341 2006-12-15 11:53:09Z lha $	*/
3
4/*-
5 * Copyright (c) 1990, 1993
6 *	The Regents of the University of California.  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. Neither the name of the University nor the names of its contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 *	@(#)vis.h	8.1 (Berkeley) 6/2/93
33 */
34
35#ifndef _VIS_H_
36#define	_VIS_H_
37
38#ifndef ROKEN_LIB_FUNCTION
39#ifdef _WIN32
40#define ROKEN_LIB_FUNCTION _stdcall
41#else
42#define ROKEN_LIB_FUNCTION
43#endif
44#endif
45
46/*
47 * to select alternate encoding format
48 */
49#define	VIS_OCTAL	0x01	/* use octal \ddd format */
50#define	VIS_CSTYLE	0x02	/* use \[nrft0..] where appropiate */
51
52/*
53 * to alter set of characters encoded (default is to encode all
54 * non-graphic except space, tab, and newline).
55 */
56#define	VIS_SP		0x04	/* also encode space */
57#define	VIS_TAB		0x08	/* also encode tab */
58#define	VIS_NL		0x10	/* also encode newline */
59#define	VIS_WHITE	(VIS_SP | VIS_TAB | VIS_NL)
60#define	VIS_SAFE	0x20	/* only encode "unsafe" characters */
61
62/*
63 * other
64 */
65#define	VIS_NOSLASH	0x40	/* inhibit printing '\' */
66
67/*
68 * unvis return codes
69 */
70#define	UNVIS_VALID	 1	/* character valid */
71#define	UNVIS_VALIDPUSH	 2	/* character valid, push back passed char */
72#define	UNVIS_NOCHAR	 3	/* valid sequence, no character produced */
73#define	UNVIS_SYNBAD	-1	/* unrecognized escape sequence */
74#define	UNVIS_ERROR	-2	/* decoder in unknown state (unrecoverable) */
75
76/*
77 * unvis flags
78 */
79#define	UNVIS_END	1	/* no more characters */
80
81char ROKEN_LIB_FUNCTION
82	*rk_vis (char *, int, int, int);
83char ROKEN_LIB_FUNCTION
84	*rk_svis (char *, int, int, int, const char *);
85int ROKEN_LIB_FUNCTION
86	rk_strvis (char *, const char *, int);
87int ROKEN_LIB_FUNCTION
88	rk_strsvis (char *, const char *, int, const char *);
89int ROKEN_LIB_FUNCTION
90	rk_strvisx (char *, const char *, size_t, int);
91int ROKEN_LIB_FUNCTION
92	rk_strsvisx (char *, const char *, size_t, int, const char *);
93int ROKEN_LIB_FUNCTION
94	rk_strunvis (char *, const char *);
95int ROKEN_LIB_FUNCTION
96	rk_unvis (char *, int, int *, int);
97
98#undef vis
99#define vis(a,b,c,d) rk_vis(a,b,c,d)
100#undef svis
101#define svis(a,b,c,d,e) rk_svis(a,b,c,d,e)
102#undef strvis
103#define strvis(a,b,c) rk_strvis(a,b,c)
104#undef strsvis
105#define strsvis(a,b,c,d) rk_strsvis(a,b,c,d)
106#undef strvisx
107#define strvisx(a,b,c,d) rk_strvisx(a,b,c,d)
108#undef strsvisx
109#define strsvisx(a,b,c,d,e) rk_strsvisx(a,b,c,d,e)
110#undef strunvis
111#define strunvis(a,b) rk_strunvis(a,b)
112#undef unvis
113#define unvis(a,b,c,d) rk_unvis(a,b,c,d)
114
115#endif /* !_VIS_H_ */
116