termhooks.h 15.7 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
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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

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

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

Andreas Schwab's avatar
Andreas Schwab committed
28 29 30 31
/* Only use prototypes when lisp.h has been included.  */
#ifndef P_
#define P_(X) ()
#endif
32 33

/* Text display hooks.  */
Jim Blandy's avatar
Jim Blandy committed
34

Andreas Schwab's avatar
Andreas Schwab committed
35 36
extern void (*cursor_to_hook) P_ ((int, int));
extern void (*raw_cursor_to_hook) P_ ((int, int));
Jim Blandy's avatar
Jim Blandy committed
37

Andreas Schwab's avatar
Andreas Schwab committed
38 39 40
extern void (*clear_to_end_hook) P_ ((void));
extern void (*clear_frame_hook) P_ ((void));
extern void (*clear_end_of_line_hook) P_ ((int));
Jim Blandy's avatar
Jim Blandy committed
41

Andreas Schwab's avatar
Andreas Schwab committed
42
extern void (*ins_del_lines_hook) P_ ((int, int));
Jim Blandy's avatar
Jim Blandy committed
43

Andreas Schwab's avatar
Andreas Schwab committed
44 45
extern void (*change_line_highlight_hook) P_ ((int, int, int));
extern void (*reassert_line_highlight_hook) P_ ((int, int));
Jim Blandy's avatar
Jim Blandy committed
46

Andreas Schwab's avatar
Andreas Schwab committed
47 48 49
extern void (*insert_glyphs_hook) P_ ((GLYPH *, int));
extern void (*write_glyphs_hook) P_ ((GLYPH *, int));
extern void (*delete_glyphs_hook) P_ ((int));
Jim Blandy's avatar
Jim Blandy committed
50

Andreas Schwab's avatar
Andreas Schwab committed
51
extern void (*ring_bell_hook) P_ ((void));
Jim Blandy's avatar
Jim Blandy committed
52

Andreas Schwab's avatar
Andreas Schwab committed
53 54 55 56 57
extern void (*reset_terminal_modes_hook) P_ ((void));
extern void (*set_terminal_modes_hook) P_ ((void));
extern void (*update_begin_hook) P_ ((struct frame *));
extern void (*update_end_hook) P_ ((struct frame *));
extern void (*set_terminal_window_hook) P_ ((int));
Jim Blandy's avatar
Jim Blandy committed
58

59 60 61

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

63 64 65
enum scroll_bar_part {
  scroll_bar_above_handle,
  scroll_bar_handle,
66 67
  scroll_bar_below_handle,
  scroll_bar_up_arrow,
68
  scroll_bar_down_arrow
69 70 71
};

/* Return the current position of the mouse.
72 73 74 75 76

   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.

77 78 79 80
   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.
81 82 83 84 85 86 87 88

   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.  */
Andreas Schwab's avatar
Andreas Schwab committed
89
extern void (*mouse_position_hook) P_ ((struct frame **f, int,
90
					Lisp_Object *bar_window,
91
					enum scroll_bar_part *part,
Jim Blandy's avatar
Jim Blandy committed
92 93
					Lisp_Object *x,
					Lisp_Object *y,
Andreas Schwab's avatar
Andreas Schwab committed
94
					unsigned long *time));
Jim Blandy's avatar
Jim Blandy committed
95 96 97 98 99

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

Jim Blandy's avatar
Jim Blandy committed
101
/* When a frame's focus redirection is changed, this hook tells the
Jim Blandy's avatar
Jim Blandy committed
102
   window system code to re-decide where to put the highlight.  Under
Jim Blandy's avatar
Jim Blandy committed
103
   X, this means that Emacs lies about where the focus is.  */
Andreas Schwab's avatar
Andreas Schwab committed
104
extern void (*frame_rehighlight_hook) P_ ((struct frame *));
Jim Blandy's avatar
Jim Blandy committed
105

Jim Blandy's avatar
Jim Blandy committed
106 107 108 109 110 111 112 113 114 115
/* 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.  */
Andreas Schwab's avatar
Andreas Schwab committed
116
extern void (*frame_raise_lower_hook) P_ ((struct frame *f, int raise));
117 118


119
/* Scroll bar hooks.  */
120

121
/* The representation of scroll bars is determined by the code which
122 123 124
   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
125
   dangling references when the scroll bar is destroyed.
126 127

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

132 133 134
   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.
135

136 137
   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
138 139 140
   fit.  They are marked by the garbage collector.  */


141
/* Set the vertical scroll bar for WINDOW to have its upper left corner
142 143 144
   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
145 146
   have a scroll bar, create one for it.  */
extern void (*set_vertical_scroll_bar_hook)
Andreas Schwab's avatar
Andreas Schwab committed
147 148
            P_ ((struct window *window,
	         int portion, int whole, int position));
149 150 151


/* The following three hooks are used when we're doing a thorough
152
   redisplay of the frame.  We don't explicitly know which scroll bars
153 154 155
   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*
156
   scroll bars are to be removed, and then save scroll bars from the
Karl Heuer's avatar
Karl Heuer committed
157
   fiery pit when we actually redisplay their window.  */
158

159 160 161
/* 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. 
162 163

   This should be applied to each frame each time its window tree is
164 165 166
   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.
167

168
   If non-zero, this hook should be safe to apply to any frame,
169
   whether or not it can support scroll bars, and whether or not it is
170
   currently displaying them.  */
Andreas Schwab's avatar
Andreas Schwab committed
171
extern void (*condemn_scroll_bars_hook) P_ ((struct frame *frame));
172

173 174
/* 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.  */
Andreas Schwab's avatar
Andreas Schwab committed
175
extern void (*redeem_scroll_bar_hook) P_ ((struct window *window));
176

177 178
/* Remove all scroll bars on FRAME that haven't been saved since the
   last call to `*condemn_scroll_bars_hook'.  
179 180

   This should be applied to each frame after each time its window
181 182 183
   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.
184

185
   If non-zero, this hook should be safe to apply to any frame,
186
   whether or not it can support scroll bars, and whether or not it is
187
   currently displaying them.  */
Andreas Schwab's avatar
Andreas Schwab committed
188
extern void (*judge_scroll_bars_hook) P_ ((struct frame *FRAME));
189

190 191

/* Input queue declarations and hooks.  */
192

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

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

  ascii_keystroke,		/* The ASCII code is in .code, perhaps
				   with modifiers applied.
				   .modifiers holds the state of the
				   modifier keys.
207 208
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
209 210
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
211
  non_ascii_keystroke,		/* .code is a number identifying the
Jim Blandy's avatar
Jim Blandy committed
212 213 214 215 216 217
				   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
218
				   modifier keys.
219 220
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
221 222
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
223
  timer_event,                  /* A timer fired.  */
224
  mouse_click,			/* The button number is in .code; it must
225 226
				   be >= 0 and < NUM_MOUSE_BUTTONS, defined
				   below.
Jim Blandy's avatar
Jim Blandy committed
227 228 229
				   .modifiers holds the state of the
				   modifier keys.
				   .x and .y give the mouse position,
Jim Blandy's avatar
Jim Blandy committed
230
				   in characters, within the window.
231 232
				   .frame_or_window gives the frame
				   the mouse click occurred in.
Jim Blandy's avatar
Jim Blandy committed
233 234
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
235
#ifdef WINDOWSNT
236 237
  mouse_wheel,			/* A mouse-wheel event is generated 
				   on WINDOWSNT by a 
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
				   wheel on a mouse (e.g., MS Intellimouse).
				   The event contains a delta that corresponds
				   to the amount and direction that the wheel
				   is rotated.  This delta is typically
				   used to implement a scroll or zoom.
				   .code gives the delta.
				   .modifiers holds the state of the
				   modifier keys.
				   .x and .y give the mouse position,
				   in characters, within the window.
				   .frame_or_window gives the frame
				   the wheel event occurred in.
				   .timestamp gives a timestamp (in
				   milliseconds) for the wheel event.  */
#endif
253
  scroll_bar_click,		/* .code gives the number of the mouse button
254 255 256
				   that was clicked.
				   .modifiers holds the state of the modifier
				   keys.
Jim Blandy's avatar
Jim Blandy committed
257
				   .part is a lisp symbol indicating which
258
				   part of the scroll bar got clicked.
259 260 261
				   .x gives the distance from the start of the
				   scroll bar of the click; .y gives the total
				   length of the scroll bar.
262
				   .frame_or_window gives the window
263
				   whose scroll bar was clicked in.
Jim Blandy's avatar
Jim Blandy committed
264 265
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
266
#ifdef WINDOWSNT
267
  w32_scroll_bar_click,	/* as for scroll_bar_click, but only generated
268 269
				   by MS-Windows scroll bar controls. */
#endif
270 271
  selection_request_event,	/* Another X client wants a selection from us.
				   See `struct selection_event'.  */
272
  selection_clear_event,	/* Another X client cleared our selection.  */
273
  buffer_switch_event,		/* A process filter has switched buffers.  */
274
  delete_window_event,		/* An X client said "delete this window".  */
275
  menu_bar_event,		/* An event generated by the menu bar.
276
				   The frame_or_window field's cdr holds the
277 278
				   Lisp-level event value.
				   (Only the toolkit version uses these.)  */
279
  iconify_event,		/* An X client iconified this window.  */
280
  deiconify_event,		/* An X client deiconified this window.  */
281
  menu_bar_activate_event,       /* A button press in the menu bar
282
				   (toolkit version only).  */
283 284 285 286 287 288 289 290 291 292 293 294 295
  drag_n_drop			/* A drag-n-drop event is generated when
				   files selected outside of Emacs are dropped
				   onto an Emacs window.
				   Currently used only on Windows NT.
				   .modifiers holds the state of the 
				   modifier keys.
				   .x and .y give the mouse position,
				   in characters, within the window.
				   .frame_or_window is a cons of the frame
				   in which the drop was made and a list of
				   the filenames of the dropped files.
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
296 297 298 299 300 301 302 303 304 305 306
};

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

307 308
struct input_event
{
309 310

  /* What kind of event was this?  */
311
  int kind;
Jim Blandy's avatar
Jim Blandy committed
312
  
313 314
  /* For an ascii_keystroke, this is the character.
     For a non_ascii_keystroke, this is the keysym code.
315
     For a mouse event, this is the button number.  */
316
  /* In WindowsNT, for a mouse wheel event, this is the delta.  */
317
  int code;
318
  enum scroll_bar_part part;
319

320 321 322 323 324
  int modifiers;		/* See enum below for interpretation.  */

  Lisp_Object x, y;
  unsigned long timestamp;

325 326 327 328
  /* This is padding just to put the frame_or_window field
     past the size of struct selection_event.  */
  int *padding[2];

329 330
  /* This field is copied into a vector while the event is in the queue,
     so that garbage collections won't kill it.  */
331 332
  /* 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.  */
333 334
  /* This field is last so that struct selection_input_event
     does not overlap with it.  */
335
  Lisp_Object frame_or_window;
Jim Blandy's avatar
Jim Blandy committed
336
};
Andreas Schwab's avatar
Andreas Schwab committed
337 338 339 340 341 342

/* Called to read input events.  */
extern int (*read_socket_hook) P_ ((int, struct input_event *, int, int));

/* Called when a frame's display becomes entirely up to date.  */
extern void (*frame_up_to_date_hook) P_ ((struct frame *));
343

344 345 346 347
/* This is used in keyboard.c, to tell how many buttons we will need
   to track the positions of.  */
#define NUM_MOUSE_BUTTONS (5)

348 349
/* Bits in the modifiers member of the input_event structure.
   Note that reorder_modifiers assumes that the bits are in canonical
350 351 352 353
   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
354 355 356 357 358 359
   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
360 361 362 363 364
   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
365
enum {
366 367 368
  up_modifier	=   1,		/* Only used on mouse buttons - always
				   turned into a click or a drag modifier
				   before lisp code sees the event.  */
369 370
  down_modifier =   2,		/* Only used on mouse buttons.  */
  drag_modifier =   4,		/* This is never used in the event
371 372
				   queue; it's only used internally by
				   the window-system-independent code.  */
373
  click_modifier=   8,		/* See drag_modifier.  */
374 375
  double_modifier= 16,          /* See drag_modifier.  */
  triple_modifier= 32,          /* See drag_modifier.  */
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393

  /* 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,
394
  meta_modifier	=  CHAR_META	/* Under X, the XK_Meta_[LR] keysyms.  */
Jim Blandy's avatar
Jim Blandy committed
395 396 397
};

#endif