Annotation of src/include/vis.h, Revision 1.1.1.1
1.1 deraadt 1: /* $NetBSD: vis.h,v 1.4 1994/10/26 00:56:41 cgd Exp $ */
2:
3: /*-
4: * Copyright (c) 1990 The Regents of the University of California.
5: * 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. All advertising materials mentioning features or use of this software
16: * must display the following acknowledgement:
17: * This product includes software developed by the University of
18: * California, Berkeley and its contributors.
19: * 4. Neither the name of the University nor the names of its contributors
20: * may be used to endorse or promote products derived from this software
21: * without specific prior written permission.
22: *
23: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: * SUCH DAMAGE.
34: *
35: * @(#)vis.h 5.9 (Berkeley) 4/3/91
36: */
37:
38: #ifndef _VIS_H_
39: #define _VIS_H_
40:
41: /*
42: * to select alternate encoding format
43: */
44: #define VIS_OCTAL 0x01 /* use octal \ddd format */
45: #define VIS_CSTYLE 0x02 /* use \[nrft0..] where appropiate */
46:
47: /*
48: * to alter set of characters encoded (default is to encode all
49: * non-graphic except space, tab, and newline).
50: */
51: #define VIS_SP 0x04 /* also encode space */
52: #define VIS_TAB 0x08 /* also encode tab */
53: #define VIS_NL 0x10 /* also encode newline */
54: #define VIS_WHITE (VIS_SP | VIS_TAB | VIS_NL)
55: #define VIS_SAFE 0x20 /* only encode "unsafe" characters */
56:
57: /*
58: * other
59: */
60: #define VIS_NOSLASH 0x40 /* inhibit printing '\' */
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:
76: #include <sys/cdefs.h>
77:
78: __BEGIN_DECLS
79: char *vis __P((char *, int, int, int));
80: int strvis __P((char *, const char *, int));
81: int strvisx __P((char *, const char *, size_t, int));
82: int strunvis __P((char *, const char *));
83: int unvis __P((char *, char, int *, int));
84: __END_DECLS
85:
86: #endif /* !_VIS_H_ */