termhooks.h 23 KB
Newer Older
1
/* Parameters and display hooks for output devices
Stefan Monnier's avatar
Stefan Monnier committed
2
   Copyright (C) 1985,86,93,94,2003  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20

21 22 23

/* Miscellanea.   */

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

Andreas Schwab's avatar
Andreas Schwab committed
27 28 29 30
/* Only use prototypes when lisp.h has been included.  */
#ifndef P_
#define P_(X) ()
#endif
31

Jim Blandy's avatar
Jim Blandy committed
32

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

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

Jim Blandy's avatar
Jim Blandy committed
48
/* Expedient hack: only provide the below definitions to files that
49
   are prepared to handle lispy things.  CONSP is defined iff lisp.h
Jim Blandy's avatar
Jim Blandy committed
50
   has been included before this file.  */
51
#ifdef CONSP
Jim Blandy's avatar
Jim Blandy committed
52

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

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

160 161 162
  /* 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
163 164
  HELP_EVENT,

165 166 167
  /* 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.  */
168 169 170 171
  TOOL_BAR_EVENT,

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

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

177 178
  /* Queued from XTread_socket when session manager sends
     save yourself before shutdown. */
Pavel Janík's avatar
Pavel Janík committed
179
  SAVE_SESSION_EVENT
180 181
};

Pavel Janík's avatar
Pavel Janík committed
182 183
/* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
   or SELECTION_CLEAR_EVENT, then its contents are really described
184 185 186 187 188 189 190
   by `struct selection_event'; see xterm.h.  */

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

191 192
struct input_event
{
193
  /* What kind of event was this?  */
194
  enum event_kind kind;
195

Pavel Janík's avatar
Pavel Janík committed
196 197 198
  /* 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.
199
     For a mouse event, this is the button number.  */
200
  /* In WindowsNT, for a mouse wheel event, this is the delta.  */
201
  int code;
202
  enum scroll_bar_part part;
203

204 205 206 207 208
  int modifiers;		/* See enum below for interpretation.  */

  Lisp_Object x, y;
  unsigned long timestamp;

209 210 211 212
  /* This is padding just to put the frame_or_window field
     past the size of struct selection_event.  */
  int *padding[2];

213 214
  /* This field is copied into a vector while the event is in the queue,
     so that garbage collections won't kill it.  */
215 216
  /* 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.  */
217 218
  /* This field is last so that struct selection_input_event
     does not overlap with it.  */
219
  Lisp_Object frame_or_window;
220 221 222 223

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

Stefan Monnier's avatar
Stefan Monnier committed
226 227
#define EVENT_INIT(event) bzero (&(event), sizeof (struct input_event))

228 229
/* Bits in the modifiers member of the input_event structure.
   Note that reorder_modifiers assumes that the bits are in canonical
230
   order.
231 232 233

   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
234 235 236 237 238 239
   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
240 241 242 243 244
   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
245
enum {
246 247 248
  up_modifier	=   1,		/* Only used on mouse buttons - always
				   turned into a click or a drag modifier
				   before lisp code sees the event.  */
249 250
  down_modifier =   2,		/* Only used on mouse buttons.  */
  drag_modifier =   4,		/* This is never used in the event
251 252
				   queue; it's only used internally by
				   the window-system-independent code.  */
253
  click_modifier=   8,		/* See drag_modifier.  */
254 255
  double_modifier= 16,          /* See drag_modifier.  */
  triple_modifier= 32,          /* See drag_modifier.  */
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273

  /* 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,
274
  meta_modifier	=  CHAR_META	/* Under X, the XK_Meta_[LR] keysyms.  */
Jim Blandy's avatar
Jim Blandy committed
275 276
};

277
#endif /* CONSP */
Miles Bader's avatar
Miles Bader committed
278

279 280 281 282 283 284 285

/* Display-local parameters. */
struct display
{
  /* Chain of all displays. */
  struct display *next_display;

286 287 288
  /* Unique id for this display. */
  int id;

289 290 291 292 293 294
  /* The number of frames that are on this display. */
  int reference_count;
  
  /* The type of the display. */
  enum output_method type;

295 296 297
  /* The name of the display device.  Do not use this to identify the display. */
  char *name;

298 299 300 301 302 303 304 305
  /* Display-type dependent data shared amongst all frames on this display. */
  union display_info
  {
    struct tty_display_info *tty;     /* termchar.h */
    struct x_display_info *x;         /* xterm.h */
  } display_info;


306 307 308 309 310 311 312 313 314 315 316
  /* 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;

317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
  /* Terminal characteristics. */
  /* XXX Are these really used on non-termcap displays? */
  
  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 */
  
  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. */
  
  /* Text display hooks.  */

Karoly Lorentey's avatar
Karoly Lorentey committed
350 351
  void (*cursor_to_hook) P_ ((struct frame *f, int vpos, int hpos));
  void (*raw_cursor_to_hook) P_ ((struct frame *, int, int));
352
  
Karoly Lorentey's avatar
Karoly Lorentey committed
353 354 355
  void (*clear_to_end_hook) P_ ((struct frame *));
  void (*clear_frame_hook) P_ ((struct frame *));
  void (*clear_end_of_line_hook) P_ ((struct frame *, int));
356
  
Karoly Lorentey's avatar
Karoly Lorentey committed
357
  void (*ins_del_lines_hook) P_ ((struct frame *f, int, int));
358
  
Karoly Lorentey's avatar
Karoly Lorentey committed
359 360 361
  void (*insert_glyphs_hook) P_ ((struct frame *f, struct glyph *s, int n));
  void (*write_glyphs_hook) P_ ((struct frame *f, struct glyph *s, int n));
  void (*delete_glyphs_hook) P_ ((struct frame *, int));
362
  
Karoly Lorentey's avatar
Karoly Lorentey committed
363
  void (*ring_bell_hook) P_ ((struct frame *f));
364
  
365 366
  void (*reset_terminal_modes_hook) P_ ((struct display *));
  void (*set_terminal_modes_hook) P_ ((struct display *));
Karoly Lorentey's avatar
Karoly Lorentey committed
367

368 369
  void (*update_begin_hook) P_ ((struct frame *));
  void (*update_end_hook) P_ ((struct frame *));
Karoly Lorentey's avatar
Karoly Lorentey committed
370
  void (*set_terminal_window_hook) P_ ((struct frame *, int));
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493

  /* 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.
  
     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.
     
     This should clear mouse_moved until the next motion
     event arrives.  */
  void (*mouse_position_hook) P_ ((struct frame **f, int,
                                   Lisp_Object *bar_window,
                                   enum scroll_bar_part *part,
                                   Lisp_Object *x,
                                   Lisp_Object *y,
                                   unsigned long *time));

  /* 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.  */
  void (*frame_rehighlight_hook) P_ ((struct frame *));

  /* 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
     hook is zero, that means the device we're displaying on doesn't
     support overlapping frames, so there's no need to raise or lower
     anything.
     
     If RAISE is non-zero, F is brought to the front, before all other
     windows.  If RAISE is zero, F is sent to the back, behind all other
     windows.  */
  void (*frame_raise_lower_hook) P_ ((struct frame *f, int raise));

  
  /* 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.
     
     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.
     
     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.
     
     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.  */
  
  
  /* 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.  */
  void (*set_vertical_scroll_bar_hook) P_ ((struct window *window,
                                            int portion, int whole,
                                            int position));


  /* 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.  */
  
  /* 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.
     
     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.
     
     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.  */
  void (*condemn_scroll_bars_hook) P_ ((struct frame *frame));

  /* 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.  */
  void (*redeem_scroll_bar_hook) P_ ((struct window *window));

  /* 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.
     
     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.  */
  void (*judge_scroll_bars_hook) P_ ((struct frame *FRAME));


494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
  /* Called to read input events.

     DISPLAY indicates which display 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.

     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
     that the display was closed (hangup), and it should be deleted.

     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
     display devices -- but not necessarily on this device.
     Therefore, in most cases EXPECTED should be simply ignored.
511 512

     XXX This documentation needs to be updated.  */
513
  int (*read_socket_hook) P_ ((struct display *display,
514 515
                               int expected,
                               struct input_event *hold_quit));
516 517 518 519 520 521 522 523 524

  /* Called when a frame's display becomes entirely up to date.  */
  void (*frame_up_to_date_hook) P_ ((struct frame *));


  /* Called to delete the device-specific portions of a frame that is
     on this display. */
  void (*delete_frame_hook) P_ ((struct frame *));

525 526 527
  /* Called after the last frame on this display is deleted, or when
     the display device was closed (hangup).
     
528 529
     If this is NULL, then the generic delete_display is called
     instead.  Otherwise the hook must call delete_display itself.
530

531 532 533 534
     The hook must check for and close any live frames that are still
     on the display.  Fdelete_frame ensures that there are no live
     frames on the display when it calls this hook, so infinite
     recursion is prevented.  */
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
  void (*delete_display_hook) P_ ((struct display *));
};


/* Chain of all displays currently in use. */
extern struct display *display_list;

#define FRAME_MUST_WRITE_SPACES(f) ((f)->display->must_write_spaces)
#define FRAME_FAST_CLEAR_END_OF_LINE(f) ((f)->display->fast_clear_end_of_line)
#define FRAME_LINE_INS_DEL_OK(f) ((f)->display->line_ins_del_ok)
#define FRAME_CHAR_INS_DEL_OK(f) ((f)->display->char_ins_del_ok)
#define FRAME_SCROLL_REGION_OK(f) ((f)->display->scroll_region_ok)
#define FRAME_SCROLL_REGION_COST(f) ((f)->display->scroll_region_cost)
#define FRAME_MEMORY_BELOW_FRAME(f) ((f)->display->memory_below_frame)

550 551 552
#define FRAME_TERMINAL_CODING(f) ((f)->display->terminal_coding)
#define FRAME_KEYBOARD_CODING(f) ((f)->display->keyboard_coding)

553 554 555
#define DISPLAY_TERMINAL_CODING(d) ((d)->terminal_coding)
#define DISPLAY_KEYBOARD_CODING(d) ((d)->keyboard_coding)

556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
#define FRAME_RIF(f) ((f)->display->rif)

#define FRAME_DISPLAY(f) ((f)->display)

/* FRAME_WINDOW_P tests whether the frame is a window, and is
   defined to be the predicate for the window system being used.  */

#ifdef HAVE_X_WINDOWS
#define FRAME_WINDOW_P(f) FRAME_X_P (f)
#endif
#ifdef HAVE_NTGUI
#define FRAME_WINDOW_P(f) FRAME_W32_P (f)
#endif
#ifdef MAC_OS
#define FRAME_WINDOW_P(f) FRAME_MAC_P (f)
#endif
#ifndef FRAME_WINDOW_P
#define FRAME_WINDOW_P(f) (0)
#endif

576 577 578
/* Return true if the display is not suspended. */
#define DISPLAY_ACTIVE_P(d) ((d)->type != output_termcap || (d)->display_info.tty->input)

579 580 581
extern struct display *create_display P_ ((void));
extern void delete_display P_ ((struct display *));

582 583 584
/* The initial display device, created by initial_term_init. */
extern struct display *initial_display;

Miles Bader's avatar
Miles Bader committed
585 586
/* arch-tag: 33a00ecc-52b5-4186-a410-8801ac9f087d
   (do not change this comment) */