termhooks.h 7.26 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
/* Hooks by which low level terminal operations
   can be made to call other routines.
Jim Blandy's avatar
Jim Blandy committed
3
   Copyright (C) 1985, 1986, 1992 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

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.  */


extern int (*cursor_to_hook) ();
extern int (*raw_cursor_to_hook) ();

extern int (*clear_to_end_hook) ();
Jim Blandy's avatar
Jim Blandy committed
26
extern int (*clear_frame_hook) ();
Jim Blandy's avatar
Jim Blandy committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
extern int (*clear_end_of_line_hook) ();

extern int (*ins_del_lines_hook) ();

extern int (*change_line_highlight_hook) ();
extern int (*reassert_line_highlight_hook) ();

extern int (*insert_glyphs_hook) ();
extern int (*write_glyphs_hook) ();
extern int (*delete_glyphs_hook) ();

extern int (*ring_bell_hook) ();

extern int (*reset_terminal_modes_hook) ();
extern int (*set_terminal_modes_hook) ();
extern int (*update_begin_hook) ();
extern int (*update_end_hook) ();
extern int (*set_terminal_window_hook) ();

extern int (*read_socket_hook) ();

Jim Blandy's avatar
Jim Blandy committed
48 49
/* Return the current position of the mouse.  This should clear
   mouse_moved until the next motion event arrives.  */
Jim Blandy's avatar
Jim Blandy committed
50
extern void (*mouse_position_hook) ( /* FRAME_PTR *f,
Jim Blandy's avatar
Jim Blandy committed
51 52
					Lisp_Object *x,
					Lisp_Object *y,
Jim Blandy's avatar
Jim Blandy committed
53
					unsigned long *time */ );
Jim Blandy's avatar
Jim Blandy committed
54 55 56 57 58

/* The window system handling code should set this if the mouse has
   moved since the last call to the mouse_position_hook.  Calling that
   hook should clear this.  */
extern int mouse_moved;
Jim Blandy's avatar
Jim Blandy committed
59

Jim Blandy's avatar
Jim Blandy committed
60
/* When a frame's focus redirection is changed, this hook tells the
Jim Blandy's avatar
Jim Blandy committed
61
   window system code to re-decide where to put the highlight.  Under
Jim Blandy's avatar
Jim Blandy committed
62
   X, this means that Emacs lies about where the focus is.  */
Jim Blandy's avatar
Jim Blandy committed
63
extern void (*frame_rehighlight_hook) ( /* void */ );
Jim Blandy's avatar
Jim Blandy committed
64

Jim Blandy's avatar
Jim Blandy committed
65 66 67 68 69
/* If nonzero, send all terminal output characters to this stream also.  */
extern FILE *termscript;

/* Expedient hack: only provide the below definitions to files that
   are prepared to handle lispy things.  XINT is defined iff lisp.h
Jim Blandy's avatar
Jim Blandy committed
70 71
   has been included before this file.  */
#ifdef XINT
Jim Blandy's avatar
Jim Blandy committed
72 73 74 75 76 77 78 79 80 81 82 83

/* 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?  */
  enum {
    no_event,			/* nothing happened.  This should never
				   actually appear in the event queue.  */
Jim Blandy's avatar
Jim Blandy committed
84
    ascii_keystroke,		/* The ASCII code is in .code.
Jim Blandy's avatar
Jim Blandy committed
85
				   .frame is the frame in which the key
Jim Blandy's avatar
Jim Blandy committed
86 87 88
				   was typed.
				   Note that this includes meta-keys, and
				   the modifiers field of the event
Jim Blandy's avatar
Jim Blandy committed
89 90 91
				   is unused.
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
Jim Blandy's avatar
Jim Blandy committed
92 93 94 95 96 97 98
    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
				   is a table in keyboard.c to which you
				   should feel free to add missing keys.
				   .modifiers holds the state of the
Jim Blandy's avatar
Jim Blandy committed
99
				   modifier keys.
Jim Blandy's avatar
Jim Blandy committed
100
				   .frame is the frame in which the key
Jim Blandy's avatar
Jim Blandy committed
101 102 103
				   was typed.
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
104 105 106
    mouse_click,		/* The button number is in .code; it must
				   be >= 0 and < NUM_MOUSE_BUTTONS, defined
				   below.
Jim Blandy's avatar
Jim Blandy committed
107 108 109
				   .modifiers holds the state of the
				   modifier keys.
				   .x and .y give the mouse position,
Jim Blandy's avatar
Jim Blandy committed
110
				   in characters, within the window.
Jim Blandy's avatar
Jim Blandy committed
111
				   .frame gives the frame the mouse
Jim Blandy's avatar
Jim Blandy committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125
				   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.
				   .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.
Jim Blandy's avatar
Jim Blandy committed
126
				   .frame gives the frame the click
Jim Blandy's avatar
Jim Blandy committed
127 128 129
				   should apply to.
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
Jim Blandy's avatar
Jim Blandy committed
130
#if 0
Jim Blandy's avatar
Jim Blandy committed
131 132 133
    frame_selected,		/* The user has moved the focus to another
				   frame.
				   .frame is the frame that should become
Jim Blandy's avatar
Jim Blandy committed
134
				   selected at the next convenient time.  */
Jim Blandy's avatar
Jim Blandy committed
135
#endif
Jim Blandy's avatar
Jim Blandy committed
136 137 138 139
  } kind;
  
  Lisp_Object code;
  Lisp_Object part;
Jim Blandy's avatar
Jim Blandy committed
140 141

/* This is obviously wrong, but I'm not sure what else I should do.
Jim Blandy's avatar
Jim Blandy committed
142 143
   Obviously, this should be a FRAME_PTR.  But that would require that
   every file which #includes this one should also #include "frame.h",
Jim Blandy's avatar
Jim Blandy committed
144
   which would mean that files like cm.c and other innocents would be
Jim Blandy's avatar
Jim Blandy committed
145
   dragged into the set of frame.h users.  Maybe the definition of this
Jim Blandy's avatar
Jim Blandy committed
146
   structure should be elsewhere?  In its own file?  */
Jim Blandy's avatar
Jim Blandy committed
147 148
#ifdef MULTI_FRAME
  struct frame *frame;
Jim Blandy's avatar
Jim Blandy committed
149
#else
Jim Blandy's avatar
Jim Blandy committed
150
  int frame;
Jim Blandy's avatar
Jim Blandy committed
151
#endif
Jim Blandy's avatar
Jim Blandy committed
152
  int modifiers;		/* See enum below for interpretation.  */
Jim Blandy's avatar
Jim Blandy committed
153

Jim Blandy's avatar
Jim Blandy committed
154
  Lisp_Object x, y;
Jim Blandy's avatar
Jim Blandy committed
155
  unsigned long timestamp;
Jim Blandy's avatar
Jim Blandy committed
156 157
};

158 159 160 161
/* This is used in keyboard.c, to tell how many buttons we will need
   to track the positions of.  */
#define NUM_MOUSE_BUTTONS (5)

162 163
/* Bits in the modifiers member of the input_event structure.
   Note that reorder_modifiers assumes that the bits are in canonical
164 165 166 167
   order.  

   The modifiers applied to mouse clicks are rather ornate.  The
   window-system-specific code should store mouse clicks with
Jim Blandy's avatar
Jim Blandy committed
168 169 170 171 172 173 174 175 176 177
   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.

   The window-system independent code turns all up_modifier events
   bits into either drag_modifier or click_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.  */
Jim Blandy's avatar
Jim Blandy committed
178
enum {
179 180 181
  up_modifier	=   1,		/* Only used on mouse buttons - always
				   turned into a click or a drag modifier
				   before lisp code sees the event.  */
182 183 184 185 186 187
  alt_modifier	=   2,		/* Under X, the XK_Alt_[LR] keysyms.  */
  ctrl_modifier	=   4,
  hyper_modifier=   8,		/* Under X, the XK_Hyper_[LR] keysyms.  */
  meta_modifier	=  16,		/* Under X, the XK_Meta_[LR] keysyms.  */
  shift_modifier=  32,
  super_modifier=  64,		/* Under X, the XK_Super_[LR] keysyms.  */
188 189 190 191 192
  down_modifier = 128,		/* Only used on mouse buttons.  */
  drag_modifier = 256,		/* This is never used in the event
				   queue; it's only used internally by
				   the window-system-independent code.  */
  click_modifier= 512,		/* See drag_modifier.  */
Jim Blandy's avatar
Jim Blandy committed
193 194 195 196 197
  last_modifier			/* This should always be one more than the
				   highest modifier bit defined.  */
};

#endif