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 \f
  29 /* Text display hooks.  */
  30
  31 extern int (*cursor_to_hook) ();
  32 extern int (*raw_cursor_to_hook) ();
  33
  34 extern int (*clear_to_end_hook) ();
  35 extern int (*clear_frame_hook) ();
  36 extern int (*clear_end_of_line_hook) ();
  37
  38 extern int (*ins_del_lines_hook) ();
  39
  40 extern int (*change_line_highlight_hook) ();
  41 extern int (*reassert_line_highlight_hook) ();
  42
  43 extern int (*insert_glyphs_hook) ();
  44 extern int (*write_glyphs_hook) ();
  45 extern int (*delete_glyphs_hook) ();
  46
  47 extern int (*ring_bell_hook) ();
  48
  49 extern int (*reset_terminal_modes_hook) ();
  50 extern int (*set_terminal_modes_hook) ();
  51 extern int (*update_begin_hook) ();
  52 extern int (*update_end_hook) ();
  53 extern int (*set_terminal_window_hook) ();
  54
  55
  56 \f
  57 /* Multi-frame and mouse support hooks.  */
  58
  59 enum scroll_bar_part {
  60   scroll_bar_above_handle,
  61   scroll_bar_handle,
  62   scroll_bar_below_handle
  63 };
  64
  65 /* Return the current position of the mouse.
  66
  67    Set *f to the frame the mouse is in, or zero if the mouse is in no
  68    Emacs frame.  If it is set to zero, all the other arguments are
  69    garbage.
  70
  71    If the motion started in a scroll bar, set *bar_window to the
  72    scroll bar's window, *part to the part the mouse is currently over,
  73    *x to the position of the mouse along the scroll bar, and *y to the
  74    overall length of the scroll bar.
  75
  76    Otherwise, set *bar_window to Qnil, and *x and *y to the column and
  77    row of the character cell the mouse is over.
  78
  79    Set *time to the time the mouse was at the returned position.
  80
  81    This should clear mouse_moved until the next motion
  82    event arrives.  */
  83 extern void (*mouse_position_hook) ( /* FRAME_PTR *f,
  84                                         Lisp_Object *bar_window,
  85                                         enum scroll_bar_part *part,
  86                                         Lisp_Object *x,
  87                                         Lisp_Object *y,
  88                                         unsigned long *time */ );
  89
  90 /* The window system handling code should set this if the mouse has
  91    moved since the last call to the mouse_position_hook.  Calling that
  92    hook should clear this.  */
  93 extern int mouse_moved;
  94
  95 /* When a frame's focus redirection is changed, this hook tells the
  96    window system code to re-decide where to put the highlight.  Under
  97    X, this means that Emacs lies about where the focus is.  */
  98 extern void (*frame_rehighlight_hook) ( /* void */ );
  99
 100 /* If we're displaying frames using a window system that can stack
 101    frames on top of each other, this hook allows you to bring a frame
 102    to the front, or bury it behind all the other windows.  If this
 103    hook is zero, that means the device we're displaying on doesn't
 104    support overlapping frames, so there's no need to raise or lower
 105    anything.
 106
 107    If RAISE is non-zero, F is brought to the front, before all other
 108    windows.  If RAISE is zero, F is sent to the back, behind all other
 109    windows.  */
 110 extern void (*frame_raise_lower_hook) ( /* FRAME_PTR f, int raise */ );
 111
 112 \f
 113 /* Scroll bar hooks.  */
 114
 115 /* The representation of scroll bars is determined by the code which
 116    implements them, except for one thing: they must be represented by
 117    lisp objects.  This allows us to place references to them in
 118    Lisp_Windows without worrying about those references becoming
 119    dangling references when the scroll bar is destroyed.
 120
 121    The window-system-independent portion of Emacs just refers to
 122    scroll bars via their windows, and never looks inside the scroll bar
 123    representation; it always uses hook functions to do all the
 124    scroll bar manipulation it needs.
 125
 126    The `vertical_scroll_bar' field of a Lisp_Window refers to that
 127    window's scroll bar, or is nil if the window doesn't have a
 128    scroll bar.
 129
 130    The `scroll_bars' and `condemned_scroll_bars' fields of a Lisp_Frame
 131    are free for use by the scroll bar implementation in any way it sees
 132    fit.  They are marked by the garbage collector.  */
 133
 134
 135 /* Set the vertical scroll bar for WINDOW to have its upper left corner
 136    at (TOP, LEFT), and be LENGTH rows high.  Set its handle to
 137    indicate that we are displaying PORTION characters out of a total
 138    of WHOLE characters, starting at POSITION.  If WINDOW doesn't yet
 139    have a scroll bar, create one for it.  */
 140 extern void (*set_vertical_scroll_bar_hook)
 141             ( /* struct window *window,
 142                  int portion, int whole, int position */ );
 143
 144
 145 /* The following three hooks are used when we're doing a thorough
 146    redisplay of the frame.  We don't explicitly know which scroll bars
 147    are going to be deleted, because keeping track of when windows go
 148    away is a real pain - can you say set-window-configuration?
 149    Instead, we just assert at the beginning of redisplay that *all*
 150    scroll bars are to be removed, and then save scroll bars from the
 151    fiery pit when we actually redisplay their window.  */
 152
 153 /* Arrange for all scroll bars on FRAME to be removed at the next call
 154    to `*judge_scroll_bars_hook'.  A scroll bar may be spared if
 155    `*redeem_scroll_bar_hook' is applied to its window before the judgement.
 156
 157    This should be applied to each frame each time its window tree is
 158    redisplayed, even if it is not displaying scroll bars at the moment;
 159    if the HAS_SCROLL_BARS flag has just been turned off, only calling
 160    this and the judge_scroll_bars_hook will get rid of them.
 161
 162    If non-zero, this hook should be safe to apply to any frame,
 163    whether or not it can support scroll bars, and whether or not it is
 164    currently displaying them.  */
 165 extern void (*condemn_scroll_bars_hook)( /* FRAME_PTR *frame */ );
 166
 167 /* Unmark WINDOW's scroll bar for deletion in this judgement cycle.
 168    Note that it's okay to redeem a scroll bar that is not condemned.  */
 169 extern void (*redeem_scroll_bar_hook)( /* struct window *window */ );
 170
 171 /* Remove all scroll bars on FRAME that haven't been saved since the
 172    last call to `*condemn_scroll_bars_hook'.
 173
 174    This should be applied to each frame after each time its window
 175    tree is redisplayed, even if it is not displaying scroll bars at the
 176    moment; if the HAS_SCROLL_BARS flag has just been turned off, only
 177    calling this and condemn_scroll_bars_hook will get rid of them.
 178
 179    If non-zero, this hook should be safe to apply to any frame,
 180    whether or not it can support scroll bars, and whether or not it is
 181    currently displaying them.  */
 182 extern void (*judge_scroll_bars_hook)( /* FRAME_PTR *FRAME */ );
 183
 184 \f
 185 /* Input queue declarations and hooks.  */
 186
 187 /* Called to read input events.  */
 188 extern int (*read_socket_hook) ();
 189
 190 /* Called when a frame's display becomes entirely up to date.  */
 191 extern int (*frame_up_to_date_hook) ();
 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   scroll_bar_click,             /* .code gives the number of the mouse button
 236                                    that was clicked.
 237                                    .modifiers holds the state of the modifier
 238                                    keys.
 239                                    .part is a lisp symbol indicating which
 240                                    part of the scroll bar got clicked.
 241                                    .x gives the distance from the start of the
 242                                    scroll bar of the click; .y gives the total
 243                                    length of the scroll bar.
 244                                    .frame_or_window gives the window
 245                                    whose scroll bar was clicked in.
 246                                    .timestamp gives a timestamp (in
 247                                    milliseconds) for the click.  */
 248   selection_request_event,      /* Another X client wants a selection from us.
 249                                    See `struct selection_event'.  */
 250   selection_clear_event,        /* Another X client cleared our selection.  */
 251   buffer_switch_event,          /* A process filter has switched buffers.  */
 252   delete_window_event,          /* An X client said "delete this window".  */
 253   menu_bar_event,               /* An event generated by the menu bar.
 254                                    The frame_or_window field's cdr holds the
 255                                    Lisp-level event value.
 256                                    (Only the toolkit version uses these.)  */
 257   iconify_event,                /* An X client iconified this window.  */
 258   deiconify_event,              /* An X client deiconified this window.  */
 259   menu_bar_activate_event       /* A button press in the menu bar
 260                                    (toolkit version only).  */
 261 };
 262
 263 /* If a struct input_event has a kind which is selection_request_event
 264    or selection_clear_event, then its contents are really described
 265    by `struct selection_event'; see xterm.h.  */
 266
 267 /* The keyboard input buffer is an array of these structures.  Each one
 268    represents some sort of input event - a keystroke, a mouse click, or
 269    a window system event.  These get turned into their lispy forms when
 270    they are removed from the event queue.  */
 271
 272 struct input_event
 273 {
 274
 275   /* What kind of event was this?  */
 276   int kind;
 277
 278   /* For an ascii_keystroke, this is the character.
 279      For a non_ascii_keystroke, this is the keysym code.
 280      For a mouse event, this is the button number.  */
 281   int code;
 282   enum scroll_bar_part part;
 283
 284   int modifiers;                /* See enum below for interpretation.  */
 285
 286   Lisp_Object x, y;
 287   unsigned long timestamp;
 288
 289   /* This is padding just to put the frame_or_window field
 290      past the size of struct selection_event.  */
 291   int *padding[2];
 292
 293   /* This field is copied into a vector while the event is in the queue,
 294      so that garbage collections won't kill it.  */
 295   /* In a menu_bar_event, this is a cons cell whose car is the frame
 296      and whose cdr is the Lisp object that is the event's value.  */
 297   /* This field is last so that struct selection_input_event
 298      does not overlap with it.  */
 299   Lisp_Object frame_or_window;
 300 };
 301 \f
 302 /* This is used in keyboard.c, to tell how many buttons we will need
 303    to track the positions of.  */
 304 #define NUM_MOUSE_BUTTONS (5)
 305
 306 /* Bits in the modifiers member of the input_event structure.
 307    Note that reorder_modifiers assumes that the bits are in canonical
 308    order.
 309
 310    The modifiers applied to mouse clicks are rather ornate.  The
 311    window-system-specific code should store mouse clicks with
 312    up_modifier or down_modifier set.  Having an explicit down modifier
 313    simplifies some of window-system-independent code; without it, the
 314    code would have to recognize down events by checking if the event
 315    is a mouse click lacking the click and drag modifiers.
 316
 317    The window-system independent code turns all up_modifier events
 318    bits into drag_modifier, click_modifier, double_modifier, or
 319    triple_modifier events.  The click_modifier has no written
 320    representation in the names of the symbols used as event heads,
 321    but it does appear in the Qevent_symbol_components property of the
 322    event heads.  */
 323 enum {
 324   up_modifier   =   1,          /* Only used on mouse buttons - always
 325                                    turned into a click or a drag modifier
 326                                    before lisp code sees the event.  */
 327   down_modifier =   2,          /* Only used on mouse buttons.  */
 328   drag_modifier =   4,          /* This is never used in the event
 329                                    queue; it's only used internally by
 330                                    the window-system-independent code.  */
 331   click_modifier=   8,          /* See drag_modifier.  */
 332   double_modifier= 16,          /* See drag_modifier.  */
 333   triple_modifier= 32,          /* See drag_modifier.  */
 334
 335   /* The next four modifier bits are used also in keyboard events at
 336      the Lisp level.
 337
 338      It's probably not the greatest idea to use the 2^23 bit for any
 339      modifier.  It may or may not be the sign bit, depending on
 340      VALBITS, so using it to represent a modifier key means that
 341      characters thus modified have different integer equivalents
 342      depending on the architecture they're running on.  Oh, and
 343      applying XINT to a character whose 2^23 bit is set sign-extends
 344      it, so you get a bunch of bits in the mask you didn't want.
 345
 346      The CHAR_ macros are defined in lisp.h.  */
 347   alt_modifier  =  CHAR_ALT,    /* Under X, the XK_Alt_[LR] keysyms.  */
 348   super_modifier=  CHAR_SUPER,  /* Under X, the XK_Super_[LR] keysyms.  */
 349   hyper_modifier=  CHAR_HYPER,  /* Under X, the XK_Hyper_[LR] keysyms.  */
 350   shift_modifier=  CHAR_SHIFT,
 351   ctrl_modifier =  CHAR_CTL,
 352   meta_modifier =  CHAR_META    /* Under X, the XK_Meta_[LR] keysyms.  */
 353 };
 354
 355 #endif