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