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