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