termhooks.h 13.3 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.
Karl Heuer's avatar
Karl Heuer committed
3
   Copyright (C) 1985, 1986, 1993, 1994 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
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.  */

21 22 23 24 25 26 27 28

/* Miscellanea.   */

/* If nonzero, send all terminal output characters to this stream also.  */
extern FILE *termscript;


/* Text display hooks.  */
Jim Blandy's avatar
Jim Blandy committed
29 30 31 32 33

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

extern int (*clear_to_end_hook) ();
Jim Blandy's avatar
Jim Blandy committed
34
extern int (*clear_frame_hook) ();
Jim Blandy's avatar
Jim Blandy committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
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) ();

54 55 56


/* Multi-frame and mouse support hooks.  */
Jim Blandy's avatar
Jim Blandy committed
57

58 59 60 61
enum scroll_bar_part {
  scroll_bar_above_handle,
  scroll_bar_handle,
  scroll_bar_below_handle
62 63 64
};

/* Return the current position of the mouse.
65 66 67 68 69

   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.

70 71 72 73
   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.
74 75 76 77 78 79 80 81

   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.  */
Jim Blandy's avatar
Jim Blandy committed
82
extern void (*mouse_position_hook) ( /* FRAME_PTR *f,
83
					Lisp_Object *bar_window,
84
					enum scroll_bar_part *part,
Jim Blandy's avatar
Jim Blandy committed
85 86
					Lisp_Object *x,
					Lisp_Object *y,
Jim Blandy's avatar
Jim Blandy committed
87
					unsigned long *time */ );
Jim Blandy's avatar
Jim Blandy committed
88 89 90 91 92

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

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

Jim Blandy's avatar
Jim Blandy committed
99 100 101 102 103 104 105 106 107 108 109
/* 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.

   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 */ );
110 111


112
/* Scroll bar hooks.  */
113

114
/* The representation of scroll bars is determined by the code which
115 116 117
   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
118
   dangling references when the scroll bar is destroyed.
119 120

   The window-system-independent portion of Emacs just refers to
121
   scroll bars via their windows, and never looks inside the scroll bar
122
   representation; it always uses hook functions to do all the
123
   scroll bar manipulation it needs.
124

125 126 127
   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.
128

129 130
   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
131 132 133
   fit.  They are marked by the garbage collector.  */


134
/* Set the vertical scroll bar for WINDOW to have its upper left corner
135 136 137
   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
138 139
   have a scroll bar, create one for it.  */
extern void (*set_vertical_scroll_bar_hook)
140 141
            ( /* struct window *window,
	         int portion, int whole, int position */ );
142 143 144


/* The following three hooks are used when we're doing a thorough
145
   redisplay of the frame.  We don't explicitly know which scroll bars
146 147 148
   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*
149
   scroll bars are to be removed, and then save scroll bars from the
150 151
   firey pit when we actually redisplay their window.  */

152 153 154
/* 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. 
155 156

   This should be applied to each frame each time its window tree is
157 158 159
   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.
160

161
   If non-zero, this hook should be safe to apply to any frame,
162
   whether or not it can support scroll bars, and whether or not it is
163
   currently displaying them.  */
164
extern void (*condemn_scroll_bars_hook)( /* FRAME_PTR *frame */ );
165

166 167 168
/* 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 */ );
169

170 171
/* Remove all scroll bars on FRAME that haven't been saved since the
   last call to `*condemn_scroll_bars_hook'.  
172 173

   This should be applied to each frame after each time its window
174 175 176
   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.
177

178
   If non-zero, this hook should be safe to apply to any frame,
179
   whether or not it can support scroll bars, and whether or not it is
180
   currently displaying them.  */
181
extern void (*judge_scroll_bars_hook)( /* FRAME_PTR *FRAME */ );
182

183 184

/* Input queue declarations and hooks.  */
185

186
/* Called to read input events.  */
187
extern int (*read_socket_hook) ();
Jim Blandy's avatar
Jim Blandy committed
188

189 190 191
/* Called when a frame's display becomes entirely up to date.  */
extern int (*frame_up_to_date_hook) ();

Jim Blandy's avatar
Jim Blandy committed
192
/* Expedient hack: only provide the below definitions to files that
193
   are prepared to handle lispy things.  CONSP is defined iff lisp.h
Jim Blandy's avatar
Jim Blandy committed
194
   has been included before this file.  */
195
#ifdef CONSP
Jim Blandy's avatar
Jim Blandy committed
196

197 198 199
enum event_kind
{
  no_event,			/* nothing happened.  This should never
Jim Blandy's avatar
Jim Blandy committed
200
				   actually appear in the event queue.  */
Jim Blandy's avatar
Jim Blandy committed
201 202 203 204 205

  ascii_keystroke,		/* The ASCII code is in .code, perhaps
				   with modifiers applied.
				   .modifiers holds the state of the
				   modifier keys.
206 207
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
208 209
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
210
  non_ascii_keystroke,		/* .code is a number identifying the
Jim Blandy's avatar
Jim Blandy committed
211 212 213 214 215 216
				   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
217
				   modifier keys.
218 219
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
220 221
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
222
  mouse_click,			/* The button number is in .code; it must
223 224
				   be >= 0 and < NUM_MOUSE_BUTTONS, defined
				   below.
Jim Blandy's avatar
Jim Blandy committed
225 226 227
				   .modifiers holds the state of the
				   modifier keys.
				   .x and .y give the mouse position,
Jim Blandy's avatar
Jim Blandy committed
228
				   in characters, within the window.
229 230
				   .frame_or_window gives the frame
				   the mouse click occurred in.
Jim Blandy's avatar
Jim Blandy committed
231 232
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
233
  scroll_bar_click,		/* .code gives the number of the mouse button
234 235 236
				   that was clicked.
				   .modifiers holds the state of the modifier
				   keys.
Jim Blandy's avatar
Jim Blandy committed
237
				   .part is a lisp symbol indicating which
238
				   part of the scroll bar got clicked.
239 240 241
				   .x gives the distance from the start of the
				   scroll bar of the click; .y gives the total
				   length of the scroll bar.
242
				   .frame_or_window gives the window
243
				   whose scroll bar was clicked in.
Jim Blandy's avatar
Jim Blandy committed
244 245
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
246 247
  selection_request_event,	/* Another X client wants a selection from us.
				   See `struct selection_event'.  */
248
  selection_clear_event,	/* Another X client cleared our selection.  */
249
  buffer_switch_event,		/* A process filter has switched buffers.  */
250 251 252 253 254
  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 holds the
				   Lisp-level event value.
				   (Only the toolkit version uses these.)  */
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
};

/* 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?  */
  enum event_kind kind;
Jim Blandy's avatar
Jim Blandy committed
270
  
271 272
  /* For an ascii_keystroke, this is the character.
     For a non_ascii_keystroke, this is the keysym code.
273
     For a mouse event, this is the button number.  */
274
  int code;
275
  enum scroll_bar_part part;
276 277 278

  /* This field is copied into a vector while the event is in the queue,
     so that garbage collections won't kill it.  */
279 280
  /* In a menu_bar_event, this holds the Lisp object
     that is the event's value.  */
281 282
  Lisp_Object frame_or_window;

Jim Blandy's avatar
Jim Blandy committed
283
  int modifiers;		/* See enum below for interpretation.  */
Jim Blandy's avatar
Jim Blandy committed
284

Jim Blandy's avatar
Jim Blandy committed
285
  Lisp_Object x, y;
Jim Blandy's avatar
Jim Blandy committed
286
  unsigned long timestamp;
Jim Blandy's avatar
Jim Blandy committed
287
};
288

289 290 291 292
/* This is used in keyboard.c, to tell how many buttons we will need
   to track the positions of.  */
#define NUM_MOUSE_BUTTONS (5)

293 294
/* Bits in the modifiers member of the input_event structure.
   Note that reorder_modifiers assumes that the bits are in canonical
295 296 297 298
   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
299 300 301 302 303 304
   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
305 306 307 308 309
   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.  */
Jim Blandy's avatar
Jim Blandy committed
310
enum {
311 312 313
  up_modifier	=   1,		/* Only used on mouse buttons - always
				   turned into a click or a drag modifier
				   before lisp code sees the event.  */
314 315
  down_modifier =   2,		/* Only used on mouse buttons.  */
  drag_modifier =   4,		/* This is never used in the event
316 317
				   queue; it's only used internally by
				   the window-system-independent code.  */
318
  click_modifier=   8,		/* See drag_modifier.  */
319 320
  double_modifier= 16,          /* See drag_modifier.  */
  triple_modifier= 32,          /* See drag_modifier.  */
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338

  /* The next four modifier bits are used also in keyboard events at
     the Lisp level.

     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,
339
  meta_modifier	=  CHAR_META	/* Under X, the XK_Meta_[LR] keysyms.  */
Jim Blandy's avatar
Jim Blandy committed
340 341 342
};

#endif