1 /* Define console object for XEmacs.
2 Copyright (C) 1996 Ben Wing
4 This file is part of XEmacs.
6 XEmacs is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with XEmacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Synched up with: Not in FSF. */
23 /* Written by Ben Wing. */
25 #ifndef INCLUDED_console_h_
26 #define INCLUDED_console_h_
28 #include "character.h"
30 /* Devices and consoles are similar entities. The idea is that
31 a console represents a physical keyboard/mouse/other-input-source
32 while a device represents a display where frames appear on.
33 In the X world, a console is a "Display" while a device is a
34 "Screen". Implementationally, it can sometimes get confusing:
35 under X, multiple devices on a single console are different
36 "Display" connections to what is in reality the same Display on
37 the same server. Because of this, input comes from the device
38 and not from the console. This is OK because events are basically
39 always tagged to a particular X window (i.e. frame),
40 which exists on only one screen; therefore the event won't be
41 reported multiple times even if there are multiple devices on
42 the same physical display. This is an implementation detail
43 specific to X consoles (e.g. under NeXTstep or Windows, this
44 could be different, and input would come directly from the console).
48 /* GCC does not like forward enum declaration. This needs to be
49 defined here. What a disgust! */
53 DM_color_default, DM_color_select, DM_color_balloon, DM_color_3d_face,
54 DM_color_3d_light, DM_color_3d_dark, DM_color_menu, DM_color_menu_highlight,
55 DM_color_menu_button, DM_color_menu_disabled, DM_color_toolbar,
56 DM_color_scrollbar, DM_color_desktop, DM_color_workspace, DM_font_default,
57 DM_font_menubar, DM_font_dialog, DM_size_cursor, DM_size_scrollbar,
58 DM_size_menu, DM_size_toolbar, DM_size_toolbar_button,
59 DM_size_toolbar_border, DM_size_icon, DM_size_icon_small, DM_size_device,
60 DM_size_workspace, DM_offset_workspace, DM_size_device_mm, DM_device_dpi,
61 DM_num_bit_planes, DM_num_color_cells, DM_mouse_buttons, DM_swap_buttons,
62 DM_show_sounds, DM_slow_device, DM_security
65 extern const struct struct_description cted_description;
66 extern const struct struct_description console_methods_description;
68 struct console_methods
70 const char *name; /* Used by print_console, print_device, print_frame */
72 Lisp_Object predicate_symbol;
75 void (*init_console_method) (struct console *, Lisp_Object props);
76 void (*mark_console_method) (struct console *);
77 int (*initially_selected_for_input_method) (struct console *);
78 void (*delete_console_method) (struct console *);
79 Lisp_Object (*semi_canonicalize_console_connection_method)
80 (Lisp_Object connection, Error_behavior errb);
81 Lisp_Object (*semi_canonicalize_device_connection_method)
82 (Lisp_Object connection, Error_behavior errb);
83 Lisp_Object (*canonicalize_console_connection_method)
84 (Lisp_Object connection, Error_behavior errb);
85 Lisp_Object (*canonicalize_device_connection_method)
86 (Lisp_Object connection, Error_behavior errb);
87 Lisp_Object (*device_to_console_connection_method)
88 (Lisp_Object connection, Error_behavior errb);
91 void (*init_device_method) (struct device *, Lisp_Object props);
92 void (*finish_init_device_method) (struct device *, Lisp_Object props);
93 void (*delete_device_method) (struct device *);
94 void (*mark_device_method) (struct device *);
95 void (*asynch_device_change_method) (void);
96 Lisp_Object (*device_system_metrics_method) (struct device *,
98 unsigned int (*device_implementation_flags_method) (void);
99 Lisp_Object (*own_selection_method)(Lisp_Object selection_name,
100 Lisp_Object selection_value,
101 Lisp_Object how_to_add,
102 Lisp_Object selection_type);
103 void (*disown_selection_method)(Lisp_Object selection_name,
104 Lisp_Object timeval);
105 Lisp_Object (*get_foreign_selection_method) (Lisp_Object selection_symbol,
106 Lisp_Object target_type);
107 Lisp_Object (*selection_exists_p_method)(Lisp_Object selection_name,
108 Lisp_Object selection_type);
109 Lisp_Object (*available_selection_types_method)(Lisp_Object selection_name);
110 Lisp_Object (*register_selection_data_type_method)(Lisp_Object type_name);
111 Lisp_Object (*selection_data_type_name_method)(Lisp_Object type);
114 Lisp_Object *device_specific_frame_props;
115 void (*init_frame_1_method) (struct frame *, Lisp_Object properties);
116 void (*init_frame_2_method) (struct frame *, Lisp_Object properties);
117 void (*init_frame_3_method) (struct frame *);
118 void (*after_init_frame_method) (struct frame *, int first_on_device,
119 int first_on_console);
120 void (*mark_frame_method) (struct frame *);
121 void (*delete_frame_method) (struct frame *);
122 void (*focus_on_frame_method) (struct frame *);
123 void (*raise_frame_method) (struct frame *);
124 void (*lower_frame_method) (struct frame *);
125 void (*enable_frame_method) (struct frame *);
126 void (*disable_frame_method) (struct frame *);
127 int (*get_mouse_position_method) (struct device *d, Lisp_Object *frame,
129 void (*set_mouse_position_method) (struct window *w, int x, int y);
130 void (*make_frame_visible_method) (struct frame *f);
131 void (*make_frame_invisible_method) (struct frame *f);
132 void (*iconify_frame_method) (struct frame *f);
133 Lisp_Object (*frame_property_method) (struct frame *f, Lisp_Object prop);
134 int (*internal_frame_property_p_method) (struct frame *f,
136 Lisp_Object (*frame_properties_method) (struct frame *f);
137 void (*set_frame_properties_method) (struct frame *f, Lisp_Object plist);
138 void (*set_frame_size_method) (struct frame *f, int width, int height);
139 void (*set_frame_position_method) (struct frame *f, int xoff, int yoff);
140 int (*frame_visible_p_method) (struct frame *f);
141 int (*frame_totally_visible_p_method) (struct frame *f);
142 int (*frame_iconified_p_method) (struct frame *f);
143 void (*set_title_from_bufbyte_method) (struct frame *f, Bufbyte *title);
144 void (*set_icon_name_from_bufbyte_method) (struct frame *f, Bufbyte *title);
145 void (*set_frame_pointer_method) (struct frame *f);
146 void (*set_frame_icon_method) (struct frame *f);
147 void (*popup_menu_method) (Lisp_Object menu, Lisp_Object event);
148 Lisp_Object (*get_frame_parent_method) (struct frame *f);
149 void (*update_frame_external_traits_method) (struct frame *f, Lisp_Object name);
150 int (*frame_size_fixed_p_method) (struct frame *f);
151 void (*eject_page_method) (struct frame *f);
153 /* redisplay methods */
154 int (*left_margin_width_method) (struct window *);
155 int (*right_margin_width_method) (struct window *);
156 int (*text_width_method) (struct frame *f, struct face_cachel *cachel,
157 const Charc *str, Charcount len);
158 void (*output_display_block_method) (struct window *, struct display_line *,
159 int, int, int, int, int, int, int);
160 int (*divider_height_method) (void);
161 int (*eol_cursor_width_method) (void);
162 void (*output_vertical_divider_method) (struct window *, int);
163 void (*clear_to_window_end_method) (struct window *, int, int);
164 void (*clear_region_method) (Lisp_Object, struct device*, struct frame*, face_index,
166 Lisp_Object, Lisp_Object, Lisp_Object);
167 void (*clear_frame_method) (struct frame *);
168 void (*window_output_begin_method) (struct window *);
169 void (*frame_output_begin_method) (struct frame *);
170 void (*window_output_end_method) (struct window *);
171 void (*frame_output_end_method) (struct frame *);
172 int (*flash_method) (struct device *);
173 void (*ring_bell_method) (struct device *, int volume, int pitch,
175 void (*frame_redraw_cursor_method) (struct frame *f);
176 void (*set_final_cursor_coords_method) (struct frame *, int, int);
177 void (*bevel_area_method) (struct window *, face_index, int, int, int, int, int,
178 int, enum edge_style);
179 void (*output_pixmap_method) (struct window *w, Lisp_Object image_instance,
180 struct display_box *db, struct display_glyph_area *dga,
181 face_index findex, int cursor_start, int cursor_width,
182 int cursor_height, int offset_bitmap);
183 void (*output_string_method) (struct window *w, struct display_line *dl,
184 Charc_dynarr *buf, int xpos, int xoffset,
185 int start_pixpos, int width, face_index findex,
186 int cursor, int cursor_start, int cursor_width,
189 int (*initialize_color_instance_method) (Lisp_Color_Instance *,
192 Error_behavior errb);
193 void (*mark_color_instance_method) (Lisp_Color_Instance *);
194 void (*print_color_instance_method) (Lisp_Color_Instance *,
195 Lisp_Object printcharfun,
197 void (*finalize_color_instance_method) (Lisp_Color_Instance *);
198 int (*color_instance_equal_method) (Lisp_Color_Instance *,
199 Lisp_Color_Instance *,
201 unsigned long (*color_instance_hash_method) (Lisp_Color_Instance *,
203 Lisp_Object (*color_instance_rgb_components_method) (Lisp_Color_Instance *);
204 int (*valid_color_name_p_method) (struct device *, Lisp_Object color);
207 int (*initialize_font_instance_method) (Lisp_Font_Instance *,
210 Error_behavior errb);
211 void (*mark_font_instance_method) (Lisp_Font_Instance *);
212 void (*print_font_instance_method) (Lisp_Font_Instance *,
213 Lisp_Object printcharfun,
215 void (*finalize_font_instance_method) (Lisp_Font_Instance *);
216 Lisp_Object (*font_instance_truename_method) (Lisp_Font_Instance *,
217 Error_behavior errb);
218 Lisp_Object (*font_instance_properties_method) (Lisp_Font_Instance *);
219 Lisp_Object (*list_fonts_method) (Lisp_Object pattern,
221 Lisp_Object (*find_charset_font_method) (Lisp_Object device,
223 Lisp_Object charset);
224 int (*font_spec_matches_charset_method) (struct device *d,
226 const Bufbyte *nonreloc,
232 void (*mark_image_instance_method) (Lisp_Image_Instance *);
233 void (*print_image_instance_method) (Lisp_Image_Instance *,
234 Lisp_Object printcharfun,
236 void (*finalize_image_instance_method) (Lisp_Image_Instance *);
237 void (*unmap_subwindow_method) (Lisp_Image_Instance *);
238 void (*map_subwindow_method) (Lisp_Image_Instance *, int x, int y,
239 struct display_glyph_area* dga);
240 void (*resize_subwindow_method) (Lisp_Image_Instance *, int w, int h);
241 void (*redisplay_subwindow_method) (Lisp_Image_Instance *);
242 void (*redisplay_widget_method) (Lisp_Image_Instance *);
243 int (*image_instance_equal_method) (Lisp_Image_Instance *,
244 Lisp_Image_Instance *,
246 unsigned long (*image_instance_hash_method) (Lisp_Image_Instance *,
248 void (*init_image_instance_from_eimage_method) (Lisp_Image_Instance *ii,
249 int width, int height,
251 unsigned char *eimage,
253 Lisp_Object instantiator,
255 Lisp_Object (*locate_pixmap_file_method) (Lisp_Object file_method);
256 int (*colorize_image_instance_method) (Lisp_Object image_instance,
257 Lisp_Object fg, Lisp_Object bg);
258 Lisp_Object image_conversion_list;
261 /* toolbar methods */
262 void (*output_frame_toolbars_method) (struct frame *);
263 void (*initialize_frame_toolbars_method) (struct frame *);
264 void (*free_frame_toolbars_method) (struct frame *);
265 void (*output_toolbar_button_method) (struct frame *, Lisp_Object);
266 void (*redraw_frame_toolbars_method) (struct frame *);
267 void (*redraw_exposed_toolbars_method) (struct frame *f, int x, int y,
268 int width, int height);
271 #ifdef HAVE_SCROLLBARS
272 /* scrollbar methods */
273 int (*inhibit_scrollbar_slider_size_change_method) (void);
274 void (*free_scrollbar_instance_method) (struct scrollbar_instance *);
275 void (*release_scrollbar_instance_method) (struct scrollbar_instance *);
276 void (*create_scrollbar_instance_method) (struct frame *, int,
277 struct scrollbar_instance *);
278 void (*update_scrollbar_instance_values_method) (struct window *,
279 struct scrollbar_instance *,
280 int, int, int, int, int,
281 int, int, int, int, int);
282 void (*update_scrollbar_instance_status_method) (struct window *, int, int,
284 scrollbar_instance *);
285 void (*scrollbar_pointer_changed_in_window_method) (struct window *w);
286 #ifdef MEMORY_USAGE_STATS
287 int (*compute_scrollbar_instance_usage_method) (struct device *,
288 struct scrollbar_instance *,
289 struct overhead_stats *);
291 #endif /* HAVE_SCROLLBARS */
294 /* menubar methods */
295 void (*update_frame_menubars_method) (struct frame *);
296 void (*free_frame_menubars_method) (struct frame *);
301 Lisp_Object (*make_dialog_box_internal_method) (struct frame *,
308 * Constants returned by device_implementation_flags_method
311 /* Set when device uses pixel-based geometry */
312 #define XDEVIMPF_PIXEL_GEOMETRY 0x00000001L
314 /* Indicates that the device is a printer */
315 #define XDEVIMPF_IS_A_PRINTER 0x00000002L
317 /* Do not automatically redisplay this device */
318 #define XDEVIMPF_NO_AUTO_REDISPLAY 0x00000004L
320 /* Do not delete the device when last frame's gone */
321 #define XDEVIMPF_FRAMELESS_OK 0x00000008L
324 #define CONSOLE_TYPE_NAME(c) ((c)->conmeths->name)
325 #define CONSOLE_TYPE(c) ((c)->conmeths->symbol)
326 #define CONMETH_TYPE(meths) ((meths)->symbol)
328 /******** Accessing / calling a console method *********/
330 #define HAS_CONTYPE_METH_P(meth, m) ((meth)->m##_method)
331 #define CONTYPE_METH(meth, m, args) (((meth)->m##_method) args)
333 /* Call a void-returning console method, if it exists */
334 #define MAYBE_CONTYPE_METH(meth, m, args) do { \
335 struct console_methods *maybe_contype_meth_meth = (meth); \
336 if (HAS_CONTYPE_METH_P (maybe_contype_meth_meth, m)) \
337 CONTYPE_METH (maybe_contype_meth_meth, m, args); \
340 /* Call a console method, if it exists; otherwise return
341 the specified value - meth is multiply evaluated. */
342 #define CONTYPE_METH_OR_GIVEN(meth, m, args, given) \
343 (HAS_CONTYPE_METH_P (meth, m) ? \
344 CONTYPE_METH (meth, m, args) : (given))
346 /* Call an int-returning console method, if it exists; otherwise
348 #define MAYBE_INT_CONTYPE_METH(meth, m, args) \
349 CONTYPE_METH_OR_GIVEN (meth, m, args, 0)
351 /* Call an Lisp-Object-returning console method, if it exists;
352 otherwise return Qnil */
353 #define MAYBE_LISP_CONTYPE_METH(meth, m, args) \
354 CONTYPE_METH_OR_GIVEN (meth, m, args, Qnil)
356 /******** Same functions, operating on a console instead of a
357 struct console_methods ********/
359 #define HAS_CONMETH_P(c, m) HAS_CONTYPE_METH_P ((c)->conmeths, m)
360 #define CONMETH(c, m, args) CONTYPE_METH ((c)->conmeths, m, args)
361 #define MAYBE_CONMETH(c, m, args) MAYBE_CONTYPE_METH ((c)->conmeths, m, args)
362 #define CONMETH_OR_GIVEN(c, m, args, given) \
363 CONTYPE_METH_OR_GIVEN((c)->conmeths, m, args, given)
364 #define MAYBE_INT_CONMETH(c, m, args) \
365 MAYBE_INT_CONTYPE_METH ((c)->conmeths, m, args)
366 #define MAYBE_LISP_CONMETH(c, m, args) \
367 MAYBE_LISP_CONTYPE_METH ((c)->conmeths, m, args)
369 /******** Defining new console types ********/
371 typedef struct console_type_entry console_type_entry;
372 struct console_type_entry
375 struct console_methods *meths;
378 #define DECLARE_CONSOLE_TYPE(type) \
379 extern struct console_methods * type##_console_methods
381 #define DEFINE_CONSOLE_TYPE(type) \
382 struct console_methods * type##_console_methods
384 #define INITIALIZE_CONSOLE_TYPE(type, obj_name, pred_sym) do { \
385 type##_console_methods = xnew_and_zero (struct console_methods); \
386 type##_console_methods->name = obj_name; \
387 type##_console_methods->symbol = Q##type; \
388 defsymbol_nodump (&type##_console_methods->predicate_symbol, pred_sym); \
389 add_entry_to_console_type_list (Q##type, type##_console_methods); \
390 type##_console_methods->image_conversion_list = Qnil; \
391 staticpro_nodump (&type##_console_methods->image_conversion_list); \
392 dump_add_root_struct_ptr (&type##_console_methods, &console_methods_description); \
395 #define REINITIALIZE_CONSOLE_TYPE(type) do { \
396 staticpro_nodump (&type##_console_methods->predicate_symbol); \
397 staticpro_nodump (&type##_console_methods->image_conversion_list); \
401 /* Declare that console-type TYPE has method M; used in
402 initialization routines */
403 #define CONSOLE_HAS_METHOD(type, m) \
404 (type##_console_methods->m##_method = type##_##m)
406 /* Declare that console-type TYPE inherits method M
407 implementation from console-type FROMTYPE */
408 #define CONSOLE_INHERITS_METHOD(type, fromtype, m) \
409 (type##_console_methods->m##_method = fromtype##_##m)
413 struct lcrecord_header header;
415 /* Description of this console's methods. */
416 struct console_methods *conmeths;
418 /* A structure of auxiliary data specific to the console type.
419 struct x_console is used for X window frames; defined in console-x.h
420 struct tty_console is used to TTY's; defined in console-tty.h */
423 /* Character that causes a quit. Normally C-g.
424 #### Should be possible for this not to be ASCII. */
427 /* ----- begin partially-completed console localization of
432 #define MARKED_SLOT(x) Lisp_Object x
433 #include "conslots.h"
436 /* Where to store the next keystroke of the macro.
437 Index into con->kbd_macro_builder. */
440 /* The finalized section of the macro starts at kbd_macro_buffer and
441 ends before this. This is not the same as kbd_macro_pointer, because
442 we advance this to kbd_macro_pointer when a key's command is complete.
443 This way, the keystrokes for "end-kbd-macro" are not included in the
447 /* ----- end partially-completed console localization of event loop ---- */
449 unsigned int input_enabled :1;
452 DECLARE_LRECORD (console, struct console);
453 #define XCONSOLE(x) XRECORD (x, console, struct console)
454 #define XSETCONSOLE(x, p) XSETRECORD (x, p, console)
455 #define CONSOLEP(x) RECORDP (x, console)
456 #define CHECK_CONSOLE(x) CHECK_RECORD (x, console)
457 #define CONCHECK_CONSOLE(x) CONCHECK_RECORD (x, console)
459 #define CHECK_LIVE_CONSOLE(x) do { \
461 if (! CONSOLE_LIVE_P (XCONSOLE (x))) \
462 dead_wrong_type_argument (Qconsole_live_p, (x)); \
464 #define CONCHECK_LIVE_CONSOLE(x) do { \
465 CONCHECK_CONSOLE (x); \
466 if (! CONSOLE_LIVE_P (XCONSOLE (x))) \
467 x = wrong_type_argument (Qconsole_live_p, (x)); \
470 #define CONSOLE_TYPE_P(con, type) EQ (CONSOLE_TYPE (con), Q##type)
472 #ifdef ERROR_CHECK_TYPECHECK
473 INLINE_HEADER struct console *
474 error_check_console_type (struct console *con, Lisp_Object sym);
475 INLINE_HEADER struct console *
476 error_check_console_type (struct console *con, Lisp_Object sym)
478 assert (EQ (CONSOLE_TYPE (con), sym));
481 # define CONSOLE_TYPE_DATA(con, type) \
482 (*(struct type##_console **) \
483 &(error_check_console_type (con, Q##type))->console_data)
485 # define CONSOLE_TYPE_DATA(con, type) \
486 (*(struct type##_console **) &((con)->console_data))
489 #define CHECK_CONSOLE_TYPE(x, type) do { \
491 if (! CONSOLE_TYPE_P (XCONSOLE (x), type)) \
492 dead_wrong_type_argument \
493 (type##_console_methods->predicate_symbol, x); \
495 #define CONCHECK_CONSOLE_TYPE(x, type) do { \
496 CONCHECK_CONSOLE (x); \
497 if (!(CONSOLEP (x) && \
498 CONSOLE_TYPE_P (XCONSOLE (x), type))) \
499 x = wrong_type_argument \
500 (type##_console_methods->predicate_symbol, x); \
503 /* #### These should be in the console-*.h files but there are
504 too many places where the abstraction is broken. Need to
507 #ifdef HAVE_X_WINDOWS
508 #define CONSOLE_TYPESYM_X_P(typesym) EQ (typesym, Qx)
510 #define CONSOLE_TYPESYM_X_P(typesym) 0
513 #define CONSOLE_TYPESYM_TTY_P(typesym) EQ (typesym, Qtty)
515 #define CONSOLE_TYPESYM_TTY_P(typesym) 0
517 #ifdef HAVE_MS_WINDOWS
518 #define CONSOLE_TYPESYM_MSWINDOWS_P(typesym) EQ (typesym, Qmswindows)
520 #define CONSOLE_TYPESYM_MSWINDOWS_P(typesym) 0
522 #define CONSOLE_TYPESYM_STREAM_P(typesym) EQ (typesym, Qstream)
524 #define CONSOLE_TYPESYM_WIN_P(typesym) \
525 (CONSOLE_TYPESYM_X_P (typesym) || CONSOLE_TYPESYM_MSWINDOWS_P (typesym))
527 #define CONSOLE_X_P(con) CONSOLE_TYPESYM_X_P (CONSOLE_TYPE (con))
528 #define CHECK_X_CONSOLE(z) CHECK_CONSOLE_TYPE (z, x)
529 #define CONCHECK_X_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, x)
531 #define CONSOLE_TTY_P(con) CONSOLE_TYPESYM_TTY_P (CONSOLE_TYPE (con))
532 #define CHECK_TTY_CONSOLE(z) CHECK_CONSOLE_TYPE (z, tty)
533 #define CONCHECK_TTY_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, tty)
535 #define CONSOLE_MSWINDOWS_P(con) CONSOLE_TYPESYM_MSWINDOWS_P (CONSOLE_TYPE (con))
536 #define CHECK_MSWINDOWS_CONSOLE(z) CHECK_CONSOLE_TYPE (z, mswindows)
537 #define CONCHECK_MSWINDOWS_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, mswindows)
539 #define CONSOLE_STREAM_P(con) CONSOLE_TYPESYM_STREAM_P (CONSOLE_TYPE (con))
540 #define CHECK_STREAM_CONSOLE(z) CHECK_CONSOLE_TYPE (z, stream)
541 #define CONCHECK_STREAM_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, stream)
543 #define CONSOLE_WIN_P(con) CONSOLE_TYPESYM_WIN_P (CONSOLE_TYPE (con))
545 EXFUN (Fconsole_disable_input, 1);
546 EXFUN (Fdelete_console, 2);
547 EXFUN (Fselect_console, 1);
548 EXFUN (Fselected_console, 0);
550 extern Lisp_Object Qcreate_console_hook, Qdelete_console_hook;
551 extern Lisp_Object Vconsole_defaults, Vconsole_type_list, Vselected_console;
553 /* This structure marks which slots in a console have corresponding
554 default values in console_defaults.
555 Each such slot has a nonzero value in this structure.
556 The value has only one nonzero bit.
558 When a console has its own local value for a slot,
559 the bit for that slot (found in the same slot in this structure)
560 is turned on in the console's local_var_flags slot.
562 If a slot in this structure is zero, then even though there may
563 be a DEFVAR_CONSOLE_LOCAL for the slot, there is no default value for it;
564 and the corresponding slot in console_defaults is not used. */
566 extern struct console console_local_flags;
568 int valid_console_type_p (Lisp_Object type);
570 #define CONSOLE_LIVE_P(con) (!EQ (CONSOLE_TYPE (con), Qdead))
572 #define CONSOLE_NAME(con) ((con)->name)
573 #define CONSOLE_CONNECTION(con) ((con)->connection)
574 #define CONSOLE_CANON_CONNECTION(con) ((con)->canon_connection)
575 #define CONSOLE_FUNCTION_KEY_MAP(con) ((con)->function_key_map)
576 #define CONSOLE_DEVICE_LIST(con) ((con)->device_list)
577 #define CONSOLE_SELECTED_DEVICE(con) ((con)->selected_device)
578 #define CONSOLE_SELECTED_FRAME(con) \
579 DEVICE_SELECTED_FRAME (XDEVICE ((con)->selected_device))
580 #define CONSOLE_LAST_NONMINIBUF_FRAME(con) NON_LVALUE ((con)->last_nonminibuf_frame)
581 #define CONSOLE_QUIT_CHAR(con) ((con)->quit_char)
583 #define CDFW_CONSOLE(obj) \
584 (WINDOWP (obj) ? WINDOW_CONSOLE (XWINDOW (obj)) \
585 : (FRAMEP (obj) ? FRAME_CONSOLE (XFRAME (obj)) \
586 : (DEVICEP (obj) ? DEVICE_CONSOLE (XDEVICE (obj)) \
587 : (CONSOLEP (obj) ? obj \
590 #define CONSOLE_LOOP(concons) LIST_LOOP (concons, Vconsole_list)
591 #define CONSOLE_DEVICE_LOOP(devcons, con) \
592 LIST_LOOP (devcons, CONSOLE_DEVICE_LIST (con))
594 DECLARE_CONSOLE_TYPE (dead);
595 extern console_type_entry_dynarr *the_console_type_entry_dynarr;
597 Lisp_Object create_console (Lisp_Object name, Lisp_Object type,
598 Lisp_Object connection, Lisp_Object props);
599 void select_console_1 (Lisp_Object);
600 struct console *decode_console (Lisp_Object);
601 Lisp_Object make_console (struct console *c);
602 void add_entry_to_console_type_list (Lisp_Object symbol,
603 struct console_methods *type);
604 struct console_methods *decode_console_type (Lisp_Object type,
605 Error_behavior errb);
606 void delete_console_internal (struct console *con, int force,
607 int from_kill_emacs, int from_io_error);
608 void io_error_delete_console (Lisp_Object console);
609 void set_console_last_nonminibuf_frame (struct console *con,
612 #endif /* INCLUDED_console_h_ */