296
|
1 /* Hooks by which low level terminal operations
|
|
2 can be made to call other routines.
|
64770
|
3 Copyright (C) 1985, 1986, 1993, 1994, 2002, 2003, 2004,
|
68651
|
4 2005, 2006 Free Software Foundation, Inc.
|
296
|
5
|
|
6 This file is part of GNU Emacs.
|
|
7
|
|
8 GNU Emacs is free software; you can redistribute it and/or modify
|
|
9 it under the terms of the GNU General Public License as published by
|
648
|
10 the Free Software Foundation; either version 2, or (at your option)
|
296
|
11 any later version.
|
|
12
|
|
13 GNU Emacs is distributed in the hope that it will be useful,
|
|
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
16 GNU General Public License for more details.
|
|
17
|
|
18 You should have received a copy of the GNU General Public License
|
|
19 along with GNU Emacs; see the file COPYING. If not, write to
|
64084
|
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
21 Boston, MA 02110-1301, USA. */
|
296
|
22
|
1782
|
23
|
|
24 /* Miscellanea. */
|
|
25
|
25001
|
26 struct glyph;
|
|
27 struct frame;
|
|
28
|
1782
|
29 /* If nonzero, send all terminal output characters to this stream also. */
|
|
30 extern FILE *termscript;
|
|
31
|
21515
|
32 /* Only use prototypes when lisp.h has been included. */
|
|
33 #ifndef P_
|
|
34 #define P_(X) ()
|
|
35 #endif
|
1782
|
36
|
|
37 /* Text display hooks. */
|
296
|
38
|
25001
|
39 extern void (*cursor_to_hook) P_ ((int vpos, int hpos));
|
21515
|
40 extern void (*raw_cursor_to_hook) P_ ((int, int));
|
296
|
41
|
21515
|
42 extern void (*clear_to_end_hook) P_ ((void));
|
|
43 extern void (*clear_frame_hook) P_ ((void));
|
|
44 extern void (*clear_end_of_line_hook) P_ ((int));
|
296
|
45
|
21515
|
46 extern void (*ins_del_lines_hook) P_ ((int, int));
|
296
|
47
|
25001
|
48 extern void (*insert_glyphs_hook) P_ ((struct glyph *s, int n));
|
|
49 extern void (*write_glyphs_hook) P_ ((struct glyph *s, int n));
|
21515
|
50 extern void (*delete_glyphs_hook) P_ ((int));
|
296
|
51
|
21515
|
52 extern void (*ring_bell_hook) P_ ((void));
|
296
|
53
|
21515
|
54 extern void (*reset_terminal_modes_hook) P_ ((void));
|
|
55 extern void (*set_terminal_modes_hook) P_ ((void));
|
|
56 extern void (*update_begin_hook) P_ ((struct frame *));
|
|
57 extern void (*update_end_hook) P_ ((struct frame *));
|
|
58 extern void (*set_terminal_window_hook) P_ ((int));
|
296
|
59
|
1782
|
60
|
|
61
|
|
62 /* Multi-frame and mouse support hooks. */
|
296
|
63
|
1994
|
64 enum scroll_bar_part {
|
|
65 scroll_bar_above_handle,
|
|
66 scroll_bar_handle,
|
15176
|
67 scroll_bar_below_handle,
|
|
68 scroll_bar_up_arrow,
|
25001
|
69 scroll_bar_down_arrow,
|
|
70 scroll_bar_to_top,
|
|
71 scroll_bar_to_bottom,
|
26787
|
72 scroll_bar_end_scroll,
|
|
73 scroll_bar_move_ratio
|
1717
|
74 };
|
|
75
|
|
76 /* Return the current position of the mouse.
|
1782
|
77
|
|
78 Set *f to the frame the mouse is in, or zero if the mouse is in no
|
|
79 Emacs frame. If it is set to zero, all the other arguments are
|
|
80 garbage.
|
|
81
|
1994
|
82 If the motion started in a scroll bar, set *bar_window to the
|
|
83 scroll bar's window, *part to the part the mouse is currently over,
|
|
84 *x to the position of the mouse along the scroll bar, and *y to the
|
|
85 overall length of the scroll bar.
|
1782
|
86
|
|
87 Otherwise, set *bar_window to Qnil, and *x and *y to the column and
|
|
88 row of the character cell the mouse is over.
|
|
89
|
|
90 Set *time to the time the mouse was at the returned position.
|
|
91
|
|
92 This should clear mouse_moved until the next motion
|
|
93 event arrives. */
|
21515
|
94 extern void (*mouse_position_hook) P_ ((struct frame **f, int,
|
1782
|
95 Lisp_Object *bar_window,
|
1994
|
96 enum scroll_bar_part *part,
|
485
|
97 Lisp_Object *x,
|
|
98 Lisp_Object *y,
|
21515
|
99 unsigned long *time));
|
296
|
100
|
485
|
101 /* The window system handling code should set this if the mouse has
|
|
102 moved since the last call to the mouse_position_hook. Calling that
|
|
103 hook should clear this. */
|
|
104 extern int mouse_moved;
|
296
|
105
|
766
|
106 /* When a frame's focus redirection is changed, this hook tells the
|
357
|
107 window system code to re-decide where to put the highlight. Under
|
485
|
108 X, this means that Emacs lies about where the focus is. */
|
21515
|
109 extern void (*frame_rehighlight_hook) P_ ((struct frame *));
|
338
|
110
|
1821
|
111 /* If we're displaying frames using a window system that can stack
|
|
112 frames on top of each other, this hook allows you to bring a frame
|
|
113 to the front, or bury it behind all the other windows. If this
|
|
114 hook is zero, that means the device we're displaying on doesn't
|
|
115 support overlapping frames, so there's no need to raise or lower
|
|
116 anything.
|
|
117
|
|
118 If RAISE is non-zero, F is brought to the front, before all other
|
|
119 windows. If RAISE is zero, F is sent to the back, behind all other
|
|
120 windows. */
|
21515
|
121 extern void (*frame_raise_lower_hook) P_ ((struct frame *f, int raise));
|
1782
|
122
|
|
123
|
1994
|
124 /* Scroll bar hooks. */
|
1782
|
125
|
1994
|
126 /* The representation of scroll bars is determined by the code which
|
1782
|
127 implements them, except for one thing: they must be represented by
|
|
128 lisp objects. This allows us to place references to them in
|
|
129 Lisp_Windows without worrying about those references becoming
|
1994
|
130 dangling references when the scroll bar is destroyed.
|
1782
|
131
|
|
132 The window-system-independent portion of Emacs just refers to
|
1994
|
133 scroll bars via their windows, and never looks inside the scroll bar
|
1782
|
134 representation; it always uses hook functions to do all the
|
1994
|
135 scroll bar manipulation it needs.
|
1782
|
136
|
1994
|
137 The `vertical_scroll_bar' field of a Lisp_Window refers to that
|
|
138 window's scroll bar, or is nil if the window doesn't have a
|
|
139 scroll bar.
|
1782
|
140
|
1994
|
141 The `scroll_bars' and `condemned_scroll_bars' fields of a Lisp_Frame
|
|
142 are free for use by the scroll bar implementation in any way it sees
|
1782
|
143 fit. They are marked by the garbage collector. */
|
|
144
|
|
145
|
1994
|
146 /* Set the vertical scroll bar for WINDOW to have its upper left corner
|
1782
|
147 at (TOP, LEFT), and be LENGTH rows high. Set its handle to
|
|
148 indicate that we are displaying PORTION characters out of a total
|
|
149 of WHOLE characters, starting at POSITION. If WINDOW doesn't yet
|
1994
|
150 have a scroll bar, create one for it. */
|
|
151 extern void (*set_vertical_scroll_bar_hook)
|
21515
|
152 P_ ((struct window *window,
|
|
153 int portion, int whole, int position));
|
1717
|
154
|
|
155
|
|
156 /* The following three hooks are used when we're doing a thorough
|
1994
|
157 redisplay of the frame. We don't explicitly know which scroll bars
|
1717
|
158 are going to be deleted, because keeping track of when windows go
|
|
159 away is a real pain - can you say set-window-configuration?
|
|
160 Instead, we just assert at the beginning of redisplay that *all*
|
1994
|
161 scroll bars are to be removed, and then save scroll bars from the
|
14034
|
162 fiery pit when we actually redisplay their window. */
|
1717
|
163
|
1994
|
164 /* Arrange for all scroll bars on FRAME to be removed at the next call
|
|
165 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
|
49600
|
166 `*redeem_scroll_bar_hook' is applied to its window before the judgement.
|
1782
|
167
|
|
168 This should be applied to each frame each time its window tree is
|
1994
|
169 redisplayed, even if it is not displaying scroll bars at the moment;
|
|
170 if the HAS_SCROLL_BARS flag has just been turned off, only calling
|
|
171 this and the judge_scroll_bars_hook will get rid of them.
|
1717
|
172
|
1782
|
173 If non-zero, this hook should be safe to apply to any frame,
|
1994
|
174 whether or not it can support scroll bars, and whether or not it is
|
1782
|
175 currently displaying them. */
|
21515
|
176 extern void (*condemn_scroll_bars_hook) P_ ((struct frame *frame));
|
1782
|
177
|
1994
|
178 /* Unmark WINDOW's scroll bar for deletion in this judgement cycle.
|
|
179 Note that it's okay to redeem a scroll bar that is not condemned. */
|
21515
|
180 extern void (*redeem_scroll_bar_hook) P_ ((struct window *window));
|
1717
|
181
|
1994
|
182 /* Remove all scroll bars on FRAME that haven't been saved since the
|
49600
|
183 last call to `*condemn_scroll_bars_hook'.
|
1782
|
184
|
|
185 This should be applied to each frame after each time its window
|
1994
|
186 tree is redisplayed, even if it is not displaying scroll bars at the
|
|
187 moment; if the HAS_SCROLL_BARS flag has just been turned off, only
|
|
188 calling this and condemn_scroll_bars_hook will get rid of them.
|
1782
|
189
|
|
190 If non-zero, this hook should be safe to apply to any frame,
|
1994
|
191 whether or not it can support scroll bars, and whether or not it is
|
1782
|
192 currently displaying them. */
|
21515
|
193 extern void (*judge_scroll_bars_hook) P_ ((struct frame *FRAME));
|
1717
|
194
|
1782
|
195
|
|
196 /* Input queue declarations and hooks. */
|
1717
|
197
|
296
|
198 /* Expedient hack: only provide the below definitions to files that
|
6747
|
199 are prepared to handle lispy things. CONSP is defined iff lisp.h
|
485
|
200 has been included before this file. */
|
4143
|
201 #ifdef CONSP
|
296
|
202
|
2186
82e8ee492593
(selection_request_event, selection_clear_event): New event kinds.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
203 enum event_kind
|
82e8ee492593
(selection_request_event, selection_clear_event): New event kinds.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
204 {
|
45803
|
205 NO_EVENT, /* nothing happened. This should never
|
296
|
206 actually appear in the event queue. */
|
4799
|
207
|
45803
|
208 ASCII_KEYSTROKE_EVENT, /* The ASCII code is in .code, perhaps
|
4799
|
209 with modifiers applied.
|
|
210 .modifiers holds the state of the
|
|
211 modifier keys.
|
1782
|
212 .frame_or_window is the frame in
|
|
213 which the key was typed.
|
485
|
214 .timestamp gives a timestamp (in
|
|
215 milliseconds) for the keystroke. */
|
45803
|
216 MULTIBYTE_CHAR_KEYSTROKE_EVENT, /* The multibyte char code is in .code,
|
30750
|
217 perhaps with modifiers applied.
|
|
218 The others are the same as
|
48090
|
219 ASCII_KEYSTROKE_EVENT. */
|
45803
|
220 NON_ASCII_KEYSTROKE_EVENT, /* .code is a number identifying the
|
296
|
221 function key. A code N represents
|
|
222 a key whose name is
|
|
223 function_key_names[N]; function_key_names
|
|
224 is a table in keyboard.c to which you
|
|
225 should feel free to add missing keys.
|
|
226 .modifiers holds the state of the
|
338
|
227 modifier keys.
|
1782
|
228 .frame_or_window is the frame in
|
|
229 which the key was typed.
|
485
|
230 .timestamp gives a timestamp (in
|
|
231 milliseconds) for the keystroke. */
|
45803
|
232 TIMER_EVENT, /* A timer fired. */
|
|
233 MOUSE_CLICK_EVENT, /* The button number is in .code; it must
|
1312
|
234 be >= 0 and < NUM_MOUSE_BUTTONS, defined
|
|
235 below.
|
296
|
236 .modifiers holds the state of the
|
|
237 modifier keys.
|
|
238 .x and .y give the mouse position,
|
708
|
239 in characters, within the window.
|
1782
|
240 .frame_or_window gives the frame
|
|
241 the mouse click occurred in.
|
296
|
242 .timestamp gives a timestamp (in
|
|
243 milliseconds) for the click. */
|
51383
|
244 WHEEL_EVENT, /* A wheel event is generated by a
|
|
245 wheel on a mouse (e.g., MS
|
|
246 Intellimouse).
|
|
247 .modifiers holds the rotate
|
|
248 direction (up or down), and the
|
|
249 state of the modifier keys.
|
|
250 .x and .y give the mouse position,
|
|
251 in characters, within the window.
|
|
252 .frame_or_window gives the frame
|
|
253 the wheel event occurred in.
|
|
254 .timestamp gives a timestamp (in
|
|
255 milliseconds) for the event. */
|
61501
1ccfb57e0ed0
(enum event_kind) [MAC_OS]: Add LANGUAGE_CHANGE_EVENT.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
256 #if defined (WINDOWSNT) || defined (MAC_OS)
|
1ccfb57e0ed0
(enum event_kind) [MAC_OS]: Add LANGUAGE_CHANGE_EVENT.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
257 LANGUAGE_CHANGE_EVENT, /* A LANGUAGE_CHANGE_EVENT is
|
1ccfb57e0ed0
(enum event_kind) [MAC_OS]: Add LANGUAGE_CHANGE_EVENT.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
258 generated on WINDOWSNT or Mac OS
|
1ccfb57e0ed0
(enum event_kind) [MAC_OS]: Add LANGUAGE_CHANGE_EVENT.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
259 when the keyboard layout or input
|
1ccfb57e0ed0
(enum event_kind) [MAC_OS]: Add LANGUAGE_CHANGE_EVENT.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
260 language is changed by the
|
23800
|
261 user. */
|
19700
|
262 #endif
|
45803
|
263 SCROLL_BAR_CLICK_EVENT, /* .code gives the number of the mouse button
|
1717
|
264 that was clicked.
|
|
265 .modifiers holds the state of the modifier
|
|
266 keys.
|
296
|
267 .part is a lisp symbol indicating which
|
1994
|
268 part of the scroll bar got clicked.
|
1717
|
269 .x gives the distance from the start of the
|
|
270 scroll bar of the click; .y gives the total
|
|
271 length of the scroll bar.
|
1782
|
272 .frame_or_window gives the window
|
1994
|
273 whose scroll bar was clicked in.
|
296
|
274 .timestamp gives a timestamp (in
|
|
275 milliseconds) for the click. */
|
15176
|
276 #ifdef WINDOWSNT
|
45803
|
277 W32_SCROLL_BAR_CLICK_EVENT, /* as for SCROLL_BAR_CLICK, but only generated
|
15176
|
278 by MS-Windows scroll bar controls. */
|
|
279 #endif
|
45803
|
280 SELECTION_REQUEST_EVENT, /* Another X client wants a selection from us.
|
67460
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
281 See `struct selection_input_event'. */
|
45803
|
282 SELECTION_CLEAR_EVENT, /* Another X client cleared our selection. */
|
|
283 BUFFER_SWITCH_EVENT, /* A process filter has switched buffers. */
|
|
284 DELETE_WINDOW_EVENT, /* An X client said "delete this window". */
|
30175
|
285 MENU_BAR_EVENT, /* An event generated by the menu bar.
|
10798
|
286 The frame_or_window field's cdr holds the
|
7097
|
287 Lisp-level event value.
|
|
288 (Only the toolkit version uses these.) */
|
45803
|
289 ICONIFY_EVENT, /* An X client iconified this window. */
|
|
290 DEICONIFY_EVENT, /* An X client deiconified this window. */
|
|
291 MENU_BAR_ACTIVATE_EVENT, /* A button press in the menu bar
|
12660
|
292 (toolkit version only). */
|
45803
|
293 DRAG_N_DROP_EVENT, /* A drag-n-drop event is generated when
|
21889
|
294 files selected outside of Emacs are dropped
|
|
295 onto an Emacs window.
|
49600
|
296 .modifiers holds the state of the
|
21889
|
297 modifier keys.
|
|
298 .x and .y give the mouse position,
|
|
299 in characters, within the window.
|
67668
8926adaaf30f
(struct input_event): Fix comment for DRAG_N_DROP_EVENT.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
300 .frame_or_window is the frame in
|
8926adaaf30f
(struct input_event): Fix comment for DRAG_N_DROP_EVENT.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
301 which the drop was made.
|
8926adaaf30f
(struct input_event): Fix comment for DRAG_N_DROP_EVENT.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
302 .arg is a platform-dependent
|
8926adaaf30f
(struct input_event): Fix comment for DRAG_N_DROP_EVENT.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
303 representation of the dropped items.
|
21889
|
304 .timestamp gives a timestamp (in
|
|
305 milliseconds) for the click. */
|
30175
|
306 USER_SIGNAL_EVENT, /* A user signal.
|
|
307 code is a number identifying it,
|
25001
|
308 index into lispy_user_signals. */
|
|
309
|
30175
|
310 /* Help events. Member `frame_or_window' of the input_event is the
|
|
311 frame on which the event occurred, and member `arg' contains
|
|
312 the help to show. */
|
25001
|
313 HELP_EVENT,
|
|
314
|
30175
|
315 /* An event from a tool-bar. Member `arg' of the input event
|
|
316 contains the tool-bar item selected. If `frame_or_window'
|
|
317 and `arg' are equal, this is a prefix event. */
|
29514
|
318 TOOL_BAR_EVENT,
|
|
319
|
|
320 /* Queued from XTread_socket on FocusIn events. Translated into
|
|
321 `switch-frame' events in kbd_buffer_get_event, if necessary. */
|
43813
|
322 FOCUS_IN_EVENT,
|
|
323
|
44299
|
324 /* Generated when mouse moves over window not currently selected. */
|
|
325 SELECT_WINDOW_EVENT,
|
|
326
|
43813
|
327 /* Queued from XTread_socket when session manager sends
|
|
328 save yourself before shutdown. */
|
67460
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
329 SAVE_SESSION_EVENT,
|
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
330
|
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
331 #ifdef MAC_OS
|
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
332 /* Generated when an Apple event, a HICommand event, or a Services
|
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
333 menu event is received and the corresponding handler is
|
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
334 registered. Members `x' and `y' are for the event class and ID
|
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
335 symbols, respectively. Member `code' points to the Apple event
|
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
336 descriptor. Parameters for Non-Apple events are converted to
|
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
337 those in Apple events. */
|
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
338 MAC_APPLE_EVENT
|
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
339 #endif
|
2186
82e8ee492593
(selection_request_event, selection_clear_event): New event kinds.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
340 };
|
82e8ee492593
(selection_request_event, selection_clear_event): New event kinds.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
341
|
45803
|
342 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
|
|
343 or SELECTION_CLEAR_EVENT, then its contents are really described
|
67460
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
344 by `struct selection_input_event'; see xterm.h. */
|
2186
82e8ee492593
(selection_request_event, selection_clear_event): New event kinds.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
345
|
82e8ee492593
(selection_request_event, selection_clear_event): New event kinds.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
346 /* The keyboard input buffer is an array of these structures. Each one
|
82e8ee492593
(selection_request_event, selection_clear_event): New event kinds.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
347 represents some sort of input event - a keystroke, a mouse click, or
|
82e8ee492593
(selection_request_event, selection_clear_event): New event kinds.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
348 a window system event. These get turned into their lispy forms when
|
82e8ee492593
(selection_request_event, selection_clear_event): New event kinds.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
349 they are removed from the event queue. */
|
82e8ee492593
(selection_request_event, selection_clear_event): New event kinds.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
350
|
14393
|
351 struct input_event
|
|
352 {
|
2186
82e8ee492593
(selection_request_event, selection_clear_event): New event kinds.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
353 /* What kind of event was this? */
|
39583
|
354 enum event_kind kind;
|
49600
|
355
|
45803
|
356 /* For an ASCII_KEYSTROKE_EVENT and MULTIBYTE_CHAR_KEYSTROKE_EVENT,
|
|
357 this is the character.
|
|
358 For a NON_ASCII_KEYSTROKE_EVENT, this is the keysym code.
|
5361
|
359 For a mouse event, this is the button number. */
|
19700
|
360 /* In WindowsNT, for a mouse wheel event, this is the delta. */
|
5226
|
361 int code;
|
1994
|
362 enum scroll_bar_part part;
|
732
|
363
|
14161
|
364 int modifiers; /* See enum below for interpretation. */
|
|
365
|
|
366 Lisp_Object x, y;
|
|
367 unsigned long timestamp;
|
|
368
|
14393
|
369 /* This is padding just to put the frame_or_window field
|
67460
d74c30ee3772
(enum event_kind) [MAC_OS]: Add new MAC_APPLE_EVENT event.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
diff
changeset
|
370 past the size of struct selection_input_event. */
|
14393
|
371 int *padding[2];
|
|
372
|
1782
|
373 /* This field is copied into a vector while the event is in the queue,
|
|
374 so that garbage collections won't kill it. */
|
10798
|
375 /* In a menu_bar_event, this is a cons cell whose car is the frame
|
|
376 and whose cdr is the Lisp object that is the event's value. */
|
14161
|
377 /* This field is last so that struct selection_input_event
|
|
378 does not overlap with it. */
|
1782
|
379 Lisp_Object frame_or_window;
|
30175
|
380
|
|
381 /* Additional event argument. This is used for TOOL_BAR_EVENTs and
|
|
382 HELP_EVENTs and avoids calling Fcons during signal handling. */
|
|
383 Lisp_Object arg;
|
296
|
384 };
|
21515
|
385
|
51568
|
386 #define EVENT_INIT(event) bzero (&(event), sizeof (struct input_event))
|
|
387
|
21515
|
388 /* Called to read input events. */
|
54168
|
389 extern int (*read_socket_hook) P_ ((int, int, struct input_event *));
|
21515
|
390
|
|
391 /* Called when a frame's display becomes entirely up to date. */
|
|
392 extern void (*frame_up_to_date_hook) P_ ((struct frame *));
|
2186
82e8ee492593
(selection_request_event, selection_clear_event): New event kinds.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
393
|
1312
|
394
|
1238
|
395 /* Bits in the modifiers member of the input_event structure.
|
|
396 Note that reorder_modifiers assumes that the bits are in canonical
|
49600
|
397 order.
|
1312
|
398
|
|
399 The modifiers applied to mouse clicks are rather ornate. The
|
|
400 window-system-specific code should store mouse clicks with
|
1319
|
401 up_modifier or down_modifier set. Having an explicit down modifier
|
|
402 simplifies some of window-system-independent code; without it, the
|
|
403 code would have to recognize down events by checking if the event
|
|
404 is a mouse click lacking the click and drag modifiers.
|
|
405
|
|
406 The window-system independent code turns all up_modifier events
|
3861
|
407 bits into drag_modifier, click_modifier, double_modifier, or
|
|
408 triple_modifier events. The click_modifier has no written
|
|
409 representation in the names of the symbols used as event heads,
|
|
410 but it does appear in the Qevent_symbol_components property of the
|
|
411 event heads. */
|
296
|
412 enum {
|
1312
|
413 up_modifier = 1, /* Only used on mouse buttons - always
|
|
414 turned into a click or a drag modifier
|
|
415 before lisp code sees the event. */
|
2659
|
416 down_modifier = 2, /* Only used on mouse buttons. */
|
|
417 drag_modifier = 4, /* This is never used in the event
|
1312
|
418 queue; it's only used internally by
|
|
419 the window-system-independent code. */
|
2659
|
420 click_modifier= 8, /* See drag_modifier. */
|
3861
|
421 double_modifier= 16, /* See drag_modifier. */
|
|
422 triple_modifier= 32, /* See drag_modifier. */
|
2659
|
423
|
|
424 /* The next four modifier bits are used also in keyboard events at
|
|
425 the Lisp level.
|
2046
|
426
|
2659
|
427 It's probably not the greatest idea to use the 2^23 bit for any
|
|
428 modifier. It may or may not be the sign bit, depending on
|
|
429 VALBITS, so using it to represent a modifier key means that
|
|
430 characters thus modified have different integer equivalents
|
|
431 depending on the architecture they're running on. Oh, and
|
|
432 applying XINT to a character whose 2^23 bit is set sign-extends
|
|
433 it, so you get a bunch of bits in the mask you didn't want.
|
|
434
|
|
435 The CHAR_ macros are defined in lisp.h. */
|
|
436 alt_modifier = CHAR_ALT, /* Under X, the XK_Alt_[LR] keysyms. */
|
|
437 super_modifier= CHAR_SUPER, /* Under X, the XK_Super_[LR] keysyms. */
|
|
438 hyper_modifier= CHAR_HYPER, /* Under X, the XK_Hyper_[LR] keysyms. */
|
|
439 shift_modifier= CHAR_SHIFT,
|
|
440 ctrl_modifier = CHAR_CTL,
|
4569
|
441 meta_modifier = CHAR_META /* Under X, the XK_Meta_[LR] keysyms. */
|
296
|
442 };
|
|
443
|
|
444 #endif
|
52401
|
445
|
|
446 /* arch-tag: 33a00ecc-52b5-4186-a410-8801ac9f087d
|
|
447 (do not change this comment) */
|