annotate src/commands.h @ 7416:4996c50431de

(outline-init) New user interface for control of outline-mode session setup, sets up `outline-find-file-hook', `outline-layout', and `outline-auto-activation'. (outline-mode-post-command-business, outline-mode) (outlineify-sticky): Major new mode activation scheme. See outline-layout docstring for details. (outline-layout, outline-use-mode-specific-leader) (outline-mode-leaders): Variables for new mode-activation scheme. (outline-expose-topic): New specification format and optimizations, including thorough accomodation of multiple top-level topics. (outline-forward-current-level, outline-next-sibling) (outline-backward-current-level, outline-goto-prefix) (outline-show-children, outline-up-current-level) (outline-expose-topic): Behavior refinements and repairs, and speed optimizations. Better accomodation for multiple top-level topics. (outline-recent-end-of-subtree): New state var, basis for many topic-oriented optimizations. Revisions of many docstrings, for conformance to GNU standards and/or clarity.
author Richard M. Stallman <rms@gnu.org>
date Mon, 09 May 1994 06:36:19 +0000
parents 18bc27b97236
children cd8665daa5a8
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.
7307
cd81dba38a49 Update copyright.
Karl Heuer <kwzh@gnu.org>
parents: 7171
diff changeset
2 Copyright (C) 1985, 1994 Free Software Foundation, Inc.
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
3
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4 This file is part of GNU Emacs.
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6 GNU Emacs is free software; you can redistribute it and/or modify
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
8 the Free Software Foundation; either version 1, or (at your option)
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
9 any later version.
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11 GNU Emacs is distributed in the hope that it will be useful,
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 GNU General Public License for more details.
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 along with GNU Emacs; see the file COPYING. If not, write to
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
19
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
20
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
21 #define Ctl(c) ((c)&037)
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
22
3886
92f6b47e3e8d * keyboard.c (menu_bar_items, read_key_sequence): Use
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
23 /* 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
24 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
25 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
26 current_global_map instead. */
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
27 extern Lisp_Object global_map;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
28 extern Lisp_Object meta_map;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
29 extern Lisp_Object control_x_map;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
30
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
31 extern Lisp_Object Vminibuffer_local_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_ns_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 /* keymap used for minibuffers when doing completion */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
36 extern Lisp_Object Vminibuffer_local_completion_map;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
37
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
38 /* keymap used for minibuffers when doing completion and require a match */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
39 extern Lisp_Object Vminibuffer_local_must_match_map;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
40
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
41 /* Last character of last key sequence. */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
42 extern Lisp_Object last_command_char;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
43
1080
8f64d3122435 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 485
diff changeset
44 /* Last input character read as a command, not counting menus
8f64d3122435 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 485
diff changeset
45 reached by the mouse. */
8f64d3122435 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 485
diff changeset
46 extern Lisp_Object last_nonmenu_event;
8f64d3122435 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 485
diff changeset
47
1821
04fb1d3d6992 JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents: 1587
diff changeset
48 /* 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
49 extern Lisp_Object Vunread_command_events;
1587
57ae5625fe22 * commands.h (unread_command_event): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1507
diff changeset
50
6536
4fa1c2b2f1e9 (this_command, last_command): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 6179
diff changeset
51 /* Last command executed by the editor command loop, not counting
4fa1c2b2f1e9 (this_command, last_command): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 6179
diff changeset
52 commands that set the prefix argument. */
4fa1c2b2f1e9 (this_command, last_command): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 6179
diff changeset
53
4fa1c2b2f1e9 (this_command, last_command): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 6179
diff changeset
54 extern Lisp_Object last_command;
4fa1c2b2f1e9 (this_command, last_command): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 6179
diff changeset
55
4fa1c2b2f1e9 (this_command, last_command): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 6179
diff changeset
56 /* The command being executed by the command loop.
4fa1c2b2f1e9 (this_command, last_command): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 6179
diff changeset
57 Commands may set this, and the value set will be copied into last_command
4fa1c2b2f1e9 (this_command, last_command): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 6179
diff changeset
58 instead of the actual command. */
4fa1c2b2f1e9 (this_command, last_command): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 6179
diff changeset
59 extern Lisp_Object this_command;
4fa1c2b2f1e9 (this_command, last_command): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 6179
diff changeset
60
1587
57ae5625fe22 * commands.h (unread_command_event): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1507
diff changeset
61 /* 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
62 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
63 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
64
57ae5625fe22 * commands.h (unread_command_event): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1507
diff changeset
65 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
66 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
67 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
68 extern Lisp_Object unread_switch_frame;
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
69
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
70 /* Previous command symbol found here for comparison */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
71 extern Lisp_Object last_command;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
72
7331
18bc27b97236 (last_point_position_buffer): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 7307
diff changeset
73 /* 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
74 extern int last_point_position;
e2bb2d0b8a00 New variable last_point_position.
Karl Heuer <kwzh@gnu.org>
parents: 3886
diff changeset
75
7331
18bc27b97236 (last_point_position_buffer): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 7307
diff changeset
76 /* 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
77 extern Lisp_Object last_point_position_buffer;
18bc27b97236 (last_point_position_buffer): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 7307
diff changeset
78
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
79 /* Nonzero means ^G can quit instantly */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
80 extern int immediate_quit;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
81
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
82 extern Lisp_Object Vexecuting_macro;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
83
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
84 /* Nonzero if input is coming from the keyboard */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
85
485
8c615e453683 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 239
diff changeset
86 #define INTERACTIVE (NILP (Vexecuting_macro) && !noninteractive)
239
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
87
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
88 /* Set this nonzero to force reconsideration of mode line. */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
89
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
90 extern int update_mode_lines;
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
91
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
92 /* Nonzero means reading single-character input with prompt
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
93 so put cursor on minibuffer after the prompt. */
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
94
ed9362406f5f Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
95 extern int cursor_in_echo_area;