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