/*
 * Copyright (C) 2013 by egnite GmbH
 * 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 copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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
 * COPYRIGHT OWNER 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.
 *
 * For additional information see http://www.ethernut.de/
 */

#ifndef _VIS_H_
#define _VIS_H_

/*
 * To select alternate encoding format
 */
#define VIS_OCTAL       0x01 /*!< \brief Use octal \ddd format */
#define VIS_CSTYLE      0x02 /*!< \brief Use \[nrft0..] where appropriate */
#define VIS_HTTPSTYLE   0x80 /*!< \brief HTTP-style escape % HEX HEX */

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

/*
 * Other
 */
#define VIS_NOSLASH 0x40    /*!< \brief Inhibit printing '\' */
#define VIS_GLOB    0x100   /*!< \brief Encode glob(3) magics and '#' */

/*
 * unvis return codes
 */
#define UNVIS_VALID      1  /*!< \brief Character valid */
#define UNVIS_VALIDPUSH  2  /*!< \brief Character valid, push back passed char */
#define UNVIS_NOCHAR     3  /*!< \brief Valid sequence, no character produced */
#define UNVIS_SYNBAD    -1  /*!< \brief Unrecognized escape sequence */
#define UNVIS_ERROR     -2  /*!< \brief Decoder in unknown state (unrecoverable) */

/*
 * unvis flags
 */
#define UNVIS_END   1       /*!< \brief No more characters */

char *vis(char *, int, int, int);
int strvis(char *, const char *, int);
int strnvis(char *, const char *, size_t, int);
int strvisx(char *, const char *, size_t, int);
int strunvis(char *, const char *);
int unvis(char *, int, int *, int);
int strnunvis(char *, const char *, size_t);
int strunvisx(char *, const char *, int);

#endif