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