RTEMS  5.1
vis.h
1 /* $NetBSD: vis.h,v 1.16 2005/09/13 01:44:32 christos 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 0x01 /* use octal \ddd format */
43 #define VIS_CSTYLE 0x02 /* use \[nrft0..] where appropiate */
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 0x04 /* also encode space */
50 #define VIS_TAB 0x08 /* also encode tab */
51 #define VIS_NL 0x10 /* also encode newline */
52 #define VIS_WHITE (VIS_SP | VIS_TAB | VIS_NL)
53 #define VIS_SAFE 0x20 /* only encode "unsafe" characters */
54 
55 /*
56  * other
57  */
58 #define VIS_NOSLASH 0x40 /* inhibit printing '\' */
59 #define VIS_HTTPSTYLE 0x80 /* http-style escape % HEX HEX */
60 
61 /*
62  * unvis return codes
63  */
64 #define UNVIS_VALID 1 /* character valid */
65 #define UNVIS_VALIDPUSH 2 /* character valid, push back passed char */
66 #define UNVIS_NOCHAR 3 /* valid sequence, no character produced */
67 #define UNVIS_SYNBAD -1 /* unrecognized escape sequence */
68 #define UNVIS_ERROR -2 /* decoder in unknown state (unrecoverable) */
69 
70 /*
71  * unvis flags
72  */
73 #define UNVIS_END 1 /* no more characters */
74 
75 #include <sys/cdefs.h>
76 
77 __BEGIN_DECLS
78 char *vis(char *, int, int, int);
79 char *svis(char *, int, int, int, const char *);
80 int strvis(char *, const char *, int);
81 int strsvis(char *, const char *, int, const char *);
82 int strvisx(char *, const char *, size_t, int);
83 int strsvisx(char *, const char *, size_t, int, const char *);
84 int strunvis(char *, const char *);
85 int strunvisx(char *, const char *, int);
86 #ifndef __LIBC12_SOURCE__
87 //int unvis(char *, int, int *, int) __RENAME(__unvis13);
88 #endif
89 __END_DECLS
90 
91 #endif /* !_VIS_H_ */