*** empty log message ***
[emacs.git] / lisp / lpr.el
blob4df98d6d7515da5f5cf2cb0c3e351f29be641262
1 ;;; lpr.el --- print Emacs buffer on line printer
3 ;; Copyright (C) 1985, 1988, 1992, 1994, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: unix
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; Commands to send the region or a buffer to your printer. Entry points
29 ;; are `lpr-buffer', `print-buffer', `lpr-region', or `print-region'; option
30 ;; variables include `printer-name', `lpr-switches' and `lpr-command'.
32 ;;; Code:
34 ;;;###autoload
35 (defvar lpr-windows-system
36 (memq system-type '(emx win32 w32 mswindows ms-dos windows-nt)))
38 ;;;###autoload
39 (defvar lpr-lp-system
40 (memq system-type '(usg-unix-v dgux hpux irix)))
43 (defgroup lpr nil
44 "Print Emacs buffer on line printer."
45 :group 'wp)
48 ;;;###autoload
49 (defcustom printer-name
50 (and lpr-windows-system "PRN")
51 "*The name of a local printer to which data is sent for printing.
52 \(Note that PostScript files are sent to `ps-printer-name', which see.\)
54 On Unix-like systems, a string value should be a name understood by
55 lpr's -P option; otherwise the value should be nil.
57 On MS-DOS and MS-Windows systems, a string value is taken as the name of
58 a printer device or port, provided `lpr-command' is set to \"\".
59 Typical non-default settings would be \"LPT1\" to \"LPT3\" for parallel
60 printers, or \"COM1\" to \"COM4\" or \"AUX\" for serial printers, or
61 \"//hostname/printer\" for a shared network printer. You can also set
62 it to the name of a file, in which case the output gets appended to that
63 file. If you want to discard the printed output, set this to \"NUL\"."
64 :type '(choice :menu-tag "Printer Name"
65 :tag "Printer Name"
66 (const :tag "Default" nil)
67 ;; could use string but then we lose completion for files.
68 (file :tag "Name"))
69 :group 'lpr)
71 ;;;###autoload
72 (defcustom lpr-switches nil
73 "*List of strings to pass as extra options for the printer program.
74 It is recommended to set `printer-name' instead of including an explicit
75 switch on this list.
76 See `lpr-command'."
77 :type '(repeat (string :tag "Argument"))
78 :group 'lpr)
80 (defcustom lpr-add-switches (memq system-type '(berkeley-unix gnu/linux))
81 "*Non-nil means construct `-T' and `-J' options for the printer program.
82 These are made assuming that the program is `lpr';
83 if you are using some other incompatible printer program,
84 this variable should be nil."
85 :type 'boolean
86 :group 'lpr)
88 (defcustom lpr-printer-switch
89 (if lpr-lp-system
90 "-d "
91 "-P")
92 "*Printer switch, that is, something like \"-P\", \"-d \", \"/D:\", etc.
93 This switch is used in conjunction with `printer-name'."
94 :type '(choice :menu-tag "Printer Name Switch"
95 :tag "Printer Name Switch"
96 (const :tag "None" nil)
97 (string :tag "Printer Switch"))
98 :group 'lpr)
100 ;;;###autoload
101 (defcustom lpr-command
102 (cond
103 (lpr-windows-system
105 (lpr-lp-system
106 "lp")
108 "lpr"))
109 "*Name of program for printing a file.
111 On MS-DOS and MS-Windows systems, if the value is an empty string then
112 Emacs will write directly to the printer port named by `printer-name'.
113 The programs `print' and `nprint' (the standard print programs on
114 Windows NT and Novell Netware respectively) are handled specially, using
115 `printer-name' as the destination for output; any other program is
116 treated like `lpr' except that an explicit filename is given as the last
117 argument."
118 :type 'string
119 :group 'lpr)
121 ;; Default is nil, because that enables us to use pr -f
122 ;; which is more reliable than pr with no args, which is what lpr -p does.
123 (defcustom lpr-headers-switches nil
124 "*List of strings of options to request page headings in the printer program.
125 If nil, we run `lpr-page-header-program' to make page headings
126 and print the result."
127 :type '(repeat (string :tag "Argument"))
128 :group 'lpr)
130 (defcustom print-region-function nil
131 "Function to call to print the region on a printer.
132 See definition of `print-region-1' for calling conventions."
133 :type '(choice (const nil) function)
134 :group 'lpr)
136 (defcustom lpr-page-header-program "pr"
137 "*Name of program for adding page headers to a file."
138 :type 'string
139 :group 'lpr)
141 ;; Berkeley systems support -F, and GNU pr supports both -f and -F,
142 ;; So it looks like -F is a better default.
143 (defcustom lpr-page-header-switches '("-h" "%s" "-F")
144 "*List of strings to use as options for the page-header-generating program.
145 If `%s' appears in any of the strings, it is substituted by the page title.
146 Note that for correct quoting, `%s' should normally be a separate element.
147 The variable `lpr-page-header-program' specifies the program to use."
148 :type '(repeat string)
149 :group 'lpr)
151 ;;;###autoload
152 (defun lpr-buffer ()
153 "Print buffer contents without pagination or page headers.
154 See the variables `lpr-switches' and `lpr-command'
155 for customization of the printer command."
156 (interactive)
157 (print-region-1 (point-min) (point-max) lpr-switches nil))
159 ;;;###autoload
160 (defun print-buffer ()
161 "Paginate and print buffer contents.
163 The variable `lpr-headers-switches' controls how to paginate.
164 If it is nil (the default), we run the `pr' program (or whatever program
165 `lpr-page-header-program' specifies) to paginate.
166 `lpr-page-header-switches' specifies the switches for that program.
168 Otherwise, the switches in `lpr-headers-switches' are used
169 in the print command itself; we expect them to request pagination.
171 See the variables `lpr-switches' and `lpr-command'
172 for further customization of the printer command."
173 (interactive)
174 (print-region-1 (point-min) (point-max) lpr-switches t))
176 ;;;###autoload
177 (defun lpr-region (start end)
178 "Print region contents without pagination or page headers.
179 See the variables `lpr-switches' and `lpr-command'
180 for customization of the printer command."
181 (interactive "r")
182 (print-region-1 start end lpr-switches nil))
184 ;;;###autoload
185 (defun print-region (start end)
186 "Paginate and print the region contents.
188 The variable `lpr-headers-switches' controls how to paginate.
189 If it is nil (the default), we run the `pr' program (or whatever program
190 `lpr-page-header-program' specifies) to paginate.
191 `lpr-page-header-switches' specifies the switches for that program.
193 Otherwise, the switches in `lpr-headers-switches' are used
194 in the print command itself; we expect them to request pagination.
196 See the variables `lpr-switches' and `lpr-command'
197 for further customization of the printer command."
198 (interactive "r")
199 (print-region-1 start end lpr-switches t))
201 (defun print-region-1 (start end switches page-headers)
202 ;; On some MIPS system, having a space in the job name
203 ;; crashes the printer demon. But using dashes looks ugly
204 ;; and it seems to annoying to do for that MIPS system.
205 (let ((name (concat (buffer-name) " Emacs buffer"))
206 (title (concat (buffer-name) " Emacs buffer"))
207 ;; Make pipes use the same coding system as
208 ;; writing the buffer to a file would.
209 (coding-system-for-write (or coding-system-for-write
210 buffer-file-coding-system))
211 (coding-system-for-read (or coding-system-for-read
212 buffer-file-coding-system))
213 (width tab-width)
214 nswitches
215 switch-string)
216 (save-excursion
217 (and page-headers lpr-headers-switches
218 ;; It's possible to use an lpr option to get page headers.
219 (setq switches (append (if (stringp lpr-headers-switches)
220 (list lpr-headers-switches)
221 lpr-headers-switches)
222 switches)))
223 (setq nswitches (lpr-flatten-list
224 (mapcar 'lpr-eval-switch ; Dynamic evaluation
225 switches))
226 switch-string (if switches
227 (concat " with options "
228 (mapconcat 'identity switches " "))
229 ""))
230 (message "Spooling%s..." switch-string)
231 (if (/= tab-width 8)
232 (let ((new-coords (print-region-new-buffer start end)))
233 (setq start (car new-coords)
234 end (cdr new-coords)
235 tab-width width)
236 (save-excursion
237 (goto-char end)
238 (setq end (point-marker)))
239 (untabify (point-min) (point-max))))
240 (if page-headers
241 (if lpr-headers-switches
242 ;; We handled this above by modifying SWITCHES.
244 ;; Run a separate program to get page headers.
245 (let ((new-coords (print-region-new-buffer start end)))
246 (apply 'call-process-region (car new-coords) (cdr new-coords)
247 lpr-page-header-program t t nil
248 (mapcar (lambda (e) (format e title))
249 lpr-page-header-switches)))
250 (setq start (point-min)
251 end (point-max))))
252 (apply (or print-region-function 'call-process-region)
253 (nconc (list start end lpr-command
254 nil nil nil)
255 (and lpr-add-switches
256 (list "-J" name))
257 ;; These belong in pr if we are using that.
258 (and lpr-add-switches lpr-headers-switches
259 (list "-T" title))
260 (and (stringp printer-name)
261 (list (concat lpr-printer-switch
262 printer-name)))
263 nswitches))
264 (if (markerp end)
265 (set-marker end nil))
266 (message "Spooling%s...done" switch-string))))
268 ;; This function copies the text between start and end
269 ;; into a new buffer, makes that buffer current.
270 ;; It returns the new range to print from the new current buffer
271 ;; as (START . END).
273 (defun print-region-new-buffer (ostart oend)
274 (if (string= (buffer-name) " *spool temp*")
275 (cons ostart oend)
276 (let ((oldbuf (current-buffer)))
277 (set-buffer (get-buffer-create " *spool temp*"))
278 (widen)
279 (erase-buffer)
280 (insert-buffer-substring oldbuf ostart oend)
281 (cons (point-min) (point-max)))))
283 (defun printify-region (begin end)
284 "Replace nonprinting characters in region with printable representations.
285 The printable representations use ^ (for ASCII control characters) or hex.
286 The characters tab, linefeed, space, return and formfeed are not affected."
287 (interactive "r")
288 (save-excursion
289 (save-restriction
290 (narrow-to-region begin end)
291 (goto-char (point-min))
292 (let (c)
293 (while (re-search-forward "[\^@-\^h\^k\^n-\^_\177-\377]" nil t)
294 (setq c (preceding-char))
295 (delete-backward-char 1)
296 (insert (if (< c ?\s)
297 (format "\\^%c" (+ c ?@))
298 (format "\\%02x" c))))))))
300 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
301 ;; Functions hacked from `ps-print' package.
303 ;; Dynamic evaluation
304 (defun lpr-eval-switch (arg)
305 (cond ((stringp arg) arg)
306 ((functionp arg) (apply arg nil))
307 ((symbolp arg) (symbol-value arg))
308 ((consp arg) (apply (car arg) (cdr arg)))
309 (t nil)))
311 ;; `lpr-flatten-list' is defined here (copied from "message.el" and
312 ;; enhanced to handle dotted pairs as well) until we can get some
313 ;; sensible autoloads, or `flatten-list' gets put somewhere decent.
315 ;; (lpr-flatten-list '((a . b) c (d . e) (f g h) i . j))
316 ;; => (a b c d e f g h i j)
318 (defun lpr-flatten-list (&rest list)
319 (lpr-flatten-list-1 list))
321 (defun lpr-flatten-list-1 (list)
322 (cond
323 ((null list) (list))
324 ((consp list)
325 (append (lpr-flatten-list-1 (car list))
326 (lpr-flatten-list-1 (cdr list))))
327 (t (list list))))
329 (provide 'lpr)
331 ;;; arch-tag: 21c3f821-ebec-4ca9-ac67-a81e4b75c62a
332 ;;; lpr.el ends here