[unix-history] / gnu / usr.bin / gdb / readline / readline.h

/* Readline.h -- the names of functions callable from within readline. */

#ifndef _READLINE_H_
#define _READLINE_H_

#include <readline/keymaps.h>

#ifndef __FUNCTION_DEF
typedef int Function ();
#define __FUNCTION_DEF
#endif

/* The functions for manipulating the text of the line within readline.
Most of these functions are bound to keys by default. */
extern int
rl_beg_of_line (), rl_backward (), rl_delete (), rl_end_of_line (),
rl_forward (), ding (), rl_backward (), rl_newline (), rl_kill_line (),
rl_clear_screen (), rl_get_next_history (), rl_get_previous_history (),
rl_quoted_insert (), rl_reverse_search_history (), rl_transpose_chars
(), rl_unix_line_discard (), rl_quoted_insert (), rl_unix_word_rubout
(), rl_yank (), rl_rubout (), rl_backward_word (), rl_kill_word (),
rl_forward_word (), rl_tab_insert (), rl_yank_pop (), rl_yank_nth_arg (),
rl_backward_kill_word (), rl_backward_kill_line (), rl_transpose_words
(), rl_complete (), rl_possible_completions (), rl_do_lowercase_version
(), rl_digit_argument (), rl_universal_argument (), rl_abort (),
rl_undo_command (), rl_revert_line (), rl_beginning_of_history (),
rl_end_of_history (), rl_forward_search_history (), rl_insert (),
rl_upcase_word (), rl_downcase_word (), rl_capitalize_word (),
rl_restart_output (), rl_re_read_init_file ();

/* These are *both* defined even when VI_MODE is not. */
extern int rl_vi_editing_mode (), rl_emacs_editing_mode ();

#ifdef VI_MODE
/* Things for vi mode. */
extern int rl_vi_movement_mode (), rl_vi_insertion_mode (), rl_vi_arg_digit (),
rl_vi_prev_word (), rl_vi_next_word (), rl_vi_char_search (),
rl_vi_eof_maybe (), rl_vi_append_mode (), rl_vi_put (),
rl_vi_append_eol (), rl_vi_insert_beg (), rl_vi_delete (), rl_vi_comment (),
rl_vi_first_print (), rl_vi_fword (), rl_vi_fWord (), rl_vi_bword (),
rl_vi_bWord (), rl_vi_eword (), rl_vi_eWord (), rl_vi_end_word (),
rl_vi_change_case (), rl_vi_match (), rl_vi_bracktype (), rl_vi_change_char (),
rl_vi_yank_arg (), rl_vi_search (), rl_vi_search_again (),
rl_vi_dosearch (), rl_vi_subst (), rl_vi_overstrike (),
rl_vi_overstrike_delete (), rl_vi_replace(), rl_vi_column (),
rl_vi_delete_to (), rl_vi_change_to (), rl_vi_yank_to (), rl_vi_complete ();
#endif /* VI_MODE */

/* Keyboard macro commands. */
extern int
rl_start_kbd_macro (), rl_end_kbd_macro (), rl_call_last_kbd_macro ();

/* Maintaining the state of undo.  We remember individual deletes and inserts
   on a chain of things to do. */

/* The actions that undo knows how to undo.  Notice that UNDO_DELETE means
   to insert some text, and UNDO_INSERT means to delete some text.   I.e.,
   the code tells undo what to undo, not how to undo it. */
enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };

/* What an element of THE_UNDO_LIST looks like. */
typedef struct undo_list {
  struct undo_list *next;
  int start, end;		/* Where the change took place. */
  char *text;			/* The text to insert, if undoing a delete. */
  enum undo_code what;		/* Delete, Insert, Begin, End. */
} UNDO_LIST;

/* The current undo list for RL_LINE_BUFFER. */
extern UNDO_LIST *rl_undo_list;

/* The data structure for mapping textual names to code addresses. */
typedef struct {
  char *name;
  Function *function;
} FUNMAP;

extern FUNMAP **funmap;

/* **************************************************************** */
/*								    */
/*			Well Published Variables		    */
/*								    */
/* **************************************************************** */

/* The name of the calling program.  You should initialize this to
   whatever was in argv[0].  It is used when parsing conditionals. */
extern char *rl_readline_name;

/* The line buffer that is in use. */
extern char *rl_line_buffer;

/* The location of point, and end. */
extern int rl_point, rl_end;

/* The name of the terminal to use. */
extern char *rl_terminal_name;

/* The input and output streams. */
extern FILE *rl_instream, *rl_outstream;

/* The basic list of characters that signal a break between words for the
   completer routine.  The contents of this variable is what breaks words
   in the shell, i.e. "n\"\\'`@$>". */
extern char *rl_basic_word_break_characters;

/* The list of characters that signal a break between words for
   rl_complete_internal.  The default list is the contents of
   rl_basic_word_break_characters.  */
extern char *rl_completer_word_break_characters;

/* List of characters that are word break characters, but should be left
   in TEXT when it is passed to the completion function.  The shell uses
   this to help determine what kind of completing to do. */
extern char *rl_special_prefixes;

/* Pointer to the generator function for completion_matches ().
   NULL means to use filename_entry_function (), the default filename
   completer. */
extern Function *rl_completion_entry_function;

/* Pointer to alternative function to create matches.
   Function is called with TEXT, START, and END.
   START and END are indices in RL_LINE_BUFFER saying what the boundaries
   of TEXT are.
   If this function exists and returns NULL then call the value of
   rl_completion_entry_function to try to match, otherwise use the
   array of strings returned. */
extern Function *rl_attempted_completion_function;

/* If non-null, this contains the address of a function to call if the
   standard meaning for expanding a tilde fails.  The function is called
   with the text (sans tilde, as in "foo"), and returns a malloc()'ed string
   which is the expansion, or a NULL pointer if there is no expansion. */
extern Function *rl_tilde_expander;

/* If non-zero, then this is the address of a function to call just
   before readline_internal () prints the first prompt. */
extern Function *rl_startup_hook;

/* **************************************************************** */
/*								    */
/*			Well Published Functions		    */
/*								    */
/* **************************************************************** */

/* Read a line of input.  Prompt with PROMPT.  A NULL PROMPT means none. */
extern char *readline ();

/* Return an array of strings which are the result of repeatadly calling
   FUNC with TEXT. */
extern char **completion_matches ();

/* rl_add_defun (char *name, Function *function, int key)
   Add NAME to the list of named functions.  Make FUNCTION
   be the function that gets called.
   If KEY is not -1, then bind it. */
extern int rl_add_defun ();

#endif /* _READLINE_H_ */
Commit	Line	Data
04497f0b NW	1	/* Readline.h -- the names of functions callable from within readline. */
	2
	3	#ifndef _READLINE_H_
	4	#define _READLINE_H_
	5
	6	#include <readline/keymaps.h>
	7
	8	#ifndef __FUNCTION_DEF
	9	typedef int Function ();
	10	#define __FUNCTION_DEF
	11	#endif
	12
	13	/* The functions for manipulating the text of the line within readline.
	14	Most of these functions are bound to keys by default. */
	15	extern int
	16	rl_beg_of_line (), rl_backward (), rl_delete (), rl_end_of_line (),
	17	rl_forward (), ding (), rl_backward (), rl_newline (), rl_kill_line (),
	18	rl_clear_screen (), rl_get_next_history (), rl_get_previous_history (),
	19	rl_quoted_insert (), rl_reverse_search_history (), rl_transpose_chars
	20	(), rl_unix_line_discard (), rl_quoted_insert (), rl_unix_word_rubout
	21	(), rl_yank (), rl_rubout (), rl_backward_word (), rl_kill_word (),
	22	rl_forward_word (), rl_tab_insert (), rl_yank_pop (), rl_yank_nth_arg (),
	23	rl_backward_kill_word (), rl_backward_kill_line (), rl_transpose_words
	24	(), rl_complete (), rl_possible_completions (), rl_do_lowercase_version
	25	(), rl_digit_argument (), rl_universal_argument (), rl_abort (),
	26	rl_undo_command (), rl_revert_line (), rl_beginning_of_history (),
	27	rl_end_of_history (), rl_forward_search_history (), rl_insert (),
	28	rl_upcase_word (), rl_downcase_word (), rl_capitalize_word (),
	29	rl_restart_output (), rl_re_read_init_file ();
	30
	31	/* These are both defined even when VI_MODE is not. */
	32	extern int rl_vi_editing_mode (), rl_emacs_editing_mode ();
	33
	34	#ifdef VI_MODE
	35	/* Things for vi mode. */
	36	extern int rl_vi_movement_mode (), rl_vi_insertion_mode (), rl_vi_arg_digit (),
	37	rl_vi_prev_word (), rl_vi_next_word (), rl_vi_char_search (),
	38	rl_vi_eof_maybe (), rl_vi_append_mode (), rl_vi_put (),
	39	rl_vi_append_eol (), rl_vi_insert_beg (), rl_vi_delete (), rl_vi_comment (),
	40	rl_vi_first_print (), rl_vi_fword (), rl_vi_fWord (), rl_vi_bword (),
	41	rl_vi_bWord (), rl_vi_eword (), rl_vi_eWord (), rl_vi_end_word (),
	42	rl_vi_change_case (), rl_vi_match (), rl_vi_bracktype (), rl_vi_change_char (),
	43	rl_vi_yank_arg (), rl_vi_search (), rl_vi_search_again (),
	44	rl_vi_dosearch (), rl_vi_subst (), rl_vi_overstrike (),
	45	rl_vi_overstrike_delete (), rl_vi_replace(), rl_vi_column (),
	46	rl_vi_delete_to (), rl_vi_change_to (), rl_vi_yank_to (), rl_vi_complete ();
	47	#endif /* VI_MODE */
	48
	49	/* Keyboard macro commands. */
	50	extern int
	51	rl_start_kbd_macro (), rl_end_kbd_macro (), rl_call_last_kbd_macro ();
	52
	53	/* Maintaining the state of undo. We remember individual deletes and inserts
	54	on a chain of things to do. */
	55
	56	/* The actions that undo knows how to undo. Notice that UNDO_DELETE means
	57	to insert some text, and UNDO_INSERT means to delete some text. I.e.,
	58	the code tells undo what to undo, not how to undo it. */
	59	enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
	60
	61	/* What an element of THE_UNDO_LIST looks like. */
	62	typedef struct undo_list {
	63	struct undo_list *next;
	64	int start, end; /* Where the change took place. */
65	char text; / The text to insert, if undoing a delete. */
66	enum undo_code what; /* Delete, Insert, Begin, End. */
67	} UNDO_LIST;
68
69	/* The current undo list for RL_LINE_BUFFER. */
70	extern UNDO_LIST *rl_undo_list;
71
72	/* The data structure for mapping textual names to code addresses. */
73	typedef struct {
74	char *name;
75	Function *function;
76	} FUNMAP;
77
78	extern FUNMAP **funmap;
79
80	/* **************************************************************** */
81	/* */
82	/* Well Published Variables */
83	/* */
84	/* **************************************************************** */
85
86	/* The name of the calling program. You should initialize this to
87	whatever was in argv[0]. It is used when parsing conditionals. */
88	extern char *rl_readline_name;
89
90	/* The line buffer that is in use. */
91	extern char *rl_line_buffer;
92
93	/* The location of point, and end. */
94	extern int rl_point, rl_end;
95
96	/* The name of the terminal to use. */
97	extern char *rl_terminal_name;
98
99	/* The input and output streams. */
100	extern FILE rl_instream, rl_outstream;
101
102	/* The basic list of characters that signal a break between words for the
103	completer routine. The contents of this variable is what breaks words
104	in the shell, i.e. "n\"\\'`@$>". */
105	extern char *rl_basic_word_break_characters;
106
107	/* The list of characters that signal a break between words for
108	rl_complete_internal. The default list is the contents of
109	rl_basic_word_break_characters. */
110	extern char *rl_completer_word_break_characters;
111
112	/* List of characters that are word break characters, but should be left
113	in TEXT when it is passed to the completion function. The shell uses
114	this to help determine what kind of completing to do. */
115	extern char *rl_special_prefixes;
116
117	/* Pointer to the generator function for completion_matches ().
118	NULL means to use filename_entry_function (), the default filename
119	completer. */
120	extern Function *rl_completion_entry_function;
121
122	/* Pointer to alternative function to create matches.
123	Function is called with TEXT, START, and END.
124	START and END are indices in RL_LINE_BUFFER saying what the boundaries
125	of TEXT are.
126	If this function exists and returns NULL then call the value of
127	rl_completion_entry_function to try to match, otherwise use the
128	array of strings returned. */
129	extern Function *rl_attempted_completion_function;
130
131	/* If non-null, this contains the address of a function to call if the
132	standard meaning for expanding a tilde fails. The function is called
133	with the text (sans tilde, as in "foo"), and returns a malloc()'ed string
134	which is the expansion, or a NULL pointer if there is no expansion. */
135	extern Function *rl_tilde_expander;
136
137	/* If non-zero, then this is the address of a function to call just
138	before readline_internal () prints the first prompt. */
139	extern Function *rl_startup_hook;
140
141	/* **************************************************************** */
142	/* */
143	/* Well Published Functions */
144	/* */
145	/* **************************************************************** */
146
147	/* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */
148	extern char *readline ();
149
150	/* Return an array of strings which are the result of repeatadly calling
151	FUNC with TEXT. */
152	extern char **completion_matches ();
153
154	/* rl_add_defun (char name, Function function, int key)
155	Add NAME to the list of named functions. Make FUNCTION
156	be the function that gets called.
157	If KEY is not -1, then bind it. */
158	extern int rl_add_defun ();
159
160	#endif /* _READLINE_H_ */
161