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