xref: /illumos-gate/usr/src/lib/libtecla/common/getline.h (revision 7c478bd95313f5f23a4c958a745db2134aa03244)
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 #pragma ident	"%Z%%M%	%I%	%E% SMI"
36 
37 /*
38  * Set the name of the getline configuration file.
39  */
40 #define TECLA_CONFIG_FILE "~/.teclarc"
41 
42 /*
43  * The following macro returns non-zero if a character is
44  * a control character.
45  */
46 #define IS_CTRL_CHAR(c) ((unsigned char)(c) < ' ' || (unsigned char)(c)=='\177')
47 
48 /*
49  * The following macro returns non-zero if a character is
50  * a meta character.
51  */
52 #define IS_META_CHAR(c) (((unsigned char)(c) & 0x80) && !isprint((int)(unsigned char)(c)))
53 
54 /*
55  * Return the character that would be produced by pressing the
56  * specified key plus the control key.
57  */
58 #define MAKE_CTRL(c) ((c)=='?' ? '\177' : ((unsigned char)toupper(c) & ~0x40))
59 
60 /*
61  * Return the character that would be produced by pressing the
62  * specified key plus the meta key.
63  */
64 #define MAKE_META(c) ((unsigned char)(c) | 0x80)
65 
66 /*
67  * Given a binary control character, return the character that
68  * had to be pressed at the same time as the control key.
69  */
70 #define CTRL_TO_CHAR(c) (toupper((unsigned char)(c) | 0x40))
71 
72 /*
73  * Given a meta character, return the character that was pressed
74  * at the same time as the meta key.
75  */
76 #define META_TO_CHAR(c) ((unsigned char)(c) & ~0x80)
77 
78 /*
79  * Specify the string of characters other than the alphanumeric characters,
80  * that are to be considered parts of words.
81  */
82 #define GL_WORD_CHARS "_*\?\\[]"
83 
84 /*
85  * Define the escape character, both as a string and as a character.
86  */
87 #define GL_ESC_STR "\033"
88 #define GL_ESC_CHAR '\033'
89 
90 #endif
91