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