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