vis.h revision 126274 
1/* OPENBSD ORIGINAL: include/vis.h */
2
3/*	$OpenBSD: vis.h,v 1.6 2003/06/02 19:34:12 millert Exp $	*/
4/*	$NetBSD: vis.h,v 1.4 1994/10/26 00:56:41 cgd Exp $	*/
5
6/*-
7 * Copyright (c) 1990 The Regents of the University of California.
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 *	@(#)vis.h	5.9 (Berkeley) 4/3/91
35 */
36
37#include "includes.h"
38#if !defined(HAVE_STRNVIS)
39
40#ifndef _VIS_H_
41#define	_VIS_H_
42
43#include <sys/types.h>
44#include <limits.h>
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 appropriate */
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	*vis(char *, int, int, int);
82int	strvis(char *, const char *, int);
83int	strnvis(char *, const char *, size_t, int);
84int	strvisx(char *, const char *, size_t, int);
85int	strunvis(char *, const char *);
86int	unvis(char *, char, int *, int);
87
88#endif /* !_VIS_H_ */
89
90#endif /* !HAVE_STRNVIS */
91