src/termhooks.h

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