include/readline/rltypedefs.h

0001 /* rltypedefs.h -- Type declarations for readline functions. */
0002
0003 /* Copyright (C) 2000-2023 Free Software Foundation, Inc.
0004
0005    This file is part of the GNU Readline Library (Readline), a library
0006    for reading lines of text with interactive input and history editing.
0007
0008    Readline is free software: you can redistribute it and/or modify
0009    it under the terms of the GNU General Public License as published by
0010    the Free Software Foundation, either version 3 of the License, or
0011    (at your option) any later version.
0012
0013    Readline is distributed in the hope that it will be useful,
0014    but WITHOUT ANY WARRANTY; without even the implied warranty of
0015    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0016    GNU General Public License for more details.
0017
0018    You should have received a copy of the GNU General Public License
0019    along with Readline.  If not, see <http://www.gnu.org/licenses/>.
0020 */
0021
0022 #ifndef _RL_TYPEDEFS_H_
0023 #define _RL_TYPEDEFS_H_
0024
0025 #ifdef __cplusplus
0026 extern "C" {
0027 #endif
0028
0029 /* Old-style, attempt to mark as deprecated in some way people will notice. */
0030
0031 #if !defined (_FUNCTION_DEF) && defined (WANT_OBSOLETE_TYPEDEFS)
0032 #  define _FUNCTION_DEF
0033
0034 typedef int Function () __attribute__((deprecated));
0035 typedef void VFunction () __attribute__((deprecated));
0036 typedef char *CPFunction () __attribute__((deprecated));
0037 typedef char **CPPFunction () __attribute__((deprecated));
0038
0039 #endif /* _FUNCTION_DEF && WANT_OBSOLETE_TYPEDEFS */
0040
0041 /* New style. */
0042
0043 #if !defined (_RL_FUNCTION_TYPEDEF)
0044 #  define _RL_FUNCTION_TYPEDEF
0045
0046 /* Bindable functions */
0047 typedef int rl_command_func_t (int, int);
0048
0049 /* Typedefs for the completion system */
0050 typedef char *rl_compentry_func_t (const char *, int);
0051 typedef char **rl_completion_func_t (const char *, int, int);
0052
0053 typedef char *rl_quote_func_t (char *, int, char *);
0054 typedef char *rl_dequote_func_t (char *, int);
0055
0056 typedef int rl_compignore_func_t (char **);
0057
0058 typedef void rl_compdisp_func_t (char **, int, int);
0059
0060 /* Functions for displaying key bindings. Currently only one. */
0061 typedef void rl_macro_print_func_t (const char *, const char *, int, const char *);
0062
0063 /* Type for input and pre-read hook functions like rl_event_hook */
0064 typedef int rl_hook_func_t (void);
0065
0066 /* Input function type */
0067 typedef int rl_getc_func_t (FILE *);
0068
0069 /* Generic function that takes a character buffer (which could be the readline
0070    line buffer) and an index into it (which could be rl_point) and returns
0071    an int. */
0072 typedef int rl_linebuf_func_t (char *, int);
0073
0074 /* `Generic' function pointer typedefs */
0075 typedef int rl_intfunc_t (int);
0076 #define rl_ivoidfunc_t rl_hook_func_t
0077 typedef int rl_icpfunc_t (char *);
0078 typedef int rl_icppfunc_t (char **);
0079
0080 typedef void rl_voidfunc_t (void);
0081 typedef void rl_vintfunc_t (int);
0082 typedef void rl_vcpfunc_t (char *);
0083 typedef void rl_vcppfunc_t (char **);
0084
0085 typedef char *rl_cpvfunc_t (void);
0086 typedef char *rl_cpifunc_t (int);
0087 typedef char *rl_cpcpfunc_t (char  *);
0088 typedef char *rl_cpcppfunc_t (char  **);
0089
0090 #endif /* _RL_FUNCTION_TYPEDEF */
0091
0092 #ifdef __cplusplus
0093 }
0094 #endif
0095
0096 #endif /* _RL_TYPEDEFS_H_ */