readline.h revision 1.24
1 /* $NetBSD: readline.h,v 1.24 2009/02/05 19:15:26 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 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 #ifndef _READLINE_H_ 32 #define _READLINE_H_ 33 34 #include <sys/types.h> 35 36 /* list of readline stuff supported by editline library's readline wrapper */ 37 38 /* typedefs */ 39 typedef int Function(const char *, int); 40 typedef void VFunction(void); 41 typedef void VCPFunction(char *); 42 typedef char *CPFunction(const char *, int); 43 typedef char **CPPFunction(const char *, int, int); 44 typedef char *rl_compentry_func_t(const char *, int); 45 46 typedef struct _hist_entry { 47 const char *line; 48 const char *data; 49 } HIST_ENTRY; 50 51 typedef struct _keymap_entry { 52 char type; 53 #define ISFUNC 0 54 #define ISKMAP 1 55 #define ISMACR 2 56 Function *function; 57 } KEYMAP_ENTRY; 58 59 #define KEYMAP_SIZE 256 60 61 typedef KEYMAP_ENTRY KEYMAP_ENTRY_ARRAY[KEYMAP_SIZE]; 62 typedef KEYMAP_ENTRY *Keymap; 63 64 #define control_character_threshold 0x20 65 #define control_character_bit 0x40 66 67 #ifndef CTRL 68 #include <sys/ioctl.h> 69 #if !defined(__sun__) && !defined(__hpux__) 70 #include <sys/ttydefaults.h> 71 #endif 72 #ifndef CTRL 73 #define CTRL(c) ((c) & 037) 74 #endif 75 #endif 76 #ifndef UNCTRL 77 #define UNCTRL(c) (((c) - 'a' + 'A')|control_character_bit) 78 #endif 79 80 #define RUBOUT 0x7f 81 #define ABORT_CHAR CTRL('G') 82 83 /* global variables used by readline enabled applications */ 84 #ifdef __cplusplus 85 extern "C" { 86 #endif 87 extern const char *rl_library_version; 88 extern char *rl_readline_name; 89 extern FILE *rl_instream; 90 extern FILE *rl_outstream; 91 extern char *rl_line_buffer; 92 extern int rl_point, rl_end; 93 extern int history_base, history_length; 94 extern int max_input_history; 95 extern char *rl_basic_word_break_characters; 96 extern char *rl_completer_word_break_characters; 97 extern char *rl_completer_quote_characters; 98 extern Function *rl_completion_entry_function; 99 extern CPPFunction *rl_attempted_completion_function; 100 extern int rl_attempted_completion_over; 101 extern int rl_completion_type; 102 extern int rl_completion_query_items; 103 extern char *rl_special_prefixes; 104 extern int rl_completion_append_character; 105 extern int rl_inhibit_completion; 106 extern Function *rl_pre_input_hook; 107 extern Function *rl_startup_hook; 108 extern char *rl_terminal_name; 109 extern int rl_already_prompted; 110 extern char *rl_prompt; 111 /* 112 * The following is not implemented 113 */ 114 extern KEYMAP_ENTRY_ARRAY emacs_standard_keymap, 115 emacs_meta_keymap, 116 emacs_ctlx_keymap; 117 extern int rl_filename_completion_desired; 118 extern int rl_ignore_completion_duplicates; 119 extern int (*rl_getc_function)(FILE *); 120 extern VFunction *rl_redisplay_function; 121 extern VFunction *rl_completion_display_matches_hook; 122 extern VFunction *rl_prep_term_function; 123 extern VFunction *rl_deprep_term_function; 124 extern int readline_echoing_p; 125 extern int _rl_print_completions_horizontally; 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 void rl_get_screen_size(int *, int *); 180 void rl_set_screen_size(int, int); 181 char *rl_filename_completion_function (const char *, int); 182 int _rl_abort_internal(void); 183 int _rl_qsort_string_compare(char **, char **); 184 char **rl_completion_matches(const char *, rl_compentry_func_t *); 185 void rl_forced_update_display(void); 186 int rl_set_prompt(const char *); 187 188 /* 189 * The following are not implemented 190 */ 191 int rl_kill_text(int, int); 192 Keymap rl_get_keymap(void); 193 void rl_set_keymap(Keymap); 194 Keymap rl_make_bare_keymap(void); 195 int rl_generic_bind(int, const char *, const char *, Keymap); 196 int rl_bind_key_in_map(int, Function *, Keymap); 197 #ifdef __cplusplus 198 } 199 #endif 200 201 #endif /* _READLINE_H_ */ 202
Indexes created Fri Oct 03 02:09:57 GMT 2025