/* Hooks by which low level terminal operations
can be made to call other routines.
- Copyright (C) 1985, 1986, 1992 Free Software Foundation, Inc.
+ Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
This file is part of GNU Emacs.
You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING. If not, write to
-the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
+the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA. */
+\f
+/* Miscellanea. */
+
+/* If nonzero, send all terminal output characters to this stream also. */
+extern FILE *termscript;
+
+\f
+/* Text display hooks. */
extern int (*cursor_to_hook) ();
extern int (*raw_cursor_to_hook) ();
extern int (*clear_to_end_hook) ();
-extern int (*clear_screen_hook) ();
+extern int (*clear_frame_hook) ();
extern int (*clear_end_of_line_hook) ();
extern int (*ins_del_lines_hook) ();
extern int (*update_end_hook) ();
extern int (*set_terminal_window_hook) ();
-extern int (*read_socket_hook) ();
-/* Return the current position of the mouse. This should clear
- mouse_moved until the next motion event arrives. */
-extern void (*mouse_position_hook) ( /* SCREEN_PTR *s,
+\f
+/* Multi-frame and mouse support hooks. */
+
+enum scroll_bar_part {
+ scroll_bar_above_handle,
+ scroll_bar_handle,
+ scroll_bar_below_handle,
+ scroll_bar_up_arrow,
+ scroll_bar_down_arrow
+};
+
+/* Return the current position of the mouse.
+
+ Set *f to the frame the mouse is in, or zero if the mouse is in no
+ Emacs frame. If it is set to zero, all the other arguments are
+ garbage.
+
+ If the motion started in a scroll bar, set *bar_window to the
+ scroll bar's window, *part to the part the mouse is currently over,
+ *x to the position of the mouse along the scroll bar, and *y to the
+ overall length of the scroll bar.
+
+ Otherwise, set *bar_window to Qnil, and *x and *y to the column and
+ row of the character cell the mouse is over.
+
+ Set *time to the time the mouse was at the returned position.
+
+ This should clear mouse_moved until the next motion
+ event arrives. */
+extern void (*mouse_position_hook) ( /* FRAME_PTR *f,
+ Lisp_Object *bar_window,
+ enum scroll_bar_part *part,
Lisp_Object *x,
Lisp_Object *y,
unsigned long *time */ );
hook should clear this. */
extern int mouse_moved;
-/* When a screen's focus redirection is changed, this hook tells the
+/* When a frame's focus redirection is changed, this hook tells the
window system code to re-decide where to put the highlight. Under
X, this means that Emacs lies about where the focus is. */
-extern void (*screen_rehighlight_hook) ( /* void */ );
+extern void (*frame_rehighlight_hook) ( /* void */ );
-/* If nonzero, send all terminal output characters to this stream also. */
-extern FILE *termscript;
+/* If we're displaying frames using a window system that can stack
+ frames on top of each other, this hook allows you to bring a frame
+ to the front, or bury it behind all the other windows. If this
+ hook is zero, that means the device we're displaying on doesn't
+ support overlapping frames, so there's no need to raise or lower
+ anything.
-/* Expedient hack: only provide the below definitions to files that
- are prepared to handle lispy things. XINT is defined iff lisp.h
- has been included before this file. */
-#ifdef XINT
+ If RAISE is non-zero, F is brought to the front, before all other
+ windows. If RAISE is zero, F is sent to the back, behind all other
+ windows. */
+extern void (*frame_raise_lower_hook) ( /* FRAME_PTR f, int raise */ );
-/* The keyboard input buffer is an array of these structures. Each one
- represents some sort of input event - a keystroke, a mouse click, or
- a window system event. These get turned into their lispy forms when
- they are removed from the event queue. */
+\f
+/* Scroll bar hooks. */
-struct input_event {
+/* The representation of scroll bars is determined by the code which
+ implements them, except for one thing: they must be represented by
+ lisp objects. This allows us to place references to them in
+ Lisp_Windows without worrying about those references becoming
+ dangling references when the scroll bar is destroyed.
- /* What kind of event was this? */
- enum {
- no_event, /* nothing happened. This should never
+ The window-system-independent portion of Emacs just refers to
+ scroll bars via their windows, and never looks inside the scroll bar
+ representation; it always uses hook functions to do all the
+ scroll bar manipulation it needs.
+
+ The `vertical_scroll_bar' field of a Lisp_Window refers to that
+ window's scroll bar, or is nil if the window doesn't have a
+ scroll bar.
+
+ The `scroll_bars' and `condemned_scroll_bars' fields of a Lisp_Frame
+ are free for use by the scroll bar implementation in any way it sees
+ fit. They are marked by the garbage collector. */
+
+
+/* Set the vertical scroll bar for WINDOW to have its upper left corner
+ at (TOP, LEFT), and be LENGTH rows high. Set its handle to
+ indicate that we are displaying PORTION characters out of a total
+ of WHOLE characters, starting at POSITION. If WINDOW doesn't yet
+ have a scroll bar, create one for it. */
+extern void (*set_vertical_scroll_bar_hook)
+ ( /* struct window *window,
+ int portion, int whole, int position */ );
+
+
+/* The following three hooks are used when we're doing a thorough
+ redisplay of the frame. We don't explicitly know which scroll bars
+ are going to be deleted, because keeping track of when windows go
+ away is a real pain - can you say set-window-configuration?
+ Instead, we just assert at the beginning of redisplay that *all*
+ scroll bars are to be removed, and then save scroll bars from the
+ fiery pit when we actually redisplay their window. */
+
+/* Arrange for all scroll bars on FRAME to be removed at the next call
+ to `*judge_scroll_bars_hook'. A scroll bar may be spared if
+ `*redeem_scroll_bar_hook' is applied to its window before the judgement.
+
+ This should be applied to each frame each time its window tree is
+ redisplayed, even if it is not displaying scroll bars at the moment;
+ if the HAS_SCROLL_BARS flag has just been turned off, only calling
+ this and the judge_scroll_bars_hook will get rid of them.
+
+ If non-zero, this hook should be safe to apply to any frame,
+ whether or not it can support scroll bars, and whether or not it is
+ currently displaying them. */
+extern void (*condemn_scroll_bars_hook)( /* FRAME_PTR *frame */ );
+
+/* Unmark WINDOW's scroll bar for deletion in this judgement cycle.
+ Note that it's okay to redeem a scroll bar that is not condemned. */
+extern void (*redeem_scroll_bar_hook)( /* struct window *window */ );
+
+/* Remove all scroll bars on FRAME that haven't been saved since the
+ last call to `*condemn_scroll_bars_hook'.
+
+ This should be applied to each frame after each time its window
+ tree is redisplayed, even if it is not displaying scroll bars at the
+ moment; if the HAS_SCROLL_BARS flag has just been turned off, only
+ calling this and condemn_scroll_bars_hook will get rid of them.
+
+ If non-zero, this hook should be safe to apply to any frame,
+ whether or not it can support scroll bars, and whether or not it is
+ currently displaying them. */
+extern void (*judge_scroll_bars_hook)( /* FRAME_PTR *FRAME */ );
+
+\f
+/* Input queue declarations and hooks. */
+
+/* Called to read input events. */
+extern int (*read_socket_hook) ();
+
+/* Called when a frame's display becomes entirely up to date. */
+extern int (*frame_up_to_date_hook) ();
+
+/* Expedient hack: only provide the below definitions to files that
+ are prepared to handle lispy things. CONSP is defined iff lisp.h
+ has been included before this file. */
+#ifdef CONSP
+
+enum event_kind
+{
+ no_event, /* nothing happened. This should never
actually appear in the event queue. */
- ascii_keystroke, /* The ASCII code is in .code.
- .screen is the screen in which the key
- was typed.
- Note that this includes meta-keys, and
- the modifiers field of the event
- is unused.
+
+ ascii_keystroke, /* The ASCII code is in .code, perhaps
+ with modifiers applied.
+ .modifiers holds the state of the
+ modifier keys.
+ .frame_or_window is the frame in
+ which the key was typed.
.timestamp gives a timestamp (in
milliseconds) for the keystroke. */
- non_ascii_keystroke, /* .code is a number identifying the
+ non_ascii_keystroke, /* .code is a number identifying the
function key. A code N represents
a key whose name is
function_key_names[N]; function_key_names
should feel free to add missing keys.
.modifiers holds the state of the
modifier keys.
- .screen is the screen in which the key
- was typed.
+ .frame_or_window is the frame in
+ which the key was typed.
.timestamp gives a timestamp (in
milliseconds) for the keystroke. */
- mouse_click, /* The button number is in .code.
+ timer_event, /* A timer fired. */
+ mouse_click, /* The button number is in .code; it must
+ be >= 0 and < NUM_MOUSE_BUTTONS, defined
+ below.
.modifiers holds the state of the
modifier keys.
.x and .y give the mouse position,
in characters, within the window.
- .screen gives the screen the mouse
- click occurred in.
+ .frame_or_window gives the frame
+ the mouse click occurred in.
.timestamp gives a timestamp (in
milliseconds) for the click. */
- scrollbar_click, /* .code gives the number of the mouse
- button that was clicked.
+ scroll_bar_click, /* .code gives the number of the mouse button
+ that was clicked.
+ .modifiers holds the state of the modifier
+ keys.
.part is a lisp symbol indicating which
- part of the scrollbar got clicked. This
- indicates whether the scroll bar was
- horizontal or vertical.
- .modifiers gives the state of the
- modifier keys.
- .x gives the distance from the start
- of the scroll bar of the click; .y gives
- the total length of the scroll bar.
- .screen gives the screen the click
- should apply to.
+ part of the scroll bar got clicked.
+ .x gives the distance from the start of the
+ scroll bar of the click; .y gives the total
+ length of the scroll bar.
+ .frame_or_window gives the window
+ whose scroll bar was clicked in.
.timestamp gives a timestamp (in
milliseconds) for the click. */
-#if 0
- screen_selected, /* The user has moved the focus to another
- screen.
- .screen is the screen that should become
- selected at the next convenient time. */
+#ifdef WINDOWSNT
+ win32_scroll_bar_click, /* as for scroll_bar_click, but only generated
+ by MS-Windows scroll bar controls. */
#endif
- } kind;
+ selection_request_event, /* Another X client wants a selection from us.
+ See `struct selection_event'. */
+ selection_clear_event, /* Another X client cleared our selection. */
+ buffer_switch_event, /* A process filter has switched buffers. */
+ delete_window_event, /* An X client said "delete this window". */
+ menu_bar_event, /* An event generated by the menu bar.
+ The frame_or_window field's cdr holds the
+ Lisp-level event value.
+ (Only the toolkit version uses these.) */
+ iconify_event, /* An X client iconified this window. */
+ deiconify_event, /* An X client deiconified this window. */
+ menu_bar_activate_event /* A button press in the menu bar
+ (toolkit version only). */
+};
+
+/* If a struct input_event has a kind which is selection_request_event
+ or selection_clear_event, then its contents are really described
+ by `struct selection_event'; see xterm.h. */
+
+/* The keyboard input buffer is an array of these structures. Each one
+ represents some sort of input event - a keystroke, a mouse click, or
+ a window system event. These get turned into their lispy forms when
+ they are removed from the event queue. */
+
+struct input_event
+{
+
+ /* What kind of event was this? */
+ int kind;
- Lisp_Object code;
- Lisp_Object part;
-
-/* This is obviously wrong, but I'm not sure what else I should do.
- Obviously, this should be a SCREEN_PTR. But that would require that
- every file which #includes this one should also #include "screen.h",
- which would mean that files like cm.c and other innocents would be
- dragged into the set of screen.h users. Maybe the definition of this
- structure should be elsewhere? In its own file? */
-#ifdef MULTI_SCREEN
- struct screen *screen;
-#else
- int screen;
-#endif
+ /* For an ascii_keystroke, this is the character.
+ For a non_ascii_keystroke, this is the keysym code.
+ For a mouse event, this is the button number. */
+ int code;
+ enum scroll_bar_part part;
+
int modifiers; /* See enum below for interpretation. */
Lisp_Object x, y;
unsigned long timestamp;
+
+ /* This is padding just to put the frame_or_window field
+ past the size of struct selection_event. */
+ int *padding[2];
+
+ /* This field is copied into a vector while the event is in the queue,
+ so that garbage collections won't kill it. */
+ /* In a menu_bar_event, this is a cons cell whose car is the frame
+ and whose cdr is the Lisp object that is the event's value. */
+ /* This field is last so that struct selection_input_event
+ does not overlap with it. */
+ Lisp_Object frame_or_window;
};
+\f
+/* This is used in keyboard.c, to tell how many buttons we will need
+ to track the positions of. */
+#define NUM_MOUSE_BUTTONS (5)
+
+/* Bits in the modifiers member of the input_event structure.
+ Note that reorder_modifiers assumes that the bits are in canonical
+ order.
+
+ The modifiers applied to mouse clicks are rather ornate. The
+ window-system-specific code should store mouse clicks with
+ up_modifier or down_modifier set. Having an explicit down modifier
+ simplifies some of window-system-independent code; without it, the
+ code would have to recognize down events by checking if the event
+ is a mouse click lacking the click and drag modifiers.
-/* Bits in the modifiers member of the input_event structure. */
+ The window-system independent code turns all up_modifier events
+ bits into drag_modifier, click_modifier, double_modifier, or
+ triple_modifier events. The click_modifier has no written
+ representation in the names of the symbols used as event heads,
+ but it does appear in the Qevent_symbol_components property of the
+ event heads. */
enum {
- shift_modifier = 1,
- ctrl_modifier = 2,
- meta_modifier = 4,
- up_modifier = 8, /* This only applies to mouse buttons. */
- last_modifier /* This should always be one more than the
- highest modifier bit defined. */
-};
+ up_modifier = 1, /* Only used on mouse buttons - always
+ turned into a click or a drag modifier
+ before lisp code sees the event. */
+ down_modifier = 2, /* Only used on mouse buttons. */
+ drag_modifier = 4, /* This is never used in the event
+ queue; it's only used internally by
+ the window-system-independent code. */
+ click_modifier= 8, /* See drag_modifier. */
+ double_modifier= 16, /* See drag_modifier. */
+ triple_modifier= 32, /* See drag_modifier. */
+
+ /* The next four modifier bits are used also in keyboard events at
+ the Lisp level.
-#define NUM_MODIFIER_COMBOS ((last_modifier-1) << 1)
+ It's probably not the greatest idea to use the 2^23 bit for any
+ modifier. It may or may not be the sign bit, depending on
+ VALBITS, so using it to represent a modifier key means that
+ characters thus modified have different integer equivalents
+ depending on the architecture they're running on. Oh, and
+ applying XINT to a character whose 2^23 bit is set sign-extends
+ it, so you get a bunch of bits in the mask you didn't want.
+
+ The CHAR_ macros are defined in lisp.h. */
+ alt_modifier = CHAR_ALT, /* Under X, the XK_Alt_[LR] keysyms. */
+ super_modifier= CHAR_SUPER, /* Under X, the XK_Super_[LR] keysyms. */
+ hyper_modifier= CHAR_HYPER, /* Under X, the XK_Hyper_[LR] keysyms. */
+ shift_modifier= CHAR_SHIFT,
+ ctrl_modifier = CHAR_CTL,
+ meta_modifier = CHAR_META /* Under X, the XK_Meta_[LR] keysyms. */
+};
#endif