1 /* bind.c -- key binding and startup file support for the readline library. */
2
3 /* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc.
4
5 This file is part of the GNU Readline Library, a library for
6 reading lines of text with interactive input and history editing.
7
8 The GNU Readline Library is free software; you can redistribute it
9 and/or modify it under the terms of the GNU General Public License
10 as published by the Free Software Foundation; either version 2, or
11 (at your option) any later version.
12
13 The GNU Readline Library is distributed in the hope that it will be
14 useful, but WITHOUT ANY WARRANTY; without even the implied warranty
15 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 The GNU General Public License is often shipped with GNU software, and
19 is generally kept in a file called COPYING or LICENSE. If you do not
20 have a copy of the license, write to the Free Software Foundation,
21 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
22 #define READLINE_LIBRARY
23
24 #if defined (HAVE_CONFIG_H)
25 # include <config.h>
26 #endif
27
28 #include <stdio.h>
29 #include <sys/types.h>
30 #include <fcntl.h>
31 #if defined (HAVE_SYS_FILE_H)
32 # include <sys/file.h>
33 #endif /* HAVE_SYS_FILE_H */
34
35 #if defined (HAVE_UNISTD_H)
36 # include <unistd.h>
37 #endif /* HAVE_UNISTD_H */
38
39 #if defined (HAVE_STDLIB_H)
40 # include <stdlib.h>
41 #else
42 # include "ansi_stdlib.h"
43 #endif /* HAVE_STDLIB_H */
44
45 #include <errno.h>
46
47 #if !defined (errno)
48 extern int errno;
49 #endif /* !errno */
50
51 #include "posixstat.h"
52
53 /* System-specific feature definitions and include files. */
54 #include "rldefs.h"
55
56 /* Some standard library routines. */
57 #include "readline.h"
58 #include "history.h"
59
60 #include "rlprivate.h"
61 #include "rlshell.h"
62 #include "xmalloc.h"
63
64 #if !defined (strchr) && !defined (__STDC__)
65 extern char *strchr (), *strrchr ();
66 #endif /* !strchr && !__STDC__ */
67
68 /* Variables exported by this file. */
69 Keymap rl_binding_keymap;
70
71 static char *_rl_read_file PARAMS((char *, size_t *));
72 static void _rl_init_file_error PARAMS((const char *));
73 static int _rl_read_init_file PARAMS((const char *, int));
74 static int glean_key_from_name PARAMS((char *));
75 static int substring_member_of_array PARAMS((char *, const char **));
76
77 static int currently_reading_init_file;
78
79 /* used only in this file */
80 static int _rl_prefer_visible_bell = 1;
81
82 /* **************************************************************** */
83 /* */
84 /* Binding keys */
85 /* */
86 /* **************************************************************** */
87
88 /* rl_add_defun (char *name, rl_command_func_t *function, int key)
89 Add NAME to the list of named functions. Make FUNCTION be the function
90 that gets called. If KEY is not -1, then bind it. */
91 int
rl_add_defun(name,function,key)92 rl_add_defun (name, function, key)
93 const char *name;
94 rl_command_func_t *function;
95 int key;
96 {
97 if (key != -1)
98 rl_bind_key (key, function);
99 rl_add_funmap_entry (name, function);
100 return 0;
101 }
102
103 /* Bind KEY to FUNCTION. Returns non-zero if KEY is out of range. */
104 int
rl_bind_key(key,function)105 rl_bind_key (key, function)
106 int key;
107 rl_command_func_t *function;
108 {
109 if (key < 0)
110 return (key);
111
112 if (META_CHAR (key) && _rl_convert_meta_chars_to_ascii)
113 {
114 if (_rl_keymap[ESC].type == ISKMAP)
115 {
116 Keymap escmap;
117
118 escmap = FUNCTION_TO_KEYMAP (_rl_keymap, ESC);
119 key = UNMETA (key);
120 escmap[key].type = ISFUNC;
121 escmap[key].function = function;
122 return (0);
123 }
124 return (key);
125 }
126
127 _rl_keymap[key].type = ISFUNC;
128 _rl_keymap[key].function = function;
129 rl_binding_keymap = _rl_keymap;
130 return (0);
131 }
132
133 /* Bind KEY to FUNCTION in MAP. Returns non-zero in case of invalid
134 KEY. */
135 int
rl_bind_key_in_map(key,function,map)136 rl_bind_key_in_map (key, function, map)
137 int key;
138 rl_command_func_t *function;
139 Keymap map;
140 {
141 int result;
142 Keymap oldmap;
143
144 oldmap = _rl_keymap;
145 _rl_keymap = map;
146 result = rl_bind_key (key, function);
147 _rl_keymap = oldmap;
148 return (result);
149 }
150
151 /* Make KEY do nothing in the currently selected keymap.
152 Returns non-zero in case of error. */
153 int
rl_unbind_key(key)154 rl_unbind_key (key)
155 int key;
156 {
157 return (rl_bind_key (key, (rl_command_func_t *)NULL));
158 }
159
160 /* Make KEY do nothing in MAP.
161 Returns non-zero in case of error. */
162 int
rl_unbind_key_in_map(key,map)163 rl_unbind_key_in_map (key, map)
164 int key;
165 Keymap map;
166 {
167 return (rl_bind_key_in_map (key, (rl_command_func_t *)NULL, map));
168 }
169
170 /* Unbind all keys bound to FUNCTION in MAP. */
171 int
rl_unbind_function_in_map(func,map)172 rl_unbind_function_in_map (func, map)
173 rl_command_func_t *func;
174 Keymap map;
175 {
176 register int i, rval;
177
178 for (i = rval = 0; i < KEYMAP_SIZE; i++)
179 {
180 if (map[i].type == ISFUNC && map[i].function == func)
181 {
182 map[i].function = (rl_command_func_t *)NULL;
183 rval = 1;
184 }
185 }
186 return rval;
187 }
188
189 int
rl_unbind_command_in_map(command,map)190 rl_unbind_command_in_map (command, map)
191 const char *command;
192 Keymap map;
193 {
194 rl_command_func_t *func;
195
196 func = rl_named_function (command);
197 if (func == 0)
198 return 0;
199 return (rl_unbind_function_in_map (func, map));
200 }
201
202 /* Bind the key sequence represented by the string KEYSEQ to
203 FUNCTION. This makes new keymaps as necessary. The initial
204 place to do bindings is in MAP. */
205 int
rl_set_key(keyseq,function,map)206 rl_set_key (keyseq, function, map)
207 const char *keyseq;
208 rl_command_func_t *function;
209 Keymap map;
210 {
211 return (rl_generic_bind (ISFUNC, keyseq, (char *)function, map));
212 }
213
214 /* Bind the key sequence represented by the string KEYSEQ to
215 the string of characters MACRO. This makes new keymaps as
216 necessary. The initial place to do bindings is in MAP. */
217 int
rl_macro_bind(keyseq,macro,map)218 rl_macro_bind (keyseq, macro, map)
219 const char *keyseq, *macro;
220 Keymap map;
221 {
222 char *macro_keys;
223 int macro_keys_len;
224
225 macro_keys = (char *)xmalloc ((2 * strlen (macro)) + 1);
226
227 if (rl_translate_keyseq (macro, macro_keys, ¯o_keys_len))
228 {
229 free (macro_keys);
230 return -1;
231 }
232 rl_generic_bind (ISMACR, keyseq, macro_keys, map);
233 return 0;
234 }
235
236 /* Bind the key sequence represented by the string KEYSEQ to
237 the arbitrary pointer DATA. TYPE says what kind of data is
238 pointed to by DATA, right now this can be a function (ISFUNC),
239 a macro (ISMACR), or a keymap (ISKMAP). This makes new keymaps
240 as necessary. The initial place to do bindings is in MAP. */
241 int
rl_generic_bind(type,keyseq,data,map)242 rl_generic_bind (type, keyseq, data, map)
243 int type;
244 const char *keyseq;
245 char *data;
246 Keymap map;
247 {
248 char *keys;
249 int keys_len;
250 register int i;
251 KEYMAP_ENTRY k;
252
253 k.function = 0;
254
255 /* If no keys to bind to, exit right away. */
256 if (!keyseq || !*keyseq)
257 {
258 if (type == ISMACR)
259 free (data);
260 return -1;
261 }
262
263 keys = (char *)xmalloc (1 + (2 * strlen (keyseq)));
264
265 /* Translate the ASCII representation of KEYSEQ into an array of
266 characters. Stuff the characters into KEYS, and the length of
267 KEYS into KEYS_LEN. */
268 if (rl_translate_keyseq (keyseq, keys, &keys_len))
269 {
270 free (keys);
271 return -1;
272 }
273
274 /* Bind keys, making new keymaps as necessary. */
275 for (i = 0; i < keys_len; i++)
276 {
277 unsigned char uc = keys[i];
278 int ic;
279
280 ic = uc;
281 if (ic < 0 || ic >= KEYMAP_SIZE)
282 return -1;
283
284 if (_rl_convert_meta_chars_to_ascii && META_CHAR (ic))
285 {
286 ic = UNMETA (ic);
287 if (map[ESC].type == ISKMAP)
288 map = FUNCTION_TO_KEYMAP (map, ESC);
289 }
290
291 if ((i + 1) < keys_len)
292 {
293 if (map[ic].type != ISKMAP)
294 {
295 /* We allow subsequences of keys. If a keymap is being
296 created that will `shadow' an existing function or macro
297 key binding, we save that keybinding into the ANYOTHERKEY
298 index in the new map. The dispatch code will look there
299 to find the function to execute if the subsequence is not
300 matched. ANYOTHERKEY was chosen to be greater than
301 UCHAR_MAX. */
302 k = map[ic];
303
304 map[ic].type = ISKMAP;
305 map[ic].function = KEYMAP_TO_FUNCTION (rl_make_bare_keymap());
306 }
307 map = FUNCTION_TO_KEYMAP (map, ic);
308 /* The dispatch code will return this function if no matching
309 key sequence is found in the keymap. This (with a little
310 help from the dispatch code in readline.c) allows `a' to be
311 mapped to something, `abc' to be mapped to something else,
312 and the function bound to `a' to be executed when the user
313 types `abx', leaving `bx' in the input queue. */
314 if (k.function && ((k.type == ISFUNC && k.function != rl_do_lowercase_version) || k.type == ISMACR))
315 {
316 map[ANYOTHERKEY] = k;
317 k.function = 0;
318 }
319 }
320 else
321 {
322 if (map[ic].type == ISMACR)
323 free ((char *)map[ic].function);
324 else if (map[ic].type == ISKMAP)
325 {
326 map = FUNCTION_TO_KEYMAP (map, ic);
327 ic = ANYOTHERKEY;
328 }
329
330 map[ic].function = KEYMAP_TO_FUNCTION (data);
331 map[ic].type = type;
332 }
333
334 rl_binding_keymap = map;
335 }
336 free (keys);
337 return 0;
338 }
339
340 /* Translate the ASCII representation of SEQ, stuffing the values into ARRAY,
341 an array of characters. LEN gets the final length of ARRAY. Return
342 non-zero if there was an error parsing SEQ. */
343 int
rl_translate_keyseq(seq,array,len)344 rl_translate_keyseq (seq, array, len)
345 const char *seq;
346 char *array;
347 int *len;
348 {
349 register int i, c, l, temp;
350
351 for (i = l = 0; (c = seq[i]); i++)
352 {
353 if (c == '\\')
354 {
355 c = seq[++i];
356
357 if (c == 0)
358 break;
359
360 /* Handle \C- and \M- prefixes. */
361 if ((c == 'C' || c == 'M') && seq[i + 1] == '-')
362 {
363 /* Handle special case of backwards define. */
364 if (strncmp (&seq[i], "C-\\M-", 5) == 0)
365 {
366 array[l++] = ESC; /* ESC is meta-prefix */
367 i += 5;
368 array[l++] = CTRL (_rl_to_upper (seq[i]));
369 if (seq[i] == '\0')
370 i--;
371 }
372 else if (c == 'M')
373 {
374 i++;
375 array[l++] = ESC; /* ESC is meta-prefix */
376 }
377 else if (c == 'C')
378 {
379 i += 2;
380 /* Special hack for C-?... */
381 array[l++] = (seq[i] == '?') ? RUBOUT : CTRL (_rl_to_upper (seq[i]));
382 }
383 continue;
384 }
385
386 /* Translate other backslash-escaped characters. These are the
387 same escape sequences that bash's `echo' and `printf' builtins
388 handle, with the addition of \d -> RUBOUT. A backslash
389 preceding a character that is not special is stripped. */
390 switch (c)
391 {
392 case 'a':
393 array[l++] = '\007';
394 break;
395 case 'b':
396 array[l++] = '\b';
397 break;
398 case 'd':
399 array[l++] = RUBOUT; /* readline-specific */
400 break;
401 case 'e':
402 array[l++] = ESC;
403 break;
404 case 'f':
405 array[l++] = '\f';
406 break;
407 case 'n':
408 array[l++] = NEWLINE;
409 break;
410 case 'r':
411 array[l++] = RETURN;
412 break;
413 case 't':
414 array[l++] = TAB;
415 break;
416 case 'v':
417 array[l++] = 0x0B;
418 break;
419 case '\\':
420 array[l++] = '\\';
421 break;
422 case '0': case '1': case '2': case '3':
423 case '4': case '5': case '6': case '7':
424 i++;
425 for (temp = 2, c -= '0'; ISOCTAL (seq[i]) && temp--; i++)
426 c = (c * 8) + OCTVALUE (seq[i]);
427 i--; /* auto-increment in for loop */
428 array[l++] = c & largest_char;
429 break;
430 case 'x':
431 i++;
432 for (temp = 2, c = 0; ISXDIGIT ((unsigned char)seq[i]) && temp--; i++)
433 c = (c * 16) + HEXVALUE (seq[i]);
434 if (temp == 2)
435 c = 'x';
436 i--; /* auto-increment in for loop */
437 array[l++] = c & largest_char;
438 break;
439 default: /* backslashes before non-special chars just add the char */
440 array[l++] = c;
441 break; /* the backslash is stripped */
442 }
443 continue;
444 }
445
446 array[l++] = c;
447 }
448
449 *len = l;
450 array[l] = '\0';
451 return (0);
452 }
453
454 char *
rl_untranslate_keyseq(seq)455 rl_untranslate_keyseq (seq)
456 int seq;
457 {
458 static char kseq[16];
459 int i, c;
460
461 i = 0;
462 c = seq;
463 if (META_CHAR (c))
464 {
465 kseq[i++] = '\\';
466 kseq[i++] = 'M';
467 kseq[i++] = '-';
468 c = UNMETA (c);
469 }
470 else if (CTRL_CHAR (c))
471 {
472 kseq[i++] = '\\';
473 kseq[i++] = 'C';
474 kseq[i++] = '-';
475 c = _rl_to_lower (UNCTRL (c));
476 }
477 else if (c == RUBOUT)
478 {
479 kseq[i++] = '\\';
480 kseq[i++] = 'C';
481 kseq[i++] = '-';
482 c = '?';
483 }
484
485 if (c == ESC)
486 {
487 kseq[i++] = '\\';
488 c = 'e';
489 }
490 else if (c == '\\' || c == '"')
491 {
492 kseq[i++] = '\\';
493 }
494
495 kseq[i++] = (unsigned char) c;
496 kseq[i] = '\0';
497 return kseq;
498 }
499
500 static char *
_rl_untranslate_macro_value(seq)501 _rl_untranslate_macro_value (seq)
502 char *seq;
503 {
504 char *ret, *r, *s;
505 int c;
506
507 r = ret = (char *)xmalloc (7 * strlen (seq) + 1);
508 for (s = seq; *s; s++)
509 {
510 c = *s;
511 if (META_CHAR (c))
512 {
513 *r++ = '\\';
514 *r++ = 'M';
515 *r++ = '-';
516 c = UNMETA (c);
517 }
518 else if (CTRL_CHAR (c) && c != ESC)
519 {
520 *r++ = '\\';
521 *r++ = 'C';
522 *r++ = '-';
523 c = _rl_to_lower (UNCTRL (c));
524 }
525 else if (c == RUBOUT)
526 {
527 *r++ = '\\';
528 *r++ = 'C';
529 *r++ = '-';
530 c = '?';
531 }
532
533 if (c == ESC)
534 {
535 *r++ = '\\';
536 c = 'e';
537 }
538 else if (c == '\\' || c == '"')
539 *r++ = '\\';
540
541 *r++ = (unsigned char)c;
542 }
543 *r = '\0';
544 return ret;
545 }
546
547 /* Return a pointer to the function that STRING represents.
548 If STRING doesn't have a matching function, then a NULL pointer
549 is returned. */
550 rl_command_func_t *
rl_named_function(string)551 rl_named_function (string)
552 const char *string;
553 {
554 register int i;
555
556 rl_initialize_funmap ();
557
558 for (i = 0; funmap[i]; i++)
559 if (_rl_stricmp (funmap[i]->name, string) == 0)
560 return (funmap[i]->function);
561 return ((rl_command_func_t *)NULL);
562 }
563
564 /* Return the function (or macro) definition which would be invoked via
565 KEYSEQ if executed in MAP. If MAP is NULL, then the current keymap is
566 used. TYPE, if non-NULL, is a pointer to an int which will receive the
567 type of the object pointed to. One of ISFUNC (function), ISKMAP (keymap),
568 or ISMACR (macro). */
569 rl_command_func_t *
rl_function_of_keyseq(keyseq,map,type)570 rl_function_of_keyseq (keyseq, map, type)
571 const char *keyseq;
572 Keymap map;
573 int *type;
574 {
575 register int i;
576
577 if (!map)
578 map = _rl_keymap;
579
580 for (i = 0; keyseq && keyseq[i]; i++)
581 {
582 unsigned char ic = keyseq[i];
583
584 if (META_CHAR (ic) && _rl_convert_meta_chars_to_ascii)
585 {
586 if (map[ESC].type != ISKMAP)
587 {
588 if (type)
589 *type = map[ESC].type;
590
591 return (map[ESC].function);
592 }
593 else
594 {
595 map = FUNCTION_TO_KEYMAP (map, ESC);
596 ic = UNMETA (ic);
597 }
598 }
599
600 if (map[ic].type == ISKMAP)
601 {
602 /* If this is the last key in the key sequence, return the
603 map. */
604 if (!keyseq[i + 1])
605 {
606 if (type)
607 *type = ISKMAP;
608
609 return (map[ic].function);
610 }
611 else
612 map = FUNCTION_TO_KEYMAP (map, ic);
613 }
614 else
615 {
616 if (type)
617 *type = map[ic].type;
618
619 return (map[ic].function);
620 }
621 }
622 return ((rl_command_func_t *) NULL);
623 }
624
625 /* The last key bindings file read. */
626 static char *last_readline_init_file = (char *)NULL;
627
628 /* The file we're currently reading key bindings from. */
629 static const char *current_readline_init_file;
630 static int current_readline_init_include_level;
631 static int current_readline_init_lineno;
632
633 /* Read FILENAME into a locally-allocated buffer and return the buffer.
634 The size of the buffer is returned in *SIZEP. Returns NULL if any
635 errors were encountered. */
636 static char *
_rl_read_file(filename,sizep)637 _rl_read_file (filename, sizep)
638 char *filename;
639 size_t *sizep;
640 {
641 struct stat finfo;
642 size_t file_size;
643 char *buffer;
644 int i, file;
645
646 if ((stat (filename, &finfo) < 0) || (file = open (filename, O_RDONLY, 0666)) < 0)
647 return ((char *)NULL);
648
649 file_size = (size_t)finfo.st_size;
650
651 /* check for overflow on very large files */
652 if (file_size != finfo.st_size || file_size + 1 < file_size)
653 {
654 if (file >= 0)
655 close (file);
656 #if defined (EFBIG)
657 errno = EFBIG;
658 #endif
659 return ((char *)NULL);
660 }
661
662 /* Read the file into BUFFER. */
663 buffer = (char *)xmalloc (file_size + 1);
664 i = read (file, buffer, file_size);
665 close (file);
666
667 if (i < 0)
668 {
669 free (buffer);
670 return ((char *)NULL);
671 }
672
673 buffer[i] = '\0';
674 if (sizep)
675 *sizep = i;
676
677 return (buffer);
678 }
679
680 /* Re-read the current keybindings file. */
681 int
rl_re_read_init_file(count,ignore)682 rl_re_read_init_file (count, ignore)
683 int count, ignore;
684 {
685 int r;
686 r = rl_read_init_file ((const char *)NULL);
687 rl_set_keymap_from_edit_mode ();
688 return r;
689 }
690
691 /* Do key bindings from a file. If FILENAME is NULL it defaults
692 to the first non-null filename from this list:
693 1. the filename used for the previous call
694 2. the value of the shell variable `INPUTRC'
695 3. ~/.inputrc
696 If the file existed and could be opened and read, 0 is returned,
697 otherwise errno is returned. */
698 int
rl_read_init_file(filename)699 rl_read_init_file (filename)
700 const char *filename;
701 {
702 /* Default the filename. */
703 if (filename == 0)
704 {
705 filename = last_readline_init_file;
706 if (filename == 0)
707 filename = sh_get_env_value ("INPUTRC");
708 if (filename == 0 || *filename == '\0')
709 filename = DEFAULT_INPUTRC;
710 }
711
712 if (*filename == 0)
713 filename = DEFAULT_INPUTRC;
714
715 #if defined (__MSDOS__)
716 if (_rl_read_init_file (filename, 0) == 0)
717 return 0;
718 filename = "~/_inputrc";
719 #endif
720 return (_rl_read_init_file (filename, 0));
721 }
722
723 static int
_rl_read_init_file(filename,include_level)724 _rl_read_init_file (filename, include_level)
725 const char *filename;
726 int include_level;
727 {
728 register int i;
729 char *buffer, *openname, *line, *end;
730 size_t file_size;
731
732 current_readline_init_file = filename;
733 current_readline_init_include_level = include_level;
734
735 openname = tilde_expand (filename);
736 buffer = _rl_read_file (openname, &file_size);
737 free (openname);
738
739 if (buffer == 0)
740 return (errno);
741
742 if (include_level == 0 && filename != last_readline_init_file)
743 {
744 FREE (last_readline_init_file);
745 last_readline_init_file = savestring (filename);
746 }
747
748 currently_reading_init_file = 1;
749
750 /* Loop over the lines in the file. Lines that start with `#' are
751 comments; all other lines are commands for readline initialization. */
752 current_readline_init_lineno = 1;
753 line = buffer;
754 end = buffer + file_size;
755 while (line < end)
756 {
757 /* Find the end of this line. */
758 for (i = 0; line + i != end && line[i] != '\n'; i++);
759
760 #if defined (__CYGWIN__)
761 /* ``Be liberal in what you accept.'' */
762 if (line[i] == '\n' && line[i-1] == '\r')
763 line[i - 1] = '\0';
764 #endif
765
766 /* Mark end of line. */
767 line[i] = '\0';
768
769 /* Skip leading whitespace. */
770 while (*line && whitespace (*line))
771 {
772 line++;
773 i--;
774 }
775
776 /* If the line is not a comment, then parse it. */
777 if (*line && *line != '#')
778 rl_parse_and_bind (line);
779
780 /* Move to the next line. */
781 line += i + 1;
782 current_readline_init_lineno++;
783 }
784
785 free (buffer);
786 currently_reading_init_file = 0;
787 return (0);
788 }
789
790 static void
_rl_init_file_error(msg)791 _rl_init_file_error (msg)
792 const char *msg;
793 {
794 if (currently_reading_init_file)
795 fprintf (stderr, "readline: %s: line %d: %s\n", current_readline_init_file,
796 current_readline_init_lineno, msg);
797 else
798 fprintf (stderr, "readline: %s\n", msg);
799 }
800
801 /* **************************************************************** */
802 /* */
803 /* Parser Directives */
804 /* */
805 /* **************************************************************** */
806
807 typedef int _rl_parser_func_t PARAMS((char *));
808
809 /* Things that mean `Control'. */
810 const char *_rl_possible_control_prefixes[] = {
811 "Control-", "C-", "CTRL-", (const char *)NULL
812 };
813
814 const char *_rl_possible_meta_prefixes[] = {
815 "Meta", "M-", (const char *)NULL
816 };
817
818 /* Conditionals. */
819
820 /* Calling programs set this to have their argv[0]. */
821 const char *rl_readline_name = "other";
822
823 /* Stack of previous values of parsing_conditionalized_out. */
824 static unsigned char *if_stack = (unsigned char *)NULL;
825 static int if_stack_depth;
826 static int if_stack_size;
827
828 /* Push _rl_parsing_conditionalized_out, and set parser state based
829 on ARGS. */
830 static int
parser_if(args)831 parser_if (args)
832 char *args;
833 {
834 register int i;
835
836 /* Push parser state. */
837 if (if_stack_depth + 1 >= if_stack_size)
838 {
839 if (!if_stack)
840 if_stack = (unsigned char *)xmalloc (if_stack_size = 20);
841 else
842 if_stack = (unsigned char *)xrealloc (if_stack, if_stack_size += 20);
843 }
844 if_stack[if_stack_depth++] = _rl_parsing_conditionalized_out;
845
846 /* If parsing is turned off, then nothing can turn it back on except
847 for finding the matching endif. In that case, return right now. */
848 if (_rl_parsing_conditionalized_out)
849 return 0;
850
851 /* Isolate first argument. */
852 for (i = 0; args[i] && !whitespace (args[i]); i++);
853
854 if (args[i])
855 args[i++] = '\0';
856
857 /* Handle "$if term=foo" and "$if mode=emacs" constructs. If this
858 isn't term=foo, or mode=emacs, then check to see if the first
859 word in ARGS is the same as the value stored in rl_readline_name. */
860 if (rl_terminal_name && _rl_strnicmp (args, "term=", 5) == 0)
861 {
862 char *tem, *tname;
863
864 /* Terminals like "aaa-60" are equivalent to "aaa". */
865 tname = savestring (rl_terminal_name);
866 tem = strchr (tname, '-');
867 if (tem)
868 *tem = '\0';
869
870 /* Test the `long' and `short' forms of the terminal name so that
871 if someone has a `sun-cmd' and does not want to have bindings
872 that will be executed if the terminal is a `sun', they can put
873 `$if term=sun-cmd' into their .inputrc. */
874 _rl_parsing_conditionalized_out = _rl_stricmp (args + 5, tname) &&
875 _rl_stricmp (args + 5, rl_terminal_name);
876 free (tname);
877 }
878 #if defined (VI_MODE)
879 else if (_rl_strnicmp (args, "mode=", 5) == 0)
880 {
881 int mode;
882
883 if (_rl_stricmp (args + 5, "emacs") == 0)
884 mode = emacs_mode;
885 else if (_rl_stricmp (args + 5, "vi") == 0)
886 mode = vi_mode;
887 else
888 mode = no_mode;
889
890 _rl_parsing_conditionalized_out = mode != rl_editing_mode;
891 }
892 #endif /* VI_MODE */
893 /* Check to see if the first word in ARGS is the same as the
894 value stored in rl_readline_name. */
895 else if (_rl_stricmp (args, rl_readline_name) == 0)
896 _rl_parsing_conditionalized_out = 0;
897 else
898 _rl_parsing_conditionalized_out = 1;
899 return 0;
900 }
901
902 /* Invert the current parser state if there is anything on the stack. */
903 static int
parser_else(args)904 parser_else (args)
905 char *args;
906 {
907 register int i;
908
909 if (if_stack_depth == 0)
910 {
911 _rl_init_file_error ("$else found without matching $if");
912 return 0;
913 }
914
915 /* Check the previous (n - 1) levels of the stack to make sure that
916 we haven't previously turned off parsing. */
917 for (i = 0; i < if_stack_depth - 1; i++)
918 if (if_stack[i] == 1)
919 return 0;
920
921 /* Invert the state of parsing if at top level. */
922 _rl_parsing_conditionalized_out = !_rl_parsing_conditionalized_out;
923 return 0;
924 }
925
926 /* Terminate a conditional, popping the value of
927 _rl_parsing_conditionalized_out from the stack. */
928 static int
parser_endif(args)929 parser_endif (args)
930 char *args;
931 {
932 if (if_stack_depth)
933 _rl_parsing_conditionalized_out = if_stack[--if_stack_depth];
934 else
935 _rl_init_file_error ("$endif without matching $if");
936 return 0;
937 }
938
939 static int
parser_include(args)940 parser_include (args)
941 char *args;
942 {
943 const char *old_init_file;
944 char *e;
945 int old_line_number, old_include_level, r;
946
947 if (_rl_parsing_conditionalized_out)
948 return (0);
949
950 old_init_file = current_readline_init_file;
951 old_line_number = current_readline_init_lineno;
952 old_include_level = current_readline_init_include_level;
953
954 e = strchr (args, '\n');
955 if (e)
956 *e = '\0';
957 r = _rl_read_init_file ((const char *)args, old_include_level + 1);
958
959 current_readline_init_file = old_init_file;
960 current_readline_init_lineno = old_line_number;
961 current_readline_init_include_level = old_include_level;
962
963 return r;
964 }
965
966 /* Associate textual names with actual functions. */
967 static struct {
968 const char *name;
969 _rl_parser_func_t *function;
970 } parser_directives [] = {
971 { "if", parser_if },
972 { "endif", parser_endif },
973 { "else", parser_else },
974 { "include", parser_include },
975 { (char *)0x0, (_rl_parser_func_t *)0x0 }
976 };
977
978 /* Handle a parser directive. STATEMENT is the line of the directive
979 without any leading `$'. */
980 static int
handle_parser_directive(statement)981 handle_parser_directive (statement)
982 char *statement;
983 {
984 register int i;
985 char *directive, *args;
986
987 /* Isolate the actual directive. */
988
989 /* Skip whitespace. */
990 for (i = 0; whitespace (statement[i]); i++);
991
992 directive = &statement[i];
993
994 for (; statement[i] && !whitespace (statement[i]); i++);
995
996 if (statement[i])
997 statement[i++] = '\0';
998
999 for (; statement[i] && whitespace (statement[i]); i++);
1000
1001 args = &statement[i];
1002
1003 /* Lookup the command, and act on it. */
1004 for (i = 0; parser_directives[i].name; i++)
1005 if (_rl_stricmp (directive, parser_directives[i].name) == 0)
1006 {
1007 (*parser_directives[i].function) (args);
1008 return (0);
1009 }
1010
1011 /* display an error message about the unknown parser directive */
1012 _rl_init_file_error ("unknown parser directive");
1013 return (1);
1014 }
1015
1016 /* Read the binding command from STRING and perform it.
1017 A key binding command looks like: Keyname: function-name\0,
1018 a variable binding command looks like: set variable value.
1019 A new-style keybinding looks like "\C-x\C-x": exchange-point-and-mark. */
1020 int
rl_parse_and_bind(string)1021 rl_parse_and_bind (string)
1022 char *string;
1023 {
1024 char *funname, *kname;
1025 register int c, i;
1026 int key, equivalency;
1027
1028 while (string && whitespace (*string))
1029 string++;
1030
1031 if (!string || !*string || *string == '#')
1032 return 0;
1033
1034 /* If this is a parser directive, act on it. */
1035 if (*string == '$')
1036 {
1037 handle_parser_directive (&string[1]);
1038 return 0;
1039 }
1040
1041 /* If we aren't supposed to be parsing right now, then we're done. */
1042 if (_rl_parsing_conditionalized_out)
1043 return 0;
1044
1045 i = 0;
1046 /* If this keyname is a complex key expression surrounded by quotes,
1047 advance to after the matching close quote. This code allows the
1048 backslash to quote characters in the key expression. */
1049 if (*string == '"')
1050 {
1051 int passc = 0;
1052
1053 for (i = 1; (c = string[i]); i++)
1054 {
1055 if (passc)
1056 {
1057 passc = 0;
1058 continue;
1059 }
1060
1061 if (c == '\\')
1062 {
1063 passc++;
1064 continue;
1065 }
1066
1067 if (c == '"')
1068 break;
1069 }
1070 /* If we didn't find a closing quote, abort the line. */
1071 if (string[i] == '\0')
1072 {
1073 _rl_init_file_error ("no closing `\"' in key binding");
1074 return 1;
1075 }
1076 }
1077
1078 /* Advance to the colon (:) or whitespace which separates the two objects. */
1079 for (; (c = string[i]) && c != ':' && c != ' ' && c != '\t'; i++ );
1080
1081 equivalency = (c == ':' && string[i + 1] == '=');
1082
1083 /* Mark the end of the command (or keyname). */
1084 if (string[i])
1085 string[i++] = '\0';
1086
1087 /* If doing assignment, skip the '=' sign as well. */
1088 if (equivalency)
1089 string[i++] = '\0';
1090
1091 /* If this is a command to set a variable, then do that. */
1092 if (_rl_stricmp (string, "set") == 0)
1093 {
1094 char *var = string + i;
1095 char *value;
1096
1097 /* Make VAR point to start of variable name. */
1098 while (*var && whitespace (*var)) var++;
1099
1100 /* Make VALUE point to start of value string. */
1101 value = var;
1102 while (*value && !whitespace (*value)) value++;
1103 if (*value)
1104 *value++ = '\0';
1105 while (*value && whitespace (*value)) value++;
1106
1107 rl_variable_bind (var, value);
1108 return 0;
1109 }
1110
1111 /* Skip any whitespace between keyname and funname. */
1112 for (; string[i] && whitespace (string[i]); i++);
1113 funname = &string[i];
1114
1115 /* Now isolate funname.
1116 For straight function names just look for whitespace, since
1117 that will signify the end of the string. But this could be a
1118 macro definition. In that case, the string is quoted, so skip
1119 to the matching delimiter. We allow the backslash to quote the
1120 delimiter characters in the macro body. */
1121 /* This code exists to allow whitespace in macro expansions, which
1122 would otherwise be gobbled up by the next `for' loop.*/
1123 /* XXX - it may be desirable to allow backslash quoting only if " is
1124 the quoted string delimiter, like the shell. */
1125 if (*funname == '\'' || *funname == '"')
1126 {
1127 int delimiter = string[i++], passc;
1128
1129 for (passc = 0; (c = string[i]); i++)
1130 {
1131 if (passc)
1132 {
1133 passc = 0;
1134 continue;
1135 }
1136
1137 if (c == '\\')
1138 {
1139 passc = 1;
1140 continue;
1141 }
1142
1143 if (c == delimiter)
1144 break;
1145 }
1146 if (c)
1147 i++;
1148 }
1149
1150 /* Advance to the end of the string. */
1151 for (; string[i] && !whitespace (string[i]); i++);
1152
1153 /* No extra whitespace at the end of the string. */
1154 string[i] = '\0';
1155
1156 /* Handle equivalency bindings here. Make the left-hand side be exactly
1157 whatever the right-hand evaluates to, including keymaps. */
1158 if (equivalency)
1159 {
1160 return 0;
1161 }
1162
1163 /* If this is a new-style key-binding, then do the binding with
1164 rl_set_key (). Otherwise, let the older code deal with it. */
1165 if (*string == '"')
1166 {
1167 char *seq;
1168 register int j, k, passc;
1169
1170 seq = (char *)xmalloc (1 + strlen (string));
1171 for (j = 1, k = passc = 0; string[j]; j++)
1172 {
1173 /* Allow backslash to quote characters, but leave them in place.
1174 This allows a string to end with a backslash quoting another
1175 backslash, or with a backslash quoting a double quote. The
1176 backslashes are left in place for rl_translate_keyseq (). */
1177 if (passc || (string[j] == '\\'))
1178 {
1179 seq[k++] = string[j];
1180 passc = !passc;
1181 continue;
1182 }
1183
1184 if (string[j] == '"')
1185 break;
1186
1187 seq[k++] = string[j];
1188 }
1189 seq[k] = '\0';
1190
1191 /* Binding macro? */
1192 if (*funname == '\'' || *funname == '"')
1193 {
1194 j = strlen (funname);
1195
1196 /* Remove the delimiting quotes from each end of FUNNAME. */
1197 if (j && funname[j - 1] == *funname)
1198 funname[j - 1] = '\0';
1199
1200 rl_macro_bind (seq, &funname[1], _rl_keymap);
1201 }
1202 else
1203 rl_set_key (seq, rl_named_function (funname), _rl_keymap);
1204
1205 free (seq);
1206 return 0;
1207 }
1208
1209 /* Get the actual character we want to deal with. */
1210 kname = strrchr (string, '-');
1211 if (!kname)
1212 kname = string;
1213 else
1214 kname++;
1215
1216 key = glean_key_from_name (kname);
1217
1218 /* Add in control and meta bits. */
1219 if (substring_member_of_array (string, _rl_possible_control_prefixes))
1220 key = CTRL (_rl_to_upper (key));
1221
1222 if (substring_member_of_array (string, _rl_possible_meta_prefixes))
1223 key = META (key);
1224
1225 /* Temporary. Handle old-style keyname with macro-binding. */
1226 if (*funname == '\'' || *funname == '"')
1227 {
1228 char useq[2];
1229 int fl = strlen (funname);
1230
1231 useq[0] = key; useq[1] = '\0';
1232 if (fl && funname[fl - 1] == *funname)
1233 funname[fl - 1] = '\0';
1234
1235 rl_macro_bind (useq, &funname[1], _rl_keymap);
1236 }
1237 #if defined (PREFIX_META_HACK)
1238 /* Ugly, but working hack to keep prefix-meta around. */
1239 else if (_rl_stricmp (funname, "prefix-meta") == 0)
1240 {
1241 char seq[2];
1242
1243 seq[0] = key;
1244 seq[1] = '\0';
1245 rl_generic_bind (ISKMAP, seq, (char *)emacs_meta_keymap, _rl_keymap);
1246 }
1247 #endif /* PREFIX_META_HACK */
1248 else
1249 rl_bind_key (key, rl_named_function (funname));
1250 return 0;
1251 }
1252
1253 /* Simple structure for boolean readline variables (i.e., those that can
1254 have one of two values; either "On" or 1 for truth, or "Off" or 0 for
1255 false. */
1256
1257 #define V_SPECIAL 0x1
1258
1259 static struct {
1260 const char *name;
1261 int *value;
1262 int flags;
1263 } boolean_varlist [] = {
1264 { "blink-matching-paren", &rl_blink_matching_paren, V_SPECIAL },
1265 { "byte-oriented", &rl_byte_oriented, 0 },
1266 { "completion-ignore-case", &_rl_completion_case_fold, 0 },
1267 { "convert-meta", &_rl_convert_meta_chars_to_ascii, 0 },
1268 { "disable-completion", &rl_inhibit_completion, 0 },
1269 { "enable-keypad", &_rl_enable_keypad, 0 },
1270 { "expand-tilde", &rl_complete_with_tilde_expansion, 0 },
1271 { "history-preserve-point", &_rl_history_preserve_point, 0 },
1272 { "horizontal-scroll-mode", &_rl_horizontal_scroll_mode, 0 },
1273 { "input-meta", &_rl_meta_flag, 0 },
1274 { "mark-directories", &_rl_complete_mark_directories, 0 },
1275 { "mark-modified-lines", &_rl_mark_modified_lines, 0 },
1276 { "mark-symlinked-directories", &_rl_complete_mark_symlink_dirs, 0 },
1277 { "match-hidden-files", &_rl_match_hidden_files, 0 },
1278 { "meta-flag", &_rl_meta_flag, 0 },
1279 { "output-meta", &_rl_output_meta_chars, 0 },
1280 { "page-completions", &_rl_page_completions, 0 },
1281 { "prefer-visible-bell", &_rl_prefer_visible_bell, V_SPECIAL },
1282 { "print-completions-horizontally", &_rl_print_completions_horizontally, 0 },
1283 { "show-all-if-ambiguous", &_rl_complete_show_all, 0 },
1284 #if defined (VISIBLE_STATS)
1285 { "visible-stats", &rl_visible_stats, 0 },
1286 #endif /* VISIBLE_STATS */
1287 { (char *)NULL, (int *)NULL }
1288 };
1289
1290 static int
find_boolean_var(name)1291 find_boolean_var (name)
1292 const char *name;
1293 {
1294 register int i;
1295
1296 for (i = 0; boolean_varlist[i].name; i++)
1297 if (_rl_stricmp (name, boolean_varlist[i].name) == 0)
1298 return i;
1299 return -1;
1300 }
1301
1302 /* Hooks for handling special boolean variables, where a
1303 function needs to be called or another variable needs
1304 to be changed when they're changed. */
1305 static void
hack_special_boolean_var(i)1306 hack_special_boolean_var (i)
1307 int i;
1308 {
1309 const char *name;
1310
1311 name = boolean_varlist[i].name;
1312
1313 if (_rl_stricmp (name, "blink-matching-paren") == 0)
1314 _rl_enable_paren_matching (rl_blink_matching_paren);
1315 else if (_rl_stricmp (name, "prefer-visible-bell") == 0)
1316 {
1317 if (_rl_prefer_visible_bell)
1318 _rl_bell_preference = VISIBLE_BELL;
1319 else
1320 _rl_bell_preference = AUDIBLE_BELL;
1321 }
1322 }
1323
1324 typedef int _rl_sv_func_t PARAMS((const char *));
1325
1326 /* These *must* correspond to the array indices for the appropriate
1327 string variable. (Though they're not used right now.) */
1328 #define V_BELLSTYLE 0
1329 #define V_COMBEGIN 1
1330 #define V_EDITMODE 2
1331 #define V_ISRCHTERM 3
1332 #define V_KEYMAP 4
1333
1334 #define V_STRING 1
1335 #define V_INT 2
1336
1337 /* Forward declarations */
1338 static int sv_bell_style PARAMS((const char *));
1339 static int sv_combegin PARAMS((const char *));
1340 static int sv_compquery PARAMS((const char *));
1341 static int sv_editmode PARAMS((const char *));
1342 static int sv_isrchterm PARAMS((const char *));
1343 static int sv_keymap PARAMS((const char *));
1344
1345 static struct {
1346 const char *name;
1347 int flags;
1348 _rl_sv_func_t *set_func;
1349 } string_varlist[] = {
1350 { "bell-style", V_STRING, sv_bell_style },
1351 { "comment-begin", V_STRING, sv_combegin },
1352 { "completion-query-items", V_INT, sv_compquery },
1353 { "editing-mode", V_STRING, sv_editmode },
1354 { "isearch-terminators", V_STRING, sv_isrchterm },
1355 { "keymap", V_STRING, sv_keymap },
1356 { (char *)NULL, 0 }
1357 };
1358
1359 static int
find_string_var(name)1360 find_string_var (name)
1361 const char *name;
1362 {
1363 register int i;
1364
1365 for (i = 0; string_varlist[i].name; i++)
1366 if (_rl_stricmp (name, string_varlist[i].name) == 0)
1367 return i;
1368 return -1;
1369 }
1370
1371 /* A boolean value that can appear in a `set variable' command is true if
1372 the value is null or empty, `on' (case-insenstive), or "1". Any other
1373 values result in 0 (false). */
1374 static int
bool_to_int(value)1375 bool_to_int (value)
1376 const char *value;
1377 {
1378 return (value == 0 || *value == '\0' ||
1379 (_rl_stricmp (value, "on") == 0) ||
1380 (value[0] == '1' && value[1] == '\0'));
1381 }
1382
1383 int
rl_variable_bind(name,value)1384 rl_variable_bind (name, value)
1385 const char *name, *value;
1386 {
1387 register int i;
1388 int v;
1389
1390 /* Check for simple variables first. */
1391 i = find_boolean_var (name);
1392 if (i >= 0)
1393 {
1394 *boolean_varlist[i].value = bool_to_int (value);
1395 if (boolean_varlist[i].flags & V_SPECIAL)
1396 hack_special_boolean_var (i);
1397 return 0;
1398 }
1399
1400 i = find_string_var (name);
1401
1402 /* For the time being, unknown variable names or string names without a
1403 handler function are simply ignored. */
1404 if (i < 0 || string_varlist[i].set_func == 0)
1405 return 0;
1406
1407 v = (*string_varlist[i].set_func) (value);
1408 return v;
1409 }
1410
1411 static int
sv_editmode(value)1412 sv_editmode (value)
1413 const char *value;
1414 {
1415 if (_rl_strnicmp (value, "vi", 2) == 0)
1416 {
1417 #if defined (VI_MODE)
1418 _rl_keymap = vi_insertion_keymap;
1419 rl_editing_mode = vi_mode;
1420 #endif /* VI_MODE */
1421 return 0;
1422 }
1423 else if (_rl_strnicmp (value, "emacs", 5) == 0)
1424 {
1425 _rl_keymap = emacs_standard_keymap;
1426 rl_editing_mode = emacs_mode;
1427 return 0;
1428 }
1429 return 1;
1430 }
1431
1432 static int
sv_combegin(value)1433 sv_combegin (value)
1434 const char *value;
1435 {
1436 if (value && *value)
1437 {
1438 FREE (_rl_comment_begin);
1439 _rl_comment_begin = savestring (value);
1440 return 0;
1441 }
1442 return 1;
1443 }
1444
1445 static int
sv_compquery(value)1446 sv_compquery (value)
1447 const char *value;
1448 {
1449 int nval = 100;
1450
1451 if (value && *value)
1452 {
1453 nval = atoi (value);
1454 if (nval < 0)
1455 nval = 0;
1456 }
1457 rl_completion_query_items = nval;
1458 return 0;
1459 }
1460
1461 static int
sv_keymap(value)1462 sv_keymap (value)
1463 const char *value;
1464 {
1465 Keymap kmap;
1466
1467 kmap = rl_get_keymap_by_name (value);
1468 if (kmap)
1469 {
1470 rl_set_keymap (kmap);
1471 return 0;
1472 }
1473 return 1;
1474 }
1475
1476 static int
sv_bell_style(value)1477 sv_bell_style (value)
1478 const char *value;
1479 {
1480 if (value == 0 || *value == '\0')
1481 _rl_bell_preference = AUDIBLE_BELL;
1482 else if (_rl_stricmp (value, "none") == 0 || _rl_stricmp (value, "off") == 0)
1483 _rl_bell_preference = NO_BELL;
1484 else if (_rl_stricmp (value, "audible") == 0 || _rl_stricmp (value, "on") == 0)
1485 _rl_bell_preference = AUDIBLE_BELL;
1486 else if (_rl_stricmp (value, "visible") == 0)
1487 _rl_bell_preference = VISIBLE_BELL;
1488 else
1489 return 1;
1490 return 0;
1491 }
1492
1493 static int
sv_isrchterm(value)1494 sv_isrchterm (value)
1495 const char *value;
1496 {
1497 int beg, end, delim;
1498 char *v;
1499
1500 if (value == 0)
1501 return 1;
1502
1503 /* Isolate the value and translate it into a character string. */
1504 v = savestring (value);
1505 FREE (_rl_isearch_terminators);
1506 if (v[0] == '"' || v[0] == '\'')
1507 {
1508 delim = v[0];
1509 for (beg = end = 1; v[end] && v[end] != delim; end++)
1510 ;
1511 }
1512 else
1513 {
1514 for (beg = end = 0; whitespace (v[end]) == 0; end++)
1515 ;
1516 }
1517
1518 v[end] = '\0';
1519
1520 /* The value starts at v + beg. Translate it into a character string. */
1521 _rl_isearch_terminators = (char *)xmalloc (2 * strlen (v) + 1);
1522 rl_translate_keyseq (v + beg, _rl_isearch_terminators, &end);
1523 _rl_isearch_terminators[end] = '\0';
1524
1525 free (v);
1526 return 0;
1527 }
1528
1529 /* Return the character which matches NAME.
1530 For example, `Space' returns ' '. */
1531
1532 typedef struct {
1533 const char *name;
1534 int value;
1535 } assoc_list;
1536
1537 static assoc_list name_key_alist[] = {
1538 { "DEL", 0x7f },
1539 { "ESC", '\033' },
1540 { "Escape", '\033' },
1541 { "LFD", '\n' },
1542 { "Newline", '\n' },
1543 { "RET", '\r' },
1544 { "Return", '\r' },
1545 { "Rubout", 0x7f },
1546 { "SPC", ' ' },
1547 { "Space", ' ' },
1548 { "Tab", 0x09 },
1549 { (char *)0x0, 0 }
1550 };
1551
1552 static int
glean_key_from_name(name)1553 glean_key_from_name (name)
1554 char *name;
1555 {
1556 register int i;
1557
1558 for (i = 0; name_key_alist[i].name; i++)
1559 if (_rl_stricmp (name, name_key_alist[i].name) == 0)
1560 return (name_key_alist[i].value);
1561
1562 return (*(unsigned char *)name); /* XXX was return (*name) */
1563 }
1564
1565 /* Auxiliary functions to manage keymaps. */
1566 static struct {
1567 const char *name;
1568 Keymap map;
1569 } keymap_names[] = {
1570 { "emacs", emacs_standard_keymap },
1571 { "emacs-standard", emacs_standard_keymap },
1572 { "emacs-meta", emacs_meta_keymap },
1573 { "emacs-ctlx", emacs_ctlx_keymap },
1574 #if defined (VI_MODE)
1575 { "vi", vi_movement_keymap },
1576 { "vi-move", vi_movement_keymap },
1577 { "vi-command", vi_movement_keymap },
1578 { "vi-insert", vi_insertion_keymap },
1579 #endif /* VI_MODE */
1580 { (char *)0x0, (Keymap)0x0 }
1581 };
1582
1583 Keymap
rl_get_keymap_by_name(name)1584 rl_get_keymap_by_name (name)
1585 const char *name;
1586 {
1587 register int i;
1588
1589 for (i = 0; keymap_names[i].name; i++)
1590 if (_rl_stricmp (name, keymap_names[i].name) == 0)
1591 return (keymap_names[i].map);
1592 return ((Keymap) NULL);
1593 }
1594
1595 char *
rl_get_keymap_name(map)1596 rl_get_keymap_name (map)
1597 Keymap map;
1598 {
1599 register int i;
1600 for (i = 0; keymap_names[i].name; i++)
1601 if (map == keymap_names[i].map)
1602 return ((char *)keymap_names[i].name);
1603 return ((char *)NULL);
1604 }
1605
1606 void
rl_set_keymap(map)1607 rl_set_keymap (map)
1608 Keymap map;
1609 {
1610 if (map)
1611 _rl_keymap = map;
1612 }
1613
1614 Keymap
rl_get_keymap()1615 rl_get_keymap ()
1616 {
1617 return (_rl_keymap);
1618 }
1619
1620 void
rl_set_keymap_from_edit_mode()1621 rl_set_keymap_from_edit_mode ()
1622 {
1623 if (rl_editing_mode == emacs_mode)
1624 _rl_keymap = emacs_standard_keymap;
1625 #if defined (VI_MODE)
1626 else if (rl_editing_mode == vi_mode)
1627 _rl_keymap = vi_insertion_keymap;
1628 #endif /* VI_MODE */
1629 }
1630
1631 char *
rl_get_keymap_name_from_edit_mode()1632 rl_get_keymap_name_from_edit_mode ()
1633 {
1634 if (rl_editing_mode == emacs_mode)
1635 return "emacs";
1636 #if defined (VI_MODE)
1637 else if (rl_editing_mode == vi_mode)
1638 return "vi";
1639 #endif /* VI_MODE */
1640 else
1641 return "none";
1642 }
1643
1644 /* **************************************************************** */
1645 /* */
1646 /* Key Binding and Function Information */
1647 /* */
1648 /* **************************************************************** */
1649
1650 /* Each of the following functions produces information about the
1651 state of keybindings and functions known to Readline. The info
1652 is always printed to rl_outstream, and in such a way that it can
1653 be read back in (i.e., passed to rl_parse_and_bind (). */
1654
1655 /* Print the names of functions known to Readline. */
1656 void
rl_list_funmap_names()1657 rl_list_funmap_names ()
1658 {
1659 register int i;
1660 const char **funmap_names;
1661
1662 funmap_names = rl_funmap_names ();
1663
1664 if (!funmap_names)
1665 return;
1666
1667 for (i = 0; funmap_names[i]; i++)
1668 fprintf (rl_outstream, "%s\n", funmap_names[i]);
1669
1670 free (funmap_names);
1671 }
1672
1673 static char *
_rl_get_keyname(key)1674 _rl_get_keyname (key)
1675 int key;
1676 {
1677 char *keyname;
1678 int i, c;
1679
1680 keyname = (char *)xmalloc (8);
1681
1682 c = key;
1683 /* Since this is going to be used to write out keysequence-function
1684 pairs for possible inclusion in an inputrc file, we don't want to
1685 do any special meta processing on KEY. */
1686
1687 #if 1
1688 /* XXX - Experimental */
1689 /* We might want to do this, but the old version of the code did not. */
1690
1691 /* If this is an escape character, we don't want to do any more processing.
1692 Just add the special ESC key sequence and return. */
1693 if (c == ESC)
1694 {
1695 keyname[0] = '\\';
1696 keyname[1] = 'e';
1697 keyname[2] = '\0';
1698 return keyname;
1699 }
1700 #endif
1701
1702 /* RUBOUT is translated directly into \C-? */
1703 if (key == RUBOUT)
1704 {
1705 keyname[0] = '\\';
1706 keyname[1] = 'C';
1707 keyname[2] = '-';
1708 keyname[3] = '?';
1709 keyname[4] = '\0';
1710 return keyname;
1711 }
1712
1713 i = 0;
1714 /* Now add special prefixes needed for control characters. This can
1715 potentially change C. */
1716 if (CTRL_CHAR (c))
1717 {
1718 keyname[i++] = '\\';
1719 keyname[i++] = 'C';
1720 keyname[i++] = '-';
1721 c = _rl_to_lower (UNCTRL (c));
1722 }
1723
1724 /* XXX experimental code. Turn the characters that are not ASCII or
1725 ISO Latin 1 (128 - 159) into octal escape sequences (\200 - \237).
1726 This changes C. */
1727 if (c >= 128 && c <= 159)
1728 {
1729 keyname[i++] = '\\';
1730 keyname[i++] = '2';
1731 c -= 128;
1732 keyname[i++] = (c / 8) + '0';
1733 c = (c % 8) + '0';
1734 }
1735
1736 /* Now, if the character needs to be quoted with a backslash, do that. */
1737 if (c == '\\' || c == '"')
1738 keyname[i++] = '\\';
1739
1740 /* Now add the key, terminate the string, and return it. */
1741 keyname[i++] = (char) c;
1742 keyname[i] = '\0';
1743
1744 return keyname;
1745 }
1746
1747 /* Return a NULL terminated array of strings which represent the key
1748 sequences that are used to invoke FUNCTION in MAP. */
1749 char **
rl_invoking_keyseqs_in_map(function,map)1750 rl_invoking_keyseqs_in_map (function, map)
1751 rl_command_func_t *function;
1752 Keymap map;
1753 {
1754 register int key;
1755 char **result;
1756 int result_index, result_size;
1757
1758 result = (char **)NULL;
1759 result_index = result_size = 0;
1760
1761 for (key = 0; key < KEYMAP_SIZE; key++)
1762 {
1763 switch (map[key].type)
1764 {
1765 case ISMACR:
1766 /* Macros match, if, and only if, the pointers are identical.
1767 Thus, they are treated exactly like functions in here. */
1768 case ISFUNC:
1769 /* If the function in the keymap is the one we are looking for,
1770 then add the current KEY to the list of invoking keys. */
1771 if (map[key].function == function)
1772 {
1773 char *keyname;
1774
1775 keyname = _rl_get_keyname (key);
1776
1777 if (result_index + 2 > result_size)
1778 {
1779 result_size += 10;
1780 result = (char **)xrealloc (result, result_size * sizeof (char *));
1781 }
1782
1783 result[result_index++] = keyname;
1784 result[result_index] = (char *)NULL;
1785 }
1786 break;
1787
1788 case ISKMAP:
1789 {
1790 char **seqs;
1791 register int i;
1792
1793 /* Find the list of keyseqs in this map which have FUNCTION as
1794 their target. Add the key sequences found to RESULT. */
1795 if (map[key].function)
1796 seqs =
1797 rl_invoking_keyseqs_in_map (function, FUNCTION_TO_KEYMAP (map, key));
1798 else
1799 break;
1800
1801 if (seqs == 0)
1802 break;
1803
1804 for (i = 0; seqs[i]; i++)
1805 {
1806 int len = 6 + strlen(seqs[i]);
1807 char *keyname = (char *)xmalloc (len);
1808
1809 if (key == ESC)
1810 #if 0
1811 snprintf(keyname, len, "\\e");
1812 #else
1813 /* XXX - experimental */
1814 snprintf(keyname, len, "\\M-");
1815 #endif
1816 else if (CTRL_CHAR (key))
1817 snprintf(keyname, len, "\\C-%c", _rl_to_lower (UNCTRL (key)));
1818 else if (key == RUBOUT)
1819 snprintf(keyname, len, "\\C-?");
1820 else if (key == '\\' || key == '"')
1821 {
1822 keyname[0] = '\\';
1823 keyname[1] = (char) key;
1824 keyname[2] = '\0';
1825 }
1826 else
1827 {
1828 keyname[0] = (char) key;
1829 keyname[1] = '\0';
1830 }
1831
1832 strlcat (keyname, seqs[i], len);
1833 free (seqs[i]);
1834
1835 if (result_index + 2 > result_size)
1836 {
1837 result_size += 10;
1838 result = (char **)xrealloc (result, result_size * sizeof (char *));
1839 }
1840
1841 result[result_index++] = keyname;
1842 result[result_index] = (char *)NULL;
1843 }
1844
1845 free (seqs);
1846 }
1847 break;
1848 }
1849 }
1850 return (result);
1851 }
1852
1853 /* Return a NULL terminated array of strings which represent the key
1854 sequences that can be used to invoke FUNCTION using the current keymap. */
1855 char **
rl_invoking_keyseqs(function)1856 rl_invoking_keyseqs (function)
1857 rl_command_func_t *function;
1858 {
1859 return (rl_invoking_keyseqs_in_map (function, _rl_keymap));
1860 }
1861
1862 /* Print all of the functions and their bindings to rl_outstream. If
1863 PRINT_READABLY is non-zero, then print the output in such a way
1864 that it can be read back in. */
1865 void
rl_function_dumper(print_readably)1866 rl_function_dumper (print_readably)
1867 int print_readably;
1868 {
1869 register int i;
1870 const char **names;
1871 const char *name;
1872
1873 names = rl_funmap_names ();
1874
1875 fprintf (rl_outstream, "\n");
1876
1877 for (i = 0; (name = names[i]); i++)
1878 {
1879 rl_command_func_t *function;
1880 char **invokers;
1881
1882 function = rl_named_function (name);
1883 invokers = rl_invoking_keyseqs_in_map (function, _rl_keymap);
1884
1885 if (print_readably)
1886 {
1887 if (!invokers)
1888 fprintf (rl_outstream, "# %s (not bound)\n", name);
1889 else
1890 {
1891 register int j;
1892
1893 for (j = 0; invokers[j]; j++)
1894 {
1895 fprintf (rl_outstream, "\"%s\": %s\n",
1896 invokers[j], name);
1897 free (invokers[j]);
1898 }
1899
1900 free (invokers);
1901 }
1902 }
1903 else
1904 {
1905 if (!invokers)
1906 fprintf (rl_outstream, "%s is not bound to any keys\n",
1907 name);
1908 else
1909 {
1910 register int j;
1911
1912 fprintf (rl_outstream, "%s can be found on ", name);
1913
1914 for (j = 0; invokers[j] && j < 5; j++)
1915 {
1916 fprintf (rl_outstream, "\"%s\"%s", invokers[j],
1917 invokers[j + 1] ? ", " : ".\n");
1918 }
1919
1920 if (j == 5 && invokers[j])
1921 fprintf (rl_outstream, "...\n");
1922
1923 for (j = 0; invokers[j]; j++)
1924 free (invokers[j]);
1925
1926 free (invokers);
1927 }
1928 }
1929 }
1930 }
1931
1932 /* Print all of the current functions and their bindings to
1933 rl_outstream. If an explicit argument is given, then print
1934 the output in such a way that it can be read back in. */
1935 int
rl_dump_functions(count,key)1936 rl_dump_functions (count, key)
1937 int count, key;
1938 {
1939 if (rl_dispatching)
1940 fprintf (rl_outstream, "\r\n");
1941 rl_function_dumper (rl_explicit_arg);
1942 rl_on_new_line ();
1943 return (0);
1944 }
1945
1946 static void
_rl_macro_dumper_internal(print_readably,map,prefix)1947 _rl_macro_dumper_internal (print_readably, map, prefix)
1948 int print_readably;
1949 Keymap map;
1950 char *prefix;
1951 {
1952 register int key;
1953 char *keyname, *out;
1954 int prefix_len;
1955
1956 for (key = 0; key < KEYMAP_SIZE; key++)
1957 {
1958 switch (map[key].type)
1959 {
1960 case ISMACR:
1961 keyname = _rl_get_keyname (key);
1962 out = _rl_untranslate_macro_value ((char *)map[key].function);
1963
1964 if (print_readably)
1965 fprintf (rl_outstream, "\"%s%s\": \"%s\"\n", prefix ? prefix : "",
1966 keyname,
1967 out ? out : "");
1968 else
1969 fprintf (rl_outstream, "%s%s outputs %s\n", prefix ? prefix : "",
1970 keyname,
1971 out ? out : "");
1972 free (keyname);
1973 free (out);
1974 break;
1975 case ISFUNC:
1976 break;
1977 case ISKMAP:
1978 prefix_len = prefix ? strlen (prefix) : 0;
1979 if (key == ESC)
1980 {
1981 int len = 3 + prefix_len;
1982 keyname = (char *)xmalloc (len);
1983 if (prefix)
1984 strlcpy (keyname, prefix, len);
1985 keyname[prefix_len] = '\\';
1986 keyname[prefix_len + 1] = 'e';
1987 keyname[prefix_len + 2] = '\0';
1988 }
1989 else
1990 {
1991 keyname = _rl_get_keyname (key);
1992 if (prefix)
1993 {
1994 if (asprintf(&out, "%s%s", prefix, keyname) == -1)
1995 memory_error_and_abort("asprintf");
1996 free (keyname);
1997 keyname = out;
1998 }
1999 }
2000
2001 _rl_macro_dumper_internal (print_readably, FUNCTION_TO_KEYMAP (map, key), keyname);
2002 free (keyname);
2003 break;
2004 }
2005 }
2006 }
2007
2008 void
rl_macro_dumper(print_readably)2009 rl_macro_dumper (print_readably)
2010 int print_readably;
2011 {
2012 _rl_macro_dumper_internal (print_readably, _rl_keymap, (char *)NULL);
2013 }
2014
2015 int
rl_dump_macros(count,key)2016 rl_dump_macros (count, key)
2017 int count, key;
2018 {
2019 if (rl_dispatching)
2020 fprintf (rl_outstream, "\r\n");
2021 rl_macro_dumper (rl_explicit_arg);
2022 rl_on_new_line ();
2023 return (0);
2024 }
2025
2026 void
rl_variable_dumper(print_readably)2027 rl_variable_dumper (print_readably)
2028 int print_readably;
2029 {
2030 int i;
2031 const char *kname;
2032
2033 for (i = 0; boolean_varlist[i].name; i++)
2034 {
2035 if (print_readably)
2036 fprintf (rl_outstream, "set %s %s\n", boolean_varlist[i].name,
2037 *boolean_varlist[i].value ? "on" : "off");
2038 else
2039 fprintf (rl_outstream, "%s is set to `%s'\n", boolean_varlist[i].name,
2040 *boolean_varlist[i].value ? "on" : "off");
2041 }
2042
2043 /* bell-style */
2044 switch (_rl_bell_preference)
2045 {
2046 case NO_BELL:
2047 kname = "none"; break;
2048 case VISIBLE_BELL:
2049 kname = "visible"; break;
2050 case AUDIBLE_BELL:
2051 default:
2052 kname = "audible"; break;
2053 }
2054 if (print_readably)
2055 fprintf (rl_outstream, "set bell-style %s\n", kname);
2056 else
2057 fprintf (rl_outstream, "bell-style is set to `%s'\n", kname);
2058
2059 /* comment-begin */
2060 if (print_readably)
2061 fprintf (rl_outstream, "set comment-begin %s\n", _rl_comment_begin ? _rl_comment_begin : RL_COMMENT_BEGIN_DEFAULT);
2062 else
2063 fprintf (rl_outstream, "comment-begin is set to `%s'\n", _rl_comment_begin ? _rl_comment_begin : RL_COMMENT_BEGIN_DEFAULT);
2064
2065 /* completion-query-items */
2066 if (print_readably)
2067 fprintf (rl_outstream, "set completion-query-items %d\n", rl_completion_query_items);
2068 else
2069 fprintf (rl_outstream, "completion-query-items is set to `%d'\n", rl_completion_query_items);
2070
2071 /* editing-mode */
2072 if (print_readably)
2073 fprintf (rl_outstream, "set editing-mode %s\n", (rl_editing_mode == emacs_mode) ? "emacs" : "vi");
2074 else
2075 fprintf (rl_outstream, "editing-mode is set to `%s'\n", (rl_editing_mode == emacs_mode) ? "emacs" : "vi");
2076
2077 /* isearch-terminators */
2078 if (_rl_isearch_terminators)
2079 {
2080 char *disp;
2081
2082 disp = _rl_untranslate_macro_value (_rl_isearch_terminators);
2083
2084 if (print_readably)
2085 fprintf (rl_outstream, "set isearch-terminators \"%s\"\n", disp);
2086 else
2087 fprintf (rl_outstream, "isearch-terminators is set to \"%s\"\n", disp);
2088
2089 free (disp);
2090 }
2091
2092 /* keymap */
2093 kname = rl_get_keymap_name (_rl_keymap);
2094 if (kname == 0)
2095 kname = rl_get_keymap_name_from_edit_mode ();
2096 if (print_readably)
2097 fprintf (rl_outstream, "set keymap %s\n", kname ? kname : "none");
2098 else
2099 fprintf (rl_outstream, "keymap is set to `%s'\n", kname ? kname : "none");
2100 }
2101
2102 /* Print all of the current variables and their values to
2103 rl_outstream. If an explicit argument is given, then print
2104 the output in such a way that it can be read back in. */
2105 int
rl_dump_variables(count,key)2106 rl_dump_variables (count, key)
2107 int count, key;
2108 {
2109 if (rl_dispatching)
2110 fprintf (rl_outstream, "\r\n");
2111 rl_variable_dumper (rl_explicit_arg);
2112 rl_on_new_line ();
2113 return (0);
2114 }
2115
2116 /* Bind key sequence KEYSEQ to DEFAULT_FUNC if KEYSEQ is unbound. Right
2117 now, this is always used to attempt to bind the arrow keys, hence the
2118 check for rl_vi_movement_mode. */
2119 void
_rl_bind_if_unbound(keyseq,default_func)2120 _rl_bind_if_unbound (keyseq, default_func)
2121 const char *keyseq;
2122 rl_command_func_t *default_func;
2123 {
2124 rl_command_func_t *func;
2125
2126 if (keyseq)
2127 {
2128 func = rl_function_of_keyseq (keyseq, _rl_keymap, (int *)NULL);
2129 #if defined (VI_MODE)
2130 if (!func || func == rl_do_lowercase_version || func == rl_vi_movement_mode)
2131 #else
2132 if (!func || func == rl_do_lowercase_version)
2133 #endif
2134 rl_set_key (keyseq, default_func, _rl_keymap);
2135 }
2136 }
2137
2138 /* Return non-zero if any members of ARRAY are a substring in STRING. */
2139 static int
substring_member_of_array(string,array)2140 substring_member_of_array (string, array)
2141 char *string;
2142 const char **array;
2143 {
2144 while (*array)
2145 {
2146 if (_rl_strindex (string, *array))
2147 return (1);
2148 array++;
2149 }
2150 return (0);
2151 }
2152