vis.h revision 1.1 1 1.1 cgd /*-
2 1.1 cgd * Copyright (c) 1990 The Regents of the University of California.
3 1.1 cgd * All rights reserved.
4 1.1 cgd *
5 1.1 cgd * Redistribution and use in source and binary forms, with or without
6 1.1 cgd * modification, are permitted provided that the following conditions
7 1.1 cgd * are met:
8 1.1 cgd * 1. Redistributions of source code must retain the above copyright
9 1.1 cgd * notice, this list of conditions and the following disclaimer.
10 1.1 cgd * 2. Redistributions in binary form must reproduce the above copyright
11 1.1 cgd * notice, this list of conditions and the following disclaimer in the
12 1.1 cgd * documentation and/or other materials provided with the distribution.
13 1.1 cgd * 3. All advertising materials mentioning features or use of this software
14 1.1 cgd * must display the following acknowledgement:
15 1.1 cgd * This product includes software developed by the University of
16 1.1 cgd * California, Berkeley and its contributors.
17 1.1 cgd * 4. Neither the name of the University nor the names of its contributors
18 1.1 cgd * may be used to endorse or promote products derived from this software
19 1.1 cgd * without specific prior written permission.
20 1.1 cgd *
21 1.1 cgd * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 1.1 cgd * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 1.1 cgd * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 1.1 cgd * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 1.1 cgd * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 1.1 cgd * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 1.1 cgd * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 1.1 cgd * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 1.1 cgd * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 1.1 cgd * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 1.1 cgd * SUCH DAMAGE.
32 1.1 cgd *
33 1.1 cgd * @(#)vis.h 5.9 (Berkeley) 4/3/91
34 1.1 cgd */
35 1.1 cgd
36 1.1 cgd #ifndef _VIS_H_
37 1.1 cgd #define _VIS_H_
38 1.1 cgd
39 1.1 cgd /*
40 1.1 cgd * to select alternate encoding format
41 1.1 cgd */
42 1.1 cgd #define VIS_OCTAL 0x01 /* use octal \ddd format */
43 1.1 cgd #define VIS_CSTYLE 0x02 /* use \[nrft0..] where appropiate */
44 1.1 cgd
45 1.1 cgd /*
46 1.1 cgd * to alter set of characters encoded (default is to encode all
47 1.1 cgd * non-graphic except space, tab, and newline).
48 1.1 cgd */
49 1.1 cgd #define VIS_SP 0x04 /* also encode space */
50 1.1 cgd #define VIS_TAB 0x08 /* also encode tab */
51 1.1 cgd #define VIS_NL 0x10 /* also encode newline */
52 1.1 cgd #define VIS_WHITE (VIS_SP | VIS_TAB | VIS_NL)
53 1.1 cgd #define VIS_SAFE 0x20 /* only encode "unsafe" characters */
54 1.1 cgd
55 1.1 cgd /*
56 1.1 cgd * other
57 1.1 cgd */
58 1.1 cgd #define VIS_NOSLASH 0x40 /* inhibit printing '\' */
59 1.1 cgd
60 1.1 cgd /*
61 1.1 cgd * unvis return codes
62 1.1 cgd */
63 1.1 cgd #define UNVIS_VALID 1 /* character valid */
64 1.1 cgd #define UNVIS_VALIDPUSH 2 /* character valid, push back passed char */
65 1.1 cgd #define UNVIS_NOCHAR 3 /* valid sequence, no character produced */
66 1.1 cgd #define UNVIS_SYNBAD -1 /* unrecognized escape sequence */
67 1.1 cgd #define UNVIS_ERROR -2 /* decoder in unknown state (unrecoverable) */
68 1.1 cgd
69 1.1 cgd /*
70 1.1 cgd * unvis flags
71 1.1 cgd */
72 1.1 cgd #define UNVIS_END 1 /* no more characters */
73 1.1 cgd
74 1.1 cgd #include <sys/cdefs.h>
75 1.1 cgd
76 1.1 cgd __BEGIN_DECLS
77 1.1 cgd char *vis __P((char *, char, int, char));
78 1.1 cgd int strvis __P((char *, const char *, int));
79 1.1 cgd int strvisx __P((char *, const char *, size_t, int));
80 1.1 cgd int strunvis __P((char *, const char *));
81 1.1 cgd int unvis __P((char *, char, int *, int));
82 1.1 cgd __END_DECLS
83 1.1 cgd
84 1.1 cgd #endif /* !_VIS_H_ */
85