Reformatted.
[chise/xemacs-chise.git] / lisp / device.el
1 ;;; device.el --- miscellaneous device functions not written in C
2
3 ;; Copyright (C) 1994-5, 1997 Free Software Foundation, Inc.
4 ;; Copyright (C) 1995, 1996 Ben Wing
5
6 ;; Maintainer: XEmacs Development Team
7 ;; Keywords: internal, dumped
8
9 ;; This file is part of XEmacs.
10
11 ;; XEmacs is free software; you can redistribute it and/or modify it
12 ;; under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; XEmacs is distributed in the hope that it will be useful, but
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19 ;; General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with XEmacs; see the file COPYING.  If not, write to the 
23 ;; Free Software Foundation, 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Synched up with: Not in FSF.
27
28 ;;; Commentary:
29
30 ;; This file is dumped with XEmacs.
31
32 ;;; Code:
33
34 ;;; Initialization
35
36 ; Specifier tag 'printer which matches printers
37 (define-specifier-tag 'printer (function device-printer-p))
38
39 ; Specifier tag 'display which matches displays
40 (define-specifier-tag 'display (function
41                                 (lambda (device)
42                                   (not (device-printer-p device)))))
43
44 ;;; Functions
45
46 (defun device-list ()
47   "Return a list of all devices."
48   (apply 'nconc (mapcar 'console-device-list (console-list))))
49
50 (defun device-type (&optional device)
51   "Return the type of the specified device (e.g. `x' or `tty').
52 This is equivalent to the type of the device's console.
53 Value is `tty' for a tty device (a character-only terminal),
54 `x' for a device that is a screen on an X display,
55 `gtk' for a device that is a GTK connection.
56 `ns' for a device that is a NeXTstep connection (not yet implemented),
57 `mswindows' for a device that is a MS Windows workstation,
58 `msprinter' for a device that is a MS Windows printer connection,
59 `stream' for a stream device (which acts like a stdio stream), and
60 `dead' for a deleted device."
61   (or device (setq device (selected-device)))
62   (if (not (device-live-p device)) 'dead
63     (console-type (device-console device))))
64
65 (defun make-tty-device (&optional tty terminal-type controlling-process)
66   "Create a new device on TTY.
67   TTY should be the name of a tty device file (e.g. \"/dev/ttyp3\" under
68 SunOS et al.), as returned by the `tty' command.  A value of nil means
69 use the stdin and stdout as passed to XEmacs from the shell.
70   If TERMINAL-TYPE is non-nil, it should be a string specifying the
71 type of the terminal attached to the specified tty.  If it is nil,
72 the terminal type will be inferred from the TERM environment variable.
73   If CONTROLLING-PROCESS is non-nil, it should be an integer
74 specifying the process id of the process in control of the specified tty.  If
75 it is nil, it is assumes to be the value returned by emacs-pid."
76   (make-device 'tty tty (list 'terminal-type terminal-type 
77                               'controlling-process controlling-process)))
78
79 (defun device-pixel-width (&optional device)
80   "Return the width in pixels of DEVICE, or nil if unknown."
81   (let ((ds (device-system-metric device 'size-device)))
82     (and ds (car ds))))
83
84 (defun device-pixel-height (&optional device)
85   "Return the height in pixels of DEVICE, or nil if unknown."
86   (let ((ds (device-system-metric device 'size-device)))
87     (and ds (cdr ds))))
88
89 (defun device-mm-width (&optional device)
90   "Return the width in millimeters of DEVICE, or nil if unknown."
91   (let ((ds (device-system-metric device 'size-device-mm)))
92     (and ds (car ds))))
93
94 (defun device-mm-height (&optional device)
95   "Return the height in millimeters of DEVICE, or nil if unknown."
96   (let ((ds (device-system-metric device 'size-device-mm)))
97     (and ds (cdr ds))))
98
99 (defun device-bitplanes (&optional device)
100   "Return the number of bitplanes of DEVICE, or nil if unknown."
101   (device-system-metric device 'num-bit-planes))
102
103 (defun device-color-cells (&optional device)
104   "Return the number of color cells of DEVICE, or nil if unknown."
105   (device-system-metric device 'num-color-cells))
106
107 (defun make-gtk-device ()
108   "Create a new GTK device."
109   (make-device 'gtk nil))
110
111 (defun make-x-device (&optional display)
112   "Create a new device connected to DISPLAY."
113   (make-device 'x display))
114
115 (defun make-mswindows-device ()
116   "Create a new mswindows device."
117   (make-device 'mswindows nil))
118
119 (defun device-on-window-system-p (&optional device)
120   "Return non-nil if DEVICE is on a window system.
121 This generally means that there is support for the mouse, the menubar,
122 the toolbar, glyphs, etc."
123   (or device (setq device (selected-device)))
124   (console-on-window-system-p (device-console device)))
125
126 (defun call-device-method (name device &rest args)
127   "Call a DEVICE-specific function with the generic name NAME.
128 If DEVICE is not provided then the selected device is used."
129   (or device (setq device (selected-device)))
130   (or (symbolp name) (error "function name must be a symbol"))
131   (let ((devmeth (intern (concat (symbol-name 
132                                   (device-type device)) "-" (symbol-name name)))))
133     (if (functionp devmeth)
134         (if args
135             (apply devmeth args)
136           (funcall devmeth))
137       nil)))
138
139 (defmacro define-device-method (name &optional docstring)
140   "Define NAME to be a device method."
141   `(defun ,name (&rest arglist) ,docstring
142      (apply 'call-device-method (quote ,name) nil arglist)))
143
144 (defmacro define-device-method* (name &optional docstring)
145   "Define NAME to be a device method."
146   `(defun* ,name (&rest arglist) ,docstring
147      (apply 'call-device-method (quote ,name) nil arglist)))
148
149 (defalias 'valid-device-type-p 'valid-console-type-p)
150 (defalias 'device-type-list 'console-type-list)
151 (defalias 'device-pixel-depth 'device-bitplanes)
152
153 ;;; device.el ends here