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