git.chise.org Git - chise/xemacs-chise.git.1/blob - src/console.h

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