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