home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / e20313sr.zip / emacs / 20.3.1 / src / termhooks.h < prev    next >
C/C++ Source or Header  |  1999-07-31  |  17KB  |  409 lines
  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. /* Modified for emx by Jeremy Bowen, May 1999 based on patches
  23.    to v19.33 by Eberhard Mattes */
  24.  
  25.  
  26. /* Miscellanea.   */
  27.  
  28. /* If nonzero, send all terminal output characters to this stream also.  */
  29. extern FILE *termscript;
  30.  
  31.  
  32. /* Only use prototypes when lisp.h has been included.  */
  33. #ifndef P_
  34. #define P_(X) ()
  35. #endif
  36.  
  37. /* Text display hooks.  */
  38.  
  39. extern void (*cursor_to_hook) P_ ((int, int));
  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 (*change_line_highlight_hook) P_ ((int, int, int));
  49. extern void (*reassert_line_highlight_hook) P_ ((int, int));
  50.  
  51. extern void (*insert_glyphs_hook) P_ ((GLYPH *, int));
  52. extern void (*write_glyphs_hook) P_ ((GLYPH *, int));
  53. extern void (*delete_glyphs_hook) P_ ((int));
  54.  
  55. extern void (*ring_bell_hook) P_ ((void));
  56.  
  57. extern void (*reset_terminal_modes_hook) P_ ((void));
  58. extern void (*set_terminal_modes_hook) P_ ((void));
  59. extern void (*update_begin_hook) P_ ((struct frame *));
  60. extern void (*update_end_hook) P_ ((struct frame *));
  61. extern void (*set_terminal_window_hook) P_ ((int));
  62.  
  63.  
  64.  
  65. /* Multi-frame and mouse support hooks.  */
  66.  
  67. enum scroll_bar_part {
  68.   scroll_bar_above_handle,
  69.   scroll_bar_handle,
  70.   scroll_bar_below_handle,
  71.   scroll_bar_up_arrow,
  72.   scroll_bar_down_arrow
  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.  
  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.  
  195. /* Input queue declarations and hooks.  */
  196.  
  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,        /* 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.   non_ascii_keystroke,        /* .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,            /* 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. #ifdef WINDOWSNT
  241.   mouse_wheel,            /* A mouse-wheel event is generated 
  242.                    on WINDOWSNT by a 
  243.                    wheel on a mouse (e.g., MS Intellimouse).
  244.                    The event contains a delta that corresponds
  245.                    to the amount and direction that the wheel
  246.                    is rotated.  This delta is typically
  247.                    used to implement a scroll or zoom.
  248.                    .code gives the delta.
  249.                    .modifiers holds the state of the
  250.                    modifier keys.
  251.                    .x and .y give the mouse position,
  252.                    in characters, within the window.
  253.                    .frame_or_window gives the frame
  254.                    the wheel event occurred in.
  255.                    .timestamp gives a timestamp (in
  256.                    milliseconds) for the wheel event.  */
  257. #endif
  258.   scroll_bar_click,        /* .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,    /* 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            /* 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. };
  302.  
  303. /* If a struct input_event has a kind which is selection_request_event
  304.    or selection_clear_event, then its contents are really described
  305.    by `struct selection_event'; see xterm.h.  */
  306.  
  307. /* The keyboard input buffer is an array of these structures.  Each one
  308.    represents some sort of input event - a keystroke, a mouse click, or
  309.    a window system event.  These get turned into their lispy forms when
  310.    they are removed from the event queue.  */
  311.  
  312. struct input_event
  313. {
  314.  
  315.   /* What kind of event was this?  */
  316.   int kind;
  317.   
  318.   /* For an ascii_keystroke, this is the character.
  319.      For a non_ascii_keystroke, this is the keysym code.
  320.      For a mouse event, this is the button number.  */
  321.   /* In WindowsNT, for a mouse wheel event, this is the delta.  */
  322.   int code;
  323.   enum scroll_bar_part part;
  324.  
  325.   int modifiers;        /* See enum below for interpretation.  */
  326.  
  327.   Lisp_Object x, y;
  328.   unsigned long timestamp;
  329.  
  330.   /* This is padding just to put the frame_or_window field
  331.      past the size of struct selection_event.  */
  332.   int *padding[2];
  333.  
  334.   /* This field is copied into a vector while the event is in the queue,
  335.      so that garbage collections won't kill it.  */
  336.   /* In a menu_bar_event, this is a cons cell whose car is the frame
  337.      and whose cdr is the Lisp object that is the event's value.  */
  338.   /* This field is last so that struct selection_input_event
  339.      does not overlap with it.  */
  340.   Lisp_Object frame_or_window;
  341. };
  342.  
  343.  
  344. /* Called to read input events.  */
  345. extern int (*read_socket_hook) P_ ((int, struct input_event *, int, int));
  346.  
  347.  
  348. /* Called when a frame's display becomes entirely up to date.  */
  349. extern void (*frame_up_to_date_hook) P_ ((struct frame *));
  350.  
  351. /* This is used in keyboard.c, to tell how many buttons we will need
  352.    to track the positions of.  */
  353. #ifdef HAVE_PM
  354. #define NUM_MOUSE_BUTTONS (5+2)
  355. #else /* not HAVE_PM */
  356. #define NUM_MOUSE_BUTTONS (5)
  357. #endif /* not HAVE_PM */
  358.  
  359. /* Bits in the modifiers member of the input_event structure.
  360.    Note that reorder_modifiers assumes that the bits are in canonical
  361.    order.  
  362.  
  363.    The modifiers applied to mouse clicks are rather ornate.  The
  364.    window-system-specific code should store mouse clicks with
  365.    up_modifier or down_modifier set.  Having an explicit down modifier
  366.    simplifies some of window-system-independent code; without it, the
  367.    code would have to recognize down events by checking if the event
  368.    is a mouse click lacking the click and drag modifiers.
  369.  
  370.    The window-system independent code turns all up_modifier events
  371.    bits into drag_modifier, click_modifier, double_modifier, or
  372.    triple_modifier events.  The click_modifier has no written
  373.    representation in the names of the symbols used as event heads,
  374.    but it does appear in the Qevent_symbol_components property of the
  375.    event heads.  */
  376. enum {
  377.   up_modifier    =   1,        /* Only used on mouse buttons - always
  378.                    turned into a click or a drag modifier
  379.                    before lisp code sees the event.  */
  380.   down_modifier =   2,        /* Only used on mouse buttons.  */
  381.   drag_modifier =   4,        /* This is never used in the event
  382.                    queue; it's only used internally by
  383.                    the window-system-independent code.  */
  384.   click_modifier=   8,        /* See drag_modifier.  */
  385.   double_modifier= 16,          /* See drag_modifier.  */
  386.   triple_modifier= 32,          /* See drag_modifier.  */
  387.  
  388.   /* The next four modifier bits are used also in keyboard events at
  389.      the Lisp level.
  390.  
  391.      It's probably not the greatest idea to use the 2^23 bit for any
  392.      modifier.  It may or may not be the sign bit, depending on
  393.      VALBITS, so using it to represent a modifier key means that
  394.      characters thus modified have different integer equivalents
  395.      depending on the architecture they're running on.  Oh, and
  396.      applying XINT to a character whose 2^23 bit is set sign-extends
  397.      it, so you get a bunch of bits in the mask you didn't want.
  398.  
  399.      The CHAR_ macros are defined in lisp.h.  */
  400.   alt_modifier    =  CHAR_ALT,    /* Under X, the XK_Alt_[LR] keysyms.  */
  401.   super_modifier=  CHAR_SUPER,    /* Under X, the XK_Super_[LR] keysyms.  */
  402.   hyper_modifier=  CHAR_HYPER,    /* Under X, the XK_Hyper_[LR] keysyms.  */
  403.   shift_modifier=  CHAR_SHIFT,
  404.   ctrl_modifier    =  CHAR_CTL,
  405.   meta_modifier    =  CHAR_META    /* Under X, the XK_Meta_[LR] keysyms.  */
  406. };
  407.  
  408. #endif
  409.