src/termhooks.h

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