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