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