|
0
|
1 /* Definitions for the new event model;
|
|
|
2 created 16-jul-91 by Jamie Zawinski
|
|
|
3 Copyright (C) 1991, 1992, 1993 Free Software Foundation, Inc.
|
|
|
4 Copyright (C) 1995, 1996 Ben Wing.
|
|
|
5
|
|
|
6 This file is part of XEmacs.
|
|
|
7
|
|
|
8 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
9 under the terms of the GNU General Public License as published by the
|
|
|
10 Free Software Foundation; either version 2, or (at your option) any
|
|
|
11 later version.
|
|
|
12
|
|
|
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
16 for more details.
|
|
|
17
|
|
|
18 You should have received a copy of the GNU General Public License
|
|
|
19 along with XEmacs; see the file COPYING. If not, write to
|
|
|
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
21 Boston, MA 02111-1307, USA. */
|
|
|
22
|
|
|
23 /* Synched up with: Not in FSF. */
|
|
|
24
|
|
|
25 #ifndef _XEMACS_EVENTS_H_
|
|
|
26 #define _XEMACS_EVENTS_H_
|
|
|
27
|
|
|
28 #include "systime.h"
|
|
|
29
|
|
2
|
30 /* There is one object called an event_stream. This object contains
|
|
|
31 callback functions for doing the window-system-dependent operations
|
|
|
32 that XEmacs requires.
|
|
0
|
33
|
|
|
34 If XEmacs is compiled with support for X11 and the X Toolkit, then this
|
|
|
35 event_stream structure will contain functions that can cope with input
|
|
|
36 on XEmacs windows on multiple displays, as well as input from dumb tty
|
|
2
|
37 frames.
|
|
0
|
38
|
|
|
39 If it is desired to have XEmacs able to open frames on the displays of
|
|
|
40 multiple heterogeneous machines, X11 and SunView, or X11 and NeXT, for
|
|
|
41 example, then it will be necessary to construct an event_stream structure
|
|
|
42 that can cope with the given types. Currently, the only implemented
|
|
|
43 event_streams are for dumb-ttys, and for X11 plus dumb-ttys.
|
|
185
|
44
|
|
|
45 To implement this for one window system is relatively simple.
|
|
0
|
46 To implement this for multiple window systems is trickier and may
|
|
|
47 not be possible in all situations, but it's been done for X and TTY.
|
|
|
48
|
|
|
49 Note that these callbacks are *NOT* console methods; that's because
|
|
|
50 the routines are not specific to a particular console type but must
|
|
|
51 be able to simultaneously cope with all allowable console types.
|
|
|
52
|
|
|
53 The slots of the event_stream structure:
|
|
|
54
|
|
2
|
55 next_event_cb A function which fills in an XEmacs_event structure
|
|
0
|
56 with the next event available. If there is no event
|
|
|
57 available, then this should block.
|
|
|
58
|
|
|
59 IMPORTANT: timer events and especially process
|
|
|
60 events *must not* be returned if there are
|
|
|
61 events of other types available; otherwise you
|
|
|
62 can end up with an infinite loop in Fdiscard_input().
|
|
|
63
|
|
|
64 event_pending_cb A function which says whether there are events to be
|
|
|
65 read. If called with an argument of 0, then this
|
|
|
66 should say whether calling the next_event_cb will
|
|
|
67 block. If called with an argument of 1, then this
|
|
|
68 should say whether there are user-generated events
|
|
|
69 pending (that is, keypresses or mouse-clicks). This
|
|
185
|
70 is used for redisplay optimization, among other
|
|
|
71 things. On dumb ttys, these two results are the
|
|
0
|
72 same, but under a window system, they are not.
|
|
|
73
|
|
|
74 If this function is not sure whether there are events
|
|
|
75 to be read, it *must* return 0. Otherwise various
|
|
|
76 undesirable effects will occur, such as redisplay
|
|
|
77 not occurring until the next event occurs.
|
|
|
78
|
|
|
79 handle_magic_event_cb XEmacs calls this with an event structure which
|
|
|
80 contains window-system dependent information that
|
|
|
81 XEmacs doesn't need to know about, but which must
|
|
|
82 happen in order. If the next_event_cb never returns
|
|
|
83 an event of type "magic", this will never be used.
|
|
|
84
|
|
|
85 add_timeout_cb Called with an EMACS_TIME, the absolute time at
|
|
|
86 which a wakeup event should be generated; and a
|
|
|
87 void *, which is an arbitrary value that will be
|
|
|
88 returned in the timeout event. The timeouts
|
|
|
89 generated by this function should be one-shots:
|
|
|
90 they fire once and then disappear. This callback
|
|
|
91 should return an int id-number which uniquely
|
|
|
92 identifies this wakeup. If an implementation
|
|
|
93 doesn't have microseconds or millisecond
|
|
|
94 granularity, it should round up to the closest
|
|
|
95 value it can deal with.
|
|
|
96
|
|
185
|
97 remove_timeout_cb Called with an int, the id number of a wakeup to
|
|
0
|
98 discard. This id number must have been returned by
|
|
|
99 the add_timeout_cb. If the given wakeup has
|
|
|
100 already expired, this should do nothing.
|
|
|
101
|
|
|
102 select_process_cb These callbacks tell the underlying implementation to
|
|
|
103 unselect_process_cb add or remove a file descriptor from the list of fds
|
|
|
104 which are polled for inferior-process input. When
|
|
|
105 input becomes available on the given process
|
|
|
106 connection, an event of type "process" should be
|
|
|
107 generated.
|
|
|
108
|
|
185
|
109 select_console_cb These callbacks tell the underlying implementation
|
|
0
|
110 unselect_console_cb to add or remove a console from the list of consoles
|
|
|
111 which are polled for user-input.
|
|
|
112
|
|
|
113 select_device_cb These callbacks are used by Unixoid event loops
|
|
|
114 unselect_device_cb (those that use select() and file descriptors and
|
|
|
115 have a separate input fd per device).
|
|
|
116
|
|
263
|
117 create_stream_pair_cb These callbacks are called by process code to
|
|
|
118 delete_stream_pair_cb create and delete a pait of input and output lstreams
|
|
|
119 which are used for subprocess I/O.
|
|
|
120
|
|
0
|
121 quitp_cb A handler function called from the `QUIT' macro which
|
|
|
122 should check whether the quit character has been
|
|
|
123 typed. On systems with SIGIO, this will not be called
|
|
|
124 unless the `sigio_happened' flag is true (it is set
|
|
|
125 from the SIGIO handler).
|
|
|
126
|
|
|
127 XEmacs has its own event structures, which are distinct from the event
|
|
|
128 structures used by X or any other window system. It is the job of the
|
|
|
129 event_stream layer to translate to this format.
|
|
|
130
|
|
|
131 NOTE: #### All timestamps should be measured as milliseconds since XEmacs
|
|
|
132 started. Currently many or most events have a 0 as their
|
|
|
133 timestamp value, and for other timestamps, they are raw server
|
|
|
134 timestamps. (The X protocol doesn't provide any easy way of
|
|
|
135 translating between server time and real process time; yuck.)
|
|
|
136
|
|
|
137 Every event type has the following structures:
|
|
|
138
|
|
|
139 channel Where this event occurred on. This will be
|
|
|
140 a frame, device, console, or nil, depending on the
|
|
|
141 event type. It is important that an object of
|
|
|
142 a more specific type than is actually generated
|
|
|
143 is not substituted -- e.g. there should not be
|
|
|
144 a frame inserted when a key-press event occurs,
|
|
|
145 because events on dead channels are automatically
|
|
|
146 ignored.
|
|
|
147
|
|
|
148 Specifically:
|
|
|
149
|
|
|
150 -- for button and mouse-motion events, channel
|
|
|
151 will be a frame. (The translation to a window
|
|
|
152 occurs later.)
|
|
|
153 -- for keyboard events, channel will be a console.
|
|
|
154 Note that fake keyboard events (generated
|
|
|
155 by `character-to-event' or something that
|
|
|
156 calls this, such as macros) need to have
|
|
|
157 the selected console stored into them when
|
|
|
158 the event is created. This is so that the
|
|
|
159 correct console-local variables (e.g. the
|
|
|
160 command builder) will get affected.
|
|
|
161 -- for timer, process, magic-eval, and eval events,
|
|
|
162 channel will be nil.
|
|
|
163 -- for scrollbar misc-user events, channel
|
|
|
164 will be a window.
|
|
|
165 -- for menubar misc-user events, channel
|
|
|
166 will be a frame.
|
|
|
167 -- for magic events, channel will be a frame
|
|
|
168 (usually) or a device.
|
|
185
|
169
|
|
0
|
170 timestamp When this event occurred -- if not known, this
|
|
|
171 is made up.
|
|
|
172
|
|
|
173 In addition, the following structures are specific to particular event
|
|
|
174 types:
|
|
|
175
|
|
185
|
176 key_press_event
|
|
0
|
177 key What keysym this is; an integer or a symbol.
|
|
|
178 If this is an integer, it will be in the printing
|
|
|
179 ASCII range: >32 and <127.
|
|
|
180 modifiers Bucky-bits on that key: control, meta, etc.
|
|
2
|
181 For many keys, Shift is not a bit; that is implicit
|
|
0
|
182 in the keyboard layout.
|
|
|
183
|
|
|
184 button_press_event
|
|
|
185 button_release_event
|
|
|
186 button What button went down or up.
|
|
|
187 modifiers Bucky-bits on that button: shift, control, meta, etc.
|
|
|
188 x, y Where it was at the button-state-change (in pixels).
|
|
|
189
|
|
|
190 pointer_motion_event
|
|
|
191 x, y Where it was after it moved (in pixels).
|
|
|
192 modifiers Bucky-bits down when the motion was detected.
|
|
|
193 (Possibly not all window systems will provide this?)
|
|
|
194
|
|
|
195 process_event
|
|
|
196 process the XEmacs "process" object in question
|
|
|
197
|
|
|
198 timeout_event
|
|
|
199 interval_id The ID returned when the associated call to
|
|
|
200 add_timeout_cb() was made
|
|
|
201 ------ the rest of the fields are filled in by XEmacs -----
|
|
|
202 id_number The XEmacs timeout ID for this timeout (more
|
|
|
203 than one timeout event can have the same value
|
|
|
204 here, since XEmacs timeouts, as opposed to
|
|
|
205 add_timeout_cb() timeouts, can resignal
|
|
|
206 themselves)
|
|
|
207 function An elisp function to call when this timeout is
|
|
|
208 processed.
|
|
|
209 object The object passed to that function.
|
|
|
210
|
|
|
211 eval_event
|
|
|
212 function An elisp function to call with this event object.
|
|
|
213 internal_function An unexported function to call with this event
|
|
|
214 object. This allows eval events to call internal
|
|
|
215 functions. For a normal eval event, this field
|
|
|
216 will always be 0.
|
|
|
217 object Anything.
|
|
|
218 This kind of event is used internally; sometimes the
|
|
|
219 window system interface would like to inform XEmacs of
|
|
|
220 some user action (such as focusing on another frame)
|
|
|
221 but needs that to happen synchronously with the other
|
|
|
222 user input, like keypresses. This is useful when
|
|
|
223 events are reported through callbacks rather
|
|
|
224 than in the standard event stream.
|
|
|
225
|
|
|
226 misc_user_event
|
|
|
227 function An elisp function to call with this event object.
|
|
|
228 internal_function Ignored.
|
|
|
229 object Anything.
|
|
|
230 This is similar to an eval_event, except that it is
|
|
|
231 generated by user actions: selections in the
|
|
|
232 menubar or scrollbar actions. It is a "command"
|
|
|
233 event, like key and mouse presses (and unlike mouse
|
|
|
234 motion, process output, and enter and leave window
|
|
|
235 hooks). In many ways, eval_events are not the same
|
|
|
236 as keypresses or misc_user_events.
|
|
|
237
|
|
|
238 magic_event
|
|
|
239 No user-serviceable parts within. This is for things
|
|
|
240 like KeymapNotify and ExposeRegion events and so on
|
|
|
241 that XEmacs itself doesn't care about, but which it
|
|
|
242 must do something with for proper interaction with
|
|
|
243 the window system.
|
|
|
244
|
|
|
245 Magic_events are handled somewhat asynchronously, just
|
|
185
|
246 like subprocess filters. However, occasionally a
|
|
0
|
247 magic_event needs to be handled synchronously; in that
|
|
|
248 case, the asynchronous handling of the magic_event will
|
|
185
|
249 push an eval_event back onto the queue, which will be
|
|
0
|
250 handled synchronously later. This is one of the
|
|
|
251 reasons why eval_events exist; I'm not entirely happy
|
|
|
252 with this aspect of this event model.
|
|
|
253
|
|
|
254 magic_eval_event
|
|
|
255 This is like an eval event but its contents are
|
|
|
256 not Lisp-accessible. This allows for "internal
|
|
|
257 eval events" that call non-Lisp-accessible functions.
|
|
|
258 Externally, a magic_eval_event just appears as
|
|
|
259 a magic_event; the Lisp programmer need not know
|
|
|
260 anything more.
|
|
197
|
261
|
|
249
|
262 #if defined(HAVE_OFFIX_DND) || defined(HAVE_MS_WINDOWS)
|
|
197
|
263 dnd_drop_event
|
|
|
264 dnd_drag_event (* to be implemented *)
|
|
|
265 button What button went down or up.
|
|
|
266 modifiers Bucky-bits on that button: shift, control, meta, etc.
|
|
|
267 x, y Where it was at the button-state-change (in pixels).
|
|
|
268 data A list of type and data.
|
|
|
269 This events are created by Drag'n'Drop actions.
|
|
|
270 Currently only the OffiX Dnd Protocol is supported.
|
|
|
271 #endif
|
|
|
272
|
|
0
|
273 */
|
|
|
274
|
|
263
|
275 /*
|
|
|
276 Stream pairs description
|
|
|
277 ------------------------
|
|
|
278
|
|
|
279 Since there are many possible processes/event loop combinations, the event code
|
|
|
280 is responsible for creating an appropriare lstream type. The process
|
|
|
281 implementation does not care about that implementation.
|
|
|
282
|
|
|
283 The Create stream pair function is passed two void* values, which identify
|
|
|
284 process-dependant 'handles'. The process implementation uses these handles
|
|
|
285 to communicate with child processes. The function must be prepared to receive
|
|
|
286 handle types of any process implementation. Since there only one process
|
|
|
287 implementation exists in a particular XEmacs configuration, preprocessing
|
|
|
288 is a mean of compiling in the support for the code which deals with particular
|
|
|
289 handle types.
|
|
|
290
|
|
|
291 For example, a unixoid type loop, which relies on file descriptors, may be
|
|
|
292 asked to create a pair of streams by a unix-style process implementation.
|
|
|
293 In this case, the handles passed are unix file descriptors, and the code
|
|
|
294 may deal with these directly. Although, the same code may be used on Win32
|
|
|
295 system with X-Windows. In this case, Win32 process implementation passes
|
|
|
296 handles of type HANDLE, and the create_stream_pair function must call
|
|
|
297 appropriate function to get file descriptors given HANDLEs, so that these
|
|
|
298 descriptors may be passed to XtAddInput.
|
|
|
299
|
|
|
300 The handle given may have special denying value, in which case the
|
|
|
301 corresponding lstream should not be created.
|
|
|
302
|
|
|
303 The return value of the function is a unique stream identifier. It is used
|
|
|
304 by processes implementation, in its platform-independant part. There is
|
|
|
305 the get_process_from_usid function, which returns process object given its
|
|
|
306 USID. The event stream is responsible for converting its internal handle
|
|
|
307 type into USID.
|
|
|
308
|
|
|
309 Example is the TTY event stream. When a file descriptor signals input, the
|
|
|
310 event loop must determine process to which the input is destined. Thus,
|
|
|
311 the imlementation uses process input stream file descriptor as USID, by
|
|
|
312 simply casting the fd value to USID type.
|
|
|
313
|
|
|
314 There are two special USID values. One, USID_ERROR, indicates that the stream
|
|
|
315 pair cannot be created. The second, USID_DONTHASH, indicates that streams are
|
|
|
316 created, but the event stream does not wish to be able to find the process
|
|
|
317 by its USID. Specifically, if an event stream implementation never calss
|
|
|
318 get_process_from_usid, this value should always be returned, to prevent
|
|
|
319 accumulating useless information on USID to process relationship.
|
|
|
320 */
|
|
|
321
|
|
|
322 /* typedef unsigned int USID; in lisp.h */
|
|
|
323 #define USID_ERROR ((USID)-1)
|
|
|
324 #define USID_DONTHASH ((USID)0)
|
|
|
325
|
|
0
|
326
|
|
|
327 struct Lisp_Event;
|
|
|
328 struct Lisp_Process;
|
|
|
329
|
|
|
330 struct event_stream
|
|
|
331 {
|
|
|
332 int (*event_pending_p) (int);
|
|
|
333 void (*next_event_cb) (struct Lisp_Event *);
|
|
|
334 void (*handle_magic_event_cb) (struct Lisp_Event *);
|
|
|
335 int (*add_timeout_cb) (EMACS_TIME);
|
|
|
336 void (*remove_timeout_cb) (int);
|
|
|
337 void (*select_console_cb) (struct console *);
|
|
|
338 void (*unselect_console_cb) (struct console *);
|
|
|
339 void (*select_process_cb) (struct Lisp_Process *);
|
|
|
340 void (*unselect_process_cb) (struct Lisp_Process *);
|
|
|
341 void (*quit_p_cb) (void);
|
|
263
|
342 USID (*create_stream_pair_cb) (void* /* inhandle*/, void* /*outhandle*/ ,
|
|
|
343 Lisp_Object* /* instream */,
|
|
|
344 Lisp_Object* /* outstream */,
|
|
|
345 int /* pty_flag */);
|
|
|
346 USID (*delete_stream_pair_cb) (Lisp_Object /* instream */,
|
|
|
347 Lisp_Object /* outstream */);
|
|
0
|
348 };
|
|
|
349
|
|
|
350 extern struct event_stream *event_stream;
|
|
|
351
|
|
|
352 typedef enum emacs_event_type
|
|
|
353 {
|
|
|
354 empty_event,
|
|
|
355 key_press_event,
|
|
|
356 button_press_event,
|
|
|
357 button_release_event,
|
|
|
358 pointer_motion_event,
|
|
|
359 process_event,
|
|
|
360 timeout_event,
|
|
|
361 magic_event,
|
|
|
362 magic_eval_event,
|
|
|
363 eval_event,
|
|
|
364 misc_user_event,
|
|
249
|
365 #if defined(HAVE_OFFIX_DND) || defined(HAVE_MS_WINDOWS)
|
|
197
|
366 dnd_drop_event,
|
|
|
367 #endif
|
|
0
|
368 dead_event
|
|
|
369 } emacs_event_type;
|
|
|
370
|
|
|
371 #define first_event_type empty_event
|
|
|
372 #define last_event_type dead_event
|
|
|
373
|
|
|
374
|
|
|
375 struct key_data
|
|
|
376 {
|
|
|
377 Lisp_Object keysym;
|
|
|
378 unsigned char modifiers;
|
|
|
379 };
|
|
|
380
|
|
|
381 struct button_data
|
|
|
382 {
|
|
|
383 int button;
|
|
|
384 unsigned char modifiers;
|
|
|
385 int x, y;
|
|
|
386 };
|
|
|
387
|
|
|
388 struct motion_data
|
|
|
389 {
|
|
|
390 int x, y;
|
|
|
391 unsigned char modifiers;
|
|
|
392 };
|
|
|
393
|
|
|
394 struct process_data
|
|
|
395 {
|
|
|
396 Lisp_Object process;
|
|
|
397 };
|
|
|
398
|
|
|
399 struct timeout_data
|
|
|
400 {
|
|
|
401 int interval_id;
|
|
|
402 int id_number;
|
|
|
403 Lisp_Object function, object;
|
|
|
404 };
|
|
|
405
|
|
|
406 struct eval_data
|
|
|
407 {
|
|
|
408 Lisp_Object function;
|
|
|
409 Lisp_Object object;
|
|
|
410 };
|
|
|
411
|
|
|
412 struct magic_eval_data
|
|
|
413 {
|
|
|
414 void (*internal_function) (Lisp_Object);
|
|
|
415 Lisp_Object object;
|
|
|
416 };
|
|
|
417
|
|
249
|
418 #if defined(HAVE_OFFIX_DND) || defined(HAVE_MS_WINDOWS)
|
|
197
|
419 struct dnd_drop_data
|
|
|
420 {
|
|
|
421 int button;
|
|
|
422 unsigned char modifiers;
|
|
|
423 int x, y;
|
|
|
424 Lisp_Object data;
|
|
|
425 };
|
|
|
426 #endif
|
|
|
427
|
|
0
|
428 #if defined (HAVE_X_WINDOWS) && defined(emacs)
|
|
|
429 # include <X11/Xlib.h>
|
|
|
430 #endif
|
|
|
431
|
|
|
432 union magic_data
|
|
|
433 {
|
|
209
|
434 #ifdef HAVE_TTY
|
|
|
435 char underlying_tty_event;
|
|
|
436 #endif
|
|
0
|
437 #ifdef HAVE_X_WINDOWS
|
|
209
|
438 XEvent underlying_x_event;
|
|
|
439 #endif
|
|
213
|
440 #ifdef HAVE_MS_WINDOWS
|
|
249
|
441 int underlying_mswindows_event;
|
|
0
|
442 #endif
|
|
|
443 };
|
|
|
444
|
|
|
445 struct Lisp_Event
|
|
|
446 {
|
|
|
447 /* header->next (aka XEVENT_NEXT ()) is used as follows:
|
|
|
448 - For dead events, this is the next dead one.
|
|
|
449 - For events on the command_event_queue, the next one on the queue.
|
|
|
450 - Likewise for events chained in the command builder.
|
|
|
451 - Otherwise it's Qnil.
|
|
|
452 */
|
|
|
453 struct lrecord_header lheader;
|
|
|
454 Lisp_Object next;
|
|
|
455 emacs_event_type event_type;
|
|
|
456 Lisp_Object channel;
|
|
|
457 unsigned int timestamp;
|
|
|
458 union
|
|
|
459 {
|
|
|
460 struct key_data key;
|
|
|
461 struct button_data button;
|
|
|
462 struct motion_data motion;
|
|
|
463 struct process_data process;
|
|
|
464 struct timeout_data timeout;
|
|
|
465 struct eval_data eval; /* misc_user_event uses this too */
|
|
|
466 union magic_data magic;
|
|
|
467 struct magic_eval_data magic_eval;
|
|
249
|
468 #if defined(HAVE_OFFIX_DND) || defined(HAVE_MS_WINDOWS)
|
|
197
|
469 struct dnd_drop_data dnd_drop;
|
|
|
470 #endif
|
|
0
|
471 } event;
|
|
|
472 };
|
|
|
473
|
|
|
474 DECLARE_LRECORD (event, struct Lisp_Event);
|
|
|
475 #define XEVENT(x) XRECORD (x, event, struct Lisp_Event)
|
|
|
476 #define XSETEVENT(x, p) XSETRECORD (x, p, event)
|
|
|
477 #define EVENTP(x) RECORDP (x, event)
|
|
|
478 #define GC_EVENTP(x) GC_RECORDP (x, event)
|
|
|
479 #define CHECK_EVENT(x) CHECK_RECORD (x, event)
|
|
|
480 #define CONCHECK_EVENT(x) CONCHECK_RECORD (x, event)
|
|
|
481
|
|
|
482 DECLARE_LRECORD (command_builder, struct command_builder);
|
|
|
483
|
|
|
484 #define EVENT_CHANNEL(a) ((a)->channel)
|
|
|
485 #define EVENT_TYPE(a) ((a)->event_type)
|
|
|
486 #define XEVENT_TYPE(a) (XEVENT (a)->event_type)
|
|
|
487 #define EVENT_NEXT(a) ((a)->next)
|
|
|
488 #define XEVENT_NEXT(e) (XEVENT (e)->next)
|
|
|
489 #define XSET_EVENT_NEXT(e, n) do { (XEVENT (e)->next = (n)); } while (0)
|
|
|
490
|
|
|
491 #define EVENT_CHAIN_LOOP(event, chain) \
|
|
|
492 for (event = chain; !NILP (event); event = XEVENT_NEXT (event))
|
|
|
493
|
|
|
494 #define EVENT_LIVE_P(a) (EVENT_TYPE (a) != dead_event)
|
|
|
495
|
|
|
496 #define CHECK_LIVE_EVENT(x) \
|
|
|
497 do { CHECK_EVENT (x); \
|
|
|
498 if (! EVENTP (x) \
|
|
|
499 || ! EVENT_LIVE_P (XEVENT (x))) \
|
|
|
500 dead_wrong_type_argument (Qevent_live_p, (x)); } while (0)
|
|
|
501 #define CONCHECK_LIVE_EVENT(x) \
|
|
|
502 do { CONCHECK_EVENT (x); \
|
|
|
503 if (! EVENTP (x) \
|
|
|
504 || ! EVENT_LIVE_P (XEVENT (x))) \
|
|
|
505 x = wrong_type_argument (Qevent_live_p, (x)); } while (0)
|
|
|
506
|
|
|
507
|
|
|
508 extern Lisp_Object Qevent_live_p;
|
|
|
509
|
|
|
510 /* Note: under X Windows, MOD_ALT is generated by the Alt key if there are
|
|
|
511 both Alt and Meta keys. If there are no Meta keys, then Alt generates
|
|
|
512 MOD_META instead.
|
|
|
513 */
|
|
|
514
|
|
|
515 #ifdef emacs
|
|
|
516 /* Maybe this should be trickier */
|
|
|
517 #define KEYSYM(x) (intern (x))
|
|
|
518
|
|
|
519 Lisp_Object allocate_command_builder (Lisp_Object console);
|
|
|
520
|
|
|
521 void format_event_object (char *buf, struct Lisp_Event *e, int brief);
|
|
|
522 void character_to_event (Emchar c, struct Lisp_Event *event,
|
|
|
523 struct console *con,
|
|
263
|
524 int use_console_meta_flag,
|
|
|
525 int do_backspace_mapping);
|
|
0
|
526 void enqueue_magic_eval_event (void (*fun) (Lisp_Object), Lisp_Object object);
|
|
|
527 void zero_event (struct Lisp_Event *e);
|
|
|
528
|
|
|
529 void deallocate_event_chain (Lisp_Object event);
|
|
|
530 Lisp_Object event_chain_tail (Lisp_Object event);
|
|
|
531 void enqueue_event (Lisp_Object event, Lisp_Object *head, Lisp_Object *tail);
|
|
|
532 Lisp_Object dequeue_event (Lisp_Object *head, Lisp_Object *tail);
|
|
|
533 void enqueue_event_chain (Lisp_Object event_chain, Lisp_Object *head,
|
|
|
534 Lisp_Object *tail);
|
|
|
535 int event_chain_count (Lisp_Object event_chain);
|
|
|
536 void nth_of_key_sequence_as_event (Lisp_Object seq, int n, Lisp_Object event);
|
|
|
537 Lisp_Object key_sequence_to_event_chain (Lisp_Object seq);
|
|
|
538 Lisp_Object event_chain_find_previous (Lisp_Object event_chain,
|
|
|
539 Lisp_Object event);
|
|
|
540 Lisp_Object event_chain_nth (Lisp_Object event_chain, int n);
|
|
|
541 Lisp_Object copy_event_chain (Lisp_Object event_chain);
|
|
|
542
|
|
2
|
543 /* True if this is a non-internal event
|
|
0
|
544 (keyboard press, menu, scrollbar, mouse button) */
|
|
|
545 int command_event_p (Lisp_Object event);
|
|
|
546
|
|
|
547 struct console *event_console_or_selected (Lisp_Object event);
|
|
|
548
|
|
|
549 int event_stream_event_pending_p (int user);
|
|
|
550 void event_stream_next_event (struct Lisp_Event *event);
|
|
|
551 void event_stream_handle_magic_event (struct Lisp_Event *event);
|
|
2
|
552 void event_stream_select_console (struct console *c);
|
|
0
|
553 void event_stream_unselect_console (struct console *c);
|
|
2
|
554 void event_stream_select_process (struct Lisp_Process *proc);
|
|
0
|
555 void event_stream_unselect_process (struct Lisp_Process *proc);
|
|
263
|
556 USID event_stream_create_stream_pair (void* inhandle, void* outhandle,
|
|
|
557 Lisp_Object* instream, Lisp_Object* outstream, int flags);
|
|
|
558 USID event_stream_delete_stream_pair (Lisp_Object instream, Lisp_Object outstream);
|
|
0
|
559 void event_stream_quit_p (void);
|
|
|
560
|
|
|
561 struct low_level_timeout
|
|
|
562 {
|
|
|
563 int id;
|
|
|
564 EMACS_TIME time;
|
|
|
565 struct low_level_timeout *next;
|
|
|
566 };
|
|
|
567
|
|
|
568 int add_low_level_timeout (struct low_level_timeout **timeout_list,
|
|
|
569 EMACS_TIME thyme);
|
|
|
570 void remove_low_level_timeout (struct low_level_timeout **timeout_list,
|
|
|
571 int id);
|
|
|
572 int get_low_level_timeout_interval (struct low_level_timeout *
|
|
|
573 timeout_list, EMACS_TIME *interval);
|
|
|
574 int pop_low_level_timeout (struct low_level_timeout **timeout_list,
|
|
|
575 EMACS_TIME *time_out);
|
|
|
576 int event_stream_generate_wakeup (unsigned int milliseconds,
|
|
|
577 unsigned int vanilliseconds,
|
|
|
578 Lisp_Object function,
|
|
|
579 Lisp_Object object,
|
|
|
580 int async_p);
|
|
|
581 void event_stream_disable_wakeup (int id, int async_p);
|
|
|
582 void event_stream_deal_with_async_timeout (int interval_id);
|
|
|
583
|
|
|
584 /* from signal.c */
|
|
|
585 int event_stream_add_async_timeout (EMACS_TIME thyme);
|
|
|
586 void event_stream_remove_async_timeout (int id);
|
|
|
587
|
|
|
588 void emacs_handle_focus_change_preliminary (Lisp_Object frame_inp_and_dev);
|
|
|
589 void emacs_handle_focus_change_final (Lisp_Object frame_inp_and_dev);
|
|
|
590
|
|
|
591 Lisp_Object extract_this_command_keys_nth_mouse_event (int n);
|
|
|
592 Lisp_Object extract_vector_nth_mouse_event (Lisp_Object vector, int n);
|
|
|
593
|
|
|
594 void single_console_state (void);
|
|
|
595 void any_console_state (void);
|
|
|
596 int in_single_console_state (void);
|
|
|
597
|
|
|
598 #ifdef HAVE_UNIXOID_EVENT_LOOP
|
|
|
599 /* Ceci n'est pas un pipe. */
|
|
|
600 extern int signal_event_pipe[];
|
|
|
601
|
|
|
602 void signal_fake_event (void);
|
|
|
603 void drain_signal_event_pipe (void);
|
|
|
604
|
|
|
605 extern int fake_event_occurred;
|
|
|
606
|
|
2
|
607 int event_stream_unixoid_select_console (struct console *con);
|
|
0
|
608 int event_stream_unixoid_unselect_console (struct console *con);
|
|
2
|
609 int event_stream_unixoid_select_process (struct Lisp_Process *proc);
|
|
0
|
610 int event_stream_unixoid_unselect_process (struct Lisp_Process *proc);
|
|
|
611 int read_event_from_tty_or_stream_desc (struct Lisp_Event *event,
|
|
|
612 struct console *c, int fd);
|
|
263
|
613 USID event_stream_unixoid_create_stream_pair (void* inhandle, void* outhandle,
|
|
|
614 Lisp_Object* instream,
|
|
|
615 Lisp_Object* outstream,
|
|
|
616 int flags);
|
|
|
617 USID event_stream_unixoid_delete_stream_pair (Lisp_Object instream,
|
|
|
618 Lisp_Object outstream);
|
|
|
619
|
|
|
620 /* Beware: this evil macro evaluates its arg many times */
|
|
|
621 #define FD_TO_USID(fd) ((fd)==0 ? (USID)999999 : ((fd)<0 ? USID_DONTHASH : (USID)(fd)))
|
|
|
622
|
|
0
|
623 #endif /* HAVE_UNIXOID_EVENT_LOOP */
|
|
|
624
|
|
|
625 extern int emacs_is_blocking;
|
|
|
626
|
|
|
627 extern Lisp_Object Vcontrolling_terminal;
|
|
|
628
|
|
|
629 extern volatile int sigint_happened;
|
|
|
630
|
|
|
631 /* Define this if you want the tty event stream to be used when the
|
|
|
632 first console is tty, even if HAVE_X_WINDOWS is defined */
|
|
|
633 /* #define DEBUG_TTY_EVENT_STREAM */
|
|
|
634
|
|
|
635 #endif /* emacs */
|
|
|
636
|
|
|
637 #endif /* _XEMACS_EVENTS_H_ */
|
