termhooks.h 9.11 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.
Jim Blandy's avatar
Jim Blandy committed
3
   Copyright (C) 1985, 1986, 1992 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 19 20 21 22 23 24 25
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
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */


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

extern int (*clear_to_end_hook) ();
Jim Blandy's avatar
Jim Blandy committed
26
extern int (*clear_frame_hook) ();
Jim Blandy's avatar
Jim Blandy committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
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) ();

extern int (*read_socket_hook) ();

48 49 50 51 52 53 54 55 56 57
enum scrollbar_part {
  scrollbar_above_handle,
  scrollbar_handle,
  scrollbar_below_handle
};

/* Return the current position of the mouse.
   Set `bar' to point to the scrollbar if the mouse movement started
   in a scrollbar, or zero if it started elsewhere in the frame.
   This should clear mouse_moved until the next motion event arrives.  */
Jim Blandy's avatar
Jim Blandy committed
58
extern void (*mouse_position_hook) ( /* FRAME_PTR *f,
59 60
					struct scrollbar **bar,
					enum scrollbar_part *part,
Jim Blandy's avatar
Jim Blandy committed
61 62
					Lisp_Object *x,
					Lisp_Object *y,
Jim Blandy's avatar
Jim Blandy committed
63
					unsigned long *time */ );
Jim Blandy's avatar
Jim Blandy committed
64 65 66 67 68

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

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

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
/* Set vertical scollbar BAR to have its upper left corner 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.  Return BAR.  If BAR is zero,
   create a new scrollbar and return a pointer to it.  */
extern struct scrollbar *(*set_vertical_scrollbar_hook)
     ( /* struct scrollbar *BAR,
	  struct window *window,
	  int portion, int whole, int position */ );


/* The following three hooks are used when we're doing a thorough
   redisplay of the frame.  We don't explicitly know which scrollbars
   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*
   scrollbars are to be removed, and then save scrollbars from the
   firey pit when we actually redisplay their window.  */

/* Arrange for all scrollbars on FRAME to be removed at the next call
   to `*judge_scrollbars_hook'.  A scrollbar may be spared if
   `*redeem_scrollbar_hook' is applied to it before the judgement.  */
extern void (*condemn_scrollbars_hook)( /* FRAME_PTR *FRAME */ );

/* Unmark BAR for deletion in this judgement cycle.  */
extern void (*redeem_scrollbar_hook)( /* struct scrollbar *BAR */ );

/* Remove all scrollbars on FRAME that haven't been saved since the
   last call to `*condemn_scrollbars_hook'.  */
extern void (*judge_scrollbars_hook)( /* FRAME_PTR *FRAME */ );



Jim Blandy's avatar
Jim Blandy committed
108 109 110 111 112
/* If nonzero, send all terminal output characters to this stream also.  */
extern FILE *termscript;

/* Expedient hack: only provide the below definitions to files that
   are prepared to handle lispy things.  XINT is defined iff lisp.h
Jim Blandy's avatar
Jim Blandy committed
113 114
   has been included before this file.  */
#ifdef XINT
Jim Blandy's avatar
Jim Blandy committed
115 116 117 118 119 120 121 122 123 124 125 126

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

struct input_event {

  /* What kind of event was this?  */
  enum {
    no_event,			/* nothing happened.  This should never
				   actually appear in the event queue.  */
Jim Blandy's avatar
Jim Blandy committed
127
    ascii_keystroke,		/* The ASCII code is in .code.
Jim Blandy's avatar
Jim Blandy committed
128
				   .frame is the frame in which the key
Jim Blandy's avatar
Jim Blandy committed
129 130 131
				   was typed.
				   Note that this includes meta-keys, and
				   the modifiers field of the event
Jim Blandy's avatar
Jim Blandy committed
132 133 134
				   is unused.
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
Jim Blandy's avatar
Jim Blandy committed
135 136 137 138 139 140 141
    non_ascii_keystroke,	/* .code is a number identifying the
				   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
142
				   modifier keys.
Jim Blandy's avatar
Jim Blandy committed
143
				   .frame is the frame in which the key
Jim Blandy's avatar
Jim Blandy committed
144 145 146
				   was typed.
				   .timestamp gives a timestamp (in
				   milliseconds) for the keystroke.  */
147 148 149
    mouse_click,		/* The button number is in .code; it must
				   be >= 0 and < NUM_MOUSE_BUTTONS, defined
				   below.
Jim Blandy's avatar
Jim Blandy committed
150 151 152
				   .modifiers holds the state of the
				   modifier keys.
				   .x and .y give the mouse position,
Jim Blandy's avatar
Jim Blandy committed
153
				   in characters, within the window.
Jim Blandy's avatar
Jim Blandy committed
154
				   .frame gives the frame the mouse
Jim Blandy's avatar
Jim Blandy committed
155 156 157
				   click occurred in.
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
158 159 160 161 162

    scrollbar_click,		/* .code gives the number of the mouse button
				   that was clicked.
				   .modifiers holds the state of the modifier
				   keys.
Jim Blandy's avatar
Jim Blandy committed
163
				   .part is a lisp symbol indicating which
164 165 166 167 168 169 170 171 172 173 174 175 176
				   part of the scrollbar got clicked.
				   .scrollbar is a pointer to the scrollbar
				   clicked on.  Since redisplay may delete
				   scrollbars at any time, you may not assume
				   that this scrollbar still exists when you
				   dequeue this event.  You have to traverse
				   the window tree to make it's in a valid
				   window.
				   .x gives the distance from the start of the
				   scroll bar of the click; .y gives the total
				   length of the scroll bar.
				   .frame gives the frame the click should
				   apply to.
Jim Blandy's avatar
Jim Blandy committed
177 178 179 180 181
				   .timestamp gives a timestamp (in
				   milliseconds) for the click.  */
  } kind;
  
  Lisp_Object code;
182 183
  enum scrollbar_part part;
  struct scrollbar *scrollbar;
Jim Blandy's avatar
Jim Blandy committed
184 185

/* This is obviously wrong, but I'm not sure what else I should do.
Jim Blandy's avatar
Jim Blandy committed
186 187
   Obviously, this should be a FRAME_PTR.  But that would require that
   every file which #includes this one should also #include "frame.h",
Jim Blandy's avatar
Jim Blandy committed
188
   which would mean that files like cm.c and other innocents would be
Jim Blandy's avatar
Jim Blandy committed
189
   dragged into the set of frame.h users.  Maybe the definition of this
Jim Blandy's avatar
Jim Blandy committed
190
   structure should be elsewhere?  In its own file?  */
Jim Blandy's avatar
Jim Blandy committed
191 192
#ifdef MULTI_FRAME
  struct frame *frame;
Jim Blandy's avatar
Jim Blandy committed
193
#else
Jim Blandy's avatar
Jim Blandy committed
194
  int frame;
Jim Blandy's avatar
Jim Blandy committed
195
#endif
Jim Blandy's avatar
Jim Blandy committed
196
  int modifiers;		/* See enum below for interpretation.  */
Jim Blandy's avatar
Jim Blandy committed
197

Jim Blandy's avatar
Jim Blandy committed
198
  Lisp_Object x, y;
Jim Blandy's avatar
Jim Blandy committed
199
  unsigned long timestamp;
Jim Blandy's avatar
Jim Blandy committed
200 201
};

202 203 204 205
/* This is used in keyboard.c, to tell how many buttons we will need
   to track the positions of.  */
#define NUM_MOUSE_BUTTONS (5)

206 207
/* Bits in the modifiers member of the input_event structure.
   Note that reorder_modifiers assumes that the bits are in canonical
208 209 210 211
   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
212 213 214 215 216 217 218 219 220 221
   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
   bits into either drag_modifier or click_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
222
enum {
223 224 225
  up_modifier	=   1,		/* Only used on mouse buttons - always
				   turned into a click or a drag modifier
				   before lisp code sees the event.  */
226 227 228 229 230 231
  alt_modifier	=   2,		/* Under X, the XK_Alt_[LR] keysyms.  */
  ctrl_modifier	=   4,
  hyper_modifier=   8,		/* Under X, the XK_Hyper_[LR] keysyms.  */
  meta_modifier	=  16,		/* Under X, the XK_Meta_[LR] keysyms.  */
  shift_modifier=  32,
  super_modifier=  64,		/* Under X, the XK_Super_[LR] keysyms.  */
232 233 234 235 236
  down_modifier = 128,		/* Only used on mouse buttons.  */
  drag_modifier = 256,		/* This is never used in the event
				   queue; it's only used internally by
				   the window-system-independent code.  */
  click_modifier= 512,		/* See drag_modifier.  */
Jim Blandy's avatar
Jim Blandy committed
237 238 239 240 241
  last_modifier			/* This should always be one more than the
				   highest modifier bit defined.  */
};

#endif