src/keymap.h

   1 /* Functions to manipulate keymaps.
   2    Copyright (C) 2001-2011 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   6 GNU Emacs is free software: you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation, either version 3 of the License, or
   9 (at your option) any later version.
  10
  11 GNU Emacs is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef KEYMAP_H
  20 #define KEYMAP_H
  21
  22 #define KEYMAPP(m) (!NILP (get_keymap (m, 0, 0)))
  23 extern Lisp_Object Qkeymap, Qmenu_bar;
  24 extern Lisp_Object Qremap;
  25 extern Lisp_Object Qmenu_item;
  26 extern Lisp_Object current_global_map;
  27 EXFUN (Fmake_sparse_keymap, 1);
  28 EXFUN (Fkeymap_prompt, 1);
  29 EXFUN (Fdefine_key, 3);
  30 EXFUN (Fcommand_remapping, 3);
  31 EXFUN (Fkey_binding, 4);
  32 EXFUN (Fkey_description, 2);
  33 EXFUN (Fsingle_key_description, 2);
  34 EXFUN (Fwhere_is_internal, 5);
  35 EXFUN (Fcurrent_active_maps, 2);
  36 extern Lisp_Object access_keymap (Lisp_Object, Lisp_Object, int, int, int);
  37 extern Lisp_Object get_keymap (Lisp_Object, int, int);
  38 EXFUN (Fset_keymap_parent, 2);
  39 extern int describe_map_tree (Lisp_Object, int, Lisp_Object, Lisp_Object,
  40                               const char *, int, int, int, int);
  41 extern ptrdiff_t current_minor_maps (Lisp_Object **, Lisp_Object **);
  42 extern void initial_define_key (Lisp_Object, int, const char *);
  43 extern void initial_define_lispy_key (Lisp_Object, const char *, const char *);
  44 extern void syms_of_keymap (void);
  45 extern void keys_of_keymap (void);
  46
  47 typedef void (*map_keymap_function_t)
  48      (Lisp_Object key, Lisp_Object val, Lisp_Object args, void* data);
  49 extern void map_keymap (Lisp_Object map, map_keymap_function_t fun, Lisp_Object largs, void* cargs, int autoload);
  50 extern void map_keymap_canonical (Lisp_Object map,
  51                                   map_keymap_function_t fun,
  52                                   Lisp_Object args, void *data);
  53
  54 #endif