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