termhooks.h 17 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

/* Miscellanea.   */

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

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

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

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
47
extern void (*change_line_highlight_hook) P_ ((int, int, int, int));
Andreas Schwab's avatar
Andreas Schwab committed
48
extern void (*reassert_line_highlight_hook) P_ ((int, int));
Jim Blandy's avatar
Jim Blandy committed
49

Gerd Moellmann's avatar
Gerd Moellmann committed
50 51
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
52
extern void (*delete_glyphs_hook) P_ ((int));
Jim Blandy's avatar
Jim Blandy committed
53

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

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

62 63 64

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

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

/* Return the current position of the mouse.
79 80 81 82 83

   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.

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

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

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

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

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


126
/* Scroll bar hooks.  */
127

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

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

139 140 141
   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.
142

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


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


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

166 167 168
/* 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. 
169 170

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

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

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

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

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

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

197 198

/* Input queue declarations and hooks.  */
199

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

205 206 207
enum event_kind
{
  no_event,			/* nothing happened.  This should never
Jim Blandy's avatar
Jim Blandy committed
208
				   actually appear in the event queue.  */
Jim Blandy's avatar
Jim Blandy committed
209 210 211 212 213

  ascii_keystroke,		/* The ASCII code is in .code, perhaps
				   with modifiers applied.
				   .modifiers holds the state of the
				   modifier keys.
214 215
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
216 217
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
218 219 220 221 222 223
  multibyte_char_keystroke,	/* The multibye char code is in .code,
				   perhaps with modifiers applied.
				   The others are the same as
				   ascii_keystroke.  This type of event
				   is generated only when we are using
				   XIM on X window.  */
224
  non_ascii_keystroke,		/* .code is a number identifying the
Jim Blandy's avatar
Jim Blandy committed
225 226 227 228 229 230
				   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
231
				   modifier keys.
232 233
				   .frame_or_window is the frame in
				   which the key was typed.
Jim Blandy's avatar
Jim Blandy committed
234 235
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
236
  timer_event,                  /* A timer fired.  */
237
  mouse_click,			/* The button number is in .code; it must
238 239
				   be >= 0 and < NUM_MOUSE_BUTTONS, defined
				   below.
Jim Blandy's avatar
Jim Blandy committed
240 241 242
				   .modifiers holds the state of the
				   modifier keys.
				   .x and .y give the mouse position,
Jim Blandy's avatar
Jim Blandy committed
243
				   in characters, within the window.
244 245
				   .frame_or_window gives the frame
				   the mouse click occurred in.
Jim Blandy's avatar
Jim Blandy committed
246 247
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
248
#ifdef WINDOWSNT
249 250
  mouse_wheel,			/* A mouse-wheel event is generated 
				   on WINDOWSNT by a 
251 252 253 254 255 256 257 258 259 260 261 262 263 264
				   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.  */
265 266 267 268
  language_change_event,	/* A language_change event is generated
				   on WINDOWSNT when the keyboard layout
				   or input language is changed by the
				   user.  */
269
#endif
270
  scroll_bar_click,		/* .code gives the number of the mouse button
271 272 273
				   that was clicked.
				   .modifiers holds the state of the modifier
				   keys.
Jim Blandy's avatar
Jim Blandy committed
274
				   .part is a lisp symbol indicating which
275
				   part of the scroll bar got clicked.
276 277 278
				   .x gives the distance from the start of the
				   scroll bar of the click; .y gives the total
				   length of the scroll bar.
279
				   .frame_or_window gives the window
280
				   whose scroll bar was clicked in.
Jim Blandy's avatar
Jim Blandy committed
281 282
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
283
#ifdef WINDOWSNT
284
  w32_scroll_bar_click,	/* as for scroll_bar_click, but only generated
285 286
				   by MS-Windows scroll bar controls. */
#endif
287 288
  selection_request_event,	/* Another X client wants a selection from us.
				   See `struct selection_event'.  */
289
  selection_clear_event,	/* Another X client cleared our selection.  */
290
  buffer_switch_event,		/* A process filter has switched buffers.  */
291
  delete_window_event,		/* An X client said "delete this window".  */
292
  MENU_BAR_EVENT,		/* An event generated by the menu bar.
293
				   The frame_or_window field's cdr holds the
294 295
				   Lisp-level event value.
				   (Only the toolkit version uses these.)  */
296
  iconify_event,		/* An X client iconified this window.  */
297
  deiconify_event,		/* An X client deiconified this window.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
298
  menu_bar_activate_event,      /* A button press in the menu bar
299
				   (toolkit version only).  */
300
  drag_n_drop,			/* A drag-n-drop event is generated when
301 302 303 304 305 306 307 308 309 310 311 312
				   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.  */
313 314
  USER_SIGNAL_EVENT,		/* A user signal.
                                   code is a number identifying it,
Gerd Moellmann's avatar
Gerd Moellmann committed
315 316
                                   index into lispy_user_signals.  */

317 318 319
  /* 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
320 321
  HELP_EVENT,

322 323 324
  /* 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.  */
325 326 327 328 329
  TOOL_BAR_EVENT,

  /* Queued from XTread_socket on FocusIn events.  Translated into
     `switch-frame' events in kbd_buffer_get_event, if necessary.  */
  FOCUS_IN_EVENT
330 331 332 333 334 335 336 337 338 339 340
};

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

341 342
struct input_event
{
343
  /* What kind of event was this?  */
344
  int kind;
Jim Blandy's avatar
Jim Blandy committed
345
  
346 347
  /* For an ascii_keystroke and multibyte_char_keystroke, this is the
     character.
348
     For a non_ascii_keystroke, 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 376 377 378 379 380

/* 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 *));
381

382

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

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

#endif