428
+ − 1 /* Define device-object for XEmacs.
+ − 2 Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
+ − 3 Copyright (C) 1995 Ben Wing
+ − 4 Copyright (C) 1995 Sun Microsystems
+ − 5
+ − 6 This file is part of XEmacs.
+ − 7
+ − 8 XEmacs is free software; you can redistribute it and/or modify it
+ − 9 under the terms of the GNU General Public License as published by the
+ − 10 Free Software Foundation; either version 2, or (at your option) any
+ − 11 later version.
+ − 12
+ − 13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
+ − 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ − 15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ − 16 for more details.
+ − 17
+ − 18 You should have received a copy of the GNU General Public License
+ − 19 along with XEmacs; see the file COPYING. If not, write to
+ − 20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ − 21 Boston, MA 02111-1307, USA. */
+ − 22
+ − 23 /* Synched up with: Not in FSF. */
+ − 24
+ − 25 /* Written by Chuck Thompson and Ben Wing. */
+ − 26
440
+ − 27 #ifndef INCLUDED_device_h_
+ − 28 #define INCLUDED_device_h_
428
+ − 29
+ − 30 #include "console.h"
+ − 31
+ − 32 /* This should really be in redisplay.h but by putting it here we
+ − 33 won't have to ensure that redisplay.h is always included before
+ − 34 this file. */
+ − 35 struct pixel_to_glyph_translation_cache
+ − 36 {
+ − 37 unsigned int valid :1;
+ − 38 struct frame *frame;
+ − 39 int low_x_coord, high_x_coord, col, obj_x;
+ − 40 int low_y_coord, high_y_coord, row, obj_y;
+ − 41 struct window *w;
665
+ − 42 Charbpos charbpos;
+ − 43 Charbpos closest;
428
+ − 44 Charcount modeline_closest;
+ − 45 Lisp_Object obj1, obj2;
+ − 46 int retval;
+ − 47 };
+ − 48
+ − 49 #define DEVICE_TYPE_NAME(d) ((d)->devmeths->name)
+ − 50 #define DEVICE_TYPE(d) ((d)->devmeths->symbol)
545
+ − 51 #define DEVICE_IMPL_FLAG(d, f) CONMETH_IMPL_FLAG ((d)->devmeths, (f))
428
+ − 52 #define DEVICE_SPECIFIC_FRAME_PROPS(d) \
+ − 53 ((d)->devmeths->device_specific_frame_props)
+ − 54
+ − 55 /******** Accessing / calling a device method *********/
+ − 56
+ − 57 #define HAS_DEVMETH_P(d, m) HAS_CONTYPE_METH_P ((d)->devmeths, m)
+ − 58 #define DEVMETH(d, m, args) CONTYPE_METH ((d)->devmeths, m, args)
+ − 59 #define MAYBE_DEVMETH(d, m, args) MAYBE_CONTYPE_METH ((d)->devmeths, m, args)
+ − 60 #define DEVMETH_OR_GIVEN(d, m, args, given) \
+ − 61 CONTYPE_METH_OR_GIVEN((d)->devmeths, m, args, given)
+ − 62 #define MAYBE_INT_DEVMETH(d, m, args) \
+ − 63 MAYBE_INT_CONTYPE_METH ((d)->devmeths, m, args)
+ − 64 #define MAYBE_LISP_DEVMETH(d, m, args) \
+ − 65 MAYBE_LISP_CONTYPE_METH ((d)->devmeths, m, args)
+ − 66
+ − 67 struct device
+ − 68 {
+ − 69 struct lcrecord_header header;
+ − 70
+ − 71 /* Methods for this device's console. This can also be retrieved
+ − 72 through device->console, but it's faster this way. */
+ − 73 struct console_methods *devmeths;
+ − 74
+ − 75 /* A structure of auxiliary data specific to the device type.
+ − 76 struct x_device is used for X window frames; defined in console-x.h
+ − 77 struct tty_device is used to TTY's; defined in console-tty.h */
+ − 78 void *device_data;
+ − 79
+ − 80 /* redisplay flags */
+ − 81 unsigned int buffers_changed :1;
+ − 82 unsigned int clip_changed :1;
+ − 83 unsigned int extents_changed :1;
+ − 84 unsigned int faces_changed :1;
+ − 85 unsigned int frame_changed :1;
+ − 86 unsigned int glyphs_changed :1;
+ − 87 unsigned int subwindows_changed :1;
+ − 88 unsigned int subwindows_state_changed :1;
+ − 89 unsigned int icon_changed :1;
+ − 90 unsigned int menubar_changed :1;
+ − 91 unsigned int modeline_changed :1;
+ − 92 unsigned int point_changed :1;
+ − 93 unsigned int size_changed :1;
+ − 94 unsigned int gutter_changed :1;
+ − 95 unsigned int toolbar_changed :1;
+ − 96 unsigned int windows_changed :1;
+ − 97 unsigned int windows_structure_changed :1;
+ − 98
+ − 99 unsigned int locked :1;
+ − 100
+ − 101 /* Cache information about last pixel position translated to a
+ − 102 glyph. The law of locality applies very heavily here so caching
+ − 103 the value leads to a significant win. At the moment this is
+ − 104 really X specific but once we have generic mouse support it won't
+ − 105 be. */
+ − 106 struct pixel_to_glyph_translation_cache pixel_to_glyph_cache;
+ − 107
+ − 108 /* Output baud rate of device; used for redisplay decisions. */
+ − 109 int baud_rate;
+ − 110
+ − 111 /* sound flags */
+ − 112 unsigned int on_console_p :1;
+ − 113 unsigned int connected_to_nas_p :1;
+ − 114
617
+ − 115 #define MARKED_SLOT(x) Lisp_Object x
+ − 116 #include "devslots.h"
428
+ − 117
+ − 118 /* File descriptors for input and output. Much of the time
+ − 119 (but not always) these will be the same. For an X device,
+ − 120 these both hold the file descriptor of the socket used
+ − 121 to communicate with the X server. For a TTY device, these
+ − 122 may or may not be the same and point to the terminal that
+ − 123 is used for I/O. */
+ − 124 int infd, outfd;
+ − 125
+ − 126 /* infd and outfd are moved outside HAVE_UNIXOID_EVENT_LOOP conditionals,
+ − 127 because Win32, presumably the first port which does not use select()
+ − 128 polling, DOES have handles for a console device. -- kkm */
+ − 129
+ − 130 #ifdef HAVE_UNIXOID_EVENT_LOOP
+ − 131 /* holds some data necessary for SIGIO control. Perhaps this should
+ − 132 be inside of device_data; but it is used for both TTY's and X
+ − 133 device. Perhaps it should be conditionalized on SIGIO; but
+ − 134 this requires including syssignal.h and systty.h. */
+ − 135 int old_fcntl_owner;
+ − 136 #endif
+ − 137 };
+ − 138
+ − 139 DECLARE_LRECORD (device, struct device);
+ − 140 #define XDEVICE(x) XRECORD (x, device, struct device)
+ − 141 #define XSETDEVICE(x, p) XSETRECORD (x, p, device)
617
+ − 142 #define wrap_device(p) wrap_record (p, device)
428
+ − 143 #define DEVICEP(x) RECORDP (x, device)
+ − 144 #define CHECK_DEVICE(x) CHECK_RECORD (x, device)
+ − 145 #define CONCHECK_DEVICE(x) CONCHECK_RECORD (x, device)
+ − 146
+ − 147 #define CHECK_LIVE_DEVICE(x) do { \
+ − 148 CHECK_DEVICE (x); \
+ − 149 if (! DEVICE_LIVE_P (XDEVICE (x))) \
+ − 150 dead_wrong_type_argument (Qdevice_live_p, (x)); \
+ − 151 } while (0)
+ − 152 #define CONCHECK_LIVE_DEVICE(x) do { \
+ − 153 CONCHECK_DEVICE (x); \
+ − 154 if (! DEVICE_LIVE_P (XDEVICE (x))) \
+ − 155 x = wrong_type_argument (Qdevice_live_p, (x)); \
+ − 156 } while (0)
+ − 157
+ − 158 #define DEVICE_TYPE_P(d, type) EQ (DEVICE_TYPE (d), Q##type)
+ − 159
+ − 160 #ifdef ERROR_CHECK_TYPECHECK
442
+ − 161 INLINE_HEADER struct device *
428
+ − 162 error_check_device_type (struct device *d, Lisp_Object sym);
442
+ − 163 INLINE_HEADER struct device *
428
+ − 164 error_check_device_type (struct device *d, Lisp_Object sym)
+ − 165 {
+ − 166 assert (EQ (DEVICE_TYPE (d), sym));
+ − 167 return d;
+ − 168 }
+ − 169 # define DEVICE_TYPE_DATA(d, type) \
+ − 170 ((struct type##_device *) error_check_device_type (d, Q##type)->device_data)
+ − 171 #else
+ − 172 # define DEVICE_TYPE_DATA(d, type) \
+ − 173 ((struct type##_device *) (d)->device_data)
+ − 174 #endif
+ − 175
+ − 176 #define CHECK_DEVICE_TYPE(x, type) \
+ − 177 do { \
+ − 178 CHECK_DEVICE (x); \
+ − 179 if (!(DEVICEP (x) && DEVICE_TYPE_P (XDEVICE (x), \
+ − 180 type))) \
+ − 181 dead_wrong_type_argument \
+ − 182 (type##_console_methods->predicate_symbol, x); \
+ − 183 } while (0)
+ − 184 #define CONCHECK_DEVICE_TYPE(x, type) \
+ − 185 do { \
+ − 186 CONCHECK_DEVICE (x); \
+ − 187 if (!(DEVICEP (x) && DEVICE_TYPE_P (XDEVICE (x), \
+ − 188 type))) \
+ − 189 x = wrong_type_argument \
+ − 190 (type##_console_methods->predicate_symbol, x); \
+ − 191 } while (0)
+ − 192
442
+ − 193 #define DEVICE_DISPLAY_P(dev) \
+ − 194 (DEVICE_LIVE_P (dev) && \
545
+ − 195 !DEVICE_IMPL_FLAG (dev, XDEVIMPF_IS_A_PRINTER))
442
+ − 196
+ − 197 #define CHECK_DISPLAY_DEVICE(dev) \
+ − 198 do { \
+ − 199 CHECK_DEVICE (dev); \
+ − 200 if (!(DEVICEP (dev) \
+ − 201 && DEVICE_DISPLAY_P (XDEVICE (dev)))) \
+ − 202 dead_wrong_type_argument (Qdisplay, dev); \
+ − 203 } while (0)
+ − 204
+ − 205 #define CONCHECK_DISPLAY_DEVICE(dev) \
+ − 206 do { \
+ − 207 CONCHECK_DEVICE (dev); \
+ − 208 if (!(DEVICEP (dev) \
+ − 209 && DEVICE_DISPLAY_P (XDEVICE (dev)))) \
+ − 210 wrong_type_argument (Qdisplay, dev); \
+ − 211 } while (0)
+ − 212
+ − 213 #define DEVICE_PRINTER_P(dev) \
+ − 214 (DEVICE_LIVE_P (dev) && !DEVICE_DISPLAY_P (dev))
+ − 215
+ − 216 #define CHECK_PRINTER_DEVICE(dev) \
+ − 217 do { \
+ − 218 CHECK_DEVICE (dev); \
+ − 219 if (!(DEVICEP (dev) \
+ − 220 && DEVICE_PRINTER_P (XDEVICE (dev)))) \
+ − 221 dead_wrong_type_argument (Qprinter, dev); \
+ − 222 } while (0)
+ − 223
+ − 224 #define CONCHECK_PRINTER_DEVICE(dev) \
+ − 225 do { \
+ − 226 CONCHECK_DEVICE (dev); \
+ − 227 if (!(DEVICEP (dev) \
+ − 228 && DEVICE_PRINTER_P (XDEVICE (dev)))) \
+ − 229 wrong_type_argument (Qprinter, dev); \
+ − 230 } while (0)
+ − 231
428
+ − 232 /* #### These should be in the device-*.h files but there are
+ − 233 too many places where the abstraction is broken. Need to
+ − 234 fix. */
+ − 235
+ − 236 #define DEVICE_X_P(dev) CONSOLE_TYPESYM_X_P (DEVICE_TYPE (dev))
+ − 237 #define CHECK_X_DEVICE(z) CHECK_DEVICE_TYPE (z, x)
+ − 238 #define CONCHECK_X_DEVICE(z) CONCHECK_DEVICE_TYPE (z, x)
+ − 239
462
+ − 240 #define DEVICE_GTK_P(dev) CONSOLE_TYPESYM_GTK_P (DEVICE_TYPE (dev))
+ − 241 #define CHECK_GTK_DEVICE(z) CHECK_DEVICE_TYPE (z, gtk)
+ − 242 #define CONCHECK_GTK_DEVICE(z) CONCHECK_DEVICE_TYPE (z, gtk)
+ − 243
428
+ − 244 #define DEVICE_MSWINDOWS_P(dev) CONSOLE_TYPESYM_MSWINDOWS_P (DEVICE_TYPE (dev))
+ − 245 #define CHECK_MSWINDOWS_DEVICE(z) CHECK_DEVICE_TYPE (z, mswindows)
+ − 246 #define CONCHECK_MSWINDOWS_DEVICE(z) CONCHECK_DEVICE_TYPE (z, mswindows)
+ − 247
+ − 248 #define DEVICE_TTY_P(dev) CONSOLE_TYPESYM_TTY_P (DEVICE_TYPE (dev))
+ − 249 #define CHECK_TTY_DEVICE(z) CHECK_DEVICE_TYPE (z, tty)
+ − 250 #define CONCHECK_TTY_DEVICE(z) CONCHECK_DEVICE_TYPE (z, tty)
+ − 251
+ − 252 #define DEVICE_STREAM_P(dev) CONSOLE_TYPESYM_STREAM_P (DEVICE_TYPE (dev))
+ − 253 #define CHECK_STREAM_DEVICE(z) CHECK_DEVICE_TYPE (z, stream)
+ − 254 #define CONCHECK_STREAM_DEVICE(z) CONCHECK_DEVICE_TYPE (z, stream)
+ − 255
+ − 256 #define DEVICE_WIN_P(dev) CONSOLE_TYPESYM_WIN_P (DEVICE_TYPE (dev))
+ − 257
+ − 258 EXFUN (Fdevice_console, 1);
+ − 259 EXFUN (Fdevice_name, 1);
442
+ − 260 EXFUN (Ffind_device, 2);
428
+ − 261 EXFUN (Fmake_device, 3);
+ − 262 EXFUN (Fselected_device, 1);
+ − 263
+ − 264 extern Lisp_Object Qcreate_device_hook, Qdelete_device_hook, Qgrayscale;
462
+ − 265 extern Lisp_Object Qinit_post_tty_win, Qmono, Vdefault_x_device, Vdefault_gtk_device;
428
+ − 266 extern Lisp_Object Vdevice_class_list;
+ − 267
+ − 268 int valid_device_class_p (Lisp_Object class);
+ − 269
+ − 270 #define DEVICE_LIVE_P(d) (!EQ (DEVICE_TYPE (d), Qdead))
+ − 271
+ − 272 #define DEVICE_REDISPLAY_INFO(d) ((d)->redisplay_info)
+ − 273
+ − 274 #define DEVICE_NAME(d) ((d)->name)
+ − 275 #define DEVICE_CLASS(d) ((d)->device_class)
+ − 276 /* Catch people attempting to set this. */
+ − 277 #define DEVICE_SELECTED_FRAME(d) NON_LVALUE ((d)->selected_frame)
+ − 278 #define DEVICE_FRAME_WITH_FOCUS_REAL(d) ((d)->frame_with_focus_real)
+ − 279 #define DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS(d) ((d)->frame_with_focus_for_hooks)
+ − 280 #define DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS(d) \
+ − 281 ((d)->frame_that_ought_to_have_focus)
+ − 282 #define DEVICE_USER_DEFINED_TAGS(d) ((d)->user_defined_tags)
+ − 283 #define DEVICE_FRAME_LIST(d) ((d)->frame_list)
+ − 284 #define DEVICE_CONNECTION(d) ((d)->connection)
+ − 285 #define DEVICE_CANON_CONNECTION(d) ((d)->canon_connection)
+ − 286 #define DEVICE_CONSOLE(d) ((d)->console)
+ − 287 #define DEVICE_BAUD_RATE(d) ((d)->baud_rate)
+ − 288 #define DEVICE_INFD(d) ((d)->infd)
+ − 289 #define DEVICE_OUTFD(d) ((d)->outfd)
+ − 290 #define DEVICE_OLD_FCNTL_OWNER(d) ((d)->old_fcntl_owner)
+ − 291 #define DEVICE_ON_CONSOLE_P(d) ((d)->on_console_p)
+ − 292 #define DEVICE_CONNECTED_TO_NAS_P(d) ((d)->connected_to_nas_p)
+ − 293
+ − 294 #define LOCK_DEVICE(d) ((void) ((d)->locked = 1))
+ − 295 #define UNLOCK_DEVICE(d) ((void) ((d)->locked = 0))
+ − 296
+ − 297 #define INVALIDATE_DEVICE_PIXEL_TO_GLYPH_CACHE(d) \
+ − 298 ((void) ((d)->pixel_to_glyph_cache.valid = 0))
+ − 299
+ − 300 #define INVALIDATE_PIXEL_TO_GLYPH_CACHE do { \
+ − 301 Lisp_Object IPTGC_devcons, IPTGC_concons; \
+ − 302 DEVICE_LOOP_NO_BREAK (IPTGC_devcons, IPTGC_concons) \
+ − 303 INVALIDATE_DEVICE_PIXEL_TO_GLYPH_CACHE (XDEVICE (XCAR (IPTGC_devcons))); \
+ − 304 } while (0)
+ − 305
+ − 306 #define MARK_DEVICE_FACES_CHANGED(d) \
+ − 307 ((void) (faces_changed = (d)->faces_changed = 1))
+ − 308
+ − 309 #define MARK_DEVICE_GLYPHS_CHANGED(d) \
+ − 310 ((void) (glyphs_changed = (d)->glyphs_changed = 1))
+ − 311
+ − 312 #define MARK_DEVICE_SUBWINDOWS_CHANGED(d) \
+ − 313 ((void) (subwindows_changed = (d)->subwindows_changed = 1))
+ − 314
+ − 315 #define MARK_DEVICE_SUBWINDOWS_STATE_CHANGED(d) \
+ − 316 ((void) (subwindows_state_changed = (d)->subwindows_state_changed = 1))
+ − 317
+ − 318 #define MARK_DEVICE_TOOLBARS_CHANGED(d) \
+ − 319 ((void) (toolbar_changed = (d)->toolbar_changed = 1))
+ − 320
+ − 321 #define MARK_DEVICE_GUTTERS_CHANGED(d) \
+ − 322 ((void) (gutter_changed = (d)->gutter_changed = 1))
+ − 323
+ − 324 #define MARK_DEVICE_SIZE_CHANGED(d) \
+ − 325 ((void) (size_changed = (d)->size_changed = 1))
+ − 326
+ − 327 #define MARK_DEVICE_FRAMES_FACES_CHANGED(d) do { \
+ − 328 struct device *mdffc_d = (d); \
+ − 329 Lisp_Object frmcons; \
+ − 330 DEVICE_FRAME_LOOP (frmcons, mdffc_d) \
+ − 331 XFRAME (XCAR (frmcons))->faces_changed = 1; \
+ − 332 MARK_DEVICE_FACES_CHANGED (mdffc_d); \
+ − 333 } while (0)
+ − 334
+ − 335 #define MARK_DEVICE_FRAMES_GLYPHS_CHANGED(d) do { \
+ − 336 struct device *mdffc_d = (d); \
+ − 337 Lisp_Object frmcons; \
+ − 338 DEVICE_FRAME_LOOP (frmcons, mdffc_d) \
+ − 339 XFRAME (XCAR (frmcons))->glyphs_changed = 1; \
+ − 340 MARK_DEVICE_GLYPHS_CHANGED (mdffc_d); \
+ − 341 } while (0)
+ − 342
+ − 343 #define MARK_DEVICE_FRAME_CHANGED(d) \
+ − 344 ((void) (frame_changed = (d)->frame_changed = 1))
+ − 345
+ − 346 #define MARK_DEVICE_WINDOWS_CHANGED(d) \
+ − 347 ((void) (windows_changed = (d)->windows_changed = 1))
+ − 348
+ − 349 #define MARK_DEVICE_WINDOWS_STRUCTURE_CHANGED(d) \
+ − 350 ((void) (windows_structure_changed = (d)->windows_structure_changed = 1))
+ − 351
442
+ − 352 /* #### unify this with DOMAIN_DEVICE once the latter has image instances
+ − 353 expunged from it. */
428
+ − 354 /* This turns out to be used heavily so we make it a macro to make it
+ − 355 inline. Also, the majority of the time the object will turn out to
+ − 356 be a window so we move it from being checked last to being checked
+ − 357 first. */
+ − 358 #define DFW_DEVICE(obj) \
+ − 359 (WINDOWP (obj) ? WINDOW_DEVICE (XWINDOW (obj)) \
+ − 360 : (FRAMEP (obj) ? FRAME_DEVICE (XFRAME (obj)) \
+ − 361 : (DEVICEP (obj) ? obj \
+ − 362 : Qnil)))
+ − 363
+ − 364 /* NO_BREAK means that "break" doesn't do what you think it does!
+ − 365 Use goto instead. "continue" is OK, though. */
+ − 366 #define DEVICE_LOOP_NO_BREAK(devcons, concons) \
+ − 367 CONSOLE_LOOP (concons) \
+ − 368 CONSOLE_DEVICE_LOOP (devcons, XCONSOLE (XCAR (concons)))
+ − 369 #define DEVICE_FRAME_LOOP(frmcons, d) \
+ − 370 LIST_LOOP (frmcons, DEVICE_FRAME_LIST (d))
+ − 371 #define CONSOLE_FRAME_LOOP_NO_BREAK(frmcons, devcons, con) \
+ − 372 CONSOLE_DEVICE_LOOP (devcons, con) \
+ − 373 DEVICE_FRAME_LOOP (frmcons, XDEVICE (XCAR (devcons)))
+ − 374
+ − 375 void select_device_1 (Lisp_Object);
+ − 376 struct device *decode_device (Lisp_Object);
+ − 377 void handle_asynch_device_change (void);
+ − 378 void call_critical_lisp_code (struct device *d, Lisp_Object function,
+ − 379 Lisp_Object object);
+ − 380 void delete_device_internal (struct device *d, int force,
+ − 381 int called_from_delete_console,
+ − 382 int from_io_error);
+ − 383 void io_error_delete_device (Lisp_Object device);
+ − 384 Lisp_Object find_nonminibuffer_frame_not_on_device (Lisp_Object device);
+ − 385 void set_device_selected_frame (struct device *d, Lisp_Object frame);
+ − 386 Lisp_Object domain_device_type (Lisp_Object domain);
+ − 387 int window_system_pixelated_geometry (Lisp_Object domain);
+ − 388
440
+ − 389 #endif /* INCLUDED_device_h_ */
