ncurses 6.2 - patch 20200817
[ncurses.git] / include / unctrl.h.in
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 1998-2001,2009 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
33  ****************************************************************************/
34
35 /*
36  * unctrl.h
37  *
38  * Display a printable version of a control character.
39  * Control characters are displayed in caret notation (^x), DELETE is displayed
40  * as ^?. Printable characters are displayed as is.
41  */
42
43 /* $Id: unctrl.h.in,v 1.12 2020/02/02 23:34:34 tom Exp $ */
44
45 #ifndef NCURSES_UNCTRL_H_incl
46 #define NCURSES_UNCTRL_H_incl   1
47
48 #undef  NCURSES_VERSION
49 #define NCURSES_VERSION "@NCURSES_MAJOR@.@NCURSES_MINOR@"
50
51 #ifdef __cplusplus
52 extern "C" {
53 #endif
54
55 #include <curses.h>
56
57 #undef unctrl
58 NCURSES_EXPORT(NCURSES_CONST char *) unctrl (chtype);
59
60 #if @NCURSES_SP_FUNCS@
61 NCURSES_EXPORT(NCURSES_CONST char *) NCURSES_SP_NAME(unctrl) (SCREEN*, chtype);
62 #endif
63
64 #ifdef __cplusplus
65 }
66 #endif
67
68 #endif /* NCURSES_UNCTRL_H_incl */