annotate src/keymap.h @ 103264:b269cabac20c

* syntax.texi (Position Parse): Document rationale for ignored arguments to syntax-ppss-flush-cache. * processes.texi (Input to Processes): Mark PROCESS arg to process-running-child-p as optional. (Network Options): Document NO-ERROR arg to set-network-process-option. * buffers.texi (Indirect Buffers): Mark clone-indirect-buffer as a command. * searching.texi (POSIX Regexps): Mark posix-search-forward and posix-search-backward as commands. * os.texi (Killing Emacs): Mark kill-emacs as a command. (Suspending Emacs): Mark suspend-emacs as a command. (Processor Run Time): Mark emacs-uptime and emacs-init-time as commands. (Terminal Output): Remove obsolete function baud-rate. Document TERMINAL arg for send-string-to-terminal. * nonascii.texi (Terminal I/O Encoding): Document TERMINAL arg for terminal-coding-system and set-terminal-coding-system. (Explicit Encoding): Mark DESTINATION arg of decode-coding-region as optional. (Character Sets): Document RESTRICTION arg of char-charset. (Character Codes): Mark POS argument to get-byte as optional. * minibuf.texi (Minibuffer Misc): Document ARGS arg for minibuffer-message. * files.texi (Create/Delete Dirs): Mark make-directory and delete-directory as commands. * abbrevs.texi (Abbrev Tables): Fix arglist for make-abbrev-table. * text.texi (Base 64): Mark base64-decode-string and base64-encode-string as commands. (Columns): Mark move-to-column as a command. (Mode-Specific Indent): Document RIGID arg to indent-for-tab-command. (Region Indent): Mark TO-COLUMN arg to indent-region as optional. Mark indent-code-rigidly as a command. (Substitution): Mark translate-region as a command. * frames.texi (Size and Position): Remove obsolete functions screen-height and screen-width.

/* Functions to manipulate keymaps.
   Copyright (C) 2001, 2002, 2003, 2004, 2005,
                 2006, 2007, 2008, 2009 Free Software Foundation, Inc.

This file is part of GNU Emacs.

GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef KEYMAP_H
#define KEYMAP_H

#define KEYMAPP(m) (!NILP (get_keymap (m, 0, 0)))
extern Lisp_Object Qkeymap, Qmenu_bar;
extern Lisp_Object current_global_map;
EXFUN (Fmake_sparse_keymap, 1);
EXFUN (Fkeymap_prompt, 1);
EXFUN (Fdefine_key, 3);
EXFUN (Flookup_key, 3);
EXFUN (Fcommand_remapping, 3);
EXFUN (Fkey_binding, 4);
EXFUN (Fkey_description, 2);
EXFUN (Fsingle_key_description, 2);
EXFUN (Fwhere_is_internal, 5);
EXFUN (Fcurrent_active_maps, 2);
extern Lisp_Object access_keymap P_ ((Lisp_Object, Lisp_Object, int, int, int));
extern Lisp_Object get_keyelt P_ ((Lisp_Object, int));
extern Lisp_Object get_keymap P_ ((Lisp_Object, int, int));
EXFUN (Fset_keymap_parent, 2);
extern void describe_map_tree P_ ((Lisp_Object, int, Lisp_Object, Lisp_Object,
				   char *, int, int, int, int));
extern int current_minor_maps P_ ((Lisp_Object **, Lisp_Object **));
extern void initial_define_key P_ ((Lisp_Object, int, char *));
extern void initial_define_lispy_key P_ ((Lisp_Object, char *, char *));
extern void syms_of_keymap P_ ((void));
extern void keys_of_keymap P_ ((void));

typedef void (*map_keymap_function_t)
     P_ ((Lisp_Object key, Lisp_Object val, Lisp_Object args, void* data));
extern void map_keymap P_ ((Lisp_Object map, map_keymap_function_t fun, Lisp_Object largs, void* cargs, int autoload));
extern void map_keymap_canonical (Lisp_Object map,
				  map_keymap_function_t fun,
				  Lisp_Object args, void *data);

#endif

/* arch-tag: 7400d5a1-ef0b-43d0-b366-f4d678bf3ba2
   (do not change this comment) */