1/* $Id: vis.h,v 1.1.1.2 2011/08/17 18:40:06 jmmv Exp $ */
2/*	$OpenBSD: vis.h,v 1.11 2005/08/09 19:38:31 millert Exp $	*/
3/*	$NetBSD: vis.h,v 1.1.1.2 2011/08/17 18:40:06 jmmv Exp $	*/
4
5/*-
6 * Copyright (c) 1990 The Regents of the University of California.
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 * 3. 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 *	@(#)vis.h	5.9 (Berkeley) 4/3/91
34 */
35
36#ifndef _VIS_H_
37#define	_VIS_H_
38
39/*
40 * to select alternate encoding format
41 */
42#define	VIS_OCTAL	0x01	/* use octal \ddd format */
43#define	VIS_CSTYLE	0x02	/* use \[nrft0..] where appropriate */
44
45/*
46 * to alter set of characters encoded (default is to encode all
47 * non-graphic except space, tab, and newline).
48 */
49#define	VIS_SP		0x04	/* also encode space */
50#define	VIS_TAB		0x08	/* also encode tab */
51#define	VIS_NL		0x10	/* also encode newline */
52#define	VIS_WHITE	(VIS_SP | VIS_TAB | VIS_NL)
53#define	VIS_SAFE	0x20	/* only encode "unsafe" characters */
54
55/*
56 * other
57 */
58#define	VIS_NOSLASH	0x40	/* inhibit printing '\' */
59#define	VIS_GLOB	0x100	/* encode glob(3) magics and '#' */
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
75char	*vis(char *, int, int, int);
76int	strvis(char *, const char *, int);
77int	strnvis(char *, const char *, size_t, int);
78int	strvisx(char *, const char *, size_t, int);
79int	strunvis(char *, const char *);
80int	unvis(char *, char, int *, int);
81ssize_t strnunvis(char *, const char *, size_t);
82
83#endif /* !_VIS_H_ */
84