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