872
+ − 1 /* Define device-object for XEmacs.
+ − 2 Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
+ − 3 Copyright (C) 1995, 2002 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
+ − 27 #ifndef INCLUDED_device_impl_h_
+ − 28 #define INCLUDED_device_impl_h_
+ − 29
+ − 30 #include "console-impl.h"
+ − 31 #include "device.h"
+ − 32
+ − 33 /* This should really be in redisplay.h but by putting it here we
+ − 34 won't have to ensure that redisplay.h is always included before
+ − 35 this file. */
+ − 36 struct pixel_to_glyph_translation_cache
+ − 37 {
+ − 38 unsigned int valid :1;
+ − 39 struct frame *frame;
+ − 40 int low_x_coord, high_x_coord, col, obj_x;
+ − 41 int low_y_coord, high_y_coord, row, obj_y;
+ − 42 struct window *w;
+ − 43 Charbpos charpos;
+ − 44 Charbpos closest;
+ − 45 Charcount modeline_closest;
+ − 46 Lisp_Object obj1, obj2;
+ − 47 int retval;
+ − 48 };
+ − 49
+ − 50 /* Less public: */
+ − 51 #define DEVICE_TYPE_NAME(d) ((d)->devmeths->name)
+ − 52 #define DEVICE_IMPL_FLAG(d, f) CONMETH_IMPL_FLAG ((d)->devmeths, (f))
+ − 53 #define DEVICE_SPECIFIC_FRAME_PROPS(d) \
+ − 54 ((d)->devmeths->device_specific_frame_props)
+ − 55
+ − 56 /* More public: */
+ − 57 #define DEVICE_TYPE(d) ((d)->devmeths->symbol)
+ − 58 #define XDEVICE_TYPE(d) DEVICE_TYPE (XDEVICE (d))
+ − 59
+ − 60 /******** Accessing / calling a device method *********/
+ − 61
+ − 62 #define HAS_DEVMETH_P(d, m) HAS_CONTYPE_METH_P ((d)->devmeths, m)
+ − 63 #define DEVMETH(d, m, args) CONTYPE_METH ((d)->devmeths, m, args)
+ − 64 #define MAYBE_DEVMETH(d, m, args) MAYBE_CONTYPE_METH ((d)->devmeths, m, args)
+ − 65 #define DEVMETH_OR_GIVEN(d, m, args, given) \
+ − 66 CONTYPE_METH_OR_GIVEN((d)->devmeths, m, args, given)
+ − 67 #define MAYBE_INT_DEVMETH(d, m, args) \
+ − 68 MAYBE_INT_CONTYPE_METH ((d)->devmeths, m, args)
+ − 69 #define MAYBE_LISP_DEVMETH(d, m, args) \
+ − 70 MAYBE_LISP_CONTYPE_METH ((d)->devmeths, m, args)
+ − 71
+ − 72 struct device
+ − 73 {
3017
+ − 74 struct LCRECORD_HEADER header;
872
+ − 75
+ − 76 /* Methods for this device's console. This can also be retrieved
+ − 77 through device->console, but it's faster this way. */
+ − 78 struct console_methods *devmeths;
+ − 79
1204
+ − 80 /* Duplicates devmeths->symbol. See comment in struct console. */
934
+ − 81 enum console_variant devtype;
+ − 82
872
+ − 83 /* A structure of auxiliary data specific to the device type.
+ − 84 struct x_device is used for X window frames; defined in console-x.h
+ − 85 struct tty_device is used to TTY's; defined in console-tty.h */
+ − 86 void *device_data;
+ − 87
+ − 88 /* redisplay flags */
+ − 89 unsigned int buffers_changed :1;
+ − 90 unsigned int clip_changed :1;
+ − 91 unsigned int extents_changed :1;
+ − 92 unsigned int faces_changed :1;
+ − 93 unsigned int frame_changed :1;
905
+ − 94 unsigned int frame_layout_changed :1; /* The layout of frame
+ − 95 elements has changed. */
872
+ − 96 unsigned int glyphs_changed :1;
+ − 97 unsigned int subwindows_changed :1;
+ − 98 unsigned int subwindows_state_changed :1;
+ − 99 unsigned int icon_changed :1;
+ − 100 unsigned int menubar_changed :1;
+ − 101 unsigned int modeline_changed :1;
+ − 102 unsigned int point_changed :1;
+ − 103 unsigned int size_changed :1;
+ − 104 unsigned int gutter_changed :1;
+ − 105 unsigned int toolbar_changed :1;
+ − 106 unsigned int windows_changed :1;
+ − 107 unsigned int windows_structure_changed :1;
+ − 108
+ − 109 unsigned int locked :1;
+ − 110
+ − 111 /* Cache information about last pixel position translated to a
+ − 112 glyph. The law of locality applies very heavily here so caching
+ − 113 the value leads to a significant win. At the moment this is
+ − 114 really X specific but once we have generic mouse support it won't
+ − 115 be. */
+ − 116 struct pixel_to_glyph_translation_cache pixel_to_glyph_cache;
+ − 117
+ − 118 /* Output baud rate of device; used for redisplay decisions. */
+ − 119 int baud_rate;
+ − 120
+ − 121 /* sound flags */
+ − 122 unsigned int on_console_p :1;
+ − 123 unsigned int connected_to_nas_p :1;
+ − 124
1204
+ − 125 #define MARKED_SLOT(x) Lisp_Object x;
872
+ − 126 #include "devslots.h"
+ − 127
+ − 128 /* File descriptors for input and output. Much of the time
+ − 129 (but not always) these will be the same. For an X device,
+ − 130 these both hold the file descriptor of the socket used
+ − 131 to communicate with the X server. For a TTY device, these
+ − 132 may or may not be the same and point to the terminal that
+ − 133 is used for I/O. */
+ − 134 int infd, outfd;
+ − 135
+ − 136 /* infd and outfd are moved outside HAVE_UNIXOID_EVENT_LOOP conditionals,
+ − 137 because Win32, presumably the first port which does not use select()
+ − 138 polling, DOES have handles for a console device. -- kkm */
+ − 139
+ − 140 #ifdef HAVE_UNIXOID_EVENT_LOOP
+ − 141 /* holds some data necessary for SIGIO control. Perhaps this should
+ − 142 be inside of device_data; but it is used for both TTY's and X
+ − 143 device. Perhaps it should be conditionalized on SIGIO; but
+ − 144 this requires including syssignal.h. */
+ − 145 int old_fcntl_owner;
+ − 146 #endif
+ − 147 };
+ − 148
+ − 149 /* Redefine basic properties more efficiently */
+ − 150
+ − 151 #undef DEVICE_LIVE_P
+ − 152 #define DEVICE_LIVE_P(d) (!EQ (DEVICE_TYPE (d), Qdead))
+ − 153 #undef DEVICE_CONSOLE
+ − 154 #define DEVICE_CONSOLE(d) ((d)->console)
+ − 155 #undef DEVICE_FRAME_LIST
+ − 156 #define DEVICE_FRAME_LIST(d) ((d)->frame_list)
+ − 157
+ − 158 #define DEVICE_TYPE_P(d, type) EQ (DEVICE_TYPE (d), Q##type)
+ − 159
+ − 160 #ifdef ERROR_CHECK_TYPES
+ − 161 DECLARE_INLINE_HEADER (
+ − 162 struct device *
+ − 163 error_check_device_type (struct device *d, Lisp_Object sym)
+ − 164 )
+ − 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
+ − 193 #define DEVICE_DISPLAY_P(dev) \
+ − 194 (DEVICE_LIVE_P (dev) && \
+ − 195 !DEVICE_IMPL_FLAG (dev, XDEVIMPF_IS_A_PRINTER))
+ − 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
+ − 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
+ − 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
+ − 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 #define DEVICE_REDISPLAY_INFO(d) ((d)->redisplay_info)
+ − 259
+ − 260 #define DEVICE_NAME(d) ((d)->name)
+ − 261 #define DEVICE_CLASS(d) ((d)->device_class)
+ − 262 /* Catch people attempting to set this. */
+ − 263 #define DEVICE_SELECTED_FRAME(d) NON_LVALUE ((d)->selected_frame)
+ − 264 #define DEVICE_FRAME_WITH_FOCUS_REAL(d) ((d)->frame_with_focus_real)
+ − 265 #define DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS(d) ((d)->frame_with_focus_for_hooks)
+ − 266 #define DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS(d) \
+ − 267 ((d)->frame_that_ought_to_have_focus)
+ − 268 #define DEVICE_USER_DEFINED_TAGS(d) ((d)->user_defined_tags)
+ − 269 #define DEVICE_CONNECTION(d) ((d)->connection)
+ − 270 #define DEVICE_CANON_CONNECTION(d) ((d)->canon_connection)
+ − 271 #define DEVICE_BAUD_RATE(d) ((d)->baud_rate)
+ − 272 #define DEVICE_INFD(d) ((d)->infd)
+ − 273 #define DEVICE_OUTFD(d) ((d)->outfd)
+ − 274 #define DEVICE_OLD_FCNTL_OWNER(d) ((d)->old_fcntl_owner)
+ − 275 #define DEVICE_ON_CONSOLE_P(d) ((d)->on_console_p)
+ − 276 #define DEVICE_CONNECTED_TO_NAS_P(d) ((d)->connected_to_nas_p)
+ − 277
+ − 278 #define LOCK_DEVICE(d) ((void) ((d)->locked = 1))
+ − 279 #define UNLOCK_DEVICE(d) ((void) ((d)->locked = 0))
+ − 280
+ − 281 #define INVALIDATE_DEVICE_PIXEL_TO_GLYPH_CACHE(d) \
+ − 282 ((void) ((d)->pixel_to_glyph_cache.valid = 0))
+ − 283
+ − 284 #define INVALIDATE_PIXEL_TO_GLYPH_CACHE do { \
+ − 285 Lisp_Object IPTGC_devcons, IPTGC_concons; \
+ − 286 DEVICE_LOOP_NO_BREAK (IPTGC_devcons, IPTGC_concons) \
+ − 287 INVALIDATE_DEVICE_PIXEL_TO_GLYPH_CACHE (XDEVICE (XCAR (IPTGC_devcons))); \
+ − 288 } while (0)
+ − 289
+ − 290 #define MARK_DEVICE_FACES_CHANGED(d) \
+ − 291 ((void) (faces_changed = (d)->faces_changed = 1))
+ − 292
+ − 293 #define MARK_DEVICE_GLYPHS_CHANGED(d) \
+ − 294 ((void) (glyphs_changed = (d)->glyphs_changed = 1))
+ − 295
+ − 296 #define MARK_DEVICE_SUBWINDOWS_CHANGED(d) \
+ − 297 ((void) (subwindows_changed = (d)->subwindows_changed = 1))
+ − 298
+ − 299 #define MARK_DEVICE_SUBWINDOWS_STATE_CHANGED(d) \
+ − 300 ((void) (subwindows_state_changed = (d)->subwindows_state_changed = 1))
+ − 301
+ − 302 #define MARK_DEVICE_TOOLBARS_CHANGED(d) \
+ − 303 ((void) (toolbar_changed = (d)->toolbar_changed = 1))
+ − 304
+ − 305 #define MARK_DEVICE_GUTTERS_CHANGED(d) \
+ − 306 ((void) (gutter_changed = (d)->gutter_changed = 1))
+ − 307
+ − 308 #define MARK_DEVICE_SIZE_CHANGED(d) \
+ − 309 ((void) (size_changed = (d)->size_changed = 1))
+ − 310
+ − 311 #define MARK_DEVICE_FRAMES_FACES_CHANGED(d) do { \
+ − 312 struct device *mdffc_d = (d); \
+ − 313 Lisp_Object frmcons; \
+ − 314 DEVICE_FRAME_LOOP (frmcons, mdffc_d) \
+ − 315 XFRAME (XCAR (frmcons))->faces_changed = 1; \
+ − 316 MARK_DEVICE_FACES_CHANGED (mdffc_d); \
+ − 317 } while (0)
+ − 318
+ − 319 #define MARK_DEVICE_FRAMES_GLYPHS_CHANGED(d) do { \
+ − 320 struct device *mdffc_d = (d); \
+ − 321 Lisp_Object frmcons; \
+ − 322 DEVICE_FRAME_LOOP (frmcons, mdffc_d) \
+ − 323 XFRAME (XCAR (frmcons))->glyphs_changed = 1; \
+ − 324 MARK_DEVICE_GLYPHS_CHANGED (mdffc_d); \
+ − 325 } while (0)
+ − 326
+ − 327 #define MARK_DEVICE_FRAME_CHANGED(d) \
+ − 328 ((void) (frame_changed = (d)->frame_changed = 1))
+ − 329
905
+ − 330 #define MARK_DEVICE_FRAME_LAYOUT_CHANGED(d) \
+ − 331 ((void) (frame_layout_changed = (d)->frame_layout_changed = 1))
+ − 332
872
+ − 333 #define MARK_DEVICE_WINDOWS_CHANGED(d) \
+ − 334 ((void) (windows_changed = (d)->windows_changed = 1))
+ − 335
+ − 336 #define MARK_DEVICE_WINDOWS_STRUCTURE_CHANGED(d) \
+ − 337 ((void) (windows_structure_changed = (d)->windows_structure_changed = 1))
+ − 338
+ − 339 #endif /* INCLUDED_device_impl_h_ */