src/keymap.h

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