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