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