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