[openssh.git] / openbsd-compat / vis.h

/*	$OpenBSD: vis.h,v 1.11 2005/08/09 19:38:31 millert Exp $	*/
/*	$NetBSD: vis.h,v 1.4 1994/10/26 00:56:41 cgd Exp $	*/

/*-
 * Copyright (c) 1990 The Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)vis.h	5.9 (Berkeley) 4/3/91
 */

/* OPENBSD ORIGINAL: include/vis.h */

#include "includes.h"
#if !defined(HAVE_STRNVIS)

#ifndef _VIS_H_
#define	_VIS_H_

#include <sys/types.h>
#include <limits.h>

/*
 * to select alternate encoding format
 */
#define	VIS_OCTAL	0x01	/* use octal \ddd format */
#define	VIS_CSTYLE	0x02	/* use \[nrft0..] where appropriate */

/*
 * to alter set of characters encoded (default is to encode all
 * non-graphic except space, tab, and newline).
 */
#define	VIS_SP		0x04	/* also encode space */
#define	VIS_TAB		0x08	/* also encode tab */
#define	VIS_NL		0x10	/* also encode newline */
#define	VIS_WHITE	(VIS_SP | VIS_TAB | VIS_NL)
#define	VIS_SAFE	0x20	/* only encode "unsafe" characters */

/*
 * other
 */
#define	VIS_NOSLASH	0x40	/* inhibit printing '\' */
#define	VIS_GLOB	0x100	/* encode glob(3) magics and '#' */

/*
 * unvis return codes
 */
#define	UNVIS_VALID	 1	/* character valid */
#define	UNVIS_VALIDPUSH	 2	/* character valid, push back passed char */
#define	UNVIS_NOCHAR	 3	/* valid sequence, no character produced */
#define	UNVIS_SYNBAD	-1	/* unrecognized escape sequence */
#define	UNVIS_ERROR	-2	/* decoder in unknown state (unrecoverable) */

/*
 * unvis flags
 */
#define	UNVIS_END	1	/* no more characters */

char	*vis(char *, int, int, int);
int	strvis(char *, const char *, int);
int	strnvis(char *, const char *, size_t, int)
		__attribute__ ((__bounded__(__string__,1,3)));
int	strvisx(char *, const char *, size_t, int)
		__attribute__ ((__bounded__(__string__,1,3)));
int	strunvis(char *, const char *);
int	unvis(char *, char, int *, int);
ssize_t strnunvis(char *, const char *, size_t)
		__attribute__ ((__bounded__(__string__,1,3)));

#endif /* !_VIS_H_ */

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