termhooks.h 14 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 28 29

/* 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
30 31 32 33 34

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

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

55 56 57

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

59 60 61
enum scroll_bar_part {
  scroll_bar_above_handle,
  scroll_bar_handle,
62 63
  scroll_bar_below_handle,
  scroll_bar_up_arrow,
64
  scroll_bar_down_arrow
65 66 67
};

/* Return the current position of the mouse.
68 69 70 71 72

   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.

73 74 75 76
   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.
77 78 79 80 81 82 83 84

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

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

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

Jim Blandy's avatar
Jim Blandy committed
102 103 104 105 106 107 108 109 110 111 112
/* 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 */ );
113 114


115
/* Scroll bar hooks.  */
116

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

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

128 129 130
   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.
131

132 133
   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
134 135 136
   fit.  They are marked by the garbage collector.  */


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


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

155 156 157
/* 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. 
158 159

   This should be applied to each frame each time its window tree is
160 161 162
   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.
163

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

169 170 171
/* 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 */ );
172

173 174
/* Remove all scroll bars on FRAME that haven't been saved since the
   last call to `*condemn_scroll_bars_hook'.  
175 176

   This should be applied to each frame after each time its window
177 178 179
   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.
180

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

186 187

/* Input queue declarations and hooks.  */
188

189
/* Called to read input events.  */
190
extern int (*read_socket_hook) ();
Jim Blandy's avatar
Jim Blandy committed
191

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

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

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

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

278 279
struct input_event
{
280 281

  /* What kind of event was this?  */
282
  int kind;
Jim Blandy's avatar
Jim Blandy committed
283
  
284 285
  /* For an ascii_keystroke, this is the character.
     For a non_ascii_keystroke, this is the keysym code.
286
     For a mouse event, this is the button number.  */
287
  int code;
288
  enum scroll_bar_part part;
289

290 291 292 293 294
  int modifiers;		/* See enum below for interpretation.  */

  Lisp_Object x, y;
  unsigned long timestamp;

295 296 297 298
  /* This is padding just to put the frame_or_window field
     past the size of struct selection_event.  */
  int *padding[2];

299 300
  /* This field is copied into a vector while the event is in the queue,
     so that garbage collections won't kill it.  */
301 302
  /* 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.  */
303 304
  /* This field is last so that struct selection_input_event
     does not overlap with it.  */
305
  Lisp_Object frame_or_window;
Jim Blandy's avatar
Jim Blandy committed
306
};
307

308 309 310 311
/* This is used in keyboard.c, to tell how many buttons we will need
   to track the positions of.  */
#define NUM_MOUSE_BUTTONS (5)

312 313
/* Bits in the modifiers member of the input_event structure.
   Note that reorder_modifiers assumes that the bits are in canonical
314 315 316 317
   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
318 319 320 321 322 323
   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
324 325 326 327 328
   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
329
enum {
330 331 332
  up_modifier	=   1,		/* Only used on mouse buttons - always
				   turned into a click or a drag modifier
				   before lisp code sees the event.  */
333 334
  down_modifier =   2,		/* Only used on mouse buttons.  */
  drag_modifier =   4,		/* This is never used in the event
335 336
				   queue; it's only used internally by
				   the window-system-independent code.  */
337
  click_modifier=   8,		/* See drag_modifier.  */
338 339
  double_modifier= 16,          /* See drag_modifier.  */
  triple_modifier= 32,          /* See drag_modifier.  */
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357

  /* 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,
358
  meta_modifier	=  CHAR_META	/* Under X, the XK_Meta_[LR] keysyms.  */
Jim Blandy's avatar
Jim Blandy committed
359 360 361
};

#endif