include/vis.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*-
  26  * Copyright (c) 1990, 1993
  27  *      The Regents of the University of California.  All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  * 1. Redistributions of source code must retain the above copyright
  33  *    notice, this list of conditions and the following disclaimer.
  34  * 2. Redistributions in binary form must reproduce the above copyright
  35  *    notice, this list of conditions and the following disclaimer in the
  36  *    documentation and/or other materials provided with the distribution.
  37  * 3. All advertising materials mentioning features or use of this software
  38  *    must display the following acknowledgement:
  39  *      This product includes software developed by the University of
  40  *      California, Berkeley and its contributors.
  41  * 4. Neither the name of the University nor the names of its contributors
  42  *    may be used to endorse or promote products derived from this software
  43  *    without specific prior written permission.
  44  *
  45  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  48  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  49  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  55  * SUCH DAMAGE.
  56  *
  57  *      @(#)vis.h       8.1 (Berkeley) 6/2/93
  58  */
  59
  60 #ifndef _VIS_H_
  61 #define _VIS_H_
  62
  63 /*
  64  * to select alternate encoding format
  65  */
  66 #define VIS_OCTAL       0x01    /* use octal \ddd format */
  67 #define VIS_CSTYLE      0x02    /* use \[nrft0..] where appropiate */
  68
  69 /*
  70  * to alter set of characters encoded (default is to encode all
  71  * non-graphic except space, tab, and newline).
  72  */
  73 #define VIS_SP          0x04    /* also encode space */
  74 #define VIS_TAB         0x08    /* also encode tab */
  75 #define VIS_NL          0x10    /* also encode newline */
  76 #define VIS_WHITE       (VIS_SP | VIS_TAB | VIS_NL)
  77 #define VIS_SAFE        0x20    /* only encode "unsafe" characters */
  78
  79 /*
  80  * other
  81  */
  82 #define VIS_NOSLASH     0x40    /* inhibit printing '\' */
  83
  84 /*
  85  * unvis return codes
  86  */
  87 #define UNVIS_VALID      1      /* character valid */
  88 #define UNVIS_VALIDPUSH  2      /* character valid, push back passed char */
  89 #define UNVIS_NOCHAR     3      /* valid sequence, no character produced */
  90 #define UNVIS_SYNBAD    -1      /* unrecognized escape sequence */
  91 #define UNVIS_ERROR     -2      /* decoder in unknown state (unrecoverable) */
  92
  93 /*
  94  * unvis flags
  95  */
  96 #define UNVIS_END       1       /* no more characters */
  97
  98 #include <sys/cdefs.h>
  99
 100 __BEGIN_DECLS
 101 char    *vis __P((char *, int, int, int));
 102 int     strvis __P((char *, const char *, int));
 103 int     strvisx __P((char *, const char *, size_t, int));
 104 int     strunvis __P((char *, const char *));
 105 int     unvis __P((char *, int, int *, int));
 106 __END_DECLS
 107
 108 #endif /* !_VIS_H_ */