src/termhooks.h

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