1/* echo_area.h -- Functions used in reading information from the echo area. */
2
3/* This file is part of GNU Info, a program for reading online documentation
4   stored in Info format.
5
6   Copyright (C) 1993 Free Software Foundation, Inc.
7
8   This program is free software; you can redistribute it and/or modify
9   it under the terms of the GNU General Public License as published by
10   the Free Software Foundation; either version 2, or (at your option)
11   any later version.
12
13   This program is distributed in the hope that it will be useful,
14   but WITHOUT ANY WARRANTY; without even the implied warranty of
15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16   GNU General Public License for more details.
17
18   You should have received a copy of the GNU General Public License
19   along with this program; if not, write to the Free Software
20   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21
22   Written by Brian Fox (bfox@ai.mit.edu). */
23
24#if !defined (_ECHO_AREA_H_)
25#define _ECHO_AREA_H_
26
27#define EA_MAX_INPUT 256
28
29extern int echo_area_is_active, info_aborted_echo_area;
30
31/* Non-zero means that the last command executed while reading input
32   killed some text. */
33extern int echo_area_last_command_was_kill;
34
35extern void inform_in_echo_area (), echo_area_inform_of_deleted_window ();
36extern void echo_area_prep_read ();
37extern VFunction *ea_last_executed_command;
38
39/* Read a line of text in the echo area.  Return a malloc ()'ed string,
40   or NULL if the user aborted out of this read.  WINDOW is the currently
41   active window, so that we can restore it when we need to.  PROMPT, if
42   non-null, is a prompt to print before reading the line. */
43extern char *info_read_in_echo_area ();
44
45/* Read a line in the echo area with completion over COMPLETIONS.
46   Takes arguments of WINDOW, PROMPT, and COMPLETIONS, a REFERENCE **. */
47char *info_read_completing_in_echo_area ();
48
49/* Read a line in the echo area allowing completion over COMPLETIONS, but
50   not requiring it.  Takes arguments of WINDOW, PROMPT, and COMPLETIONS,
51   a REFERENCE **. */
52extern char *info_read_maybe_completing ();
53
54extern void ea_insert (), ea_quoted_insert ();
55extern void ea_beg_of_line (), ea_backward (), ea_delete (), ea_end_of_line ();
56extern void ea_forward (), ea_abort (), ea_rubout (), ea_complete ();
57extern void ea_newline (), ea_kill_line (), ea_transpose_chars ();
58extern void ea_yank (), ea_tab_insert (), ea_possible_completions ();
59extern void ea_backward_word (), ea_kill_word (), ea_forward_word ();
60extern void ea_yank_pop (), ea_backward_kill_word ();
61extern void ea_scroll_completions_window ();
62
63#endif /* _ECHO_AREA_H_ */
64