annotate src/keymap.h @ 92672:6f28457f84ac

(entry): Declare for compiler part-way through. Comments.
author Glenn Morris <rgm@gnu.org>
date Sat, 08 Mar 2008 23:37:54 +0000
parents 107ccd98fa12
children 606f2d163a64 d3bf833831d6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
39691
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
1 /* Functions to manipulate keymaps.
68651
3bd95f4f2941 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64770
diff changeset
2 Copyright (C) 2001, 2002, 2003, 2004, 2005,
79759
fc2bcd2a8aad Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 78260
diff changeset
3 2006, 2007, 2008 Free Software Foundation, Inc.
39691
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
4
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
5 This file is part of GNU Emacs.
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
6
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
7 GNU Emacs is free software; you can redistribute it and/or modify
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
8 it under the terms of the GNU General Public License as published by
78260
922696f363b0 Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents: 76885
diff changeset
9 the Free Software Foundation; either version 3, or (at your option)
39691
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
10 any later version.
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
11
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
12 GNU Emacs is distributed in the hope that it will be useful,
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
15 GNU General Public License for more details.
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
16
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
18 along with GNU Emacs; see the file COPYING. If not, write to
64084
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 60192
diff changeset
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 60192
diff changeset
20 Boston, MA 02110-1301, USA. */
39691
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
21
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
22 #ifndef KEYMAP_H
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
23 #define KEYMAP_H
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
24
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
25 #define KEYMAPP(m) (!NILP (get_keymap (m, 0, 0)))
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
26 extern Lisp_Object Qkeymap, Qmenu_bar;
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
27 extern Lisp_Object current_global_map;
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
28 EXFUN (Fmake_sparse_keymap, 1);
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
29 EXFUN (Fkeymap_prompt, 1);
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
30 EXFUN (Fdefine_key, 3);
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
31 EXFUN (Flookup_key, 3);
76885
fcaf9518268a (Fcommand_remapping): New optional argument.
Chong Yidong <cyd@stupidchicken.com>
parents: 75348
diff changeset
32 EXFUN (Fcommand_remapping, 3);
72889
25c755416160 * NEWS: explain new behavior and arguments of `key-binding' and
David Kastrup <dak@gnu.org>
parents: 68651
diff changeset
33 EXFUN (Fkey_binding, 4);
54926
9d9ed20a61d2 (Fkey_description): Fix prototype.
Kim F. Storm <storm@cua.dk>
parents: 52401
diff changeset
34 EXFUN (Fkey_description, 2);
39691
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
35 EXFUN (Fsingle_key_description, 2);
43153
d6162a8dc872 (Fkey_binding, Fwhere_is_internal): Update prototype.
Kim F. Storm <storm@cua.dk>
parents: 41292
diff changeset
36 EXFUN (Fwhere_is_internal, 5);
81609
7e640eac2dcb * keymaps.texi (Active Keymaps): Document new POSITION argument of
David Kastrup <dak@gnu.org>
parents: 76885
diff changeset
37 EXFUN (Fcurrent_active_maps, 2);
39691
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
38 extern Lisp_Object access_keymap P_ ((Lisp_Object, Lisp_Object, int, int, int));
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
39 extern Lisp_Object get_keyelt P_ ((Lisp_Object, int));
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
40 extern Lisp_Object get_keymap P_ ((Lisp_Object, int, int));
83420
521d3f18b3d1 Reimplement terminal parameters in C; clean up term.c, create terminal.c.
Karoly Lorentey <lorentey@elte.hu>
parents: 64770
diff changeset
41 EXFUN (Fset_keymap_parent, 2);
39691
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
42 extern void describe_map_tree P_ ((Lisp_Object, int, Lisp_Object, Lisp_Object,
60068
3e2faa2a85ed (describe_map_tree): Change decl.
Richard M. Stallman <rms@gnu.org>
parents: 54926
diff changeset
43 char *, int, int, int, int));
39691
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
44 extern int current_minor_maps P_ ((Lisp_Object **, Lisp_Object **));
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
45 extern void initial_define_key P_ ((Lisp_Object, int, char *));
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
46 extern void initial_define_lispy_key P_ ((Lisp_Object, char *, char *));
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
47 extern void syms_of_keymap P_ ((void));
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
48 extern void keys_of_keymap P_ ((void));
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
49
50797
5b0873c0b734 (map_keymap_function_t): New type.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49757
diff changeset
50 typedef void (*map_keymap_function_t)
81791
98732c4676bc (map_keymap_function_t): More informative prototype.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81609
diff changeset
51 P_ ((Lisp_Object key, Lisp_Object val, Lisp_Object args, void* data));
50797
5b0873c0b734 (map_keymap_function_t): New type.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49757
diff changeset
52 extern void map_keymap P_ ((Lisp_Object map, map_keymap_function_t fun, Lisp_Object largs, void* cargs, int autoload));
39691
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
53
27fe3d5767ed New file. Extracted from lisp.h.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
54 #endif
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 50797
diff changeset
55
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 50797
diff changeset
56 /* arch-tag: 7400d5a1-ef0b-43d0-b366-f4d678bf3ba2
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 50797
diff changeset
57 (do not change this comment) */