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