1 This file is bind.def, from which is created bind.c.
2 It implements the builtin "bind" in Bash.
4 Copyright (C) 1987-2009 Free Software Foundation, Inc.
6 This file is part of GNU Bash, the Bourne Again SHell.
8 Bash 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 Bash 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 Bash. If not, see <http://www.gnu.org/licenses/>.
27 $FUNCTION bind_builtin
28 $SHORT_DOC bind [-lpsvPSVX] [-m keymap] [-f filename] [-q name] [-u name] [-r keyseq] [-x keyseq:shell-command] [keyseq:readline-function or readline-command]
29 Set Readline key bindings and variables.
31 Bind a key sequence to a Readline function or a macro, or set a
32 Readline variable. The non-option argument syntax is equivalent to
33 that found in ~/.inputrc, but must be passed as a single argument:
34 e.g., bind '"\C-x\C-r": re-read-init-file'.
37 -m keymap Use KEYMAP as the keymap for the duration of this
38 command. Acceptable keymap names are emacs,
39 emacs-standard, emacs-meta, emacs-ctlx, vi, vi-move,
40 vi-command, and vi-insert.
41 -l List names of functions.
42 -P List function names and bindings.
43 -p List functions and bindings in a form that can be
45 -S List key sequences that invoke macros and their values
46 -s List key sequences that invoke macros and their values
47 in a form that can be reused as input.
48 -V List variable names and values
49 -v List variable names and values in a form that can
51 -q function-name Query about which keys invoke the named function.
52 -u function-name Unbind all keys which are bound to the named function.
53 -r keyseq Remove the binding for KEYSEQ.
54 -f filename Read key bindings from FILENAME.
55 -x keyseq:shell-command Cause SHELL-COMMAND to be executed when
57 -X List key sequences bound with -x and associated commands
58 in a form that can be reused as input.
61 bind returns 0 unless an unrecognized option is given or an error occurs.
64 #if defined (READLINE)
66 #if defined (HAVE_UNISTD_H)
68 # include <sys/types.h>
79 #include <readline/readline.h>
80 #include <readline/history.h>
82 #include "../bashintl.h"
85 #include "../bashline.h"
86 #include "bashgetopt.h"
89 static int query_bindings __P((char *));
90 static int unbind_command __P((char *));
92 extern int no_line_editing;
94 #define BIND_RETURN(x) do { return_code = x; goto bind_exit; } while (0)
103 #define PPFLAG 0x0080
104 #define VVFLAG 0x0100
106 #define SSFLAG 0x0400
109 #define XXFLAG 0x2000
116 Keymap kmap, saved_keymap;
118 char *initfile, *map_name, *fun_name, *unbind_name, *remove_seq, *cmd_seq;
123 builtin_error (_("line editing not enabled"));
124 return (EXECUTION_FAILURE);
126 builtin_warning (_("line editing not enabled"));
130 kmap = saved_keymap = (Keymap) NULL;
132 initfile = map_name = fun_name = unbind_name = remove_seq = (char *)NULL;
133 return_code = EXECUTION_SUCCESS;
135 if (bash_readline_initialized == 0)
136 initialize_readline ();
138 begin_unwind_frame ("bind_builtin");
139 unwind_protect_var (rl_outstream);
141 rl_outstream = stdout;
143 reset_internal_getopt ();
144 while ((opt = internal_getopt (list, "lvpVPsSXf:q:u:m:r:x:")) != EOF)
159 initfile = list_optarg;
163 map_name = list_optarg;
167 fun_name = list_optarg;
171 unbind_name = list_optarg;
175 remove_seq = list_optarg;
191 cmd_seq = list_optarg;
198 BIND_RETURN (EX_USAGE);
204 /* First, see if we need to install a special keymap for this
205 command. Then start on the arguments. */
207 if ((flags & MFLAG) && map_name)
209 kmap = rl_get_keymap_by_name (map_name);
212 builtin_error (_("`%s': invalid keymap name"), map_name);
213 BIND_RETURN (EXECUTION_FAILURE);
219 saved_keymap = rl_get_keymap ();
220 rl_set_keymap (kmap);
223 /* XXX - we need to add exclusive use tests here. It doesn't make sense
224 to use some of these options together. */
225 /* Now hack the option arguments */
227 rl_list_funmap_names ();
230 rl_function_dumper (1);
233 rl_function_dumper (0);
242 rl_variable_dumper (1);
245 rl_variable_dumper (0);
247 if ((flags & FFLAG) && initfile)
249 if (rl_read_init_file (initfile) != 0)
251 builtin_error (_("%s: cannot read: %s"), initfile, strerror (errno));
252 BIND_RETURN (EXECUTION_FAILURE);
256 if ((flags & QFLAG) && fun_name)
257 return_code = query_bindings (fun_name);
259 if ((flags & UFLAG) && unbind_name)
260 return_code = unbind_command (unbind_name);
262 if ((flags & RFLAG) && remove_seq)
264 if (rl_bind_keyseq (remove_seq, (rl_command_func_t *)NULL) != 0)
266 builtin_error (_("`%s': cannot unbind"), remove_seq);
267 BIND_RETURN (EXECUTION_FAILURE);
272 return_code = bind_keyseq_to_unix_command (cmd_seq);
275 return_code = print_unix_command_map ();
277 /* Process the rest of the arguments as binding specifications. */
280 rl_parse_and_bind (list->word->word);
286 rl_set_keymap (saved_keymap);
288 run_unwind_frame ("bind_builtin");
290 return (sh_chkwrite (return_code));
294 query_bindings (name)
297 rl_command_func_t *function;
301 function = rl_named_function (name);
304 builtin_error (_("`%s': unknown function name"), name);
305 return EXECUTION_FAILURE;
308 keyseqs = rl_invoking_keyseqs (function);
312 printf (_("%s is not bound to any keys.\n"), name);
313 return EXECUTION_FAILURE;
316 printf (_("%s can be invoked via "), name);
317 for (j = 0; j < 5 && keyseqs[j]; j++)
318 printf ("\"%s\"%s", keyseqs[j], keyseqs[j + 1] ? ", " : ".\n");
321 strvec_dispose (keyseqs);
322 return EXECUTION_SUCCESS;
326 unbind_command (name)
329 rl_command_func_t *function;
331 function = rl_named_function (name);
334 builtin_error (_("`%s': unknown function name"), name);
335 return EXECUTION_FAILURE;
338 rl_unbind_function_in_map (function, rl_get_keymap ());
339 return EXECUTION_SUCCESS;
341 #endif /* READLINE */