src/termhooks.h

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