(temp-buffer-show-hook): Doc fix.
[emacs.git] / lisp / ps-print.el
blob73fa3bb2a257b53ff257280fc2d7866b06221d3c
1 ;;; ps-print.el --- print text from the buffer as PostScript
3 ;; Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 ;; 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Jim Thompson (was <thompson@wg2.waii.com>)
7 ;; Jacques Duthen (was <duthen@cegelec-red.fr>)
8 ;; Vinicius Jose Latorre <viniciusjl@ig.com.br>
9 ;; Kenichi Handa <handa@m17n.org> (multi-byte characters)
10 ;; Maintainer: Kenichi Handa <handa@m17n.org> (multi-byte characters)
11 ;; Vinicius Jose Latorre <viniciusjl@ig.com.br>
12 ;; Keywords: wp, print, PostScript
13 ;; Version: 6.7.6
14 ;; X-URL: http://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre
16 (defconst ps-print-version "6.7.6"
17 "ps-print.el, v 6.7.6 <2007/10/10 vinicius>
19 Vinicius's last change version -- this file may have been edited as part of
20 Emacs without changes to the version number. When reporting bugs, please also
21 report the version of Emacs, if any, that ps-print was distributed with.
23 Please send all bug fixes and enhancements to
24 Vinicius Jose Latorre <viniciusjl@ig.com.br>.")
26 ;; This file is part of GNU Emacs.
28 ;; GNU Emacs is free software; you can redistribute it and/or modify it under
29 ;; the terms of the GNU General Public License as published by the Free
30 ;; Software Foundation; either version 3, or (at your option) any later
31 ;; version.
33 ;; GNU Emacs is distributed in the hope that it will be useful, but WITHOUT ANY
34 ;; WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
35 ;; FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
36 ;; details.
38 ;; You should have received a copy of the GNU General Public License along with
39 ;; GNU Emacs; see the file COPYING. If not, write to the Free Software
40 ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
42 ;;; Commentary:
44 ;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
46 ;; About ps-print
47 ;; --------------
49 ;; This package provides printing of Emacs buffers on PostScript printers; the
50 ;; buffer's bold and italic text attributes are preserved in the printer
51 ;; output. ps-print is intended for use with Emacs or XEmacs, together with a
52 ;; fontifying package such as font-lock or hilit.
54 ;; ps-print uses the same face attributes defined through font-lock or hilit to
55 ;; print a PostScript file, but some faces are better seeing on the screen than
56 ;; on paper, specially when you have a black/white PostScript printer.
58 ;; ps-print allows a remap of face to another one that it is better to print,
59 ;; for example, the face font-lock-comment-face (if you are using font-lock)
60 ;; could have bold or italic attribute when printing, besides foreground color.
61 ;; This remap improves printing look (see How Ps-Print Maps Faces).
64 ;; Using ps-print
65 ;; --------------
67 ;; ps-print provides eight commands for generating PostScript images of Emacs
68 ;; buffers:
70 ;; ps-print-buffer
71 ;; ps-print-buffer-with-faces
72 ;; ps-print-region
73 ;; ps-print-region-with-faces
74 ;; ps-spool-buffer
75 ;; ps-spool-buffer-with-faces
76 ;; ps-spool-region
77 ;; ps-spool-region-with-faces
79 ;; These commands all perform essentially the same function: they generate
80 ;; PostScript images suitable for printing on a PostScript printer or
81 ;; displaying with GhostScript. These commands are collectively referred to as
82 ;; "ps-print- commands".
84 ;; The word "print" or "spool" in the command name determines when the
85 ;; PostScript image is sent to the printer:
87 ;; print - The PostScript image is immediately sent to the printer;
89 ;; spool - The PostScript image is saved temporarily in an Emacs
90 ;; buffer. Many images may be spooled locally before
91 ;; printing them. To send the spooled images to the
92 ;; printer, use the command `ps-despool'.
94 ;; The spooling mechanism was designed for printing lots of small files (mail
95 ;; messages or netnews articles) to save paper that would otherwise be wasted
96 ;; on banner pages, and to make it easier to find your output at the printer
97 ;; (it's easier to pick up one 50-page printout than to find 50 single-page
98 ;; printouts).
100 ;; ps-print has a hook in the `kill-emacs-hook' so that you won't accidentally
101 ;; quit from Emacs while you have unprinted PostScript waiting in the spool
102 ;; buffer. If you do attempt to exit with spooled PostScript, you'll be asked
103 ;; if you want to print it, and if you decline, you'll be asked to confirm the
104 ;; exit; this is modeled on the confirmation that Emacs uses for modified
105 ;; buffers.
107 ;; The word "buffer" or "region" in the command name determines how much of the
108 ;; buffer is printed:
110 ;; buffer - Print the entire buffer.
112 ;; region - Print just the current region.
114 ;; The -with-faces suffix on the command name means that the command will
115 ;; include font, color, and underline information in the PostScript image, so
116 ;; the printed image can look as pretty as the buffer. The ps-print- commands
117 ;; without the -with-faces suffix don't include font, color, or underline
118 ;; information; images printed with these commands aren't as pretty, but are
119 ;; faster to generate.
121 ;; Two ps-print- command examples:
123 ;; ps-print-buffer - print the entire buffer, without font,
124 ;; color, or underline information, and
125 ;; send it immediately to the printer.
127 ;; ps-spool-region-with-faces - print just the current region; include
128 ;; font, color, and underline information,
129 ;; and spool the image in Emacs to send to
130 ;; the printer later.
133 ;; Invoking Ps-Print
134 ;; -----------------
136 ;; To print your buffer, type
138 ;; M-x ps-print-buffer
140 ;; or substitute one of the other seven ps-print- commands. The command will
141 ;; generate the PostScript image and print or spool it as specified. By giving
142 ;; the command a prefix argument
144 ;; C-u M-x ps-print-buffer
146 ;; it will save the PostScript image to a file instead of sending it to the
147 ;; printer; you will be prompted for the name of the file to save the image to.
148 ;; The prefix argument is ignored by the commands that spool their images, but
149 ;; you may save the spooled images to a file by giving a prefix argument to
150 ;; `ps-despool':
152 ;; C-u M-x ps-despool
154 ;; When invoked this way, `ps-despool' will prompt you for the name of the file
155 ;; to save to.
157 ;; Any of the `ps-print-' commands can be bound to keys; I recommend binding
158 ;; `ps-spool-buffer-with-faces', `ps-spool-region-with-faces', and
159 ;; `ps-despool'. Here are the bindings I use on my Sun 4 keyboard:
161 ;; (global-set-key 'f22 'ps-spool-buffer-with-faces) ;f22 is prsc
162 ;; (global-set-key '(shift f22) 'ps-spool-region-with-faces)
163 ;; (global-set-key '(control f22) 'ps-despool)
166 ;; The Printer Interface
167 ;; ---------------------
169 ;; The variables `ps-lpr-command' and `ps-lpr-switches' determine what command
170 ;; is used to send the PostScript images to the printer, and what arguments to
171 ;; give the command. These are analogous to `lpr-command' and `lpr-switches'.
173 ;; Make sure that they contain appropriate values for your system;
174 ;; see the usage notes below and the documentation of these variables.
176 ;; The variable `ps-printer-name' determines the name of a local printer for
177 ;; printing PostScript files.
179 ;; The variable `ps-printer-name-option' determines the option used by some
180 ;; utilities to indicate the printer name, it's used only when
181 ;; `ps-printer-name' is a non-empty string. If you're using lpr utility to
182 ;; print, for example, `ps-printer-name-option' should be set to "-P".
184 ;; NOTE: `ps-lpr-command' and `ps-lpr-switches' take their initial values from
185 ;; the variables `lpr-command' and `lpr-switches'. If you have
186 ;; `lpr-command' set to invoke a pretty-printer such as `enscript', then
187 ;; ps-print won't work properly. `ps-lpr-command' must name a program
188 ;; that does not format the files it prints.
189 ;; `ps-printer-name' takes its initial value from the variable
190 ;; `printer-name'. `ps-printer-name-option' tries to guess which system
191 ;; Emacs is running and takes its initial value in accordance with this
192 ;; guess.
194 ;; The variable `ps-print-region-function' specifies a function to print the
195 ;; region on a PostScript printer.
196 ;; See definition of `call-process-region' for calling conventions. The fourth
197 ;; and the sixth arguments are both nil.
199 ;; The variable `ps-manual-feed' indicates if the printer will manually feed
200 ;; paper. If it's nil, automatic feeding takes place. If it's non-nil, manual
201 ;; feeding takes place. The default is nil (automatic feeding).
203 ;; The variable `ps-end-with-control-d' specifies whether C-d (\x04) should be
204 ;; inserted at end of PostScript generated. Non-nil means do so. The default
205 ;; is nil (don't insert).
207 ;; If you're using Emacs for Windows 95/98/NT or MS-DOS, don't forget to
208 ;; customize the following variables: `ps-printer-name',
209 ;; `ps-printer-name-option', `ps-lpr-command', `ps-lpr-switches' and
210 ;; `ps-spool-config'. See these variables documentation in the code or by
211 ;; typing, for example, C-h v ps-printer-name RET.
214 ;; The Page Layout
215 ;; ---------------
217 ;; All dimensions are floats in PostScript points.
218 ;; 1 inch == 2.54 cm == 72 points
219 ;; 1 cm == (/ 1 2.54) inch == (/ 72 2.54) points
221 ;; The variable `ps-paper-type' determines the size of paper ps-print formats
222 ;; for; it should contain one of the symbols: `a4' `a3' `letter' `legal'
223 ;; `letter-small' `tabloid' `ledger' `statement' `executive' `a4small' `b4'
224 ;; `b5'.
226 ;; If variable `ps-warn-paper-type' is nil, it's *not* given an error if
227 ;; PostScript printer doesn't have a paper with the size indicated by
228 ;; `ps-paper-type', instead it uses the default paper size. If variable
229 ;; `ps-warn-paper-type' is non-nil, it's given an error if PostScript printer
230 ;; doesn't have a paper with the size indicated by `ps-paper-type'. It's used
231 ;; when `ps-spool-config' is set to `setpagedevice' (see section Duplex
232 ;; Printers). The default value is non-nil (it gives an error).
234 ;; The variable `ps-landscape-mode' determines the orientation of the printing
235 ;; on the page: nil means `portrait' mode, non-nil means `landscape' mode.
236 ;; There is no oblique mode yet, though this is easy to do in ps.
238 ;; In landscape mode, the text is NOT scaled: you may print 70 lines in
239 ;; portrait mode and only 50 lines in landscape mode. The margins represent
240 ;; margins in the printed paper: the top margin is the margin between the top
241 ;; of the page and the printed header, whatever the orientation is.
243 ;; The variable `ps-number-of-columns' determines the number of columns both in
244 ;; landscape and portrait mode.
245 ;; You can use:
246 ;; - (the standard) one column portrait mode.
247 ;; - (my favorite) two columns landscape mode (which spares trees).
248 ;; but also:
249 ;; - one column landscape mode for files with very long lines.
250 ;; - multi-column portrait or landscape mode.
252 ;; The variable `ps-print-upside-down' determines other orientation for
253 ;; printing page: nil means `normal' printing, non-nil means `upside-down'
254 ;; printing (that is, the page is rotated by 180 grades). The default value is
255 ;; nil (`normal' printing).
257 ;; The `upside-down' orientation can be used in portrait or landscape mode.
259 ;; The variable `ps-selected-pages' specifies which pages to print. If it's
260 ;; nil, all pages are printed. If it's a list, the list element may be an
261 ;; integer or a cons cell (FROM . TO) designating FROM page to TO page; any
262 ;; invalid element is ignored, that is, an integer lesser than one or if FROM
263 ;; is greater than TO. Otherwise, it's treated as nil. The default value is
264 ;; nil (print all pages). After ps-print processing `ps-selected-pages' is set
265 ;; to nil. But the latest `ps-selected-pages' is saved in
266 ;; `ps-last-selected-pages' (see it for documentation). So you can restore the
267 ;; latest selected pages by using `ps-last-selected-pages' or by calling
268 ;; `ps-restore-selected-pages' command (see it for documentation).
270 ;; The variable `ps-even-or-odd-pages' specifies if it prints even/odd pages.
272 ;; Valid values are:
274 ;; nil print all pages.
276 ;; even-page print only even pages.
278 ;; odd-page print only odd pages.
280 ;; even-sheet print only even sheets.
282 ;; odd-sheet print only odd sheets.
284 ;; Any other value is treated as nil. The default value is nil.
286 ;; See `ps-even-or-odd-pages' for more detailed documentation.
289 ;; Horizontal layout
290 ;; -----------------
292 ;; The horizontal layout is determined by the variables
293 ;; `ps-left-margin' `ps-inter-column' `ps-right-margin'
294 ;; as follows:
296 ;; ------------------------------------------
297 ;; | | | | | | | |
298 ;; | lm | text | ic | text | ic | text | rm |
299 ;; | | | | | | | |
300 ;; ------------------------------------------
302 ;; If `ps-number-of-columns' is 1, `ps-inter-column' is not relevant.
303 ;; Usually, lm = rm > 0 and ic = lm
304 ;; If (ic < 0), the text of adjacent columns can overlap.
307 ;; Vertical layout
308 ;; ---------------
310 ;; The vertical layout is determined by the variables
311 ;; `ps-bottom-margin' `ps-top-margin' `ps-header-offset' `ps-footer-offset'
312 ;; as follows:
314 ;; |--------| |--------| |--------| |--------|
315 ;; | tm | | tm | | tm | | tm |
316 ;; |--------| |--------| |--------| |--------|
317 ;; | header | | | | header | | |
318 ;; |--------| | | |--------| | |
319 ;; | ho | | | | ho | | |
320 ;; |--------| | | |--------| | |
321 ;; | | | | | | | |
322 ;; | text | or | text | or | text | or | text |
323 ;; | | | | | | | |
324 ;; | | |--------| |--------| | |
325 ;; | | | fo | | fo | | |
326 ;; | | |--------| |--------| | |
327 ;; | | | footer | | footer | | |
328 ;; |--------| |--------| |--------| |--------|
329 ;; | bm | | bm | | bm | | bm |
330 ;; |--------| |--------| |--------| |--------|
332 ;; If `ps-print-header' is nil, `ps-header-offset' is not relevant.
333 ;; If `ps-print-footer' is nil, `ps-footer-offset' is not relevant.
334 ;; The margins represent margins in the printed paper:
335 ;; the top margin is the margin between the top of the page and the printed
336 ;; header, whatever the orientation is;
337 ;; the bottom margin is the margin between the bottom of the page and the
338 ;; printed footer, whatever the orientation is.
341 ;; Headers & Footers
342 ;; -----------------
344 ;; ps-print can print headers at the top of each column or at the top of each
345 ;; page; the default headers contain the following four items: on the left, the
346 ;; name of the buffer and, if the buffer is visiting a file, the file's
347 ;; directory; on the right, the page number and date of printing. The default
348 ;; headers look something like this:
350 ;; ps-print.el 1/21
351 ;; /home/jct/emacs-lisp/ps/new 94/12/31
353 ;; When printing on duplex printers, left and right are reversed so that the
354 ;; page numbers are toward the outside (cf. `ps-spool-duplex').
356 ;; Headers are configurable:
357 ;; To turn them off completely, set `ps-print-header' to nil.
358 ;; To turn off the header's gaudy framing box,
359 ;; set `ps-print-header-frame' to nil.
361 ;; The variable `ps-header-frame-alist' specifies header frame properties
362 ;; alist. Valid frame properties are:
364 ;; fore-color Specify the foreground frame color.
365 ;; It should be a float number between 0.0 (black color)
366 ;; and 1.0 (white color), a string which is a color name,
367 ;; or a list of 3 float numbers which corresponds to the
368 ;; Red Green Blue color scale, each float number between
369 ;; 0.0 (dark color) and 1.0 (bright color).
370 ;; The default is 0 ("black").
372 ;; back-color Specify the background frame color (similar to
373 ;; fore-color). The default is 0.9 ("gray90").
375 ;; shadow-color Specify the shadow color (similar to fore-color).
376 ;; The default is 0 ("black").
378 ;; border-color Specify the border color (similar to fore-color).
379 ;; The default is 0 ("black").
381 ;; border-width Specify the border width.
382 ;; The default is 0.4.
384 ;; Any other property is ignored.
386 ;; Don't change this alist directly, instead use customization, or `ps-value',
387 ;; `ps-get', `ps-put' and `ps-del' functions (see them for documentation).
389 ;; To print only one header at the top of each page, set
390 ;; `ps-print-only-one-header' to t.
392 ;; To switch headers, set `ps-switch-header' to:
394 ;; nil Never switch headers.
396 ;; t Always switch headers.
398 ;; duplex Switch headers only when duplexing is on, that is, when
399 ;; `ps-spool-duplex' is non-nil (see Duplex Printers).
401 ;; Any other value is treated as t. The default value is `duplex'.
403 ;; The font family and size of text in the header are determined by the
404 ;; variables `ps-header-font-family', `ps-header-font-size' and
405 ;; `ps-header-title-font-size' (see below).
407 ;; The variable `ps-header-line-pad' determines the portion of a header title
408 ;; line height to insert between the header frame and the text it contains,
409 ;; both in the vertical and horizontal directions: .5 means half a line.
411 ;; Page numbers are printed in `n/m' format, indicating page n of m pages; to
412 ;; omit the total page count and just print the page number, set
413 ;; `ps-show-n-of-n' to nil.
415 ;; The amount of information in the header can be changed by changing the
416 ;; number of lines. To show less, set `ps-header-lines' to 1, and the header
417 ;; will show only the buffer name and page number. To show more, set
418 ;; `ps-header-lines' to 3, and the header will show the time of printing below
419 ;; the date.
421 ;; To change the content of the headers, change the variables `ps-left-header'
422 ;; and `ps-right-header'.
423 ;; These variables are lists, specifying top-to-bottom the text to display on
424 ;; the left or right side of the header. Each element of the list should be a
425 ;; string or a symbol. Strings are inserted directly into the PostScript
426 ;; arrays, and should contain the PostScript string delimiters '(' and ')'.
428 ;; Symbols in the header format lists can either represent functions or
429 ;; variables. Functions are called, and should return a string to show in the
430 ;; header. Variables should contain strings to display in the header. In
431 ;; either case, function or variable, the PostScript string delimiters are
432 ;; added by ps-print, and should not be part of the returned value.
434 ;; Here's an example: say we want the left header to display the text
436 ;; Moe
437 ;; Larry
438 ;; Curly
440 ;; where we have a function to return "Moe"
442 ;; (defun moe-func ()
443 ;; "Moe")
445 ;; a variable specifying "Larry"
447 ;; (setq larry-var "Larry")
449 ;; and a literal for "Curly". Here's how `ps-left-header' should be set:
451 ;; (setq ps-left-header (list 'moe-func 'larry-var "(Curly)"))
453 ;; Note that Curly has the PostScript string delimiters inside his quotes --
454 ;; those aren't misplaced lisp delimiters!
456 ;; Without them, PostScript would attempt to call the undefined function Curly,
457 ;; which would result in a PostScript error.
459 ;; Since most printers don't report PostScript errors except by aborting the
460 ;; print job, this kind of error can be hard to track down.
462 ;; Consider yourself warned!
464 ;; ps-print also print footers. The footer variables are: `ps-print-footer',
465 ;; `ps-footer-offset', `ps-print-footer-frame', `ps-footer-font-family',
466 ;; `ps-footer-font-size', `ps-footer-line-pad', `ps-footer-lines',
467 ;; `ps-left-footer', `ps-right-footer' and `ps-footer-frame-alist'. These
468 ;; variables are similar to those one that control headers.
470 ;; The variables `ps-print-only-one-header' and `ps-switch-header' also control
471 ;; the footer (The same way that control header).
473 ;; As a footer example, if you want to have a centered page number in the
474 ;; footer but without headers, set:
476 ;; (setq ps-print-header nil
477 ;; ps-print-footer t
478 ;; ps-print-footer-frame nil
479 ;; ps-footer-lines 1
480 ;; ps-right-footer nil
481 ;; ps-left-footer
482 ;; (list (concat "{pagenumberstring dup stringwidth pop"
483 ;; " 2 div PrintWidth 2 div exch sub 0 rmoveto}")))
486 ;; PostScript Prologue Header
487 ;; --------------------------
489 ;; It is possible to add PostScript prologue header comments besides that
490 ;; ps-print generates by setting the variable `ps-print-prologue-header'.
492 ;; `ps-print-prologue-header' may be a string or a symbol function which
493 ;; returns a string. Note that this string is inserted on PostScript prologue
494 ;; header section which is used to define some document characteristic through
495 ;; PostScript special comments, like "%%Requirements: jog\n".
497 ;; By default `ps-print-prologue-header' is nil.
499 ;; ps-print always inserts the %%Requirements: comment, so if you need to
500 ;; insert more requirements put them first in `ps-print-prologue-header' using
501 ;; the "%%+" comment. For example, if you need to set numcopies to 3 and jog
502 ;; on requirements and set %%LanguageLevel: to 2, do:
504 ;; (setq ps-print-prologue-header
505 ;; "%%+ numcopies(3) jog\n%%LanguageLevel: 2\n")
507 ;; The duplex requirement is inserted by ps-print (see section Duplex
508 ;; Printers).
510 ;; Do not forget to terminate the string with "\n".
512 ;; For more information about PostScript document comments, see:
513 ;; PostScript Language Reference Manual (2nd edition)
514 ;; Adobe Systems Incorporated
515 ;; Appendix G: Document Structuring Conventions -- Version 3.0
517 ;; It is also possible to add an user defined PostScript prologue code before
518 ;; all generated prologue code by setting the variable
519 ;; `ps-user-defined-prologue'.
521 ;; `ps-user-defined-prologue' may be a string or a symbol function which
522 ;; returns a string. Note that this string is inserted after `ps-adobe-tag'
523 ;; and PostScript prologue comments, and before ps-print PostScript prologue
524 ;; code section. That is, this string is inserted after error handler
525 ;; initialization and before ps-print settings.
527 ;; By default `ps-user-defined-prologue' is nil.
529 ;; It's strongly recommended only insert PostScript code and/or comments
530 ;; specific for your printing system particularities. For example, some
531 ;; special initialization that only your printing system needs.
533 ;; Do not insert code for duplex printing, n-up printing or error handler,
534 ;; ps-print handles this in a suitable way.
536 ;; For more information about PostScript, see:
537 ;; PostScript Language Reference Manual (2nd edition)
538 ;; Adobe Systems Incorporated
540 ;; As an example for `ps-user-defined-prologue' setting:
542 ;; ;; Setting for HP PostScript printer
543 ;; (setq ps-user-defined-prologue
544 ;; (concat "<</DeferredMediaSelection true /PageSize [612 792] "
545 ;; "/MediaPosition 2 /MediaType (Plain)>> setpagedevice"))
548 ;; PostScript Error Handler
549 ;; ------------------------
551 ;; ps-print instruments generated PostScript code with an error handler.
553 ;; The variable `ps-error-handler-message' specifies where the error handler
554 ;; message should be sent.
556 ;; Valid values are:
558 ;; none catch the error and *DON'T* send any message.
560 ;; paper catch the error and print on paper the error message.
561 ;; This is the default value.
563 ;; system catch the error and send back the error message to
564 ;; printing system. This is useful only if printing
565 ;; system send back an email reporting the error, or if
566 ;; there is some other alternative way to report back the
567 ;; error from the system to you.
569 ;; paper-and-system catch the error, print on paper the error message and
570 ;; send back the error message to printing system.
572 ;; Any other value is treated as `paper'.
575 ;; Duplex Printers
576 ;; ---------------
578 ;; If you have a duplex-capable printer (one that prints both sides of the
579 ;; paper), set `ps-spool-duplex' to t.
580 ;; ps-print will insert blank pages to make sure each buffer starts on the
581 ;; correct side of the paper.
583 ;; The variable `ps-spool-config' specifies who is the responsible for setting
584 ;; duplex and page size. Valid values are:
586 ;; lpr-switches duplex and page size are configured by `ps-lpr-switches'.
587 ;; Don't forget to set `ps-lpr-switches' to select duplex
588 ;; printing for your printer.
590 ;; setpagedevice duplex and page size are configured by ps-print using the
591 ;; setpagedevice PostScript operator.
593 ;; nil duplex and page size are configured by ps-print *not* using
594 ;; the setpagedevice PostScript operator.
596 ;; Any other value is treated as nil.
598 ;; The default value is `lpr-switches'.
600 ;; WARNING: The setpagedevice PostScript operator affects ghostview utility
601 ;; when viewing file generated using landscape. Also on some
602 ;; printers, setpagedevice affects zebra stripes; on other printers,
603 ;; setpagedevice affects the left margin.
604 ;; Besides all that, if your printer does not have the paper size
605 ;; specified by setpagedevice, your printing will be aborted.
606 ;; So, if you need to use setpagedevice, set `ps-spool-config' to
607 ;; `setpagedevice', generate a test file and send it to your printer;
608 ;; if the printed file isn't ok, set `ps-spool-config' to nil.
610 ;; The variable `ps-spool-tumble' specifies how the page images on opposite
611 ;; sides of a sheet are oriented with respect to each other. If
612 ;; `ps-spool-tumble' is nil, produces output suitable for binding on the left
613 ;; or right. If `ps-spool-tumble' is non-nil, produces output suitable for
614 ;; binding at the top or bottom. It has effect only when `ps-spool-duplex' is
615 ;; non-nil. The default value is nil.
617 ;; Some printer system prints a header page and forces the first page be
618 ;; printed on header page back, when using duplex. If your printer system has
619 ;; this behavior, set variable `ps-banner-page-when-duplexing' to t.
621 ;; When `ps-banner-page-when-duplexing' is non-nil, it prints a blank page as
622 ;; the very first printed page. So, it behaves as the very first character of
623 ;; buffer (or region) is ^L (\014).
625 ;; The default for `ps-banner-page-when-duplexing' is nil (*don't* skip the
626 ;; very first page).
629 ;; N-up Printing
630 ;; -------------
632 ;; The variable `ps-n-up-printing' specifies the number of pages per sheet of
633 ;; paper. The value specified must be between 1 and 100. The default is 1.
635 ;; NOTE: some PostScript printer may crash printing if `ps-n-up-printing' is
636 ;; set to a high value (for example, 23). If this happens, set a lower value.
638 ;; The variable `ps-n-up-margin' specifies the margin in points between the
639 ;; sheet border and the n-up printing. The default is 1 cm (or 0.3937 inches,
640 ;; or 28.35 points).
642 ;; If variable `ps-n-up-border-p' is non-nil a border is drawn around each
643 ;; page. The default is t.
645 ;; The variable `ps-n-up-filling' specifies how page matrix is filled on each
646 ;; sheet of paper. Following are the valid values for `ps-n-up-filling' with a
647 ;; filling example using a 3x4 page matrix:
649 ;; left-top 1 2 3 4 left-bottom 9 10 11 12
650 ;; 5 6 7 8 5 6 7 8
651 ;; 9 10 11 12 1 2 3 4
653 ;; right-top 4 3 2 1 right-bottom 12 11 10 9
654 ;; 8 7 6 5 8 7 6 5
655 ;; 12 11 10 9 4 3 2 1
657 ;; top-left 1 4 7 10 bottom-left 3 6 9 12
658 ;; 2 5 8 11 2 5 8 11
659 ;; 3 6 9 12 1 4 7 10
661 ;; top-right 10 7 4 1 bottom-right 12 9 6 3
662 ;; 11 8 5 2 11 8 5 2
663 ;; 12 9 6 3 10 7 4 1
665 ;; Any other value is treated as `left-top'.
667 ;; The default value is left-top.
670 ;; Control And 8-bit Characters
671 ;; ----------------------------
673 ;; The variable `ps-print-control-characters' specifies whether you want to see
674 ;; a printable form for control and 8-bit characters, that is, instead of
675 ;; sending, for example, a ^D (\004) to printer, it is sent the string "^D".
677 ;; Valid values for `ps-print-control-characters' are:
679 ;; 8-bit This is the value to use when you want an ASCII encoding of
680 ;; any control or non-ASCII character. Control characters are
681 ;; encoded as "^D", and non-ASCII characters have an
682 ;; octal encoding.
684 ;; control-8-bit This is the value to use when you want an ASCII encoding of
685 ;; any control character, whether it is 7 or 8-bit.
686 ;; European 8-bits accented characters are printed according
687 ;; the current font.
689 ;; control Only ASCII control characters have an ASCII encoding.
690 ;; European 8-bits accented characters are printed according
691 ;; the current font.
693 ;; nil No ASCII encoding. Any character is printed according the
694 ;; current font.
696 ;; Any other value is treated as nil.
698 ;; The default is `control-8-bit'.
700 ;; Characters TAB, NEWLINE and FORMFEED are always treated by ps-print engine.
703 ;; Printing Multi-byte Buffer
704 ;; --------------------------
706 ;; See ps-mule.el for documentation.
709 ;; Line Number
710 ;; -----------
712 ;; The variable `ps-line-number' specifies whether to number each line;
713 ;; non-nil means do so. The default is nil (don't number each line).
715 ;; The variable `ps-line-number-color' specifies the color for line number.
716 ;; See `ps-zebra-color' for documentation. The default is "black" (or 0.0, or
717 ;; '(0.0 0.0 0.0)).
719 ;; The variable `ps-line-number-font' specifies the font for line number.
720 ;; The default is "Times-Italic".
722 ;; The variable `ps-line-number-font-size' specifies the font size in points
723 ;; for line number. See `ps-font-size' for documentation. The default is 6.
725 ;; The variable `ps-line-number-step' specifies the interval that line number
726 ;; is printed. For example, if `ps-line-number-step' is set to 2, the printing
727 ;; will look like:
729 ;; 1 one line
730 ;; one line
731 ;; 3 one line
732 ;; one line
733 ;; 5 one line
734 ;; one line
735 ;; ...
737 ;; Valid values are:
739 ;; integer an integer that specifies the interval that line number is
740 ;; printed. If it's lesser than or equal to zero, it's used the
741 ;; value 1.
743 ;; `zebra' specifies that only the line number of the first line in a
744 ;; zebra stripe is to be printed.
746 ;; Any other value is treated as `zebra'.
747 ;; The default value is 1, so each line number is printed.
749 ;; The variable `ps-line-number-start' specifies the starting point in the
750 ;; interval given by `ps-line-number-step'. For example, if
751 ;; `ps-line-number-step' is set to 3 and `ps-line-number-start' is set to 3,
752 ;; the printing will look like:
754 ;; one line
755 ;; one line
756 ;; 3 one line
757 ;; one line
758 ;; one line
759 ;; 6 one line
760 ;; one line
761 ;; one line
762 ;; 9 one line
763 ;; one line
764 ;; ...
766 ;; The values for `ps-line-number-start':
768 ;; * If `ps-line-number-step' is an integer, must be between 1 and the value
769 ;; of `ps-line-number-step' inclusive.
771 ;; * If `ps-line-number-step' is set to `zebra', must be between 1 and the
772 ;; value of `ps-zebra-stripe-height' inclusive.
774 ;; The default value is 1, so the line number of the first line of each
775 ;; interval is printed.
778 ;; Zebra Stripes
779 ;; -------------
781 ;; Zebra stripes are a kind of background that appear "underneath" the text and
782 ;; can make the text easier to read. They look like this:
784 ;; XXXXXXXXXXXXXXXXXXXXXXXX
785 ;; XXXXXXXXXXXXXXXXXXXXXXXX
786 ;; XXXXXXXXXXXXXXXXXXXXXXXX
790 ;; XXXXXXXXXXXXXXXXXXXXXXXX
791 ;; XXXXXXXXXXXXXXXXXXXXXXXX
792 ;; XXXXXXXXXXXXXXXXXXXXXXXX
794 ;; The blocks of X's represent rectangles filled with a light gray color.
795 ;; Each rectangle extends all the way across the page.
797 ;; The height, in lines, of each rectangle is controlled by the variable
798 ;; `ps-zebra-stripe-height', which is 3 by default. The distance between
799 ;; stripes equals the height of a stripe.
801 ;; The variable `ps-zebra-stripes' controls whether to print zebra stripes.
802 ;; Non-nil means yes, nil means no. The default is nil.
804 ;; The variable `ps-zebra-color' controls the zebra stripes gray scale or RGB
805 ;; color. It should be a float number between 0.0 (black color) and 1.0 (white
806 ;; color), a string which is a color name, or a list of 3 numbers which
807 ;; corresponds to the Red Green Blue color scale.
808 ;; The default is 0.95 (or "gray95", or '(0.95 0.95 0.95)).
810 ;; The variable `ps-zebra-stripe-follow' specifies how zebra stripes continue
811 ;; on next page. Visually, valid values are (the character `+' at right of
812 ;; each column indicates that a line is printed):
814 ;; `nil' `follow' `full' `full-follow'
815 ;; Current Page -------- ----------- --------- ----------------
816 ;; 1 XXXXX + 1 XXXXXXXX + 1 XXXXXX + 1 XXXXXXXXXXXXX +
817 ;; 2 XXXXX + 2 XXXXXXXX + 2 XXXXXX + 2 XXXXXXXXXXXXX +
818 ;; 3 XXXXX + 3 XXXXXXXX + 3 XXXXXX + 3 XXXXXXXXXXXXX +
819 ;; 4 + 4 + 4 + 4 +
820 ;; 5 + 5 + 5 + 5 +
821 ;; 6 + 6 + 6 + 6 +
822 ;; 7 XXXXX + 7 XXXXXXXX + 7 XXXXXX + 7 XXXXXXXXXXXXX +
823 ;; 8 XXXXX + 8 XXXXXXXX + 8 XXXXXX + 8 XXXXXXXXXXXXX +
824 ;; 9 XXXXX + 9 XXXXXXXX + 9 XXXXXX + 9 XXXXXXXXXXXXX +
825 ;; 10 + 10 +
826 ;; 11 + 11 +
827 ;; -------- ----------- --------- ----------------
828 ;; Next Page -------- ----------- --------- ----------------
829 ;; 12 XXXXX + 12 + 10 XXXXXX + 10 +
830 ;; 13 XXXXX + 13 XXXXXXXX + 11 XXXXXX + 11 +
831 ;; 14 XXXXX + 14 XXXXXXXX + 12 XXXXXX + 12 +
832 ;; 15 + 15 XXXXXXXX + 13 + 13 XXXXXXXXXXXXX +
833 ;; 16 + 16 + 14 + 14 XXXXXXXXXXXXX +
834 ;; 17 + 17 + 15 + 15 XXXXXXXXXXXXX +
835 ;; 18 XXXXX + 18 + 16 XXXXXX + 16 +
836 ;; 19 XXXXX + 19 XXXXXXXX + 17 XXXXXX + 17 +
837 ;; 20 XXXXX + 20 XXXXXXXX + 18 XXXXXX + 18 +
838 ;; 21 + 21 XXXXXXXX +
839 ;; 22 + 22 +
840 ;; -------- ----------- --------- ----------------
842 ;; Any other value is treated as nil.
844 ;; See also section How Ps-Print Has A Text And/Or Image On Background.
847 ;; Hooks
848 ;; -----
850 ;; ps-print has the following hook variables:
852 ;; `ps-print-hook'
853 ;; It is evaluated once before any printing process. This is the right
854 ;; place to initialize ps-print global data.
855 ;; For an example, see section Adding a New Font Family.
857 ;; `ps-print-begin-sheet-hook'
858 ;; It is evaluated on each beginning of sheet of paper.
859 ;; If `ps-n-up-printing' is equal to 1, `ps-print-begin-page-hook' is never
860 ;; evaluated.
862 ;; `ps-print-begin-page-hook'
863 ;; It is evaluated on each beginning of page, except in the beginning of
864 ;; page that `ps-print-begin-sheet-hook' is evaluated.
866 ;; `ps-print-begin-column-hook'
867 ;; It is evaluated on each beginning of column, except in the beginning of
868 ;; column that `ps-print-begin-page-hook' is evaluated or that
869 ;; `ps-print-begin-sheet-hook' is evaluated.
872 ;; Font Managing
873 ;; -------------
875 ;; ps-print now knows rather precisely some fonts: the variable
876 ;; `ps-font-info-database' contains information for a list of font families
877 ;; (currently mainly `Courier' `Helvetica' `Times' `Palatino'
878 ;; `Helvetica-Narrow' `NewCenturySchlbk'). Each font family contains the font
879 ;; names for standard, bold, italic and bold-italic characters, a reference
880 ;; size (usually 10) and the corresponding line height, width of a space and
881 ;; average character width.
883 ;; The variable `ps-font-family' determines which font family is to be used for
884 ;; ordinary text. If its value does not correspond to a known font family, an
885 ;; error message is printed into the `*Messages*' buffer, which lists the
886 ;; currently available font families.
888 ;; The variable `ps-font-size' determines the size (in points) of the font for
889 ;; ordinary text, when generating PostScript. Its value is a float or a cons
890 ;; of floats which has the following form:
892 ;; (LANDSCAPE-SIZE . PORTRAIT-SIZE)
894 ;; Similarly, the variable `ps-header-font-family' determines which font family
895 ;; is to be used for text in the header.
897 ;; The variable `ps-header-font-size' determines the font size, in points, for
898 ;; text in the header (similar to `ps-font-size').
900 ;; The variable `ps-header-title-font-size' determines the font size, in
901 ;; points, for the top line of text in the header (similar to `ps-font-size').
903 ;; The variable `ps-line-spacing' determines the line spacing, in points, for
904 ;; ordinary text, when generating PostScript (similar to `ps-font-size'). The
905 ;; default value is 0 (zero = no line spacing).
907 ;; The variable `ps-paragraph-spacing' determines the paragraph spacing, in
908 ;; points, for ordinary text, when generating PostScript (similar to
909 ;; `ps-font-size'). The default value is 0 (zero = no paragraph spacing).
911 ;; To get all lines with some spacing set both `ps-line-spacing' and
912 ;; `ps-paragraph-spacing' variables.
914 ;; The variable `ps-paragraph-regexp' specifies the paragraph delimiter. It
915 ;; should be a regexp or nil. The default value is "[ \t]*$", that is, an
916 ;; empty line or a line containing only spaces and tabs.
918 ;; The variable `ps-begin-cut-regexp' and `ps-end-cut-regexp' specify the start
919 ;; and end of a region to cut out when printing.
921 ;; As an example, variables `ps-begin-cut-regexp' and `ps-end-cut-regexp' may
922 ;; be set to "^Local Variables:" and "^End:", respectively, in order to leave
923 ;; out some special printing instructions from the actual print. Special
924 ;; printing instructions may be appended to the end of the file just like any
925 ;; other buffer-local variables. See section "Local Variables in Files" on
926 ;; Emacs manual for more information.
928 ;; Variables `ps-begin-cut-regexp' and `ps-end-cut-regexp' control together
929 ;; what actually gets printed. Both variables may be set to nil in which case
930 ;; no cutting occurs. By default, both variables are set to nil.
933 ;; Adding a New Font Family
934 ;; ------------------------
936 ;; To use a new font family, you MUST first teach ps-print this font, i.e., add
937 ;; its information to `ps-font-info-database', otherwise ps-print cannot
938 ;; correctly place line and page breaks.
940 ;; For example, assuming `Helvetica' is unknown, you first need to do the
941 ;; following ONLY ONCE:
943 ;; - create a new buffer
944 ;; - generate the PostScript image to a file (C-u M-x ps-print-buffer)
945 ;; - open this file and find the line:
946 ;; `% 3 cm 20 cm moveto 10/Courier ReportFontInfo showpage'
947 ;; - delete the leading `%' (which is the PostScript comment character)
948 ;; - replace in this line `Courier' by the new font (say `Helvetica') to get
949 ;; the line:
950 ;; `3 cm 20 cm moveto 10/Helvetica ReportFontInfo showpage'
951 ;; - send this file to the printer (or to ghostscript).
952 ;; You should read the following on the output page:
954 ;; For Helvetica 10 point, the line height is 11.56, the space width is 2.78
955 ;; and a crude estimate of average character width is 5.09243
957 ;; - Add these values to the `ps-font-info-database':
958 ;; (setq ps-font-info-database
959 ;; (append
960 ;; '((Helvetica ; the family key
961 ;; (fonts (normal . "Helvetica")
962 ;; (bold . "Helvetica-Bold")
963 ;; (italic . "Helvetica-Oblique")
964 ;; (bold-italic . "Helvetica-BoldOblique"))
965 ;; (size . 10.0)
966 ;; (line-height . 11.56)
967 ;; (space-width . 2.78)
968 ;; (avg-char-width . 5.09243)))
969 ;; ps-font-info-database))
970 ;; - Now you can use this font family with any size:
971 ;; (setq ps-font-family 'Helvetica)
972 ;; - if you want to use this family in another emacs session, you must put into
973 ;; your `~/.emacs':
974 ;; (require 'ps-print)
975 ;; (setq ps-font-info-database (append ...)))
976 ;; if you don't want to load ps-print, you have to copy the whole value:
977 ;; (setq ps-font-info-database '(<your stuff> <the standard stuff>))
978 ;; or, use `ps-print-hook' (see section Hooks):
979 ;; (add-hook 'ps-print-hook
980 ;; '(lambda ()
981 ;; (or (assq 'Helvetica ps-font-info-database)
982 ;; (setq ps-font-info-database (append ...)))))
984 ;; You can create new `mixed' font families like:
985 ;; (my-mixed-family
986 ;; (fonts (normal . "Courier-Bold")
987 ;; (bold . "Helvetica")
988 ;; (italic . "ZapfChancery-MediumItalic")
989 ;; (bold-italic . "NewCenturySchlbk-BoldItalic")
990 ;; (w3-table-hack-x-face . "LineDrawNormal"))
991 ;; (size . 10.0)
992 ;; (line-height . 10.55)
993 ;; (space-width . 6.0)
994 ;; (avg-char-width . 6.0))
996 ;; Now you can use your new font family with any size:
997 ;; (setq ps-font-family 'my-mixed-family)
999 ;; Note that on above example the `w3-table-hack-x-face' entry refers to a face
1000 ;; symbol, so when printing this face it'll be used the font `LineDrawNormal'.
1001 ;; If the face `w3-table-hack-x-face' is remapped to use bold and/or italic
1002 ;; attribute, the corresponding entry (bold, italic or bold-italic) will be
1003 ;; used instead of `w3-table-hack-x-face' entry.
1005 ;; Note also that the font family entry order is irrelevant, so the above
1006 ;; example could also be written:
1007 ;; (my-mixed-family
1008 ;; (size . 10.0)
1009 ;; (fonts (w3-table-hack-x-face . "LineDrawNormal")
1010 ;; (bold . "Helvetica")
1011 ;; (bold-italic . "NewCenturySchlbk-BoldItalic")
1012 ;; (italic . "ZapfChancery-MediumItalic")
1013 ;; (normal . "Courier-Bold"))
1014 ;; (avg-char-width . 6.0)
1015 ;; (space-width . 6.0)
1016 ;; (line-height . 10.55))
1018 ;; Despite the note above, it is recommended that some convention about
1019 ;; entry order be used.
1021 ;; You can get information on all the fonts resident in YOUR printer
1022 ;; by uncommenting the line:
1023 ;; % 3 cm 20 cm moveto ReportAllFontInfo showpage
1025 ;; The PostScript file should be sent to YOUR PostScript printer.
1026 ;; If you send it to ghostscript or to another PostScript printer, you may get
1027 ;; slightly different results.
1028 ;; Anyway, as ghostscript fonts are autoload, you won't get much font info.
1030 ;; Note also that ps-print DOESN'T download any font to your printer, instead
1031 ;; it uses the fonts resident in your printer.
1034 ;; How Ps-Print Deals With Faces
1035 ;; -----------------------------
1037 ;; The ps-print-*-with-faces commands attempt to determine which faces should
1038 ;; be printed in bold or italic, but their guesses aren't always right. For
1039 ;; example, you might want to map colors into faces so that blue faces print in
1040 ;; bold, and red faces in italic.
1042 ;; It is possible to force ps-print to consider specific faces bold, italic or
1043 ;; underline, no matter what font they are displayed in, by setting the
1044 ;; variables `ps-bold-faces', `ps-italic-faces' and `ps-underlined-faces'.
1045 ;; These variables contain lists of faces that ps-print should consider bold,
1046 ;; italic or underline; to set them, put code like the following into your
1047 ;; .emacs file:
1049 ;; (setq ps-bold-faces '(my-blue-face))
1050 ;; (setq ps-italic-faces '(my-red-face))
1051 ;; (setq ps-underlined-faces '(my-green-face))
1053 ;; Faces like bold-italic that are both bold and italic should go in *both*
1054 ;; lists.
1056 ;; ps-print keeps internal lists of which fonts are bold and which are italic;
1057 ;; these lists are built the first time you invoke ps-print.
1058 ;; For the sake of efficiency, the lists are built only once; the same lists
1059 ;; are referred in later invocations of ps-print.
1061 ;; Because these lists are built only once, it's possible for them to get out
1062 ;; of sync, if a face changes, or if new faces are added. To get the lists
1063 ;; back in sync, you can set the variable `ps-build-face-reference' to t, and
1064 ;; the lists will be rebuilt the next time ps-print is invoked. If you need
1065 ;; that the lists always be rebuilt when ps-print is invoked, set the variable
1066 ;; `ps-always-build-face-reference' to t.
1068 ;; If you need to print without worrying about face background color, set the
1069 ;; variable `ps-use-face-background' which specifies if face background should
1070 ;; be used. Valid values are:
1072 ;; t always use face background color.
1073 ;; nil never use face background color.
1074 ;; (face...) list of faces whose background color will be used.
1076 ;; Any other value will be treated as t.
1077 ;; The default value is nil.
1080 ;; How Ps-Print Deals With Color
1081 ;; -----------------------------
1083 ;; ps-print detects faces with foreground and background colors defined and
1084 ;; embeds color information in the PostScript image.
1085 ;; The default foreground and background colors are defined by the variables
1086 ;; `ps-default-fg' and `ps-default-bg'.
1087 ;; On black/white printers, colors are displayed in gray scale.
1088 ;; To turn off color output, set `ps-print-color-p' to nil.
1089 ;; You can also set `ps-print-color-p' to 'black-white to have a better looking
1090 ;; on black/white printers. See also `ps-black-white-faces' for documentation.
1093 ;; How Ps-Print Maps Faces
1094 ;; -----------------------
1096 ;; As ps-print uses PostScript to print buffers, it is possible to have other
1097 ;; attributes associated with faces. So the new attributes used by ps-print
1098 ;; are:
1100 ;; strikeout - like underline, but the line is in middle of text.
1101 ;; overline - like underline, but the line is over the text.
1102 ;; shadow - text will have a shadow.
1103 ;; box - text will be surrounded by a box.
1104 ;; outline - print characters as hollow outlines.
1106 ;; See the documentation for `ps-extend-face'.
1108 ;; Let's, for example, remap `font-lock-keyword-face' to another foreground
1109 ;; color and bold attribute:
1111 ;; (ps-extend-face '(font-lock-keyword-face "RoyalBlue" nil bold) 'MERGE)
1113 ;; If you want to use a new face, define it first with `defface', and then call
1114 ;; `ps-extend-face' to specify how to print it.
1117 ;; How Ps-Print Has A Text And/Or Image On Background
1118 ;; --------------------------------------------------
1120 ;; ps-print can print texts and/or EPS PostScript images on background; it is
1121 ;; possible to define the following text attributes: font name, font size,
1122 ;; initial position, angle, gray scale and pages to print.
1124 ;; It has the following EPS PostScript images attributes: file name containing
1125 ;; the image, initial position, X and Y scales, angle and pages to print.
1127 ;; See documentation for `ps-print-background-text' and
1128 ;; `ps-print-background-image'.
1130 ;; For example, if we wish to print text "preliminary" on all pages and text
1131 ;; "special" on page 5 and from page 11 to page 17, we could specify:
1133 ;; (setq ps-print-background-text
1134 ;; '(("preliminary")
1135 ;; ("special"
1136 ;; "LeftMargin" "BottomMargin PrintHeight add" ; X and Y position
1137 ;; ; (upper left corner)
1138 ;; nil nil nil
1139 ;; "PrintHeight neg PrintPageWidth atan" ; angle
1140 ;; 5 (11 . 17)) ; page list
1141 ;; ))
1143 ;; Similarly, we could print image "~/images/EPS-image1.ps" on all pages and
1144 ;; image "~/images/EPS-image2.ps" on page 5 and from page 11 to page 17, we
1145 ;; specify:
1147 ;; (setq ps-print-background-image
1148 ;; '(("~/images/EPS-image1.ps"
1149 ;; "LeftMargin" "BottomMargin") ; X and Y position (lower left corner)
1150 ;; ("~/images/EPS-image2.ps"
1151 ;; "LeftMargin" "BottomMargin PrintHeight 2 div add" ; X and Y pos.
1152 ;; ; (upper left corner)
1153 ;; nil nil nil
1154 ;; 5 (11 . 17)) ; page list
1155 ;; ))
1157 ;; If it is not possible to read (or does not exist) an image file, that file
1158 ;; is ignored.
1160 ;; The printing order is:
1162 ;; 1. Print background color
1163 ;; 2. Print zebra stripes
1164 ;; 3. Print background texts that it should be on all pages
1165 ;; 4. Print background images that it should be on all pages
1166 ;; 5. Print background texts only for current page (if any)
1167 ;; 6. Print background images only for current page (if any)
1168 ;; 7. Print header
1169 ;; 8. Print buffer text (with faces, if specified) and line number
1172 ;; Utilities
1173 ;; ---------
1175 ;; Some tools are provided to help you customize your font setup.
1177 ;; `ps-setup' returns (some part of) the current setup.
1179 ;; To avoid wrapping too many lines, you may want to adjust the left and right
1180 ;; margins and the font size. On UN*X systems, do:
1181 ;; pr -t file | awk '{printf "%3d %s\n", length($0), $0}' | sort -r | head
1182 ;; to determine the longest lines of your file.
1183 ;; Then, the command `ps-line-lengths' will give you the correspondence between
1184 ;; a line length (number of characters) and the maximum font size which doesn't
1185 ;; wrap such a line with the current ps-print setup.
1187 ;; The commands `ps-nb-pages-buffer' and `ps-nb-pages-region' display the
1188 ;; correspondence between a number of pages and the maximum font size which
1189 ;; allow the number of lines of the current buffer or of its current region to
1190 ;; fit in this number of pages.
1192 ;; NOTE: line folding is not taken into account in this process and could
1193 ;; change the results.
1195 ;; The command `ps-print-customize' activates a customization buffer for
1196 ;; ps-print options.
1199 ;; New since version 1.5
1200 ;; ---------------------
1202 ;; Color output capability.
1203 ;; Automatic detection of font attributes (bold, italic).
1204 ;; Configurable headers with page numbers.
1205 ;; Slightly faster.
1206 ;; Support for different paper sizes.
1207 ;; Better conformance to PostScript Document Structure Conventions.
1210 ;; New since version 2.8
1211 ;; ---------------------
1213 ;; [vinicius] Vinicius Jose Latorre <viniciusjl@ig.com.br>
1215 ;; 20040229
1216 ;; `ps-time-stamp-yyyy-mm-dd', `ps-time-stamp-iso8601'
1218 ;; 20010619
1219 ;; `ps-time-stamp-locale-default'
1221 ;; 20010530
1222 ;; Handle before-string and after-string overlay properties.
1224 ;; 20010407
1225 ;; `ps-line-number-color', `ps-print-footer', `ps-footer-offset',
1226 ;; `ps-print-footer-frame', `ps-footer-font-family',
1227 ;; `ps-footer-font-size', `ps-footer-line-pad', `ps-footer-lines',
1228 ;; `ps-left-footer', `ps-right-footer', `ps-footer-frame-alist' and
1229 ;; `ps-header-frame-alist'.
1231 ;; 20010328
1232 ;; `ps-line-spacing', `ps-paragraph-spacing', `ps-paragraph-regexp',
1233 ;; `ps-begin-cut-regexp' and `ps-end-cut-regexp'.
1235 ;; 20001122
1236 ;; `ps-line-number-font', `ps-line-number-font-size' and
1237 ;; `ps-end-with-control-d'.
1239 ;; 20000821
1240 ;; `ps-even-or-odd-pages'
1242 ;; 20000617
1243 ;; `ps-manual-feed', `ps-warn-paper-type', `ps-print-upside-down',
1244 ;; `ps-selected-pages', `ps-last-selected-pages',
1245 ;; `ps-restore-selected-pages', `ps-switch-header',
1246 ;; `ps-line-number-step', `ps-line-number-start',
1247 ;; `ps-zebra-stripe-follow' and `ps-use-face-background'.
1249 ;; 20000310
1250 ;; PostScript error handler.
1251 ;; `ps-user-defined-prologue' and `ps-error-handler-message'.
1253 ;; 19991211
1254 ;; `ps-print-customize'.
1256 ;; 19990703
1257 ;; Better customization.
1258 ;; `ps-banner-page-when-duplexing' and `ps-zebra-color'.
1260 ;; 19990513
1261 ;; N-up printing.
1262 ;; Hook: `ps-print-begin-sheet-hook'.
1264 ;; [kenichi] 19990509 Ken'ichi Handa <handa@m17n.org>
1266 ;; `ps-print-region-function'
1268 ;; [vinicius] Vinicius Jose Latorre <viniciusjl@ig.com.br>
1270 ;; 19990301
1271 ;; PostScript tumble and setpagedevice.
1273 ;; 19980922
1274 ;; PostScript prologue header comment insertion.
1275 ;; Skip invisible text better.
1277 ;; [kenichi] 19980819 Ken'ichi Handa <handa@m17n.org>
1279 ;; Multi-byte buffer handling.
1281 ;; [vinicius] Vinicius Jose Latorre <viniciusjl@ig.com.br>
1283 ;; 19980306
1284 ;; Skip invisible text.
1286 ;; 19971130
1287 ;; Hooks: `ps-print-hook', `ps-print-begin-page-hook' and
1288 ;; `ps-print-begin-column-hook'.
1289 ;; Put one header per page over the columns.
1290 ;; Better database font management.
1291 ;; Better control characters handling.
1293 ;; 19971121
1294 ;; Dynamic evaluation at print time of `ps-lpr-switches'.
1295 ;; Handle control characters.
1296 ;; Face remapping.
1297 ;; New face attributes.
1298 ;; Line number.
1299 ;; Zebra stripes.
1300 ;; Text and/or image on background.
1302 ;; [jack] 19960517 Jacques Duthen <duthen@cegelec-red.fr>
1304 ;; Font family and float size for text and header.
1305 ;; Landscape mode.
1306 ;; Multiple columns.
1307 ;; Tools for page setup.
1310 ;; Known bugs and limitations of ps-print
1311 ;; --------------------------------------
1313 ;; Although color printing will work in XEmacs 19.12, it doesn't work well; in
1314 ;; particular, bold or italic fonts don't print in the right background color.
1316 ;; Invisible properties aren't correctly ignored in XEmacs 19.12.
1318 ;; Automatic font-attribute detection doesn't work well, especially with
1319 ;; hilit19 and older versions of get-create-face. Users having problems with
1320 ;; auto-font detection should use the lists `ps-italic-faces', `ps-bold-faces'
1321 ;; and `ps-underlined-faces' and/or turn off automatic detection by setting
1322 ;; `ps-auto-font-detect' to nil.
1324 ;; Automatic font-attribute detection doesn't work with XEmacs 19.12 in tty
1325 ;; mode; use the lists `ps-italic-faces', `ps-bold-faces' and
1326 ;; `ps-underlined-faces' instead.
1328 ;; Still too slow; could use some hand-optimization.
1330 ;; Default background color isn't working.
1332 ;; Faces are always treated as opaque.
1334 ;; Epoch, Lucid and Emacs 21 not supported. At all.
1336 ;; Fixed-pitch fonts work better for line folding, but are not required.
1338 ;; `ps-nb-pages-buffer' and `ps-nb-pages-region' don't take care of folding
1339 ;; lines.
1342 ;; Things to change
1343 ;; ----------------
1345 ;; Avoid page break inside a paragraph.
1346 ;; Add `ps-non-bold-faces' and `ps-non-italic-faces' (should be easy).
1347 ;; Improve the memory management for big files (hard?).
1348 ;; `ps-nb-pages-buffer' and `ps-nb-pages-region' should take care of folding
1349 ;; lines.
1352 ;; Acknowledgments
1353 ;; ---------------
1355 ;; Thanks to Michael Piotrowski <mxp@dynalabs.de> for improving the DSC
1356 ;; compliance of the generated PostScript.
1358 ;; Thanks to Adam Doppelt <adoppelt@avogadro.com> for face mapping suggestion
1359 ;; for black/white PostScript printers.
1361 ;; Thanks to Toni Ronkko <tronkko@hytti.uku.fi> for line and paragraph spacing,
1362 ;; region to cut out when printing and footer suggestions.
1364 ;; Thanks to Pavel Janik ml <Pavel@Janik.cz> for documentation correction.
1366 ;; Thanks to Corinne Ilvedson <cilvedson@draper.com> for line number font size
1367 ;; suggestion.
1369 ;; Thanks to Gord Wait <Gord_Wait@spectrumsignal.com> for
1370 ;; `ps-user-defined-prologue' example setting for HP PostScript printer.
1372 ;; Thanks to Paul Furnanz <pfurnanz@synopsys.com> for XEmacs compatibility
1373 ;; suggestion for `ps-postscript-code-directory' variable.
1375 ;; Thanks to David X Callaway <dxc@xprt.net> for helping debugging PostScript
1376 ;; level 1 compatibility.
1378 ;; Thanks to Colin Marquardt <colin.marquardt@usa.alcatel.com> for:
1379 ;; - upside-down, line number step, line number start and zebra stripe
1380 ;; follow suggestions.
1381 ;; - `ps-time-stamp-yyyy-mm-dd' and `ps-time-stamp-iso8601' suggestion.
1382 ;; - and for XEmacs beta-tests.
1384 ;; Thanks to Klaus Berndl <klaus.berndl@sdm.de> for user defined PostScript
1385 ;; prologue code suggestion, for odd/even printing suggestion and for
1386 ;; `ps-prologue-file' enhancement.
1388 ;; Thanks to Ken'ichi Handa <handa@m17n.org> for multi-byte buffer handling.
1390 ;; Thanks to Matthew O Persico <Matthew.Persico@lazard.com> for line number on
1391 ;; empty columns.
1393 ;; Thanks to Theodore Jump <tjump@cais.com> for adjust PostScript code order on
1394 ;; last page.
1396 ;; Thanks to Roland Ducournau <ducour@lirmm.fr> for
1397 ;; `ps-print-control-characters' variable documentation.
1399 ;; Thanks to Marcus G Daniels <marcus@cathcart.sysc.pdx.edu> for a better
1400 ;; database font management.
1402 ;; Thanks to Martin Boyer <gamin@videotron.ca> for some ideas on putting one
1403 ;; header per page over the columns and correct line numbers when printing a
1404 ;; region.
1406 ;; Thanks to Steven L Baur <steve@miranova.com> for dynamic evaluation at
1407 ;; print time of `ps-lpr-switches'.
1409 ;; Thanks to Kevin Rodgers <kevinr@ihs.com> for handling control characters
1410 ;; (his code was severely modified, but the main idea was kept).
1412 ;; Thanks to some suggestions on:
1413 ;; * Face color map: Marco Melgazzi <marco@techie.com>
1414 ;; * XEmacs compatibility: William J. Henney <will@astrosmo.unam.mx>
1415 ;; * Check `ps-paper-type': Sudhakar Frederick <sfrederi@asc.corp.mot.com>
1417 ;; Thanks to Jacques Duthen <duthen@cegelec-red.fr> (Jack) for version 3.4 I
1418 ;; started from. [vinicius]
1420 ;; Thanks to Jim Thompson <?@?> for the 2.8 version I started from. [jack]
1422 ;; Thanks to Kevin Rodgers <kevinr@ihs.com> for adding support for color and
1423 ;; the invisible property.
1425 ;; Thanks to Avishai Yacobi, avishaiy@mcil.comm.mot.com, for writing the
1426 ;; initial port to Emacs 19. His code is no longer part of ps-print, but his
1427 ;; work is still appreciated.
1429 ;; Thanks to Remi Houdaille and Michel Train <michel@metasoft.fdn.org> for
1430 ;; adding underline support. Their code also is no longer part of ps-print,
1431 ;; but their efforts are not forgotten.
1433 ;; Thanks also to all of you who mailed code to add features to ps-print;
1434 ;; although I didn't use your code, I still appreciate your sharing it with me.
1436 ;; Thanks to all who mailed comments, encouragement, and criticism.
1437 ;; Thanks also to all who responded to my survey; I had too many responses to
1438 ;; reply to them all, but I greatly appreciate your interest.
1440 ;; Jim
1441 ;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1443 ;;; Code:
1446 (require 'lpr)
1448 (or (featurep 'lisp-float-type)
1449 (error "`ps-print' requires floating point support"))
1451 (let ((case-fold-search t))
1452 (cond ((string-match "XEmacs" emacs-version))
1453 ((string-match "Lucid" emacs-version)
1454 (error "`ps-print' doesn't support Lucid"))
1455 ((string-match "Epoch" emacs-version)
1456 (error "`ps-print' doesn't support Epoch"))
1458 (unless (and (boundp 'emacs-major-version)
1459 (>= emacs-major-version 22))
1460 (error "`ps-print' only supports Emacs 22 and higher")))))
1463 ;; GNU Emacs
1464 (or (fboundp 'line-beginning-position)
1465 (defun line-beginning-position (&optional n)
1466 (save-excursion
1467 (and n (/= n 1) (forward-line (1- n)))
1468 (beginning-of-line)
1469 (point))))
1472 ;; to avoid compilation gripes
1474 ;; XEmacs
1475 (defalias 'ps-x-color-instance-p 'color-instance-p)
1476 (defalias 'ps-x-color-instance-rgb-components 'color-instance-rgb-components)
1477 (defalias 'ps-x-color-name 'color-name)
1478 (defalias 'ps-x-color-specifier-p 'color-specifier-p)
1479 (defalias 'ps-x-copy-coding-system 'copy-coding-system)
1480 (defalias 'ps-x-device-class 'device-class)
1481 (defalias 'ps-x-extent-end-position 'extent-end-position)
1482 (defalias 'ps-x-extent-face 'extent-face)
1483 (defalias 'ps-x-extent-priority 'extent-priority)
1484 (defalias 'ps-x-extent-start-position 'extent-start-position)
1485 (defalias 'ps-x-face-font-instance 'face-font-instance)
1486 (defalias 'ps-x-find-coding-system 'find-coding-system)
1487 (defalias 'ps-x-font-instance-properties 'font-instance-properties)
1488 (defalias 'ps-x-make-color-instance 'make-color-instance)
1489 (defalias 'ps-x-map-extents 'map-extents)
1491 ;; GNU Emacs
1492 (defalias 'ps-e-face-bold-p 'face-bold-p)
1493 (defalias 'ps-e-face-italic-p 'face-italic-p)
1494 (defalias 'ps-e-next-overlay-change 'next-overlay-change)
1495 (defalias 'ps-e-overlays-at 'overlays-at)
1496 (defalias 'ps-e-overlay-get 'overlay-get)
1497 (defalias 'ps-e-overlay-end 'overlay-end)
1498 (defalias 'ps-e-x-color-values 'x-color-values)
1499 (defalias 'ps-e-color-values 'color-values)
1500 (defalias 'ps-e-find-composition (if (fboundp 'find-composition)
1501 'find-composition
1502 'ignore))
1505 (defconst ps-windows-system
1506 (memq system-type '(emx win32 w32 mswindows ms-dos windows-nt)))
1507 (defconst ps-lp-system
1508 (memq system-type '(usg-unix-v dgux hpux irix)))
1511 (defun ps-xemacs-color-name (color)
1512 (if (ps-x-color-specifier-p color)
1513 (ps-x-color-name color)
1514 color))
1516 (defalias 'ps-frame-parameter
1517 (if (fboundp 'frame-parameter) 'frame-parameter 'frame-property))
1519 (defalias 'ps-mark-active-p
1520 (if (fboundp 'region-active-p)
1521 'region-active-p ; XEmacs
1522 (defvar mark-active) ; To shup up XEmacs's byte compiler.
1523 (lambda () mark-active))) ; Emacs
1525 (cond ((featurep 'xemacs) ; XEmacs
1526 (defun ps-face-foreground-name (face)
1527 (ps-xemacs-color-name (face-foreground face)))
1528 (defun ps-face-background-name (face)
1529 (ps-xemacs-color-name (face-background face)))
1531 (t ; Emacs 22 or higher
1532 (defun ps-face-foreground-name (face)
1533 (face-foreground face nil t))
1534 (defun ps-face-background-name (face)
1535 (face-background face nil t))
1539 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1540 ;; User Variables:
1543 ;;; Interface to the command system
1545 (defgroup postscript nil
1546 "PostScript Group."
1547 :tag "PostScript"
1548 :version "20"
1549 :group 'emacs)
1551 (defgroup ps-print nil
1552 "PostScript generator for Emacs."
1553 :link '(emacs-library-link :tag "Source Lisp File" "ps-print.el")
1554 :prefix "ps-"
1555 :version "20"
1556 :group 'wp
1557 :group 'postscript)
1559 (defgroup ps-print-horizontal nil
1560 "Horizontal page layout."
1561 :prefix "ps-"
1562 :tag "Horizontal"
1563 :version "20"
1564 :group 'ps-print)
1566 (defgroup ps-print-vertical nil
1567 "Vertical page layout."
1568 :prefix "ps-"
1569 :tag "Vertical"
1570 :version "20"
1571 :group 'ps-print)
1573 (defgroup ps-print-headers nil
1574 "Headers & footers layout."
1575 :prefix "ps-"
1576 :tag "Header & Footer"
1577 :version "20"
1578 :group 'ps-print)
1580 (defgroup ps-print-font nil
1581 "Fonts customization."
1582 :prefix "ps-"
1583 :tag "Font"
1584 :version "20"
1585 :group 'ps-print)
1587 (defgroup ps-print-color nil
1588 "Color customization."
1589 :prefix "ps-"
1590 :tag "Color"
1591 :version "20"
1592 :group 'ps-print)
1594 (defgroup ps-print-face nil
1595 "Faces customization."
1596 :prefix "ps-"
1597 :tag "PS Faces"
1598 :version "20"
1599 :group 'ps-print
1600 :group 'faces)
1602 (defgroup ps-print-n-up nil
1603 "N-up customization."
1604 :prefix "ps-"
1605 :tag "N-Up"
1606 :version "20"
1607 :group 'ps-print)
1609 (defgroup ps-print-zebra nil
1610 "Zebra customization."
1611 :prefix "ps-"
1612 :tag "Zebra"
1613 :version "20"
1614 :group 'ps-print)
1616 (defgroup ps-print-background nil
1617 "Background customization."
1618 :prefix "ps-"
1619 :tag "Background"
1620 :version "20"
1621 :group 'ps-print)
1623 (defgroup ps-print-printer '((lpr custom-group))
1624 "Printer customization."
1625 :prefix "ps-"
1626 :tag "Printer"
1627 :version "20"
1628 :group 'ps-print)
1630 (defgroup ps-print-page nil
1631 "Page customization."
1632 :prefix "ps-"
1633 :tag "Page"
1634 :version "20"
1635 :group 'ps-print)
1637 (defgroup ps-print-miscellany nil
1638 "Miscellany customization."
1639 :prefix "ps-"
1640 :tag "Miscellany"
1641 :version "20"
1642 :group 'ps-print)
1645 (defcustom ps-error-handler-message 'paper
1646 "*Specify where the error handler message should be sent.
1648 Valid values are:
1650 `none' catch the error and *DON'T* send any message.
1652 `paper' catch the error and print on paper the error message.
1654 `system' catch the error and send back the error message to
1655 printing system. This is useful only if printing system
1656 send back an email reporting the error, or if there is
1657 some other alternative way to report back the error from
1658 the system to you.
1660 `paper-and-system' catch the error, print on paper the error message and
1661 send back the error message to printing system.
1663 Any other value is treated as `paper'."
1664 :type '(choice :menu-tag "Error Handler Message"
1665 :tag "Error Handler Message"
1666 (const none) (const paper)
1667 (const system) (const paper-and-system))
1668 :version "20"
1669 :group 'ps-print-miscellany)
1671 (defcustom ps-user-defined-prologue nil
1672 "*User defined PostScript prologue code inserted before all prologue code.
1674 `ps-user-defined-prologue' may be a string or a symbol function which returns a
1675 string. Note that this string is inserted after `ps-adobe-tag' and PostScript
1676 prologue comments, and before ps-print PostScript prologue code section. That
1677 is, this string is inserted after error handler initialization and before
1678 ps-print settings.
1680 It's strongly recommended only insert PostScript code and/or comments specific
1681 for your printing system particularities. For example, some special
1682 initialization that only your printing system needs.
1684 Do not insert code for duplex printing, n-up printing or error handler,
1685 ps-print handles this in a suitable way.
1687 For more information about PostScript, see:
1688 PostScript Language Reference Manual (2nd edition)
1689 Adobe Systems Incorporated
1691 As an example for `ps-user-defined-prologue' setting:
1693 ;; Setting for HP PostScript printer
1694 (setq ps-user-defined-prologue
1695 (concat \"<</DeferredMediaSelection true /PageSize [612 792] \"
1696 \"/MediaPosition 2 /MediaType (Plain)>> setpagedevice\"))"
1697 :type '(choice :menu-tag "User Defined Prologue"
1698 :tag "User Defined Prologue"
1699 (const :tag "none" nil) string symbol)
1700 :version "20"
1701 :group 'ps-print-miscellany)
1703 (defcustom ps-print-prologue-header nil
1704 "*PostScript prologue header comments besides that ps-print generates.
1706 `ps-print-prologue-header' may be a string or a symbol function which returns a
1707 string. Note that this string is inserted on PostScript prologue header
1708 section which is used to define some document characteristic through PostScript
1709 special comments, like \"%%Requirements: jog\\n\".
1711 ps-print always inserts the %%Requirements: comment, so if you need to insert
1712 more requirements put them first in `ps-print-prologue-header' using the
1713 \"%%+\" comment. For example, if you need to set numcopies to 3 and jog on
1714 requirements and set %%LanguageLevel: to 2, do:
1716 (setq ps-print-prologue-header
1717 \"%%+ numcopies(3) jog\\n%%LanguageLevel: 2\\n\")
1719 The duplex requirement is inserted by ps-print (see `ps-spool-duplex').
1721 Do not forget to terminate the string with \"\\n\".
1723 For more information about PostScript document comments, see:
1724 PostScript Language Reference Manual (2nd edition)
1725 Adobe Systems Incorporated
1726 Appendix G: Document Structuring Conventions -- Version 3.0"
1727 :type '(choice :menu-tag "Prologue Header"
1728 :tag "Prologue Header"
1729 (const :tag "none" nil) string symbol)
1730 :version "20"
1731 :group 'ps-print-miscellany)
1733 (defcustom ps-printer-name (and (boundp 'printer-name)
1734 (symbol-value 'printer-name))
1735 "*The name of a local printer for printing PostScript files.
1737 On Unix-like systems, a string value should be a name understood by lpr's -P
1738 option; a value of nil means use the value of `printer-name' instead.
1740 On MS-DOS and MS-Windows systems, a string value is taken as the name of the
1741 printer device or port to which PostScript files are written, provided
1742 `ps-lpr-command' is \"\". By default it is the same as `printer-name'; typical
1743 non-default settings would be \"LPT1\" to \"LPT3\" for parallel printers, or
1744 \"COM1\" to \"COM4\" or \"AUX\" for serial printers, or \"\\\\hostname\\printer\"
1745 for a shared network printer. You can also set it to a name of a file, in
1746 which case the output gets appended to that file. \(Note that `ps-print'
1747 package already has facilities for printing to a file, so you might as well use
1748 them instead of changing the setting of this variable.\) If you want to
1749 silently discard the printed output, set this to \"NUL\".
1751 Set to t, if the utility given by `ps-lpr-command' needs an empty printer name.
1753 Any other value is treated as t, that is, an empty printer name.
1755 See also `ps-printer-name-option' for documentation."
1756 :type '(choice :menu-tag "Printer Name"
1757 :tag "Printer Name"
1758 (const :tag "Same as printer-name" nil)
1759 (const :tag "No Printer Name" t)
1760 (file :tag "Print to file")
1761 (string :tag "Pipe to ps-lpr-command"))
1762 :version "20"
1763 :group 'ps-print-printer)
1765 (defcustom ps-printer-name-option
1766 (cond (ps-windows-system
1767 "/D:")
1768 (ps-lp-system
1769 "-d")
1771 "-P" ))
1772 "*Option for `ps-printer-name' variable (see it).
1774 On Unix-like systems, if `lpr' is in use, this should be the string
1775 \"-P\"; if `lp' is in use, this should be the string \"-d\".
1777 On MS-DOS and MS-Windows systems, if `print' is in use, this should be
1778 the string \"/D:\".
1780 For any other printing utility, see its documentation.
1782 Set this to \"\" or nil, if the utility given by `ps-lpr-command'
1783 needs an empty printer name option--that is, pass the printer name
1784 with no special option preceding it.
1786 Any value that is not a string is treated as nil.
1788 This variable is used only when `ps-printer-name' is a non-empty string."
1789 :type '(choice :menu-tag "Printer Name Option"
1790 :tag "Printer Name Option"
1791 (const :tag "None" nil)
1792 (string :tag "Option"))
1793 :version "21.1"
1794 :group 'ps-print-printer)
1796 (defcustom ps-lpr-command lpr-command
1797 "*Name of program for printing a PostScript file.
1799 On MS-DOS and MS-Windows systems, if the value is an empty string then Emacs
1800 will write directly to the printer port named by `ps-printer-name'. The
1801 programs `print' and `nprint' (the standard print programs on Windows NT and
1802 Novell Netware respectively) are handled specially, using `ps-printer-name' as
1803 the destination for output; any other program is treated like `lpr' except that
1804 an explicit filename is given as the last argument."
1805 :type 'string
1806 :version "20"
1807 :group 'ps-print-printer)
1809 (defcustom ps-lpr-switches lpr-switches
1810 "*A list of extra switches to pass to `ps-lpr-command'."
1811 :type '(repeat :tag "PostScript lpr Switches"
1812 (choice :menu-tag "PostScript lpr Switch"
1813 :tag "PostScript lpr Switch"
1814 string symbol (repeat sexp)))
1815 :version "20"
1816 :group 'ps-print-printer)
1818 (defcustom ps-print-region-function nil
1819 "*Specify a function to print the region on a PostScript printer.
1820 See definition of `call-process-region' for calling conventions. The fourth
1821 and the sixth arguments are both nil."
1822 :type '(choice (const nil) function)
1823 :version "20"
1824 :group 'ps-print-printer)
1826 (defcustom ps-manual-feed nil
1827 "*Non-nil means the printer will manually feed paper.
1829 If it's nil, automatic feeding takes place."
1830 :type 'boolean
1831 :version "20"
1832 :group 'ps-print-printer)
1834 (defcustom ps-end-with-control-d (and ps-windows-system t)
1835 "*Non-nil means insert C-d at end of PostScript file generated."
1836 :version "21.1"
1837 :type 'boolean
1838 :version "20"
1839 :group 'ps-print-printer)
1841 ;;; Page layout
1843 ;; All page dimensions are in PostScript points.
1844 ;; 1 inch == 2.54 cm == 72 points
1845 ;; 1 cm == (/ 1 2.54) inch == (/ 72 2.54) points
1847 ;; Letter 8.5 inch x 11.0 inch
1848 ;; Legal 8.5 inch x 14.0 inch
1849 ;; A4 8.26 inch x 11.69 inch = 21.0 cm x 29.7 cm
1851 ;; LetterSmall 7.68 inch x 10.16 inch
1852 ;; Tabloid 11.0 inch x 17.0 inch
1853 ;; Ledger 17.0 inch x 11.0 inch
1854 ;; Statement 5.5 inch x 8.5 inch
1855 ;; Executive 7.5 inch x 10.0 inch
1856 ;; A3 11.69 inch x 16.5 inch = 29.7 cm x 42.0 cm
1857 ;; A4Small 7.47 inch x 10.85 inch
1858 ;; B4 10.125 inch x 14.33 inch
1859 ;; B5 7.16 inch x 10.125 inch
1861 ;;;###autoload
1862 (defcustom ps-page-dimensions-database
1863 (list (list 'a4 (/ (* 72 21.0) 2.54) (/ (* 72 29.7) 2.54) "A4")
1864 (list 'a3 (/ (* 72 29.7) 2.54) (/ (* 72 42.0) 2.54) "A3")
1865 (list 'letter (* 72 8.5) (* 72 11.0) "Letter")
1866 (list 'legal (* 72 8.5) (* 72 14.0) "Legal")
1867 (list 'letter-small (* 72 7.68) (* 72 10.16) "LetterSmall")
1868 (list 'tabloid (* 72 11.0) (* 72 17.0) "Tabloid")
1869 (list 'ledger (* 72 17.0) (* 72 11.0) "Ledger")
1870 (list 'statement (* 72 5.5) (* 72 8.5) "Statement")
1871 (list 'executive (* 72 7.5) (* 72 10.0) "Executive")
1872 (list 'a4small (* 72 7.47) (* 72 10.85) "A4Small")
1873 (list 'b4 (* 72 10.125) (* 72 14.33) "B4")
1874 (list 'b5 (* 72 7.16) (* 72 10.125) "B5"))
1875 "*List associating a symbolic paper type to its width, height and doc media.
1876 See `ps-paper-type'."
1877 :type '(repeat (list :tag "Paper Type"
1878 (symbol :tag "Name")
1879 (number :tag "Width")
1880 (number :tag "Height")
1881 (string :tag "Media")))
1882 :version "20"
1883 :group 'ps-print-page)
1885 ;;;###autoload
1886 (defcustom ps-paper-type 'letter
1887 "*Specify the size of paper to format for.
1888 Should be one of the paper types defined in `ps-page-dimensions-database', for
1889 example `letter', `legal' or `a4'."
1890 :type '(symbol :validate (lambda (wid)
1891 (if (assq (widget-value wid)
1892 ps-page-dimensions-database)
1894 (widget-put wid :error "Unknown paper size")
1895 wid)))
1896 :version "20"
1897 :group 'ps-print-page)
1899 (defcustom ps-warn-paper-type t
1900 "*Non-nil means give an error if paper size is not equal to `ps-paper-type'.
1902 It's used when `ps-spool-config' is set to `setpagedevice'."
1903 :type 'boolean
1904 :version "20"
1905 :group 'ps-print-page)
1907 (defcustom ps-landscape-mode nil
1908 "*Non-nil means print in landscape mode."
1909 :type 'boolean
1910 :version "20"
1911 :group 'ps-print-page)
1913 (defcustom ps-print-upside-down nil
1914 "*Non-nil means print upside-down (that is, rotated by 180 degrees)."
1915 :type 'boolean
1916 :version "21.1"
1917 :group 'ps-print-page)
1919 (defcustom ps-selected-pages nil
1920 "*Specify which pages to print.
1922 If nil, print all pages.
1924 If a list, the lists element may be an integer or a cons cell (FROM . TO)
1925 designating FROM page to TO page; any invalid element is ignored, that is, an
1926 integer lesser than one or if FROM is greater than TO.
1928 Otherwise, it's treated as nil.
1930 After ps-print processing `ps-selected-pages' is set to nil. But the
1931 latest `ps-selected-pages' is saved in `ps-last-selected-pages' (which
1932 see). So you can restore the latest selected pages by using
1933 `ps-last-selected-pages' or with the `ps-restore-selected-pages'
1934 command (which see).
1936 See also `ps-even-or-odd-pages'."
1937 :type '(repeat :tag "Selected Pages"
1938 (radio :tag "Page"
1939 (integer :tag "Number")
1940 (cons :tag "Range"
1941 (integer :tag "From")
1942 (integer :tag "To"))))
1943 :version "20"
1944 :group 'ps-print-page)
1946 (defcustom ps-even-or-odd-pages nil
1947 "*Specify if it prints even/odd pages.
1949 Valid values are:
1951 nil print all pages.
1953 `even-page' print only even pages.
1955 `odd-page' print only odd pages.
1957 `even-sheet' print only even sheets.
1958 That is, if `ps-n-up-printing' is 1, it behaves as `even-page';
1959 but for values greater than 1, it'll print only the even sheet
1960 of paper.
1962 `odd-sheet' print only odd sheets.
1963 That is, if `ps-n-up-printing' is 1, it behaves as `odd-page';
1964 but for values greater than 1, it'll print only the odd sheet
1965 of paper.
1967 Any other value is treated as nil.
1969 If you set `ps-selected-pages' (see it for documentation), first the pages are
1970 filtered by `ps-selected-pages' and then by `ps-even-or-odd-pages'. For
1971 example, if we have:
1973 (setq ps-selected-pages '(1 4 (6 . 10) (12 . 16) 20))
1975 Combining with `ps-even-or-odd-pages' and `ps-n-up-printing', we have:
1977 `ps-n-up-printing' = 1:
1978 `ps-even-or-odd-pages' PAGES PRINTED
1979 nil 1, 4, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 20
1980 even-page 4, 6, 8, 10, 12, 14, 16, 20
1981 odd-page 1, 7, 9, 13, 15
1982 even-sheet 4, 6, 8, 10, 12, 14, 16, 20
1983 odd-sheet 1, 7, 9, 13, 15
1985 `ps-n-up-printing' = 2:
1986 `ps-even-or-odd-pages' PAGES PRINTED
1987 nil 1/4, 6/7, 8/9, 10/12, 13/14, 15/16, 20
1988 even-page 4/6, 8/10, 12/14, 16/20
1989 odd-page 1/7, 9/13, 15
1990 even-sheet 6/7, 10/12, 15/16
1991 odd-sheet 1/4, 8/9, 13/14, 20
1993 So even-page/odd-page are about page parity and even-sheet/odd-sheet are about
1994 sheet parity."
1995 :type '(choice :menu-tag "Print Even/Odd Pages"
1996 :tag "Print Even/Odd Pages"
1997 (const :tag "All Pages" nil)
1998 (const :tag "Only Even Pages" even-page)
1999 (const :tag "Only Odd Pages" odd-page)
2000 (const :tag "Only Even Sheets" even-sheet)
2001 (const :tag "Only Odd Sheets" odd-sheet))
2002 :version "20"
2003 :group 'ps-print-page)
2005 (defcustom ps-print-control-characters 'control-8-bit
2006 "*Specify the printable form for control and 8-bit characters.
2007 That is, instead of sending, for example, a ^D (\\004) to printer,
2008 it is sent the string \"^D\".
2010 Valid values are:
2012 `8-bit' This is the value to use when you want an ASCII encoding of
2013 any control or non-ASCII character. Control characters are
2014 encoded as \"^D\", and non-ASCII characters have an
2015 octal encoding.
2017 `control-8-bit' This is the value to use when you want an ASCII encoding of
2018 any control character, whether it is 7 or 8-bit.
2019 European 8-bits accented characters are printed according
2020 the current font.
2022 `control' Only ASCII control characters have an ASCII encoding.
2023 European 8-bits accented characters are printed according
2024 the current font.
2026 nil No ASCII encoding. Any character is printed according the
2027 current font.
2029 Any other value is treated as nil."
2030 :type '(choice :menu-tag "Control Char"
2031 :tag "Control Char"
2032 (const 8-bit) (const control-8-bit)
2033 (const control) (const :tag "nil" nil))
2034 :version "20"
2035 :group 'ps-print-miscellany)
2037 (defcustom ps-n-up-printing 1
2038 "*Specify the number of pages per sheet paper."
2039 :type '(integer
2040 :tag "N Up Printing"
2041 :validate
2042 (lambda (wid)
2043 (if (and (< 0 (widget-value wid))
2044 (<= (widget-value wid) 100))
2046 (widget-put
2047 wid :error
2048 "Number of pages per sheet paper must be between 1 and 100.")
2049 wid)))
2050 :version "20"
2051 :group 'ps-print-n-up)
2053 (defcustom ps-n-up-margin (/ (* 72 1.0) 2.54) ; 1 cm
2054 "*Specify the margin in points between the sheet border and n-up printing."
2055 :type 'number
2056 :version "20"
2057 :group 'ps-print-n-up)
2059 (defcustom ps-n-up-border-p t
2060 "*Non-nil means a border is drawn around each page."
2061 :type 'boolean
2062 :version "20"
2063 :group 'ps-print-n-up)
2065 (defcustom ps-n-up-filling 'left-top
2066 "*Specify how page matrix is filled on each sheet of paper.
2068 Following are the valid values for `ps-n-up-filling' with a filling example
2069 using a 3x4 page matrix:
2071 `left-top' 1 2 3 4 `left-bottom' 9 10 11 12
2072 5 6 7 8 5 6 7 8
2073 9 10 11 12 1 2 3 4
2075 `right-top' 4 3 2 1 `right-bottom' 12 11 10 9
2076 8 7 6 5 8 7 6 5
2077 12 11 10 9 4 3 2 1
2079 `top-left' 1 4 7 10 `bottom-left' 3 6 9 12
2080 2 5 8 11 2 5 8 11
2081 3 6 9 12 1 4 7 10
2083 `top-right' 10 7 4 1 `bottom-right' 12 9 6 3
2084 11 8 5 2 11 8 5 2
2085 12 9 6 3 10 7 4 1
2087 Any other value is treated as `left-top'."
2088 :type '(choice :menu-tag "N-Up Filling"
2089 :tag "N-Up Filling"
2090 (const left-top) (const left-bottom)
2091 (const right-top) (const right-bottom)
2092 (const top-left) (const bottom-left)
2093 (const top-right) (const bottom-right))
2094 :version "20"
2095 :group 'ps-print-n-up)
2097 (defcustom ps-number-of-columns (if ps-landscape-mode 2 1)
2098 "*Specify the number of columns."
2099 :type 'number
2100 :version "20"
2101 :group 'ps-print-miscellany)
2103 (defcustom ps-zebra-stripes nil
2104 "*Non-nil means print zebra stripes.
2105 See also documentation for `ps-zebra-stripe-height' and `ps-zebra-color'."
2106 :type 'boolean
2107 :version "20"
2108 :group 'ps-print-zebra)
2110 (defcustom ps-zebra-stripe-height 3
2111 "*Number of zebra stripe lines.
2112 See also documentation for `ps-zebra-stripes' and `ps-zebra-color'."
2113 :type 'number
2114 :version "20"
2115 :group 'ps-print-zebra)
2117 (defcustom ps-zebra-color 0.95
2118 "*Zebra stripe gray scale or RGB color.
2119 See also documentation for `ps-zebra-stripes' and `ps-zebra-stripe-height'."
2120 :type '(choice :menu-tag "Zebra Gray/Color"
2121 :tag "Zebra Gray/Color"
2122 (number :tag "Gray Scale" :value 0.95)
2123 (string :tag "Color Name" :value "gray95")
2124 (list :tag "RGB Color" :value (0.95 0.95 0.95)
2125 (number :tag "Red")
2126 (number :tag "Green")
2127 (number :tag "Blue")))
2128 :version "20"
2129 :group 'ps-print-zebra)
2131 (defcustom ps-zebra-stripe-follow nil
2132 "*Specify how zebra stripes continue on next page.
2134 Visually, valid values are (the character `+' at right of each column indicates
2135 that a line is printed):
2137 `nil' `follow' `full' `full-follow'
2138 Current Page -------- ----------- --------- ----------------
2139 1 XXXXX + 1 XXXXXXXX + 1 XXXXXX + 1 XXXXXXXXXXXXX +
2140 2 XXXXX + 2 XXXXXXXX + 2 XXXXXX + 2 XXXXXXXXXXXXX +
2141 3 XXXXX + 3 XXXXXXXX + 3 XXXXXX + 3 XXXXXXXXXXXXX +
2142 4 + 4 + 4 + 4 +
2143 5 + 5 + 5 + 5 +
2144 6 + 6 + 6 + 6 +
2145 7 XXXXX + 7 XXXXXXXX + 7 XXXXXX + 7 XXXXXXXXXXXXX +
2146 8 XXXXX + 8 XXXXXXXX + 8 XXXXXX + 8 XXXXXXXXXXXXX +
2147 9 XXXXX + 9 XXXXXXXX + 9 XXXXXX + 9 XXXXXXXXXXXXX +
2148 10 + 10 +
2149 11 + 11 +
2150 -------- ----------- --------- ----------------
2151 Next Page -------- ----------- --------- ----------------
2152 12 XXXXX + 12 + 10 XXXXXX + 10 +
2153 13 XXXXX + 13 XXXXXXXX + 11 XXXXXX + 11 +
2154 14 XXXXX + 14 XXXXXXXX + 12 XXXXXX + 12 +
2155 15 + 15 XXXXXXXX + 13 + 13 XXXXXXXXXXXXX +
2156 16 + 16 + 14 + 14 XXXXXXXXXXXXX +
2157 17 + 17 + 15 + 15 XXXXXXXXXXXXX +
2158 18 XXXXX + 18 + 16 XXXXXX + 16 +
2159 19 XXXXX + 19 XXXXXXXX + 17 XXXXXX + 17 +
2160 20 XXXXX + 20 XXXXXXXX + 18 XXXXXX + 18 +
2161 21 + 21 XXXXXXXX +
2162 22 + 22 +
2163 -------- ----------- --------- ----------------
2165 Any other value is treated as nil."
2166 :type '(choice :menu-tag "Zebra Stripe Follow"
2167 :tag "Zebra Stripe Follow"
2168 (const :tag "Always Restart" nil)
2169 (const :tag "Continue on Next Page" follow)
2170 (const :tag "Print Only Full Stripe" full)
2171 (const :tag "Continue on Full Stripe" full-follow))
2172 :version "20"
2173 :group 'ps-print-zebra)
2175 (defcustom ps-line-number nil
2176 "*Non-nil means print line number."
2177 :type 'boolean
2178 :version "20"
2179 :group 'ps-print-miscellany)
2181 (defcustom ps-line-number-step 1
2182 "*Specify the interval that line number is printed.
2184 For example, `ps-line-number-step' is set to 2, the printing will look like:
2186 1 one line
2187 one line
2188 3 one line
2189 one line
2190 5 one line
2191 one line
2194 Valid values are:
2196 integer an integer that specifies the interval that line number is
2197 printed. If it's lesser than or equal to zero, it's used the
2198 value 1.
2200 `zebra' specifies that only the line number of the first line in a
2201 zebra stripe is to be printed.
2203 Any other value is treated as `zebra'."
2204 :type '(choice :menu-tag "Line Number Step"
2205 :tag "Line Number Step"
2206 (integer :tag "Step Interval")
2207 (const :tag "Synchronize Zebra" zebra))
2208 :version "20"
2209 :group 'ps-print-miscellany)
2211 (defcustom ps-line-number-start 1
2212 "*Specify the starting point in the interval given by `ps-line-number-step'.
2214 For example, if `ps-line-number-step' is set to 3 and `ps-line-number-start' is
2215 set to 3, the printing will look like:
2217 one line
2218 one line
2219 3 one line
2220 one line
2221 one line
2222 6 one line
2223 one line
2224 one line
2225 9 one line
2226 one line
2229 The values for `ps-line-number-start':
2231 * If `ps-line-number-step' is an integer, must be between 1 and the value of
2232 `ps-line-number-step' inclusive.
2234 * If `ps-line-number-step' is set to `zebra', must be between 1 and the
2235 value of `ps-zebra-strip-height' inclusive. Use this combination if you
2236 wish that line number be relative to zebra stripes."
2237 :type '(integer :tag "Start Step Interval")
2238 :version "20"
2239 :group 'ps-print-miscellany)
2241 (defcustom ps-print-background-image nil
2242 "*EPS image list to be printed on background.
2244 The elements are:
2246 (FILENAME X Y XSCALE YSCALE ROTATION PAGES...)
2248 FILENAME is a file name which contains an EPS image or some PostScript
2249 programming like EPS.
2250 FILENAME is ignored, if it doesn't exist or is read protected.
2252 X and Y are relative positions on paper to put the image.
2253 If X and Y are nil, the image is centered on paper.
2255 XSCALE and YSCALE are scale factor to be applied to image before printing.
2256 If XSCALE and YSCALE are nil, the original size is used.
2258 ROTATION is the image rotation angle; if nil, the default is 0.
2260 PAGES designates the page to print background image.
2261 PAGES may be a number or a cons cell (FROM . TO) designating FROM page to TO
2262 page.
2263 If PAGES is nil, print background image on all pages.
2265 X, Y, XSCALE, YSCALE and ROTATION may be a floating point number, an integer
2266 number or a string. If it is a string, the string should contain PostScript
2267 programming that returns a float or integer value.
2269 For example, if you wish to print an EPS image on all pages do:
2271 '((\"~/images/EPS-image.ps\"))"
2272 :type '(repeat
2273 (list
2274 (file :tag "EPS File")
2275 (choice :tag "X" (const :tag "default" nil) number string)
2276 (choice :tag "Y" (const :tag "default" nil) number string)
2277 (choice :tag "X Scale" (const :tag "default" nil) number string)
2278 (choice :tag "Y Scale" (const :tag "default" nil) number string)
2279 (choice :tag "Rotation" (const :tag "default" nil) number string)
2280 (repeat :tag "Pages" :inline t
2281 (radio (integer :tag "Page")
2282 (cons :tag "Range"
2283 (integer :tag "From")
2284 (integer :tag "To"))))))
2285 :version "20"
2286 :group 'ps-print-background)
2288 (defcustom ps-print-background-text nil
2289 "*Text list to be printed on background.
2291 The elements are:
2293 (STRING X Y FONT FONTSIZE GRAY ROTATION PAGES...)
2295 STRING is the text to be printed on background.
2297 X and Y are positions on paper to put the text.
2298 If X and Y are nil, the text is positioned at lower left corner.
2300 FONT is a font name to be used on printing the text.
2301 If nil, \"Times-Roman\" is used.
2303 FONTSIZE is font size to be used, if nil, 200 is used.
2305 GRAY is the text gray factor (should be very light like 0.8).
2306 If nil, the default is 0.85.
2308 ROTATION is the text rotation angle; if nil, the angle is given by the diagonal
2309 from lower left corner to upper right corner.
2311 PAGES designates the page to print background text.
2312 PAGES may be a number or a cons cell (FROM . TO) designating FROM page to TO
2313 page.
2314 If PAGES is nil, print background text on all pages.
2316 X, Y, FONTSIZE, GRAY and ROTATION may be a floating point number, an integer
2317 number or a string. If it is a string, the string should contain PostScript
2318 programming that returns a float or integer value.
2320 For example, if you wish to print text \"Preliminary\" on all pages do:
2322 '((\"Preliminary\"))"
2323 :type '(repeat
2324 (list
2325 (string :tag "Text")
2326 (choice :tag "X" (const :tag "default" nil) number string)
2327 (choice :tag "Y" (const :tag "default" nil) number string)
2328 (choice :tag "Font" (const :tag "default" nil) string)
2329 (choice :tag "Fontsize" (const :tag "default" nil) number string)
2330 (choice :tag "Gray" (const :tag "default" nil) number string)
2331 (choice :tag "Rotation" (const :tag "default" nil) number string)
2332 (repeat :tag "Pages" :inline t
2333 (radio (integer :tag "Page")
2334 (cons :tag "Range"
2335 (integer :tag "From")
2336 (integer :tag "To"))))))
2337 :version "20"
2338 :group 'ps-print-background)
2340 ;;; Horizontal layout
2342 ;; ------------------------------------------
2343 ;; | | | | | | | |
2344 ;; | lm | text | ic | text | ic | text | rm |
2345 ;; | | | | | | | |
2346 ;; ------------------------------------------
2348 (defcustom ps-left-margin (/ (* 72 2.0) 2.54) ; 2 cm
2349 "*Left margin in points (1/72 inch)."
2350 :type 'number
2351 :version "20"
2352 :group 'ps-print-horizontal)
2354 (defcustom ps-right-margin (/ (* 72 2.0) 2.54) ; 2 cm
2355 "*Right margin in points (1/72 inch)."
2356 :type 'number
2357 :version "20"
2358 :group 'ps-print-horizontal)
2360 (defcustom ps-inter-column (/ (* 72 2.0) 2.54) ; 2 cm
2361 "*Horizontal space between columns in points (1/72 inch)."
2362 :type 'number
2363 :version "20"
2364 :group 'ps-print-horizontal)
2366 ;;; Vertical layout
2368 ;; |--------|
2369 ;; | tm |
2370 ;; |--------|
2371 ;; | header |
2372 ;; |--------|
2373 ;; | ho |
2374 ;; |--------|
2375 ;; | text |
2376 ;; |--------|
2377 ;; | bm |
2378 ;; |--------|
2380 (defcustom ps-bottom-margin (/ (* 72 1.5) 2.54) ; 1.5 cm
2381 "*Bottom margin in points (1/72 inch)."
2382 :type 'number
2383 :version "20"
2384 :group 'ps-print-vertical)
2386 (defcustom ps-top-margin (/ (* 72 1.5) 2.54) ; 1.5 cm
2387 "*Top margin in points (1/72 inch)."
2388 :type 'number
2389 :version "20"
2390 :group 'ps-print-vertical)
2392 (defcustom ps-header-offset (/ (* 72 1.0) 2.54) ; 1.0 cm
2393 "*Vertical space in points (1/72 inch) between the main text and the header."
2394 :type 'number
2395 :version "20"
2396 :group 'ps-print-vertical)
2398 (defcustom ps-header-line-pad 0.15
2399 "*Portion of a header title line height to insert.
2400 The insertion is done between the header frame and the text it contains,
2401 both in the vertical and horizontal directions."
2402 :type 'number
2403 :version "20"
2404 :group 'ps-print-vertical)
2406 (defcustom ps-footer-offset (/ (* 72 1.0) 2.54) ; 1.0 cm
2407 "*Vertical space in points (1/72 inch) between the main text and the footer."
2408 :type 'number
2409 :version "20"
2410 :group 'ps-print-vertical)
2412 (defcustom ps-footer-line-pad 0.15
2413 "*Portion of a footer title line height to insert.
2414 The insertion is done between the footer frame and the text it contains,
2415 both in the vertical and horizontal directions."
2416 :type 'number
2417 :version "20"
2418 :group 'ps-print-vertical)
2420 ;;; Header/Footer setup
2422 (defcustom ps-print-header t
2423 "*Non-nil means print a header at the top of each page.
2424 By default, the header displays the buffer name, page number, and, if the
2425 buffer is visiting a file, the file's directory. Headers are customizable by
2426 changing variables `ps-left-header' and `ps-right-header'."
2427 :type 'boolean
2428 :version "20"
2429 :group 'ps-print-headers)
2431 (defcustom ps-print-header-frame t
2432 "*Non-nil means draw a gaudy frame around the header."
2433 :type 'boolean
2434 :version "20"
2435 :group 'ps-print-headers)
2437 (defcustom ps-header-frame-alist
2438 '((fore-color . 0.0)
2439 (back-color . 0.9)
2440 (border-width . 0.4)
2441 (border-color . 0.0)
2442 (shadow-color . 0.0))
2443 "*Specify header frame properties alist.
2445 Valid frame properties are:
2447 `fore-color' Specify the foreground frame color.
2448 It should be a float number between 0.0 (black color)
2449 and 1.0 (white color), a string which is a color name,
2450 or a list of 3 float numbers which corresponds to the
2451 Red Green Blue color scale, each float number between
2452 0.0 (dark color) and 1.0 (bright color).
2454 `back-color' Specify the background frame color (similar to
2455 `fore-color').
2457 `shadow-color' Specify the shadow color (similar to `fore-color').
2459 `border-color' Specify the border color (similar to `fore-color').
2461 `border-width' Specify the border width.
2463 Any other property is ignored.
2465 Don't change this alist directly, instead use customization, or `ps-value',
2466 `ps-get', `ps-put' and `ps-del' functions (see them for documentation)."
2467 :version "21.1"
2468 :type '(repeat
2469 (choice :menu-tag "Header Frame Element"
2470 :tag ""
2471 (cons :tag "Foreground Color" :format "%v"
2472 (const :format "" fore-color)
2473 (choice :menu-tag "Foreground Color"
2474 :tag "Foreground Color"
2475 (number :tag "Gray Scale" :value 0.0)
2476 (string :tag "Color Name" :value "black")
2477 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2478 (number :tag "Red")
2479 (number :tag "Green")
2480 (number :tag "Blue"))))
2481 (cons :tag "Background Color" :format "%v"
2482 (const :format "" back-color)
2483 (choice :menu-tag "Background Color"
2484 :tag "Background Color"
2485 (number :tag "Gray Scale" :value 0.9)
2486 (string :tag "Color Name" :value "gray90")
2487 (list :tag "RGB Color" :value (0.9 0.9 0.9)
2488 (number :tag "Red")
2489 (number :tag "Green")
2490 (number :tag "Blue"))))
2491 (cons :tag "Border Width" :format "%v"
2492 (const :format "" border-width)
2493 (number :tag "Border Width" :value 0.4))
2494 (cons :tag "Border Color" :format "%v"
2495 (const :format "" border-color)
2496 (choice :menu-tag "Border Color"
2497 :tag "Border Color"
2498 (number :tag "Gray Scale" :value 0.0)
2499 (string :tag "Color Name" :value "black")
2500 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2501 (number :tag "Red")
2502 (number :tag "Green")
2503 (number :tag "Blue"))))
2504 (cons :tag "Shadow Color" :format "%v"
2505 (const :format "" shadow-color)
2506 (choice :menu-tag "Shadow Color"
2507 :tag "Shadow Color"
2508 (number :tag "Gray Scale" :value 0.0)
2509 (string :tag "Color Name" :value "black")
2510 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2511 (number :tag "Red")
2512 (number :tag "Green")
2513 (number :tag "Blue"))))))
2514 :version "20"
2515 :group 'ps-print-headers)
2517 (defcustom ps-header-lines 2
2518 "*Number of lines to display in page header, when generating PostScript."
2519 :type 'integer
2520 :version "20"
2521 :group 'ps-print-headers)
2523 (defcustom ps-print-footer nil
2524 "*Non-nil means print a footer at the bottom of each page.
2525 By default, the footer displays page number.
2526 Footers are customizable by changing variables `ps-left-footer' and
2527 `ps-right-footer'."
2528 :type 'boolean
2529 :version "21.1"
2530 :group 'ps-print-headers)
2532 (defcustom ps-print-footer-frame t
2533 "*Non-nil means draw a gaudy frame around the footer."
2534 :type 'boolean
2535 :version "21.1"
2536 :group 'ps-print-headers)
2538 (defcustom ps-footer-frame-alist
2539 '((fore-color . 0.0)
2540 (back-color . 0.9)
2541 (border-width . 0.4)
2542 (border-color . 0.0)
2543 (shadow-color . 0.0))
2544 "*Specify footer frame properties alist.
2546 Don't change this alist directly, instead use customization, or `ps-value',
2547 `ps-get', `ps-put' and `ps-del' functions (see them for documentation).
2549 See also `ps-header-frame-alist' for documentation."
2550 :type '(repeat
2551 (choice :menu-tag "Header Frame Element"
2552 :tag ""
2553 (cons :tag "Foreground Color" :format "%v"
2554 (const :format "" fore-color)
2555 (choice :menu-tag "Foreground Color"
2556 :tag "Foreground Color"
2557 (number :tag "Gray Scale" :value 0.0)
2558 (string :tag "Color Name" :value "black")
2559 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2560 (number :tag "Red")
2561 (number :tag "Green")
2562 (number :tag "Blue"))))
2563 (cons :tag "Background Color" :format "%v"
2564 (const :format "" back-color)
2565 (choice :menu-tag "Background Color"
2566 :tag "Background Color"
2567 (number :tag "Gray Scale" :value 0.9)
2568 (string :tag "Color Name" :value "gray90")
2569 (list :tag "RGB Color" :value (0.9 0.9 0.9)
2570 (number :tag "Red")
2571 (number :tag "Green")
2572 (number :tag "Blue"))))
2573 (cons :tag "Border Width" :format "%v"
2574 (const :format "" border-width)
2575 (number :tag "Border Width" :value 0.4))
2576 (cons :tag "Border Color" :format "%v"
2577 (const :format "" border-color)
2578 (choice :menu-tag "Border Color"
2579 :tag "Border Color"
2580 (number :tag "Gray Scale" :value 0.0)
2581 (string :tag "Color Name" :value "black")
2582 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2583 (number :tag "Red")
2584 (number :tag "Green")
2585 (number :tag "Blue"))))
2586 (cons :tag "Shadow Color" :format "%v"
2587 (const :format "" shadow-color)
2588 (choice :menu-tag "Shadow Color"
2589 :tag "Shadow Color"
2590 (number :tag "Gray Scale" :value 0.0)
2591 (string :tag "Color Name" :value "black")
2592 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2593 (number :tag "Red")
2594 (number :tag "Green")
2595 (number :tag "Blue"))))))
2596 :version "21.1"
2597 :group 'ps-print-headers)
2599 (defcustom ps-footer-lines 2
2600 "*Number of lines to display in page footer, when generating PostScript."
2601 :type 'integer
2602 :version "21.1"
2603 :group 'ps-print-headers)
2605 (defcustom ps-print-only-one-header nil
2606 "*Non-nil means print only one header/footer at the top/bottom of each page.
2607 This is useful when printing more than one column, so it is possible to have
2608 only one header/footer over all columns or one header/footer per column.
2609 See also `ps-print-header' and `ps-print-footer'."
2610 :type 'boolean
2611 :version "20"
2612 :group 'ps-print-headers)
2614 (defcustom ps-switch-header 'duplex
2615 "*Specify if headers/footers are switched or not.
2617 Valid values are:
2619 nil Never switch headers/footers.
2621 t Always switch headers/footers.
2623 duplex Switch headers/footers only when duplexing is on, that is, when
2624 `ps-spool-duplex' is non-nil.
2626 Any other value is treated as t.
2628 See also `ps-print-header' and `ps-print-footer'."
2629 :type '(choice :menu-tag "Switch Header/Footer"
2630 :tag "Switch Header/Footer"
2631 (const :tag "Never Switch" nil)
2632 (const :tag "Always Switch" t)
2633 (const :tag "Switch When Duplexing" duplex))
2634 :version "20"
2635 :group 'ps-print-headers)
2637 (defcustom ps-show-n-of-n t
2638 "*Non-nil means show page numbers as N/M, meaning page N of M.
2639 NOTE: page numbers are displayed as part of headers,
2640 see variable `ps-print-header'."
2641 :type 'boolean
2642 :version "20"
2643 :group 'ps-print-headers)
2645 (defcustom ps-spool-config
2646 (if ps-windows-system
2648 'lpr-switches)
2649 "*Specify who is responsible for setting duplex and page size.
2651 Valid values are:
2653 `lpr-switches' duplex and page size are configured by `ps-lpr-switches'.
2654 Don't forget to set `ps-lpr-switches' to select duplex
2655 printing for your printer.
2657 `setpagedevice' duplex and page size are configured by ps-print using the
2658 setpagedevice PostScript operator.
2660 nil duplex and page size are configured by ps-print *not* using
2661 the setpagedevice PostScript operator.
2663 Any other value is treated as nil.
2665 WARNING: The setpagedevice PostScript operator affects ghostview utility when
2666 viewing file generated using landscape. Also on some printers,
2667 setpagedevice affects zebra stripes; on other printers, setpagedevice
2668 affects the left margin.
2669 Besides all that, if your printer does not have the paper size
2670 specified by setpagedevice, your printing will be aborted.
2671 So, if you need to use setpagedevice, set `ps-spool-config' to
2672 `setpagedevice', generate a test file and send it to your printer; if
2673 the printed file isn't OK, set `ps-spool-config' to nil."
2674 :type '(choice :menu-tag "Spool Config"
2675 :tag "Spool Config"
2676 (const lpr-switches) (const setpagedevice)
2677 (const :tag "nil" nil))
2678 :version "20"
2679 :group 'ps-print-headers)
2681 (defcustom ps-spool-duplex nil ; Not many people have duplex printers,
2682 ; so default to nil.
2683 "*Non-nil generates PostScript for a two-sided printer.
2684 For a duplex printer, the `ps-spool-*' and `ps-print-*' commands will insert
2685 blank pages as needed between print jobs so that the next buffer printed will
2686 start on the right page. Also, if headers are turned on, the headers will be
2687 reversed on duplex printers so that the page numbers fall to the left on
2688 even-numbered pages.
2690 See also `ps-spool-tumble'."
2691 :type 'boolean
2692 :version "20"
2693 :group 'ps-print-headers)
2695 (defcustom ps-spool-tumble nil
2696 "*Specify how the page images on opposite sides of a sheet are oriented.
2697 If `ps-spool-tumble' is nil, produces output suitable for binding on the left
2698 or right. If `ps-spool-tumble' is non-nil, produces output suitable for
2699 binding at the top or bottom.
2701 It has effect only when `ps-spool-duplex' is non-nil."
2702 :type 'boolean
2703 :version "20"
2704 :group 'ps-print-headers)
2706 ;;; Fonts
2708 (defcustom ps-font-info-database
2709 '((Courier ; the family key
2710 (fonts (normal . "Courier")
2711 (bold . "Courier-Bold")
2712 (italic . "Courier-Oblique")
2713 (bold-italic . "Courier-BoldOblique"))
2714 (size . 10.0)
2715 (line-height . 10.55)
2716 (space-width . 6.0)
2717 (avg-char-width . 6.0))
2718 (Helvetica ; the family key
2719 (fonts (normal . "Helvetica")
2720 (bold . "Helvetica-Bold")
2721 (italic . "Helvetica-Oblique")
2722 (bold-italic . "Helvetica-BoldOblique"))
2723 (size . 10.0)
2724 (line-height . 11.56)
2725 (space-width . 2.78)
2726 (avg-char-width . 5.09243))
2727 (Times
2728 (fonts (normal . "Times-Roman")
2729 (bold . "Times-Bold")
2730 (italic . "Times-Italic")
2731 (bold-italic . "Times-BoldItalic"))
2732 (size . 10.0)
2733 (line-height . 11.0)
2734 (space-width . 2.5)
2735 (avg-char-width . 4.71432))
2736 (Palatino
2737 (fonts (normal . "Palatino-Roman")
2738 (bold . "Palatino-Bold")
2739 (italic . "Palatino-Italic")
2740 (bold-italic . "Palatino-BoldItalic"))
2741 (size . 10.0)
2742 (line-height . 12.1)
2743 (space-width . 2.5)
2744 (avg-char-width . 5.08676))
2745 (Helvetica-Narrow
2746 (fonts (normal . "Helvetica-Narrow")
2747 (bold . "Helvetica-Narrow-Bold")
2748 (italic . "Helvetica-Narrow-Oblique")
2749 (bold-italic . "Helvetica-Narrow-BoldOblique"))
2750 (size . 10.0)
2751 (line-height . 11.56)
2752 (space-width . 2.2796)
2753 (avg-char-width . 4.17579))
2754 (NewCenturySchlbk
2755 (fonts (normal . "NewCenturySchlbk-Roman")
2756 (bold . "NewCenturySchlbk-Bold")
2757 (italic . "NewCenturySchlbk-Italic")
2758 (bold-italic . "NewCenturySchlbk-BoldItalic"))
2759 (size . 10.0)
2760 (line-height . 12.15)
2761 (space-width . 2.78)
2762 (avg-char-width . 5.31162))
2763 ;; got no bold for the next ones
2764 (AvantGarde-Book
2765 (fonts (normal . "AvantGarde-Book")
2766 (italic . "AvantGarde-BookOblique"))
2767 (size . 10.0)
2768 (line-height . 11.77)
2769 (space-width . 2.77)
2770 (avg-char-width . 5.45189))
2771 (AvantGarde-Demi
2772 (fonts (normal . "AvantGarde-Demi")
2773 (italic . "AvantGarde-DemiOblique"))
2774 (size . 10.0)
2775 (line-height . 12.72)
2776 (space-width . 2.8)
2777 (avg-char-width . 5.51351))
2778 (Bookman-Demi
2779 (fonts (normal . "Bookman-Demi")
2780 (italic . "Bookman-DemiItalic"))
2781 (size . 10.0)
2782 (line-height . 11.77)
2783 (space-width . 3.4)
2784 (avg-char-width . 6.05946))
2785 (Bookman-Light
2786 (fonts (normal . "Bookman-Light")
2787 (italic . "Bookman-LightItalic"))
2788 (size . 10.0)
2789 (line-height . 11.79)
2790 (space-width . 3.2)
2791 (avg-char-width . 5.67027))
2792 ;; got no bold and no italic for the next ones
2793 (Symbol
2794 (fonts (normal . "Symbol"))
2795 (size . 10.0)
2796 (line-height . 13.03)
2797 (space-width . 2.5)
2798 (avg-char-width . 3.24324))
2799 (Zapf-Dingbats
2800 (fonts (normal . "Zapf-Dingbats"))
2801 (size . 10.0)
2802 (line-height . 9.63)
2803 (space-width . 2.78)
2804 (avg-char-width . 2.78))
2805 (ZapfChancery-MediumItalic
2806 (fonts (normal . "ZapfChancery-MediumItalic"))
2807 (size . 10.0)
2808 (line-height . 11.45)
2809 (space-width . 2.2)
2810 (avg-char-width . 4.10811))
2811 ;; We keep this wrong entry name (but with correct font name) for
2812 ;; backward compatibility.
2813 (Zapf-Chancery-MediumItalic
2814 (fonts (normal . "ZapfChancery-MediumItalic"))
2815 (size . 10.0)
2816 (line-height . 11.45)
2817 (space-width . 2.2)
2818 (avg-char-width . 4.10811))
2820 "*Font info database.
2821 Each element comprises: font family (the key), name, bold, italic, bold-italic,
2822 reference size, line height, space width, average character width.
2823 To get the info for another specific font (say Helvetica), do the following:
2824 - create a new buffer
2825 - generate the PostScript image to a file (C-u M-x ps-print-buffer)
2826 - open this file and delete the leading `%' (which is the PostScript comment
2827 character) from the line
2828 `% 3 cm 20 cm moveto 10/Courier ReportFontInfo showpage'
2829 to get the line
2830 `3 cm 20 cm moveto 10/Helvetica ReportFontInfo showpage'
2831 - add the values to `ps-font-info-database'.
2832 You can get all the fonts of YOUR printer using `ReportAllFontInfo'.
2834 Note also that ps-print DOESN'T download any font to your printer, instead it
2835 uses the fonts resident in your printer."
2836 :type '(repeat
2837 (list :tag "Font Definition"
2838 (symbol :tag "Font Family")
2839 (cons :format "%v"
2840 (const :format "" fonts)
2841 (repeat :tag "Faces"
2842 (cons (choice :menu-tag "Font Weight/Slant"
2843 :tag "Font Weight/Slant"
2844 (const normal)
2845 (const bold)
2846 (const italic)
2847 (const bold-italic)
2848 (symbol :tag "Face"))
2849 (string :tag "Font Name"))))
2850 (cons :format "%v"
2851 (const :format "" size)
2852 (number :tag "Reference Size"))
2853 (cons :format "%v"
2854 (const :format "" line-height)
2855 (number :tag "Line Height"))
2856 (cons :format "%v"
2857 (const :format "" space-width)
2858 (number :tag "Space Width"))
2859 (cons :format "%v"
2860 (const :format "" avg-char-width)
2861 (number :tag "Average Character Width"))))
2862 :version "20"
2863 :group 'ps-print-font)
2865 (defcustom ps-font-family 'Courier
2866 "*Font family name for ordinary text, when generating PostScript."
2867 :type 'symbol
2868 :version "20"
2869 :group 'ps-print-font)
2871 (defcustom ps-font-size '(7 . 8.5)
2872 "*Font size, in points, for ordinary text, when generating PostScript.
2873 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
2874 :type '(choice :menu-tag "Ordinary Text Font Size"
2875 :tag "Ordinary Text Font Size"
2876 (number :tag "Text Size")
2877 (cons :tag "Landscape/Portrait"
2878 (number :tag "Landscape Text Size")
2879 (number :tag "Portrait Text Size")))
2880 :version "20"
2881 :group 'ps-print-font)
2883 (defcustom ps-header-font-family 'Helvetica
2884 "*Font family name for text in the header, when generating PostScript."
2885 :type 'symbol
2886 :version "20"
2887 :group 'ps-print-font)
2889 (defcustom ps-header-font-size '(10 . 12)
2890 "*Font size, in points, for text in the header, when generating PostScript.
2891 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
2892 :type '(choice :menu-tag "Header Font Size"
2893 :tag "Header Font Size"
2894 (number :tag "Header Size")
2895 (cons :tag "Landscape/Portrait"
2896 (number :tag "Landscape Header Size")
2897 (number :tag "Portrait Header Size")))
2898 :version "20"
2899 :group 'ps-print-font)
2901 (defcustom ps-header-title-font-size '(12 . 14)
2902 "*Font size, in points, for the top line of text in header, in PostScript.
2903 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
2904 :type '(choice :menu-tag "Header Title Font Size"
2905 :tag "Header Title Font Size"
2906 (number :tag "Header Title Size")
2907 (cons :tag "Landscape/Portrait"
2908 (number :tag "Landscape Header Title Size")
2909 (number :tag "Portrait Header Title Size")))
2910 :version "20"
2911 :group 'ps-print-font)
2913 (defcustom ps-footer-font-family 'Helvetica
2914 "*Font family name for text in the footer, when generating PostScript."
2915 :type 'symbol
2916 :version "21.1"
2917 :group 'ps-print-font)
2919 (defcustom ps-footer-font-size '(10 . 12)
2920 "*Font size, in points, for text in the footer, when generating PostScript.
2921 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
2922 :type '(choice :menu-tag "Footer Font Size"
2923 :tag "Footer Font Size"
2924 (number :tag "Footer Size")
2925 (cons :tag "Landscape/Portrait"
2926 (number :tag "Landscape Footer Size")
2927 (number :tag "Portrait Footer Size")))
2928 :version "21.1"
2929 :group 'ps-print-font)
2931 (defcustom ps-line-number-color "black"
2932 "*Specify color for line-number, when generating PostScript."
2933 :type '(choice :menu-tag "Line Number Color"
2934 :tag "Line Number Color"
2935 (number :tag "Gray Scale" :value 0)
2936 (string :tag "Color Name" :value "black")
2937 (list :tag "RGB Color" :value (0 0 0)
2938 (number :tag "Red")
2939 (number :tag "Green")
2940 (number :tag "Blue")))
2941 :version "21.1"
2942 :group 'ps-print-font
2943 :group 'ps-print-miscellany)
2945 (defcustom ps-line-number-font "Times-Italic"
2946 "*Font for line-number, when generating PostScript."
2947 :type 'string
2948 :version "20"
2949 :group 'ps-print-font
2950 :group 'ps-print-miscellany)
2952 (defcustom ps-line-number-font-size 6
2953 "*Font size, in points, for line number, when generating PostScript.
2954 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
2955 :type '(choice :menu-tag "Line Number Font Size"
2956 :tag "Line Number Font Size"
2957 (number :tag "Font Size")
2958 (cons :tag "Landscape/Portrait"
2959 (number :tag "Landscape Font Size")
2960 (number :tag "Portrait Font Size")))
2961 :version "20"
2962 :group 'ps-print-font
2963 :group 'ps-print-miscellany)
2965 ;;; Colors
2967 ;; Printing color requires x-color-values.
2968 ;; XEmacs change: Need autoload for the "Options->Printing->Color Printing"
2969 ;; widget to work.
2970 ;;;###autoload
2971 (defcustom ps-print-color-p
2972 (or (fboundp 'x-color-values) ; Emacs
2973 (fboundp 'color-instance-rgb-components))
2974 ; XEmacs
2975 "*Specify how buffer's text color is printed.
2977 Valid values are:
2979 nil Do not print colors.
2981 t Print colors.
2983 black-white Print colors on black/white printer.
2984 See also `ps-black-white-faces'.
2986 Any other value is treated as t."
2987 :type '(choice :menu-tag "Print Color"
2988 :tag "Print Color"
2989 (const :tag "Do NOT Print Color" nil)
2990 (const :tag "Print Always Color" t)
2991 (const :tag "Print Black/White Color" black-white))
2992 :version "20"
2993 :group 'ps-print-color)
2995 (defcustom ps-default-fg nil
2996 "*RGB values of the default foreground color.
2998 The `ps-default-fg' variable contains the default foreground color used by
2999 ps-print, that is, if there is a face in a text that doesn't have a foreground
3000 color, the `ps-default-fg' color should be used.
3002 Valid values are:
3004 t The foreground color of Emacs session will be used.
3006 frame-parameter The foreground-color frame parameter will be used.
3008 NUMBER It's a real value between 0.0 (black) and 1.0 (white) that
3009 indicate the gray color.
3011 COLOR-NAME It's a string which contains the color name. For example:
3012 \"yellow\".
3014 LIST It's a list of RGB values, that is a list of three real values
3015 of the form:
3017 (RED, GREEN, BLUE)
3019 Where RED, GREEN and BLUE are reals between 0.0 (no color) and
3020 1.0 (full color).
3022 Any other value is ignored and black color will be used.
3024 This variable is used only when `ps-print-color-p' (which see) is neither nil
3025 nor black-white."
3026 :type '(choice :menu-tag "Default Foreground Gray/Color"
3027 :tag "Default Foreground Gray/Color"
3028 (const :tag "Session Foreground" t)
3029 (const :tag "Frame Foreground" frame-parameter)
3030 (number :tag "Gray Scale" :value 0.0)
3031 (string :tag "Color Name" :value "black")
3032 (list :tag "RGB Color" :value (0.0 0.0 0.0)
3033 (number :tag "Red")
3034 (number :tag "Green")
3035 (number :tag "Blue")))
3036 :version "20"
3037 :group 'ps-print-color)
3039 (defcustom ps-default-bg nil
3040 "*RGB values of the default background color.
3042 The `ps-default-bg' variable contains the default background color used by
3043 ps-print, that is, if there is a face in a text that doesn't have a background
3044 color, the `ps-default-bg' color should be used.
3046 Valid values are:
3048 t The background color of Emacs session will be used.
3050 frame-parameter The background-color frame parameter will be used.
3052 NUMBER It's a real value between 0.0 (black) and 1.0 (white) that
3053 indicate the gray color.
3055 COLOR-NAME It's a string which contains the color name. For example:
3056 \"yellow\".
3058 LIST It's a list of RGB values, that is a list of three real values
3059 of the form:
3061 (RED, GREEN, BLUE)
3063 Where RED, GREEN and BLUE are reals between 0.0 (no color) and
3064 1.0 (full color).
3066 Any other value is ignored and white color will be used.
3068 This variable is used only when `ps-print-color-p' (which see) is neither nil
3069 nor black-white.
3071 See also `ps-use-face-background'."
3072 :type '(choice :menu-tag "Default Background Gray/Color"
3073 :tag "Default Background Gray/Color"
3074 (const :tag "Session Background" t)
3075 (const :tag "Frame Background" frame-parameter)
3076 (number :tag "Gray Scale" :value 1.0)
3077 (string :tag "Color Name" :value "white")
3078 (list :tag "RGB Color" :value (1.0 1.0 1.0)
3079 (number :tag "Red")
3080 (number :tag "Green")
3081 (number :tag "Blue")))
3082 :version "20"
3083 :group 'ps-print-color)
3085 (defcustom ps-auto-font-detect t
3086 "*Non-nil means automatically detect bold/italic/underline face attributes.
3087 If nil, we rely solely on the lists `ps-bold-faces', `ps-italic-faces', and
3088 `ps-underlined-faces'."
3089 :type 'boolean
3090 :version "20"
3091 :group 'ps-print-font)
3093 (defcustom ps-black-white-faces
3094 '((font-lock-builtin-face "black" nil bold )
3095 (font-lock-comment-face "gray20" nil italic)
3096 (font-lock-constant-face "black" nil bold )
3097 (font-lock-function-name-face "black" nil bold )
3098 (font-lock-keyword-face "black" nil bold )
3099 (font-lock-string-face "black" nil italic)
3100 (font-lock-type-face "black" nil italic)
3101 (font-lock-variable-name-face "black" nil bold italic)
3102 (font-lock-warning-face "black" nil bold italic))
3103 "*Specify list of face attributes to print colors on black/white printers.
3105 The list elements are the same as defined on `ps-extend-face' (which see).
3107 This variable is used only when `ps-print-color-p' is set to `black-white'."
3108 :version "21.1"
3109 :type '(repeat
3110 (list :tag "Face Specification"
3111 (face :tag "Face Symbol")
3112 (choice :menu-tag "Foreground Color"
3113 :tag "Foreground Color"
3114 (const :tag "Black" nil)
3115 (string :tag "Color Name"))
3116 (choice :menu-tag "Background Color"
3117 :tag "Background Color"
3118 (const :tag "None" nil)
3119 (string :tag "Color Name"))
3120 (repeat :inline t
3121 (choice :menu-tag "Attribute"
3122 (const bold)
3123 (const italic)
3124 (const underline)
3125 (const strikeout)
3126 (const overline)
3127 (const shadow)
3128 (const box)
3129 (const outline)))))
3130 :version "20"
3131 :group 'ps-print-face)
3133 (defcustom ps-bold-faces
3134 (unless ps-print-color-p
3135 '(font-lock-function-name-face
3136 font-lock-builtin-face
3137 font-lock-variable-name-face
3138 font-lock-keyword-face
3139 font-lock-warning-face))
3140 "*A list of the \(non-bold\) faces that should be printed in bold font.
3141 This applies to generating PostScript."
3142 :type '(repeat face)
3143 :version "20"
3144 :group 'ps-print-face)
3146 (defcustom ps-italic-faces
3147 (unless ps-print-color-p
3148 '(font-lock-variable-name-face
3149 font-lock-type-face
3150 font-lock-string-face
3151 font-lock-comment-face
3152 font-lock-warning-face))
3153 "*A list of the \(non-italic\) faces that should be printed in italic font.
3154 This applies to generating PostScript."
3155 :type '(repeat face)
3156 :version "20"
3157 :group 'ps-print-face)
3159 (defcustom ps-underlined-faces
3160 (unless ps-print-color-p
3161 '(font-lock-function-name-face
3162 font-lock-constant-face
3163 font-lock-warning-face))
3164 "*A list of the \(non-underlined\) faces that should be printed underlined.
3165 This applies to generating PostScript."
3166 :type '(repeat face)
3167 :version "20"
3168 :group 'ps-print-face)
3170 (defcustom ps-use-face-background nil
3171 "*Specify if face background should be used.
3173 Valid values are:
3175 t always use face background color.
3176 nil never use face background color.
3177 (face...) list of faces whose background color will be used.
3179 Any other value will be treated as t."
3180 :type '(choice :menu-tag "Use Face Background"
3181 :tag "Use Face Background"
3182 (const :tag "Always Use Face Background" t)
3183 (const :tag "Never Use Face Background" nil)
3184 (repeat :menu-tag "Face Background List"
3185 :tag "Face Background List"
3186 face))
3187 :version "20"
3188 :group 'ps-print-face)
3190 (defcustom ps-left-header
3191 (list 'ps-get-buffer-name 'ps-header-dirpart)
3192 "*The items to display (each on a line) on the left part of the page header.
3193 This applies to generating PostScript.
3195 The value should be a list of strings and symbols, each representing an entry
3196 in the PostScript array HeaderLinesLeft.
3198 Strings are inserted unchanged into the array; those representing
3199 PostScript string literals should be delimited with PostScript string
3200 delimiters '(' and ')'.
3202 For symbols with bound functions, the function is called and should return a
3203 string to be inserted into the array. For symbols with bound values, the value
3204 should be a string to be inserted into the array. In either case, function or
3205 variable, the string value has PostScript string delimiters added to it.
3207 If symbols are unbounded, they are silently ignored."
3208 :type '(repeat (choice :menu-tag "Left Header"
3209 :tag "Left Header"
3210 string symbol))
3211 :version "20"
3212 :group 'ps-print-headers)
3214 (defcustom ps-right-header
3215 (list "/pagenumberstring load"
3216 'ps-time-stamp-locale-default 'ps-time-stamp-hh:mm:ss)
3217 "*The items to display (each on a line) on the right part of the page header.
3218 This applies to generating PostScript.
3220 See the variable `ps-left-header' for a description of the format of this
3221 variable.
3223 There are the following basic functions implemented:
3225 `ps-time-stamp-locale-default' Return the locale's \"preferred\" date
3226 as, for example, \"06/18/01\".
3228 `ps-time-stamp-hh:mm:ss' Return time as \"17:28:31\".
3230 `ps-time-stamp-mon-dd-yyyy' Return date as \"Jun 18 2001\".
3232 `ps-time-stamp-yyyy-mm-dd' Return date as \"2001-06-18\" (ISO
3233 date).
3235 `ps-time-stamp-iso8601' Alias for `ps-time-stamp-yyyy-mm-dd'.
3237 You can also create your own time stamp function by using `format-time-string'
3238 \(which see)."
3239 :type '(repeat (choice :menu-tag "Right Header"
3240 :tag "Right Header"
3241 string symbol))
3242 :version "20"
3243 :group 'ps-print-headers)
3245 (defcustom ps-left-footer
3246 (list 'ps-get-buffer-name 'ps-header-dirpart)
3247 "*The items to display (each on a line) on the left part of the page footer.
3248 This applies to generating PostScript.
3250 The value should be a list of strings and symbols, each representing an entry
3251 in the PostScript array FooterLinesLeft.
3253 Strings are inserted unchanged into the array; those representing PostScript
3254 string literals should be delimited with PostScript string delimiters '(' and
3255 ')'.
3257 For symbols with bound functions, the function is called and should return a
3258 string to be inserted into the array. For symbols with bound values, the value
3259 should be a string to be inserted into the array. In either case, function or
3260 variable, the string value has PostScript string delimiters added to it.
3262 If symbols are unbounded, they are silently ignored."
3263 :type '(repeat (choice :menu-tag "Left Footer"
3264 :tag "Left Footer"
3265 string symbol))
3266 :version "21.1"
3267 :group 'ps-print-headers)
3269 (defcustom ps-right-footer
3270 (list "/pagenumberstring load"
3271 'ps-time-stamp-locale-default 'ps-time-stamp-hh:mm:ss)
3272 "*The items to display (each on a line) on the right part of the page footer.
3273 This applies to generating PostScript.
3275 See the variable `ps-left-footer' for a description of the format of this
3276 variable.
3278 There are the following basic functions implemented:
3280 `ps-time-stamp-locale-default' Return the locale's \"preferred\" date
3281 as, for example, \"06/18/01\".
3283 `ps-time-stamp-hh:mm:ss' Return time as \"17:28:31\".
3285 `ps-time-stamp-mon-dd-yyyy' Return date as \"Jun 18 2001\".
3287 `ps-time-stamp-yyyy-mm-dd' Return date as \"2001-06-18\" (ISO
3288 date).
3290 `ps-time-stamp-iso8601' Alias for `ps-time-stamp-yyyy-mm-dd'.
3292 You can also create your own time stamp function by using `format-time-string'
3293 \(which see)."
3294 :type '(repeat (choice :menu-tag "Right Footer"
3295 :tag "Right Footer"
3296 string symbol))
3297 :version "21.1"
3298 :group 'ps-print-headers)
3300 (defcustom ps-razzle-dazzle t
3301 "*Non-nil means report progress while formatting buffer."
3302 :type 'boolean
3303 :version "20"
3304 :group 'ps-print-miscellany)
3306 (defcustom ps-adobe-tag "%!PS-Adobe-3.0\n"
3307 "*Contains the header line identifying the output as PostScript.
3308 By default, `ps-adobe-tag' contains the standard identifier. Some printers
3309 require slightly different versions of this line."
3310 :type 'string
3311 :version "20"
3312 :group 'ps-print-miscellany)
3314 (defcustom ps-build-face-reference t
3315 "*Non-nil means build the reference face lists.
3317 ps-print sets this value to nil after it builds its internal reference lists of
3318 bold and italic faces. By setting its value back to t, you can force ps-print
3319 to rebuild the lists the next time you invoke one of the ...-with-faces
3320 commands.
3322 You should set this value back to t after you change the attributes of any
3323 face, or create new faces. Most users shouldn't have to worry about its
3324 setting, though."
3325 :type 'boolean
3326 :version "20"
3327 :group 'ps-print-face)
3329 (defcustom ps-always-build-face-reference nil
3330 "*Non-nil means always rebuild the reference face lists.
3332 If this variable is non-nil, ps-print will rebuild its internal reference lists
3333 of bold and italic faces *every* time one of the ...-with-faces commands is
3334 called. Most users shouldn't need to set this variable."
3335 :type 'boolean
3336 :version "20"
3337 :group 'ps-print-face)
3339 (defcustom ps-banner-page-when-duplexing nil
3340 "*Non-nil means the very first page is skipped.
3341 It's like the very first character of buffer (or region) is ^L (\\014)."
3342 :type 'boolean
3343 :version "20"
3344 :group 'ps-print-headers)
3346 (defcustom ps-postscript-code-directory
3347 (or (if (featurep 'xemacs)
3348 (cond ((fboundp 'locate-data-directory) ; XEmacs
3349 (locate-data-directory "ps-print"))
3350 ((boundp 'data-directory) ; XEmacs
3351 data-directory)
3352 (t ; don't know what to do
3353 nil))
3354 data-directory) ; Emacs
3355 (error "`ps-postscript-code-directory' isn't set properly"))
3356 "*Directory where it's located the PostScript prologue file used by ps-print.
3357 By default, this directory is the same as in the variable `data-directory'."
3358 :type 'directory
3359 :version "20"
3360 :group 'ps-print-miscellany)
3362 (defcustom ps-line-spacing 0
3363 "*Specify line spacing, in points, for ordinary text.
3365 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE).
3367 See also `ps-paragraph-spacing' and `ps-paragraph-regexp'.
3369 To get all lines with some spacing set both `ps-line-spacing' and
3370 `ps-paragraph-spacing' variables."
3371 :type '(choice :menu-tag "Line Spacing For Ordinary Text"
3372 :tag "Line Spacing For Ordinary Text"
3373 (number :tag "Line Spacing")
3374 (cons :tag "Landscape/Portrait"
3375 (number :tag "Landscape Line Spacing")
3376 (number :tag "Portrait Line Spacing")))
3377 :version "21.1"
3378 :group 'ps-print-miscellany)
3380 (defcustom ps-paragraph-spacing 0
3381 "*Specify paragraph spacing, in points, for ordinary text.
3383 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE).
3385 See also `ps-line-spacing' and `ps-paragraph-regexp'.
3387 To get all lines with some spacing set both `ps-line-spacing' and
3388 `ps-paragraph-spacing' variables."
3389 :type '(choice :menu-tag "Paragraph Spacing For Ordinary Text"
3390 :tag "Paragraph Spacing For Ordinary Text"
3391 (number :tag "Paragraph Spacing")
3392 (cons :tag "Landscape/Portrait"
3393 (number :tag "Landscape Paragraph Spacing")
3394 (number :tag "Portrait Paragraph Spacing")))
3395 :version "21.1"
3396 :group 'ps-print-miscellany)
3398 (defcustom ps-paragraph-regexp "[ \t]*$"
3399 "*Specify paragraph delimiter.
3401 It should be a regexp or nil.
3403 See also `ps-paragraph-spacing'."
3404 :type '(choice :menu-tag "Paragraph Delimiter"
3405 (const :tag "No Delimiter" nil)
3406 (regexp :tag "Delimiter Regexp"))
3407 :version "21.1"
3408 :group 'ps-print-miscellany)
3410 (defcustom ps-begin-cut-regexp nil
3411 "*Specify regexp which is start of a region to cut out when printing.
3413 As an example, variables `ps-begin-cut-regexp' and `ps-end-cut-regexp' may be
3414 set to \"^Local Variables:\" and \"^End:\", respectively, in order to leave out
3415 some special printing instructions from the actual print. Special printing
3416 instructions may be appended to the end of the file just like any other
3417 buffer-local variables. See section \"Local Variables in Files\" on Emacs
3418 manual for more information.
3420 Variables `ps-begin-cut-regexp' and `ps-end-cut-regexp' control together what
3421 actually gets printed. Both variables may be set to nil in which case no
3422 cutting occurs."
3423 :type '(choice (const :tag "No Delimiter" nil)
3424 (regexp :tag "Delimiter Regexp"))
3425 :version "21.1"
3426 :group 'ps-print-miscellany)
3428 (defcustom ps-end-cut-regexp nil
3429 "*Specify regexp which is end of the region to cut out when printing.
3431 See `ps-begin-cut-regexp' for more information."
3432 :type '(choice (const :tag "No Delimiter" nil)
3433 (regexp :tag "Delimiter Regexp"))
3434 :version "21.1"
3435 :group 'ps-print-miscellany)
3438 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3439 ;; Selected Pages
3442 (defvar ps-last-selected-pages nil
3443 "Latest `ps-selected-pages' value.")
3446 (defun ps-restore-selected-pages ()
3447 "Restore latest `ps-selected-pages' value."
3448 (interactive)
3449 (setq ps-selected-pages ps-last-selected-pages))
3452 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3453 ;; Customization
3456 ;;;###autoload
3457 (defun ps-print-customize ()
3458 "Customization of ps-print group."
3459 (interactive)
3460 (customize-group 'ps-print))
3463 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3464 ;; User commands
3467 ;;;###autoload
3468 (defun ps-print-buffer (&optional filename)
3469 "Generate and print a PostScript image of the buffer.
3471 Interactively, when you use a prefix argument (\\[universal-argument]), the command prompts the
3472 user for a file name, and saves the PostScript image in that file instead of
3473 sending it to the printer.
3475 Noninteractively, the argument FILENAME is treated as follows: if it is nil,
3476 send the image to the printer. If FILENAME is a string, save the PostScript
3477 image in a file with that name."
3478 (interactive (list (ps-print-preprint current-prefix-arg)))
3479 (ps-print-without-faces (point-min) (point-max) filename))
3482 ;;;###autoload
3483 (defun ps-print-buffer-with-faces (&optional filename)
3484 "Generate and print a PostScript image of the buffer.
3485 Like `ps-print-buffer', but includes font, color, and underline information in
3486 the generated image. This command works only if you are using a window system,
3487 so it has a way to determine color values."
3488 (interactive (list (ps-print-preprint current-prefix-arg)))
3489 (ps-print-with-faces (point-min) (point-max) filename))
3492 ;;;###autoload
3493 (defun ps-print-region (from to &optional filename)
3494 "Generate and print a PostScript image of the region.
3495 Like `ps-print-buffer', but prints just the current region."
3496 (interactive (ps-print-preprint-region current-prefix-arg))
3497 (ps-print-without-faces from to filename t))
3500 ;;;###autoload
3501 (defun ps-print-region-with-faces (from to &optional filename)
3502 "Generate and print a PostScript image of the region.
3503 Like `ps-print-region', but includes font, color, and underline information in
3504 the generated image. This command works only if you are using a window system,
3505 so it has a way to determine color values."
3506 (interactive (ps-print-preprint-region current-prefix-arg))
3507 (ps-print-with-faces from to filename t))
3510 ;;;###autoload
3511 (defun ps-spool-buffer ()
3512 "Generate and spool a PostScript image of the buffer.
3513 Like `ps-print-buffer' except that the PostScript image is saved in a local
3514 buffer to be sent to the printer later.
3516 Use the command `ps-despool' to send the spooled images to the printer."
3517 (interactive)
3518 (ps-spool-without-faces (point-min) (point-max)))
3521 ;;;###autoload
3522 (defun ps-spool-buffer-with-faces ()
3523 "Generate and spool a PostScript image of the buffer.
3524 Like `ps-spool-buffer', but includes font, color, and underline information in
3525 the generated image. This command works only if you are using a window system,
3526 so it has a way to determine color values.
3528 Use the command `ps-despool' to send the spooled images to the printer."
3529 (interactive)
3530 (ps-spool-with-faces (point-min) (point-max)))
3533 ;;;###autoload
3534 (defun ps-spool-region (from to)
3535 "Generate a PostScript image of the region and spool locally.
3536 Like `ps-spool-buffer', but spools just the current region.
3538 Use the command `ps-despool' to send the spooled images to the printer."
3539 (interactive "r")
3540 (ps-spool-without-faces from to t))
3543 ;;;###autoload
3544 (defun ps-spool-region-with-faces (from to)
3545 "Generate a PostScript image of the region and spool locally.
3546 Like `ps-spool-region', but includes font, color, and underline information in
3547 the generated image. This command works only if you are using a window system,
3548 so it has a way to determine color values.
3550 Use the command `ps-despool' to send the spooled images to the printer."
3551 (interactive "r")
3552 (ps-spool-with-faces from to t))
3554 ;;;###autoload
3555 (defun ps-despool (&optional filename)
3556 "Send the spooled PostScript to the printer.
3558 Interactively, when you use a prefix argument (\\[universal-argument]), the command prompts the
3559 user for a file name, and saves the spooled PostScript image in that file
3560 instead of sending it to the printer.
3562 Noninteractively, the argument FILENAME is treated as follows: if it is nil,
3563 send the image to the printer. If FILENAME is a string, save the PostScript
3564 image in a file with that name."
3565 (interactive (list (ps-print-preprint current-prefix-arg)))
3566 (ps-do-despool filename))
3568 ;;;###autoload
3569 (defun ps-line-lengths ()
3570 "Display the correspondence between a line length and a font size.
3571 Done using the current ps-print setup.
3572 Try: pr -t file | awk '{printf \"%3d %s\n\", length($0), $0}' | sort -r | head"
3573 (interactive)
3574 (ps-line-lengths-internal))
3576 ;;;###autoload
3577 (defun ps-nb-pages-buffer (nb-lines)
3578 "Display number of pages to print this buffer, for various font heights.
3579 The table depends on the current ps-print setup."
3580 (interactive (ps-count-lines-preprint (point-min) (point-max)))
3581 (ps-nb-pages nb-lines))
3583 ;;;###autoload
3584 (defun ps-nb-pages-region (nb-lines)
3585 "Display number of pages to print the region, for various font heights.
3586 The table depends on the current ps-print setup."
3587 (interactive (ps-count-lines-preprint (mark) (point)))
3588 (ps-nb-pages nb-lines))
3590 (defvar ps-prefix-quote nil
3591 "Used for `ps-print-quote' (which see).")
3593 ;;;###autoload
3594 (defun ps-setup ()
3595 "Return the current PostScript-generation setup."
3596 (let (ps-prefix-quote)
3597 (mapconcat
3598 #'ps-print-quote
3599 (list
3600 (concat "\n;;; (" (if (featurep 'xemacs) "XEmacs" "Emacs")
3601 ") ps-print version " ps-print-version "\n")
3602 ";; internal vars"
3603 (ps-comment-string "emacs-version " emacs-version)
3604 (ps-comment-string "ps-windows-system " ps-windows-system)
3605 (ps-comment-string "ps-lp-system " ps-lp-system)
3607 '(25 . ps-print-color-p)
3608 '(25 . ps-lpr-command)
3609 '(25 . ps-lpr-switches)
3610 '(25 . ps-printer-name)
3611 '(25 . ps-printer-name-option)
3612 '(25 . ps-print-region-function)
3613 '(25 . ps-manual-feed)
3614 '(25 . ps-end-with-control-d)
3616 '(23 . ps-paper-type)
3617 '(23 . ps-warn-paper-type)
3618 '(23 . ps-landscape-mode)
3619 '(23 . ps-print-upside-down)
3620 '(23 . ps-number-of-columns)
3622 '(23 . ps-zebra-stripes)
3623 '(23 . ps-zebra-stripe-height)
3624 '(23 . ps-zebra-stripe-follow)
3625 '(23 . ps-zebra-color)
3626 '(23 . ps-line-number)
3627 '(23 . ps-line-number-step)
3628 '(23 . ps-line-number-start)
3630 '(17 . ps-default-fg)
3631 '(17 . ps-default-bg)
3632 '(17 . ps-razzle-dazzle)
3634 '(23 . ps-use-face-background)
3636 '(28 . ps-print-control-characters)
3638 '(26 . ps-print-background-image)
3640 '(25 . ps-print-background-text)
3642 '(29 . ps-error-handler-message)
3643 '(29 . ps-user-defined-prologue)
3644 '(29 . ps-print-prologue-header)
3645 '(29 . ps-postscript-code-directory)
3646 '(29 . ps-adobe-tag)
3648 '(30 . ps-left-margin)
3649 '(30 . ps-right-margin)
3650 '(30 . ps-inter-column)
3651 '(30 . ps-bottom-margin)
3652 '(30 . ps-top-margin)
3653 '(30 . ps-print-only-one-header)
3654 '(30 . ps-switch-header)
3655 '(30 . ps-print-header)
3656 '(30 . ps-header-lines)
3657 '(30 . ps-header-offset)
3658 '(30 . ps-header-line-pad)
3659 '(30 . ps-print-header-frame)
3660 '(30 . ps-header-frame-alist)
3661 '(30 . ps-print-footer)
3662 '(30 . ps-footer-lines)
3663 '(30 . ps-footer-offset)
3664 '(30 . ps-footer-line-pad)
3665 '(30 . ps-print-footer-frame)
3666 '(30 . ps-footer-frame-alist)
3667 '(30 . ps-show-n-of-n)
3668 '(30 . ps-spool-config)
3669 '(30 . ps-spool-duplex)
3670 '(30 . ps-spool-tumble)
3671 '(30 . ps-banner-page-when-duplexing)
3672 '(30 . ps-left-header)
3673 '(30 . ps-right-header)
3674 '(30 . ps-left-footer)
3675 '(30 . ps-right-footer)
3677 '(23 . ps-n-up-printing)
3678 '(23 . ps-n-up-margin)
3679 '(23 . ps-n-up-border-p)
3680 '(23 . ps-n-up-filling)
3682 '(26 . ps-multibyte-buffer)
3683 '(26 . ps-font-family)
3684 '(26 . ps-font-size)
3685 '(26 . ps-header-font-family)
3686 '(26 . ps-header-font-size)
3687 '(26 . ps-header-title-font-size)
3688 '(26 . ps-footer-font-family)
3689 '(26 . ps-footer-font-size)
3690 '(26 . ps-line-number-color)
3691 '(26 . ps-line-number-font)
3692 '(26 . ps-line-number-font-size)
3693 '(26 . ps-line-spacing)
3694 '(26 . ps-paragraph-spacing)
3695 '(26 . ps-paragraph-regexp)
3696 '(26 . ps-begin-cut-regexp)
3697 '(26 . ps-end-cut-regexp)
3699 '(23 . ps-even-or-odd-pages)
3700 '(23 . ps-selected-pages)
3701 '(23 . ps-last-selected-pages)
3703 '(31 . ps-build-face-reference)
3704 '(31 . ps-always-build-face-reference)
3706 '(20 . ps-auto-font-detect)
3707 '(20 . ps-bold-faces)
3708 '(20 . ps-italic-faces)
3709 '(20 . ps-underlined-faces)
3710 '(20 . ps-black-white-faces)
3711 " )\n
3712 ;; The following customized variables have long lists and are seldom modified:
3713 ;; ps-page-dimensions-database
3714 ;; ps-font-info-database
3716 \;;; ps-print - end of settings\n")
3717 "\n")))
3720 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3721 ;; Utility functions and variables:
3724 (defun ps-print-quote (elt)
3725 "Quote ELT for printing (used for showing settings).
3727 If ELT is nil, return an empty string.
3728 If ELT is string, return it.
3729 Otherwise, ELT should be a cons (LEN . SYM) where SYM is a variable symbol and
3730 LEN is the field length where SYM name will be inserted. The variable
3731 `ps-prefix-quote' is used to form the string, if `ps-prefix-quote' is nil, it's
3732 used \"(setq \" as prefix; otherwise, it's used \" \". So, the string
3733 generated is:
3735 * If `ps-prefix-quote' is nil:
3736 \"(setq SYM-NAME SYM-VALUE\"
3737 |<------->|
3740 * If `ps-prefix-quote' is non-nil:
3741 \" SYM-NAME SYM-VALUE\"
3742 |<------->|
3745 If `ps-prefix-quote' is nil, it's set to t after generating string."
3746 (cond
3747 ((stringp elt) elt)
3748 ((and (consp elt) (integerp (car elt))
3749 (symbolp (cdr elt)) (boundp (cdr elt)))
3750 (let* ((col (car elt))
3751 (sym (cdr elt))
3752 (key (symbol-name sym))
3753 (len (length key))
3754 (val (symbol-value sym)))
3755 (concat (if ps-prefix-quote
3757 (setq ps-prefix-quote t)
3758 "(setq ")
3760 (if (> col len)
3761 (make-string (- col len) ?\s)
3762 " ")
3763 (ps-value-string val))))
3764 (t "")
3768 (defun ps-value-string (val)
3769 "Return a string representation of VAL. Used by `ps-print-quote'."
3770 (cond ((null val)
3771 "nil")
3772 ((eq val t)
3773 "t")
3774 ((or (symbolp val) (listp val))
3775 (format "'%S" val))
3777 (format "%S" val))))
3780 (defun ps-comment-string (str value)
3781 "Return a comment string like \";; STR = VALUE\"."
3782 (format ";; %s = %s" str (ps-value-string value)))
3785 (defun ps-value (alist-sym key)
3786 "Return value from association list ALIST-SYM which car is `eq' to KEY."
3787 (cdr (assq key (symbol-value alist-sym))))
3790 (defun ps-get (alist-sym key)
3791 "Return element from association list ALIST-SYM which car is `eq' to KEY."
3792 (assq key (symbol-value alist-sym)))
3795 (defun ps-put (alist-sym key value)
3796 "Store element (KEY . VALUE) into association list ALIST-SYM.
3797 If KEY already exists in ALIST-SYM, modify cdr to VALUE.
3798 It can be retrieved with `(ps-get ALIST-SYM KEY)'."
3799 (let ((elt: (assq key (symbol-value alist-sym)))) ; to avoid name conflict
3800 (if elt:
3801 (setcdr elt: value)
3802 (setq elt: (cons key value))
3803 (set alist-sym (cons elt: (symbol-value alist-sym))))
3804 elt:))
3807 (defun ps-del (alist-sym key)
3808 "Delete by side effect element KEY from association list ALIST-SYM."
3809 (let ((a:list: (symbol-value alist-sym)) ; to avoid name conflict
3810 old)
3811 (while a:list:
3812 (if (eq key (car (car a:list:)))
3813 (progn
3814 (if old
3815 (setcdr old (cdr a:list:))
3816 (set alist-sym (cdr a:list:)))
3817 (setq a:list: nil))
3818 (setq old a:list:
3819 a:list: (cdr a:list:)))))
3820 (symbol-value alist-sym))
3823 (defun ps-time-stamp-locale-default ()
3824 "Return the locale's \"preferred\" date as, for example, \"06/18/01\"."
3825 (format-time-string "%x"))
3828 (defun ps-time-stamp-mon-dd-yyyy ()
3829 "Return date as \"Jun 18 2001\"."
3830 (format-time-string "%b %d %Y"))
3833 (defun ps-time-stamp-yyyy-mm-dd ()
3834 "Return date as \"2001-06-18\" (ISO date)."
3835 (format-time-string "%Y-%m-%d"))
3838 ;; Alias for `ps-time-stamp-yyyy-mm-dd' (which see).
3839 (defalias 'ps-time-stamp-iso8601 'ps-time-stamp-yyyy-mm-dd)
3842 (defun ps-time-stamp-hh:mm:ss ()
3843 "Return time as \"17:28:31\"."
3844 (format-time-string "%T"))
3847 (and (featurep 'xemacs)
3848 ;; XEmacs change: Need to check for emacs-major-version too.
3849 (or (< emacs-major-version 19)
3850 (and (= emacs-major-version 19) (< emacs-minor-version 12)))
3851 (setq ps-print-color-p nil))
3854 ;; Return t if the device (which can be changed during an emacs session)
3855 ;; can handle colors.
3856 ;; This function is not yet implemented for GNU emacs.
3857 (defalias 'ps-color-device
3858 (cond ((and (featurep 'xemacs)
3859 ;; XEmacs change: Need to check for emacs-major-version too.
3860 (or (> emacs-major-version 19)
3861 (and (= emacs-major-version 19)
3862 (>= emacs-minor-version 12)))) ; XEmacs >= 19.12
3863 (lambda ()
3864 (eq (ps-x-device-class) 'color)))
3866 (t ; Emacs
3867 (lambda ()
3868 (if (fboundp 'color-values)
3869 (ps-e-color-values "Green")
3870 t)))))
3873 (defun ps-mapper (extent list)
3874 (nconc list
3875 (list (list (ps-x-extent-start-position extent) 'push extent)
3876 (list (ps-x-extent-end-position extent) 'pull extent)))
3877 nil)
3879 (defun ps-extent-sorter (a b)
3880 (< (ps-x-extent-priority a) (ps-x-extent-priority b)))
3882 (defun ps-xemacs-face-kind-p (face kind kind-regex)
3883 (let* ((frame-font (or (ps-x-face-font-instance face)
3884 (ps-x-face-font-instance 'default)))
3885 (kind-cons
3886 (and frame-font
3887 (assq kind
3888 (ps-x-font-instance-properties frame-font))))
3889 (kind-spec (cdr-safe kind-cons))
3890 (case-fold-search t))
3891 (and kind-spec (string-match kind-regex kind-spec))))
3893 (cond ((featurep 'xemacs) ; XEmacs
3895 ;; to avoid XEmacs compilation gripes
3896 (defvar coding-system-for-write)
3897 (defvar coding-system-for-read)
3898 (defvar buffer-file-coding-system)
3900 (and (fboundp 'find-coding-system)
3901 (or (ps-x-find-coding-system 'raw-text-unix)
3902 (ps-x-copy-coding-system 'no-conversion-unix 'raw-text-unix)))
3904 (defun ps-color-values (x-color)
3905 (let ((color (ps-xemacs-color-name x-color)))
3906 (cond
3907 ((fboundp 'x-color-values)
3908 (ps-e-x-color-values color))
3909 ((and (fboundp 'color-instance-rgb-components)
3910 (ps-color-device))
3911 (ps-x-color-instance-rgb-components
3912 (if (ps-x-color-instance-p x-color)
3913 x-color
3914 (ps-x-make-color-instance color))))
3916 (error "No available function to determine X color values")))))
3918 (defun ps-face-bold-p (face)
3919 (or (ps-xemacs-face-kind-p face 'WEIGHT_NAME "bold\\|demibold")
3920 (memq face ps-bold-faces))) ; Kludge-compatible
3922 (defun ps-face-italic-p (face)
3923 (or (ps-xemacs-face-kind-p face 'ANGLE_NAME "i\\|o")
3924 (ps-xemacs-face-kind-p face 'SLANT "i\\|o")
3925 (memq face ps-italic-faces))) ; Kludge-compatible
3927 (defalias 'ps-face-strikeout-p 'ignore)
3929 (defalias 'ps-face-overline-p 'ignore)
3931 (defalias 'ps-face-box-p 'ignore)
3934 (t ; Emacs
3936 (defun ps-color-values (x-color)
3937 (cond
3938 ((fboundp 'color-values)
3939 (ps-e-color-values x-color))
3940 ((fboundp 'x-color-values)
3941 (ps-e-x-color-values x-color))
3943 (error "No available function to determine X color values"))))
3945 (defun ps-face-bold-p (face)
3946 (or (ps-e-face-bold-p face)
3947 (memq face ps-bold-faces)))
3949 (defun ps-face-italic-p (face)
3950 (or (ps-e-face-italic-p face)
3951 (memq face ps-italic-faces)))
3953 (defun ps-face-strikeout-p (face)
3954 (eq (face-attribute face :strike-through) t))
3956 (defun ps-face-overline-p (face)
3957 (eq (face-attribute face :overline) t))
3959 (defun ps-face-box-p (face)
3960 (not (memq (face-attribute face :box) '(nil unspecified))))
3964 (defvar ps-print-color-scale 1.0)
3966 (defun ps-color-scale (color)
3967 ;; Scale 16-bit X-COLOR-VALUE to PostScript color value in [0, 1] interval.
3968 (mapcar #'(lambda (value) (/ value ps-print-color-scale))
3969 (ps-color-values color)))
3972 (defun ps-face-underlined-p (face)
3973 (or (face-underline-p face)
3974 (memq face ps-underlined-faces)))
3977 (defun ps-prologue-file (filenumber)
3978 "If prologue FILENUMBER exists and is readable, return contents as string.
3980 Note: No major/minor-mode is activated and no local variables are evaluated for
3981 FILENUMBER, but proper EOL-conversion and character interpretation is
3982 done!"
3983 (let ((filename (convert-standard-filename
3984 (expand-file-name (format "ps-prin%d.ps" filenumber)
3985 ps-postscript-code-directory))))
3986 (if (and (file-exists-p filename)
3987 (file-readable-p filename))
3988 (with-temp-buffer
3989 (insert-file-contents filename)
3990 (buffer-string))
3991 (error "ps-print PostScript prologue `%s' file was not found"
3992 filename))))
3995 (defvar ps-mark-code-directory nil)
3997 (defvar ps-print-prologue-0 ""
3998 "ps-print PostScript error handler.")
4000 (defvar ps-print-prologue-1 ""
4001 "ps-print PostScript prologue.")
4003 ;; Start Editing Here:
4005 (defvar ps-source-buffer nil)
4006 (defvar ps-spool-buffer-name "*PostScript*")
4007 (defvar ps-spool-buffer nil)
4009 (defvar ps-output-head nil)
4010 (defvar ps-output-tail nil)
4012 (defvar ps-page-postscript 0) ; page number
4013 (defvar ps-page-order 0) ; PostScript page counter
4014 (defvar ps-page-sheet 0) ; sheet counter
4015 (defvar ps-page-column 0) ; column counter
4016 (defvar ps-page-printed 0) ; total pages printed
4017 (defvar ps-page-n-up 0) ; n-up counter
4018 (defvar ps-lines-printed 0) ; total lines printed
4019 (defvar ps-showline-count 1) ; line number counter
4020 (defvar ps-first-page nil)
4021 (defvar ps-last-page nil)
4022 (defvar ps-print-page-p t)
4024 (defvar ps-control-or-escape-regexp nil)
4025 (defvar ps-n-up-on nil)
4027 (defvar ps-background-pages nil)
4028 (defvar ps-background-all-pages nil)
4029 (defvar ps-background-text-count 0)
4030 (defvar ps-background-image-count 0)
4032 (defvar ps-current-font 0)
4033 (defvar ps-default-foreground nil)
4034 (defvar ps-default-background nil)
4035 (defvar ps-default-color nil)
4036 (defvar ps-current-color nil)
4037 (defvar ps-current-bg nil)
4039 (defvar ps-zebra-stripe-full-p nil)
4040 (defvar ps-razchunk 0)
4042 (defvar ps-color-p nil)
4043 (defvar ps-color-format
4044 (if (featurep 'xemacs)
4045 ;; XEmacs will have to make do with %s (princ) for floats.
4046 "%s %s %s"
4048 ;; Emacs understands the %f format; we'll use it to limit color RGB
4049 ;; values to three decimals to cut down some on the size of the
4050 ;; PostScript output.
4051 "%0.3f %0.3f %0.3f"))
4053 ;; These values determine how much print-height to deduct when headers/footers
4054 ;; are turned on. This is a pretty clumsy way of handling it, but it'll do for
4055 ;; now.
4057 (defvar ps-header-pad 0
4058 "Vertical and horizontal space between the header frame and the text.
4059 This is in units of points (1/72 inch).")
4061 (defvar ps-footer-pad 0
4062 "Vertical and horizontal space between the footer frame and the text.
4063 This is in units of points (1/72 inch).")
4065 ;; Define accessors to the dimensions list.
4067 (defmacro ps-page-dimensions-get-width (dims) `(nth 0 ,dims))
4068 (defmacro ps-page-dimensions-get-height (dims) `(nth 1 ,dims))
4069 (defmacro ps-page-dimensions-get-media (dims) `(nth 2 ,dims))
4071 (defvar ps-landscape-page-height nil)
4073 (defvar ps-print-width nil)
4074 (defvar ps-print-height nil)
4076 (defvar ps-height-remaining nil)
4077 (defvar ps-width-remaining nil)
4079 (defvar ps-font-size-internal nil)
4080 (defvar ps-header-font-size-internal nil)
4081 (defvar ps-header-title-font-size-internal nil)
4082 (defvar ps-footer-font-size-internal nil)
4083 (defvar ps-line-spacing-internal nil)
4084 (defvar ps-paragraph-spacing-internal nil)
4087 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4088 ;; Internal Variables
4091 (defvar ps-black-white-faces-alist nil
4092 "Alist of symbolic faces used for black/white PostScript printers.
4093 An element of this list has the same form as `ps-print-face-extension-alist'
4094 \(which see).
4096 Don't change this list directly; instead,
4097 use `ps-extend-face' and `ps-extend-face-list'.
4098 See documentation for `ps-extend-face' for valid extension symbol.
4099 See also documentation for `ps-print-color-p'.")
4102 (defvar ps-print-face-extension-alist nil
4103 "Alist of symbolic faces *WITH* extension features (box, outline, etc).
4104 An element of this list has the following form:
4106 (FACE . [BITS FG BG])
4108 FACE is a symbol denoting a face name
4109 BITS is a bit vector, where each bit correspond
4110 to a feature (bold, underline, etc)
4111 (see documentation for `ps-print-face-map-alist')
4112 FG foreground color (string or nil)
4113 BG background color (string or nil)
4115 Don't change this list directly; instead,
4116 use `ps-extend-face' and `ps-extend-face-list'.
4117 See documentation for `ps-extend-face' for valid extension symbol.")
4120 (defvar ps-print-face-alist nil
4121 "Alist of symbolic faces *WITHOUT* extension features (box, outline, etc).
4123 An element of this list has the same form as an element of
4124 `ps-print-face-extension-alist'.
4126 Don't change this list directly; this list is used by `ps-face-attributes',
4127 `ps-map-face' and `ps-build-reference-face-lists'.")
4130 (defconst ps-print-face-map-alist
4131 '((bold . 1)
4132 (italic . 2)
4133 (underline . 4)
4134 (strikeout . 8)
4135 (overline . 16)
4136 (shadow . 32)
4137 (box . 64)
4138 (outline . 128))
4139 "Alist of all features and the corresponding bit mask.
4140 Each symbol correspond to one bit in a bit vector.")
4143 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4144 ;; Remapping Faces
4147 ;;;###autoload
4148 (defun ps-extend-face-list (face-extension-list &optional merge-p alist-sym)
4149 "Extend face in ALIST-SYM.
4151 If optional MERGE-P is non-nil, extensions in FACE-EXTENSION-LIST are merged
4152 with face extension in ALIST-SYM; otherwise, overrides.
4154 If optional ALIST-SYM is nil, `ps-print-face-extension-alist' is used;
4155 otherwise, it should be an alist symbol.
4157 The elements in FACE-EXTENSION-LIST are like those for `ps-extend-face'.
4159 See `ps-extend-face' for documentation."
4160 (while face-extension-list
4161 (ps-extend-face (car face-extension-list) merge-p alist-sym)
4162 (setq face-extension-list (cdr face-extension-list))))
4165 ;;;###autoload
4166 (defun ps-extend-face (face-extension &optional merge-p alist-sym)
4167 "Extend face in ALIST-SYM.
4169 If optional MERGE-P is non-nil, extensions in FACE-EXTENSION list are merged
4170 with face extensions in ALIST-SYM; otherwise, overrides.
4172 If optional ALIST-SYM is nil, `ps-print-face-extension-alist' is used;
4173 otherwise, it should be an alist symbol.
4175 The elements of FACE-EXTENSION list have the form:
4177 (FACE-NAME FOREGROUND BACKGROUND EXTENSION...)
4179 FACE-NAME is a face name symbol.
4181 FOREGROUND and BACKGROUND may be nil or a string that denotes the
4182 foreground and background colors respectively.
4184 EXTENSION is one of the following symbols:
4185 bold - use bold font.
4186 italic - use italic font.
4187 underline - put a line under text.
4188 strikeout - like underline, but the line is in middle of text.
4189 overline - like underline, but the line is over the text.
4190 shadow - text will have a shadow.
4191 box - text will be surrounded by a box.
4192 outline - print characters as hollow outlines.
4194 If EXTENSION is any other symbol, it is ignored."
4195 (or alist-sym
4196 (setq alist-sym 'ps-print-face-extension-alist))
4197 (let* ((background (nth 2 face-extension))
4198 (foreground (nth 1 face-extension))
4199 (face-name (nth 0 face-extension))
4200 (ps-face (cdr (assq face-name (symbol-value alist-sym))))
4201 (face-vector (or ps-face (vector 0 nil nil)))
4202 (face-bit (ps-extension-bit face-extension)))
4203 ;; extend face
4204 (aset face-vector 0 (if merge-p
4205 (logior (aref face-vector 0) face-bit)
4206 face-bit))
4207 (and (or (not merge-p) (and foreground (stringp foreground)))
4208 (aset face-vector 1 foreground))
4209 (and (or (not merge-p) (and background (stringp background)))
4210 (aset face-vector 2 background))
4211 ;; if face does not exist, insert it
4212 (or ps-face
4213 (set alist-sym (cons (cons face-name face-vector)
4214 (symbol-value alist-sym))))))
4217 (defun ps-extension-bit (face-extension)
4218 (let ((face-bit 0))
4219 ;; map valid symbol extension to bit vector
4220 (setq face-extension (cdr (cdr face-extension)))
4221 (while (setq face-extension (cdr face-extension))
4222 (setq face-bit (logior face-bit
4223 (or (cdr (assq (car face-extension)
4224 ps-print-face-map-alist))
4225 0))))
4226 face-bit))
4229 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4230 ;; Adapted from font-lock: (obsolete stuff)
4231 ;; Originally face attributes were specified via `font-lock-face-attributes'.
4232 ;; Users then changed the default face attributes by setting that variable.
4233 ;; However, we try and be back-compatible and respect its value if set except
4234 ;; for faces where M-x customize has been used to save changes for the face.
4237 (defun ps-font-lock-face-attributes ()
4238 (and (boundp 'font-lock-mode) (symbol-value 'font-lock-mode)
4239 (boundp 'font-lock-face-attributes)
4240 (let ((face-attributes (symbol-value 'font-lock-face-attributes)))
4241 (while face-attributes
4242 (let* ((face-attribute
4243 (car (prog1 face-attributes
4244 (setq face-attributes (cdr face-attributes)))))
4245 (face (car face-attribute)))
4246 ;; Rustle up a `defface' SPEC from a
4247 ;; `font-lock-face-attributes' entry.
4248 (unless (get face 'saved-face)
4249 (let ((foreground (nth 1 face-attribute))
4250 (background (nth 2 face-attribute))
4251 (bold-p (nth 3 face-attribute))
4252 (italic-p (nth 4 face-attribute))
4253 (underline-p (nth 5 face-attribute))
4254 face-spec)
4255 (when foreground
4256 (setq face-spec (cons ':foreground
4257 (cons foreground face-spec))))
4258 (when background
4259 (setq face-spec (cons ':background
4260 (cons background face-spec))))
4261 (when bold-p
4262 (setq face-spec (append '(:weight bold) face-spec)))
4263 (when italic-p
4264 (setq face-spec (append '(:slant italic) face-spec)))
4265 (when underline-p
4266 (setq face-spec (append '(:underline t) face-spec)))
4267 (custom-declare-face face (list (list t face-spec)) nil)
4268 )))))))
4271 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4272 ;; Internal functions and variables
4275 (defun ps-message-log-max ()
4276 (and (not (string= (buffer-name) "*Messages*"))
4277 (boundp 'message-log-max)
4278 message-log-max))
4281 (defvar ps-print-hook nil)
4282 (defvar ps-print-begin-sheet-hook nil)
4283 (defvar ps-print-begin-page-hook nil)
4284 (defvar ps-print-begin-column-hook nil)
4287 (defun ps-print-without-faces (from to &optional filename region-p)
4288 (ps-spool-without-faces from to region-p)
4289 (ps-do-despool filename))
4292 (defun ps-spool-without-faces (from to &optional region-p)
4293 (let ((message-log-max (ps-message-log-max))) ; to print *Messages* buffer
4294 (run-hooks 'ps-print-hook)
4295 (ps-printing-region region-p from to)
4296 (ps-generate (current-buffer) from to 'ps-generate-postscript)))
4299 (defun ps-print-with-faces (from to &optional filename region-p)
4300 (ps-spool-with-faces from to region-p)
4301 (ps-do-despool filename))
4304 (defun ps-spool-with-faces (from to &optional region-p)
4305 (let ((message-log-max (ps-message-log-max))) ; to print *Messages* buffer
4306 (run-hooks 'ps-print-hook)
4307 (ps-printing-region region-p from to)
4308 (ps-generate (current-buffer) from to 'ps-generate-postscript-with-faces)))
4311 (defun ps-count-lines-preprint (from to)
4312 (or (and from to)
4313 (error "The mark is not set now"))
4314 (let ((message-log-max (ps-message-log-max))) ; to count lines of *Messages*
4315 (list (count-lines from to))))
4318 (defun ps-count-lines (from to)
4319 (+ (count-lines from to)
4320 (save-excursion
4321 (goto-char to)
4322 (if (= (current-column) 0) 1 0))))
4325 (defvar ps-printing-region nil
4326 "Variable used to indicate the region that ps-print is printing.
4327 It is a cons, the car of which is the line number where the region begins, and
4328 its cdr is the total number of lines in the buffer. Formatting functions can
4329 use this information to print the original line number (and not the number of
4330 lines printed), and to indicate in the header that the printout is of a partial
4331 file.")
4334 (defvar ps-printing-region-p nil
4335 "Non-nil means ps-print is printing a region.")
4338 (defun ps-printing-region (region-p from to)
4339 (setq ps-printing-region-p region-p
4340 ps-printing-region
4341 (cons (if region-p
4342 (ps-count-lines (point-min) (min from to))
4344 (ps-count-lines (point-min) (point-max)))))
4347 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4348 ;; Internal functions
4351 (defsubst ps-font-alist (font-sym)
4352 (get font-sym 'fonts))
4354 (defun ps-font (font-sym font-type)
4355 "Font family name for text of `font-type', when generating PostScript."
4356 (let* ((font-list (ps-font-alist font-sym))
4357 (normal-font (cdr (assq 'normal font-list))))
4358 (while (and font-list (not (eq font-type (car (car font-list)))))
4359 (setq font-list (cdr font-list)))
4360 (or (cdr (car font-list)) normal-font)))
4362 (defsubst ps-fonts (font-sym)
4363 (mapcar 'cdr (ps-font-alist font-sym)))
4365 (defsubst ps-font-number (font-sym font-type)
4366 (or (ps-alist-position font-type (ps-font-alist font-sym))
4369 (defsubst ps-line-height (font-sym)
4370 "The height of a line, for generating PostScript.
4371 This is the value that ps-print uses to determine the height,
4372 y-dimension, of the lines of text it has printed, and thus affects the
4373 point at which page-breaks are placed.
4374 The line-height is *not* the same as the point size of the font."
4375 (get font-sym 'line-height))
4377 (defsubst ps-title-line-height (font-sym)
4378 "The height of a `title' line, for generating PostScript.
4379 This is the value that ps-print uses to determine the height,
4380 y-dimension, of the lines of text it has printed, and thus affects the
4381 point at which page-breaks are placed.
4382 The title-line-height is *not* the same as the point size of the font."
4383 (get font-sym 'title-line-height))
4385 (defsubst ps-space-width (font-sym)
4386 "The width of a space character, for generating PostScript.
4387 This value is used in expanding tab characters."
4388 (get font-sym 'space-width))
4390 (defsubst ps-avg-char-width (font-sym)
4391 "The average width, in points, of a character, for generating PostScript.
4392 This is the value that ps-print uses to determine the length,
4393 x-dimension, of the text it has printed, and thus affects the point at
4394 which long lines wrap around."
4395 (get font-sym 'avg-char-width))
4397 (defun ps-line-lengths-internal ()
4398 "Display the correspondence between a line length and a font size.
4399 Done using the current ps-print setup.
4400 Try: pr -t file | awk '{printf \"%3d %s\n\", length($0), $0}' | sort -r | head"
4401 (let* ((ps-font-size-internal
4402 (or ps-font-size-internal
4403 (ps-get-font-size 'ps-font-size)))
4404 (ps-header-font-size-internal
4405 (or ps-header-font-size-internal
4406 (ps-get-font-size 'ps-header-font-size)))
4407 (ps-header-title-font-size-internal
4408 (or ps-header-title-font-size-internal
4409 (ps-get-font-size 'ps-header-title-font-size)))
4410 (buf (get-buffer-create "*Line-lengths*"))
4411 (ifs ps-font-size-internal) ; initial font size
4412 (icw (ps-avg-char-width 'ps-font-for-text)) ; initial character width
4413 (print-width (progn (ps-get-page-dimensions)
4414 ps-print-width))
4415 (ps-setup (ps-setup)) ; setup for the current buffer
4416 (fs-min 5) ; minimum font size
4417 cw-min ; minimum character width
4418 nb-cpl-max ; maximum nb of characters per line
4419 (fs-max 14) ; maximum font size
4420 cw-max ; maximum character width
4421 nb-cpl-min ; minimum nb of characters per line
4422 fs ; current font size
4423 cw ; current character width
4424 nb-cpl ; current nb of characters per line
4426 (setq cw-min (/ (* icw fs-min) ifs)
4427 nb-cpl-max (floor (/ print-width cw-min))
4428 cw-max (/ (* icw fs-max) ifs)
4429 nb-cpl-min (floor (/ print-width cw-max))
4430 nb-cpl nb-cpl-min)
4431 (set-buffer buf)
4432 (goto-char (point-max))
4433 (or (bobp) (insert "\n" (make-string 75 ?\;) "\n"))
4434 (insert ps-setup
4435 "\nnb char per line / font size\n")
4436 (while (<= nb-cpl nb-cpl-max)
4437 (setq cw (/ print-width (float nb-cpl))
4438 fs (/ (* ifs cw) icw))
4439 (insert (format "%16d %s\n" nb-cpl fs))
4440 (setq nb-cpl (1+ nb-cpl)))
4441 (insert "\n")
4442 (display-buffer buf 'not-this-window)))
4444 (defun ps-nb-pages (nb-lines)
4445 "Display correspondence between font size and the number of pages.
4446 The correspondence is based on having NB-LINES lines of text,
4447 and on the current ps-print setup."
4448 (let* ((ps-font-size-internal
4449 (or ps-font-size-internal
4450 (ps-get-font-size 'ps-font-size)))
4451 (ps-header-font-size-internal
4452 (or ps-header-font-size-internal
4453 (ps-get-font-size 'ps-header-font-size)))
4454 (ps-header-title-font-size-internal
4455 (or ps-header-title-font-size-internal
4456 (ps-get-font-size 'ps-header-title-font-size)))
4457 (ps-line-spacing-internal
4458 (or ps-line-spacing-internal
4459 (ps-get-size ps-line-spacing "line spacing")))
4460 (buf (get-buffer-create "*Nb-Pages*"))
4461 (ils ps-line-spacing-internal) ; initial line spacing
4462 (ifs ps-font-size-internal) ; initial font size
4463 (ilh (ps-line-height 'ps-font-for-text)) ; initial line height
4464 (page-height (progn (ps-get-page-dimensions)
4465 ps-print-height))
4466 (ps-setup (ps-setup)) ; setup for the current buffer
4467 (fs-min 4) ; minimum font size
4468 lh-min ; minimum line height
4469 nb-lpp-max ; maximum nb of lines per page
4470 nb-page-min ; minimum nb of pages
4471 (fs-max 14) ; maximum font size
4472 lh-max ; maximum line height
4473 nb-lpp-min ; minimum nb of lines per page
4474 nb-page-max ; maximum nb of pages
4475 fs ; current font size
4476 lh ; current line height
4477 nb-lpp ; current nb of lines per page
4478 nb-page ; current nb of pages
4480 (setq lh-min (/ (- (* (+ ilh ils) fs-min) ils) ifs)
4481 nb-lpp-max (floor (/ page-height lh-min))
4482 nb-page-min (ceiling (/ (float nb-lines) nb-lpp-max))
4483 lh-max (/ (- (* (+ ilh ils) fs-max) ils) ifs)
4484 nb-lpp-min (floor (/ page-height lh-max))
4485 nb-page-max (ceiling (/ (float nb-lines) nb-lpp-min))
4486 nb-page nb-page-min)
4487 (set-buffer buf)
4488 (goto-char (point-max))
4489 (or (bobp) (insert "\n" (make-string 75 ?\;) "\n"))
4490 (insert ps-setup
4491 (format "\nThere are %d lines.\n\n" nb-lines)
4492 "nb page / font size\n")
4493 (while (<= nb-page nb-page-max)
4494 (setq nb-lpp (ceiling (/ nb-lines (float nb-page)))
4495 lh (/ page-height nb-lpp)
4496 fs (/ (* ifs lh) ilh))
4497 (insert (format "%7d %s\n" nb-page fs))
4498 (setq nb-page (1+ nb-page)))
4499 (insert "\n")
4500 (display-buffer buf 'not-this-window)))
4502 ;; macros used in `ps-select-font'
4503 (defmacro ps-lookup (key) `(cdr (assq ,key font-entry)))
4504 (defmacro ps-size-scale (key) `(/ (* (ps-lookup ,key) font-size) size))
4506 (defun ps-select-font (font-family sym font-size title-font-size)
4507 (let ((font-entry (cdr (assq font-family ps-font-info-database))))
4508 (or font-entry
4509 (error "Don't have data to scale font %s. Known fonts families are %s"
4510 font-family
4511 (mapcar 'car ps-font-info-database)))
4512 (let ((size (ps-lookup 'size)))
4513 (put sym 'fonts (ps-lookup 'fonts))
4514 (put sym 'space-width (ps-size-scale 'space-width))
4515 (put sym 'avg-char-width (ps-size-scale 'avg-char-width))
4516 (put sym 'line-height (ps-size-scale 'line-height))
4517 (put sym 'title-line-height
4518 (/ (* (ps-lookup 'line-height) title-font-size) size)))))
4520 (defun ps-get-page-dimensions ()
4521 (let ((page-dimensions (cdr (assq ps-paper-type ps-page-dimensions-database)))
4522 page-width page-height)
4523 (cond
4524 ((null page-dimensions)
4525 (error "`ps-paper-type' must be one of:\n%s"
4526 (mapcar 'car ps-page-dimensions-database)))
4527 ((< ps-number-of-columns 1)
4528 (error "The number of columns %d should be positive"
4529 ps-number-of-columns)))
4531 (ps-select-font ps-font-family 'ps-font-for-text
4532 ps-font-size-internal ps-font-size-internal)
4533 (ps-select-font ps-header-font-family 'ps-font-for-header
4534 ps-header-font-size-internal
4535 ps-header-title-font-size-internal)
4536 (ps-select-font ps-footer-font-family 'ps-font-for-footer
4537 ps-footer-font-size-internal ps-footer-font-size-internal)
4539 (setq page-width (ps-page-dimensions-get-width page-dimensions)
4540 page-height (ps-page-dimensions-get-height page-dimensions))
4542 ;; Landscape mode
4543 (if ps-landscape-mode
4544 ;; exchange width and height
4545 (setq page-width (prog1 page-height (setq page-height page-width))))
4547 ;; It is used to get the lower right corner (only in landscape mode)
4548 (setq ps-landscape-page-height page-height)
4550 ;; | lm | text | ic | text | ic | text | rm |
4551 ;; page-width == lm + n * pw + (n - 1) * ic + rm
4552 ;; => pw == (page-width - lm -rm - (n - 1) * ic) / n
4553 (setq ps-print-width (/ (- page-width
4554 ps-left-margin ps-right-margin
4555 (* (1- ps-number-of-columns) ps-inter-column))
4556 ps-number-of-columns))
4557 (if (<= ps-print-width 0)
4558 (error "Bad horizontal layout:
4559 page-width == %s
4560 ps-left-margin == %s
4561 ps-right-margin == %s
4562 ps-inter-column == %s
4563 ps-number-of-columns == %s
4564 | lm | text | ic | text | ic | text | rm |
4565 page-width == lm + n * print-width + (n - 1) * ic + rm
4566 => print-width == %d !"
4567 page-width
4568 ps-left-margin
4569 ps-right-margin
4570 ps-inter-column
4571 ps-number-of-columns
4572 ps-print-width))
4574 (setq ps-print-height
4575 (- page-height ps-bottom-margin ps-top-margin))
4576 (if (<= ps-print-height 0)
4577 (error "Bad vertical layout:
4578 ps-top-margin == %s
4579 ps-bottom-margin == %s
4580 page-height == bm + print-height + tm
4581 => print-height == %d !"
4582 ps-top-margin
4583 ps-bottom-margin
4584 ps-print-height))
4585 ;; If headers are turned on, deduct the height of the header from the print
4586 ;; height.
4587 (if ps-print-header
4588 (setq ps-header-pad (* ps-header-line-pad
4589 (ps-title-line-height 'ps-font-for-header))
4590 ps-print-height (- ps-print-height
4591 ps-header-offset
4592 ps-header-pad
4593 (ps-title-line-height 'ps-font-for-header)
4594 (* (ps-line-height 'ps-font-for-header)
4595 (1- ps-header-lines))
4596 ps-header-pad)))
4597 (if (<= ps-print-height 0)
4598 (error "Bad vertical layout (header):
4599 ps-top-margin == %s
4600 ps-bottom-margin == %s
4601 ps-header-offset == %s
4602 ps-header-pad == %s
4603 header-height == %s
4604 page-height == bm + print-height + tm - ho - hh
4605 => print-height == %d !"
4606 ps-top-margin
4607 ps-bottom-margin
4608 ps-header-offset
4609 ps-header-pad
4610 (+ ps-header-pad
4611 (ps-title-line-height 'ps-font-for-header)
4612 (* (ps-line-height 'ps-font-for-header)
4613 (1- ps-header-lines))
4614 ps-header-pad)
4615 ps-print-height))
4616 ;; If footers are turned on, deduct the height of the footer from the print
4617 ;; height.
4618 (if ps-print-footer
4619 (setq ps-footer-pad (* ps-footer-line-pad
4620 (ps-title-line-height 'ps-font-for-footer))
4621 ps-print-height (- ps-print-height
4622 ps-footer-offset
4623 ps-footer-pad
4624 (* (ps-line-height 'ps-font-for-footer)
4625 (1- ps-footer-lines))
4626 ps-footer-pad)))
4627 (if (<= ps-print-height 0)
4628 (error "Bad vertical layout (footer):
4629 ps-top-margin == %s
4630 ps-bottom-margin == %s
4631 ps-footer-offset == %s
4632 ps-footer-pad == %s
4633 footer-height == %s
4634 page-height == bm + print-height + tm - fo - fh
4635 => print-height == %d !"
4636 ps-top-margin
4637 ps-bottom-margin
4638 ps-footer-offset
4639 ps-footer-pad
4640 (+ ps-footer-pad
4641 (* (ps-line-height 'ps-font-for-footer)
4642 (1- ps-footer-lines))
4643 ps-footer-pad)
4644 ps-print-height))
4645 ;; ps-zebra-stripe-follow is `full' or `full-follow'
4646 (if ps-zebra-stripe-full-p
4647 (let* ((line-height (ps-line-height 'ps-font-for-text))
4648 (zebra (* (+ line-height ps-line-spacing-internal)
4649 ps-zebra-stripe-height)))
4650 (setq ps-print-height (- (* (floor ps-print-height zebra) zebra)
4651 line-height))
4652 (if (<= ps-print-height 0)
4653 (error "Bad vertical layout (full zebra stripe follow):
4654 ps-zebra-stripe-follow == %s
4655 ps-zebra-stripe-height == %s
4656 font-text-height == %s
4657 line-spacing == %s
4658 page-height == ((floor print-height ((th + ls) * zh)) * ((th + ls) * zh)) - th
4659 => print-height == %d !"
4660 ps-zebra-stripe-follow
4661 ps-zebra-stripe-height
4662 (ps-line-height 'ps-font-for-text)
4663 ps-line-spacing-internal
4664 ps-print-height))))))
4667 (defun ps-print-preprint-region (prefix-arg)
4668 (or (ps-mark-active-p)
4669 (error "The mark is not set now"))
4670 (list (point) (mark) (ps-print-preprint prefix-arg)))
4673 (defun ps-print-preprint (prefix-arg)
4674 (and prefix-arg
4675 (or (numberp prefix-arg)
4676 (listp prefix-arg))
4677 (let* ((name (concat (file-name-nondirectory (or (buffer-file-name)
4678 (buffer-name)))
4679 ".ps"))
4680 (prompt (format "Save PostScript to file (default %s): " name))
4681 (res (read-file-name prompt default-directory name nil)))
4682 (while (cond ((file-directory-p res)
4683 (ding)
4684 (setq prompt "It's a directory"))
4685 ((not (file-writable-p res))
4686 (ding)
4687 (setq prompt "File is unwritable"))
4688 ((file-exists-p res)
4689 (setq prompt "File exists")
4690 (not (y-or-n-p (format "File `%s' exists; overwrite? "
4691 res))))
4692 (t nil))
4693 (setq res (read-file-name
4694 (format "%s; save PostScript to file: " prompt)
4695 (file-name-directory res) nil nil
4696 (file-name-nondirectory res))))
4697 (if (file-directory-p res)
4698 (expand-file-name name (file-name-as-directory res))
4699 res))))
4701 ;; The following functions implement a simple list-buffering scheme so
4702 ;; that ps-print doesn't have to repeatedly switch between buffers
4703 ;; while spooling. The functions `ps-output' and `ps-output-string' build
4704 ;; up the lists; the function `ps-flush-output' takes the lists and
4705 ;; insert its contents into the spool buffer (*PostScript*).
4707 (defvar ps-string-escape-codes
4708 (let ((table (make-vector 256 nil))
4709 (char ?\000))
4710 ;; control characters
4711 (while (<= char ?\037)
4712 (aset table char (format "\\%03o" char))
4713 (setq char (1+ char)))
4714 ;; printable characters
4715 (while (< char ?\177)
4716 (aset table char (format "%c" char))
4717 (setq char (1+ char)))
4718 ;; DEL and 8-bit characters
4719 (while (<= char ?\377)
4720 (aset table char (format "\\%o" char))
4721 (setq char (1+ char)))
4722 ;; Override ASCII formatting characters with named escape code:
4723 (aset table ?\n "\\n") ; [NL] linefeed
4724 (aset table ?\r "\\r") ; [CR] carriage return
4725 (aset table ?\t "\\t") ; [HT] horizontal tab
4726 (aset table ?\b "\\b") ; [BS] backspace
4727 (aset table ?\f "\\f") ; [NP] form feed
4728 ;; Escape PostScript escape and string delimiter characters:
4729 (aset table ?\\ "\\\\")
4730 (aset table ?\( "\\(")
4731 (aset table ?\) "\\)")
4732 table)
4733 "Vector used to map characters to PostScript string escape codes.")
4735 (defsubst ps-output-string-prim (string)
4736 (insert "(") ;insert start-string delimiter
4737 (save-excursion ;insert string
4738 (insert (string-as-unibyte string)))
4739 ;; Find and quote special characters as necessary for PS
4740 ;; This skips everything except control chars, non-ASCII chars, (, ) and \.
4741 (while (progn (skip-chars-forward " -'*-[]-~") (not (eobp)))
4742 (let ((special (following-char)))
4743 (delete-char 1)
4744 (insert
4745 (if (and (<= 0 special) (<= special 255))
4746 (aref ps-string-escape-codes special)
4747 ;; insert hexadecimal representation if character code is out of range
4748 (format "\\%04X" special)
4749 ))))
4750 (goto-char (point-max))
4751 (insert ")")) ;insert end-string delimiter
4753 (defsubst ps-init-output-queue ()
4754 (setq ps-output-head (list "")
4755 ps-output-tail ps-output-head))
4758 (defun ps-selected-pages ()
4759 (while (progn
4760 (setq ps-first-page (car (car ps-selected-pages))
4761 ps-last-page (cdr (car ps-selected-pages))
4762 ps-selected-pages (cdr ps-selected-pages))
4763 (and ps-selected-pages
4764 (< ps-last-page ps-page-postscript)))))
4767 (defsubst ps-print-page-p ()
4768 (setq ps-print-page-p
4769 (and (cond ((null ps-first-page))
4770 ((<= ps-page-postscript ps-last-page)
4771 (<= ps-first-page ps-page-postscript))
4772 (ps-selected-pages
4773 (ps-selected-pages)
4774 (and (<= ps-first-page ps-page-postscript)
4775 (<= ps-page-postscript ps-last-page)))
4777 nil))
4778 (cond ((eq ps-even-or-odd-pages 'even-page)
4779 (= (logand ps-page-postscript 1) 0))
4780 ((eq ps-even-or-odd-pages 'odd-page)
4781 (= (logand ps-page-postscript 1) 1))
4783 ))))
4786 (defsubst ps-print-sheet-p ()
4787 (setq ps-print-page-p
4788 (cond ((eq ps-even-or-odd-pages 'even-sheet)
4789 (= (logand ps-page-sheet 1) 0))
4790 ((eq ps-even-or-odd-pages 'odd-sheet)
4791 (= (logand ps-page-sheet 1) 1))
4796 (defun ps-output (&rest args)
4797 (when ps-print-page-p
4798 (setcdr ps-output-tail args)
4799 (while (cdr ps-output-tail)
4800 (setq ps-output-tail (cdr ps-output-tail)))))
4802 (defun ps-output-string (string)
4803 (ps-output t string))
4805 ;; Output strings in the list ARGS in the PostScript prologue part.
4806 (defun ps-output-prologue (args)
4807 (ps-output 'prologue (if (stringp args) (list args) args)))
4809 (defun ps-flush-output ()
4810 (save-excursion
4811 (set-buffer ps-spool-buffer)
4812 (goto-char (point-max))
4813 (while ps-output-head
4814 (let ((it (car ps-output-head)))
4815 (cond
4816 ((eq t it)
4817 (setq ps-output-head (cdr ps-output-head))
4818 (ps-output-string-prim (car ps-output-head)))
4819 ((eq 'prologue it)
4820 (setq ps-output-head (cdr ps-output-head))
4821 (save-excursion
4822 (search-backward "\nBeginDoc")
4823 (forward-char 1)
4824 (apply 'insert (car ps-output-head))))
4826 (insert it))))
4827 (setq ps-output-head (cdr ps-output-head))))
4828 (ps-init-output-queue))
4830 (defun ps-insert-file (fname)
4831 (ps-flush-output)
4832 (save-excursion
4833 (set-buffer ps-spool-buffer)
4834 (goto-char (point-max))
4835 (insert-file-contents fname)))
4837 ;; These functions are used in `ps-mule' to get charset of header and footer.
4838 ;; To avoid unnecessary calls to functions in `ps-left-header',
4839 ;; `ps-right-header', `ps-left-footer' and `ps-right-footer'.
4841 (defun ps-generate-string-list (content)
4842 (let (str)
4843 (while content
4844 (setq str (cons (cond
4845 ;; string
4846 ((stringp (car content))
4847 (car content))
4848 ;; function symbol
4849 ((functionp (car content))
4850 (concat "(" (funcall (car content)) ")"))
4851 ;; variable symbol
4852 ((and (symbolp (car content)) (boundp (car content)))
4853 (concat "(" (symbol-value (car content)) ")"))
4854 ;; otherwise, empty string
4856 ""))
4857 str)
4858 content (cdr content)))
4859 (nreverse str)))
4861 (defvar ps-lh-cache nil)
4862 (defvar ps-rh-cache nil)
4863 (defvar ps-lf-cache nil)
4864 (defvar ps-rf-cache nil)
4866 (defun ps-header-footer-string ()
4867 (and ps-print-header
4868 (setq ps-lh-cache (ps-generate-string-list ps-left-header)
4869 ps-rh-cache (ps-generate-string-list ps-right-header)))
4870 (and ps-print-footer
4871 (setq ps-lf-cache (ps-generate-string-list ps-left-footer)
4872 ps-rf-cache (ps-generate-string-list ps-right-footer)))
4873 (append ps-lh-cache ps-rh-cache ps-lf-cache ps-rf-cache))
4875 ;; These functions insert the arrays that define the contents of the headers.
4877 (defun ps-generate-header-line (fonttag &optional content)
4878 (ps-output " [" fonttag " ")
4879 (cond
4880 ;; Literal strings should be output as is -- the string must contain its own
4881 ;; PS string delimiters, '(' and ')', if necessary.
4882 ((stringp content)
4883 (ps-output (ps-mule-encode-header-string content fonttag)))
4885 ;; Functions are called -- they should return strings; they will be inserted
4886 ;; as strings and the PS string delimiters added.
4887 ((functionp content)
4888 (ps-output-string (ps-mule-encode-header-string (funcall content)
4889 fonttag)))
4891 ;; Variables will have their contents inserted. They should contain
4892 ;; strings, and will be inserted as strings.
4893 ((and (symbolp content) (boundp content))
4894 (ps-output-string (ps-mule-encode-header-string (symbol-value content)
4895 fonttag)))
4897 ;; Anything else will get turned into an empty string.
4899 (ps-output-string "")))
4900 (ps-output "]\n"))
4902 (defun ps-generate-header (name fonttag0 fonttag1 contents)
4903 (ps-output "/" name "[\n")
4904 (and contents (> ps-header-lines 0)
4905 (let ((count 1))
4906 (ps-generate-header-line fonttag0 (car contents))
4907 (while (and (< count ps-header-lines)
4908 (setq contents (cdr contents)))
4909 (ps-generate-header-line fonttag1 (car contents))
4910 (setq count (1+ count)))))
4911 (ps-output "]def\n"))
4914 (defun ps-output-boolean (name bool)
4915 (ps-output (format "/%s %s def\n" name (if bool "true" "false"))))
4918 (defun ps-output-frame-properties (name alist)
4919 (ps-output "/" name " ["
4920 (ps-format-color (cdr (assq 'fore-color alist)) 0.0)
4921 (ps-format-color (cdr (assq 'back-color alist)) 0.9)
4922 (ps-float-format (or (cdr (assq 'border-width alist)) 0.4))
4923 (ps-format-color (cdr (assq 'border-color alist)) 0.0)
4924 (ps-format-color (cdr (assq 'shadow-color alist)) 0.0)
4925 "]def\n"))
4928 (defun ps-background-pages (page-list func)
4929 (if page-list
4930 (mapcar
4931 #'(lambda (pages)
4932 (let ((start (if (consp pages) (car pages) pages))
4933 (end (if (consp pages) (cdr pages) pages)))
4934 (and (integerp start) (integerp end) (<= start end)
4935 (add-to-list 'ps-background-pages (vector start end func)))))
4936 page-list)
4937 (setq ps-background-all-pages (cons func ps-background-all-pages))))
4940 (defconst ps-boundingbox-re
4941 "^%%BoundingBox:\
4942 \\s-+\\([0-9.]+\\)\\s-+\\([0-9.]+\\)\\s-+\\([0-9.]+\\)\\s-+\\([0-9.]+\\)")
4945 (defun ps-get-boundingbox ()
4946 (save-excursion
4947 (set-buffer ps-spool-buffer)
4948 (save-excursion
4949 (if (re-search-forward ps-boundingbox-re nil t)
4950 (vector (string-to-number ; lower x
4951 (buffer-substring (match-beginning 1) (match-end 1)))
4952 (string-to-number ; lower y
4953 (buffer-substring (match-beginning 2) (match-end 2)))
4954 (string-to-number ; upper x
4955 (buffer-substring (match-beginning 3) (match-end 3)))
4956 (string-to-number ; upper y
4957 (buffer-substring (match-beginning 4) (match-end 4))))
4958 (vector 0 0 0 0)))))
4961 ;; Emacs understands the %f format; we'll use it to limit color RGB values
4962 ;; to three decimals to cut down some on the size of the PostScript output.
4963 ;; XEmacs will have to make do with %s (princ) for floats.
4965 (defvar ps-float-format (if (featurep 'xemacs)
4966 "%s " ; XEmacs
4967 "%0.3f ")) ; Emacs
4970 (defun ps-float-format (value &optional default)
4971 (let ((literal (or value default)))
4972 (cond ((null literal)
4973 " ")
4974 ((numberp literal)
4975 (format ps-float-format (* literal 1.0))) ; force float number
4977 (format "%s " literal))
4981 (defun ps-background-text ()
4982 (mapcar
4983 #'(lambda (text)
4984 (setq ps-background-text-count (1+ ps-background-text-count))
4985 (ps-output (format "/ShowBackText-%d{\n" ps-background-text-count))
4986 (ps-output-string (nth 0 text)) ; text
4987 (ps-output
4988 "\n"
4989 (ps-float-format (nth 4 text) 200.0) ; font size
4990 (format "/%s " (or (nth 3 text) "Times-Roman")) ; font name
4991 (ps-float-format (nth 6 text)
4992 "PrintHeight PrintPageWidth atan") ; rotation
4993 (ps-float-format (nth 5 text) 0.85) ; gray
4994 (ps-float-format (nth 1 text) "0") ; x position
4995 (ps-float-format (nth 2 text) "0") ; y position
4996 "\nShowBackText}def\n")
4997 (ps-background-pages (nthcdr 7 text) ; page list
4998 (format "ShowBackText-%d\n"
4999 ps-background-text-count)))
5000 ps-print-background-text))
5003 (defun ps-background-image ()
5004 (mapcar
5005 #'(lambda (image)
5006 (let ((image-file (expand-file-name (nth 0 image))))
5007 (when (file-readable-p image-file)
5008 (setq ps-background-image-count (1+ ps-background-image-count))
5009 (ps-output
5010 (format "/ShowBackImage-%d{\n--back-- "
5011 ps-background-image-count)
5012 (ps-float-format (nth 5 image) 0.0) ; rotation
5013 (ps-float-format (nth 3 image) 1.0) ; x scale
5014 (ps-float-format (nth 4 image) 1.0) ; y scale
5015 (ps-float-format (nth 1 image) ; x position
5016 "PrintPageWidth 2 div")
5017 (ps-float-format (nth 2 image) ; y position
5018 "PrintHeight 2 div BottomMargin add")
5019 "\nBeginBackImage\n")
5020 (ps-insert-file image-file)
5021 ;; coordinate adjustment to center image
5022 ;; around x and y position
5023 (let ((box (ps-get-boundingbox)))
5024 (save-excursion
5025 (set-buffer ps-spool-buffer)
5026 (save-excursion
5027 (if (re-search-backward "^--back--" nil t)
5028 (replace-match
5029 (format "%s %s"
5030 (ps-float-format
5031 (- (+ (/ (- (aref box 2) (aref box 0)) 2.0)
5032 (aref box 0))))
5033 (ps-float-format
5034 (- (+ (/ (- (aref box 3) (aref box 1)) 2.0)
5035 (aref box 1)))))
5036 t)))))
5037 (ps-output "\nEndBackImage}def\n")
5038 (ps-background-pages (nthcdr 6 image) ; page list
5039 (format "ShowBackImage-%d\n"
5040 ps-background-image-count)))))
5041 ps-print-background-image))
5044 (defun ps-background (page-number)
5045 (let (has-local-background)
5046 (mapcar #'(lambda (range)
5047 (and (<= (aref range 0) page-number)
5048 (<= page-number (aref range 1))
5049 (if has-local-background
5050 (ps-output (aref range 2))
5051 (setq has-local-background t)
5052 (ps-output "/printLocalBackground{\n"
5053 (aref range 2)))))
5054 ps-background-pages)
5055 (and has-local-background (ps-output "}def\n"))))
5058 ;; Return a list of the distinct elements of LIST.
5059 ;; Elements are compared with `equal'.
5060 (defun ps-remove-duplicates (list)
5061 (let (new (tail list))
5062 (while tail
5063 (or (member (car tail) new)
5064 (setq new (cons (car tail) new)))
5065 (setq tail (cdr tail)))
5066 (nreverse new)))
5069 ;; Find the first occurrence of ITEM in LIST.
5070 ;; Return the index of the matching item, or nil if not found.
5071 ;; Elements are compared with `eq'.
5072 (defun ps-alist-position (item list)
5073 (let ((tail list) (index 0) found)
5074 (while tail
5075 (if (setq found (eq (car (car tail)) item))
5076 (setq tail nil)
5077 (setq index (1+ index)
5078 tail (cdr tail))))
5079 (and found index)))
5082 (defconst ps-n-up-database
5083 '((a4
5084 (1 nil 1 1 0)
5085 (2 t 1 2 0)
5086 (4 nil 2 2 0)
5087 (6 t 2 3 1)
5088 (8 t 2 4 0)
5089 (9 nil 3 3 0)
5090 (12 t 3 4 2)
5091 (16 nil 4 4 0)
5092 (18 t 3 6 0)
5093 (20 nil 5 4 1)
5094 (25 nil 5 5 0)
5095 (30 nil 6 5 1)
5096 (32 t 4 8 0)
5097 (36 nil 6 6 0)
5098 (42 nil 7 6 1)
5099 (49 nil 7 7 0)
5100 (50 t 5 10 0)
5101 (56 nil 8 7 1)
5102 (64 nil 8 8 0)
5103 (72 nil 9 8 1)
5104 (81 nil 9 9 0)
5105 (90 nil 10 9 1)
5106 (100 nil 10 10 0))
5108 (1 nil 1 1 0)
5109 (2 t 1 2 0)
5110 (4 nil 2 2 0)
5111 (6 t 2 3 1)
5112 (8 t 2 4 0)
5113 (9 nil 3 3 0)
5114 (12 nil 4 3 1)
5115 (16 nil 4 4 0)
5116 (18 t 3 6 0)
5117 (20 nil 5 4 1)
5118 (25 nil 5 5 0)
5119 (30 nil 6 5 1)
5120 (32 t 4 8 0)
5121 (36 nil 6 6 0)
5122 (42 nil 7 6 1)
5123 (49 nil 7 7 0)
5124 (50 t 5 10 0)
5125 (56 nil 8 7 1)
5126 (64 nil 8 8 0)
5127 (72 nil 9 8 1)
5128 (81 nil 9 9 0)
5129 (90 nil 10 9 1)
5130 (100 nil 10 10 0))
5131 (letter
5132 (1 nil 1 1 0)
5133 (2 t 1 2 0) ; adjusted by PostScript code
5134 (4 nil 2 2 0)
5135 (6 t 2 3 0)
5136 (9 nil 3 3 0)
5137 (12 nil 4 3 1)
5138 (16 nil 4 4 0)
5139 (20 nil 5 4 1)
5140 (25 nil 5 5 0)
5141 (30 nil 6 5 1)
5142 (36 nil 6 6 0)
5143 (40 t 5 8 0)
5144 (42 nil 7 6 1)
5145 (49 nil 7 7 0)
5146 (56 nil 8 7 1)
5147 (64 nil 8 8 0)
5148 (72 nil 9 8 1)
5149 (81 nil 9 9 0)
5150 (90 nil 10 9 1)
5151 (100 nil 10 10 0))
5152 (legal
5153 (1 nil 1 1 0)
5154 (2 t 1 2 0)
5155 (4 nil 2 2 0)
5156 (6 nil 3 2 1)
5157 (9 nil 3 3 0)
5158 (10 t 2 5 0)
5159 (12 nil 4 3 1)
5160 (16 nil 4 4 0)
5161 (20 nil 5 4 1)
5162 (25 nil 5 5 0)
5163 (30 nil 6 5 1)
5164 (36 nil 6 6 0)
5165 (42 nil 7 6 1)
5166 (49 nil 7 7 0)
5167 (56 nil 8 7 1)
5168 (64 nil 8 8 0)
5169 (70 t 5 14 0)
5170 (72 nil 9 8 1)
5171 (81 nil 9 9 0)
5172 (90 nil 10 9 1)
5173 (100 nil 10 10 0))
5174 (letter-small
5175 (1 nil 1 1 0)
5176 (2 t 1 2 0) ; adjusted by PostScript code
5177 (4 nil 2 2 0)
5178 (6 t 2 3 0)
5179 (9 nil 3 3 0)
5180 (12 t 3 4 1)
5181 (15 t 3 5 0)
5182 (16 nil 4 4 0)
5183 (20 nil 5 4 1)
5184 (25 nil 5 5 0)
5185 (28 t 4 7 0)
5186 (30 nil 6 5 1)
5187 (36 nil 6 6 0)
5188 (40 t 5 8 0)
5189 (42 nil 7 6 1)
5190 (49 nil 7 7 0)
5191 (56 nil 8 7 1)
5192 (60 t 6 10 0)
5193 (64 nil 8 8 0)
5194 (72 ni 9 8 1)
5195 (81 nil 9 9 0)
5196 (84 t 7 12 0)
5197 (90 nil 10 9 1)
5198 (100 nil 10 10 0))
5199 (tabloid
5200 (1 nil 1 1 0)
5201 (2 t 1 2 0)
5202 (4 nil 2 2 0)
5203 (6 t 2 3 1)
5204 (8 t 2 4 0)
5205 (9 nil 3 3 0)
5206 (12 nil 4 3 1)
5207 (16 nil 4 4 0)
5208 (20 nil 5 4 1)
5209 (25 nil 5 5 0)
5210 (30 nil 6 5 1)
5211 (36 nil 6 6 0)
5212 (42 nil 7 6 1)
5213 (49 nil 7 7 0)
5214 (56 nil 8 7 1)
5215 (64 nil 8 8 0)
5216 (72 nil 9 8 1)
5217 (81 nil 9 9 0)
5218 (84 t 6 14 0)
5219 (90 nil 10 9 1)
5220 (100 nil 10 10 0))
5221 ;; Ledger paper size is a special case, it is the only paper size where the
5222 ;; normal size is landscaped, that is, the height is smaller than width.
5223 ;; So, we use the special value `pag' in the `landscape' field.
5224 (ledger
5225 (1 nil 1 1 0)
5226 (2 pag 1 2 0)
5227 (4 nil 2 2 0)
5228 (6 pag 2 3 1)
5229 (8 pag 2 4 0)
5230 (9 nil 3 3 0)
5231 (12 nil 4 3 1)
5232 (16 nil 4 4 0)
5233 (20 nil 5 4 1)
5234 (25 nil 5 5 0)
5235 (30 nil 6 5 1)
5236 (36 nil 6 6 0)
5237 (42 nil 7 6 1)
5238 (49 nil 7 7 0)
5239 (56 nil 8 7 1)
5240 (64 nil 8 8 0)
5241 (72 nil 9 8 1)
5242 (81 nil 9 9 0)
5243 (84 pag 6 14 0)
5244 (90 nil 10 9 1)
5245 (100 nil 10 10 0))
5246 (statement
5247 (1 nil 1 1 0)
5248 (2 t 1 2 0)
5249 (4 nil 2 2 0)
5250 (6 nil 3 2 1)
5251 (9 nil 3 3 0)
5252 (10 t 2 5 0)
5253 (12 nil 4 3 1)
5254 (16 nil 4 4 0)
5255 (20 nil 5 4 1)
5256 (21 t 3 7 0)
5257 (25 nil 5 5 0)
5258 (30 nil 6 5 1)
5259 (36 nil 6 6 0)
5260 (40 t 4 10 0)
5261 (42 nil 7 6 1)
5262 (49 nil 7 7 0)
5263 (56 nil 8 7 1)
5264 (60 t 5 12 0)
5265 (64 nil 8 8 0)
5266 (72 nil 9 8 1)
5267 (81 nil 9 9 0)
5268 (90 nil 10 9 1)
5269 (100 nil 10 10 0))
5270 (executive
5271 (1 nil 1 1 0)
5272 (2 t 1 2 0) ; adjusted by PostScript code
5273 (4 nil 2 2 0)
5274 (6 t 2 3 0)
5275 (9 nil 3 3 0)
5276 (12 nil 4 3 1)
5277 (16 nil 4 4 0)
5278 (20 nil 5 4 1)
5279 (25 nil 5 5 0)
5280 (28 t 4 7 0)
5281 (30 nil 6 5 1)
5282 (36 nil 6 6 0)
5283 (42 nil 7 6 1)
5284 (45 t 5 9 0)
5285 (49 nil 7 7 0)
5286 (56 nil 8 7 1)
5287 (60 t 6 10 0)
5288 (64 nil 8 8 0)
5289 (72 nil 9 8 1)
5290 (81 nil 9 9 0)
5291 (84 t 7 12 0)
5292 (90 nil 10 9 1)
5293 (100 nil 10 10 0))
5294 (a4small
5295 (1 nil 1 1 0)
5296 (2 t 1 2 0)
5297 (4 nil 2 2 0)
5298 (6 t 2 3 1)
5299 (8 t 2 4 0)
5300 (9 nil 3 3 0)
5301 (12 nil 4 3 1)
5302 (16 nil 4 4 0)
5303 (18 t 3 6 0)
5304 (20 nil 5 4 1)
5305 (25 nil 5 5 0)
5306 (30 nil 6 5 1)
5307 (32 t 4 8 0)
5308 (36 nil 6 6 0)
5309 (42 nil 7 6 1)
5310 (49 nil 7 7 0)
5311 (50 t 5 10 0)
5312 (56 nil 8 7 1)
5313 (64 nil 8 8 0)
5314 (72 nil 9 8 1)
5315 (78 t 6 13 0)
5316 (81 nil 9 9 0)
5317 (90 nil 10 9 1)
5318 (100 nil 10 10 0))
5320 (1 nil 1 1 0)
5321 (2 t 1 2 0)
5322 (4 nil 2 2 0)
5323 (6 t 2 3 1)
5324 (8 t 2 4 0)
5325 (9 nil 3 3 0)
5326 (12 nil 4 3 1)
5327 (16 nil 4 4 0)
5328 (18 t 3 6 0)
5329 (20 nil 5 4 1)
5330 (25 nil 5 5 0)
5331 (30 nil 6 5 1)
5332 (32 t 4 8 0)
5333 (36 nil 6 6 0)
5334 (42 nil 7 6 1)
5335 (49 nil 7 7 0)
5336 (50 t 5 10 0)
5337 (56 nil 8 7 1)
5338 (64 nil 8 8 0)
5339 (72 nil 9 8 1)
5340 (81 nil 9 9 0)
5341 (90 nil 10 9 1)
5342 (100 nil 10 10 0))
5344 (1 nil 1 1 0)
5345 (2 t 1 2 0)
5346 (4 nil 2 2 0)
5347 (6 t 2 3 1)
5348 (8 t 2 4 0)
5349 (9 nil 3 3 0)
5350 (12 nil 4 3 1)
5351 (16 nil 4 4 0)
5352 (18 t 3 6 0)
5353 (20 nil 5 4 1)
5354 (25 nil 5 5 0)
5355 (30 nil 6 5 1)
5356 (32 t 4 8 0)
5357 (36 nil 6 6 0)
5358 (42 nil 7 6 1)
5359 (49 nil 7 7 0)
5360 (50 t 5 10 0)
5361 (56 nil 8 7 1)
5362 (64 nil 8 8 0)
5363 (72 nil 9 8 0)
5364 (81 nil 9 9 0)
5365 (90 nil 10 9 1)
5366 (98 t 7 14 0)
5367 (100 nil 10 10 0)))
5368 "Alist which is the page matrix database used for N-up printing.
5370 Each element has the following form:
5372 (PAGE
5373 (MAX LANDSCAPE LINES COLUMNS COL-MISSING)
5374 ...)
5376 Where:
5377 PAGE is the page size used (see `ps-paper-type').
5378 MAX is the maximum elements of this page matrix.
5379 LANDSCAPE specifies if page matrix is landscaped, has the following valid
5380 values:
5381 nil the sheet is in portrait mode.
5382 t the sheet is in landscape mode.
5383 pag the sheet is in portrait mode and page is in landscape mode.
5384 LINES is the number of lines of page matrix.
5385 COLUMNS is the number of columns of page matrix.
5386 COL-MISSING is the number of columns missing to fill the sheet.")
5389 (defmacro ps-n-up-landscape (mat) `(nth 1 ,mat))
5390 (defmacro ps-n-up-lines (mat) `(nth 2 ,mat))
5391 (defmacro ps-n-up-columns (mat) `(nth 3 ,mat))
5392 (defmacro ps-n-up-missing (mat) `(nth 4 ,mat))
5395 (defun ps-n-up-printing ()
5396 ;; force `ps-n-up-printing' be in range 1 to 100.
5397 (setq ps-n-up-printing (max (min ps-n-up-printing 100) 1))
5398 ;; find suitable page matrix for a given `ps-paper-type'.
5399 (let ((the-list (cdr (assq ps-paper-type ps-n-up-database))))
5400 (and the-list
5401 (while (> ps-n-up-printing (caar the-list))
5402 (setq the-list (cdr the-list))))
5403 (car the-list)))
5406 (defconst ps-n-up-filling-database
5407 '((left-top
5408 "PageWidth" ; N-Up-XColumn
5409 "0" ; N-Up-YColumn
5410 "N-Up-End 1 sub PageWidth mul neg" ; N-Up-XLine
5411 "LandscapePageHeight neg" ; N-Up-YLine
5412 "N-Up-Lines" ; N-Up-Repeat
5413 "N-Up-Columns" ; N-Up-End
5414 "0" ; N-Up-XStart
5415 "0") ; N-Up-YStart
5416 (left-bottom
5417 "PageWidth" ; N-Up-XColumn
5418 "0" ; N-Up-YColumn
5419 "N-Up-End 1 sub PageWidth mul neg" ; N-Up-XLine
5420 "LandscapePageHeight" ; N-Up-YLine
5421 "N-Up-Lines" ; N-Up-Repeat
5422 "N-Up-Columns" ; N-Up-End
5423 "0" ; N-Up-XStart
5424 "N-Up-Repeat 1 sub LandscapePageHeight mul neg") ; N-Up-YStart
5425 (right-top
5426 "PageWidth neg" ; N-Up-XColumn
5427 "0" ; N-Up-YColumn
5428 "N-Up-End 1 sub PageWidth mul" ; N-Up-XLine
5429 "LandscapePageHeight neg" ; N-Up-YLine
5430 "N-Up-Lines" ; N-Up-Repeat
5431 "N-Up-Columns" ; N-Up-End
5432 "N-Up-End 1 sub PageWidth mul" ; N-Up-XStart
5433 "0") ; N-Up-YStart
5434 (right-bottom
5435 "PageWidth neg" ; N-Up-XColumn
5436 "0" ; N-Up-YColumn
5437 "N-Up-End 1 sub PageWidth mul" ; N-Up-XLine
5438 "LandscapePageHeight" ; N-Up-YLine
5439 "N-Up-Lines" ; N-Up-Repeat
5440 "N-Up-Columns" ; N-Up-End
5441 "N-Up-End 1 sub PageWidth mul" ; N-Up-XStart
5442 "N-Up-Repeat 1 sub LandscapePageHeight mul neg") ; N-Up-YStart
5443 (top-left
5444 "0" ; N-Up-XColumn
5445 "LandscapePageHeight neg" ; N-Up-YColumn
5446 "PageWidth" ; N-Up-XLine
5447 "N-Up-End 1 sub LandscapePageHeight mul" ; N-Up-YLine
5448 "N-Up-Columns" ; N-Up-Repeat
5449 "N-Up-Lines" ; N-Up-End
5450 "0" ; N-Up-XStart
5451 "0") ; N-Up-YStart
5452 (bottom-left
5453 "0" ; N-Up-XColumn
5454 "LandscapePageHeight" ; N-Up-YColumn
5455 "PageWidth" ; N-Up-XLine
5456 "N-Up-End 1 sub LandscapePageHeight mul neg" ; N-Up-YLine
5457 "N-Up-Columns" ; N-Up-Repeat
5458 "N-Up-Lines" ; N-Up-End
5459 "0" ; N-Up-XStart
5460 "N-Up-End 1 sub LandscapePageHeight mul neg") ; N-Up-YStart
5461 (top-right
5462 "0" ; N-Up-XColumn
5463 "LandscapePageHeight neg" ; N-Up-YColumn
5464 "PageWidth neg" ; N-Up-XLine
5465 "N-Up-End 1 sub LandscapePageHeight mul" ; N-Up-YLine
5466 "N-Up-Columns" ; N-Up-Repeat
5467 "N-Up-Lines" ; N-Up-End
5468 "N-Up-Repeat 1 sub PageWidth mul" ; N-Up-XStart
5469 "0") ; N-Up-YStart
5470 (bottom-right
5471 "0" ; N-Up-XColumn
5472 "LandscapePageHeight" ; N-Up-YColumn
5473 "PageWidth neg" ; N-Up-XLine
5474 "N-Up-End 1 sub LandscapePageHeight mul neg" ; N-Up-YLine
5475 "N-Up-Columns" ; N-Up-Repeat
5476 "N-Up-Lines" ; N-Up-End
5477 "N-Up-Repeat 1 sub PageWidth mul" ; N-Up-XStart
5478 "N-Up-End 1 sub LandscapePageHeight mul neg")) ; N-Up-YStart
5479 "Alist for n-up printing initializations.
5481 Each element has the following form:
5483 (KIND XCOL YCOL XLIN YLIN REPEAT END XSTART YSTART)
5485 Where:
5486 KIND is a valid value of `ps-n-up-filling'.
5487 XCOL YCOL are the relative position for the next column.
5488 XLIN YLIN are the relative position for the beginning of next line.
5489 REPEAT is the number of repetions for external loop.
5490 END is the number of repetions for internal loop and also the number of pages in
5491 a row.
5492 XSTART YSTART are the relative position for the first page in a sheet.")
5495 (defun ps-n-up-filling ()
5496 (cdr (or (assq ps-n-up-filling ps-n-up-filling-database)
5497 (assq 'left-top ps-n-up-filling-database))))
5500 (defmacro ps-n-up-xcolumn (init) `(nth 0 ,init))
5501 (defmacro ps-n-up-ycolumn (init) `(nth 1 ,init))
5502 (defmacro ps-n-up-xline (init) `(nth 2 ,init))
5503 (defmacro ps-n-up-yline (init) `(nth 3 ,init))
5504 (defmacro ps-n-up-repeat (init) `(nth 4 ,init))
5505 (defmacro ps-n-up-end (init) `(nth 5 ,init))
5506 (defmacro ps-n-up-xstart (init) `(nth 6 ,init))
5507 (defmacro ps-n-up-ystart (init) `(nth 7 ,init))
5510 (defconst ps-error-handler-alist
5511 '((none . 0)
5512 (paper . 1)
5513 (system . 2)
5514 (paper-and-system . 3))
5515 "Alist for error handler message.")
5518 (defconst ps-zebra-stripe-alist
5519 '((follow . 1)
5520 (full . 2)
5521 (full-follow . 3))
5522 "Alist for zebra stripe continuation.")
5525 (defun ps-begin-file ()
5526 (setq ps-page-order 0
5527 ps-page-printed 0
5528 ps-background-text-count 0
5529 ps-background-image-count 0
5530 ps-background-pages nil
5531 ps-background-all-pages nil)
5533 (let ((dimensions (cdr (assq ps-paper-type ps-page-dimensions-database)))
5534 (tumble (if ps-landscape-mode (not ps-spool-tumble) ps-spool-tumble))
5535 (n-up (ps-n-up-printing))
5536 (n-up-filling (ps-n-up-filling)))
5537 (and ps-n-up-on (setq tumble (not tumble)))
5538 (ps-output
5539 ps-adobe-tag
5540 "%%Title: " (buffer-name) ; Take job name from name of
5541 ; first buffer printed
5542 "\n%%Creator: ps-print v" ps-print-version
5543 "\n%%For: " (user-full-name)
5544 "\n%%CreationDate: " (format-time-string "%T %b %d %Y")
5545 "\n%%Orientation: "
5546 (if ps-landscape-mode "Landscape" "Portrait")
5547 "\n%%DocumentNeededResources: font Times-Roman Times-Italic\n%%+ font "
5548 (mapconcat 'identity
5549 (ps-remove-duplicates
5550 (append (ps-fonts 'ps-font-for-text)
5551 (list (ps-font 'ps-font-for-header 'normal)
5552 (ps-font 'ps-font-for-header 'bold)
5553 (ps-font 'ps-font-for-footer 'normal)
5554 (ps-font 'ps-font-for-footer 'bold))))
5555 "\n%%+ font ")
5556 "\n%%DocumentSuppliedResources: procset PSPrintUserDefinedPrologue-" (user-login-name) " 0 0"
5557 "\n%%DocumentMedia: " (ps-page-dimensions-get-media dimensions)
5558 (format " %d" (round (ps-page-dimensions-get-width dimensions)))
5559 (format " %d" (round (ps-page-dimensions-get-height dimensions)))
5560 " 0 () ()\n%%PageOrder: Ascend\n%%Pages: (atend)\n%%Requirements:"
5561 (if ps-spool-duplex
5562 (if tumble " duplex(tumble)\n" " duplex\n")
5563 "\n"))
5565 (ps-insert-string ps-print-prologue-header)
5567 (ps-output "%%EndComments\n%%BeginDefaults\n%%PageMedia: "
5568 (ps-page-dimensions-get-media dimensions)
5569 "\n%%EndDefaults\n\n%%BeginProlog\n\n"
5570 "/languagelevel where{pop}{/languagelevel 1 def}ifelse\n"
5571 (format "/ErrorMessage %s def\n\n"
5572 (or (cdr (assoc ps-error-handler-message
5573 ps-error-handler-alist))
5574 1)) ; send to paper
5575 ps-print-prologue-0
5576 "\n%%BeginResource: procset PSPrintUserDefinedPrologue-" (user-login-name) " 0 0\n\n")
5578 (ps-insert-string ps-user-defined-prologue)
5580 (ps-output "\n%%EndResource\n\n")
5582 (ps-output-boolean "LandscapeMode "
5583 (or ps-landscape-mode
5584 (eq (ps-n-up-landscape n-up) 'pag)))
5585 (ps-output-boolean "UpsideDown " ps-print-upside-down)
5586 (ps-output (format "/NumberOfColumns %d def\n" ps-number-of-columns)
5588 (format "/LandscapePageHeight %s def\n" ps-landscape-page-height)
5589 (format "/PrintPageWidth %s def\n"
5590 (- (* (+ ps-print-width ps-inter-column)
5591 ps-number-of-columns)
5592 ps-inter-column))
5593 (format "/PrintWidth %s def\n" ps-print-width)
5594 (format "/PrintHeight %s def\n" ps-print-height)
5596 (format "/LeftMargin %s def\n" ps-left-margin)
5597 (format "/RightMargin %s def\n" ps-right-margin)
5598 (format "/InterColumn %s def\n" ps-inter-column)
5600 (format "/BottomMargin %s def\n" ps-bottom-margin)
5601 (format "/TopMargin %s def\n" ps-top-margin) ; not used
5602 (format "/HeaderOffset %s def\n" ps-header-offset)
5603 (format "/HeaderPad %s def\n" ps-header-pad)
5604 (format "/FooterOffset %s def\n" ps-footer-offset)
5605 (format "/FooterPad %s def\n" ps-footer-pad)
5606 (format "/FooterLines %s def\n" ps-footer-lines))
5608 (ps-output-boolean "ShowNofN " ps-show-n-of-n)
5609 (ps-output-boolean "SwitchHeader " (if (eq ps-switch-header 'duplex)
5610 ps-spool-duplex
5611 ps-switch-header))
5612 (ps-output-boolean "PrintOnlyOneHeader" ps-print-only-one-header)
5613 (ps-output-boolean "PrintHeader " ps-print-header)
5614 (ps-output-boolean "PrintHeaderFrame " ps-print-header-frame)
5615 (ps-output-frame-properties "HeaderFrameProperties" ps-header-frame-alist)
5616 (ps-output-boolean "PrintFooter " ps-print-footer)
5617 (ps-output-boolean "PrintFooterFrame " ps-print-footer-frame)
5618 (ps-output-frame-properties "FooterFrameProperties" ps-footer-frame-alist)
5620 (let ((line-height (ps-line-height 'ps-font-for-text)))
5621 (ps-output (format "/LineSpacing %s def\n" ps-line-spacing-internal)
5622 (format "/ParagraphSpacing %s def\n"
5623 ps-paragraph-spacing-internal)
5624 (format "/LineHeight %s def\n" line-height)
5625 (format "/LinesPerColumn %d def\n"
5626 (let ((height (+ line-height
5627 ps-line-spacing-internal)))
5628 (round (/ (+ ps-print-height
5629 (* height 0.45))
5630 height))))))
5632 (ps-output-boolean "WarnPaperSize " ps-warn-paper-type)
5633 (ps-output-boolean "Zebra " ps-zebra-stripes)
5634 (ps-output-boolean "PrintLineNumber " ps-line-number)
5635 (ps-output-boolean "SyncLineZebra " (not (integerp ps-line-number-step)))
5636 (ps-output (format "/ZebraFollow %d def\n"
5637 (or (cdr (assq ps-zebra-stripe-follow
5638 ps-zebra-stripe-alist))
5640 (format "/PrintLineStep %d def\n"
5641 (if (integerp ps-line-number-step)
5642 ps-line-number-step
5643 ps-zebra-stripe-height))
5644 (format "/PrintLineStart %d def\n" ps-line-number-start)
5645 "/LineNumberColor "
5646 (ps-format-color ps-line-number-color 0.0)
5647 (format "def\n/ZebraHeight %d def\n"
5648 ps-zebra-stripe-height)
5649 "/ZebraColor "
5650 (ps-format-color ps-zebra-color 0.95)
5651 "def\n")
5652 (ps-output "/BackgroundColor "
5653 (ps-format-color ps-default-background 1.0)
5654 "def\n")
5655 (ps-output "/UseSetpagedevice "
5656 (if (eq ps-spool-config 'setpagedevice)
5657 "/setpagedevice where{pop languagelevel 2 eq}{false}ifelse"
5658 "false")
5659 " def\n\n/PageWidth "
5660 "PrintPageWidth LeftMargin add RightMargin add def\n\n"
5661 (format "/N-Up %d def\n" ps-n-up-printing))
5662 (ps-output-boolean "N-Up-Landscape" (eq (ps-n-up-landscape n-up) t))
5663 (ps-output-boolean "N-Up-Border " ps-n-up-border-p)
5664 (ps-output (format "/N-Up-Lines %d def\n" (ps-n-up-lines n-up))
5665 (format "/N-Up-Columns %d def\n" (ps-n-up-columns n-up))
5666 (format "/N-Up-Missing %d def\n" (ps-n-up-missing n-up))
5667 (format "/N-Up-Margin %s def\n" ps-n-up-margin)
5668 "/N-Up-Repeat "
5669 (if ps-landscape-mode
5670 (ps-n-up-end n-up-filling)
5671 (ps-n-up-repeat n-up-filling))
5672 " def\n/N-Up-End "
5673 (if ps-landscape-mode
5674 (ps-n-up-repeat n-up-filling)
5675 (ps-n-up-end n-up-filling))
5676 " def\n/N-Up-XColumn " (ps-n-up-xcolumn n-up-filling)
5677 " def\n/N-Up-YColumn " (ps-n-up-ycolumn n-up-filling)
5678 " def\n/N-Up-XLine " (ps-n-up-xline n-up-filling)
5679 " def\n/N-Up-YLine " (ps-n-up-yline n-up-filling)
5680 " def\n/N-Up-XStart " (ps-n-up-xstart n-up-filling)
5681 " def\n/N-Up-YStart " (ps-n-up-ystart n-up-filling) " def\n")
5683 (ps-background-text)
5684 (ps-background-image)
5685 (setq ps-background-all-pages (nreverse ps-background-all-pages)
5686 ps-background-pages (nreverse ps-background-pages))
5688 (ps-output "\n" ps-print-prologue-1
5689 "\n/printGlobalBackground{\n")
5690 (mapcar 'ps-output ps-background-all-pages)
5691 (ps-output
5692 "}def\n/printLocalBackground{\n}def\n"
5693 "\n%%EndProlog\n\n%%BeginSetup\n"
5694 "\n%%IncludeResource: font Times-Roman"
5695 "\n%%IncludeResource: font Times-Italic"
5696 "\n%%IncludeResource: font "
5697 (mapconcat 'identity
5698 (ps-remove-duplicates
5699 (append (ps-fonts 'ps-font-for-text)
5700 (list (ps-font 'ps-font-for-header 'normal)
5701 (ps-font 'ps-font-for-header 'bold)
5702 (ps-font 'ps-font-for-footer 'normal)
5703 (ps-font 'ps-font-for-footer 'bold))))
5704 "\n%%IncludeResource: font ")
5705 ;; Header/line number fonts
5706 (format "\n/h0 %s(%s)cvn DefFont\n" ; /h0 14/Helvetica-Bold DefFont
5707 ps-header-title-font-size-internal
5708 (ps-font 'ps-font-for-header 'bold))
5709 (format "/h1 %s(%s)cvn DefFont\n" ; /h1 12/Helvetica DefFont
5710 ps-header-font-size-internal
5711 (ps-font 'ps-font-for-header 'normal))
5712 (format "/L0 %s(%s)cvn DefFont\n" ; /L0 6/Times-Italic DefFont
5713 (ps-get-font-size 'ps-line-number-font-size)
5714 ps-line-number-font)
5715 (format "/H0 %s(%s)cvn DefFont\n" ; /H0 12/Helvetica DefFont
5716 ps-footer-font-size-internal
5717 (ps-font 'ps-font-for-footer 'normal))
5718 "\n\n% ---- These lines must be kept together because...
5720 /h0 F
5721 /HeaderTitleLineHeight FontHeight def
5723 /h1 F
5724 /HeaderLineHeight FontHeight def
5725 /HeaderDescent Descent def
5727 /H0 F
5728 /FooterLineHeight FontHeight def
5729 /FooterDescent Descent def
5731 % ---- ...because `F' has a side-effect on `FontHeight' and `Descent'\n\n")
5733 ;; Text fonts
5734 (let ((font (ps-font-alist 'ps-font-for-text))
5735 (i 0))
5736 (while font
5737 (ps-output (format "/f%d %s(%s)cvn DefFont\n"
5739 ps-font-size-internal
5740 (ps-font 'ps-font-for-text (car (car font)))))
5741 (setq font (cdr font)
5742 i (1+ i))))
5744 (let ((font-entry (cdr (assq ps-font-family ps-font-info-database))))
5745 (ps-output (format "/SpaceWidthRatio %f def\n"
5746 (/ (ps-lookup 'space-width) (ps-lookup 'size)))))
5748 (unless (eq ps-spool-config 'lpr-switches)
5749 (ps-output "\n%%BeginFeature: *Duplex "
5750 (ps-boolean-capitalized ps-spool-duplex)
5751 " *Tumble "
5752 (ps-boolean-capitalized tumble)
5753 "\nUseSetpagedevice\n{BMark/Duplex "
5754 (ps-boolean-constant ps-spool-duplex)
5755 "/Tumble "
5756 (ps-boolean-constant tumble)
5757 " EMark setpagedevice}\n{statusdict begin "
5758 (ps-boolean-constant ps-spool-duplex)
5759 " setduplexmode "
5760 (ps-boolean-constant tumble)
5761 " settumble end}ifelse\n%%EndFeature\n")))
5762 (ps-output "\n%%BeginFeature: *ManualFeed "
5763 (ps-boolean-capitalized ps-manual-feed)
5764 "\nBMark /ManualFeed "
5765 (ps-boolean-constant ps-manual-feed)
5766 " EMark setpagedevice\n%%EndFeature\n\nBeginDoc\n%%EndSetup\n")
5767 (and ps-banner-page-when-duplexing
5768 (ps-output "\n%%Page: banner 0\nsave showpage restore\n")))
5771 (defun ps-format-color (color &optional default)
5772 (let ((the-color (if (stringp color)
5773 (ps-color-scale color)
5774 color)))
5775 (if (and the-color (listp the-color))
5776 (concat "["
5777 (format ps-color-format
5778 (* (nth 0 the-color) 1.0) ; force float number
5779 (* (nth 1 the-color) 1.0) ; force float number
5780 (* (nth 2 the-color) 1.0)) ; force float number
5781 "] ")
5782 (ps-float-format (if (numberp the-color) the-color default)))))
5785 (defun ps-insert-string (prologue)
5786 (let ((str (if (functionp prologue)
5787 (funcall prologue)
5788 prologue)))
5789 (and (stringp str)
5790 (ps-output str))))
5793 (defun ps-boolean-capitalized (bool)
5794 (if bool "True" "False"))
5797 (defun ps-boolean-constant (bool)
5798 (if bool "true" "false"))
5801 (defun ps-header-dirpart ()
5802 (let ((fname (buffer-file-name)))
5803 (if fname
5804 (if (string-equal (buffer-name) (file-name-nondirectory fname))
5805 (abbreviate-file-name (file-name-directory fname))
5806 fname)
5807 "")))
5810 (defun ps-get-buffer-name ()
5811 (cond
5812 ;; Indulge Jim this little easter egg:
5813 ((string= (buffer-name) "ps-print.el")
5814 "Hey, Cool! It's ps-print.el!!!")
5815 ;; Indulge Jack this other little easter egg:
5816 ((string= (buffer-name) "sokoban.el")
5817 "Super! C'est sokoban.el!")
5818 (t (concat
5819 (and ps-printing-region-p "Subset of: ")
5820 (buffer-name)
5821 (and (buffer-modified-p) " (unsaved)")))))
5824 (defun ps-get-size (size mess &optional arg)
5825 (let ((siz (cond ((numberp size)
5826 size)
5827 ((and (consp size)
5828 (numberp (car size))
5829 (numberp (cdr size)))
5830 (if ps-landscape-mode
5831 (car size)
5832 (cdr size)))
5834 -1))))
5835 (and (< siz 0)
5836 (error "Invalid %s `%S'%s"
5837 mess size
5838 (if arg
5839 (format " for `%S'" arg)
5840 "")))
5841 siz))
5844 (defun ps-get-font-size (font-sym)
5845 (ps-get-size (symbol-value font-sym) "font size" font-sym))
5848 (defun ps-rgb-color (color unspecified default)
5849 (cond
5850 ;; (float float float) ==> (R G B)
5851 ((and color (listp color) (= (length color) 3)
5852 (let ((cl color)
5853 (ok t) e)
5854 (while (and ok cl)
5855 (setq e (car cl)
5856 cl (cdr cl)
5857 ok (and (floatp e) (<= 0.0 e) (<= e 1.0))))
5858 ok))
5859 color)
5860 ;; float ==> 0.0 = black .. 1.0 = white
5861 ((and (floatp color) (<= 0.0 color) (<= color 1.0))
5862 (list color color color))
5863 ;; "colorName" but different from "unspecified-[bf]g"
5864 ((and (stringp color) (not (string= color unspecified)))
5865 (ps-color-scale color))
5866 ;; ok, use the default
5868 (list default default default))))
5871 (defun ps-begin-job (genfunc)
5872 ;; prologue files
5873 (or (equal ps-mark-code-directory ps-postscript-code-directory)
5874 (setq ps-print-prologue-0 (ps-prologue-file 0)
5875 ps-print-prologue-1 (ps-prologue-file 1)
5876 ps-mark-code-directory ps-postscript-code-directory))
5877 ;; selected pages
5878 (let (new page)
5879 (while ps-selected-pages
5880 (setq page (car ps-selected-pages)
5881 ps-selected-pages (cdr ps-selected-pages))
5882 (cond ((integerp page)
5883 (and (> page 0)
5884 (setq new (cons (cons page page) new))))
5885 ((consp page)
5886 (and (integerp (car page)) (integerp (cdr page))
5887 (> (car page) 0)
5888 (<= (car page) (cdr page))
5889 (setq new (cons page new))))))
5890 (setq ps-selected-pages (sort new #'(lambda (one other)
5891 (< (car one) (car other))))
5892 ps-last-selected-pages ps-selected-pages
5893 ps-first-page nil
5894 ps-last-page nil))
5895 ;; face background
5896 (or (listp ps-use-face-background)
5897 (setq ps-use-face-background t))
5898 ;; line number
5899 (and (integerp ps-line-number-step)
5900 (<= ps-line-number-step 0)
5901 (setq ps-line-number-step 1))
5902 (setq ps-n-up-on (> ps-n-up-printing 1)
5903 ps-line-number-start (max 1 (min ps-line-number-start
5904 (if (integerp ps-line-number-step)
5905 ps-line-number-step
5906 ps-zebra-stripe-height))))
5907 ;; spooling buffer
5908 (save-excursion
5909 (set-buffer ps-spool-buffer)
5910 (goto-char (point-max))
5911 (and (re-search-backward "^%%Trailer$" nil t)
5912 (delete-region (match-beginning 0) (point-max))))
5913 ;; miscellaneous
5914 (setq ps-zebra-stripe-full-p (memq ps-zebra-stripe-follow
5915 '(full full-follow))
5916 ps-page-postscript 0
5917 ps-page-sheet 0
5918 ps-page-n-up 0
5919 ps-page-column 0
5920 ps-lines-printed 0
5921 ps-print-page-p t
5922 ps-showline-count (car ps-printing-region)
5923 ps-line-spacing-internal (ps-get-size ps-line-spacing
5924 "line spacing")
5925 ps-paragraph-spacing-internal (ps-get-size ps-paragraph-spacing
5926 "paragraph spacing")
5927 ps-font-size-internal (ps-get-font-size 'ps-font-size)
5928 ps-header-font-size-internal (ps-get-font-size 'ps-header-font-size)
5929 ps-header-title-font-size-internal
5930 (ps-get-font-size 'ps-header-title-font-size)
5931 ps-footer-font-size-internal (ps-get-font-size 'ps-footer-font-size)
5932 ps-control-or-escape-regexp
5933 (cond ((eq ps-print-control-characters '8-bit)
5934 (string-as-unibyte "[\000-\037\177-\377]"))
5935 ((eq ps-print-control-characters 'control-8-bit)
5936 (string-as-unibyte "[\000-\037\177-\237]"))
5937 ((eq ps-print-control-characters 'control)
5938 "[\000-\037\177]")
5939 (t "[\t\n\f]"))
5940 ;; Set the color scale. We do it here instead of in the defvar so
5941 ;; that ps-print can be dumped into emacs. This expression can't be
5942 ;; evaluated at dump-time because X isn't initialized.
5943 ps-color-p (and ps-print-color-p (ps-color-device))
5944 ps-print-color-scale (if ps-color-p
5945 (float (car (ps-color-values "white")))
5946 1.0)
5947 ps-default-background (ps-rgb-color
5948 (cond
5949 ((or (member ps-print-color-p
5950 '(nil back-white))
5951 (eq genfunc 'ps-generate-postscript))
5952 nil)
5953 ((eq ps-default-bg 'frame-parameter)
5954 (ps-frame-parameter nil 'background-color))
5955 ((eq ps-default-bg t)
5956 (ps-face-background-name 'default))
5958 ps-default-bg))
5959 "unspecified-bg"
5960 1.0)
5961 ps-default-foreground (ps-rgb-color
5962 (cond
5963 ((or (member ps-print-color-p
5964 '(nil back-white))
5965 (eq genfunc 'ps-generate-postscript))
5966 nil)
5967 ((eq ps-default-fg 'frame-parameter)
5968 (ps-frame-parameter nil 'foreground-color))
5969 ((eq ps-default-fg t)
5970 (ps-face-foreground-name 'default))
5972 ps-default-fg))
5973 "unspecified-fg"
5974 0.0)
5975 ps-default-color (and (not (member ps-print-color-p
5976 '(nil back-white)))
5977 ps-default-foreground)
5978 ps-current-color ps-default-color)
5979 ;; initialize page dimensions
5980 (ps-get-page-dimensions)
5981 ;; final check
5982 (and ps-color-p
5983 (equal ps-default-background ps-default-foreground)
5984 (error
5985 (concat
5986 "`ps-default-fg' and `ps-default-bg' have the same color.\n"
5987 "Text won't appear on page. Please, check these variables."))))
5990 (defun ps-page-number ()
5991 (if ps-print-only-one-header
5992 (1+ (/ (1- ps-page-column) ps-number-of-columns))
5993 ps-page-column))
5996 (defsubst ps-end-page ()
5997 (ps-output "EndPage\nEndDSCPage\n"))
6000 (defsubst ps-next-page ()
6001 (ps-end-page)
6002 (ps-flush-output)
6003 (ps-begin-page))
6006 (defun ps-end-sheet ()
6007 (and ps-print-page-p (> ps-page-sheet 0)
6008 (ps-output "EndSheet\n")))
6011 (defun ps-header-sheet ()
6012 ;; Print only when a new sheet begins.
6013 (ps-end-sheet)
6014 (setq ps-page-sheet (1+ ps-page-sheet))
6015 (when (ps-print-sheet-p)
6016 (setq ps-page-order (1+ ps-page-order))
6017 (ps-output (if ps-n-up-on
6018 (format "\n%%%%Page: (%d \\(%d\\)) %d\n"
6019 ps-page-order ps-page-postscript ps-page-order)
6020 (format "\n%%%%Page: %d %d\n"
6021 ps-page-postscript ps-page-order))
6022 ;; spooling needs to redefine Lines and PageCount on each page
6023 "/Lines 0 def\n/PageCount 0 def\n"
6024 (format "%d BeginSheet\nBeginDSCPage\n"
6025 ps-n-up-printing))))
6028 (defun ps-header-page ()
6029 ;; set total line and page number when printing has finished
6030 ;; (see `ps-generate')
6031 (if (zerop (mod ps-page-column ps-number-of-columns))
6032 (progn
6033 (setq ps-page-postscript (1+ ps-page-postscript))
6034 (when (ps-print-page-p)
6035 (ps-print-sheet-p)
6036 (if (zerop (mod ps-page-n-up ps-n-up-printing))
6037 ;; Print only when a new sheet begins.
6038 (progn
6039 (ps-header-sheet)
6040 (run-hooks 'ps-print-begin-sheet-hook))
6041 ;; Print only when a new page begins.
6042 (ps-output "BeginDSCPage\n")
6043 (run-hooks 'ps-print-begin-page-hook))
6044 (ps-background ps-page-postscript)
6045 (setq ps-page-n-up (1+ ps-page-n-up))
6046 (and ps-print-page-p
6047 (setq ps-page-printed (1+ ps-page-printed)))))
6048 ;; Print only when a new column begins.
6049 (ps-output "BeginDSCPage\n")
6050 (run-hooks 'ps-print-begin-column-hook))
6051 (setq ps-page-column (1+ ps-page-column)))
6053 (defun ps-begin-page ()
6054 (setq ps-width-remaining ps-print-width
6055 ps-height-remaining ps-print-height)
6057 (ps-header-page)
6059 (ps-output (format "/LineNumber %d def\n" ps-showline-count)
6060 (format "/PageNumber %d def\n" (ps-page-number)))
6062 (when ps-print-header
6063 (ps-generate-header "HeaderLinesLeft" "/h0" "/h1"
6064 (or ps-lh-cache ps-left-header))
6065 (ps-generate-header "HeaderLinesRight" "/h0" "/h1"
6066 (or ps-rh-cache ps-right-header))
6067 (ps-output (format "%d SetHeaderLines\n" ps-header-lines))
6068 (setq ps-lh-cache nil
6069 ps-rh-cache nil))
6071 (when ps-print-footer
6072 (ps-generate-header "FooterLinesLeft" "/H0" "/H0"
6073 (or ps-lf-cache ps-left-footer))
6074 (ps-generate-header "FooterLinesRight" "/H0" "/H0"
6075 (or ps-rf-cache ps-right-footer))
6076 (ps-output (format "%d SetFooterLines\n" ps-footer-lines))
6077 (setq ps-lf-cache nil
6078 ps-rf-cache nil))
6080 (ps-output (number-to-string ps-lines-printed) " BeginPage\n")
6081 (ps-set-font ps-current-font)
6082 (ps-set-bg ps-current-bg)
6083 (ps-set-color ps-current-color)
6084 (ps-mule-begin-page))
6086 (defsubst ps-skip-newline (limit)
6087 (setq ps-showline-count (1+ ps-showline-count)
6088 ps-lines-printed (1+ ps-lines-printed))
6089 (and (< (point) limit)
6090 (forward-char 1)))
6092 (defsubst ps-next-line ()
6093 (setq ps-showline-count (1+ ps-showline-count)
6094 ps-lines-printed (1+ ps-lines-printed))
6095 (let* ((paragraph-p (and ps-paragraph-regexp
6096 (looking-at ps-paragraph-regexp)))
6097 (lh (+ (ps-line-height 'ps-font-for-text)
6098 (if paragraph-p
6099 ps-paragraph-spacing-internal
6100 ps-line-spacing-internal))))
6101 (if (< ps-height-remaining lh)
6102 (ps-next-page)
6103 (setq ps-width-remaining ps-print-width
6104 ps-height-remaining (- ps-height-remaining lh))
6105 (ps-output (if paragraph-p "PHL\n" "LHL\n")))))
6107 (defun ps-continue-line ()
6108 (setq ps-lines-printed (1+ ps-lines-printed))
6109 (let ((lh (+ (ps-line-height 'ps-font-for-text) ps-line-spacing-internal)))
6110 (if (< ps-height-remaining lh)
6111 (ps-next-page)
6112 (setq ps-width-remaining ps-print-width
6113 ps-height-remaining (- ps-height-remaining lh))
6114 (ps-output "SL\n"))))
6116 (defun ps-find-wrappoint (from to char-width)
6117 (let ((avail (truncate (/ ps-width-remaining char-width)))
6118 (todo (- to from)))
6119 (if (< todo avail)
6120 (cons to (* todo char-width))
6121 (cons (+ from avail) ps-width-remaining))))
6123 (defun ps-basic-plot-str (from to string)
6124 (let* ((wrappoint (ps-find-wrappoint from to
6125 (ps-avg-char-width 'ps-font-for-text)))
6126 (to (car wrappoint))
6127 (str (substring string from to)))
6128 (ps-mule-prepare-ascii-font str)
6129 (ps-output-string str)
6130 (ps-output " S\n")
6131 wrappoint))
6133 (defun ps-basic-plot-string (from to &optional bg-color)
6134 (let* ((wrappoint (ps-find-wrappoint from to
6135 (ps-avg-char-width 'ps-font-for-text)))
6136 (to (car wrappoint))
6137 (string (buffer-substring-no-properties from to)))
6138 (ps-mule-prepare-ascii-font string)
6139 (ps-output-string string)
6140 (ps-output " S\n")
6141 wrappoint))
6143 (defun ps-basic-plot-whitespace (from to &optional bg-color)
6144 (let* ((wrappoint (ps-find-wrappoint from to
6145 (ps-space-width 'ps-font-for-text)))
6146 (to (car wrappoint)))
6147 (ps-output (format "%d W\n" (- to from)))
6148 wrappoint))
6150 (defun ps-plot (plotfunc from to &optional bg-color)
6151 (while (< from to)
6152 (let* ((wrappoint (funcall plotfunc from to bg-color))
6153 (plotted-to (car wrappoint))
6154 (plotted-width (cdr wrappoint)))
6155 (setq from plotted-to
6156 ps-width-remaining (- ps-width-remaining plotted-width))
6157 (if (< from to)
6158 (ps-continue-line))))
6159 (if ps-razzle-dazzle
6160 (let* ((q-todo (- (point-max) (point-min)))
6161 (q-done (- (point) (point-min)))
6162 (chunkfrac (/ q-todo 8))
6163 (chunksize (min chunkfrac 1000)))
6164 (if (> (- q-done ps-razchunk) chunksize)
6165 (progn
6166 (setq ps-razchunk q-done)
6167 (message "Formatting...%3d%%"
6168 (if (< q-todo 100)
6169 (/ (* 100 q-done) q-todo)
6170 (/ q-done (/ q-todo 100)))
6171 ))))))
6173 (defvar ps-last-font nil)
6175 (defun ps-set-font (font)
6176 (setq ps-last-font (format "f%d" (setq ps-current-font font)))
6177 (ps-output (format "/%s F\n" ps-last-font)))
6179 (defun ps-set-bg (color)
6180 (if (setq ps-current-bg color)
6181 (ps-output (format ps-color-format
6182 (nth 0 color) (nth 1 color) (nth 2 color))
6183 " true BG\n")
6184 (ps-output "false BG\n")))
6186 (defun ps-set-color (color)
6187 (setq ps-current-color (or color ps-default-foreground))
6188 (ps-output (format ps-color-format
6189 (nth 0 ps-current-color)
6190 (nth 1 ps-current-color) (nth 2 ps-current-color))
6191 " FG\n"))
6194 (defsubst ps-plot-string (string)
6195 (ps-plot 'ps-basic-plot-str 0 (length string) string))
6198 (defvar ps-current-effect 0)
6200 (defvar ps-print-translation-table
6201 (let ((tbl (make-char-table 'translation-table nil)))
6202 (if (and (boundp 'ucs-mule-8859-to-mule-unicode)
6203 (char-table-p ucs-mule-8859-to-mule-unicode))
6204 (map-char-table
6205 #'(lambda (k v)
6206 (if (and v (eq (char-charset v) 'latin-iso8859-1) (/= k v))
6207 (aset tbl k v)))
6208 ucs-mule-8859-to-mule-unicode))
6209 tbl)
6210 "Translation table for PostScript printing.
6211 The default value is a table that translates non-Latin-1 Latin characters
6212 to the equivalent Latin-1 characters.")
6214 (defun ps-plot-region (from to font &optional fg-color bg-color effects)
6215 (or (equal font ps-current-font)
6216 (ps-set-font font))
6218 ;; Specify a foreground color only if one's specified and it's
6219 ;; different than the current.
6220 (let ((fg (or fg-color ps-default-foreground)))
6221 (or (equal fg ps-current-color)
6222 (ps-set-color fg)))
6224 (or (equal bg-color ps-current-bg)
6225 (ps-set-bg bg-color))
6227 ;; Specify effects (underline, overline, box, etc)
6228 (cond
6229 ((not (integerp effects))
6230 (ps-output "0 EF\n")
6231 (setq ps-current-effect 0))
6232 ((/= effects ps-current-effect)
6233 (ps-output (number-to-string effects) " EF\n")
6234 (setq ps-current-effect effects)))
6236 ;; Starting at the beginning of the specified region...
6237 (save-excursion
6238 (goto-char from)
6240 ;; ...break the region up into chunks separated by tabs, linefeeds,
6241 ;; pagefeeds, control characters, and plot each chunk.
6242 (while (< from to)
6243 ;; skip lines between cut markers
6244 (and ps-begin-cut-regexp ps-end-cut-regexp
6245 (looking-at ps-begin-cut-regexp)
6246 (progn
6247 (goto-char (match-end 0))
6248 (and (re-search-forward ps-end-cut-regexp to 'noerror)
6249 (= (following-char) ?\n)
6250 (forward-char 1))
6251 (setq from (point))))
6252 (if (re-search-forward ps-control-or-escape-regexp to t)
6253 ;; region with some control characters or some multi-byte characters
6254 (let* ((match-point (match-beginning 0))
6255 (match (char-after match-point))
6256 (composition (ps-e-find-composition from (1+ match-point))))
6257 (if composition
6258 (if (and (nth 2 composition)
6259 (<= (car composition) match-point))
6260 (progn
6261 (setq match-point (car composition)
6262 match 0)
6263 (goto-char (nth 1 composition)))
6264 (setq composition nil)))
6265 (when (< from match-point)
6266 (ps-mule-set-ascii-font)
6267 (ps-plot 'ps-basic-plot-string from match-point bg-color))
6268 (cond
6269 ((= match ?\t) ; tab
6270 (let ((linestart (line-beginning-position)))
6271 (forward-char -1)
6272 (setq from (+ linestart (current-column)))
6273 (when (re-search-forward "[ \t]+" to t)
6274 (ps-mule-set-ascii-font)
6275 (ps-plot 'ps-basic-plot-whitespace
6276 from (+ linestart (current-column))
6277 bg-color))))
6279 ((= match ?\n) ; newline
6280 (if (looking-at "\f[^\n]")
6281 ;; \n\ftext\n ==>> next page, but keep line counting!!
6282 (progn
6283 (ps-skip-newline to)
6284 (ps-next-page))
6285 ;; \n\f\n ==>> it'll be handled by form feed
6286 ;; \ntext\n ==>> next line
6287 (ps-next-line)))
6289 ((= match ?\f) ; form feed
6290 ;; do not skip page if previous character is NEWLINE and
6291 ;; it is a beginning of page.
6292 (unless (and (equal (char-after (1- match-point)) ?\n)
6293 (= ps-height-remaining ps-print-height))
6294 ;; \f\n ==>> skip \n, but keep line counting!!
6295 (and (equal (following-char) ?\n)
6296 (ps-skip-newline to))
6297 (ps-next-page)))
6299 (composition ; a composite sequence
6300 (ps-plot 'ps-mule-plot-composition match-point (point) bg-color))
6302 ((> match 255) ; a multi-byte character
6303 (setq match (or (aref ps-print-translation-table match) match))
6304 (let* ((charset (char-charset match))
6305 (composition (ps-e-find-composition match-point to))
6306 (stop (if (nth 2 composition) (car composition) to)))
6307 (or (eq charset 'composition)
6308 (while (and (< (point) stop)
6309 (let ((ch (following-char)))
6310 (setq ch
6311 (or (aref ps-print-translation-table ch)
6312 ch))
6313 (eq (char-charset ch) charset)))
6314 (forward-char 1)))
6315 (ps-plot 'ps-mule-plot-string match-point (point) bg-color)))
6316 ; characters from ^@ to ^_ and
6317 (t ; characters from 127 to 255
6318 (ps-control-character match)))
6319 (setq from (point)))
6320 ;; region without control characters nor multi-byte characters
6321 (ps-mule-set-ascii-font)
6322 (ps-plot 'ps-basic-plot-string from to bg-color)
6323 (setq from to)))))
6325 (defvar ps-string-control-codes
6326 (let ((table (make-vector 256 nil))
6327 (char ?\000))
6328 ;; control character
6329 (while (<= char ?\037)
6330 (aset table char (format "^%c" (+ char ?@)))
6331 (setq char (1+ char)))
6332 ;; printable character
6333 (while (< char ?\177)
6334 (aset table char (format "%c" char))
6335 (setq char (1+ char)))
6336 ;; DEL
6337 (aset table char "^?")
6338 ;; 8-bit character
6339 (while (<= (setq char (1+ char)) ?\377)
6340 (aset table char (format "\\%o" char)))
6341 table)
6342 "Vector used to map characters to a printable string.")
6344 (defun ps-control-character (char)
6345 (let* ((str (aref ps-string-control-codes char))
6346 (from (1- (point)))
6347 (len (length str))
6348 (to (+ from len))
6349 (char-width (ps-avg-char-width 'ps-font-for-text))
6350 (wrappoint (ps-find-wrappoint from to char-width)))
6351 (if (< (car wrappoint) to)
6352 (ps-continue-line))
6353 (setq ps-width-remaining (- ps-width-remaining (* len char-width)))
6354 (ps-mule-prepare-ascii-font str)
6355 (ps-output-string str)
6356 (ps-output " S\n")))
6359 (defsubst ps-face-foreground-color-p (attr)
6360 (memq attr '(foreground-color :foreground)))
6363 (defsubst ps-face-background-color-p (attr)
6364 (memq attr '(background-color :background)))
6367 (defsubst ps-face-color-p (attr)
6368 (memq attr '(foreground-color :foreground background-color :background)))
6371 (defun ps-face-attributes (face)
6372 "Return face attribute vector.
6374 If FACE is not in `ps-print-face-extension-alist' or in
6375 `ps-print-face-alist', insert it on `ps-print-face-alist' and
6376 return the attribute vector.
6378 If FACE is not a valid face name, use default face."
6379 (cond
6380 (ps-black-white-faces-alist
6381 (or (and (symbolp face)
6382 (cdr (assq face ps-black-white-faces-alist)))
6383 (vector 0 nil nil)))
6384 ((symbolp face)
6385 (cdr (or (assq face ps-print-face-extension-alist)
6386 (assq face ps-print-face-alist)
6387 (let* ((the-face (if (facep face) face 'default))
6388 (new-face (ps-screen-to-bit-face the-face)))
6389 (or (and (eq the-face 'default)
6390 (assq the-face ps-print-face-alist))
6391 (setq ps-print-face-alist
6392 (cons new-face ps-print-face-alist)))
6393 new-face))))
6394 ((ps-face-foreground-color-p (car face))
6395 (vector 0 (cdr face) nil))
6396 ((ps-face-background-color-p (car face))
6397 (vector 0 nil (cdr face)))
6399 (vector 0 nil nil))))
6402 (defun ps-face-background (face background)
6403 (and (cond ((eq ps-use-face-background t)) ; always
6404 ((null ps-use-face-background) nil) ; never
6405 ;; ps-user-face-background is a symbol face list
6406 ((symbolp face)
6407 (memq face ps-use-face-background))
6408 ((listp face)
6409 (or (ps-face-color-p (car face))
6410 (let (ok)
6411 (while face
6412 (if (or (memq (car face) ps-use-face-background)
6413 (ps-face-color-p (car face)))
6414 (setq face nil
6415 ok t)
6416 (setq face (cdr face))))
6417 ok)))
6419 nil)
6421 background))
6424 (defun ps-face-attribute-list (face-or-list)
6425 (cond
6426 ;; simple face
6427 ((not (listp face-or-list))
6428 (ps-face-attributes face-or-list))
6429 ;; only foreground color, not a `real' face
6430 ((ps-face-foreground-color-p (car face-or-list))
6431 (vector 0 (cdr face-or-list) nil))
6432 ;; only background color, not a `real' face
6433 ((ps-face-background-color-p (car face-or-list))
6434 (vector 0 nil (cdr face-or-list)))
6435 ;; list of faces
6437 (let ((effects 0)
6438 foreground background face-attr face)
6439 (while face-or-list
6440 (setq face (car face-or-list)
6441 face-or-list (cdr face-or-list)
6442 face-attr (ps-face-attributes face)
6443 effects (logior effects (aref face-attr 0)))
6444 (or foreground (setq foreground (aref face-attr 1)))
6445 (or background
6446 (setq background (ps-face-background face (aref face-attr 2)))))
6447 (vector effects foreground background)))))
6450 (defconst ps-font-type (vector nil 'bold 'italic 'bold-italic))
6453 (defun ps-plot-with-face (from to face)
6454 (cond
6455 ((null face) ; print text with null face
6456 (ps-plot-region from to 0))
6457 ((eq face 'emacs--invisible--face)) ; skip invisible text!!!
6458 (t ; otherwise, text has a valid face
6459 (let* ((face-bit (ps-face-attribute-list face))
6460 (effect (aref face-bit 0))
6461 (foreground (aref face-bit 1))
6462 (background (ps-face-background face (aref face-bit 2)))
6463 (fg-color (if (and ps-color-p foreground)
6464 (ps-color-scale foreground)
6465 ps-default-color))
6466 (bg-color (and ps-color-p background
6467 (ps-color-scale background))))
6468 (ps-plot-region
6469 from to
6470 (ps-font-number 'ps-font-for-text
6471 (or (aref ps-font-type (logand effect 3))
6472 face))
6473 fg-color bg-color (lsh effect -2)))))
6474 (goto-char to))
6477 ;; Ensure that face-list is fbound.
6478 (or (fboundp 'face-list) (defalias 'face-list 'list-faces))
6481 (defun ps-build-reference-face-lists ()
6482 ;; Ensure that face database is updated with faces on
6483 ;; `font-lock-face-attributes' (obsolete stuff)
6484 (ps-font-lock-face-attributes)
6485 ;; Now, rebuild reference face lists
6486 (setq ps-print-face-alist nil)
6487 (if ps-auto-font-detect
6488 (mapcar 'ps-map-face (face-list))
6489 (mapcar 'ps-set-face-bold ps-bold-faces)
6490 (mapcar 'ps-set-face-italic ps-italic-faces)
6491 (mapcar 'ps-set-face-underline ps-underlined-faces))
6492 (setq ps-build-face-reference nil))
6495 (defun ps-set-face-bold (face)
6496 (ps-set-face-attribute face 1))
6498 (defun ps-set-face-italic (face)
6499 (ps-set-face-attribute face 2))
6501 (defun ps-set-face-underline (face)
6502 (ps-set-face-attribute face 4))
6505 (defun ps-set-face-attribute (face effect)
6506 (let ((face-bit (cdr (ps-map-face face))))
6507 (aset face-bit 0 (logior (aref face-bit 0) effect))))
6510 (defun ps-map-face (face)
6511 (let* ((face-map (ps-screen-to-bit-face face))
6512 (ps-face-bit (cdr (assq (car face-map) ps-print-face-alist))))
6513 (if ps-face-bit
6514 ;; if face exists, merge both
6515 (let ((face-bit (cdr face-map)))
6516 (aset ps-face-bit 0 (logior (aref ps-face-bit 0) (aref face-bit 0)))
6517 (or (aref ps-face-bit 1) (aset ps-face-bit 1 (aref face-bit 1)))
6518 (or (aref ps-face-bit 2) (aset ps-face-bit 2 (aref face-bit 2))))
6519 ;; if face does not exist, insert it
6520 (setq ps-print-face-alist (cons face-map ps-print-face-alist)))
6521 face-map))
6524 (defun ps-screen-to-bit-face (face)
6525 (cons face
6526 (vector (logior (if (ps-face-bold-p face) 1 0) ; bold
6527 (if (ps-face-italic-p face) 2 0) ; italic
6528 (if (ps-face-underlined-p face) 4 0) ; underline
6529 (if (ps-face-strikeout-p face) 8 0) ; strikeout
6530 (if (ps-face-overline-p face) 16 0) ; overline
6531 (if (ps-face-box-p face) 64 0)) ; box
6532 (ps-face-foreground-name face)
6533 (ps-face-background-name face))))
6536 ;; to avoid compilation gripes
6537 (defalias 'ps-jitify 'jit-lock-fontify-now)
6538 (defalias 'ps-lazify 'lazy-lock-fontify-region)
6541 ;; to avoid compilation gripes
6542 (defun ps-print-ensure-fontified (start end)
6543 (cond ((and (boundp 'jit-lock-mode) (symbol-value 'jit-lock-mode))
6544 (ps-jitify start end))
6545 ((and (boundp 'lazy-lock-mode) (symbol-value 'lazy-lock-mode))
6546 (ps-lazify start end))))
6549 (defun ps-generate-postscript-with-faces (from to)
6550 ;; Some initialization...
6551 (setq ps-current-effect 0)
6553 ;; Build the reference lists of faces if necessary.
6554 (when (or ps-always-build-face-reference
6555 ps-build-face-reference)
6556 (message "Collecting face information...")
6557 (ps-build-reference-face-lists))
6559 ;; Black/white printer.
6560 (setq ps-black-white-faces-alist nil)
6561 (and (eq ps-print-color-p 'black-white)
6562 (ps-extend-face-list ps-black-white-faces nil
6563 'ps-black-white-faces-alist))
6565 ;; Generate some PostScript.
6566 (save-restriction
6567 (narrow-to-region from to)
6568 (ps-print-ensure-fontified from to)
6569 (let ((face 'default)
6570 (position to))
6571 (cond
6572 ((featurep 'xemacs) ; XEmacs
6573 ;; Build the list of extents...
6574 (let ((a (cons 'dummy nil))
6575 record type extent extent-list)
6576 (ps-x-map-extents 'ps-mapper nil from to a)
6577 (setq a (sort (cdr a) 'car-less-than-car)
6578 extent-list nil)
6580 ;; Loop through the extents...
6581 (while a
6582 (setq record (car a)
6583 position (car record)
6585 record (cdr record)
6586 type (car record)
6588 record (cdr record)
6589 extent (car record))
6591 ;; Plot up to this record.
6592 ;; XEmacs 19.12: for some reason, we're getting into a
6593 ;; situation in which some of the records have
6594 ;; positions less than 'from'. Since we've narrowed
6595 ;; the buffer, this'll generate errors. This is a hack,
6596 ;; but don't call ps-plot-with-face unless from > point-min.
6597 (and (>= from (point-min))
6598 (ps-plot-with-face from (min position (point-max)) face))
6600 (cond
6601 ((eq type 'push)
6602 (and (ps-x-extent-face extent)
6603 (setq extent-list (sort (cons extent extent-list)
6604 'ps-extent-sorter))))
6606 ((eq type 'pull)
6607 (setq extent-list (sort (delq extent extent-list)
6608 'ps-extent-sorter))))
6610 (setq face (if extent-list
6611 (ps-x-extent-face (car extent-list))
6612 'default)
6613 from position
6614 a (cdr a)))))
6616 (t ; Emacs
6617 (let ((property-change from)
6618 (overlay-change from)
6619 (save-buffer-invisibility-spec buffer-invisibility-spec)
6620 (buffer-invisibility-spec nil)
6621 before-string after-string)
6622 (while (< from to)
6623 (and (< property-change to) ; Don't search for property change
6624 ; unless previous search succeeded.
6625 (setq property-change (next-property-change from nil to)))
6626 (and (< overlay-change to) ; Don't search for overlay change
6627 ; unless previous search succeeded.
6628 (setq overlay-change (min (ps-e-next-overlay-change from)
6629 to)))
6630 (setq position (min property-change overlay-change)
6631 before-string nil
6632 after-string nil)
6633 ;; The code below is not quite correct,
6634 ;; because a non-nil overlay invisible property
6635 ;; which is inactive according to the current value
6636 ;; of buffer-invisibility-spec nonetheless overrides
6637 ;; a face text property.
6638 (setq face
6639 (cond ((let ((prop (get-text-property from 'invisible)))
6640 ;; Decide whether this invisible property
6641 ;; really makes the text invisible.
6642 (if (eq save-buffer-invisibility-spec t)
6643 (not (null prop))
6644 (or (memq prop save-buffer-invisibility-spec)
6645 (assq prop save-buffer-invisibility-spec))))
6646 'emacs--invisible--face)
6647 ((get-text-property from 'face))
6648 (t 'default)))
6649 (let ((overlays (ps-e-overlays-at from))
6650 (face-priority -1)) ; text-property
6651 (while (and overlays
6652 (not (eq face 'emacs--invisible--face)))
6653 (let* ((overlay (car overlays))
6654 (overlay-invisible
6655 (ps-e-overlay-get overlay 'invisible))
6656 (overlay-priority
6657 (or (ps-e-overlay-get overlay 'priority) 0)))
6658 (and (> overlay-priority face-priority)
6659 (setq before-string
6660 (or (ps-e-overlay-get overlay 'before-string)
6661 before-string)
6662 after-string
6663 (or (and (<= (ps-e-overlay-end overlay) position)
6664 (ps-e-overlay-get overlay 'after-string))
6665 after-string)
6666 face-priority overlay-priority
6667 face
6668 (cond
6669 ((if (eq save-buffer-invisibility-spec t)
6670 (not (null overlay-invisible))
6671 (or (memq overlay-invisible
6672 save-buffer-invisibility-spec)
6673 (assq overlay-invisible
6674 save-buffer-invisibility-spec)))
6675 'emacs--invisible--face)
6676 ((ps-e-overlay-get overlay 'face))
6677 (t face)
6678 ))))
6679 (setq overlays (cdr overlays)))
6680 ;; Ediff refinement overlays specify faces by name, as a
6681 ;; string, not as symbols.
6682 (if (stringp face)
6683 (setq face (intern face))))
6684 ;; Plot up to this record.
6685 (and before-string
6686 (ps-plot-string before-string))
6687 (ps-plot-with-face from position face)
6688 (and after-string
6689 (ps-plot-string after-string))
6690 (setq from position)))))
6691 (ps-plot-with-face from to face))))
6693 (defun ps-generate-postscript (from to)
6694 (ps-plot-region from to 0))
6696 (defun ps-generate (buffer from to genfunc)
6697 (save-excursion
6698 (let ((from (min to from))
6699 (to (max to from))
6700 ;; This avoids trouble if chars with read-only properties
6701 ;; are copied into ps-spool-buffer.
6702 (inhibit-read-only t))
6703 (save-restriction
6704 (narrow-to-region from to)
6705 (and ps-razzle-dazzle
6706 (message "Formatting...%3d%%" (setq ps-razchunk 0)))
6707 (setq ps-source-buffer buffer
6708 ps-spool-buffer (get-buffer-create ps-spool-buffer-name))
6709 (ps-init-output-queue)
6710 (let (safe-marker completed-safely needs-begin-file)
6711 (unwind-protect
6712 (progn
6713 (set-buffer ps-spool-buffer)
6714 (set-buffer-multibyte nil)
6716 ;; Get a marker and make it point to the current end of the
6717 ;; buffer, If an error occurs, we'll delete everything from
6718 ;; the end of this marker onwards.
6719 (setq safe-marker (make-marker))
6720 (set-marker safe-marker (point-max))
6722 (goto-char (point-min))
6723 (or (looking-at (regexp-quote ps-adobe-tag))
6724 (setq needs-begin-file t))
6726 (set-buffer ps-source-buffer)
6727 (save-excursion
6728 (let ((ps-print-page-p t)
6729 ps-even-or-odd-pages)
6730 (ps-begin-job genfunc)
6731 (when needs-begin-file
6732 (ps-begin-file)
6733 (ps-mule-initialize))
6734 (ps-mule-begin-job from to)
6735 (ps-selected-pages)))
6736 (ps-begin-page)
6737 (funcall genfunc from to)
6738 (ps-end-page)
6739 (ps-end-job needs-begin-file)
6741 ;; Setting this variable tells the unwind form that the
6742 ;; the PostScript was generated without error.
6743 (setq completed-safely t))
6745 ;; Unwind form: If some bad mojo occurred while generating
6746 ;; PostScript, delete all the PostScript that was generated.
6747 ;; This protects the previously spooled files from getting
6748 ;; corrupted.
6749 (and (markerp safe-marker) (not completed-safely)
6750 (progn
6751 (set-buffer ps-spool-buffer)
6752 (delete-region (marker-position safe-marker) (point-max))))))
6754 (and ps-razzle-dazzle (message "Formatting...done"))))))
6757 (defun ps-end-job (needs-begin-file)
6758 (let ((ps-print-page-p t))
6759 (ps-flush-output)
6760 (save-excursion
6761 (let ((pages-per-sheet (mod ps-page-printed ps-n-up-printing))
6762 (total-lines (cdr ps-printing-region))
6763 (total-pages (ps-page-number)))
6764 (set-buffer ps-spool-buffer)
6765 (let (case-fold-search)
6766 ;; Back to the PS output buffer to set the last page n-up printing
6767 (goto-char (point-max))
6768 (and (> pages-per-sheet 0)
6769 (re-search-backward "^[0-9]+ BeginSheet$" nil t)
6770 (replace-match (format "%d BeginSheet" pages-per-sheet) t))
6771 ;; Back to the PS output buffer to set the page count
6772 (goto-char (point-min))
6773 (while (re-search-forward "^/Lines 0 def\n/PageCount 0 def$" nil t)
6774 (replace-match (format "/Lines %d def\n/PageCount %d def"
6775 total-lines total-pages) t)))))
6776 ;; Set dummy page
6777 (and ps-spool-duplex (= (mod ps-page-order 2) 1)
6778 (let ((ps-n-up-printing 0))
6779 (ps-header-sheet)
6780 (ps-output "/PrintHeader false def\n/ColumnIndex 0 def\n"
6781 "/PrintLineNumber false def\n"
6782 (number-to-string ps-lines-printed) " BeginPage\n")
6783 (ps-end-page)))
6784 ;; Set end of PostScript file
6785 (ps-end-sheet)
6786 (ps-output "\n%%Trailer\n%%Pages: "
6787 (number-to-string
6788 (if (and needs-begin-file
6789 ps-banner-page-when-duplexing)
6790 (1+ ps-page-order)
6791 ps-page-order))
6792 "\n\nEndDoc\n\n%%EOF\n")
6793 (and ps-end-with-control-d
6794 (ps-output "\C-d"))
6795 (ps-flush-output))
6796 ;; disable selected pages
6797 (setq ps-selected-pages nil))
6800 ;; Permit dynamic evaluation at print time of `ps-lpr-switches'.
6801 (defun ps-do-despool (filename)
6802 (if (or (not (boundp 'ps-spool-buffer))
6803 (not (symbol-value 'ps-spool-buffer)))
6804 (message "No spooled PostScript to print")
6805 (if filename
6806 (save-excursion
6807 (and ps-razzle-dazzle (message "Saving..."))
6808 (set-buffer ps-spool-buffer)
6809 (setq filename (expand-file-name filename))
6810 (let ((coding-system-for-write 'raw-text-unix))
6811 (write-region (point-min) (point-max) filename))
6812 (and ps-razzle-dazzle (message "Wrote %s" filename)))
6813 ;; Else, spool to the printer
6814 (and ps-razzle-dazzle (message "Printing..."))
6815 (save-excursion
6816 (set-buffer ps-spool-buffer)
6817 (let* ((coding-system-for-write 'raw-text-unix)
6818 (ps-printer-name (or ps-printer-name
6819 (and (boundp 'printer-name)
6820 (symbol-value 'printer-name))))
6821 (ps-lpr-switches
6822 (append ps-lpr-switches
6823 (and (stringp ps-printer-name)
6824 (string< "" ps-printer-name)
6825 (list (concat
6826 (and (stringp ps-printer-name-option)
6827 ps-printer-name-option)
6828 ps-printer-name))))))
6829 (or (stringp ps-printer-name)
6830 (setq ps-printer-name nil))
6831 (apply (or ps-print-region-function 'call-process-region)
6832 (point-min) (point-max) ps-lpr-command nil
6833 (and (fboundp 'start-process) 0)
6835 (ps-flatten-list ; dynamic evaluation
6836 (mapcar 'ps-eval-switch ps-lpr-switches)))))
6837 (and ps-razzle-dazzle (message "Printing...done")))
6838 (kill-buffer ps-spool-buffer)))
6840 ;; Dynamic evaluation
6841 (defun ps-eval-switch (arg)
6842 (cond ((stringp arg) arg)
6843 ((functionp arg) (apply arg nil))
6844 ((symbolp arg) (symbol-value arg))
6845 ((consp arg) (apply (car arg) (cdr arg)))
6846 (t nil)))
6848 ;; `ps-flatten-list' is defined here (copied from "message.el" and
6849 ;; enhanced to handle dotted pairs as well) until we can get some
6850 ;; sensible autoloads, or `flatten-list' gets put somewhere decent.
6852 ;; (ps-flatten-list '((a . b) c (d . e) (f g h) i . j))
6853 ;; => (a b c d e f g h i j)
6855 (defun ps-flatten-list (&rest list)
6856 (ps-flatten-list-1 list))
6858 (defun ps-flatten-list-1 (list)
6859 (cond ((null list) nil)
6860 ((consp list) (append (ps-flatten-list-1 (car list))
6861 (ps-flatten-list-1 (cdr list))))
6862 (t (list list))))
6864 (defun ps-kill-emacs-check ()
6865 (let (ps-buffer)
6866 (and (setq ps-buffer (get-buffer ps-spool-buffer-name))
6867 (buffer-name ps-buffer) ; check if it's not killed
6868 (buffer-modified-p ps-buffer)
6869 (y-or-n-p "Unprinted PostScript waiting; print now? ")
6870 (ps-despool))
6871 (and (setq ps-buffer (get-buffer ps-spool-buffer-name))
6872 (buffer-name ps-buffer) ; check if it's not killed
6873 (buffer-modified-p ps-buffer)
6874 (not (yes-or-no-p "Unprinted PostScript waiting; exit anyway? "))
6875 (error "Unprinted PostScript"))))
6877 (cond ((fboundp 'add-hook)
6878 (funcall 'add-hook 'kill-emacs-hook 'ps-kill-emacs-check))
6879 (kill-emacs-hook
6880 (message "Won't override existing `kill-emacs-hook'"))
6882 (setq kill-emacs-hook 'ps-kill-emacs-check)))
6885 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
6886 ;;; Sample Setup Code:
6889 ;; This stuff is for anybody that's brave enough to look this far,
6890 ;; and able to figure out how to use it. It isn't really part of
6891 ;; ps-print, but I'll leave it here in hopes it might be useful:
6893 ;; WARNING!!! The following code is *sample* code only.
6894 ;; Don't use it unless you understand what it does!
6896 ;; The key `f22' should probably be replaced by `print'. --Stef
6898 ;; A hook to bind to `rmail-mode-hook' to locally bind prsc and set the
6899 ;; `ps-left-headers' specially for mail messages.
6900 (defun ps-rmail-mode-hook ()
6901 (local-set-key [(f22)] 'ps-rmail-print-message-from-summary)
6902 (setq ps-header-lines 3
6903 ps-left-header
6904 ;; The left headers will display the message's subject, its
6905 ;; author, and the name of the folder it was in.
6906 '(ps-article-subject ps-article-author buffer-name)))
6908 ;; See `ps-gnus-print-article-from-summary'. This function does the
6909 ;; same thing for rmail.
6910 (defun ps-rmail-print-message-from-summary ()
6911 (interactive)
6912 (ps-print-message-from-summary 'rmail-summary-buffer "RMAIL"))
6914 ;; Used in `ps-rmail-print-article-from-summary',
6915 ;; `ps-gnus-print-article-from-summary' and `ps-vm-print-message-from-summary'.
6916 (defun ps-print-message-from-summary (summary-buffer summary-default)
6917 (let ((ps-buf (or (and (boundp summary-buffer)
6918 (symbol-value summary-buffer))
6919 summary-default)))
6920 (and (get-buffer ps-buf)
6921 (save-excursion
6922 (set-buffer ps-buf)
6923 (ps-spool-buffer-with-faces)))))
6925 ;; Look in an article or mail message for the Subject: line. To be
6926 ;; placed in `ps-left-headers'.
6927 (defun ps-article-subject ()
6928 (save-excursion
6929 (goto-char (point-min))
6930 (if (re-search-forward "^Subject:[ \t]+\\(.*\\)$" nil t)
6931 (buffer-substring (match-beginning 1) (match-end 1))
6932 "Subject ???")))
6934 ;; Look in an article or mail message for the From: line. Sorta-kinda
6935 ;; understands RFC-822 addresses and can pull the real name out where
6936 ;; it's provided. To be placed in `ps-left-headers'.
6937 (defun ps-article-author ()
6938 (save-excursion
6939 (goto-char (point-min))
6940 (if (re-search-forward "^From:[ \t]+\\(.*\\)$" nil t)
6941 (let ((fromstring (buffer-substring (match-beginning 1) (match-end 1))))
6942 (cond
6944 ;; Try first to match addresses that look like
6945 ;; thompson@wg2.waii.com (Jim Thompson)
6946 ((string-match ".*[ \t]+(\\(.*\\))" fromstring)
6947 (substring fromstring (match-beginning 1) (match-end 1)))
6949 ;; Next try to match addresses that look like
6950 ;; Jim Thompson <thompson@wg2.waii.com> or
6951 ;; "Jim Thompson" <thompson@wg2.waii.com>
6952 ((string-match "\\(\"?\\)\\(.*\\)\\1[ \t]+<.*>" fromstring)
6953 (substring fromstring (match-beginning 2) (match-end 2)))
6955 ;; Couldn't find a real name -- show the address instead.
6956 (t fromstring)))
6957 "From ???")))
6959 ;; A hook to bind to `gnus-article-prepare-hook'. This will set the
6960 ;; `ps-left-headers' specially for gnus articles. Unfortunately,
6961 ;; `gnus-article-mode-hook' is called only once, the first time the *Article*
6962 ;; buffer enters that mode, so it would only work for the first time
6963 ;; we ran gnus. The second time, this hook wouldn't get set up. The
6964 ;; only alternative is `gnus-article-prepare-hook'.
6965 (defun ps-gnus-article-prepare-hook ()
6966 (setq ps-header-lines 3
6967 ps-left-header
6968 ;; The left headers will display the article's subject, its
6969 ;; author, and the newsgroup it was in.
6970 '(ps-article-subject ps-article-author gnus-newsgroup-name)))
6972 ;; A hook to bind to `vm-mode-hook' to locally bind prsc and set the
6973 ;; `ps-left-headers' specially for mail messages.
6974 (defun ps-vm-mode-hook ()
6975 (local-set-key [(f22)] 'ps-vm-print-message-from-summary)
6976 (setq ps-header-lines 3
6977 ps-left-header
6978 ;; The left headers will display the message's subject, its
6979 ;; author, and the name of the folder it was in.
6980 '(ps-article-subject ps-article-author buffer-name)))
6982 ;; Every now and then I forget to switch from the *Summary* buffer to
6983 ;; the *Article* before hitting prsc, and a nicely formatted list of
6984 ;; article subjects shows up at the printer. This function, bound to
6985 ;; prsc for the gnus *Summary* buffer means I don't have to switch
6986 ;; buffers first.
6987 ;; sb: Updated for Gnus 5.
6988 (defun ps-gnus-print-article-from-summary ()
6989 (interactive)
6990 (ps-print-message-from-summary 'gnus-article-buffer "*Article*"))
6992 ;; See `ps-gnus-print-article-from-summary'. This function does the
6993 ;; same thing for vm.
6994 (defun ps-vm-print-message-from-summary ()
6995 (interactive)
6996 (ps-print-message-from-summary 'vm-mail-buffer ""))
6998 ;; A hook to bind to bind to `gnus-summary-setup-buffer' to locally bind
6999 ;; prsc.
7000 (defun ps-gnus-summary-setup ()
7001 (local-set-key [(f22)] 'ps-gnus-print-article-from-summary))
7003 ;; Look in an article or mail message for the Subject: line. To be
7004 ;; placed in `ps-left-headers'.
7005 (defun ps-info-file ()
7006 (save-excursion
7007 (goto-char (point-min))
7008 (if (re-search-forward "File:[ \t]+\\([^, \t\n]*\\)" nil t)
7009 (buffer-substring (match-beginning 1) (match-end 1))
7010 "File ???")))
7012 ;; Look in an article or mail message for the Subject: line. To be
7013 ;; placed in `ps-left-headers'.
7014 (defun ps-info-node ()
7015 (save-excursion
7016 (goto-char (point-min))
7017 (if (re-search-forward "Node:[ \t]+\\([^,\t\n]*\\)" nil t)
7018 (buffer-substring (match-beginning 1) (match-end 1))
7019 "Node ???")))
7021 (defun ps-info-mode-hook ()
7022 (setq ps-left-header
7023 ;; The left headers will display the node name and file name.
7024 '(ps-info-node ps-info-file)))
7026 ;; WARNING! The following function is a *sample* only, and is *not*
7027 ;; meant to be used as a whole unless you understand what the effects
7028 ;; will be! (In fact, this is a copy of Jim's setup for ps-print --
7029 ;; I'd be very surprised if it was useful to *anybody*, without
7030 ;; modification.)
7032 (defun ps-jts-ps-setup ()
7033 (global-set-key [(f22)] 'ps-spool-buffer-with-faces) ;f22 is prsc
7034 (global-set-key [(shift f22)] 'ps-spool-region-with-faces)
7035 (global-set-key [(control f22)] 'ps-despool)
7036 (add-hook 'gnus-article-prepare-hook 'ps-gnus-article-prepare-hook)
7037 (add-hook 'gnus-summary-mode-hook 'ps-gnus-summary-setup)
7038 (add-hook 'vm-mode-hook 'ps-vm-mode-hook)
7039 (add-hook 'vm-mode-hooks 'ps-vm-mode-hook)
7040 (add-hook 'Info-mode-hook 'ps-info-mode-hook)
7041 (setq ps-spool-duplex t
7042 ps-print-color-p nil
7043 ps-lpr-command "lpr"
7044 ps-lpr-switches '("-Jjct,duplex_long"))
7045 'ps-jts-ps-setup)
7047 ;; WARNING! The following function is a *sample* only, and is *not*
7048 ;; meant to be used as a whole unless it corresponds to your needs.
7049 ;; (In fact, this is a copy of Jack's setup for ps-print --
7050 ;; I would not be that surprised if it was useful to *anybody*,
7051 ;; without modification.)
7053 (defun ps-jack-setup ()
7054 (setq ps-print-color-p nil
7055 ps-lpr-command "lpr"
7056 ps-lpr-switches nil
7058 ps-paper-type 'a4
7059 ps-landscape-mode t
7060 ps-number-of-columns 2
7062 ps-left-margin (/ (* 72 1.0) 2.54) ; 1.0 cm
7063 ps-right-margin (/ (* 72 1.0) 2.54) ; 1.0 cm
7064 ps-inter-column (/ (* 72 1.0) 2.54) ; 1.0 cm
7065 ps-bottom-margin (/ (* 72 1.5) 2.54) ; 1.5 cm
7066 ps-top-margin (/ (* 72 1.5) 2.54) ; 1.5 cm
7067 ps-header-offset (/ (* 72 1.0) 2.54) ; 1.0 cm
7068 ps-header-line-pad .15
7069 ps-print-header t
7070 ps-print-header-frame t
7071 ps-header-lines 2
7072 ps-show-n-of-n t
7073 ps-spool-duplex nil
7075 ps-font-family 'Courier
7076 ps-font-size 5.5
7077 ps-header-font-family 'Helvetica
7078 ps-header-font-size 6
7079 ps-header-title-font-size 8)
7080 'ps-jack-setup)
7083 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
7084 ;; To make this file smaller, some commands go in a separate file.
7085 ;; But autoload them here to make the separation invisible.
7087 (autoload 'ps-mule-prepare-ascii-font "ps-mule"
7088 "Setup special ASCII font for STRING.
7089 STRING should contain only ASCII characters.")
7091 (autoload 'ps-mule-set-ascii-font "ps-mule"
7092 "Adjust current font if current charset is not ASCII.")
7094 (autoload 'ps-mule-plot-string "ps-mule"
7095 "Generate PostScript code for plotting characters in the region FROM and TO.
7097 It is assumed that all characters in this region belong to the same charset.
7099 Optional argument BG-COLOR specifies background color.
7101 Returns the value:
7103 (ENDPOS . RUN-WIDTH)
7105 Where ENDPOS is the end position of the sequence and RUN-WIDTH is the width of
7106 the sequence.")
7108 (autoload 'ps-mule-initialize "ps-mule"
7109 "Initialize global data for printing multi-byte characters.")
7111 (autoload 'ps-mule-begin-job "ps-mule"
7112 "Start printing job for multi-byte chars between FROM and TO.
7113 This checks if all multi-byte characters in the region are printable or not.")
7115 (autoload 'ps-mule-begin-page "ps-mule"
7116 "Initialize multi-byte charset for printing current page.")
7118 (autoload 'ps-mule-encode-header-string "ps-mule"
7119 "Generate PostScript code for plotting characters in header STRING.
7121 It is assumed that the length of STRING is not zero.")
7124 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
7126 (provide 'ps-print)
7128 ;; arch-tag: fb06a585-1112-4206-885d-a57d95d50579
7129 ;;; ps-print.el ends here