|
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 {
|
|
|
74 struct lcrecord_header header;
|
|
|
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
|
|
934
|
80 #ifdef USE_KKCC
|
|
|
81 enum console_variant devtype;
|
|
|
82 #endif /* USE_KKCC */
|
|
|
83
|
|
872
|
84 /* A structure of auxiliary data specific to the device type.
|
|
|
85 struct x_device is used for X window frames; defined in console-x.h
|
|
|
86 struct tty_device is used to TTY's; defined in console-tty.h */
|
|
|
87 void *device_data;
|
|
|
88
|
|
|
89 /* redisplay flags */
|
|
|
90 unsigned int buffers_changed :1;
|
|
|
91 unsigned int clip_changed :1;
|
|
|
92 unsigned int extents_changed :1;
|
|
|
93 unsigned int faces_changed :1;
|
|
|
94 unsigned int frame_changed :1;
|
|
905
|
95 unsigned int frame_layout_changed :1; /* The layout of frame
|
|
|
96 elements has changed. */
|
|
872
|
97 unsigned int glyphs_changed :1;
|
|
|
98 unsigned int subwindows_changed :1;
|
|
|
99 unsigned int subwindows_state_changed :1;
|
|
|
100 unsigned int icon_changed :1;
|
|
|
101 unsigned int menubar_changed :1;
|
|
|
102 unsigned int modeline_changed :1;
|
|
|
103 unsigned int point_changed :1;
|
|
|
104 unsigned int size_changed :1;
|
|
|
105 unsigned int gutter_changed :1;
|
|
|
106 unsigned int toolbar_changed :1;
|
|
|
107 unsigned int windows_changed :1;
|
|
|
108 unsigned int windows_structure_changed :1;
|
|
|
109
|
|
|
110 unsigned int locked :1;
|
|
|
111
|
|
|
112 /* Cache information about last pixel position translated to a
|
|
|
113 glyph. The law of locality applies very heavily here so caching
|
|
|
114 the value leads to a significant win. At the moment this is
|
|
|
115 really X specific but once we have generic mouse support it won't
|
|
|
116 be. */
|
|
|
117 struct pixel_to_glyph_translation_cache pixel_to_glyph_cache;
|
|
|
118
|
|
|
119 /* Output baud rate of device; used for redisplay decisions. */
|
|
|
120 int baud_rate;
|
|
|
121
|
|
|
122 /* sound flags */
|
|
|
123 unsigned int on_console_p :1;
|
|
|
124 unsigned int connected_to_nas_p :1;
|
|
|
125
|
|
|
126 #define MARKED_SLOT(x) Lisp_Object x
|
|
|
127 #include "devslots.h"
|
|
|
128
|
|
|
129 /* File descriptors for input and output. Much of the time
|
|
|
130 (but not always) these will be the same. For an X device,
|
|
|
131 these both hold the file descriptor of the socket used
|
|
|
132 to communicate with the X server. For a TTY device, these
|
|
|
133 may or may not be the same and point to the terminal that
|
|
|
134 is used for I/O. */
|
|
|
135 int infd, outfd;
|
|
|
136
|
|
|
137 /* infd and outfd are moved outside HAVE_UNIXOID_EVENT_LOOP conditionals,
|
|
|
138 because Win32, presumably the first port which does not use select()
|
|
|
139 polling, DOES have handles for a console device. -- kkm */
|
|
|
140
|
|
|
141 #ifdef HAVE_UNIXOID_EVENT_LOOP
|
|
|
142 /* holds some data necessary for SIGIO control. Perhaps this should
|
|
|
143 be inside of device_data; but it is used for both TTY's and X
|
|
|
144 device. Perhaps it should be conditionalized on SIGIO; but
|
|
|
145 this requires including syssignal.h. */
|
|
|
146 int old_fcntl_owner;
|
|
|
147 #endif
|
|
|
148 };
|
|
|
149
|
|
|
150 /* Redefine basic properties more efficiently */
|
|
|
151
|
|
|
152 #undef DEVICE_LIVE_P
|
|
|
153 #define DEVICE_LIVE_P(d) (!EQ (DEVICE_TYPE (d), Qdead))
|
|
|
154 #undef DEVICE_CONSOLE
|
|
|
155 #define DEVICE_CONSOLE(d) ((d)->console)
|
|
|
156 #undef DEVICE_FRAME_LIST
|
|
|
157 #define DEVICE_FRAME_LIST(d) ((d)->frame_list)
|
|
|
158
|
|
|
159 #define DEVICE_TYPE_P(d, type) EQ (DEVICE_TYPE (d), Q##type)
|
|
|
160
|
|
|
161 #ifdef ERROR_CHECK_TYPES
|
|
|
162 DECLARE_INLINE_HEADER (
|
|
|
163 struct device *
|
|
|
164 error_check_device_type (struct device *d, Lisp_Object sym)
|
|
|
165 )
|
|
|
166 {
|
|
|
167 assert (EQ (DEVICE_TYPE (d), sym));
|
|
|
168 return d;
|
|
|
169 }
|
|
|
170 # define DEVICE_TYPE_DATA(d, type) \
|
|
|
171 ((struct type##_device *) error_check_device_type (d, Q##type)->device_data)
|
|
|
172 #else
|
|
|
173 # define DEVICE_TYPE_DATA(d, type) \
|
|
|
174 ((struct type##_device *) (d)->device_data)
|
|
|
175 #endif
|
|
|
176
|
|
|
177 #define CHECK_DEVICE_TYPE(x, type) \
|
|
|
178 do { \
|
|
|
179 CHECK_DEVICE (x); \
|
|
|
180 if (!(DEVICEP (x) && DEVICE_TYPE_P (XDEVICE (x), \
|
|
|
181 type))) \
|
|
|
182 dead_wrong_type_argument \
|
|
|
183 (type##_console_methods->predicate_symbol, x); \
|
|
|
184 } while (0)
|
|
|
185 #define CONCHECK_DEVICE_TYPE(x, type) \
|
|
|
186 do { \
|
|
|
187 CONCHECK_DEVICE (x); \
|
|
|
188 if (!(DEVICEP (x) && DEVICE_TYPE_P (XDEVICE (x), \
|
|
|
189 type))) \
|
|
|
190 x = wrong_type_argument \
|
|
|
191 (type##_console_methods->predicate_symbol, x); \
|
|
|
192 } while (0)
|
|
|
193
|
|
|
194 #define DEVICE_DISPLAY_P(dev) \
|
|
|
195 (DEVICE_LIVE_P (dev) && \
|
|
|
196 !DEVICE_IMPL_FLAG (dev, XDEVIMPF_IS_A_PRINTER))
|
|
|
197
|
|
|
198 #define CHECK_DISPLAY_DEVICE(dev) \
|
|
|
199 do { \
|
|
|
200 CHECK_DEVICE (dev); \
|
|
|
201 if (!(DEVICEP (dev) \
|
|
|
202 && DEVICE_DISPLAY_P (XDEVICE (dev)))) \
|
|
|
203 dead_wrong_type_argument (Qdisplay, dev); \
|
|
|
204 } while (0)
|
|
|
205
|
|
|
206 #define CONCHECK_DISPLAY_DEVICE(dev) \
|
|
|
207 do { \
|
|
|
208 CONCHECK_DEVICE (dev); \
|
|
|
209 if (!(DEVICEP (dev) \
|
|
|
210 && DEVICE_DISPLAY_P (XDEVICE (dev)))) \
|
|
|
211 wrong_type_argument (Qdisplay, dev); \
|
|
|
212 } while (0)
|
|
|
213
|
|
|
214 #define DEVICE_PRINTER_P(dev) \
|
|
|
215 (DEVICE_LIVE_P (dev) && !DEVICE_DISPLAY_P (dev))
|
|
|
216
|
|
|
217 #define CHECK_PRINTER_DEVICE(dev) \
|
|
|
218 do { \
|
|
|
219 CHECK_DEVICE (dev); \
|
|
|
220 if (!(DEVICEP (dev) \
|
|
|
221 && DEVICE_PRINTER_P (XDEVICE (dev)))) \
|
|
|
222 dead_wrong_type_argument (Qprinter, dev); \
|
|
|
223 } while (0)
|
|
|
224
|
|
|
225 #define CONCHECK_PRINTER_DEVICE(dev) \
|
|
|
226 do { \
|
|
|
227 CONCHECK_DEVICE (dev); \
|
|
|
228 if (!(DEVICEP (dev) \
|
|
|
229 && DEVICE_PRINTER_P (XDEVICE (dev)))) \
|
|
|
230 wrong_type_argument (Qprinter, dev); \
|
|
|
231 } while (0)
|
|
|
232
|
|
|
233 /* #### These should be in the device-*.h files but there are
|
|
|
234 too many places where the abstraction is broken. Need to
|
|
|
235 fix. */
|
|
|
236
|
|
|
237 #define DEVICE_X_P(dev) CONSOLE_TYPESYM_X_P (DEVICE_TYPE (dev))
|
|
|
238 #define CHECK_X_DEVICE(z) CHECK_DEVICE_TYPE (z, x)
|
|
|
239 #define CONCHECK_X_DEVICE(z) CONCHECK_DEVICE_TYPE (z, x)
|
|
|
240
|
|
|
241 #define DEVICE_GTK_P(dev) CONSOLE_TYPESYM_GTK_P (DEVICE_TYPE (dev))
|
|
|
242 #define CHECK_GTK_DEVICE(z) CHECK_DEVICE_TYPE (z, gtk)
|
|
|
243 #define CONCHECK_GTK_DEVICE(z) CONCHECK_DEVICE_TYPE (z, gtk)
|
|
|
244
|
|
|
245 #define DEVICE_MSWINDOWS_P(dev) CONSOLE_TYPESYM_MSWINDOWS_P (DEVICE_TYPE (dev))
|
|
|
246 #define CHECK_MSWINDOWS_DEVICE(z) CHECK_DEVICE_TYPE (z, mswindows)
|
|
|
247 #define CONCHECK_MSWINDOWS_DEVICE(z) CONCHECK_DEVICE_TYPE (z, mswindows)
|
|
|
248
|
|
|
249 #define DEVICE_TTY_P(dev) CONSOLE_TYPESYM_TTY_P (DEVICE_TYPE (dev))
|
|
|
250 #define CHECK_TTY_DEVICE(z) CHECK_DEVICE_TYPE (z, tty)
|
|
|
251 #define CONCHECK_TTY_DEVICE(z) CONCHECK_DEVICE_TYPE (z, tty)
|
|
|
252
|
|
|
253 #define DEVICE_STREAM_P(dev) CONSOLE_TYPESYM_STREAM_P (DEVICE_TYPE (dev))
|
|
|
254 #define CHECK_STREAM_DEVICE(z) CHECK_DEVICE_TYPE (z, stream)
|
|
|
255 #define CONCHECK_STREAM_DEVICE(z) CONCHECK_DEVICE_TYPE (z, stream)
|
|
|
256
|
|
|
257 #define DEVICE_WIN_P(dev) CONSOLE_TYPESYM_WIN_P (DEVICE_TYPE (dev))
|
|
|
258
|
|
|
259 #define DEVICE_REDISPLAY_INFO(d) ((d)->redisplay_info)
|
|
|
260
|
|
|
261 #define DEVICE_NAME(d) ((d)->name)
|
|
|
262 #define DEVICE_CLASS(d) ((d)->device_class)
|
|
|
263 /* Catch people attempting to set this. */
|
|
|
264 #define DEVICE_SELECTED_FRAME(d) NON_LVALUE ((d)->selected_frame)
|
|
|
265 #define DEVICE_FRAME_WITH_FOCUS_REAL(d) ((d)->frame_with_focus_real)
|
|
|
266 #define DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS(d) ((d)->frame_with_focus_for_hooks)
|
|
|
267 #define DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS(d) \
|
|
|
268 ((d)->frame_that_ought_to_have_focus)
|
|
|
269 #define DEVICE_USER_DEFINED_TAGS(d) ((d)->user_defined_tags)
|
|
|
270 #define DEVICE_CONNECTION(d) ((d)->connection)
|
|
|
271 #define DEVICE_CANON_CONNECTION(d) ((d)->canon_connection)
|
|
|
272 #define DEVICE_BAUD_RATE(d) ((d)->baud_rate)
|
|
|
273 #define DEVICE_INFD(d) ((d)->infd)
|
|
|
274 #define DEVICE_OUTFD(d) ((d)->outfd)
|
|
|
275 #define DEVICE_OLD_FCNTL_OWNER(d) ((d)->old_fcntl_owner)
|
|
|
276 #define DEVICE_ON_CONSOLE_P(d) ((d)->on_console_p)
|
|
|
277 #define DEVICE_CONNECTED_TO_NAS_P(d) ((d)->connected_to_nas_p)
|
|
|
278
|
|
|
279 #define LOCK_DEVICE(d) ((void) ((d)->locked = 1))
|
|
|
280 #define UNLOCK_DEVICE(d) ((void) ((d)->locked = 0))
|
|
|
281
|
|
|
282 #define INVALIDATE_DEVICE_PIXEL_TO_GLYPH_CACHE(d) \
|
|
|
283 ((void) ((d)->pixel_to_glyph_cache.valid = 0))
|
|
|
284
|
|
|
285 #define INVALIDATE_PIXEL_TO_GLYPH_CACHE do { \
|
|
|
286 Lisp_Object IPTGC_devcons, IPTGC_concons; \
|
|
|
287 DEVICE_LOOP_NO_BREAK (IPTGC_devcons, IPTGC_concons) \
|
|
|
288 INVALIDATE_DEVICE_PIXEL_TO_GLYPH_CACHE (XDEVICE (XCAR (IPTGC_devcons))); \
|
|
|
289 } while (0)
|
|
|
290
|
|
|
291 #define MARK_DEVICE_FACES_CHANGED(d) \
|
|
|
292 ((void) (faces_changed = (d)->faces_changed = 1))
|
|
|
293
|
|
|
294 #define MARK_DEVICE_GLYPHS_CHANGED(d) \
|
|
|
295 ((void) (glyphs_changed = (d)->glyphs_changed = 1))
|
|
|
296
|
|
|
297 #define MARK_DEVICE_SUBWINDOWS_CHANGED(d) \
|
|
|
298 ((void) (subwindows_changed = (d)->subwindows_changed = 1))
|
|
|
299
|
|
|
300 #define MARK_DEVICE_SUBWINDOWS_STATE_CHANGED(d) \
|
|
|
301 ((void) (subwindows_state_changed = (d)->subwindows_state_changed = 1))
|
|
|
302
|
|
|
303 #define MARK_DEVICE_TOOLBARS_CHANGED(d) \
|
|
|
304 ((void) (toolbar_changed = (d)->toolbar_changed = 1))
|
|
|
305
|
|
|
306 #define MARK_DEVICE_GUTTERS_CHANGED(d) \
|
|
|
307 ((void) (gutter_changed = (d)->gutter_changed = 1))
|
|
|
308
|
|
|
309 #define MARK_DEVICE_SIZE_CHANGED(d) \
|
|
|
310 ((void) (size_changed = (d)->size_changed = 1))
|
|
|
311
|
|
|
312 #define MARK_DEVICE_FRAMES_FACES_CHANGED(d) do { \
|
|
|
313 struct device *mdffc_d = (d); \
|
|
|
314 Lisp_Object frmcons; \
|
|
|
315 DEVICE_FRAME_LOOP (frmcons, mdffc_d) \
|
|
|
316 XFRAME (XCAR (frmcons))->faces_changed = 1; \
|
|
|
317 MARK_DEVICE_FACES_CHANGED (mdffc_d); \
|
|
|
318 } while (0)
|
|
|
319
|
|
|
320 #define MARK_DEVICE_FRAMES_GLYPHS_CHANGED(d) do { \
|
|
|
321 struct device *mdffc_d = (d); \
|
|
|
322 Lisp_Object frmcons; \
|
|
|
323 DEVICE_FRAME_LOOP (frmcons, mdffc_d) \
|
|
|
324 XFRAME (XCAR (frmcons))->glyphs_changed = 1; \
|
|
|
325 MARK_DEVICE_GLYPHS_CHANGED (mdffc_d); \
|
|
|
326 } while (0)
|
|
|
327
|
|
|
328 #define MARK_DEVICE_FRAME_CHANGED(d) \
|
|
|
329 ((void) (frame_changed = (d)->frame_changed = 1))
|
|
|
330
|
|
905
|
331 #define MARK_DEVICE_FRAME_LAYOUT_CHANGED(d) \
|
|
|
332 ((void) (frame_layout_changed = (d)->frame_layout_changed = 1))
|
|
|
333
|
|
872
|
334 #define MARK_DEVICE_WINDOWS_CHANGED(d) \
|
|
|
335 ((void) (windows_changed = (d)->windows_changed = 1))
|
|
|
336
|
|
|
337 #define MARK_DEVICE_WINDOWS_STRUCTURE_CHANGED(d) \
|
|
|
338 ((void) (windows_structure_changed = (d)->windows_structure_changed = 1))
|
|
|
339
|
|
|
340 #endif /* INCLUDED_device_impl_h_ */
|
