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