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