annotate src/blockinput.h @ 29338:c30e82ef32bb

*** empty log message ***
author Gerd Moellmann <gerd@gnu.org>
date Wed, 31 May 2000 19:19:50 +0000
parents e28edb0e4233
children 5a1dca465b50
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2439
b6c62e4abf59 Put interrupt input blocking in a separate file from xterm.h.
Jim Blandy <jimb@redhat.com>
parents: 2437
diff changeset
1 /* blockinput.h - interface to blocking complicated interrupt-driven input.
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
2 Copyright (C) 1989, 1993 Free Software Foundation, Inc.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
3
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4 This file is part of GNU Emacs.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6 GNU Emacs is free software; you can redistribute it and/or modify
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
9 any later version.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11 GNU Emacs is distributed in the hope that it will be useful,
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 GNU General Public License for more details.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 along with GNU Emacs; see the file COPYING. If not, write to
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 2721
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 2721
diff changeset
19 Boston, MA 02111-1307, USA. */
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
20
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
21
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
22 /* When Emacs is using signal-driven input, the processing of those
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
23 input signals can get pretty hairy. For example, when Emacs is
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
24 running under X windows, handling an input signal can entail
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
25 retrieving events from the X event queue, or making other X calls.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
26
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
27 If an input signal occurs while Emacs is in the midst of some
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
28 non-reentrant code, and the signal processing invokes that same
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
29 code, we lose. For example, malloc and the Xlib functions aren't
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
30 usually re-entrant, and both are used by the X input signal handler
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
31 - if we try to process an input signal in the midst of executing
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
32 any of these functions, we'll lose.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
33
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
34 To avoid this, we make the following requirements:
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
35
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
36 * Everyone must evaluate BLOCK_INPUT before entering these functions,
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
37 and then call UNBLOCK_INPUT after performing them. Calls
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
38 BLOCK_INPUT and UNBLOCK_INPUT may be nested.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
39
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
40 * Any complicated interrupt handling code should test
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
41 interrupt_input_blocked, and put off its work until later.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
42
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
43 * If the interrupt handling code wishes, it may set
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
44 interrupt_input_pending to a non-zero value. If that flag is set
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
45 when input becomes unblocked, UNBLOCK_INPUT will send a new SIGIO. */
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
46
2479
6d011b24f6fe (interrupt_input_blocked): Make this signed int.
Richard M. Stallman <rms@gnu.org>
parents: 2477
diff changeset
47 extern int interrupt_input_blocked;
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
48
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
49 /* Nonzero means an input interrupt has arrived
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
50 during the current critical section. */
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
51 extern int interrupt_input_pending;
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
52
27426
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
53
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
54 /* Non-zero means asynchronous timers should be run when input is
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
55 unblocked. */
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
56
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
57 extern int pending_atimers;
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
58
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
59 /* Begin critical section. */
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
60 #define BLOCK_INPUT (interrupt_input_blocked++)
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
61
2721
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
62 /* End critical section.
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
63
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
64 If doing signal-driven input, and a signal came in when input was
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
65 blocked, reinvoke the signal handler now to deal with it.
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
66
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
67 We used to have two possible definitions of this macro - one for
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
68 when SIGIO was #defined, and one for when it wasn't; when SIGIO
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
69 wasn't #defined, we wouldn't bother to check if we should re-invoke
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
70 the signal handler. But that doesn't work very well; some of the
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
71 files which use this macro don't #include the right files to get
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
72 SIGIO.
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
73
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
74 So, we always test interrupt_input_pending now; that's not too
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
75 expensive, and it'll never get set if we don't need to resignal. */
27426
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
76
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
77 #define UNBLOCK_INPUT \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
78 do \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
79 { \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
80 --interrupt_input_blocked; \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
81 if (interrupt_input_blocked == 0) \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
82 { \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
83 if (interrupt_input_pending) \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
84 reinvoke_input_signal (); \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
85 if (pending_atimers) \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
86 do_pending_atimers (); \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
87 } \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
88 else if (interrupt_input_blocked < 0) \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
89 abort (); \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
90 } \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
91 while (0)
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
92
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
93 #define TOTALLY_UNBLOCK_INPUT (interrupt_input_blocked = 0)
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
94 #define UNBLOCK_INPUT_RESIGNAL UNBLOCK_INPUT
21515
fb4c986db0e2 Add more prototypes.
Andreas Schwab <schwab@suse.de>
parents: 14186
diff changeset
95
fb4c986db0e2 Add more prototypes.
Andreas Schwab <schwab@suse.de>
parents: 14186
diff changeset
96 /* Defined in keyboard.c */
21796
f7ca88e90856 (reinvoke_input_signal): Don't use prototype decl.
Richard M. Stallman <rms@gnu.org>
parents: 21515
diff changeset
97 /* Don't use a prototype here; it causes trouble in some files. */
f7ca88e90856 (reinvoke_input_signal): Don't use prototype decl.
Richard M. Stallman <rms@gnu.org>
parents: 21515
diff changeset
98 extern void reinvoke_input_signal ();