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

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

This file is part of GNU Emacs.

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

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
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

20 21 22

/* Miscellanea.   */

Gerd Moellmann's avatar
Gerd Moellmann committed
23 24
struct glyph;
struct frame;
25

Jim Blandy's avatar
Jim Blandy committed
26

27 28 29
enum scroll_bar_part {
  scroll_bar_above_handle,
  scroll_bar_handle,
30 31
  scroll_bar_below_handle,
  scroll_bar_up_arrow,
Gerd Moellmann's avatar
Gerd Moellmann committed
32 33 34
  scroll_bar_down_arrow,
  scroll_bar_to_top,
  scroll_bar_to_bottom,
35 36
  scroll_bar_end_scroll,
  scroll_bar_move_ratio
37 38
};

Jan Djärv's avatar
Jan Djärv committed
39 40 41
/* 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
42
extern void (*fullscreen_hook) (struct frame *f);
Jan Djärv's avatar
Jan Djärv committed
43

44 45

/* Input queue declarations and hooks.  */
46

47 48
enum event_kind
{
Pavel Janík's avatar
Pavel Janík committed
49
  NO_EVENT,			/* nothing happened.  This should never
Jim Blandy's avatar
Jim Blandy committed
50
				   actually appear in the event queue.  */
Jim Blandy's avatar
Jim Blandy committed
51

Pavel Janík's avatar
Pavel Janík committed
52
  ASCII_KEYSTROKE_EVENT,	/* The ASCII code is in .code, perhaps
Jim Blandy's avatar
Jim Blandy committed
53 54 55
				   with modifiers applied.
				   .modifiers holds the state of the
				   modifier keys.
56 57
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
58 59
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
Pavel Janík's avatar
Pavel Janík committed
60
  MULTIBYTE_CHAR_KEYSTROKE_EVENT,	/* The multibyte char code is in .code,
61 62
				   perhaps with modifiers applied.
				   The others are the same as
Dave Love's avatar
Dave Love committed
63
				   ASCII_KEYSTROKE_EVENT.  */
Pavel Janík's avatar
Pavel Janík committed
64
  NON_ASCII_KEYSTROKE_EVENT,	/* .code is a number identifying the
Jim Blandy's avatar
Jim Blandy committed
65 66 67 68 69 70
				   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
71
				   modifier keys.
72 73
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
74 75
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
Pavel Janík's avatar
Pavel Janík committed
76 77
  TIMER_EVENT,                  /* A timer fired.  */
  MOUSE_CLICK_EVENT,		/* The button number is in .code; it must
78 79
				   be >= 0 and < NUM_MOUSE_BUTTONS, defined
				   below.
Jim Blandy's avatar
Jim Blandy committed
80 81 82
				   .modifiers holds the state of the
				   modifier keys.
				   .x and .y give the mouse position,
Jim Blandy's avatar
Jim Blandy committed
83
				   in characters, within the window.
84 85
				   .frame_or_window gives the frame
				   the mouse click occurred in.
Jim Blandy's avatar
Jim Blandy committed
86 87
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
88 89 90 91 92 93 94 95 96 97 98 99
  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.  */
100 101 102
  HORIZ_WHEEL_EVENT,            /* A wheel event generated by a second
                                   horizontal wheel that is present on some
                                   mice. See WHEEL_EVENT.  */
103
#if defined (WINDOWSNT)
104 105 106 107
  LANGUAGE_CHANGE_EVENT,	/* A LANGUAGE_CHANGE_EVENT is
				   generated on WINDOWSNT or Mac OS
				   when the keyboard layout or input
				   language is changed by the
108
				   user.  */
109
#endif
Pavel Janík's avatar
Pavel Janík committed
110
  SCROLL_BAR_CLICK_EVENT,	/* .code gives the number of the mouse button
111 112 113
				   that was clicked.
				   .modifiers holds the state of the modifier
				   keys.
Jim Blandy's avatar
Jim Blandy committed
114
				   .part is a lisp symbol indicating which
115
				   part of the scroll bar got clicked.
116 117 118
				   .x gives the distance from the start of the
				   scroll bar of the click; .y gives the total
				   length of the scroll bar.
119
				   .frame_or_window gives the window
120
				   whose scroll bar was clicked in.
Jim Blandy's avatar
Jim Blandy committed
121 122
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
Pavel Janík's avatar
Pavel Janík committed
123
  SELECTION_REQUEST_EVENT,	/* Another X client wants a selection from us.
124
				   See `struct selection_input_event'.  */
Pavel Janík's avatar
Pavel Janík committed
125 126 127
  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".  */
128
  MENU_BAR_EVENT,		/* An event generated by the menu bar.
129
				   The frame_or_window field's cdr holds the
130 131
				   Lisp-level event value.
				   (Only the toolkit version uses these.)  */
Pavel Janík's avatar
Pavel Janík committed
132 133 134
  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
135
				   (toolkit version only).  */
Pavel Janík's avatar
Pavel Janík committed
136
  DRAG_N_DROP_EVENT,		/* A drag-n-drop event is generated when
137 138
				   files selected outside of Emacs are dropped
				   onto an Emacs window.
139
				   .modifiers holds the state of the
140 141 142
				   modifier keys.
				   .x and .y give the mouse position,
				   in characters, within the window.
143 144 145 146
				   .frame_or_window is the frame in
				   which the drop was made.
				   .arg is a platform-dependent
				   representation of the dropped items.
147 148
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
149 150
  USER_SIGNAL_EVENT,		/* A user signal.
                                   code is a number identifying it,
Gerd Moellmann's avatar
Gerd Moellmann committed
151 152
                                   index into lispy_user_signals.  */

153 154 155
  /* 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
156 157
  HELP_EVENT,

158 159 160
  /* 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.  */
161 162 163 164
  TOOL_BAR_EVENT,

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

167 168 169
  /* Generated when mouse moves over window not currently selected.  */
  SELECT_WINDOW_EVENT,

170 171
  /* Queued from XTread_socket when session manager sends
     save yourself before shutdown. */
172
  SAVE_SESSION_EVENT
173

174
#ifdef HAVE_GPM
Miles Bader's avatar
Miles Bader committed
175
  , GPM_CLICK_EVENT
176 177
#endif

178 179 180 181
#ifdef HAVE_DBUS
  , DBUS_EVENT
#endif

182 183
  , CONFIG_CHANGED_EVENT

184 185 186 187 188 189 190 191 192 193 194 195 196
#ifdef WINDOWSNT
  /* 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
197
#endif
198 199 200 201 202

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

207 208
};

Pavel Janík's avatar
Pavel Janík committed
209 210
/* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
   or SELECTION_CLEAR_EVENT, then its contents are really described
211
   by `struct selection_input_event'; see xterm.h.  */
212 213 214 215 216 217

/* 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.  */

218 219
struct input_event
{
220
  /* What kind of event was this?  */
221
  enum event_kind kind;
222

Pavel Janík's avatar
Pavel Janík committed
223 224 225
  /* 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.
226 227 228
     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.  */
229
  /* In WindowsNT, for a mouse wheel event, this is the delta.  */
230
  EMACS_INT code;
231
  enum scroll_bar_part part;
232

233 234 235 236 237
  int modifiers;		/* See enum below for interpretation.  */

  Lisp_Object x, y;
  unsigned long timestamp;

238
  /* This is padding just to put the frame_or_window field
239
     past the size of struct selection_input_event.  */
240 241
  int *padding[2];

242 243
  /* This field is copied into a vector while the event is in the queue,
     so that garbage collections won't kill it.  */
244 245
  /* In a menu_bar_event, this is a cons cell whose car is the frame
     and whose cdr is the Lisp object that is the event's value.  */
246 247
  /* This field is last so that struct selection_input_event
     does not overlap with it.  */
248
  Lisp_Object frame_or_window;
249 250 251 252

  /* 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
253
};
Andreas Schwab's avatar
Andreas Schwab committed
254

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

257 258
/* Bits in the modifiers member of the input_event structure.
   Note that reorder_modifiers assumes that the bits are in canonical
259
   order.
260 261 262

   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
263 264 265 266 267 268
   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
269 270 271 272 273
   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
274
enum {
275 276 277
  up_modifier	=   1,		/* Only used on mouse buttons - always
				   turned into a click or a drag modifier
				   before lisp code sees the event.  */
278 279
  down_modifier =   2,		/* Only used on mouse buttons.  */
  drag_modifier =   4,		/* This is never used in the event
280 281
				   queue; it's only used internally by
				   the window-system-independent code.  */
282
  click_modifier=   8,		/* See drag_modifier.  */
283 284
  double_modifier= 16,          /* See drag_modifier.  */
  triple_modifier= 32,          /* See drag_modifier.  */
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302

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

     It's probably not the greatest idea to use the 2^23 bit for any
     modifier.  It may or may not be the sign bit, depending on
     VALBITS, so using it to represent a modifier key means that
     characters thus modified have different integer equivalents
     depending on the architecture they're running on.  Oh, and
     applying XINT to a character whose 2^23 bit is set sign-extends
     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,
303
  meta_modifier	=  CHAR_META	/* Under X, the XK_Meta_[LR] keysyms.  */
Jim Blandy's avatar
Jim Blandy committed
304 305
};

306
#ifdef HAVE_GPM
307
#include <gpm.h>
Miles Bader's avatar
Miles Bader committed
308
extern int handle_one_term_event (struct tty_display_info *, Gpm_Event *, struct input_event *);
309
#ifndef HAVE_WINDOW_SYSTEM
310
extern void term_mouse_moveto (int, int);
311
#endif
312

313 314
/* The device for which we have enabled gpm support.  */
extern struct tty_display_info *gpm_tty;
Miles Bader's avatar
Miles Bader committed
315 316
#endif

317

318 319
struct ns_display_info;
struct x_display_info;
320 321
struct w32_display_info;

322 323
/* Terminal-local parameters. */
struct terminal
324
{
325 326
  /* This is for Lisp; the terminal code does not refer to it.  */
  struct vector_header header;
327

328 329 330
  /* Parameter alist of this terminal.  */
  Lisp_Object param_alist;

331 332 333 334 335
  /* 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;

336 337
  /* All fields before `next_terminal' should be Lisp_Object and are traced
     by the GC.  All fields afterwards are ignored by the GC.  */
338

339 340
  /* Chain of all terminal devices. */
  struct terminal *next_terminal;
341

342
  /* Unique id for this terminal device. */
343 344
  int id;

345
  /* The number of frames that are on this terminal. */
346
  int reference_count;
347

348
  /* The type of the terminal device. */
349 350
  enum output_method type;

351 352 353
  /* The name of the terminal device.  Do not use this to uniquely
     identify a terminal; the same device may be opened multiple
     times. */
354 355
  char *name;

356
  /* The terminal's keyboard object. */
357 358
  struct kboard *kboard;

359 360 361 362 363
#ifdef HAVE_WINDOW_SYSTEM
  /* Cache of images.  */
  struct image_cache *image_cache;
#endif /* HAVE_WINDOW_SYSTEM */

364
  /* Device-type dependent data shared amongst all frames on this terminal. */
365 366 367 368
  union display_info
  {
    struct tty_display_info *tty;     /* termchar.h */
    struct x_display_info *x;         /* xterm.h */
369
    struct w32_display_info *w32;     /* w32term.h */
370
    struct ns_display_info *ns;       /* nsterm.h */
371 372 373
  } display_info;


374 375 376 377 378 379 380 381 382 383 384
  /* 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;

385 386
  /* Terminal characteristics. */
  /* XXX Are these really used on non-termcap displays? */
387

388 389 390 391
  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.  */
  int fast_clear_end_of_line;   /* Nonzero means terminal has a `ce' string */
392

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
  int line_ins_del_ok;          /* Terminal can insert and delete lines */
  int char_ins_del_ok;          /* Terminal can insert and delete chars */
  int scroll_region_ok;         /* Terminal supports setting the scroll
                                   window */
  int scroll_region_cost;	/* Cost of setting the scroll window,
                                   measured in characters. */
  int memory_below_frame;	/* Terminal remembers lines scrolled
                                   off bottom */

#if 0  /* These are not used anywhere. */
  /* EMACS_INT baud_rate; */	/* Output speed in baud */
  int min_padding_speed;	/* Speed below which no padding necessary. */
  int dont_calculate_costs;     /* Nonzero means don't bother computing
                                   various cost tables; we won't use them. */
#endif

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

  /* Frame-based redisplay interface. */
415

416 417
  /* Text display hooks.  */

Jan D's avatar
Jan D committed
418 419
  void (*cursor_to_hook) (struct frame *f, int vpos, int hpos);
  void (*raw_cursor_to_hook) (struct frame *, int, int);
420

Jan D's avatar
Jan D committed
421 422 423
  void (*clear_to_end_hook) (struct frame *);
  void (*clear_frame_hook) (struct frame *);
  void (*clear_end_of_line_hook) (struct frame *, int);
424

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

Jan D's avatar
Jan D committed
427 428 429
  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);
430

Jan D's avatar
Jan D committed
431 432
  void (*ring_bell_hook) (struct frame *f);
  void (*toggle_invisible_pointer_hook) (struct frame *f, int invisible);
433

Jan D's avatar
Jan D committed
434 435
  void (*reset_terminal_modes_hook) (struct terminal *);
  void (*set_terminal_modes_hook) (struct terminal *);
Karoly Lorentey's avatar
Karoly Lorentey committed
436

Jan D's avatar
Jan D committed
437 438 439
  void (*update_begin_hook) (struct frame *);
  void (*update_end_hook) (struct frame *);
  void (*set_terminal_window_hook) (struct frame *, int);
440 441 442 443 444 445 446 447

  /* 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.
448

449 450 451 452 453 454 455 456 457
     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.

     Set *time to the time the mouse was at the returned position.
458

459 460
     This should clear mouse_moved until the next motion
     event arrives.  */
Jan D's avatar
Jan D committed
461 462 463 464 465
  void (*mouse_position_hook) (struct frame **f, int,
                               Lisp_Object *bar_window,
                               enum scroll_bar_part *part,
                               Lisp_Object *x,
                               Lisp_Object *y,
466
                               unsigned long *);
467 468 469 470 471 472 473 474 475

  /* The window system handling code should set this if the mouse has
     moved since the last call to the mouse_position_hook.  Calling that
     hook should clear this.  */
  int mouse_moved;

  /* 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
476
  void (*frame_rehighlight_hook) (struct frame *);
477 478 479 480

  /* 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
481
     hook is zero, that means the terminal we're displaying on doesn't
482 483
     support overlapping frames, so there's no need to raise or lower
     anything.
484

485 486
     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
487
     windows.  */
488
  void (*frame_raise_lower_hook) (struct frame *f, int raise_flag);
489

490 491 492
  /* 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
493
  void (*fullscreen_hook) (struct frame *f);
494

495 496 497 498 499 500 501 502
  
  /* 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.
503

504 505 506 507
     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.
508

509 510 511
     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.
512

513 514 515
     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.  */
516 517


518 519 520 521 522
  /* 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
523 524 525
  void (*set_vertical_scroll_bar_hook) (struct window *window,
                                        int portion, int whole,
                                        int position);
526 527 528 529 530 531 532 533 534


  /* 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.  */
535

536 537 538
  /* 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
     `*redeem_scroll_bar_hook' is applied to its window before the judgement.
539

540 541 542 543
     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.
544

545 546 547
     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
548
  void (*condemn_scroll_bars_hook) (struct frame *frame);
549 550 551

  /* Unmark WINDOW's scroll bar for deletion in this judgement cycle.
     Note that it's okay to redeem a scroll bar that is not condemned.  */
Jan D's avatar
Jan D committed
552
  void (*redeem_scroll_bar_hook) (struct window *window);
553 554 555 556 557 558 559 560

  /* 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.
561

562 563 564
     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
565
  void (*judge_scroll_bars_hook) (struct frame *FRAME);
566 567


568 569
  /* Called to read input events.

570 571 572 573
     TERMINAL indicates which terminal device to read from.  Input
     events should be read into BUF, the size of which is given in
     SIZE.  EXPECTED is non-zero if the caller suspects that new input
     is available.
574 575 576 577 578

     A positive return value indicates that that many input events
     where read into BUF.
     Zero means no events were immediately available.
     A value of -1 means a transient read error, while -2 indicates
579
     that the device was closed (hangup), and it should be deleted.
580 581 582

     XXX Please note that a non-zero value of EXPECTED only means that
     there is available input on at least one of the currently opened
583
     terminal devices -- but not necessarily on this device.
584
     Therefore, in most cases EXPECTED should be simply ignored.
585 586

     XXX This documentation needs to be updated.  */
Jan D's avatar
Jan D committed
587 588 589
  int (*read_socket_hook) (struct terminal *terminal,
                           int expected,
                           struct input_event *hold_quit);
590 591

  /* Called when a frame's display becomes entirely up to date.  */
Jan D's avatar
Jan D committed
592
  void (*frame_up_to_date_hook) (struct frame *);
593 594 595

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

599
  /* Called after the last frame on this terminal is deleted, or when
600
     the display device was closed (hangup).
601

602 603
     If this is NULL, then the generic delete_terminal is called
     instead.  Otherwise the hook must call delete_terminal itself.
604

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


613 614
/* Chain of all terminal devices currently in use. */
extern struct terminal *terminal_list;
615

616 617 618 619 620 621 622
#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)
623

624 625
#define FRAME_TERMINAL_CODING(f) ((f)->terminal->terminal_coding)
#define FRAME_KEYBOARD_CODING(f) ((f)->terminal->keyboard_coding)
626

627 628
#define TERMINAL_TERMINAL_CODING(d) ((d)->terminal_coding)
#define TERMINAL_KEYBOARD_CODING(d) ((d)->keyboard_coding)
629

630
#define FRAME_RIF(f) ((f)->terminal->rif)
631

632
#define FRAME_TERMINAL(f) ((f)->terminal)
633

634
/* Return true if the terminal device is not suspended. */
635
#define TERMINAL_ACTIVE_P(d) (((d)->type != output_termcap && (d)->type !=output_msdos_raw) || (d)->display_info.tty->input)
636

Jan D's avatar
Jan D committed
637 638 639
extern struct terminal *get_terminal (Lisp_Object terminal, int);
extern struct terminal *create_terminal (void);
extern void delete_terminal (struct terminal *);
640

641 642
/* The initial terminal device, created by initial_term_init. */
extern struct terminal *initial_terminal;
643

644 645 646
extern unsigned char *encode_terminal_code (struct glyph *, int,
					    struct coding_system *);

647
#ifdef HAVE_GPM
648
extern void close_gpm (int gpm_fd);
649
#endif