• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*	$NetBSD: vis.h,v 1.21 2013/02/20 17:01:15 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1990, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)vis.h	8.1 (Berkeley) 6/2/93
32  */
33 
34 #ifndef _VIS_H_
35 #define	_VIS_H_
36 
37 /*
38  * to select alternate encoding format
39  */
40 #define	VIS_OCTAL	0x0001	/* use octal \ddd format */
41 #define	VIS_CSTYLE	0x0002	/* use \[nrft0..] where appropiate */
42 
43 /*
44  * to alter set of characters encoded (default is to encode all
45  * non-graphic except space, tab, and newline).
46  */
47 #define	VIS_SP		0x0004	/* also encode space */
48 #define	VIS_TAB		0x0008	/* also encode tab */
49 #define	VIS_NL		0x0010	/* also encode newline */
50 #define	VIS_WHITE	(VIS_SP | VIS_TAB | VIS_NL)
51 #define	VIS_SAFE	0x0020	/* only encode "unsafe" characters */
52 
53 /*
54  * other
55  */
56 #define	VIS_NOSLASH	0x0040	/* inhibit printing '\' */
57 #define	VIS_HTTP1808	0x0080	/* http-style escape % hex hex */
58 #define	VIS_HTTPSTYLE	0x0080	/* http-style escape % hex hex */
59 #define	VIS_MIMESTYLE	0x0100	/* mime-style escape = HEX HEX */
60 #define	VIS_HTTP1866	0x0200	/* http-style &#num; or &string; */
61 #define	VIS_NOESCAPE	0x0400	/* don't decode `\' */
62 #define	_VIS_END	0x0800	/* for unvis */
63 #define	VIS_GLOB	0x1000	/* encode glob(3) magic characters */
64 
65 /*
66  * unvis return codes
67  */
68 #define	UNVIS_VALID	 1	/* character valid */
69 #define	UNVIS_VALIDPUSH	 2	/* character valid, push back passed char */
70 #define	UNVIS_NOCHAR	 3	/* valid sequence, no character produced */
71 #define	UNVIS_SYNBAD	-1	/* unrecognized escape sequence */
72 #define	UNVIS_ERROR	-2	/* decoder in unknown state (unrecoverable) */
73 
74 /*
75  * unvis flags
76  */
77 #define	UNVIS_END	_VIS_END	/* no more characters */
78 
79 __BEGIN_DECLS
80 char	*vis(char *, int, int, int);
81 char	*nvis(char *, size_t, int, int, int);
82 
83 char	*svis(char *, int, int, int, const char *);
84 char	*snvis(char *, size_t, int, int, int, const char *);
85 
86 int	strvis(char *, const char *, int);
87 int	strnvis(char *, size_t, const char *, int);
88 
89 int	strsvis(char *, const char *, int, const char *);
90 int	strsnvis(char *, size_t, const char *, int, const char *);
91 
92 int	strvisx(char *, const char *, size_t, int);
93 int	strnvisx(char *, size_t, const char *, size_t, int);
94 int 	strenvisx(char *, size_t, const char *, size_t, int, int *);
95 
96 int	strsvisx(char *, const char *, size_t, int, const char *);
97 int	strsnvisx(char *, size_t, const char *, size_t, int, const char *);
98 int	strsenvisx(char *, size_t, const char *, size_t , int, const char *,
99     int *);
100 
101 int	strunvis(char *, const char *);
102 int	strnunvis(char *, size_t, const char *);
103 
104 int	strunvisx(char *, const char *, int);
105 int	strnunvisx(char *, size_t, const char *, int);
106 
107 #ifndef __LIBC12_SOURCE__
108 int	unvis(char *, int, int *, int);
109 #endif
110 __END_DECLS
111 
112 #endif /* !_VIS_H_ */
113