readline/funmap.c

   1 /* funmap.c -- attach names to functions. */
   2
   3 /* Copyright (C) 1987-2017 Free Software Foundation, Inc.
   4
   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.
   7
   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.
  12
  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.
  17
  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/>.
  20 */
  21
  22 #define READLINE_LIBRARY
  23
  24 #if defined (HAVE_CONFIG_H)
  25 #  include <config.h>
  26 #endif
  27
  28 #if !defined (BUFSIZ)
  29 #include <stdio.h>
  30 #endif /* BUFSIZ */
  31
  32 #if defined (HAVE_STDLIB_H)
  33 #  include <stdlib.h>
  34 #else
  35 #  include "ansi_stdlib.h"
  36 #endif /* HAVE_STDLIB_H */
  37
  38 #include "rlconf.h"
  39 #include "readline.h"
  40
  41 #include "xmalloc.h"
  42
  43 #ifdef __STDC__
  44 typedef int QSFUNC (const void *, const void *);
  45 #else
  46 typedef int QSFUNC ();
  47 #endif
  48
  49 extern int _rl_qsort_string_compare PARAMS((char **, char **));
  50
  51 FUNMAP **funmap;
  52 static int funmap_size;
  53 static int funmap_entry;
  54
  55 /* After initializing the function map, this is the index of the first
  56    program specific function. */
  57 int funmap_program_specific_entry_start;
  58
  59 static const FUNMAP default_funmap[] = {
  60   { "abort", rl_abort },
  61   { "accept-line", rl_newline },
  62   { "arrow-key-prefix", rl_arrow_keys },
  63   { "backward-byte", rl_backward_byte },
  64   { "backward-char", rl_backward_char },
  65   { "backward-delete-char", rl_rubout },
  66   { "backward-kill-line", rl_backward_kill_line },
  67   { "backward-kill-word", rl_backward_kill_word },
  68   { "backward-word", rl_backward_word },
  69   { "beginning-of-history", rl_beginning_of_history },
  70   { "beginning-of-line", rl_beg_of_line },
  71   { "bracketed-paste-begin", rl_bracketed_paste_begin },
  72   { "call-last-kbd-macro", rl_call_last_kbd_macro },
  73   { "capitalize-word", rl_capitalize_word },
  74   { "character-search", rl_char_search },
  75   { "character-search-backward", rl_backward_char_search },
  76   { "clear-screen", rl_clear_screen },
  77   { "complete", rl_complete },
  78   { "copy-backward-word", rl_copy_backward_word },
  79   { "copy-forward-word", rl_copy_forward_word },
  80   { "copy-region-as-kill", rl_copy_region_to_kill },
  81   { "delete-char", rl_delete },
  82   { "delete-char-or-list", rl_delete_or_show_completions },
  83   { "delete-horizontal-space", rl_delete_horizontal_space },
  84   { "digit-argument", rl_digit_argument },
  85   { "do-lowercase-version", rl_do_lowercase_version },
  86   { "downcase-word", rl_downcase_word },
  87   { "dump-functions", rl_dump_functions },
  88   { "dump-macros", rl_dump_macros },
  89   { "dump-variables", rl_dump_variables },
  90   { "emacs-editing-mode", rl_emacs_editing_mode },
  91   { "end-kbd-macro", rl_end_kbd_macro },
  92   { "end-of-history", rl_end_of_history },
  93   { "end-of-line", rl_end_of_line },
  94   { "exchange-point-and-mark", rl_exchange_point_and_mark },
  95   { "forward-backward-delete-char", rl_rubout_or_delete },
  96   { "forward-byte", rl_forward_byte },
  97   { "forward-char", rl_forward_char },
  98   { "forward-search-history", rl_forward_search_history },
  99   { "forward-word", rl_forward_word },
 100   { "history-search-backward", rl_history_search_backward },
 101   { "history-search-forward", rl_history_search_forward },
 102   { "history-substring-search-backward", rl_history_substr_search_backward },
 103   { "history-substring-search-forward", rl_history_substr_search_forward },
 104   { "insert-comment", rl_insert_comment },
 105   { "insert-completions", rl_insert_completions },
 106   { "kill-whole-line", rl_kill_full_line },
 107   { "kill-line", rl_kill_line },
 108   { "kill-region", rl_kill_region },
 109   { "kill-word", rl_kill_word },
 110   { "menu-complete", rl_menu_complete },
 111   { "menu-complete-backward", rl_backward_menu_complete },
 112   { "next-history", rl_get_next_history },
 113   { "next-screen-line", rl_next_screen_line },
 114   { "non-incremental-forward-search-history", rl_noninc_forward_search },
 115   { "non-incremental-reverse-search-history", rl_noninc_reverse_search },
 116   { "non-incremental-forward-search-history-again", rl_noninc_forward_search_again },
 117   { "non-incremental-reverse-search-history-again", rl_noninc_reverse_search_again },
 118   { "old-menu-complete", rl_old_menu_complete },
 119   { "overwrite-mode", rl_overwrite_mode },
 120 #if defined (_WIN32)
 121   { "paste-from-clipboard", rl_paste_from_clipboard },
 122 #endif
 123   { "possible-completions", rl_possible_completions },
 124   { "previous-history", rl_get_previous_history },
 125   { "previous-screen-line", rl_previous_screen_line },
 126   { "print-last-kbd-macro", rl_print_last_kbd_macro },
 127   { "quoted-insert", rl_quoted_insert },
 128   { "re-read-init-file", rl_re_read_init_file },
 129   { "redraw-current-line", rl_refresh_line},
 130   { "reverse-search-history", rl_reverse_search_history },
 131   { "revert-line", rl_revert_line },
 132   { "self-insert", rl_insert },
 133   { "set-mark", rl_set_mark },
 134   { "skip-csi-sequence", rl_skip_csi_sequence },
 135   { "start-kbd-macro", rl_start_kbd_macro },
 136   { "tab-insert", rl_tab_insert },
 137   { "tilde-expand", rl_tilde_expand },
 138   { "transpose-chars", rl_transpose_chars },
 139   { "transpose-words", rl_transpose_words },
 140   { "tty-status", rl_tty_status },
 141   { "undo", rl_undo_command },
 142   { "universal-argument", rl_universal_argument },
 143   { "unix-filename-rubout", rl_unix_filename_rubout },
 144   { "unix-line-discard", rl_unix_line_discard },
 145   { "unix-word-rubout", rl_unix_word_rubout },
 146   { "upcase-word", rl_upcase_word },
 147   { "yank", rl_yank },
 148   { "yank-last-arg", rl_yank_last_arg },
 149   { "yank-nth-arg", rl_yank_nth_arg },
 150   { "yank-pop", rl_yank_pop },
 151
 152 #if defined (VI_MODE)
 153   { "vi-append-eol", rl_vi_append_eol },
 154   { "vi-append-mode", rl_vi_append_mode },
 155   { "vi-arg-digit", rl_vi_arg_digit },
 156   { "vi-back-to-indent", rl_vi_back_to_indent },
 157   { "vi-backward-bigword", rl_vi_bWord },
 158   { "vi-backward-word", rl_vi_bword },
 159   { "vi-bWord", rl_vi_bWord },
 160   { "vi-bword", rl_vi_bword },
 161   { "vi-change-case", rl_vi_change_case },
 162   { "vi-change-char", rl_vi_change_char },
 163   { "vi-change-to", rl_vi_change_to },
 164   { "vi-char-search", rl_vi_char_search },
 165   { "vi-column", rl_vi_column },
 166   { "vi-complete", rl_vi_complete },
 167   { "vi-delete", rl_vi_delete },
 168   { "vi-delete-to", rl_vi_delete_to },
 169   { "vi-eWord", rl_vi_eWord },
 170   { "vi-editing-mode", rl_vi_editing_mode },
 171   { "vi-end-bigword", rl_vi_eWord },
 172   { "vi-end-word", rl_vi_end_word },
 173   { "vi-eof-maybe", rl_vi_eof_maybe },
 174   { "vi-eword", rl_vi_eword },
 175   { "vi-fWord", rl_vi_fWord },
 176   { "vi-fetch-history", rl_vi_fetch_history },
 177   { "vi-first-print", rl_vi_first_print },
 178   { "vi-forward-bigword", rl_vi_fWord },
 179   { "vi-forward-word", rl_vi_fword },
 180   { "vi-fword", rl_vi_fword },
 181   { "vi-goto-mark", rl_vi_goto_mark },
 182   { "vi-insert-beg", rl_vi_insert_beg },
 183   { "vi-insertion-mode", rl_vi_insert_mode },
 184   { "vi-match", rl_vi_match },
 185   { "vi-movement-mode", rl_vi_movement_mode },
 186   { "vi-next-word", rl_vi_next_word },
 187   { "vi-overstrike", rl_vi_overstrike },
 188   { "vi-overstrike-delete", rl_vi_overstrike_delete },
 189   { "vi-prev-word", rl_vi_prev_word },
 190   { "vi-put", rl_vi_put },
 191   { "vi-redo", rl_vi_redo },
 192   { "vi-replace", rl_vi_replace },
 193   { "vi-rubout", rl_vi_rubout },
 194   { "vi-search", rl_vi_search },
 195   { "vi-search-again", rl_vi_search_again },
 196   { "vi-set-mark", rl_vi_set_mark },
 197   { "vi-subst", rl_vi_subst },
 198   { "vi-tilde-expand", rl_vi_tilde_expand },
 199   { "vi-unix-word-rubout", rl_vi_unix_word_rubout },
 200   { "vi-yank-arg", rl_vi_yank_arg },
 201   { "vi-yank-pop", rl_vi_yank_pop },
 202   { "vi-yank-to", rl_vi_yank_to },
 203 #endif /* VI_MODE */
 204
 205  {(char *)NULL, (rl_command_func_t *)NULL }
 206 };
 207
 208 int
 209 rl_add_funmap_entry (const char *name, rl_command_func_t *function)
 210 {
 211   if (funmap_entry + 2 >= funmap_size)
 212     {
 213       funmap_size += 64;
 214       funmap = (FUNMAP **)xrealloc (funmap, funmap_size * sizeof (FUNMAP *));
 215     }
 216
 217   funmap[funmap_entry] = (FUNMAP *)xmalloc (sizeof (FUNMAP));
 218   funmap[funmap_entry]->name = name;
 219   funmap[funmap_entry]->function = function;
 220
 221   funmap[++funmap_entry] = (FUNMAP *)NULL;
 222   return funmap_entry;
 223 }
 224
 225 static int funmap_initialized;
 226
 227 /* Make the funmap contain all of the default entries. */
 228 void
 229 rl_initialize_funmap (void)
 230 {
 231   register int i;
 232
 233   if (funmap_initialized)
 234     return;
 235
 236   for (i = 0; default_funmap[i].name; i++)
 237     rl_add_funmap_entry (default_funmap[i].name, default_funmap[i].function);
 238
 239   funmap_initialized = 1;
 240   funmap_program_specific_entry_start = i;
 241 }
 242
 243 /* Produce a NULL terminated array of known function names.  The array
 244    is sorted.  The array itself is allocated, but not the strings inside.
 245    You should free () the array when you done, but not the pointers. */
 246 const char **
 247 rl_funmap_names (void)
 248 {
 249   const char **result;
 250   int result_size, result_index;
 251
 252   /* Make sure that the function map has been initialized. */
 253   rl_initialize_funmap ();
 254
 255   for (result_index = result_size = 0, result = (const char **)NULL; funmap[result_index]; result_index++)
 256     {
 257       if (result_index + 2 > result_size)
 258         {
 259           result_size += 20;
 260           result = (const char **)xrealloc (result, result_size * sizeof (char *));
 261         }
 262
 263       result[result_index] = funmap[result_index]->name;
 264       result[result_index + 1] = (char *)NULL;
 265     }
 266
 267   qsort (result, result_index, sizeof (char *), (QSFUNC *)_rl_qsort_string_compare);
 268   return (result);
 269 }