*** empty log message ***
[bpt/emacs.git] / src / keyboard.h
CommitLineData
284f4730 1/* Declarations useful when processing input.
e5d77022 2 Copyright (C) 1985, 1986, 1987, 1992 Free Software Foundation, Inc.
284f4730
JB
3
4This file is part of GNU Emacs.
5
6GNU Emacs is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
e5d77022 8the Free Software Foundation; either version 2, or (at your option)
284f4730
JB
9any later version.
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Emacs; see the file COPYING. If not, write to
18the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19
20/* Total number of times read_char has returned. */
21extern int num_input_chars;
22
23/* Nonzero means polling for input is temporarily suppresed. */
24extern int poll_suppress_count;
25
26/* Keymap mapping ASCII function key sequences onto their preferred forms.
27 Initialized by the terminal-specific lisp files. */
28extern Lisp_Object Vfunction_key_map;
29
30\f
31/* Macros for dealing with lispy events. */
32
33/* True iff EVENT has data fields describing it (i.e. a mouse click). */
34#define EVENT_HAS_PARAMETERS(event) \
35 (XTYPE (event) == Lisp_Cons && Flength (event) == 5)
36
37/* Access the components of composite events. */
38#define EVENT_HEAD(event) (Fnth (0, (event)))
39#define EVENT_WINDOW(event) (Fnth (1, (event)))
40#define EVENT_BUFFER_POSN(event) (Fnth (2, (event)))
41#define EVENT_SCROLLBAR_BUTTON EVENT_BUFFER_POSN
42#define EVENT_WINDOW_POSN(event) (Fnth (3, (event)))
43#define EVENT_TIMESTAMP(event) (Fnth (4, (event)))
44
45/* Some of the event heads. */
46extern Lisp_Object Qvscrollbar_part, Qvslider_part;
47extern Lisp_Object Qvthumbup_part, Qvthumbdown_part;
48extern Lisp_Object Qhscrollbar_part, Qhslider_part;
49extern Lisp_Object Qhthumbleft_part, Qhthumbright_part;
50
51/* Properties on event heads. */
52extern Lisp_Object Qevent_kind, Qevent_unmodified;
53
54/* Getting an unmodified version of an event head. */
55#define EVENT_HEAD_UNMODIFIED(event_head) \
56 (Fget ((event_head), Qevent_unmodified))
57
58/* The values of Qevent_kind properties. */
59extern Lisp_Object Qfunction_key, Qmouse_click, Qmouse_movement;
60extern Lisp_Object Qscrollbar_click;
61
62/* Getting the kind of an event head. */
63#define EVENT_HEAD_KIND(event_head) \
64 (Fget ((event_head), Qevent_kind))
65
66/* Symbols to use for non-text mouse positions. */
e5d77022 67extern Lisp_Object Qmode_line, Qvertical_line;
284f4730 68