annotate src/device.h @ 4594:2986723ac32d

Update comment.
author Stephen J. Turnbull <stephen@xemacs.org>
date Mon, 02 Feb 2009 23:31:09 +0900
parents e22b0213b713
children e0db3c197671
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 /* Define device-object for XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
872
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
3 Copyright (C) 1995, 2002 Ben Wing
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4 Copyright (C) 1995 Sun Microsystems
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6 This file is part of XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 XEmacs is free software; you can redistribute it and/or modify it
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 Free Software Foundation; either version 2, or (at your option) any
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 later version.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16 for more details.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 along with XEmacs; see the file COPYING. If not, write to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21 Boston, MA 02111-1307, USA. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23 /* Synched up with: Not in FSF. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 /* Written by Chuck Thompson and Ben Wing. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
27 #ifndef INCLUDED_device_h_
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
28 #define INCLUDED_device_h_
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 #include "console.h"
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31
872
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
32 struct device;
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 DECLARE_LRECORD (device, struct device);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 #define XDEVICE(x) XRECORD (x, device, struct device)
617
af57a77cbc92 [xemacs-hg @ 2001-06-18 07:09:50 by ben]
ben
parents: 545
diff changeset
36 #define wrap_device(p) wrap_record (p, device)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 #define DEVICEP(x) RECORDP (x, device)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 #define CHECK_DEVICE(x) CHECK_RECORD (x, device)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 #define CONCHECK_DEVICE(x) CONCHECK_RECORD (x, device)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40
872
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
41 /* Basic properties available to non-privileged users; redefined in
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
42 device-impl.h */
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
43
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
44 int device_live_p (struct device *d);
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
45 Lisp_Object device_console (struct device *d);
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
46 Lisp_Object device_frame_list (struct device *d);
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
47
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
48 #define DEVICE_LIVE_P(d) device_live_p (d)
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
49 #define DEVICE_CONSOLE(d) device_console (d)
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
50 #define DEVICE_FRAME_LIST(d) device_frame_list (d)
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
51
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
52 #define DEVICE_XCONSOLE(d) XCONSOLE (DEVICE_CONSOLE (d))
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
53
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
54 #define XDEVICE_CONSOLE(d) DEVICE_CONSOLE (XDEVICE (d))
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
55 #define XDEVICE_XCONSOLE(d) XCONSOLE (XDEVICE_XCONSOLE (d))
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
56
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57 #define CHECK_LIVE_DEVICE(x) do { \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 CHECK_DEVICE (x); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59 if (! DEVICE_LIVE_P (XDEVICE (x))) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 dead_wrong_type_argument (Qdevice_live_p, (x)); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62 #define CONCHECK_LIVE_DEVICE(x) do { \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 CONCHECK_DEVICE (x); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 if (! DEVICE_LIVE_P (XDEVICE (x))) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65 x = wrong_type_argument (Qdevice_live_p, (x)); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
68 /* #### unify this with DOMAIN_DEVICE once the latter has image instances
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
69 expunged from it. */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 /* This turns out to be used heavily so we make it a macro to make it
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 inline. Also, the majority of the time the object will turn out to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72 be a window so we move it from being checked last to being checked
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73 first. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74 #define DFW_DEVICE(obj) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
75 (WINDOWP (obj) ? WINDOW_DEVICE (XWINDOW (obj)) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76 : (FRAMEP (obj) ? FRAME_DEVICE (XFRAME (obj)) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77 : (DEVICEP (obj) ? obj \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78 : Qnil)))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
79
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 /* NO_BREAK means that "break" doesn't do what you think it does!
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81 Use goto instead. "continue" is OK, though. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82 #define DEVICE_LOOP_NO_BREAK(devcons, concons) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 CONSOLE_LOOP (concons) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84 CONSOLE_DEVICE_LOOP (devcons, XCONSOLE (XCAR (concons)))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85 #define DEVICE_FRAME_LOOP(frmcons, d) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86 LIST_LOOP (frmcons, DEVICE_FRAME_LIST (d))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87 #define CONSOLE_FRAME_LOOP_NO_BREAK(frmcons, devcons, con) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 CONSOLE_DEVICE_LOOP (devcons, con) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89 DEVICE_FRAME_LOOP (frmcons, XDEVICE (XCAR (devcons)))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90
872
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
91 EXFUN (Fdevice_console, 1);
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
92 EXFUN (Fdevice_name, 1);
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
93 EXFUN (Ffind_device, 2);
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
94 EXFUN (Fmake_device, 3);
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
95 EXFUN (Fselected_device, 1);
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
96
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
97 extern Lisp_Object Qcreate_device_hook, Qdelete_device_hook, Qgrayscale;
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
98 extern Lisp_Object Qinit_post_tty_win, Qmono;
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
99 extern Lisp_Object Vdevice_class_list;
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
100
1204
e22b0213b713 [xemacs-hg @ 2003-01-12 11:07:58 by michaels]
michaels
parents: 872
diff changeset
101 int valid_device_class_p (Lisp_Object class_);
872
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
102
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
103 void select_device_1 (Lisp_Object);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
104 struct device *decode_device (Lisp_Object);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
105 void handle_asynch_device_change (void);
872
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
106 Lisp_Object call_critical_lisp_code (struct device *d, Lisp_Object function,
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
107 Lisp_Object object);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
108 void delete_device_internal (struct device *d, int force,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109 int called_from_delete_console,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110 int from_io_error);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111 void io_error_delete_device (Lisp_Object device);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
112 Lisp_Object find_nonminibuffer_frame_not_on_device (Lisp_Object device);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
113 void set_device_selected_frame (struct device *d, Lisp_Object frame);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 Lisp_Object domain_device_type (Lisp_Object domain);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
115 int window_system_pixelated_geometry (Lisp_Object domain);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116
872
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
117 Lisp_Object get_default_device (Lisp_Object type);
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
118 void set_default_device (Lisp_Object type, Lisp_Object device);
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
119 void clear_default_devices (void);
79c6ff3eef26 [xemacs-hg @ 2002-06-20 21:18:01 by ben]
ben
parents: 859
diff changeset
120
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
121 #endif /* INCLUDED_device_h_ */