include/vis.h

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