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