src/termhooks.h

   1 /* Hooks by which low level terminal operations
   2    can be made to call other routines.
   3    Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs; see the file COPYING.  If not, write to
  19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22 \f
  23 /* Miscellanea.   */
  24
  25 /* If nonzero, send all terminal output characters to this stream also.  */
  26 extern FILE *termscript;
  27
  28 /* Only use prototypes when lisp.h has been included.  */
  29 #ifndef P_
  30 #define P_(X) ()
  31 #endif
  32 \f
  33 /* Text display hooks.  */
  34
  35 extern void (*cursor_to_hook) P_ ((int, int));
  36 extern void (*raw_cursor_to_hook) P_ ((int, int));
  37
  38 extern void (*clear_to_end_hook) P_ ((void));
  39 extern void (*clear_frame_hook) P_ ((void));
  40 extern void (*clear_end_of_line_hook) P_ ((int));
  41
  42 extern void (*ins_del_lines_hook) P_ ((int, int));
  43
  44 extern void (*change_line_highlight_hook) P_ ((int, int, int));
  45 extern void (*reassert_line_highlight_hook) P_ ((int, int));
  46
  47 extern void (*insert_glyphs_hook) P_ ((GLYPH *, int));
  48 extern void (*write_glyphs_hook) P_ ((GLYPH *, int));
  49 extern void (*delete_glyphs_hook) P_ ((int));
  50
  51 extern void (*ring_bell_hook) P_ ((void));
  52
  53 extern void (*reset_terminal_modes_hook) P_ ((void));
  54 extern void (*set_terminal_modes_hook) P_ ((void));
  55 extern void (*update_begin_hook) P_ ((struct frame *));
  56 extern void (*update_end_hook) P_ ((struct frame *));
  57 extern void (*set_terminal_window_hook) P_ ((int));
  58
  59
  60 \f
  61 /* Multi-frame and mouse support hooks.  */
  62
  63 enum scroll_bar_part {
  64   scroll_bar_above_handle,
  65   scroll_bar_handle,
  66   scroll_bar_below_handle,
  67   scroll_bar_up_arrow,
  68   scroll_bar_down_arrow
  69 };
  70
  71 /* Return the current position of the mouse.
  72
  73    Set *f to the frame the mouse is in, or zero if the mouse is in no
  74    Emacs frame.  If it is set to zero, all the other arguments are
  75    garbage.
  76
  77    If the motion started in a scroll bar, set *bar_window to the
  78    scroll bar's window, *part to the part the mouse is currently over,
  79    *x to the position of the mouse along the scroll bar, and *y to the
  80    overall length of the scroll bar.
  81
  82    Otherwise, set *bar_window to Qnil, and *x and *y to the column and
  83    row of the character cell the mouse is over.
  84
  85    Set *time to the time the mouse was at the returned position.
  86
  87    This should clear mouse_moved until the next motion
  88    event arrives.  */
  89 extern void (*mouse_position_hook) P_ ((struct frame **f, int,
  90                                         Lisp_Object *bar_window,
  91                                         enum scroll_bar_part *part,
  92                                         Lisp_Object *x,
  93                                         Lisp_Object *y,
  94                                         unsigned long *time));
  95
  96 /* The window system handling code should set this if the mouse has
  97    moved since the last call to the mouse_position_hook.  Calling that
  98    hook should clear this.  */
  99 extern int mouse_moved;
 100
 101 /* When a frame's focus redirection is changed, this hook tells the
 102    window system code to re-decide where to put the highlight.  Under
 103    X, this means that Emacs lies about where the focus is.  */
 104 extern void (*frame_rehighlight_hook) P_ ((struct frame *));
 105
 106 /* If we're displaying frames using a window system that can stack
 107    frames on top of each other, this hook allows you to bring a frame
 108    to the front, or bury it behind all the other windows.  If this
 109    hook is zero, that means the device we're displaying on doesn't
 110    support overlapping frames, so there's no need to raise or lower
 111    anything.
 112
 113    If RAISE is non-zero, F is brought to the front, before all other
 114    windows.  If RAISE is zero, F is sent to the back, behind all other
 115    windows.  */
 116 extern void (*frame_raise_lower_hook) P_ ((struct frame *f, int raise));
 117
 118 \f
 119 /* Scroll bar hooks.  */
 120
 121 /* The representation of scroll bars is determined by the code which
 122    implements them, except for one thing: they must be represented by
 123    lisp objects.  This allows us to place references to them in
 124    Lisp_Windows without worrying about those references becoming
 125    dangling references when the scroll bar is destroyed.
 126
 127    The window-system-independent portion of Emacs just refers to
 128    scroll bars via their windows, and never looks inside the scroll bar
 129    representation; it always uses hook functions to do all the
 130    scroll bar manipulation it needs.
 131
 132    The `vertical_scroll_bar' field of a Lisp_Window refers to that
 133    window's scroll bar, or is nil if the window doesn't have a
 134    scroll bar.
 135
 136    The `scroll_bars' and `condemned_scroll_bars' fields of a Lisp_Frame
 137    are free for use by the scroll bar implementation in any way it sees
 138    fit.  They are marked by the garbage collector.  */
 139
 140
 141 /* Set the vertical scroll bar for WINDOW to have its upper left corner
 142    at (TOP, LEFT), and be LENGTH rows high.  Set its handle to
 143    indicate that we are displaying PORTION characters out of a total
 144    of WHOLE characters, starting at POSITION.  If WINDOW doesn't yet
 145    have a scroll bar, create one for it.  */
 146 extern void (*set_vertical_scroll_bar_hook)
 147             P_ ((struct window *window,
 148                  int portion, int whole, int position));
 149
 150
 151 /* The following three hooks are used when we're doing a thorough
 152    redisplay of the frame.  We don't explicitly know which scroll bars
 153    are going to be deleted, because keeping track of when windows go
 154    away is a real pain - can you say set-window-configuration?
 155    Instead, we just assert at the beginning of redisplay that *all*
 156    scroll bars are to be removed, and then save scroll bars from the
 157    fiery pit when we actually redisplay their window.  */
 158
 159 /* Arrange for all scroll bars on FRAME to be removed at the next call
 160    to `*judge_scroll_bars_hook'.  A scroll bar may be spared if
 161    `*redeem_scroll_bar_hook' is applied to its window before the judgement.
 162
 163    This should be applied to each frame each time its window tree is
 164    redisplayed, even if it is not displaying scroll bars at the moment;
 165    if the HAS_SCROLL_BARS flag has just been turned off, only calling
 166    this and the judge_scroll_bars_hook will get rid of them.
 167
 168    If non-zero, this hook should be safe to apply to any frame,
 169    whether or not it can support scroll bars, and whether or not it is
 170    currently displaying them.  */
 171 extern void (*condemn_scroll_bars_hook) P_ ((struct frame *frame));
 172
 173 /* Unmark WINDOW's scroll bar for deletion in this judgement cycle.
 174    Note that it's okay to redeem a scroll bar that is not condemned.  */
 175 extern void (*redeem_scroll_bar_hook) P_ ((struct window *window));
 176
 177 /* Remove all scroll bars on FRAME that haven't been saved since the
 178    last call to `*condemn_scroll_bars_hook'.
 179
 180    This should be applied to each frame after each time its window
 181    tree is redisplayed, even if it is not displaying scroll bars at the
 182    moment; if the HAS_SCROLL_BARS flag has just been turned off, only
 183    calling this and condemn_scroll_bars_hook will get rid of them.
 184
 185    If non-zero, this hook should be safe to apply to any frame,
 186    whether or not it can support scroll bars, and whether or not it is
 187    currently displaying them.  */
 188 extern void (*judge_scroll_bars_hook) P_ ((struct frame *FRAME));
 189
 190 \f
 191 /* Input queue declarations and hooks.  */
 192
 193 /* Expedient hack: only provide the below definitions to files that
 194    are prepared to handle lispy things.  CONSP is defined iff lisp.h
 195    has been included before this file.  */
 196 #ifdef CONSP
 197
 198 enum event_kind
 199 {
 200   no_event,                     /* nothing happened.  This should never
 201                                    actually appear in the event queue.  */
 202
 203   ascii_keystroke,              /* The ASCII code is in .code, perhaps
 204                                    with modifiers applied.
 205                                    .modifiers holds the state of the
 206                                    modifier keys.
 207                                    .frame_or_window is the frame in
 208                                    which the key was typed.
 209                                    .timestamp gives a timestamp (in
 210                                    milliseconds) for the keystroke.  */
 211   non_ascii_keystroke,          /* .code is a number identifying the
 212                                    function key.  A code N represents
 213                                    a key whose name is
 214                                    function_key_names[N]; function_key_names
 215                                    is a table in keyboard.c to which you
 216                                    should feel free to add missing keys.
 217                                    .modifiers holds the state of the
 218                                    modifier keys.
 219                                    .frame_or_window is the frame in
 220                                    which the key was typed.
 221                                    .timestamp gives a timestamp (in
 222                                    milliseconds) for the keystroke.  */
 223   timer_event,                  /* A timer fired.  */
 224   mouse_click,                  /* The button number is in .code; it must
 225                                    be >= 0 and < NUM_MOUSE_BUTTONS, defined
 226                                    below.
 227                                    .modifiers holds the state of the
 228                                    modifier keys.
 229                                    .x and .y give the mouse position,
 230                                    in characters, within the window.
 231                                    .frame_or_window gives the frame
 232                                    the mouse click occurred in.
 233                                    .timestamp gives a timestamp (in
 234                                    milliseconds) for the click.  */
 235 #ifdef WINDOWSNT
 236   mouse_wheel,                  /* A mouse-wheel event is generated
 237                                    on WINDOWSNT by a
 238                                    wheel on a mouse (e.g., MS Intellimouse).
 239                                    The event contains a delta that corresponds
 240                                    to the amount and direction that the wheel
 241                                    is rotated.  This delta is typically
 242                                    used to implement a scroll or zoom.
 243                                    .code gives the delta.
 244                                    .modifiers holds the state of the
 245                                    modifier keys.
 246                                    .x and .y give the mouse position,
 247                                    in characters, within the window.
 248                                    .frame_or_window gives the frame
 249                                    the wheel event occurred in.
 250                                    .timestamp gives a timestamp (in
 251                                    milliseconds) for the wheel event.  */
 252 #endif
 253   scroll_bar_click,             /* .code gives the number of the mouse button
 254                                    that was clicked.
 255                                    .modifiers holds the state of the modifier
 256                                    keys.
 257                                    .part is a lisp symbol indicating which
 258                                    part of the scroll bar got clicked.
 259                                    .x gives the distance from the start of the
 260                                    scroll bar of the click; .y gives the total
 261                                    length of the scroll bar.
 262                                    .frame_or_window gives the window
 263                                    whose scroll bar was clicked in.
 264                                    .timestamp gives a timestamp (in
 265                                    milliseconds) for the click.  */
 266 #ifdef WINDOWSNT
 267   w32_scroll_bar_click, /* as for scroll_bar_click, but only generated
 268                                    by MS-Windows scroll bar controls. */
 269 #endif
 270   selection_request_event,      /* Another X client wants a selection from us.
 271                                    See `struct selection_event'.  */
 272   selection_clear_event,        /* Another X client cleared our selection.  */
 273   buffer_switch_event,          /* A process filter has switched buffers.  */
 274   delete_window_event,          /* An X client said "delete this window".  */
 275   menu_bar_event,               /* An event generated by the menu bar.
 276                                    The frame_or_window field's cdr holds the
 277                                    Lisp-level event value.
 278                                    (Only the toolkit version uses these.)  */
 279   iconify_event,                /* An X client iconified this window.  */
 280   deiconify_event,              /* An X client deiconified this window.  */
 281   menu_bar_activate_event,       /* A button press in the menu bar
 282                                    (toolkit version only).  */
 283   drag_n_drop                   /* A drag-n-drop event is generated when
 284                                    files selected outside of Emacs are dropped
 285                                    onto an Emacs window.
 286                                    Currently used only on Windows NT.
 287                                    .modifiers holds the state of the
 288                                    modifier keys.
 289                                    .x and .y give the mouse position,
 290                                    in characters, within the window.
 291                                    .frame_or_window is a cons of the frame
 292                                    in which the drop was made and a list of
 293                                    the filenames of the dropped files.
 294                                    .timestamp gives a timestamp (in
 295                                    milliseconds) for the click.  */
 296 };
 297
 298 /* If a struct input_event has a kind which is selection_request_event
 299    or selection_clear_event, then its contents are really described
 300    by `struct selection_event'; see xterm.h.  */
 301
 302 /* The keyboard input buffer is an array of these structures.  Each one
 303    represents some sort of input event - a keystroke, a mouse click, or
 304    a window system event.  These get turned into their lispy forms when
 305    they are removed from the event queue.  */
 306
 307 struct input_event
 308 {
 309
 310   /* What kind of event was this?  */
 311   int kind;
 312
 313   /* For an ascii_keystroke, this is the character.
 314      For a non_ascii_keystroke, this is the keysym code.
 315      For a mouse event, this is the button number.  */
 316   /* In WindowsNT, for a mouse wheel event, this is the delta.  */
 317   int code;
 318   enum scroll_bar_part part;
 319
 320   int modifiers;                /* See enum below for interpretation.  */
 321
 322   Lisp_Object x, y;
 323   unsigned long timestamp;
 324
 325   /* This is padding just to put the frame_or_window field
 326      past the size of struct selection_event.  */
 327   int *padding[2];
 328
 329   /* This field is copied into a vector while the event is in the queue,
 330      so that garbage collections won't kill it.  */
 331   /* In a menu_bar_event, this is a cons cell whose car is the frame
 332      and whose cdr is the Lisp object that is the event's value.  */
 333   /* This field is last so that struct selection_input_event
 334      does not overlap with it.  */
 335   Lisp_Object frame_or_window;
 336 };
 337
 338 /* Called to read input events.  */
 339 extern int (*read_socket_hook) P_ ((int, struct input_event *, int, int));
 340
 341 /* Called when a frame's display becomes entirely up to date.  */
 342 extern void (*frame_up_to_date_hook) P_ ((struct frame *));
 343 \f
 344 /* This is used in keyboard.c, to tell how many buttons we will need
 345    to track the positions of.  */
 346 #define NUM_MOUSE_BUTTONS (5)
 347
 348 /* Bits in the modifiers member of the input_event structure.
 349    Note that reorder_modifiers assumes that the bits are in canonical
 350    order.
 351
 352    The modifiers applied to mouse clicks are rather ornate.  The
 353    window-system-specific code should store mouse clicks with
 354    up_modifier or down_modifier set.  Having an explicit down modifier
 355    simplifies some of window-system-independent code; without it, the
 356    code would have to recognize down events by checking if the event
 357    is a mouse click lacking the click and drag modifiers.
 358
 359    The window-system independent code turns all up_modifier events
 360    bits into drag_modifier, click_modifier, double_modifier, or
 361    triple_modifier events.  The click_modifier has no written
 362    representation in the names of the symbols used as event heads,
 363    but it does appear in the Qevent_symbol_components property of the
 364    event heads.  */
 365 enum {
 366   up_modifier   =   1,          /* Only used on mouse buttons - always
 367                                    turned into a click or a drag modifier
 368                                    before lisp code sees the event.  */
 369   down_modifier =   2,          /* Only used on mouse buttons.  */
 370   drag_modifier =   4,          /* This is never used in the event
 371                                    queue; it's only used internally by
 372                                    the window-system-independent code.  */
 373   click_modifier=   8,          /* See drag_modifier.  */
 374   double_modifier= 16,          /* See drag_modifier.  */
 375   triple_modifier= 32,          /* See drag_modifier.  */
 376
 377   /* The next four modifier bits are used also in keyboard events at
 378      the Lisp level.
 379
 380      It's probably not the greatest idea to use the 2^23 bit for any
 381      modifier.  It may or may not be the sign bit, depending on
 382      VALBITS, so using it to represent a modifier key means that
 383      characters thus modified have different integer equivalents
 384      depending on the architecture they're running on.  Oh, and
 385      applying XINT to a character whose 2^23 bit is set sign-extends
 386      it, so you get a bunch of bits in the mask you didn't want.
 387
 388      The CHAR_ macros are defined in lisp.h.  */
 389   alt_modifier  =  CHAR_ALT,    /* Under X, the XK_Alt_[LR] keysyms.  */
 390   super_modifier=  CHAR_SUPER,  /* Under X, the XK_Super_[LR] keysyms.  */
 391   hyper_modifier=  CHAR_HYPER,  /* Under X, the XK_Hyper_[LR] keysyms.  */
 392   shift_modifier=  CHAR_SHIFT,
 393   ctrl_modifier =  CHAR_CTL,
 394   meta_modifier =  CHAR_META    /* Under X, the XK_Meta_[LR] keysyms.  */
 395 };
 396
 397 #endif