src/termhooks.h

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