annotate src/keyboard.h @ 4971:8175d30c0181

Initial revision
author Richard M. Stallman <rms@gnu.org>
date Wed, 10 Nov 1993 21:03:53 +0000
parents 8ef557c6a30a
children 37dada8ae351
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
518
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
1 /* Declarations useful when processing input.
2961
e94a593c3952 Updated copyright years.
Jim Blandy <jimb@redhat.com>
parents: 2172
diff changeset
2 Copyright (C) 1985, 1986, 1987, 1993 Free Software Foundation, Inc.
518
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
3
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4 This file is part of GNU Emacs.
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6 GNU Emacs is free software; you can redistribute it and/or modify
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
732
a8d94735277e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 518
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
518
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
9 any later version.
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11 GNU Emacs is distributed in the hope that it will be useful,
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 GNU General Public License for more details.
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 along with GNU Emacs; see the file COPYING. If not, write to
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
19
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
20 /* Total number of times read_char has returned. */
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
21 extern int num_input_chars;
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
22
1191
4a1b4379eb53 * keyboard.h (num_nonmacro_input_chars): Added extern declaration
Jim Blandy <jimb@redhat.com>
parents: 1113
diff changeset
23 /* Total number of times read_char has returned, outside of macros. */
4a1b4379eb53 * keyboard.h (num_nonmacro_input_chars): Added extern declaration
Jim Blandy <jimb@redhat.com>
parents: 1113
diff changeset
24 extern int num_nonmacro_input_chars;
4a1b4379eb53 * keyboard.h (num_nonmacro_input_chars): Added extern declaration
Jim Blandy <jimb@redhat.com>
parents: 1113
diff changeset
25
3591
507f64624555 Apply typo patches from Paul Eggert.
Jim Blandy <jimb@redhat.com>
parents: 2961
diff changeset
26 /* Nonzero means polling for input is temporarily suppressed. */
518
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
27 extern int poll_suppress_count;
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
28
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
29 /* Keymap mapping ASCII function key sequences onto their preferred forms.
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
30 Initialized by the terminal-specific lisp files. */
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
31 extern Lisp_Object Vfunction_key_map;
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
32
1440
8c27b145955a * keyboard.h (this_command_keys): Extern declaration changed. Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1387
diff changeset
33 /* Vector holding the key sequence that invoked the current command.
8c27b145955a * keyboard.h (this_command_keys): Extern declaration changed. Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1387
diff changeset
34 It is reused for each command, and it may be longer than the current
8c27b145955a * keyboard.h (this_command_keys): Extern declaration changed. Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1387
diff changeset
35 sequence; this_command_key_count indicates how many elements
8c27b145955a * keyboard.h (this_command_keys): Extern declaration changed. Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1387
diff changeset
36 actually mean something. */
8c27b145955a * keyboard.h (this_command_keys): Extern declaration changed. Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1387
diff changeset
37 extern Lisp_Object this_command_keys;
8c27b145955a * keyboard.h (this_command_keys): Extern declaration changed. Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 1387
diff changeset
38 extern int this_command_key_count;
1387
774897fea33a * keyboard.h (Qswitch_frame): Declare this extern.
Jim Blandy <jimb@redhat.com>
parents: 1313
diff changeset
39
1989
b1c1ab20f810 Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
40 #ifdef MULTI_FRAME
b1c1ab20f810 Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
41 /* The frame in which the last input event occurred, or Qmacro if the
b1c1ab20f810 Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
42 last event came from a macro. We use this to determine when to
b1c1ab20f810 Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
43 generate switch-frame events. This may be cleared by functions
b1c1ab20f810 Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
44 like Fselect_frame, to make sure that a switch-frame event is
b1c1ab20f810 Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
45 generated by the next character. */
2172
9e84120ecc0a * keyboard.h (internal_last_event_frame): This should be extern,
Jim Blandy <jimb@redhat.com>
parents: 1989
diff changeset
46 extern Lisp_Object internal_last_event_frame;
1989
b1c1ab20f810 Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
47 #endif
b1c1ab20f810 Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
48
518
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
49
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
50 /* Macros for dealing with lispy events. */
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
51
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
52 /* True iff EVENT has data fields describing it (i.e. a mouse click). */
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
53 #define EVENT_HAS_PARAMETERS(event) \
1311
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
54 (XTYPE (event) == Lisp_Cons)
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
55
1313
ddbcabc6dcc9 Doc fixes.
Jim Blandy <jimb@redhat.com>
parents: 1311
diff changeset
56 /* Extract the head from an event.
ddbcabc6dcc9 Doc fixes.
Jim Blandy <jimb@redhat.com>
parents: 1311
diff changeset
57 This works on composite and simple events. */
1311
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
58 #define EVENT_HEAD(event) \
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
59 (EVENT_HAS_PARAMETERS (event) ? XCONS (event)->car : (event))
518
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
60
1313
ddbcabc6dcc9 Doc fixes.
Jim Blandy <jimb@redhat.com>
parents: 1311
diff changeset
61 /* Extract the starting and ending positions from a composite event. */
1311
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
62 #define EVENT_START(event) (XCONS (XCONS (event)->cdr)->car)
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
63 #define EVENT_END(event) (XCONS (XCONS (XCONS (event)->cdr)->cdr)->car)
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
64
3990
8ef557c6a30a * keyboard.h (EVENT_CLICK_COUNT, POSN_SCROLLBAR_PART): New
Jim Blandy <jimb@redhat.com>
parents: 3591
diff changeset
65 /* Extract the click count from a multi-click event. */
8ef557c6a30a * keyboard.h (EVENT_CLICK_COUNT, POSN_SCROLLBAR_PART): New
Jim Blandy <jimb@redhat.com>
parents: 3591
diff changeset
66 #define EVENT_CLICK_COUNT(event) (Fnth ((event), make_number (2)))
8ef557c6a30a * keyboard.h (EVENT_CLICK_COUNT, POSN_SCROLLBAR_PART): New
Jim Blandy <jimb@redhat.com>
parents: 3591
diff changeset
67
1313
ddbcabc6dcc9 Doc fixes.
Jim Blandy <jimb@redhat.com>
parents: 1311
diff changeset
68 /* Extract the fields of a position. */
1311
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
69 #define POSN_WINDOW(posn) (XCONS (posn)->car)
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
70 #define POSN_BUFFER_POSN(posn) (XCONS (XCONS (posn)->cdr)->car)
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
71 #define POSN_WINDOW_POSN(posn) (XCONS (XCONS (XCONS (posn)->cdr)->cdr)->car)
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
72 #define POSN_TIMESTAMP(posn) \
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
73 (XCONS (XCONS (XCONS (XCONS (posn)->cdr)->cdr)->cdr)->car)
3990
8ef557c6a30a * keyboard.h (EVENT_CLICK_COUNT, POSN_SCROLLBAR_PART): New
Jim Blandy <jimb@redhat.com>
parents: 3591
diff changeset
74 #define POSN_SCROLLBAR_PART(posn) (Fnth ((posn), make_number (4)))
518
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
75
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
76 /* Some of the event heads. */
1387
774897fea33a * keyboard.h (Qswitch_frame): Declare this extern.
Jim Blandy <jimb@redhat.com>
parents: 1313
diff changeset
77 extern Lisp_Object Qswitch_frame;
518
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
78
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
79 /* Properties on event heads. */
1311
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
80 extern Lisp_Object Qevent_kind, Qevent_symbol_elements;
518
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
81
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
82 /* Getting an unmodified version of an event head. */
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
83 #define EVENT_HEAD_UNMODIFIED(event_head) \
1311
339a82d29dfa * keyboard.h (EVENT_HAS_PARAMETERS): Definition changed - all events
Jim Blandy <jimb@redhat.com>
parents: 1191
diff changeset
84 (Fcar (Fget ((event_head), Qevent_symbol_elements)))
518
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
85
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
86 /* The values of Qevent_kind properties. */
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
87 extern Lisp_Object Qfunction_key, Qmouse_click, Qmouse_movement;
1989
b1c1ab20f810 Use the term `scroll bar', instead of `scrollbar'.
Jim Blandy <jimb@redhat.com>
parents: 1821
diff changeset
88 extern Lisp_Object Qscroll_bar_movement;
518
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
89
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
90 /* Getting the kind of an event head. */
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
91 #define EVENT_HEAD_KIND(event_head) \
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
92 (Fget ((event_head), Qevent_kind))
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
93
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
94 /* Symbols to use for non-text mouse positions. */
732
a8d94735277e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 518
diff changeset
95 extern Lisp_Object Qmode_line, Qvertical_line;
518
3a316f923456 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
96
1516
02bd6870de86 * keyboard.h (get_keymap_1, Fkeymapp, reorder_modifiers,
Jim Blandy <jimb@redhat.com>
parents: 1440
diff changeset
97 extern Lisp_Object get_keymap_1 ();
02bd6870de86 * keyboard.h (get_keymap_1, Fkeymapp, reorder_modifiers,
Jim Blandy <jimb@redhat.com>
parents: 1440
diff changeset
98 extern Lisp_Object Fkeymapp ();
02bd6870de86 * keyboard.h (get_keymap_1, Fkeymapp, reorder_modifiers,
Jim Blandy <jimb@redhat.com>
parents: 1440
diff changeset
99 extern Lisp_Object reorder_modifiers ();
02bd6870de86 * keyboard.h (get_keymap_1, Fkeymapp, reorder_modifiers,
Jim Blandy <jimb@redhat.com>
parents: 1440
diff changeset
100 extern Lisp_Object read_char ();
1113
0ffcf74fb8ad entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 732
diff changeset
101 /* User-supplied string to translate input characters through. */
0ffcf74fb8ad entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 732
diff changeset
102 extern Lisp_Object Vkeyboard_translate_table;
0ffcf74fb8ad entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 732
diff changeset
103