git.chise.org Git - chise/xemacs-chise.git.1/blob - 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 INCLUDED_console_h_
  26 #define INCLUDED_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_offset_workspace, DM_size_device_mm, DM_device_dpi,
  59   DM_num_bit_planes, DM_num_color_cells, DM_mouse_buttons, DM_swap_buttons,
  60   DM_show_sounds, 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 *,
  95                                                enum device_metrics);
  96   unsigned int (*device_implementation_flags_method) (void);
  97   Lisp_Object (*own_selection_method)(Lisp_Object selection_name,
  98                                       Lisp_Object selection_value,
  99                                       Lisp_Object how_to_add,
 100                                       Lisp_Object selection_type);
 101   void (*disown_selection_method)(Lisp_Object selection_name,
 102                                   Lisp_Object timeval);
 103   Lisp_Object (*get_foreign_selection_method) (Lisp_Object selection_symbol,
 104                                                Lisp_Object target_type);
 105   Lisp_Object (*selection_exists_p_method)(Lisp_Object selection_name,
 106                                            Lisp_Object selection_type);
 107   Lisp_Object (*available_selection_types_method)(Lisp_Object selection_name);
 108   Lisp_Object (*register_selection_data_type_method)(Lisp_Object type_name);
 109   Lisp_Object (*selection_data_type_name_method)(Lisp_Object type);
 110
 111   /* frame methods */
 112   Lisp_Object *device_specific_frame_props;
 113   void (*init_frame_1_method) (struct frame *, Lisp_Object properties);
 114   void (*init_frame_2_method) (struct frame *, Lisp_Object properties);
 115   void (*init_frame_3_method) (struct frame *);
 116   void (*after_init_frame_method) (struct frame *, int first_on_device,
 117                                    int first_on_console);
 118   void (*mark_frame_method) (struct frame *);
 119   void (*delete_frame_method) (struct frame *);
 120   void (*focus_on_frame_method) (struct frame *);
 121   void (*raise_frame_method) (struct frame *);
 122   void (*lower_frame_method) (struct frame *);
 123   void (*enable_frame_method) (struct frame *);
 124   void (*disable_frame_method) (struct frame *);
 125   int (*get_mouse_position_method) (struct device *d, Lisp_Object *frame,
 126                                     int *x, int *y);
 127   void (*set_mouse_position_method) (struct window *w, int x, int y);
 128   void (*make_frame_visible_method) (struct frame *f);
 129   void (*make_frame_invisible_method) (struct frame *f);
 130   void (*iconify_frame_method) (struct frame *f);
 131   Lisp_Object (*frame_property_method) (struct frame *f, Lisp_Object prop);
 132   int (*internal_frame_property_p_method) (struct frame *f,
 133                                            Lisp_Object prop);
 134   Lisp_Object (*frame_properties_method) (struct frame *f);
 135   void (*set_frame_properties_method) (struct frame *f, Lisp_Object plist);
 136   void (*set_frame_size_method) (struct frame *f, int width, int height);
 137   void (*set_frame_position_method) (struct frame *f, int xoff, int yoff);
 138   int (*frame_visible_p_method) (struct frame *f);
 139   int (*frame_totally_visible_p_method) (struct frame *f);
 140   int (*frame_iconified_p_method) (struct frame *f);
 141   void (*set_title_from_bufbyte_method) (struct frame *f, Bufbyte *title);
 142   void (*set_icon_name_from_bufbyte_method) (struct frame *f, Bufbyte *title);
 143   void (*set_frame_pointer_method) (struct frame *f);
 144   void (*set_frame_icon_method) (struct frame *f);
 145   void (*popup_menu_method) (Lisp_Object menu, Lisp_Object event);
 146   Lisp_Object (*get_frame_parent_method) (struct frame *f);
 147   void (*update_frame_external_traits_method) (struct frame *f, Lisp_Object name);
 148   int (*frame_size_fixed_p_method) (struct frame *f);
 149   void (*eject_page_method) (struct frame *f);
 150
 151   /* redisplay methods */
 152   int (*left_margin_width_method) (struct window *);
 153   int (*right_margin_width_method) (struct window *);
 154   int (*text_width_method) (struct frame *f, struct face_cachel *cachel,
 155                             const Emchar *str, Charcount len);
 156   void (*output_display_block_method) (struct window *, struct display_line *,
 157                                        int, int, int, int, int, int, int);
 158   int (*divider_height_method) (void);
 159   int (*eol_cursor_width_method) (void);
 160   void (*output_vertical_divider_method) (struct window *, int);
 161   void (*clear_to_window_end_method) (struct window *, int, int);
 162   void (*clear_region_method) (Lisp_Object, struct device*, struct frame*, face_index,
 163                                int, int, int, int,
 164                                Lisp_Object, Lisp_Object, Lisp_Object);
 165   void (*clear_frame_method) (struct frame *);
 166   void (*window_output_begin_method) (struct window *);
 167   void (*frame_output_begin_method) (struct frame *);
 168   void (*window_output_end_method) (struct window *);
 169   void (*frame_output_end_method) (struct frame *);
 170   int (*flash_method) (struct device *);
 171   void (*ring_bell_method) (struct device *, int volume, int pitch,
 172                             int duration);
 173   void (*frame_redraw_cursor_method) (struct frame *f);
 174   void (*set_final_cursor_coords_method) (struct frame *, int, int);
 175   void (*bevel_area_method) (struct window *, face_index, int, int, int, int, int,
 176                              int, enum edge_style);
 177   void (*output_pixmap_method) (struct window *w, Lisp_Object image_instance,
 178                                 struct display_box *db, struct display_glyph_area *dga,
 179                                 face_index findex, int cursor_start, int cursor_width,
 180                                 int cursor_height, int offset_bitmap);
 181   void (*output_string_method) (struct window *w, struct display_line *dl,
 182                                 Emchar_dynarr *buf, int xpos, int xoffset,
 183                                 int start_pixpos, int width, face_index findex,
 184                                 int cursor, int cursor_start, int cursor_width,
 185                                 int cursor_height);
 186   /* color methods */
 187   int (*initialize_color_instance_method) (Lisp_Color_Instance *,
 188                                            Lisp_Object name,
 189                                            Lisp_Object device,
 190                                            Error_behavior errb);
 191   void (*mark_color_instance_method) (Lisp_Color_Instance *);
 192   void (*print_color_instance_method) (Lisp_Color_Instance *,
 193                                        Lisp_Object printcharfun,
 194                                        int escapeflag);
 195   void (*finalize_color_instance_method) (Lisp_Color_Instance *);
 196   int (*color_instance_equal_method) (Lisp_Color_Instance *,
 197                                       Lisp_Color_Instance *,
 198                                       int depth);
 199   unsigned long (*color_instance_hash_method) (Lisp_Color_Instance *,
 200                                                int depth);
 201   Lisp_Object (*color_instance_rgb_components_method) (Lisp_Color_Instance *);
 202   int (*valid_color_name_p_method) (struct device *, Lisp_Object color);
 203
 204   /* font methods */
 205   int (*initialize_font_instance_method) (Lisp_Font_Instance *,
 206                                           Lisp_Object name,
 207                                           Lisp_Object device,
 208                                           Error_behavior errb);
 209   void (*mark_font_instance_method) (Lisp_Font_Instance *);
 210   void (*print_font_instance_method) (Lisp_Font_Instance *,
 211                                       Lisp_Object printcharfun,
 212                                       int escapeflag);
 213   void (*finalize_font_instance_method) (Lisp_Font_Instance *);
 214   Lisp_Object (*font_instance_truename_method) (Lisp_Font_Instance *,
 215                                                 Error_behavior errb);
 216   Lisp_Object (*font_instance_properties_method) (Lisp_Font_Instance *);
 217   Lisp_Object (*list_fonts_method) (Lisp_Object pattern,
 218                                     Lisp_Object device);
 219   Lisp_Object (*find_charset_font_method) (Lisp_Object device,
 220                                            Lisp_Object font,
 221                                            Lisp_Object charset);
 222   int (*font_spec_matches_charset_method) (struct device *d,
 223                                            Lisp_Object charset,
 224                                            const Bufbyte *nonreloc,
 225                                            Lisp_Object reloc,
 226                                            Bytecount offset,
 227                                            Bytecount length);
 228
 229   /* image methods */
 230   void (*mark_image_instance_method) (Lisp_Image_Instance *);
 231   void (*print_image_instance_method) (Lisp_Image_Instance *,
 232                                        Lisp_Object printcharfun,
 233                                        int escapeflag);
 234   void (*finalize_image_instance_method) (Lisp_Image_Instance *);
 235   void (*unmap_subwindow_method) (Lisp_Image_Instance *);
 236   void (*map_subwindow_method) (Lisp_Image_Instance *, int x, int y,
 237                                 struct display_glyph_area* dga);
 238   void (*resize_subwindow_method) (Lisp_Image_Instance *, int w, int h);
 239   void (*redisplay_subwindow_method) (Lisp_Image_Instance *);
 240   void (*redisplay_widget_method) (Lisp_Image_Instance *);
 241   int (*image_instance_equal_method) (Lisp_Image_Instance *,
 242                                       Lisp_Image_Instance *,
 243                                       int depth);
 244   unsigned long (*image_instance_hash_method) (Lisp_Image_Instance *,
 245                                                int depth);
 246   void (*init_image_instance_from_eimage_method) (Lisp_Image_Instance *ii,
 247                                                   int width, int height,
 248                                                   int slices,
 249                                                   unsigned char *eimage,
 250                                                   int dest_mask,
 251                                                   Lisp_Object instantiator,
 252                                                   Lisp_Object domain);
 253   Lisp_Object (*locate_pixmap_file_method) (Lisp_Object file_method);
 254   int (*colorize_image_instance_method) (Lisp_Object image_instance,
 255                                          Lisp_Object fg, Lisp_Object bg);
 256   Lisp_Object image_conversion_list;
 257
 258 #ifdef HAVE_TOOLBARS
 259   /* toolbar methods */
 260   void (*output_frame_toolbars_method) (struct frame *);
 261   void (*initialize_frame_toolbars_method) (struct frame *);
 262   void (*free_frame_toolbars_method) (struct frame *);
 263   void (*output_toolbar_button_method) (struct frame *, Lisp_Object);
 264   void (*redraw_frame_toolbars_method) (struct frame *);
 265   void (*redraw_exposed_toolbars_method) (struct frame *f, int x, int y,
 266                                           int width, int height);
 267 #endif
 268
 269 #ifdef HAVE_SCROLLBARS
 270   /* scrollbar methods */
 271   int (*inhibit_scrollbar_slider_size_change_method) (void);
 272   void (*free_scrollbar_instance_method) (struct scrollbar_instance *);
 273   void (*release_scrollbar_instance_method) (struct scrollbar_instance *);
 274   void (*create_scrollbar_instance_method) (struct frame *, int,
 275                                             struct scrollbar_instance *);
 276   void (*update_scrollbar_instance_values_method) (struct window *,
 277                                                    struct scrollbar_instance *,
 278                                                    int, int, int, int, int,
 279                                                    int, int, int, int, int);
 280   void (*update_scrollbar_instance_status_method) (struct window *, int, int,
 281                                                    struct
 282                                                    scrollbar_instance *);
 283   void (*scrollbar_pointer_changed_in_window_method) (struct window *w);
 284 #ifdef MEMORY_USAGE_STATS
 285   int (*compute_scrollbar_instance_usage_method) (struct device *,
 286                                                   struct scrollbar_instance *,
 287                                                   struct overhead_stats *);
 288 #endif
 289 #endif /* HAVE_SCROLLBARS */
 290
 291 #ifdef HAVE_MENUBARS
 292   /* menubar methods */
 293   void (*update_frame_menubars_method) (struct frame *);
 294   void (*free_frame_menubars_method) (struct frame *);
 295 #endif
 296
 297 #ifdef HAVE_DIALOGS
 298   /* dialog methods */
 299   Lisp_Object (*make_dialog_box_internal_method) (struct frame *,
 300                                                   Lisp_Object type,
 301                                                   Lisp_Object keys);
 302 #endif
 303 };
 304
 305 /*
 306  * Constants returned by device_implementation_flags_method
 307  */
 308
 309 /* Set when device uses pixel-based geometry */
 310 #define XDEVIMPF_PIXEL_GEOMETRY     0x00000001L
 311
 312 /* Indicates that the device is a printer */
 313 #define XDEVIMPF_IS_A_PRINTER       0x00000002L
 314
 315 /* Do not automatically redisplay this device */
 316 #define XDEVIMPF_NO_AUTO_REDISPLAY  0x00000004L
 317
 318 /* Do not delete the device when last frame's gone */
 319 #define XDEVIMPF_FRAMELESS_OK       0x00000008L
 320
 321
 322 #define CONSOLE_TYPE_NAME(c) ((c)->conmeths->name)
 323 #define CONSOLE_TYPE(c) ((c)->conmeths->symbol)
 324 #define CONMETH_TYPE(meths) ((meths)->symbol)
 325
 326 /******** Accessing / calling a console method *********/
 327
 328 #define HAS_CONTYPE_METH_P(meth, m) ((meth)->m##_method)
 329 #define CONTYPE_METH(meth, m, args) (((meth)->m##_method) args)
 330
 331 /* Call a void-returning console method, if it exists */
 332 #define MAYBE_CONTYPE_METH(meth, m, args) do {                  \
 333   struct console_methods *maybe_contype_meth_meth = (meth);     \
 334   if (HAS_CONTYPE_METH_P (maybe_contype_meth_meth, m))          \
 335     CONTYPE_METH (maybe_contype_meth_meth, m, args);            \
 336 } while (0)
 337
 338 /* Call a console method, if it exists; otherwise return
 339    the specified value - meth is multiply evaluated.  */
 340 #define CONTYPE_METH_OR_GIVEN(meth, m, args, given)     \
 341   (HAS_CONTYPE_METH_P (meth, m) ?                       \
 342    CONTYPE_METH (meth, m, args) : (given))
 343
 344 /* Call an int-returning console method, if it exists; otherwise
 345    return 0 */
 346 #define MAYBE_INT_CONTYPE_METH(meth, m, args) \
 347   CONTYPE_METH_OR_GIVEN (meth, m, args, 0)
 348
 349 /* Call an Lisp-Object-returning console method, if it exists;
 350    otherwise return Qnil */
 351 #define MAYBE_LISP_CONTYPE_METH(meth, m, args) \
 352   CONTYPE_METH_OR_GIVEN (meth, m, args, Qnil)
 353
 354 /******** Same functions, operating on a console instead of a
 355           struct console_methods ********/
 356
 357 #define HAS_CONMETH_P(c, m) HAS_CONTYPE_METH_P ((c)->conmeths, m)
 358 #define CONMETH(c, m, args) CONTYPE_METH ((c)->conmeths, m, args)
 359 #define MAYBE_CONMETH(c, m, args) MAYBE_CONTYPE_METH ((c)->conmeths, m, args)
 360 #define CONMETH_OR_GIVEN(c, m, args, given) \
 361   CONTYPE_METH_OR_GIVEN((c)->conmeths, m, args, given)
 362 #define MAYBE_INT_CONMETH(c, m, args) \
 363   MAYBE_INT_CONTYPE_METH ((c)->conmeths, m, args)
 364 #define MAYBE_LISP_CONMETH(c, m, args) \
 365   MAYBE_LISP_CONTYPE_METH ((c)->conmeths, m, args)
 366
 367 /******** Defining new console types ********/
 368
 369 typedef struct console_type_entry console_type_entry;
 370 struct console_type_entry
 371 {
 372   Lisp_Object symbol;
 373   struct console_methods *meths;
 374 };
 375
 376 #define DECLARE_CONSOLE_TYPE(type) \
 377 extern struct console_methods * type##_console_methods
 378
 379 #define DEFINE_CONSOLE_TYPE(type) \
 380 struct console_methods * type##_console_methods
 381
 382 #define INITIALIZE_CONSOLE_TYPE(type, obj_name, pred_sym) do {          \
 383     type##_console_methods = xnew_and_zero (struct console_methods);    \
 384     type##_console_methods->name = obj_name;                            \
 385     type##_console_methods->symbol = Q##type;                           \
 386     defsymbol_nodump (&type##_console_methods->predicate_symbol, pred_sym);     \
 387     add_entry_to_console_type_list (Q##type, type##_console_methods);   \
 388     type##_console_methods->image_conversion_list = Qnil;               \
 389     staticpro_nodump (&type##_console_methods->image_conversion_list);  \
 390     dumpstruct (&type##_console_methods, &console_methods_description); \
 391 } while (0)
 392
 393 #define REINITIALIZE_CONSOLE_TYPE(type) do {    \
 394     staticpro_nodump (&type##_console_methods->predicate_symbol);       \
 395     staticpro_nodump (&type##_console_methods->image_conversion_list);  \
 396 } while (0)
 397
 398
 399 /* Declare that console-type TYPE has method M; used in
 400    initialization routines */
 401 #define CONSOLE_HAS_METHOD(type, m) \
 402   (type##_console_methods->m##_method = type##_##m)
 403
 404 /* Declare that console-type TYPE inherits method M
 405    implementation from console-type FROMTYPE */
 406 #define CONSOLE_INHERITS_METHOD(type, fromtype, m) \
 407   (type##_console_methods->m##_method = fromtype##_##m)
 408
 409 struct console
 410 {
 411   struct lcrecord_header header;
 412
 413   /* Description of this console's methods.  */
 414   struct console_methods *conmeths;
 415
 416   /* A structure of auxiliary data specific to the console type.
 417      struct x_console is used for X window frames; defined in console-x.h
 418      struct tty_console is used to TTY's; defined in console-tty.h */
 419   void *console_data;
 420
 421   /* Character that causes a quit.  Normally C-g.
 422      #### Should be possible for this not to be ASCII. */
 423   int quit_char;
 424
 425   /* ----- begin partially-completed console localization of
 426            event loop ---- */
 427
 428   int local_var_flags;
 429
 430 #define MARKED_SLOT(x) Lisp_Object x
 431 #include "conslots.h"
 432 #undef MARKED_SLOT
 433
 434   /* Where to store the next keystroke of the macro.
 435      Index into con->kbd_macro_builder. */
 436   int kbd_macro_ptr;
 437
 438   /* The finalized section of the macro starts at kbd_macro_buffer and
 439      ends before this.  This is not the same as kbd_macro_pointer, because
 440      we advance this to kbd_macro_pointer when a key's command is complete.
 441      This way, the keystrokes for "end-kbd-macro" are not included in the
 442      macro.  */
 443   int kbd_macro_end;
 444
 445   /* ----- end partially-completed console localization of event loop ---- */
 446
 447   unsigned int input_enabled :1;
 448 };
 449
 450 DECLARE_LRECORD (console, struct console);
 451 #define XCONSOLE(x) XRECORD (x, console, struct console)
 452 #define XSETCONSOLE(x, p) XSETRECORD (x, p, console)
 453 #define CONSOLEP(x) RECORDP (x, console)
 454 #define CHECK_CONSOLE(x) CHECK_RECORD (x, console)
 455 #define CONCHECK_CONSOLE(x) CONCHECK_RECORD (x, console)
 456
 457 #define CHECK_LIVE_CONSOLE(x) do {                      \
 458   CHECK_CONSOLE (x);                                    \
 459   if (! CONSOLE_LIVE_P (XCONSOLE (x)))                  \
 460     dead_wrong_type_argument (Qconsole_live_p, (x));    \
 461 } while (0)
 462 #define CONCHECK_LIVE_CONSOLE(x) do {                   \
 463   CONCHECK_CONSOLE (x);                                 \
 464   if (! CONSOLE_LIVE_P (XCONSOLE (x)))                  \
 465     x = wrong_type_argument (Qconsole_live_p, (x));     \
 466 } while (0)
 467
 468 #define CONSOLE_TYPE_P(con, type) EQ (CONSOLE_TYPE (con), Q##type)
 469
 470 #ifdef ERROR_CHECK_TYPECHECK
 471 INLINE_HEADER struct console *
 472 error_check_console_type (struct console *con, Lisp_Object sym);
 473 INLINE_HEADER struct console *
 474 error_check_console_type (struct console *con, Lisp_Object sym)
 475 {
 476   assert (EQ (CONSOLE_TYPE (con), sym));
 477   return con;
 478 }
 479 # define CONSOLE_TYPE_DATA(con, type)                   \
 480   (*(struct type##_console **)                          \
 481    &(error_check_console_type (con, Q##type))->console_data)
 482 #else
 483 # define CONSOLE_TYPE_DATA(con, type)                   \
 484   (*(struct type##_console **) &((con)->console_data))
 485 #endif
 486
 487 #define CHECK_CONSOLE_TYPE(x, type) do {                \
 488   CHECK_CONSOLE (x);                                    \
 489   if (! CONSOLE_TYPE_P (XCONSOLE (x), type))            \
 490     dead_wrong_type_argument                            \
 491       (type##_console_methods->predicate_symbol, x);    \
 492 } while (0)
 493 #define CONCHECK_CONSOLE_TYPE(x, type) do {             \
 494   CONCHECK_CONSOLE (x);                                 \
 495   if (!(CONSOLEP (x) &&                                 \
 496         CONSOLE_TYPE_P (XCONSOLE (x), type)))           \
 497     x = wrong_type_argument                             \
 498       (type##_console_methods->predicate_symbol, x);    \
 499 } while (0)
 500
 501 /* #### These should be in the console-*.h files but there are
 502    too many places where the abstraction is broken.  Need to
 503    fix. */
 504
 505 #ifdef HAVE_X_WINDOWS
 506 #define CONSOLE_TYPESYM_X_P(typesym) EQ (typesym, Qx)
 507 #else
 508 #define CONSOLE_TYPESYM_X_P(typesym) 0
 509 #endif
 510 #ifdef HAVE_TTY
 511 #define CONSOLE_TYPESYM_TTY_P(typesym) EQ (typesym, Qtty)
 512 #else
 513 #define CONSOLE_TYPESYM_TTY_P(typesym) 0
 514 #endif
 515 #ifdef HAVE_MS_WINDOWS
 516 #define CONSOLE_TYPESYM_MSWINDOWS_P(typesym) EQ (typesym, Qmswindows)
 517 #else
 518 #define CONSOLE_TYPESYM_MSWINDOWS_P(typesym) 0
 519 #endif
 520 #define CONSOLE_TYPESYM_STREAM_P(typesym) EQ (typesym, Qstream)
 521
 522 #define CONSOLE_TYPESYM_WIN_P(typesym) \
 523   (CONSOLE_TYPESYM_X_P (typesym) || CONSOLE_TYPESYM_MSWINDOWS_P (typesym))
 524
 525 #define CONSOLE_X_P(con) CONSOLE_TYPESYM_X_P (CONSOLE_TYPE (con))
 526 #define CHECK_X_CONSOLE(z) CHECK_CONSOLE_TYPE (z, x)
 527 #define CONCHECK_X_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, x)
 528
 529 #define CONSOLE_TTY_P(con) CONSOLE_TYPESYM_TTY_P (CONSOLE_TYPE (con))
 530 #define CHECK_TTY_CONSOLE(z) CHECK_CONSOLE_TYPE (z, tty)
 531 #define CONCHECK_TTY_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, tty)
 532
 533 #define CONSOLE_MSWINDOWS_P(con) CONSOLE_TYPESYM_MSWINDOWS_P (CONSOLE_TYPE (con))
 534 #define CHECK_MSWINDOWS_CONSOLE(z) CHECK_CONSOLE_TYPE (z, mswindows)
 535 #define CONCHECK_MSWINDOWS_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, mswindows)
 536
 537 #define CONSOLE_STREAM_P(con) CONSOLE_TYPESYM_STREAM_P (CONSOLE_TYPE (con))
 538 #define CHECK_STREAM_CONSOLE(z) CHECK_CONSOLE_TYPE (z, stream)
 539 #define CONCHECK_STREAM_CONSOLE(z) CONCHECK_CONSOLE_TYPE (z, stream)
 540
 541 #define CONSOLE_WIN_P(con) CONSOLE_TYPESYM_WIN_P (CONSOLE_TYPE (con))
 542
 543 EXFUN (Fconsole_disable_input, 1);
 544 EXFUN (Fdelete_console, 2);
 545 EXFUN (Fselect_console, 1);
 546 EXFUN (Fselected_console, 0);
 547
 548 extern Lisp_Object Qcreate_console_hook, Qdelete_console_hook;
 549 extern Lisp_Object Vconsole_defaults, Vconsole_type_list, Vselected_console;
 550
 551 /* This structure marks which slots in a console have corresponding
 552    default values in console_defaults.
 553    Each such slot has a nonzero value in this structure.
 554    The value has only one nonzero bit.
 555
 556    When a console has its own local value for a slot,
 557    the bit for that slot (found in the same slot in this structure)
 558    is turned on in the console's local_var_flags slot.
 559
 560    If a slot in this structure is zero, then even though there may
 561    be a DEFVAR_CONSOLE_LOCAL for the slot, there is no default value for it;
 562    and the corresponding slot in console_defaults is not used.  */
 563
 564 extern struct console console_local_flags;
 565
 566 int valid_console_type_p (Lisp_Object type);
 567
 568 #define CONSOLE_LIVE_P(con) (!EQ (CONSOLE_TYPE (con), Qdead))
 569
 570 #define CONSOLE_NAME(con) ((con)->name)
 571 #define CONSOLE_CONNECTION(con) ((con)->connection)
 572 #define CONSOLE_CANON_CONNECTION(con) ((con)->canon_connection)
 573 #define CONSOLE_FUNCTION_KEY_MAP(con) ((con)->function_key_map)
 574 #define CONSOLE_DEVICE_LIST(con) ((con)->device_list)
 575 #define CONSOLE_SELECTED_DEVICE(con) ((con)->selected_device)
 576 #define CONSOLE_SELECTED_FRAME(con) \
 577   DEVICE_SELECTED_FRAME (XDEVICE ((con)->selected_device))
 578 #define CONSOLE_LAST_NONMINIBUF_FRAME(con) NON_LVALUE ((con)->last_nonminibuf_frame)
 579 #define CONSOLE_QUIT_CHAR(con) ((con)->quit_char)
 580
 581 #define CDFW_CONSOLE(obj)                               \
 582    (WINDOWP  (obj) ? WINDOW_CONSOLE (XWINDOW (obj))     \
 583  : (FRAMEP   (obj) ?  FRAME_CONSOLE (XFRAME  (obj))     \
 584  : (DEVICEP  (obj) ? DEVICE_CONSOLE (XDEVICE (obj))     \
 585  : (CONSOLEP (obj) ? obj                                \
 586  : Qnil))))
 587
 588 #define CONSOLE_LOOP(concons) LIST_LOOP (concons, Vconsole_list)
 589 #define CONSOLE_DEVICE_LOOP(devcons, con) \
 590   LIST_LOOP (devcons, CONSOLE_DEVICE_LIST (con))
 591
 592 DECLARE_CONSOLE_TYPE (dead);
 593 extern console_type_entry_dynarr *the_console_type_entry_dynarr;
 594
 595 Lisp_Object create_console (Lisp_Object name, Lisp_Object type,
 596                             Lisp_Object connection, Lisp_Object props);
 597 void select_console_1 (Lisp_Object);
 598 struct console *decode_console (Lisp_Object);
 599 Lisp_Object make_console (struct console *c);
 600 void add_entry_to_console_type_list (Lisp_Object symbol,
 601                                      struct console_methods *type);
 602 struct console_methods *decode_console_type (Lisp_Object type,
 603                                              Error_behavior errb);
 604 void delete_console_internal (struct console *con, int force,
 605                               int from_kill_emacs, int from_io_error);
 606 void io_error_delete_console (Lisp_Object console);
 607 void set_console_last_nonminibuf_frame (struct console *con,
 608                                         Lisp_Object frame);
 609
 610 #endif /* INCLUDED_console_h_ */