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