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