1 /* Parameters and display hooks for terminal devices.
2 Copyright (C) 1985, 1986, 1993, 1994, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008 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 3 of the License, or
10 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
27 enum scroll_bar_part
{
28 scroll_bar_above_handle
,
30 scroll_bar_below_handle
,
32 scroll_bar_down_arrow
,
35 scroll_bar_end_scroll
,
39 /* If the value of the frame parameter changed, whis hook is called.
40 For example, if going from fullscreen to not fullscreen this hook
41 may do something OS dependent, like extended window manager hints on X11. */
42 extern void (*fullscreen_hook
) P_ ((struct frame
*f
));
45 /* Input queue declarations and hooks. */
47 /* Expedient hack: only provide the below definitions to files that
48 are prepared to handle lispy things. CONSP is defined if lisp.h
49 has been included before this file. */
54 NO_EVENT
, /* nothing happened. This should never
55 actually appear in the event queue. */
57 ASCII_KEYSTROKE_EVENT
, /* The ASCII code is in .code, perhaps
58 with modifiers applied.
59 .modifiers holds the state of the
61 .frame_or_window is the frame in
62 which the key was typed.
63 .timestamp gives a timestamp (in
64 milliseconds) for the keystroke. */
65 MULTIBYTE_CHAR_KEYSTROKE_EVENT
, /* The multibyte char code is in .code,
66 perhaps with modifiers applied.
67 The others are the same as
68 ASCII_KEYSTROKE_EVENT. */
69 NON_ASCII_KEYSTROKE_EVENT
, /* .code is a number identifying the
70 function key. A code N represents
72 function_key_names[N]; function_key_names
73 is a table in keyboard.c to which you
74 should feel free to add missing keys.
75 .modifiers holds the state of the
77 .frame_or_window is the frame in
78 which the key was typed.
79 .timestamp gives a timestamp (in
80 milliseconds) for the keystroke. */
81 TIMER_EVENT
, /* A timer fired. */
82 MOUSE_CLICK_EVENT
, /* The button number is in .code; it must
83 be >= 0 and < NUM_MOUSE_BUTTONS, defined
85 .modifiers holds the state of the
87 .x and .y give the mouse position,
88 in characters, within the window.
89 .frame_or_window gives the frame
90 the mouse click occurred in.
91 .timestamp gives a timestamp (in
92 milliseconds) for the click. */
93 WHEEL_EVENT
, /* A wheel event is generated by a
94 wheel on a mouse (e.g., MS
96 .modifiers holds the rotate
97 direction (up or down), and the
98 state of the modifier keys.
99 .x and .y give the mouse position,
100 in characters, within the window.
101 .frame_or_window gives the frame
102 the wheel event occurred in.
103 .timestamp gives a timestamp (in
104 milliseconds) for the event. */
105 HORIZ_WHEEL_EVENT
, /* A wheel event generated by a second
106 horizontal wheel that is present on some
107 mice. See WHEEL_EVENT. */
108 #if defined (WINDOWSNT)
109 LANGUAGE_CHANGE_EVENT
, /* A LANGUAGE_CHANGE_EVENT is
110 generated on WINDOWSNT or Mac OS
111 when the keyboard layout or input
112 language is changed by the
115 SCROLL_BAR_CLICK_EVENT
, /* .code gives the number of the mouse button
117 .modifiers holds the state of the modifier
119 .part is a lisp symbol indicating which
120 part of the scroll bar got clicked.
121 .x gives the distance from the start of the
122 scroll bar of the click; .y gives the total
123 length of the scroll bar.
124 .frame_or_window gives the window
125 whose scroll bar was clicked in.
126 .timestamp gives a timestamp (in
127 milliseconds) for the click. */
128 SELECTION_REQUEST_EVENT
, /* Another X client wants a selection from us.
129 See `struct selection_input_event'. */
130 SELECTION_CLEAR_EVENT
, /* Another X client cleared our selection. */
131 BUFFER_SWITCH_EVENT
, /* A process filter has switched buffers. */
132 DELETE_WINDOW_EVENT
, /* An X client said "delete this window". */
133 MENU_BAR_EVENT
, /* An event generated by the menu bar.
134 The frame_or_window field's cdr holds the
135 Lisp-level event value.
136 (Only the toolkit version uses these.) */
137 ICONIFY_EVENT
, /* An X client iconified this window. */
138 DEICONIFY_EVENT
, /* An X client deiconified this window. */
139 MENU_BAR_ACTIVATE_EVENT
, /* A button press in the menu bar
140 (toolkit version only). */
141 DRAG_N_DROP_EVENT
, /* A drag-n-drop event is generated when
142 files selected outside of Emacs are dropped
143 onto an Emacs window.
144 .modifiers holds the state of the
146 .x and .y give the mouse position,
147 in characters, within the window.
148 .frame_or_window is the frame in
149 which the drop was made.
150 .arg is a platform-dependent
151 representation of the dropped items.
152 .timestamp gives a timestamp (in
153 milliseconds) for the click. */
154 USER_SIGNAL_EVENT
, /* A user signal.
155 code is a number identifying it,
156 index into lispy_user_signals. */
158 /* Help events. Member `frame_or_window' of the input_event is the
159 frame on which the event occurred, and member `arg' contains
163 /* An event from a tool-bar. Member `arg' of the input event
164 contains the tool-bar item selected. If `frame_or_window'
165 and `arg' are equal, this is a prefix event. */
168 /* Queued from XTread_socket on FocusIn events. Translated into
169 `switch-frame' events in kbd_buffer_get_event, if necessary. */
172 /* Generated when mouse moves over window not currently selected. */
175 /* Queued from XTread_socket when session manager sends
176 save yourself before shutdown. */
188 /* Generated when an APPCOMMAND event is received, in response to
189 Multimedia or Internet buttons on some keyboards.
190 Such keys are available as normal function keys on X through the
192 On Windows, some of them get mapped to normal function key events,
193 but others need to be handled by APPCOMMAND. Handling them all as
194 APPCOMMAND events means they can be disabled
195 (w32-pass-multimedia-buttons-to-system), important on Windows since
196 the system never sees these keys if Emacs claims to handle them.
197 On X, the window manager seems to grab the keys it wants
198 first, so this is not a problem there. */
199 , MULTIMEDIA_KEY_EVENT
203 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
204 or SELECTION_CLEAR_EVENT, then its contents are really described
205 by `struct selection_input_event'; see xterm.h. */
207 /* The keyboard input buffer is an array of these structures. Each one
208 represents some sort of input event - a keystroke, a mouse click, or
209 a window system event. These get turned into their lispy forms when
210 they are removed from the event queue. */
214 /* What kind of event was this? */
215 enum event_kind kind
;
217 /* For an ASCII_KEYSTROKE_EVENT and MULTIBYTE_CHAR_KEYSTROKE_EVENT,
218 this is the character.
219 For a NON_ASCII_KEYSTROKE_EVENT, this is the keysym code.
220 For a mouse event, this is the button number. */
221 /* In WindowsNT, for a mouse wheel event, this is the delta. */
223 enum scroll_bar_part part
;
225 int modifiers
; /* See enum below for interpretation. */
228 unsigned long timestamp
;
230 /* This is padding just to put the frame_or_window field
231 past the size of struct selection_input_event. */
234 /* This field is copied into a vector while the event is in the queue,
235 so that garbage collections won't kill it. */
236 /* In a menu_bar_event, this is a cons cell whose car is the frame
237 and whose cdr is the Lisp object that is the event's value. */
238 /* This field is last so that struct selection_input_event
239 does not overlap with it. */
240 Lisp_Object frame_or_window
;
242 /* Additional event argument. This is used for TOOL_BAR_EVENTs and
243 HELP_EVENTs and avoids calling Fcons during signal handling. */
247 #define EVENT_INIT(event) bzero (&(event), sizeof (struct input_event))
249 /* Bits in the modifiers member of the input_event structure.
250 Note that reorder_modifiers assumes that the bits are in canonical
253 The modifiers applied to mouse clicks are rather ornate. The
254 window-system-specific code should store mouse clicks with
255 up_modifier or down_modifier set. Having an explicit down modifier
256 simplifies some of window-system-independent code; without it, the
257 code would have to recognize down events by checking if the event
258 is a mouse click lacking the click and drag modifiers.
260 The window-system independent code turns all up_modifier events
261 bits into drag_modifier, click_modifier, double_modifier, or
262 triple_modifier events. The click_modifier has no written
263 representation in the names of the symbols used as event heads,
264 but it does appear in the Qevent_symbol_components property of the
267 up_modifier
= 1, /* Only used on mouse buttons - always
268 turned into a click or a drag modifier
269 before lisp code sees the event. */
270 down_modifier
= 2, /* Only used on mouse buttons. */
271 drag_modifier
= 4, /* This is never used in the event
272 queue; it's only used internally by
273 the window-system-independent code. */
274 click_modifier
= 8, /* See drag_modifier. */
275 double_modifier
= 16, /* See drag_modifier. */
276 triple_modifier
= 32, /* See drag_modifier. */
278 /* The next four modifier bits are used also in keyboard events at
281 It's probably not the greatest idea to use the 2^23 bit for any
282 modifier. It may or may not be the sign bit, depending on
283 VALBITS, so using it to represent a modifier key means that
284 characters thus modified have different integer equivalents
285 depending on the architecture they're running on. Oh, and
286 applying XINT to a character whose 2^23 bit is set sign-extends
287 it, so you get a bunch of bits in the mask you didn't want.
289 The CHAR_ macros are defined in lisp.h. */
290 alt_modifier
= CHAR_ALT
, /* Under X, the XK_Alt_[LR] keysyms. */
291 super_modifier
= CHAR_SUPER
, /* Under X, the XK_Super_[LR] keysyms. */
292 hyper_modifier
= CHAR_HYPER
, /* Under X, the XK_Hyper_[LR] keysyms. */
293 shift_modifier
= CHAR_SHIFT
,
294 ctrl_modifier
= CHAR_CTL
,
295 meta_modifier
= CHAR_META
/* Under X, the XK_Meta_[LR] keysyms. */
300 extern int handle_one_term_event (struct tty_display_info
*, Gpm_Event
*, struct input_event
*);
301 extern void term_mouse_moveto (int, int);
303 /* The device for which we have enabled gpm support. */
304 extern struct tty_display_info
*gpm_tty
;
310 struct ns_display_info
;
311 struct x_display_info
;
312 struct w32_display_info
;
314 /* Terminal-local parameters. */
317 /* The first two fields are really the header of a vector */
318 /* The terminal code does not refer to them. */
320 struct Lisp_Vector
*vec_next
;
322 /* Parameter alist of this terminal. */
323 Lisp_Object param_alist
;
325 /* All fields before `next_terminal' should be Lisp_Object and are traced
326 by the GC. All fields afterwards are ignored by the GC. */
328 /* Chain of all terminal devices. */
329 struct terminal
*next_terminal
;
331 /* Unique id for this terminal device. */
334 /* The number of frames that are on this terminal. */
337 /* The type of the terminal device. */
338 enum output_method type
;
340 /* The name of the terminal device. Do not use this to uniquely
341 identify a terminal; the same device may be opened multiple
345 /* The terminal's keyboard object. */
346 struct kboard
*kboard
;
348 #ifdef HAVE_WINDOW_SYSTEM
349 /* Cache of images. */
350 struct image_cache
*image_cache
;
351 #endif /* HAVE_WINDOW_SYSTEM */
353 /* Device-type dependent data shared amongst all frames on this terminal. */
356 struct tty_display_info
*tty
; /* termchar.h */
357 struct x_display_info
*x
; /* xterm.h */
358 struct w32_display_info
*w32
; /* w32term.h */
359 struct ns_display_info
*ns
; /* nsterm.h */
363 /* Coding-system to be used for encoding terminal output. This
364 structure contains information of a coding-system specified by
365 the function `set-terminal-coding-system'. Also see
366 `safe_terminal_coding' in coding.h. */
367 struct coding_system
*terminal_coding
;
369 /* Coding-system of what is sent from terminal keyboard. This
370 structure contains information of a coding-system specified by
371 the function `set-keyboard-coding-system'. */
372 struct coding_system
*keyboard_coding
;
374 /* Terminal characteristics. */
375 /* XXX Are these really used on non-termcap displays? */
377 int must_write_spaces
; /* Nonzero means spaces in the text must
378 actually be output; can't just skip over
379 some columns to leave them blank. */
380 int fast_clear_end_of_line
; /* Nonzero means terminal has a `ce' string */
382 int line_ins_del_ok
; /* Terminal can insert and delete lines */
383 int char_ins_del_ok
; /* Terminal can insert and delete chars */
384 int scroll_region_ok
; /* Terminal supports setting the scroll
386 int scroll_region_cost
; /* Cost of setting the scroll window,
387 measured in characters. */
388 int memory_below_frame
; /* Terminal remembers lines scrolled
391 #if 0 /* These are not used anywhere. */
392 /* EMACS_INT baud_rate; */ /* Output speed in baud */
393 int min_padding_speed
; /* Speed below which no padding necessary. */
394 int dont_calculate_costs
; /* Nonzero means don't bother computing
395 various cost tables; we won't use them. */
399 /* Window-based redisplay interface for this device (0 for tty
401 struct redisplay_interface
*rif
;
403 /* Frame-based redisplay interface. */
405 /* Text display hooks. */
407 void (*cursor_to_hook
) P_ ((struct frame
*f
, int vpos
, int hpos
));
408 void (*raw_cursor_to_hook
) P_ ((struct frame
*, int, int));
410 void (*clear_to_end_hook
) P_ ((struct frame
*));
411 void (*clear_frame_hook
) P_ ((struct frame
*));
412 void (*clear_end_of_line_hook
) P_ ((struct frame
*, int));
414 void (*ins_del_lines_hook
) P_ ((struct frame
*f
, int, int));
416 void (*insert_glyphs_hook
) P_ ((struct frame
*f
, struct glyph
*s
, int n
));
417 void (*write_glyphs_hook
) P_ ((struct frame
*f
, struct glyph
*s
, int n
));
418 void (*delete_glyphs_hook
) P_ ((struct frame
*, int));
420 void (*ring_bell_hook
) P_ ((struct frame
*f
));
422 void (*reset_terminal_modes_hook
) P_ ((struct terminal
*));
423 void (*set_terminal_modes_hook
) P_ ((struct terminal
*));
425 void (*update_begin_hook
) P_ ((struct frame
*));
426 void (*update_end_hook
) P_ ((struct frame
*));
427 void (*set_terminal_window_hook
) P_ ((struct frame
*, int));
429 /* Multi-frame and mouse support hooks. */
431 /* Return the current position of the mouse.
433 Set *f to the frame the mouse is in, or zero if the mouse is in no
434 Emacs frame. If it is set to zero, all the other arguments are
437 If the motion started in a scroll bar, set *bar_window to the
438 scroll bar's window, *part to the part the mouse is currently over,
439 *x to the position of the mouse along the scroll bar, and *y to the
440 overall length of the scroll bar.
442 Otherwise, set *bar_window to Qnil, and *x and *y to the column and
443 row of the character cell the mouse is over.
445 Set *time to the time the mouse was at the returned position.
447 This should clear mouse_moved until the next motion
449 void (*mouse_position_hook
) P_ ((struct frame
**f
, int,
450 Lisp_Object
*bar_window
,
451 enum scroll_bar_part
*part
,
454 unsigned long *time
));
456 /* The window system handling code should set this if the mouse has
457 moved since the last call to the mouse_position_hook. Calling that
458 hook should clear this. */
461 /* When a frame's focus redirection is changed, this hook tells the
462 window system code to re-decide where to put the highlight. Under
463 X, this means that Emacs lies about where the focus is. */
464 void (*frame_rehighlight_hook
) P_ ((struct frame
*));
466 /* If we're displaying frames using a window system that can stack
467 frames on top of each other, this hook allows you to bring a frame
468 to the front, or bury it behind all the other windows. If this
469 hook is zero, that means the terminal we're displaying on doesn't
470 support overlapping frames, so there's no need to raise or lower
473 If RAISE is non-zero, F is brought to the front, before all other
474 windows. If RAISE is zero, F is sent to the back, behind all other
476 void (*frame_raise_lower_hook
) P_ ((struct frame
*f
, int raise
));
478 /* If the value of the frame parameter changed, whis hook is called.
479 For example, if going from fullscreen to not fullscreen this hook
480 may do something OS dependent, like extended window manager hints on X11. */
481 void (*fullscreen_hook
) P_ ((struct frame
*f
));
484 /* Scroll bar hooks. */
486 /* The representation of scroll bars is determined by the code which
487 implements them, except for one thing: they must be represented by
488 lisp objects. This allows us to place references to them in
489 Lisp_Windows without worrying about those references becoming
490 dangling references when the scroll bar is destroyed.
492 The window-system-independent portion of Emacs just refers to
493 scroll bars via their windows, and never looks inside the scroll bar
494 representation; it always uses hook functions to do all the
495 scroll bar manipulation it needs.
497 The `vertical_scroll_bar' field of a Lisp_Window refers to that
498 window's scroll bar, or is nil if the window doesn't have a
501 The `scroll_bars' and `condemned_scroll_bars' fields of a Lisp_Frame
502 are free for use by the scroll bar implementation in any way it sees
503 fit. They are marked by the garbage collector. */
506 /* Set the vertical scroll bar for WINDOW to have its upper left corner
507 at (TOP, LEFT), and be LENGTH rows high. Set its handle to
508 indicate that we are displaying PORTION characters out of a total
509 of WHOLE characters, starting at POSITION. If WINDOW doesn't yet
510 have a scroll bar, create one for it. */
511 void (*set_vertical_scroll_bar_hook
) P_ ((struct window
*window
,
512 int portion
, int whole
,
516 /* The following three hooks are used when we're doing a thorough
517 redisplay of the frame. We don't explicitly know which scroll bars
518 are going to be deleted, because keeping track of when windows go
519 away is a real pain - can you say set-window-configuration?
520 Instead, we just assert at the beginning of redisplay that *all*
521 scroll bars are to be removed, and then save scroll bars from the
522 fiery pit when we actually redisplay their window. */
524 /* Arrange for all scroll bars on FRAME to be removed at the next call
525 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
526 `*redeem_scroll_bar_hook' is applied to its window before the judgement.
528 This should be applied to each frame each time its window tree is
529 redisplayed, even if it is not displaying scroll bars at the moment;
530 if the HAS_SCROLL_BARS flag has just been turned off, only calling
531 this and the judge_scroll_bars_hook will get rid of them.
533 If non-zero, this hook should be safe to apply to any frame,
534 whether or not it can support scroll bars, and whether or not it is
535 currently displaying them. */
536 void (*condemn_scroll_bars_hook
) P_ ((struct frame
*frame
));
538 /* Unmark WINDOW's scroll bar for deletion in this judgement cycle.
539 Note that it's okay to redeem a scroll bar that is not condemned. */
540 void (*redeem_scroll_bar_hook
) P_ ((struct window
*window
));
542 /* Remove all scroll bars on FRAME that haven't been saved since the
543 last call to `*condemn_scroll_bars_hook'.
545 This should be applied to each frame after each time its window
546 tree is redisplayed, even if it is not displaying scroll bars at the
547 moment; if the HAS_SCROLL_BARS flag has just been turned off, only
548 calling this and condemn_scroll_bars_hook will get rid of them.
550 If non-zero, this hook should be safe to apply to any frame,
551 whether or not it can support scroll bars, and whether or not it is
552 currently displaying them. */
553 void (*judge_scroll_bars_hook
) P_ ((struct frame
*FRAME
));
556 /* Called to read input events.
558 TERMINAL indicates which terminal device to read from. Input
559 events should be read into BUF, the size of which is given in
560 SIZE. EXPECTED is non-zero if the caller suspects that new input
563 A positive return value indicates that that many input events
565 Zero means no events were immediately available.
566 A value of -1 means a transient read error, while -2 indicates
567 that the device was closed (hangup), and it should be deleted.
569 XXX Please note that a non-zero value of EXPECTED only means that
570 there is available input on at least one of the currently opened
571 terminal devices -- but not necessarily on this device.
572 Therefore, in most cases EXPECTED should be simply ignored.
574 XXX This documentation needs to be updated. */
575 int (*read_socket_hook
) P_ ((struct terminal
*terminal
,
577 struct input_event
*hold_quit
));
579 /* Called when a frame's display becomes entirely up to date. */
580 void (*frame_up_to_date_hook
) P_ ((struct frame
*));
583 /* Called to delete the device-specific portions of a frame that is
584 on this terminal device. */
585 void (*delete_frame_hook
) P_ ((struct frame
*));
587 /* Called after the last frame on this terminal is deleted, or when
588 the display device was closed (hangup).
590 If this is NULL, then the generic delete_terminal is called
591 instead. Otherwise the hook must call delete_terminal itself.
593 The hook must check for and close any live frames that are still
594 on the terminal. delete_frame ensures that there are no live
595 frames on the terminal when it calls this hook, so infinite
596 recursion is prevented. */
597 void (*delete_terminal_hook
) P_ ((struct terminal
*));
601 /* Chain of all terminal devices currently in use. */
602 extern struct terminal
*terminal_list
;
604 #define FRAME_MUST_WRITE_SPACES(f) ((f)->terminal->must_write_spaces)
605 #define FRAME_FAST_CLEAR_END_OF_LINE(f) ((f)->terminal->fast_clear_end_of_line)
606 #define FRAME_LINE_INS_DEL_OK(f) ((f)->terminal->line_ins_del_ok)
607 #define FRAME_CHAR_INS_DEL_OK(f) ((f)->terminal->char_ins_del_ok)
608 #define FRAME_SCROLL_REGION_OK(f) ((f)->terminal->scroll_region_ok)
609 #define FRAME_SCROLL_REGION_COST(f) ((f)->terminal->scroll_region_cost)
610 #define FRAME_MEMORY_BELOW_FRAME(f) ((f)->terminal->memory_below_frame)
612 #define FRAME_TERMINAL_CODING(f) ((f)->terminal->terminal_coding)
613 #define FRAME_KEYBOARD_CODING(f) ((f)->terminal->keyboard_coding)
615 #define TERMINAL_TERMINAL_CODING(d) ((d)->terminal_coding)
616 #define TERMINAL_KEYBOARD_CODING(d) ((d)->keyboard_coding)
618 #define FRAME_RIF(f) ((f)->terminal->rif)
620 #define FRAME_TERMINAL(f) ((f)->terminal)
622 /* FRAME_WINDOW_P tests whether the frame is a window, and is
623 defined to be the predicate for the window system being used. */
625 #ifdef HAVE_X_WINDOWS
626 #define FRAME_WINDOW_P(f) FRAME_X_P (f)
629 #define FRAME_WINDOW_P(f) FRAME_W32_P (f)
631 #ifndef FRAME_WINDOW_P
632 #define FRAME_WINDOW_P(f) (0)
635 /* Return true if the terminal device is not suspended. */
636 #define TERMINAL_ACTIVE_P(d) (((d)->type != output_termcap && (d)->type !=output_msdos_raw) || (d)->display_info.tty->input)
638 extern Lisp_Object get_terminal_param
P_ ((struct terminal
*, Lisp_Object
));
639 extern struct terminal
*get_terminal
P_ ((Lisp_Object terminal
, int));
640 extern struct terminal
*create_terminal
P_ ((void));
641 extern void delete_terminal
P_ ((struct terminal
*));
643 /* The initial terminal device, created by initial_term_init. */
644 extern struct terminal
*initial_terminal
;
647 extern void close_gpm (void);
650 /* arch-tag: 33a00ecc-52b5-4186-a410-8801ac9f087d
651 (do not change this comment) */