termhooks.h 17.8 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, 2001, 2002, 2003, 2004,
                 2005, 2006, 2007  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

Jan Djärv's avatar
Jan Djärv committed
123 124 125 126 127
/* If the value of the frame parameter changed, whis hook is called.
   For example, if going from fullscreen to not fullscreen this hook
   may do something OS dependent, like extended window manager hints on X11.  */
extern void (*fullscreen_hook) P_ ((struct frame *f));

128

129
/* Scroll bar hooks.  */
130

131
/* The representation of scroll bars is determined by the code which
132 133 134
   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
135
   dangling references when the scroll bar is destroyed.
136 137

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

142 143 144
   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.
145

146 147
   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
148 149 150
   fit.  They are marked by the garbage collector.  */


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


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

169 170
/* 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
171
   `*redeem_scroll_bar_hook' is applied to its window before the judgement.
172 173

   This should be applied to each frame each time its window tree is
174 175 176
   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.
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.  */
Andreas Schwab's avatar
Andreas Schwab committed
181
extern void (*condemn_scroll_bars_hook) P_ ((struct frame *frame));
182

183 184
/* 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
185
extern void (*redeem_scroll_bar_hook) P_ ((struct window *window));
186

187
/* Remove all scroll bars on FRAME that haven't been saved since the
188
   last call to `*condemn_scroll_bars_hook'.
189 190

   This should be applied to each frame after each time its window
191 192 193
   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.
194

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

200 201

/* Input queue declarations and hooks.  */
202

Jim Blandy's avatar
Jim Blandy committed
203
/* Expedient hack: only provide the below definitions to files that
204
   are prepared to handle lispy things.  CONSP is defined iff lisp.h
Jim Blandy's avatar
Jim Blandy committed
205
   has been included before this file.  */
206
#ifdef CONSP
Jim Blandy's avatar
Jim Blandy committed
207

208 209
enum event_kind
{
Pavel Janík's avatar
Pavel Janík committed
210
  NO_EVENT,			/* nothing happened.  This should never
Jim Blandy's avatar
Jim Blandy committed
211
				   actually appear in the event queue.  */
Jim Blandy's avatar
Jim Blandy committed
212

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

315 316 317
  /* 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
318 319
  HELP_EVENT,

320 321 322
  /* 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.  */
323 324 325 326
  TOOL_BAR_EVENT,

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

329 330 331
  /* Generated when mouse moves over window not currently selected.  */
  SELECT_WINDOW_EVENT,

332 333
  /* Queued from XTread_socket when session manager sends
     save yourself before shutdown. */
334 335 336 337 338 339
  SAVE_SESSION_EVENT,

#ifdef MAC_OS
  /* Generated when an Apple event, a HICommand event, or a Services
     menu event is received and the corresponding handler is
     registered.  Members `x' and `y' are for the event class and ID
340 341 342
     symbols, respectively.  Member `arg' is a Lisp object converted
     from the received Apple event.  Parameters for non-Apple events
     are converted to those in Apple events.  */
343 344
  MAC_APPLE_EVENT
#endif
345 346
};

Pavel Janík's avatar
Pavel Janík committed
347 348
/* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
   or SELECTION_CLEAR_EVENT, then its contents are really described
349
   by `struct selection_input_event'; see xterm.h.  */
350 351 352 353 354 355

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

356 357
struct input_event
{
358
  /* What kind of event was this?  */
359
  enum event_kind kind;
360

Pavel Janík's avatar
Pavel Janík committed
361 362 363
  /* 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.
364
     For a mouse event, this is the button number.  */
365
  /* In WindowsNT, for a mouse wheel event, this is the delta.  */
366
  int code;
367
  enum scroll_bar_part part;
368

369 370 371 372 373
  int modifiers;		/* See enum below for interpretation.  */

  Lisp_Object x, y;
  unsigned long timestamp;

374
  /* This is padding just to put the frame_or_window field
375
     past the size of struct selection_input_event.  */
376 377
  int *padding[2];

378 379
  /* This field is copied into a vector while the event is in the queue,
     so that garbage collections won't kill it.  */
380 381
  /* 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.  */
382 383
  /* This field is last so that struct selection_input_event
     does not overlap with it.  */
384
  Lisp_Object frame_or_window;
385 386 387 388

  /* 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
389
};
Andreas Schwab's avatar
Andreas Schwab committed
390

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

Andreas Schwab's avatar
Andreas Schwab committed
393
/* Called to read input events.  */
394
extern int (*read_socket_hook) P_ ((int, int, struct input_event *));
Andreas Schwab's avatar
Andreas Schwab committed
395 396 397

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

400 401
/* Bits in the modifiers member of the input_event structure.
   Note that reorder_modifiers assumes that the bits are in canonical
402
   order.
403 404 405

   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
406 407 408 409 410 411
   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
412 413 414 415 416
   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
417
enum {
418 419 420
  up_modifier	=   1,		/* Only used on mouse buttons - always
				   turned into a click or a drag modifier
				   before lisp code sees the event.  */
421 422
  down_modifier =   2,		/* Only used on mouse buttons.  */
  drag_modifier =   4,		/* This is never used in the event
423 424
				   queue; it's only used internally by
				   the window-system-independent code.  */
425
  click_modifier=   8,		/* See drag_modifier.  */
426 427
  double_modifier= 16,          /* See drag_modifier.  */
  triple_modifier= 32,          /* See drag_modifier.  */
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445

  /* 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,
446
  meta_modifier	=  CHAR_META	/* Under X, the XK_Meta_[LR] keysyms.  */
Jim Blandy's avatar
Jim Blandy committed
447 448 449
};

#endif
Miles Bader's avatar
Miles Bader committed
450 451 452

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