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

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1986, 1993-1994, 2001-2018 Free Software Foundation,
4
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 <https://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

Joakim Verona's avatar
Joakim Verona committed
21 22 23
#ifndef EMACS_TERMHOOKS_H
#define EMACS_TERMHOOKS_H

24 25
/* Miscellanea.   */

26
#include "lisp.h"
27 28
#include "systime.h" /* for Time */

29 30
struct glyph;

Paul Eggert's avatar
Paul Eggert committed
31 32
INLINE_HEADER_BEGIN

33
enum scroll_bar_part {
34
  scroll_bar_nowhere,
35 36
  scroll_bar_above_handle,
  scroll_bar_handle,
37 38
  scroll_bar_below_handle,
  scroll_bar_up_arrow,
Gerd Moellmann's avatar
Gerd Moellmann committed
39 40 41
  scroll_bar_down_arrow,
  scroll_bar_to_top,
  scroll_bar_to_bottom,
42
  scroll_bar_end_scroll,
43 44 45 46 47 48 49 50
  scroll_bar_move_ratio,
  scroll_bar_before_handle,
  scroll_bar_horizontal_handle,
  scroll_bar_after_handle,
  scroll_bar_left_arrow,
  scroll_bar_right_arrow,
  scroll_bar_to_leftmost,
  scroll_bar_to_rightmost
51 52
};

Joakim Verona's avatar
Joakim Verona committed
53 54 55 56 57 58 59 60 61 62 63 64
/* Output method of a terminal (and frames on this terminal, respectively).  */

enum output_method
{
  output_initial,
  output_termcap,
  output_x_window,
  output_msdos_raw,
  output_w32,
  output_ns
};

65
/* Input queue declarations and hooks.  */
66

67 68
enum event_kind
{
Pavel Janík's avatar
Pavel Janík committed
69
  NO_EVENT,			/* nothing happened.  This should never
Jim Blandy's avatar
Jim Blandy committed
70
				   actually appear in the event queue.  */
Jim Blandy's avatar
Jim Blandy committed
71

Pavel Janík's avatar
Pavel Janík committed
72
  ASCII_KEYSTROKE_EVENT,	/* The ASCII code is in .code, perhaps
Jim Blandy's avatar
Jim Blandy committed
73 74 75
				   with modifiers applied.
				   .modifiers holds the state of the
				   modifier keys.
76 77
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
78 79
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
Pavel Janík's avatar
Pavel Janík committed
80
  MULTIBYTE_CHAR_KEYSTROKE_EVENT,	/* The multibyte char code is in .code,
81 82
				   perhaps with modifiers applied.
				   The others are the same as
Dave Love's avatar
Dave Love committed
83
				   ASCII_KEYSTROKE_EVENT.  */
Pavel Janík's avatar
Pavel Janík committed
84
  NON_ASCII_KEYSTROKE_EVENT,	/* .code is a number identifying the
Jim Blandy's avatar
Jim Blandy committed
85 86 87 88 89 90
				   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
91
				   modifier keys.
92 93
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
94 95
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
Pavel Janík's avatar
Pavel Janík committed
96 97
  TIMER_EVENT,                  /* A timer fired.  */
  MOUSE_CLICK_EVENT,		/* The button number is in .code; it must
98 99
				   be >= 0 and < NUM_MOUSE_BUTTONS, defined
				   below.
Jim Blandy's avatar
Jim Blandy committed
100 101 102
				   .modifiers holds the state of the
				   modifier keys.
				   .x and .y give the mouse position,
Jim Blandy's avatar
Jim Blandy committed
103
				   in characters, within the window.
104 105
				   .frame_or_window gives the frame
				   the mouse click occurred in.
Jim Blandy's avatar
Jim Blandy committed
106 107
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
108 109 110 111 112 113 114 115 116 117 118
  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
119 120 121
				   milliseconds) for the event.
                                   .arg may contain the number of
                                   lines to scroll.  */
122 123 124
  HORIZ_WHEEL_EVENT,            /* A wheel event generated by a second
                                   horizontal wheel that is present on some
                                   mice. See WHEEL_EVENT.  */
125
#ifdef HAVE_NTGUI
126
  LANGUAGE_CHANGE_EVENT,	/* A LANGUAGE_CHANGE_EVENT is
Daniel Colascione's avatar
Daniel Colascione committed
127
				   generated when HAVE_NTGUI or on Mac OS
128 129
				   when the keyboard layout or input
				   language is changed by the
130
				   user.  */
131
#endif
Pavel Janík's avatar
Pavel Janík committed
132
  SCROLL_BAR_CLICK_EVENT,	/* .code gives the number of the mouse button
133 134 135
				   that was clicked.
				   .modifiers holds the state of the modifier
				   keys.
Jim Blandy's avatar
Jim Blandy committed
136
				   .part is a lisp symbol indicating which
137
				   part of the scroll bar got clicked.
138 139 140
				   .x gives the distance from the start of the
				   scroll bar of the click; .y gives the total
				   length of the scroll bar.
141
				   .frame_or_window gives the window
142
				   whose scroll bar was clicked in.
Jim Blandy's avatar
Jim Blandy committed
143 144
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
145 146 147 148 149 150 151 152 153 154 155 156 157
  HORIZONTAL_SCROLL_BAR_CLICK_EVENT,	/* .code gives the number of the mouse button
				   that was clicked.
				   .modifiers holds the state of the modifier
				   keys.
				   .part is a lisp symbol indicating which
				   part of the scroll bar got clicked.
				   .x gives the distance from the start of the
				   scroll bar of the click; .y gives the total
				   length of the scroll bar.
				   .frame_or_window gives the window
				   whose scroll bar was clicked in.
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
Pavel Janík's avatar
Pavel Janík committed
158
  SELECTION_REQUEST_EVENT,	/* Another X client wants a selection from us.
159
				   See `struct selection_input_event'.  */
Pavel Janík's avatar
Pavel Janík committed
160 161 162
  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".  */
163 164 165
#ifdef HAVE_NTGUI
  END_SESSION_EVENT,		/* The user is logging out or shutting down.  */
#endif
166
  MENU_BAR_EVENT,		/* An event generated by the menu bar.
167
				   The frame_or_window field's cdr holds the
168 169
				   Lisp-level event value.
				   (Only the toolkit version uses these.)  */
Pavel Janík's avatar
Pavel Janík committed
170 171 172
  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
173
				   (toolkit version only).  */
Pavel Janík's avatar
Pavel Janík committed
174
  DRAG_N_DROP_EVENT,		/* A drag-n-drop event is generated when
175 176
				   files selected outside of Emacs are dropped
				   onto an Emacs window.
177
				   .modifiers holds the state of the
178 179 180
				   modifier keys.
				   .x and .y give the mouse position,
				   in characters, within the window.
181 182 183 184
				   .frame_or_window is the frame in
				   which the drop was made.
				   .arg is a platform-dependent
				   representation of the dropped items.
185 186
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
187 188
  USER_SIGNAL_EVENT,		/* A user signal.
                                   code is a number identifying it,
Gerd Moellmann's avatar
Gerd Moellmann committed
189 190
                                   index into lispy_user_signals.  */

191 192 193
  /* 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
194 195
  HELP_EVENT,

196 197 198
  /* 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.  */
199 200 201 202
  TOOL_BAR_EVENT,

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

205 206
  FOCUS_OUT_EVENT,

207 208 209
  /* Generated when a frame is moved.  */
  MOVE_FRAME_EVENT,

210 211 212
  /* Generated when mouse moves over window not currently selected.  */
  SELECT_WINDOW_EVENT,

213 214
  /* Queued from XTread_socket when session manager sends
     save yourself before shutdown. */
215
  SAVE_SESSION_EVENT
216

217
#ifdef HAVE_GPM
Miles Bader's avatar
Miles Bader committed
218
  , GPM_CLICK_EVENT
219 220
#endif

221 222 223 224
#ifdef HAVE_DBUS
  , DBUS_EVENT
#endif

225 226
  , CONFIG_CHANGED_EVENT

Daniel Colascione's avatar
Daniel Colascione committed
227
#ifdef HAVE_NTGUI
228 229 230 231 232 233 234 235 236 237 238 239
  /* 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
240
#endif
241 242 243 244 245

#ifdef HAVE_NS
  /* Generated when native multi-keystroke input method is used to modify
     tentative or indicative text display. */
  , NS_TEXT_EVENT
246 247
  /* Non-key system events (e.g. application menu events) */
  , NS_NONKEY_EVENT
248
#endif
jave's avatar
jave committed
249

250 251 252 253 254
#ifdef HAVE_XWIDGETS
  /* events generated by xwidgets*/
   , XWIDGET_EVENT
#endif

255
#ifdef USE_FILE_NOTIFY
256 257
  /* File or directory was changed.  */
  , FILE_NOTIFY_EVENT
258
#endif
259

260 261
};

262 263 264
/* Bit width of an enum event_kind tag at the start of structs and unions.  */
enum { EVENT_KIND_WIDTH = 16 };

Pavel Janík's avatar
Pavel Janík committed
265 266
/* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
   or SELECTION_CLEAR_EVENT, then its contents are really described
267
   by `struct selection_input_event'; see xterm.h.  */
268 269 270 271 272 273

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

274 275
struct input_event
{
276
  /* What kind of event was this?  */
277
  ENUM_BF (event_kind) kind : EVENT_KIND_WIDTH;
278 279 280

  /* Used in scroll back click events.  */
  ENUM_BF (scroll_bar_part) part : 16;
281

Pavel Janík's avatar
Pavel Janík committed
282 283 284
  /* 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.
285 286
     For a mouse event, this is the button number.  */
  unsigned code;
287

288 289
  /* See enum below for interpretation.  */
  unsigned modifiers;
290

291 292
  /* One would prefer C integers, but HELP_EVENT uses these to
     record frame or window object and a help form, respectively.  */
293
  Lisp_Object x, y;
294 295 296 297

  /* Usually a time as reported by window system-specific event loop.
     For a HELP_EVENT, this is the position within the object (stored
     in ARG below) where the help was found.  */
298
  Time timestamp;
299

300 301
  /* This field is copied into a vector while the event is in
     the queue, so that garbage collections won't kill it.  */
302
  Lisp_Object frame_or_window;
303

304 305 306
  /* This additional argument is used in attempt to avoid extra consing
     when building events.  Unfortunately some events have to pass much
     more data than it's reasonable to pack directly into this structure.  */
307
  Lisp_Object arg;
Jim Blandy's avatar
Jim Blandy committed
308
};
Andreas Schwab's avatar
Andreas Schwab committed
309

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

312 313
/* Bits in the modifiers member of the input_event structure.
   Note that reorder_modifiers assumes that the bits are in canonical
314
   order.
315 316 317

   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
318 319 320 321 322 323
   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
324 325 326 327 328
   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
329
enum {
330 331 332
  up_modifier	=   1,		/* Only used on mouse buttons - always
				   turned into a click or a drag modifier
				   before lisp code sees the event.  */
333 334
  down_modifier =   2,		/* Only used on mouse buttons.  */
  drag_modifier =   4,		/* This is never used in the event
335 336
				   queue; it's only used internally by
				   the window-system-independent code.  */
337
  click_modifier=   8,		/* See drag_modifier.  */
338 339
  double_modifier= 16,          /* See drag_modifier.  */
  triple_modifier= 32,          /* See drag_modifier.  */
340 341 342 343

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

Paul Eggert's avatar
Paul Eggert committed
344
     It's probably not the greatest idea to use the 2^28 bit for any
345
     modifier.  It may or may not be the sign bit, depending on
Paul Eggert's avatar
Paul Eggert committed
346
     FIXNUM_BITS, so using it to represent a modifier key means that
347 348
     characters thus modified have different integer equivalents
     depending on the architecture they're running on.  Oh, and
Paul Eggert's avatar
Paul Eggert committed
349
     applying XINT to a character whose 2^28 bit is set might sign-extend
350 351 352 353 354 355 356 357
     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,
358
  meta_modifier	=  CHAR_META	/* Under X, the XK_Meta_[LR] keysyms.  */
Jim Blandy's avatar
Jim Blandy committed
359 360
};

361
#ifdef HAVE_GPM
362
#include <gpm.h>
Miles Bader's avatar
Miles Bader committed
363
extern int handle_one_term_event (struct tty_display_info *, Gpm_Event *, struct input_event *);
364
#ifndef HAVE_WINDOW_SYSTEM
365
extern void term_mouse_moveto (int, int);
366
#endif
367

368 369
/* The device for which we have enabled gpm support.  */
extern struct tty_display_info *gpm_tty;
Miles Bader's avatar
Miles Bader committed
370 371
#endif

372 373
/* Terminal-local parameters. */
struct terminal
374
{
375
  /* This is for Lisp; the terminal code does not refer to it.  */
376
  union vectorlike_header header;
377

378 379 380
  /* Parameter alist of this terminal.  */
  Lisp_Object param_alist;

381 382 383 384 385
  /* 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
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
  /* 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;

402 403 404 405 406
  /* If a char-table, this maps characters to terminal glyph codes.
     If t, the mapping is not available.  If nil, it is not known
     whether the mapping is available.  */
  Lisp_Object glyph_code_table;

407 408
  /* All fields before `next_terminal' should be Lisp_Object and are traced
     by the GC.  All fields afterwards are ignored by the GC.  */
409

410 411
  /* Chain of all terminal devices. */
  struct terminal *next_terminal;
412

413
  /* Unique id for this terminal device. */
414 415
  int id;

416
  /* The number of frames that are on this terminal. */
417
  int reference_count;
418

419
  /* The type of the terminal device. */
420 421
  enum output_method type;

422 423 424
  /* The name of the terminal device.  Do not use this to uniquely
     identify a terminal; the same device may be opened multiple
     times. */
425 426
  char *name;

427
  /* The terminal's keyboard object. */
428 429
  struct kboard *kboard;

430 431 432 433 434
#ifdef HAVE_WINDOW_SYSTEM
  /* Cache of images.  */
  struct image_cache *image_cache;
#endif /* HAVE_WINDOW_SYSTEM */

435
  /* Device-type dependent data shared amongst all frames on this terminal.  */
436 437 438 439
  union display_info
  {
    struct tty_display_info *tty;     /* termchar.h */
    struct x_display_info *x;         /* xterm.h */
440
    struct w32_display_info *w32;     /* w32term.h */
441
    struct ns_display_info *ns;       /* nsterm.h */
442 443 444
  } display_info;


445 446 447 448 449 450 451 452 453 454 455
  /* 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;

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

  /* Frame-based redisplay interface. */
461

462 463
  /* Text display hooks.  */

Jan D's avatar
Jan D committed
464 465
  void (*cursor_to_hook) (struct frame *f, int vpos, int hpos);
  void (*raw_cursor_to_hook) (struct frame *, int, int);
466

Jan D's avatar
Jan D committed
467 468 469
  void (*clear_to_end_hook) (struct frame *);
  void (*clear_frame_hook) (struct frame *);
  void (*clear_end_of_line_hook) (struct frame *, int);
470

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

Jan D's avatar
Jan D committed
473 474 475
  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);
476

Jan D's avatar
Jan D committed
477
  void (*ring_bell_hook) (struct frame *f);
Paul Eggert's avatar
Paul Eggert committed
478
  void (*toggle_invisible_pointer_hook) (struct frame *f, bool invisible);
479

Jan D's avatar
Jan D committed
480 481
  void (*reset_terminal_modes_hook) (struct terminal *);
  void (*set_terminal_modes_hook) (struct terminal *);
Karoly Lorentey's avatar
Karoly Lorentey committed
482

Jan D's avatar
Jan D committed
483 484 485
  void (*update_begin_hook) (struct frame *);
  void (*update_end_hook) (struct frame *);
  void (*set_terminal_window_hook) (struct frame *, int);
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.
494

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

503
     Set *time to the time the mouse was at the returned position.  */
Jan D's avatar
Jan D committed
504 505 506 507 508
  void (*mouse_position_hook) (struct frame **f, int,
                               Lisp_Object *bar_window,
                               enum scroll_bar_part *part,
                               Lisp_Object *x,
                               Lisp_Object *y,
509
                               Time *);
510 511 512 513

  /* 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
514
  void (*frame_rehighlight_hook) (struct frame *);
515 516 517 518

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

Paul Eggert's avatar
Paul Eggert committed
523 524
     If RAISE_FLAG, F is brought to the front, before all other
     windows.  If !RAISE_FLAG, F is sent to the back, behind all other
525
     windows.  */
Paul Eggert's avatar
Paul Eggert committed
526
  void (*frame_raise_lower_hook) (struct frame *f, bool raise_flag);
527

528
  /* If the value of the frame parameter changed, this hook is called.
529 530
     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
531
  void (*fullscreen_hook) (struct frame *f);
532

533 534 535 536
  /* This hook is called to display menus.  */
  Lisp_Object (*menu_show_hook) (struct frame *f, int x, int y, int menuflags,
				 Lisp_Object title, const char **error_name);

537 538 539 540
  /* This hook is called to display popup dialog.  */
  Lisp_Object (*popup_dialog_hook) (struct frame *f, Lisp_Object header,
				    Lisp_Object contents);

541 542 543 544 545 546 547
  /* 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.
548

549 550 551 552
     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.
553

554 555 556
     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.
557

558 559 560
     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.  */
561 562


563 564 565 566 567
  /* 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
568 569 570
  void (*set_vertical_scroll_bar_hook) (struct window *window,
                                        int portion, int whole,
                                        int position);
571 572


573 574 575 576 577 578 579 580 581 582
  /* Set the horizontal 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_horizontal_scroll_bar_hook) (struct window *window,
					  int portion, int whole,
					  int position);


583 584 585 586 587 588 589
  /* 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.  */
590

591 592
  /* 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
593
     `*redeem_scroll_bar_hook' is applied to its window before the judgment.
594

595 596 597 598
     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.
599

600 601 602
     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
603
  void (*condemn_scroll_bars_hook) (struct frame *frame);
604

Paul Eggert's avatar
Paul Eggert committed
605
  /* Unmark WINDOW's scroll bar for deletion in this judgment cycle.
606
     Note that it's okay to redeem a scroll bar that is not condemned.  */
Jan D's avatar
Jan D committed
607
  void (*redeem_scroll_bar_hook) (struct window *window);
608 609 610 611 612 613 614 615

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

617 618 619
     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
620
  void (*judge_scroll_bars_hook) (struct frame *FRAME);
621 622


623 624
  /* Called to read input events.

625
     TERMINAL indicates which terminal device to read from.  Input
626
     events should be read into HOLD_QUIT.
627

628
     A positive return value N indicates that N input events
629
     were read into BUF.
630 631
     Zero means no events were immediately available.
     A value of -1 means a transient read error, while -2 indicates
632
     that the device was closed (hangup), and it should be deleted.  */
Jan D's avatar
Jan D committed
633 634
  int (*read_socket_hook) (struct terminal *terminal,
                           struct input_event *hold_quit);
635 636

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

639 640 641 642 643
  /* Called when buffer flipping becomes unblocked after having
     previously been blocked.  Redisplay always blocks buffer flips
     while it runs.  */
  void (*buffer_flipping_unblocked_hook) (struct frame *);

644 645

  /* Called to delete the device-specific portions of a frame that is
646
     on this terminal device. */
Jan D's avatar
Jan D committed
647
  void (*delete_frame_hook) (struct frame *);
648

649
  /* Called after the last frame on this terminal is deleted, or when
650
     the display device was closed (hangup).
651

652 653
     If this is NULL, then the generic delete_terminal is called
     instead.  Otherwise the hook must call delete_terminal itself.
654

655
     The hook must check for and close any live frames that are still
656
     on the terminal.  delete_frame ensures that there are no live
657
     frames on the terminal when it calls this hook, so infinite
658
     recursion is prevented.  */
Jan D's avatar
Jan D committed
659
  void (*delete_terminal_hook) (struct terminal *);
660 661
};

662 663 664 665 666 667 668 669 670 671 672 673 674
INLINE bool
TERMINALP (Lisp_Object a)
{
  return PSEUDOVECTORP (a, PVEC_TERMINAL);
}

INLINE struct terminal *
XTERMINAL (Lisp_Object a)
{
  eassert (TERMINALP (a));
  return XUNTAG (a, Lisp_Vectorlike);
}

Paul Eggert's avatar
Paul Eggert committed
675 676
/* Most code should use these functions to set Lisp fields in struct
   terminal.  */
Paul Eggert's avatar
Paul Eggert committed
677
INLINE void
Paul Eggert's avatar
Paul Eggert committed
678 679 680 681
tset_charset_list (struct terminal *t, Lisp_Object val)
{
  t->charset_list = val;
}
Paul Eggert's avatar
Paul Eggert committed
682
INLINE void
Paul Eggert's avatar
Paul Eggert committed
683 684 685 686
tset_selection_alist (struct terminal *t, Lisp_Object val)
{
  t->Vselection_alist = val;
}
687

688
/* Chain of all terminal devices currently in use.  */
689
extern struct terminal *terminal_list;
690

691 692 693 694 695 696
#define FRAME_MUST_WRITE_SPACES(f) (FRAME_TTY (f)->must_write_spaces)
#define FRAME_LINE_INS_DEL_OK(f) (FRAME_TTY (f)->line_ins_del_ok)
#define FRAME_CHAR_INS_DEL_OK(f) (FRAME_TTY (f)->char_ins_del_ok)
#define FRAME_SCROLL_REGION_OK(f) (FRAME_TTY (f)->scroll_region_ok)
#define FRAME_SCROLL_REGION_COST(f) (FRAME_TTY (f)->scroll_region_cost)
#define FRAME_MEMORY_BELOW_FRAME(f) (FRAME_TTY (f)->memory_below_frame)
697

698 699
#define FRAME_TERMINAL_CODING(f) ((f)->terminal->terminal_coding)
#define FRAME_KEYBOARD_CODING(f) ((f)->terminal->keyboard_coding)
700

701 702
#define TERMINAL_TERMINAL_CODING(d) ((d)->terminal_coding)
#define TERMINAL_KEYBOARD_CODING(d) ((d)->keyboard_coding)
703

704
#define FRAME_RIF(f) ((f)->terminal->rif)
705

706
#define FRAME_TERMINAL(f) ((f)->terminal)
707

708 709 710 711
/* 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)
712

713 714 715 716 717 718 719 720 721 722 723 724 725
/* Return font cache data for the specified terminal.  The historical
   name is grossly misleading, actually it is (NAME . FONT-LIST-CACHE).  */
#if defined (HAVE_X_WINDOWS)
#define TERMINAL_FONT_CACHE(t)						\
  (t->type == output_x_window ? t->display_info.x->name_list_element : Qnil)
#elif defined (HAVE_NTGUI)
#define TERMINAL_FONT_CACHE(t)						\
  (t->type == output_w32 ? t->display_info.w32->name_list_element : Qnil)
#elif defined (HAVE_NS)
#define TERMINAL_FONT_CACHE(t)						\
  (t->type == output_ns ? t->display_info.ns->name_list_element : Qnil)
#endif

726 727 728
extern struct terminal *decode_live_terminal (Lisp_Object);
extern struct terminal *decode_tty_terminal (Lisp_Object);
extern struct terminal *get_named_terminal (const char *);
729 730
extern struct terminal *create_terminal (enum output_method,
					 struct redisplay_interface *);
Jan D's avatar
Jan D committed
731
extern void delete_terminal (struct terminal *);
732
extern void delete_terminal_internal (struct terminal *);
733
extern Lisp_Object terminal_glyph_code (struct terminal *, int);
734

735
/* The initial terminal device, created by initial_term_init.  */
736
extern struct terminal *initial_terminal;
737

738 739 740
extern unsigned char *encode_terminal_code (struct glyph *, int,
					    struct coding_system *);

741
#ifdef HAVE_GPM
742
extern void close_gpm (int gpm_fd);
743
#endif
Paul Eggert's avatar
Paul Eggert committed
744

745
#ifdef WINDOWSNT
Eli Zaretskii's avatar
Eli Zaretskii committed
746 747 748 749 750
extern int cursorX (struct tty_display_info *);
extern int cursorY (struct tty_display_info *);
#else
#define cursorX(t)  curX(t)
#define cursorY(t)  curY(t)
751 752
#endif

Paul Eggert's avatar
Paul Eggert committed
753
INLINE_HEADER_END
Joakim Verona's avatar
Joakim Verona committed
754 755

#endif /* EMACS_TERMHOOKS_H */