termhooks.h 25.3 KB
Newer Older
1
/* Parameters and display hooks for terminal devices.
2

3 4
Copyright (C) 1985-1986, 1993-1994, 2001-2013 Free Software Foundation,
Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

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/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

21 22 23

/* Miscellanea.   */

24 25
#include "systime.h" /* for Time */

Paul Eggert's avatar
Paul Eggert committed
26 27 28 29 30
INLINE_HEADER_BEGIN
#ifndef TERMHOOKS_INLINE
# define TERMHOOKS_INLINE INLINE
#endif

Gerd Moellmann's avatar
Gerd Moellmann committed
31 32
struct glyph;
struct frame;
33

Jim Blandy's avatar
Jim Blandy committed
34

35 36 37
enum scroll_bar_part {
  scroll_bar_above_handle,
  scroll_bar_handle,
38 39
  scroll_bar_below_handle,
  scroll_bar_up_arrow,
Gerd Moellmann's avatar
Gerd Moellmann committed
40 41 42
  scroll_bar_down_arrow,
  scroll_bar_to_top,
  scroll_bar_to_bottom,
43 44
  scroll_bar_end_scroll,
  scroll_bar_move_ratio
45 46
};

Jan Djärv's avatar
Jan Djärv committed
47 48 49
/* If the value of the frame parameter changed, whis hook is called.
   For example, if going from fullscreen to not fullscreen this hook
   may do something OS dependent, like extended window manager hints on X11.  */
Jan D's avatar
Jan D committed
50
extern void (*fullscreen_hook) (struct frame *f);
Jan Djärv's avatar
Jan Djärv committed
51

52 53

/* Input queue declarations and hooks.  */
54

55 56
enum event_kind
{
Pavel Janík's avatar
Pavel Janík committed
57
  NO_EVENT,			/* nothing happened.  This should never
Jim Blandy's avatar
Jim Blandy committed
58
				   actually appear in the event queue.  */
Jim Blandy's avatar
Jim Blandy committed
59

Pavel Janík's avatar
Pavel Janík committed
60
  ASCII_KEYSTROKE_EVENT,	/* The ASCII code is in .code, perhaps
Jim Blandy's avatar
Jim Blandy committed
61 62 63
				   with modifiers applied.
				   .modifiers holds the state of the
				   modifier keys.
64 65
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
66 67
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
Pavel Janík's avatar
Pavel Janík committed
68
  MULTIBYTE_CHAR_KEYSTROKE_EVENT,	/* The multibyte char code is in .code,
69 70
				   perhaps with modifiers applied.
				   The others are the same as
Dave Love's avatar
Dave Love committed
71
				   ASCII_KEYSTROKE_EVENT.  */
Pavel Janík's avatar
Pavel Janík committed
72
  NON_ASCII_KEYSTROKE_EVENT,	/* .code is a number identifying the
Jim Blandy's avatar
Jim Blandy committed
73 74 75 76 77 78
				   function key.  A code N represents
				   a key whose name is
				   function_key_names[N]; function_key_names
				   is a table in keyboard.c to which you
				   should feel free to add missing keys.
				   .modifiers holds the state of the
Jim Blandy's avatar
Jim Blandy committed
79
				   modifier keys.
80 81
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
82 83
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
Pavel Janík's avatar
Pavel Janík committed
84 85
  TIMER_EVENT,                  /* A timer fired.  */
  MOUSE_CLICK_EVENT,		/* The button number is in .code; it must
86 87
				   be >= 0 and < NUM_MOUSE_BUTTONS, defined
				   below.
Jim Blandy's avatar
Jim Blandy committed
88 89 90
				   .modifiers holds the state of the
				   modifier keys.
				   .x and .y give the mouse position,
Jim Blandy's avatar
Jim Blandy committed
91
				   in characters, within the window.
92 93
				   .frame_or_window gives the frame
				   the mouse click occurred in.
Jim Blandy's avatar
Jim Blandy committed
94 95
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
96 97 98 99 100 101 102 103 104 105 106 107
  WHEEL_EVENT,			/* A wheel event is generated by a
				   wheel on a mouse (e.g., MS
				   Intellimouse).
				   .modifiers holds the rotate
				   direction (up or down), and the
				   state of the modifier keys.
				   .x and .y give the mouse position,
				   in characters, within the window.
				   .frame_or_window gives the frame
				   the wheel event occurred in.
				   .timestamp gives a timestamp (in
				   milliseconds) for the event.  */
108 109 110
  HORIZ_WHEEL_EVENT,            /* A wheel event generated by a second
                                   horizontal wheel that is present on some
                                   mice. See WHEEL_EVENT.  */
111
#ifdef HAVE_NTGUI
112
  LANGUAGE_CHANGE_EVENT,	/* A LANGUAGE_CHANGE_EVENT is
Daniel Colascione's avatar
Daniel Colascione committed
113
				   generated when HAVE_NTGUI or on Mac OS
114 115
				   when the keyboard layout or input
				   language is changed by the
116
				   user.  */
117
#endif
Pavel Janík's avatar
Pavel Janík committed
118
  SCROLL_BAR_CLICK_EVENT,	/* .code gives the number of the mouse button
119 120 121
				   that was clicked.
				   .modifiers holds the state of the modifier
				   keys.
Jim Blandy's avatar
Jim Blandy committed
122
				   .part is a lisp symbol indicating which
123
				   part of the scroll bar got clicked.
124 125 126
				   .x gives the distance from the start of the
				   scroll bar of the click; .y gives the total
				   length of the scroll bar.
127
				   .frame_or_window gives the window
128
				   whose scroll bar was clicked in.
Jim Blandy's avatar
Jim Blandy committed
129 130
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
Pavel Janík's avatar
Pavel Janík committed
131
  SELECTION_REQUEST_EVENT,	/* Another X client wants a selection from us.
132
				   See `struct selection_input_event'.  */
Pavel Janík's avatar
Pavel Janík committed
133 134 135
  SELECTION_CLEAR_EVENT,	/* Another X client cleared our selection.  */
  BUFFER_SWITCH_EVENT,		/* A process filter has switched buffers.  */
  DELETE_WINDOW_EVENT,		/* An X client said "delete this window".  */
136
  MENU_BAR_EVENT,		/* An event generated by the menu bar.
137
				   The frame_or_window field's cdr holds the
138 139
				   Lisp-level event value.
				   (Only the toolkit version uses these.)  */
Pavel Janík's avatar
Pavel Janík committed
140 141 142
  ICONIFY_EVENT,		/* An X client iconified this window.  */
  DEICONIFY_EVENT,		/* An X client deiconified this window.  */
  MENU_BAR_ACTIVATE_EVENT,      /* A button press in the menu bar
143
				   (toolkit version only).  */
Pavel Janík's avatar
Pavel Janík committed
144
  DRAG_N_DROP_EVENT,		/* A drag-n-drop event is generated when
145 146
				   files selected outside of Emacs are dropped
				   onto an Emacs window.
147
				   .modifiers holds the state of the
148 149 150
				   modifier keys.
				   .x and .y give the mouse position,
				   in characters, within the window.
151 152 153 154
				   .frame_or_window is the frame in
				   which the drop was made.
				   .arg is a platform-dependent
				   representation of the dropped items.
155 156
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
157 158
  USER_SIGNAL_EVENT,		/* A user signal.
                                   code is a number identifying it,
Gerd Moellmann's avatar
Gerd Moellmann committed
159 160
                                   index into lispy_user_signals.  */

161 162 163
  /* Help events.  Member `frame_or_window' of the input_event is the
     frame on which the event occurred, and member `arg' contains
     the help to show.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
164 165
  HELP_EVENT,

166 167 168
  /* An event from a tool-bar.  Member `arg' of the input event
     contains the tool-bar item selected.  If `frame_or_window'
     and `arg' are equal, this is a prefix event.  */
169 170 171 172
  TOOL_BAR_EVENT,

  /* Queued from XTread_socket on FocusIn events.  Translated into
     `switch-frame' events in kbd_buffer_get_event, if necessary.  */
173 174
  FOCUS_IN_EVENT,

175 176 177
  /* Generated when mouse moves over window not currently selected.  */
  SELECT_WINDOW_EVENT,

178 179
  /* Queued from XTread_socket when session manager sends
     save yourself before shutdown. */
180
  SAVE_SESSION_EVENT
181

182
#ifdef HAVE_GPM
Miles Bader's avatar
Miles Bader committed
183
  , GPM_CLICK_EVENT
184 185
#endif

186 187 188 189
#ifdef HAVE_DBUS
  , DBUS_EVENT
#endif

190 191
  , CONFIG_CHANGED_EVENT

Daniel Colascione's avatar
Daniel Colascione committed
192
#ifdef HAVE_NTGUI
193 194 195 196 197 198 199 200 201 202 203 204
  /* Generated when an APPCOMMAND event is received, in response to
     Multimedia or Internet buttons on some keyboards.
     Such keys are available as normal function keys on X through the
     Xkeyboard extension.
     On Windows, some of them get mapped to normal function key events,
     but others need to be handled by APPCOMMAND. Handling them all as
     APPCOMMAND events means they can be disabled
     (w32-pass-multimedia-buttons-to-system), important on Windows since
     the system never sees these keys if Emacs claims to handle them.
     On X, the window manager seems to grab the keys it wants
     first, so this is not a problem there.  */
  , MULTIMEDIA_KEY_EVENT
205
#endif
206 207 208 209 210

#ifdef HAVE_NS
  /* Generated when native multi-keystroke input method is used to modify
     tentative or indicative text display. */
  , NS_TEXT_EVENT
211 212
  /* Non-key system events (e.g. application menu events) */
  , NS_NONKEY_EVENT
213 214
#endif

215
#ifdef USE_FILE_NOTIFY
216 217 218 219
  /* File or directory was changed.  */
  , FILE_NOTIFY_EVENT
#endif

220 221
};

Pavel Janík's avatar
Pavel Janík committed
222 223
/* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
   or SELECTION_CLEAR_EVENT, then its contents are really described
224
   by `struct selection_input_event'; see xterm.h.  */
225 226 227 228 229 230

/* The keyboard input buffer is an array of these structures.  Each one
   represents some sort of input event - a keystroke, a mouse click, or
   a window system event.  These get turned into their lispy forms when
   they are removed from the event queue.  */

231 232
struct input_event
{
233
  /* What kind of event was this?  */
234
  enum event_kind kind;
235

Pavel Janík's avatar
Pavel Janík committed
236 237 238
  /* For an ASCII_KEYSTROKE_EVENT and MULTIBYTE_CHAR_KEYSTROKE_EVENT,
     this is the character.
     For a NON_ASCII_KEYSTROKE_EVENT, this is the keysym code.
239 240 241
     For a mouse event, this is the button number.
     For a HELP_EVENT, this is the position within the object
      (stored in ARG below) where the help was found.  */
242
  /* In WindowsNT, for a mouse wheel event, this is the delta.  */
243
  ptrdiff_t code;
244
  enum scroll_bar_part part;
245

246 247 248
  int modifiers;		/* See enum below for interpretation.  */

  Lisp_Object x, y;
249
  Time timestamp;
250

251 252
  /* This field is copied into a vector while the event is in
     the queue, so that garbage collections won't kill it.  */
253
  Lisp_Object frame_or_window;
254 255 256 257

  /* Additional event argument.  This is used for TOOL_BAR_EVENTs and
     HELP_EVENTs and avoids calling Fcons during signal handling.  */
  Lisp_Object arg;
Jim Blandy's avatar
Jim Blandy committed
258
};
Andreas Schwab's avatar
Andreas Schwab committed
259

260
#define EVENT_INIT(event) memset (&(event), 0, sizeof (struct input_event))
Stefan Monnier's avatar
Stefan Monnier committed
261

262 263
/* Bits in the modifiers member of the input_event structure.
   Note that reorder_modifiers assumes that the bits are in canonical
264
   order.
265 266 267

   The modifiers applied to mouse clicks are rather ornate.  The
   window-system-specific code should store mouse clicks with
Jim Blandy's avatar
Jim Blandy committed
268 269 270 271 272 273
   up_modifier or down_modifier set.  Having an explicit down modifier
   simplifies some of window-system-independent code; without it, the
   code would have to recognize down events by checking if the event
   is a mouse click lacking the click and drag modifiers.

   The window-system independent code turns all up_modifier events
274 275 276 277 278
   bits into drag_modifier, click_modifier, double_modifier, or
   triple_modifier events.  The click_modifier has no written
   representation in the names of the symbols used as event heads,
   but it does appear in the Qevent_symbol_components property of the
   event heads.  */
Jim Blandy's avatar
Jim Blandy committed
279
enum {
280 281 282
  up_modifier	=   1,		/* Only used on mouse buttons - always
				   turned into a click or a drag modifier
				   before lisp code sees the event.  */
283 284
  down_modifier =   2,		/* Only used on mouse buttons.  */
  drag_modifier =   4,		/* This is never used in the event
285 286
				   queue; it's only used internally by
				   the window-system-independent code.  */
287
  click_modifier=   8,		/* See drag_modifier.  */
288 289
  double_modifier= 16,          /* See drag_modifier.  */
  triple_modifier= 32,          /* See drag_modifier.  */
290 291 292 293

  /* The next four modifier bits are used also in keyboard events at
     the Lisp level.

Paul Eggert's avatar
Paul Eggert committed
294
     It's probably not the greatest idea to use the 2^28 bit for any
295
     modifier.  It may or may not be the sign bit, depending on
Paul Eggert's avatar
Paul Eggert committed
296
     FIXNUM_BITS, so using it to represent a modifier key means that
297 298
     characters thus modified have different integer equivalents
     depending on the architecture they're running on.  Oh, and
Paul Eggert's avatar
Paul Eggert committed
299
     applying XINT to a character whose 2^28 bit is set might sign-extend
300 301 302 303 304 305 306 307
     it, so you get a bunch of bits in the mask you didn't want.

     The CHAR_ macros are defined in lisp.h.  */
  alt_modifier	=  CHAR_ALT,	/* Under X, the XK_Alt_[LR] keysyms.  */
  super_modifier=  CHAR_SUPER,	/* Under X, the XK_Super_[LR] keysyms.  */
  hyper_modifier=  CHAR_HYPER,	/* Under X, the XK_Hyper_[LR] keysyms.  */
  shift_modifier=  CHAR_SHIFT,
  ctrl_modifier	=  CHAR_CTL,
308
  meta_modifier	=  CHAR_META	/* Under X, the XK_Meta_[LR] keysyms.  */
Jim Blandy's avatar
Jim Blandy committed
309 310
};

311
#ifdef HAVE_GPM
312
#include <gpm.h>
Miles Bader's avatar
Miles Bader committed
313
extern int handle_one_term_event (struct tty_display_info *, Gpm_Event *, struct input_event *);
314
#ifndef HAVE_WINDOW_SYSTEM
315
extern void term_mouse_moveto (int, int);
316
#endif
317

318 319
/* The device for which we have enabled gpm support.  */
extern struct tty_display_info *gpm_tty;
Miles Bader's avatar
Miles Bader committed
320 321
#endif

322

323 324
struct ns_display_info;
struct x_display_info;
325 326
struct w32_display_info;

327 328
/* Terminal-local parameters. */
struct terminal
329
{
330
  /* This is for Lisp; the terminal code does not refer to it.  */
331
  struct vectorlike_header header;
332

333 334 335
  /* Parameter alist of this terminal.  */
  Lisp_Object param_alist;

336 337 338 339 340
  /* List of charsets supported by the terminal.  It is set by
     Fset_terminal_coding_system_internal along with
     the member terminal_coding.  */
  Lisp_Object charset_list;

Chong Yidong's avatar
Chong Yidong committed
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
  /* This is an association list containing the X selections that
     Emacs might own on this terminal.  Each element has the form
       (SELECTION-NAME SELECTION-VALUE SELECTION-TIMESTAMP FRAME)
     SELECTION-NAME is a lisp symbol, whose name is the name of an X Atom.
     SELECTION-VALUE is the value that emacs owns for that selection.
      It may be any kind of Lisp object.
     SELECTION-TIMESTAMP is the time at which emacs began owning this
      selection, as a cons of two 16-bit numbers (making a 32 bit
      time.)
     FRAME is the frame for which we made the selection.  If there is
      an entry in this alist, then it can be assumed that Emacs owns
      that selection.
     The only (eq) parts of this list that are visible from Lisp are
    the selection-values.  */
  Lisp_Object Vselection_alist;

357 358
  /* All fields before `next_terminal' should be Lisp_Object and are traced
     by the GC.  All fields afterwards are ignored by the GC.  */
359

360 361
  /* Chain of all terminal devices. */
  struct terminal *next_terminal;
362

363
  /* Unique id for this terminal device. */
364 365
  int id;

366
  /* The number of frames that are on this terminal. */
367
  int reference_count;
368

369
  /* The type of the terminal device. */
370 371
  enum output_method type;

372 373 374
  /* The name of the terminal device.  Do not use this to uniquely
     identify a terminal; the same device may be opened multiple
     times. */
375 376
  char *name;

377
  /* The terminal's keyboard object. */
378 379
  struct kboard *kboard;

380 381 382 383 384
#ifdef HAVE_WINDOW_SYSTEM
  /* Cache of images.  */
  struct image_cache *image_cache;
#endif /* HAVE_WINDOW_SYSTEM */

385
  /* Device-type dependent data shared amongst all frames on this terminal.  */
386 387 388 389
  union display_info
  {
    struct tty_display_info *tty;     /* termchar.h */
    struct x_display_info *x;         /* xterm.h */
390
    struct w32_display_info *w32;     /* w32term.h */
391
    struct ns_display_info *ns;       /* nsterm.h */
392 393 394
  } display_info;


395 396 397 398 399 400 401 402 403 404 405
  /* Coding-system to be used for encoding terminal output.  This
     structure contains information of a coding-system specified by
     the function `set-terminal-coding-system'.  Also see
     `safe_terminal_coding' in coding.h.  */
  struct coding_system *terminal_coding;

  /* Coding-system of what is sent from terminal keyboard.  This
     structure contains information of a coding-system specified by
     the function `set-keyboard-coding-system'.  */
  struct coding_system *keyboard_coding;

406 407
  /* Terminal characteristics.  */
  /* XXX Are these really used on non-termcap displays?  */
408

409 410 411
  int must_write_spaces;	/* Nonzero means spaces in the text must
				   actually be output; can't just skip over
				   some columns to leave them blank.  */
412
  int fast_clear_end_of_line;   /* Nonzero means terminal has a `ce' string.  */
413

414 415
  int line_ins_del_ok;          /* Terminal can insert and delete lines.  */
  int char_ins_del_ok;          /* Terminal can insert and delete chars.  */
416
  int scroll_region_ok;         /* Terminal supports setting the scroll
417
                                   window.  */
418
  int scroll_region_cost;	/* Cost of setting the scroll window,
419
                                   measured in characters.  */
420
  int memory_below_frame;	/* Terminal remembers lines scrolled
421
                                   off bottom.  */
422 423 424 425 426 427

  /* Window-based redisplay interface for this device (0 for tty
     devices). */
  struct redisplay_interface *rif;

  /* Frame-based redisplay interface. */
428

429 430
  /* Text display hooks.  */

Jan D's avatar
Jan D committed
431 432
  void (*cursor_to_hook) (struct frame *f, int vpos, int hpos);
  void (*raw_cursor_to_hook) (struct frame *, int, int);
433

Jan D's avatar
Jan D committed
434 435 436
  void (*clear_to_end_hook) (struct frame *);
  void (*clear_frame_hook) (struct frame *);
  void (*clear_end_of_line_hook) (struct frame *, int);
437

Jan D's avatar
Jan D committed
438
  void (*ins_del_lines_hook) (struct frame *f, int, int);
439

Jan D's avatar
Jan D committed
440 441 442
  void (*insert_glyphs_hook) (struct frame *f, struct glyph *s, int n);
  void (*write_glyphs_hook) (struct frame *f, struct glyph *s, int n);
  void (*delete_glyphs_hook) (struct frame *, int);
443

Jan D's avatar
Jan D committed
444 445
  void (*ring_bell_hook) (struct frame *f);
  void (*toggle_invisible_pointer_hook) (struct frame *f, int invisible);
446

Jan D's avatar
Jan D committed
447 448
  void (*reset_terminal_modes_hook) (struct terminal *);
  void (*set_terminal_modes_hook) (struct terminal *);
Karoly Lorentey's avatar
Karoly Lorentey committed
449

Jan D's avatar
Jan D committed
450 451 452
  void (*update_begin_hook) (struct frame *);
  void (*update_end_hook) (struct frame *);
  void (*set_terminal_window_hook) (struct frame *, int);
453 454 455 456 457 458 459 460

  /* Multi-frame and mouse support hooks.  */

  /* Return the current position of the mouse.

     Set *f to the frame the mouse is in, or zero if the mouse is in no
     Emacs frame.  If it is set to zero, all the other arguments are
     garbage.
461

462 463 464 465 466 467 468 469
     If the motion started in a scroll bar, set *bar_window to the
     scroll bar's window, *part to the part the mouse is currently over,
     *x to the position of the mouse along the scroll bar, and *y to the
     overall length of the scroll bar.

     Otherwise, set *bar_window to Qnil, and *x and *y to the column and
     row of the character cell the mouse is over.

470
     Set *time to the time the mouse was at the returned position.  */
Jan D's avatar
Jan D committed
471 472 473 474 475
  void (*mouse_position_hook) (struct frame **f, int,
                               Lisp_Object *bar_window,
                               enum scroll_bar_part *part,
                               Lisp_Object *x,
                               Lisp_Object *y,
476
                               Time *);
477 478 479 480

  /* When a frame's focus redirection is changed, this hook tells the
     window system code to re-decide where to put the highlight.  Under
     X, this means that Emacs lies about where the focus is.  */
Jan D's avatar
Jan D committed
481
  void (*frame_rehighlight_hook) (struct frame *);
482 483 484 485

  /* If we're displaying frames using a window system that can stack
     frames on top of each other, this hook allows you to bring a frame
     to the front, or bury it behind all the other windows.  If this
486
     hook is zero, that means the terminal we're displaying on doesn't
487 488
     support overlapping frames, so there's no need to raise or lower
     anything.
489

490 491
     If RAISE_FLAG is non-zero, F is brought to the front, before all other
     windows.  If RAISE_FLAG is zero, F is sent to the back, behind all other
492
     windows.  */
493
  void (*frame_raise_lower_hook) (struct frame *f, int raise_flag);
494

495 496 497
  /* If the value of the frame parameter changed, whis hook is called.
     For example, if going from fullscreen to not fullscreen this hook
     may do something OS dependent, like extended window manager hints on X11.  */
Jan D's avatar
Jan D committed
498
  void (*fullscreen_hook) (struct frame *f);
499

500 501 502 503 504 505 506 507
  
  /* Scroll bar hooks.  */

  /* The representation of scroll bars is determined by the code which
     implements them, except for one thing: they must be represented by
     lisp objects.  This allows us to place references to them in
     Lisp_Windows without worrying about those references becoming
     dangling references when the scroll bar is destroyed.
508

509 510 511 512
     The window-system-independent portion of Emacs just refers to
     scroll bars via their windows, and never looks inside the scroll bar
     representation; it always uses hook functions to do all the
     scroll bar manipulation it needs.
513

514 515 516
     The `vertical_scroll_bar' field of a Lisp_Window refers to that
     window's scroll bar, or is nil if the window doesn't have a
     scroll bar.
517

518 519 520
     The `scroll_bars' and `condemned_scroll_bars' fields of a Lisp_Frame
     are free for use by the scroll bar implementation in any way it sees
     fit.  They are marked by the garbage collector.  */
521 522


523 524 525 526 527
  /* Set the vertical scroll bar for WINDOW to have its upper left corner
     at (TOP, LEFT), and be LENGTH rows high.  Set its handle to
     indicate that we are displaying PORTION characters out of a total
     of WHOLE characters, starting at POSITION.  If WINDOW doesn't yet
     have a scroll bar, create one for it.  */
Jan D's avatar
Jan D committed
528 529 530
  void (*set_vertical_scroll_bar_hook) (struct window *window,
                                        int portion, int whole,
                                        int position);
531 532 533 534 535 536 537 538 539


  /* The following three hooks are used when we're doing a thorough
     redisplay of the frame.  We don't explicitly know which scroll bars
     are going to be deleted, because keeping track of when windows go
     away is a real pain - can you say set-window-configuration?
     Instead, we just assert at the beginning of redisplay that *all*
     scroll bars are to be removed, and then save scroll bars from the
     fiery pit when we actually redisplay their window.  */
540

541 542
  /* Arrange for all scroll bars on FRAME to be removed at the next call
     to `*judge_scroll_bars_hook'.  A scroll bar may be spared if
Paul Eggert's avatar
Paul Eggert committed
543
     `*redeem_scroll_bar_hook' is applied to its window before the judgment.
544

545 546 547 548
     This should be applied to each frame each time its window tree is
     redisplayed, even if it is not displaying scroll bars at the moment;
     if the HAS_SCROLL_BARS flag has just been turned off, only calling
     this and the judge_scroll_bars_hook will get rid of them.
549

550 551 552
     If non-zero, this hook should be safe to apply to any frame,
     whether or not it can support scroll bars, and whether or not it is
     currently displaying them.  */
Jan D's avatar
Jan D committed
553
  void (*condemn_scroll_bars_hook) (struct frame *frame);
554

Paul Eggert's avatar
Paul Eggert committed
555
  /* Unmark WINDOW's scroll bar for deletion in this judgment cycle.
556
     Note that it's okay to redeem a scroll bar that is not condemned.  */
Jan D's avatar
Jan D committed
557
  void (*redeem_scroll_bar_hook) (struct window *window);
558 559 560 561 562 563 564 565

  /* Remove all scroll bars on FRAME that haven't been saved since the
     last call to `*condemn_scroll_bars_hook'.

     This should be applied to each frame after each time its window
     tree is redisplayed, even if it is not displaying scroll bars at the
     moment; if the HAS_SCROLL_BARS flag has just been turned off, only
     calling this and condemn_scroll_bars_hook will get rid of them.
566

567 568 569
     If non-zero, this hook should be safe to apply to any frame,
     whether or not it can support scroll bars, and whether or not it is
     currently displaying them.  */
Jan D's avatar
Jan D committed
570
  void (*judge_scroll_bars_hook) (struct frame *FRAME);
571 572


573 574
  /* Called to read input events.

575
     TERMINAL indicates which terminal device to read from.  Input
576
     events should be read into HOLD_QUIT.
577 578

     A positive return value indicates that that many input events
579
     were read into BUF.
580 581
     Zero means no events were immediately available.
     A value of -1 means a transient read error, while -2 indicates
582
     that the device was closed (hangup), and it should be deleted.  */
Jan D's avatar
Jan D committed
583 584
  int (*read_socket_hook) (struct terminal *terminal,
                           struct input_event *hold_quit);
585 586

  /* Called when a frame's display becomes entirely up to date.  */
Jan D's avatar
Jan D committed
587
  void (*frame_up_to_date_hook) (struct frame *);
588 589 590


  /* Called to delete the device-specific portions of a frame that is
591
     on this terminal device. */
Jan D's avatar
Jan D committed
592
  void (*delete_frame_hook) (struct frame *);
593

594
  /* Called after the last frame on this terminal is deleted, or when
595
     the display device was closed (hangup).
596

597 598
     If this is NULL, then the generic delete_terminal is called
     instead.  Otherwise the hook must call delete_terminal itself.
599

600
     The hook must check for and close any live frames that are still
601
     on the terminal.  delete_frame ensures that there are no live
602
     frames on the terminal when it calls this hook, so infinite
603
     recursion is prevented.  */
Jan D's avatar
Jan D committed
604
  void (*delete_terminal_hook) (struct terminal *);
605 606
};

Paul Eggert's avatar
Paul Eggert committed
607 608 609 610 611 612 613 614 615 616 617 618
/* Most code should use these functions to set Lisp fields in struct
   terminal.  */
TERMHOOKS_INLINE void
tset_charset_list (struct terminal *t, Lisp_Object val)
{
  t->charset_list = val;
}
TERMHOOKS_INLINE void
tset_selection_alist (struct terminal *t, Lisp_Object val)
{
  t->Vselection_alist = val;
}
619

620
/* Chain of all terminal devices currently in use.  */
621
extern struct terminal *terminal_list;
622

623 624 625 626 627 628 629
#define FRAME_MUST_WRITE_SPACES(f) ((f)->terminal->must_write_spaces)
#define FRAME_FAST_CLEAR_END_OF_LINE(f) ((f)->terminal->fast_clear_end_of_line)
#define FRAME_LINE_INS_DEL_OK(f) ((f)->terminal->line_ins_del_ok)
#define FRAME_CHAR_INS_DEL_OK(f) ((f)->terminal->char_ins_del_ok)
#define FRAME_SCROLL_REGION_OK(f) ((f)->terminal->scroll_region_ok)
#define FRAME_SCROLL_REGION_COST(f) ((f)->terminal->scroll_region_cost)
#define FRAME_MEMORY_BELOW_FRAME(f) ((f)->terminal->memory_below_frame)
630

631 632
#define FRAME_TERMINAL_CODING(f) ((f)->terminal->terminal_coding)
#define FRAME_KEYBOARD_CODING(f) ((f)->terminal->keyboard_coding)
633

634 635
#define TERMINAL_TERMINAL_CODING(d) ((d)->terminal_coding)
#define TERMINAL_KEYBOARD_CODING(d) ((d)->keyboard_coding)
636

637
#define FRAME_RIF(f) ((f)->terminal->rif)
638

639
#define FRAME_TERMINAL(f) ((f)->terminal)
640

641 642 643 644
/* Return true if the terminal device is not suspended.  */
#define TERMINAL_ACTIVE_P(d)						\
  (((d)->type != output_termcap && (d)->type != output_msdos_raw)	\
   || (d)->display_info.tty->input)
645

646
extern struct terminal *get_terminal (Lisp_Object terminal, bool);
Jan D's avatar
Jan D committed
647 648
extern struct terminal *create_terminal (void);
extern void delete_terminal (struct terminal *);
649

650
/* The initial terminal device, created by initial_term_init.  */
651
extern struct terminal *initial_terminal;
652

653 654 655
extern unsigned char *encode_terminal_code (struct glyph *, int,
					    struct coding_system *);

656
#ifdef HAVE_GPM
657
extern void close_gpm (int gpm_fd);
658
#endif
Paul Eggert's avatar
Paul Eggert committed
659 660

INLINE_HEADER_END