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