readline.h revision 1.4
1 /* $NetBSD: readline.h,v 1.4 2003/09/14 21:55:19 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 #define CTRL(c) ((c) & 037) 74 #endif 75 #ifndef UNCTRL 76 #define UNCTRL(c) (((c) - 'a' + 'A')|control_character_bit) 77 #endif 78 79 #define RUBOUT 0x7f 80 #define ABORT_CHAR CTRL('G') 81 82 /* global variables used by readline enabled applications */ 83 #ifdef __cplusplus 84 extern "C" { 85 #endif 86 extern const char *rl_library_version; 87 extern char *rl_readline_name; 88 extern FILE *rl_instream; 89 extern FILE *rl_outstream; 90 extern char *rl_line_buffer; 91 extern int rl_point, rl_end; 92 extern int history_base, history_length; 93 extern int max_input_history; 94 extern char *rl_basic_word_break_characters; 95 extern char *rl_completer_word_break_characters; 96 extern char *rl_completer_quote_characters; 97 extern CPFunction *rl_completion_entry_function; 98 extern CPPFunction *rl_attempted_completion_function; 99 extern int rl_completion_type; 100 extern int rl_completion_query_items; 101 extern char *rl_special_prefixes; 102 extern int rl_completion_append_character; 103 extern Function *rl_pre_input_hook; 104 extern Function *rl_startup_hook; 105 extern char *rl_terminal_name; 106 extern int rl_already_prompted; 107 extern char *rl_prompt; 108 /* 109 * The following is not implemented 110 */ 111 extern KEYMAP_ENTRY_ARRAY emacs_standard_keymap, 112 emacs_meta_keymap, 113 emacs_ctlx_keymap; 114 extern int rl_filename_completion_desired; 115 extern int rl_ignore_completion_duplicates; 116 extern Function *rl_getc_function; 117 extern VFunction *rl_redisplay_function; 118 extern Function *rl_completion_display_matches_hook; 119 extern VFunction *rl_prep_term_function; 120 extern VFunction *rl_deprep_term_function; 121 122 /* supported functions */ 123 char *readline(const char *); 124 int rl_initialize(void); 125 126 void using_history(void); 127 int add_history(const char *); 128 void clear_history(void); 129 void stifle_history(int); 130 int unstifle_history(void); 131 int history_is_stifled(void); 132 int where_history(void); 133 HIST_ENTRY *current_history(void); 134 HIST_ENTRY *history_get(int); 135 int history_total_bytes(void); 136 int history_set_pos(int); 137 HIST_ENTRY *previous_history(void); 138 HIST_ENTRY *next_history(void); 139 int history_search(const char *, int); 140 int history_search_prefix(const char *, int); 141 int history_search_pos(const char *, int, int); 142 int read_history(const char *); 143 int write_history(const char *); 144 int history_expand(char *, char **); 145 char **history_tokenize(const char *); 146 147 char *tilde_expand(char *); 148 char *filename_completion_function(const char *, int); 149 char *username_completion_function(const char *, int); 150 int rl_complete(int, int); 151 int rl_read_key(void); 152 char **completion_matches(const char *, CPFunction *); 153 void rl_display_match_list(char **, int, int); 154 155 int rl_insert(int, int); 156 void rl_reset_terminal(const char *); 157 int rl_bind_key(int, int (*)(int, int)); 158 159 /* 160 * The following are not implemented 161 */ 162 Keymap rl_get_keymap(void); 163 Keymap rl_make_bare_keymap(void); 164 int rl_add_defun(const char *, Function *, int); 165 int rl_generic_bind(int, const char *, const char *, Keymap); 166 int rl_bind_key_in_map(int, Function *, Keymap); 167 #ifdef __cplusplus 168 } 169 #endif 170 171 #endif /* _READLINE_H_ */ 172
Indexes created Fri Oct 03 17:10:05 GMT 2025