xref: /illumos-gate/usr/src/lib/libtecla/common/getline.h (revision 1da57d551424de5a9d469760be7c4b4d4f10a755)
1 #ifndef getline_h
2 #define getline_h
3 
4 /*
5  * Copyright (c) 2000, 2001, 2002, 2003, 2004 by Martin C. Shepherd.
6  *
7  * All rights reserved.
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining a
10  * copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, and/or sell copies of the Software, and to permit persons
14  * to whom the Software is furnished to do so, provided that the above
15  * copyright notice(s) and this permission notice appear in all copies of
16  * the Software and that both the above copyright notice(s) and this
17  * permission notice appear in supporting documentation.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
22  * OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
24  * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
25  * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
26  * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
27  * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
28  *
29  * Except as contained in this notice, the name of a copyright holder
30  * shall not be used in advertising or otherwise to promote the sale, use
31  * or other dealings in this Software without prior written authorization
32  * of the copyright holder.
33  */
34 
35 /*
36  * Set the name of the getline configuration file.
37  */
38 #define TECLA_CONFIG_FILE "~/.teclarc"
39 
40 /*
41  * The following macro returns non-zero if a character is
42  * a control character.
43  */
44 #define IS_CTRL_CHAR(c) ((unsigned char)(c) < ' ' || (unsigned char)(c)=='\177')
45 
46 /*
47  * The following macro returns non-zero if a character is
48  * a meta character.
49  */
50 #define IS_META_CHAR(c) (((unsigned char)(c) & 0x80) && !isprint((int)(unsigned char)(c)))
51 
52 /*
53  * Return the character that would be produced by pressing the
54  * specified key plus the control key.
55  */
56 #define MAKE_CTRL(c) ((c)=='?' ? '\177' : ((unsigned char)toupper(c) & ~0x40))
57 
58 /*
59  * Return the character that would be produced by pressing the
60  * specified key plus the meta key.
61  */
62 #define MAKE_META(c) ((unsigned char)(c) | 0x80)
63 
64 /*
65  * Given a binary control character, return the character that
66  * had to be pressed at the same time as the control key.
67  */
68 #define CTRL_TO_CHAR(c) (toupper((unsigned char)(c) | 0x40))
69 
70 /*
71  * Given a meta character, return the character that was pressed
72  * at the same time as the meta key.
73  */
74 #define META_TO_CHAR(c) ((unsigned char)(c) & ~0x80)
75 
76 /*
77  * Specify the string of characters other than the alphanumeric characters,
78  * that are to be considered parts of words.
79  */
80 #define GL_WORD_CHARS "_*\?\\[]"
81 
82 /*
83  * Define the escape character, both as a string and as a character.
84  */
85 #define GL_ESC_STR "\033"
86 #define GL_ESC_CHAR '\033'
87 
88 #endif
89