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