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 3, 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 #ifdef HAVE_GPM
 198   GPM_CLICK_EVENT
 199 #endif
 200 };
 201
 202 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
 203    or SELECTION_CLEAR_EVENT, then its contents are really described
 204    by `struct selection_input_event'; see xterm.h.  */
 205
 206 /* The keyboard input buffer is an array of these structures.  Each one
 207    represents some sort of input event - a keystroke, a mouse click, or
 208    a window system event.  These get turned into their lispy forms when
 209    they are removed from the event queue.  */
 210
 211 struct input_event
 212 {
 213   /* What kind of event was this?  */
 214   enum event_kind kind;
 215
 216   /* For an ASCII_KEYSTROKE_EVENT and MULTIBYTE_CHAR_KEYSTROKE_EVENT,
 217      this is the character.
 218      For a NON_ASCII_KEYSTROKE_EVENT, this is the keysym code.
 219      For a mouse event, this is the button number.  */
 220   /* In WindowsNT, for a mouse wheel event, this is the delta.  */
 221   int code;
 222   enum scroll_bar_part part;
 223
 224   int modifiers;                /* See enum below for interpretation.  */
 225
 226   Lisp_Object x, y;
 227   unsigned long timestamp;
 228
 229   /* This is padding just to put the frame_or_window field
 230      past the size of struct selection_input_event.  */
 231   int *padding[2];
 232
 233   /* This field is copied into a vector while the event is in the queue,
 234      so that garbage collections won't kill it.  */
 235   /* In a menu_bar_event, this is a cons cell whose car is the frame
 236      and whose cdr is the Lisp object that is the event's value.  */
 237   /* This field is last so that struct selection_input_event
 238      does not overlap with it.  */
 239   Lisp_Object frame_or_window;
 240
 241   /* Additional event argument.  This is used for TOOL_BAR_EVENTs and
 242      HELP_EVENTs and avoids calling Fcons during signal handling.  */
 243   Lisp_Object arg;
 244 };
 245
 246 #define EVENT_INIT(event) bzero (&(event), sizeof (struct input_event))
 247
 248 /* Bits in the modifiers member of the input_event structure.
 249    Note that reorder_modifiers assumes that the bits are in canonical
 250    order.
 251
 252    The modifiers applied to mouse clicks are rather ornate.  The
 253    window-system-specific code should store mouse clicks with
 254    up_modifier or down_modifier set.  Having an explicit down modifier
 255    simplifies some of window-system-independent code; without it, the
 256    code would have to recognize down events by checking if the event
 257    is a mouse click lacking the click and drag modifiers.
 258
 259    The window-system independent code turns all up_modifier events
 260    bits into drag_modifier, click_modifier, double_modifier, or
 261    triple_modifier events.  The click_modifier has no written
 262    representation in the names of the symbols used as event heads,
 263    but it does appear in the Qevent_symbol_components property of the
 264    event heads.  */
 265 enum {
 266   up_modifier   =   1,          /* Only used on mouse buttons - always
 267                                    turned into a click or a drag modifier
 268                                    before lisp code sees the event.  */
 269   down_modifier =   2,          /* Only used on mouse buttons.  */
 270   drag_modifier =   4,          /* This is never used in the event
 271                                    queue; it's only used internally by
 272                                    the window-system-independent code.  */
 273   click_modifier=   8,          /* See drag_modifier.  */
 274   double_modifier= 16,          /* See drag_modifier.  */
 275   triple_modifier= 32,          /* See drag_modifier.  */
 276
 277   /* The next four modifier bits are used also in keyboard events at
 278      the Lisp level.
 279
 280      It's probably not the greatest idea to use the 2^23 bit for any
 281      modifier.  It may or may not be the sign bit, depending on
 282      VALBITS, so using it to represent a modifier key means that
 283      characters thus modified have different integer equivalents
 284      depending on the architecture they're running on.  Oh, and
 285      applying XINT to a character whose 2^23 bit is set sign-extends
 286      it, so you get a bunch of bits in the mask you didn't want.
 287
 288      The CHAR_ macros are defined in lisp.h.  */
 289   alt_modifier  =  CHAR_ALT,    /* Under X, the XK_Alt_[LR] keysyms.  */
 290   super_modifier=  CHAR_SUPER,  /* Under X, the XK_Super_[LR] keysyms.  */
 291   hyper_modifier=  CHAR_HYPER,  /* Under X, the XK_Hyper_[LR] keysyms.  */
 292   shift_modifier=  CHAR_SHIFT,
 293   ctrl_modifier =  CHAR_CTL,
 294   meta_modifier =  CHAR_META    /* Under X, the XK_Meta_[LR] keysyms.  */
 295 };
 296
 297 #ifdef HAVE_GPM
 298 #include <gpm.h>
 299 extern int handle_one_term_event (struct tty_display_info *, Gpm_Event *, struct input_event *);
 300 extern void term_mouse_moveto (int, int);
 301
 302 /* Nonzero means mouse is enabled on Linux console */
 303 extern int term_gpm;
 304
 305 /* The id of the terminal device for which we have gpm support.  */
 306 extern int gpm_tty;
 307 #endif
 308
 309 #endif /* CONSP */
 310
 311 \f
 312 struct mac_display_info;
 313 struct w32_display_info;
 314
 315 /* Terminal-local parameters. */
 316 struct terminal
 317 {
 318   /* Chain of all terminal devices. */
 319   struct terminal *next_terminal;
 320
 321   /* Unique id for this terminal device. */
 322   int id;
 323
 324   /* The number of frames that are on this terminal. */
 325   int reference_count;
 326
 327   /* Nonzero while deleting this terminal.  Used to protect against
 328      recursive calls to delete_terminal_hook.  */
 329   int deleted;
 330
 331   /* The type of the terminal device. */
 332   enum output_method type;
 333
 334   /* The name of the terminal device.  Do not use this to uniquely
 335      identify a terminal; the same device may be opened multiple
 336      times. */
 337   char *name;
 338
 339 #ifdef MULTI_KBOARD
 340   /* The terminal's keyboard object. */
 341   struct kboard *kboard;
 342 #endif
 343
 344   /* Device-type dependent data shared amongst all frames on this terminal. */
 345   union display_info
 346   {
 347     struct tty_display_info *tty;     /* termchar.h */
 348     struct x_display_info *x;         /* xterm.h */
 349     struct w32_display_info *w32;     /* w32term.h */
 350     struct mac_display_info *mac;     /* macterm.h */
 351   } display_info;
 352
 353 \f
 354   /* Coding-system to be used for encoding terminal output.  This
 355      structure contains information of a coding-system specified by
 356      the function `set-terminal-coding-system'.  Also see
 357      `safe_terminal_coding' in coding.h.  */
 358   struct coding_system *terminal_coding;
 359
 360   /* Coding-system of what is sent from terminal keyboard.  This
 361      structure contains information of a coding-system specified by
 362      the function `set-keyboard-coding-system'.  */
 363   struct coding_system *keyboard_coding;
 364
 365   /* Parameter alist of this terminal.  */
 366   Lisp_Object param_alist;
 367
 368   /* Terminal characteristics. */
 369   /* XXX Are these really used on non-termcap displays? */
 370
 371   int must_write_spaces;        /* Nonzero means spaces in the text must
 372                                    actually be output; can't just skip over
 373                                    some columns to leave them blank.  */
 374   int fast_clear_end_of_line;   /* Nonzero means terminal has a `ce' string */
 375
 376   int line_ins_del_ok;          /* Terminal can insert and delete lines */
 377   int char_ins_del_ok;          /* Terminal can insert and delete chars */
 378   int scroll_region_ok;         /* Terminal supports setting the scroll
 379                                    window */
 380   int scroll_region_cost;       /* Cost of setting the scroll window,
 381                                    measured in characters. */
 382   int memory_below_frame;       /* Terminal remembers lines scrolled
 383                                    off bottom */
 384
 385 #if 0  /* These are not used anywhere. */
 386   /* EMACS_INT baud_rate; */    /* Output speed in baud */
 387   int min_padding_speed;        /* Speed below which no padding necessary. */
 388   int dont_calculate_costs;     /* Nonzero means don't bother computing
 389                                    various cost tables; we won't use them. */
 390 #endif
 391
 392 \f
 393   /* Window-based redisplay interface for this device (0 for tty
 394      devices). */
 395   struct redisplay_interface *rif;
 396
 397   /* Frame-based redisplay interface. */
 398
 399   /* Text display hooks.  */
 400
 401   void (*cursor_to_hook) P_ ((struct frame *f, int vpos, int hpos));
 402   void (*raw_cursor_to_hook) P_ ((struct frame *, int, int));
 403
 404   void (*clear_to_end_hook) P_ ((struct frame *));
 405   void (*clear_frame_hook) P_ ((struct frame *));
 406   void (*clear_end_of_line_hook) P_ ((struct frame *, int));
 407
 408   void (*ins_del_lines_hook) P_ ((struct frame *f, int, int));
 409
 410   void (*insert_glyphs_hook) P_ ((struct frame *f, struct glyph *s, int n));
 411   void (*write_glyphs_hook) P_ ((struct frame *f, struct glyph *s, int n));
 412   void (*delete_glyphs_hook) P_ ((struct frame *, int));
 413
 414   void (*ring_bell_hook) P_ ((struct frame *f));
 415
 416   void (*reset_terminal_modes_hook) P_ ((struct terminal *));
 417   void (*set_terminal_modes_hook) P_ ((struct terminal *));
 418
 419   void (*update_begin_hook) P_ ((struct frame *));
 420   void (*update_end_hook) P_ ((struct frame *));
 421   void (*set_terminal_window_hook) P_ ((struct frame *, int));
 422
 423   /* Multi-frame and mouse support hooks.  */
 424
 425   /* Return the current position of the mouse.
 426
 427      Set *f to the frame the mouse is in, or zero if the mouse is in no
 428      Emacs frame.  If it is set to zero, all the other arguments are
 429      garbage.
 430
 431      If the motion started in a scroll bar, set *bar_window to the
 432      scroll bar's window, *part to the part the mouse is currently over,
 433      *x to the position of the mouse along the scroll bar, and *y to the
 434      overall length of the scroll bar.
 435
 436      Otherwise, set *bar_window to Qnil, and *x and *y to the column and
 437      row of the character cell the mouse is over.
 438
 439      Set *time to the time the mouse was at the returned position.
 440
 441      This should clear mouse_moved until the next motion
 442      event arrives.  */
 443   void (*mouse_position_hook) P_ ((struct frame **f, int,
 444                                    Lisp_Object *bar_window,
 445                                    enum scroll_bar_part *part,
 446                                    Lisp_Object *x,
 447                                    Lisp_Object *y,
 448                                    unsigned long *time));
 449
 450   /* The window system handling code should set this if the mouse has
 451      moved since the last call to the mouse_position_hook.  Calling that
 452      hook should clear this.  */
 453   int mouse_moved;
 454
 455   /* When a frame's focus redirection is changed, this hook tells the
 456      window system code to re-decide where to put the highlight.  Under
 457      X, this means that Emacs lies about where the focus is.  */
 458   void (*frame_rehighlight_hook) P_ ((struct frame *));
 459
 460   /* If we're displaying frames using a window system that can stack
 461      frames on top of each other, this hook allows you to bring a frame
 462      to the front, or bury it behind all the other windows.  If this
 463      hook is zero, that means the terminal we're displaying on doesn't
 464      support overlapping frames, so there's no need to raise or lower
 465      anything.
 466
 467      If RAISE is non-zero, F is brought to the front, before all other
 468      windows.  If RAISE is zero, F is sent to the back, behind all other
 469      windows.  */
 470   void (*frame_raise_lower_hook) P_ ((struct frame *f, int raise));
 471
 472   /* If the value of the frame parameter changed, whis hook is called.
 473      For example, if going from fullscreen to not fullscreen this hook
 474      may do something OS dependent, like extended window manager hints on X11.  */
 475   void (*fullscreen_hook) P_ ((struct frame *f));
 476
 477   \f
 478   /* Scroll bar hooks.  */
 479
 480   /* The representation of scroll bars is determined by the code which
 481      implements them, except for one thing: they must be represented by
 482      lisp objects.  This allows us to place references to them in
 483      Lisp_Windows without worrying about those references becoming
 484      dangling references when the scroll bar is destroyed.
 485
 486      The window-system-independent portion of Emacs just refers to
 487      scroll bars via their windows, and never looks inside the scroll bar
 488      representation; it always uses hook functions to do all the
 489      scroll bar manipulation it needs.
 490
 491      The `vertical_scroll_bar' field of a Lisp_Window refers to that
 492      window's scroll bar, or is nil if the window doesn't have a
 493      scroll bar.
 494
 495      The `scroll_bars' and `condemned_scroll_bars' fields of a Lisp_Frame
 496      are free for use by the scroll bar implementation in any way it sees
 497      fit.  They are marked by the garbage collector.  */
 498
 499
 500   /* Set the vertical scroll bar for WINDOW to have its upper left corner
 501      at (TOP, LEFT), and be LENGTH rows high.  Set its handle to
 502      indicate that we are displaying PORTION characters out of a total
 503      of WHOLE characters, starting at POSITION.  If WINDOW doesn't yet
 504      have a scroll bar, create one for it.  */
 505   void (*set_vertical_scroll_bar_hook) P_ ((struct window *window,
 506                                             int portion, int whole,
 507                                             int position));
 508
 509
 510   /* The following three hooks are used when we're doing a thorough
 511      redisplay of the frame.  We don't explicitly know which scroll bars
 512      are going to be deleted, because keeping track of when windows go
 513      away is a real pain - can you say set-window-configuration?
 514      Instead, we just assert at the beginning of redisplay that *all*
 515      scroll bars are to be removed, and then save scroll bars from the
 516      fiery pit when we actually redisplay their window.  */
 517
 518   /* Arrange for all scroll bars on FRAME to be removed at the next call
 519      to `*judge_scroll_bars_hook'.  A scroll bar may be spared if
 520      `*redeem_scroll_bar_hook' is applied to its window before the judgement.
 521
 522      This should be applied to each frame each time its window tree is
 523      redisplayed, even if it is not displaying scroll bars at the moment;
 524      if the HAS_SCROLL_BARS flag has just been turned off, only calling
 525      this and the judge_scroll_bars_hook will get rid of them.
 526
 527      If non-zero, this hook should be safe to apply to any frame,
 528      whether or not it can support scroll bars, and whether or not it is
 529      currently displaying them.  */
 530   void (*condemn_scroll_bars_hook) P_ ((struct frame *frame));
 531
 532   /* Unmark WINDOW's scroll bar for deletion in this judgement cycle.
 533      Note that it's okay to redeem a scroll bar that is not condemned.  */
 534   void (*redeem_scroll_bar_hook) P_ ((struct window *window));
 535
 536   /* Remove all scroll bars on FRAME that haven't been saved since the
 537      last call to `*condemn_scroll_bars_hook'.
 538
 539      This should be applied to each frame after each time its window
 540      tree is redisplayed, even if it is not displaying scroll bars at the
 541      moment; if the HAS_SCROLL_BARS flag has just been turned off, only
 542      calling this and condemn_scroll_bars_hook will get rid of them.
 543
 544      If non-zero, this hook should be safe to apply to any frame,
 545      whether or not it can support scroll bars, and whether or not it is
 546      currently displaying them.  */
 547   void (*judge_scroll_bars_hook) P_ ((struct frame *FRAME));
 548
 549 \f
 550   /* Called to read input events.
 551
 552      TERMINAL indicates which terminal device to read from.  Input
 553      events should be read into BUF, the size of which is given in
 554      SIZE.  EXPECTED is non-zero if the caller suspects that new input
 555      is available.
 556
 557      A positive return value indicates that that many input events
 558      where read into BUF.
 559      Zero means no events were immediately available.
 560      A value of -1 means a transient read error, while -2 indicates
 561      that the device was closed (hangup), and it should be deleted.
 562
 563      XXX Please note that a non-zero value of EXPECTED only means that
 564      there is available input on at least one of the currently opened
 565      terminal devices -- but not necessarily on this device.
 566      Therefore, in most cases EXPECTED should be simply ignored.
 567
 568      XXX This documentation needs to be updated.  */
 569   int (*read_socket_hook) P_ ((struct terminal *terminal,
 570                                int expected,
 571                                struct input_event *hold_quit));
 572
 573   /* Called when a frame's display becomes entirely up to date.  */
 574   void (*frame_up_to_date_hook) P_ ((struct frame *));
 575
 576 \f
 577   /* Called to delete the device-specific portions of a frame that is
 578      on this terminal device. */
 579   void (*delete_frame_hook) P_ ((struct frame *));
 580
 581   /* Called after the last frame on this terminal is deleted, or when
 582      the display device was closed (hangup).
 583
 584      If this is NULL, then the generic delete_terminal is called
 585      instead.  Otherwise the hook must call delete_terminal itself.
 586
 587      The hook must check for and close any live frames that are still
 588      on the terminal.  Fdelete_frame ensures that there are no live
 589      frames on the terminal when it calls this hook, so infinite
 590      recursion is prevented.  */
 591   void (*delete_terminal_hook) P_ ((struct terminal *));
 592 };
 593
 594
 595 /* Chain of all terminal devices currently in use. */
 596 extern struct terminal *terminal_list;
 597
 598 #define FRAME_MUST_WRITE_SPACES(f) ((f)->terminal->must_write_spaces)
 599 #define FRAME_FAST_CLEAR_END_OF_LINE(f) ((f)->terminal->fast_clear_end_of_line)
 600 #define FRAME_LINE_INS_DEL_OK(f) ((f)->terminal->line_ins_del_ok)
 601 #define FRAME_CHAR_INS_DEL_OK(f) ((f)->terminal->char_ins_del_ok)
 602 #define FRAME_SCROLL_REGION_OK(f) ((f)->terminal->scroll_region_ok)
 603 #define FRAME_SCROLL_REGION_COST(f) ((f)->terminal->scroll_region_cost)
 604 #define FRAME_MEMORY_BELOW_FRAME(f) ((f)->terminal->memory_below_frame)
 605
 606 #define FRAME_TERMINAL_CODING(f) ((f)->terminal->terminal_coding)
 607 #define FRAME_KEYBOARD_CODING(f) ((f)->terminal->keyboard_coding)
 608
 609 #define TERMINAL_TERMINAL_CODING(d) ((d)->terminal_coding)
 610 #define TERMINAL_KEYBOARD_CODING(d) ((d)->keyboard_coding)
 611
 612 #define FRAME_RIF(f) ((f)->terminal->rif)
 613
 614 #define FRAME_TERMINAL(f) ((f)->terminal)
 615
 616 /* FRAME_WINDOW_P tests whether the frame is a window, and is
 617    defined to be the predicate for the window system being used.  */
 618
 619 #ifdef HAVE_X_WINDOWS
 620 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
 621 #endif
 622 #ifdef HAVE_NTGUI
 623 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
 624 #endif
 625 #ifdef MAC_OS
 626 #define FRAME_WINDOW_P(f) FRAME_MAC_P (f)
 627 #endif
 628 #ifndef FRAME_WINDOW_P
 629 #define FRAME_WINDOW_P(f) (0)
 630 #endif
 631
 632 /* Return true if the terminal device is not suspended. */
 633 #define TERMINAL_ACTIVE_P(d) ((d)->type != output_termcap || (d)->display_info.tty->input)
 634
 635 extern Lisp_Object get_terminal_param P_ ((struct terminal *, Lisp_Object));
 636 extern struct terminal *get_terminal P_ ((Lisp_Object terminal, int));
 637 extern struct terminal *create_terminal P_ ((void));
 638 extern void delete_terminal P_ ((struct terminal *));
 639
 640 /* The initial terminal device, created by initial_term_init. */
 641 extern struct terminal *initial_terminal;
 642
 643 /* arch-tag: 33a00ecc-52b5-4186-a410-8801ac9f087d
 644    (do not change this comment) */