termhooks.h 24.3 KB
Newer Older
1
/* Parameters and display hooks for terminal devices.
2

3 4
Copyright (C) 1985-1986, 1993-1994, 2001-2013 Free Software Foundation,
Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

21 22 23
#ifndef EMACS_TERMHOOKS_H
#define EMACS_TERMHOOKS_H

24 25
/* Miscellanea.   */

26 27
#include "systime.h" /* for Time */

Paul Eggert's avatar
Paul Eggert committed
28
INLINE_HEADER_BEGIN
Jim Blandy's avatar
Jim Blandy committed
29

30
enum scroll_bar_part {
31
  scroll_bar_nowhere = -1,
32 33
  scroll_bar_above_handle,
  scroll_bar_handle,
34 35
  scroll_bar_below_handle,
  scroll_bar_up_arrow,
Gerd Moellmann's avatar
Gerd Moellmann committed
36 37 38
  scroll_bar_down_arrow,
  scroll_bar_to_top,
  scroll_bar_to_bottom,
39 40
  scroll_bar_end_scroll,
  scroll_bar_move_ratio
41 42
};

43 44 45 46 47 48 49 50 51 52 53 54
/* Output method of a terminal (and frames on this terminal, respectively).  */

enum output_method
{
  output_initial,
  output_termcap,
  output_x_window,
  output_msdos_raw,
  output_w32,
  output_ns
};

55
/* Input queue declarations and hooks.  */
56

57 58
enum event_kind
{
Pavel Janík's avatar
Pavel Janík committed
59
  NO_EVENT,			/* nothing happened.  This should never
Jim Blandy's avatar
Jim Blandy committed
60
				   actually appear in the event queue.  */
Jim Blandy's avatar
Jim Blandy committed
61

Pavel Janík's avatar
Pavel Janík committed
62
  ASCII_KEYSTROKE_EVENT,	/* The ASCII code is in .code, perhaps
Jim Blandy's avatar
Jim Blandy committed
63 64 65
				   with modifiers applied.
				   .modifiers holds the state of the
				   modifier keys.
66 67
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
68 69
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
Pavel Janík's avatar
Pavel Janík committed
70
  MULTIBYTE_CHAR_KEYSTROKE_EVENT,	/* The multibyte char code is in .code,
71 72
				   perhaps with modifiers applied.
				   The others are the same as
Dave Love's avatar
Dave Love committed
73
				   ASCII_KEYSTROKE_EVENT.  */
Pavel Janík's avatar
Pavel Janík committed
74
  NON_ASCII_KEYSTROKE_EVENT,	/* .code is a number identifying the
Jim Blandy's avatar
Jim Blandy committed
75 76 77 78 79 80
				   function key.  A code N represents
				   a key whose name is
				   function_key_names[N]; function_key_names
				   is a table in keyboard.c to which you
				   should feel free to add missing keys.
				   .modifiers holds the state of the
Jim Blandy's avatar
Jim Blandy committed
81
				   modifier keys.
82 83
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
84 85
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
Pavel Janík's avatar
Pavel Janík committed
86 87
  TIMER_EVENT,                  /* A timer fired.  */
  MOUSE_CLICK_EVENT,		/* The button number is in .code; it must
88 89
				   be >= 0 and < NUM_MOUSE_BUTTONS, defined
				   below.
Jim Blandy's avatar
Jim Blandy committed
90 91 92
				   .modifiers holds the state of the
				   modifier keys.
				   .x and .y give the mouse position,
Jim Blandy's avatar
Jim Blandy committed
93
				   in characters, within the window.
94 95
				   .frame_or_window gives the frame
				   the mouse click occurred in.
Jim Blandy's avatar
Jim Blandy committed
96 97
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
98 99 100 101 102 103 104 105 106 107 108 109
  WHEEL_EVENT,			/* A wheel event is generated by a
				   wheel on a mouse (e.g., MS
				   Intellimouse).
				   .modifiers holds the rotate
				   direction (up or down), and the
				   state of the modifier keys.
				   .x and .y give the mouse position,
				   in characters, within the window.
				   .frame_or_window gives the frame
				   the wheel event occurred in.
				   .timestamp gives a timestamp (in
				   milliseconds) for the event.  */
110 111 112
  HORIZ_WHEEL_EVENT,            /* A wheel event generated by a second
                                   horizontal wheel that is present on some
                                   mice. See WHEEL_EVENT.  */
113
#ifdef HAVE_NTGUI
114
  LANGUAGE_CHANGE_EVENT,	/* A LANGUAGE_CHANGE_EVENT is
Daniel Colascione's avatar
Daniel Colascione committed
115
				   generated when HAVE_NTGUI or on Mac OS
116 117
				   when the keyboard layout or input
				   language is changed by the
118
				   user.  */
119
#endif
Pavel Janík's avatar
Pavel Janík committed
120
  SCROLL_BAR_CLICK_EVENT,	/* .code gives the number of the mouse button
121 122 123
				   that was clicked.
				   .modifiers holds the state of the modifier
				   keys.
Jim Blandy's avatar
Jim Blandy committed
124
				   .part is a lisp symbol indicating which
125
				   part of the scroll bar got clicked.
126 127 128
				   .x gives the distance from the start of the
				   scroll bar of the click; .y gives the total
				   length of the scroll bar.
129
				   .frame_or_window gives the window
130
				   whose scroll bar was clicked in.
Jim Blandy's avatar
Jim Blandy committed
131 132
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
Pavel Janík's avatar
Pavel Janík committed
133
  SELECTION_REQUEST_EVENT,	/* Another X client wants a selection from us.
134
				   See `struct selection_input_event'.  */
Pavel Janík's avatar
Pavel Janík committed
135 136 137
  SELECTION_CLEAR_EVENT,	/* Another X client cleared our selection.  */
  BUFFER_SWITCH_EVENT,		/* A process filter has switched buffers.  */
  DELETE_WINDOW_EVENT,		/* An X client said "delete this window".  */
138
  MENU_BAR_EVENT,		/* An event generated by the menu bar.
139
				   The frame_or_window field's cdr holds the
140 141
				   Lisp-level event value.
				   (Only the toolkit version uses these.)  */
Pavel Janík's avatar
Pavel Janík committed
142 143 144
  ICONIFY_EVENT,		/* An X client iconified this window.  */
  DEICONIFY_EVENT,		/* An X client deiconified this window.  */
  MENU_BAR_ACTIVATE_EVENT,      /* A button press in the menu bar
145
				   (toolkit version only).  */
Pavel Janík's avatar
Pavel Janík committed
146
  DRAG_N_DROP_EVENT,		/* A drag-n-drop event is generated when
147 148
				   files selected outside of Emacs are dropped
				   onto an Emacs window.
149
				   .modifiers holds the state of the
150 151 152
				   modifier keys.
				   .x and .y give the mouse position,
				   in characters, within the window.
153 154 155 156
				   .frame_or_window is the frame in
				   which the drop was made.
				   .arg is a platform-dependent
				   representation of the dropped items.
157 158
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
159 160
  USER_SIGNAL_EVENT,		/* A user signal.
                                   code is a number identifying it,
Gerd Moellmann's avatar
Gerd Moellmann committed
161 162
                                   index into lispy_user_signals.  */

163 164 165
  /* Help events.  Member `frame_or_window' of the input_event is the
     frame on which the event occurred, and member `arg' contains
     the help to show.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
166 167
  HELP_EVENT,

168 169 170
  /* An event from a tool-bar.  Member `arg' of the input event
     contains the tool-bar item selected.  If `frame_or_window'
     and `arg' are equal, this is a prefix event.  */
171 172 173 174
  TOOL_BAR_EVENT,

  /* Queued from XTread_socket on FocusIn events.  Translated into
     `switch-frame' events in kbd_buffer_get_event, if necessary.  */
175 176
  FOCUS_IN_EVENT,

177 178
  FOCUS_OUT_EVENT,

179 180 181
  /* Generated when mouse moves over window not currently selected.  */
  SELECT_WINDOW_EVENT,

182 183
  /* Queued from XTread_socket when session manager sends
     save yourself before shutdown. */
184
  SAVE_SESSION_EVENT
185

186
#ifdef HAVE_GPM
Miles Bader's avatar
Miles Bader committed
187
  , GPM_CLICK_EVENT
188 189
#endif

190 191 192 193
#ifdef HAVE_DBUS
  , DBUS_EVENT
#endif

194 195
  , CONFIG_CHANGED_EVENT

Daniel Colascione's avatar
Daniel Colascione committed
196
#ifdef HAVE_NTGUI
197 198 199 200 201 202 203 204 205 206 207 208
  /* Generated when an APPCOMMAND event is received, in response to
     Multimedia or Internet buttons on some keyboards.
     Such keys are available as normal function keys on X through the
     Xkeyboard extension.
     On Windows, some of them get mapped to normal function key events,
     but others need to be handled by APPCOMMAND. Handling them all as
     APPCOMMAND events means they can be disabled
     (w32-pass-multimedia-buttons-to-system), important on Windows since
     the system never sees these keys if Emacs claims to handle them.
     On X, the window manager seems to grab the keys it wants
     first, so this is not a problem there.  */
  , MULTIMEDIA_KEY_EVENT
209
#endif
210 211 212 213 214

#ifdef HAVE_NS
  /* Generated when native multi-keystroke input method is used to modify
     tentative or indicative text display. */
  , NS_TEXT_EVENT
215 216
  /* Non-key system events (e.g. application menu events) */
  , NS_NONKEY_EVENT
217 218
#endif

219
#ifdef USE_FILE_NOTIFY
220 221 222 223
  /* File or directory was changed.  */
  , FILE_NOTIFY_EVENT
#endif

224 225
};

Pavel Janík's avatar
Pavel Janík committed
226 227
/* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
   or SELECTION_CLEAR_EVENT, then its contents are really described
228
   by `struct selection_input_event'; see xterm.h.  */
229 230 231 232 233 234

/* The keyboard input buffer is an array of these structures.  Each one
   represents some sort of input event - a keystroke, a mouse click, or
   a window system event.  These get turned into their lispy forms when
   they are removed from the event queue.  */

235 236
struct input_event
{
237
  /* What kind of event was this?  */
238
  enum event_kind kind;
239

Pavel Janík's avatar
Pavel Janík committed
240 241 242
  /* For an ASCII_KEYSTROKE_EVENT and MULTIBYTE_CHAR_KEYSTROKE_EVENT,
     this is the character.
     For a NON_ASCII_KEYSTROKE_EVENT, this is the keysym code.
243 244 245
     For a mouse event, this is the button number.
     For a HELP_EVENT, this is the position within the object
      (stored in ARG below) where the help was found.  */
246
  ptrdiff_t code;
247
  enum scroll_bar_part part;
248

249 250 251
  int modifiers;		/* See enum below for interpretation.  */

  Lisp_Object x, y;
252
  Time timestamp;
253

254 255
  /* This field is copied into a vector while the event is in
     the queue, so that garbage collections won't kill it.  */
256
  Lisp_Object frame_or_window;
257 258 259 260

  /* Additional event argument.  This is used for TOOL_BAR_EVENTs and
     HELP_EVENTs and avoids calling Fcons during signal handling.  */
  Lisp_Object arg;
Jim Blandy's avatar
Jim Blandy committed
261
};
Andreas Schwab's avatar
Andreas Schwab committed
262

263
#define EVENT_INIT(event) memset (&(event), 0, sizeof (struct input_event))
Stefan Monnier's avatar
Stefan Monnier committed
264

265 266
/* Bits in the modifiers member of the input_event structure.
   Note that reorder_modifiers assumes that the bits are in canonical
267
   order.
268 269 270

   The modifiers applied to mouse clicks are rather ornate.  The
   window-system-specific code should store mouse clicks with
Jim Blandy's avatar
Jim Blandy committed
271 272 273 274 275 276
   up_modifier or down_modifier set.  Having an explicit down modifier
   simplifies some of window-system-independent code; without it, the
   code would have to recognize down events by checking if the event
   is a mouse click lacking the click and drag modifiers.

   The window-system independent code turns all up_modifier events
277 278 279 280 281
   bits into drag_modifier, click_modifier, double_modifier, or
   triple_modifier events.  The click_modifier has no written
   representation in the names of the symbols used as event heads,
   but it does appear in the Qevent_symbol_components property of the
   event heads.  */
Jim Blandy's avatar
Jim Blandy committed
282
enum {
283 284 285
  up_modifier	=   1,		/* Only used on mouse buttons - always
				   turned into a click or a drag modifier
				   before lisp code sees the event.  */
286 287
  down_modifier =   2,		/* Only used on mouse buttons.  */
  drag_modifier =   4,		/* This is never used in the event
288 289
				   queue; it's only used internally by
				   the window-system-independent code.  */
290
  click_modifier=   8,		/* See drag_modifier.  */
291 292
  double_modifier= 16,          /* See drag_modifier.  */
  triple_modifier= 32,          /* See drag_modifier.  */
293 294 295 296

  /* The next four modifier bits are used also in keyboard events at
     the Lisp level.

Paul Eggert's avatar
Paul Eggert committed
297
     It's probably not the greatest idea to use the 2^28 bit for any
298
     modifier.  It may or may not be the sign bit, depending on
Paul Eggert's avatar
Paul Eggert committed
299
     FIXNUM_BITS, so using it to represent a modifier key means that
300 301
     characters thus modified have different integer equivalents
     depending on the architecture they're running on.  Oh, and
Paul Eggert's avatar
Paul Eggert committed
302
     applying XINT to a character whose 2^28 bit is set might sign-extend
303 304 305 306 307 308 309 310
     it, so you get a bunch of bits in the mask you didn't want.

     The CHAR_ macros are defined in lisp.h.  */
  alt_modifier	=  CHAR_ALT,	/* Under X, the XK_Alt_[LR] keysyms.  */
  super_modifier=  CHAR_SUPER,	/* Under X, the XK_Super_[LR] keysyms.  */
  hyper_modifier=  CHAR_HYPER,	/* Under X, the XK_Hyper_[LR] keysyms.  */
  shift_modifier=  CHAR_SHIFT,
  ctrl_modifier	=  CHAR_CTL,
311
  meta_modifier	=  CHAR_META	/* Under X, the XK_Meta_[LR] keysyms.  */
Jim Blandy's avatar
Jim Blandy committed
312 313
};

314
#ifdef HAVE_GPM
315
#include <gpm.h>
Miles Bader's avatar
Miles Bader committed
316
extern int handle_one_term_event (struct tty_display_info *, Gpm_Event *, struct input_event *);
317
#ifndef HAVE_WINDOW_SYSTEM
318
extern void term_mouse_moveto (int, int);
319
#endif
320

321 322
/* The device for which we have enabled gpm support.  */
extern struct tty_display_info *gpm_tty;
Miles Bader's avatar
Miles Bader committed
323 324
#endif

325 326
/* Terminal-local parameters. */
struct terminal
327
{
328
  /* This is for Lisp; the terminal code does not refer to it.  */
329
  struct vectorlike_header header;
330

331 332 333
  /* Parameter alist of this terminal.  */
  Lisp_Object param_alist;

334 335 336 337 338
  /* List of charsets supported by the terminal.  It is set by
     Fset_terminal_coding_system_internal along with
     the member terminal_coding.  */
  Lisp_Object charset_list;

Chong Yidong's avatar
Chong Yidong committed
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
  /* This is an association list containing the X selections that
     Emacs might own on this terminal.  Each element has the form
       (SELECTION-NAME SELECTION-VALUE SELECTION-TIMESTAMP FRAME)
     SELECTION-NAME is a lisp symbol, whose name is the name of an X Atom.
     SELECTION-VALUE is the value that emacs owns for that selection.
      It may be any kind of Lisp object.
     SELECTION-TIMESTAMP is the time at which emacs began owning this
      selection, as a cons of two 16-bit numbers (making a 32 bit
      time.)
     FRAME is the frame for which we made the selection.  If there is
      an entry in this alist, then it can be assumed that Emacs owns
      that selection.
     The only (eq) parts of this list that are visible from Lisp are
    the selection-values.  */
  Lisp_Object Vselection_alist;

355 356
  /* All fields before `next_terminal' should be Lisp_Object and are traced
     by the GC.  All fields afterwards are ignored by the GC.  */
357

358 359
  /* Chain of all terminal devices. */
  struct terminal *next_terminal;
360

361
  /* Unique id for this terminal device. */
362 363
  int id;

364
  /* The number of frames that are on this terminal. */
365
  int reference_count;
366

367
  /* The type of the terminal device. */
368 369
  enum output_method type;

370 371 372
  /* The name of the terminal device.  Do not use this to uniquely
     identify a terminal; the same device may be opened multiple
     times. */
373 374
  char *name;

375
  /* The terminal's keyboard object. */
376 377
  struct kboard *kboard;

378 379 380 381 382
#ifdef HAVE_WINDOW_SYSTEM
  /* Cache of images.  */
  struct image_cache *image_cache;
#endif /* HAVE_WINDOW_SYSTEM */

383
  /* Device-type dependent data shared amongst all frames on this terminal.  */
384 385 386 387
  union display_info
  {
    struct tty_display_info *tty;     /* termchar.h */
    struct x_display_info *x;         /* xterm.h */
388
    struct w32_display_info *w32;     /* w32term.h */
389
    struct ns_display_info *ns;       /* nsterm.h */
390 391 392
  } display_info;


393 394 395 396 397 398 399 400 401 402 403
  /* Coding-system to be used for encoding terminal output.  This
     structure contains information of a coding-system specified by
     the function `set-terminal-coding-system'.  Also see
     `safe_terminal_coding' in coding.h.  */
  struct coding_system *terminal_coding;

  /* Coding-system of what is sent from terminal keyboard.  This
     structure contains information of a coding-system specified by
     the function `set-keyboard-coding-system'.  */
  struct coding_system *keyboard_coding;

404 405 406 407 408
  /* Window-based redisplay interface for this device (0 for tty
     devices). */
  struct redisplay_interface *rif;

  /* Frame-based redisplay interface. */
409

410 411
  /* Text display hooks.  */

Jan D's avatar
Jan D committed
412 413
  void (*cursor_to_hook) (struct frame *f, int vpos, int hpos);
  void (*raw_cursor_to_hook) (struct frame *, int, int);
414

Jan D's avatar
Jan D committed
415 416 417
  void (*clear_to_end_hook) (struct frame *);
  void (*clear_frame_hook) (struct frame *);
  void (*clear_end_of_line_hook) (struct frame *, int);
418

Jan D's avatar
Jan D committed
419
  void (*ins_del_lines_hook) (struct frame *f, int, int);
420

Jan D's avatar
Jan D committed
421 422 423
  void (*insert_glyphs_hook) (struct frame *f, struct glyph *s, int n);
  void (*write_glyphs_hook) (struct frame *f, struct glyph *s, int n);
  void (*delete_glyphs_hook) (struct frame *, int);
424

Jan D's avatar
Jan D committed
425 426
  void (*ring_bell_hook) (struct frame *f);
  void (*toggle_invisible_pointer_hook) (struct frame *f, int invisible);
427

Jan D's avatar
Jan D committed
428 429
  void (*reset_terminal_modes_hook) (struct terminal *);
  void (*set_terminal_modes_hook) (struct terminal *);
Karoly Lorentey's avatar
Karoly Lorentey committed
430

Jan D's avatar
Jan D committed
431 432 433
  void (*update_begin_hook) (struct frame *);
  void (*update_end_hook) (struct frame *);
  void (*set_terminal_window_hook) (struct frame *, int);
434 435 436 437 438 439 440 441

  /* Multi-frame and mouse support hooks.  */

  /* Return the current position of the mouse.

     Set *f to the frame the mouse is in, or zero if the mouse is in no
     Emacs frame.  If it is set to zero, all the other arguments are
     garbage.
442

443 444 445 446 447 448 449 450
     If the motion started in a scroll bar, set *bar_window to the
     scroll bar's window, *part to the part the mouse is currently over,
     *x to the position of the mouse along the scroll bar, and *y to the
     overall length of the scroll bar.

     Otherwise, set *bar_window to Qnil, and *x and *y to the column and
     row of the character cell the mouse is over.

451
     Set *time to the time the mouse was at the returned position.  */
Jan D's avatar
Jan D committed
452 453 454 455 456
  void (*mouse_position_hook) (struct frame **f, int,
                               Lisp_Object *bar_window,
                               enum scroll_bar_part *part,
                               Lisp_Object *x,
                               Lisp_Object *y,
457
                               Time *);
458 459 460 461

  /* When a frame's focus redirection is changed, this hook tells the
     window system code to re-decide where to put the highlight.  Under
     X, this means that Emacs lies about where the focus is.  */
Jan D's avatar
Jan D committed
462
  void (*frame_rehighlight_hook) (struct frame *);
463 464 465 466

  /* If we're displaying frames using a window system that can stack
     frames on top of each other, this hook allows you to bring a frame
     to the front, or bury it behind all the other windows.  If this
467
     hook is zero, that means the terminal we're displaying on doesn't
468 469
     support overlapping frames, so there's no need to raise or lower
     anything.
470

471 472
     If RAISE_FLAG is non-zero, F is brought to the front, before all other
     windows.  If RAISE_FLAG is zero, F is sent to the back, behind all other
473
     windows.  */
474
  void (*frame_raise_lower_hook) (struct frame *f, int raise_flag);
475

476
  /* If the value of the frame parameter changed, this hook is called.
477 478
     For example, if going from fullscreen to not fullscreen this hook
     may do something OS dependent, like extended window manager hints on X11.  */
Jan D's avatar
Jan D committed
479
  void (*fullscreen_hook) (struct frame *f);
480

481 482 483 484 485 486 487 488
  
  /* Scroll bar hooks.  */

  /* The representation of scroll bars is determined by the code which
     implements them, except for one thing: they must be represented by
     lisp objects.  This allows us to place references to them in
     Lisp_Windows without worrying about those references becoming
     dangling references when the scroll bar is destroyed.
489

490 491 492 493
     The window-system-independent portion of Emacs just refers to
     scroll bars via their windows, and never looks inside the scroll bar
     representation; it always uses hook functions to do all the
     scroll bar manipulation it needs.
494

495 496 497
     The `vertical_scroll_bar' field of a Lisp_Window refers to that
     window's scroll bar, or is nil if the window doesn't have a
     scroll bar.
498

499 500 501
     The `scroll_bars' and `condemned_scroll_bars' fields of a Lisp_Frame
     are free for use by the scroll bar implementation in any way it sees
     fit.  They are marked by the garbage collector.  */
502 503


504 505 506 507 508
  /* Set the vertical scroll bar for WINDOW to have its upper left corner
     at (TOP, LEFT), and be LENGTH rows high.  Set its handle to
     indicate that we are displaying PORTION characters out of a total
     of WHOLE characters, starting at POSITION.  If WINDOW doesn't yet
     have a scroll bar, create one for it.  */
Jan D's avatar
Jan D committed
509 510 511
  void (*set_vertical_scroll_bar_hook) (struct window *window,
                                        int portion, int whole,
                                        int position);
512 513 514 515 516 517 518 519 520


  /* The following three hooks are used when we're doing a thorough
     redisplay of the frame.  We don't explicitly know which scroll bars
     are going to be deleted, because keeping track of when windows go
     away is a real pain - can you say set-window-configuration?
     Instead, we just assert at the beginning of redisplay that *all*
     scroll bars are to be removed, and then save scroll bars from the
     fiery pit when we actually redisplay their window.  */
521

522 523
  /* Arrange for all scroll bars on FRAME to be removed at the next call
     to `*judge_scroll_bars_hook'.  A scroll bar may be spared if
Paul Eggert's avatar
Paul Eggert committed
524
     `*redeem_scroll_bar_hook' is applied to its window before the judgment.
525

526 527 528 529
     This should be applied to each frame each time its window tree is
     redisplayed, even if it is not displaying scroll bars at the moment;
     if the HAS_SCROLL_BARS flag has just been turned off, only calling
     this and the judge_scroll_bars_hook will get rid of them.
530

531 532 533
     If non-zero, this hook should be safe to apply to any frame,
     whether or not it can support scroll bars, and whether or not it is
     currently displaying them.  */
Jan D's avatar
Jan D committed
534
  void (*condemn_scroll_bars_hook) (struct frame *frame);
535

Paul Eggert's avatar
Paul Eggert committed
536
  /* Unmark WINDOW's scroll bar for deletion in this judgment cycle.
537
     Note that it's okay to redeem a scroll bar that is not condemned.  */
Jan D's avatar
Jan D committed
538
  void (*redeem_scroll_bar_hook) (struct window *window);
539 540 541 542 543 544 545 546

  /* Remove all scroll bars on FRAME that haven't been saved since the
     last call to `*condemn_scroll_bars_hook'.

     This should be applied to each frame after each time its window
     tree is redisplayed, even if it is not displaying scroll bars at the
     moment; if the HAS_SCROLL_BARS flag has just been turned off, only
     calling this and condemn_scroll_bars_hook will get rid of them.
547

548 549 550
     If non-zero, this hook should be safe to apply to any frame,
     whether or not it can support scroll bars, and whether or not it is
     currently displaying them.  */
Jan D's avatar
Jan D committed
551
  void (*judge_scroll_bars_hook) (struct frame *FRAME);
552 553


554 555
  /* Called to read input events.

556
     TERMINAL indicates which terminal device to read from.  Input
557
     events should be read into HOLD_QUIT.
558 559

     A positive return value indicates that that many input events
560
     were read into BUF.
561 562
     Zero means no events were immediately available.
     A value of -1 means a transient read error, while -2 indicates
563
     that the device was closed (hangup), and it should be deleted.  */
Jan D's avatar
Jan D committed
564 565
  int (*read_socket_hook) (struct terminal *terminal,
                           struct input_event *hold_quit);
566 567

  /* Called when a frame's display becomes entirely up to date.  */
Jan D's avatar
Jan D committed
568
  void (*frame_up_to_date_hook) (struct frame *);
569 570 571


  /* Called to delete the device-specific portions of a frame that is
572
     on this terminal device. */
Jan D's avatar
Jan D committed
573
  void (*delete_frame_hook) (struct frame *);
574

575
  /* Called after the last frame on this terminal is deleted, or when
576
     the display device was closed (hangup).
577

578 579
     If this is NULL, then the generic delete_terminal is called
     instead.  Otherwise the hook must call delete_terminal itself.
580

581
     The hook must check for and close any live frames that are still
582
     on the terminal.  delete_frame ensures that there are no live
583
     frames on the terminal when it calls this hook, so infinite
584
     recursion is prevented.  */
Jan D's avatar
Jan D committed
585
  void (*delete_terminal_hook) (struct terminal *);
586 587
};

Paul Eggert's avatar
Paul Eggert committed
588 589
/* Most code should use these functions to set Lisp fields in struct
   terminal.  */
Paul Eggert's avatar
Paul Eggert committed
590
INLINE void
Paul Eggert's avatar
Paul Eggert committed
591 592 593 594
tset_charset_list (struct terminal *t, Lisp_Object val)
{
  t->charset_list = val;
}
Paul Eggert's avatar
Paul Eggert committed
595
INLINE void
Paul Eggert's avatar
Paul Eggert committed
596 597 598 599
tset_selection_alist (struct terminal *t, Lisp_Object val)
{
  t->Vselection_alist = val;
}
600

601
/* Chain of all terminal devices currently in use.  */
602
extern struct terminal *terminal_list;
603

604 605 606 607 608 609
#define FRAME_MUST_WRITE_SPACES(f) (FRAME_TTY (f)->must_write_spaces)
#define FRAME_LINE_INS_DEL_OK(f) (FRAME_TTY (f)->line_ins_del_ok)
#define FRAME_CHAR_INS_DEL_OK(f) (FRAME_TTY (f)->char_ins_del_ok)
#define FRAME_SCROLL_REGION_OK(f) (FRAME_TTY (f)->scroll_region_ok)
#define FRAME_SCROLL_REGION_COST(f) (FRAME_TTY (f)->scroll_region_cost)
#define FRAME_MEMORY_BELOW_FRAME(f) (FRAME_TTY (f)->memory_below_frame)
610

611 612
#define FRAME_TERMINAL_CODING(f) ((f)->terminal->terminal_coding)
#define FRAME_KEYBOARD_CODING(f) ((f)->terminal->keyboard_coding)
613

614 615
#define TERMINAL_TERMINAL_CODING(d) ((d)->terminal_coding)
#define TERMINAL_KEYBOARD_CODING(d) ((d)->keyboard_coding)
616

617
#define FRAME_RIF(f) ((f)->terminal->rif)
618

619
#define FRAME_TERMINAL(f) ((f)->terminal)
620

621 622 623 624
/* Return true if the terminal device is not suspended.  */
#define TERMINAL_ACTIVE_P(d)						\
  (((d)->type != output_termcap && (d)->type != output_msdos_raw)	\
   || (d)->display_info.tty->input)
625

626
extern struct terminal *get_terminal (Lisp_Object terminal, bool);
Jan D's avatar
Jan D committed
627 628
extern struct terminal *create_terminal (void);
extern void delete_terminal (struct terminal *);
629

630
/* The initial terminal device, created by initial_term_init.  */
631
extern struct terminal *initial_terminal;
632

633 634 635
extern unsigned char *encode_terminal_code (struct glyph *, int,
					    struct coding_system *);

636
#ifdef HAVE_GPM
637
extern void close_gpm (int gpm_fd);
638
#endif
639 640

#ifdef WINDOWSNT
Eli Zaretskii's avatar
Eli Zaretskii committed
641 642 643 644 645
extern int cursorX (struct tty_display_info *);
extern int cursorY (struct tty_display_info *);
#else
#define cursorX(t)  curX(t)
#define cursorY(t)  curY(t)
646 647
#endif

Paul Eggert's avatar
Paul Eggert committed
648
INLINE_HEADER_END
649 650

#endif /* EMACS_TERMHOOKS_H */