Home | History | Annotate | Line # | Download | only in include
vis.h revision 1.21
      1  1.21  christos /*	$NetBSD: vis.h,v 1.21 2013/02/20 17:01:15 christos Exp $	*/
      2   1.4       cgd 
      3   1.1       cgd /*-
      4   1.9     perry  * Copyright (c) 1990, 1993
      5   1.9     perry  *	The Regents of the University of California.  All rights reserved.
      6   1.1       cgd  *
      7   1.1       cgd  * Redistribution and use in source and binary forms, with or without
      8   1.1       cgd  * modification, are permitted provided that the following conditions
      9   1.1       cgd  * are met:
     10   1.1       cgd  * 1. Redistributions of source code must retain the above copyright
     11   1.1       cgd  *    notice, this list of conditions and the following disclaimer.
     12   1.1       cgd  * 2. Redistributions in binary form must reproduce the above copyright
     13   1.1       cgd  *    notice, this list of conditions and the following disclaimer in the
     14   1.1       cgd  *    documentation and/or other materials provided with the distribution.
     15  1.14       agc  * 3. Neither the name of the University nor the names of its contributors
     16   1.1       cgd  *    may be used to endorse or promote products derived from this software
     17   1.1       cgd  *    without specific prior written permission.
     18   1.1       cgd  *
     19   1.1       cgd  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     20   1.1       cgd  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     21   1.1       cgd  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     22   1.1       cgd  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     23   1.1       cgd  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     24   1.1       cgd  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     25   1.1       cgd  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     26   1.1       cgd  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     27   1.1       cgd  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     28   1.1       cgd  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     29   1.1       cgd  * SUCH DAMAGE.
     30   1.1       cgd  *
     31   1.9     perry  *	@(#)vis.h	8.1 (Berkeley) 6/2/93
     32   1.1       cgd  */
     33   1.1       cgd 
     34   1.1       cgd #ifndef _VIS_H_
     35   1.1       cgd #define	_VIS_H_
     36  1.13     lukem 
     37  1.13     lukem #include <sys/types.h>
     38   1.1       cgd 
     39   1.1       cgd /*
     40   1.1       cgd  * to select alternate encoding format
     41   1.1       cgd  */
     42  1.20  christos #define	VIS_OCTAL	0x0001	/* use octal \ddd format */
     43  1.20  christos #define	VIS_CSTYLE	0x0002	/* 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.20  christos #define	VIS_SP		0x0004	/* also encode space */
     50  1.20  christos #define	VIS_TAB		0x0008	/* also encode tab */
     51  1.20  christos #define	VIS_NL		0x0010	/* also encode newline */
     52   1.1       cgd #define	VIS_WHITE	(VIS_SP | VIS_TAB | VIS_NL)
     53  1.20  christos #define	VIS_SAFE	0x0020	/* only encode "unsafe" characters */
     54   1.1       cgd 
     55   1.1       cgd /*
     56   1.1       cgd  * other
     57   1.1       cgd  */
     58  1.20  christos #define	VIS_NOSLASH	0x0040	/* inhibit printing '\' */
     59  1.20  christos #define	VIS_HTTP1808	0x0080	/* http-style escape % hex hex */
     60  1.20  christos #define	VIS_HTTPSTYLE	0x0080	/* http-style escape % hex hex */
     61  1.20  christos #define	VIS_MIMESTYLE	0x0100	/* mime-style escape = HEX HEX */
     62  1.20  christos #define	VIS_HTTP1866	0x0200	/* http-style &#num; or &string; */
     63  1.20  christos #define	VIS_NOESCAPE	0x0400	/* don't decode `\' */
     64  1.20  christos #define	_VIS_END	0x0800	/* for unvis */
     65  1.20  christos #define	VIS_GLOB	0x1000	/* encode glob(3) magic characters */
     66   1.1       cgd 
     67   1.1       cgd /*
     68   1.1       cgd  * unvis return codes
     69   1.1       cgd  */
     70   1.1       cgd #define	UNVIS_VALID	 1	/* character valid */
     71   1.1       cgd #define	UNVIS_VALIDPUSH	 2	/* character valid, push back passed char */
     72   1.1       cgd #define	UNVIS_NOCHAR	 3	/* valid sequence, no character produced */
     73   1.1       cgd #define	UNVIS_SYNBAD	-1	/* unrecognized escape sequence */
     74   1.1       cgd #define	UNVIS_ERROR	-2	/* decoder in unknown state (unrecoverable) */
     75   1.1       cgd 
     76   1.1       cgd /*
     77   1.1       cgd  * unvis flags
     78   1.1       cgd  */
     79  1.19  christos #define	UNVIS_END	_VIS_END	/* no more characters */
     80   1.1       cgd 
     81   1.1       cgd #include <sys/cdefs.h>
     82   1.1       cgd 
     83   1.1       cgd __BEGIN_DECLS
     84  1.15     perry char	*vis(char *, int, int, int);
     85  1.19  christos char	*nvis(char *, size_t, int, int, int);
     86  1.19  christos 
     87  1.15     perry char	*svis(char *, int, int, int, const char *);
     88  1.19  christos char	*snvis(char *, size_t, int, int, int, const char *);
     89  1.19  christos 
     90  1.15     perry int	strvis(char *, const char *, int);
     91  1.19  christos int	strnvis(char *, size_t, const char *, int);
     92  1.19  christos 
     93  1.15     perry int	strsvis(char *, const char *, int, const char *);
     94  1.19  christos int	strsnvis(char *, size_t, const char *, int, const char *);
     95  1.19  christos 
     96  1.15     perry int	strvisx(char *, const char *, size_t, int);
     97  1.19  christos int	strnvisx(char *, size_t, const char *, size_t, int);
     98  1.21  christos int 	strenvisx(char *, size_t, const char *, size_t, int, int *);
     99  1.19  christos 
    100  1.15     perry int	strsvisx(char *, const char *, size_t, int, const char *);
    101  1.19  christos int	strsnvisx(char *, size_t, const char *, size_t, int, const char *);
    102  1.21  christos int	strsenvisx(char *, size_t, const char *, size_t , int, const char *,
    103  1.21  christos     int *);
    104  1.19  christos 
    105  1.15     perry int	strunvis(char *, const char *);
    106  1.19  christos int	strnunvis(char *, size_t, const char *);
    107  1.19  christos 
    108  1.15     perry int	strunvisx(char *, const char *, int);
    109  1.19  christos int	strnunvisx(char *, size_t, const char *, int);
    110  1.19  christos 
    111  1.16  christos #ifndef __LIBC12_SOURCE__
    112  1.19  christos int	unvis(char *, int, int *, int) __RENAME(__unvis50);
    113   1.7      fvdl #endif
    114   1.1       cgd __END_DECLS
    115   1.1       cgd 
    116   1.1       cgd #endif /* !_VIS_H_ */
    117