Rob Riepel <riepel at networking.stanford.edu>
[emacs.git] / lisp / ps-print.el
blobd15d5879d69c4a10ca170b6399c7baa79bd19929
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 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.8
14 ;; X-URL: http://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre
16 (defconst ps-print-version "6.8"
17 "ps-print.el, v 6.8 <2007/10/26 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.
1092 ;; ps-print also detects if the text foreground and background colors are
1093 ;; equals when `ps-fg-validate-p' is non-nil. In this case, if these colors
1094 ;; are used, no text will appear. You can use `ps-fg-list' to give a list of
1095 ;; foreground colors to be used when text foreground and background colors are
1096 ;; equals. It'll be used the first foreground color in `ps-fg-list' which is
1097 ;; different from the background color. If `ps-fg-list' is nil, the default
1098 ;; foreground color is used.
1101 ;; How Ps-Print Maps Faces
1102 ;; -----------------------
1104 ;; As ps-print uses PostScript to print buffers, it is possible to have other
1105 ;; attributes associated with faces. So the new attributes used by ps-print
1106 ;; are:
1108 ;; strikeout - like underline, but the line is in middle of text.
1109 ;; overline - like underline, but the line is over the text.
1110 ;; shadow - text will have a shadow.
1111 ;; box - text will be surrounded by a box.
1112 ;; outline - print characters as hollow outlines.
1114 ;; See the documentation for `ps-extend-face'.
1116 ;; Let's, for example, remap `font-lock-keyword-face' to another foreground
1117 ;; color and bold attribute:
1119 ;; (ps-extend-face '(font-lock-keyword-face "RoyalBlue" nil bold) 'MERGE)
1121 ;; If you want to use a new face, define it first with `defface', and then call
1122 ;; `ps-extend-face' to specify how to print it.
1125 ;; How Ps-Print Has A Text And/Or Image On Background
1126 ;; --------------------------------------------------
1128 ;; ps-print can print texts and/or EPS PostScript images on background; it is
1129 ;; possible to define the following text attributes: font name, font size,
1130 ;; initial position, angle, gray scale and pages to print.
1132 ;; It has the following EPS PostScript images attributes: file name containing
1133 ;; the image, initial position, X and Y scales, angle and pages to print.
1135 ;; See documentation for `ps-print-background-text' and
1136 ;; `ps-print-background-image'.
1138 ;; For example, if we wish to print text "preliminary" on all pages and text
1139 ;; "special" on page 5 and from page 11 to page 17, we could specify:
1141 ;; (setq ps-print-background-text
1142 ;; '(("preliminary")
1143 ;; ("special"
1144 ;; "LeftMargin" "BottomMargin PrintHeight add" ; X and Y position
1145 ;; ; (upper left corner)
1146 ;; nil nil nil
1147 ;; "PrintHeight neg PrintPageWidth atan" ; angle
1148 ;; 5 (11 . 17)) ; page list
1149 ;; ))
1151 ;; Similarly, we could print image "~/images/EPS-image1.ps" on all pages and
1152 ;; image "~/images/EPS-image2.ps" on page 5 and from page 11 to page 17, we
1153 ;; specify:
1155 ;; (setq ps-print-background-image
1156 ;; '(("~/images/EPS-image1.ps"
1157 ;; "LeftMargin" "BottomMargin") ; X and Y position (lower left corner)
1158 ;; ("~/images/EPS-image2.ps"
1159 ;; "LeftMargin" "BottomMargin PrintHeight 2 div add" ; X and Y pos.
1160 ;; ; (upper left corner)
1161 ;; nil nil nil
1162 ;; 5 (11 . 17)) ; page list
1163 ;; ))
1165 ;; If it is not possible to read (or does not exist) an image file, that file
1166 ;; is ignored.
1168 ;; The printing order is:
1170 ;; 1. Print background color
1171 ;; 2. Print zebra stripes
1172 ;; 3. Print background texts that it should be on all pages
1173 ;; 4. Print background images that it should be on all pages
1174 ;; 5. Print background texts only for current page (if any)
1175 ;; 6. Print background images only for current page (if any)
1176 ;; 7. Print header
1177 ;; 8. Print buffer text (with faces, if specified) and line number
1180 ;; Utilities
1181 ;; ---------
1183 ;; Some tools are provided to help you customize your font setup.
1185 ;; `ps-setup' returns (some part of) the current setup.
1187 ;; To avoid wrapping too many lines, you may want to adjust the left and right
1188 ;; margins and the font size. On UN*X systems, do:
1189 ;; pr -t file | awk '{printf "%3d %s\n", length($0), $0}' | sort -r | head
1190 ;; to determine the longest lines of your file.
1191 ;; Then, the command `ps-line-lengths' will give you the correspondence between
1192 ;; a line length (number of characters) and the maximum font size which doesn't
1193 ;; wrap such a line with the current ps-print setup.
1195 ;; The commands `ps-nb-pages-buffer' and `ps-nb-pages-region' display the
1196 ;; correspondence between a number of pages and the maximum font size which
1197 ;; allow the number of lines of the current buffer or of its current region to
1198 ;; fit in this number of pages.
1200 ;; NOTE: line folding is not taken into account in this process and could
1201 ;; change the results.
1203 ;; The command `ps-print-customize' activates a customization buffer for
1204 ;; ps-print options.
1207 ;; New since version 1.5
1208 ;; ---------------------
1210 ;; Color output capability.
1211 ;; Automatic detection of font attributes (bold, italic).
1212 ;; Configurable headers with page numbers.
1213 ;; Slightly faster.
1214 ;; Support for different paper sizes.
1215 ;; Better conformance to PostScript Document Structure Conventions.
1218 ;; New since version 2.8
1219 ;; ---------------------
1221 ;; [vinicius] Vinicius Jose Latorre <viniciusjl@ig.com.br>
1223 ;; 2007-10-27
1224 ;; `ps-fg-validate-p', `ps-fg-list'
1226 ;; 2004-02-29
1227 ;; `ps-time-stamp-yyyy-mm-dd', `ps-time-stamp-iso8601'
1229 ;; 2001-06-19
1230 ;; `ps-time-stamp-locale-default'
1232 ;; 2001-05-30
1233 ;; Handle before-string and after-string overlay properties.
1235 ;; 2001-04-07
1236 ;; `ps-line-number-color', `ps-print-footer', `ps-footer-offset',
1237 ;; `ps-print-footer-frame', `ps-footer-font-family',
1238 ;; `ps-footer-font-size', `ps-footer-line-pad', `ps-footer-lines',
1239 ;; `ps-left-footer', `ps-right-footer', `ps-footer-frame-alist' and
1240 ;; `ps-header-frame-alist'.
1242 ;; 2001-03-28
1243 ;; `ps-line-spacing', `ps-paragraph-spacing', `ps-paragraph-regexp',
1244 ;; `ps-begin-cut-regexp' and `ps-end-cut-regexp'.
1246 ;; 2000-11-22
1247 ;; `ps-line-number-font', `ps-line-number-font-size' and
1248 ;; `ps-end-with-control-d'.
1250 ;; 2000-08-21
1251 ;; `ps-even-or-odd-pages'
1253 ;; 2000-06-17
1254 ;; `ps-manual-feed', `ps-warn-paper-type', `ps-print-upside-down',
1255 ;; `ps-selected-pages', `ps-last-selected-pages',
1256 ;; `ps-restore-selected-pages', `ps-switch-header',
1257 ;; `ps-line-number-step', `ps-line-number-start',
1258 ;; `ps-zebra-stripe-follow' and `ps-use-face-background'.
1260 ;; 2000-03-10
1261 ;; PostScript error handler.
1262 ;; `ps-user-defined-prologue' and `ps-error-handler-message'.
1264 ;; 1999-12-11
1265 ;; `ps-print-customize'.
1267 ;; 1999-07-03
1268 ;; Better customization.
1269 ;; `ps-banner-page-when-duplexing' and `ps-zebra-color'.
1271 ;; 1999-05-13
1272 ;; N-up printing.
1273 ;; Hook: `ps-print-begin-sheet-hook'.
1275 ;; [kenichi] 1999-05-09 Ken'ichi Handa <handa@m17n.org>
1277 ;; `ps-print-region-function'
1279 ;; [vinicius] Vinicius Jose Latorre <viniciusjl@ig.com.br>
1281 ;; 1999-03-01
1282 ;; PostScript tumble and setpagedevice.
1284 ;; 1998-09-22
1285 ;; PostScript prologue header comment insertion.
1286 ;; Skip invisible text better.
1288 ;; [kenichi] 1998-08-19 Ken'ichi Handa <handa@m17n.org>
1290 ;; Multi-byte buffer handling.
1292 ;; [vinicius] Vinicius Jose Latorre <viniciusjl@ig.com.br>
1294 ;; 1998-03-06
1295 ;; Skip invisible text.
1297 ;; 1997-11-30
1298 ;; Hooks: `ps-print-hook', `ps-print-begin-page-hook' and
1299 ;; `ps-print-begin-column-hook'.
1300 ;; Put one header per page over the columns.
1301 ;; Better database font management.
1302 ;; Better control characters handling.
1304 ;; 1997-11-21
1305 ;; Dynamic evaluation at print time of `ps-lpr-switches'.
1306 ;; Handle control characters.
1307 ;; Face remapping.
1308 ;; New face attributes.
1309 ;; Line number.
1310 ;; Zebra stripes.
1311 ;; Text and/or image on background.
1313 ;; [jack] 1996-05-17 Jacques Duthen <duthen@cegelec-red.fr>
1315 ;; Font family and float size for text and header.
1316 ;; Landscape mode.
1317 ;; Multiple columns.
1318 ;; Tools for page setup.
1321 ;; Known bugs and limitations of ps-print
1322 ;; --------------------------------------
1324 ;; Although color printing will work in XEmacs 19.12, it doesn't work well; in
1325 ;; particular, bold or italic fonts don't print in the right background color.
1327 ;; Invisible properties aren't correctly ignored in XEmacs 19.12.
1329 ;; Automatic font-attribute detection doesn't work well, especially with
1330 ;; hilit19 and older versions of get-create-face. Users having problems with
1331 ;; auto-font detection should use the lists `ps-italic-faces', `ps-bold-faces'
1332 ;; and `ps-underlined-faces' and/or turn off automatic detection by setting
1333 ;; `ps-auto-font-detect' to nil.
1335 ;; Automatic font-attribute detection doesn't work with XEmacs 19.12 in tty
1336 ;; mode; use the lists `ps-italic-faces', `ps-bold-faces' and
1337 ;; `ps-underlined-faces' instead.
1339 ;; Still too slow; could use some hand-optimization.
1341 ;; Default background color isn't working.
1343 ;; Faces are always treated as opaque.
1345 ;; Epoch, Lucid and Emacs 21 not supported. At all.
1347 ;; Fixed-pitch fonts work better for line folding, but are not required.
1349 ;; `ps-nb-pages-buffer' and `ps-nb-pages-region' don't take care of folding
1350 ;; lines.
1353 ;; Things to change
1354 ;; ----------------
1356 ;; Avoid page break inside a paragraph.
1358 ;; Add `ps-non-bold-faces' and `ps-non-italic-faces' (should be easy).
1360 ;; Improve the memory management for big files (hard?).
1362 ;; `ps-nb-pages-buffer' and `ps-nb-pages-region' should take care of folding
1363 ;; lines.
1366 ;; Acknowledgments
1367 ;; ---------------
1369 ;; Thanks to Michael Piotrowski <mxp@dynalabs.de> for improving the DSC
1370 ;; compliance of the generated PostScript.
1372 ;; Thanks to Adam Doppelt <adoppelt@avogadro.com> for face mapping suggestion
1373 ;; for black/white PostScript printers.
1375 ;; Thanks to Toni Ronkko <tronkko@hytti.uku.fi> for line and paragraph spacing,
1376 ;; region to cut out when printing and footer suggestions.
1378 ;; Thanks to Pavel Janik ml <Pavel@Janik.cz> for documentation correction.
1380 ;; Thanks to Corinne Ilvedson <cilvedson@draper.com> for line number font size
1381 ;; suggestion.
1383 ;; Thanks to Gord Wait <Gord_Wait@spectrumsignal.com> for
1384 ;; `ps-user-defined-prologue' example setting for HP PostScript printer.
1386 ;; Thanks to Paul Furnanz <pfurnanz@synopsys.com> for XEmacs compatibility
1387 ;; suggestion for `ps-postscript-code-directory' variable.
1389 ;; Thanks to David X Callaway <dxc@xprt.net> for helping debugging PostScript
1390 ;; level 1 compatibility.
1392 ;; Thanks to Colin Marquardt <colin.marquardt@usa.alcatel.com> for:
1393 ;; - upside-down, line number step, line number start and zebra stripe
1394 ;; follow suggestions.
1395 ;; - `ps-time-stamp-yyyy-mm-dd' and `ps-time-stamp-iso8601' suggestion.
1396 ;; - and for XEmacs beta-tests.
1398 ;; Thanks to Klaus Berndl <klaus.berndl@sdm.de> for user defined PostScript
1399 ;; prologue code suggestion, for odd/even printing suggestion and for
1400 ;; `ps-prologue-file' enhancement.
1402 ;; Thanks to Ken'ichi Handa <handa@m17n.org> for multi-byte buffer handling.
1404 ;; Thanks to Matthew O Persico <Matthew.Persico@lazard.com> for line number on
1405 ;; empty columns.
1407 ;; Thanks to Theodore Jump <tjump@cais.com> for adjust PostScript code order on
1408 ;; last page.
1410 ;; Thanks to Roland Ducournau <ducour@lirmm.fr> for
1411 ;; `ps-print-control-characters' variable documentation.
1413 ;; Thanks to Marcus G Daniels <marcus@cathcart.sysc.pdx.edu> for a better
1414 ;; database font management.
1416 ;; Thanks to Martin Boyer <gamin@videotron.ca> for some ideas on putting one
1417 ;; header per page over the columns and correct line numbers when printing a
1418 ;; region.
1420 ;; Thanks to Steven L Baur <steve@miranova.com> for dynamic evaluation at
1421 ;; print time of `ps-lpr-switches'.
1423 ;; Thanks to Kevin Rodgers <kevinr@ihs.com> for handling control characters
1424 ;; (his code was severely modified, but the main idea was kept).
1426 ;; Thanks to some suggestions on:
1427 ;; * Face color map: Marco Melgazzi <marco@techie.com>
1428 ;; * XEmacs compatibility: William J. Henney <will@astrosmo.unam.mx>
1429 ;; * Check `ps-paper-type': Sudhakar Frederick <sfrederi@asc.corp.mot.com>
1431 ;; Thanks to Jacques Duthen <duthen@cegelec-red.fr> (Jack) for version 3.4 I
1432 ;; started from. [vinicius]
1434 ;; Thanks to Jim Thompson <?@?> for the 2.8 version I started from. [jack]
1436 ;; Thanks to Kevin Rodgers <kevinr@ihs.com> for adding support for color and
1437 ;; the invisible property.
1439 ;; Thanks to Avishai Yacobi, avishaiy@mcil.comm.mot.com, for writing the
1440 ;; initial port to Emacs 19. His code is no longer part of ps-print, but his
1441 ;; work is still appreciated.
1443 ;; Thanks to Remi Houdaille and Michel Train <michel@metasoft.fdn.org> for
1444 ;; adding underline support. Their code also is no longer part of ps-print,
1445 ;; but their efforts are not forgotten.
1447 ;; Thanks also to all of you who mailed code to add features to ps-print;
1448 ;; although I didn't use your code, I still appreciate your sharing it with me.
1450 ;; Thanks to all who mailed comments, encouragement, and criticism.
1451 ;; Thanks also to all who responded to my survey; I had too many responses to
1452 ;; reply to them all, but I greatly appreciate your interest.
1454 ;; Jim
1455 ;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1457 ;;; Code:
1460 (require 'lpr)
1462 (or (featurep 'lisp-float-type)
1463 (error "`ps-print' requires floating point support"))
1465 (let ((case-fold-search t))
1466 (cond ((featurep 'xemacs))
1468 (unless (and (boundp 'emacs-major-version)
1469 (>= emacs-major-version 22))
1470 (error "`ps-print' only supports Emacs 22 and higher")))))
1473 ;; GNU Emacs
1474 (or (fboundp 'line-beginning-position)
1475 (defun line-beginning-position (&optional n)
1476 (save-excursion
1477 (and n (/= n 1) (forward-line (1- n)))
1478 (beginning-of-line)
1479 (point))))
1482 ;; to avoid compilation gripes
1484 ;; GNU Emacs
1485 (defalias 'ps-e-find-composition (if (fboundp 'find-composition)
1486 'find-composition
1487 'ignore))
1490 (defconst ps-windows-system
1491 (memq system-type '(emx win32 w32 mswindows ms-dos windows-nt)))
1492 (defconst ps-lp-system
1493 (memq system-type '(usg-unix-v dgux hpux irix)))
1496 (defun ps-xemacs-color-name (color)
1497 (when (featurep 'xemacs)
1498 (if (color-specifier-p color)
1499 (color-name color)
1500 color)))
1502 (defalias 'ps-frame-parameter
1503 (if (fboundp 'frame-parameter) 'frame-parameter 'frame-property))
1505 (defalias 'ps-mark-active-p
1506 (if (fboundp 'region-active-p)
1507 'region-active-p ; XEmacs
1508 (defvar mark-active) ; To shup up XEmacs's byte compiler.
1509 (lambda () mark-active))) ; Emacs
1511 (defun ps-face-foreground-name (face)
1512 (if (featurep 'xemacs)
1513 (ps-xemacs-color-name (face-foreground face))
1514 (face-foreground face nil t)))
1516 (defun ps-face-background-name (face)
1517 (if (featurep 'xemacs)
1518 (ps-xemacs-color-name (face-background face))
1519 (face-background face nil t)))
1521 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1522 ;; User Variables:
1525 ;;; Interface to the command system
1527 (defgroup postscript nil
1528 "PostScript Group."
1529 :tag "PostScript"
1530 :version "20"
1531 :group 'emacs)
1533 (defgroup ps-print nil
1534 "PostScript generator for Emacs."
1535 :link '(emacs-library-link :tag "Source Lisp File" "ps-print.el")
1536 :prefix "ps-"
1537 :version "20"
1538 :group 'wp
1539 :group 'postscript)
1541 (defgroup ps-print-horizontal nil
1542 "Horizontal page layout."
1543 :prefix "ps-"
1544 :tag "Horizontal"
1545 :version "20"
1546 :group 'ps-print)
1548 (defgroup ps-print-vertical nil
1549 "Vertical page layout."
1550 :prefix "ps-"
1551 :tag "Vertical"
1552 :version "20"
1553 :group 'ps-print)
1555 (defgroup ps-print-headers nil
1556 "Headers & footers layout."
1557 :prefix "ps-"
1558 :tag "Header & Footer"
1559 :version "20"
1560 :group 'ps-print)
1562 (defgroup ps-print-font nil
1563 "Fonts customization."
1564 :prefix "ps-"
1565 :tag "Font"
1566 :version "20"
1567 :group 'ps-print)
1569 (defgroup ps-print-color nil
1570 "Color customization."
1571 :prefix "ps-"
1572 :tag "Color"
1573 :version "20"
1574 :group 'ps-print)
1576 (defgroup ps-print-face nil
1577 "Faces customization."
1578 :prefix "ps-"
1579 :tag "PS Faces"
1580 :version "20"
1581 :group 'ps-print
1582 :group 'faces)
1584 (defgroup ps-print-n-up nil
1585 "N-up customization."
1586 :prefix "ps-"
1587 :tag "N-Up"
1588 :version "20"
1589 :group 'ps-print)
1591 (defgroup ps-print-zebra nil
1592 "Zebra customization."
1593 :prefix "ps-"
1594 :tag "Zebra"
1595 :version "20"
1596 :group 'ps-print)
1598 (defgroup ps-print-background nil
1599 "Background customization."
1600 :prefix "ps-"
1601 :tag "Background"
1602 :version "20"
1603 :group 'ps-print)
1605 (defgroup ps-print-printer '((lpr custom-group))
1606 "Printer customization."
1607 :prefix "ps-"
1608 :tag "Printer"
1609 :version "20"
1610 :group 'ps-print)
1612 (defgroup ps-print-page nil
1613 "Page customization."
1614 :prefix "ps-"
1615 :tag "Page"
1616 :version "20"
1617 :group 'ps-print)
1619 (defgroup ps-print-miscellany nil
1620 "Miscellany customization."
1621 :prefix "ps-"
1622 :tag "Miscellany"
1623 :version "20"
1624 :group 'ps-print)
1627 (defcustom ps-error-handler-message 'paper
1628 "*Specify where the error handler message should be sent.
1630 Valid values are:
1632 `none' catch the error and *DON'T* send any message.
1634 `paper' catch the error and print on paper the error message.
1636 `system' catch the error and send back the error message to
1637 printing system. This is useful only if printing system
1638 send back an email reporting the error, or if there is
1639 some other alternative way to report back the error from
1640 the system to you.
1642 `paper-and-system' catch the error, print on paper the error message and
1643 send back the error message to printing system.
1645 Any other value is treated as `paper'."
1646 :type '(choice :menu-tag "Error Handler Message"
1647 :tag "Error Handler Message"
1648 (const none) (const paper)
1649 (const system) (const paper-and-system))
1650 :version "20"
1651 :group 'ps-print-miscellany)
1653 (defcustom ps-user-defined-prologue nil
1654 "*User defined PostScript prologue code inserted before all prologue code.
1656 `ps-user-defined-prologue' may be a string or a symbol function which returns a
1657 string. Note that this string is inserted after `ps-adobe-tag' and PostScript
1658 prologue comments, and before ps-print PostScript prologue code section. That
1659 is, this string is inserted after error handler initialization and before
1660 ps-print settings.
1662 It's strongly recommended only insert PostScript code and/or comments specific
1663 for your printing system particularities. For example, some special
1664 initialization that only your printing system needs.
1666 Do not insert code for duplex printing, n-up printing or error handler,
1667 ps-print handles this in a suitable way.
1669 For more information about PostScript, see:
1670 PostScript Language Reference Manual (2nd edition)
1671 Adobe Systems Incorporated
1673 As an example for `ps-user-defined-prologue' setting:
1675 ;; Setting for HP PostScript printer
1676 (setq ps-user-defined-prologue
1677 (concat \"<</DeferredMediaSelection true /PageSize [612 792] \"
1678 \"/MediaPosition 2 /MediaType (Plain)>> setpagedevice\"))"
1679 :type '(choice :menu-tag "User Defined Prologue"
1680 :tag "User Defined Prologue"
1681 (const :tag "none" nil) string symbol)
1682 :version "20"
1683 :group 'ps-print-miscellany)
1685 (defcustom ps-print-prologue-header nil
1686 "*PostScript prologue header comments besides that ps-print generates.
1688 `ps-print-prologue-header' may be a string or a symbol function which returns a
1689 string. Note that this string is inserted on PostScript prologue header
1690 section which is used to define some document characteristic through PostScript
1691 special comments, like \"%%Requirements: jog\\n\".
1693 ps-print always inserts the %%Requirements: comment, so if you need to insert
1694 more requirements put them first in `ps-print-prologue-header' using the
1695 \"%%+\" comment. For example, if you need to set numcopies to 3 and jog on
1696 requirements and set %%LanguageLevel: to 2, do:
1698 (setq ps-print-prologue-header
1699 \"%%+ numcopies(3) jog\\n%%LanguageLevel: 2\\n\")
1701 The duplex requirement is inserted by ps-print (see `ps-spool-duplex').
1703 Do not forget to terminate the string with \"\\n\".
1705 For more information about PostScript document comments, see:
1706 PostScript Language Reference Manual (2nd edition)
1707 Adobe Systems Incorporated
1708 Appendix G: Document Structuring Conventions -- Version 3.0"
1709 :type '(choice :menu-tag "Prologue Header"
1710 :tag "Prologue Header"
1711 (const :tag "none" nil) string symbol)
1712 :version "20"
1713 :group 'ps-print-miscellany)
1715 (defcustom ps-printer-name (and (boundp 'printer-name)
1716 (symbol-value 'printer-name))
1717 "*The name of a local printer for printing PostScript files.
1719 On Unix-like systems, a string value should be a name understood by lpr's -P
1720 option; a value of nil means use the value of `printer-name' instead.
1722 On MS-DOS and MS-Windows systems, a string value is taken as the name of the
1723 printer device or port to which PostScript files are written, provided
1724 `ps-lpr-command' is \"\". By default it is the same as `printer-name'; typical
1725 non-default settings would be \"LPT1\" to \"LPT3\" for parallel printers, or
1726 \"COM1\" to \"COM4\" or \"AUX\" for serial printers, or \"\\\\hostname\\printer\"
1727 for a shared network printer. You can also set it to a name of a file, in
1728 which case the output gets appended to that file. \(Note that `ps-print'
1729 package already has facilities for printing to a file, so you might as well use
1730 them instead of changing the setting of this variable.\) If you want to
1731 silently discard the printed output, set this to \"NUL\".
1733 Set to t, if the utility given by `ps-lpr-command' needs an empty printer name.
1735 Any other value is treated as t, that is, an empty printer name.
1737 See also `ps-printer-name-option' for documentation."
1738 :type '(choice :menu-tag "Printer Name"
1739 :tag "Printer Name"
1740 (const :tag "Same as printer-name" nil)
1741 (const :tag "No Printer Name" t)
1742 (file :tag "Print to file")
1743 (string :tag "Pipe to ps-lpr-command"))
1744 :version "20"
1745 :group 'ps-print-printer)
1747 (defcustom ps-printer-name-option
1748 (cond (ps-windows-system
1749 "/D:")
1750 (ps-lp-system
1751 "-d")
1753 "-P" ))
1754 "*Option for `ps-printer-name' variable (see it).
1756 On Unix-like systems, if `lpr' is in use, this should be the string
1757 \"-P\"; if `lp' is in use, this should be the string \"-d\".
1759 On MS-DOS and MS-Windows systems, if `print' is in use, this should be
1760 the string \"/D:\".
1762 For any other printing utility, see its documentation.
1764 Set this to \"\" or nil, if the utility given by `ps-lpr-command'
1765 needs an empty printer name option--that is, pass the printer name
1766 with no special option preceding it.
1768 Any value that is not a string is treated as nil.
1770 This variable is used only when `ps-printer-name' is a non-empty string."
1771 :type '(choice :menu-tag "Printer Name Option"
1772 :tag "Printer Name Option"
1773 (const :tag "None" nil)
1774 (string :tag "Option"))
1775 :version "21.1"
1776 :group 'ps-print-printer)
1778 (defcustom ps-lpr-command lpr-command
1779 "*Name of program for printing a PostScript file.
1781 On MS-DOS and MS-Windows systems, if the value is an empty string then Emacs
1782 will write directly to the printer port named by `ps-printer-name'. The
1783 programs `print' and `nprint' (the standard print programs on Windows NT and
1784 Novell Netware respectively) are handled specially, using `ps-printer-name' as
1785 the destination for output; any other program is treated like `lpr' except that
1786 an explicit filename is given as the last argument."
1787 :type 'string
1788 :version "20"
1789 :group 'ps-print-printer)
1791 (defcustom ps-lpr-switches lpr-switches
1792 "*A list of extra switches to pass to `ps-lpr-command'."
1793 :type '(repeat :tag "PostScript lpr Switches"
1794 (choice :menu-tag "PostScript lpr Switch"
1795 :tag "PostScript lpr Switch"
1796 string symbol (repeat sexp)))
1797 :version "20"
1798 :group 'ps-print-printer)
1800 (defcustom ps-print-region-function nil
1801 "*Specify a function to print the region on a PostScript printer.
1802 See definition of `call-process-region' for calling conventions. The fourth
1803 and the sixth arguments are both nil."
1804 :type '(choice (const nil) function)
1805 :version "20"
1806 :group 'ps-print-printer)
1808 (defcustom ps-manual-feed nil
1809 "*Non-nil means the printer will manually feed paper.
1811 If it's nil, automatic feeding takes place."
1812 :type 'boolean
1813 :version "20"
1814 :group 'ps-print-printer)
1816 (defcustom ps-end-with-control-d (and ps-windows-system t)
1817 "*Non-nil means insert C-d at end of PostScript file generated."
1818 :version "21.1"
1819 :type 'boolean
1820 :version "20"
1821 :group 'ps-print-printer)
1823 ;;; Page layout
1825 ;; All page dimensions are in PostScript points.
1826 ;; 1 inch == 2.54 cm == 72 points
1827 ;; 1 cm == (/ 1 2.54) inch == (/ 72 2.54) points
1829 ;; Letter 8.5 inch x 11.0 inch
1830 ;; Legal 8.5 inch x 14.0 inch
1831 ;; A4 8.26 inch x 11.69 inch = 21.0 cm x 29.7 cm
1833 ;; LetterSmall 7.68 inch x 10.16 inch
1834 ;; Tabloid 11.0 inch x 17.0 inch
1835 ;; Ledger 17.0 inch x 11.0 inch
1836 ;; Statement 5.5 inch x 8.5 inch
1837 ;; Executive 7.5 inch x 10.0 inch
1838 ;; A3 11.69 inch x 16.5 inch = 29.7 cm x 42.0 cm
1839 ;; A4Small 7.47 inch x 10.85 inch
1840 ;; B4 10.125 inch x 14.33 inch
1841 ;; B5 7.16 inch x 10.125 inch
1843 ;;;###autoload
1844 (defcustom ps-page-dimensions-database
1845 (list (list 'a4 (/ (* 72 21.0) 2.54) (/ (* 72 29.7) 2.54) "A4")
1846 (list 'a3 (/ (* 72 29.7) 2.54) (/ (* 72 42.0) 2.54) "A3")
1847 (list 'letter (* 72 8.5) (* 72 11.0) "Letter")
1848 (list 'legal (* 72 8.5) (* 72 14.0) "Legal")
1849 (list 'letter-small (* 72 7.68) (* 72 10.16) "LetterSmall")
1850 (list 'tabloid (* 72 11.0) (* 72 17.0) "Tabloid")
1851 (list 'ledger (* 72 17.0) (* 72 11.0) "Ledger")
1852 (list 'statement (* 72 5.5) (* 72 8.5) "Statement")
1853 (list 'executive (* 72 7.5) (* 72 10.0) "Executive")
1854 (list 'a4small (* 72 7.47) (* 72 10.85) "A4Small")
1855 (list 'b4 (* 72 10.125) (* 72 14.33) "B4")
1856 (list 'b5 (* 72 7.16) (* 72 10.125) "B5"))
1857 "*List associating a symbolic paper type to its width, height and doc media.
1858 See `ps-paper-type'."
1859 :type '(repeat (list :tag "Paper Type"
1860 (symbol :tag "Name")
1861 (number :tag "Width")
1862 (number :tag "Height")
1863 (string :tag "Media")))
1864 :version "20"
1865 :group 'ps-print-page)
1867 ;;;###autoload
1868 (defcustom ps-paper-type 'letter
1869 "*Specify the size of paper to format for.
1870 Should be one of the paper types defined in `ps-page-dimensions-database', for
1871 example `letter', `legal' or `a4'."
1872 :type '(symbol :validate (lambda (wid)
1873 (if (assq (widget-value wid)
1874 ps-page-dimensions-database)
1876 (widget-put wid :error "Unknown paper size")
1877 wid)))
1878 :version "20"
1879 :group 'ps-print-page)
1881 (defcustom ps-warn-paper-type t
1882 "*Non-nil means give an error if paper size is not equal to `ps-paper-type'.
1884 It's used when `ps-spool-config' is set to `setpagedevice'."
1885 :type 'boolean
1886 :version "20"
1887 :group 'ps-print-page)
1889 (defcustom ps-landscape-mode nil
1890 "*Non-nil means print in landscape mode."
1891 :type 'boolean
1892 :version "20"
1893 :group 'ps-print-page)
1895 (defcustom ps-print-upside-down nil
1896 "*Non-nil means print upside-down (that is, rotated by 180 degrees)."
1897 :type 'boolean
1898 :version "21.1"
1899 :group 'ps-print-page)
1901 (defcustom ps-selected-pages nil
1902 "*Specify which pages to print.
1904 If nil, print all pages.
1906 If a list, the lists element may be an integer or a cons cell (FROM . TO)
1907 designating FROM page to TO page; any invalid element is ignored, that is, an
1908 integer lesser than one or if FROM is greater than TO.
1910 Otherwise, it's treated as nil.
1912 After ps-print processing `ps-selected-pages' is set to nil. But the
1913 latest `ps-selected-pages' is saved in `ps-last-selected-pages' (which
1914 see). So you can restore the latest selected pages by using
1915 `ps-last-selected-pages' or with the `ps-restore-selected-pages'
1916 command (which see).
1918 See also `ps-even-or-odd-pages'."
1919 :type '(repeat :tag "Selected Pages"
1920 (radio :tag "Page"
1921 (integer :tag "Number")
1922 (cons :tag "Range"
1923 (integer :tag "From")
1924 (integer :tag "To"))))
1925 :version "20"
1926 :group 'ps-print-page)
1928 (defcustom ps-even-or-odd-pages nil
1929 "*Specify if it prints even/odd pages.
1931 Valid values are:
1933 nil print all pages.
1935 `even-page' print only even pages.
1937 `odd-page' print only odd pages.
1939 `even-sheet' print only even sheets.
1940 That is, if `ps-n-up-printing' is 1, it behaves as `even-page';
1941 but for values greater than 1, it'll print only the even sheet
1942 of paper.
1944 `odd-sheet' print only odd sheets.
1945 That is, if `ps-n-up-printing' is 1, it behaves as `odd-page';
1946 but for values greater than 1, it'll print only the odd sheet
1947 of paper.
1949 Any other value is treated as nil.
1951 If you set `ps-selected-pages' (see it for documentation), first the pages are
1952 filtered by `ps-selected-pages' and then by `ps-even-or-odd-pages'. For
1953 example, if we have:
1955 (setq ps-selected-pages '(1 4 (6 . 10) (12 . 16) 20))
1957 Combining with `ps-even-or-odd-pages' and `ps-n-up-printing', we have:
1959 `ps-n-up-printing' = 1:
1960 `ps-even-or-odd-pages' PAGES PRINTED
1961 nil 1, 4, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 20
1962 even-page 4, 6, 8, 10, 12, 14, 16, 20
1963 odd-page 1, 7, 9, 13, 15
1964 even-sheet 4, 6, 8, 10, 12, 14, 16, 20
1965 odd-sheet 1, 7, 9, 13, 15
1967 `ps-n-up-printing' = 2:
1968 `ps-even-or-odd-pages' PAGES PRINTED
1969 nil 1/4, 6/7, 8/9, 10/12, 13/14, 15/16, 20
1970 even-page 4/6, 8/10, 12/14, 16/20
1971 odd-page 1/7, 9/13, 15
1972 even-sheet 6/7, 10/12, 15/16
1973 odd-sheet 1/4, 8/9, 13/14, 20
1975 So even-page/odd-page are about page parity and even-sheet/odd-sheet are about
1976 sheet parity."
1977 :type '(choice :menu-tag "Print Even/Odd Pages"
1978 :tag "Print Even/Odd Pages"
1979 (const :tag "All Pages" nil)
1980 (const :tag "Only Even Pages" even-page)
1981 (const :tag "Only Odd Pages" odd-page)
1982 (const :tag "Only Even Sheets" even-sheet)
1983 (const :tag "Only Odd Sheets" odd-sheet))
1984 :version "20"
1985 :group 'ps-print-page)
1987 (defcustom ps-print-control-characters 'control-8-bit
1988 "*Specify the printable form for control and 8-bit characters.
1989 That is, instead of sending, for example, a ^D (\\004) to printer,
1990 it is sent the string \"^D\".
1992 Valid values are:
1994 `8-bit' This is the value to use when you want an ASCII encoding of
1995 any control or non-ASCII character. Control characters are
1996 encoded as \"^D\", and non-ASCII characters have an
1997 octal encoding.
1999 `control-8-bit' This is the value to use when you want an ASCII encoding of
2000 any control character, whether it is 7 or 8-bit.
2001 European 8-bits accented characters are printed according
2002 the current font.
2004 `control' Only ASCII control characters have an ASCII encoding.
2005 European 8-bits accented characters are printed according
2006 the current font.
2008 nil No ASCII encoding. Any character is printed according the
2009 current font.
2011 Any other value is treated as nil."
2012 :type '(choice :menu-tag "Control Char"
2013 :tag "Control Char"
2014 (const 8-bit) (const control-8-bit)
2015 (const control) (const :tag "nil" nil))
2016 :version "20"
2017 :group 'ps-print-miscellany)
2019 (defcustom ps-n-up-printing 1
2020 "*Specify the number of pages per sheet paper."
2021 :type '(integer
2022 :tag "N Up Printing"
2023 :validate
2024 (lambda (wid)
2025 (if (and (< 0 (widget-value wid))
2026 (<= (widget-value wid) 100))
2028 (widget-put
2029 wid :error
2030 "Number of pages per sheet paper must be between 1 and 100.")
2031 wid)))
2032 :version "20"
2033 :group 'ps-print-n-up)
2035 (defcustom ps-n-up-margin (/ (* 72 1.0) 2.54) ; 1 cm
2036 "*Specify the margin in points between the sheet border and n-up printing."
2037 :type 'number
2038 :version "20"
2039 :group 'ps-print-n-up)
2041 (defcustom ps-n-up-border-p t
2042 "*Non-nil means a border is drawn around each page."
2043 :type 'boolean
2044 :version "20"
2045 :group 'ps-print-n-up)
2047 (defcustom ps-n-up-filling 'left-top
2048 "*Specify how page matrix is filled on each sheet of paper.
2050 Following are the valid values for `ps-n-up-filling' with a filling example
2051 using a 3x4 page matrix:
2053 `left-top' 1 2 3 4 `left-bottom' 9 10 11 12
2054 5 6 7 8 5 6 7 8
2055 9 10 11 12 1 2 3 4
2057 `right-top' 4 3 2 1 `right-bottom' 12 11 10 9
2058 8 7 6 5 8 7 6 5
2059 12 11 10 9 4 3 2 1
2061 `top-left' 1 4 7 10 `bottom-left' 3 6 9 12
2062 2 5 8 11 2 5 8 11
2063 3 6 9 12 1 4 7 10
2065 `top-right' 10 7 4 1 `bottom-right' 12 9 6 3
2066 11 8 5 2 11 8 5 2
2067 12 9 6 3 10 7 4 1
2069 Any other value is treated as `left-top'."
2070 :type '(choice :menu-tag "N-Up Filling"
2071 :tag "N-Up Filling"
2072 (const left-top) (const left-bottom)
2073 (const right-top) (const right-bottom)
2074 (const top-left) (const bottom-left)
2075 (const top-right) (const bottom-right))
2076 :version "20"
2077 :group 'ps-print-n-up)
2079 (defcustom ps-number-of-columns (if ps-landscape-mode 2 1)
2080 "*Specify the number of columns."
2081 :type 'number
2082 :version "20"
2083 :group 'ps-print-miscellany)
2085 (defcustom ps-zebra-stripes nil
2086 "*Non-nil means print zebra stripes.
2087 See also documentation for `ps-zebra-stripe-height' and `ps-zebra-color'."
2088 :type 'boolean
2089 :version "20"
2090 :group 'ps-print-zebra)
2092 (defcustom ps-zebra-stripe-height 3
2093 "*Number of zebra stripe lines.
2094 See also documentation for `ps-zebra-stripes' and `ps-zebra-color'."
2095 :type 'number
2096 :version "20"
2097 :group 'ps-print-zebra)
2099 (defcustom ps-zebra-color 0.95
2100 "*Zebra stripe gray scale or RGB color.
2101 See also documentation for `ps-zebra-stripes' and `ps-zebra-stripe-height'."
2102 :type '(choice :menu-tag "Zebra Gray/Color"
2103 :tag "Zebra Gray/Color"
2104 (number :tag "Gray Scale" :value 0.95)
2105 (string :tag "Color Name" :value "gray95")
2106 (list :tag "RGB Color" :value (0.95 0.95 0.95)
2107 (number :tag "Red")
2108 (number :tag "Green")
2109 (number :tag "Blue")))
2110 :version "20"
2111 :group 'ps-print-zebra)
2113 (defcustom ps-zebra-stripe-follow nil
2114 "*Specify how zebra stripes continue on next page.
2116 Visually, valid values are (the character `+' at right of each column indicates
2117 that a line is printed):
2119 `nil' `follow' `full' `full-follow'
2120 Current Page -------- ----------- --------- ----------------
2121 1 XXXXX + 1 XXXXXXXX + 1 XXXXXX + 1 XXXXXXXXXXXXX +
2122 2 XXXXX + 2 XXXXXXXX + 2 XXXXXX + 2 XXXXXXXXXXXXX +
2123 3 XXXXX + 3 XXXXXXXX + 3 XXXXXX + 3 XXXXXXXXXXXXX +
2124 4 + 4 + 4 + 4 +
2125 5 + 5 + 5 + 5 +
2126 6 + 6 + 6 + 6 +
2127 7 XXXXX + 7 XXXXXXXX + 7 XXXXXX + 7 XXXXXXXXXXXXX +
2128 8 XXXXX + 8 XXXXXXXX + 8 XXXXXX + 8 XXXXXXXXXXXXX +
2129 9 XXXXX + 9 XXXXXXXX + 9 XXXXXX + 9 XXXXXXXXXXXXX +
2130 10 + 10 +
2131 11 + 11 +
2132 -------- ----------- --------- ----------------
2133 Next Page -------- ----------- --------- ----------------
2134 12 XXXXX + 12 + 10 XXXXXX + 10 +
2135 13 XXXXX + 13 XXXXXXXX + 11 XXXXXX + 11 +
2136 14 XXXXX + 14 XXXXXXXX + 12 XXXXXX + 12 +
2137 15 + 15 XXXXXXXX + 13 + 13 XXXXXXXXXXXXX +
2138 16 + 16 + 14 + 14 XXXXXXXXXXXXX +
2139 17 + 17 + 15 + 15 XXXXXXXXXXXXX +
2140 18 XXXXX + 18 + 16 XXXXXX + 16 +
2141 19 XXXXX + 19 XXXXXXXX + 17 XXXXXX + 17 +
2142 20 XXXXX + 20 XXXXXXXX + 18 XXXXXX + 18 +
2143 21 + 21 XXXXXXXX +
2144 22 + 22 +
2145 -------- ----------- --------- ----------------
2147 Any other value is treated as nil."
2148 :type '(choice :menu-tag "Zebra Stripe Follow"
2149 :tag "Zebra Stripe Follow"
2150 (const :tag "Always Restart" nil)
2151 (const :tag "Continue on Next Page" follow)
2152 (const :tag "Print Only Full Stripe" full)
2153 (const :tag "Continue on Full Stripe" full-follow))
2154 :version "20"
2155 :group 'ps-print-zebra)
2157 (defcustom ps-line-number nil
2158 "*Non-nil means print line number."
2159 :type 'boolean
2160 :version "20"
2161 :group 'ps-print-miscellany)
2163 (defcustom ps-line-number-step 1
2164 "*Specify the interval that line number is printed.
2166 For example, `ps-line-number-step' is set to 2, the printing will look like:
2168 1 one line
2169 one line
2170 3 one line
2171 one line
2172 5 one line
2173 one line
2176 Valid values are:
2178 integer an integer that specifies the interval that line number is
2179 printed. If it's lesser than or equal to zero, it's used the
2180 value 1.
2182 `zebra' specifies that only the line number of the first line in a
2183 zebra stripe is to be printed.
2185 Any other value is treated as `zebra'."
2186 :type '(choice :menu-tag "Line Number Step"
2187 :tag "Line Number Step"
2188 (integer :tag "Step Interval")
2189 (const :tag "Synchronize Zebra" zebra))
2190 :version "20"
2191 :group 'ps-print-miscellany)
2193 (defcustom ps-line-number-start 1
2194 "*Specify the starting point in the interval given by `ps-line-number-step'.
2196 For example, if `ps-line-number-step' is set to 3 and `ps-line-number-start' is
2197 set to 3, the printing will look like:
2199 one line
2200 one line
2201 3 one line
2202 one line
2203 one line
2204 6 one line
2205 one line
2206 one line
2207 9 one line
2208 one line
2211 The values for `ps-line-number-start':
2213 * If `ps-line-number-step' is an integer, must be between 1 and the value of
2214 `ps-line-number-step' inclusive.
2216 * If `ps-line-number-step' is set to `zebra', must be between 1 and the
2217 value of `ps-zebra-strip-height' inclusive. Use this combination if you
2218 wish that line number be relative to zebra stripes."
2219 :type '(integer :tag "Start Step Interval")
2220 :version "20"
2221 :group 'ps-print-miscellany)
2223 (defcustom ps-print-background-image nil
2224 "*EPS image list to be printed on background.
2226 The elements are:
2228 (FILENAME X Y XSCALE YSCALE ROTATION PAGES...)
2230 FILENAME is a file name which contains an EPS image or some PostScript
2231 programming like EPS.
2232 FILENAME is ignored, if it doesn't exist or is read protected.
2234 X and Y are relative positions on paper to put the image.
2235 If X and Y are nil, the image is centered on paper.
2237 XSCALE and YSCALE are scale factor to be applied to image before printing.
2238 If XSCALE and YSCALE are nil, the original size is used.
2240 ROTATION is the image rotation angle; if nil, the default is 0.
2242 PAGES designates the page to print background image.
2243 PAGES may be a number or a cons cell (FROM . TO) designating FROM page to TO
2244 page.
2245 If PAGES is nil, print background image on all pages.
2247 X, Y, XSCALE, YSCALE and ROTATION may be a floating point number, an integer
2248 number or a string. If it is a string, the string should contain PostScript
2249 programming that returns a float or integer value.
2251 For example, if you wish to print an EPS image on all pages do:
2253 '((\"~/images/EPS-image.ps\"))"
2254 :type '(repeat
2255 (list
2256 (file :tag "EPS File")
2257 (choice :tag "X" (const :tag "default" nil) number string)
2258 (choice :tag "Y" (const :tag "default" nil) number string)
2259 (choice :tag "X Scale" (const :tag "default" nil) number string)
2260 (choice :tag "Y Scale" (const :tag "default" nil) number string)
2261 (choice :tag "Rotation" (const :tag "default" nil) number string)
2262 (repeat :tag "Pages" :inline t
2263 (radio (integer :tag "Page")
2264 (cons :tag "Range"
2265 (integer :tag "From")
2266 (integer :tag "To"))))))
2267 :version "20"
2268 :group 'ps-print-background)
2270 (defcustom ps-print-background-text nil
2271 "*Text list to be printed on background.
2273 The elements are:
2275 (STRING X Y FONT FONTSIZE GRAY ROTATION PAGES...)
2277 STRING is the text to be printed on background.
2279 X and Y are positions on paper to put the text.
2280 If X and Y are nil, the text is positioned at lower left corner.
2282 FONT is a font name to be used on printing the text.
2283 If nil, \"Times-Roman\" is used.
2285 FONTSIZE is font size to be used, if nil, 200 is used.
2287 GRAY is the text gray factor (should be very light like 0.8).
2288 If nil, the default is 0.85.
2290 ROTATION is the text rotation angle; if nil, the angle is given by the diagonal
2291 from lower left corner to upper right corner.
2293 PAGES designates the page to print background text.
2294 PAGES may be a number or a cons cell (FROM . TO) designating FROM page to TO
2295 page.
2296 If PAGES is nil, print background text on all pages.
2298 X, Y, FONTSIZE, GRAY and ROTATION may be a floating point number, an integer
2299 number or a string. If it is a string, the string should contain PostScript
2300 programming that returns a float or integer value.
2302 For example, if you wish to print text \"Preliminary\" on all pages do:
2304 '((\"Preliminary\"))"
2305 :type '(repeat
2306 (list
2307 (string :tag "Text")
2308 (choice :tag "X" (const :tag "default" nil) number string)
2309 (choice :tag "Y" (const :tag "default" nil) number string)
2310 (choice :tag "Font" (const :tag "default" nil) string)
2311 (choice :tag "Fontsize" (const :tag "default" nil) number string)
2312 (choice :tag "Gray" (const :tag "default" nil) number string)
2313 (choice :tag "Rotation" (const :tag "default" nil) number string)
2314 (repeat :tag "Pages" :inline t
2315 (radio (integer :tag "Page")
2316 (cons :tag "Range"
2317 (integer :tag "From")
2318 (integer :tag "To"))))))
2319 :version "20"
2320 :group 'ps-print-background)
2322 ;;; Horizontal layout
2324 ;; ------------------------------------------
2325 ;; | | | | | | | |
2326 ;; | lm | text | ic | text | ic | text | rm |
2327 ;; | | | | | | | |
2328 ;; ------------------------------------------
2330 (defcustom ps-left-margin (/ (* 72 2.0) 2.54) ; 2 cm
2331 "*Left margin in points (1/72 inch)."
2332 :type 'number
2333 :version "20"
2334 :group 'ps-print-horizontal)
2336 (defcustom ps-right-margin (/ (* 72 2.0) 2.54) ; 2 cm
2337 "*Right margin in points (1/72 inch)."
2338 :type 'number
2339 :version "20"
2340 :group 'ps-print-horizontal)
2342 (defcustom ps-inter-column (/ (* 72 2.0) 2.54) ; 2 cm
2343 "*Horizontal space between columns in points (1/72 inch)."
2344 :type 'number
2345 :version "20"
2346 :group 'ps-print-horizontal)
2348 ;;; Vertical layout
2350 ;; |--------|
2351 ;; | tm |
2352 ;; |--------|
2353 ;; | header |
2354 ;; |--------|
2355 ;; | ho |
2356 ;; |--------|
2357 ;; | text |
2358 ;; |--------|
2359 ;; | bm |
2360 ;; |--------|
2362 (defcustom ps-bottom-margin (/ (* 72 1.5) 2.54) ; 1.5 cm
2363 "*Bottom margin in points (1/72 inch)."
2364 :type 'number
2365 :version "20"
2366 :group 'ps-print-vertical)
2368 (defcustom ps-top-margin (/ (* 72 1.5) 2.54) ; 1.5 cm
2369 "*Top margin in points (1/72 inch)."
2370 :type 'number
2371 :version "20"
2372 :group 'ps-print-vertical)
2374 (defcustom ps-header-offset (/ (* 72 1.0) 2.54) ; 1.0 cm
2375 "*Vertical space in points (1/72 inch) between the main text and the header."
2376 :type 'number
2377 :version "20"
2378 :group 'ps-print-vertical)
2380 (defcustom ps-header-line-pad 0.15
2381 "*Portion of a header title line height to insert.
2382 The insertion is done between the header frame and the text it contains,
2383 both in the vertical and horizontal directions."
2384 :type 'number
2385 :version "20"
2386 :group 'ps-print-vertical)
2388 (defcustom ps-footer-offset (/ (* 72 1.0) 2.54) ; 1.0 cm
2389 "*Vertical space in points (1/72 inch) between the main text and the footer."
2390 :type 'number
2391 :version "20"
2392 :group 'ps-print-vertical)
2394 (defcustom ps-footer-line-pad 0.15
2395 "*Portion of a footer title line height to insert.
2396 The insertion is done between the footer frame and the text it contains,
2397 both in the vertical and horizontal directions."
2398 :type 'number
2399 :version "20"
2400 :group 'ps-print-vertical)
2402 ;;; Header/Footer setup
2404 (defcustom ps-print-header t
2405 "*Non-nil means print a header at the top of each page.
2406 By default, the header displays the buffer name, page number, and, if the
2407 buffer is visiting a file, the file's directory. Headers are customizable by
2408 changing variables `ps-left-header' and `ps-right-header'."
2409 :type 'boolean
2410 :version "20"
2411 :group 'ps-print-headers)
2413 (defcustom ps-print-header-frame t
2414 "*Non-nil means draw a gaudy frame around the header."
2415 :type 'boolean
2416 :version "20"
2417 :group 'ps-print-headers)
2419 (defcustom ps-header-frame-alist
2420 '((fore-color . 0.0)
2421 (back-color . 0.9)
2422 (border-width . 0.4)
2423 (border-color . 0.0)
2424 (shadow-color . 0.0))
2425 "*Specify header frame properties alist.
2427 Valid frame properties are:
2429 `fore-color' Specify the foreground frame color.
2430 It should be a float number between 0.0 (black color)
2431 and 1.0 (white color), a string which is a color name,
2432 or a list of 3 float numbers which corresponds to the
2433 Red Green Blue color scale, each float number between
2434 0.0 (dark color) and 1.0 (bright color).
2436 `back-color' Specify the background frame color (similar to
2437 `fore-color').
2439 `shadow-color' Specify the shadow color (similar to `fore-color').
2441 `border-color' Specify the border color (similar to `fore-color').
2443 `border-width' Specify the border width.
2445 Any other property is ignored.
2447 Don't change this alist directly, instead use customization, or `ps-value',
2448 `ps-get', `ps-put' and `ps-del' functions (see them for documentation)."
2449 :version "21.1"
2450 :type '(repeat
2451 (choice :menu-tag "Header Frame Element"
2452 :tag ""
2453 (cons :tag "Foreground Color" :format "%v"
2454 (const :format "" fore-color)
2455 (choice :menu-tag "Foreground Color"
2456 :tag "Foreground Color"
2457 (number :tag "Gray Scale" :value 0.0)
2458 (string :tag "Color Name" :value "black")
2459 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2460 (number :tag "Red")
2461 (number :tag "Green")
2462 (number :tag "Blue"))))
2463 (cons :tag "Background Color" :format "%v"
2464 (const :format "" back-color)
2465 (choice :menu-tag "Background Color"
2466 :tag "Background Color"
2467 (number :tag "Gray Scale" :value 0.9)
2468 (string :tag "Color Name" :value "gray90")
2469 (list :tag "RGB Color" :value (0.9 0.9 0.9)
2470 (number :tag "Red")
2471 (number :tag "Green")
2472 (number :tag "Blue"))))
2473 (cons :tag "Border Width" :format "%v"
2474 (const :format "" border-width)
2475 (number :tag "Border Width" :value 0.4))
2476 (cons :tag "Border Color" :format "%v"
2477 (const :format "" border-color)
2478 (choice :menu-tag "Border Color"
2479 :tag "Border Color"
2480 (number :tag "Gray Scale" :value 0.0)
2481 (string :tag "Color Name" :value "black")
2482 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2483 (number :tag "Red")
2484 (number :tag "Green")
2485 (number :tag "Blue"))))
2486 (cons :tag "Shadow Color" :format "%v"
2487 (const :format "" shadow-color)
2488 (choice :menu-tag "Shadow Color"
2489 :tag "Shadow Color"
2490 (number :tag "Gray Scale" :value 0.0)
2491 (string :tag "Color Name" :value "black")
2492 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2493 (number :tag "Red")
2494 (number :tag "Green")
2495 (number :tag "Blue"))))))
2496 :version "20"
2497 :group 'ps-print-headers)
2499 (defcustom ps-header-lines 2
2500 "*Number of lines to display in page header, when generating PostScript."
2501 :type 'integer
2502 :version "20"
2503 :group 'ps-print-headers)
2505 (defcustom ps-print-footer nil
2506 "*Non-nil means print a footer at the bottom of each page.
2507 By default, the footer displays page number.
2508 Footers are customizable by changing variables `ps-left-footer' and
2509 `ps-right-footer'."
2510 :type 'boolean
2511 :version "21.1"
2512 :group 'ps-print-headers)
2514 (defcustom ps-print-footer-frame t
2515 "*Non-nil means draw a gaudy frame around the footer."
2516 :type 'boolean
2517 :version "21.1"
2518 :group 'ps-print-headers)
2520 (defcustom ps-footer-frame-alist
2521 '((fore-color . 0.0)
2522 (back-color . 0.9)
2523 (border-width . 0.4)
2524 (border-color . 0.0)
2525 (shadow-color . 0.0))
2526 "*Specify footer frame properties alist.
2528 Don't change this alist directly, instead use customization, or `ps-value',
2529 `ps-get', `ps-put' and `ps-del' functions (see them for documentation).
2531 See also `ps-header-frame-alist' for documentation."
2532 :type '(repeat
2533 (choice :menu-tag "Header Frame Element"
2534 :tag ""
2535 (cons :tag "Foreground Color" :format "%v"
2536 (const :format "" fore-color)
2537 (choice :menu-tag "Foreground Color"
2538 :tag "Foreground Color"
2539 (number :tag "Gray Scale" :value 0.0)
2540 (string :tag "Color Name" :value "black")
2541 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2542 (number :tag "Red")
2543 (number :tag "Green")
2544 (number :tag "Blue"))))
2545 (cons :tag "Background Color" :format "%v"
2546 (const :format "" back-color)
2547 (choice :menu-tag "Background Color"
2548 :tag "Background Color"
2549 (number :tag "Gray Scale" :value 0.9)
2550 (string :tag "Color Name" :value "gray90")
2551 (list :tag "RGB Color" :value (0.9 0.9 0.9)
2552 (number :tag "Red")
2553 (number :tag "Green")
2554 (number :tag "Blue"))))
2555 (cons :tag "Border Width" :format "%v"
2556 (const :format "" border-width)
2557 (number :tag "Border Width" :value 0.4))
2558 (cons :tag "Border Color" :format "%v"
2559 (const :format "" border-color)
2560 (choice :menu-tag "Border Color"
2561 :tag "Border Color"
2562 (number :tag "Gray Scale" :value 0.0)
2563 (string :tag "Color Name" :value "black")
2564 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2565 (number :tag "Red")
2566 (number :tag "Green")
2567 (number :tag "Blue"))))
2568 (cons :tag "Shadow Color" :format "%v"
2569 (const :format "" shadow-color)
2570 (choice :menu-tag "Shadow Color"
2571 :tag "Shadow Color"
2572 (number :tag "Gray Scale" :value 0.0)
2573 (string :tag "Color Name" :value "black")
2574 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2575 (number :tag "Red")
2576 (number :tag "Green")
2577 (number :tag "Blue"))))))
2578 :version "21.1"
2579 :group 'ps-print-headers)
2581 (defcustom ps-footer-lines 2
2582 "*Number of lines to display in page footer, when generating PostScript."
2583 :type 'integer
2584 :version "21.1"
2585 :group 'ps-print-headers)
2587 (defcustom ps-print-only-one-header nil
2588 "*Non-nil means print only one header/footer at the top/bottom of each page.
2589 This is useful when printing more than one column, so it is possible to have
2590 only one header/footer over all columns or one header/footer per column.
2591 See also `ps-print-header' and `ps-print-footer'."
2592 :type 'boolean
2593 :version "20"
2594 :group 'ps-print-headers)
2596 (defcustom ps-switch-header 'duplex
2597 "*Specify if headers/footers are switched or not.
2599 Valid values are:
2601 nil Never switch headers/footers.
2603 t Always switch headers/footers.
2605 duplex Switch headers/footers only when duplexing is on, that is, when
2606 `ps-spool-duplex' is non-nil.
2608 Any other value is treated as t.
2610 See also `ps-print-header' and `ps-print-footer'."
2611 :type '(choice :menu-tag "Switch Header/Footer"
2612 :tag "Switch Header/Footer"
2613 (const :tag "Never Switch" nil)
2614 (const :tag "Always Switch" t)
2615 (const :tag "Switch When Duplexing" duplex))
2616 :version "20"
2617 :group 'ps-print-headers)
2619 (defcustom ps-show-n-of-n t
2620 "*Non-nil means show page numbers as N/M, meaning page N of M.
2621 NOTE: page numbers are displayed as part of headers,
2622 see variable `ps-print-header'."
2623 :type 'boolean
2624 :version "20"
2625 :group 'ps-print-headers)
2627 (defcustom ps-spool-config
2628 (if ps-windows-system
2630 'lpr-switches)
2631 "*Specify who is responsible for setting duplex and page size.
2633 Valid values are:
2635 `lpr-switches' duplex and page size are configured by `ps-lpr-switches'.
2636 Don't forget to set `ps-lpr-switches' to select duplex
2637 printing for your printer.
2639 `setpagedevice' duplex and page size are configured by ps-print using the
2640 setpagedevice PostScript operator.
2642 nil duplex and page size are configured by ps-print *not* using
2643 the setpagedevice PostScript operator.
2645 Any other value is treated as nil.
2647 WARNING: The setpagedevice PostScript operator affects ghostview utility when
2648 viewing file generated using landscape. Also on some printers,
2649 setpagedevice affects zebra stripes; on other printers, setpagedevice
2650 affects the left margin.
2651 Besides all that, if your printer does not have the paper size
2652 specified by setpagedevice, your printing will be aborted.
2653 So, if you need to use setpagedevice, set `ps-spool-config' to
2654 `setpagedevice', generate a test file and send it to your printer; if
2655 the printed file isn't OK, set `ps-spool-config' to nil."
2656 :type '(choice :menu-tag "Spool Config"
2657 :tag "Spool Config"
2658 (const lpr-switches) (const setpagedevice)
2659 (const :tag "nil" nil))
2660 :version "20"
2661 :group 'ps-print-headers)
2663 (defcustom ps-spool-duplex nil ; Not many people have duplex printers,
2664 ; so default to nil.
2665 "*Non-nil generates PostScript for a two-sided printer.
2666 For a duplex printer, the `ps-spool-*' and `ps-print-*' commands will insert
2667 blank pages as needed between print jobs so that the next buffer printed will
2668 start on the right page. Also, if headers are turned on, the headers will be
2669 reversed on duplex printers so that the page numbers fall to the left on
2670 even-numbered pages.
2672 See also `ps-spool-tumble'."
2673 :type 'boolean
2674 :version "20"
2675 :group 'ps-print-headers)
2677 (defcustom ps-spool-tumble nil
2678 "*Specify how the page images on opposite sides of a sheet are oriented.
2679 If `ps-spool-tumble' is nil, produces output suitable for binding on the left
2680 or right. If `ps-spool-tumble' is non-nil, produces output suitable for
2681 binding at the top or bottom.
2683 It has effect only when `ps-spool-duplex' is non-nil."
2684 :type 'boolean
2685 :version "20"
2686 :group 'ps-print-headers)
2688 ;;; Fonts
2690 (defcustom ps-font-info-database
2691 '((Courier ; the family key
2692 (fonts (normal . "Courier")
2693 (bold . "Courier-Bold")
2694 (italic . "Courier-Oblique")
2695 (bold-italic . "Courier-BoldOblique"))
2696 (size . 10.0)
2697 (line-height . 10.55)
2698 (space-width . 6.0)
2699 (avg-char-width . 6.0))
2700 (Helvetica ; the family key
2701 (fonts (normal . "Helvetica")
2702 (bold . "Helvetica-Bold")
2703 (italic . "Helvetica-Oblique")
2704 (bold-italic . "Helvetica-BoldOblique"))
2705 (size . 10.0)
2706 (line-height . 11.56)
2707 (space-width . 2.78)
2708 (avg-char-width . 5.09243))
2709 (Times
2710 (fonts (normal . "Times-Roman")
2711 (bold . "Times-Bold")
2712 (italic . "Times-Italic")
2713 (bold-italic . "Times-BoldItalic"))
2714 (size . 10.0)
2715 (line-height . 11.0)
2716 (space-width . 2.5)
2717 (avg-char-width . 4.71432))
2718 (Palatino
2719 (fonts (normal . "Palatino-Roman")
2720 (bold . "Palatino-Bold")
2721 (italic . "Palatino-Italic")
2722 (bold-italic . "Palatino-BoldItalic"))
2723 (size . 10.0)
2724 (line-height . 12.1)
2725 (space-width . 2.5)
2726 (avg-char-width . 5.08676))
2727 (Helvetica-Narrow
2728 (fonts (normal . "Helvetica-Narrow")
2729 (bold . "Helvetica-Narrow-Bold")
2730 (italic . "Helvetica-Narrow-Oblique")
2731 (bold-italic . "Helvetica-Narrow-BoldOblique"))
2732 (size . 10.0)
2733 (line-height . 11.56)
2734 (space-width . 2.2796)
2735 (avg-char-width . 4.17579))
2736 (NewCenturySchlbk
2737 (fonts (normal . "NewCenturySchlbk-Roman")
2738 (bold . "NewCenturySchlbk-Bold")
2739 (italic . "NewCenturySchlbk-Italic")
2740 (bold-italic . "NewCenturySchlbk-BoldItalic"))
2741 (size . 10.0)
2742 (line-height . 12.15)
2743 (space-width . 2.78)
2744 (avg-char-width . 5.31162))
2745 ;; got no bold for the next ones
2746 (AvantGarde-Book
2747 (fonts (normal . "AvantGarde-Book")
2748 (italic . "AvantGarde-BookOblique"))
2749 (size . 10.0)
2750 (line-height . 11.77)
2751 (space-width . 2.77)
2752 (avg-char-width . 5.45189))
2753 (AvantGarde-Demi
2754 (fonts (normal . "AvantGarde-Demi")
2755 (italic . "AvantGarde-DemiOblique"))
2756 (size . 10.0)
2757 (line-height . 12.72)
2758 (space-width . 2.8)
2759 (avg-char-width . 5.51351))
2760 (Bookman-Demi
2761 (fonts (normal . "Bookman-Demi")
2762 (italic . "Bookman-DemiItalic"))
2763 (size . 10.0)
2764 (line-height . 11.77)
2765 (space-width . 3.4)
2766 (avg-char-width . 6.05946))
2767 (Bookman-Light
2768 (fonts (normal . "Bookman-Light")
2769 (italic . "Bookman-LightItalic"))
2770 (size . 10.0)
2771 (line-height . 11.79)
2772 (space-width . 3.2)
2773 (avg-char-width . 5.67027))
2774 ;; got no bold and no italic for the next ones
2775 (Symbol
2776 (fonts (normal . "Symbol"))
2777 (size . 10.0)
2778 (line-height . 13.03)
2779 (space-width . 2.5)
2780 (avg-char-width . 3.24324))
2781 (Zapf-Dingbats
2782 (fonts (normal . "Zapf-Dingbats"))
2783 (size . 10.0)
2784 (line-height . 9.63)
2785 (space-width . 2.78)
2786 (avg-char-width . 2.78))
2787 (ZapfChancery-MediumItalic
2788 (fonts (normal . "ZapfChancery-MediumItalic"))
2789 (size . 10.0)
2790 (line-height . 11.45)
2791 (space-width . 2.2)
2792 (avg-char-width . 4.10811))
2793 ;; We keep this wrong entry name (but with correct font name) for
2794 ;; backward compatibility.
2795 (Zapf-Chancery-MediumItalic
2796 (fonts (normal . "ZapfChancery-MediumItalic"))
2797 (size . 10.0)
2798 (line-height . 11.45)
2799 (space-width . 2.2)
2800 (avg-char-width . 4.10811))
2802 "*Font info database.
2803 Each element comprises: font family (the key), name, bold, italic, bold-italic,
2804 reference size, line height, space width, average character width.
2805 To get the info for another specific font (say Helvetica), do the following:
2806 - create a new buffer
2807 - generate the PostScript image to a file (C-u M-x ps-print-buffer)
2808 - open this file and delete the leading `%' (which is the PostScript comment
2809 character) from the line
2810 `% 3 cm 20 cm moveto 10/Courier ReportFontInfo showpage'
2811 to get the line
2812 `3 cm 20 cm moveto 10/Helvetica ReportFontInfo showpage'
2813 - add the values to `ps-font-info-database'.
2814 You can get all the fonts of YOUR printer using `ReportAllFontInfo'.
2816 Note also that ps-print DOESN'T download any font to your printer, instead it
2817 uses the fonts resident in your printer."
2818 :type '(repeat
2819 (list :tag "Font Definition"
2820 (symbol :tag "Font Family")
2821 (cons :format "%v"
2822 (const :format "" fonts)
2823 (repeat :tag "Faces"
2824 (cons (choice :menu-tag "Font Weight/Slant"
2825 :tag "Font Weight/Slant"
2826 (const normal)
2827 (const bold)
2828 (const italic)
2829 (const bold-italic)
2830 (symbol :tag "Face"))
2831 (string :tag "Font Name"))))
2832 (cons :format "%v"
2833 (const :format "" size)
2834 (number :tag "Reference Size"))
2835 (cons :format "%v"
2836 (const :format "" line-height)
2837 (number :tag "Line Height"))
2838 (cons :format "%v"
2839 (const :format "" space-width)
2840 (number :tag "Space Width"))
2841 (cons :format "%v"
2842 (const :format "" avg-char-width)
2843 (number :tag "Average Character Width"))))
2844 :version "20"
2845 :group 'ps-print-font)
2847 (defcustom ps-font-family 'Courier
2848 "*Font family name for ordinary text, when generating PostScript."
2849 :type 'symbol
2850 :version "20"
2851 :group 'ps-print-font)
2853 (defcustom ps-font-size '(7 . 8.5)
2854 "*Font size, in points, for ordinary text, when generating PostScript.
2855 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
2856 :type '(choice :menu-tag "Ordinary Text Font Size"
2857 :tag "Ordinary Text Font Size"
2858 (number :tag "Text Size")
2859 (cons :tag "Landscape/Portrait"
2860 (number :tag "Landscape Text Size")
2861 (number :tag "Portrait Text Size")))
2862 :version "20"
2863 :group 'ps-print-font)
2865 (defcustom ps-header-font-family 'Helvetica
2866 "*Font family name for text in the header, when generating PostScript."
2867 :type 'symbol
2868 :version "20"
2869 :group 'ps-print-font)
2871 (defcustom ps-header-font-size '(10 . 12)
2872 "*Font size, in points, for text in the header, when generating PostScript.
2873 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
2874 :type '(choice :menu-tag "Header Font Size"
2875 :tag "Header Font Size"
2876 (number :tag "Header Size")
2877 (cons :tag "Landscape/Portrait"
2878 (number :tag "Landscape Header Size")
2879 (number :tag "Portrait Header Size")))
2880 :version "20"
2881 :group 'ps-print-font)
2883 (defcustom ps-header-title-font-size '(12 . 14)
2884 "*Font size, in points, for the top line of text in header, in PostScript.
2885 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
2886 :type '(choice :menu-tag "Header Title Font Size"
2887 :tag "Header Title Font Size"
2888 (number :tag "Header Title Size")
2889 (cons :tag "Landscape/Portrait"
2890 (number :tag "Landscape Header Title Size")
2891 (number :tag "Portrait Header Title Size")))
2892 :version "20"
2893 :group 'ps-print-font)
2895 (defcustom ps-footer-font-family 'Helvetica
2896 "*Font family name for text in the footer, when generating PostScript."
2897 :type 'symbol
2898 :version "21.1"
2899 :group 'ps-print-font)
2901 (defcustom ps-footer-font-size '(10 . 12)
2902 "*Font size, in points, for text in the footer, when generating PostScript.
2903 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
2904 :type '(choice :menu-tag "Footer Font Size"
2905 :tag "Footer Font Size"
2906 (number :tag "Footer Size")
2907 (cons :tag "Landscape/Portrait"
2908 (number :tag "Landscape Footer Size")
2909 (number :tag "Portrait Footer Size")))
2910 :version "21.1"
2911 :group 'ps-print-font)
2913 (defcustom ps-line-number-color "black"
2914 "*Specify color for line-number, when generating PostScript."
2915 :type '(choice :menu-tag "Line Number Color"
2916 :tag "Line Number Color"
2917 (number :tag "Gray Scale" :value 0)
2918 (string :tag "Color Name" :value "black")
2919 (list :tag "RGB Color" :value (0 0 0)
2920 (number :tag "Red")
2921 (number :tag "Green")
2922 (number :tag "Blue")))
2923 :version "21.1"
2924 :group 'ps-print-font
2925 :group 'ps-print-miscellany)
2927 (defcustom ps-line-number-font "Times-Italic"
2928 "*Font for line-number, when generating PostScript."
2929 :type 'string
2930 :version "20"
2931 :group 'ps-print-font
2932 :group 'ps-print-miscellany)
2934 (defcustom ps-line-number-font-size 6
2935 "*Font size, in points, for line number, when generating PostScript.
2936 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
2937 :type '(choice :menu-tag "Line Number Font Size"
2938 :tag "Line Number Font Size"
2939 (number :tag "Font Size")
2940 (cons :tag "Landscape/Portrait"
2941 (number :tag "Landscape Font Size")
2942 (number :tag "Portrait Font Size")))
2943 :version "20"
2944 :group 'ps-print-font
2945 :group 'ps-print-miscellany)
2947 ;;; Colors
2949 ;; Printing color requires x-color-values.
2950 ;; XEmacs change: Need autoload for the "Options->Printing->Color Printing"
2951 ;; widget to work.
2952 ;;;###autoload
2953 (defcustom ps-print-color-p
2954 (or (fboundp 'x-color-values) ; Emacs
2955 (fboundp 'color-instance-rgb-components))
2956 ; XEmacs
2957 "*Specify how buffer's text color is printed.
2959 Valid values are:
2961 nil Do not print colors.
2963 t Print colors.
2965 black-white Print colors on black/white printer.
2966 See also `ps-black-white-faces'.
2968 Any other value is treated as t."
2969 :type '(choice :menu-tag "Print Color"
2970 :tag "Print Color"
2971 (const :tag "Do NOT Print Color" nil)
2972 (const :tag "Print Always Color" t)
2973 (const :tag "Print Black/White Color" black-white))
2974 :version "20"
2975 :group 'ps-print-color)
2977 (defcustom ps-default-fg nil
2978 "*RGB values of the default foreground color.
2980 The `ps-default-fg' variable contains the default foreground color used by
2981 ps-print, that is, if there is a face in a text that doesn't have a foreground
2982 color, the `ps-default-fg' color should be used.
2984 Valid values are:
2986 t The foreground color of Emacs session will be used.
2988 frame-parameter The foreground-color frame parameter will be used.
2990 NUMBER It's a real value between 0.0 (black) and 1.0 (white) that
2991 indicate the gray color.
2993 COLOR-NAME It's a string which contains the color name. For example:
2994 \"yellow\".
2996 LIST It's a list of RGB values, that is a list of three real values
2997 of the form:
2999 (RED GREEN BLUE)
3001 Where RED, GREEN and BLUE are reals between 0.0 (no color) and
3002 1.0 (full color).
3004 Any other value is ignored and black color will be used.
3006 This variable is used only when `ps-print-color-p' (which see) is neither nil
3007 nor black-white."
3008 :type '(choice :menu-tag "Default Foreground Gray/Color"
3009 :tag "Default Foreground Gray/Color"
3010 (const :tag "Session Foreground" t)
3011 (const :tag "Frame Foreground" frame-parameter)
3012 (number :tag "Gray Scale" :value 0.0)
3013 (string :tag "Color Name" :value "black")
3014 (list :tag "RGB Color" :value (0.0 0.0 0.0)
3015 (number :tag "Red")
3016 (number :tag "Green")
3017 (number :tag "Blue")))
3018 :version "20"
3019 :group 'ps-print-color)
3021 (defcustom ps-default-bg nil
3022 "*RGB values of the default background color.
3024 The `ps-default-bg' variable contains the default background color used by
3025 ps-print, that is, if there is a face in a text that doesn't have a background
3026 color, the `ps-default-bg' color should be used.
3028 Valid values are:
3030 t The background color of Emacs session will be used.
3032 frame-parameter The background-color frame parameter will be used.
3034 NUMBER It's a real value between 0.0 (black) and 1.0 (white) that
3035 indicate the gray color.
3037 COLOR-NAME It's a string which contains the color name. For example:
3038 \"yellow\".
3040 LIST It's a list of RGB values, that is a list of three real values
3041 of the form:
3043 (RED GREEN BLUE)
3045 Where RED, GREEN and BLUE are reals between 0.0 (no color) and
3046 1.0 (full color).
3048 Any other value is ignored and white color will be used.
3050 This variable is used only when `ps-print-color-p' (which see) is neither nil
3051 nor black-white.
3053 See also `ps-use-face-background'."
3054 :type '(choice :menu-tag "Default Background Gray/Color"
3055 :tag "Default Background Gray/Color"
3056 (const :tag "Session Background" t)
3057 (const :tag "Frame Background" frame-parameter)
3058 (number :tag "Gray Scale" :value 1.0)
3059 (string :tag "Color Name" :value "white")
3060 (list :tag "RGB Color" :value (1.0 1.0 1.0)
3061 (number :tag "Red")
3062 (number :tag "Green")
3063 (number :tag "Blue")))
3064 :version "20"
3065 :group 'ps-print-color)
3067 (defcustom ps-fg-list nil
3068 "*Specify foreground color list.
3070 This list is used to chose a text foreground color which is different than the
3071 background color. It'll be used the first foreground color in `ps-fg-list'
3072 which is different from the background color.
3074 If this list is nil, the default foreground color is used. See
3075 `ps-default-fg'.
3077 The list element valid values are:
3079 NUMBER It's a real value between 0.0 (black) and 1.0 (white) that
3080 indicate the gray color.
3082 COLOR-NAME It's a string which contains the color name. For example:
3083 \"yellow\".
3085 LIST It's a list of RGB values, that is a list of three real values
3086 of the form:
3088 (RED GREEN BLUE)
3090 Where RED, GREEN and BLUE are reals between 0.0 (no color) and
3091 1.0 (full color).
3093 Any other value is ignored and black color will be used.
3095 This variable is used only when `ps-fg-validate-p' (which see) is non-nil and
3096 when `ps-print-color-p' (which see) is neither nil nor black-white."
3097 :type '(repeat
3098 (choice :menu-tag "Foreground Gray/Color"
3099 :tag "Foreground Gray/Color"
3100 (number :tag "Gray Scale" :value 0.0)
3101 (string :tag "Color Name" :value "black")
3102 (list :tag "RGB Color" :value (0.0 0.0 0.0)
3103 (number :tag "Red")
3104 (number :tag "Green")
3105 (number :tag "Blue"))))
3106 :version "22"
3107 :group 'ps-print-color)
3109 (defcustom ps-fg-validate-p t
3110 "*Non-nil means validate if foreground color is different than background.
3112 If text foreground and background colors are equals, no text will appear.
3114 See also `ps-fg-list'."
3115 :type 'boolean
3116 :version "22"
3117 :group 'ps-print-color)
3119 (defcustom ps-auto-font-detect t
3120 "*Non-nil means automatically detect bold/italic/underline face attributes.
3121 If nil, we rely solely on the lists `ps-bold-faces', `ps-italic-faces', and
3122 `ps-underlined-faces'."
3123 :type 'boolean
3124 :version "20"
3125 :group 'ps-print-font)
3127 (defcustom ps-black-white-faces
3128 '((font-lock-builtin-face "black" nil bold )
3129 (font-lock-comment-face "gray20" nil italic)
3130 (font-lock-constant-face "black" nil bold )
3131 (font-lock-function-name-face "black" nil bold )
3132 (font-lock-keyword-face "black" nil bold )
3133 (font-lock-string-face "black" nil italic)
3134 (font-lock-type-face "black" nil italic)
3135 (font-lock-variable-name-face "black" nil bold italic)
3136 (font-lock-warning-face "black" nil bold italic))
3137 "*Specify list of face attributes to print colors on black/white printers.
3139 The list elements are the same as defined on `ps-extend-face' (which see).
3141 This variable is used only when `ps-print-color-p' is set to `black-white'."
3142 :version "21.1"
3143 :type '(repeat
3144 (list :tag "Face Specification"
3145 (face :tag "Face Symbol")
3146 (choice :menu-tag "Foreground Color"
3147 :tag "Foreground Color"
3148 (const :tag "Black" nil)
3149 (string :tag "Color Name"))
3150 (choice :menu-tag "Background Color"
3151 :tag "Background Color"
3152 (const :tag "None" nil)
3153 (string :tag "Color Name"))
3154 (repeat :inline t
3155 (choice :menu-tag "Attribute"
3156 (const bold)
3157 (const italic)
3158 (const underline)
3159 (const strikeout)
3160 (const overline)
3161 (const shadow)
3162 (const box)
3163 (const outline)))))
3164 :version "20"
3165 :group 'ps-print-face)
3167 (defcustom ps-bold-faces
3168 (unless ps-print-color-p
3169 '(font-lock-function-name-face
3170 font-lock-builtin-face
3171 font-lock-variable-name-face
3172 font-lock-keyword-face
3173 font-lock-warning-face))
3174 "*A list of the \(non-bold\) faces that should be printed in bold font.
3175 This applies to generating PostScript."
3176 :type '(repeat face)
3177 :version "20"
3178 :group 'ps-print-face)
3180 (defcustom ps-italic-faces
3181 (unless ps-print-color-p
3182 '(font-lock-variable-name-face
3183 font-lock-type-face
3184 font-lock-string-face
3185 font-lock-comment-face
3186 font-lock-warning-face))
3187 "*A list of the \(non-italic\) faces that should be printed in italic font.
3188 This applies to generating PostScript."
3189 :type '(repeat face)
3190 :version "20"
3191 :group 'ps-print-face)
3193 (defcustom ps-underlined-faces
3194 (unless ps-print-color-p
3195 '(font-lock-function-name-face
3196 font-lock-constant-face
3197 font-lock-warning-face))
3198 "*A list of the \(non-underlined\) faces that should be printed underlined.
3199 This applies to generating PostScript."
3200 :type '(repeat face)
3201 :version "20"
3202 :group 'ps-print-face)
3204 (defcustom ps-use-face-background nil
3205 "*Specify if face background should be used.
3207 Valid values are:
3209 t always use face background color.
3210 nil never use face background color.
3211 (face...) list of faces whose background color will be used.
3213 Any other value will be treated as t."
3214 :type '(choice :menu-tag "Use Face Background"
3215 :tag "Use Face Background"
3216 (const :tag "Always Use Face Background" t)
3217 (const :tag "Never Use Face Background" nil)
3218 (repeat :menu-tag "Face Background List"
3219 :tag "Face Background List"
3220 face))
3221 :version "20"
3222 :group 'ps-print-face)
3224 (defcustom ps-left-header
3225 (list 'ps-get-buffer-name 'ps-header-dirpart)
3226 "*The items to display (each on a line) on the left part of the page header.
3227 This applies to generating PostScript.
3229 The value should be a list of strings and symbols, each representing an entry
3230 in the PostScript array HeaderLinesLeft.
3232 Strings are inserted unchanged into the array; those representing
3233 PostScript string literals should be delimited with PostScript string
3234 delimiters '(' and ')'.
3236 For symbols with bound functions, the function is called and should return a
3237 string to be inserted into the array. For symbols with bound values, the value
3238 should be a string to be inserted into the array. In either case, function or
3239 variable, the string value has PostScript string delimiters added to it.
3241 If symbols are unbounded, they are silently ignored."
3242 :type '(repeat (choice :menu-tag "Left Header"
3243 :tag "Left Header"
3244 string symbol))
3245 :version "20"
3246 :group 'ps-print-headers)
3248 (defcustom ps-right-header
3249 (list "/pagenumberstring load"
3250 'ps-time-stamp-locale-default 'ps-time-stamp-hh:mm:ss)
3251 "*The items to display (each on a line) on the right part of the page header.
3252 This applies to generating PostScript.
3254 See the variable `ps-left-header' for a description of the format of this
3255 variable.
3257 There are the following basic functions implemented:
3259 `ps-time-stamp-locale-default' Return the locale's \"preferred\" date
3260 as, for example, \"06/18/01\".
3262 `ps-time-stamp-hh:mm:ss' Return time as \"17:28:31\".
3264 `ps-time-stamp-mon-dd-yyyy' Return date as \"Jun 18 2001\".
3266 `ps-time-stamp-yyyy-mm-dd' Return date as \"2001-06-18\" (ISO
3267 date).
3269 `ps-time-stamp-iso8601' Alias for `ps-time-stamp-yyyy-mm-dd'.
3271 You can also create your own time stamp function by using `format-time-string'
3272 \(which see)."
3273 :type '(repeat (choice :menu-tag "Right Header"
3274 :tag "Right Header"
3275 string symbol))
3276 :version "20"
3277 :group 'ps-print-headers)
3279 (defcustom ps-left-footer
3280 (list 'ps-get-buffer-name 'ps-header-dirpart)
3281 "*The items to display (each on a line) on the left part of the page footer.
3282 This applies to generating PostScript.
3284 The value should be a list of strings and symbols, each representing an entry
3285 in the PostScript array FooterLinesLeft.
3287 Strings are inserted unchanged into the array; those representing PostScript
3288 string literals should be delimited with PostScript string delimiters '(' and
3289 ')'.
3291 For symbols with bound functions, the function is called and should return a
3292 string to be inserted into the array. For symbols with bound values, the value
3293 should be a string to be inserted into the array. In either case, function or
3294 variable, the string value has PostScript string delimiters added to it.
3296 If symbols are unbounded, they are silently ignored."
3297 :type '(repeat (choice :menu-tag "Left Footer"
3298 :tag "Left Footer"
3299 string symbol))
3300 :version "21.1"
3301 :group 'ps-print-headers)
3303 (defcustom ps-right-footer
3304 (list "/pagenumberstring load"
3305 'ps-time-stamp-locale-default 'ps-time-stamp-hh:mm:ss)
3306 "*The items to display (each on a line) on the right part of the page footer.
3307 This applies to generating PostScript.
3309 See the variable `ps-left-footer' for a description of the format of this
3310 variable.
3312 There are the following basic functions implemented:
3314 `ps-time-stamp-locale-default' Return the locale's \"preferred\" date
3315 as, for example, \"06/18/01\".
3317 `ps-time-stamp-hh:mm:ss' Return time as \"17:28:31\".
3319 `ps-time-stamp-mon-dd-yyyy' Return date as \"Jun 18 2001\".
3321 `ps-time-stamp-yyyy-mm-dd' Return date as \"2001-06-18\" (ISO
3322 date).
3324 `ps-time-stamp-iso8601' Alias for `ps-time-stamp-yyyy-mm-dd'.
3326 You can also create your own time stamp function by using `format-time-string'
3327 \(which see)."
3328 :type '(repeat (choice :menu-tag "Right Footer"
3329 :tag "Right Footer"
3330 string symbol))
3331 :version "21.1"
3332 :group 'ps-print-headers)
3334 (defcustom ps-razzle-dazzle t
3335 "*Non-nil means report progress while formatting buffer."
3336 :type 'boolean
3337 :version "20"
3338 :group 'ps-print-miscellany)
3340 (defcustom ps-adobe-tag "%!PS-Adobe-3.0\n"
3341 "*Contains the header line identifying the output as PostScript.
3342 By default, `ps-adobe-tag' contains the standard identifier. Some printers
3343 require slightly different versions of this line."
3344 :type 'string
3345 :version "20"
3346 :group 'ps-print-miscellany)
3348 (defcustom ps-build-face-reference t
3349 "*Non-nil means build the reference face lists.
3351 ps-print sets this value to nil after it builds its internal reference lists of
3352 bold and italic faces. By setting its value back to t, you can force ps-print
3353 to rebuild the lists the next time you invoke one of the ...-with-faces
3354 commands.
3356 You should set this value back to t after you change the attributes of any
3357 face, or create new faces. Most users shouldn't have to worry about its
3358 setting, though."
3359 :type 'boolean
3360 :version "20"
3361 :group 'ps-print-face)
3363 (defcustom ps-always-build-face-reference nil
3364 "*Non-nil means always rebuild the reference face lists.
3366 If this variable is non-nil, ps-print will rebuild its internal reference lists
3367 of bold and italic faces *every* time one of the ...-with-faces commands is
3368 called. Most users shouldn't need to set this variable."
3369 :type 'boolean
3370 :version "20"
3371 :group 'ps-print-face)
3373 (defcustom ps-banner-page-when-duplexing nil
3374 "*Non-nil means the very first page is skipped.
3375 It's like the very first character of buffer (or region) is ^L (\\014)."
3376 :type 'boolean
3377 :version "20"
3378 :group 'ps-print-headers)
3380 (defcustom ps-postscript-code-directory
3381 (or (if (featurep 'xemacs)
3382 (cond ((fboundp 'locate-data-directory) ; XEmacs
3383 (funcall 'locate-data-directory "ps-print"))
3384 ((boundp 'data-directory) ; XEmacs
3385 (symbol-value 'data-directory))
3386 (t ; don't know what to do
3387 nil))
3388 data-directory) ; Emacs
3389 (error "`ps-postscript-code-directory' isn't set properly"))
3390 "*Directory where it's located the PostScript prologue file used by ps-print.
3391 By default, this directory is the same as in the variable `data-directory'."
3392 :type 'directory
3393 :version "20"
3394 :group 'ps-print-miscellany)
3396 (defcustom ps-line-spacing 0
3397 "*Specify line spacing, in points, for ordinary text.
3399 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE).
3401 See also `ps-paragraph-spacing' and `ps-paragraph-regexp'.
3403 To get all lines with some spacing set both `ps-line-spacing' and
3404 `ps-paragraph-spacing' variables."
3405 :type '(choice :menu-tag "Line Spacing For Ordinary Text"
3406 :tag "Line Spacing For Ordinary Text"
3407 (number :tag "Line Spacing")
3408 (cons :tag "Landscape/Portrait"
3409 (number :tag "Landscape Line Spacing")
3410 (number :tag "Portrait Line Spacing")))
3411 :version "21.1"
3412 :group 'ps-print-miscellany)
3414 (defcustom ps-paragraph-spacing 0
3415 "*Specify paragraph spacing, in points, for ordinary text.
3417 Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE).
3419 See also `ps-line-spacing' and `ps-paragraph-regexp'.
3421 To get all lines with some spacing set both `ps-line-spacing' and
3422 `ps-paragraph-spacing' variables."
3423 :type '(choice :menu-tag "Paragraph Spacing For Ordinary Text"
3424 :tag "Paragraph Spacing For Ordinary Text"
3425 (number :tag "Paragraph Spacing")
3426 (cons :tag "Landscape/Portrait"
3427 (number :tag "Landscape Paragraph Spacing")
3428 (number :tag "Portrait Paragraph Spacing")))
3429 :version "21.1"
3430 :group 'ps-print-miscellany)
3432 (defcustom ps-paragraph-regexp "[ \t]*$"
3433 "*Specify paragraph delimiter.
3435 It should be a regexp or nil.
3437 See also `ps-paragraph-spacing'."
3438 :type '(choice :menu-tag "Paragraph Delimiter"
3439 (const :tag "No Delimiter" nil)
3440 (regexp :tag "Delimiter Regexp"))
3441 :version "21.1"
3442 :group 'ps-print-miscellany)
3444 (defcustom ps-begin-cut-regexp nil
3445 "*Specify regexp which is start of a region to cut out when printing.
3447 As an example, variables `ps-begin-cut-regexp' and `ps-end-cut-regexp' may be
3448 set to \"^Local Variables:\" and \"^End:\", respectively, in order to leave out
3449 some special printing instructions from the actual print. Special printing
3450 instructions may be appended to the end of the file just like any other
3451 buffer-local variables. See section \"Local Variables in Files\" on Emacs
3452 manual for more information.
3454 Variables `ps-begin-cut-regexp' and `ps-end-cut-regexp' control together what
3455 actually gets printed. Both variables may be set to nil in which case no
3456 cutting occurs."
3457 :type '(choice (const :tag "No Delimiter" nil)
3458 (regexp :tag "Delimiter Regexp"))
3459 :version "21.1"
3460 :group 'ps-print-miscellany)
3462 (defcustom ps-end-cut-regexp nil
3463 "*Specify regexp which is end of the region to cut out when printing.
3465 See `ps-begin-cut-regexp' for more information."
3466 :type '(choice (const :tag "No Delimiter" nil)
3467 (regexp :tag "Delimiter Regexp"))
3468 :version "21.1"
3469 :group 'ps-print-miscellany)
3472 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3473 ;; Selected Pages
3476 (defvar ps-last-selected-pages nil
3477 "Latest `ps-selected-pages' value.")
3480 (defun ps-restore-selected-pages ()
3481 "Restore latest `ps-selected-pages' value."
3482 (interactive)
3483 (setq ps-selected-pages ps-last-selected-pages))
3486 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3487 ;; Customization
3490 ;;;###autoload
3491 (defun ps-print-customize ()
3492 "Customization of ps-print group."
3493 (interactive)
3494 (customize-group 'ps-print))
3497 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3498 ;; User commands
3501 ;;;###autoload
3502 (defun ps-print-buffer (&optional filename)
3503 "Generate and print a PostScript image of the buffer.
3505 Interactively, when you use a prefix argument (\\[universal-argument]), the command prompts the
3506 user for a file name, and saves the PostScript image in that file instead of
3507 sending it to the printer.
3509 Noninteractively, the argument FILENAME is treated as follows: if it is nil,
3510 send the image to the printer. If FILENAME is a string, save the PostScript
3511 image in a file with that name."
3512 (interactive (list (ps-print-preprint current-prefix-arg)))
3513 (ps-print-without-faces (point-min) (point-max) filename))
3516 ;;;###autoload
3517 (defun ps-print-buffer-with-faces (&optional filename)
3518 "Generate and print a PostScript image of the buffer.
3519 Like `ps-print-buffer', but includes font, color, and underline information in
3520 the generated image. This command works only if you are using a window system,
3521 so it has a way to determine color values."
3522 (interactive (list (ps-print-preprint current-prefix-arg)))
3523 (ps-print-with-faces (point-min) (point-max) filename))
3526 ;;;###autoload
3527 (defun ps-print-region (from to &optional filename)
3528 "Generate and print a PostScript image of the region.
3529 Like `ps-print-buffer', but prints just the current region."
3530 (interactive (ps-print-preprint-region current-prefix-arg))
3531 (ps-print-without-faces from to filename t))
3534 ;;;###autoload
3535 (defun ps-print-region-with-faces (from to &optional filename)
3536 "Generate and print a PostScript image of the region.
3537 Like `ps-print-region', but includes font, color, and underline information in
3538 the generated image. This command works only if you are using a window system,
3539 so it has a way to determine color values."
3540 (interactive (ps-print-preprint-region current-prefix-arg))
3541 (ps-print-with-faces from to filename t))
3544 ;;;###autoload
3545 (defun ps-spool-buffer ()
3546 "Generate and spool a PostScript image of the buffer.
3547 Like `ps-print-buffer' except that the PostScript image is saved in a local
3548 buffer to be sent to the printer later.
3550 Use the command `ps-despool' to send the spooled images to the printer."
3551 (interactive)
3552 (ps-spool-without-faces (point-min) (point-max)))
3555 ;;;###autoload
3556 (defun ps-spool-buffer-with-faces ()
3557 "Generate and spool a PostScript image of the buffer.
3558 Like `ps-spool-buffer', but includes font, color, and underline information in
3559 the generated image. This command works only if you are using a window system,
3560 so it has a way to determine color values.
3562 Use the command `ps-despool' to send the spooled images to the printer."
3563 (interactive)
3564 (ps-spool-with-faces (point-min) (point-max)))
3567 ;;;###autoload
3568 (defun ps-spool-region (from to)
3569 "Generate a PostScript image of the region and spool locally.
3570 Like `ps-spool-buffer', but spools just the current region.
3572 Use the command `ps-despool' to send the spooled images to the printer."
3573 (interactive "r")
3574 (ps-spool-without-faces from to t))
3577 ;;;###autoload
3578 (defun ps-spool-region-with-faces (from to)
3579 "Generate a PostScript image of the region and spool locally.
3580 Like `ps-spool-region', but includes font, color, and underline information in
3581 the generated image. This command works only if you are using a window system,
3582 so it has a way to determine color values.
3584 Use the command `ps-despool' to send the spooled images to the printer."
3585 (interactive "r")
3586 (ps-spool-with-faces from to t))
3588 ;;;###autoload
3589 (defun ps-despool (&optional filename)
3590 "Send the spooled PostScript to the printer.
3592 Interactively, when you use a prefix argument (\\[universal-argument]), the command prompts the
3593 user for a file name, and saves the spooled PostScript image in that file
3594 instead of sending it to the printer.
3596 Noninteractively, the argument FILENAME is treated as follows: if it is nil,
3597 send the image to the printer. If FILENAME is a string, save the PostScript
3598 image in a file with that name."
3599 (interactive (list (ps-print-preprint current-prefix-arg)))
3600 (ps-do-despool filename))
3602 ;;;###autoload
3603 (defun ps-line-lengths ()
3604 "Display the correspondence between a line length and a font size.
3605 Done using the current ps-print setup.
3606 Try: pr -t file | awk '{printf \"%3d %s\n\", length($0), $0}' | sort -r | head"
3607 (interactive)
3608 (ps-line-lengths-internal))
3610 ;;;###autoload
3611 (defun ps-nb-pages-buffer (nb-lines)
3612 "Display number of pages to print this buffer, for various font heights.
3613 The table depends on the current ps-print setup."
3614 (interactive (ps-count-lines-preprint (point-min) (point-max)))
3615 (ps-nb-pages nb-lines))
3617 ;;;###autoload
3618 (defun ps-nb-pages-region (nb-lines)
3619 "Display number of pages to print the region, for various font heights.
3620 The table depends on the current ps-print setup."
3621 (interactive (ps-count-lines-preprint (mark) (point)))
3622 (ps-nb-pages nb-lines))
3624 (defvar ps-prefix-quote nil
3625 "Used for `ps-print-quote' (which see).")
3627 ;;;###autoload
3628 (defun ps-setup ()
3629 "Return the current PostScript-generation setup."
3630 (let (ps-prefix-quote)
3631 (mapconcat
3632 #'ps-print-quote
3633 (list
3634 (concat "\n;;; (" (if (featurep 'xemacs) "XEmacs" "Emacs")
3635 ") ps-print version " ps-print-version "\n")
3636 ";; internal vars"
3637 (ps-comment-string "emacs-version " emacs-version)
3638 (ps-comment-string "ps-windows-system " ps-windows-system)
3639 (ps-comment-string "ps-lp-system " ps-lp-system)
3641 '(25 . ps-print-color-p)
3642 '(25 . ps-lpr-command)
3643 '(25 . ps-lpr-switches)
3644 '(25 . ps-printer-name)
3645 '(25 . ps-printer-name-option)
3646 '(25 . ps-print-region-function)
3647 '(25 . ps-manual-feed)
3648 '(25 . ps-end-with-control-d)
3650 '(23 . ps-paper-type)
3651 '(23 . ps-warn-paper-type)
3652 '(23 . ps-landscape-mode)
3653 '(23 . ps-print-upside-down)
3654 '(23 . ps-number-of-columns)
3656 '(23 . ps-zebra-stripes)
3657 '(23 . ps-zebra-stripe-height)
3658 '(23 . ps-zebra-stripe-follow)
3659 '(23 . ps-zebra-color)
3660 '(23 . ps-line-number)
3661 '(23 . ps-line-number-step)
3662 '(23 . ps-line-number-start)
3664 '(17 . ps-razzle-dazzle)
3665 '(17 . ps-default-bg)
3666 '(17 . ps-default-fg)
3667 '(17 . ps-fg-validate-p)
3668 '(17 . ps-fg-list)
3670 '(23 . ps-use-face-background)
3672 '(28 . ps-print-control-characters)
3674 '(26 . ps-print-background-image)
3676 '(25 . ps-print-background-text)
3678 '(29 . ps-error-handler-message)
3679 '(29 . ps-user-defined-prologue)
3680 '(29 . ps-print-prologue-header)
3681 '(29 . ps-postscript-code-directory)
3682 '(29 . ps-adobe-tag)
3684 '(30 . ps-left-margin)
3685 '(30 . ps-right-margin)
3686 '(30 . ps-inter-column)
3687 '(30 . ps-bottom-margin)
3688 '(30 . ps-top-margin)
3689 '(30 . ps-print-only-one-header)
3690 '(30 . ps-switch-header)
3691 '(30 . ps-print-header)
3692 '(30 . ps-header-lines)
3693 '(30 . ps-header-offset)
3694 '(30 . ps-header-line-pad)
3695 '(30 . ps-print-header-frame)
3696 '(30 . ps-header-frame-alist)
3697 '(30 . ps-print-footer)
3698 '(30 . ps-footer-lines)
3699 '(30 . ps-footer-offset)
3700 '(30 . ps-footer-line-pad)
3701 '(30 . ps-print-footer-frame)
3702 '(30 . ps-footer-frame-alist)
3703 '(30 . ps-show-n-of-n)
3704 '(30 . ps-spool-config)
3705 '(30 . ps-spool-duplex)
3706 '(30 . ps-spool-tumble)
3707 '(30 . ps-banner-page-when-duplexing)
3708 '(30 . ps-left-header)
3709 '(30 . ps-right-header)
3710 '(30 . ps-left-footer)
3711 '(30 . ps-right-footer)
3713 '(23 . ps-n-up-printing)
3714 '(23 . ps-n-up-margin)
3715 '(23 . ps-n-up-border-p)
3716 '(23 . ps-n-up-filling)
3718 '(26 . ps-multibyte-buffer)
3719 '(26 . ps-font-family)
3720 '(26 . ps-font-size)
3721 '(26 . ps-header-font-family)
3722 '(26 . ps-header-font-size)
3723 '(26 . ps-header-title-font-size)
3724 '(26 . ps-footer-font-family)
3725 '(26 . ps-footer-font-size)
3726 '(26 . ps-line-number-color)
3727 '(26 . ps-line-number-font)
3728 '(26 . ps-line-number-font-size)
3729 '(26 . ps-line-spacing)
3730 '(26 . ps-paragraph-spacing)
3731 '(26 . ps-paragraph-regexp)
3732 '(26 . ps-begin-cut-regexp)
3733 '(26 . ps-end-cut-regexp)
3735 '(23 . ps-even-or-odd-pages)
3736 '(23 . ps-selected-pages)
3737 '(23 . ps-last-selected-pages)
3739 '(31 . ps-build-face-reference)
3740 '(31 . ps-always-build-face-reference)
3742 '(20 . ps-auto-font-detect)
3743 '(20 . ps-bold-faces)
3744 '(20 . ps-italic-faces)
3745 '(20 . ps-underlined-faces)
3746 '(20 . ps-black-white-faces)
3747 " )\n
3748 \;; The following customized variables have long lists and are seldom modified:
3749 \;; ps-page-dimensions-database
3750 \;; ps-font-info-database
3752 \;;; ps-print - end of settings\n")
3753 "\n")))
3756 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3757 ;; Utility functions and variables:
3760 (defun ps-print-quote (elt)
3761 "Quote ELT for printing (used for showing settings).
3763 If ELT is nil, return an empty string.
3764 If ELT is string, return it.
3765 Otherwise, ELT should be a cons (LEN . SYM) where SYM is a variable symbol and
3766 LEN is the field length where SYM name will be inserted. The variable
3767 `ps-prefix-quote' is used to form the string, if `ps-prefix-quote' is nil, it's
3768 used \"(setq \" as prefix; otherwise, it's used \" \". So, the string
3769 generated is:
3771 * If `ps-prefix-quote' is nil:
3772 \"(setq SYM-NAME SYM-VALUE\"
3773 |<------->|
3776 * If `ps-prefix-quote' is non-nil:
3777 \" SYM-NAME SYM-VALUE\"
3778 |<------->|
3781 If `ps-prefix-quote' is nil, it's set to t after generating string."
3782 (cond
3783 ((stringp elt) elt)
3784 ((and (consp elt) (integerp (car elt))
3785 (symbolp (cdr elt)) (boundp (cdr elt)))
3786 (let* ((col (car elt))
3787 (sym (cdr elt))
3788 (key (symbol-name sym))
3789 (len (length key))
3790 (val (symbol-value sym)))
3791 (concat (if ps-prefix-quote
3793 (setq ps-prefix-quote t)
3794 "(setq ")
3796 (if (> col len)
3797 (make-string (- col len) ?\s)
3798 " ")
3799 (ps-value-string val))))
3800 (t "")
3804 (defun ps-value-string (val)
3805 "Return a string representation of VAL. Used by `ps-print-quote'."
3806 (cond ((null val)
3807 "nil")
3808 ((eq val t)
3809 "t")
3810 ((or (symbolp val) (listp val))
3811 (format "'%S" val))
3813 (format "%S" val))))
3816 (defun ps-comment-string (str value)
3817 "Return a comment string like \";; STR = VALUE\"."
3818 (format ";; %s = %s" str (ps-value-string value)))
3821 (defun ps-value (alist-sym key)
3822 "Return value from association list ALIST-SYM which car is `eq' to KEY."
3823 (cdr (assq key (symbol-value alist-sym))))
3826 (defun ps-get (alist-sym key)
3827 "Return element from association list ALIST-SYM which car is `eq' to KEY."
3828 (assq key (symbol-value alist-sym)))
3831 (defun ps-put (alist-sym key value)
3832 "Store element (KEY . VALUE) into association list ALIST-SYM.
3833 If KEY already exists in ALIST-SYM, modify cdr to VALUE.
3834 It can be retrieved with `(ps-get ALIST-SYM KEY)'."
3835 (let ((elt: (assq key (symbol-value alist-sym)))) ; to avoid name conflict
3836 (if elt:
3837 (setcdr elt: value)
3838 (setq elt: (cons key value))
3839 (set alist-sym (cons elt: (symbol-value alist-sym))))
3840 elt:))
3843 (defun ps-del (alist-sym key)
3844 "Delete by side effect element KEY from association list ALIST-SYM."
3845 (let ((a:list: (symbol-value alist-sym)) ; to avoid name conflict
3846 old)
3847 (while a:list:
3848 (if (eq key (car (car a:list:)))
3849 (progn
3850 (if old
3851 (setcdr old (cdr a:list:))
3852 (set alist-sym (cdr a:list:)))
3853 (setq a:list: nil))
3854 (setq old a:list:
3855 a:list: (cdr a:list:)))))
3856 (symbol-value alist-sym))
3859 (defun ps-time-stamp-locale-default ()
3860 "Return the locale's \"preferred\" date as, for example, \"06/18/01\"."
3861 (format-time-string "%x"))
3864 (defun ps-time-stamp-mon-dd-yyyy ()
3865 "Return date as \"Jun 18 2001\"."
3866 (format-time-string "%b %d %Y"))
3869 (defun ps-time-stamp-yyyy-mm-dd ()
3870 "Return date as \"2001-06-18\" (ISO date)."
3871 (format-time-string "%Y-%m-%d"))
3874 ;; Alias for `ps-time-stamp-yyyy-mm-dd' (which see).
3875 (defalias 'ps-time-stamp-iso8601 'ps-time-stamp-yyyy-mm-dd)
3878 (defun ps-time-stamp-hh:mm:ss ()
3879 "Return time as \"17:28:31\"."
3880 (format-time-string "%T"))
3883 (and (featurep 'xemacs)
3884 ;; XEmacs change: Need to check for emacs-major-version too.
3885 (or (< emacs-major-version 19)
3886 (and (= emacs-major-version 19) (< emacs-minor-version 12)))
3887 (setq ps-print-color-p nil))
3890 ;; Return t if the device (which can be changed during an emacs session)
3891 ;; can handle colors.
3892 ;; This function is not yet implemented for GNU emacs.
3893 (defalias 'ps-color-device
3894 (cond ((and (featurep 'xemacs)
3895 ;; XEmacs change: Need to check for emacs-major-version too.
3896 (or (> emacs-major-version 19)
3897 (and (= emacs-major-version 19)
3898 (>= emacs-minor-version 12)))) ; XEmacs >= 19.12
3899 (lambda ()
3900 (eq (device-class) 'color)))
3902 (t ; Emacs
3903 (lambda ()
3904 (if (fboundp 'color-values)
3905 (color-values "Green")
3906 t)))))
3909 (defun ps-xemacs-mapper (extent list)
3910 (when (featurep 'xemacs)
3911 (nconc list
3912 (list (list (extent-start-position extent) 'push extent)
3913 (list (extent-end-position extent) 'pull extent))))
3914 nil)
3916 (defun ps-xemacs-extent-sorter (a b)
3917 (when (featurep 'xemacs)
3918 (< (extent-priority a) (extent-priority b))))
3920 (defun ps-xemacs-face-kind-p (face kind kind-regex)
3921 (when (featurep 'xemacs)
3922 (let* ((frame-font (or (face-font-instance face)
3923 (face-font-instance 'default)))
3924 (kind-cons
3925 (and frame-font
3926 (assq kind
3927 (font-instance-properties frame-font))))
3928 (kind-spec (cdr-safe kind-cons))
3929 (case-fold-search t))
3930 (and kind-spec (string-match kind-regex kind-spec)))))
3932 (when (featurep 'xemacs)
3933 ;; to avoid XEmacs compilation gripes
3934 (defvar coding-system-for-write)
3935 (defvar coding-system-for-read)
3936 (defvar buffer-file-coding-system)
3938 (and (fboundp 'find-coding-system)
3939 (or (find-coding-system 'raw-text-unix)
3940 (copy-coding-system 'no-conversion-unix 'raw-text-unix))))
3942 (defun ps-color-values (x-color)
3943 (if (featurep 'xemacs)
3944 (let ((color (ps-xemacs-color-name x-color)))
3945 (cond
3946 ((fboundp 'x-color-values)
3947 (x-color-values color))
3948 ((and (fboundp 'color-instance-rgb-components)
3949 (ps-color-device))
3950 (color-instance-rgb-components
3951 (if (color-instance-p x-color)
3952 x-color
3953 (make-color-instance color))))
3955 (error "No available function to determine X color values"))))
3956 (cond
3957 ((fboundp 'color-values)
3958 (color-values x-color))
3959 ((fboundp 'x-color-values)
3960 (x-color-values x-color))
3962 (error "No available function to determine X color values")))))
3964 (defun ps-face-bold-p (face)
3965 (if (featurep 'xemacs)
3966 (or (ps-xemacs-face-kind-p face 'WEIGHT_NAME "bold\\|demibold")
3967 (memq face ps-bold-faces)) ; Kludge-compatible
3968 (or (face-bold-p face)
3969 (memq face ps-bold-faces))))
3971 (defun ps-face-italic-p (face)
3972 (if (featurep 'xemacs)
3973 (or (ps-xemacs-face-kind-p face 'ANGLE_NAME "i\\|o")
3974 (ps-xemacs-face-kind-p face 'SLANT "i\\|o")
3975 (memq face ps-italic-faces)) ; Kludge-compatible
3976 (or (face-italic-p face)
3977 (memq face ps-italic-faces))))
3979 (defvar ps-print-color-scale 1.0)
3981 (defun ps-color-scale (color)
3982 ;; Scale 16-bit X-COLOR-VALUE to PostScript color value in [0, 1] interval.
3983 (mapcar #'(lambda (value) (/ value ps-print-color-scale))
3984 (ps-color-values color)))
3987 (defun ps-face-underlined-p (face)
3988 (or (face-underline-p face)
3989 (memq face ps-underlined-faces)))
3992 (defun ps-prologue-file (filenumber)
3993 "If prologue FILENUMBER exists and is readable, return contents as string.
3995 Note: No major/minor-mode is activated and no local variables are evaluated for
3996 FILENUMBER, but proper EOL-conversion and character interpretation is
3997 done!"
3998 (let ((filename (convert-standard-filename
3999 (expand-file-name (format "ps-prin%d.ps" filenumber)
4000 ps-postscript-code-directory))))
4001 (if (and (file-exists-p filename)
4002 (file-readable-p filename))
4003 (with-temp-buffer
4004 (insert-file-contents filename)
4005 (buffer-string))
4006 (error "ps-print PostScript prologue `%s' file was not found"
4007 filename))))
4010 (defvar ps-mark-code-directory nil)
4012 (defvar ps-print-prologue-0 ""
4013 "ps-print PostScript error handler.")
4015 (defvar ps-print-prologue-1 ""
4016 "ps-print PostScript prologue.")
4018 ;; Start Editing Here:
4020 (defvar ps-source-buffer nil)
4021 (defvar ps-spool-buffer-name "*PostScript*")
4022 (defvar ps-spool-buffer nil)
4024 (defvar ps-output-head nil)
4025 (defvar ps-output-tail nil)
4027 (defvar ps-page-postscript 0) ; page number
4028 (defvar ps-page-order 0) ; PostScript page counter
4029 (defvar ps-page-sheet 0) ; sheet counter
4030 (defvar ps-page-column 0) ; column counter
4031 (defvar ps-page-printed 0) ; total pages printed
4032 (defvar ps-page-n-up 0) ; n-up counter
4033 (defvar ps-lines-printed 0) ; total lines printed
4034 (defvar ps-showline-count 1) ; line number counter
4035 (defvar ps-first-page nil)
4036 (defvar ps-last-page nil)
4037 (defvar ps-print-page-p t)
4039 (defvar ps-control-or-escape-regexp nil)
4040 (defvar ps-n-up-on nil)
4042 (defvar ps-background-pages nil)
4043 (defvar ps-background-all-pages nil)
4044 (defvar ps-background-text-count 0)
4045 (defvar ps-background-image-count 0)
4047 (defvar ps-current-font 0)
4048 (defvar ps-default-foreground nil)
4049 (defvar ps-default-background nil)
4050 (defvar ps-default-color nil)
4051 (defvar ps-current-color nil)
4052 (defvar ps-current-bg nil)
4053 (defvar ps-foreground-list nil)
4055 (defvar ps-zebra-stripe-full-p nil)
4056 (defvar ps-razchunk 0)
4058 (defvar ps-color-p nil)
4059 (defvar ps-color-format
4060 (if (featurep 'xemacs)
4061 ;; XEmacs will have to make do with %s (princ) for floats.
4062 "%s %s %s"
4064 ;; Emacs understands the %f format; we'll use it to limit color RGB
4065 ;; values to three decimals to cut down some on the size of the
4066 ;; PostScript output.
4067 "%0.3f %0.3f %0.3f"))
4069 ;; These values determine how much print-height to deduct when headers/footers
4070 ;; are turned on. This is a pretty clumsy way of handling it, but it'll do for
4071 ;; now.
4073 (defvar ps-header-pad 0
4074 "Vertical and horizontal space between the header frame and the text.
4075 This is in units of points (1/72 inch).")
4077 (defvar ps-footer-pad 0
4078 "Vertical and horizontal space between the footer frame and the text.
4079 This is in units of points (1/72 inch).")
4081 ;; Define accessors to the dimensions list.
4083 (defmacro ps-page-dimensions-get-width (dims) `(nth 0 ,dims))
4084 (defmacro ps-page-dimensions-get-height (dims) `(nth 1 ,dims))
4085 (defmacro ps-page-dimensions-get-media (dims) `(nth 2 ,dims))
4087 (defvar ps-landscape-page-height nil)
4089 (defvar ps-print-width nil)
4090 (defvar ps-print-height nil)
4092 (defvar ps-height-remaining nil)
4093 (defvar ps-width-remaining nil)
4095 (defvar ps-font-size-internal nil)
4096 (defvar ps-header-font-size-internal nil)
4097 (defvar ps-header-title-font-size-internal nil)
4098 (defvar ps-footer-font-size-internal nil)
4099 (defvar ps-line-spacing-internal nil)
4100 (defvar ps-paragraph-spacing-internal nil)
4103 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4104 ;; Internal Variables
4107 (defvar ps-black-white-faces-alist nil
4108 "Alist of symbolic faces used for black/white PostScript printers.
4109 An element of this list has the same form as `ps-print-face-extension-alist'
4110 \(which see).
4112 Don't change this list directly; instead,
4113 use `ps-extend-face' and `ps-extend-face-list'.
4114 See documentation for `ps-extend-face' for valid extension symbol.
4115 See also documentation for `ps-print-color-p'.")
4118 (defvar ps-print-face-extension-alist nil
4119 "Alist of symbolic faces *WITH* extension features (box, outline, etc).
4120 An element of this list has the following form:
4122 (FACE . [BITS FG BG])
4124 FACE is a symbol denoting a face name
4125 BITS is a bit vector, where each bit correspond
4126 to a feature (bold, underline, etc)
4127 (see documentation for `ps-print-face-map-alist')
4128 FG foreground color (string or nil)
4129 BG background color (string or nil)
4131 Don't change this list directly; instead,
4132 use `ps-extend-face' and `ps-extend-face-list'.
4133 See documentation for `ps-extend-face' for valid extension symbol.")
4136 (defvar ps-print-face-alist nil
4137 "Alist of symbolic faces *WITHOUT* extension features (box, outline, etc).
4139 An element of this list has the same form as an element of
4140 `ps-print-face-extension-alist'.
4142 Don't change this list directly; this list is used by `ps-face-attributes',
4143 `ps-map-face' and `ps-build-reference-face-lists'.")
4146 (defconst ps-print-face-map-alist
4147 '((bold . 1)
4148 (italic . 2)
4149 (underline . 4)
4150 (strikeout . 8)
4151 (overline . 16)
4152 (shadow . 32)
4153 (box . 64)
4154 (outline . 128))
4155 "Alist of all features and the corresponding bit mask.
4156 Each symbol correspond to one bit in a bit vector.")
4159 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4160 ;; Remapping Faces
4163 ;;;###autoload
4164 (defun ps-extend-face-list (face-extension-list &optional merge-p alist-sym)
4165 "Extend face in ALIST-SYM.
4167 If optional MERGE-P is non-nil, extensions in FACE-EXTENSION-LIST are merged
4168 with face extension in ALIST-SYM; otherwise, overrides.
4170 If optional ALIST-SYM is nil, `ps-print-face-extension-alist' is used;
4171 otherwise, it should be an alist symbol.
4173 The elements in FACE-EXTENSION-LIST are like those for `ps-extend-face'.
4175 See `ps-extend-face' for documentation."
4176 (while face-extension-list
4177 (ps-extend-face (car face-extension-list) merge-p alist-sym)
4178 (setq face-extension-list (cdr face-extension-list))))
4181 ;;;###autoload
4182 (defun ps-extend-face (face-extension &optional merge-p alist-sym)
4183 "Extend face in ALIST-SYM.
4185 If optional MERGE-P is non-nil, extensions in FACE-EXTENSION list are merged
4186 with face extensions in ALIST-SYM; otherwise, overrides.
4188 If optional ALIST-SYM is nil, `ps-print-face-extension-alist' is used;
4189 otherwise, it should be an alist symbol.
4191 The elements of FACE-EXTENSION list have the form:
4193 (FACE-NAME FOREGROUND BACKGROUND EXTENSION...)
4195 FACE-NAME is a face name symbol.
4197 FOREGROUND and BACKGROUND may be nil or a string that denotes the
4198 foreground and background colors respectively.
4200 EXTENSION is one of the following symbols:
4201 bold - use bold font.
4202 italic - use italic font.
4203 underline - put a line under text.
4204 strikeout - like underline, but the line is in middle of text.
4205 overline - like underline, but the line is over the text.
4206 shadow - text will have a shadow.
4207 box - text will be surrounded by a box.
4208 outline - print characters as hollow outlines.
4210 If EXTENSION is any other symbol, it is ignored."
4211 (or alist-sym
4212 (setq alist-sym 'ps-print-face-extension-alist))
4213 (let* ((background (nth 2 face-extension))
4214 (foreground (nth 1 face-extension))
4215 (face-name (nth 0 face-extension))
4216 (ps-face (cdr (assq face-name (symbol-value alist-sym))))
4217 (face-vector (or ps-face (vector 0 nil nil)))
4218 (face-bit (ps-extension-bit face-extension)))
4219 ;; extend face
4220 (aset face-vector 0 (if merge-p
4221 (logior (aref face-vector 0) face-bit)
4222 face-bit))
4223 (and (or (not merge-p) (and foreground (stringp foreground)))
4224 (aset face-vector 1 foreground))
4225 (and (or (not merge-p) (and background (stringp background)))
4226 (aset face-vector 2 background))
4227 ;; if face does not exist, insert it
4228 (or ps-face
4229 (set alist-sym (cons (cons face-name face-vector)
4230 (symbol-value alist-sym))))))
4233 (defun ps-extension-bit (face-extension)
4234 (let ((face-bit 0))
4235 ;; map valid symbol extension to bit vector
4236 (setq face-extension (cdr (cdr face-extension)))
4237 (while (setq face-extension (cdr face-extension))
4238 (setq face-bit (logior face-bit
4239 (or (cdr (assq (car face-extension)
4240 ps-print-face-map-alist))
4241 0))))
4242 face-bit))
4245 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4246 ;; Adapted from font-lock: (obsolete stuff)
4247 ;; Originally face attributes were specified via `font-lock-face-attributes'.
4248 ;; Users then changed the default face attributes by setting that variable.
4249 ;; However, we try and be back-compatible and respect its value if set except
4250 ;; for faces where M-x customize has been used to save changes for the face.
4253 (defun ps-font-lock-face-attributes ()
4254 (and (boundp 'font-lock-mode) (symbol-value 'font-lock-mode)
4255 (boundp 'font-lock-face-attributes)
4256 (let ((face-attributes (symbol-value 'font-lock-face-attributes)))
4257 (while face-attributes
4258 (let* ((face-attribute
4259 (car (prog1 face-attributes
4260 (setq face-attributes (cdr face-attributes)))))
4261 (face (car face-attribute)))
4262 ;; Rustle up a `defface' SPEC from a
4263 ;; `font-lock-face-attributes' entry.
4264 (unless (get face 'saved-face)
4265 (let ((foreground (nth 1 face-attribute))
4266 (background (nth 2 face-attribute))
4267 (bold-p (nth 3 face-attribute))
4268 (italic-p (nth 4 face-attribute))
4269 (underline-p (nth 5 face-attribute))
4270 face-spec)
4271 (when foreground
4272 (setq face-spec (cons ':foreground
4273 (cons foreground face-spec))))
4274 (when background
4275 (setq face-spec (cons ':background
4276 (cons background face-spec))))
4277 (when bold-p
4278 (setq face-spec (append '(:weight bold) face-spec)))
4279 (when italic-p
4280 (setq face-spec (append '(:slant italic) face-spec)))
4281 (when underline-p
4282 (setq face-spec (append '(:underline t) face-spec)))
4283 (custom-declare-face face (list (list t face-spec)) nil)
4284 )))))))
4287 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4288 ;; Internal functions and variables
4291 (defun ps-message-log-max ()
4292 (and (not (string= (buffer-name) "*Messages*"))
4293 (boundp 'message-log-max)
4294 message-log-max))
4297 (defvar ps-print-hook nil)
4298 (defvar ps-print-begin-sheet-hook nil)
4299 (defvar ps-print-begin-page-hook nil)
4300 (defvar ps-print-begin-column-hook nil)
4303 (defun ps-print-without-faces (from to &optional filename region-p)
4304 (ps-spool-without-faces from to region-p)
4305 (ps-do-despool filename))
4308 (defun ps-spool-without-faces (from to &optional region-p)
4309 (let ((message-log-max (ps-message-log-max))) ; to print *Messages* buffer
4310 (run-hooks 'ps-print-hook)
4311 (ps-printing-region region-p from to)
4312 (ps-generate (current-buffer) from to 'ps-generate-postscript)))
4315 (defun ps-print-with-faces (from to &optional filename region-p)
4316 (ps-spool-with-faces from to region-p)
4317 (ps-do-despool filename))
4320 (defun ps-spool-with-faces (from to &optional region-p)
4321 (let ((message-log-max (ps-message-log-max))) ; to print *Messages* buffer
4322 (run-hooks 'ps-print-hook)
4323 (ps-printing-region region-p from to)
4324 (ps-generate (current-buffer) from to 'ps-generate-postscript-with-faces)))
4327 (defun ps-count-lines-preprint (from to)
4328 (or (and from to)
4329 (error "The mark is not set now"))
4330 (let ((message-log-max (ps-message-log-max))) ; to count lines of *Messages*
4331 (list (count-lines from to))))
4334 (defun ps-count-lines (from to)
4335 (+ (count-lines from to)
4336 (save-excursion
4337 (goto-char to)
4338 (if (= (current-column) 0) 1 0))))
4341 (defvar ps-printing-region nil
4342 "Variable used to indicate the region that ps-print is printing.
4343 It is a cons, the car of which is the line number where the region begins, and
4344 its cdr is the total number of lines in the buffer. Formatting functions can
4345 use this information to print the original line number (and not the number of
4346 lines printed), and to indicate in the header that the printout is of a partial
4347 file.")
4350 (defvar ps-printing-region-p nil
4351 "Non-nil means ps-print is printing a region.")
4354 (defun ps-printing-region (region-p from to)
4355 (setq ps-printing-region-p region-p
4356 ps-printing-region
4357 (cons (if region-p
4358 (ps-count-lines (point-min) (min from to))
4360 (ps-count-lines (point-min) (point-max)))))
4363 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4364 ;; Internal functions
4367 (defsubst ps-font-alist (font-sym)
4368 (get font-sym 'fonts))
4370 (defun ps-font (font-sym font-type)
4371 "Font family name for text of `font-type', when generating PostScript."
4372 (let* ((font-list (ps-font-alist font-sym))
4373 (normal-font (cdr (assq 'normal font-list))))
4374 (while (and font-list (not (eq font-type (car (car font-list)))))
4375 (setq font-list (cdr font-list)))
4376 (or (cdr (car font-list)) normal-font)))
4378 (defsubst ps-fonts (font-sym)
4379 (mapcar 'cdr (ps-font-alist font-sym)))
4381 (defsubst ps-font-number (font-sym font-type)
4382 (or (ps-alist-position font-type (ps-font-alist font-sym))
4385 (defsubst ps-line-height (font-sym)
4386 "The height of a line, for generating PostScript.
4387 This is the value that ps-print uses to determine the height,
4388 y-dimension, of the lines of text it has printed, and thus affects the
4389 point at which page-breaks are placed.
4390 The line-height is *not* the same as the point size of the font."
4391 (get font-sym 'line-height))
4393 (defsubst ps-title-line-height (font-sym)
4394 "The height of a `title' line, for generating PostScript.
4395 This is the value that ps-print uses to determine the height,
4396 y-dimension, of the lines of text it has printed, and thus affects the
4397 point at which page-breaks are placed.
4398 The title-line-height is *not* the same as the point size of the font."
4399 (get font-sym 'title-line-height))
4401 (defsubst ps-space-width (font-sym)
4402 "The width of a space character, for generating PostScript.
4403 This value is used in expanding tab characters."
4404 (get font-sym 'space-width))
4406 (defsubst ps-avg-char-width (font-sym)
4407 "The average width, in points, of a character, for generating PostScript.
4408 This is the value that ps-print uses to determine the length,
4409 x-dimension, of the text it has printed, and thus affects the point at
4410 which long lines wrap around."
4411 (get font-sym 'avg-char-width))
4413 (defun ps-line-lengths-internal ()
4414 "Display the correspondence between a line length and a font size.
4415 Done using the current ps-print setup.
4416 Try: pr -t file | awk '{printf \"%3d %s\n\", length($0), $0}' | sort -r | head"
4417 (let* ((ps-font-size-internal
4418 (or ps-font-size-internal
4419 (ps-get-font-size 'ps-font-size)))
4420 (ps-header-font-size-internal
4421 (or ps-header-font-size-internal
4422 (ps-get-font-size 'ps-header-font-size)))
4423 (ps-header-title-font-size-internal
4424 (or ps-header-title-font-size-internal
4425 (ps-get-font-size 'ps-header-title-font-size)))
4426 (buf (get-buffer-create "*Line-lengths*"))
4427 (ifs ps-font-size-internal) ; initial font size
4428 (icw (ps-avg-char-width 'ps-font-for-text)) ; initial character width
4429 (print-width (progn (ps-get-page-dimensions)
4430 ps-print-width))
4431 (ps-setup (ps-setup)) ; setup for the current buffer
4432 (fs-min 5) ; minimum font size
4433 cw-min ; minimum character width
4434 nb-cpl-max ; maximum nb of characters per line
4435 (fs-max 14) ; maximum font size
4436 cw-max ; maximum character width
4437 nb-cpl-min ; minimum nb of characters per line
4438 fs ; current font size
4439 cw ; current character width
4440 nb-cpl ; current nb of characters per line
4442 (setq cw-min (/ (* icw fs-min) ifs)
4443 nb-cpl-max (floor (/ print-width cw-min))
4444 cw-max (/ (* icw fs-max) ifs)
4445 nb-cpl-min (floor (/ print-width cw-max))
4446 nb-cpl nb-cpl-min)
4447 (set-buffer buf)
4448 (goto-char (point-max))
4449 (or (bobp) (insert "\n" (make-string 75 ?\;) "\n"))
4450 (insert ps-setup
4451 "\nnb char per line / font size\n")
4452 (while (<= nb-cpl nb-cpl-max)
4453 (setq cw (/ print-width (float nb-cpl))
4454 fs (/ (* ifs cw) icw))
4455 (insert (format "%16d %s\n" nb-cpl fs))
4456 (setq nb-cpl (1+ nb-cpl)))
4457 (insert "\n")
4458 (display-buffer buf 'not-this-window)))
4460 (defun ps-nb-pages (nb-lines)
4461 "Display correspondence between font size and the number of pages.
4462 The correspondence is based on having NB-LINES lines of text,
4463 and on the current ps-print setup."
4464 (let* ((ps-font-size-internal
4465 (or ps-font-size-internal
4466 (ps-get-font-size 'ps-font-size)))
4467 (ps-header-font-size-internal
4468 (or ps-header-font-size-internal
4469 (ps-get-font-size 'ps-header-font-size)))
4470 (ps-header-title-font-size-internal
4471 (or ps-header-title-font-size-internal
4472 (ps-get-font-size 'ps-header-title-font-size)))
4473 (ps-line-spacing-internal
4474 (or ps-line-spacing-internal
4475 (ps-get-size ps-line-spacing "line spacing")))
4476 (buf (get-buffer-create "*Nb-Pages*"))
4477 (ils ps-line-spacing-internal) ; initial line spacing
4478 (ifs ps-font-size-internal) ; initial font size
4479 (ilh (ps-line-height 'ps-font-for-text)) ; initial line height
4480 (page-height (progn (ps-get-page-dimensions)
4481 ps-print-height))
4482 (ps-setup (ps-setup)) ; setup for the current buffer
4483 (fs-min 4) ; minimum font size
4484 lh-min ; minimum line height
4485 nb-lpp-max ; maximum nb of lines per page
4486 nb-page-min ; minimum nb of pages
4487 (fs-max 14) ; maximum font size
4488 lh-max ; maximum line height
4489 nb-lpp-min ; minimum nb of lines per page
4490 nb-page-max ; maximum nb of pages
4491 fs ; current font size
4492 lh ; current line height
4493 nb-lpp ; current nb of lines per page
4494 nb-page ; current nb of pages
4496 (setq lh-min (/ (- (* (+ ilh ils) fs-min) ils) ifs)
4497 nb-lpp-max (floor (/ page-height lh-min))
4498 nb-page-min (ceiling (/ (float nb-lines) nb-lpp-max))
4499 lh-max (/ (- (* (+ ilh ils) fs-max) ils) ifs)
4500 nb-lpp-min (floor (/ page-height lh-max))
4501 nb-page-max (ceiling (/ (float nb-lines) nb-lpp-min))
4502 nb-page nb-page-min)
4503 (set-buffer buf)
4504 (goto-char (point-max))
4505 (or (bobp) (insert "\n" (make-string 75 ?\;) "\n"))
4506 (insert ps-setup
4507 (format "\nThere are %d lines.\n\n" nb-lines)
4508 "nb page / font size\n")
4509 (while (<= nb-page nb-page-max)
4510 (setq nb-lpp (ceiling (/ nb-lines (float nb-page)))
4511 lh (/ page-height nb-lpp)
4512 fs (/ (* ifs lh) ilh))
4513 (insert (format "%7d %s\n" nb-page fs))
4514 (setq nb-page (1+ nb-page)))
4515 (insert "\n")
4516 (display-buffer buf 'not-this-window)))
4518 ;; macros used in `ps-select-font'
4519 (defmacro ps-lookup (key) `(cdr (assq ,key font-entry)))
4520 (defmacro ps-size-scale (key) `(/ (* (ps-lookup ,key) font-size) size))
4522 (defun ps-select-font (font-family sym font-size title-font-size)
4523 (let ((font-entry (cdr (assq font-family ps-font-info-database))))
4524 (or font-entry
4525 (error "Don't have data to scale font %s. Known fonts families are %s"
4526 font-family
4527 (mapcar 'car ps-font-info-database)))
4528 (let ((size (ps-lookup 'size)))
4529 (put sym 'fonts (ps-lookup 'fonts))
4530 (put sym 'space-width (ps-size-scale 'space-width))
4531 (put sym 'avg-char-width (ps-size-scale 'avg-char-width))
4532 (put sym 'line-height (ps-size-scale 'line-height))
4533 (put sym 'title-line-height
4534 (/ (* (ps-lookup 'line-height) title-font-size) size)))))
4536 (defun ps-get-page-dimensions ()
4537 (let ((page-dimensions (cdr (assq ps-paper-type ps-page-dimensions-database)))
4538 page-width page-height)
4539 (cond
4540 ((null page-dimensions)
4541 (error "`ps-paper-type' must be one of:\n%s"
4542 (mapcar 'car ps-page-dimensions-database)))
4543 ((< ps-number-of-columns 1)
4544 (error "The number of columns %d should be positive"
4545 ps-number-of-columns)))
4547 (ps-select-font ps-font-family 'ps-font-for-text
4548 ps-font-size-internal ps-font-size-internal)
4549 (ps-select-font ps-header-font-family 'ps-font-for-header
4550 ps-header-font-size-internal
4551 ps-header-title-font-size-internal)
4552 (ps-select-font ps-footer-font-family 'ps-font-for-footer
4553 ps-footer-font-size-internal ps-footer-font-size-internal)
4555 (setq page-width (ps-page-dimensions-get-width page-dimensions)
4556 page-height (ps-page-dimensions-get-height page-dimensions))
4558 ;; Landscape mode
4559 (if ps-landscape-mode
4560 ;; exchange width and height
4561 (setq page-width (prog1 page-height (setq page-height page-width))))
4563 ;; It is used to get the lower right corner (only in landscape mode)
4564 (setq ps-landscape-page-height page-height)
4566 ;; | lm | text | ic | text | ic | text | rm |
4567 ;; page-width == lm + n * pw + (n - 1) * ic + rm
4568 ;; => pw == (page-width - lm -rm - (n - 1) * ic) / n
4569 (setq ps-print-width (/ (- page-width
4570 ps-left-margin ps-right-margin
4571 (* (1- ps-number-of-columns) ps-inter-column))
4572 ps-number-of-columns))
4573 (if (<= ps-print-width 0)
4574 (error "Bad horizontal layout:
4575 page-width == %s
4576 ps-left-margin == %s
4577 ps-right-margin == %s
4578 ps-inter-column == %s
4579 ps-number-of-columns == %s
4580 | lm | text | ic | text | ic | text | rm |
4581 page-width == lm + n * print-width + (n - 1) * ic + rm
4582 => print-width == %d !"
4583 page-width
4584 ps-left-margin
4585 ps-right-margin
4586 ps-inter-column
4587 ps-number-of-columns
4588 ps-print-width))
4590 (setq ps-print-height
4591 (- page-height ps-bottom-margin ps-top-margin))
4592 (if (<= ps-print-height 0)
4593 (error "Bad vertical layout:
4594 ps-top-margin == %s
4595 ps-bottom-margin == %s
4596 page-height == bm + print-height + tm
4597 => print-height == %d !"
4598 ps-top-margin
4599 ps-bottom-margin
4600 ps-print-height))
4601 ;; If headers are turned on, deduct the height of the header from the print
4602 ;; height.
4603 (if ps-print-header
4604 (setq ps-header-pad (* ps-header-line-pad
4605 (ps-title-line-height 'ps-font-for-header))
4606 ps-print-height (- ps-print-height
4607 ps-header-offset
4608 ps-header-pad
4609 (ps-title-line-height 'ps-font-for-header)
4610 (* (ps-line-height 'ps-font-for-header)
4611 (1- ps-header-lines))
4612 ps-header-pad)))
4613 (if (<= ps-print-height 0)
4614 (error "Bad vertical layout (header):
4615 ps-top-margin == %s
4616 ps-bottom-margin == %s
4617 ps-header-offset == %s
4618 ps-header-pad == %s
4619 header-height == %s
4620 page-height == bm + print-height + tm - ho - hh
4621 => print-height == %d !"
4622 ps-top-margin
4623 ps-bottom-margin
4624 ps-header-offset
4625 ps-header-pad
4626 (+ ps-header-pad
4627 (ps-title-line-height 'ps-font-for-header)
4628 (* (ps-line-height 'ps-font-for-header)
4629 (1- ps-header-lines))
4630 ps-header-pad)
4631 ps-print-height))
4632 ;; If footers are turned on, deduct the height of the footer from the print
4633 ;; height.
4634 (if ps-print-footer
4635 (setq ps-footer-pad (* ps-footer-line-pad
4636 (ps-title-line-height 'ps-font-for-footer))
4637 ps-print-height (- ps-print-height
4638 ps-footer-offset
4639 ps-footer-pad
4640 (* (ps-line-height 'ps-font-for-footer)
4641 (1- ps-footer-lines))
4642 ps-footer-pad)))
4643 (if (<= ps-print-height 0)
4644 (error "Bad vertical layout (footer):
4645 ps-top-margin == %s
4646 ps-bottom-margin == %s
4647 ps-footer-offset == %s
4648 ps-footer-pad == %s
4649 footer-height == %s
4650 page-height == bm + print-height + tm - fo - fh
4651 => print-height == %d !"
4652 ps-top-margin
4653 ps-bottom-margin
4654 ps-footer-offset
4655 ps-footer-pad
4656 (+ ps-footer-pad
4657 (* (ps-line-height 'ps-font-for-footer)
4658 (1- ps-footer-lines))
4659 ps-footer-pad)
4660 ps-print-height))
4661 ;; ps-zebra-stripe-follow is `full' or `full-follow'
4662 (if ps-zebra-stripe-full-p
4663 (let* ((line-height (ps-line-height 'ps-font-for-text))
4664 (zebra (* (+ line-height ps-line-spacing-internal)
4665 ps-zebra-stripe-height)))
4666 (setq ps-print-height (- (* (floor ps-print-height zebra) zebra)
4667 line-height))
4668 (if (<= ps-print-height 0)
4669 (error "Bad vertical layout (full zebra stripe follow):
4670 ps-zebra-stripe-follow == %s
4671 ps-zebra-stripe-height == %s
4672 font-text-height == %s
4673 line-spacing == %s
4674 page-height == ((floor print-height ((th + ls) * zh)) * ((th + ls) * zh)) - th
4675 => print-height == %d !"
4676 ps-zebra-stripe-follow
4677 ps-zebra-stripe-height
4678 (ps-line-height 'ps-font-for-text)
4679 ps-line-spacing-internal
4680 ps-print-height))))))
4683 (defun ps-print-preprint-region (prefix-arg)
4684 (or (ps-mark-active-p)
4685 (error "The mark is not set now"))
4686 (list (point) (mark) (ps-print-preprint prefix-arg)))
4689 (defun ps-print-preprint (prefix-arg)
4690 (and prefix-arg
4691 (or (numberp prefix-arg)
4692 (listp prefix-arg))
4693 (let* ((name (concat (file-name-nondirectory (or (buffer-file-name)
4694 (buffer-name)))
4695 ".ps"))
4696 (prompt (format "Save PostScript to file (default %s): " name))
4697 (res (read-file-name prompt default-directory name nil)))
4698 (while (cond ((file-directory-p res)
4699 (ding)
4700 (setq prompt "It's a directory"))
4701 ((not (file-writable-p res))
4702 (ding)
4703 (setq prompt "File is unwritable"))
4704 ((file-exists-p res)
4705 (setq prompt "File exists")
4706 (not (y-or-n-p (format "File `%s' exists; overwrite? "
4707 res))))
4708 (t nil))
4709 (setq res (read-file-name
4710 (format "%s; save PostScript to file: " prompt)
4711 (file-name-directory res) nil nil
4712 (file-name-nondirectory res))))
4713 (if (file-directory-p res)
4714 (expand-file-name name (file-name-as-directory res))
4715 res))))
4717 ;; The following functions implement a simple list-buffering scheme so
4718 ;; that ps-print doesn't have to repeatedly switch between buffers
4719 ;; while spooling. The functions `ps-output' and `ps-output-string' build
4720 ;; up the lists; the function `ps-flush-output' takes the lists and
4721 ;; insert its contents into the spool buffer (*PostScript*).
4723 (defvar ps-string-escape-codes
4724 (let ((table (make-vector 256 nil))
4725 (char ?\000))
4726 ;; control characters
4727 (while (<= char ?\037)
4728 (aset table char (format "\\%03o" char))
4729 (setq char (1+ char)))
4730 ;; printable characters
4731 (while (< char ?\177)
4732 (aset table char (format "%c" char))
4733 (setq char (1+ char)))
4734 ;; DEL and 8-bit characters
4735 (while (<= char ?\377)
4736 (aset table char (format "\\%o" char))
4737 (setq char (1+ char)))
4738 ;; Override ASCII formatting characters with named escape code:
4739 (aset table ?\n "\\n") ; [NL] linefeed
4740 (aset table ?\r "\\r") ; [CR] carriage return
4741 (aset table ?\t "\\t") ; [HT] horizontal tab
4742 (aset table ?\b "\\b") ; [BS] backspace
4743 (aset table ?\f "\\f") ; [NP] form feed
4744 ;; Escape PostScript escape and string delimiter characters:
4745 (aset table ?\\ "\\\\")
4746 (aset table ?\( "\\(")
4747 (aset table ?\) "\\)")
4748 table)
4749 "Vector used to map characters to PostScript string escape codes.")
4751 (defsubst ps-output-string-prim (string)
4752 (insert "(") ;insert start-string delimiter
4753 (save-excursion ;insert string
4754 (insert (string-as-unibyte string)))
4755 ;; Find and quote special characters as necessary for PS
4756 ;; This skips everything except control chars, non-ASCII chars, (, ) and \.
4757 (while (progn (skip-chars-forward " -'*-[]-~") (not (eobp)))
4758 (let ((special (following-char)))
4759 (delete-char 1)
4760 (insert
4761 (if (and (<= 0 special) (<= special 255))
4762 (aref ps-string-escape-codes special)
4763 ;; insert hexadecimal representation if character code is out of range
4764 (format "\\%04X" special)
4765 ))))
4766 (goto-char (point-max))
4767 (insert ")")) ;insert end-string delimiter
4769 (defsubst ps-init-output-queue ()
4770 (setq ps-output-head (list "")
4771 ps-output-tail ps-output-head))
4774 (defun ps-selected-pages ()
4775 (while (progn
4776 (setq ps-first-page (car (car ps-selected-pages))
4777 ps-last-page (cdr (car ps-selected-pages))
4778 ps-selected-pages (cdr ps-selected-pages))
4779 (and ps-selected-pages
4780 (< ps-last-page ps-page-postscript)))))
4783 (defsubst ps-print-page-p ()
4784 (setq ps-print-page-p
4785 (and (cond ((null ps-first-page))
4786 ((<= ps-page-postscript ps-last-page)
4787 (<= ps-first-page ps-page-postscript))
4788 (ps-selected-pages
4789 (ps-selected-pages)
4790 (and (<= ps-first-page ps-page-postscript)
4791 (<= ps-page-postscript ps-last-page)))
4793 nil))
4794 (cond ((eq ps-even-or-odd-pages 'even-page)
4795 (= (logand ps-page-postscript 1) 0))
4796 ((eq ps-even-or-odd-pages 'odd-page)
4797 (= (logand ps-page-postscript 1) 1))
4799 ))))
4802 (defsubst ps-print-sheet-p ()
4803 (setq ps-print-page-p
4804 (cond ((eq ps-even-or-odd-pages 'even-sheet)
4805 (= (logand ps-page-sheet 1) 0))
4806 ((eq ps-even-or-odd-pages 'odd-sheet)
4807 (= (logand ps-page-sheet 1) 1))
4812 (defun ps-output (&rest args)
4813 (when ps-print-page-p
4814 (setcdr ps-output-tail args)
4815 (while (cdr ps-output-tail)
4816 (setq ps-output-tail (cdr ps-output-tail)))))
4818 (defun ps-output-string (string)
4819 (ps-output t string))
4821 ;; Output strings in the list ARGS in the PostScript prologue part.
4822 (defun ps-output-prologue (args)
4823 (ps-output 'prologue (if (stringp args) (list args) args)))
4825 (defun ps-flush-output ()
4826 (save-excursion
4827 (set-buffer ps-spool-buffer)
4828 (goto-char (point-max))
4829 (while ps-output-head
4830 (let ((it (car ps-output-head)))
4831 (cond
4832 ((eq t it)
4833 (setq ps-output-head (cdr ps-output-head))
4834 (ps-output-string-prim (car ps-output-head)))
4835 ((eq 'prologue it)
4836 (setq ps-output-head (cdr ps-output-head))
4837 (save-excursion
4838 (search-backward "\nBeginDoc")
4839 (forward-char 1)
4840 (apply 'insert (car ps-output-head))))
4842 (insert it))))
4843 (setq ps-output-head (cdr ps-output-head))))
4844 (ps-init-output-queue))
4846 (defun ps-insert-file (fname)
4847 (ps-flush-output)
4848 (save-excursion
4849 (set-buffer ps-spool-buffer)
4850 (goto-char (point-max))
4851 (insert-file-contents fname)))
4853 ;; These functions are used in `ps-mule' to get charset of header and footer.
4854 ;; To avoid unnecessary calls to functions in `ps-left-header',
4855 ;; `ps-right-header', `ps-left-footer' and `ps-right-footer'.
4857 (defun ps-generate-string-list (content)
4858 (let (str)
4859 (while content
4860 (setq str (cons (cond
4861 ;; string
4862 ((stringp (car content))
4863 (car content))
4864 ;; function symbol
4865 ((functionp (car content))
4866 (concat "(" (funcall (car content)) ")"))
4867 ;; variable symbol
4868 ((and (symbolp (car content)) (boundp (car content)))
4869 (concat "(" (symbol-value (car content)) ")"))
4870 ;; otherwise, empty string
4872 ""))
4873 str)
4874 content (cdr content)))
4875 (nreverse str)))
4877 (defvar ps-lh-cache nil)
4878 (defvar ps-rh-cache nil)
4879 (defvar ps-lf-cache nil)
4880 (defvar ps-rf-cache nil)
4882 (defun ps-header-footer-string ()
4883 (and ps-print-header
4884 (setq ps-lh-cache (ps-generate-string-list ps-left-header)
4885 ps-rh-cache (ps-generate-string-list ps-right-header)))
4886 (and ps-print-footer
4887 (setq ps-lf-cache (ps-generate-string-list ps-left-footer)
4888 ps-rf-cache (ps-generate-string-list ps-right-footer)))
4889 (append ps-lh-cache ps-rh-cache ps-lf-cache ps-rf-cache))
4891 ;; These functions insert the arrays that define the contents of the headers.
4893 (defun ps-generate-header-line (fonttag &optional content)
4894 (ps-output " [" fonttag " ")
4895 (cond
4896 ;; Literal strings should be output as is -- the string must contain its own
4897 ;; PS string delimiters, '(' and ')', if necessary.
4898 ((stringp content)
4899 (ps-output (ps-mule-encode-header-string content fonttag)))
4901 ;; Functions are called -- they should return strings; they will be inserted
4902 ;; as strings and the PS string delimiters added.
4903 ((functionp content)
4904 (ps-output-string (ps-mule-encode-header-string (funcall content)
4905 fonttag)))
4907 ;; Variables will have their contents inserted. They should contain
4908 ;; strings, and will be inserted as strings.
4909 ((and (symbolp content) (boundp content))
4910 (ps-output-string (ps-mule-encode-header-string (symbol-value content)
4911 fonttag)))
4913 ;; Anything else will get turned into an empty string.
4915 (ps-output-string "")))
4916 (ps-output "]\n"))
4918 (defun ps-generate-header (name fonttag0 fonttag1 contents)
4919 (ps-output "/" name "[\n")
4920 (and contents (> ps-header-lines 0)
4921 (let ((count 1))
4922 (ps-generate-header-line fonttag0 (car contents))
4923 (while (and (< count ps-header-lines)
4924 (setq contents (cdr contents)))
4925 (ps-generate-header-line fonttag1 (car contents))
4926 (setq count (1+ count)))))
4927 (ps-output "]def\n"))
4930 (defun ps-output-boolean (name bool)
4931 (ps-output (format "/%s %s def\n" name (if bool "true" "false"))))
4934 (defun ps-output-frame-properties (name alist)
4935 (ps-output "/" name " ["
4936 (ps-format-color (cdr (assq 'fore-color alist)) 0.0)
4937 (ps-format-color (cdr (assq 'back-color alist)) 0.9)
4938 (ps-float-format (or (cdr (assq 'border-width alist)) 0.4))
4939 (ps-format-color (cdr (assq 'border-color alist)) 0.0)
4940 (ps-format-color (cdr (assq 'shadow-color alist)) 0.0)
4941 "]def\n"))
4944 (defun ps-background-pages (page-list func)
4945 (if page-list
4946 (mapcar
4947 #'(lambda (pages)
4948 (let ((start (if (consp pages) (car pages) pages))
4949 (end (if (consp pages) (cdr pages) pages)))
4950 (and (integerp start) (integerp end) (<= start end)
4951 (add-to-list 'ps-background-pages (vector start end func)))))
4952 page-list)
4953 (setq ps-background-all-pages (cons func ps-background-all-pages))))
4956 (defconst ps-boundingbox-re
4957 "^%%BoundingBox:\
4958 \\s-+\\([0-9.]+\\)\\s-+\\([0-9.]+\\)\\s-+\\([0-9.]+\\)\\s-+\\([0-9.]+\\)")
4961 (defun ps-get-boundingbox ()
4962 (save-excursion
4963 (set-buffer ps-spool-buffer)
4964 (save-excursion
4965 (if (re-search-forward ps-boundingbox-re nil t)
4966 (vector (string-to-number ; lower x
4967 (buffer-substring (match-beginning 1) (match-end 1)))
4968 (string-to-number ; lower y
4969 (buffer-substring (match-beginning 2) (match-end 2)))
4970 (string-to-number ; upper x
4971 (buffer-substring (match-beginning 3) (match-end 3)))
4972 (string-to-number ; upper y
4973 (buffer-substring (match-beginning 4) (match-end 4))))
4974 (vector 0 0 0 0)))))
4977 ;; Emacs understands the %f format; we'll use it to limit color RGB values
4978 ;; to three decimals to cut down some on the size of the PostScript output.
4979 ;; XEmacs will have to make do with %s (princ) for floats.
4981 (defvar ps-float-format (if (featurep 'xemacs)
4982 "%s " ; XEmacs
4983 "%0.3f ")) ; Emacs
4986 (defun ps-float-format (value &optional default)
4987 (let ((literal (or value default)))
4988 (cond ((null literal)
4989 " ")
4990 ((numberp literal)
4991 (format ps-float-format (* literal 1.0))) ; force float number
4993 (format "%s " literal))
4997 (defun ps-background-text ()
4998 (mapcar
4999 #'(lambda (text)
5000 (setq ps-background-text-count (1+ ps-background-text-count))
5001 (ps-output (format "/ShowBackText-%d{\n" ps-background-text-count))
5002 (ps-output-string (nth 0 text)) ; text
5003 (ps-output
5004 "\n"
5005 (ps-float-format (nth 4 text) 200.0) ; font size
5006 (format "/%s " (or (nth 3 text) "Times-Roman")) ; font name
5007 (ps-float-format (nth 6 text)
5008 "PrintHeight PrintPageWidth atan") ; rotation
5009 (ps-float-format (nth 5 text) 0.85) ; gray
5010 (ps-float-format (nth 1 text) "0") ; x position
5011 (ps-float-format (nth 2 text) "0") ; y position
5012 "\nShowBackText}def\n")
5013 (ps-background-pages (nthcdr 7 text) ; page list
5014 (format "ShowBackText-%d\n"
5015 ps-background-text-count)))
5016 ps-print-background-text))
5019 (defun ps-background-image ()
5020 (mapcar
5021 #'(lambda (image)
5022 (let ((image-file (expand-file-name (nth 0 image))))
5023 (when (file-readable-p image-file)
5024 (setq ps-background-image-count (1+ ps-background-image-count))
5025 (ps-output
5026 (format "/ShowBackImage-%d{\n--back-- "
5027 ps-background-image-count)
5028 (ps-float-format (nth 5 image) 0.0) ; rotation
5029 (ps-float-format (nth 3 image) 1.0) ; x scale
5030 (ps-float-format (nth 4 image) 1.0) ; y scale
5031 (ps-float-format (nth 1 image) ; x position
5032 "PrintPageWidth 2 div")
5033 (ps-float-format (nth 2 image) ; y position
5034 "PrintHeight 2 div BottomMargin add")
5035 "\nBeginBackImage\n")
5036 (ps-insert-file image-file)
5037 ;; coordinate adjustment to center image
5038 ;; around x and y position
5039 (let ((box (ps-get-boundingbox)))
5040 (save-excursion
5041 (set-buffer ps-spool-buffer)
5042 (save-excursion
5043 (if (re-search-backward "^--back--" nil t)
5044 (replace-match
5045 (format "%s %s"
5046 (ps-float-format
5047 (- (+ (/ (- (aref box 2) (aref box 0)) 2.0)
5048 (aref box 0))))
5049 (ps-float-format
5050 (- (+ (/ (- (aref box 3) (aref box 1)) 2.0)
5051 (aref box 1)))))
5052 t)))))
5053 (ps-output "\nEndBackImage}def\n")
5054 (ps-background-pages (nthcdr 6 image) ; page list
5055 (format "ShowBackImage-%d\n"
5056 ps-background-image-count)))))
5057 ps-print-background-image))
5060 (defun ps-background (page-number)
5061 (let (has-local-background)
5062 (mapc #'(lambda (range)
5063 (and (<= (aref range 0) page-number)
5064 (<= page-number (aref range 1))
5065 (if has-local-background
5066 (ps-output (aref range 2))
5067 (setq has-local-background t)
5068 (ps-output "/printLocalBackground{\n"
5069 (aref range 2)))))
5070 ps-background-pages)
5071 (and has-local-background (ps-output "}def\n"))))
5074 ;; Return a list of the distinct elements of LIST.
5075 ;; Elements are compared with `equal'.
5076 (defun ps-remove-duplicates (list)
5077 (let (new (tail list))
5078 (while tail
5079 (or (member (car tail) new)
5080 (setq new (cons (car tail) new)))
5081 (setq tail (cdr tail)))
5082 (nreverse new)))
5085 ;; Find the first occurrence of ITEM in LIST.
5086 ;; Return the index of the matching item, or nil if not found.
5087 ;; Elements are compared with `eq'.
5088 (defun ps-alist-position (item list)
5089 (let ((tail list) (index 0) found)
5090 (while tail
5091 (if (setq found (eq (car (car tail)) item))
5092 (setq tail nil)
5093 (setq index (1+ index)
5094 tail (cdr tail))))
5095 (and found index)))
5098 (defconst ps-n-up-database
5099 '((a4
5100 (1 nil 1 1 0)
5101 (2 t 1 2 0)
5102 (4 nil 2 2 0)
5103 (6 t 2 3 1)
5104 (8 t 2 4 0)
5105 (9 nil 3 3 0)
5106 (12 t 3 4 2)
5107 (16 nil 4 4 0)
5108 (18 t 3 6 0)
5109 (20 nil 5 4 1)
5110 (25 nil 5 5 0)
5111 (30 nil 6 5 1)
5112 (32 t 4 8 0)
5113 (36 nil 6 6 0)
5114 (42 nil 7 6 1)
5115 (49 nil 7 7 0)
5116 (50 t 5 10 0)
5117 (56 nil 8 7 1)
5118 (64 nil 8 8 0)
5119 (72 nil 9 8 1)
5120 (81 nil 9 9 0)
5121 (90 nil 10 9 1)
5122 (100 nil 10 10 0))
5124 (1 nil 1 1 0)
5125 (2 t 1 2 0)
5126 (4 nil 2 2 0)
5127 (6 t 2 3 1)
5128 (8 t 2 4 0)
5129 (9 nil 3 3 0)
5130 (12 nil 4 3 1)
5131 (16 nil 4 4 0)
5132 (18 t 3 6 0)
5133 (20 nil 5 4 1)
5134 (25 nil 5 5 0)
5135 (30 nil 6 5 1)
5136 (32 t 4 8 0)
5137 (36 nil 6 6 0)
5138 (42 nil 7 6 1)
5139 (49 nil 7 7 0)
5140 (50 t 5 10 0)
5141 (56 nil 8 7 1)
5142 (64 nil 8 8 0)
5143 (72 nil 9 8 1)
5144 (81 nil 9 9 0)
5145 (90 nil 10 9 1)
5146 (100 nil 10 10 0))
5147 (letter
5148 (1 nil 1 1 0)
5149 (2 t 1 2 0) ; adjusted by PostScript code
5150 (4 nil 2 2 0)
5151 (6 t 2 3 0)
5152 (9 nil 3 3 0)
5153 (12 nil 4 3 1)
5154 (16 nil 4 4 0)
5155 (20 nil 5 4 1)
5156 (25 nil 5 5 0)
5157 (30 nil 6 5 1)
5158 (36 nil 6 6 0)
5159 (40 t 5 8 0)
5160 (42 nil 7 6 1)
5161 (49 nil 7 7 0)
5162 (56 nil 8 7 1)
5163 (64 nil 8 8 0)
5164 (72 nil 9 8 1)
5165 (81 nil 9 9 0)
5166 (90 nil 10 9 1)
5167 (100 nil 10 10 0))
5168 (legal
5169 (1 nil 1 1 0)
5170 (2 t 1 2 0)
5171 (4 nil 2 2 0)
5172 (6 nil 3 2 1)
5173 (9 nil 3 3 0)
5174 (10 t 2 5 0)
5175 (12 nil 4 3 1)
5176 (16 nil 4 4 0)
5177 (20 nil 5 4 1)
5178 (25 nil 5 5 0)
5179 (30 nil 6 5 1)
5180 (36 nil 6 6 0)
5181 (42 nil 7 6 1)
5182 (49 nil 7 7 0)
5183 (56 nil 8 7 1)
5184 (64 nil 8 8 0)
5185 (70 t 5 14 0)
5186 (72 nil 9 8 1)
5187 (81 nil 9 9 0)
5188 (90 nil 10 9 1)
5189 (100 nil 10 10 0))
5190 (letter-small
5191 (1 nil 1 1 0)
5192 (2 t 1 2 0) ; adjusted by PostScript code
5193 (4 nil 2 2 0)
5194 (6 t 2 3 0)
5195 (9 nil 3 3 0)
5196 (12 t 3 4 1)
5197 (15 t 3 5 0)
5198 (16 nil 4 4 0)
5199 (20 nil 5 4 1)
5200 (25 nil 5 5 0)
5201 (28 t 4 7 0)
5202 (30 nil 6 5 1)
5203 (36 nil 6 6 0)
5204 (40 t 5 8 0)
5205 (42 nil 7 6 1)
5206 (49 nil 7 7 0)
5207 (56 nil 8 7 1)
5208 (60 t 6 10 0)
5209 (64 nil 8 8 0)
5210 (72 ni 9 8 1)
5211 (81 nil 9 9 0)
5212 (84 t 7 12 0)
5213 (90 nil 10 9 1)
5214 (100 nil 10 10 0))
5215 (tabloid
5216 (1 nil 1 1 0)
5217 (2 t 1 2 0)
5218 (4 nil 2 2 0)
5219 (6 t 2 3 1)
5220 (8 t 2 4 0)
5221 (9 nil 3 3 0)
5222 (12 nil 4 3 1)
5223 (16 nil 4 4 0)
5224 (20 nil 5 4 1)
5225 (25 nil 5 5 0)
5226 (30 nil 6 5 1)
5227 (36 nil 6 6 0)
5228 (42 nil 7 6 1)
5229 (49 nil 7 7 0)
5230 (56 nil 8 7 1)
5231 (64 nil 8 8 0)
5232 (72 nil 9 8 1)
5233 (81 nil 9 9 0)
5234 (84 t 6 14 0)
5235 (90 nil 10 9 1)
5236 (100 nil 10 10 0))
5237 ;; Ledger paper size is a special case, it is the only paper size where the
5238 ;; normal size is landscaped, that is, the height is smaller than width.
5239 ;; So, we use the special value `pag' in the `landscape' field.
5240 (ledger
5241 (1 nil 1 1 0)
5242 (2 pag 1 2 0)
5243 (4 nil 2 2 0)
5244 (6 pag 2 3 1)
5245 (8 pag 2 4 0)
5246 (9 nil 3 3 0)
5247 (12 nil 4 3 1)
5248 (16 nil 4 4 0)
5249 (20 nil 5 4 1)
5250 (25 nil 5 5 0)
5251 (30 nil 6 5 1)
5252 (36 nil 6 6 0)
5253 (42 nil 7 6 1)
5254 (49 nil 7 7 0)
5255 (56 nil 8 7 1)
5256 (64 nil 8 8 0)
5257 (72 nil 9 8 1)
5258 (81 nil 9 9 0)
5259 (84 pag 6 14 0)
5260 (90 nil 10 9 1)
5261 (100 nil 10 10 0))
5262 (statement
5263 (1 nil 1 1 0)
5264 (2 t 1 2 0)
5265 (4 nil 2 2 0)
5266 (6 nil 3 2 1)
5267 (9 nil 3 3 0)
5268 (10 t 2 5 0)
5269 (12 nil 4 3 1)
5270 (16 nil 4 4 0)
5271 (20 nil 5 4 1)
5272 (21 t 3 7 0)
5273 (25 nil 5 5 0)
5274 (30 nil 6 5 1)
5275 (36 nil 6 6 0)
5276 (40 t 4 10 0)
5277 (42 nil 7 6 1)
5278 (49 nil 7 7 0)
5279 (56 nil 8 7 1)
5280 (60 t 5 12 0)
5281 (64 nil 8 8 0)
5282 (72 nil 9 8 1)
5283 (81 nil 9 9 0)
5284 (90 nil 10 9 1)
5285 (100 nil 10 10 0))
5286 (executive
5287 (1 nil 1 1 0)
5288 (2 t 1 2 0) ; adjusted by PostScript code
5289 (4 nil 2 2 0)
5290 (6 t 2 3 0)
5291 (9 nil 3 3 0)
5292 (12 nil 4 3 1)
5293 (16 nil 4 4 0)
5294 (20 nil 5 4 1)
5295 (25 nil 5 5 0)
5296 (28 t 4 7 0)
5297 (30 nil 6 5 1)
5298 (36 nil 6 6 0)
5299 (42 nil 7 6 1)
5300 (45 t 5 9 0)
5301 (49 nil 7 7 0)
5302 (56 nil 8 7 1)
5303 (60 t 6 10 0)
5304 (64 nil 8 8 0)
5305 (72 nil 9 8 1)
5306 (81 nil 9 9 0)
5307 (84 t 7 12 0)
5308 (90 nil 10 9 1)
5309 (100 nil 10 10 0))
5310 (a4small
5311 (1 nil 1 1 0)
5312 (2 t 1 2 0)
5313 (4 nil 2 2 0)
5314 (6 t 2 3 1)
5315 (8 t 2 4 0)
5316 (9 nil 3 3 0)
5317 (12 nil 4 3 1)
5318 (16 nil 4 4 0)
5319 (18 t 3 6 0)
5320 (20 nil 5 4 1)
5321 (25 nil 5 5 0)
5322 (30 nil 6 5 1)
5323 (32 t 4 8 0)
5324 (36 nil 6 6 0)
5325 (42 nil 7 6 1)
5326 (49 nil 7 7 0)
5327 (50 t 5 10 0)
5328 (56 nil 8 7 1)
5329 (64 nil 8 8 0)
5330 (72 nil 9 8 1)
5331 (78 t 6 13 0)
5332 (81 nil 9 9 0)
5333 (90 nil 10 9 1)
5334 (100 nil 10 10 0))
5336 (1 nil 1 1 0)
5337 (2 t 1 2 0)
5338 (4 nil 2 2 0)
5339 (6 t 2 3 1)
5340 (8 t 2 4 0)
5341 (9 nil 3 3 0)
5342 (12 nil 4 3 1)
5343 (16 nil 4 4 0)
5344 (18 t 3 6 0)
5345 (20 nil 5 4 1)
5346 (25 nil 5 5 0)
5347 (30 nil 6 5 1)
5348 (32 t 4 8 0)
5349 (36 nil 6 6 0)
5350 (42 nil 7 6 1)
5351 (49 nil 7 7 0)
5352 (50 t 5 10 0)
5353 (56 nil 8 7 1)
5354 (64 nil 8 8 0)
5355 (72 nil 9 8 1)
5356 (81 nil 9 9 0)
5357 (90 nil 10 9 1)
5358 (100 nil 10 10 0))
5360 (1 nil 1 1 0)
5361 (2 t 1 2 0)
5362 (4 nil 2 2 0)
5363 (6 t 2 3 1)
5364 (8 t 2 4 0)
5365 (9 nil 3 3 0)
5366 (12 nil 4 3 1)
5367 (16 nil 4 4 0)
5368 (18 t 3 6 0)
5369 (20 nil 5 4 1)
5370 (25 nil 5 5 0)
5371 (30 nil 6 5 1)
5372 (32 t 4 8 0)
5373 (36 nil 6 6 0)
5374 (42 nil 7 6 1)
5375 (49 nil 7 7 0)
5376 (50 t 5 10 0)
5377 (56 nil 8 7 1)
5378 (64 nil 8 8 0)
5379 (72 nil 9 8 0)
5380 (81 nil 9 9 0)
5381 (90 nil 10 9 1)
5382 (98 t 7 14 0)
5383 (100 nil 10 10 0)))
5384 "Alist which is the page matrix database used for N-up printing.
5386 Each element has the following form:
5388 (PAGE
5389 (MAX LANDSCAPE LINES COLUMNS COL-MISSING)
5390 ...)
5392 Where:
5393 PAGE is the page size used (see `ps-paper-type').
5394 MAX is the maximum elements of this page matrix.
5395 LANDSCAPE specifies if page matrix is landscaped, has the following valid
5396 values:
5397 nil the sheet is in portrait mode.
5398 t the sheet is in landscape mode.
5399 pag the sheet is in portrait mode and page is in landscape mode.
5400 LINES is the number of lines of page matrix.
5401 COLUMNS is the number of columns of page matrix.
5402 COL-MISSING is the number of columns missing to fill the sheet.")
5405 (defmacro ps-n-up-landscape (mat) `(nth 1 ,mat))
5406 (defmacro ps-n-up-lines (mat) `(nth 2 ,mat))
5407 (defmacro ps-n-up-columns (mat) `(nth 3 ,mat))
5408 (defmacro ps-n-up-missing (mat) `(nth 4 ,mat))
5411 (defun ps-n-up-printing ()
5412 ;; force `ps-n-up-printing' be in range 1 to 100.
5413 (setq ps-n-up-printing (max (min ps-n-up-printing 100) 1))
5414 ;; find suitable page matrix for a given `ps-paper-type'.
5415 (let ((the-list (cdr (assq ps-paper-type ps-n-up-database))))
5416 (and the-list
5417 (while (> ps-n-up-printing (caar the-list))
5418 (setq the-list (cdr the-list))))
5419 (car the-list)))
5422 (defconst ps-n-up-filling-database
5423 '((left-top
5424 "PageWidth" ; N-Up-XColumn
5425 "0" ; N-Up-YColumn
5426 "N-Up-End 1 sub PageWidth mul neg" ; N-Up-XLine
5427 "LandscapePageHeight neg" ; N-Up-YLine
5428 "N-Up-Lines" ; N-Up-Repeat
5429 "N-Up-Columns" ; N-Up-End
5430 "0" ; N-Up-XStart
5431 "0") ; N-Up-YStart
5432 (left-bottom
5433 "PageWidth" ; N-Up-XColumn
5434 "0" ; N-Up-YColumn
5435 "N-Up-End 1 sub PageWidth mul neg" ; N-Up-XLine
5436 "LandscapePageHeight" ; N-Up-YLine
5437 "N-Up-Lines" ; N-Up-Repeat
5438 "N-Up-Columns" ; N-Up-End
5439 "0" ; N-Up-XStart
5440 "N-Up-Repeat 1 sub LandscapePageHeight mul neg") ; N-Up-YStart
5441 (right-top
5442 "PageWidth neg" ; N-Up-XColumn
5443 "0" ; N-Up-YColumn
5444 "N-Up-End 1 sub PageWidth mul" ; N-Up-XLine
5445 "LandscapePageHeight neg" ; N-Up-YLine
5446 "N-Up-Lines" ; N-Up-Repeat
5447 "N-Up-Columns" ; N-Up-End
5448 "N-Up-End 1 sub PageWidth mul" ; N-Up-XStart
5449 "0") ; N-Up-YStart
5450 (right-bottom
5451 "PageWidth neg" ; N-Up-XColumn
5452 "0" ; N-Up-YColumn
5453 "N-Up-End 1 sub PageWidth mul" ; N-Up-XLine
5454 "LandscapePageHeight" ; N-Up-YLine
5455 "N-Up-Lines" ; N-Up-Repeat
5456 "N-Up-Columns" ; N-Up-End
5457 "N-Up-End 1 sub PageWidth mul" ; N-Up-XStart
5458 "N-Up-Repeat 1 sub LandscapePageHeight mul neg") ; N-Up-YStart
5459 (top-left
5460 "0" ; N-Up-XColumn
5461 "LandscapePageHeight neg" ; N-Up-YColumn
5462 "PageWidth" ; N-Up-XLine
5463 "N-Up-End 1 sub LandscapePageHeight mul" ; N-Up-YLine
5464 "N-Up-Columns" ; N-Up-Repeat
5465 "N-Up-Lines" ; N-Up-End
5466 "0" ; N-Up-XStart
5467 "0") ; N-Up-YStart
5468 (bottom-left
5469 "0" ; N-Up-XColumn
5470 "LandscapePageHeight" ; N-Up-YColumn
5471 "PageWidth" ; N-Up-XLine
5472 "N-Up-End 1 sub LandscapePageHeight mul neg" ; N-Up-YLine
5473 "N-Up-Columns" ; N-Up-Repeat
5474 "N-Up-Lines" ; N-Up-End
5475 "0" ; N-Up-XStart
5476 "N-Up-End 1 sub LandscapePageHeight mul neg") ; N-Up-YStart
5477 (top-right
5478 "0" ; N-Up-XColumn
5479 "LandscapePageHeight neg" ; N-Up-YColumn
5480 "PageWidth neg" ; N-Up-XLine
5481 "N-Up-End 1 sub LandscapePageHeight mul" ; N-Up-YLine
5482 "N-Up-Columns" ; N-Up-Repeat
5483 "N-Up-Lines" ; N-Up-End
5484 "N-Up-Repeat 1 sub PageWidth mul" ; N-Up-XStart
5485 "0") ; N-Up-YStart
5486 (bottom-right
5487 "0" ; N-Up-XColumn
5488 "LandscapePageHeight" ; N-Up-YColumn
5489 "PageWidth neg" ; N-Up-XLine
5490 "N-Up-End 1 sub LandscapePageHeight mul neg" ; N-Up-YLine
5491 "N-Up-Columns" ; N-Up-Repeat
5492 "N-Up-Lines" ; N-Up-End
5493 "N-Up-Repeat 1 sub PageWidth mul" ; N-Up-XStart
5494 "N-Up-End 1 sub LandscapePageHeight mul neg")) ; N-Up-YStart
5495 "Alist for n-up printing initializations.
5497 Each element has the following form:
5499 (KIND XCOL YCOL XLIN YLIN REPEAT END XSTART YSTART)
5501 Where:
5502 KIND is a valid value of `ps-n-up-filling'.
5503 XCOL YCOL are the relative position for the next column.
5504 XLIN YLIN are the relative position for the beginning of next line.
5505 REPEAT is the number of repetions for external loop.
5506 END is the number of repetions for internal loop and also the number of pages in
5507 a row.
5508 XSTART YSTART are the relative position for the first page in a sheet.")
5511 (defun ps-n-up-filling ()
5512 (cdr (or (assq ps-n-up-filling ps-n-up-filling-database)
5513 (assq 'left-top ps-n-up-filling-database))))
5516 (defmacro ps-n-up-xcolumn (init) `(nth 0 ,init))
5517 (defmacro ps-n-up-ycolumn (init) `(nth 1 ,init))
5518 (defmacro ps-n-up-xline (init) `(nth 2 ,init))
5519 (defmacro ps-n-up-yline (init) `(nth 3 ,init))
5520 (defmacro ps-n-up-repeat (init) `(nth 4 ,init))
5521 (defmacro ps-n-up-end (init) `(nth 5 ,init))
5522 (defmacro ps-n-up-xstart (init) `(nth 6 ,init))
5523 (defmacro ps-n-up-ystart (init) `(nth 7 ,init))
5526 (defconst ps-error-handler-alist
5527 '((none . 0)
5528 (paper . 1)
5529 (system . 2)
5530 (paper-and-system . 3))
5531 "Alist for error handler message.")
5534 (defconst ps-zebra-stripe-alist
5535 '((follow . 1)
5536 (full . 2)
5537 (full-follow . 3))
5538 "Alist for zebra stripe continuation.")
5541 (defun ps-begin-file ()
5542 (setq ps-page-order 0
5543 ps-page-printed 0
5544 ps-background-text-count 0
5545 ps-background-image-count 0
5546 ps-background-pages nil
5547 ps-background-all-pages nil)
5549 (let ((dimensions (cdr (assq ps-paper-type ps-page-dimensions-database)))
5550 (tumble (if ps-landscape-mode (not ps-spool-tumble) ps-spool-tumble))
5551 (n-up (ps-n-up-printing))
5552 (n-up-filling (ps-n-up-filling)))
5553 (and ps-n-up-on (setq tumble (not tumble)))
5554 (ps-output
5555 ps-adobe-tag
5556 "%%Title: " (buffer-name) ; Take job name from name of
5557 ; first buffer printed
5558 "\n%%Creator: ps-print v" ps-print-version
5559 "\n%%For: " (user-full-name)
5560 "\n%%CreationDate: " (format-time-string "%T %b %d %Y")
5561 "\n%%Orientation: "
5562 (if ps-landscape-mode "Landscape" "Portrait")
5563 "\n%%DocumentNeededResources: font Times-Roman Times-Italic\n%%+ font "
5564 (mapconcat 'identity
5565 (ps-remove-duplicates
5566 (append (ps-fonts 'ps-font-for-text)
5567 (list (ps-font 'ps-font-for-header 'normal)
5568 (ps-font 'ps-font-for-header 'bold)
5569 (ps-font 'ps-font-for-footer 'normal)
5570 (ps-font 'ps-font-for-footer 'bold))))
5571 "\n%%+ font ")
5572 "\n%%DocumentSuppliedResources: procset PSPrintUserDefinedPrologue-" (user-login-name) " 0 0"
5573 "\n%%DocumentMedia: " (ps-page-dimensions-get-media dimensions)
5574 (format " %d" (round (ps-page-dimensions-get-width dimensions)))
5575 (format " %d" (round (ps-page-dimensions-get-height dimensions)))
5576 " 0 () ()\n%%PageOrder: Ascend\n%%Pages: (atend)\n%%Requirements:"
5577 (if ps-spool-duplex
5578 (if tumble " duplex(tumble)\n" " duplex\n")
5579 "\n"))
5581 (ps-insert-string ps-print-prologue-header)
5583 (ps-output "%%EndComments\n%%BeginDefaults\n%%PageMedia: "
5584 (ps-page-dimensions-get-media dimensions)
5585 "\n%%EndDefaults\n\n%%BeginProlog\n\n"
5586 "/languagelevel where{pop}{/languagelevel 1 def}ifelse\n"
5587 (format "/ErrorMessage %s def\n\n"
5588 (or (cdr (assoc ps-error-handler-message
5589 ps-error-handler-alist))
5590 1)) ; send to paper
5591 ps-print-prologue-0
5592 "\n%%BeginResource: procset PSPrintUserDefinedPrologue-" (user-login-name) " 0 0\n\n")
5594 (ps-insert-string ps-user-defined-prologue)
5596 (ps-output "\n%%EndResource\n\n")
5598 (ps-output-boolean "LandscapeMode "
5599 (or ps-landscape-mode
5600 (eq (ps-n-up-landscape n-up) 'pag)))
5601 (ps-output-boolean "UpsideDown " ps-print-upside-down)
5602 (ps-output (format "/NumberOfColumns %d def\n" ps-number-of-columns)
5604 (format "/LandscapePageHeight %s def\n" ps-landscape-page-height)
5605 (format "/PrintPageWidth %s def\n"
5606 (- (* (+ ps-print-width ps-inter-column)
5607 ps-number-of-columns)
5608 ps-inter-column))
5609 (format "/PrintWidth %s def\n" ps-print-width)
5610 (format "/PrintHeight %s def\n" ps-print-height)
5612 (format "/LeftMargin %s def\n" ps-left-margin)
5613 (format "/RightMargin %s def\n" ps-right-margin)
5614 (format "/InterColumn %s def\n" ps-inter-column)
5616 (format "/BottomMargin %s def\n" ps-bottom-margin)
5617 (format "/TopMargin %s def\n" ps-top-margin) ; not used
5618 (format "/HeaderOffset %s def\n" ps-header-offset)
5619 (format "/HeaderPad %s def\n" ps-header-pad)
5620 (format "/FooterOffset %s def\n" ps-footer-offset)
5621 (format "/FooterPad %s def\n" ps-footer-pad)
5622 (format "/FooterLines %s def\n" ps-footer-lines))
5624 (ps-output-boolean "ShowNofN " ps-show-n-of-n)
5625 (ps-output-boolean "SwitchHeader " (if (eq ps-switch-header 'duplex)
5626 ps-spool-duplex
5627 ps-switch-header))
5628 (ps-output-boolean "PrintOnlyOneHeader" ps-print-only-one-header)
5629 (ps-output-boolean "PrintHeader " ps-print-header)
5630 (ps-output-boolean "PrintHeaderFrame " ps-print-header-frame)
5631 (ps-output-frame-properties "HeaderFrameProperties" ps-header-frame-alist)
5632 (ps-output-boolean "PrintFooter " ps-print-footer)
5633 (ps-output-boolean "PrintFooterFrame " ps-print-footer-frame)
5634 (ps-output-frame-properties "FooterFrameProperties" ps-footer-frame-alist)
5636 (let ((line-height (ps-line-height 'ps-font-for-text)))
5637 (ps-output (format "/LineSpacing %s def\n" ps-line-spacing-internal)
5638 (format "/ParagraphSpacing %s def\n"
5639 ps-paragraph-spacing-internal)
5640 (format "/LineHeight %s def\n" line-height)
5641 (format "/LinesPerColumn %d def\n"
5642 (let ((height (+ line-height
5643 ps-line-spacing-internal)))
5644 (round (/ (+ ps-print-height
5645 (* height 0.45))
5646 height))))))
5648 (ps-output-boolean "WarnPaperSize " ps-warn-paper-type)
5649 (ps-output-boolean "Zebra " ps-zebra-stripes)
5650 (ps-output-boolean "PrintLineNumber " ps-line-number)
5651 (ps-output-boolean "SyncLineZebra " (not (integerp ps-line-number-step)))
5652 (ps-output (format "/ZebraFollow %d def\n"
5653 (or (cdr (assq ps-zebra-stripe-follow
5654 ps-zebra-stripe-alist))
5656 (format "/PrintLineStep %d def\n"
5657 (if (integerp ps-line-number-step)
5658 ps-line-number-step
5659 ps-zebra-stripe-height))
5660 (format "/PrintLineStart %d def\n" ps-line-number-start)
5661 "/LineNumberColor "
5662 (ps-format-color ps-line-number-color 0.0)
5663 (format "def\n/ZebraHeight %d def\n"
5664 ps-zebra-stripe-height)
5665 "/ZebraColor "
5666 (ps-format-color ps-zebra-color 0.95)
5667 "def\n")
5668 (ps-output "/BackgroundColor "
5669 (ps-format-color ps-default-background 1.0)
5670 "def\n")
5671 (ps-output "/UseSetpagedevice "
5672 (if (eq ps-spool-config 'setpagedevice)
5673 "/setpagedevice where{pop languagelevel 2 eq}{false}ifelse"
5674 "false")
5675 " def\n\n/PageWidth "
5676 "PrintPageWidth LeftMargin add RightMargin add def\n\n"
5677 (format "/N-Up %d def\n" ps-n-up-printing))
5678 (ps-output-boolean "N-Up-Landscape" (eq (ps-n-up-landscape n-up) t))
5679 (ps-output-boolean "N-Up-Border " ps-n-up-border-p)
5680 (ps-output (format "/N-Up-Lines %d def\n" (ps-n-up-lines n-up))
5681 (format "/N-Up-Columns %d def\n" (ps-n-up-columns n-up))
5682 (format "/N-Up-Missing %d def\n" (ps-n-up-missing n-up))
5683 (format "/N-Up-Margin %s def\n" ps-n-up-margin)
5684 "/N-Up-Repeat "
5685 (if ps-landscape-mode
5686 (ps-n-up-end n-up-filling)
5687 (ps-n-up-repeat n-up-filling))
5688 " def\n/N-Up-End "
5689 (if ps-landscape-mode
5690 (ps-n-up-repeat n-up-filling)
5691 (ps-n-up-end n-up-filling))
5692 " def\n/N-Up-XColumn " (ps-n-up-xcolumn n-up-filling)
5693 " def\n/N-Up-YColumn " (ps-n-up-ycolumn n-up-filling)
5694 " def\n/N-Up-XLine " (ps-n-up-xline n-up-filling)
5695 " def\n/N-Up-YLine " (ps-n-up-yline n-up-filling)
5696 " def\n/N-Up-XStart " (ps-n-up-xstart n-up-filling)
5697 " def\n/N-Up-YStart " (ps-n-up-ystart n-up-filling) " def\n")
5699 (ps-background-text)
5700 (ps-background-image)
5701 (setq ps-background-all-pages (nreverse ps-background-all-pages)
5702 ps-background-pages (nreverse ps-background-pages))
5704 (ps-output "\n" ps-print-prologue-1
5705 "\n/printGlobalBackground{\n")
5706 (mapc 'ps-output ps-background-all-pages)
5707 (ps-output
5708 "}def\n/printLocalBackground{\n}def\n"
5709 "\n%%EndProlog\n\n%%BeginSetup\n"
5710 "\n%%IncludeResource: font Times-Roman"
5711 "\n%%IncludeResource: font Times-Italic"
5712 "\n%%IncludeResource: font "
5713 (mapconcat 'identity
5714 (ps-remove-duplicates
5715 (append (ps-fonts 'ps-font-for-text)
5716 (list (ps-font 'ps-font-for-header 'normal)
5717 (ps-font 'ps-font-for-header 'bold)
5718 (ps-font 'ps-font-for-footer 'normal)
5719 (ps-font 'ps-font-for-footer 'bold))))
5720 "\n%%IncludeResource: font ")
5721 ;; Header/line number fonts
5722 (format "\n/h0 %s(%s)cvn DefFont\n" ; /h0 14/Helvetica-Bold DefFont
5723 ps-header-title-font-size-internal
5724 (ps-font 'ps-font-for-header 'bold))
5725 (format "/h1 %s(%s)cvn DefFont\n" ; /h1 12/Helvetica DefFont
5726 ps-header-font-size-internal
5727 (ps-font 'ps-font-for-header 'normal))
5728 (format "/L0 %s(%s)cvn DefFont\n" ; /L0 6/Times-Italic DefFont
5729 (ps-get-font-size 'ps-line-number-font-size)
5730 ps-line-number-font)
5731 (format "/H0 %s(%s)cvn DefFont\n" ; /H0 12/Helvetica DefFont
5732 ps-footer-font-size-internal
5733 (ps-font 'ps-font-for-footer 'normal))
5734 "\n\n% ---- These lines must be kept together because...
5736 /h0 F
5737 /HeaderTitleLineHeight FontHeight def
5739 /h1 F
5740 /HeaderLineHeight FontHeight def
5741 /HeaderDescent Descent def
5743 /H0 F
5744 /FooterLineHeight FontHeight def
5745 /FooterDescent Descent def
5747 % ---- ...because `F' has a side-effect on `FontHeight' and `Descent'\n\n")
5749 ;; Text fonts
5750 (let ((font (ps-font-alist 'ps-font-for-text))
5751 (i 0))
5752 (while font
5753 (ps-output (format "/f%d %s(%s)cvn DefFont\n"
5755 ps-font-size-internal
5756 (ps-font 'ps-font-for-text (car (car font)))))
5757 (setq font (cdr font)
5758 i (1+ i))))
5760 (let ((font-entry (cdr (assq ps-font-family ps-font-info-database))))
5761 (ps-output (format "/SpaceWidthRatio %f def\n"
5762 (/ (ps-lookup 'space-width) (ps-lookup 'size)))))
5764 (unless (eq ps-spool-config 'lpr-switches)
5765 (ps-output "\n%%BeginFeature: *Duplex "
5766 (ps-boolean-capitalized ps-spool-duplex)
5767 " *Tumble "
5768 (ps-boolean-capitalized tumble)
5769 "\nUseSetpagedevice\n{BMark/Duplex "
5770 (ps-boolean-constant ps-spool-duplex)
5771 "/Tumble "
5772 (ps-boolean-constant tumble)
5773 " EMark setpagedevice}\n{statusdict begin "
5774 (ps-boolean-constant ps-spool-duplex)
5775 " setduplexmode "
5776 (ps-boolean-constant tumble)
5777 " settumble end}ifelse\n%%EndFeature\n")))
5778 (ps-output "\n%%BeginFeature: *ManualFeed "
5779 (ps-boolean-capitalized ps-manual-feed)
5780 "\nBMark /ManualFeed "
5781 (ps-boolean-constant ps-manual-feed)
5782 " EMark setpagedevice\n%%EndFeature\n\nBeginDoc\n%%EndSetup\n")
5783 (and ps-banner-page-when-duplexing
5784 (ps-output "\n%%Page: banner 0\nsave showpage restore\n")))
5787 (defun ps-format-color (color &optional default)
5788 (let ((the-color (if (stringp color)
5789 (ps-color-scale color)
5790 color)))
5791 (if (and the-color (listp the-color))
5792 (concat "["
5793 (format ps-color-format
5794 (* (nth 0 the-color) 1.0) ; force float number
5795 (* (nth 1 the-color) 1.0) ; force float number
5796 (* (nth 2 the-color) 1.0)) ; force float number
5797 "] ")
5798 (ps-float-format (if (numberp the-color) the-color default)))))
5801 (defun ps-insert-string (prologue)
5802 (let ((str (if (functionp prologue)
5803 (funcall prologue)
5804 prologue)))
5805 (and (stringp str)
5806 (ps-output str))))
5809 (defun ps-boolean-capitalized (bool)
5810 (if bool "True" "False"))
5813 (defun ps-boolean-constant (bool)
5814 (if bool "true" "false"))
5817 (defun ps-header-dirpart ()
5818 (let ((fname (buffer-file-name)))
5819 (if fname
5820 (if (string-equal (buffer-name) (file-name-nondirectory fname))
5821 (abbreviate-file-name (file-name-directory fname))
5822 fname)
5823 "")))
5826 (defun ps-get-buffer-name ()
5827 (cond
5828 ;; Indulge Jim this little easter egg:
5829 ((string= (buffer-name) "ps-print.el")
5830 "Hey, Cool! It's ps-print.el!!!")
5831 ;; Indulge Jack this other little easter egg:
5832 ((string= (buffer-name) "sokoban.el")
5833 "Super! C'est sokoban.el!")
5834 (t (concat
5835 (and ps-printing-region-p "Subset of: ")
5836 (buffer-name)
5837 (and (buffer-modified-p) " (unsaved)")))))
5840 (defun ps-get-size (size mess &optional arg)
5841 (let ((siz (cond ((numberp size)
5842 size)
5843 ((and (consp size)
5844 (numberp (car size))
5845 (numberp (cdr size)))
5846 (if ps-landscape-mode
5847 (car size)
5848 (cdr size)))
5850 -1))))
5851 (and (< siz 0)
5852 (error "Invalid %s `%S'%s"
5853 mess size
5854 (if arg
5855 (format " for `%S'" arg)
5856 "")))
5857 siz))
5860 (defun ps-get-font-size (font-sym)
5861 (ps-get-size (symbol-value font-sym) "font size" font-sym))
5864 (defun ps-rgb-color (color unspecified default)
5865 (cond
5866 ;; (float float float) ==> (R G B)
5867 ((and color (listp color) (= (length color) 3)
5868 (let ((cl color)
5869 (ok t) e)
5870 (while (and ok cl)
5871 (setq e (car cl)
5872 cl (cdr cl)
5873 ok (and (floatp e) (<= 0.0 e) (<= e 1.0))))
5874 ok))
5875 color)
5876 ;; float ==> 0.0 = black .. 1.0 = white
5877 ((and (floatp color) (<= 0.0 color) (<= color 1.0))
5878 (list color color color))
5879 ;; "colorName" but different from "unspecified-[bf]g"
5880 ((and (stringp color) (not (string= color unspecified)))
5881 (ps-color-scale color))
5882 ;; ok, use the default
5884 (list default default default))))
5887 (defun ps-begin-job (genfunc)
5888 ;; prologue files
5889 (or (equal ps-mark-code-directory ps-postscript-code-directory)
5890 (setq ps-print-prologue-0 (ps-prologue-file 0)
5891 ps-print-prologue-1 (ps-prologue-file 1)
5892 ps-mark-code-directory ps-postscript-code-directory))
5893 ;; selected pages
5894 (let (new page)
5895 (while ps-selected-pages
5896 (setq page (car ps-selected-pages)
5897 ps-selected-pages (cdr ps-selected-pages))
5898 (cond ((integerp page)
5899 (and (> page 0)
5900 (setq new (cons (cons page page) new))))
5901 ((consp page)
5902 (and (integerp (car page)) (integerp (cdr page))
5903 (> (car page) 0)
5904 (<= (car page) (cdr page))
5905 (setq new (cons page new))))))
5906 (setq ps-selected-pages (sort new #'(lambda (one other)
5907 (< (car one) (car other))))
5908 ps-last-selected-pages ps-selected-pages
5909 ps-first-page nil
5910 ps-last-page nil))
5911 ;; face background
5912 (or (listp ps-use-face-background)
5913 (setq ps-use-face-background t))
5914 ;; line number
5915 (and (integerp ps-line-number-step)
5916 (<= ps-line-number-step 0)
5917 (setq ps-line-number-step 1))
5918 (setq ps-n-up-on (> ps-n-up-printing 1)
5919 ps-line-number-start (max 1 (min ps-line-number-start
5920 (if (integerp ps-line-number-step)
5921 ps-line-number-step
5922 ps-zebra-stripe-height))))
5923 ;; spooling buffer
5924 (save-excursion
5925 (set-buffer ps-spool-buffer)
5926 (goto-char (point-max))
5927 (and (re-search-backward "^%%Trailer$" nil t)
5928 (delete-region (match-beginning 0) (point-max))))
5929 ;; miscellaneous
5930 (setq ps-zebra-stripe-full-p (memq ps-zebra-stripe-follow
5931 '(full full-follow))
5932 ps-page-postscript 0
5933 ps-page-sheet 0
5934 ps-page-n-up 0
5935 ps-page-column 0
5936 ps-lines-printed 0
5937 ps-print-page-p t
5938 ps-showline-count (car ps-printing-region)
5939 ps-line-spacing-internal (ps-get-size ps-line-spacing
5940 "line spacing")
5941 ps-paragraph-spacing-internal (ps-get-size ps-paragraph-spacing
5942 "paragraph spacing")
5943 ps-font-size-internal (ps-get-font-size 'ps-font-size)
5944 ps-header-font-size-internal (ps-get-font-size 'ps-header-font-size)
5945 ps-header-title-font-size-internal
5946 (ps-get-font-size 'ps-header-title-font-size)
5947 ps-footer-font-size-internal (ps-get-font-size 'ps-footer-font-size)
5948 ps-control-or-escape-regexp
5949 (cond ((eq ps-print-control-characters '8-bit)
5950 (string-as-unibyte "[\000-\037\177-\377]"))
5951 ((eq ps-print-control-characters 'control-8-bit)
5952 (string-as-unibyte "[\000-\037\177-\237]"))
5953 ((eq ps-print-control-characters 'control)
5954 "[\000-\037\177]")
5955 (t "[\t\n\f]"))
5956 ;; Set the color scale. We do it here instead of in the defvar so
5957 ;; that ps-print can be dumped into emacs. This expression can't be
5958 ;; evaluated at dump-time because X isn't initialized.
5959 ps-color-p (and ps-print-color-p (ps-color-device))
5960 ps-print-color-scale (if ps-color-p
5961 (float (car (ps-color-values "white")))
5962 1.0)
5963 ps-default-background (ps-rgb-color
5964 (cond
5965 ((or (member ps-print-color-p
5966 '(nil back-white))
5967 (eq genfunc 'ps-generate-postscript))
5968 nil)
5969 ((eq ps-default-bg 'frame-parameter)
5970 (ps-frame-parameter nil 'background-color))
5971 ((eq ps-default-bg t)
5972 (ps-face-background-name 'default))
5974 ps-default-bg))
5975 "unspecified-bg"
5976 1.0)
5977 ps-default-foreground (ps-rgb-color
5978 (cond
5979 ((or (member ps-print-color-p
5980 '(nil back-white))
5981 (eq genfunc 'ps-generate-postscript))
5982 nil)
5983 ((eq ps-default-fg 'frame-parameter)
5984 (ps-frame-parameter nil 'foreground-color))
5985 ((eq ps-default-fg t)
5986 (ps-face-foreground-name 'default))
5988 ps-default-fg))
5989 "unspecified-fg"
5990 0.0)
5991 ps-foreground-list (mapcar
5992 #'(lambda (arg)
5993 (ps-rgb-color arg "unspecified-fg" 0.0))
5994 (append (and (not (member ps-print-color-p
5995 '(nil back-white)))
5996 ps-fg-list)
5997 (list ps-default-foreground
5998 "black")))
5999 ps-default-color (and (not (member ps-print-color-p
6000 '(nil back-white)))
6001 ps-default-foreground)
6002 ps-current-color ps-default-color)
6003 ;; initialize page dimensions
6004 (ps-get-page-dimensions)
6005 ;; final check
6006 (and ps-color-p
6007 (equal ps-default-background ps-default-foreground)
6008 (error
6009 (concat
6010 "`ps-default-fg' and `ps-default-bg' have the same color.\n"
6011 "Text won't appear on page. Please, check these variables."))))
6014 (defun ps-page-number ()
6015 (if ps-print-only-one-header
6016 (1+ (/ (1- ps-page-column) ps-number-of-columns))
6017 ps-page-column))
6020 (defsubst ps-end-page ()
6021 (ps-output "EndPage\nEndDSCPage\n"))
6024 (defsubst ps-next-page ()
6025 (ps-end-page)
6026 (ps-flush-output)
6027 (ps-begin-page))
6030 (defun ps-end-sheet ()
6031 (and ps-print-page-p (> ps-page-sheet 0)
6032 (ps-output "EndSheet\n")))
6035 (defun ps-header-sheet ()
6036 ;; Print only when a new sheet begins.
6037 (ps-end-sheet)
6038 (setq ps-page-sheet (1+ ps-page-sheet))
6039 (when (ps-print-sheet-p)
6040 (setq ps-page-order (1+ ps-page-order))
6041 (ps-output (if ps-n-up-on
6042 (format "\n%%%%Page: (%d \\(%d\\)) %d\n"
6043 ps-page-order ps-page-postscript ps-page-order)
6044 (format "\n%%%%Page: %d %d\n"
6045 ps-page-postscript ps-page-order))
6046 ;; spooling needs to redefine Lines and PageCount on each page
6047 "/Lines 0 def\n/PageCount 0 def\n"
6048 (format "%d BeginSheet\nBeginDSCPage\n"
6049 ps-n-up-printing))))
6052 (defun ps-header-page ()
6053 ;; set total line and page number when printing has finished
6054 ;; (see `ps-generate')
6055 (if (zerop (mod ps-page-column ps-number-of-columns))
6056 (progn
6057 (setq ps-page-postscript (1+ ps-page-postscript))
6058 (when (ps-print-page-p)
6059 (ps-print-sheet-p)
6060 (if (zerop (mod ps-page-n-up ps-n-up-printing))
6061 ;; Print only when a new sheet begins.
6062 (progn
6063 (ps-header-sheet)
6064 (run-hooks 'ps-print-begin-sheet-hook))
6065 ;; Print only when a new page begins.
6066 (ps-output "BeginDSCPage\n")
6067 (run-hooks 'ps-print-begin-page-hook))
6068 (ps-background ps-page-postscript)
6069 (setq ps-page-n-up (1+ ps-page-n-up))
6070 (and ps-print-page-p
6071 (setq ps-page-printed (1+ ps-page-printed)))))
6072 ;; Print only when a new column begins.
6073 (ps-output "BeginDSCPage\n")
6074 (run-hooks 'ps-print-begin-column-hook))
6075 (setq ps-page-column (1+ ps-page-column)))
6077 (defun ps-begin-page ()
6078 (setq ps-width-remaining ps-print-width
6079 ps-height-remaining ps-print-height)
6081 (ps-header-page)
6083 (ps-output (format "/LineNumber %d def\n" ps-showline-count)
6084 (format "/PageNumber %d def\n" (ps-page-number)))
6086 (when ps-print-header
6087 (ps-generate-header "HeaderLinesLeft" "/h0" "/h1"
6088 (or ps-lh-cache ps-left-header))
6089 (ps-generate-header "HeaderLinesRight" "/h0" "/h1"
6090 (or ps-rh-cache ps-right-header))
6091 (ps-output (format "%d SetHeaderLines\n" ps-header-lines))
6092 (setq ps-lh-cache nil
6093 ps-rh-cache nil))
6095 (when ps-print-footer
6096 (ps-generate-header "FooterLinesLeft" "/H0" "/H0"
6097 (or ps-lf-cache ps-left-footer))
6098 (ps-generate-header "FooterLinesRight" "/H0" "/H0"
6099 (or ps-rf-cache ps-right-footer))
6100 (ps-output (format "%d SetFooterLines\n" ps-footer-lines))
6101 (setq ps-lf-cache nil
6102 ps-rf-cache nil))
6104 (ps-output (number-to-string ps-lines-printed) " BeginPage\n")
6105 (ps-set-font ps-current-font)
6106 (ps-set-bg ps-current-bg)
6107 (ps-set-color ps-current-color)
6108 (ps-mule-begin-page))
6110 (defsubst ps-skip-newline (limit)
6111 (setq ps-showline-count (1+ ps-showline-count)
6112 ps-lines-printed (1+ ps-lines-printed))
6113 (and (< (point) limit)
6114 (forward-char 1)))
6116 (defsubst ps-next-line ()
6117 (setq ps-showline-count (1+ ps-showline-count)
6118 ps-lines-printed (1+ ps-lines-printed))
6119 (let* ((paragraph-p (and ps-paragraph-regexp
6120 (looking-at ps-paragraph-regexp)))
6121 (lh (+ (ps-line-height 'ps-font-for-text)
6122 (if paragraph-p
6123 ps-paragraph-spacing-internal
6124 ps-line-spacing-internal))))
6125 (if (< ps-height-remaining lh)
6126 (ps-next-page)
6127 (setq ps-width-remaining ps-print-width
6128 ps-height-remaining (- ps-height-remaining lh))
6129 (ps-output (if paragraph-p "PHL\n" "LHL\n")))))
6131 (defun ps-continue-line ()
6132 (setq ps-lines-printed (1+ ps-lines-printed))
6133 (let ((lh (+ (ps-line-height 'ps-font-for-text) ps-line-spacing-internal)))
6134 (if (< ps-height-remaining lh)
6135 (ps-next-page)
6136 (setq ps-width-remaining ps-print-width
6137 ps-height-remaining (- ps-height-remaining lh))
6138 (ps-output "SL\n"))))
6140 (defun ps-find-wrappoint (from to char-width)
6141 (let ((avail (truncate (/ ps-width-remaining char-width)))
6142 (todo (- to from)))
6143 (if (< todo avail)
6144 (cons to (* todo char-width))
6145 (cons (+ from avail) ps-width-remaining))))
6147 (defun ps-basic-plot-str (from to string)
6148 (let* ((wrappoint (ps-find-wrappoint from to
6149 (ps-avg-char-width 'ps-font-for-text)))
6150 (to (car wrappoint))
6151 (str (substring string from to)))
6152 (ps-mule-prepare-ascii-font str)
6153 (ps-output-string str)
6154 (ps-output " S\n")
6155 wrappoint))
6157 (defun ps-basic-plot-string (from to &optional bg-color)
6158 (let* ((wrappoint (ps-find-wrappoint from to
6159 (ps-avg-char-width 'ps-font-for-text)))
6160 (to (car wrappoint))
6161 (string (buffer-substring-no-properties from to)))
6162 (ps-mule-prepare-ascii-font string)
6163 (ps-output-string string)
6164 (ps-output " S\n")
6165 wrappoint))
6167 (defun ps-basic-plot-whitespace (from to &optional bg-color)
6168 (let* ((wrappoint (ps-find-wrappoint from to
6169 (ps-space-width 'ps-font-for-text)))
6170 (to (car wrappoint)))
6171 (ps-output (format "%d W\n" (- to from)))
6172 wrappoint))
6174 (defun ps-plot (plotfunc from to &optional bg-color)
6175 (while (< from to)
6176 (let* ((wrappoint (funcall plotfunc from to bg-color))
6177 (plotted-to (car wrappoint))
6178 (plotted-width (cdr wrappoint)))
6179 (setq from plotted-to
6180 ps-width-remaining (- ps-width-remaining plotted-width))
6181 (if (< from to)
6182 (ps-continue-line))))
6183 (if ps-razzle-dazzle
6184 (let* ((q-todo (- (point-max) (point-min)))
6185 (q-done (- (point) (point-min)))
6186 (chunkfrac (/ q-todo 8))
6187 (chunksize (min chunkfrac 1000)))
6188 (if (> (- q-done ps-razchunk) chunksize)
6189 (progn
6190 (setq ps-razchunk q-done)
6191 (message "Formatting...%3d%%"
6192 (if (< q-todo 100)
6193 (/ (* 100 q-done) q-todo)
6194 (/ q-done (/ q-todo 100)))
6195 ))))))
6197 (defvar ps-last-font nil)
6199 (defun ps-set-font (font)
6200 (setq ps-last-font (format "f%d" (setq ps-current-font font)))
6201 (ps-output (format "/%s F\n" ps-last-font)))
6203 (defun ps-set-bg (color)
6204 (if (setq ps-current-bg color)
6205 (ps-output (format ps-color-format
6206 (nth 0 color) (nth 1 color) (nth 2 color))
6207 " true BG\n")
6208 (ps-output "false BG\n")))
6210 (defun ps-set-color (color)
6211 (setq ps-current-color (or color ps-default-foreground))
6212 (ps-output (format ps-color-format
6213 (nth 0 ps-current-color)
6214 (nth 1 ps-current-color) (nth 2 ps-current-color))
6215 " FG\n"))
6218 (defsubst ps-plot-string (string)
6219 (ps-plot 'ps-basic-plot-str 0 (length string) string))
6222 (defvar ps-current-effect 0)
6224 (defvar ps-print-translation-table
6225 (let ((tbl (make-char-table 'translation-table nil)))
6226 (if (and (boundp 'ucs-mule-8859-to-mule-unicode)
6227 (char-table-p ucs-mule-8859-to-mule-unicode))
6228 (map-char-table
6229 #'(lambda (k v)
6230 (if (and v (eq (char-charset v) 'latin-iso8859-1) (/= k v))
6231 (aset tbl k v)))
6232 ucs-mule-8859-to-mule-unicode))
6233 tbl)
6234 "Translation table for PostScript printing.
6235 The default value is a table that translates non-Latin-1 Latin characters
6236 to the equivalent Latin-1 characters.")
6238 (defun ps-plot-region (from to font &optional fg-color bg-color effects)
6239 (or (equal font ps-current-font)
6240 (ps-set-font font))
6242 ;; Specify a foreground color only if:
6243 ;; one's specified,
6244 ;; it's different than the background (if `ps-fg-validate-p' is non-nil)
6245 ;; and it's different than the current.
6246 (let ((fg (or fg-color ps-default-foreground)))
6247 (if ps-fg-validate-p
6248 (let ((bg (or bg-color ps-default-background))
6249 (el ps-foreground-list))
6250 (while (and el (equal fg bg))
6251 (setq fg (car el)
6252 el (cdr el)))))
6253 (or (equal fg ps-current-color)
6254 (ps-set-color fg)))
6256 (or (equal bg-color ps-current-bg)
6257 (ps-set-bg bg-color))
6259 ;; Specify effects (underline, overline, box, etc.)
6260 (cond
6261 ((not (integerp effects))
6262 (ps-output "0 EF\n")
6263 (setq ps-current-effect 0))
6264 ((/= effects ps-current-effect)
6265 (ps-output (number-to-string effects) " EF\n")
6266 (setq ps-current-effect effects)))
6268 ;; Starting at the beginning of the specified region...
6269 (save-excursion
6270 (goto-char from)
6272 ;; ...break the region up into chunks separated by tabs, linefeeds,
6273 ;; pagefeeds, control characters, and plot each chunk.
6274 (while (< from to)
6275 ;; skip lines between cut markers
6276 (and ps-begin-cut-regexp ps-end-cut-regexp
6277 (looking-at ps-begin-cut-regexp)
6278 (progn
6279 (goto-char (match-end 0))
6280 (and (re-search-forward ps-end-cut-regexp to 'noerror)
6281 (= (following-char) ?\n)
6282 (forward-char 1))
6283 (setq from (point))))
6284 (if (re-search-forward ps-control-or-escape-regexp to t)
6285 ;; region with some control characters or some multi-byte characters
6286 (let* ((match-point (match-beginning 0))
6287 (match (char-after match-point))
6288 (composition (ps-e-find-composition from (1+ match-point))))
6289 (if composition
6290 (if (and (nth 2 composition)
6291 (<= (car composition) match-point))
6292 (progn
6293 (setq match-point (car composition)
6294 match 0)
6295 (goto-char (nth 1 composition)))
6296 (setq composition nil)))
6297 (when (< from match-point)
6298 (ps-mule-set-ascii-font)
6299 (ps-plot 'ps-basic-plot-string from match-point bg-color))
6300 (cond
6301 ((= match ?\t) ; tab
6302 (let ((linestart (line-beginning-position)))
6303 (forward-char -1)
6304 (setq from (+ linestart (current-column)))
6305 (when (re-search-forward "[ \t]+" to t)
6306 (ps-mule-set-ascii-font)
6307 (ps-plot 'ps-basic-plot-whitespace
6308 from (+ linestart (current-column))
6309 bg-color))))
6311 ((= match ?\n) ; newline
6312 (if (looking-at "\f[^\n]")
6313 ;; \n\ftext\n ==>> next page, but keep line counting!!
6314 (progn
6315 (ps-skip-newline to)
6316 (ps-next-page))
6317 ;; \n\f\n ==>> it'll be handled by form feed
6318 ;; \ntext\n ==>> next line
6319 (ps-next-line)))
6321 ((= match ?\f) ; form feed
6322 ;; do not skip page if previous character is NEWLINE and
6323 ;; it is a beginning of page.
6324 (unless (and (equal (char-after (1- match-point)) ?\n)
6325 (= ps-height-remaining ps-print-height))
6326 ;; \f\n ==>> skip \n, but keep line counting!!
6327 (and (equal (following-char) ?\n)
6328 (ps-skip-newline to))
6329 (ps-next-page)))
6331 (composition ; a composite sequence
6332 (ps-plot 'ps-mule-plot-composition match-point (point) bg-color))
6334 ((> match 255) ; a multi-byte character
6335 (setq match (or (aref ps-print-translation-table match) match))
6336 (let* ((charset (char-charset match))
6337 (composition (ps-e-find-composition match-point to))
6338 (stop (if (nth 2 composition) (car composition) to)))
6339 (or (eq charset 'composition)
6340 (while (and (< (point) stop)
6341 (let ((ch (following-char)))
6342 (setq ch
6343 (or (aref ps-print-translation-table ch)
6344 ch))
6345 (eq (char-charset ch) charset)))
6346 (forward-char 1)))
6347 (ps-plot 'ps-mule-plot-string match-point (point) bg-color)))
6348 ; characters from ^@ to ^_ and
6349 (t ; characters from 127 to 255
6350 (ps-control-character match)))
6351 (setq from (point)))
6352 ;; region without control characters nor multi-byte characters
6353 (ps-mule-set-ascii-font)
6354 (ps-plot 'ps-basic-plot-string from to bg-color)
6355 (setq from to)))))
6357 (defvar ps-string-control-codes
6358 (let ((table (make-vector 256 nil))
6359 (char ?\000))
6360 ;; control character
6361 (while (<= char ?\037)
6362 (aset table char (format "^%c" (+ char ?@)))
6363 (setq char (1+ char)))
6364 ;; printable character
6365 (while (< char ?\177)
6366 (aset table char (format "%c" char))
6367 (setq char (1+ char)))
6368 ;; DEL
6369 (aset table char "^?")
6370 ;; 8-bit character
6371 (while (<= (setq char (1+ char)) ?\377)
6372 (aset table char (format "\\%o" char)))
6373 table)
6374 "Vector used to map characters to a printable string.")
6376 (defun ps-control-character (char)
6377 (let* ((str (aref ps-string-control-codes char))
6378 (from (1- (point)))
6379 (len (length str))
6380 (to (+ from len))
6381 (char-width (ps-avg-char-width 'ps-font-for-text))
6382 (wrappoint (ps-find-wrappoint from to char-width)))
6383 (if (< (car wrappoint) to)
6384 (ps-continue-line))
6385 (setq ps-width-remaining (- ps-width-remaining (* len char-width)))
6386 (ps-mule-prepare-ascii-font str)
6387 (ps-output-string str)
6388 (ps-output " S\n")))
6391 (defsubst ps-face-foreground-color-p (attr)
6392 (memq attr '(foreground-color :foreground)))
6395 (defsubst ps-face-background-color-p (attr)
6396 (memq attr '(background-color :background)))
6399 (defsubst ps-face-color-p (attr)
6400 (memq attr '(foreground-color :foreground background-color :background)))
6403 (defun ps-face-attributes (face)
6404 "Return face attribute vector.
6406 If FACE is not in `ps-print-face-extension-alist' or in
6407 `ps-print-face-alist', insert it on `ps-print-face-alist' and
6408 return the attribute vector.
6410 If FACE is not a valid face name, use default face."
6411 (cond
6412 (ps-black-white-faces-alist
6413 (or (and (symbolp face)
6414 (cdr (assq face ps-black-white-faces-alist)))
6415 (vector 0 nil nil)))
6416 ((symbolp face)
6417 (cdr (or (assq face ps-print-face-extension-alist)
6418 (assq face ps-print-face-alist)
6419 (let* ((the-face (if (facep face) face 'default))
6420 (new-face (ps-screen-to-bit-face the-face)))
6421 (or (and (eq the-face 'default)
6422 (assq the-face ps-print-face-alist))
6423 (setq ps-print-face-alist
6424 (cons new-face ps-print-face-alist)))
6425 new-face))))
6426 ((ps-face-foreground-color-p (car face))
6427 (vector 0 (cdr face) nil))
6428 ((ps-face-background-color-p (car face))
6429 (vector 0 nil (cdr face)))
6431 (vector 0 nil nil))))
6434 (defun ps-face-background (face background)
6435 (and (cond ((eq ps-use-face-background t)) ; always
6436 ((null ps-use-face-background) nil) ; never
6437 ;; ps-user-face-background is a symbol face list
6438 ((symbolp face)
6439 (memq face ps-use-face-background))
6440 ((listp face)
6441 (or (ps-face-color-p (car face))
6442 (let (ok)
6443 (while face
6444 (if (or (memq (car face) ps-use-face-background)
6445 (ps-face-color-p (car face)))
6446 (setq face nil
6447 ok t)
6448 (setq face (cdr face))))
6449 ok)))
6451 nil)
6453 background))
6456 (defun ps-face-attribute-list (face-or-list)
6457 (cond
6458 ;; simple face
6459 ((not (listp face-or-list))
6460 (ps-face-attributes face-or-list))
6461 ;; only foreground color, not a `real' face
6462 ((ps-face-foreground-color-p (car face-or-list))
6463 (vector 0 (cdr face-or-list) nil))
6464 ;; only background color, not a `real' face
6465 ((ps-face-background-color-p (car face-or-list))
6466 (vector 0 nil (cdr face-or-list)))
6467 ;; list of faces
6469 (let ((effects 0)
6470 foreground background face-attr face)
6471 (while face-or-list
6472 (setq face (car face-or-list)
6473 face-or-list (cdr face-or-list)
6474 face-attr (ps-face-attributes face)
6475 effects (logior effects (aref face-attr 0)))
6476 (or foreground (setq foreground (aref face-attr 1)))
6477 (or background
6478 (setq background (ps-face-background face (aref face-attr 2)))))
6479 (vector effects foreground background)))))
6482 (defconst ps-font-type (vector nil 'bold 'italic 'bold-italic))
6485 (defun ps-plot-with-face (from to face)
6486 (cond
6487 ((null face) ; print text with null face
6488 (ps-plot-region from to 0))
6489 ((eq face 'emacs--invisible--face)) ; skip invisible text!!!
6490 (t ; otherwise, text has a valid face
6491 (let* ((face-bit (ps-face-attribute-list face))
6492 (effect (aref face-bit 0))
6493 (foreground (aref face-bit 1))
6494 (background (ps-face-background face (aref face-bit 2)))
6495 (fg-color (if (and ps-color-p foreground)
6496 (ps-color-scale foreground)
6497 ps-default-color))
6498 (bg-color (and ps-color-p background
6499 (ps-color-scale background))))
6500 (ps-plot-region
6501 from to
6502 (ps-font-number 'ps-font-for-text
6503 (or (aref ps-font-type (logand effect 3))
6504 face))
6505 fg-color bg-color (lsh effect -2)))))
6506 (goto-char to))
6509 ;; Ensure that face-list is fbound.
6510 (or (fboundp 'face-list) (defalias 'face-list 'list-faces))
6513 (defun ps-build-reference-face-lists ()
6514 ;; Ensure that face database is updated with faces on
6515 ;; `font-lock-face-attributes' (obsolete stuff)
6516 (ps-font-lock-face-attributes)
6517 ;; Now, rebuild reference face lists
6518 (setq ps-print-face-alist nil)
6519 (if ps-auto-font-detect
6520 (mapc 'ps-map-face (face-list))
6521 (mapc 'ps-set-face-bold ps-bold-faces)
6522 (mapc 'ps-set-face-italic ps-italic-faces)
6523 (mapc 'ps-set-face-underline ps-underlined-faces))
6524 (setq ps-build-face-reference nil))
6527 (defun ps-set-face-bold (face)
6528 (ps-set-face-attribute face 1))
6530 (defun ps-set-face-italic (face)
6531 (ps-set-face-attribute face 2))
6533 (defun ps-set-face-underline (face)
6534 (ps-set-face-attribute face 4))
6537 (defun ps-set-face-attribute (face effect)
6538 (let ((face-bit (cdr (ps-map-face face))))
6539 (aset face-bit 0 (logior (aref face-bit 0) effect))))
6542 (defun ps-map-face (face)
6543 (let* ((face-map (ps-screen-to-bit-face face))
6544 (ps-face-bit (cdr (assq (car face-map) ps-print-face-alist))))
6545 (if ps-face-bit
6546 ;; if face exists, merge both
6547 (let ((face-bit (cdr face-map)))
6548 (aset ps-face-bit 0 (logior (aref ps-face-bit 0) (aref face-bit 0)))
6549 (or (aref ps-face-bit 1) (aset ps-face-bit 1 (aref face-bit 1)))
6550 (or (aref ps-face-bit 2) (aset ps-face-bit 2 (aref face-bit 2))))
6551 ;; if face does not exist, insert it
6552 (setq ps-print-face-alist (cons face-map ps-print-face-alist)))
6553 face-map))
6556 (defun ps-screen-to-bit-face (face)
6557 (cons face
6558 (vector (logior (if (ps-face-bold-p face) 1 0) ; bold
6559 (if (ps-face-italic-p face) 2 0) ; italic
6560 (if (ps-face-underlined-p face) 4 0)) ; underline
6561 (ps-face-foreground-name face)
6562 (ps-face-background-name face))))
6565 ;; to avoid compilation gripes
6566 (defalias 'ps-jitify 'jit-lock-fontify-now)
6567 (defalias 'ps-lazify 'lazy-lock-fontify-region)
6570 ;; to avoid compilation gripes
6571 (defun ps-print-ensure-fontified (start end)
6572 (cond ((and (boundp 'jit-lock-mode) (symbol-value 'jit-lock-mode))
6573 (ps-jitify start end))
6574 ((and (boundp 'lazy-lock-mode) (symbol-value 'lazy-lock-mode))
6575 (ps-lazify start end))))
6578 (defun ps-generate-postscript-with-faces (from to)
6579 ;; Some initialization...
6580 (setq ps-current-effect 0)
6582 ;; Build the reference lists of faces if necessary.
6583 (when (or ps-always-build-face-reference
6584 ps-build-face-reference)
6585 (message "Collecting face information...")
6586 (ps-build-reference-face-lists))
6588 ;; Black/white printer.
6589 (setq ps-black-white-faces-alist nil)
6590 (and (eq ps-print-color-p 'black-white)
6591 (ps-extend-face-list ps-black-white-faces nil
6592 'ps-black-white-faces-alist))
6594 ;; Generate some PostScript.
6595 (save-restriction
6596 (narrow-to-region from to)
6597 (ps-print-ensure-fontified from to)
6598 (let ((face 'default)
6599 (position to))
6600 (cond
6601 ((featurep 'xemacs) ; XEmacs
6602 ;; Build the list of extents...
6603 (let ((a (cons 'dummy nil))
6604 record type extent extent-list)
6605 (map-extents 'ps-xemacs-mapper nil from to a)
6606 (setq a (sort (cdr a) 'car-less-than-car)
6607 extent-list nil)
6609 ;; Loop through the extents...
6610 (while a
6611 (setq record (car a)
6612 position (car record)
6614 record (cdr record)
6615 type (car record)
6617 record (cdr record)
6618 extent (car record))
6620 ;; Plot up to this record.
6621 ;; XEmacs 19.12: for some reason, we're getting into a
6622 ;; situation in which some of the records have
6623 ;; positions less than 'from'. Since we've narrowed
6624 ;; the buffer, this'll generate errors. This is a hack,
6625 ;; but don't call ps-plot-with-face unless from > point-min.
6626 (and (>= from (point-min))
6627 (ps-plot-with-face from (min position (point-max)) face))
6629 (cond
6630 ((eq type 'push)
6631 (and (extent-face extent)
6632 (setq extent-list (sort (cons extent extent-list)
6633 'ps-xemacs-extent-sorter))))
6635 ((eq type 'pull)
6636 (setq extent-list (sort (delq extent extent-list)
6637 'ps-xemacs-extent-sorter))))
6639 (setq face (if extent-list
6640 (extent-face (car extent-list))
6641 'default)
6642 from position
6643 a (cdr a)))))
6645 (t ; Emacs
6646 (let ((property-change from)
6647 (overlay-change from)
6648 (save-buffer-invisibility-spec buffer-invisibility-spec)
6649 (buffer-invisibility-spec nil)
6650 before-string after-string)
6651 (while (< from to)
6652 (and (< property-change to) ; Don't search for property change
6653 ; unless previous search succeeded.
6654 (setq property-change (next-property-change from nil to)))
6655 (and (< overlay-change to) ; Don't search for overlay change
6656 ; unless previous search succeeded.
6657 (setq overlay-change (min (next-overlay-change from)
6658 to)))
6659 (setq position (min property-change overlay-change)
6660 before-string nil
6661 after-string nil)
6662 ;; The code below is not quite correct,
6663 ;; because a non-nil overlay invisible property
6664 ;; which is inactive according to the current value
6665 ;; of buffer-invisibility-spec nonetheless overrides
6666 ;; a face text property.
6667 (setq face
6668 (cond ((let ((prop (get-text-property from 'invisible)))
6669 ;; Decide whether this invisible property
6670 ;; really makes the text invisible.
6671 (if (eq save-buffer-invisibility-spec t)
6672 (not (null prop))
6673 (or (memq prop save-buffer-invisibility-spec)
6674 (assq prop save-buffer-invisibility-spec))))
6675 'emacs--invisible--face)
6676 ((get-text-property from 'face))
6677 (t 'default)))
6678 (let ((overlays (overlays-at from))
6679 (face-priority -1)) ; text-property
6680 (while (and overlays
6681 (not (eq face 'emacs--invisible--face)))
6682 (let* ((overlay (car overlays))
6683 (overlay-invisible
6684 (overlay-get overlay 'invisible))
6685 (overlay-priority
6686 (or (overlay-get overlay 'priority) 0)))
6687 (and (> overlay-priority face-priority)
6688 (setq before-string
6689 (or (overlay-get overlay 'before-string)
6690 before-string)
6691 after-string
6692 (or (and (<= (overlay-end overlay) position)
6693 (overlay-get overlay 'after-string))
6694 after-string)
6695 face-priority overlay-priority
6696 face
6697 (cond
6698 ((if (eq save-buffer-invisibility-spec t)
6699 (not (null overlay-invisible))
6700 (or (memq overlay-invisible
6701 save-buffer-invisibility-spec)
6702 (assq overlay-invisible
6703 save-buffer-invisibility-spec)))
6704 'emacs--invisible--face)
6705 ((overlay-get overlay 'face))
6706 (t face)
6707 ))))
6708 (setq overlays (cdr overlays))))
6709 ;; Plot up to this record.
6710 (and before-string
6711 (ps-plot-string before-string))
6712 (ps-plot-with-face from position face)
6713 (and after-string
6714 (ps-plot-string after-string))
6715 (setq from position)))))
6716 (ps-plot-with-face from to face))))
6718 (defun ps-generate-postscript (from to)
6719 (ps-plot-region from to 0))
6721 (defun ps-generate (buffer from to genfunc)
6722 (save-excursion
6723 (let ((from (min to from))
6724 (to (max to from))
6725 ;; This avoids trouble if chars with read-only properties
6726 ;; are copied into ps-spool-buffer.
6727 (inhibit-read-only t))
6728 (save-restriction
6729 (narrow-to-region from to)
6730 (and ps-razzle-dazzle
6731 (message "Formatting...%3d%%" (setq ps-razchunk 0)))
6732 (setq ps-source-buffer buffer
6733 ps-spool-buffer (get-buffer-create ps-spool-buffer-name))
6734 (ps-init-output-queue)
6735 (let (safe-marker completed-safely needs-begin-file)
6736 (unwind-protect
6737 (progn
6738 (set-buffer ps-spool-buffer)
6739 (set-buffer-multibyte nil)
6741 ;; Get a marker and make it point to the current end of the
6742 ;; buffer, If an error occurs, we'll delete everything from
6743 ;; the end of this marker onwards.
6744 (setq safe-marker (make-marker))
6745 (set-marker safe-marker (point-max))
6747 (goto-char (point-min))
6748 (or (looking-at (regexp-quote ps-adobe-tag))
6749 (setq needs-begin-file t))
6751 (set-buffer ps-source-buffer)
6752 (save-excursion
6753 (let ((ps-print-page-p t)
6754 ps-even-or-odd-pages)
6755 (ps-begin-job genfunc)
6756 (when needs-begin-file
6757 (ps-begin-file)
6758 (ps-mule-initialize))
6759 (ps-mule-begin-job from to)
6760 (ps-selected-pages)))
6761 (ps-begin-page)
6762 (funcall genfunc from to)
6763 (ps-end-page)
6764 (ps-end-job needs-begin-file)
6766 ;; Setting this variable tells the unwind form that the
6767 ;; the PostScript was generated without error.
6768 (setq completed-safely t))
6770 ;; Unwind form: If some bad mojo occurred while generating
6771 ;; PostScript, delete all the PostScript that was generated.
6772 ;; This protects the previously spooled files from getting
6773 ;; corrupted.
6774 (and (markerp safe-marker) (not completed-safely)
6775 (progn
6776 (set-buffer ps-spool-buffer)
6777 (delete-region (marker-position safe-marker) (point-max))))))
6779 (and ps-razzle-dazzle (message "Formatting...done"))))))
6782 (defun ps-end-job (needs-begin-file)
6783 (let ((ps-print-page-p t))
6784 (ps-flush-output)
6785 (save-excursion
6786 (let ((pages-per-sheet (mod ps-page-printed ps-n-up-printing))
6787 (total-lines (cdr ps-printing-region))
6788 (total-pages (ps-page-number)))
6789 (set-buffer ps-spool-buffer)
6790 (let (case-fold-search)
6791 ;; Back to the PS output buffer to set the last page n-up printing
6792 (goto-char (point-max))
6793 (and (> pages-per-sheet 0)
6794 (re-search-backward "^[0-9]+ BeginSheet$" nil t)
6795 (replace-match (format "%d BeginSheet" pages-per-sheet) t))
6796 ;; Back to the PS output buffer to set the page count
6797 (goto-char (point-min))
6798 (while (re-search-forward "^/Lines 0 def\n/PageCount 0 def$" nil t)
6799 (replace-match (format "/Lines %d def\n/PageCount %d def"
6800 total-lines total-pages) t)))))
6801 ;; Set dummy page
6802 (and ps-spool-duplex (= (mod ps-page-order 2) 1)
6803 (let ((ps-n-up-printing 0))
6804 (ps-header-sheet)
6805 (ps-output "/PrintHeader false def\n/ColumnIndex 0 def\n"
6806 "/PrintLineNumber false def\n"
6807 (number-to-string ps-lines-printed) " BeginPage\n")
6808 (ps-end-page)))
6809 ;; Set end of PostScript file
6810 (ps-end-sheet)
6811 (ps-output "\n%%Trailer\n%%Pages: "
6812 (number-to-string
6813 (if (and needs-begin-file
6814 ps-banner-page-when-duplexing)
6815 (1+ ps-page-order)
6816 ps-page-order))
6817 "\n\nEndDoc\n\n%%EOF\n")
6818 (and ps-end-with-control-d
6819 (ps-output "\C-d"))
6820 (ps-flush-output))
6821 ;; disable selected pages
6822 (setq ps-selected-pages nil))
6825 ;; Permit dynamic evaluation at print time of `ps-lpr-switches'.
6826 (defun ps-do-despool (filename)
6827 (if (or (not (boundp 'ps-spool-buffer))
6828 (not (symbol-value 'ps-spool-buffer)))
6829 (message "No spooled PostScript to print")
6830 (if filename
6831 (save-excursion
6832 (and ps-razzle-dazzle (message "Saving..."))
6833 (set-buffer ps-spool-buffer)
6834 (setq filename (expand-file-name filename))
6835 (let ((coding-system-for-write 'raw-text-unix))
6836 (write-region (point-min) (point-max) filename))
6837 (and ps-razzle-dazzle (message "Wrote %s" filename)))
6838 ;; Else, spool to the printer
6839 (and ps-razzle-dazzle (message "Printing..."))
6840 (save-excursion
6841 (set-buffer ps-spool-buffer)
6842 (let* ((coding-system-for-write 'raw-text-unix)
6843 (ps-printer-name (or ps-printer-name
6844 (and (boundp 'printer-name)
6845 (symbol-value 'printer-name))))
6846 (ps-lpr-switches
6847 (append ps-lpr-switches
6848 (and (stringp ps-printer-name)
6849 (string< "" ps-printer-name)
6850 (list (concat
6851 (and (stringp ps-printer-name-option)
6852 ps-printer-name-option)
6853 ps-printer-name))))))
6854 (or (stringp ps-printer-name)
6855 (setq ps-printer-name nil))
6856 (apply (or ps-print-region-function 'call-process-region)
6857 (point-min) (point-max) ps-lpr-command nil
6858 (and (fboundp 'start-process) 0)
6860 (ps-flatten-list ; dynamic evaluation
6861 (mapcar 'ps-eval-switch ps-lpr-switches)))))
6862 (and ps-razzle-dazzle (message "Printing...done")))
6863 (kill-buffer ps-spool-buffer)))
6865 ;; Dynamic evaluation
6866 (defun ps-eval-switch (arg)
6867 (cond ((stringp arg) arg)
6868 ((functionp arg) (apply arg nil))
6869 ((symbolp arg) (symbol-value arg))
6870 ((consp arg) (apply (car arg) (cdr arg)))
6871 (t nil)))
6873 ;; `ps-flatten-list' is defined here (copied from "message.el" and
6874 ;; enhanced to handle dotted pairs as well) until we can get some
6875 ;; sensible autoloads, or `flatten-list' gets put somewhere decent.
6877 ;; (ps-flatten-list '((a . b) c (d . e) (f g h) i . j))
6878 ;; => (a b c d e f g h i j)
6880 (defun ps-flatten-list (&rest list)
6881 (ps-flatten-list-1 list))
6883 (defun ps-flatten-list-1 (list)
6884 (cond ((null list) nil)
6885 ((consp list) (append (ps-flatten-list-1 (car list))
6886 (ps-flatten-list-1 (cdr list))))
6887 (t (list list))))
6889 (defun ps-kill-emacs-check ()
6890 (let (ps-buffer)
6891 (and (setq ps-buffer (get-buffer ps-spool-buffer-name))
6892 (buffer-name ps-buffer) ; check if it's not killed
6893 (buffer-modified-p ps-buffer)
6894 (y-or-n-p "Unprinted PostScript waiting; print now? ")
6895 (ps-despool))
6896 (and (setq ps-buffer (get-buffer ps-spool-buffer-name))
6897 (buffer-name ps-buffer) ; check if it's not killed
6898 (buffer-modified-p ps-buffer)
6899 (not (yes-or-no-p "Unprinted PostScript waiting; exit anyway? "))
6900 (error "Unprinted PostScript"))))
6902 (cond ((fboundp 'add-hook)
6903 (funcall 'add-hook 'kill-emacs-hook 'ps-kill-emacs-check))
6904 (kill-emacs-hook
6905 (message "Won't override existing `kill-emacs-hook'"))
6907 (setq kill-emacs-hook 'ps-kill-emacs-check)))
6910 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
6911 ;;; Sample Setup Code:
6914 ;; This stuff is for anybody that's brave enough to look this far,
6915 ;; and able to figure out how to use it. It isn't really part of
6916 ;; ps-print, but I'll leave it here in hopes it might be useful:
6918 ;; WARNING!!! The following code is *sample* code only.
6919 ;; Don't use it unless you understand what it does!
6921 ;; The key `f22' should probably be replaced by `print'. --Stef
6923 ;; A hook to bind to `rmail-mode-hook' to locally bind prsc and set the
6924 ;; `ps-left-headers' specially for mail messages.
6925 (defun ps-rmail-mode-hook ()
6926 (local-set-key [(f22)] 'ps-rmail-print-message-from-summary)
6927 (setq ps-header-lines 3
6928 ps-left-header
6929 ;; The left headers will display the message's subject, its
6930 ;; author, and the name of the folder it was in.
6931 '(ps-article-subject ps-article-author buffer-name)))
6933 ;; See `ps-gnus-print-article-from-summary'. This function does the
6934 ;; same thing for rmail.
6935 (defun ps-rmail-print-message-from-summary ()
6936 (interactive)
6937 (ps-print-message-from-summary 'rmail-summary-buffer "RMAIL"))
6939 ;; Used in `ps-rmail-print-article-from-summary',
6940 ;; `ps-gnus-print-article-from-summary' and `ps-vm-print-message-from-summary'.
6941 (defun ps-print-message-from-summary (summary-buffer summary-default)
6942 (let ((ps-buf (or (and (boundp summary-buffer)
6943 (symbol-value summary-buffer))
6944 summary-default)))
6945 (and (get-buffer ps-buf)
6946 (save-excursion
6947 (set-buffer ps-buf)
6948 (ps-spool-buffer-with-faces)))))
6950 ;; Look in an article or mail message for the Subject: line. To be
6951 ;; placed in `ps-left-headers'.
6952 (defun ps-article-subject ()
6953 (save-excursion
6954 (goto-char (point-min))
6955 (if (re-search-forward "^Subject:[ \t]+\\(.*\\)$" nil t)
6956 (buffer-substring (match-beginning 1) (match-end 1))
6957 "Subject ???")))
6959 ;; Look in an article or mail message for the From: line. Sorta-kinda
6960 ;; understands RFC-822 addresses and can pull the real name out where
6961 ;; it's provided. To be placed in `ps-left-headers'.
6962 (defun ps-article-author ()
6963 (save-excursion
6964 (goto-char (point-min))
6965 (if (re-search-forward "^From:[ \t]+\\(.*\\)$" nil t)
6966 (let ((fromstring (buffer-substring (match-beginning 1) (match-end 1))))
6967 (cond
6969 ;; Try first to match addresses that look like
6970 ;; thompson@wg2.waii.com (Jim Thompson)
6971 ((string-match ".*[ \t]+(\\(.*\\))" fromstring)
6972 (substring fromstring (match-beginning 1) (match-end 1)))
6974 ;; Next try to match addresses that look like
6975 ;; Jim Thompson <thompson@wg2.waii.com> or
6976 ;; "Jim Thompson" <thompson@wg2.waii.com>
6977 ((string-match "\\(\"?\\)\\(.*\\)\\1[ \t]+<.*>" fromstring)
6978 (substring fromstring (match-beginning 2) (match-end 2)))
6980 ;; Couldn't find a real name -- show the address instead.
6981 (t fromstring)))
6982 "From ???")))
6984 ;; A hook to bind to `gnus-article-prepare-hook'. This will set the
6985 ;; `ps-left-headers' specially for gnus articles. Unfortunately,
6986 ;; `gnus-article-mode-hook' is called only once, the first time the *Article*
6987 ;; buffer enters that mode, so it would only work for the first time
6988 ;; we ran gnus. The second time, this hook wouldn't get set up. The
6989 ;; only alternative is `gnus-article-prepare-hook'.
6990 (defun ps-gnus-article-prepare-hook ()
6991 (setq ps-header-lines 3
6992 ps-left-header
6993 ;; The left headers will display the article's subject, its
6994 ;; author, and the newsgroup it was in.
6995 '(ps-article-subject ps-article-author gnus-newsgroup-name)))
6997 ;; A hook to bind to `vm-mode-hook' to locally bind prsc and set the
6998 ;; `ps-left-headers' specially for mail messages.
6999 (defun ps-vm-mode-hook ()
7000 (local-set-key [(f22)] 'ps-vm-print-message-from-summary)
7001 (setq ps-header-lines 3
7002 ps-left-header
7003 ;; The left headers will display the message's subject, its
7004 ;; author, and the name of the folder it was in.
7005 '(ps-article-subject ps-article-author buffer-name)))
7007 ;; Every now and then I forget to switch from the *Summary* buffer to
7008 ;; the *Article* before hitting prsc, and a nicely formatted list of
7009 ;; article subjects shows up at the printer. This function, bound to
7010 ;; prsc for the gnus *Summary* buffer means I don't have to switch
7011 ;; buffers first.
7012 ;; sb: Updated for Gnus 5.
7013 (defun ps-gnus-print-article-from-summary ()
7014 (interactive)
7015 (ps-print-message-from-summary 'gnus-article-buffer "*Article*"))
7017 ;; See `ps-gnus-print-article-from-summary'. This function does the
7018 ;; same thing for vm.
7019 (defun ps-vm-print-message-from-summary ()
7020 (interactive)
7021 (ps-print-message-from-summary 'vm-mail-buffer ""))
7023 ;; A hook to bind to bind to `gnus-summary-setup-buffer' to locally bind
7024 ;; prsc.
7025 (defun ps-gnus-summary-setup ()
7026 (local-set-key [(f22)] 'ps-gnus-print-article-from-summary))
7028 ;; Look in an article or mail message for the Subject: line. To be
7029 ;; placed in `ps-left-headers'.
7030 (defun ps-info-file ()
7031 (save-excursion
7032 (goto-char (point-min))
7033 (if (re-search-forward "File:[ \t]+\\([^, \t\n]*\\)" nil t)
7034 (buffer-substring (match-beginning 1) (match-end 1))
7035 "File ???")))
7037 ;; Look in an article or mail message for the Subject: line. To be
7038 ;; placed in `ps-left-headers'.
7039 (defun ps-info-node ()
7040 (save-excursion
7041 (goto-char (point-min))
7042 (if (re-search-forward "Node:[ \t]+\\([^,\t\n]*\\)" nil t)
7043 (buffer-substring (match-beginning 1) (match-end 1))
7044 "Node ???")))
7046 (defun ps-info-mode-hook ()
7047 (setq ps-left-header
7048 ;; The left headers will display the node name and file name.
7049 '(ps-info-node ps-info-file)))
7051 ;; WARNING! The following function is a *sample* only, and is *not*
7052 ;; meant to be used as a whole unless you understand what the effects
7053 ;; will be! (In fact, this is a copy of Jim's setup for ps-print --
7054 ;; I'd be very surprised if it was useful to *anybody*, without
7055 ;; modification.)
7057 (defun ps-jts-ps-setup ()
7058 (global-set-key [(f22)] 'ps-spool-buffer-with-faces) ;f22 is prsc
7059 (global-set-key [(shift f22)] 'ps-spool-region-with-faces)
7060 (global-set-key [(control f22)] 'ps-despool)
7061 (add-hook 'gnus-article-prepare-hook 'ps-gnus-article-prepare-hook)
7062 (add-hook 'gnus-summary-mode-hook 'ps-gnus-summary-setup)
7063 (add-hook 'vm-mode-hook 'ps-vm-mode-hook)
7064 (add-hook 'vm-mode-hooks 'ps-vm-mode-hook)
7065 (add-hook 'Info-mode-hook 'ps-info-mode-hook)
7066 (setq ps-spool-duplex t
7067 ps-print-color-p nil
7068 ps-lpr-command "lpr"
7069 ps-lpr-switches '("-Jjct,duplex_long"))
7070 'ps-jts-ps-setup)
7072 ;; WARNING! The following function is a *sample* only, and is *not*
7073 ;; meant to be used as a whole unless it corresponds to your needs.
7074 ;; (In fact, this is a copy of Jack's setup for ps-print --
7075 ;; I would not be that surprised if it was useful to *anybody*,
7076 ;; without modification.)
7078 (defun ps-jack-setup ()
7079 (setq ps-print-color-p nil
7080 ps-lpr-command "lpr"
7081 ps-lpr-switches nil
7083 ps-paper-type 'a4
7084 ps-landscape-mode t
7085 ps-number-of-columns 2
7087 ps-left-margin (/ (* 72 1.0) 2.54) ; 1.0 cm
7088 ps-right-margin (/ (* 72 1.0) 2.54) ; 1.0 cm
7089 ps-inter-column (/ (* 72 1.0) 2.54) ; 1.0 cm
7090 ps-bottom-margin (/ (* 72 1.5) 2.54) ; 1.5 cm
7091 ps-top-margin (/ (* 72 1.5) 2.54) ; 1.5 cm
7092 ps-header-offset (/ (* 72 1.0) 2.54) ; 1.0 cm
7093 ps-header-line-pad .15
7094 ps-print-header t
7095 ps-print-header-frame t
7096 ps-header-lines 2
7097 ps-show-n-of-n t
7098 ps-spool-duplex nil
7100 ps-font-family 'Courier
7101 ps-font-size 5.5
7102 ps-header-font-family 'Helvetica
7103 ps-header-font-size 6
7104 ps-header-title-font-size 8)
7105 'ps-jack-setup)
7108 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
7109 ;; To make this file smaller, some commands go in a separate file.
7110 ;; But autoload them here to make the separation invisible.
7112 ;;;### (autoloads (ps-mule-begin-page ps-mule-begin-job ps-mule-encode-header-string
7113 ;;;;;; ps-mule-initialize ps-mule-plot-composition ps-mule-plot-string
7114 ;;;;;; ps-mule-set-ascii-font ps-mule-prepare-ascii-font ps-multibyte-buffer)
7115 ;;;;;; "ps-mule" "ps-mule.el" "586d0a4deeb89be9b80cc01def34481c")
7116 ;;; Generated autoloads from ps-mule.el
7118 (defvar ps-multibyte-buffer nil "\
7119 *Specifies the multi-byte buffer handling.
7121 Valid values are:
7123 nil This is the value to use the default settings;
7124 by default, this only works to print buffers with
7125 only ASCII and Latin characters. But this default
7126 setting can be changed by setting the variable
7127 `ps-mule-font-info-database-default' differently.
7128 The initial value of this variable is
7129 `ps-mule-font-info-database-latin' (see
7130 documentation).
7132 `non-latin-printer' This is the value to use when you have a Japanese
7133 or Korean PostScript printer and want to print
7134 buffer with ASCII, Latin-1, Japanese (JISX0208 and
7135 JISX0201-Kana) and Korean characters. At present,
7136 it was not tested with the Korean characters
7137 printing. If you have a korean PostScript printer,
7138 please, test it.
7140 `bdf-font' This is the value to use when you want to print
7141 buffer with BDF fonts. BDF fonts include both latin
7142 and non-latin fonts. BDF (Bitmap Distribution
7143 Format) is a format used for distributing X's font
7144 source file. BDF fonts are included in
7145 `intlfonts-1.2' which is a collection of X11 fonts
7146 for all characters supported by Emacs. In order to
7147 use this value, be sure to have installed
7148 `intlfonts-1.2' and set the variable
7149 `bdf-directory-list' appropriately (see ps-bdf.el for
7150 documentation of this variable).
7152 `bdf-font-except-latin' This is like `bdf-font' except that it uses
7153 PostScript default fonts to print ASCII and Latin-1
7154 characters. This is convenient when you want or
7155 need to use both latin and non-latin characters on
7156 the same buffer. See `ps-font-family',
7157 `ps-header-font-family' and `ps-font-info-database'.
7159 Any other value is treated as nil.")
7161 (custom-autoload 'ps-multibyte-buffer "ps-mule" t)
7163 (autoload 'ps-mule-prepare-ascii-font "ps-mule" "\
7164 Setup special ASCII font for STRING.
7165 STRING should contain only ASCII characters.
7167 \(fn STRING)" nil nil)
7169 (autoload 'ps-mule-set-ascii-font "ps-mule" "\
7170 Not documented
7172 \(fn)" nil nil)
7174 (autoload 'ps-mule-plot-string "ps-mule" "\
7175 Generate PostScript code for plotting characters in the region FROM and TO.
7177 It is assumed that all characters in this region belong to the same charset.
7179 Optional argument BG-COLOR specifies background color.
7181 Returns the value:
7183 (ENDPOS . RUN-WIDTH)
7185 Where ENDPOS is the end position of the sequence and RUN-WIDTH is the width of
7186 the sequence.
7188 \(fn FROM TO &optional BG-COLOR)" nil nil)
7190 (autoload 'ps-mule-plot-composition "ps-mule" "\
7191 Generate PostScript code for plotting composition in the region FROM and TO.
7193 It is assumed that all characters in this region belong to the same
7194 composition.
7196 Optional argument BG-COLOR specifies background color.
7198 Returns the value:
7200 (ENDPOS . RUN-WIDTH)
7202 Where ENDPOS is the end position of the sequence and RUN-WIDTH is the width of
7203 the sequence.
7205 \(fn FROM TO &optional BG-COLOR)" nil nil)
7207 (autoload 'ps-mule-initialize "ps-mule" "\
7208 Initialize global data for printing multi-byte characters.
7210 \(fn)" nil nil)
7212 (autoload 'ps-mule-encode-header-string "ps-mule" "\
7213 Generate PostScript code for ploting STRING by font FONTTAG.
7214 FONTTAG should be a string \"/h0\" or \"/h1\".
7216 \(fn STRING FONTTAG)" nil nil)
7218 (autoload 'ps-mule-begin-job "ps-mule" "\
7219 Start printing job for multi-byte chars between FROM and TO.
7220 It checks if all multi-byte characters in the region are printable or not.
7222 \(fn FROM TO)" nil nil)
7224 (autoload 'ps-mule-begin-page "ps-mule" "\
7225 Not documented
7227 \(fn)" nil nil)
7229 ;;;***
7231 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
7233 (provide 'ps-print)
7235 ;; arch-tag: fb06a585-1112-4206-885d-a57d95d50579
7236 ;;; ps-print.el ends here