annotate src/blockinput.h @ 73044:f55aad8022e2

*** empty log message ***
author Richard M. Stallman <rms@gnu.org>
date Thu, 21 Sep 2006 21:06:31 +0000
parents 3bd95f4f2941
children e90d04cd455a c5406394f567
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.
64770
a0d1312ede66 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64084
diff changeset
2 Copyright (C) 1989, 1993, 2002, 2003, 2004,
68651
3bd95f4f2941 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64770
diff changeset
3 2005, 2006 Free Software Foundation, Inc.
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5 This file is part of GNU Emacs.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7 GNU Emacs is free software; you can redistribute it and/or modify
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
8 it under the terms of the GNU General Public License as published by
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
9 the Free Software Foundation; either version 2, or (at your option)
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10 any later version.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 GNU Emacs is distributed in the hope that it will be useful,
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15 GNU General Public License for more details.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
290a7be0d392 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: 60481
diff changeset
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 60481
diff changeset
20 Boston, MA 02110-1301, USA. */
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
21
29926
5a1dca465b50 Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents: 27426
diff changeset
22 #ifndef EMACS_BLOCKINPUT_H
5a1dca465b50 Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents: 27426
diff changeset
23 #define EMACS_BLOCKINPUT_H
5a1dca465b50 Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents: 27426
diff changeset
24
5a1dca465b50 Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents: 27426
diff changeset
25 #include "atimer.h"
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
26
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
27 /* When Emacs is using signal-driven input, the processing of those
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
28 input signals can get pretty hairy. For example, when Emacs is
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
29 running under X windows, handling an input signal can entail
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
30 retrieving events from the X event queue, or making other X calls.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
31
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
32 If an input signal occurs while Emacs is in the midst of some
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
33 non-reentrant code, and the signal processing invokes that same
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
34 code, we lose. For example, malloc and the Xlib functions aren't
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
35 usually re-entrant, and both are used by the X input signal handler
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
36 - if we try to process an input signal in the midst of executing
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
37 any of these functions, we'll lose.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
38
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
39 To avoid this, we make the following requirements:
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
40
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
41 * Everyone must evaluate BLOCK_INPUT before entering these functions,
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
42 and then call UNBLOCK_INPUT after performing them. Calls
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
43 BLOCK_INPUT and UNBLOCK_INPUT may be nested.
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
44
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
45 * Any complicated interrupt handling code should test
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 29926
diff changeset
46 interrupt_input_blocked, and put off its work until later.
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
47
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
48 * If the interrupt handling code wishes, it may set
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
49 interrupt_input_pending to a non-zero value. If that flag is set
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
50 when input becomes unblocked, UNBLOCK_INPUT will send a new SIGIO. */
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
51
2479
6d011b24f6fe (interrupt_input_blocked): Make this signed int.
Richard M. Stallman <rms@gnu.org>
parents: 2477
diff changeset
52 extern int interrupt_input_blocked;
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
53
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
54 /* Nonzero means an input interrupt has arrived
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
55 during the current critical section. */
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
56 extern int interrupt_input_pending;
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
57
27426
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
58
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
59 /* 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
60 unblocked. */
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
61
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
62 extern int pending_atimers;
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
63
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
64 /* Begin critical section. */
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
65 #define BLOCK_INPUT (interrupt_input_blocked++)
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
66
2721
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
67 /* End critical section.
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
68
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
69 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
70 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
71
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
72 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
73 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
74 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
75 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
76 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
77 SIGIO.
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
78
ca5cb6cafc40 * blockinput.h (UNBLOCK_INPUT): We cannot assume that SIGIO is
Jim Blandy <jimb@redhat.com>
parents: 2479
diff changeset
79 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
80 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
81
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
82 #define UNBLOCK_INPUT \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
83 do \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
84 { \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
85 --interrupt_input_blocked; \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
86 if (interrupt_input_blocked == 0) \
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 if (interrupt_input_pending) \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
89 reinvoke_input_signal (); \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
90 if (pending_atimers) \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
91 do_pending_atimers (); \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
92 } \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
93 else if (interrupt_input_blocked < 0) \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
94 abort (); \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
95 } \
e28edb0e4233 (pending_atimers): Add extern declaration.
Gerd Moellmann <gerd@gnu.org>
parents: 21796
diff changeset
96 while (0)
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
97
60416
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
98 /* Undo any number of BLOCK_INPUT calls,
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
99 and also reinvoke any pending signal. */
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
100
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
101 #define TOTALLY_UNBLOCK_INPUT \
60481
335c6a2f0c12 (TOTALLY_UNBLOCK_INPUT): Avoid dangling else.
Kim F. Storm <storm@cua.dk>
parents: 60474
diff changeset
102 do if (interrupt_input_blocked != 0) \
60416
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
103 { \
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
104 interrupt_input_blocked = 1; \
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
105 UNBLOCK_INPUT; \
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
106 } \
60481
335c6a2f0c12 (TOTALLY_UNBLOCK_INPUT): Avoid dangling else.
Kim F. Storm <storm@cua.dk>
parents: 60474
diff changeset
107 while (0)
60416
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
108
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
109 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
110 and also (if the level is now 0) reinvoke any pending signal. */
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
111
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
112 #define UNBLOCK_INPUT_TO(LEVEL) \
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
113 do \
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
114 { \
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
115 interrupt_input_blocked = (LEVEL) + 1; \
60474
3bb3556e7af0 (UNBLOCK_INPUT_TO): Always call UNBLOCK_INPUT.
Andreas Schwab <schwab@suse.de>
parents: 60416
diff changeset
116 UNBLOCK_INPUT; \
60416
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
117 } \
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
118 while (0)
306f7ce8d80d (UNBLOCK_INPUT_TO): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 56135
diff changeset
119
2437
290a7be0d392 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
120 #define UNBLOCK_INPUT_RESIGNAL UNBLOCK_INPUT
21515
fb4c986db0e2 Add more prototypes.
Andreas Schwab <schwab@suse.de>
parents: 14186
diff changeset
121
55658
0e26a0be1ee5 (INPUT_BLOCKED_P): New macro.
Kim F. Storm <storm@cua.dk>
parents: 52401
diff changeset
122 /* In critical section ? */
0e26a0be1ee5 (INPUT_BLOCKED_P): New macro.
Kim F. Storm <storm@cua.dk>
parents: 52401
diff changeset
123 #define INPUT_BLOCKED_P (interrupt_input_blocked > 0)
0e26a0be1ee5 (INPUT_BLOCKED_P): New macro.
Kim F. Storm <storm@cua.dk>
parents: 52401
diff changeset
124
21515
fb4c986db0e2 Add more prototypes.
Andreas Schwab <schwab@suse.de>
parents: 14186
diff changeset
125 /* Defined in keyboard.c */
21796
f7ca88e90856 (reinvoke_input_signal): Don't use prototype decl.
Richard M. Stallman <rms@gnu.org>
parents: 21515
diff changeset
126 /* 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
127 extern void reinvoke_input_signal ();
29926
5a1dca465b50 Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents: 27426
diff changeset
128
5a1dca465b50 Protect against multiple inclusion. Include
Dave Love <fx@gnu.org>
parents: 27426
diff changeset
129 #endif /* EMACS_BLOCKINPUT_H */
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
130
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
131 /* arch-tag: 51a9ec86-945a-4966-8f04-2d1341250e03
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
132 (do not change this comment) */