vis.h revision 324336d1
1/*	$NetBSD: vis.h,v 1.25 2017/04/23 01:57:36 christos Exp $	*/
2/*	$FreeBSD: head/contrib/libc-vis/vis.h 326307 2017-11-28 01:35:28Z brooks $	*/
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#include <sys/types.h>
39
40/*
41 * to select alternate encoding format
42 */
43#define	VIS_OCTAL	0x0001	/* use octal \ddd format */
44#define	VIS_CSTYLE	0x0002	/* 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		0x0004	/* also encode space */
51#define	VIS_TAB		0x0008	/* also encode tab */
52#define	VIS_NL		0x0010	/* also encode newline */
53#define	VIS_WHITE	(VIS_SP | VIS_TAB | VIS_NL)
54#define	VIS_SAFE	0x0020	/* only encode "unsafe" characters */
55#define	VIS_DQ		0x8000	/* also encode double quotes */
56
57/*
58 * other
59 */
60#define	VIS_NOSLASH	0x0040	/* inhibit printing '\' */
61#define	VIS_HTTP1808	0x0080	/* http-style escape % hex hex */
62#define	VIS_HTTPSTYLE	0x0080	/* http-style escape % hex hex */
63#define	VIS_GLOB	0x0100	/* encode glob(3) magic characters */
64#define	VIS_MIMESTYLE	0x0200	/* mime-style escape = HEX HEX */
65#define	VIS_HTTP1866	0x0400	/* http-style &#num; or &string; */
66#define	VIS_NOESCAPE	0x0800	/* don't decode `\' */
67#define	_VIS_END	0x1000	/* for unvis */
68#define	VIS_SHELL	0x2000	/* encode shell special characters [not glob] */
69#define	VIS_META	(VIS_WHITE | VIS_GLOB | VIS_SHELL)
70#define	VIS_NOLOCALE	0x4000	/* encode using the C locale */
71
72/*
73 * unvis return codes
74 */
75#define	UNVIS_VALID	 1	/* character valid */
76#define	UNVIS_VALIDPUSH	 2	/* character valid, push back passed char */
77#define	UNVIS_NOCHAR	 3	/* valid sequence, no character produced */
78#define	UNVIS_SYNBAD	-1	/* unrecognized escape sequence */
79#define	UNVIS_ERROR	-2	/* decoder in unknown state (unrecoverable) */
80
81/*
82 * unvis flags
83 */
84#define	UNVIS_END	_VIS_END	/* no more characters */
85
86#include <sys/cdefs.h>
87
88__BEGIN_DECLS
89char	*vis(char *, int, int, int);
90char	*nvis(char *, size_t, int, int, int);
91
92char	*svis(char *, int, int, int, const char *);
93char	*snvis(char *, size_t, int, int, int, const char *);
94
95int	strvis(char *, const char *, int);
96int	stravis(char **, const char *, int);
97int	strnvis(char *, size_t, const char *, int);
98
99int	strsvis(char *, const char *, int, const char *);
100int	strsnvis(char *, size_t, const char *, int, const char *);
101
102int	strvisx(char *, const char *, size_t, int);
103int	strnvisx(char *, size_t, const char *, size_t, int);
104int 	strenvisx(char *, size_t, const char *, size_t, int, int *);
105
106int	strsvisx(char *, const char *, size_t, int, const char *);
107int	strsnvisx(char *, size_t, const char *, size_t, int, const char *);
108int	strsenvisx(char *, size_t, const char *, size_t , int, const char *,
109    int *);
110
111int	strunvis(char *, const char *);
112int	strnunvis(char *, size_t, const char *);
113
114int	strunvisx(char *, const char *, int);
115int	strnunvisx(char *, size_t, const char *, int);
116
117#ifndef __LIBC12_SOURCE__
118int	unvis(char *, int, int *, int);
119#endif
120__END_DECLS
121
122#endif /* !_VIS_H_ */
123