XEmacs 21.2.20 "Yoko".
[chise/xemacs-chise.git.1] / src / console.h
1 /* Define console object for XEmacs.
2    Copyright (C) 1996 Ben Wing
3
4 This file is part of XEmacs.
5
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
9 later version.
10
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
14 for more details.
15
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.  */
20
21 /* Synched up with: Not in FSF. */
22
23 /* Written by Ben Wing. */
24
25 #ifndef _XEMACS_CONSOLE_H_
26 #define _XEMACS_CONSOLE_H_
27
28 /* Devices and consoles are similar entities.  The idea is that
29    a console represents a physical keyboard/mouse/other-input-source
30    while a device represents a display where frames appear on.
31    In the X world, a console is a "Display" while a device is a
32    "Screen".  Implementationally, it can sometimes get confusing:
33    under X, multiple devices on a single console are different
34    "Display" connections to what is in reality the same Display on
35    the same server.  Because of this, input comes from the device
36    and not from the console.  This is OK because events are basically
37    always tagged to a particular X window (i.e. frame),
38    which exists on only one screen; therefore the event won't be
39    reported multiple times even if there are multiple devices on
40    the same physical display.  This is an implementation detail
41    specific to X consoles (e.g. under NeXTstep or Windows, this
42    could be different, and input would come directly from the console).
43 */
44
45
46 /* GCC does not like forward enum declaration. This needs to be
47    defined here. What a disgust! */
48
49 enum device_metrics
50 {
51   DM_color_default, DM_color_select, DM_color_balloon, DM_color_3d_face,
52   DM_color_3d_light, DM_color_3d_dark, DM_color_menu, DM_color_menu_highlight,
53   DM_color_menu_button, DM_color_menu_disabled, DM_color_toolbar,
54   DM_color_scrollbar, DM_color_desktop, DM_color_workspace, DM_font_default,
55   DM_font_menubar, DM_font_dialog, DM_size_cursor, DM_size_scrollbar,
56   DM_size_menu, DM_size_toolbar, DM_size_toolbar_button,
57   DM_size_toolbar_border, DM_size_icon, DM_size_icon_small, DM_size_device,
58   DM_size_workspace, DM_size_device_mm, DM_device_dpi, DM_num_bit_planes,
59   DM_num_color_cells, DM_mouse_buttons, DM_swap_buttons, DM_show_sounds,
60   DM_slow_device, DM_security
61 };
62
63 extern const struct struct_description cted_description;
64 extern const struct struct_description console_methods_description;
65
66 struct console_methods
67 {
68   CONST char *name;     /* Used by print_console, print_device, print_frame */
69   Lisp_Object symbol;
70   Lisp_Object predicate_symbol;
71
72   /* console methods */
73   void (*init_console_method) (struct console *, Lisp_Object props);
74   void (*mark_console_method) (struct console *);
75   int (*initially_selected_for_input_method) (struct console *);
76   void (*delete_console_method) (struct console *);
77   Lisp_Object (*semi_canonicalize_console_connection_method)
78     (Lisp_Object connection, Error_behavior errb);
79   Lisp_Object (*semi_canonicalize_device_connection_method)
80     (Lisp_Object connection, Error_behavior errb);
81   Lisp_Object (*canonicalize_console_connection_method)
82     (Lisp_Object connection, Error_behavior errb);
83   Lisp_Object (*canonicalize_device_connection_method)
84     (Lisp_Object connection, Error_behavior errb);
85   Lisp_Object (*device_to_console_connection_method)
86     (Lisp_Object connection, Error_behavior errb);
87
88   /* device methods */
89   void (*init_device_method) (struct device *, Lisp_Object props);
90   void (*finish_init_device_method) (struct device *, Lisp_Object props);
91   void (*delete_device_method) (struct device *);
92   void (*mark_device_method) (struct device *);
93   void (*asynch_device_change_method) (void);
94   Lisp_Object (*device_system_metrics_method) (struct device *, enum device_metrics);
95   unsigned int (*device_implementation_flags_method) (void);
96   Lisp_Object (*own_selection_method)(Lisp_Object selection_name, Lisp_Object selection_value);
97   void (*disown_selection_method)(Lisp_Object selection_name, Lisp_Object timeval);
98     Lisp_Object (*get_foreign_selection_method) (Lisp_Object selection_symbol,
99                                                  Lisp_Object target_type);
100   Lisp_Object (*selection_exists_p_method)(Lisp_Object selection_name);
101
102   /* frame methods */
103   Lisp_Object *device_specific_frame_props;
104   void (*init_frame_1_method) (struct frame *, Lisp_Object properties);
105   void (*init_frame_2_method) (struct frame *, Lisp_Object properties);
106   void (*init_frame_3_method) (struct frame *);
107   void (*after_init_frame_method) (struct frame *, int first_on_device,
108                                    int first_on_console);
109   void (*mark_frame_method) (struct frame *);
110   void (*delete_frame_method) (struct frame *);
111   void (*focus_on_frame_method) (struct frame *);
112   void (*raise_frame_method) (struct frame *);
113   void (*lower_frame_method) (struct frame *);
114   int (*get_mouse_position_method) (struct device *d, Lisp_Object *frame,
115                                     int *x, int *y);
116   void (*set_mouse_position_method) (struct window *w, int x, int y);
117   void (*make_frame_visible_method) (struct frame *f);
118   void (*make_frame_invisible_method) (struct frame *f);
119   void (*iconify_frame_method) (struct frame *f);
120   Lisp_Object (*frame_property_method) (struct frame *f, Lisp_Object prop);
121   int (*internal_frame_property_p_method) (struct frame *f,
122                                            Lisp_Object prop);
123   Lisp_Object (*frame_properties_method) (struct frame *f);
124   void (*set_frame_properties_method) (struct frame *f, Lisp_Object plist);
125   void (*set_frame_size_method) (struct frame *f, int width, int height);
126   void (*set_frame_position_method) (struct frame *f, int xoff, int yoff);
127   int (*frame_visible_p_method) (struct frame *f);
128   int (*frame_totally_visible_p_method) (struct frame *f);
129   int (*frame_iconified_p_method) (struct frame *f);
130   void (*set_title_from_bufbyte_method) (struct frame *f, Bufbyte *title);
131   void (*set_icon_name_from_bufbyte_method) (struct frame *f, Bufbyte *title);
132   void (*set_frame_pointer_method) (struct frame *f);
133   void (*set_frame_icon_method) (struct frame *f);
134   void (*popup_menu_method) (Lisp_Object menu, Lisp_Object event);
135   Lisp_Object (*get_frame_parent_method) (struct frame *f);
136   void (*update_frame_external_traits_method) (struct frame *f, Lisp_Object name);
137   int (*frame_size_fixed_p_method) (struct frame *f);
138
139   /* redisplay methods */
140   int (*left_margin_width_method) (struct window *);
141   int (*right_margin_width_method) (struct window *);
142   int (*text_width_method) (struct frame *f, struct face_cachel *cachel,
143                             CONST Emchar *str, Charcount len);
144   void (*output_display_block_method) (struct window *, struct display_line *,
145                                        int, int, int, int, int, int, int);
146   int (*divider_height_method) (void);
147   int (*eol_cursor_width_method) (void);
148   void (*output_vertical_divider_method) (struct window *, int);
149   void (*clear_to_window_end_method) (struct window *, int, int);
150   void (*clear_region_method) (Lisp_Object, struct device*, struct frame*, face_index,
151                                int, int, int, int,
152                                Lisp_Object, Lisp_Object, Lisp_Object);
153   void (*clear_frame_method) (struct frame *);
154   void (*output_begin_method) (struct device *);
155   void (*output_end_method) (struct device *);
156   int (*flash_method) (struct device *);
157   void (*ring_bell_method) (struct device *, int volume, int pitch,
158                             int duration);
159   void (*frame_redraw_cursor_method) (struct frame *f);
160   void (*set_final_cursor_coords_method) (struct frame *, int, int);
161   void (*bevel_area_method) (struct window *, face_index, int, int, int, int, int,
162                              int, enum edge_style);
163   void (*output_pixmap_method) (struct window *w, Lisp_Object image_instance,
164                                 struct display_box *db, struct display_glyph_area *dga,
165                                 face_index findex, int cursor_start, int cursor_width,
166                                 int cursor_height, int offset_bitmap);
167   void (*output_string_method) (struct window *w, struct display_line *dl,
168                                 Emchar_dynarr *buf, int xpos, int xoffset,
169                                 int start_pixpos, int width, face_index findex,
170                                 int cursor, int cursor_start, int cursor_width,
171                                 int cursor_height);
172   /* color methods */
173   int (*initialize_color_instance_method) (struct Lisp_Color_Instance *,
174                                            Lisp_Object name,
175                                            Lisp_Object device,
176                                            Error_behavior errb);
177   void (*mark_color_instance_method) (struct Lisp_Color_Instance *);
178   void (*print_color_instance_method) (struct Lisp_Color_Instance *,
179                                        Lisp_Object printcharfun,
180                                        int escapeflag);
181   void (*finalize_color_instance_method) (struct Lisp_Color_Instance *);
182   int (*color_instance_equal_method) (struct Lisp_Color_Instance *,
183                                       struct Lisp_Color_Instance *,
184                                       int depth);
185   unsigned long (*color_instance_hash_method) (struct Lisp_Color_Instance *,
186                                                int depth);
187   Lisp_Object (*color_instance_rgb_components_method)
188     (struct Lisp_Color_Instance *);
189   int (*valid_color_name_p_method) (struct device *, Lisp_Object color);
190
191   /* font methods */
192   int (*initialize_font_instance_method) (struct Lisp_Font_Instance *,
193                                           Lisp_Object name,
194                                           Lisp_Object device,
195                                           Error_behavior errb);
196   void (*mark_font_instance_method) (struct Lisp_Font_Instance *);
197   void (*print_font_instance_method) (struct Lisp_Font_Instance *,
198                                       Lisp_Object printcharfun,
199                                       int escapeflag);
200   void (*finalize_font_instance_method) (struct Lisp_Font_Instance *);
201   Lisp_Object (*font_instance_truename_method) (struct Lisp_Font_Instance *,
202                                                 Error_behavior errb);
203   Lisp_Object (*font_instance_properties_method) (struct Lisp_Font_Instance *);
204   Lisp_Object (*list_fonts_method) (Lisp_Object pattern,
205                                     Lisp_Object device);
206   Lisp_Object (*find_charset_font_method) (Lisp_Object device,
207                                            Lisp_Object font,
208                                            Lisp_Object charset);
209   int (*font_spec_matches_charset_method) (struct device *d,
210                                            Lisp_Object charset,
211                                            CONST Bufbyte *nonreloc,
212                                            Lisp_Object reloc,
213                                            Bytecount offset,
214                                            Bytecount length);
215
216   /* image methods */
217   void (*mark_image_instance_method) (struct Lisp_Image_Instance *);
218   void (*print_image_instance_method) (struct Lisp_Image_Instance *,
219                                        Lisp_Object printcharfun,
220                                        int escapeflag);
221   void (*finalize_image_instance_method) (struct Lisp_Image_Instance *);
222   void (*unmap_subwindow_method) (struct Lisp_Image_Instance *);
223   void (*map_subwindow_method) (struct Lisp_Image_Instance *, int x, int y,
224                                 struct display_glyph_area* dga);
225   void (*resize_subwindow_method) (struct Lisp_Image_Instance *, int w, int h);
226   void (*update_subwindow_method) (struct Lisp_Image_Instance *);
227   int (*image_instance_equal_method) (struct Lisp_Image_Instance *,
228                                       struct Lisp_Image_Instance *,
229                                       int depth);
230   unsigned long (*image_instance_hash_method) (struct Lisp_Image_Instance *,
231                                                int depth);
232   void (*init_image_instance_from_eimage_method) (struct Lisp_Image_Instance *ii,
233                                                   int width, int height,
234                                                   int slices,
235                                                   unsigned char *eimage,
236                                                   int dest_mask,
237                                                   Lisp_Object instantiator,
238                                                   Lisp_Object domain);
239   Lisp_Object (*locate_pixmap_file_method) (Lisp_Object file_method);
240   int (*colorize_image_instance_method) (Lisp_Object image_instance,
241                                          Lisp_Object fg, Lisp_Object bg);
242   Lisp_Object image_conversion_list;
243
244 #ifdef HAVE_TOOLBARS
245   /* toolbar methods */
246   void (*output_frame_toolbars_method) (struct frame *);
247   void (*initialize_frame_toolbars_method) (struct frame *);
248   void (*free_frame_toolbars_method) (struct frame *);
249   void (*output_toolbar_button_method) (struct frame *, Lisp_Object);
250   void (*redraw_frame_toolbars_method) (struct frame *);
251   void (*redraw_exposed_toolbars_method) (struct frame *f, int x, int y,
252                                           int width, int height);
253 #endif
254
255 #ifdef HAVE_SCROLLBARS
256   /* scrollbar methods */
257   int (*inhibit_scrollbar_slider_size_change_method) (void);
258   void (*free_scrollbar_instance_method) (struct scrollbar_instance *);
259   void (*release_scrollbar_instance_method) (struct scrollbar_instance *);
260   void (*create_scrollbar_instance_method) (struct frame *, int,
261                                             struct scrollbar_instance *);
262   void (*update_scrollbar_instance_values_method) (struct window *,
263                                                    struct scrollbar_instance *,
264                                                    int, int, int, int, int,
265                                                    int, int, int, int, int);
266   void (*update_scrollbar_instance_status_method) (struct window *, int, int,
267                                                    struct
268                                                    scrollbar_instance *);
269   void (*scrollbar_pointer_changed_in_window_method) (struct window *w);
270 #ifdef MEMORY_USAGE_STATS
271   int (*compute_scrollbar_instance_usage_method) (struct device *,
272                                                   struct scrollbar_instance *,
273                                                   struct overhead_stats *);
274 #endif
275 #endif /* HAVE_SCROLLBARS */
276
277 #ifdef HAVE_MENUBARS
278   /* menubar methods */
279   void (*update_frame_menubars_method) (struct frame *);
280   void (*free_frame_menubars_method) (struct frame *);
281 #endif
282
283 #ifdef HAVE_DIALOGS
284   /* dialog methods */
285   void (*popup_dialog_box_method) (struct frame *, Lisp_Object dbox_desc);
286 #endif
287 };
288
289 /*
290  * Constants returned by device_implementation_flags_method
291  */
292 /* Set when device uses pixel-based geometry */
293 #define XDEVIMPF_PIXEL_GEOMETRY   0x00000001L
294
295
296 #define CONSOLE_TYPE_NAME(c) ((c)->conmeths->name)
297 #define CONSOLE_TYPE(c) ((c)->conmeths->symbol)
298 #define CONMETH_TYPE(meths) ((meths)->symbol)
299
300 /******** Accessing / calling a console method *********/
301
302 #define HAS_CONTYPE_METH_P(meth, m) ((meth)->m##_method)
303 #define CONTYPE_METH(meth, m, args) (((meth)->m##_method) args)
304
305 /* Call a void-returning console method, if it exists */
306 #define MAYBE_CONTYPE_METH(meth, m, args) do {                  \
307   struct console_methods *maybe_contype_meth_meth = (meth);     \
308   if (HAS_CONTYPE_METH_P (maybe_contype_meth_meth, m))          \
309     CONTYPE_METH (maybe_contype_meth_meth, m, args);            \
310 } while (0)
311
312 /* Call a console method, if it exists; otherwise return
313    the specified value - meth is multiply evaluated.  */
314 #define CONTYPE_METH_OR_GIVEN(meth, m, args, given)     \
315   (HAS_CONTYPE_METH_P (meth, m) ?                       \
316    CONTYPE_METH (meth, m, args) : (given))
317
318 /* Call an int-returning console method, if it exists; otherwise
319    return 0 */
320 #define MAYBE_INT_CONTYPE_METH(meth, m, args) \
321   CONTYPE_METH_OR_GIVEN (meth, m, args, 0)
322
323 /* Call an Lisp-Object-returning console method, if it exists;
324    otherwise return Qnil */
325 #define MAYBE_LISP_CONTYPE_METH(meth, m, args) \
326   CONTYPE_METH_OR_GIVEN (meth, m, args, Qnil)
327
328 /******** Same functions, operating on a console instead of a
329           struct console_methods ********/
330
331 #define HAS_CONMETH_P(c, m) HAS_CONTYPE_METH_P ((c)->conmeths, m)
332 #define CONMETH(c, m, args) CONTYPE_METH ((c)->conmeths, m, args)
333 #define MAYBE_CONMETH(c, m, args) MAYBE_CONTYPE_METH ((c)->conmeths, m, args)
334 #define CONMETH_OR_GIVEN(c, m, args, given) \
335   CONTYPE_METH_OR_GIVEN((c)->conmeths, m, args, given)
336 #define MAYBE_INT_CONMETH(c, m, args) \
337   MAYBE_INT_CONTYPE_METH ((c)->conmeths, m, args)
338 #define MAYBE_LISP_CONMETH(c, m, args) \
339   MAYBE_LISP_CONTYPE_METH ((c)->conmeths, m, args)
340
341 /******** Defining new console types ********/
342
343 typedef struct console_type_entry console_type_entry;
344 struct console_type_entry
345 {
346   Lisp_Object symbol;
347   struct console_methods *meths;
348 };
349
350 #define DECLARE_CONSOLE_TYPE(type) \
351 extern struct console_methods * type##_console_methods
352
353 #define DEFINE_CONSOLE_TYPE(type) \
354 struct console_methods * type##_console_methods
355
356 #define INITIALIZE_CONSOLE_TYPE(type, obj_name, pred_sym) do {          \
357     type##_console_methods = xnew_and_zero (struct console_methods);    \
358     type##_console_methods->name = obj_name;                            \
359     type##_console_methods->symbol = Q##type;                           \
360     defsymbol_nodump (&type##_console_methods->predicate_symbol, pred_sym);     \
361     add_entry_to_console_type_list (Q##type, type##_console_methods);   \
362     type##_console_methods->image_conversion_list = Qnil;               \
363     staticpro_nodump (&type##_console_methods->image_conversion_list);  \
364     dumpstruct (&type##_console_methods, &console_methods_description); \
365 } while (0)
366
367 #define REINITIALIZE_CONSOLE_TYPE(type) do {    \
368     staticpro_nodump (&type##_console_methods->predicate_symbol);       \
369     staticpro_nodump (&type##_console_methods->image_conversion_list);  \
370 } while (0)
371
372
373 /* Declare that console-type TYPE has method M; used in
374    initialization routines */
375 #define CONSOLE_HAS_METHOD(type, m) \
376   (type##_console_methods->m##_method = type##_##m)
377
378 struct console
379 {
380   struct lcrecord_header header;
381
382   /* Description of this console's methods.  */
383   struct console_methods *conmeths;
384
385   /* A structure of auxiliary data specific to the console type.
386      struct x_console is used for X window frames; defined in console-x.h
387      struct tty_console is used to TTY's; defined in console-tty.h */
388   void *console_data;
389
390   /* Character that causes a quit.  Normally C-g.
391      #### Should be possible for this not to be ASCII. */
392   int quit_char;
393
394   /* ----- begin partially-completed console localization of
395            event loop ---- */
396
397   int local_var_flags;
398
399 #define MARKED_SLOT(x) Lisp_Object x
400 #include "conslots.h"
401 #undef MARKED_SLOT
402
403   /* Where to store the next keystroke of the macro.
404      Index into con->kbd_macro_builder. */
405   int kbd_macro_ptr;
406
407   /* The finalized section of the macro starts at kbd_macro_buffer and
408      ends before this.  This is not the same as kbd_macro_pointer, because
409      we advance this to kbd_macro_pointer when a key's command is complete.
410      This way, the keystrokes for "end-kbd-macro" are not included in the
411      macro.  */
412   int kbd_macro_end;
413
414   /* ----- end partially-completed console localization of event loop ---- */
415
416   unsigned int input_enabled :1;
417 };
418
419 DECLARE_LRECORD (console, struct console);
420 #define XCONSOLE(x) XRECORD (x, console, struct console)
421 #define XSETCONSOLE(x, p) XSETRECORD (x, p, console)
422 #define CONSOLEP(x) RECORDP (x, console)
423 #define CHECK_CONSOLE(x) CHECK_RECORD (x, console)
424 #define CONCHECK_CONSOLE(x) CONCHECK_RECORD (x, console)
425
426 #define CHECK_LIVE_CONSOLE(x) do {                      \
427   CHECK_CONSOLE (x);                                    \
428   if (! CONSOLE_LIVE_P (XCONSOLE (x)))                  \
429     dead_wrong_type_argument (Qconsole_live_p, (x));    \
430 } while (0)
431 #define CONCHECK_LIVE_CONSOLE(x) do {                   \
432   CONCHECK_CONSOLE (x);                                 \
433   if (! CONSOLE_LIVE_P (XCONSOLE (x)))                  \
434     x = wrong_type_argument (Qconsole_live_p, (x));     \
435 } while (0)
436
437 #define CONSOLE_TYPE_P(con, type) EQ (CONSOLE_TYPE (con), Q##type)
438
439 #ifdef ERROR_CHECK_TYPECHECK
440 INLINE struct console *
441 error_check_console_type (struct console *con, Lisp_Object sym);
442 INLINE struct console *
443 error_check_console_type (struct console *con, Lisp_Object sym)
444 {
445   assert (EQ (CONSOLE_TYPE (con), sym));
446   return con;
447 }
448 # define CONSOLE_TYPE_DATA(con, type)                   \
449   (*(struct type##_console **)                          \
450    &(error_check_console_type (con, Q##type))->console_data)
451 #else
452 # define CONSOLE_TYPE_DATA(con, type)                   \
453   (*(struct type##_console **) &((con)->console_data))
454 #endif
455
456 #define CHECK_CONSOLE_TYPE(x, type) do {                \
457   CHECK_CONSOLE (x);                                    \
458   if (! CONSOLE_TYPE_P (XCONSOLE (x), type))            \
459     dead_wrong_type_argument                            \
460       (type##_console_methods->predicate_symbol, x);    \
461 } while (0)
462 #define CONCHECK_CONSOLE_TYPE(x, type) do {             \
463   CONCHECK_CONSOLE (x);                                 \
464   if (!(CONSOLEP (x) &&                                 \
465         CONSOLE_TYPE_P (XCONSOLE (x), type)))           \
466     x = wrong_type_argument                             \
467       (type##_console_methods->predicate_symbol, x);    \
468 } while (0)
469
470 /* #### These should be in the console-*.h files but there are
471    too many places where the abstraction is broken.  Need to
472    fix. */
473
474 #ifdef HAVE_X_WINDOWS
475 #define CONSOLE_TYPESYM_X_P(typesym) EQ (typesym, Qx)
476 #else
477 #define CONSOLE_TYPESYM_X_P(typesym) 0
478 #endif
479 #ifdef HAVE_TTY
480 #define CONSOLE_TYPESYM_TTY_P(typesym) EQ (typesym, Qtty)
481 #else
482 #define CONSOLE_TYPESYM_TTY_P(typesym) 0
483 #endif
484 #ifdef HAVE_MS_WINDOWS
485 #define CONSOLE_TYPESYM_MSWINDOWS_P(typesym) EQ (typesym, Qmswindows)
486 #else
487 #define CONSOLE_TYPESYM_MSWINDOWS_P(typesym) 0
488 #endif
489 #define CONSOLE_TYPESYM_STREAM_P(typesym) EQ (typesym, Qstream)
490
491 #define CONSOLE_TYPESYM_WIN_P(typesym) \
492   (CONSOLE_TYPESYM_X_P (typesym) || CONSOLE_TYPESYM_MSWINDOWS_P (typesym))
493
494 #define CONSOLE_X_P(con) CONSOLE_TYPESYM_X_P (CONSOLE_TYPE (con))
495 #define CHECK_X_CONSOLE(z) CHECK_CONSOLE_TYPE (z, x)
496 #define CONCHECK_X_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, x)
497
498 #define CONSOLE_TTY_P(con) CONSOLE_TYPESYM_TTY_P (CONSOLE_TYPE (con))
499 #define CHECK_TTY_CONSOLE(z) CHECK_CONSOLE_TYPE (z, tty)
500 #define CONCHECK_TTY_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, tty)
501
502 #define CONSOLE_MSWINDOWS_P(con) CONSOLE_TYPESYM_MSWINDOWS_P (CONSOLE_TYPE (con))
503 #define CHECK_MSWINDOWS_CONSOLE(z) CHECK_CONSOLE_TYPE (z, mswindows)
504 #define CONCHECK_MSWINDOWS_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, mswindows)
505
506 #define CONSOLE_STREAM_P(con) CONSOLE_TYPESYM_STREAM_P (CONSOLE_TYPE (con))
507 #define CHECK_STREAM_CONSOLE(z) CHECK_CONSOLE_TYPE (z, stream)
508 #define CONCHECK_STREAM_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, stream)
509
510 #define CONSOLE_WIN_P(con) CONSOLE_TYPESYM_WIN_P (CONSOLE_TYPE (con))
511
512 EXFUN (Fconsole_disable_input, 1);
513 EXFUN (Fdelete_console, 2);
514 EXFUN (Fselect_console, 1);
515 EXFUN (Fselected_console, 0);
516
517 extern Lisp_Object Qcreate_console_hook, Qdelete_console_hook;
518 extern Lisp_Object Vconsole_defaults, Vconsole_type_list, Vselected_console;
519
520 /* This structure marks which slots in a console have corresponding
521    default values in console_defaults.
522    Each such slot has a nonzero value in this structure.
523    The value has only one nonzero bit.
524
525    When a console has its own local value for a slot,
526    the bit for that slot (found in the same slot in this structure)
527    is turned on in the console's local_var_flags slot.
528
529    If a slot in this structure is zero, then even though there may
530    be a DEFVAR_CONSOLE_LOCAL for the slot, there is no default value for it;
531    and the corresponding slot in console_defaults is not used.  */
532
533 extern struct console console_local_flags;
534
535 int valid_console_type_p (Lisp_Object type);
536
537 #define CONSOLE_LIVE_P(con) (!EQ (CONSOLE_TYPE (con), Qdead))
538
539 #define CONSOLE_NAME(con) ((con)->name)
540 #define CONSOLE_CONNECTION(con) ((con)->connection)
541 #define CONSOLE_CANON_CONNECTION(con) ((con)->canon_connection)
542 #define CONSOLE_FUNCTION_KEY_MAP(con) ((con)->function_key_map)
543 #define CONSOLE_DEVICE_LIST(con) ((con)->device_list)
544 #define CONSOLE_SELECTED_DEVICE(con) ((con)->selected_device)
545 #define CONSOLE_SELECTED_FRAME(con) \
546   DEVICE_SELECTED_FRAME (XDEVICE ((con)->selected_device))
547 #define CONSOLE_LAST_NONMINIBUF_FRAME(con) NON_LVALUE ((con)->last_nonminibuf_frame)
548 #define CONSOLE_QUIT_CHAR(con) ((con)->quit_char)
549
550 #define CDFW_CONSOLE(obj)                               \
551    (WINDOWP  (obj) ? WINDOW_CONSOLE (XWINDOW (obj))     \
552  : (FRAMEP   (obj) ?  FRAME_CONSOLE (XFRAME  (obj))     \
553  : (DEVICEP  (obj) ? DEVICE_CONSOLE (XDEVICE (obj))     \
554  : (CONSOLEP (obj) ? obj                                \
555  : Qnil))))
556
557 #define CONSOLE_LOOP(concons) LIST_LOOP (concons, Vconsole_list)
558 #define CONSOLE_DEVICE_LOOP(devcons, con) \
559   LIST_LOOP (devcons, CONSOLE_DEVICE_LIST (con))
560
561 DECLARE_CONSOLE_TYPE (dead);
562 extern console_type_entry_dynarr *the_console_type_entry_dynarr;
563
564 Lisp_Object create_console (Lisp_Object name, Lisp_Object type,
565                             Lisp_Object connection, Lisp_Object props);
566 void select_console_1 (Lisp_Object);
567 struct console *decode_console (Lisp_Object);
568 Lisp_Object make_console (struct console *c);
569 void add_entry_to_console_type_list (Lisp_Object symbol,
570                                      struct console_methods *type);
571 struct console_methods *decode_console_type (Lisp_Object type,
572                                              Error_behavior errb);
573 void delete_console_internal (struct console *con, int force,
574                               int from_kill_emacs, int from_io_error);
575 void io_error_delete_console (Lisp_Object console);
576 void set_console_last_nonminibuf_frame (struct console *con,
577                                         Lisp_Object frame);
578
579 #endif /* _XEMACS_CONSOLE_H_ */