readline.h revision 1.8
1 /* $NetBSD: readline.h,v 1.8 2003/09/26 17:44:51 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 char *CPFunction(const char *, int); 49 typedef char **CPPFunction(const char *, int, int); 50 51 typedef struct _hist_entry { 52 const char *line; 53 const char *data; 54 } HIST_ENTRY; 55 56 typedef struct _keymap_entry { 57 char type; 58 #define ISFUNC 0 59 #define ISKMAP 1 60 #define ISMACR 2 61 Function *function; 62 } KEYMAP_ENTRY; 63 64 #define KEYMAP_SIZE 256 65 66 typedef KEYMAP_ENTRY KEYMAP_ENTRY_ARRAY[KEYMAP_SIZE]; 67 typedef KEYMAP_ENTRY *Keymap; 68 69 #define control_character_threshold 0x20 70 #define control_character_bit 0x40 71 72 #ifndef CTRL 73 #include <sys/ioctl.h> 74 #include <sys/ttydefaults.h> 75 #ifndef CTRL 76 #define CTRL(c) ((c) & 037) 77 #endif 78 #endif 79 #ifndef UNCTRL 80 #define UNCTRL(c) (((c) - 'a' + 'A')|control_character_bit) 81 #endif 82 83 #define RUBOUT 0x7f 84 #define ABORT_CHAR CTRL('G') 85 86 /* global variables used by readline enabled applications */ 87 #ifdef __cplusplus 88 extern "C" { 89 #endif 90 extern const char *rl_library_version; 91 extern char *rl_readline_name; 92 extern FILE *rl_instream; 93 extern FILE *rl_outstream; 94 extern char *rl_line_buffer; 95 extern int rl_point, rl_end; 96 extern int history_base, history_length; 97 extern int max_input_history; 98 extern char *rl_basic_word_break_characters; 99 extern char *rl_completer_word_break_characters; 100 extern char *rl_completer_quote_characters; 101 extern Function *rl_completion_entry_function; 102 extern CPPFunction *rl_attempted_completion_function; 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 Function *rl_pre_input_hook; 108 extern Function *rl_startup_hook; 109 extern char *rl_terminal_name; 110 extern int rl_already_prompted; 111 extern char *rl_prompt; 112 /* 113 * The following is not implemented 114 */ 115 extern KEYMAP_ENTRY_ARRAY emacs_standard_keymap, 116 emacs_meta_keymap, 117 emacs_ctlx_keymap; 118 extern int rl_filename_completion_desired; 119 extern int rl_ignore_completion_duplicates; 120 extern Function *rl_getc_function; 121 extern VFunction *rl_redisplay_function; 122 extern VFunction *rl_completion_display_matches_hook; 123 extern VFunction *rl_prep_term_function; 124 extern VFunction *rl_deprep_term_function; 125 126 /* supported functions */ 127 char *readline(const char *); 128 int rl_initialize(void); 129 130 void using_history(void); 131 int add_history(const char *); 132 void clear_history(void); 133 void stifle_history(int); 134 int unstifle_history(void); 135 int history_is_stifled(void); 136 int where_history(void); 137 HIST_ENTRY *current_history(void); 138 HIST_ENTRY *history_get(int); 139 int history_total_bytes(void); 140 int history_set_pos(int); 141 HIST_ENTRY *previous_history(void); 142 HIST_ENTRY *next_history(void); 143 int history_search(const char *, int); 144 int history_search_prefix(const char *, int); 145 int history_search_pos(const char *, int, int); 146 int read_history(const char *); 147 int write_history(const char *); 148 int history_expand(char *, char **); 149 char **history_tokenize(const char *); 150 151 char *tilde_expand(char *); 152 char *filename_completion_function(const char *, int); 153 char *username_completion_function(const char *, int); 154 int rl_complete(int, int); 155 int rl_read_key(void); 156 char **completion_matches(const char *, CPFunction *); 157 void rl_display_match_list(char **, int, int); 158 159 int rl_insert(int, int); 160 void rl_reset_terminal(const char *); 161 int rl_bind_key(int, int (*)(int, int)); 162 int rl_newline(int, int); 163 void rl_callback_read_char(void); 164 void rl_callback_handler_install(const char *, VFunction *); 165 void rl_callback_handler_remove(void); 166 void rl_redisplay(void); 167 int rl_get_previous_history(int, int); 168 169 /* 170 * The following are not implemented 171 */ 172 Keymap rl_get_keymap(void); 173 Keymap rl_make_bare_keymap(void); 174 int rl_add_defun(const char *, Function *, int); 175 int rl_generic_bind(int, const char *, const char *, Keymap); 176 int rl_bind_key_in_map(int, Function *, Keymap); 177 #ifdef __cplusplus 178 } 179 #endif 180 181 #endif /* _READLINE_H_ */ 182
Indexes created Fri Oct 03 17:10:05 GMT 2025