1/* $NetBSD: readline.h,v 1.47 2021/08/21 12:34: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 *
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#include <stdio.h>
36
37/* list of readline stuff supported by editline library's readline wrapper */
38
39/* typedefs */
40typedef int Function(const char *, int);
41typedef char *CPFunction(const char *, int);
42typedef void VFunction(void);
43typedef void rl_vcpfunc_t(char *);
44typedef char **rl_completion_func_t(const char *, int, int);
45typedef char *rl_compentry_func_t(const char *, int);
46typedef int rl_command_func_t(int, int);
47typedef int rl_hook_func_t(void);
48typedef int rl_icppfunc_t(char **);
49
50/* only supports length */
51typedef struct {
52 int length;
53} HISTORY_STATE;
54
55typedef void *histdata_t;
56
57typedef struct _hist_entry {
58 const char *line;
59 histdata_t data;
60} HIST_ENTRY;
61
62typedef struct _keymap_entry {
63 char type;
64#define ISFUNC 0
65#define ISKMAP 1
66#define ISMACR 2
67 Function *function;
68} KEYMAP_ENTRY;
69
70#define KEYMAP_SIZE 256
71
72typedef KEYMAP_ENTRY KEYMAP_ENTRY_ARRAY[KEYMAP_SIZE];
73typedef KEYMAP_ENTRY *Keymap;
74
75#define control_character_threshold 0x20
76#define control_character_bit 0x40
77
78#ifndef CTRL
79#include <sys/ioctl.h>
80#if !defined(__sun) && !defined(__hpux) && !defined(_AIX)
81#include <sys/ttydefaults.h>
82#endif
83#ifndef CTRL
84#define CTRL(c) ((c) & 037)
85#endif
86#endif
87#ifndef UNCTRL
88#define UNCTRL(c) (((c) - 'a' + 'A')|control_character_bit)
89#endif
90
91#define RUBOUT 0x7f
92#define ABORT_CHAR CTRL('G')
93#define RL_READLINE_VERSION 0x0402
94#define RL_PROMPT_START_IGNORE '\1'
95#define RL_PROMPT_END_IGNORE '\2'
96
97/* global variables used by readline enabled applications */
98#ifdef __cplusplus
99extern "C" {
100#endif
101extern const char *rl_library_version;
102extern int rl_readline_version;
103extern const char *rl_readline_name;
104extern FILE *rl_instream;
105extern FILE *rl_outstream;
106extern char *rl_line_buffer;
107extern int rl_point, rl_end;
108extern int history_base, history_length;
109extern int max_input_history;
110extern const char *rl_basic_quote_characters;
111extern const char *rl_basic_word_break_characters;
112extern char *rl_completer_word_break_characters;
113extern const char *rl_completer_quote_characters;
114extern rl_compentry_func_t *rl_completion_entry_function;
115extern char *(*rl_completion_word_break_hook)(void);
116extern rl_completion_func_t *rl_attempted_completion_function;
117extern int rl_attempted_completion_over;
118extern int rl_completion_type;
119extern int rl_completion_query_items;
120extern const char *rl_special_prefixes;
121extern int rl_completion_append_character;
122extern int rl_inhibit_completion;
123extern Function *rl_pre_input_hook;
124extern Function *rl_startup_hook;
125extern char *rl_terminal_name;
126extern int rl_already_prompted;
127extern char *rl_prompt;
128extern int rl_done;
129/*
130 * The following is not implemented
131 */
132extern unsigned long rl_readline_state;
133extern int rl_catch_signals;
134extern int rl_catch_sigwinch;
135extern KEYMAP_ENTRY_ARRAY emacs_standard_keymap,
136 emacs_meta_keymap,
137 emacs_ctlx_keymap;
138extern int rl_filename_completion_desired;
139extern int rl_ignore_completion_duplicates;
140extern int (*rl_getc_function)(FILE *);
141extern VFunction *rl_redisplay_function;
142extern VFunction *rl_completion_display_matches_hook;
143extern VFunction *rl_prep_term_function;
144extern VFunction *rl_deprep_term_function;
145extern rl_hook_func_t *rl_event_hook;
146extern int readline_echoing_p;
147extern int _rl_print_completions_horizontally;
148extern int _rl_complete_mark_directories;
149extern rl_icppfunc_t *rl_directory_completion_hook;
150extern int rl_completion_suppress_append;
151extern int rl_sort_completion_matches;
152extern int _rl_completion_prefix_display_length;
153extern int _rl_echoing_p;
154extern int history_max_entries;
155extern char *rl_display_prompt;
156
157/* supported functions */
158char *readline(const char *);
159int rl_initialize(void);
160
161void using_history(void);
162int add_history(const char *);
163void clear_history(void);
164int append_history(int, const char *);
165void stifle_history(int);
166int unstifle_history(void);
167int history_is_stifled(void);
168int where_history(void);
169HIST_ENTRY *current_history(void);
170HIST_ENTRY *history_get(int);
171HIST_ENTRY *remove_history(int);
172HIST_ENTRY *replace_history_entry(int, const char *, histdata_t);
173int history_total_bytes(void);
174int history_set_pos(int);
175HIST_ENTRY *previous_history(void);
176HIST_ENTRY *next_history(void);
177HIST_ENTRY **history_list(void);
178int history_search(const char *, int);
179int history_search_prefix(const char *, int);
180int history_search_pos(const char *, int, int);
181int read_history(const char *);
182int write_history(const char *);
183int history_truncate_file (const char *, int);
184int history_expand(char *, char **);
185char **history_tokenize(const char *);
186const char *get_history_event(const char *, int *, int);
187char *history_arg_extract(int, int, const char *);
188
189char *tilde_expand(char *);
190char *filename_completion_function(const char *, int);
191char *username_completion_function(const char *, int);
192int rl_complete(int, int);
193int rl_read_key(void);
194char **completion_matches(/* const */ char *, rl_compentry_func_t *);
195void rl_display_match_list(char **, int, int);
196
197int rl_insert(int, int);
198int rl_insert_text(const char *);
199int rl_reset_terminal(const char *);
200void rl_resize_terminal(void);
201int rl_bind_key(int, rl_command_func_t *);
202int rl_newline(int, int);
203void rl_callback_read_char(void);
204void rl_callback_handler_install(const char *, rl_vcpfunc_t *);
205void rl_callback_handler_remove(void);
206void rl_redisplay(void);
207int rl_get_previous_history(int, int);
208void rl_prep_terminal(int);
209void rl_deprep_terminal(void);
210int rl_read_init_file(const char *);
211int rl_parse_and_bind(const char *);
212int rl_variable_bind(const char *, const char *);
213int rl_stuff_char(int);
214int rl_add_defun(const char *, rl_command_func_t *, int);
215HISTORY_STATE *history_get_history_state(void);
216void rl_get_screen_size(int *, int *);
217void rl_set_screen_size(int, int);
218char *rl_filename_completion_function (const char *, int);
219int _rl_abort_internal(void);
220int _rl_qsort_string_compare(char **, char **);
221char **rl_completion_matches(const char *, rl_compentry_func_t *);
222void rl_forced_update_display(void);
223int rl_set_prompt(const char *);
224int rl_on_new_line(void);
225void rl_reset_after_signal(void);
226void rl_echo_signal_char(int);
227int rl_crlf(void);
228int rl_ding(void);
229
230/*
231 * The following are not implemented
232 */
233int rl_kill_text(int, int);
234Keymap rl_get_keymap(void);
235void rl_set_keymap(Keymap);
236Keymap rl_make_bare_keymap(void);
237int rl_generic_bind(int, const char *, const char *, Keymap);
238int rl_bind_key_in_map(int, rl_command_func_t *, Keymap);
239void rl_cleanup_after_signal(void);
240void rl_free_line_state(void);
241int rl_set_keyboard_input_timeout(int);
242int rl_abort(int, int);
243int rl_set_keymap_name(const char *, Keymap);
244histdata_t free_history_entry(HIST_ENTRY *);
245void _rl_erase_entire_line(void);
246
247#ifdef __cplusplus
248}
249#endif
250
251#endif /* _READLINE_H_ */
252

source code of include/editline/readline.h