*** empty log message ***
[bpt/emacs.git] / src / termhooks.h
CommitLineData
6ed8eeff 1/* Parameters and display hooks for terminal devices.
0b5538bd 2 Copyright (C) 1985, 1986, 1993, 1994, 2002, 2003, 2004,
93afd0f1 3 2005, 2006, 2007 Free Software Foundation, Inc.
80856e74
JB
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
684d6f5b 9the Free Software Foundation; either version 3, or (at your option)
80856e74
JB
10any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs; see the file COPYING. If not, write to
4fc5845f
LK
19the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20Boston, MA 02110-1301, USA. */
80856e74 21
ec3f896c
JB
22\f
23/* Miscellanea. */
24
6820433e
GM
25struct glyph;
26struct frame;
27
ec5d8db7
AS
28/* Only use prototypes when lisp.h has been included. */
29#ifndef P_
30#define P_(X) ()
31#endif
ec3f896c 32\f
80856e74 33
a3c87d4e
JB
34enum scroll_bar_part {
35 scroll_bar_above_handle,
36 scroll_bar_handle,
33d5f42a
RS
37 scroll_bar_below_handle,
38 scroll_bar_up_arrow,
6820433e
GM
39 scroll_bar_down_arrow,
40 scroll_bar_to_top,
41 scroll_bar_to_bottom,
57207f1e
SM
42 scroll_bar_end_scroll,
43 scroll_bar_move_ratio
20a558dc
JB
44};
45
9416ae44
JD
46/* If the value of the frame parameter changed, whis hook is called.
47 For example, if going from fullscreen to not fullscreen this hook
48 may do something OS dependent, like extended window manager hints on X11. */
49extern void (*fullscreen_hook) P_ ((struct frame *f));
50
ec3f896c
JB
51\f
52/* Input queue declarations and hooks. */
20a558dc 53
80856e74 54/* Expedient hack: only provide the below definitions to files that
e0f24100 55 are prepared to handle lispy things. CONSP is defined if lisp.h
265a9e55 56 has been included before this file. */
23c6349c 57#ifdef CONSP
80856e74 58
351c638e
RS
59enum event_kind
60{
3b8f9651 61 NO_EVENT, /* nothing happened. This should never
80856e74 62 actually appear in the event queue. */
f05ddc05 63
3b8f9651 64 ASCII_KEYSTROKE_EVENT, /* The ASCII code is in .code, perhaps
f05ddc05
JB
65 with modifiers applied.
66 .modifiers holds the state of the
67 modifier keys.
ec3f896c
JB
68 .frame_or_window is the frame in
69 which the key was typed.
265a9e55
JB
70 .timestamp gives a timestamp (in
71 milliseconds) for the keystroke. */
3b8f9651 72 MULTIBYTE_CHAR_KEYSTROKE_EVENT, /* The multibyte char code is in .code,
4ff939ad
KH
73 perhaps with modifiers applied.
74 The others are the same as
7273faa1 75 ASCII_KEYSTROKE_EVENT. */
3b8f9651 76 NON_ASCII_KEYSTROKE_EVENT, /* .code is a number identifying the
80856e74
JB
77 function key. A code N represents
78 a key whose name is
79 function_key_names[N]; function_key_names
80 is a table in keyboard.c to which you
81 should feel free to add missing keys.
82 .modifiers holds the state of the
62c07cc7 83 modifier keys.
ec3f896c
JB
84 .frame_or_window is the frame in
85 which the key was typed.
265a9e55
JB
86 .timestamp gives a timestamp (in
87 milliseconds) for the keystroke. */
3b8f9651
PJ
88 TIMER_EVENT, /* A timer fired. */
89 MOUSE_CLICK_EVENT, /* The button number is in .code; it must
a1867fb1
JB
90 be >= 0 and < NUM_MOUSE_BUTTONS, defined
91 below.
80856e74
JB
92 .modifiers holds the state of the
93 modifier keys.
94 .x and .y give the mouse position,
1113d9db 95 in characters, within the window.
ec3f896c
JB
96 .frame_or_window gives the frame
97 the mouse click occurred in.
80856e74
JB
98 .timestamp gives a timestamp (in
99 milliseconds) for the click. */
3ecad19e
JR
100 WHEEL_EVENT, /* A wheel event is generated by a
101 wheel on a mouse (e.g., MS
102 Intellimouse).
103 .modifiers holds the rotate
104 direction (up or down), and the
105 state of the modifier keys.
106 .x and .y give the mouse position,
107 in characters, within the window.
108 .frame_or_window gives the frame
109 the wheel event occurred in.
110 .timestamp gives a timestamp (in
111 milliseconds) for the event. */
bce179b5
JR
112 HORIZ_WHEEL_EVENT, /* A wheel event generated by a second
113 horizontal wheel that is present on some
114 mice. See WHEEL_EVENT. */
9c5501d9
YM
115#if defined (WINDOWSNT) || defined (MAC_OS)
116 LANGUAGE_CHANGE_EVENT, /* A LANGUAGE_CHANGE_EVENT is
117 generated on WINDOWSNT or Mac OS
118 when the keyboard layout or input
119 language is changed by the
dba46b7c 120 user. */
ab8f1008 121#endif
3b8f9651 122 SCROLL_BAR_CLICK_EVENT, /* .code gives the number of the mouse button
20a558dc
JB
123 that was clicked.
124 .modifiers holds the state of the modifier
125 keys.
80856e74 126 .part is a lisp symbol indicating which
a3c87d4e 127 part of the scroll bar got clicked.
20a558dc
JB
128 .x gives the distance from the start of the
129 scroll bar of the click; .y gives the total
130 length of the scroll bar.
ec3f896c 131 .frame_or_window gives the window
a3c87d4e 132 whose scroll bar was clicked in.
80856e74
JB
133 .timestamp gives a timestamp (in
134 milliseconds) for the click. */
3b8f9651 135 SELECTION_REQUEST_EVENT, /* Another X client wants a selection from us.
0f8dad45 136 See `struct selection_input_event'. */
3b8f9651
PJ
137 SELECTION_CLEAR_EVENT, /* Another X client cleared our selection. */
138 BUFFER_SWITCH_EVENT, /* A process filter has switched buffers. */
139 DELETE_WINDOW_EVENT, /* An X client said "delete this window". */
4d92e48d 140 MENU_BAR_EVENT, /* An event generated by the menu bar.
b90afe71 141 The frame_or_window field's cdr holds the
765a05bc
RS
142 Lisp-level event value.
143 (Only the toolkit version uses these.) */
3b8f9651
PJ
144 ICONIFY_EVENT, /* An X client iconified this window. */
145 DEICONIFY_EVENT, /* An X client deiconified this window. */
146 MENU_BAR_ACTIVATE_EVENT, /* A button press in the menu bar
c8b5ebed 147 (toolkit version only). */
3b8f9651 148 DRAG_N_DROP_EVENT, /* A drag-n-drop event is generated when
523812cd
RS
149 files selected outside of Emacs are dropped
150 onto an Emacs window.
177c0ea7 151 .modifiers holds the state of the
523812cd
RS
152 modifier keys.
153 .x and .y give the mouse position,
154 in characters, within the window.
bf0f0659
YM
155 .frame_or_window is the frame in
156 which the drop was made.
157 .arg is a platform-dependent
158 representation of the dropped items.
523812cd
RS
159 .timestamp gives a timestamp (in
160 milliseconds) for the click. */
4d92e48d
GM
161 USER_SIGNAL_EVENT, /* A user signal.
162 code is a number identifying it,
6820433e
GM
163 index into lispy_user_signals. */
164
4d92e48d
GM
165 /* Help events. Member `frame_or_window' of the input_event is the
166 frame on which the event occurred, and member `arg' contains
167 the help to show. */
6820433e
GM
168 HELP_EVENT,
169
4d92e48d
GM
170 /* An event from a tool-bar. Member `arg' of the input event
171 contains the tool-bar item selected. If `frame_or_window'
172 and `arg' are equal, this is a prefix event. */
0f98c4c2
GM
173 TOOL_BAR_EVENT,
174
175 /* Queued from XTread_socket on FocusIn events. Translated into
176 `switch-frame' events in kbd_buffer_get_event, if necessary. */
408b2bfb
JD
177 FOCUS_IN_EVENT,
178
827b15c6
PJ
179 /* Generated when mouse moves over window not currently selected. */
180 SELECT_WINDOW_EVENT,
181
408b2bfb
JD
182 /* Queued from XTread_socket when session manager sends
183 save yourself before shutdown. */
fba2cc7f 184 SAVE_SESSION_EVENT
0f8dad45
YM
185
186#ifdef MAC_OS
187 /* Generated when an Apple event, a HICommand event, or a Services
188 menu event is received and the corresponding handler is
189 registered. Members `x' and `y' are for the event class and ID
8b6361c1
YM
190 symbols, respectively. Member `arg' is a Lisp object converted
191 from the received Apple event. Parameters for non-Apple events
192 are converted to those in Apple events. */
fba2cc7f 193 , MAC_APPLE_EVENT
d036ccf4
NR
194#endif
195
7e5a23bd 196#ifdef HAVE_GPM
1af74d06 197 , GPM_CLICK_EVENT
b2b25916
JR
198#endif
199
200#ifdef WINDOWSNT
201 /* Generated when an APPCOMMAND event is received, in response to
202 Multimedia or Internet buttons on some keyboards.
203 Such keys are available as normal function keys on X through the
204 Xkeyboard extension.
205 On Windows, some of them get mapped to normal function key events,
206 but others need to be handled by APPCOMMAND. Handling them all as
207 APPCOMMAND events means they can be disabled
208 (w32-pass-multimedia-buttons-to-system), important on Windows since
209 the system never sees these keys if Emacs claims to handle them.
210 On X, the window manager seems to grab the keys it wants
211 first, so this is not a problem there. */
212 , MULTIMEDIA_KEY_EVENT
0f8dad45 213#endif
351c638e
RS
214};
215
3b8f9651
PJ
216/* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
217 or SELECTION_CLEAR_EVENT, then its contents are really described
0f8dad45 218 by `struct selection_input_event'; see xterm.h. */
351c638e
RS
219
220/* The keyboard input buffer is an array of these structures. Each one
221 represents some sort of input event - a keystroke, a mouse click, or
222 a window system event. These get turned into their lispy forms when
223 they are removed from the event queue. */
224
f879067d
RS
225struct input_event
226{
351c638e 227 /* What kind of event was this? */
a9dff54b 228 enum event_kind kind;
177c0ea7 229
3b8f9651
PJ
230 /* For an ASCII_KEYSTROKE_EVENT and MULTIBYTE_CHAR_KEYSTROKE_EVENT,
231 this is the character.
232 For a NON_ASCII_KEYSTROKE_EVENT, this is the keysym code.
9257d374 233 For a mouse event, this is the button number. */
ab8f1008 234 /* In WindowsNT, for a mouse wheel event, this is the delta. */
653dfe64 235 int code;
a3c87d4e 236 enum scroll_bar_part part;
ec3f896c 237
46cfcdb4
RS
238 int modifiers; /* See enum below for interpretation. */
239
240 Lisp_Object x, y;
241 unsigned long timestamp;
242
f879067d 243 /* This is padding just to put the frame_or_window field
0f8dad45 244 past the size of struct selection_input_event. */
f879067d
RS
245 int *padding[2];
246
ec3f896c
JB
247 /* This field is copied into a vector while the event is in the queue,
248 so that garbage collections won't kill it. */
b90afe71
KH
249 /* In a menu_bar_event, this is a cons cell whose car is the frame
250 and whose cdr is the Lisp object that is the event's value. */
46cfcdb4
RS
251 /* This field is last so that struct selection_input_event
252 does not overlap with it. */
ec3f896c 253 Lisp_Object frame_or_window;
4d92e48d
GM
254
255 /* Additional event argument. This is used for TOOL_BAR_EVENTs and
256 HELP_EVENTs and avoids calling Fcons during signal handling. */
257 Lisp_Object arg;
80856e74 258};
ec5d8db7 259
5400da8f
SM
260#define EVENT_INIT(event) bzero (&(event), sizeof (struct input_event))
261
21cec071
JB
262/* Bits in the modifiers member of the input_event structure.
263 Note that reorder_modifiers assumes that the bits are in canonical
177c0ea7 264 order.
a1867fb1
JB
265
266 The modifiers applied to mouse clicks are rather ornate. The
267 window-system-specific code should store mouse clicks with
45288343
JB
268 up_modifier or down_modifier set. Having an explicit down modifier
269 simplifies some of window-system-independent code; without it, the
270 code would have to recognize down events by checking if the event
271 is a mouse click lacking the click and drag modifiers.
272
273 The window-system independent code turns all up_modifier events
fbcd35bd
JB
274 bits into drag_modifier, click_modifier, double_modifier, or
275 triple_modifier events. The click_modifier has no written
276 representation in the names of the symbols used as event heads,
277 but it does appear in the Qevent_symbol_components property of the
278 event heads. */
80856e74 279enum {
a1867fb1
JB
280 up_modifier = 1, /* Only used on mouse buttons - always
281 turned into a click or a drag modifier
282 before lisp code sees the event. */
d82222e1
JB
283 down_modifier = 2, /* Only used on mouse buttons. */
284 drag_modifier = 4, /* This is never used in the event
a1867fb1
JB
285 queue; it's only used internally by
286 the window-system-independent code. */
d82222e1 287 click_modifier= 8, /* See drag_modifier. */
fbcd35bd
JB
288 double_modifier= 16, /* See drag_modifier. */
289 triple_modifier= 32, /* See drag_modifier. */
d82222e1
JB
290
291 /* The next four modifier bits are used also in keyboard events at
292 the Lisp level.
293
294 It's probably not the greatest idea to use the 2^23 bit for any
295 modifier. It may or may not be the sign bit, depending on
296 VALBITS, so using it to represent a modifier key means that
297 characters thus modified have different integer equivalents
298 depending on the architecture they're running on. Oh, and
299 applying XINT to a character whose 2^23 bit is set sign-extends
300 it, so you get a bunch of bits in the mask you didn't want.
301
302 The CHAR_ macros are defined in lisp.h. */
303 alt_modifier = CHAR_ALT, /* Under X, the XK_Alt_[LR] keysyms. */
304 super_modifier= CHAR_SUPER, /* Under X, the XK_Super_[LR] keysyms. */
305 hyper_modifier= CHAR_HYPER, /* Under X, the XK_Hyper_[LR] keysyms. */
306 shift_modifier= CHAR_SHIFT,
307 ctrl_modifier = CHAR_CTL,
6cd195e2 308 meta_modifier = CHAR_META /* Under X, the XK_Meta_[LR] keysyms. */
80856e74
JB
309};
310
7e5a23bd 311#ifdef HAVE_GPM
d036ccf4 312#include <gpm.h>
7be1c21a 313extern int handle_one_term_event (struct tty_display_info *, Gpm_Event *, struct input_event *);
b2d1ffb1 314extern void term_mouse_moveto (int, int);
d036ccf4 315
71f44e7a
SM
316/* The device for which we have enabled gpm support. */
317extern struct tty_display_info *gpm_tty;
7be1c21a
MB
318#endif
319
daf01701 320#endif /* CONSP */
ab5796a9 321
428a555e 322\f
80ca7302
DN
323struct mac_display_info;
324struct w32_display_info;
325
6ed8eeff
KL
326/* Terminal-local parameters. */
327struct terminal
428a555e 328{
597cc809
SM
329 /* The first two fields are really the header of a vector */
330 /* The terminal code does not refer to them. */
d0fdb6da 331 EMACS_UINT size;
597cc809
SM
332 struct Lisp_Vector *vec_next;
333
ff16b875
SM
334 /* Parameter alist of this terminal. */
335 Lisp_Object param_alist;
336
337 /* All fields before `next_terminal' should be Lisp_Object and are traced
338 by the GC. All fields afterwards are ignored by the GC. */
339
6ed8eeff
KL
340 /* Chain of all terminal devices. */
341 struct terminal *next_terminal;
428a555e 342
6ed8eeff 343 /* Unique id for this terminal device. */
b6660415
KL
344 int id;
345
6ed8eeff 346 /* The number of frames that are on this terminal. */
428a555e 347 int reference_count;
a98f1617 348
6ed8eeff 349 /* The type of the terminal device. */
428a555e
KL
350 enum output_method type;
351
ab797f65
KL
352 /* The name of the terminal device. Do not use this to uniquely
353 identify a terminal; the same device may be opened multiple
354 times. */
b6660415
KL
355 char *name;
356
bedb9c0e 357#ifdef MULTI_KBOARD
6ed8eeff 358 /* The terminal's keyboard object. */
bedb9c0e
KL
359 struct kboard *kboard;
360#endif
361
6ed8eeff 362 /* Device-type dependent data shared amongst all frames on this terminal. */
428a555e
KL
363 union display_info
364 {
365 struct tty_display_info *tty; /* termchar.h */
366 struct x_display_info *x; /* xterm.h */
936ad3d6 367 struct w32_display_info *w32; /* w32term.h */
80ca7302 368 struct mac_display_info *mac; /* macterm.h */
428a555e
KL
369 } display_info;
370
371\f
b8299c66
KL
372 /* Coding-system to be used for encoding terminal output. This
373 structure contains information of a coding-system specified by
374 the function `set-terminal-coding-system'. Also see
375 `safe_terminal_coding' in coding.h. */
376 struct coding_system *terminal_coding;
377
378 /* Coding-system of what is sent from terminal keyboard. This
379 structure contains information of a coding-system specified by
380 the function `set-keyboard-coding-system'. */
381 struct coding_system *keyboard_coding;
382
428a555e
KL
383 /* Terminal characteristics. */
384 /* XXX Are these really used on non-termcap displays? */
385
386 int must_write_spaces; /* Nonzero means spaces in the text must
387 actually be output; can't just skip over
388 some columns to leave them blank. */
389 int fast_clear_end_of_line; /* Nonzero means terminal has a `ce' string */
390
391 int line_ins_del_ok; /* Terminal can insert and delete lines */
392 int char_ins_del_ok; /* Terminal can insert and delete chars */
393 int scroll_region_ok; /* Terminal supports setting the scroll
394 window */
395 int scroll_region_cost; /* Cost of setting the scroll window,
396 measured in characters. */
397 int memory_below_frame; /* Terminal remembers lines scrolled
398 off bottom */
399
400#if 0 /* These are not used anywhere. */
401 /* EMACS_INT baud_rate; */ /* Output speed in baud */
402 int min_padding_speed; /* Speed below which no padding necessary. */
403 int dont_calculate_costs; /* Nonzero means don't bother computing
404 various cost tables; we won't use them. */
405#endif
406
407\f
408 /* Window-based redisplay interface for this device (0 for tty
409 devices). */
410 struct redisplay_interface *rif;
411
412 /* Frame-based redisplay interface. */
413
414 /* Text display hooks. */
415
385ed61f
KL
416 void (*cursor_to_hook) P_ ((struct frame *f, int vpos, int hpos));
417 void (*raw_cursor_to_hook) P_ ((struct frame *, int, int));
428a555e 418
385ed61f
KL
419 void (*clear_to_end_hook) P_ ((struct frame *));
420 void (*clear_frame_hook) P_ ((struct frame *));
421 void (*clear_end_of_line_hook) P_ ((struct frame *, int));
428a555e 422
385ed61f 423 void (*ins_del_lines_hook) P_ ((struct frame *f, int, int));
428a555e 424
385ed61f
KL
425 void (*insert_glyphs_hook) P_ ((struct frame *f, struct glyph *s, int n));
426 void (*write_glyphs_hook) P_ ((struct frame *f, struct glyph *s, int n));
427 void (*delete_glyphs_hook) P_ ((struct frame *, int));
428a555e 428
385ed61f 429 void (*ring_bell_hook) P_ ((struct frame *f));
428a555e 430
6ed8eeff
KL
431 void (*reset_terminal_modes_hook) P_ ((struct terminal *));
432 void (*set_terminal_modes_hook) P_ ((struct terminal *));
385ed61f 433
428a555e
KL
434 void (*update_begin_hook) P_ ((struct frame *));
435 void (*update_end_hook) P_ ((struct frame *));
385ed61f 436 void (*set_terminal_window_hook) P_ ((struct frame *, int));
428a555e
KL
437
438 /* Multi-frame and mouse support hooks. */
439
440 /* Return the current position of the mouse.
441
442 Set *f to the frame the mouse is in, or zero if the mouse is in no
443 Emacs frame. If it is set to zero, all the other arguments are
444 garbage.
445
446 If the motion started in a scroll bar, set *bar_window to the
447 scroll bar's window, *part to the part the mouse is currently over,
448 *x to the position of the mouse along the scroll bar, and *y to the
449 overall length of the scroll bar.
450
451 Otherwise, set *bar_window to Qnil, and *x and *y to the column and
452 row of the character cell the mouse is over.
453
454 Set *time to the time the mouse was at the returned position.
455
456 This should clear mouse_moved until the next motion
457 event arrives. */
458 void (*mouse_position_hook) P_ ((struct frame **f, int,
459 Lisp_Object *bar_window,
460 enum scroll_bar_part *part,
461 Lisp_Object *x,
462 Lisp_Object *y,
463 unsigned long *time));
464
465 /* The window system handling code should set this if the mouse has
466 moved since the last call to the mouse_position_hook. Calling that
467 hook should clear this. */
468 int mouse_moved;
469
470 /* When a frame's focus redirection is changed, this hook tells the
471 window system code to re-decide where to put the highlight. Under
472 X, this means that Emacs lies about where the focus is. */
473 void (*frame_rehighlight_hook) P_ ((struct frame *));
474
475 /* If we're displaying frames using a window system that can stack
476 frames on top of each other, this hook allows you to bring a frame
477 to the front, or bury it behind all the other windows. If this
6ed8eeff 478 hook is zero, that means the terminal we're displaying on doesn't
428a555e
KL
479 support overlapping frames, so there's no need to raise or lower
480 anything.
481
482 If RAISE is non-zero, F is brought to the front, before all other
483 windows. If RAISE is zero, F is sent to the back, behind all other
484 windows. */
485 void (*frame_raise_lower_hook) P_ ((struct frame *f, int raise));
486
974b73e8
KL
487 /* If the value of the frame parameter changed, whis hook is called.
488 For example, if going from fullscreen to not fullscreen this hook
489 may do something OS dependent, like extended window manager hints on X11. */
490 void (*fullscreen_hook) P_ ((struct frame *f));
491
428a555e
KL
492 \f
493 /* Scroll bar hooks. */
494
495 /* The representation of scroll bars is determined by the code which
496 implements them, except for one thing: they must be represented by
497 lisp objects. This allows us to place references to them in
498 Lisp_Windows without worrying about those references becoming
499 dangling references when the scroll bar is destroyed.
500
501 The window-system-independent portion of Emacs just refers to
502 scroll bars via their windows, and never looks inside the scroll bar
503 representation; it always uses hook functions to do all the
504 scroll bar manipulation it needs.
505
506 The `vertical_scroll_bar' field of a Lisp_Window refers to that
507 window's scroll bar, or is nil if the window doesn't have a
508 scroll bar.
509
510 The `scroll_bars' and `condemned_scroll_bars' fields of a Lisp_Frame
511 are free for use by the scroll bar implementation in any way it sees
512 fit. They are marked by the garbage collector. */
513
514
515 /* Set the vertical scroll bar for WINDOW to have its upper left corner
516 at (TOP, LEFT), and be LENGTH rows high. Set its handle to
517 indicate that we are displaying PORTION characters out of a total
518 of WHOLE characters, starting at POSITION. If WINDOW doesn't yet
519 have a scroll bar, create one for it. */
520 void (*set_vertical_scroll_bar_hook) P_ ((struct window *window,
521 int portion, int whole,
522 int position));
523
524
525 /* The following three hooks are used when we're doing a thorough
526 redisplay of the frame. We don't explicitly know which scroll bars
527 are going to be deleted, because keeping track of when windows go
528 away is a real pain - can you say set-window-configuration?
529 Instead, we just assert at the beginning of redisplay that *all*
530 scroll bars are to be removed, and then save scroll bars from the
531 fiery pit when we actually redisplay their window. */
532
533 /* Arrange for all scroll bars on FRAME to be removed at the next call
534 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
535 `*redeem_scroll_bar_hook' is applied to its window before the judgement.
536
537 This should be applied to each frame each time its window tree is
538 redisplayed, even if it is not displaying scroll bars at the moment;
539 if the HAS_SCROLL_BARS flag has just been turned off, only calling
540 this and the judge_scroll_bars_hook will get rid of them.
541
542 If non-zero, this hook should be safe to apply to any frame,
543 whether or not it can support scroll bars, and whether or not it is
544 currently displaying them. */
545 void (*condemn_scroll_bars_hook) P_ ((struct frame *frame));
546
547 /* Unmark WINDOW's scroll bar for deletion in this judgement cycle.
548 Note that it's okay to redeem a scroll bar that is not condemned. */
549 void (*redeem_scroll_bar_hook) P_ ((struct window *window));
550
551 /* Remove all scroll bars on FRAME that haven't been saved since the
552 last call to `*condemn_scroll_bars_hook'.
553
554 This should be applied to each frame after each time its window
555 tree is redisplayed, even if it is not displaying scroll bars at the
556 moment; if the HAS_SCROLL_BARS flag has just been turned off, only
557 calling this and condemn_scroll_bars_hook will get rid of them.
558
559 If non-zero, this hook should be safe to apply to any frame,
560 whether or not it can support scroll bars, and whether or not it is
561 currently displaying them. */
562 void (*judge_scroll_bars_hook) P_ ((struct frame *FRAME));
563
564\f
d448e982
KL
565 /* Called to read input events.
566
6ed8eeff
KL
567 TERMINAL indicates which terminal device to read from. Input
568 events should be read into BUF, the size of which is given in
569 SIZE. EXPECTED is non-zero if the caller suspects that new input
570 is available.
d448e982
KL
571
572 A positive return value indicates that that many input events
573 where read into BUF.
574 Zero means no events were immediately available.
575 A value of -1 means a transient read error, while -2 indicates
7e59217d 576 that the device was closed (hangup), and it should be deleted.
d448e982
KL
577
578 XXX Please note that a non-zero value of EXPECTED only means that
579 there is available input on at least one of the currently opened
6ed8eeff 580 terminal devices -- but not necessarily on this device.
d448e982 581 Therefore, in most cases EXPECTED should be simply ignored.
057a9ab4
KL
582
583 XXX This documentation needs to be updated. */
6ed8eeff 584 int (*read_socket_hook) P_ ((struct terminal *terminal,
057a9ab4
KL
585 int expected,
586 struct input_event *hold_quit));
428a555e
KL
587
588 /* Called when a frame's display becomes entirely up to date. */
589 void (*frame_up_to_date_hook) P_ ((struct frame *));
590
591\f
592 /* Called to delete the device-specific portions of a frame that is
6ed8eeff 593 on this terminal device. */
428a555e
KL
594 void (*delete_frame_hook) P_ ((struct frame *));
595
6ed8eeff 596 /* Called after the last frame on this terminal is deleted, or when
d448e982
KL
597 the display device was closed (hangup).
598
6ed8eeff
KL
599 If this is NULL, then the generic delete_terminal is called
600 instead. Otherwise the hook must call delete_terminal itself.
428a555e 601
d448e982 602 The hook must check for and close any live frames that are still
6ed8eeff
KL
603 on the terminal. Fdelete_frame ensures that there are no live
604 frames on the terminal when it calls this hook, so infinite
d448e982 605 recursion is prevented. */
6ed8eeff 606 void (*delete_terminal_hook) P_ ((struct terminal *));
428a555e
KL
607};
608
609
6ed8eeff
KL
610/* Chain of all terminal devices currently in use. */
611extern struct terminal *terminal_list;
428a555e 612
6ed8eeff
KL
613#define FRAME_MUST_WRITE_SPACES(f) ((f)->terminal->must_write_spaces)
614#define FRAME_FAST_CLEAR_END_OF_LINE(f) ((f)->terminal->fast_clear_end_of_line)
615#define FRAME_LINE_INS_DEL_OK(f) ((f)->terminal->line_ins_del_ok)
616#define FRAME_CHAR_INS_DEL_OK(f) ((f)->terminal->char_ins_del_ok)
617#define FRAME_SCROLL_REGION_OK(f) ((f)->terminal->scroll_region_ok)
618#define FRAME_SCROLL_REGION_COST(f) ((f)->terminal->scroll_region_cost)
619#define FRAME_MEMORY_BELOW_FRAME(f) ((f)->terminal->memory_below_frame)
428a555e 620
6ed8eeff
KL
621#define FRAME_TERMINAL_CODING(f) ((f)->terminal->terminal_coding)
622#define FRAME_KEYBOARD_CODING(f) ((f)->terminal->keyboard_coding)
b8299c66 623
6ed8eeff
KL
624#define TERMINAL_TERMINAL_CODING(d) ((d)->terminal_coding)
625#define TERMINAL_KEYBOARD_CODING(d) ((d)->keyboard_coding)
68bba4e4 626
6ed8eeff 627#define FRAME_RIF(f) ((f)->terminal->rif)
428a555e 628
6ed8eeff 629#define FRAME_TERMINAL(f) ((f)->terminal)
428a555e
KL
630
631/* FRAME_WINDOW_P tests whether the frame is a window, and is
632 defined to be the predicate for the window system being used. */
633
634#ifdef HAVE_X_WINDOWS
635#define FRAME_WINDOW_P(f) FRAME_X_P (f)
636#endif
637#ifdef HAVE_NTGUI
638#define FRAME_WINDOW_P(f) FRAME_W32_P (f)
639#endif
640#ifdef MAC_OS
641#define FRAME_WINDOW_P(f) FRAME_MAC_P (f)
642#endif
643#ifndef FRAME_WINDOW_P
644#define FRAME_WINDOW_P(f) (0)
645#endif
646
6ed8eeff
KL
647/* Return true if the terminal device is not suspended. */
648#define TERMINAL_ACTIVE_P(d) ((d)->type != output_termcap || (d)->display_info.tty->input)
b6660415 649
6ed8eeff
KL
650extern Lisp_Object get_terminal_param P_ ((struct terminal *, Lisp_Object));
651extern struct terminal *get_terminal P_ ((Lisp_Object terminal, int));
652extern struct terminal *create_terminal P_ ((void));
653extern void delete_terminal P_ ((struct terminal *));
428a555e 654
6ed8eeff
KL
655/* The initial terminal device, created by initial_term_init. */
656extern struct terminal *initial_terminal;
114a8b8c 657
ab5796a9
MB
658/* arch-tag: 33a00ecc-52b5-4186-a410-8801ac9f087d
659 (do not change this comment) */