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