1 /* rltypedefs.h -- Type declarations for readline functions. */
3 /* Copyright (C) 2000-2011 Free Software Foundation, Inc.
5 This file is part of the GNU Readline Library (Readline), a library
6 for reading lines of text with interactive input and history editing.
8 Readline 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 3 of the License, or
11 (at your option) any later version.
13 Readline 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.
18 You should have received a copy of the GNU General Public License
19 along with Readline. If not, see <http://www.gnu.org/licenses/>.
22 #ifndef _RL_TYPEDEFS_H_
23 #define _RL_TYPEDEFS_H_
31 #if !defined (_RL_FUNCTION_TYPEDEF)
32 # define _RL_FUNCTION_TYPEDEF
34 /* Bindable functions */
35 typedef int rl_command_func_t PARAMS((int, int));
37 /* Typedefs for the completion system */
38 typedef char *rl_compentry_func_t PARAMS((const char *, int));
39 typedef char **rl_completion_func_t PARAMS((const char *, int, int));
41 typedef char *rl_quote_func_t PARAMS((char *, int, char *));
42 typedef char *rl_dequote_func_t PARAMS((char *, int));
44 typedef int rl_compignore_func_t PARAMS((char **));
46 typedef void rl_compdisp_func_t PARAMS((char **, int, int));
48 /* Type for input and pre-read hook functions like rl_event_hook */
49 typedef int rl_hook_func_t PARAMS((void));
51 /* Input function type */
52 typedef int rl_getc_func_t PARAMS((FILE *));
54 /* Generic function that takes a character buffer (which could be the readline
55 line buffer) and an index into it (which could be rl_point) and returns
57 typedef int rl_linebuf_func_t PARAMS((char *, int));
59 /* `Generic' function pointer typedefs */
60 typedef int rl_intfunc_t PARAMS((int));
61 #define rl_ivoidfunc_t rl_hook_func_t
62 typedef int rl_icpfunc_t PARAMS((char *));
63 typedef int rl_icppfunc_t PARAMS((char **));
65 typedef void rl_voidfunc_t PARAMS((void));
66 typedef void rl_vintfunc_t PARAMS((int));
67 typedef void rl_vcpfunc_t PARAMS((char *));
68 typedef void rl_vcppfunc_t PARAMS((char **));
70 typedef char *rl_cpvfunc_t PARAMS((void));
71 typedef char *rl_cpifunc_t PARAMS((int));
72 typedef char *rl_cpcpfunc_t PARAMS((char *));
73 typedef char *rl_cpcppfunc_t PARAMS((char **));
75 #endif /* _RL_FUNCTION_TYPEDEF */
81 #endif /* _RL_TYPEDEFS_H_ */