1/* $OpenBSD: vis.h,v 1.15 2015/07/20 01:52:27 millert Exp $ */
2/* $NetBSD: vis.h,v 1.4 1994/10/26 00:56:41 cgd Exp $ */
3
4/*-
5 * Copyright (c) 1990 The Regents of the University of California.
6 * 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 5.9 (Berkeley) 4/3/91
33 */
34
35#ifndef _VIS_H_
36#define _VIS_H_
37
38/*
39 * to select alternate encoding format
40 */
41#define VIS_OCTAL 0x01 /* use octal \ddd format */
42#define VIS_CSTYLE 0x02 /* use \[nrft0..] where appropriate */
43
44/*
45 * to alter set of characters encoded (default is to encode all
46 * non-graphic except space, tab, and newline).
47 */
48#define VIS_SP 0x04 /* also encode space */
49#define VIS_TAB 0x08 /* also encode tab */
50#define VIS_NL 0x10 /* also encode newline */
51#define VIS_WHITE (VIS_SP | VIS_TAB | VIS_NL)
52#define VIS_SAFE 0x20 /* only encode "unsafe" characters */
53#define VIS_DQ 0x200 /* backslash-escape double quotes */
54#define VIS_ALL 0x400 /* encode all characters */
55
56/*
57 * other
58 */
59#define VIS_NOSLASH 0x40 /* inhibit printing '\' */
60#define VIS_GLOB 0x100 /* encode glob(3) magics and '#' */
61
62/*
63 * unvis return codes
64 */
65#define UNVIS_VALID 1 /* character valid */
66#define UNVIS_VALIDPUSH 2 /* character valid, push back passed char */
67#define UNVIS_NOCHAR 3 /* valid sequence, no character produced */
68#define UNVIS_SYNBAD -1 /* unrecognized escape sequence */
69#define UNVIS_ERROR -2 /* decoder in unknown state (unrecoverable) */
70
71/*
72 * unvis flags
73 */
74#define UNVIS_END 1 /* no more characters */
75
76char *vis(char *, int, int, int);
77int strvis(char *, const char *, int);
78int stravis(char **, const char *, int);
79int strnvis(char *, const char *, size_t, int);
80int strvisx(char *, const char *, size_t, int);
81int strunvis(char *, const char *);
82int unvis(char *, char, int *, int);
83ssize_t strnunvis(char *, const char *, size_t);
84
85#endif /* !_VIS_H_ */
86