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