termhooks.h 17.1 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.
3 4
   Copyright (C) 1985, 1986, 1993, 1994, 2002, 2003, 2004,
                 2005 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

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
10
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
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
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22

23 24 25

/* Miscellanea.   */

Gerd Moellmann's avatar
Gerd Moellmann committed
26 27 28
struct glyph;
struct frame;

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
39
extern void (*cursor_to_hook) P_ ((int vpos, int hpos));
Andreas Schwab's avatar
Andreas Schwab committed
40
extern void (*raw_cursor_to_hook) P_ ((int, int));
Jim Blandy's avatar
Jim Blandy committed
41

Andreas Schwab's avatar
Andreas Schwab committed
42 43 44
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
45

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

Gerd Moellmann's avatar
Gerd Moellmann committed
48 49
extern void (*insert_glyphs_hook) P_ ((struct glyph *s, int n));
extern void (*write_glyphs_hook) P_ ((struct glyph *s, int n));
Andreas Schwab's avatar
Andreas Schwab committed
50
extern void (*delete_glyphs_hook) P_ ((int));
Jim Blandy's avatar
Jim Blandy committed
51

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

Andreas Schwab's avatar
Andreas Schwab committed
54 55 56 57 58
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
59

60 61 62

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

64 65 66
enum scroll_bar_part {
  scroll_bar_above_handle,
  scroll_bar_handle,
67 68
  scroll_bar_below_handle,
  scroll_bar_up_arrow,
Gerd Moellmann's avatar
Gerd Moellmann committed
69 70 71
  scroll_bar_down_arrow,
  scroll_bar_to_top,
  scroll_bar_to_bottom,
72 73
  scroll_bar_end_scroll,
  scroll_bar_move_ratio
74 75 76
};

/* Return the current position of the mouse.
77 78 79 80 81

   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.

82 83 84 85
   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.
86 87 88 89 90 91 92 93

   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
94
extern void (*mouse_position_hook) P_ ((struct frame **f, int,
95
					Lisp_Object *bar_window,
96
					enum scroll_bar_part *part,
Jim Blandy's avatar
Jim Blandy committed
97 98
					Lisp_Object *x,
					Lisp_Object *y,
Andreas Schwab's avatar
Andreas Schwab committed
99
					unsigned long *time));
Jim Blandy's avatar
Jim Blandy committed
100 101 102 103 104

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

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

Jim Blandy's avatar
Jim Blandy committed
111 112 113 114 115 116 117 118 119 120
/* 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
121
extern void (*frame_raise_lower_hook) P_ ((struct frame *f, int raise));
122 123


124
/* Scroll bar hooks.  */
125

126
/* The representation of scroll bars is determined by the code which
127 128 129
   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
130
   dangling references when the scroll bar is destroyed.
131 132

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

137 138 139
   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.
140

141 142
   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
143 144 145
   fit.  They are marked by the garbage collector.  */


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


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

164 165
/* 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
166
   `*redeem_scroll_bar_hook' is applied to its window before the judgement.
167 168

   This should be applied to each frame each time its window tree is
169 170 171
   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.
172

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

178 179
/* 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
180
extern void (*redeem_scroll_bar_hook) P_ ((struct window *window));
181

182
/* Remove all scroll bars on FRAME that haven't been saved since the
183
   last call to `*condemn_scroll_bars_hook'.
184 185

   This should be applied to each frame after each time its window
186 187 188
   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.
189

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

195 196

/* Input queue declarations and hooks.  */
197

Jim Blandy's avatar
Jim Blandy committed
198
/* Expedient hack: only provide the below definitions to files that
199
   are prepared to handle lispy things.  CONSP is defined iff lisp.h
Jim Blandy's avatar
Jim Blandy committed
200
   has been included before this file.  */
201
#ifdef CONSP
Jim Blandy's avatar
Jim Blandy committed
202

203 204
enum event_kind
{
Pavel Janík's avatar
Pavel Janík committed
205
  NO_EVENT,			/* nothing happened.  This should never
Jim Blandy's avatar
Jim Blandy committed
206
				   actually appear in the event queue.  */
Jim Blandy's avatar
Jim Blandy committed
207

Pavel Janík's avatar
Pavel Janík committed
208
  ASCII_KEYSTROKE_EVENT,	/* The ASCII code is in .code, perhaps
Jim Blandy's avatar
Jim Blandy committed
209 210 211
				   with modifiers applied.
				   .modifiers holds the state of the
				   modifier keys.
212 213
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
214 215
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
Pavel Janík's avatar
Pavel Janík committed
216
  MULTIBYTE_CHAR_KEYSTROKE_EVENT,	/* The multibyte char code is in .code,
217 218
				   perhaps with modifiers applied.
				   The others are the same as
Dave Love's avatar
Dave Love committed
219
				   ASCII_KEYSTROKE_EVENT.  */
Pavel Janík's avatar
Pavel Janík committed
220
  NON_ASCII_KEYSTROKE_EVENT,	/* .code is a number identifying the
Jim Blandy's avatar
Jim Blandy committed
221 222 223 224 225 226
				   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
227
				   modifier keys.
228 229
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
230 231
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
Pavel Janík's avatar
Pavel Janík committed
232 233
  TIMER_EVENT,                  /* A timer fired.  */
  MOUSE_CLICK_EVENT,		/* The button number is in .code; it must
234 235
				   be >= 0 and < NUM_MOUSE_BUTTONS, defined
				   below.
Jim Blandy's avatar
Jim Blandy committed
236 237 238
				   .modifiers holds the state of the
				   modifier keys.
				   .x and .y give the mouse position,
Jim Blandy's avatar
Jim Blandy committed
239
				   in characters, within the window.
240 241
				   .frame_or_window gives the frame
				   the mouse click occurred in.
Jim Blandy's avatar
Jim Blandy committed
242 243
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
244 245 246 247 248 249 250 251 252 253 254 255
  WHEEL_EVENT,			/* A wheel event is generated by a
				   wheel on a mouse (e.g., MS
				   Intellimouse).
				   .modifiers holds the rotate
				   direction (up or down), and 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 event.  */
256 257 258 259 260
#if defined (WINDOWSNT) || defined (MAC_OS)
  LANGUAGE_CHANGE_EVENT,	/* A LANGUAGE_CHANGE_EVENT is
				   generated on WINDOWSNT or Mac OS
				   when the keyboard layout or input
				   language is changed by the
261
				   user.  */
262
#endif
Pavel Janík's avatar
Pavel Janík committed
263
  SCROLL_BAR_CLICK_EVENT,	/* .code gives the number of the mouse button
264 265 266
				   that was clicked.
				   .modifiers holds the state of the modifier
				   keys.
Jim Blandy's avatar
Jim Blandy committed
267
				   .part is a lisp symbol indicating which
268
				   part of the scroll bar got clicked.
269 270 271
				   .x gives the distance from the start of the
				   scroll bar of the click; .y gives the total
				   length of the scroll bar.
272
				   .frame_or_window gives the window
273
				   whose scroll bar was clicked in.
Jim Blandy's avatar
Jim Blandy committed
274 275
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
276
#ifdef WINDOWSNT
Pavel Janík's avatar
Pavel Janík committed
277
  W32_SCROLL_BAR_CLICK_EVENT,	/* as for SCROLL_BAR_CLICK, but only generated
278 279
				   by MS-Windows scroll bar controls. */
#endif
Pavel Janík's avatar
Pavel Janík committed
280
  SELECTION_REQUEST_EVENT,	/* Another X client wants a selection from us.
281
				   See `struct selection_event'.  */
Pavel Janík's avatar
Pavel Janík committed
282 283 284
  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".  */
285
  MENU_BAR_EVENT,		/* An event generated by the menu bar.
286
				   The frame_or_window field's cdr holds the
287 288
				   Lisp-level event value.
				   (Only the toolkit version uses these.)  */
Pavel Janík's avatar
Pavel Janík committed
289 290 291
  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
292
				   (toolkit version only).  */
Pavel Janík's avatar
Pavel Janík committed
293
  DRAG_N_DROP_EVENT,		/* A drag-n-drop event is generated when
294 295 296
				   files selected outside of Emacs are dropped
				   onto an Emacs window.
				   Currently used only on Windows NT.
297
				   .modifiers holds the state of the
298 299 300 301 302 303 304 305
				   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.  */
306 307
  USER_SIGNAL_EVENT,		/* A user signal.
                                   code is a number identifying it,
Gerd Moellmann's avatar
Gerd Moellmann committed
308 309
                                   index into lispy_user_signals.  */

310 311 312
  /* Help events.  Member `frame_or_window' of the input_event is the
     frame on which the event occurred, and member `arg' contains
     the help to show.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
313 314
  HELP_EVENT,

315 316 317
  /* An event from a tool-bar.  Member `arg' of the input event
     contains the tool-bar item selected.  If `frame_or_window'
     and `arg' are equal, this is a prefix event.  */
318 319 320 321
  TOOL_BAR_EVENT,

  /* Queued from XTread_socket on FocusIn events.  Translated into
     `switch-frame' events in kbd_buffer_get_event, if necessary.  */
322 323
  FOCUS_IN_EVENT,

324 325 326
  /* Generated when mouse moves over window not currently selected.  */
  SELECT_WINDOW_EVENT,

327 328
  /* Queued from XTread_socket when session manager sends
     save yourself before shutdown. */
Pavel Janík's avatar
Pavel Janík committed
329
  SAVE_SESSION_EVENT
330 331
};

Pavel Janík's avatar
Pavel Janík committed
332 333
/* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
   or SELECTION_CLEAR_EVENT, then its contents are really described
334 335 336 337 338 339 340
   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.  */

341 342
struct input_event
{
343
  /* What kind of event was this?  */
344
  enum event_kind kind;
345

Pavel Janík's avatar
Pavel Janík committed
346 347 348
  /* For an ASCII_KEYSTROKE_EVENT and MULTIBYTE_CHAR_KEYSTROKE_EVENT,
     this is the character.
     For a NON_ASCII_KEYSTROKE_EVENT, this is the keysym code.
349
     For a mouse event, this is the button number.  */
350
  /* In WindowsNT, for a mouse wheel event, this is the delta.  */
351
  int code;
352
  enum scroll_bar_part part;
353

354 355 356 357 358
  int modifiers;		/* See enum below for interpretation.  */

  Lisp_Object x, y;
  unsigned long timestamp;

359 360 361 362
  /* This is padding just to put the frame_or_window field
     past the size of struct selection_event.  */
  int *padding[2];

363 364
  /* This field is copied into a vector while the event is in the queue,
     so that garbage collections won't kill it.  */
365 366
  /* 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.  */
367 368
  /* This field is last so that struct selection_input_event
     does not overlap with it.  */
369
  Lisp_Object frame_or_window;
370 371 372 373

  /* Additional event argument.  This is used for TOOL_BAR_EVENTs and
     HELP_EVENTs and avoids calling Fcons during signal handling.  */
  Lisp_Object arg;
Jim Blandy's avatar
Jim Blandy committed
374
};
Andreas Schwab's avatar
Andreas Schwab committed
375

Stefan Monnier's avatar
Stefan Monnier committed
376 377
#define EVENT_INIT(event) bzero (&(event), sizeof (struct input_event))

Andreas Schwab's avatar
Andreas Schwab committed
378
/* Called to read input events.  */
379
extern int (*read_socket_hook) P_ ((int, int, struct input_event *));
Andreas Schwab's avatar
Andreas Schwab committed
380 381 382

/* Called when a frame's display becomes entirely up to date.  */
extern void (*frame_up_to_date_hook) P_ ((struct frame *));
383

384

385 386
/* Bits in the modifiers member of the input_event structure.
   Note that reorder_modifiers assumes that the bits are in canonical
387
   order.
388 389 390

   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
391 392 393 394 395 396
   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
397 398 399 400 401
   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
402
enum {
403 404 405
  up_modifier	=   1,		/* Only used on mouse buttons - always
				   turned into a click or a drag modifier
				   before lisp code sees the event.  */
406 407
  down_modifier =   2,		/* Only used on mouse buttons.  */
  drag_modifier =   4,		/* This is never used in the event
408 409
				   queue; it's only used internally by
				   the window-system-independent code.  */
410
  click_modifier=   8,		/* See drag_modifier.  */
411 412
  double_modifier= 16,          /* See drag_modifier.  */
  triple_modifier= 32,          /* See drag_modifier.  */
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430

  /* 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,
431
  meta_modifier	=  CHAR_META	/* Under X, the XK_Meta_[LR] keysyms.  */
Jim Blandy's avatar
Jim Blandy committed
432 433 434
};

#endif
Miles Bader's avatar
Miles Bader committed
435 436 437

/* arch-tag: 33a00ecc-52b5-4186-a410-8801ac9f087d
   (do not change this comment) */