annotate src/commands.h @ 65220:0034e1284e23

Combine all three indices into one. Correct a few typos.
author Luc Teirlinck <teirllm@auburn.edu>
date Mon, 29 Aug 2005 22:58:34 +0000
parents a0d1312ede66
children a68df09a8a34 2d92f5c9d6ae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
1 /* Definitions needed by most editing commands.
64770
a0d1312ede66 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64084
diff changeset
2 Copyright (C) 1985, 1994, 2002, 2003, 2004,
a0d1312ede66 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64084
diff changeset
3 2005 Free Software Foundation, Inc.
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5 This file is part of GNU Emacs.
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7 GNU Emacs is free software; you can redistribute it and/or modify
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
8 it under the terms of the GNU General Public License as published by
12244
ac7375e60931 Update GPL to version 2.
Karl Heuer <kwzh@gnu.org>
parents: 12162
diff changeset
9 the Free Software Foundation; either version 2, or (at your option)
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10 any later version.
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 GNU Emacs is distributed in the hope that it will be useful,
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15 GNU General Public License for more details.
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
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: 61981
diff changeset
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 61981
diff changeset
20 Boston, MA 02110-1301, USA. */
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
21
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
22
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
23 #define Ctl(c) ((c)&037)
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
24
3886
92f6b47e3e8d * keyboard.c (menu_bar_items, read_key_sequence): Use
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
25 /* Define the names of keymaps, just so people can refer to them in
92f6b47e3e8d * keyboard.c (menu_bar_items, read_key_sequence): Use
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
26 calls to initial_define_key. These should *not* be used after
92f6b47e3e8d * keyboard.c (menu_bar_items, read_key_sequence): Use
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
27 initialization; use-global-map doesn't affect these; it sets
92f6b47e3e8d * keyboard.c (menu_bar_items, read_key_sequence): Use
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
28 current_global_map instead. */
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
29 extern Lisp_Object global_map;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
30 extern Lisp_Object meta_map;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
31 extern Lisp_Object control_x_map;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
32
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
33 extern Lisp_Object Vminibuffer_local_map;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
34
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
35 extern Lisp_Object Vminibuffer_local_ns_map;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
36
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
37 /* keymap used for minibuffers when doing completion */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
38 extern Lisp_Object Vminibuffer_local_completion_map;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
39
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
40 /* keymap used for minibuffers when doing completion and require a match */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
41 extern Lisp_Object Vminibuffer_local_must_match_map;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
42
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
43 /* Last character of last key sequence. */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
44 extern Lisp_Object last_command_char;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
45
1080
8f64d3122435 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 485
diff changeset
46 /* Last input character read as a command, not counting menus
8f64d3122435 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 485
diff changeset
47 reached by the mouse. */
8f64d3122435 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 485
diff changeset
48 extern Lisp_Object last_nonmenu_event;
8f64d3122435 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 485
diff changeset
49
1821
04fb1d3d6992 JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents: 1587
diff changeset
50 /* List of command events to be re-read, or Qnil. */
7171
945fd4c43a14 (Vunread_command_events): Renamed.
Richard M. Stallman <rms@gnu.org>
parents: 6536
diff changeset
51 extern Lisp_Object Vunread_command_events;
1587
57ae5625fe22 * commands.h (unread_command_event): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1507
diff changeset
52
8273
cd8665daa5a8 (unread_command_char): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 7331
diff changeset
53 /* Command char event to be re-read, or -1 if none.
cd8665daa5a8 (unread_command_char): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 7331
diff changeset
54 Setting this is obsolete, but some things should still check it. */
43713
f92c4d87863a Change defvar_int def and vars to use EMACS_INT instead of just int.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 22967
diff changeset
55 extern EMACS_INT unread_command_char;
8273
cd8665daa5a8 (unread_command_char): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 7331
diff changeset
56
6536
4fa1c2b2f1e9 (this_command, last_command): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 6179
diff changeset
57 /* The command being executed by the command loop.
12162
f670e669470b (last_command): Var deleted; now part of struct kboard.
Karl Heuer <kwzh@gnu.org>
parents: 8273
diff changeset
58 Commands may set this, and the value set will be copied into
f670e669470b (last_command): Var deleted; now part of struct kboard.
Karl Heuer <kwzh@gnu.org>
parents: 8273
diff changeset
59 current_kboard->Vlast_command instead of the actual command. */
22967
63801d5488f4 (Vthis_command): Renamed from this_command.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
60 extern Lisp_Object Vthis_command;
6536
4fa1c2b2f1e9 (this_command, last_command): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 6179
diff changeset
61
1587
57ae5625fe22 * commands.h (unread_command_event): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1507
diff changeset
62 /* If not Qnil, this is a switch-frame event which we decided to put
57ae5625fe22 * commands.h (unread_command_event): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1507
diff changeset
63 off until the end of a key sequence. This should be read as the
7171
945fd4c43a14 (Vunread_command_events): Renamed.
Richard M. Stallman <rms@gnu.org>
parents: 6536
diff changeset
64 next command input, after any Vunread_command_events.
1587
57ae5625fe22 * commands.h (unread_command_event): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1507
diff changeset
65
57ae5625fe22 * commands.h (unread_command_event): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1507
diff changeset
66 read_key_sequence uses this to delay switch-frame events until the
57ae5625fe22 * commands.h (unread_command_event): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1507
diff changeset
67 end of the key sequence; Fread_char uses it to put off switch-frame
57ae5625fe22 * commands.h (unread_command_event): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1507
diff changeset
68 events until a non-ASCII event is acceptable as input. */
57ae5625fe22 * commands.h (unread_command_event): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1507
diff changeset
69 extern Lisp_Object unread_switch_frame;
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
70
7331
18bc27b97236 (last_point_position_buffer): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 7307
diff changeset
71 /* The value of point when the last command was executed. */
6179
e2bb2d0b8a00 New variable last_point_position.
Karl Heuer <kwzh@gnu.org>
parents: 3886
diff changeset
72 extern int last_point_position;
e2bb2d0b8a00 New variable last_point_position.
Karl Heuer <kwzh@gnu.org>
parents: 3886
diff changeset
73
7331
18bc27b97236 (last_point_position_buffer): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 7307
diff changeset
74 /* The buffer that was current when the last command was started. */
18bc27b97236 (last_point_position_buffer): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 7307
diff changeset
75 extern Lisp_Object last_point_position_buffer;
18bc27b97236 (last_point_position_buffer): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 7307
diff changeset
76
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
77 /* Nonzero means ^G can quit instantly */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
78 extern int immediate_quit;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
79
61981
8131d95ff037 (Vexecuting_kbd_macro): Declare instead of Vexecuting_macro.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
80 extern Lisp_Object Vexecuting_kbd_macro;
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
81
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
82 /* Nonzero if input is coming from the keyboard */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
83
61981
8131d95ff037 (Vexecuting_kbd_macro): Declare instead of Vexecuting_macro.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
84 #define INTERACTIVE (NILP (Vexecuting_kbd_macro) && !noninteractive)
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
85
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
86 /* Set this nonzero to force reconsideration of mode line. */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
87
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
88 extern int update_mode_lines;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
89
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
90 /* Nonzero means reading single-character input with prompt
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
91 so put cursor on minibuffer after the prompt. */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
92
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
93 extern int cursor_in_echo_area;
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 43713
diff changeset
94
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 43713
diff changeset
95 /* arch-tag: 4f7ca0b7-6a56-4b20-8bf5-b67a99921d1d
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 43713
diff changeset
96 (do not change this comment) */