Merged in changes from CVS trunk.
[bpt/emacs.git] / src / termhooks.h
1 /* Parameters and display hooks for output devices
2 Copyright (C) 1985,86,93,94,2003 Free Software Foundation, Inc.
3
4 This file is part of GNU Emacs.
5
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
20
21 \f
22 /* Miscellanea. */
23
24 struct glyph;
25 struct frame;
26
27 /* Only use prototypes when lisp.h has been included. */
28 #ifndef P_
29 #define P_(X) ()
30 #endif
31 \f
32
33 enum scroll_bar_part {
34 scroll_bar_above_handle,
35 scroll_bar_handle,
36 scroll_bar_below_handle,
37 scroll_bar_up_arrow,
38 scroll_bar_down_arrow,
39 scroll_bar_to_top,
40 scroll_bar_to_bottom,
41 scroll_bar_end_scroll,
42 scroll_bar_move_ratio
43 };
44
45 \f
46 /* Input queue declarations and hooks. */
47
48 /* Expedient hack: only provide the below definitions to files that
49 are prepared to handle lispy things. CONSP is defined iff lisp.h
50 has been included before this file. */
51 #ifdef CONSP
52
53 enum event_kind
54 {
55 NO_EVENT, /* nothing happened. This should never
56 actually appear in the event queue. */
57
58 ASCII_KEYSTROKE_EVENT, /* The ASCII code is in .code, perhaps
59 with modifiers applied.
60 .modifiers holds the state of the
61 modifier keys.
62 .frame_or_window is the frame in
63 which the key was typed.
64 .timestamp gives a timestamp (in
65 milliseconds) for the keystroke. */
66 MULTIBYTE_CHAR_KEYSTROKE_EVENT, /* The multibyte char code is in .code,
67 perhaps with modifiers applied.
68 The others are the same as
69 ASCII_KEYSTROKE_EVENT. */
70 NON_ASCII_KEYSTROKE_EVENT, /* .code is a number identifying the
71 function key. A code N represents
72 a key whose name is
73 function_key_names[N]; function_key_names
74 is a table in keyboard.c to which you
75 should feel free to add missing keys.
76 .modifiers holds the state of the
77 modifier keys.
78 .frame_or_window is the frame in
79 which the key was typed.
80 .timestamp gives a timestamp (in
81 milliseconds) for the keystroke. */
82 TIMER_EVENT, /* A timer fired. */
83 MOUSE_CLICK_EVENT, /* The button number is in .code; it must
84 be >= 0 and < NUM_MOUSE_BUTTONS, defined
85 below.
86 .modifiers holds the state of the
87 modifier keys.
88 .x and .y give the mouse position,
89 in characters, within the window.
90 .frame_or_window gives the frame
91 the mouse click occurred in.
92 .timestamp gives a timestamp (in
93 milliseconds) for the click. */
94 WHEEL_EVENT, /* A wheel event is generated by a
95 wheel on a mouse (e.g., MS
96 Intellimouse).
97 .modifiers holds the rotate
98 direction (up or down), and the
99 state of the modifier keys.
100 .x and .y give the mouse position,
101 in characters, within the window.
102 .frame_or_window gives the frame
103 the wheel event occurred in.
104 .timestamp gives a timestamp (in
105 milliseconds) for the event. */
106 #ifdef WINDOWSNT
107 LANGUAGE_CHANGE_EVENT, /* A LANGUAGE_CHANGE_EVENT is generated
108 on WINDOWSNT when the keyboard layout
109 or input language is changed by the
110 user. */
111 #endif
112 SCROLL_BAR_CLICK_EVENT, /* .code gives the number of the mouse button
113 that was clicked.
114 .modifiers holds the state of the modifier
115 keys.
116 .part is a lisp symbol indicating which
117 part of the scroll bar got clicked.
118 .x gives the distance from the start of the
119 scroll bar of the click; .y gives the total
120 length of the scroll bar.
121 .frame_or_window gives the window
122 whose scroll bar was clicked in.
123 .timestamp gives a timestamp (in
124 milliseconds) for the click. */
125 #ifdef WINDOWSNT
126 W32_SCROLL_BAR_CLICK_EVENT, /* as for SCROLL_BAR_CLICK, but only generated
127 by MS-Windows scroll bar controls. */
128 #endif
129 SELECTION_REQUEST_EVENT, /* Another X client wants a selection from us.
130 See `struct selection_event'. */
131 SELECTION_CLEAR_EVENT, /* Another X client cleared our selection. */
132 BUFFER_SWITCH_EVENT, /* A process filter has switched buffers. */
133 DELETE_WINDOW_EVENT, /* An X client said "delete this window". */
134 MENU_BAR_EVENT, /* An event generated by the menu bar.
135 The frame_or_window field's cdr holds the
136 Lisp-level event value.
137 (Only the toolkit version uses these.) */
138 ICONIFY_EVENT, /* An X client iconified this window. */
139 DEICONIFY_EVENT, /* An X client deiconified this window. */
140 MENU_BAR_ACTIVATE_EVENT, /* A button press in the menu bar
141 (toolkit version only). */
142 DRAG_N_DROP_EVENT, /* A drag-n-drop event is generated when
143 files selected outside of Emacs are dropped
144 onto an Emacs window.
145 Currently used only on Windows NT.
146 .modifiers holds the state of the
147 modifier keys.
148 .x and .y give the mouse position,
149 in characters, within the window.
150 .frame_or_window is a cons of the frame
151 in which the drop was made and a list of
152 the filenames of the dropped files.
153 .timestamp gives a timestamp (in
154 milliseconds) for the click. */
155 USER_SIGNAL_EVENT, /* A user signal.
156 code is a number identifying it,
157 index into lispy_user_signals. */
158
159 /* Help events. Member `frame_or_window' of the input_event is the
160 frame on which the event occurred, and member `arg' contains
161 the help to show. */
162 HELP_EVENT,
163
164 /* An event from a tool-bar. Member `arg' of the input event
165 contains the tool-bar item selected. If `frame_or_window'
166 and `arg' are equal, this is a prefix event. */
167 TOOL_BAR_EVENT,
168
169 /* Queued from XTread_socket on FocusIn events. Translated into
170 `switch-frame' events in kbd_buffer_get_event, if necessary. */
171 FOCUS_IN_EVENT,
172
173 /* Generated when mouse moves over window not currently selected. */
174 SELECT_WINDOW_EVENT,
175
176 /* Queued from XTread_socket when session manager sends
177 save yourself before shutdown. */
178 SAVE_SESSION_EVENT
179 };
180
181 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
182 or SELECTION_CLEAR_EVENT, then its contents are really described
183 by `struct selection_event'; see xterm.h. */
184
185 /* The keyboard input buffer is an array of these structures. Each one
186 represents some sort of input event - a keystroke, a mouse click, or
187 a window system event. These get turned into their lispy forms when
188 they are removed from the event queue. */
189
190 struct input_event
191 {
192 /* What kind of event was this? */
193 enum event_kind kind;
194
195 /* For an ASCII_KEYSTROKE_EVENT and MULTIBYTE_CHAR_KEYSTROKE_EVENT,
196 this is the character.
197 For a NON_ASCII_KEYSTROKE_EVENT, this is the keysym code.
198 For a mouse event, this is the button number. */
199 /* In WindowsNT, for a mouse wheel event, this is the delta. */
200 int code;
201 enum scroll_bar_part part;
202
203 int modifiers; /* See enum below for interpretation. */
204
205 Lisp_Object x, y;
206 unsigned long timestamp;
207
208 /* This is padding just to put the frame_or_window field
209 past the size of struct selection_event. */
210 int *padding[2];
211
212 /* This field is copied into a vector while the event is in the queue,
213 so that garbage collections won't kill it. */
214 /* In a menu_bar_event, this is a cons cell whose car is the frame
215 and whose cdr is the Lisp object that is the event's value. */
216 /* This field is last so that struct selection_input_event
217 does not overlap with it. */
218 Lisp_Object frame_or_window;
219
220 /* Additional event argument. This is used for TOOL_BAR_EVENTs and
221 HELP_EVENTs and avoids calling Fcons during signal handling. */
222 Lisp_Object arg;
223 };
224
225 #define EVENT_INIT(event) bzero (&(event), sizeof (struct input_event))
226
227 /* Bits in the modifiers member of the input_event structure.
228 Note that reorder_modifiers assumes that the bits are in canonical
229 order.
230
231 The modifiers applied to mouse clicks are rather ornate. The
232 window-system-specific code should store mouse clicks with
233 up_modifier or down_modifier set. Having an explicit down modifier
234 simplifies some of window-system-independent code; without it, the
235 code would have to recognize down events by checking if the event
236 is a mouse click lacking the click and drag modifiers.
237
238 The window-system independent code turns all up_modifier events
239 bits into drag_modifier, click_modifier, double_modifier, or
240 triple_modifier events. The click_modifier has no written
241 representation in the names of the symbols used as event heads,
242 but it does appear in the Qevent_symbol_components property of the
243 event heads. */
244 enum {
245 up_modifier = 1, /* Only used on mouse buttons - always
246 turned into a click or a drag modifier
247 before lisp code sees the event. */
248 down_modifier = 2, /* Only used on mouse buttons. */
249 drag_modifier = 4, /* This is never used in the event
250 queue; it's only used internally by
251 the window-system-independent code. */
252 click_modifier= 8, /* See drag_modifier. */
253 double_modifier= 16, /* See drag_modifier. */
254 triple_modifier= 32, /* See drag_modifier. */
255
256 /* The next four modifier bits are used also in keyboard events at
257 the Lisp level.
258
259 It's probably not the greatest idea to use the 2^23 bit for any
260 modifier. It may or may not be the sign bit, depending on
261 VALBITS, so using it to represent a modifier key means that
262 characters thus modified have different integer equivalents
263 depending on the architecture they're running on. Oh, and
264 applying XINT to a character whose 2^23 bit is set sign-extends
265 it, so you get a bunch of bits in the mask you didn't want.
266
267 The CHAR_ macros are defined in lisp.h. */
268 alt_modifier = CHAR_ALT, /* Under X, the XK_Alt_[LR] keysyms. */
269 super_modifier= CHAR_SUPER, /* Under X, the XK_Super_[LR] keysyms. */
270 hyper_modifier= CHAR_HYPER, /* Under X, the XK_Hyper_[LR] keysyms. */
271 shift_modifier= CHAR_SHIFT,
272 ctrl_modifier = CHAR_CTL,
273 meta_modifier = CHAR_META /* Under X, the XK_Meta_[LR] keysyms. */
274 };
275
276 #endif /* CONSP */
277
278 \f
279 /* Display-local parameters. */
280 struct display
281 {
282 /* Chain of all displays. */
283 struct display *next_display;
284
285 /* Unique id for this display. */
286 int id;
287
288 /* The number of frames that are on this display. */
289 int reference_count;
290
291 /* The type of the display. */
292 enum output_method type;
293
294 /* The name of the display device. Do not use this to identify the display. */
295 char *name;
296
297 /* Display-type dependent data shared amongst all frames on this display. */
298 union display_info
299 {
300 struct tty_display_info *tty; /* termchar.h */
301 struct x_display_info *x; /* xterm.h */
302 } display_info;
303
304 \f
305 /* Coding-system to be used for encoding terminal output. This
306 structure contains information of a coding-system specified by
307 the function `set-terminal-coding-system'. Also see
308 `safe_terminal_coding' in coding.h. */
309 struct coding_system *terminal_coding;
310
311 /* Coding-system of what is sent from terminal keyboard. This
312 structure contains information of a coding-system specified by
313 the function `set-keyboard-coding-system'. */
314 struct coding_system *keyboard_coding;
315
316 /* Terminal characteristics. */
317 /* XXX Are these really used on non-termcap displays? */
318
319 int must_write_spaces; /* Nonzero means spaces in the text must
320 actually be output; can't just skip over
321 some columns to leave them blank. */
322 int fast_clear_end_of_line; /* Nonzero means terminal has a `ce' string */
323
324 int line_ins_del_ok; /* Terminal can insert and delete lines */
325 int char_ins_del_ok; /* Terminal can insert and delete chars */
326 int scroll_region_ok; /* Terminal supports setting the scroll
327 window */
328 int scroll_region_cost; /* Cost of setting the scroll window,
329 measured in characters. */
330 int memory_below_frame; /* Terminal remembers lines scrolled
331 off bottom */
332
333 #if 0 /* These are not used anywhere. */
334 /* EMACS_INT baud_rate; */ /* Output speed in baud */
335 int min_padding_speed; /* Speed below which no padding necessary. */
336 int dont_calculate_costs; /* Nonzero means don't bother computing
337 various cost tables; we won't use them. */
338 #endif
339
340 \f
341 /* Window-based redisplay interface for this device (0 for tty
342 devices). */
343 struct redisplay_interface *rif;
344
345 /* Frame-based redisplay interface. */
346
347 /* Text display hooks. */
348
349 void (*cursor_to_hook) P_ ((struct frame *f, int vpos, int hpos));
350 void (*raw_cursor_to_hook) P_ ((struct frame *, int, int));
351
352 void (*clear_to_end_hook) P_ ((struct frame *));
353 void (*clear_frame_hook) P_ ((struct frame *));
354 void (*clear_end_of_line_hook) P_ ((struct frame *, int));
355
356 void (*ins_del_lines_hook) P_ ((struct frame *f, int, int));
357
358 void (*insert_glyphs_hook) P_ ((struct frame *f, struct glyph *s, int n));
359 void (*write_glyphs_hook) P_ ((struct frame *f, struct glyph *s, int n));
360 void (*delete_glyphs_hook) P_ ((struct frame *, int));
361
362 void (*ring_bell_hook) P_ ((struct frame *f));
363
364 void (*reset_terminal_modes_hook) P_ ((struct display *));
365 void (*set_terminal_modes_hook) P_ ((struct display *));
366
367 void (*update_begin_hook) P_ ((struct frame *));
368 void (*update_end_hook) P_ ((struct frame *));
369 void (*set_terminal_window_hook) P_ ((struct frame *, int));
370
371 /* Multi-frame and mouse support hooks. */
372
373 /* Return the current position of the mouse.
374
375 Set *f to the frame the mouse is in, or zero if the mouse is in no
376 Emacs frame. If it is set to zero, all the other arguments are
377 garbage.
378
379 If the motion started in a scroll bar, set *bar_window to the
380 scroll bar's window, *part to the part the mouse is currently over,
381 *x to the position of the mouse along the scroll bar, and *y to the
382 overall length of the scroll bar.
383
384 Otherwise, set *bar_window to Qnil, and *x and *y to the column and
385 row of the character cell the mouse is over.
386
387 Set *time to the time the mouse was at the returned position.
388
389 This should clear mouse_moved until the next motion
390 event arrives. */
391 void (*mouse_position_hook) P_ ((struct frame **f, int,
392 Lisp_Object *bar_window,
393 enum scroll_bar_part *part,
394 Lisp_Object *x,
395 Lisp_Object *y,
396 unsigned long *time));
397
398 /* The window system handling code should set this if the mouse has
399 moved since the last call to the mouse_position_hook. Calling that
400 hook should clear this. */
401 int mouse_moved;
402
403 /* When a frame's focus redirection is changed, this hook tells the
404 window system code to re-decide where to put the highlight. Under
405 X, this means that Emacs lies about where the focus is. */
406 void (*frame_rehighlight_hook) P_ ((struct frame *));
407
408 /* If we're displaying frames using a window system that can stack
409 frames on top of each other, this hook allows you to bring a frame
410 to the front, or bury it behind all the other windows. If this
411 hook is zero, that means the device we're displaying on doesn't
412 support overlapping frames, so there's no need to raise or lower
413 anything.
414
415 If RAISE is non-zero, F is brought to the front, before all other
416 windows. If RAISE is zero, F is sent to the back, behind all other
417 windows. */
418 void (*frame_raise_lower_hook) P_ ((struct frame *f, int raise));
419
420 \f
421 /* Scroll bar hooks. */
422
423 /* The representation of scroll bars is determined by the code which
424 implements them, except for one thing: they must be represented by
425 lisp objects. This allows us to place references to them in
426 Lisp_Windows without worrying about those references becoming
427 dangling references when the scroll bar is destroyed.
428
429 The window-system-independent portion of Emacs just refers to
430 scroll bars via their windows, and never looks inside the scroll bar
431 representation; it always uses hook functions to do all the
432 scroll bar manipulation it needs.
433
434 The `vertical_scroll_bar' field of a Lisp_Window refers to that
435 window's scroll bar, or is nil if the window doesn't have a
436 scroll bar.
437
438 The `scroll_bars' and `condemned_scroll_bars' fields of a Lisp_Frame
439 are free for use by the scroll bar implementation in any way it sees
440 fit. They are marked by the garbage collector. */
441
442
443 /* Set the vertical scroll bar for WINDOW to have its upper left corner
444 at (TOP, LEFT), and be LENGTH rows high. Set its handle to
445 indicate that we are displaying PORTION characters out of a total
446 of WHOLE characters, starting at POSITION. If WINDOW doesn't yet
447 have a scroll bar, create one for it. */
448 void (*set_vertical_scroll_bar_hook) P_ ((struct window *window,
449 int portion, int whole,
450 int position));
451
452
453 /* The following three hooks are used when we're doing a thorough
454 redisplay of the frame. We don't explicitly know which scroll bars
455 are going to be deleted, because keeping track of when windows go
456 away is a real pain - can you say set-window-configuration?
457 Instead, we just assert at the beginning of redisplay that *all*
458 scroll bars are to be removed, and then save scroll bars from the
459 fiery pit when we actually redisplay their window. */
460
461 /* Arrange for all scroll bars on FRAME to be removed at the next call
462 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
463 `*redeem_scroll_bar_hook' is applied to its window before the judgement.
464
465 This should be applied to each frame each time its window tree is
466 redisplayed, even if it is not displaying scroll bars at the moment;
467 if the HAS_SCROLL_BARS flag has just been turned off, only calling
468 this and the judge_scroll_bars_hook will get rid of them.
469
470 If non-zero, this hook should be safe to apply to any frame,
471 whether or not it can support scroll bars, and whether or not it is
472 currently displaying them. */
473 void (*condemn_scroll_bars_hook) P_ ((struct frame *frame));
474
475 /* Unmark WINDOW's scroll bar for deletion in this judgement cycle.
476 Note that it's okay to redeem a scroll bar that is not condemned. */
477 void (*redeem_scroll_bar_hook) P_ ((struct window *window));
478
479 /* Remove all scroll bars on FRAME that haven't been saved since the
480 last call to `*condemn_scroll_bars_hook'.
481
482 This should be applied to each frame after each time its window
483 tree is redisplayed, even if it is not displaying scroll bars at the
484 moment; if the HAS_SCROLL_BARS flag has just been turned off, only
485 calling this and condemn_scroll_bars_hook will get rid of them.
486
487 If non-zero, this hook should be safe to apply to any frame,
488 whether or not it can support scroll bars, and whether or not it is
489 currently displaying them. */
490 void (*judge_scroll_bars_hook) P_ ((struct frame *FRAME));
491
492 \f
493 /* Called to read input events.
494
495 DISPLAY indicates which display to read from. Input events
496 should be read into BUF, the size of which is given in SIZE.
497 EXPECTED is non-zero if the caller suspects that new input is
498 available.
499
500 A positive return value indicates that that many input events
501 where read into BUF.
502 Zero means no events were immediately available.
503 A value of -1 means a transient read error, while -2 indicates
504 that the display was closed (hangup), and it should be deleted.
505
506 XXX Please note that a non-zero value of EXPECTED only means that
507 there is available input on at least one of the currently opened
508 display devices -- but not necessarily on this device.
509 Therefore, in most cases EXPECTED should be simply ignored.
510
511 XXX This documentation needs to be updated. */
512 int (*read_socket_hook) P_ ((struct display *display,
513 int expected,
514 struct input_event *hold_quit));
515
516 /* Called when a frame's display becomes entirely up to date. */
517 void (*frame_up_to_date_hook) P_ ((struct frame *));
518
519 \f
520 /* Called to delete the device-specific portions of a frame that is
521 on this display. */
522 void (*delete_frame_hook) P_ ((struct frame *));
523
524 /* Called after the last frame on this display is deleted, or when
525 the display device was closed (hangup).
526
527 If this is NULL, then the generic delete_display is called
528 instead. Otherwise the hook must call delete_display itself.
529
530 The hook must check for and close any live frames that are still
531 on the display. Fdelete_frame ensures that there are no live
532 frames on the display when it calls this hook, so infinite
533 recursion is prevented. */
534 void (*delete_display_hook) P_ ((struct display *));
535 };
536
537
538 /* Chain of all displays currently in use. */
539 extern struct display *display_list;
540
541 #define FRAME_MUST_WRITE_SPACES(f) ((f)->display->must_write_spaces)
542 #define FRAME_FAST_CLEAR_END_OF_LINE(f) ((f)->display->fast_clear_end_of_line)
543 #define FRAME_LINE_INS_DEL_OK(f) ((f)->display->line_ins_del_ok)
544 #define FRAME_CHAR_INS_DEL_OK(f) ((f)->display->char_ins_del_ok)
545 #define FRAME_SCROLL_REGION_OK(f) ((f)->display->scroll_region_ok)
546 #define FRAME_SCROLL_REGION_COST(f) ((f)->display->scroll_region_cost)
547 #define FRAME_MEMORY_BELOW_FRAME(f) ((f)->display->memory_below_frame)
548
549 #define FRAME_TERMINAL_CODING(f) ((f)->display->terminal_coding)
550 #define FRAME_KEYBOARD_CODING(f) ((f)->display->keyboard_coding)
551
552 #define FRAME_RIF(f) ((f)->display->rif)
553
554 #define FRAME_DISPLAY(f) ((f)->display)
555
556 /* FRAME_WINDOW_P tests whether the frame is a window, and is
557 defined to be the predicate for the window system being used. */
558
559 #ifdef HAVE_X_WINDOWS
560 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
561 #endif
562 #ifdef HAVE_NTGUI
563 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
564 #endif
565 #ifdef MAC_OS
566 #define FRAME_WINDOW_P(f) FRAME_MAC_P (f)
567 #endif
568 #ifndef FRAME_WINDOW_P
569 #define FRAME_WINDOW_P(f) (0)
570 #endif
571
572 /* Return true if the display is not suspended. */
573 #define DISPLAY_ACTIVE_P(d) ((d)->type != output_termcap || (d)->display_info.tty->input)
574
575 extern struct display *create_display P_ ((void));
576 extern void delete_display P_ ((struct display *));
577
578 /* The initial display device, created by initial_term_init. */
579 extern struct display *initial_display;
580
581 /* arch-tag: 33a00ecc-52b5-4186-a410-8801ac9f087d
582 (do not change this comment) */