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