Home | History | Annotate | Line # | Download | only in readline
readline.h revision 1.9
      1  1.9  christos /*	$NetBSD: readline.h,v 1.9 2003/10/16 22:26:32 christos Exp $	*/
      2  1.1  jdolecek 
      3  1.1  jdolecek /*-
      4  1.1  jdolecek  * Copyright (c) 1997 The NetBSD Foundation, Inc.
      5  1.1  jdolecek  * All rights reserved.
      6  1.1  jdolecek  *
      7  1.1  jdolecek  * This code is derived from software contributed to The NetBSD Foundation
      8  1.1  jdolecek  * by Jaromir Dolecek.
      9  1.1  jdolecek  *
     10  1.1  jdolecek  * Redistribution and use in source and binary forms, with or without
     11  1.1  jdolecek  * modification, are permitted provided that the following conditions
     12  1.1  jdolecek  * are met:
     13  1.1  jdolecek  * 1. Redistributions of source code must retain the above copyright
     14  1.1  jdolecek  *    notice, this list of conditions and the following disclaimer.
     15  1.1  jdolecek  * 2. Redistributions in binary form must reproduce the above copyright
     16  1.1  jdolecek  *    notice, this list of conditions and the following disclaimer in the
     17  1.1  jdolecek  *    documentation and/or other materials provided with the distribution.
     18  1.1  jdolecek  * 3. All advertising materials mentioning features or use of this software
     19  1.1  jdolecek  *    must display the following acknowledgement:
     20  1.1  jdolecek  *	This product includes software developed by the NetBSD
     21  1.1  jdolecek  *	Foundation, Inc. and its contributors.
     22  1.1  jdolecek  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  1.1  jdolecek  *    contributors may be used to endorse or promote products derived
     24  1.1  jdolecek  *    from this software without specific prior written permission.
     25  1.1  jdolecek  *
     26  1.1  jdolecek  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  1.1  jdolecek  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  1.1  jdolecek  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  1.1  jdolecek  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  1.1  jdolecek  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  1.1  jdolecek  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  1.1  jdolecek  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  1.1  jdolecek  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  1.1  jdolecek  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  1.1  jdolecek  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  1.1  jdolecek  * POSSIBILITY OF SUCH DAMAGE.
     37  1.1  jdolecek  */
     38  1.1  jdolecek #ifndef _READLINE_H_
     39  1.1  jdolecek #define	_READLINE_H_
     40  1.1  jdolecek 
     41  1.1  jdolecek #include <sys/types.h>
     42  1.1  jdolecek 
     43  1.1  jdolecek /* list of readline stuff supported by editline library's readline wrapper */
     44  1.1  jdolecek 
     45  1.1  jdolecek /* typedefs */
     46  1.1  jdolecek typedef int	  Function(const char *, int);
     47  1.1  jdolecek typedef void	  VFunction(void);
     48  1.1  jdolecek typedef char	 *CPFunction(const char *, int);
     49  1.1  jdolecek typedef char	**CPPFunction(const char *, int, int);
     50  1.1  jdolecek 
     51  1.1  jdolecek typedef struct _hist_entry {
     52  1.1  jdolecek 	const char	*line;
     53  1.1  jdolecek 	const char	*data;
     54  1.1  jdolecek } HIST_ENTRY;
     55  1.1  jdolecek 
     56  1.3  christos typedef struct _keymap_entry {
     57  1.3  christos 	char type;
     58  1.3  christos #define	ISFUNC	0
     59  1.3  christos #define	ISKMAP	1
     60  1.3  christos #define	ISMACR	2
     61  1.3  christos 	Function *function;
     62  1.3  christos } KEYMAP_ENTRY;
     63  1.3  christos 
     64  1.3  christos #define KEYMAP_SIZE	256
     65  1.3  christos 
     66  1.3  christos typedef KEYMAP_ENTRY KEYMAP_ENTRY_ARRAY[KEYMAP_SIZE];
     67  1.3  christos typedef KEYMAP_ENTRY *Keymap;
     68  1.3  christos 
     69  1.3  christos #define control_character_threshold	0x20
     70  1.3  christos #define control_character_bit		0x40
     71  1.3  christos 
     72  1.3  christos #ifndef CTRL
     73  1.6  christos #include <sys/ioctl.h>
     74  1.7      tron #include <sys/ttydefaults.h>
     75  1.6  christos #ifndef CTRL
     76  1.4  christos #define CTRL(c)		((c) & 037)
     77  1.6  christos #endif
     78  1.3  christos #endif
     79  1.3  christos #ifndef UNCTRL
     80  1.4  christos #define UNCTRL(c)	(((c) - 'a' + 'A')|control_character_bit)
     81  1.3  christos #endif
     82  1.3  christos 
     83  1.3  christos #define	RUBOUT		0x7f
     84  1.3  christos #define	ABORT_CHAR	CTRL('G')
     85  1.3  christos 
     86  1.1  jdolecek /* global variables used by readline enabled applications */
     87  1.2  christos #ifdef __cplusplus
     88  1.2  christos extern "C" {
     89  1.2  christos #endif
     90  1.1  jdolecek extern const char	*rl_library_version;
     91  1.1  jdolecek extern char		*rl_readline_name;
     92  1.1  jdolecek extern FILE		*rl_instream;
     93  1.1  jdolecek extern FILE		*rl_outstream;
     94  1.1  jdolecek extern char		*rl_line_buffer;
     95  1.1  jdolecek extern int		 rl_point, rl_end;
     96  1.1  jdolecek extern int		 history_base, history_length;
     97  1.1  jdolecek extern int		 max_input_history;
     98  1.1  jdolecek extern char		*rl_basic_word_break_characters;
     99  1.1  jdolecek extern char		*rl_completer_word_break_characters;
    100  1.1  jdolecek extern char		*rl_completer_quote_characters;
    101  1.5  christos extern Function		*rl_completion_entry_function;
    102  1.1  jdolecek extern CPPFunction	*rl_attempted_completion_function;
    103  1.1  jdolecek extern int		rl_completion_type;
    104  1.1  jdolecek extern int		rl_completion_query_items;
    105  1.1  jdolecek extern char		*rl_special_prefixes;
    106  1.1  jdolecek extern int		rl_completion_append_character;
    107  1.3  christos extern Function		*rl_pre_input_hook;
    108  1.3  christos extern Function		*rl_startup_hook;
    109  1.3  christos extern char		*rl_terminal_name;
    110  1.3  christos extern int		rl_already_prompted;
    111  1.3  christos extern char		*rl_prompt;
    112  1.3  christos /*
    113  1.3  christos  * The following is not implemented
    114  1.3  christos  */
    115  1.3  christos extern KEYMAP_ENTRY_ARRAY emacs_standard_keymap,
    116  1.3  christos 			emacs_meta_keymap,
    117  1.3  christos 			emacs_ctlx_keymap;
    118  1.3  christos extern int		rl_filename_completion_desired;
    119  1.3  christos extern int		rl_ignore_completion_duplicates;
    120  1.3  christos extern Function		*rl_getc_function;
    121  1.3  christos extern VFunction	*rl_redisplay_function;
    122  1.5  christos extern VFunction	*rl_completion_display_matches_hook;
    123  1.3  christos extern VFunction	*rl_prep_term_function;
    124  1.3  christos extern VFunction	*rl_deprep_term_function;
    125  1.1  jdolecek 
    126  1.1  jdolecek /* supported functions */
    127  1.1  jdolecek char		*readline(const char *);
    128  1.1  jdolecek int		 rl_initialize(void);
    129  1.1  jdolecek 
    130  1.1  jdolecek void		 using_history(void);
    131  1.1  jdolecek int		 add_history(const char *);
    132  1.1  jdolecek void		 clear_history(void);
    133  1.1  jdolecek void		 stifle_history(int);
    134  1.1  jdolecek int		 unstifle_history(void);
    135  1.1  jdolecek int		 history_is_stifled(void);
    136  1.1  jdolecek int		 where_history(void);
    137  1.1  jdolecek HIST_ENTRY	*current_history(void);
    138  1.1  jdolecek HIST_ENTRY	*history_get(int);
    139  1.1  jdolecek int		 history_total_bytes(void);
    140  1.1  jdolecek int		 history_set_pos(int);
    141  1.1  jdolecek HIST_ENTRY	*previous_history(void);
    142  1.1  jdolecek HIST_ENTRY	*next_history(void);
    143  1.1  jdolecek int		 history_search(const char *, int);
    144  1.1  jdolecek int		 history_search_prefix(const char *, int);
    145  1.1  jdolecek int		 history_search_pos(const char *, int, int);
    146  1.1  jdolecek int		 read_history(const char *);
    147  1.1  jdolecek int		 write_history(const char *);
    148  1.1  jdolecek int		 history_expand(char *, char **);
    149  1.1  jdolecek char	       **history_tokenize(const char *);
    150  1.1  jdolecek 
    151  1.1  jdolecek char		*tilde_expand(char *);
    152  1.1  jdolecek char		*filename_completion_function(const char *, int);
    153  1.1  jdolecek char		*username_completion_function(const char *, int);
    154  1.1  jdolecek int		 rl_complete(int, int);
    155  1.1  jdolecek int		 rl_read_key(void);
    156  1.1  jdolecek char	       **completion_matches(const char *, CPFunction *);
    157  1.1  jdolecek void		 rl_display_match_list(char **, int, int);
    158  1.1  jdolecek 
    159  1.1  jdolecek int		 rl_insert(int, int);
    160  1.1  jdolecek void		 rl_reset_terminal(const char *);
    161  1.1  jdolecek int		 rl_bind_key(int, int (*)(int, int));
    162  1.8  christos int		 rl_newline(int, int);
    163  1.8  christos void		 rl_callback_read_char(void);
    164  1.8  christos void		 rl_callback_handler_install(const char *, VFunction *);
    165  1.8  christos void		 rl_callback_handler_remove(void);
    166  1.8  christos void		 rl_redisplay(void);
    167  1.8  christos int		 rl_get_previous_history(int, int);
    168  1.9  christos void		 rl_prep_terminal(int);
    169  1.9  christos void		 rl_deprep_terminal(void);
    170  1.9  christos int		 rl_read_init_file(const char *);
    171  1.9  christos int		 rl_parse_and_bind(const char *);
    172  1.9  christos void		 rl_stuff_char(int);
    173  1.3  christos 
    174  1.3  christos /*
    175  1.3  christos  * The following are not implemented
    176  1.3  christos  */
    177  1.3  christos Keymap		 rl_get_keymap(void);
    178  1.3  christos Keymap		 rl_make_bare_keymap(void);
    179  1.3  christos int		 rl_add_defun(const char *, Function *, int);
    180  1.3  christos int		 rl_generic_bind(int, const char *, const char *, Keymap);
    181  1.3  christos int		 rl_bind_key_in_map(int, Function *, Keymap);
    182  1.2  christos #ifdef __cplusplus
    183  1.2  christos }
    184  1.2  christos #endif
    185  1.1  jdolecek 
    186  1.1  jdolecek #endif /* _READLINE_H_ */
    187