readline.h revision 1.16
1 /* $NetBSD: readline.h,v 1.16 2005/06/11 18:18:59 christos Exp $ */ 2 3 /*- 4 * Copyright (c) 1997 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Jaromir Dolecek. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 #ifndef _READLINE_H_ 39 #define _READLINE_H_ 40 41 #include <sys/types.h> 42 43 /* list of readline stuff supported by editline library's readline wrapper */ 44 45 /* typedefs */ 46 typedef int Function(const char *, int); 47 typedef void VFunction(void); 48 typedef void VCPFunction(char *); 49 typedef char *CPFunction(const char *, int); 50 typedef char **CPPFunction(const char *, int, int); 51 52 typedef struct _hist_entry { 53 const char *line; 54 const char *data; 55 } HIST_ENTRY; 56 57 typedef struct _keymap_entry { 58 char type; 59 #define ISFUNC 0 60 #define ISKMAP 1 61 #define ISMACR 2 62 Function *function; 63 } KEYMAP_ENTRY; 64 65 #define KEYMAP_SIZE 256 66 67 typedef KEYMAP_ENTRY KEYMAP_ENTRY_ARRAY[KEYMAP_SIZE]; 68 typedef KEYMAP_ENTRY *Keymap; 69 70 #define control_character_threshold 0x20 71 #define control_character_bit 0x40 72 73 #ifndef CTRL 74 #include <sys/ioctl.h> 75 #if !defined(__sun__) && !defined(__hpux__) 76 #include <sys/ttydefaults.h> 77 #endif 78 #ifndef CTRL 79 #define CTRL(c) ((c) & 037) 80 #endif 81 #endif 82 #ifndef UNCTRL 83 #define UNCTRL(c) (((c) - 'a' + 'A')|control_character_bit) 84 #endif 85 86 #define RUBOUT 0x7f 87 #define ABORT_CHAR CTRL('G') 88 89 /* global variables used by readline enabled applications */ 90 #ifdef __cplusplus 91 extern "C" { 92 #endif 93 extern const char *rl_library_version; 94 extern char *rl_readline_name; 95 extern FILE *rl_instream; 96 extern FILE *rl_outstream; 97 extern char *rl_line_buffer; 98 extern int rl_point, rl_end; 99 extern int history_base, history_length; 100 extern int max_input_history; 101 extern char *rl_basic_word_break_characters; 102 extern char *rl_completer_word_break_characters; 103 extern char *rl_completer_quote_characters; 104 extern Function *rl_completion_entry_function; 105 extern CPPFunction *rl_attempted_completion_function; 106 extern int rl_attempted_completion_over; 107 extern int rl_completion_type; 108 extern int rl_completion_query_items; 109 extern char *rl_special_prefixes; 110 extern int rl_completion_append_character; 111 extern int rl_inhibit_completion; 112 extern Function *rl_pre_input_hook; 113 extern Function *rl_startup_hook; 114 extern char *rl_terminal_name; 115 extern int rl_already_prompted; 116 extern char *rl_prompt; 117 /* 118 * The following is not implemented 119 */ 120 extern KEYMAP_ENTRY_ARRAY emacs_standard_keymap, 121 emacs_meta_keymap, 122 emacs_ctlx_keymap; 123 extern int rl_filename_completion_desired; 124 extern int rl_ignore_completion_duplicates; 125 extern Function *rl_getc_function; 126 extern VFunction *rl_redisplay_function; 127 extern VFunction *rl_completion_display_matches_hook; 128 extern VFunction *rl_prep_term_function; 129 extern VFunction *rl_deprep_term_function; 130 131 /* supported functions */ 132 char *readline(const char *); 133 int rl_initialize(void); 134 135 void using_history(void); 136 int add_history(const char *); 137 void clear_history(void); 138 void stifle_history(int); 139 int unstifle_history(void); 140 int history_is_stifled(void); 141 int where_history(void); 142 HIST_ENTRY *current_history(void); 143 HIST_ENTRY *history_get(int); 144 int history_total_bytes(void); 145 int history_set_pos(int); 146 HIST_ENTRY *previous_history(void); 147 HIST_ENTRY *next_history(void); 148 int history_search(const char *, int); 149 int history_search_prefix(const char *, int); 150 int history_search_pos(const char *, int, int); 151 int read_history(const char *); 152 int write_history(const char *); 153 int history_expand(char *, char **); 154 char **history_tokenize(const char *); 155 const char *get_history_event(const char *, int *, int); 156 char *history_arg_extract(int, int, const char *); 157 158 char *tilde_expand(char *); 159 char *filename_completion_function(const char *, int); 160 char *username_completion_function(const char *, int); 161 int rl_complete(int, int); 162 int rl_read_key(void); 163 char **completion_matches(const char *, CPFunction *); 164 void rl_display_match_list(char **, int, int); 165 166 int rl_insert(int, int); 167 void rl_reset_terminal(const char *); 168 int rl_bind_key(int, int (*)(int, int)); 169 int rl_newline(int, int); 170 void rl_callback_read_char(void); 171 void rl_callback_handler_install(const char *, VCPFunction *); 172 void rl_callback_handler_remove(void); 173 void rl_redisplay(void); 174 int rl_get_previous_history(int, int); 175 void rl_prep_terminal(int); 176 void rl_deprep_terminal(void); 177 int rl_read_init_file(const char *); 178 int rl_parse_and_bind(const char *); 179 int rl_variable_bind(const char *, const char *); 180 void rl_stuff_char(int); 181 int rl_add_defun(const char *, Function *, int); 182 183 /* 184 * The following are not implemented 185 */ 186 Keymap rl_get_keymap(void); 187 Keymap rl_make_bare_keymap(void); 188 int rl_generic_bind(int, const char *, const char *, Keymap); 189 int rl_bind_key_in_map(int, Function *, Keymap); 190 #ifdef __cplusplus 191 } 192 #endif 193 194 #endif /* _READLINE_H_ */ 195
Indexes created Fri Oct 03 02:09:57 GMT 2025