Commit | Line | Data |
---|---|---|
80856e74 JB |
1 | /* Hooks by which low level terminal operations |
2 | can be made to call other routines. | |
3a22ee35 | 3 | Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc. |
80856e74 JB |
4 | |
5 | This file is part of GNU Emacs. | |
6 | ||
7 | GNU Emacs is free software; you can redistribute it and/or modify | |
8 | it under the terms of the GNU General Public License as published by | |
ffd56f97 | 9 | the Free Software Foundation; either version 2, or (at your option) |
80856e74 JB |
10 | any later version. |
11 | ||
12 | GNU Emacs is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
18 | along with GNU Emacs; see the file COPYING. If not, write to | |
3b7ad313 EN |
19 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
20 | Boston, MA 02111-1307, USA. */ | |
80856e74 | 21 | |
ec3f896c JB |
22 | \f |
23 | /* Miscellanea. */ | |
24 | ||
25 | /* If nonzero, send all terminal output characters to this stream also. */ | |
26 | extern FILE *termscript; | |
27 | ||
ec5d8db7 AS |
28 | /* Only use prototypes when lisp.h has been included. */ |
29 | #ifndef P_ | |
30 | #define P_(X) () | |
31 | #endif | |
ec3f896c JB |
32 | \f |
33 | /* Text display hooks. */ | |
80856e74 | 34 | |
ec5d8db7 AS |
35 | extern void (*cursor_to_hook) P_ ((int, int)); |
36 | extern void (*raw_cursor_to_hook) P_ ((int, int)); | |
80856e74 | 37 | |
ec5d8db7 AS |
38 | extern void (*clear_to_end_hook) P_ ((void)); |
39 | extern void (*clear_frame_hook) P_ ((void)); | |
40 | extern void (*clear_end_of_line_hook) P_ ((int)); | |
80856e74 | 41 | |
ec5d8db7 | 42 | extern void (*ins_del_lines_hook) P_ ((int, int)); |
80856e74 | 43 | |
ec5d8db7 AS |
44 | extern void (*change_line_highlight_hook) P_ ((int, int, int)); |
45 | extern void (*reassert_line_highlight_hook) P_ ((int, int)); | |
80856e74 | 46 | |
ec5d8db7 AS |
47 | extern void (*insert_glyphs_hook) P_ ((GLYPH *, int)); |
48 | extern void (*write_glyphs_hook) P_ ((GLYPH *, int)); | |
49 | extern void (*delete_glyphs_hook) P_ ((int)); | |
80856e74 | 50 | |
ec5d8db7 | 51 | extern void (*ring_bell_hook) P_ ((void)); |
80856e74 | 52 | |
ec5d8db7 AS |
53 | extern void (*reset_terminal_modes_hook) P_ ((void)); |
54 | extern void (*set_terminal_modes_hook) P_ ((void)); | |
55 | extern void (*update_begin_hook) P_ ((struct frame *)); | |
56 | extern void (*update_end_hook) P_ ((struct frame *)); | |
57 | extern void (*set_terminal_window_hook) P_ ((int)); | |
80856e74 | 58 | |
ec3f896c JB |
59 | |
60 | \f | |
61 | /* Multi-frame and mouse support hooks. */ | |
80856e74 | 62 | |
a3c87d4e JB |
63 | enum scroll_bar_part { |
64 | scroll_bar_above_handle, | |
65 | scroll_bar_handle, | |
33d5f42a RS |
66 | scroll_bar_below_handle, |
67 | scroll_bar_up_arrow, | |
dc929aa9 | 68 | scroll_bar_down_arrow |
20a558dc JB |
69 | }; |
70 | ||
71 | /* Return the current position of the mouse. | |
ec3f896c JB |
72 | |
73 | Set *f to the frame the mouse is in, or zero if the mouse is in no | |
74 | Emacs frame. If it is set to zero, all the other arguments are | |
75 | garbage. | |
76 | ||
a3c87d4e JB |
77 | If the motion started in a scroll bar, set *bar_window to the |
78 | scroll bar's window, *part to the part the mouse is currently over, | |
79 | *x to the position of the mouse along the scroll bar, and *y to the | |
80 | overall length of the scroll bar. | |
ec3f896c JB |
81 | |
82 | Otherwise, set *bar_window to Qnil, and *x and *y to the column and | |
83 | row of the character cell the mouse is over. | |
84 | ||
85 | Set *time to the time the mouse was at the returned position. | |
86 | ||
87 | This should clear mouse_moved until the next motion | |
88 | event arrives. */ | |
ec5d8db7 | 89 | extern void (*mouse_position_hook) P_ ((struct frame **f, int, |
ec3f896c | 90 | Lisp_Object *bar_window, |
a3c87d4e | 91 | enum scroll_bar_part *part, |
265a9e55 JB |
92 | Lisp_Object *x, |
93 | Lisp_Object *y, | |
ec5d8db7 | 94 | unsigned long *time)); |
265a9e55 JB |
95 | |
96 | /* The window system handling code should set this if the mouse has | |
97 | moved since the last call to the mouse_position_hook. Calling that | |
98 | hook should clear this. */ | |
99 | extern int mouse_moved; | |
80856e74 | 100 | |
0137dbf7 | 101 | /* When a frame's focus redirection is changed, this hook tells the |
0f79a4ae | 102 | window system code to re-decide where to put the highlight. Under |
265a9e55 | 103 | X, this means that Emacs lies about where the focus is. */ |
ec5d8db7 | 104 | extern void (*frame_rehighlight_hook) P_ ((struct frame *)); |
62c07cc7 | 105 | |
dbc4e1c1 JB |
106 | /* If we're displaying frames using a window system that can stack |
107 | frames on top of each other, this hook allows you to bring a frame | |
108 | to the front, or bury it behind all the other windows. If this | |
109 | hook is zero, that means the device we're displaying on doesn't | |
110 | support overlapping frames, so there's no need to raise or lower | |
111 | anything. | |
112 | ||
113 | If RAISE is non-zero, F is brought to the front, before all other | |
114 | windows. If RAISE is zero, F is sent to the back, behind all other | |
115 | windows. */ | |
ec5d8db7 | 116 | extern void (*frame_raise_lower_hook) P_ ((struct frame *f, int raise)); |
ec3f896c JB |
117 | |
118 | \f | |
a3c87d4e | 119 | /* Scroll bar hooks. */ |
ec3f896c | 120 | |
a3c87d4e | 121 | /* The representation of scroll bars is determined by the code which |
ec3f896c JB |
122 | implements them, except for one thing: they must be represented by |
123 | lisp objects. This allows us to place references to them in | |
124 | Lisp_Windows without worrying about those references becoming | |
a3c87d4e | 125 | dangling references when the scroll bar is destroyed. |
ec3f896c JB |
126 | |
127 | The window-system-independent portion of Emacs just refers to | |
a3c87d4e | 128 | scroll bars via their windows, and never looks inside the scroll bar |
ec3f896c | 129 | representation; it always uses hook functions to do all the |
a3c87d4e | 130 | scroll bar manipulation it needs. |
ec3f896c | 131 | |
a3c87d4e JB |
132 | The `vertical_scroll_bar' field of a Lisp_Window refers to that |
133 | window's scroll bar, or is nil if the window doesn't have a | |
134 | scroll bar. | |
ec3f896c | 135 | |
a3c87d4e JB |
136 | The `scroll_bars' and `condemned_scroll_bars' fields of a Lisp_Frame |
137 | are free for use by the scroll bar implementation in any way it sees | |
ec3f896c JB |
138 | fit. They are marked by the garbage collector. */ |
139 | ||
140 | ||
a3c87d4e | 141 | /* Set the vertical scroll bar for WINDOW to have its upper left corner |
ec3f896c JB |
142 | at (TOP, LEFT), and be LENGTH rows high. Set its handle to |
143 | indicate that we are displaying PORTION characters out of a total | |
144 | of WHOLE characters, starting at POSITION. If WINDOW doesn't yet | |
a3c87d4e JB |
145 | have a scroll bar, create one for it. */ |
146 | extern void (*set_vertical_scroll_bar_hook) | |
ec5d8db7 AS |
147 | P_ ((struct window *window, |
148 | int portion, int whole, int position)); | |
20a558dc JB |
149 | |
150 | ||
151 | /* The following three hooks are used when we're doing a thorough | |
a3c87d4e | 152 | redisplay of the frame. We don't explicitly know which scroll bars |
20a558dc JB |
153 | are going to be deleted, because keeping track of when windows go |
154 | away is a real pain - can you say set-window-configuration? | |
155 | Instead, we just assert at the beginning of redisplay that *all* | |
a3c87d4e | 156 | scroll bars are to be removed, and then save scroll bars from the |
b72e4ca8 | 157 | fiery pit when we actually redisplay their window. */ |
20a558dc | 158 | |
a3c87d4e JB |
159 | /* Arrange for all scroll bars on FRAME to be removed at the next call |
160 | to `*judge_scroll_bars_hook'. A scroll bar may be spared if | |
161 | `*redeem_scroll_bar_hook' is applied to its window before the judgement. | |
ec3f896c JB |
162 | |
163 | This should be applied to each frame each time its window tree is | |
a3c87d4e JB |
164 | redisplayed, even if it is not displaying scroll bars at the moment; |
165 | if the HAS_SCROLL_BARS flag has just been turned off, only calling | |
166 | this and the judge_scroll_bars_hook will get rid of them. | |
20a558dc | 167 | |
ec3f896c | 168 | If non-zero, this hook should be safe to apply to any frame, |
a3c87d4e | 169 | whether or not it can support scroll bars, and whether or not it is |
ec3f896c | 170 | currently displaying them. */ |
ec5d8db7 | 171 | extern void (*condemn_scroll_bars_hook) P_ ((struct frame *frame)); |
ec3f896c | 172 | |
a3c87d4e JB |
173 | /* Unmark WINDOW's scroll bar for deletion in this judgement cycle. |
174 | Note that it's okay to redeem a scroll bar that is not condemned. */ | |
ec5d8db7 | 175 | extern void (*redeem_scroll_bar_hook) P_ ((struct window *window)); |
20a558dc | 176 | |
a3c87d4e JB |
177 | /* Remove all scroll bars on FRAME that haven't been saved since the |
178 | last call to `*condemn_scroll_bars_hook'. | |
ec3f896c JB |
179 | |
180 | This should be applied to each frame after each time its window | |
a3c87d4e JB |
181 | tree is redisplayed, even if it is not displaying scroll bars at the |
182 | moment; if the HAS_SCROLL_BARS flag has just been turned off, only | |
183 | calling this and condemn_scroll_bars_hook will get rid of them. | |
20a558dc | 184 | |
ec3f896c | 185 | If non-zero, this hook should be safe to apply to any frame, |
a3c87d4e | 186 | whether or not it can support scroll bars, and whether or not it is |
ec3f896c | 187 | currently displaying them. */ |
ec5d8db7 | 188 | extern void (*judge_scroll_bars_hook) P_ ((struct frame *FRAME)); |
20a558dc | 189 | |
ec3f896c JB |
190 | \f |
191 | /* Input queue declarations and hooks. */ | |
20a558dc | 192 | |
80856e74 | 193 | /* Expedient hack: only provide the below definitions to files that |
026b8c1e | 194 | are prepared to handle lispy things. CONSP is defined iff lisp.h |
265a9e55 | 195 | has been included before this file. */ |
23c6349c | 196 | #ifdef CONSP |
80856e74 | 197 | |
351c638e RS |
198 | enum event_kind |
199 | { | |
200 | no_event, /* nothing happened. This should never | |
80856e74 | 201 | actually appear in the event queue. */ |
f05ddc05 JB |
202 | |
203 | ascii_keystroke, /* The ASCII code is in .code, perhaps | |
204 | with modifiers applied. | |
205 | .modifiers holds the state of the | |
206 | modifier keys. | |
ec3f896c JB |
207 | .frame_or_window is the frame in |
208 | which the key was typed. | |
265a9e55 JB |
209 | .timestamp gives a timestamp (in |
210 | milliseconds) for the keystroke. */ | |
351c638e | 211 | non_ascii_keystroke, /* .code is a number identifying the |
80856e74 JB |
212 | function key. A code N represents |
213 | a key whose name is | |
214 | function_key_names[N]; function_key_names | |
215 | is a table in keyboard.c to which you | |
216 | should feel free to add missing keys. | |
217 | .modifiers holds the state of the | |
62c07cc7 | 218 | modifier keys. |
ec3f896c JB |
219 | .frame_or_window is the frame in |
220 | which the key was typed. | |
265a9e55 JB |
221 | .timestamp gives a timestamp (in |
222 | milliseconds) for the keystroke. */ | |
b962d6c6 | 223 | timer_event, /* A timer fired. */ |
351c638e | 224 | mouse_click, /* The button number is in .code; it must |
a1867fb1 JB |
225 | be >= 0 and < NUM_MOUSE_BUTTONS, defined |
226 | below. | |
80856e74 JB |
227 | .modifiers holds the state of the |
228 | modifier keys. | |
229 | .x and .y give the mouse position, | |
1113d9db | 230 | in characters, within the window. |
ec3f896c JB |
231 | .frame_or_window gives the frame |
232 | the mouse click occurred in. | |
80856e74 JB |
233 | .timestamp gives a timestamp (in |
234 | milliseconds) for the click. */ | |
ab8f1008 GV |
235 | #ifdef WINDOWSNT |
236 | mouse_wheel, /* A mouse-wheel event is generated by a | |
237 | wheel on a mouse (e.g., MS Intellimouse). | |
238 | The event contains a delta that corresponds | |
239 | to the amount and direction that the wheel | |
240 | is rotated. This delta is typically | |
241 | used to implement a scroll or zoom. | |
242 | .code gives the delta. | |
243 | .modifiers holds the state of the | |
244 | modifier keys. | |
245 | .x and .y give the mouse position, | |
246 | in characters, within the window. | |
247 | .frame_or_window gives the frame | |
248 | the wheel event occurred in. | |
249 | .timestamp gives a timestamp (in | |
250 | milliseconds) for the wheel event. */ | |
251 | #endif | |
351c638e | 252 | scroll_bar_click, /* .code gives the number of the mouse button |
20a558dc JB |
253 | that was clicked. |
254 | .modifiers holds the state of the modifier | |
255 | keys. | |
80856e74 | 256 | .part is a lisp symbol indicating which |
a3c87d4e | 257 | part of the scroll bar got clicked. |
20a558dc JB |
258 | .x gives the distance from the start of the |
259 | scroll bar of the click; .y gives the total | |
260 | length of the scroll bar. | |
ec3f896c | 261 | .frame_or_window gives the window |
a3c87d4e | 262 | whose scroll bar was clicked in. |
80856e74 JB |
263 | .timestamp gives a timestamp (in |
264 | milliseconds) for the click. */ | |
33d5f42a | 265 | #ifdef WINDOWSNT |
fbd6baed | 266 | w32_scroll_bar_click, /* as for scroll_bar_click, but only generated |
33d5f42a RS |
267 | by MS-Windows scroll bar controls. */ |
268 | #endif | |
351c638e RS |
269 | selection_request_event, /* Another X client wants a selection from us. |
270 | See `struct selection_event'. */ | |
3a6b074b | 271 | selection_clear_event, /* Another X client cleared our selection. */ |
026b8c1e | 272 | buffer_switch_event, /* A process filter has switched buffers. */ |
765a05bc | 273 | delete_window_event, /* An X client said "delete this window". */ |
f2afbef6 | 274 | menu_bar_event, /* An event generated by the menu bar. |
b90afe71 | 275 | The frame_or_window field's cdr holds the |
765a05bc RS |
276 | Lisp-level event value. |
277 | (Only the toolkit version uses these.) */ | |
f2afbef6 | 278 | iconify_event, /* An X client iconified this window. */ |
c8b5ebed RS |
279 | deiconify_event, /* An X client deiconified this window. */ |
280 | menu_bar_activate_event /* A button press in the menu bar | |
281 | (toolkit version only). */ | |
351c638e RS |
282 | }; |
283 | ||
284 | /* If a struct input_event has a kind which is selection_request_event | |
285 | or selection_clear_event, then its contents are really described | |
286 | by `struct selection_event'; see xterm.h. */ | |
287 | ||
288 | /* The keyboard input buffer is an array of these structures. Each one | |
289 | represents some sort of input event - a keystroke, a mouse click, or | |
290 | a window system event. These get turned into their lispy forms when | |
291 | they are removed from the event queue. */ | |
292 | ||
f879067d RS |
293 | struct input_event |
294 | { | |
351c638e RS |
295 | |
296 | /* What kind of event was this? */ | |
f879067d | 297 | int kind; |
80856e74 | 298 | |
653dfe64 RS |
299 | /* For an ascii_keystroke, this is the character. |
300 | For a non_ascii_keystroke, this is the keysym code. | |
9257d374 | 301 | For a mouse event, this is the button number. */ |
ab8f1008 | 302 | /* In WindowsNT, for a mouse wheel event, this is the delta. */ |
653dfe64 | 303 | int code; |
a3c87d4e | 304 | enum scroll_bar_part part; |
ec3f896c | 305 | |
46cfcdb4 RS |
306 | int modifiers; /* See enum below for interpretation. */ |
307 | ||
308 | Lisp_Object x, y; | |
309 | unsigned long timestamp; | |
310 | ||
f879067d RS |
311 | /* This is padding just to put the frame_or_window field |
312 | past the size of struct selection_event. */ | |
313 | int *padding[2]; | |
314 | ||
ec3f896c JB |
315 | /* This field is copied into a vector while the event is in the queue, |
316 | so that garbage collections won't kill it. */ | |
b90afe71 KH |
317 | /* In a menu_bar_event, this is a cons cell whose car is the frame |
318 | and whose cdr is the Lisp object that is the event's value. */ | |
46cfcdb4 RS |
319 | /* This field is last so that struct selection_input_event |
320 | does not overlap with it. */ | |
ec3f896c | 321 | Lisp_Object frame_or_window; |
80856e74 | 322 | }; |
ec5d8db7 AS |
323 | |
324 | /* Called to read input events. */ | |
325 | extern int (*read_socket_hook) P_ ((int, struct input_event *, int, int)); | |
326 | ||
327 | /* Called when a frame's display becomes entirely up to date. */ | |
328 | extern void (*frame_up_to_date_hook) P_ ((struct frame *)); | |
351c638e | 329 | \f |
a1867fb1 JB |
330 | /* This is used in keyboard.c, to tell how many buttons we will need |
331 | to track the positions of. */ | |
332 | #define NUM_MOUSE_BUTTONS (5) | |
333 | ||
21cec071 JB |
334 | /* Bits in the modifiers member of the input_event structure. |
335 | Note that reorder_modifiers assumes that the bits are in canonical | |
a1867fb1 JB |
336 | order. |
337 | ||
338 | The modifiers applied to mouse clicks are rather ornate. The | |
339 | window-system-specific code should store mouse clicks with | |
45288343 JB |
340 | up_modifier or down_modifier set. Having an explicit down modifier |
341 | simplifies some of window-system-independent code; without it, the | |
342 | code would have to recognize down events by checking if the event | |
343 | is a mouse click lacking the click and drag modifiers. | |
344 | ||
345 | The window-system independent code turns all up_modifier events | |
fbcd35bd JB |
346 | bits into drag_modifier, click_modifier, double_modifier, or |
347 | triple_modifier events. The click_modifier has no written | |
348 | representation in the names of the symbols used as event heads, | |
349 | but it does appear in the Qevent_symbol_components property of the | |
350 | event heads. */ | |
80856e74 | 351 | enum { |
a1867fb1 JB |
352 | up_modifier = 1, /* Only used on mouse buttons - always |
353 | turned into a click or a drag modifier | |
354 | before lisp code sees the event. */ | |
d82222e1 JB |
355 | down_modifier = 2, /* Only used on mouse buttons. */ |
356 | drag_modifier = 4, /* This is never used in the event | |
a1867fb1 JB |
357 | queue; it's only used internally by |
358 | the window-system-independent code. */ | |
d82222e1 | 359 | click_modifier= 8, /* See drag_modifier. */ |
fbcd35bd JB |
360 | double_modifier= 16, /* See drag_modifier. */ |
361 | triple_modifier= 32, /* See drag_modifier. */ | |
d82222e1 JB |
362 | |
363 | /* The next four modifier bits are used also in keyboard events at | |
364 | the Lisp level. | |
365 | ||
366 | It's probably not the greatest idea to use the 2^23 bit for any | |
367 | modifier. It may or may not be the sign bit, depending on | |
368 | VALBITS, so using it to represent a modifier key means that | |
369 | characters thus modified have different integer equivalents | |
370 | depending on the architecture they're running on. Oh, and | |
371 | applying XINT to a character whose 2^23 bit is set sign-extends | |
372 | it, so you get a bunch of bits in the mask you didn't want. | |
373 | ||
374 | The CHAR_ macros are defined in lisp.h. */ | |
375 | alt_modifier = CHAR_ALT, /* Under X, the XK_Alt_[LR] keysyms. */ | |
376 | super_modifier= CHAR_SUPER, /* Under X, the XK_Super_[LR] keysyms. */ | |
377 | hyper_modifier= CHAR_HYPER, /* Under X, the XK_Hyper_[LR] keysyms. */ | |
378 | shift_modifier= CHAR_SHIFT, | |
379 | ctrl_modifier = CHAR_CTL, | |
6cd195e2 | 380 | meta_modifier = CHAR_META /* Under X, the XK_Meta_[LR] keysyms. */ |
80856e74 JB |
381 | }; |
382 | ||
80856e74 | 383 | #endif |