Replace GPL version 2 by 3
[bpt/emacs.git] / lisp / ps-print.el
CommitLineData
652a9be9 1;;; ps-print.el --- print text from the buffer as PostScript
12d89a2e 2
0d30b337 3;; Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
830f437e 4;; 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
ef2cbb24 5
652a9be9
PJ
6;; Author: Jim Thompson (was <thompson@wg2.waii.com>)
7;; Jacques Duthen (was <duthen@cegelec-red.fr>)
e59d29d6 8;; Vinicius Jose Latorre <viniciusjl@ig.com.br>
0e80c373
VJL
9;; Kenichi Handa <handa@m17n.org> (multi-byte characters)
10;; Maintainer: Kenichi Handa <handa@m17n.org> (multi-byte characters)
e59d29d6 11;; Vinicius Jose Latorre <viniciusjl@ig.com.br>
652a9be9 12;; Keywords: wp, print, PostScript
42af7493 13;; Version: 7.2.5
502ca00a 14;; X-URL: http://www.emacswiki.org/cgi-bin/wiki/ViniciusJoseLatorre
e65df0a1 15
42af7493
VJL
16(defconst ps-print-version "7.2.5"
17 "ps-print.el, v 7.2.5 <2007/10/10 vinicius>
090be653 18
535efc38 19Vinicius's last change version -- this file may have been edited as part of
906d41a7
GM
20Emacs without changes to the version number. When reporting bugs, please also
21report the version of Emacs, if any, that ps-print was distributed with.
090be653
RS
22
23Please send all bug fixes and enhancements to
e59d29d6 24 Vinicius Jose Latorre <viniciusjl@ig.com.br>.")
ef2cbb24 25
86c10ecb 26;; This file is part of GNU Emacs.
ef2cbb24 27
319acba0
GM
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
b4aa6026 30;; Software Foundation; either version 3, or (at your option) any later
319acba0 31;; version.
ef2cbb24 32
319acba0
GM
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.
ef2cbb24 37
319acba0
GM
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
086add15 40;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
ef2cbb24 41
12d89a2e 42;;; Commentary:
ef2cbb24 43
bc0d41bd 44;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
ef2cbb24 45;;
12d89a2e 46;; About ps-print
ef2cbb24 47;; --------------
bcc0d457 48;;
319acba0
GM
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
eafa92bf
RS
51;; output. ps-print is intended for use with Emacs or XEmacs, together with a
52;; fontifying package such as font-lock or hilit.
12d89a2e 53;;
319acba0
GM
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.
87a16a06
RS
57;;
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).
62;;
bcc0d457 63;;
12d89a2e 64;; Using ps-print
ef2cbb24 65;; --------------
ef2cbb24 66;;
319acba0
GM
67;; ps-print provides eight commands for generating PostScript images of Emacs
68;; buffers:
12d89a2e
RS
69;;
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
78;;
319acba0
GM
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".
12d89a2e
RS
83;;
84;; The word "print" or "spool" in the command name determines when the
85;; PostScript image is sent to the printer:
ef2cbb24 86;;
319acba0 87;; print - The PostScript image is immediately sent to the printer;
ef2cbb24 88;;
319acba0
GM
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'.
ef2cbb24 93;;
319acba0
GM
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).
06fb6aab 99;;
319acba0
GM
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.
12d89a2e 106;;
319acba0
GM
107;; The word "buffer" or "region" in the command name determines how much of the
108;; buffer is printed:
12d89a2e
RS
109;;
110;; buffer - Print the entire buffer.
111;;
112;; region - Print just the current region.
113;;
319acba0
GM
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.
12d89a2e
RS
120;;
121;; Two ps-print- command examples:
122;;
319acba0
GM
123;; ps-print-buffer - print the entire buffer, without font,
124;; color, or underline information, and
125;; send it immediately to the printer.
12d89a2e 126;;
319acba0
GM
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.
12d89a2e
RS
131;;
132;;
133;; Invoking Ps-Print
bcc0d457 134;; -----------------
ef2cbb24 135;;
12d89a2e 136;; To print your buffer, type
ef2cbb24 137;;
12d89a2e 138;; M-x ps-print-buffer
ef2cbb24 139;;
319acba0
GM
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
12d89a2e
RS
143;;
144;; C-u M-x ps-print-buffer
145;;
319acba0
GM
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':
12d89a2e
RS
151;;
152;; C-u M-x ps-despool
153;;
319acba0
GM
154;; When invoked this way, `ps-despool' will prompt you for the name of the file
155;; to save to.
12d89a2e 156;;
319acba0
GM
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:
12d89a2e
RS
160;;
161;; (global-set-key 'f22 'ps-spool-buffer-with-faces) ;f22 is prsc
ef2cbb24
RS
162;; (global-set-key '(shift f22) 'ps-spool-region-with-faces)
163;; (global-set-key '(control f22) 'ps-despool)
164;;
12d89a2e
RS
165;;
166;; The Printer Interface
bcc0d457 167;; ---------------------
12d89a2e 168;;
319acba0
GM
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'.
87a16a06 172;;
bcc0d457
RS
173;; Make sure that they contain appropriate values for your system;
174;; see the usage notes below and the documentation of these variables.
175;;
bc0d41bd 176;; The variable `ps-printer-name' determines the name of a local printer for
d3ab8dac
KH
177;; printing PostScript files.
178;;
3556c6dd
GM
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".
183;;
319acba0
GM
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.
d3ab8dac 189;; `ps-printer-name' takes its initial value from the variable
3556c6dd
GM
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.
12d89a2e 193;;
bc0d41bd
KH
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.
198;;
8e234846
GM
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).
202;;
ef1159c2
EZ
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).
206;;
98f2fbe7 207;; If you're using Emacs for Windows 95/98/NT or MS-DOS, don't forget to
3556c6dd
GM
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.
edc9cd35 212;;
12d89a2e 213;;
bcc0d457
RS
214;; The Page Layout
215;; ---------------
12d89a2e 216;;
bcc0d457
RS
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
12d89a2e 220;;
906d41a7
GM
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'.
12d89a2e 225;;
8e234846
GM
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).
233;;
906d41a7
GM
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.
bcc0d457 236;; There is no oblique mode yet, though this is easy to do in ps.
87a16a06 237;;
319acba0
GM
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.
043620f4 242;;
906d41a7
GM
243;; The variable `ps-number-of-columns' determines the number of columns both in
244;; landscape and portrait mode.
bcc0d457 245;; You can use:
906d41a7
GM
246;; - (the standard) one column portrait mode.
247;; - (my favorite) two columns landscape mode (which spares trees).
248;; but also:
bcc0d457 249;; - one column landscape mode for files with very long lines.
906d41a7
GM
250;; - multi-column portrait or landscape mode.
251;;
319acba0
GM
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).
906d41a7
GM
256;;
257;; The `upside-down' orientation can be used in portrait or landscape mode.
12d89a2e 258;;
1fd9b7fe
GM
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).
269;;
c3d6d211
GM
270;; The variable `ps-even-or-odd-pages' specifies if it prints even/odd pages.
271;;
272;; Valid values are:
273;;
274;; nil print all pages.
275;;
4b3eb10f 276;; even-page print only even pages.
c3d6d211 277;;
4b3eb10f
GM
278;; odd-page print only odd pages.
279;;
280;; even-sheet print only even sheets.
281;;
282;; odd-sheet print only odd sheets.
c3d6d211
GM
283;;
284;; Any other value is treated as nil. The default value is nil.
285;;
4b3eb10f
GM
286;; See `ps-even-or-odd-pages' for more detailed documentation.
287;;
12d89a2e 288;;
bcc0d457
RS
289;; Horizontal layout
290;; -----------------
12d89a2e 291;;
bcc0d457
RS
292;; The horizontal layout is determined by the variables
293;; `ps-left-margin' `ps-inter-column' `ps-right-margin'
294;; as follows:
12d89a2e 295;;
bcc0d457
RS
296;; ------------------------------------------
297;; | | | | | | | |
298;; | lm | text | ic | text | ic | text | rm |
299;; | | | | | | | |
300;; ------------------------------------------
12d89a2e 301;;
bcc0d457
RS
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.
12d89a2e 305;;
12d89a2e 306;;
bcc0d457
RS
307;; Vertical layout
308;; ---------------
309;;
310;; The vertical layout is determined by the variables
319acba0 311;; `ps-bottom-margin' `ps-top-margin' `ps-header-offset' `ps-footer-offset'
bcc0d457
RS
312;; as follows:
313;;
319acba0
GM
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;; |--------| |--------| |--------| |--------|
bcc0d457
RS
331;;
332;; If `ps-print-header' is nil, `ps-header-offset' is not relevant.
319acba0 333;; If `ps-print-footer' is nil, `ps-footer-offset' is not relevant.
bcc0d457 334;; The margins represent margins in the printed paper:
319acba0
GM
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.
12d89a2e
RS
339;;
340;;
319acba0
GM
341;; Headers & Footers
342;; -----------------
12d89a2e 343;;
319acba0
GM
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:
12d89a2e
RS
349;;
350;; ps-print.el 1/21
351;; /home/jct/emacs-lisp/ps/new 94/12/31
06fb6aab 352;;
319acba0
GM
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').
12d89a2e 355;;
bcc0d457
RS
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.
360;;
319acba0
GM
361;; The variable `ps-header-frame-alist' specifies header frame properties
362;; alist. Valid frame properties are:
363;;
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").
371;;
372;; back-color Specify the background frame color (similar to
373;; fore-color). The default is 0.9 ("gray90").
374;;
375;; shadow-color Specify the shadow color (similar to fore-color).
376;; The default is 0 ("black").
377;;
378;; border-color Specify the border color (similar to fore-color).
379;; The default is 0 ("black").
380;;
381;; border-width Specify the border width.
382;; The default is 0.4.
383;;
384;; Any other property is ignored.
385;;
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).
388;;
389;; To print only one header at the top of each page, set
390;; `ps-print-only-one-header' to t.
12b88fff 391;;
8e234846
GM
392;; To switch headers, set `ps-switch-header' to:
393;;
394;; nil Never switch headers.
395;;
396;; t Always switch headers.
397;;
398;; duplex Switch headers only when duplexing is on, that is, when
399;; `ps-spool-duplex' is non-nil (see Duplex Printers).
400;;
401;; Any other value is treated as t. The default value is `duplex'.
402;;
319acba0
GM
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
bcc0d457
RS
405;; `ps-header-title-font-size' (see below).
406;;
319acba0
GM
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.
410;;
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.
414;;
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.
420;;
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 ')'.
427;;
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.
12d89a2e
RS
433;;
434;; Here's an example: say we want the left header to display the text
435;;
436;; Moe
437;; Larry
438;; Curly
439;;
440;; where we have a function to return "Moe"
441;;
442;; (defun moe-func ()
443;; "Moe")
444;;
445;; a variable specifying "Larry"
446;;
447;; (setq larry-var "Larry")
448;;
319acba0 449;; and a literal for "Curly". Here's how `ps-left-header' should be set:
12d89a2e
RS
450;;
451;; (setq ps-left-header (list 'moe-func 'larry-var "(Curly)"))
452;;
319acba0
GM
453;; Note that Curly has the PostScript string delimiters inside his quotes --
454;; those aren't misplaced lisp delimiters!
87a16a06 455;;
319acba0
GM
456;; Without them, PostScript would attempt to call the undefined function Curly,
457;; which would result in a PostScript error.
87a16a06 458;;
319acba0
GM
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.
87a16a06 461;;
bcc0d457 462;; Consider yourself warned!
12d89a2e 463;;
319acba0
GM
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.
469;;
470;; The variables `ps-print-only-one-header' and `ps-switch-header' also control
471;; the footer (The same way that control header).
472;;
473;; As a footer example, if you want to have a centered page number in the
474;; footer but without headers, set:
475;;
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}")))
484;;
12d89a2e 485;;
d3ab8dac
KH
486;; PostScript Prologue Header
487;; --------------------------
488;;
489;; It is possible to add PostScript prologue header comments besides that
490;; ps-print generates by setting the variable `ps-print-prologue-header'.
491;;
319acba0
GM
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
d3ab8dac
KH
495;; PostScript special comments, like "%%Requirements: jog\n".
496;;
497;; By default `ps-print-prologue-header' is nil.
498;;
319acba0
GM
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:
d3ab8dac
KH
503;;
504;; (setq ps-print-prologue-header
505;; "%%+ numcopies(3) jog\n%%LanguageLevel: 2\n")
506;;
319acba0
GM
507;; The duplex requirement is inserted by ps-print (see section Duplex
508;; Printers).
d3ab8dac
KH
509;;
510;; Do not forget to terminate the string with "\n".
511;;
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
516;;
66e63857
GM
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'.
520;;
319acba0
GM
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.
66e63857
GM
526;;
527;; By default `ps-user-defined-prologue' is nil.
528;;
66e63857 529;; It's strongly recommended only insert PostScript code and/or comments
319acba0
GM
530;; specific for your printing system particularities. For example, some
531;; special initialization that only your printing system needs.
66e63857
GM
532;;
533;; Do not insert code for duplex printing, n-up printing or error handler,
534;; ps-print handles this in a suitable way.
535;;
536;; For more information about PostScript, see:
537;; PostScript Language Reference Manual (2nd edition)
538;; Adobe Systems Incorporated
539;;
c3d6d211
GM
540;; As an example for `ps-user-defined-prologue' setting:
541;;
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"))
546;;
66e63857
GM
547;;
548;; PostScript Error Handler
549;; ------------------------
550;;
551;; ps-print instruments generated PostScript code with an error handler.
552;;
553;; The variable `ps-error-handler-message' specifies where the error handler
554;; message should be sent.
555;;
556;; Valid values are:
557;;
558;; none catch the error and *DON'T* send any message.
559;;
560;; paper catch the error and print on paper the error message.
561;; This is the default value.
562;;
563;; system catch the error and send back the error message to
319acba0
GM
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.
66e63857
GM
568;;
569;; paper-and-system catch the error, print on paper the error message and
570;; send back the error message to printing system.
571;;
572;; Any other value is treated as `paper'.
573;;
d3ab8dac 574;;
12d89a2e 575;; Duplex Printers
bcc0d457 576;; ---------------
12d89a2e 577;;
bc0d41bd
KH
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.
582;;
319acba0
GM
583;; The variable `ps-spool-config' specifies who is the responsible for setting
584;; duplex and page size. Valid values are:
bc0d41bd
KH
585;;
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.
589;;
590;; setpagedevice duplex and page size are configured by ps-print using the
591;; setpagedevice PostScript operator.
592;;
593;; nil duplex and page size are configured by ps-print *not* using
594;; the setpagedevice PostScript operator.
595;;
596;; Any other value is treated as nil.
597;;
598;; The default value is `lpr-switches'.
599;;
319acba0
GM
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,
bc0d41bd
KH
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.
609;;
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
319acba0
GM
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.
bc0d41bd 616;;
319acba0
GM
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.
bc0d41bd 620;;
319acba0
GM
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).
bc0d41bd 624;;
319acba0
GM
625;; The default for `ps-banner-page-when-duplexing' is nil (*don't* skip the
626;; very first page).
bc0d41bd
KH
627;;
628;;
629;; N-up Printing
630;; -------------
631;;
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.
634;;
319acba0
GM
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.
bc0d41bd
KH
637;;
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).
641;;
319acba0
GM
642;; If variable `ps-n-up-border-p' is non-nil a border is drawn around each
643;; page. The default is t.
bc0d41bd
KH
644;;
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:
648;;
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
652;;
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
656;;
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
660;;
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
664;;
55732434 665;; Any other value is treated as `left-top'.
bc0d41bd
KH
666;;
667;; The default value is left-top.
bcc0d457 668;;
06fb6aab 669;;
857686a6
RS
670;; Control And 8-bit Characters
671;; ----------------------------
672;;
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
6bdb808e 675;; sending, for example, a ^D (\004) to printer, it is sent the string "^D".
857686a6
RS
676;;
677;; Valid values for `ps-print-control-characters' are:
678;;
c82b4a75
KH
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
6bdb808e
RS
682;; octal encoding.
683;;
c82b4a75 684;; control-8-bit This is the value to use when you want an ASCII encoding of
6bdb808e
RS
685;; any control character, whether it is 7 or 8-bit.
686;; European 8-bits accented characters are printed according
687;; the current font.
688;;
c82b4a75 689;; control Only ASCII control characters have an ASCII encoding.
6bdb808e
RS
690;; European 8-bits accented characters are printed according
691;; the current font.
692;;
c82b4a75 693;; nil No ASCII encoding. Any character is printed according the
6bdb808e 694;; current font.
857686a6
RS
695;;
696;; Any other value is treated as nil.
697;;
496725ad 698;; The default is `control-8-bit'.
857686a6
RS
699;;
700;; Characters TAB, NEWLINE and FORMFEED are always treated by ps-print engine.
701;;
702;;
024ced4d
KH
703;; Printing Multi-byte Buffer
704;; --------------------------
d3ab8dac 705;;
298bfad9 706;; See ps-mule.el for documentation.
e65df0a1
KH
707;;
708;;
87a16a06
RS
709;; Line Number
710;; -----------
711;;
a18ed129
RS
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).
87a16a06 714;;
319acba0
GM
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)).
718;;
ef1159c2
EZ
719;; The variable `ps-line-number-font' specifies the font for line number.
720;; The default is "Times-Italic".
721;;
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.
724;;
319acba0
GM
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
906d41a7
GM
727;; will look like:
728;;
729;; 1 one line
730;; one line
731;; 3 one line
732;; one line
98f2fbe7 733;; 5 one line
906d41a7
GM
734;; one line
735;; ...
736;;
737;; Valid values are:
738;;
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.
742;;
319acba0
GM
743;; `zebra' specifies that only the line number of the first line in a
744;; zebra stripe is to be printed.
906d41a7
GM
745;;
746;; Any other value is treated as `zebra'.
747;; The default value is 1, so each line number is printed.
748;;
98f2fbe7
GM
749;; The variable `ps-line-number-start' specifies the starting point in the
750;; interval given by `ps-line-number-step'. For example, if
319acba0
GM
751;; `ps-line-number-step' is set to 3 and `ps-line-number-start' is set to 3,
752;; the printing will look like:
98f2fbe7
GM
753;;
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;; ...
765;;
766;; The values for `ps-line-number-start':
767;;
768;; * If `ps-line-number-step' is an integer, must be between 1 and the value
769;; of `ps-line-number-step' inclusive.
770;;
771;; * If `ps-line-number-step' is set to `zebra', must be between 1 and the
c3d6d211 772;; value of `ps-zebra-stripe-height' inclusive.
98f2fbe7 773;;
319acba0
GM
774;; The default value is 1, so the line number of the first line of each
775;; interval is printed.
98f2fbe7 776;;
87a16a06
RS
777;;
778;; Zebra Stripes
779;; -------------
780;;
319acba0
GM
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:
87a16a06
RS
783;;
784;; XXXXXXXXXXXXXXXXXXXXXXXX
785;; XXXXXXXXXXXXXXXXXXXXXXXX
535efc38
RS
786;; XXXXXXXXXXXXXXXXXXXXXXXX
787;;
87a16a06
RS
788;;
789;;
790;; XXXXXXXXXXXXXXXXXXXXXXXX
791;; XXXXXXXXXXXXXXXXXXXXXXXX
535efc38 792;; XXXXXXXXXXXXXXXXXXXXXXXX
87a16a06 793;;
06fb6aab 794;; The blocks of X's represent rectangles filled with a light gray color.
a18ed129
RS
795;; Each rectangle extends all the way across the page.
796;;
319acba0
GM
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.
8bd22fcf 800;;
01961237 801;; The variable `ps-zebra-stripes' controls whether to print zebra stripes.
a18ed129
RS
802;; Non-nil means yes, nil means no. The default is nil.
803;;
6e1b1da6
GM
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)).
bc0d41bd 809;;
2bd80d73
GM
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):
813;;
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;; -------- ----------- --------- ----------------
841;;
edf0b0c5 842;; Any other value is treated as nil.
8e234846 843;;
a18ed129 844;; See also section How Ps-Print Has A Text And/Or Image On Background.
87a16a06 845;;
87a16a06 846;;
12b88fff
RS
847;; Hooks
848;; -----
849;;
d3ab8dac 850;; ps-print has the following hook variables:
12b88fff
RS
851;;
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.
856;;
bc0d41bd
KH
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.
861;;
12b88fff 862;; `ps-print-begin-page-hook'
319acba0
GM
863;; It is evaluated on each beginning of page, except in the beginning of
864;; page that `ps-print-begin-sheet-hook' is evaluated.
12b88fff
RS
865;;
866;; `ps-print-begin-column-hook'
319acba0
GM
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
bc0d41bd 869;; `ps-print-begin-sheet-hook' is evaluated.
12b88fff
RS
870;;
871;;
872;; Font Managing
bcc0d457
RS
873;; -------------
874;;
7d8b7e8e
KH
875;; ps-print now knows rather precisely some fonts: the variable
876;; `ps-font-info-database' contains information for a list of font families
319acba0
GM
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.
06fb6aab 882;;
7d8b7e8e
KH
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.
bcc0d457 887;;
7d8b7e8e 888;; The variable `ps-font-size' determines the size (in points) of the font for
319acba0
GM
889;; ordinary text, when generating PostScript. Its value is a float or a cons
890;; of floats which has the following form:
bcc0d457 891;;
7d8b7e8e
KH
892;; (LANDSCAPE-SIZE . PORTRAIT-SIZE)
893;;
894;; Similarly, the variable `ps-header-font-family' determines which font family
895;; is to be used for text in the header.
896;;
897;; The variable `ps-header-font-size' determines the font size, in points, for
898;; text in the header (similar to `ps-font-size').
899;;
319acba0
GM
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').
bcc0d457 902;;
6bf5fb46
GM
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).
906;;
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).
910;;
911;; To get all lines with some spacing set both `ps-line-spacing' and
912;; `ps-paragraph-spacing' variables.
913;;
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.
917;;
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.
920;;
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.
319acba0
GM
927;;
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.
6bf5fb46 931;;
bcc0d457 932;;
12b88fff 933;; Adding a New Font Family
bcc0d457
RS
934;; ------------------------
935;;
319acba0
GM
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.
bcc0d457 939;;
319acba0
GM
940;; For example, assuming `Helvetica' is unknown, you first need to do the
941;; following ONLY ONCE:
bcc0d457
RS
942;;
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:
1fd9b7fe 946;; `% 3 cm 20 cm moveto 10/Courier ReportFontInfo showpage'
a18ed129 947;; - delete the leading `%' (which is the PostScript comment character)
319acba0
GM
948;; - replace in this line `Courier' by the new font (say `Helvetica') to get
949;; the line:
1fd9b7fe 950;; `3 cm 20 cm moveto 10/Helvetica ReportFontInfo showpage'
bcc0d457
RS
951;; - send this file to the printer (or to ghostscript).
952;; You should read the following on the output page:
953;;
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
956;;
957;; - Add these values to the `ps-font-info-database':
958;; (setq ps-font-info-database
12b88fff
RS
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))
bcc0d457
RS
970;; - Now you can use this font family with any size:
971;; (setq ps-font-family 'Helvetica)
319acba0
GM
972;; - if you want to use this family in another emacs session, you must put into
973;; your `~/.emacs':
bcc0d457
RS
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>))
12b88fff
RS
978;; or, use `ps-print-hook' (see section Hooks):
979;; (add-hook 'ps-print-hook
bc0d41bd
KH
980;; '(lambda ()
981;; (or (assq 'Helvetica ps-font-info-database)
982;; (setq ps-font-info-database (append ...)))))
bcc0d457
RS
983;;
984;; You can create new `mixed' font families like:
12b88fff
RS
985;; (my-mixed-family
986;; (fonts (normal . "Courier-Bold")
987;; (bold . "Helvetica")
92dc83a9 988;; (italic . "ZapfChancery-MediumItalic")
12b88fff
RS
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))
d3ab8dac 995;;
bcc0d457
RS
996;; Now you can use your new font family with any size:
997;; (setq ps-font-family 'my-mixed-family)
998;;
319acba0
GM
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.
12b88fff
RS
1004;;
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")
92dc83a9 1012;; (italic . "ZapfChancery-MediumItalic")
12b88fff
RS
1013;; (normal . "Courier-Bold"))
1014;; (avg-char-width . 6.0)
1015;; (space-width . 6.0)
1016;; (line-height . 10.55))
1017;;
1018;; Despite the note above, it is recommended that some convention about
1019;; entry order be used.
1020;;
bcc0d457
RS
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
1024;;
a18ed129 1025;; The PostScript file should be sent to YOUR PostScript printer.
319acba0
GM
1026;; If you send it to ghostscript or to another PostScript printer, you may get
1027;; slightly different results.
c3d6d211
GM
1028;; Anyway, as ghostscript fonts are autoload, you won't get much font info.
1029;;
1030;; Note also that ps-print DOESN'T download any font to your printer, instead
1031;; it uses the fonts resident in your printer.
bcc0d457
RS
1032;;
1033;;
1034;; How Ps-Print Deals With Faces
1035;; -----------------------------
12d89a2e 1036;;
319acba0
GM
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.
12d89a2e 1041;;
319acba0
GM
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'.
857686a6
RS
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:
12d89a2e 1048;;
12b88fff 1049;; (setq ps-bold-faces '(my-blue-face))
bcc0d457 1050;; (setq ps-italic-faces '(my-red-face))
857686a6 1051;; (setq ps-underlined-faces '(my-green-face))
bcc0d457 1052;;
319acba0
GM
1053;; Faces like bold-italic that are both bold and italic should go in *both*
1054;; lists.
bcc0d457 1055;;
319acba0
GM
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.
bcc0d457 1060;;
319acba0
GM
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
857686a6 1066;; `ps-always-build-face-reference' to t.
bcc0d457 1067;;
906d41a7
GM
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:
1071;;
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.
1075;;
1076;; Any other value will be treated as t.
e59d29d6 1077;; The default value is nil.
906d41a7 1078;;
bcc0d457
RS
1079;;
1080;; How Ps-Print Deals With Color
1081;; -----------------------------
1082;;
319acba0
GM
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'.
55732434 1087;; On black/white printers, colors are displayed in gray scale.
bcc0d457 1088;; To turn off color output, set `ps-print-color-p' to nil.
55732434
GM
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.
bcc0d457
RS
1091;;
1092;;
87a16a06
RS
1093;; How Ps-Print Maps Faces
1094;; -----------------------
1095;;
319acba0
GM
1096;; As ps-print uses PostScript to print buffers, it is possible to have other
1097;; attributes associated with faces. So the new attributes used by ps-print
1098;; are:
87a16a06
RS
1099;;
1100;; strikeout - like underline, but the line is in middle of text.
1101;; overline - like underline, but the line is over the text.
1102;; shadow - text will have a shadow.
1103;; box - text will be surrounded by a box.
a18ed129 1104;; outline - print characters as hollow outlines.
87a16a06 1105;;
06fb6aab 1106;; See the documentation for `ps-extend-face'.
87a16a06 1107;;
bc0d41bd
KH
1108;; Let's, for example, remap `font-lock-keyword-face' to another foreground
1109;; color and bold attribute:
87a16a06 1110;;
a18ed129 1111;; (ps-extend-face '(font-lock-keyword-face "RoyalBlue" nil bold) 'MERGE)
87a16a06 1112;;
319acba0
GM
1113;; If you want to use a new face, define it first with `defface', and then call
1114;; `ps-extend-face' to specify how to print it.
6c8f2753 1115;;
87a16a06
RS
1116;;
1117;; How Ps-Print Has A Text And/Or Image On Background
1118;; --------------------------------------------------
1119;;
d3ab8dac 1120;; ps-print can print texts and/or EPS PostScript images on background; it is
87a16a06
RS
1121;; possible to define the following text attributes: font name, font size,
1122;; initial position, angle, gray scale and pages to print.
1123;;
1124;; It has the following EPS PostScript images attributes: file name containing
1125;; the image, initial position, X and Y scales, angle and pages to print.
1126;;
1127;; See documentation for `ps-print-background-text' and
1128;; `ps-print-background-image'.
1129;;
1130;; For example, if we wish to print text "preliminary" on all pages and text
1131;; "special" on page 5 and from page 11 to page 17, we could specify:
1132;;
1133;; (setq ps-print-background-text
1134;; '(("preliminary")
1135;; ("special"
1136;; "LeftMargin" "BottomMargin PrintHeight add" ; X and Y position
1137;; ; (upper left corner)
1138;; nil nil nil
12b88fff 1139;; "PrintHeight neg PrintPageWidth atan" ; angle
87a16a06
RS
1140;; 5 (11 . 17)) ; page list
1141;; ))
1142;;
1143;; Similarly, we could print image "~/images/EPS-image1.ps" on all pages and
1144;; image "~/images/EPS-image2.ps" on page 5 and from page 11 to page 17, we
1145;; specify:
1146;;
1147;; (setq ps-print-background-image
1148;; '(("~/images/EPS-image1.ps"
1149;; "LeftMargin" "BottomMargin") ; X and Y position (lower left corner)
1150;; ("~/images/EPS-image2.ps"
319acba0 1151;; "LeftMargin" "BottomMargin PrintHeight 2 div add" ; X and Y pos.
87a16a06
RS
1152;; ; (upper left corner)
1153;; nil nil nil
1154;; 5 (11 . 17)) ; page list
1155;; ))
1156;;
1157;; If it is not possible to read (or does not exist) an image file, that file
1158;; is ignored.
1159;;
1160;; The printing order is:
1161;;
6e1b1da6
GM
1162;; 1. Print background color
1163;; 2. Print zebra stripes
1164;; 3. Print background texts that it should be on all pages
1165;; 4. Print background images that it should be on all pages
1166;; 5. Print background texts only for current page (if any)
1167;; 6. Print background images only for current page (if any)
1168;; 7. Print header
1169;; 8. Print buffer text (with faces, if specified) and line number
87a16a06
RS
1170;;
1171;;
bcc0d457
RS
1172;; Utilities
1173;; ---------
1174;;
1175;; Some tools are provided to help you customize your font setup.
1176;;
1177;; `ps-setup' returns (some part of) the current setup.
1178;;
319acba0
GM
1179;; To avoid wrapping too many lines, you may want to adjust the left and right
1180;; margins and the font size. On UN*X systems, do:
bcc0d457
RS
1181;; pr -t file | awk '{printf "%3d %s\n", length($0), $0}' | sort -r | head
1182;; to determine the longest lines of your file.
319acba0
GM
1183;; Then, the command `ps-line-lengths' will give you the correspondence between
1184;; a line length (number of characters) and the maximum font size which doesn't
1185;; wrap such a line with the current ps-print setup.
bcc0d457 1186;;
319acba0
GM
1187;; The commands `ps-nb-pages-buffer' and `ps-nb-pages-region' display the
1188;; correspondence between a number of pages and the maximum font size which
1189;; allow the number of lines of the current buffer or of its current region to
1190;; fit in this number of pages.
a18ed129
RS
1191;;
1192;; NOTE: line folding is not taken into account in this process and could
1193;; change the results.
b87c5d3d 1194;;
0a5daee5
KH
1195;; The command `ps-print-customize' activates a customization buffer for
1196;; ps-print options.
1197;;
b87c5d3d 1198;;
b87c5d3d
RS
1199;; New since version 1.5
1200;; ---------------------
b87c5d3d 1201;;
bcc0d457 1202;; Color output capability.
b87c5d3d 1203;; Automatic detection of font attributes (bold, italic).
b87c5d3d 1204;; Configurable headers with page numbers.
b87c5d3d 1205;; Slightly faster.
b87c5d3d 1206;; Support for different paper sizes.
b87c5d3d
RS
1207;; Better conformance to PostScript Document Structure Conventions.
1208;;
ef2cbb24 1209;;
bcc0d457
RS
1210;; New since version 2.8
1211;; ---------------------
1212;;
e59d29d6 1213;; [vinicius] Vinicius Jose Latorre <viniciusjl@ig.com.br>
0a5daee5 1214;;
6b61353c
KH
1215;; 20040229
1216;; `ps-time-stamp-yyyy-mm-dd', `ps-time-stamp-iso8601'
1217;;
4b81a999
GM
1218;; 20010619
1219;; `ps-time-stamp-locale-default'
1220;;
1221;; 20010530
1222;; Handle before-string and after-string overlay properties.
1223;;
319acba0
GM
1224;; 20010407
1225;; `ps-line-number-color', `ps-print-footer', `ps-footer-offset',
1226;; `ps-print-footer-frame', `ps-footer-font-family',
1227;; `ps-footer-font-size', `ps-footer-line-pad', `ps-footer-lines',
1228;; `ps-left-footer', `ps-right-footer', `ps-footer-frame-alist' and
1229;; `ps-header-frame-alist'.
1230;;
1231;; 20010328
1232;; `ps-line-spacing', `ps-paragraph-spacing', `ps-paragraph-regexp',
1233;; `ps-begin-cut-regexp' and `ps-end-cut-regexp'.
1234;;
ef1159c2
EZ
1235;; 20001122
1236;; `ps-line-number-font', `ps-line-number-font-size' and
1237;; `ps-end-with-control-d'.
1238;;
c3d6d211
GM
1239;; 20000821
1240;; `ps-even-or-odd-pages'
1241;;
1fd9b7fe
GM
1242;; 20000617
1243;; `ps-manual-feed', `ps-warn-paper-type', `ps-print-upside-down',
1244;; `ps-selected-pages', `ps-last-selected-pages',
1245;; `ps-restore-selected-pages', `ps-switch-header',
1246;; `ps-line-number-step', `ps-line-number-start',
1247;; `ps-zebra-stripe-follow' and `ps-use-face-background'.
0a5daee5 1248;;
1fd9b7fe
GM
1249;; 20000310
1250;; PostScript error handler.
1251;; `ps-user-defined-prologue' and `ps-error-handler-message'.
bc0d41bd 1252;;
df5e6194 1253;; 19991211
1fd9b7fe 1254;; `ps-print-customize'.
bc0d41bd 1255;;
df5e6194 1256;; 19990703
1fd9b7fe
GM
1257;; Better customization.
1258;; `ps-banner-page-when-duplexing' and `ps-zebra-color'.
bc0d41bd 1259;;
df5e6194 1260;; 19990513
1fd9b7fe
GM
1261;; N-up printing.
1262;; Hook: `ps-print-begin-sheet-hook'.
bc0d41bd 1263;;
edf2174f 1264;; [kenichi] 19990509 Ken'ichi Handa <handa@m17n.org>
bc0d41bd 1265;;
6b61353c 1266;; `ps-print-region-function'
bc0d41bd 1267;;
e59d29d6 1268;; [vinicius] Vinicius Jose Latorre <viniciusjl@ig.com.br>
bc0d41bd 1269;;
df5e6194 1270;; 19990301
1fd9b7fe 1271;; PostScript tumble and setpagedevice.
bc0d41bd 1272;;
df5e6194 1273;; 19980922
1fd9b7fe
GM
1274;; PostScript prologue header comment insertion.
1275;; Skip invisible text better.
d3ab8dac 1276;;
edf2174f 1277;; [kenichi] 19980819 Ken'ichi Handa <handa@m17n.org>
e65df0a1 1278;;
6b61353c 1279;; Multi-byte buffer handling.
e65df0a1 1280;;
e59d29d6 1281;; [vinicius] Vinicius Jose Latorre <viniciusjl@ig.com.br>
12b88fff 1282;;
df5e6194 1283;; 19980306
1fd9b7fe 1284;; Skip invisible text.
12b88fff 1285;;
df5e6194 1286;; 19971130
1fd9b7fe
GM
1287;; Hooks: `ps-print-hook', `ps-print-begin-page-hook' and
1288;; `ps-print-begin-column-hook'.
1289;; Put one header per page over the columns.
1290;; Better database font management.
1291;; Better control characters handling.
12b88fff 1292;;
df5e6194 1293;; 19971121
1fd9b7fe
GM
1294;; Dynamic evaluation at print time of `ps-lpr-switches'.
1295;; Handle control characters.
1296;; Face remapping.
1297;; New face attributes.
1298;; Line number.
1299;; Zebra stripes.
1300;; Text and/or image on background.
87a16a06 1301;;
df5e6194 1302;; [jack] 19960517 Jacques Duthen <duthen@cegelec-red.fr>
bcc0d457 1303;;
a18ed129 1304;; Font family and float size for text and header.
bcc0d457
RS
1305;; Landscape mode.
1306;; Multiple columns.
1307;; Tools for page setup.
1308;;
1309;;
d3ab8dac 1310;; Known bugs and limitations of ps-print
ef2cbb24 1311;; --------------------------------------
bcc0d457 1312;;
319acba0
GM
1313;; Although color printing will work in XEmacs 19.12, it doesn't work well; in
1314;; particular, bold or italic fonts don't print in the right background color.
043620f4
KH
1315;;
1316;; Invisible properties aren't correctly ignored in XEmacs 19.12.
1317;;
319acba0
GM
1318;; Automatic font-attribute detection doesn't work well, especially with
1319;; hilit19 and older versions of get-create-face. Users having problems with
1320;; auto-font detection should use the lists `ps-italic-faces', `ps-bold-faces'
1321;; and `ps-underlined-faces' and/or turn off automatic detection by setting
1322;; `ps-auto-font-detect' to nil.
00aa16af 1323;;
319acba0
GM
1324;; Automatic font-attribute detection doesn't work with XEmacs 19.12 in tty
1325;; mode; use the lists `ps-italic-faces', `ps-bold-faces' and
857686a6 1326;; `ps-underlined-faces' instead.
12d89a2e 1327;;
00aa16af 1328;; Still too slow; could use some hand-optimization.
ef2cbb24 1329;;
12d89a2e 1330;; Default background color isn't working.
ef2cbb24
RS
1331;;
1332;; Faces are always treated as opaque.
1333;;
d6d3eaab 1334;; Epoch, Lucid and Emacs 22 not supported. At all.
ef2cbb24 1335;;
06fb6aab 1336;; Fixed-pitch fonts work better for line folding, but are not required.
bcc0d457 1337;;
319acba0
GM
1338;; `ps-nb-pages-buffer' and `ps-nb-pages-region' don't take care of folding
1339;; lines.
ef2cbb24 1340;;
12d89a2e 1341;;
d3ab8dac 1342;; Things to change
bcc0d457 1343;; ----------------
ef2cbb24 1344;;
12b88fff 1345;; Avoid page break inside a paragraph.
bcc0d457 1346;; Add `ps-non-bold-faces' and `ps-non-italic-faces' (should be easy).
bcc0d457 1347;; Improve the memory management for big files (hard?).
319acba0
GM
1348;; `ps-nb-pages-buffer' and `ps-nb-pages-region' should take care of folding
1349;; lines.
ef2cbb24 1350;;
ef2cbb24 1351;;
6bf5fb46
GM
1352;; Acknowledgments
1353;; ---------------
1354;;
9586e1d3
VJL
1355;; Thanks to Michael Piotrowski <mxp@dynalabs.de> for improving the DSC
1356;; compliance of the generated PostScript.
1357;;
55732434
GM
1358;; Thanks to Adam Doppelt <adoppelt@avogadro.com> for face mapping suggestion
1359;; for black/white PostScript printers.
1360;;
319acba0
GM
1361;; Thanks to Toni Ronkko <tronkko@hytti.uku.fi> for line and paragraph spacing,
1362;; region to cut out when printing and footer suggestions.
1363;;
6bf5fb46 1364;; Thanks to Pavel Janik ml <Pavel@Janik.cz> for documentation correction.
12b88fff 1365;;
ef1159c2
EZ
1366;; Thanks to Corinne Ilvedson <cilvedson@draper.com> for line number font size
1367;; suggestion.
1368;;
c3d6d211
GM
1369;; Thanks to Gord Wait <Gord_Wait@spectrumsignal.com> for
1370;; `ps-user-defined-prologue' example setting for HP PostScript printer.
1371;;
98f2fbe7
GM
1372;; Thanks to Paul Furnanz <pfurnanz@synopsys.com> for XEmacs compatibility
1373;; suggestion for `ps-postscript-code-directory' variable.
1374;;
906d41a7
GM
1375;; Thanks to David X Callaway <dxc@xprt.net> for helping debugging PostScript
1376;; level 1 compatibility.
1377;;
6b61353c
KH
1378;; Thanks to Colin Marquardt <colin.marquardt@usa.alcatel.com> for:
1379;; - upside-down, line number step, line number start and zebra stripe
1380;; follow suggestions.
1381;; - `ps-time-stamp-yyyy-mm-dd' and `ps-time-stamp-iso8601' suggestion.
1382;; - and for XEmacs beta-tests.
906d41a7 1383;;
66e63857 1384;; Thanks to Klaus Berndl <klaus.berndl@sdm.de> for user defined PostScript
2bd80d73
GM
1385;; prologue code suggestion, for odd/even printing suggestion and for
1386;; `ps-prologue-file' enhancement.
66e63857 1387;;
edf2174f 1388;; Thanks to Ken'ichi Handa <handa@m17n.org> for multi-byte buffer handling.
915293a2
KH
1389;;
1390;; Thanks to Matthew O Persico <Matthew.Persico@lazard.com> for line number on
1391;; empty columns.
1392;;
1393;; Thanks to Theodore Jump <tjump@cais.com> for adjust PostScript code order on
1394;; last page.
1395;;
6bdb808e
RS
1396;; Thanks to Roland Ducournau <ducour@lirmm.fr> for
1397;; `ps-print-control-characters' variable documentation.
1398;;
12b88fff
RS
1399;; Thanks to Marcus G Daniels <marcus@cathcart.sysc.pdx.edu> for a better
1400;; database font management.
1401;;
1402;; Thanks to Martin Boyer <gamin@videotron.ca> for some ideas on putting one
6bdb808e
RS
1403;; header per page over the columns and correct line numbers when printing a
1404;; region.
12b88fff
RS
1405;;
1406;; Thanks to Steven L Baur <steve@miranova.com> for dynamic evaluation at
1407;; print time of `ps-lpr-switches'.
1408;;
6bdb808e
RS
1409;; Thanks to Kevin Rodgers <kevinr@ihs.com> for handling control characters
1410;; (his code was severely modified, but the main idea was kept).
1411;;
12b88fff
RS
1412;; Thanks to some suggestions on:
1413;; * Face color map: Marco Melgazzi <marco@techie.com>
1414;; * XEmacs compatibility: William J. Henney <will@astrosmo.unam.mx>
984e7bd9 1415;; * Check `ps-paper-type': Sudhakar Frederick <sfrederi@asc.corp.mot.com>
12b88fff 1416;;
319acba0
GM
1417;; Thanks to Jacques Duthen <duthen@cegelec-red.fr> (Jack) for version 3.4 I
1418;; started from. [vinicius]
857686a6 1419;;
319acba0 1420;; Thanks to Jim Thompson <?@?> for the 2.8 version I started from. [jack]
bcc0d457 1421;;
319acba0
GM
1422;; Thanks to Kevin Rodgers <kevinr@ihs.com> for adding support for color and
1423;; the invisible property.
ef2cbb24 1424;;
319acba0
GM
1425;; Thanks to Avishai Yacobi, avishaiy@mcil.comm.mot.com, for writing the
1426;; initial port to Emacs 19. His code is no longer part of ps-print, but his
1427;; work is still appreciated.
ef2cbb24 1428;;
9586e1d3 1429;; Thanks to Remi Houdaille and Michel Train <michel@metasoft.fdn.org> for
319acba0
GM
1430;; adding underline support. Their code also is no longer part of ps-print,
1431;; but their efforts are not forgotten.
12d89a2e 1432;;
319acba0
GM
1433;; Thanks also to all of you who mailed code to add features to ps-print;
1434;; although I didn't use your code, I still appreciate your sharing it with me.
12d89a2e
RS
1435;;
1436;; Thanks to all who mailed comments, encouragement, and criticism.
319acba0
GM
1437;; Thanks also to all who responded to my survey; I had too many responses to
1438;; reply to them all, but I greatly appreciate your interest.
12d89a2e
RS
1439;;
1440;; Jim
bc0d41bd 1441;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
ef2cbb24
RS
1442
1443;;; Code:
1444
55732434 1445
b6d0ac87 1446(require 'lpr)
68e684a0 1447
c97a3f22 1448
b6d0ac87
VJL
1449(or (featurep 'lisp-float-type)
1450 (error "`ps-print' requires floating point support"))
68e684a0 1451
eafa92bf 1452
9e53076e 1453(let ((case-fold-search t))
f8246027 1454 (cond ((featurep 'xemacs))
9e53076e
VJL
1455 ((string-match "Lucid" emacs-version)
1456 (error "`ps-print' doesn't support Lucid"))
1457 ((string-match "Epoch" emacs-version)
1458 (error "`ps-print' doesn't support Epoch"))
1459 (t
1460 (unless (and (boundp 'emacs-major-version)
1461 (>= emacs-major-version 22))
1462 (error "`ps-print' only supports Emacs 22 and higher")))))
eafa92bf 1463
68e684a0 1464
b6d0ac87
VJL
1465(defconst ps-windows-system
1466 (memq system-type '(emx win32 w32 mswindows ms-dos windows-nt)))
1467(defconst ps-lp-system
1468 (memq system-type '(usg-unix-v dgux hpux irix)))
1469
1470
c97a3f22
VJL
1471;; Load XEmacs/Emacs definitions
1472(eval-and-compile (require 'ps-def))
906d41a7
GM
1473
1474
ef2cbb24 1475;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
12d89a2e
RS
1476;; User Variables:
1477
0a5daee5 1478
bcc0d457
RS
1479;;; Interface to the command system
1480
bc0d41bd 1481(defgroup postscript nil
b0fa9df7 1482 "PostScript Group."
bc0d41bd 1483 :tag "PostScript"
b6d0ac87 1484 :version "20"
bc0d41bd
KH
1485 :group 'emacs)
1486
e0af0d3e 1487(defgroup ps-print nil
b0fa9df7 1488 "PostScript generator for Emacs."
3556c6dd 1489 :link '(emacs-library-link :tag "Source Lisp File" "ps-print.el")
e0af0d3e 1490 :prefix "ps-"
b6d0ac87 1491 :version "20"
bc0d41bd
KH
1492 :group 'wp
1493 :group 'postscript)
e0af0d3e
RS
1494
1495(defgroup ps-print-horizontal nil
b0fa9df7 1496 "Horizontal page layout."
e0af0d3e
RS
1497 :prefix "ps-"
1498 :tag "Horizontal"
b6d0ac87 1499 :version "20"
e0af0d3e
RS
1500 :group 'ps-print)
1501
1502(defgroup ps-print-vertical nil
b0fa9df7 1503 "Vertical page layout."
e0af0d3e
RS
1504 :prefix "ps-"
1505 :tag "Vertical"
b6d0ac87 1506 :version "20"
e0af0d3e
RS
1507 :group 'ps-print)
1508
6e1b1da6 1509(defgroup ps-print-headers nil
b0fa9df7 1510 "Headers & footers layout."
e0af0d3e 1511 :prefix "ps-"
319acba0 1512 :tag "Header & Footer"
b6d0ac87 1513 :version "20"
e0af0d3e
RS
1514 :group 'ps-print)
1515
1516(defgroup ps-print-font nil
b0fa9df7 1517 "Fonts customization."
e0af0d3e
RS
1518 :prefix "ps-"
1519 :tag "Font"
b6d0ac87 1520 :version "20"
e0af0d3e
RS
1521 :group 'ps-print)
1522
1523(defgroup ps-print-color nil
b0fa9df7 1524 "Color customization."
e0af0d3e
RS
1525 :prefix "ps-"
1526 :tag "Color"
b6d0ac87 1527 :version "20"
e0af0d3e
RS
1528 :group 'ps-print)
1529
1530(defgroup ps-print-face nil
b0fa9df7 1531 "Faces customization."
e0af0d3e
RS
1532 :prefix "ps-"
1533 :tag "PS Faces"
b6d0ac87 1534 :version "20"
e0af0d3e
RS
1535 :group 'ps-print
1536 :group 'faces)
1537
bc0d41bd 1538(defgroup ps-print-n-up nil
b0fa9df7 1539 "N-up customization."
bc0d41bd
KH
1540 :prefix "ps-"
1541 :tag "N-Up"
b6d0ac87 1542 :version "20"
bc0d41bd
KH
1543 :group 'ps-print)
1544
1545(defgroup ps-print-zebra nil
b0fa9df7 1546 "Zebra customization."
bc0d41bd
KH
1547 :prefix "ps-"
1548 :tag "Zebra"
b6d0ac87 1549 :version "20"
bc0d41bd
KH
1550 :group 'ps-print)
1551
1552(defgroup ps-print-background nil
b0fa9df7 1553 "Background customization."
bc0d41bd
KH
1554 :prefix "ps-"
1555 :tag "Background"
b6d0ac87 1556 :version "20"
bc0d41bd
KH
1557 :group 'ps-print)
1558
1426742b 1559(defgroup ps-print-printer '((lpr custom-group))
b0fa9df7 1560 "Printer customization."
bc0d41bd
KH
1561 :prefix "ps-"
1562 :tag "Printer"
b6d0ac87 1563 :version "20"
bc0d41bd
KH
1564 :group 'ps-print)
1565
1566(defgroup ps-print-page nil
b0fa9df7 1567 "Page customization."
bc0d41bd
KH
1568 :prefix "ps-"
1569 :tag "Page"
b6d0ac87 1570 :version "20"
bc0d41bd
KH
1571 :group 'ps-print)
1572
6e1b1da6 1573(defgroup ps-print-miscellany nil
b0fa9df7 1574 "Miscellany customization."
6e1b1da6
GM
1575 :prefix "ps-"
1576 :tag "Miscellany"
b6d0ac87 1577 :version "20"
6e1b1da6
GM
1578 :group 'ps-print)
1579
bc0d41bd 1580
66e63857
GM
1581(defcustom ps-error-handler-message 'paper
1582 "*Specify where the error handler message should be sent.
1583
1584Valid values are:
1585
1586 `none' catch the error and *DON'T* send any message.
1587
1588 `paper' catch the error and print on paper the error message.
1589
1590 `system' catch the error and send back the error message to
6e1b1da6
GM
1591 printing system. This is useful only if printing system
1592 send back an email reporting the error, or if there is
1593 some other alternative way to report back the error from
1594 the system to you.
66e63857
GM
1595
1596 `paper-and-system' catch the error, print on paper the error message and
1597 send back the error message to printing system.
1598
1599Any other value is treated as `paper'."
8e234846
GM
1600 :type '(choice :menu-tag "Error Handler Message"
1601 :tag "Error Handler Message"
66e63857
GM
1602 (const none) (const paper)
1603 (const system) (const paper-and-system))
b6d0ac87 1604 :version "20"
6e1b1da6 1605 :group 'ps-print-miscellany)
66e63857
GM
1606
1607(defcustom ps-user-defined-prologue nil
1608 "*User defined PostScript prologue code inserted before all prologue code.
1609
1610`ps-user-defined-prologue' may be a string or a symbol function which returns a
1611string. Note that this string is inserted after `ps-adobe-tag' and PostScript
1612prologue comments, and before ps-print PostScript prologue code section. That
1613is, this string is inserted after error handler initialization and before
1614ps-print settings.
1615
66e63857
GM
1616It's strongly recommended only insert PostScript code and/or comments specific
1617for your printing system particularities. For example, some special
1618initialization that only your printing system needs.
1619
319acba0
GM
1620Do not insert code for duplex printing, n-up printing or error handler,
1621ps-print handles this in a suitable way.
66e63857
GM
1622
1623For more information about PostScript, see:
1624 PostScript Language Reference Manual (2nd edition)
c3d6d211
GM
1625 Adobe Systems Incorporated
1626
1627As an example for `ps-user-defined-prologue' setting:
1628
1629 ;; Setting for HP PostScript printer
1630 (setq ps-user-defined-prologue
1631 (concat \"<</DeferredMediaSelection true /PageSize [612 792] \"
2285bf9d 1632 \"/MediaPosition 2 /MediaType (Plain)>> setpagedevice\"))"
8e234846
GM
1633 :type '(choice :menu-tag "User Defined Prologue"
1634 :tag "User Defined Prologue"
98f2fbe7 1635 (const :tag "none" nil) string symbol)
b6d0ac87 1636 :version "20"
6e1b1da6 1637 :group 'ps-print-miscellany)
66e63857 1638
d3ab8dac
KH
1639(defcustom ps-print-prologue-header nil
1640 "*PostScript prologue header comments besides that ps-print generates.
1641
319acba0
GM
1642`ps-print-prologue-header' may be a string or a symbol function which returns a
1643string. Note that this string is inserted on PostScript prologue header
1644section which is used to define some document characteristic through PostScript
1645special comments, like \"%%Requirements: jog\\n\".
d3ab8dac
KH
1646
1647ps-print always inserts the %%Requirements: comment, so if you need to insert
1648more requirements put them first in `ps-print-prologue-header' using the
1649\"%%+\" comment. For example, if you need to set numcopies to 3 and jog on
1650requirements and set %%LanguageLevel: to 2, do:
1651
2285bf9d 1652 (setq ps-print-prologue-header
e59d29d6 1653 \"%%+ numcopies(3) jog\\n%%LanguageLevel: 2\\n\")
d3ab8dac
KH
1654
1655The duplex requirement is inserted by ps-print (see `ps-spool-duplex').
1656
1657Do not forget to terminate the string with \"\\n\".
1658
1659For more information about PostScript document comments, see:
1660 PostScript Language Reference Manual (2nd edition)
1661 Adobe Systems Incorporated
1662 Appendix G: Document Structuring Conventions -- Version 3.0"
8e234846
GM
1663 :type '(choice :menu-tag "Prologue Header"
1664 :tag "Prologue Header"
98f2fbe7 1665 (const :tag "none" nil) string symbol)
b6d0ac87 1666 :version "20"
6e1b1da6 1667 :group 'ps-print-miscellany)
d3ab8dac 1668
298bfad9 1669(defcustom ps-printer-name (and (boundp 'printer-name)
2bd80d73 1670 (symbol-value 'printer-name))
03820514
RS
1671 "*The name of a local printer for printing PostScript files.
1672
3556c6dd
GM
1673On Unix-like systems, a string value should be a name understood by lpr's -P
1674option; a value of nil means use the value of `printer-name' instead.
1675
1676On MS-DOS and MS-Windows systems, a string value is taken as the name of the
1677printer device or port to which PostScript files are written, provided
1678`ps-lpr-command' is \"\". By default it is the same as `printer-name'; typical
1679non-default settings would be \"LPT1\" to \"LPT3\" for parallel printers, or
7bb054a5 1680\"COM1\" to \"COM4\" or \"AUX\" for serial printers, or \"\\\\hostname\\printer\"
3556c6dd
GM
1681for a shared network printer. You can also set it to a name of a file, in
1682which case the output gets appended to that file. \(Note that `ps-print'
1683package already has facilities for printing to a file, so you might as well use
1684them instead of changing the setting of this variable.\) If you want to
1685silently discard the printed output, set this to \"NUL\".
1686
1687Set to t, if the utility given by `ps-lpr-command' needs an empty printer name.
1688
1689Any other value is treated as t, that is, an empty printer name.
1690
1691See also `ps-printer-name-option' for documentation."
8e234846
GM
1692 :type '(choice :menu-tag "Printer Name"
1693 :tag "Printer Name"
1694 (const :tag "Same as printer-name" nil)
3556c6dd 1695 (const :tag "No Printer Name" t)
6e1b1da6 1696 (file :tag "Print to file")
8e234846 1697 (string :tag "Pipe to ps-lpr-command"))
b6d0ac87 1698 :version "20"
bc0d41bd 1699 :group 'ps-print-printer)
03820514 1700
3556c6dd
GM
1701(defcustom ps-printer-name-option
1702 (cond (ps-windows-system
1703 "/D:")
1704 (ps-lp-system
1705 "-d")
1706 (t
1707 "-P" ))
1708 "*Option for `ps-printer-name' variable (see it).
1709
2285bf9d
RS
1710On Unix-like systems, if `lpr' is in use, this should be the string
1711\"-P\"; if `lp' is in use, this should be the string \"-d\".
3556c6dd 1712
2285bf9d 1713On MS-DOS and MS-Windows systems, if `print' is in use, this should be
3556c6dd
GM
1714the string \"/D:\".
1715
2285bf9d 1716For any other printing utility, see its documentation.
3556c6dd 1717
c90a10fa
RS
1718Set this to \"\" or nil, if the utility given by `ps-lpr-command'
1719needs an empty printer name option--that is, pass the printer name
1720with no special option preceding it.
3556c6dd 1721
c90a10fa 1722Any value that is not a string is treated as nil.
3556c6dd
GM
1723
1724This variable is used only when `ps-printer-name' is a non-empty string."
1725 :type '(choice :menu-tag "Printer Name Option"
1726 :tag "Printer Name Option"
1727 (const :tag "None" nil)
1728 (string :tag "Option"))
6bf5fb46 1729 :version "21.1"
3556c6dd
GM
1730 :group 'ps-print-printer)
1731
e0af0d3e 1732(defcustom ps-lpr-command lpr-command
52cf535f
AI
1733 "*Name of program for printing a PostScript file.
1734
3556c6dd
GM
1735On MS-DOS and MS-Windows systems, if the value is an empty string then Emacs
1736will write directly to the printer port named by `ps-printer-name'. The
1737programs `print' and `nprint' (the standard print programs on Windows NT and
1738Novell Netware respectively) are handled specially, using `ps-printer-name' as
1739the destination for output; any other program is treated like `lpr' except that
1740an explicit filename is given as the last argument."
e0af0d3e 1741 :type 'string
b6d0ac87 1742 :version "20"
bc0d41bd 1743 :group 'ps-print-printer)
e0af0d3e
RS
1744
1745(defcustom ps-lpr-switches lpr-switches
1746 "*A list of extra switches to pass to `ps-lpr-command'."
edc9cd35 1747 :type '(repeat :tag "PostScript lpr Switches"
ef1159c2
EZ
1748 (choice :menu-tag "PostScript lpr Switch"
1749 :tag "PostScript lpr Switch"
1750 string symbol (repeat sexp)))
b6d0ac87 1751 :version "20"
bc0d41bd 1752 :group 'ps-print-printer)
12d89a2e 1753
52cf535f 1754(defcustom ps-print-region-function nil
bc0d41bd 1755 "*Specify a function to print the region on a PostScript printer.
319acba0
GM
1756See definition of `call-process-region' for calling conventions. The fourth
1757and the sixth arguments are both nil."
942a1d58 1758 :type '(choice (const nil) function)
b6d0ac87 1759 :version "20"
bc0d41bd 1760 :group 'ps-print-printer)
52cf535f 1761
8e234846
GM
1762(defcustom ps-manual-feed nil
1763 "*Non-nil means the printer will manually feed paper.
1764
1765If it's nil, automatic feeding takes place."
1766 :type 'boolean
b6d0ac87 1767 :version "20"
8e234846
GM
1768 :group 'ps-print-printer)
1769
bd7a2e26 1770(defcustom ps-end-with-control-d (and ps-windows-system t)
ef1159c2 1771 "*Non-nil means insert C-d at end of PostScript file generated."
6bf5fb46 1772 :version "21.1"
ef1159c2 1773 :type 'boolean
b6d0ac87 1774 :version "20"
ef1159c2
EZ
1775 :group 'ps-print-printer)
1776
bcc0d457 1777;;; Page layout
12d89a2e 1778
bcc0d457
RS
1779;; All page dimensions are in PostScript points.
1780;; 1 inch == 2.54 cm == 72 points
1781;; 1 cm == (/ 1 2.54) inch == (/ 72 2.54) points
1782
1783;; Letter 8.5 inch x 11.0 inch
1784;; Legal 8.5 inch x 14.0 inch
1785;; A4 8.26 inch x 11.69 inch = 21.0 cm x 29.7 cm
1786
1787;; LetterSmall 7.68 inch x 10.16 inch
1788;; Tabloid 11.0 inch x 17.0 inch
1789;; Ledger 17.0 inch x 11.0 inch
1790;; Statement 5.5 inch x 8.5 inch
1791;; Executive 7.5 inch x 10.0 inch
1792;; A3 11.69 inch x 16.5 inch = 29.7 cm x 42.0 cm
1793;; A4Small 7.47 inch x 10.85 inch
1794;; B4 10.125 inch x 14.33 inch
1795;; B5 7.16 inch x 10.125 inch
1796
c90a10fa 1797;;;###autoload
e0af0d3e 1798(defcustom ps-page-dimensions-database
bc0d41bd
KH
1799 (list (list 'a4 (/ (* 72 21.0) 2.54) (/ (* 72 29.7) 2.54) "A4")
1800 (list 'a3 (/ (* 72 29.7) 2.54) (/ (* 72 42.0) 2.54) "A3")
1801 (list 'letter (* 72 8.5) (* 72 11.0) "Letter")
1802 (list 'legal (* 72 8.5) (* 72 14.0) "Legal")
1803 (list 'letter-small (* 72 7.68) (* 72 10.16) "LetterSmall")
1804 (list 'tabloid (* 72 11.0) (* 72 17.0) "Tabloid")
1805 (list 'ledger (* 72 17.0) (* 72 11.0) "Ledger")
1806 (list 'statement (* 72 5.5) (* 72 8.5) "Statement")
1807 (list 'executive (* 72 7.5) (* 72 10.0) "Executive")
1808 (list 'a4small (* 72 7.47) (* 72 10.85) "A4Small")
1809 (list 'b4 (* 72 10.125) (* 72 14.33) "B4")
1810 (list 'b5 (* 72 7.16) (* 72 10.125) "B5"))
1811 "*List associating a symbolic paper type to its width, height and doc media.
1812See `ps-paper-type'."
e0af0d3e
RS
1813 :type '(repeat (list :tag "Paper Type"
1814 (symbol :tag "Name")
1815 (number :tag "Width")
bc0d41bd
KH
1816 (number :tag "Height")
1817 (string :tag "Media")))
b6d0ac87 1818 :version "20"
bc0d41bd 1819 :group 'ps-print-page)
e0af0d3e 1820
857686a6 1821;;;###autoload
e0af0d3e 1822(defcustom ps-paper-type 'letter
bc0d41bd 1823 "*Specify the size of paper to format for.
090be653 1824Should be one of the paper types defined in `ps-page-dimensions-database', for
e0af0d3e
RS
1825example `letter', `legal' or `a4'."
1826 :type '(symbol :validate (lambda (wid)
87a16a06
RS
1827 (if (assq (widget-value wid)
1828 ps-page-dimensions-database)
e0af0d3e
RS
1829 nil
1830 (widget-put wid :error "Unknown paper size")
1831 wid)))
b6d0ac87 1832 :version "20"
bc0d41bd 1833 :group 'ps-print-page)
e0af0d3e 1834
8e234846
GM
1835(defcustom ps-warn-paper-type t
1836 "*Non-nil means give an error if paper size is not equal to `ps-paper-type'.
1837
1838It's used when `ps-spool-config' is set to `setpagedevice'."
1839 :type 'boolean
b6d0ac87 1840 :version "20"
8e234846
GM
1841 :group 'ps-print-page)
1842
87a16a06 1843(defcustom ps-landscape-mode nil
e0af0d3e
RS
1844 "*Non-nil means print in landscape mode."
1845 :type 'boolean
b6d0ac87 1846 :version "20"
bc0d41bd 1847 :group 'ps-print-page)
e0af0d3e 1848
906d41a7 1849(defcustom ps-print-upside-down nil
2285bf9d 1850 "*Non-nil means print upside-down (that is, rotated by 180 degrees)."
906d41a7 1851 :type 'boolean
319acba0 1852 :version "21.1"
906d41a7
GM
1853 :group 'ps-print-page)
1854
1fd9b7fe
GM
1855(defcustom ps-selected-pages nil
1856 "*Specify which pages to print.
1857
2285bf9d 1858If nil, print all pages.
1fd9b7fe 1859
2285bf9d 1860If a list, the lists element may be an integer or a cons cell (FROM . TO)
1fd9b7fe 1861designating FROM page to TO page; any invalid element is ignored, that is, an
e59d29d6 1862integer lesser than one or if FROM is greater than TO.
1fd9b7fe
GM
1863
1864Otherwise, it's treated as nil.
1865
2285bf9d
RS
1866After ps-print processing `ps-selected-pages' is set to nil. But the
1867latest `ps-selected-pages' is saved in `ps-last-selected-pages' (which
1868see). So you can restore the latest selected pages by using
1869`ps-last-selected-pages' or with the `ps-restore-selected-pages'
1870command (which see).
ea0c615d
GM
1871
1872See also `ps-even-or-odd-pages'."
1fd9b7fe
GM
1873 :type '(repeat :tag "Selected Pages"
1874 (radio :tag "Page"
1875 (integer :tag "Number")
1876 (cons :tag "Range"
1877 (integer :tag "From")
1878 (integer :tag "To"))))
b6d0ac87 1879 :version "20"
1fd9b7fe
GM
1880 :group 'ps-print-page)
1881
c3d6d211
GM
1882(defcustom ps-even-or-odd-pages nil
1883 "*Specify if it prints even/odd pages.
1884
1885Valid values are:
1886
1887 nil print all pages.
1888
4b3eb10f
GM
1889 `even-page' print only even pages.
1890
1891 `odd-page' print only odd pages.
1892
1893 `even-sheet' print only even sheets.
bd7a2e26
GM
1894 That is, if `ps-n-up-printing' is 1, it behaves as `even-page';
1895 but for values greater than 1, it'll print only the even sheet
1896 of paper.
c3d6d211 1897
4b3eb10f 1898 `odd-sheet' print only odd sheets.
bd7a2e26
GM
1899 That is, if `ps-n-up-printing' is 1, it behaves as `odd-page';
1900 but for values greater than 1, it'll print only the odd sheet
1901 of paper.
c3d6d211 1902
ea0c615d
GM
1903Any other value is treated as nil.
1904
1905If you set `ps-selected-pages' (see it for documentation), first the pages are
1906filtered by `ps-selected-pages' and then by `ps-even-or-odd-pages'. For
1907example, if we have:
1908
4b3eb10f 1909 (setq ps-selected-pages '(1 4 (6 . 10) (12 . 16) 20))
ea0c615d 1910
4b3eb10f 1911Combining with `ps-even-or-odd-pages' and `ps-n-up-printing', we have:
ea0c615d 1912
4b3eb10f 1913`ps-n-up-printing' = 1:
ea0c615d 1914 `ps-even-or-odd-pages' PAGES PRINTED
4b3eb10f
GM
1915 nil 1, 4, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 20
1916 even-page 4, 6, 8, 10, 12, 14, 16, 20
1917 odd-page 1, 7, 9, 13, 15
1918 even-sheet 4, 6, 8, 10, 12, 14, 16, 20
1919 odd-sheet 1, 7, 9, 13, 15
1920
1921`ps-n-up-printing' = 2:
1922 `ps-even-or-odd-pages' PAGES PRINTED
1923 nil 1/4, 6/7, 8/9, 10/12, 13/14, 15/16, 20
1924 even-page 4/6, 8/10, 12/14, 16/20
1925 odd-page 1/7, 9/13, 15
1926 even-sheet 6/7, 10/12, 15/16
1927 odd-sheet 1/4, 8/9, 13/14, 20
1928
1929So even-page/odd-page are about page parity and even-sheet/odd-sheet are about
1930sheet parity."
c3d6d211
GM
1931 :type '(choice :menu-tag "Print Even/Odd Pages"
1932 :tag "Print Even/Odd Pages"
1933 (const :tag "All Pages" nil)
4b3eb10f
GM
1934 (const :tag "Only Even Pages" even-page)
1935 (const :tag "Only Odd Pages" odd-page)
1936 (const :tag "Only Even Sheets" even-sheet)
1937 (const :tag "Only Odd Sheets" odd-sheet))
b6d0ac87 1938 :version "20"
c3d6d211
GM
1939 :group 'ps-print-page)
1940
857686a6 1941(defcustom ps-print-control-characters 'control-8-bit
bc0d41bd
KH
1942 "*Specify the printable form for control and 8-bit characters.
1943That is, instead of sending, for example, a ^D (\\004) to printer,
915293a2 1944it is sent the string \"^D\".
6bdb808e 1945
857686a6 1946Valid values are:
6bdb808e 1947
984e7bd9 1948 `8-bit' This is the value to use when you want an ASCII encoding of
d3ab8dac
KH
1949 any control or non-ASCII character. Control characters are
1950 encoded as \"^D\", and non-ASCII characters have an
1951 octal encoding.
6bdb808e 1952
984e7bd9 1953 `control-8-bit' This is the value to use when you want an ASCII encoding of
d3ab8dac
KH
1954 any control character, whether it is 7 or 8-bit.
1955 European 8-bits accented characters are printed according
1956 the current font.
6bdb808e 1957
c82b4a75 1958 `control' Only ASCII control characters have an ASCII encoding.
d3ab8dac
KH
1959 European 8-bits accented characters are printed according
1960 the current font.
6bdb808e 1961
984e7bd9 1962 nil No ASCII encoding. Any character is printed according the
d3ab8dac 1963 current font.
6bdb808e 1964
857686a6 1965Any other value is treated as nil."
8e234846
GM
1966 :type '(choice :menu-tag "Control Char"
1967 :tag "Control Char"
bc0d41bd 1968 (const 8-bit) (const control-8-bit)
edc9cd35 1969 (const control) (const :tag "nil" nil))
b6d0ac87 1970 :version "20"
6e1b1da6 1971 :group 'ps-print-miscellany)
857686a6 1972
bc0d41bd
KH
1973(defcustom ps-n-up-printing 1
1974 "*Specify the number of pages per sheet paper."
1975 :type '(integer
1976 :tag "N Up Printing"
1977 :validate
1978 (lambda (wid)
1979 (if (and (< 0 (widget-value wid))
1980 (<= (widget-value wid) 100))
1981 nil
1982 (widget-put
1983 wid :error
1984 "Number of pages per sheet paper must be between 1 and 100.")
1985 wid)))
b6d0ac87 1986 :version "20"
bc0d41bd
KH
1987 :group 'ps-print-n-up)
1988
1989(defcustom ps-n-up-margin (/ (* 72 1.0) 2.54) ; 1 cm
1990 "*Specify the margin in points between the sheet border and n-up printing."
1991 :type 'number
b6d0ac87 1992 :version "20"
bc0d41bd
KH
1993 :group 'ps-print-n-up)
1994
1995(defcustom ps-n-up-border-p t
1996 "*Non-nil means a border is drawn around each page."
1997 :type 'boolean
b6d0ac87 1998 :version "20"
bc0d41bd
KH
1999 :group 'ps-print-n-up)
2000
2001(defcustom ps-n-up-filling 'left-top
2002 "*Specify how page matrix is filled on each sheet of paper.
2003
2004Following are the valid values for `ps-n-up-filling' with a filling example
2005using a 3x4 page matrix:
2006
2007 `left-top' 1 2 3 4 `left-bottom' 9 10 11 12
2008 5 6 7 8 5 6 7 8
2009 9 10 11 12 1 2 3 4
2010
2011 `right-top' 4 3 2 1 `right-bottom' 12 11 10 9
2012 8 7 6 5 8 7 6 5
2013 12 11 10 9 4 3 2 1
2014
2015 `top-left' 1 4 7 10 `bottom-left' 3 6 9 12
2016 2 5 8 11 2 5 8 11
2017 3 6 9 12 1 4 7 10
2018
2019 `top-right' 10 7 4 1 `bottom-right' 12 9 6 3
2020 11 8 5 2 11 8 5 2
2021 12 9 6 3 10 7 4 1
2022
2023Any other value is treated as `left-top'."
8e234846
GM
2024 :type '(choice :menu-tag "N-Up Filling"
2025 :tag "N-Up Filling"
bc0d41bd
KH
2026 (const left-top) (const left-bottom)
2027 (const right-top) (const right-bottom)
2028 (const top-left) (const bottom-left)
2029 (const top-right) (const bottom-right))
b6d0ac87 2030 :version "20"
bc0d41bd
KH
2031 :group 'ps-print-n-up)
2032
e0af0d3e 2033(defcustom ps-number-of-columns (if ps-landscape-mode 2 1)
2285bf9d 2034 "*Specify the number of columns."
87a16a06 2035 :type 'number
b6d0ac87 2036 :version "20"
6e1b1da6 2037 :group 'ps-print-miscellany)
87a16a06 2038
535efc38 2039(defcustom ps-zebra-stripes nil
87a16a06 2040 "*Non-nil means print zebra stripes.
6e1b1da6 2041See also documentation for `ps-zebra-stripe-height' and `ps-zebra-color'."
87a16a06 2042 :type 'boolean
b6d0ac87 2043 :version "20"
bc0d41bd 2044 :group 'ps-print-zebra)
87a16a06 2045
535efc38 2046(defcustom ps-zebra-stripe-height 3
87a16a06 2047 "*Number of zebra stripe lines.
6e1b1da6 2048See also documentation for `ps-zebra-stripes' and `ps-zebra-color'."
87a16a06 2049 :type 'number
b6d0ac87 2050 :version "20"
bc0d41bd
KH
2051 :group 'ps-print-zebra)
2052
6e1b1da6
GM
2053(defcustom ps-zebra-color 0.95
2054 "*Zebra stripe gray scale or RGB color.
bc0d41bd 2055See also documentation for `ps-zebra-stripes' and `ps-zebra-stripe-height'."
8e234846
GM
2056 :type '(choice :menu-tag "Zebra Gray/Color"
2057 :tag "Zebra Gray/Color"
6e1b1da6
GM
2058 (number :tag "Gray Scale" :value 0.95)
2059 (string :tag "Color Name" :value "gray95")
2060 (list :tag "RGB Color" :value (0.95 0.95 0.95)
2061 (number :tag "Red")
2062 (number :tag "Green")
2063 (number :tag "Blue")))
b6d0ac87 2064 :version "20"
bc0d41bd 2065 :group 'ps-print-zebra)
87a16a06 2066
8e234846 2067(defcustom ps-zebra-stripe-follow nil
2bd80d73
GM
2068 "*Specify how zebra stripes continue on next page.
2069
2070Visually, valid values are (the character `+' at right of each column indicates
2071that a line is printed):
2072
2073 `nil' `follow' `full' `full-follow'
2074 Current Page -------- ----------- --------- ----------------
2075 1 XXXXX + 1 XXXXXXXX + 1 XXXXXX + 1 XXXXXXXXXXXXX +
2076 2 XXXXX + 2 XXXXXXXX + 2 XXXXXX + 2 XXXXXXXXXXXXX +
2077 3 XXXXX + 3 XXXXXXXX + 3 XXXXXX + 3 XXXXXXXXXXXXX +
2078 4 + 4 + 4 + 4 +
2079 5 + 5 + 5 + 5 +
2080 6 + 6 + 6 + 6 +
2081 7 XXXXX + 7 XXXXXXXX + 7 XXXXXX + 7 XXXXXXXXXXXXX +
2082 8 XXXXX + 8 XXXXXXXX + 8 XXXXXX + 8 XXXXXXXXXXXXX +
2083 9 XXXXX + 9 XXXXXXXX + 9 XXXXXX + 9 XXXXXXXXXXXXX +
2084 10 + 10 +
2085 11 + 11 +
2086 -------- ----------- --------- ----------------
2087 Next Page -------- ----------- --------- ----------------
2088 12 XXXXX + 12 + 10 XXXXXX + 10 +
2089 13 XXXXX + 13 XXXXXXXX + 11 XXXXXX + 11 +
2090 14 XXXXX + 14 XXXXXXXX + 12 XXXXXX + 12 +
2091 15 + 15 XXXXXXXX + 13 + 13 XXXXXXXXXXXXX +
2092 16 + 16 + 14 + 14 XXXXXXXXXXXXX +
2093 17 + 17 + 15 + 15 XXXXXXXXXXXXX +
2094 18 XXXXX + 18 + 16 XXXXXX + 16 +
2095 19 XXXXX + 19 XXXXXXXX + 17 XXXXXX + 17 +
2096 20 XXXXX + 20 XXXXXXXX + 18 XXXXXX + 18 +
2097 21 + 21 XXXXXXXX +
2098 22 + 22 +
2099 -------- ----------- --------- ----------------
2100
d730a5ac 2101Any other value is treated as nil."
2bd80d73
GM
2102 :type '(choice :menu-tag "Zebra Stripe Follow"
2103 :tag "Zebra Stripe Follow"
2104 (const :tag "Always Restart" nil)
2105 (const :tag "Continue on Next Page" follow)
2106 (const :tag "Print Only Full Stripe" full)
2107 (const :tag "Continue on Full Stripe" full-follow))
b6d0ac87 2108 :version "20"
8e234846
GM
2109 :group 'ps-print-zebra)
2110
87a16a06
RS
2111(defcustom ps-line-number nil
2112 "*Non-nil means print line number."
2113 :type 'boolean
b6d0ac87 2114 :version "20"
6e1b1da6 2115 :group 'ps-print-miscellany)
87a16a06 2116
906d41a7
GM
2117(defcustom ps-line-number-step 1
2118 "*Specify the interval that line number is printed.
2119
2120For example, `ps-line-number-step' is set to 2, the printing will look like:
2121
2122 1 one line
2123 one line
2124 3 one line
2125 one line
98f2fbe7 2126 5 one line
906d41a7
GM
2127 one line
2128 ...
2129
2130Valid values are:
2131
2132 integer an integer that specifies the interval that line number is
2133 printed. If it's lesser than or equal to zero, it's used the
2134 value 1.
2135
319acba0
GM
2136 `zebra' specifies that only the line number of the first line in a
2137 zebra stripe is to be printed.
906d41a7
GM
2138
2139Any other value is treated as `zebra'."
8e234846
GM
2140 :type '(choice :menu-tag "Line Number Step"
2141 :tag "Line Number Step"
906d41a7
GM
2142 (integer :tag "Step Interval")
2143 (const :tag "Synchronize Zebra" zebra))
b6d0ac87 2144 :version "20"
906d41a7
GM
2145 :group 'ps-print-miscellany)
2146
98f2fbe7
GM
2147(defcustom ps-line-number-start 1
2148 "*Specify the starting point in the interval given by `ps-line-number-step'.
2149
3556c6dd
GM
2150For example, if `ps-line-number-step' is set to 3 and `ps-line-number-start' is
2151set to 3, the printing will look like:
98f2fbe7
GM
2152
2153 one line
2154 one line
2155 3 one line
2156 one line
2157 one line
2158 6 one line
2159 one line
2160 one line
2161 9 one line
2162 one line
2163 ...
2164
2165The values for `ps-line-number-start':
2166
319acba0
GM
2167 * If `ps-line-number-step' is an integer, must be between 1 and the value of
2168 `ps-line-number-step' inclusive.
98f2fbe7
GM
2169
2170 * If `ps-line-number-step' is set to `zebra', must be between 1 and the
2171 value of `ps-zebra-strip-height' inclusive. Use this combination if you
2172 wish that line number be relative to zebra stripes."
2173 :type '(integer :tag "Start Step Interval")
b6d0ac87 2174 :version "20"
98f2fbe7
GM
2175 :group 'ps-print-miscellany)
2176
87a16a06
RS
2177(defcustom ps-print-background-image nil
2178 "*EPS image list to be printed on background.
2179
2180The elements are:
2181
2182 (FILENAME X Y XSCALE YSCALE ROTATION PAGES...)
2183
2184FILENAME is a file name which contains an EPS image or some PostScript
2185programming like EPS.
2186FILENAME is ignored, if it doesn't exist or is read protected.
2187
2188X and Y are relative positions on paper to put the image.
01cdabc6 2189If X and Y are nil, the image is centered on paper.
87a16a06
RS
2190
2191XSCALE and YSCALE are scale factor to be applied to image before printing.
2192If XSCALE and YSCALE are nil, the original size is used.
2193
2194ROTATION is the image rotation angle; if nil, the default is 0.
2195
2196PAGES designates the page to print background image.
319acba0
GM
2197PAGES may be a number or a cons cell (FROM . TO) designating FROM page to TO
2198page.
87a16a06
RS
2199If PAGES is nil, print background image on all pages.
2200
319acba0 2201X, Y, XSCALE, YSCALE and ROTATION may be a floating point number, an integer
2285bf9d 2202number or a string. If it is a string, the string should contain PostScript
319acba0 2203programming that returns a float or integer value.
87a16a06
RS
2204
2205For example, if you wish to print an EPS image on all pages do:
2206
2207 '((\"~/images/EPS-image.ps\"))"
98f2fbe7
GM
2208 :type '(repeat
2209 (list
2210 (file :tag "EPS File")
2211 (choice :tag "X" (const :tag "default" nil) number string)
2212 (choice :tag "Y" (const :tag "default" nil) number string)
2213 (choice :tag "X Scale" (const :tag "default" nil) number string)
2214 (choice :tag "Y Scale" (const :tag "default" nil) number string)
2215 (choice :tag "Rotation" (const :tag "default" nil) number string)
2216 (repeat :tag "Pages" :inline t
2217 (radio (integer :tag "Page")
2218 (cons :tag "Range"
2219 (integer :tag "From")
2220 (integer :tag "To"))))))
b6d0ac87 2221 :version "20"
bc0d41bd 2222 :group 'ps-print-background)
87a16a06
RS
2223
2224(defcustom ps-print-background-text nil
2225 "*Text list to be printed on background.
2226
2227The elements are:
2228
2229 (STRING X Y FONT FONTSIZE GRAY ROTATION PAGES...)
2230
2231STRING is the text to be printed on background.
2232
2233X and Y are positions on paper to put the text.
2234If X and Y are nil, the text is positioned at lower left corner.
2235
2236FONT is a font name to be used on printing the text.
2237If nil, \"Times-Roman\" is used.
2238
2239FONTSIZE is font size to be used, if nil, 200 is used.
2240
2241GRAY is the text gray factor (should be very light like 0.8).
2242If nil, the default is 0.85.
2243
319acba0
GM
2244ROTATION is the text rotation angle; if nil, the angle is given by the diagonal
2245from lower left corner to upper right corner.
87a16a06
RS
2246
2247PAGES designates the page to print background text.
319acba0
GM
2248PAGES may be a number or a cons cell (FROM . TO) designating FROM page to TO
2249page.
87a16a06
RS
2250If PAGES is nil, print background text on all pages.
2251
319acba0 2252X, Y, FONTSIZE, GRAY and ROTATION may be a floating point number, an integer
2285bf9d 2253number or a string. If it is a string, the string should contain PostScript
319acba0 2254programming that returns a float or integer value.
87a16a06
RS
2255
2256For example, if you wish to print text \"Preliminary\" on all pages do:
2257
2258 '((\"Preliminary\"))"
98f2fbe7
GM
2259 :type '(repeat
2260 (list
2261 (string :tag "Text")
2262 (choice :tag "X" (const :tag "default" nil) number string)
2263 (choice :tag "Y" (const :tag "default" nil) number string)
2264 (choice :tag "Font" (const :tag "default" nil) string)
2265 (choice :tag "Fontsize" (const :tag "default" nil) number string)
2266 (choice :tag "Gray" (const :tag "default" nil) number string)
2267 (choice :tag "Rotation" (const :tag "default" nil) number string)
2268 (repeat :tag "Pages" :inline t
2269 (radio (integer :tag "Page")
2270 (cons :tag "Range"
2271 (integer :tag "From")
2272 (integer :tag "To"))))))
b6d0ac87 2273 :version "20"
bc0d41bd 2274 :group 'ps-print-background)
bcc0d457
RS
2275
2276;;; Horizontal layout
2277
2278;; ------------------------------------------
2279;; | | | | | | | |
2280;; | lm | text | ic | text | ic | text | rm |
2281;; | | | | | | | |
2282;; ------------------------------------------
2283
e0af0d3e
RS
2284(defcustom ps-left-margin (/ (* 72 2.0) 2.54) ; 2 cm
2285 "*Left margin in points (1/72 inch)."
2286 :type 'number
b6d0ac87 2287 :version "20"
e0af0d3e 2288 :group 'ps-print-horizontal)
bcc0d457 2289
e0af0d3e
RS
2290(defcustom ps-right-margin (/ (* 72 2.0) 2.54) ; 2 cm
2291 "*Right margin in points (1/72 inch)."
2292 :type 'number
b6d0ac87 2293 :version "20"
e0af0d3e 2294 :group 'ps-print-horizontal)
bcc0d457 2295
e0af0d3e
RS
2296(defcustom ps-inter-column (/ (* 72 2.0) 2.54) ; 2 cm
2297 "*Horizontal space between columns in points (1/72 inch)."
2298 :type 'number
b6d0ac87 2299 :version "20"
e0af0d3e 2300 :group 'ps-print-horizontal)
bcc0d457
RS
2301
2302;;; Vertical layout
2303
2304;; |--------|
2305;; | tm |
2306;; |--------|
2307;; | header |
2308;; |--------|
2309;; | ho |
2310;; |--------|
2311;; | text |
2312;; |--------|
2313;; | bm |
2314;; |--------|
2315
e0af0d3e
RS
2316(defcustom ps-bottom-margin (/ (* 72 1.5) 2.54) ; 1.5 cm
2317 "*Bottom margin in points (1/72 inch)."
2318 :type 'number
b6d0ac87 2319 :version "20"
e0af0d3e 2320 :group 'ps-print-vertical)
bcc0d457 2321
e0af0d3e
RS
2322(defcustom ps-top-margin (/ (* 72 1.5) 2.54) ; 1.5 cm
2323 "*Top margin in points (1/72 inch)."
2324 :type 'number
b6d0ac87 2325 :version "20"
e0af0d3e 2326 :group 'ps-print-vertical)
bcc0d457 2327
e0af0d3e
RS
2328(defcustom ps-header-offset (/ (* 72 1.0) 2.54) ; 1.0 cm
2329 "*Vertical space in points (1/72 inch) between the main text and the header."
2330 :type 'number
b6d0ac87 2331 :version "20"
e0af0d3e 2332 :group 'ps-print-vertical)
bcc0d457 2333
e0af0d3e 2334(defcustom ps-header-line-pad 0.15
2285bf9d
RS
2335 "*Portion of a header title line height to insert.
2336The insertion is done between the header frame and the text it contains,
2337both in the vertical and horizontal directions."
e0af0d3e 2338 :type 'number
b6d0ac87 2339 :version "20"
e0af0d3e 2340 :group 'ps-print-vertical)
bcc0d457 2341
319acba0
GM
2342(defcustom ps-footer-offset (/ (* 72 1.0) 2.54) ; 1.0 cm
2343 "*Vertical space in points (1/72 inch) between the main text and the footer."
2344 :type 'number
b6d0ac87 2345 :version "20"
319acba0
GM
2346 :group 'ps-print-vertical)
2347
2348(defcustom ps-footer-line-pad 0.15
2285bf9d
RS
2349 "*Portion of a footer title line height to insert.
2350The insertion is done between the footer frame and the text it contains,
2351both in the vertical and horizontal directions."
319acba0 2352 :type 'number
b6d0ac87 2353 :version "20"
319acba0
GM
2354 :group 'ps-print-vertical)
2355
2356;;; Header/Footer setup
12d89a2e 2357
e0af0d3e 2358(defcustom ps-print-header t
86c10ecb 2359 "*Non-nil means print a header at the top of each page.
319acba0
GM
2360By default, the header displays the buffer name, page number, and, if the
2361buffer is visiting a file, the file's directory. Headers are customizable by
2362changing variables `ps-left-header' and `ps-right-header'."
12b88fff 2363 :type 'boolean
b6d0ac87 2364 :version "20"
6e1b1da6 2365 :group 'ps-print-headers)
12b88fff 2366
e0af0d3e
RS
2367(defcustom ps-print-header-frame t
2368 "*Non-nil means draw a gaudy frame around the header."
2369 :type 'boolean
b6d0ac87 2370 :version "20"
6e1b1da6 2371 :group 'ps-print-headers)
e0af0d3e 2372
319acba0 2373(defcustom ps-header-frame-alist
efa89c1f 2374 '((fore-color . 0.0)
319acba0
GM
2375 (back-color . 0.9)
2376 (border-width . 0.4)
efa89c1f
GM
2377 (border-color . 0.0)
2378 (shadow-color . 0.0))
319acba0
GM
2379 "*Specify header frame properties alist.
2380
2381Valid frame properties are:
2382
2383 `fore-color' Specify the foreground frame color.
2384 It should be a float number between 0.0 (black color)
2385 and 1.0 (white color), a string which is a color name,
2386 or a list of 3 float numbers which corresponds to the
2387 Red Green Blue color scale, each float number between
2388 0.0 (dark color) and 1.0 (bright color).
2389
2390 `back-color' Specify the background frame color (similar to
2391 `fore-color').
2392
2393 `shadow-color' Specify the shadow color (similar to `fore-color').
2394
2395 `border-color' Specify the border color (similar to `fore-color').
2396
2397 `border-width' Specify the border width.
2398
2399Any other property is ignored.
2400
2401Don't change this alist directly, instead use customization, or `ps-value',
2402`ps-get', `ps-put' and `ps-del' functions (see them for documentation)."
2403 :version "21.1"
2404 :type '(repeat
2405 (choice :menu-tag "Header Frame Element"
2406 :tag ""
2407 (cons :tag "Foreground Color" :format "%v"
2408 (const :format "" fore-color)
2409 (choice :menu-tag "Foreground Color"
2410 :tag "Foreground Color"
efa89c1f 2411 (number :tag "Gray Scale" :value 0.0)
319acba0 2412 (string :tag "Color Name" :value "black")
efa89c1f 2413 (list :tag "RGB Color" :value (0.0 0.0 0.0)
319acba0
GM
2414 (number :tag "Red")
2415 (number :tag "Green")
2416 (number :tag "Blue"))))
2417 (cons :tag "Background Color" :format "%v"
2418 (const :format "" back-color)
2419 (choice :menu-tag "Background Color"
2420 :tag "Background Color"
2421 (number :tag "Gray Scale" :value 0.9)
2422 (string :tag "Color Name" :value "gray90")
2423 (list :tag "RGB Color" :value (0.9 0.9 0.9)
2424 (number :tag "Red")
2425 (number :tag "Green")
2426 (number :tag "Blue"))))
2427 (cons :tag "Border Width" :format "%v"
2428 (const :format "" border-width)
2429 (number :tag "Border Width" :value 0.4))
2430 (cons :tag "Border Color" :format "%v"
2431 (const :format "" border-color)
2432 (choice :menu-tag "Border Color"
2433 :tag "Border Color"
efa89c1f 2434 (number :tag "Gray Scale" :value 0.0)
319acba0 2435 (string :tag "Color Name" :value "black")
efa89c1f 2436 (list :tag "RGB Color" :value (0.0 0.0 0.0)
319acba0
GM
2437 (number :tag "Red")
2438 (number :tag "Green")
2439 (number :tag "Blue"))))
2440 (cons :tag "Shadow Color" :format "%v"
2441 (const :format "" shadow-color)
2442 (choice :menu-tag "Shadow Color"
2443 :tag "Shadow Color"
efa89c1f 2444 (number :tag "Gray Scale" :value 0.0)
319acba0 2445 (string :tag "Color Name" :value "black")
efa89c1f 2446 (list :tag "RGB Color" :value (0.0 0.0 0.0)
319acba0
GM
2447 (number :tag "Red")
2448 (number :tag "Green")
2449 (number :tag "Blue"))))))
b6d0ac87 2450 :version "20"
319acba0
GM
2451 :group 'ps-print-headers)
2452
e0af0d3e 2453(defcustom ps-header-lines 2
8bd22fcf 2454 "*Number of lines to display in page header, when generating PostScript."
e0af0d3e 2455 :type 'integer
b6d0ac87 2456 :version "20"
6e1b1da6 2457 :group 'ps-print-headers)
bcc0d457 2458
319acba0
GM
2459(defcustom ps-print-footer nil
2460 "*Non-nil means print a footer at the bottom of each page.
2461By default, the footer displays page number.
2462Footers are customizable by changing variables `ps-left-footer' and
2463`ps-right-footer'."
319acba0 2464 :type 'boolean
b6d0ac87 2465 :version "21.1"
319acba0
GM
2466 :group 'ps-print-headers)
2467
2468(defcustom ps-print-footer-frame t
2469 "*Non-nil means draw a gaudy frame around the footer."
319acba0 2470 :type 'boolean
b6d0ac87 2471 :version "21.1"
319acba0
GM
2472 :group 'ps-print-headers)
2473
2474(defcustom ps-footer-frame-alist
efa89c1f 2475 '((fore-color . 0.0)
319acba0
GM
2476 (back-color . 0.9)
2477 (border-width . 0.4)
efa89c1f
GM
2478 (border-color . 0.0)
2479 (shadow-color . 0.0))
319acba0
GM
2480 "*Specify footer frame properties alist.
2481
2482Don't change this alist directly, instead use customization, or `ps-value',
2483`ps-get', `ps-put' and `ps-del' functions (see them for documentation).
2484
2485See also `ps-header-frame-alist' for documentation."
319acba0
GM
2486 :type '(repeat
2487 (choice :menu-tag "Header Frame Element"
2488 :tag ""
2489 (cons :tag "Foreground Color" :format "%v"
2490 (const :format "" fore-color)
2491 (choice :menu-tag "Foreground Color"
2492 :tag "Foreground Color"
efa89c1f 2493 (number :tag "Gray Scale" :value 0.0)
319acba0 2494 (string :tag "Color Name" :value "black")
efa89c1f 2495 (list :tag "RGB Color" :value (0.0 0.0 0.0)
319acba0
GM
2496 (number :tag "Red")
2497 (number :tag "Green")
2498 (number :tag "Blue"))))
2499 (cons :tag "Background Color" :format "%v"
2500 (const :format "" back-color)
2501 (choice :menu-tag "Background Color"
2502 :tag "Background Color"
2503 (number :tag "Gray Scale" :value 0.9)
2504 (string :tag "Color Name" :value "gray90")
2505 (list :tag "RGB Color" :value (0.9 0.9 0.9)
2506 (number :tag "Red")
2507 (number :tag "Green")
2508 (number :tag "Blue"))))
2509 (cons :tag "Border Width" :format "%v"
2510 (const :format "" border-width)
2511 (number :tag "Border Width" :value 0.4))
2512 (cons :tag "Border Color" :format "%v"
2513 (const :format "" border-color)
2514 (choice :menu-tag "Border Color"
2515 :tag "Border Color"
efa89c1f 2516 (number :tag "Gray Scale" :value 0.0)
319acba0 2517 (string :tag "Color Name" :value "black")
efa89c1f 2518 (list :tag "RGB Color" :value (0.0 0.0 0.0)
319acba0
GM
2519 (number :tag "Red")
2520 (number :tag "Green")
2521 (number :tag "Blue"))))
2522 (cons :tag "Shadow Color" :format "%v"
2523 (const :format "" shadow-color)
2524 (choice :menu-tag "Shadow Color"
2525 :tag "Shadow Color"
efa89c1f 2526 (number :tag "Gray Scale" :value 0.0)
319acba0 2527 (string :tag "Color Name" :value "black")
efa89c1f 2528 (list :tag "RGB Color" :value (0.0 0.0 0.0)
319acba0
GM
2529 (number :tag "Red")
2530 (number :tag "Green")
2531 (number :tag "Blue"))))))
b6d0ac87 2532 :version "21.1"
319acba0
GM
2533 :group 'ps-print-headers)
2534
2535(defcustom ps-footer-lines 2
2536 "*Number of lines to display in page footer, when generating PostScript."
319acba0 2537 :type 'integer
b6d0ac87 2538 :version "21.1"
319acba0
GM
2539 :group 'ps-print-headers)
2540
2541(defcustom ps-print-only-one-header nil
2542 "*Non-nil means print only one header/footer at the top/bottom of each page.
2543This is useful when printing more than one column, so it is possible to have
2544only one header/footer over all columns or one header/footer per column.
2545See also `ps-print-header' and `ps-print-footer'."
2546 :type 'boolean
b6d0ac87 2547 :version "20"
319acba0
GM
2548 :group 'ps-print-headers)
2549
8e234846 2550(defcustom ps-switch-header 'duplex
319acba0 2551 "*Specify if headers/footers are switched or not.
8e234846
GM
2552
2553Valid values are:
2554
319acba0 2555nil Never switch headers/footers.
8e234846 2556
319acba0 2557t Always switch headers/footers.
8e234846 2558
319acba0 2559duplex Switch headers/footers only when duplexing is on, that is, when
8e234846
GM
2560 `ps-spool-duplex' is non-nil.
2561
319acba0
GM
2562Any other value is treated as t.
2563
2564See also `ps-print-header' and `ps-print-footer'."
2565 :type '(choice :menu-tag "Switch Header/Footer"
2566 :tag "Switch Header/Footer"
8e234846
GM
2567 (const :tag "Never Switch" nil)
2568 (const :tag "Always Switch" t)
2569 (const :tag "Switch When Duplexing" duplex))
b6d0ac87 2570 :version "20"
8e234846
GM
2571 :group 'ps-print-headers)
2572
e0af0d3e 2573(defcustom ps-show-n-of-n t
00aa16af 2574 "*Non-nil means show page numbers as N/M, meaning page N of M.
8bd22fcf 2575NOTE: page numbers are displayed as part of headers,
6e1b1da6 2576 see variable `ps-print-header'."
e0af0d3e 2577 :type 'boolean
b6d0ac87 2578 :version "20"
6e1b1da6 2579 :group 'ps-print-headers)
12d89a2e 2580
edc9cd35 2581(defcustom ps-spool-config
906d41a7 2582 (if ps-windows-system
edc9cd35
GM
2583 nil
2584 'lpr-switches)
319acba0 2585 "*Specify who is responsible for setting duplex and page size.
bc0d41bd
KH
2586
2587Valid values are:
2588
2589 `lpr-switches' duplex and page size are configured by `ps-lpr-switches'.
2590 Don't forget to set `ps-lpr-switches' to select duplex
2591 printing for your printer.
2592
2593 `setpagedevice' duplex and page size are configured by ps-print using the
2594 setpagedevice PostScript operator.
2595
2596 nil duplex and page size are configured by ps-print *not* using
2597 the setpagedevice PostScript operator.
2598
2599Any other value is treated as nil.
2600
2601WARNING: The setpagedevice PostScript operator affects ghostview utility when
2602 viewing file generated using landscape. Also on some printers,
2603 setpagedevice affects zebra stripes; on other printers, setpagedevice
2604 affects the left margin.
2605 Besides all that, if your printer does not have the paper size
2606 specified by setpagedevice, your printing will be aborted.
2607 So, if you need to use setpagedevice, set `ps-spool-config' to
2608 `setpagedevice', generate a test file and send it to your printer; if
2285bf9d 2609 the printed file isn't OK, set `ps-spool-config' to nil."
8e234846
GM
2610 :type '(choice :menu-tag "Spool Config"
2611 :tag "Spool Config"
bc0d41bd 2612 (const lpr-switches) (const setpagedevice)
edc9cd35 2613 (const :tag "nil" nil))
b6d0ac87 2614 :version "20"
6e1b1da6 2615 :group 'ps-print-headers)
bc0d41bd
KH
2616
2617(defcustom ps-spool-duplex nil ; Not many people have duplex printers,
2618 ; so default to nil.
2619 "*Non-nil generates PostScript for a two-sided printer.
2620For a duplex printer, the `ps-spool-*' and `ps-print-*' commands will insert
2621blank pages as needed between print jobs so that the next buffer printed will
2622start on the right page. Also, if headers are turned on, the headers will be
2623reversed on duplex printers so that the page numbers fall to the left on
0a5daee5
KH
2624even-numbered pages.
2625
2626See also `ps-spool-tumble'."
bc0d41bd 2627 :type 'boolean
b6d0ac87 2628 :version "20"
6e1b1da6 2629 :group 'ps-print-headers)
bc0d41bd
KH
2630
2631(defcustom ps-spool-tumble nil
2632 "*Specify how the page images on opposite sides of a sheet are oriented.
319acba0
GM
2633If `ps-spool-tumble' is nil, produces output suitable for binding on the left
2634or right. If `ps-spool-tumble' is non-nil, produces output suitable for
2635binding at the top or bottom.
bc0d41bd
KH
2636
2637It has effect only when `ps-spool-duplex' is non-nil."
e0af0d3e 2638 :type 'boolean
b6d0ac87 2639 :version "20"
6e1b1da6 2640 :group 'ps-print-headers)
bcc0d457
RS
2641
2642;;; Fonts
2643
e0af0d3e 2644(defcustom ps-font-info-database
bcc0d457 2645 '((Courier ; the family key
12b88fff
RS
2646 (fonts (normal . "Courier")
2647 (bold . "Courier-Bold")
2648 (italic . "Courier-Oblique")
2649 (bold-italic . "Courier-BoldOblique"))
2650 (size . 10.0)
2651 (line-height . 10.55)
2652 (space-width . 6.0)
2653 (avg-char-width . 6.0))
bcc0d457 2654 (Helvetica ; the family key
12b88fff
RS
2655 (fonts (normal . "Helvetica")
2656 (bold . "Helvetica-Bold")
2657 (italic . "Helvetica-Oblique")
2658 (bold-italic . "Helvetica-BoldOblique"))
2659 (size . 10.0)
2660 (line-height . 11.56)
2661 (space-width . 2.78)
2662 (avg-char-width . 5.09243))
bcc0d457 2663 (Times
12b88fff
RS
2664 (fonts (normal . "Times-Roman")
2665 (bold . "Times-Bold")
2666 (italic . "Times-Italic")
2667 (bold-italic . "Times-BoldItalic"))
2668 (size . 10.0)
2669 (line-height . 11.0)
2670 (space-width . 2.5)
334cc3b7 2671 (avg-char-width . 4.71432))
bcc0d457 2672 (Palatino
12b88fff
RS
2673 (fonts (normal . "Palatino-Roman")
2674 (bold . "Palatino-Bold")
2675 (italic . "Palatino-Italic")
2676 (bold-italic . "Palatino-BoldItalic"))
2677 (size . 10.0)
2678 (line-height . 12.1)
2679 (space-width . 2.5)
2680 (avg-char-width . 5.08676))
bcc0d457 2681 (Helvetica-Narrow
12b88fff
RS
2682 (fonts (normal . "Helvetica-Narrow")
2683 (bold . "Helvetica-Narrow-Bold")
2684 (italic . "Helvetica-Narrow-Oblique")
2685 (bold-italic . "Helvetica-Narrow-BoldOblique"))
2686 (size . 10.0)
2687 (line-height . 11.56)
2688 (space-width . 2.2796)
2689 (avg-char-width . 4.17579))
bcc0d457 2690 (NewCenturySchlbk
12b88fff
RS
2691 (fonts (normal . "NewCenturySchlbk-Roman")
2692 (bold . "NewCenturySchlbk-Bold")
2693 (italic . "NewCenturySchlbk-Italic")
2694 (bold-italic . "NewCenturySchlbk-BoldItalic"))
2695 (size . 10.0)
334cc3b7 2696 (line-height . 12.15)
12b88fff
RS
2697 (space-width . 2.78)
2698 (avg-char-width . 5.31162))
bcc0d457
RS
2699 ;; got no bold for the next ones
2700 (AvantGarde-Book
12b88fff
RS
2701 (fonts (normal . "AvantGarde-Book")
2702 (italic . "AvantGarde-BookOblique"))
2703 (size . 10.0)
2704 (line-height . 11.77)
2705 (space-width . 2.77)
2706 (avg-char-width . 5.45189))
bcc0d457 2707 (AvantGarde-Demi
12b88fff
RS
2708 (fonts (normal . "AvantGarde-Demi")
2709 (italic . "AvantGarde-DemiOblique"))
2710 (size . 10.0)
2711 (line-height . 12.72)
2712 (space-width . 2.8)
2713 (avg-char-width . 5.51351))
bcc0d457 2714 (Bookman-Demi
12b88fff
RS
2715 (fonts (normal . "Bookman-Demi")
2716 (italic . "Bookman-DemiItalic"))
2717 (size . 10.0)
2718 (line-height . 11.77)
2719 (space-width . 3.4)
2720 (avg-char-width . 6.05946))
bcc0d457 2721 (Bookman-Light
12b88fff
RS
2722 (fonts (normal . "Bookman-Light")
2723 (italic . "Bookman-LightItalic"))
2724 (size . 10.0)
2725 (line-height . 11.79)
2726 (space-width . 3.2)
2727 (avg-char-width . 5.67027))
bcc0d457
RS
2728 ;; got no bold and no italic for the next ones
2729 (Symbol
12b88fff
RS
2730 (fonts (normal . "Symbol"))
2731 (size . 10.0)
2732 (line-height . 13.03)
2733 (space-width . 2.5)
2734 (avg-char-width . 3.24324))
bcc0d457 2735 (Zapf-Dingbats
12b88fff
RS
2736 (fonts (normal . "Zapf-Dingbats"))
2737 (size . 10.0)
2738 (line-height . 9.63)
2739 (space-width . 2.78)
2740 (avg-char-width . 2.78))
92dc83a9
KH
2741 (ZapfChancery-MediumItalic
2742 (fonts (normal . "ZapfChancery-MediumItalic"))
2743 (size . 10.0)
2744 (line-height . 11.45)
2745 (space-width . 2.2)
2746 (avg-char-width . 4.10811))
2747 ;; We keep this wrong entry name (but with correct font name) for
2748 ;; backward compatibility.
bcc0d457 2749 (Zapf-Chancery-MediumItalic
92dc83a9 2750 (fonts (normal . "ZapfChancery-MediumItalic"))
12b88fff
RS
2751 (size . 10.0)
2752 (line-height . 11.45)
2753 (space-width . 2.2)
2754 (avg-char-width . 4.10811))
87a16a06 2755 )
2285bf9d
RS
2756 "*Font info database.
2757Each element comprises: font family (the key), name, bold, italic, bold-italic,
bcc0d457
RS
2758reference size, line height, space width, average character width.
2759To get the info for another specific font (say Helvetica), do the following:
2760- create a new buffer
2761- generate the PostScript image to a file (C-u M-x ps-print-buffer)
319acba0
GM
2762- open this file and delete the leading `%' (which is the PostScript comment
2763 character) from the line
1fd9b7fe 2764 `% 3 cm 20 cm moveto 10/Courier ReportFontInfo showpage'
bcc0d457 2765 to get the line
1fd9b7fe 2766 `3 cm 20 cm moveto 10/Helvetica ReportFontInfo showpage'
bcc0d457 2767- add the values to `ps-font-info-database'.
c3d6d211
GM
2768You can get all the fonts of YOUR printer using `ReportAllFontInfo'.
2769
319acba0
GM
2770Note also that ps-print DOESN'T download any font to your printer, instead it
2771uses the fonts resident in your printer."
ef1159c2
EZ
2772 :type '(repeat
2773 (list :tag "Font Definition"
2774 (symbol :tag "Font Family")
2775 (cons :format "%v"
2776 (const :format "" fonts)
2777 (repeat :tag "Faces"
2778 (cons (choice :menu-tag "Font Weight/Slant"
2779 :tag "Font Weight/Slant"
2780 (const normal)
2781 (const bold)
2782 (const italic)
2783 (const bold-italic)
2784 (symbol :tag "Face"))
2785 (string :tag "Font Name"))))
2786 (cons :format "%v"
2787 (const :format "" size)
2788 (number :tag "Reference Size"))
2789 (cons :format "%v"
2790 (const :format "" line-height)
2791 (number :tag "Line Height"))
2792 (cons :format "%v"
2793 (const :format "" space-width)
2794 (number :tag "Space Width"))
2795 (cons :format "%v"
2796 (const :format "" avg-char-width)
2797 (number :tag "Average Character Width"))))
b6d0ac87 2798 :version "20"
e0af0d3e
RS
2799 :group 'ps-print-font)
2800
2801(defcustom ps-font-family 'Courier
d3ab8dac 2802 "*Font family name for ordinary text, when generating PostScript."
e0af0d3e 2803 :type 'symbol
b6d0ac87 2804 :version "20"
e0af0d3e
RS
2805 :group 'ps-print-font)
2806
7d8b7e8e 2807(defcustom ps-font-size '(7 . 8.5)
54b506db
VJL
2808 "*Font size, in points, for ordinary text, when generating PostScript.
2809Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
ef1159c2
EZ
2810 :type '(choice :menu-tag "Ordinary Text Font Size"
2811 :tag "Ordinary Text Font Size"
2812 (number :tag "Text Size")
7d8b7e8e
KH
2813 (cons :tag "Landscape/Portrait"
2814 (number :tag "Landscape Text Size")
2815 (number :tag "Portrait Text Size")))
b6d0ac87 2816 :version "20"
e0af0d3e
RS
2817 :group 'ps-print-font)
2818
2819(defcustom ps-header-font-family 'Helvetica
d3ab8dac 2820 "*Font family name for text in the header, when generating PostScript."
e0af0d3e 2821 :type 'symbol
b6d0ac87 2822 :version "20"
e0af0d3e
RS
2823 :group 'ps-print-font)
2824
7d8b7e8e 2825(defcustom ps-header-font-size '(10 . 12)
54b506db
VJL
2826 "*Font size, in points, for text in the header, when generating PostScript.
2827Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
ef1159c2
EZ
2828 :type '(choice :menu-tag "Header Font Size"
2829 :tag "Header Font Size"
2830 (number :tag "Header Size")
7d8b7e8e
KH
2831 (cons :tag "Landscape/Portrait"
2832 (number :tag "Landscape Header Size")
2833 (number :tag "Portrait Header Size")))
b6d0ac87 2834 :version "20"
e0af0d3e
RS
2835 :group 'ps-print-font)
2836
7d8b7e8e 2837(defcustom ps-header-title-font-size '(12 . 14)
54b506db
VJL
2838 "*Font size, in points, for the top line of text in header, in PostScript.
2839Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
ef1159c2
EZ
2840 :type '(choice :menu-tag "Header Title Font Size"
2841 :tag "Header Title Font Size"
2842 (number :tag "Header Title Size")
7d8b7e8e
KH
2843 (cons :tag "Landscape/Portrait"
2844 (number :tag "Landscape Header Title Size")
2845 (number :tag "Portrait Header Title Size")))
b6d0ac87 2846 :version "20"
e0af0d3e 2847 :group 'ps-print-font)
bcc0d457 2848
319acba0
GM
2849(defcustom ps-footer-font-family 'Helvetica
2850 "*Font family name for text in the footer, when generating PostScript."
319acba0 2851 :type 'symbol
b6d0ac87 2852 :version "21.1"
319acba0
GM
2853 :group 'ps-print-font)
2854
2855(defcustom ps-footer-font-size '(10 . 12)
54b506db
VJL
2856 "*Font size, in points, for text in the footer, when generating PostScript.
2857Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
319acba0
GM
2858 :type '(choice :menu-tag "Footer Font Size"
2859 :tag "Footer Font Size"
2860 (number :tag "Footer Size")
2861 (cons :tag "Landscape/Portrait"
2862 (number :tag "Landscape Footer Size")
2863 (number :tag "Portrait Footer Size")))
b6d0ac87 2864 :version "21.1"
319acba0
GM
2865 :group 'ps-print-font)
2866
2867(defcustom ps-line-number-color "black"
2868 "*Specify color for line-number, when generating PostScript."
2869 :type '(choice :menu-tag "Line Number Color"
2870 :tag "Line Number Color"
2871 (number :tag "Gray Scale" :value 0)
2872 (string :tag "Color Name" :value "black")
2873 (list :tag "RGB Color" :value (0 0 0)
2874 (number :tag "Red")
2875 (number :tag "Green")
2876 (number :tag "Blue")))
2877 :version "21.1"
2878 :group 'ps-print-font
2879 :group 'ps-print-miscellany)
2880
ef1159c2
EZ
2881(defcustom ps-line-number-font "Times-Italic"
2882 "*Font for line-number, when generating PostScript."
2883 :type 'string
b6d0ac87 2884 :version "20"
ef1159c2
EZ
2885 :group 'ps-print-font
2886 :group 'ps-print-miscellany)
2887
2888(defcustom ps-line-number-font-size 6
54b506db
VJL
2889 "*Font size, in points, for line number, when generating PostScript.
2890Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE)."
ef1159c2
EZ
2891 :type '(choice :menu-tag "Line Number Font Size"
2892 :tag "Line Number Font Size"
2893 (number :tag "Font Size")
2894 (cons :tag "Landscape/Portrait"
2895 (number :tag "Landscape Font Size")
2896 (number :tag "Portrait Font Size")))
b6d0ac87 2897 :version "20"
ef1159c2
EZ
2898 :group 'ps-print-font
2899 :group 'ps-print-miscellany)
2900
bcc0d457
RS
2901;;; Colors
2902
87a16a06 2903;; Printing color requires x-color-values.
c90a10fa
RS
2904;; XEmacs change: Need autoload for the "Options->Printing->Color Printing"
2905;; widget to work.
2906;;;###autoload
ea0c615d 2907(defcustom ps-print-color-p
509b4dbc 2908 (or (fboundp 'x-color-values) ; Emacs
ea0c615d 2909 (fboundp 'color-instance-rgb-components))
857686a6 2910 ; XEmacs
55732434
GM
2911 "*Specify how buffer's text color is printed.
2912
2913Valid values are:
2914
2915 nil Do not print colors.
2916
2917 t Print colors.
2918
2919 black-white Print colors on black/white printer.
2920 See also `ps-black-white-faces'.
2921
2922Any other value is treated as t."
2923 :type '(choice :menu-tag "Print Color"
2924 :tag "Print Color"
2925 (const :tag "Do NOT Print Color" nil)
2926 (const :tag "Print Always Color" t)
2927 (const :tag "Print Black/White Color" black-white))
b6d0ac87 2928 :version "20"
e0af0d3e 2929 :group 'ps-print-color)
12d89a2e 2930
f1024355 2931(defcustom ps-default-fg nil
830f437e 2932 "*RGB values of the default foreground color.
e59d29d6
VJL
2933
2934The `ps-default-fg' variable contains the default foreground color used by
2935ps-print, that is, if there is a face in a text that doesn't have a foreground
2936color, the `ps-default-fg' color should be used.
2937
2938Valid values are:
2939
2940 t The foreground color of Emacs session will be used.
2941
830f437e
VJL
2942 frame-parameter The foreground-color frame parameter will be used.
2943
e59d29d6
VJL
2944 NUMBER It's a real value between 0.0 (black) and 1.0 (white) that
2945 indicate the gray color.
2946
640477ee 2947 COLOR-NAME It's a string which contains the color name. For example:
e59d29d6
VJL
2948 \"yellow\".
2949
2950 LIST It's a list of RGB values, that is a list of three real values
2951 of the form:
2952
2953 (RED, GREEN, BLUE)
2954
2955 Where RED, GREEN and BLUE are reals between 0.0 (no color) and
2956 1.0 (full color).
2957
830f437e 2958Any other value is ignored and black color will be used.
e59d29d6 2959
905350be
VJL
2960This variable is used only when `ps-print-color-p' (which see) is neither nil
2961nor black-white."
8e234846
GM
2962 :type '(choice :menu-tag "Default Foreground Gray/Color"
2963 :tag "Default Foreground Gray/Color"
c794a94d 2964 (const :tag "Session Foreground" t)
830f437e 2965 (const :tag "Frame Foreground" frame-parameter)
6e1b1da6
GM
2966 (number :tag "Gray Scale" :value 0.0)
2967 (string :tag "Color Name" :value "black")
2968 (list :tag "RGB Color" :value (0.0 0.0 0.0)
2969 (number :tag "Red")
2970 (number :tag "Green")
2971 (number :tag "Blue")))
b6d0ac87 2972 :version "20"
e0af0d3e 2973 :group 'ps-print-color)
12d89a2e 2974
f1024355 2975(defcustom ps-default-bg nil
830f437e 2976 "*RGB values of the default background color.
e59d29d6
VJL
2977
2978The `ps-default-bg' variable contains the default background color used by
2979ps-print, that is, if there is a face in a text that doesn't have a background
2980color, the `ps-default-bg' color should be used.
2981
2982Valid values are:
2983
2984 t The background color of Emacs session will be used.
2985
830f437e
VJL
2986 frame-parameter The background-color frame parameter will be used.
2987
e59d29d6
VJL
2988 NUMBER It's a real value between 0.0 (black) and 1.0 (white) that
2989 indicate the gray color.
2990
640477ee 2991 COLOR-NAME It's a string which contains the color name. For example:
e59d29d6
VJL
2992 \"yellow\".
2993
2994 LIST It's a list of RGB values, that is a list of three real values
2995 of the form:
2996
2997 (RED, GREEN, BLUE)
2998
2999 Where RED, GREEN and BLUE are reals between 0.0 (no color) and
3000 1.0 (full color).
3001
830f437e 3002Any other value is ignored and white color will be used.
e59d29d6 3003
905350be
VJL
3004This variable is used only when `ps-print-color-p' (which see) is neither nil
3005nor black-white.
e59d29d6
VJL
3006
3007See also `ps-use-face-background'."
8e234846
GM
3008 :type '(choice :menu-tag "Default Background Gray/Color"
3009 :tag "Default Background Gray/Color"
c794a94d 3010 (const :tag "Session Background" t)
830f437e 3011 (const :tag "Frame Background" frame-parameter)
6e1b1da6
GM
3012 (number :tag "Gray Scale" :value 1.0)
3013 (string :tag "Color Name" :value "white")
3014 (list :tag "RGB Color" :value (1.0 1.0 1.0)
3015 (number :tag "Red")
3016 (number :tag "Green")
3017 (number :tag "Blue")))
b6d0ac87 3018 :version "20"
e0af0d3e 3019 :group 'ps-print-color)
12d89a2e 3020
e0af0d3e 3021(defcustom ps-auto-font-detect t
df5e6194 3022 "*Non-nil means automatically detect bold/italic/underline face attributes.
319acba0
GM
3023If nil, we rely solely on the lists `ps-bold-faces', `ps-italic-faces', and
3024`ps-underlined-faces'."
e0af0d3e 3025 :type 'boolean
b6d0ac87 3026 :version "20"
e0af0d3e 3027 :group 'ps-print-font)
12d89a2e 3028
55732434
GM
3029(defcustom ps-black-white-faces
3030 '((font-lock-builtin-face "black" nil bold )
3031 (font-lock-comment-face "gray20" nil italic)
3032 (font-lock-constant-face "black" nil bold )
3033 (font-lock-function-name-face "black" nil bold )
3034 (font-lock-keyword-face "black" nil bold )
3035 (font-lock-string-face "black" nil italic)
3036 (font-lock-type-face "black" nil italic)
3037 (font-lock-variable-name-face "black" nil bold italic)
3038 (font-lock-warning-face "black" nil bold italic))
3039 "*Specify list of face attributes to print colors on black/white printers.
3040
3041The list elements are the same as defined on `ps-extend-face' (which see).
3042
3043This variable is used only when `ps-print-color-p' is set to `black-white'."
3044 :version "21.1"
3045 :type '(repeat
3046 (list :tag "Face Specification"
3047 (face :tag "Face Symbol")
3048 (choice :menu-tag "Foreground Color"
3049 :tag "Foreground Color"
3050 (const :tag "Black" nil)
3051 (string :tag "Color Name"))
3052 (choice :menu-tag "Background Color"
3053 :tag "Background Color"
3054 (const :tag "None" nil)
3055 (string :tag "Color Name"))
3056 (repeat :inline t
3057 (choice :menu-tag "Attribute"
3058 (const bold)
3059 (const italic)
3060 (const underline)
3061 (const strikeout)
3062 (const overline)
3063 (const shadow)
3064 (const box)
3065 (const outline)))))
b6d0ac87 3066 :version "20"
55732434
GM
3067 :group 'ps-print-face)
3068
e0af0d3e 3069(defcustom ps-bold-faces
090be653
RS
3070 (unless ps-print-color-p
3071 '(font-lock-function-name-face
3072 font-lock-builtin-face
3073 font-lock-variable-name-face
3074 font-lock-keyword-face
3075 font-lock-warning-face))
86c10ecb 3076 "*A list of the \(non-bold\) faces that should be printed in bold font.
8bd22fcf 3077This applies to generating PostScript."
e0af0d3e 3078 :type '(repeat face)
b6d0ac87 3079 :version "20"
e0af0d3e 3080 :group 'ps-print-face)
12d89a2e 3081
e0af0d3e 3082(defcustom ps-italic-faces
090be653
RS
3083 (unless ps-print-color-p
3084 '(font-lock-variable-name-face
8bd22fcf 3085 font-lock-type-face
090be653
RS
3086 font-lock-string-face
3087 font-lock-comment-face
3088 font-lock-warning-face))
86c10ecb 3089 "*A list of the \(non-italic\) faces that should be printed in italic font.
8bd22fcf 3090This applies to generating PostScript."
e0af0d3e 3091 :type '(repeat face)
b6d0ac87 3092 :version "20"
e0af0d3e 3093 :group 'ps-print-face)
12d89a2e 3094
e0af0d3e 3095(defcustom ps-underlined-faces
090be653
RS
3096 (unless ps-print-color-p
3097 '(font-lock-function-name-face
883212ce 3098 font-lock-constant-face
090be653 3099 font-lock-warning-face))
86c10ecb 3100 "*A list of the \(non-underlined\) faces that should be printed underlined.
8bd22fcf 3101This applies to generating PostScript."
e0af0d3e 3102 :type '(repeat face)
b6d0ac87 3103 :version "20"
e0af0d3e 3104 :group 'ps-print-face)
12d89a2e 3105
906d41a7
GM
3106(defcustom ps-use-face-background nil
3107 "*Specify if face background should be used.
3108
3109Valid values are:
3110
3111 t always use face background color.
3112 nil never use face background color.
3113 (face...) list of faces whose background color will be used.
3114
3115Any other value will be treated as t."
8e234846
GM
3116 :type '(choice :menu-tag "Use Face Background"
3117 :tag "Use Face Background"
906d41a7
GM
3118 (const :tag "Always Use Face Background" t)
3119 (const :tag "Never Use Face Background" nil)
3120 (repeat :menu-tag "Face Background List"
3121 :tag "Face Background List"
3122 face))
b6d0ac87 3123 :version "20"
906d41a7
GM
3124 :group 'ps-print-face)
3125
e0af0d3e 3126(defcustom ps-left-header
12d89a2e 3127 (list 'ps-get-buffer-name 'ps-header-dirpart)
bcc0d457 3128 "*The items to display (each on a line) on the left part of the page header.
8bd22fcf 3129This applies to generating PostScript.
12d89a2e 3130
319acba0
GM
3131The value should be a list of strings and symbols, each representing an entry
3132in the PostScript array HeaderLinesLeft.
12d89a2e
RS
3133
3134Strings are inserted unchanged into the array; those representing
3135PostScript string literals should be delimited with PostScript string
3136delimiters '(' and ')'.
3137
319acba0
GM
3138For symbols with bound functions, the function is called and should return a
3139string to be inserted into the array. For symbols with bound values, the value
3140should be a string to be inserted into the array. In either case, function or
6b61353c
KH
3141variable, the string value has PostScript string delimiters added to it.
3142
3143If symbols are unbounded, they are silently ignored."
ef1159c2
EZ
3144 :type '(repeat (choice :menu-tag "Left Header"
3145 :tag "Left Header"
3146 string symbol))
b6d0ac87 3147 :version "20"
6e1b1da6 3148 :group 'ps-print-headers)
12d89a2e 3149
e0af0d3e 3150(defcustom ps-right-header
2bd80d73 3151 (list "/pagenumberstring load"
4b81a999 3152 'ps-time-stamp-locale-default 'ps-time-stamp-hh:mm:ss)
bcc0d457 3153 "*The items to display (each on a line) on the right part of the page header.
8bd22fcf 3154This applies to generating PostScript.
12d89a2e 3155
319acba0 3156See the variable `ps-left-header' for a description of the format of this
4b81a999
GM
3157variable.
3158
3159There are the following basic functions implemented:
3160
3161 `ps-time-stamp-locale-default' Return the locale's \"preferred\" date
3162 as, for example, \"06/18/01\".
3163
3164 `ps-time-stamp-hh:mm:ss' Return time as \"17:28:31\".
3165
3166 `ps-time-stamp-mon-dd-yyyy' Return date as \"Jun 18 2001\".
3167
6b61353c
KH
3168 `ps-time-stamp-yyyy-mm-dd' Return date as \"2001-06-18\" (ISO
3169 date).
3170
3171 `ps-time-stamp-iso8601' Alias for `ps-time-stamp-yyyy-mm-dd'.
3172
4b81a999 3173You can also create your own time stamp function by using `format-time-string'
2285bf9d 3174\(which see)."
ef1159c2
EZ
3175 :type '(repeat (choice :menu-tag "Right Header"
3176 :tag "Right Header"
3177 string symbol))
b6d0ac87 3178 :version "20"
6e1b1da6 3179 :group 'ps-print-headers)
ef2cbb24 3180
319acba0
GM
3181(defcustom ps-left-footer
3182 (list 'ps-get-buffer-name 'ps-header-dirpart)
3183 "*The items to display (each on a line) on the left part of the page footer.
3184This applies to generating PostScript.
3185
3186The value should be a list of strings and symbols, each representing an entry
3187in the PostScript array FooterLinesLeft.
3188
3189Strings are inserted unchanged into the array; those representing PostScript
3190string literals should be delimited with PostScript string delimiters '(' and
3191')'.
3192
3193For symbols with bound functions, the function is called and should return a
3194string to be inserted into the array. For symbols with bound values, the value
3195should be a string to be inserted into the array. In either case, function or
6b61353c
KH
3196variable, the string value has PostScript string delimiters added to it.
3197
3198If symbols are unbounded, they are silently ignored."
319acba0
GM
3199 :type '(repeat (choice :menu-tag "Left Footer"
3200 :tag "Left Footer"
3201 string symbol))
b6d0ac87 3202 :version "21.1"
319acba0
GM
3203 :group 'ps-print-headers)
3204
3205(defcustom ps-right-footer
3206 (list "/pagenumberstring load"
4b81a999 3207 'ps-time-stamp-locale-default 'ps-time-stamp-hh:mm:ss)
319acba0
GM
3208 "*The items to display (each on a line) on the right part of the page footer.
3209This applies to generating PostScript.
3210
3211See the variable `ps-left-footer' for a description of the format of this
4b81a999
GM
3212variable.
3213
3214There are the following basic functions implemented:
3215
3216 `ps-time-stamp-locale-default' Return the locale's \"preferred\" date
3217 as, for example, \"06/18/01\".
3218
3219 `ps-time-stamp-hh:mm:ss' Return time as \"17:28:31\".
3220
3221 `ps-time-stamp-mon-dd-yyyy' Return date as \"Jun 18 2001\".
3222
6b61353c
KH
3223 `ps-time-stamp-yyyy-mm-dd' Return date as \"2001-06-18\" (ISO
3224 date).
3225
3226 `ps-time-stamp-iso8601' Alias for `ps-time-stamp-yyyy-mm-dd'.
3227
4b81a999 3228You can also create your own time stamp function by using `format-time-string'
2285bf9d 3229\(which see)."
319acba0
GM
3230 :type '(repeat (choice :menu-tag "Right Footer"
3231 :tag "Right Footer"
3232 string symbol))
b6d0ac87 3233 :version "21.1"
319acba0
GM
3234 :group 'ps-print-headers)
3235
e0af0d3e
RS
3236(defcustom ps-razzle-dazzle t
3237 "*Non-nil means report progress while formatting buffer."
3238 :type 'boolean
b6d0ac87 3239 :version "20"
6e1b1da6 3240 :group 'ps-print-miscellany)
12d89a2e 3241
a18ed129 3242(defcustom ps-adobe-tag "%!PS-Adobe-3.0\n"
12d89a2e 3243 "*Contains the header line identifying the output as PostScript.
319acba0
GM
3244By default, `ps-adobe-tag' contains the standard identifier. Some printers
3245require slightly different versions of this line."
a18ed129 3246 :type 'string
b6d0ac87 3247 :version "20"
6e1b1da6 3248 :group 'ps-print-miscellany)
12d89a2e 3249
e0af0d3e 3250(defcustom ps-build-face-reference t
12d89a2e
RS
3251 "*Non-nil means build the reference face lists.
3252
319acba0 3253ps-print sets this value to nil after it builds its internal reference lists of
1b1200a1 3254bold and italic faces. By setting its value back to t, you can force ps-print
319acba0
GM
3255to rebuild the lists the next time you invoke one of the ...-with-faces
3256commands.
12d89a2e 3257
319acba0
GM
3258You should set this value back to t after you change the attributes of any
3259face, or create new faces. Most users shouldn't have to worry about its
3260setting, though."
e0af0d3e 3261 :type 'boolean
b6d0ac87 3262 :version "20"
e0af0d3e 3263 :group 'ps-print-face)
12d89a2e 3264
e0af0d3e 3265(defcustom ps-always-build-face-reference nil
12d89a2e
RS
3266 "*Non-nil means always rebuild the reference face lists.
3267
319acba0
GM
3268If this variable is non-nil, ps-print will rebuild its internal reference lists
3269of bold and italic faces *every* time one of the ...-with-faces commands is
3270called. Most users shouldn't need to set this variable."
e0af0d3e 3271 :type 'boolean
b6d0ac87 3272 :version "20"
e0af0d3e 3273 :group 'ps-print-face)
ef2cbb24 3274
bc0d41bd
KH
3275(defcustom ps-banner-page-when-duplexing nil
3276 "*Non-nil means the very first page is skipped.
3277It's like the very first character of buffer (or region) is ^L (\\014)."
3278 :type 'boolean
b6d0ac87 3279 :version "20"
6e1b1da6 3280 :group 'ps-print-headers)
bc0d41bd 3281
98f2fbe7 3282(defcustom ps-postscript-code-directory
b6d0ac87 3283 (or (if (featurep 'xemacs)
9e53076e 3284 (cond ((fboundp 'locate-data-directory) ; XEmacs
c97a3f22 3285 (funcall 'locate-data-directory "ps-print"))
9e53076e 3286 ((boundp 'data-directory) ; XEmacs
c97a3f22 3287 (symbol-value 'data-directory))
b6d0ac87
VJL
3288 (t ; don't know what to do
3289 nil))
9e53076e 3290 data-directory) ; Emacs
eafa92bf 3291 (error "`ps-postscript-code-directory' isn't set properly"))
41481e4b
KH
3292 "*Directory where it's located the PostScript prologue file used by ps-print.
3293By default, this directory is the same as in the variable `data-directory'."
3294 :type 'directory
b6d0ac87 3295 :version "20"
6e1b1da6 3296 :group 'ps-print-miscellany)
41481e4b 3297
6bf5fb46
GM
3298(defcustom ps-line-spacing 0
3299 "*Specify line spacing, in points, for ordinary text.
3300
5d1d76ac
VJL
3301Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE).
3302
6bf5fb46
GM
3303See also `ps-paragraph-spacing' and `ps-paragraph-regexp'.
3304
3305To get all lines with some spacing set both `ps-line-spacing' and
3306`ps-paragraph-spacing' variables."
3307 :type '(choice :menu-tag "Line Spacing For Ordinary Text"
3308 :tag "Line Spacing For Ordinary Text"
3309 (number :tag "Line Spacing")
3310 (cons :tag "Landscape/Portrait"
3311 (number :tag "Landscape Line Spacing")
3312 (number :tag "Portrait Line Spacing")))
3313 :version "21.1"
3314 :group 'ps-print-miscellany)
3315
3316(defcustom ps-paragraph-spacing 0
3317 "*Specify paragraph spacing, in points, for ordinary text.
3318
5d1d76ac
VJL
3319Either a float or a cons of floats (LANDSCAPE-SIZE . PORTRAIT-SIZE).
3320
6bf5fb46
GM
3321See also `ps-line-spacing' and `ps-paragraph-regexp'.
3322
3323To get all lines with some spacing set both `ps-line-spacing' and
3324`ps-paragraph-spacing' variables."
3325 :type '(choice :menu-tag "Paragraph Spacing For Ordinary Text"
3326 :tag "Paragraph Spacing For Ordinary Text"
3327 (number :tag "Paragraph Spacing")
3328 (cons :tag "Landscape/Portrait"
3329 (number :tag "Landscape Paragraph Spacing")
3330 (number :tag "Portrait Paragraph Spacing")))
3331 :version "21.1"
3332 :group 'ps-print-miscellany)
3333
3334(defcustom ps-paragraph-regexp "[ \t]*$"
3335 "*Specify paragraph delimiter.
3336
3337It should be a regexp or nil.
3338
3339See also `ps-paragraph-spacing'."
3340 :type '(choice :menu-tag "Paragraph Delimiter"
3341 (const :tag "No Delimiter" nil)
3342 (regexp :tag "Delimiter Regexp"))
3343 :version "21.1"
3344 :group 'ps-print-miscellany)
3345
3346(defcustom ps-begin-cut-regexp nil
3347 "*Specify regexp which is start of a region to cut out when printing.
3348
3349As an example, variables `ps-begin-cut-regexp' and `ps-end-cut-regexp' may be
3350set to \"^Local Variables:\" and \"^End:\", respectively, in order to leave out
3351some special printing instructions from the actual print. Special printing
3352instructions may be appended to the end of the file just like any other
3353buffer-local variables. See section \"Local Variables in Files\" on Emacs
3354manual for more information.
3355
3356Variables `ps-begin-cut-regexp' and `ps-end-cut-regexp' control together what
3357actually gets printed. Both variables may be set to nil in which case no
3358cutting occurs."
bf29d4c1
MR
3359 :type '(choice (const :tag "No Delimiter" nil)
3360 (regexp :tag "Delimiter Regexp"))
6bf5fb46
GM
3361 :version "21.1"
3362 :group 'ps-print-miscellany)
3363
3364(defcustom ps-end-cut-regexp nil
3365 "*Specify regexp which is end of the region to cut out when printing.
3366
3367See `ps-begin-cut-regexp' for more information."
bf29d4c1
MR
3368 :type '(choice (const :tag "No Delimiter" nil)
3369 (regexp :tag "Delimiter Regexp"))
6bf5fb46
GM
3370 :version "21.1"
3371 :group 'ps-print-miscellany)
3372
0a5daee5 3373
1fd9b7fe
GM
3374;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3375;; Selected Pages
3376
3377
3378(defvar ps-last-selected-pages nil
3379 "Latest `ps-selected-pages' value.")
3380
3381
3382(defun ps-restore-selected-pages ()
3383 "Restore latest `ps-selected-pages' value."
3384 (interactive)
3385 (setq ps-selected-pages ps-last-selected-pages))
3386
3387
0a5daee5
KH
3388;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3389;; Customization
3390
3391
3392;;;###autoload
3393(defun ps-print-customize ()
3394 "Customization of ps-print group."
3395 (interactive)
3396 (customize-group 'ps-print))
3397
3398
ef2cbb24 3399;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
12d89a2e 3400;; User commands
ef2cbb24 3401
0a5daee5 3402
00aa16af 3403;;;###autoload
ef2cbb24 3404(defun ps-print-buffer (&optional filename)
12d89a2e 3405 "Generate and print a PostScript image of the buffer.
ef2cbb24 3406
2285bf9d 3407Interactively, when you use a prefix argument (\\[universal-argument]), the command prompts the
319acba0
GM
3408user for a file name, and saves the PostScript image in that file instead of
3409sending it to the printer.
ef2cbb24 3410
319acba0
GM
3411Noninteractively, the argument FILENAME is treated as follows: if it is nil,
3412send the image to the printer. If FILENAME is a string, save the PostScript
3413image in a file with that name."
00aa16af 3414 (interactive (list (ps-print-preprint current-prefix-arg)))
87a16a06 3415 (ps-print-without-faces (point-min) (point-max) filename))
ef2cbb24
RS
3416
3417
00aa16af 3418;;;###autoload
ef2cbb24 3419(defun ps-print-buffer-with-faces (&optional filename)
12d89a2e 3420 "Generate and print a PostScript image of the buffer.
319acba0
GM
3421Like `ps-print-buffer', but includes font, color, and underline information in
3422the generated image. This command works only if you are using a window system,
3423so it has a way to determine color values."
00aa16af 3424 (interactive (list (ps-print-preprint current-prefix-arg)))
87a16a06 3425 (ps-print-with-faces (point-min) (point-max) filename))
ef2cbb24 3426
ef2cbb24 3427
00aa16af 3428;;;###autoload
ef2cbb24 3429(defun ps-print-region (from to &optional filename)
12d89a2e 3430 "Generate and print a PostScript image of the region.
12d89a2e 3431Like `ps-print-buffer', but prints just the current region."
55732434 3432 (interactive (ps-print-preprint-region current-prefix-arg))
a18ed129 3433 (ps-print-without-faces from to filename t))
ef2cbb24 3434
ef2cbb24 3435
00aa16af 3436;;;###autoload
ef2cbb24 3437(defun ps-print-region-with-faces (from to &optional filename)
12d89a2e 3438 "Generate and print a PostScript image of the region.
319acba0
GM
3439Like `ps-print-region', but includes font, color, and underline information in
3440the generated image. This command works only if you are using a window system,
3441so it has a way to determine color values."
55732434 3442 (interactive (ps-print-preprint-region current-prefix-arg))
a18ed129 3443 (ps-print-with-faces from to filename t))
ef2cbb24 3444
ef2cbb24 3445
00aa16af 3446;;;###autoload
ef2cbb24 3447(defun ps-spool-buffer ()
12d89a2e 3448 "Generate and spool a PostScript image of the buffer.
319acba0
GM
3449Like `ps-print-buffer' except that the PostScript image is saved in a local
3450buffer to be sent to the printer later.
ef2cbb24 3451
12d89a2e 3452Use the command `ps-despool' to send the spooled images to the printer."
ef2cbb24 3453 (interactive)
87a16a06 3454 (ps-spool-without-faces (point-min) (point-max)))
ef2cbb24 3455
ef2cbb24 3456
00aa16af 3457;;;###autoload
ef2cbb24 3458(defun ps-spool-buffer-with-faces ()
12d89a2e 3459 "Generate and spool a PostScript image of the buffer.
319acba0
GM
3460Like `ps-spool-buffer', but includes font, color, and underline information in
3461the generated image. This command works only if you are using a window system,
3462so it has a way to determine color values.
ef2cbb24 3463
12d89a2e 3464Use the command `ps-despool' to send the spooled images to the printer."
ef2cbb24 3465 (interactive)
87a16a06 3466 (ps-spool-with-faces (point-min) (point-max)))
ef2cbb24 3467
ef2cbb24 3468
00aa16af 3469;;;###autoload
ef2cbb24 3470(defun ps-spool-region (from to)
12d89a2e 3471 "Generate a PostScript image of the region and spool locally.
12d89a2e 3472Like `ps-spool-buffer', but spools just the current region.
ef2cbb24 3473
12d89a2e 3474Use the command `ps-despool' to send the spooled images to the printer."
ef2cbb24 3475 (interactive "r")
a18ed129 3476 (ps-spool-without-faces from to t))
ef2cbb24 3477
ef2cbb24 3478
00aa16af 3479;;;###autoload
ef2cbb24 3480(defun ps-spool-region-with-faces (from to)
12d89a2e 3481 "Generate a PostScript image of the region and spool locally.
319acba0
GM
3482Like `ps-spool-region', but includes font, color, and underline information in
3483the generated image. This command works only if you are using a window system,
3484so it has a way to determine color values.
ef2cbb24 3485
12d89a2e 3486Use the command `ps-despool' to send the spooled images to the printer."
ef2cbb24 3487 (interactive "r")
a18ed129 3488 (ps-spool-with-faces from to t))
ef2cbb24 3489
00aa16af 3490;;;###autoload
ef2cbb24
RS
3491(defun ps-despool (&optional filename)
3492 "Send the spooled PostScript to the printer.
3493
2285bf9d 3494Interactively, when you use a prefix argument (\\[universal-argument]), the command prompts the
319acba0
GM
3495user for a file name, and saves the spooled PostScript image in that file
3496instead of sending it to the printer.
ef2cbb24 3497
319acba0
GM
3498Noninteractively, the argument FILENAME is treated as follows: if it is nil,
3499send the image to the printer. If FILENAME is a string, save the PostScript
3500image in a file with that name."
00aa16af
RS
3501 (interactive (list (ps-print-preprint current-prefix-arg)))
3502 (ps-do-despool filename))
12d89a2e 3503
bcc0d457
RS
3504;;;###autoload
3505(defun ps-line-lengths ()
2285bf9d
RS
3506 "Display the correspondence between a line length and a font size.
3507Done using the current ps-print setup.
bcc0d457
RS
3508Try: pr -t file | awk '{printf \"%3d %s\n\", length($0), $0}' | sort -r | head"
3509 (interactive)
3510 (ps-line-lengths-internal))
3511
3512;;;###autoload
3513(defun ps-nb-pages-buffer (nb-lines)
06fb6aab
RS
3514 "Display number of pages to print this buffer, for various font heights.
3515The table depends on the current ps-print setup."
55732434 3516 (interactive (ps-count-lines-preprint (point-min) (point-max)))
bcc0d457
RS
3517 (ps-nb-pages nb-lines))
3518
3519;;;###autoload
3520(defun ps-nb-pages-region (nb-lines)
06fb6aab
RS
3521 "Display number of pages to print the region, for various font heights.
3522The table depends on the current ps-print setup."
55732434 3523 (interactive (ps-count-lines-preprint (mark) (point)))
bcc0d457
RS
3524 (ps-nb-pages nb-lines))
3525
c86f4619
GM
3526(defvar ps-prefix-quote nil
3527 "Used for `ps-print-quote' (which see).")
efa89c1f 3528
bcc0d457
RS
3529;;;###autoload
3530(defun ps-setup ()
496725ad 3531 "Return the current PostScript-generation setup."
efa89c1f 3532 (let (ps-prefix-quote)
319acba0 3533 (mapconcat
efa89c1f 3534 #'ps-print-quote
319acba0 3535 (list
9e53076e
VJL
3536 (concat "\n;;; (" (if (featurep 'xemacs) "XEmacs" "Emacs")
3537 ") ps-print version " ps-print-version "\n")
208ccc30 3538 ";; internal vars"
9e53076e
VJL
3539 (ps-comment-string "emacs-version " emacs-version)
3540 (ps-comment-string "ps-windows-system " ps-windows-system)
3541 (ps-comment-string "ps-lp-system " ps-lp-system)
208ccc30 3542 nil
319acba0
GM
3543 '(25 . ps-print-color-p)
3544 '(25 . ps-lpr-command)
3545 '(25 . ps-lpr-switches)
3546 '(25 . ps-printer-name)
3547 '(25 . ps-printer-name-option)
3548 '(25 . ps-print-region-function)
3549 '(25 . ps-manual-feed)
3550 '(25 . ps-end-with-control-d)
3551 nil
3552 '(23 . ps-paper-type)
3553 '(23 . ps-warn-paper-type)
3554 '(23 . ps-landscape-mode)
3555 '(23 . ps-print-upside-down)
3556 '(23 . ps-number-of-columns)
3557 nil
3558 '(23 . ps-zebra-stripes)
3559 '(23 . ps-zebra-stripe-height)
3560 '(23 . ps-zebra-stripe-follow)
3561 '(23 . ps-zebra-color)
3562 '(23 . ps-line-number)
3563 '(23 . ps-line-number-step)
3564 '(23 . ps-line-number-start)
3565 nil
3566 '(17 . ps-default-fg)
3567 '(17 . ps-default-bg)
3568 '(17 . ps-razzle-dazzle)
3569 nil
3570 '(23 . ps-use-face-background)
3571 nil
3572 '(28 . ps-print-control-characters)
3573 nil
3574 '(26 . ps-print-background-image)
3575 nil
3576 '(25 . ps-print-background-text)
3577 nil
3578 '(29 . ps-error-handler-message)
3579 '(29 . ps-user-defined-prologue)
3580 '(29 . ps-print-prologue-header)
3581 '(29 . ps-postscript-code-directory)
3582 '(29 . ps-adobe-tag)
3583 nil
3584 '(30 . ps-left-margin)
3585 '(30 . ps-right-margin)
3586 '(30 . ps-inter-column)
3587 '(30 . ps-bottom-margin)
3588 '(30 . ps-top-margin)
3589 '(30 . ps-print-only-one-header)
3590 '(30 . ps-switch-header)
3591 '(30 . ps-print-header)
3592 '(30 . ps-header-lines)
3593 '(30 . ps-header-offset)
3594 '(30 . ps-header-line-pad)
3595 '(30 . ps-print-header-frame)
3596 '(30 . ps-header-frame-alist)
3597 '(30 . ps-print-footer)
3598 '(30 . ps-footer-lines)
3599 '(30 . ps-footer-offset)
3600 '(30 . ps-footer-line-pad)
3601 '(30 . ps-print-footer-frame)
3602 '(30 . ps-footer-frame-alist)
3603 '(30 . ps-show-n-of-n)
3604 '(30 . ps-spool-config)
3605 '(30 . ps-spool-duplex)
3606 '(30 . ps-spool-tumble)
3607 '(30 . ps-banner-page-when-duplexing)
3608 '(30 . ps-left-header)
3609 '(30 . ps-right-header)
3610 '(30 . ps-left-footer)
3611 '(30 . ps-right-footer)
3612 nil
3613 '(23 . ps-n-up-printing)
3614 '(23 . ps-n-up-margin)
3615 '(23 . ps-n-up-border-p)
3616 '(23 . ps-n-up-filling)
3617 nil
3618 '(26 . ps-multibyte-buffer)
3619 '(26 . ps-font-family)
3620 '(26 . ps-font-size)
3621 '(26 . ps-header-font-family)
3622 '(26 . ps-header-font-size)
3623 '(26 . ps-header-title-font-size)
3624 '(26 . ps-footer-font-family)
3625 '(26 . ps-footer-font-size)
3626 '(26 . ps-line-number-color)
3627 '(26 . ps-line-number-font)
3628 '(26 . ps-line-number-font-size)
3629 '(26 . ps-line-spacing)
3630 '(26 . ps-paragraph-spacing)
3631 '(26 . ps-paragraph-regexp)
3632 '(26 . ps-begin-cut-regexp)
3633 '(26 . ps-end-cut-regexp)
3634 nil
3635 '(23 . ps-even-or-odd-pages)
3636 '(23 . ps-selected-pages)
3637 '(23 . ps-last-selected-pages)
3638 nil
3639 '(31 . ps-build-face-reference)
3640 '(31 . ps-always-build-face-reference)
3641 nil
3642 '(20 . ps-auto-font-detect)
3643 '(20 . ps-bold-faces)
3644 '(20 . ps-italic-faces)
3645 '(20 . ps-underlined-faces)
55732434 3646 '(20 . ps-black-white-faces)
c86f4619 3647 " )\n
bd7a2e26
GM
3648;; The following customized variables have long lists and are seldom modified:
3649;; ps-page-dimensions-database
3650;; ps-font-info-database
1fd9b7fe 3651
231f3e66 3652\;;; ps-print - end of settings\n")
319acba0 3653 "\n")))
bcc0d457 3654
0a5daee5 3655
12d89a2e
RS
3656;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3657;; Utility functions and variables:
3658
0a5daee5 3659
efa89c1f 3660(defun ps-print-quote (elt)
c86f4619
GM
3661 "Quote ELT for printing (used for showing settings).
3662
3663If ELT is nil, return an empty string.
3664If ELT is string, return it.
3665Otherwise, ELT should be a cons (LEN . SYM) where SYM is a variable symbol and
3666LEN is the field length where SYM name will be inserted. The variable
3667`ps-prefix-quote' is used to form the string, if `ps-prefix-quote' is nil, it's
3668used \"(setq \" as prefix; otherwise, it's used \" \". So, the string
3669generated is:
3670
3671 * If `ps-prefix-quote' is nil:
3672 \"(setq SYM-NAME SYM-VALUE\"
3673 |<------->|
3674 LEN
3675
3676 * If `ps-prefix-quote' is non-nil:
3677 \" SYM-NAME SYM-VALUE\"
3678 |<------->|
3679 LEN
3680
3681If `ps-prefix-quote' is nil, it's set to t after generating string."
efa89c1f 3682 (cond
efa89c1f 3683 ((stringp elt) elt)
c90a10fa
RS
3684 ((and (consp elt) (integerp (car elt))
3685 (symbolp (cdr elt)) (boundp (cdr elt)))
efa89c1f
GM
3686 (let* ((col (car elt))
3687 (sym (cdr elt))
3688 (key (symbol-name sym))
3689 (len (length key))
3690 (val (symbol-value sym)))
3691 (concat (if ps-prefix-quote
c86f4619
GM
3692 " "
3693 (setq ps-prefix-quote t)
efa89c1f
GM
3694 "(setq ")
3695 key
3696 (if (> col len)
b0fa9df7 3697 (make-string (- col len) ?\s)
efa89c1f 3698 " ")
51138c94 3699 (ps-value-string val))))
c90a10fa 3700 (t "")
efa89c1f
GM
3701 ))
3702
3703
51138c94
VJL
3704(defun ps-value-string (val)
3705 "Return a string representation of VAL. Used by `ps-print-quote'."
3706 (cond ((null val)
3707 "nil")
3708 ((eq val t)
3709 "t")
3710 ((or (symbolp val) (listp val))
3711 (format "'%S" val))
3712 (t
3713 (format "%S" val))))
3714
3715
bd20e8cd 3716(defun ps-comment-string (str value)
cfb7b9ce
VJL
3717 "Return a comment string like \";; STR = VALUE\"."
3718 (format ";; %s = %s" str (ps-value-string value)))
bd20e8cd
VJL
3719
3720
319acba0
GM
3721(defun ps-value (alist-sym key)
3722 "Return value from association list ALIST-SYM which car is `eq' to KEY."
3723 (cdr (assq key (symbol-value alist-sym))))
3724
3725
3726(defun ps-get (alist-sym key)
3727 "Return element from association list ALIST-SYM which car is `eq' to KEY."
3728 (assq key (symbol-value alist-sym)))
3729
3730
3731(defun ps-put (alist-sym key value)
3732 "Store element (KEY . VALUE) into association list ALIST-SYM.
3733If KEY already exists in ALIST-SYM, modify cdr to VALUE.
3734It can be retrieved with `(ps-get ALIST-SYM KEY)'."
3735 (let ((elt: (assq key (symbol-value alist-sym)))) ; to avoid name conflict
3736 (if elt:
3737 (setcdr elt: value)
3738 (setq elt: (cons key value))
3739 (set alist-sym (cons elt: (symbol-value alist-sym))))
3740 elt:))
3741
3742
3743(defun ps-del (alist-sym key)
3744 "Delete by side effect element KEY from association list ALIST-SYM."
3745 (let ((a:list: (symbol-value alist-sym)) ; to avoid name conflict
3746 old)
3747 (while a:list:
3748 (if (eq key (car (car a:list:)))
3749 (progn
3750 (if old
3751 (setcdr old (cdr a:list:))
3752 (set alist-sym (cdr a:list:)))
3753 (setq a:list: nil))
3754 (setq old a:list:
3755 a:list: (cdr a:list:)))))
3756 (symbol-value alist-sym))
3757
3758
4b81a999
GM
3759(defun ps-time-stamp-locale-default ()
3760 "Return the locale's \"preferred\" date as, for example, \"06/18/01\"."
3761 (format-time-string "%x"))
3762
3763
2bd80d73 3764(defun ps-time-stamp-mon-dd-yyyy ()
4b81a999 3765 "Return date as \"Jun 18 2001\"."
2bd80d73
GM
3766 (format-time-string "%b %d %Y"))
3767
3768
6b61353c
KH
3769(defun ps-time-stamp-yyyy-mm-dd ()
3770 "Return date as \"2001-06-18\" (ISO date)."
3771 (format-time-string "%Y-%m-%d"))
3772
3773
3a504454
VJL
3774;; Alias for `ps-time-stamp-yyyy-mm-dd' (which see).
3775(defalias 'ps-time-stamp-iso8601 'ps-time-stamp-yyyy-mm-dd)
6b61353c
KH
3776
3777
2bd80d73 3778(defun ps-time-stamp-hh:mm:ss ()
4b81a999 3779 "Return time as \"17:28:31\"."
2bd80d73
GM
3780 (format-time-string "%T"))
3781
3782
ea0c615d 3783(defvar ps-print-color-scale 1.0)
47b54c71 3784
3e9cb08f
GM
3785(defun ps-color-scale (color)
3786 ;; Scale 16-bit X-COLOR-VALUE to PostScript color value in [0, 1] interval.
3787 (mapcar #'(lambda (value) (/ value ps-print-color-scale))
3788 (ps-color-values color)))
3789
3790
3791(defun ps-face-underlined-p (face)
3792 (or (face-underline-p face)
3793 (memq face ps-underlined-faces)))
e65df0a1 3794
857686a6 3795
41481e4b 3796(defun ps-prologue-file (filenumber)
2285bf9d 3797 "If prologue FILENUMBER exists and is readable, return contents as string.
2bd80d73
GM
3798
3799Note: No major/minor-mode is activated and no local variables are evaluated for
3800 FILENUMBER, but proper EOL-conversion and character interpretation is
3801 done!"
3802 (let ((filename (convert-standard-filename
3803 (expand-file-name (format "ps-prin%d.ps" filenumber)
3804 ps-postscript-code-directory))))
3805 (if (and (file-exists-p filename)
319acba0
GM
3806 (file-readable-p filename))
3807 (with-temp-buffer
3808 (insert-file-contents filename)
3809 (buffer-string))
e8af40ee 3810 (error "ps-print PostScript prologue `%s' file was not found"
2bd80d73 3811 filename))))
bcc0d457 3812
bcc0d457 3813
374b7675 3814(defvar ps-mark-code-directory nil)
bcc0d457 3815
66e63857
GM
3816(defvar ps-print-prologue-0 ""
3817 "ps-print PostScript error handler.")
3818
41481e4b 3819(defvar ps-print-prologue-1 ""
6bf5fb46 3820 "ps-print PostScript prologue.")
12d89a2e
RS
3821
3822;; Start Editing Here:
ef2cbb24 3823
374b7675 3824(defvar ps-source-buffer nil)
12d89a2e 3825(defvar ps-spool-buffer-name "*PostScript*")
374b7675 3826(defvar ps-spool-buffer nil)
ef2cbb24 3827
374b7675
VJL
3828(defvar ps-output-head nil)
3829(defvar ps-output-tail nil)
ef2cbb24 3830
4b3eb10f
GM
3831(defvar ps-page-postscript 0) ; page number
3832(defvar ps-page-order 0) ; PostScript page counter
3833(defvar ps-page-sheet 0) ; sheet counter
3834(defvar ps-page-column 0) ; column counter
3835(defvar ps-page-printed 0) ; total pages printed
3836(defvar ps-page-n-up 0) ; n-up counter
bd7a2e26
GM
3837(defvar ps-lines-printed 0) ; total lines printed
3838(defvar ps-showline-count 1) ; line number counter
374b7675
VJL
3839(defvar ps-first-page nil)
3840(defvar ps-last-page nil)
ea0c615d 3841(defvar ps-print-page-p t)
87a16a06 3842
374b7675
VJL
3843(defvar ps-control-or-escape-regexp nil)
3844(defvar ps-n-up-on nil)
857686a6 3845
374b7675
VJL
3846(defvar ps-background-pages nil)
3847(defvar ps-background-all-pages nil)
87a16a06
RS
3848(defvar ps-background-text-count 0)
3849(defvar ps-background-image-count 0)
ef2cbb24 3850
12d89a2e 3851(defvar ps-current-font 0)
374b7675
VJL
3852(defvar ps-default-foreground nil)
3853(defvar ps-default-background nil)
3854(defvar ps-default-color nil)
3855(defvar ps-current-color nil)
3856(defvar ps-current-bg nil)
12d89a2e 3857
374b7675 3858(defvar ps-zebra-stripe-full-p nil)
12d89a2e
RS
3859(defvar ps-razchunk 0)
3860
374b7675 3861(defvar ps-color-p nil)
12d89a2e 3862
319acba0
GM
3863;; These values determine how much print-height to deduct when headers/footers
3864;; are turned on. This is a pretty clumsy way of handling it, but it'll do for
3865;; now.
12d89a2e 3866
bcc0d457 3867(defvar ps-header-pad 0
496725ad
RS
3868 "Vertical and horizontal space between the header frame and the text.
3869This is in units of points (1/72 inch).")
12d89a2e 3870
319acba0
GM
3871(defvar ps-footer-pad 0
3872 "Vertical and horizontal space between the footer frame and the text.
3873This is in units of points (1/72 inch).")
3874
bcc0d457 3875;; Define accessors to the dimensions list.
12d89a2e 3876
bcc0d457
RS
3877(defmacro ps-page-dimensions-get-width (dims) `(nth 0 ,dims))
3878(defmacro ps-page-dimensions-get-height (dims) `(nth 1 ,dims))
bc0d41bd 3879(defmacro ps-page-dimensions-get-media (dims) `(nth 2 ,dims))
12d89a2e 3880
374b7675 3881(defvar ps-landscape-page-height nil)
12d89a2e 3882
374b7675
VJL
3883(defvar ps-print-width nil)
3884(defvar ps-print-height nil)
12d89a2e 3885
374b7675
VJL
3886(defvar ps-height-remaining nil)
3887(defvar ps-width-remaining nil)
12d89a2e 3888
374b7675
VJL
3889(defvar ps-font-size-internal nil)
3890(defvar ps-header-font-size-internal nil)
3891(defvar ps-header-title-font-size-internal nil)
3892(defvar ps-footer-font-size-internal nil)
3893(defvar ps-line-spacing-internal nil)
3894(defvar ps-paragraph-spacing-internal nil)
7d8b7e8e 3895
87a16a06
RS
3896\f
3897;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3898;; Internal Variables
3899
3900
55732434
GM
3901(defvar ps-black-white-faces-alist nil
3902 "Alist of symbolic faces used for black/white PostScript printers.
3903An element of this list has the same form as `ps-print-face-extension-alist'
2285bf9d 3904\(which see).
55732434
GM
3905
3906Don't change this list directly; instead,
3907use `ps-extend-face' and `ps-extend-face-list'.
3908See documentation for `ps-extend-face' for valid extension symbol.
3909See also documentation for `ps-print-color-p'.")
3910
3911
87a16a06 3912(defvar ps-print-face-extension-alist nil
a18ed129 3913 "Alist of symbolic faces *WITH* extension features (box, outline, etc).
87a16a06
RS
3914An element of this list has the following form:
3915
3916 (FACE . [BITS FG BG])
3917
3918 FACE is a symbol denoting a face name
3919 BITS is a bit vector, where each bit correspond
3920 to a feature (bold, underline, etc)
3921 (see documentation for `ps-print-face-map-alist')
3922 FG foreground color (string or nil)
3923 BG background color (string or nil)
3924
a18ed129
RS
3925Don't change this list directly; instead,
3926use `ps-extend-face' and `ps-extend-face-list'.
3927See documentation for `ps-extend-face' for valid extension symbol.")
3928
3929
3930(defvar ps-print-face-alist nil
3931 "Alist of symbolic faces *WITHOUT* extension features (box, outline, etc).
3932
3933An element of this list has the same form as an element of
3934`ps-print-face-extension-alist'.
3935
3936Don't change this list directly; this list is used by `ps-face-attributes',
3937`ps-map-face' and `ps-build-reference-face-lists'.")
87a16a06
RS
3938
3939
3940(defconst ps-print-face-map-alist
3941 '((bold . 1)
3942 (italic . 2)
3943 (underline . 4)
3944 (strikeout . 8)
3945 (overline . 16)
3946 (shadow . 32)
3947 (box . 64)
3948 (outline . 128))
3949 "Alist of all features and the corresponding bit mask.
3950Each symbol correspond to one bit in a bit vector.")
3951
3952\f
3953;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
a18ed129 3954;; Remapping Faces
87a16a06
RS
3955
3956
3957;;;###autoload
55732434
GM
3958(defun ps-extend-face-list (face-extension-list &optional merge-p alist-sym)
3959 "Extend face in ALIST-SYM.
87a16a06 3960
a18ed129 3961If optional MERGE-P is non-nil, extensions in FACE-EXTENSION-LIST are merged
55732434
GM
3962with face extension in ALIST-SYM; otherwise, overrides.
3963
01cdabc6 3964If optional ALIST-SYM is nil, `ps-print-face-extension-alist' is used;
55732434 3965otherwise, it should be an alist symbol.
87a16a06 3966
01cdabc6 3967The elements in FACE-EXTENSION-LIST are like those for `ps-extend-face'.
87a16a06
RS
3968
3969See `ps-extend-face' for documentation."
3970 (while face-extension-list
55732434 3971 (ps-extend-face (car face-extension-list) merge-p alist-sym)
87a16a06
RS
3972 (setq face-extension-list (cdr face-extension-list))))
3973
3974
3975;;;###autoload
55732434
GM
3976(defun ps-extend-face (face-extension &optional merge-p alist-sym)
3977 "Extend face in ALIST-SYM.
87a16a06 3978
6bdb808e 3979If optional MERGE-P is non-nil, extensions in FACE-EXTENSION list are merged
55732434
GM
3980with face extensions in ALIST-SYM; otherwise, overrides.
3981
01cdabc6 3982If optional ALIST-SYM is nil, `ps-print-face-extension-alist' is used;
55732434 3983otherwise, it should be an alist symbol.
87a16a06
RS
3984
3985The elements of FACE-EXTENSION list have the form:
3986
3987 (FACE-NAME FOREGROUND BACKGROUND EXTENSION...)
3988
3989FACE-NAME is a face name symbol.
3990
3991FOREGROUND and BACKGROUND may be nil or a string that denotes the
3992foreground and background colors respectively.
3993
3994EXTENSION is one of the following symbols:
3995 bold - use bold font.
3996 italic - use italic font.
3997 underline - put a line under text.
3998 strikeout - like underline, but the line is in middle of text.
3999 overline - like underline, but the line is over the text.
4000 shadow - text will have a shadow.
4001 box - text will be surrounded by a box.
a18ed129 4002 outline - print characters as hollow outlines.
87a16a06
RS
4003
4004If EXTENSION is any other symbol, it is ignored."
55732434
GM
4005 (or alist-sym
4006 (setq alist-sym 'ps-print-face-extension-alist))
4007 (let* ((background (nth 2 face-extension))
4008 (foreground (nth 1 face-extension))
4009 (face-name (nth 0 face-extension))
4010 (ps-face (cdr (assq face-name (symbol-value alist-sym))))
87a16a06 4011 (face-vector (or ps-face (vector 0 nil nil)))
55732434 4012 (face-bit (ps-extension-bit face-extension)))
87a16a06
RS
4013 ;; extend face
4014 (aset face-vector 0 (if merge-p
4015 (logior (aref face-vector 0) face-bit)
4016 face-bit))
55732434
GM
4017 (and (or (not merge-p) (and foreground (stringp foreground)))
4018 (aset face-vector 1 foreground))
4019 (and (or (not merge-p) (and background (stringp background)))
4020 (aset face-vector 2 background))
87a16a06
RS
4021 ;; if face does not exist, insert it
4022 (or ps-face
55732434
GM
4023 (set alist-sym (cons (cons face-name face-vector)
4024 (symbol-value alist-sym))))))
87a16a06
RS
4025
4026
4027(defun ps-extension-bit (face-extension)
4028 (let ((face-bit 0))
4029 ;; map valid symbol extension to bit vector
4030 (setq face-extension (cdr (cdr face-extension)))
4031 (while (setq face-extension (cdr face-extension))
4032 (setq face-bit (logior face-bit
4033 (or (cdr (assq (car face-extension)
4034 ps-print-face-map-alist))
4035 0))))
4036 face-bit))
4037
4038\f
857686a6 4039;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
bc0d41bd 4040;; Adapted from font-lock: (obsolete stuff)
857686a6
RS
4041;; Originally face attributes were specified via `font-lock-face-attributes'.
4042;; Users then changed the default face attributes by setting that variable.
4043;; However, we try and be back-compatible and respect its value if set except
4044;; for faces where M-x customize has been used to save changes for the face.
4045
0a5daee5 4046
857686a6
RS
4047(defun ps-font-lock-face-attributes ()
4048 (and (boundp 'font-lock-mode) (symbol-value 'font-lock-mode)
4049 (boundp 'font-lock-face-attributes)
3e9cb08f 4050 (let ((face-attributes (symbol-value 'font-lock-face-attributes)))
857686a6 4051 (while face-attributes
6bdb808e
RS
4052 (let* ((face-attribute
4053 (car (prog1 face-attributes
4054 (setq face-attributes (cdr face-attributes)))))
857686a6
RS
4055 (face (car face-attribute)))
4056 ;; Rustle up a `defface' SPEC from a
4057 ;; `font-lock-face-attributes' entry.
4058 (unless (get face 'saved-face)
4059 (let ((foreground (nth 1 face-attribute))
4060 (background (nth 2 face-attribute))
4061 (bold-p (nth 3 face-attribute))
4062 (italic-p (nth 4 face-attribute))
4063 (underline-p (nth 5 face-attribute))
4064 face-spec)
4065 (when foreground
4066 (setq face-spec (cons ':foreground
4067 (cons foreground face-spec))))
4068 (when background
4069 (setq face-spec (cons ':background
4070 (cons background face-spec))))
4071 (when bold-p
e31c1fd5 4072 (setq face-spec (append '(:weight bold) face-spec)))
857686a6 4073 (when italic-p
e31c1fd5 4074 (setq face-spec (append '(:slant italic) face-spec)))
857686a6
RS
4075 (when underline-p
4076 (setq face-spec (append '(:underline t) face-spec)))
4077 (custom-declare-face face (list (list t face-spec)) nil)
4078 )))))))
4079
4080\f
87a16a06
RS
4081;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4082;; Internal functions and variables
4083
4084
6b61353c
KH
4085(defun ps-message-log-max ()
4086 (and (not (string= (buffer-name) "*Messages*"))
9586e1d3 4087 (boundp 'message-log-max)
6b61353c
KH
4088 message-log-max))
4089
4090
374b7675
VJL
4091(defvar ps-print-hook nil)
4092(defvar ps-print-begin-sheet-hook nil)
4093(defvar ps-print-begin-page-hook nil)
4094(defvar ps-print-begin-column-hook nil)
12b88fff
RS
4095
4096
a18ed129 4097(defun ps-print-without-faces (from to &optional filename region-p)
857686a6 4098 (ps-spool-without-faces from to region-p)
87a16a06
RS
4099 (ps-do-despool filename))
4100
4101
a18ed129 4102(defun ps-spool-without-faces (from to &optional region-p)
6b61353c
KH
4103 (let ((message-log-max (ps-message-log-max))) ; to print *Messages* buffer
4104 (run-hooks 'ps-print-hook)
4105 (ps-printing-region region-p from to)
4106 (ps-generate (current-buffer) from to 'ps-generate-postscript)))
87a16a06
RS
4107
4108
a18ed129 4109(defun ps-print-with-faces (from to &optional filename region-p)
857686a6 4110 (ps-spool-with-faces from to region-p)
87a16a06
RS
4111 (ps-do-despool filename))
4112
4113
a18ed129 4114(defun ps-spool-with-faces (from to &optional region-p)
6b61353c
KH
4115 (let ((message-log-max (ps-message-log-max))) ; to print *Messages* buffer
4116 (run-hooks 'ps-print-hook)
4117 (ps-printing-region region-p from to)
4118 (ps-generate (current-buffer) from to 'ps-generate-postscript-with-faces)))
87a16a06
RS
4119
4120
55732434 4121(defun ps-count-lines-preprint (from to)
6b61353c
KH
4122 (or (and from to)
4123 (error "The mark is not set now"))
4124 (let ((message-log-max (ps-message-log-max))) ; to count lines of *Messages*
4125 (list (count-lines from to))))
55732434
GM
4126
4127
bc0d41bd 4128(defun ps-count-lines (from to)
a18ed129 4129 (+ (count-lines from to)
857686a6
RS
4130 (save-excursion
4131 (goto-char to)
4132 (if (= (current-column) 0) 1 0))))
87a16a06
RS
4133
4134
a18ed129 4135(defvar ps-printing-region nil
9586e1d3 4136 "Variable used to indicate the region that ps-print is printing.
bc0d41bd
KH
4137It is a cons, the car of which is the line number where the region begins, and
4138its cdr is the total number of lines in the buffer. Formatting functions can
4139use this information to print the original line number (and not the number of
4140lines printed), and to indicate in the header that the printout is of a partial
4141file.")
4142
4143
4144(defvar ps-printing-region-p nil
4145 "Non-nil means ps-print is printing a region.")
87a16a06
RS
4146
4147
e22ba851 4148(defun ps-printing-region (region-p from to)
bc0d41bd
KH
4149 (setq ps-printing-region-p region-p
4150 ps-printing-region
4151 (cons (if region-p
e22ba851 4152 (ps-count-lines (point-min) (min from to))
bc0d41bd
KH
4153 1)
4154 (ps-count-lines (point-min) (point-max)))))
87a16a06
RS
4155
4156\f
12d89a2e
RS
4157;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4158;; Internal functions
4159
0a5daee5 4160
7ae35a2f 4161(defsubst ps-font-alist (font-sym)
12b88fff
RS
4162 (get font-sym 'fonts))
4163
4164(defun ps-font (font-sym font-type)
4165 "Font family name for text of `font-type', when generating PostScript."
7ae35a2f 4166 (let* ((font-list (ps-font-alist font-sym))
12b88fff 4167 (normal-font (cdr (assq 'normal font-list))))
6bdb808e
RS
4168 (while (and font-list (not (eq font-type (car (car font-list)))))
4169 (setq font-list (cdr font-list)))
4170 (or (cdr (car font-list)) normal-font)))
12b88fff 4171
319acba0 4172(defsubst ps-fonts (font-sym)
7ae35a2f 4173 (mapcar 'cdr (ps-font-alist font-sym)))
12b88fff 4174
319acba0 4175(defsubst ps-font-number (font-sym font-type)
7ae35a2f 4176 (or (ps-alist-position font-type (ps-font-alist font-sym))
12b88fff
RS
4177 0))
4178
4179(defsubst ps-line-height (font-sym)
4180 "The height of a line, for generating PostScript.
4181This is the value that ps-print uses to determine the height,
4182y-dimension, of the lines of text it has printed, and thus affects the
4183point at which page-breaks are placed.
4184The line-height is *not* the same as the point size of the font."
4185 (get font-sym 'line-height))
4186
4187(defsubst ps-title-line-height (font-sym)
4188 "The height of a `title' line, for generating PostScript.
4189This is the value that ps-print uses to determine the height,
4190y-dimension, of the lines of text it has printed, and thus affects the
4191point at which page-breaks are placed.
4192The title-line-height is *not* the same as the point size of the font."
4193 (get font-sym 'title-line-height))
4194
4195(defsubst ps-space-width (font-sym)
4196 "The width of a space character, for generating PostScript.
4197This value is used in expanding tab characters."
4198 (get font-sym 'space-width))
4199
4200(defsubst ps-avg-char-width (font-sym)
4201 "The average width, in points, of a character, for generating PostScript.
4202This is the value that ps-print uses to determine the length,
4203x-dimension, of the text it has printed, and thus affects the point at
4204which long lines wrap around."
4205 (get font-sym 'avg-char-width))
4206
bcc0d457 4207(defun ps-line-lengths-internal ()
2285bf9d
RS
4208 "Display the correspondence between a line length and a font size.
4209Done using the current ps-print setup.
bcc0d457 4210Try: pr -t file | awk '{printf \"%3d %s\n\", length($0), $0}' | sort -r | head"
df5e6194
GM
4211 (let* ((ps-font-size-internal
4212 (or ps-font-size-internal
4213 (ps-get-font-size 'ps-font-size)))
4214 (ps-header-font-size-internal
4215 (or ps-header-font-size-internal
4216 (ps-get-font-size 'ps-header-font-size)))
4217 (ps-header-title-font-size-internal
4218 (or ps-header-title-font-size-internal
4219 (ps-get-font-size 'ps-header-title-font-size)))
4220 (buf (get-buffer-create "*Line-lengths*"))
4221 (ifs ps-font-size-internal) ; initial font size
4222 (icw (ps-avg-char-width 'ps-font-for-text)) ; initial character width
4223 (print-width (progn (ps-get-page-dimensions)
4224 ps-print-width))
4225 (ps-setup (ps-setup)) ; setup for the current buffer
4226 (fs-min 5) ; minimum font size
4227 cw-min ; minimum character width
4228 nb-cpl-max ; maximum nb of characters per line
4229 (fs-max 14) ; maximum font size
4230 cw-max ; maximum character width
4231 nb-cpl-min ; minimum nb of characters per line
4232 fs ; current font size
4233 cw ; current character width
4234 nb-cpl ; current nb of characters per line
4235 )
bcc0d457
RS
4236 (setq cw-min (/ (* icw fs-min) ifs)
4237 nb-cpl-max (floor (/ print-width cw-min))
4238 cw-max (/ (* icw fs-max) ifs)
8bd22fcf
KH
4239 nb-cpl-min (floor (/ print-width cw-max))
4240 nb-cpl nb-cpl-min)
bcc0d457
RS
4241 (set-buffer buf)
4242 (goto-char (point-max))
df5e6194 4243 (or (bobp) (insert "\n" (make-string 75 ?\;) "\n"))
8bd22fcf 4244 (insert ps-setup
df5e6194 4245 "\nnb char per line / font size\n")
bcc0d457 4246 (while (<= nb-cpl nb-cpl-max)
8bd22fcf
KH
4247 (setq cw (/ print-width (float nb-cpl))
4248 fs (/ (* ifs cw) icw))
df5e6194 4249 (insert (format "%16d %s\n" nb-cpl fs))
bcc0d457
RS
4250 (setq nb-cpl (1+ nb-cpl)))
4251 (insert "\n")
4252 (display-buffer buf 'not-this-window)))
4253
4254(defun ps-nb-pages (nb-lines)
496725ad
RS
4255 "Display correspondence between font size and the number of pages.
4256The correspondence is based on having NB-LINES lines of text,
4257and on the current ps-print setup."
df5e6194
GM
4258 (let* ((ps-font-size-internal
4259 (or ps-font-size-internal
4260 (ps-get-font-size 'ps-font-size)))
4261 (ps-header-font-size-internal
4262 (or ps-header-font-size-internal
4263 (ps-get-font-size 'ps-header-font-size)))
4264 (ps-header-title-font-size-internal
4265 (or ps-header-title-font-size-internal
4266 (ps-get-font-size 'ps-header-title-font-size)))
6bf5fb46
GM
4267 (ps-line-spacing-internal
4268 (or ps-line-spacing-internal
4269 (ps-get-size ps-line-spacing "line spacing")))
df5e6194 4270 (buf (get-buffer-create "*Nb-Pages*"))
6bf5fb46 4271 (ils ps-line-spacing-internal) ; initial line spacing
df5e6194
GM
4272 (ifs ps-font-size-internal) ; initial font size
4273 (ilh (ps-line-height 'ps-font-for-text)) ; initial line height
4274 (page-height (progn (ps-get-page-dimensions)
4275 ps-print-height))
4276 (ps-setup (ps-setup)) ; setup for the current buffer
4277 (fs-min 4) ; minimum font size
4278 lh-min ; minimum line height
4279 nb-lpp-max ; maximum nb of lines per page
4280 nb-page-min ; minimum nb of pages
4281 (fs-max 14) ; maximum font size
4282 lh-max ; maximum line height
4283 nb-lpp-min ; minimum nb of lines per page
4284 nb-page-max ; maximum nb of pages
4285 fs ; current font size
4286 lh ; current line height
4287 nb-lpp ; current nb of lines per page
4288 nb-page ; current nb of pages
4289 )
6bf5fb46 4290 (setq lh-min (/ (- (* (+ ilh ils) fs-min) ils) ifs)
bcc0d457
RS
4291 nb-lpp-max (floor (/ page-height lh-min))
4292 nb-page-min (ceiling (/ (float nb-lines) nb-lpp-max))
6bf5fb46 4293 lh-max (/ (- (* (+ ilh ils) fs-max) ils) ifs)
bcc0d457 4294 nb-lpp-min (floor (/ page-height lh-max))
8bd22fcf
KH
4295 nb-page-max (ceiling (/ (float nb-lines) nb-lpp-min))
4296 nb-page nb-page-min)
bcc0d457
RS
4297 (set-buffer buf)
4298 (goto-char (point-max))
df5e6194 4299 (or (bobp) (insert "\n" (make-string 75 ?\;) "\n"))
8bd22fcf 4300 (insert ps-setup
df5e6194 4301 (format "\nThere are %d lines.\n\n" nb-lines)
8bd22fcf 4302 "nb page / font size\n")
bcc0d457
RS
4303 (while (<= nb-page nb-page-max)
4304 (setq nb-lpp (ceiling (/ nb-lines (float nb-page)))
4305 lh (/ page-height nb-lpp)
4306 fs (/ (* ifs lh) ilh))
df5e6194 4307 (insert (format "%7d %s\n" nb-page fs))
bcc0d457
RS
4308 (setq nb-page (1+ nb-page)))
4309 (insert "\n")
4310 (display-buffer buf 'not-this-window)))
4311
6bdb808e
RS
4312;; macros used in `ps-select-font'
4313(defmacro ps-lookup (key) `(cdr (assq ,key font-entry)))
4314(defmacro ps-size-scale (key) `(/ (* (ps-lookup ,key) font-size) size))
4315
12b88fff
RS
4316(defun ps-select-font (font-family sym font-size title-font-size)
4317 (let ((font-entry (cdr (assq font-family ps-font-info-database))))
4318 (or font-entry
ef1159c2 4319 (error "Don't have data to scale font %s. Known fonts families are %s"
12b88fff
RS
4320 font-family
4321 (mapcar 'car ps-font-info-database)))
6bdb808e
RS
4322 (let ((size (ps-lookup 'size)))
4323 (put sym 'fonts (ps-lookup 'fonts))
4324 (put sym 'space-width (ps-size-scale 'space-width))
4325 (put sym 'avg-char-width (ps-size-scale 'avg-char-width))
4326 (put sym 'line-height (ps-size-scale 'line-height))
4327 (put sym 'title-line-height
4328 (/ (* (ps-lookup 'line-height) title-font-size) size)))))
bcc0d457 4329
12d89a2e 4330(defun ps-get-page-dimensions ()
bcc0d457
RS
4331 (let ((page-dimensions (cdr (assq ps-paper-type ps-page-dimensions-database)))
4332 page-width page-height)
4333 (cond
4334 ((null page-dimensions)
4335 (error "`ps-paper-type' must be one of:\n%s"
4336 (mapcar 'car ps-page-dimensions-database)))
4337 ((< ps-number-of-columns 1)
12b88fff 4338 (error "The number of columns %d should be positive"
8bd22fcf 4339 ps-number-of-columns)))
bcc0d457 4340
12b88fff 4341 (ps-select-font ps-font-family 'ps-font-for-text
7d8b7e8e 4342 ps-font-size-internal ps-font-size-internal)
12b88fff 4343 (ps-select-font ps-header-font-family 'ps-font-for-header
7d8b7e8e
KH
4344 ps-header-font-size-internal
4345 ps-header-title-font-size-internal)
319acba0
GM
4346 (ps-select-font ps-footer-font-family 'ps-font-for-footer
4347 ps-footer-font-size-internal ps-footer-font-size-internal)
bcc0d457
RS
4348
4349 (setq page-width (ps-page-dimensions-get-width page-dimensions)
4350 page-height (ps-page-dimensions-get-height page-dimensions))
4351
4352 ;; Landscape mode
4353 (if ps-landscape-mode
4354 ;; exchange width and height
4355 (setq page-width (prog1 page-height (setq page-height page-width))))
4356
4357 ;; It is used to get the lower right corner (only in landscape mode)
4358 (setq ps-landscape-page-height page-height)
4359
4360 ;; | lm | text | ic | text | ic | text | rm |
4361 ;; page-width == lm + n * pw + (n - 1) * ic + rm
4362 ;; => pw == (page-width - lm -rm - (n - 1) * ic) / n
8bd22fcf
KH
4363 (setq ps-print-width (/ (- page-width
4364 ps-left-margin ps-right-margin
4365 (* (1- ps-number-of-columns) ps-inter-column))
4366 ps-number-of-columns))
bcc0d457
RS
4367 (if (<= ps-print-width 0)
4368 (error "Bad horizontal layout:
4369page-width == %s
4370ps-left-margin == %s
4371ps-right-margin == %s
4372ps-inter-column == %s
4373ps-number-of-columns == %s
4374| lm | text | ic | text | ic | text | rm |
4375page-width == lm + n * print-width + (n - 1) * ic + rm
4376=> print-width == %d !"
4377 page-width
4378 ps-left-margin
4379 ps-right-margin
4380 ps-inter-column
4381 ps-number-of-columns
4382 ps-print-width))
4383
4384 (setq ps-print-height
4385 (- page-height ps-bottom-margin ps-top-margin))
4386 (if (<= ps-print-height 0)
4387 (error "Bad vertical layout:
4388ps-top-margin == %s
4389ps-bottom-margin == %s
4390page-height == bm + print-height + tm
4391=> print-height == %d !"
4392 ps-top-margin
4393 ps-bottom-margin
4394 ps-print-height))
319acba0
GM
4395 ;; If headers are turned on, deduct the height of the header from the print
4396 ;; height.
8bd22fcf 4397 (if ps-print-header
12b88fff
RS
4398 (setq ps-header-pad (* ps-header-line-pad
4399 (ps-title-line-height 'ps-font-for-header))
8bd22fcf
KH
4400 ps-print-height (- ps-print-height
4401 ps-header-offset
4402 ps-header-pad
12b88fff
RS
4403 (ps-title-line-height 'ps-font-for-header)
4404 (* (ps-line-height 'ps-font-for-header)
4405 (1- ps-header-lines))
8bd22fcf 4406 ps-header-pad)))
bcc0d457 4407 (if (<= ps-print-height 0)
319acba0 4408 (error "Bad vertical layout (header):
bcc0d457
RS
4409ps-top-margin == %s
4410ps-bottom-margin == %s
4411ps-header-offset == %s
4412ps-header-pad == %s
4413header-height == %s
4414page-height == bm + print-height + tm - ho - hh
4415=> print-height == %d !"
4416 ps-top-margin
4417 ps-bottom-margin
4418 ps-header-offset
4419 ps-header-pad
4420 (+ ps-header-pad
12b88fff
RS
4421 (ps-title-line-height 'ps-font-for-header)
4422 (* (ps-line-height 'ps-font-for-header)
4423 (1- ps-header-lines))
bcc0d457 4424 ps-header-pad)
2bd80d73 4425 ps-print-height))
319acba0
GM
4426 ;; If footers are turned on, deduct the height of the footer from the print
4427 ;; height.
4428 (if ps-print-footer
4429 (setq ps-footer-pad (* ps-footer-line-pad
4430 (ps-title-line-height 'ps-font-for-footer))
4431 ps-print-height (- ps-print-height
4432 ps-footer-offset
4433 ps-footer-pad
4434 (* (ps-line-height 'ps-font-for-footer)
4435 (1- ps-footer-lines))
4436 ps-footer-pad)))
4437 (if (<= ps-print-height 0)
4438 (error "Bad vertical layout (footer):
4439ps-top-margin == %s
4440ps-bottom-margin == %s
4441ps-footer-offset == %s
4442ps-footer-pad == %s
4443footer-height == %s
4444page-height == bm + print-height + tm - fo - fh
4445=> print-height == %d !"
4446 ps-top-margin
4447 ps-bottom-margin
4448 ps-footer-offset
4449 ps-footer-pad
4450 (+ ps-footer-pad
4451 (* (ps-line-height 'ps-font-for-footer)
4452 (1- ps-footer-lines))
4453 ps-footer-pad)
4454 ps-print-height))
2bd80d73
GM
4455 ;; ps-zebra-stripe-follow is `full' or `full-follow'
4456 (if ps-zebra-stripe-full-p
4457 (let* ((line-height (ps-line-height 'ps-font-for-text))
6bf5fb46
GM
4458 (zebra (* (+ line-height ps-line-spacing-internal)
4459 ps-zebra-stripe-height)))
2bd80d73
GM
4460 (setq ps-print-height (- (* (floor ps-print-height zebra) zebra)
4461 line-height))
4462 (if (<= ps-print-height 0)
319acba0 4463 (error "Bad vertical layout (full zebra stripe follow):
2bd80d73
GM
4464ps-zebra-stripe-follow == %s
4465ps-zebra-stripe-height == %s
4466font-text-height == %s
6bf5fb46
GM
4467line-spacing == %s
4468page-height == ((floor print-height ((th + ls) * zh)) * ((th + ls) * zh)) - th
2bd80d73
GM
4469=> print-height == %d !"
4470 ps-zebra-stripe-follow
4471 ps-zebra-stripe-height
4472 (ps-line-height 'ps-font-for-text)
6bf5fb46 4473 ps-line-spacing-internal
2bd80d73 4474 ps-print-height))))))
ef2cbb24 4475
55732434
GM
4476
4477(defun ps-print-preprint-region (prefix-arg)
509b4dbc 4478 (or (ps-mark-active-p)
55732434
GM
4479 (error "The mark is not set now"))
4480 (list (point) (mark) (ps-print-preprint prefix-arg)))
4481
4482
edc9cd35
GM
4483(defun ps-print-preprint (prefix-arg)
4484 (and prefix-arg
4485 (or (numberp prefix-arg)
4486 (listp prefix-arg))
d3ab8dac
KH
4487 (let* ((name (concat (file-name-nondirectory (or (buffer-file-name)
4488 (buffer-name)))
4489 ".ps"))
5b76833f 4490 (prompt (format "Save PostScript to file (default %s): " name))
8bd22fcf 4491 (res (read-file-name prompt default-directory name nil)))
ea0c615d
GM
4492 (while (cond ((file-directory-p res)
4493 (ding)
4494 (setq prompt "It's a directory"))
4495 ((not (file-writable-p res))
d3ab8dac 4496 (ding)
ea0c615d 4497 (setq prompt "File is unwritable"))
d3ab8dac 4498 ((file-exists-p res)
ea0c615d 4499 (setq prompt "File exists")
d3ab8dac
KH
4500 (not (y-or-n-p (format "File `%s' exists; overwrite? "
4501 res))))
4502 (t nil))
4503 (setq res (read-file-name
ea0c615d 4504 (format "%s; save PostScript to file: " prompt)
d3ab8dac
KH
4505 (file-name-directory res) nil nil
4506 (file-name-nondirectory res))))
8bd22fcf
KH
4507 (if (file-directory-p res)
4508 (expand-file-name name (file-name-as-directory res))
4509 res))))
12d89a2e
RS
4510
4511;; The following functions implement a simple list-buffering scheme so
4512;; that ps-print doesn't have to repeatedly switch between buffers
857686a6
RS
4513;; while spooling. The functions `ps-output' and `ps-output-string' build
4514;; up the lists; the function `ps-flush-output' takes the lists and
12d89a2e
RS
4515;; insert its contents into the spool buffer (*PostScript*).
4516
857686a6
RS
4517(defvar ps-string-escape-codes
4518 (let ((table (make-vector 256 nil))
4519 (char ?\000))
4520 ;; control characters
4521 (while (<= char ?\037)
4522 (aset table char (format "\\%03o" char))
4523 (setq char (1+ char)))
4524 ;; printable characters
4525 (while (< char ?\177)
4526 (aset table char (format "%c" char))
4527 (setq char (1+ char)))
4528 ;; DEL and 8-bit characters
4529 (while (<= char ?\377)
4530 (aset table char (format "\\%o" char))
4531 (setq char (1+ char)))
4532 ;; Override ASCII formatting characters with named escape code:
4533 (aset table ?\n "\\n") ; [NL] linefeed
4534 (aset table ?\r "\\r") ; [CR] carriage return
4535 (aset table ?\t "\\t") ; [HT] horizontal tab
4536 (aset table ?\b "\\b") ; [BS] backspace
4537 (aset table ?\f "\\f") ; [NP] form feed
4538 ;; Escape PostScript escape and string delimiter characters:
4539 (aset table ?\\ "\\\\")
4540 (aset table ?\( "\\(")
4541 (aset table ?\) "\\)")
4542 table)
4543 "Vector used to map characters to PostScript string escape codes.")
4544
6bf5fb46 4545(defsubst ps-output-string-prim (string)
12d89a2e
RS
4546 (insert "(") ;insert start-string delimiter
4547 (save-excursion ;insert string
e65df0a1 4548 (insert (string-as-unibyte string)))
12d89a2e 4549 ;; Find and quote special characters as necessary for PS
c82b4a75 4550 ;; This skips everything except control chars, non-ASCII chars, (, ) and \.
b61e2c11
RS
4551 (while (progn (skip-chars-forward " -'*-[]-~") (not (eobp)))
4552 (let ((special (following-char)))
e65df0a1 4553 (delete-char 1)
c794a94d
JB
4554 (insert
4555 (if (and (<= 0 special) (<= special 255))
4556 (aref ps-string-escape-codes special)
4557 ;; insert hexadecimal representation if character code is out of range
4558 (format "\\%04X" special)
4559 ))))
12d89a2e
RS
4560 (goto-char (point-max))
4561 (insert ")")) ;insert end-string delimiter
ef2cbb24 4562
6bf5fb46 4563(defsubst ps-init-output-queue ()
1fd9b7fe 4564 (setq ps-output-head (list "")
8bd22fcf 4565 ps-output-tail ps-output-head))
ef2cbb24 4566
1fd9b7fe
GM
4567
4568(defun ps-selected-pages ()
4569 (while (progn
4570 (setq ps-first-page (car (car ps-selected-pages))
4571 ps-last-page (cdr (car ps-selected-pages))
4572 ps-selected-pages (cdr ps-selected-pages))
4573 (and ps-selected-pages
4574 (< ps-last-page ps-page-postscript)))))
4575
4576
6bf5fb46 4577(defsubst ps-print-page-p ()
ea0c615d
GM
4578 (setq ps-print-page-p
4579 (and (cond ((null ps-first-page))
4580 ((<= ps-page-postscript ps-last-page)
4581 (<= ps-first-page ps-page-postscript))
4582 (ps-selected-pages
4583 (ps-selected-pages)
4584 (and (<= ps-first-page ps-page-postscript)
4585 (<= ps-page-postscript ps-last-page)))
4586 (t
4587 nil))
4b3eb10f 4588 (cond ((eq ps-even-or-odd-pages 'even-page)
ea0c615d 4589 (= (logand ps-page-postscript 1) 0))
4b3eb10f 4590 ((eq ps-even-or-odd-pages 'odd-page)
ea0c615d
GM
4591 (= (logand ps-page-postscript 1) 1))
4592 (t)
4593 ))))
1fd9b7fe
GM
4594
4595
6bf5fb46 4596(defsubst ps-print-sheet-p ()
4b3eb10f
GM
4597 (setq ps-print-page-p
4598 (cond ((eq ps-even-or-odd-pages 'even-sheet)
4599 (= (logand ps-page-sheet 1) 0))
4600 ((eq ps-even-or-odd-pages 'odd-sheet)
4601 (= (logand ps-page-sheet 1) 1))
4602 (t)
4603 )))
4604
4605
12d89a2e 4606(defun ps-output (&rest args)
ea0c615d 4607 (when ps-print-page-p
1fd9b7fe
GM
4608 (setcdr ps-output-tail args)
4609 (while (cdr ps-output-tail)
4610 (setq ps-output-tail (cdr ps-output-tail)))))
ef2cbb24 4611
12d89a2e
RS
4612(defun ps-output-string (string)
4613 (ps-output t string))
ef2cbb24 4614
e65df0a1
KH
4615;; Output strings in the list ARGS in the PostScript prologue part.
4616(defun ps-output-prologue (args)
4617 (ps-output 'prologue (if (stringp args) (list args) args)))
4618
12d89a2e
RS
4619(defun ps-flush-output ()
4620 (save-excursion
4621 (set-buffer ps-spool-buffer)
4622 (goto-char (point-max))
4623 (while ps-output-head
4624 (let ((it (car ps-output-head)))
e65df0a1
KH
4625 (cond
4626 ((eq t it)
4627 (setq ps-output-head (cdr ps-output-head))
4628 (ps-output-string-prim (car ps-output-head)))
4629 ((eq 'prologue it)
12d89a2e 4630 (setq ps-output-head (cdr ps-output-head))
e65df0a1
KH
4631 (save-excursion
4632 (search-backward "\nBeginDoc")
4633 (forward-char 1)
4634 (apply 'insert (car ps-output-head))))
4635 (t
4636 (insert it))))
12d89a2e
RS
4637 (setq ps-output-head (cdr ps-output-head))))
4638 (ps-init-output-queue))
4639
4640(defun ps-insert-file (fname)
4641 (ps-flush-output)
12d89a2e
RS
4642 (save-excursion
4643 (set-buffer ps-spool-buffer)
4644 (goto-char (point-max))
b6d0ac87 4645 (insert-file-contents fname)))
06fb6aab 4646
319acba0 4647;; These functions insert the arrays that define the contents of the headers.
ef2cbb24 4648
374b7675 4649(defvar ps-encode-header-string-function nil)
f07bb446 4650
12d89a2e 4651(defun ps-generate-header-line (fonttag &optional content)
319acba0 4652 (ps-output " [" fonttag " ")
12d89a2e 4653 (cond
319acba0
GM
4654 ;; Literal strings should be output as is -- the string must contain its own
4655 ;; PS string delimiters, '(' and ')', if necessary.
12d89a2e 4656 ((stringp content)
f07bb446 4657 (ps-output content))
12d89a2e 4658
319acba0
GM
4659 ;; Functions are called -- they should return strings; they will be inserted
4660 ;; as strings and the PS string delimiters added.
5c538596
MB
4661 ((fboundp content)
4662 (if (fboundp ps-encode-header-string-function)
4663 (dolist (l (funcall ps-encode-header-string-function
4664 (funcall content) fonttag))
4665 (ps-output-string l))
4666 (ps-output-string (funcall content))))
12d89a2e 4667
319acba0
GM
4668 ;; Variables will have their contents inserted. They should contain
4669 ;; strings, and will be inserted as strings.
12d89a2e 4670 ((and (symbolp content) (boundp content))
f07bb446
KH
4671 (if (fboundp ps-encode-header-string-function)
4672 (dolist (l (funcall ps-encode-header-string-function
4673 (symbol-value content) fonttag))
4674 (ps-output-string l))
4675 (ps-output-string (symbol-value content))))
12d89a2e
RS
4676
4677 ;; Anything else will get turned into an empty string.
4678 (t
4679 (ps-output-string "")))
319acba0 4680 (ps-output "]\n"))
12d89a2e 4681
319acba0
GM
4682(defun ps-generate-header (name fonttag0 fonttag1 contents)
4683 (ps-output "/" name "[\n")
4684 (and contents (> ps-header-lines 0)
4685 (let ((count 1))
4686 (ps-generate-header-line fonttag0 (car contents))
4687 (while (and (< count ps-header-lines)
4688 (setq contents (cdr contents)))
4689 (ps-generate-header-line fonttag1 (car contents))
4690 (setq count (1+ count)))))
4691 (ps-output "]def\n"))
12d89a2e 4692
bc0d41bd 4693
6e1b1da6
GM
4694(defun ps-output-boolean (name bool)
4695 (ps-output (format "/%s %s def\n" name (if bool "true" "false"))))
ef2cbb24 4696
06fb6aab 4697
319acba0
GM
4698(defun ps-output-frame-properties (name alist)
4699 (ps-output "/" name " ["
efa89c1f 4700 (ps-format-color (cdr (assq 'fore-color alist)) 0.0)
319acba0
GM
4701 (ps-format-color (cdr (assq 'back-color alist)) 0.9)
4702 (ps-float-format (or (cdr (assq 'border-width alist)) 0.4))
efa89c1f
GM
4703 (ps-format-color (cdr (assq 'border-color alist)) 0.0)
4704 (ps-format-color (cdr (assq 'shadow-color alist)) 0.0)
319acba0
GM
4705 "]def\n"))
4706
4707
87a16a06
RS
4708(defun ps-background-pages (page-list func)
4709 (if page-list
4710 (mapcar
bc0d41bd
KH
4711 #'(lambda (pages)
4712 (let ((start (if (consp pages) (car pages) pages))
4713 (end (if (consp pages) (cdr pages) pages)))
4714 (and (integerp start) (integerp end) (<= start end)
4715 (add-to-list 'ps-background-pages (vector start end func)))))
87a16a06
RS
4716 page-list)
4717 (setq ps-background-all-pages (cons func ps-background-all-pages))))
4718
4719
bc0d41bd
KH
4720(defconst ps-boundingbox-re
4721 "^%%BoundingBox:\
4722\\s-+\\([0-9.]+\\)\\s-+\\([0-9.]+\\)\\s-+\\([0-9.]+\\)\\s-+\\([0-9.]+\\)")
4723
4724
87a16a06
RS
4725(defun ps-get-boundingbox ()
4726 (save-excursion
4727 (set-buffer ps-spool-buffer)
4728 (save-excursion
bc0d41bd 4729 (if (re-search-forward ps-boundingbox-re nil t)
87a16a06
RS
4730 (vector (string-to-number ; lower x
4731 (buffer-substring (match-beginning 1) (match-end 1)))
4732 (string-to-number ; lower y
4733 (buffer-substring (match-beginning 2) (match-end 2)))
4734 (string-to-number ; upper x
4735 (buffer-substring (match-beginning 3) (match-end 3)))
4736 (string-to-number ; upper y
4737 (buffer-substring (match-beginning 4) (match-end 4))))
4738 (vector 0 0 0 0)))))
4739
4740
87a16a06
RS
4741(defun ps-float-format (value &optional default)
4742 (let ((literal (or value default)))
efa89c1f
GM
4743 (cond ((null literal)
4744 " ")
4745 ((numberp literal)
4746 (format ps-float-format (* literal 1.0))) ; force float number
4747 (t
4748 (format "%s " literal))
4749 )))
87a16a06
RS
4750
4751
4752(defun ps-background-text ()
4753 (mapcar
bc0d41bd
KH
4754 #'(lambda (text)
4755 (setq ps-background-text-count (1+ ps-background-text-count))
c3d6d211 4756 (ps-output (format "/ShowBackText-%d{\n" ps-background-text-count))
bc0d41bd
KH
4757 (ps-output-string (nth 0 text)) ; text
4758 (ps-output
4759 "\n"
4760 (ps-float-format (nth 4 text) 200.0) ; font size
4761 (format "/%s " (or (nth 3 text) "Times-Roman")) ; font name
4762 (ps-float-format (nth 6 text)
4763 "PrintHeight PrintPageWidth atan") ; rotation
4764 (ps-float-format (nth 5 text) 0.85) ; gray
4765 (ps-float-format (nth 1 text) "0") ; x position
8e234846 4766 (ps-float-format (nth 2 text) "0") ; y position
c3d6d211 4767 "\nShowBackText}def\n")
bc0d41bd
KH
4768 (ps-background-pages (nthcdr 7 text) ; page list
4769 (format "ShowBackText-%d\n"
4770 ps-background-text-count)))
87a16a06
RS
4771 ps-print-background-text))
4772
4773
4774(defun ps-background-image ()
4775 (mapcar
bc0d41bd
KH
4776 #'(lambda (image)
4777 (let ((image-file (expand-file-name (nth 0 image))))
41481e4b
KH
4778 (when (file-readable-p image-file)
4779 (setq ps-background-image-count (1+ ps-background-image-count))
4780 (ps-output
c3d6d211 4781 (format "/ShowBackImage-%d{\n--back-- "
41481e4b
KH
4782 ps-background-image-count)
4783 (ps-float-format (nth 5 image) 0.0) ; rotation
4784 (ps-float-format (nth 3 image) 1.0) ; x scale
4785 (ps-float-format (nth 4 image) 1.0) ; y scale
4786 (ps-float-format (nth 1 image) ; x position
4787 "PrintPageWidth 2 div")
4788 (ps-float-format (nth 2 image) ; y position
4789 "PrintHeight 2 div BottomMargin add")
4790 "\nBeginBackImage\n")
4791 (ps-insert-file image-file)
01cdabc6 4792 ;; coordinate adjustment to center image
41481e4b
KH
4793 ;; around x and y position
4794 (let ((box (ps-get-boundingbox)))
4795 (save-excursion
4796 (set-buffer ps-spool-buffer)
4797 (save-excursion
4798 (if (re-search-backward "^--back--" nil t)
4799 (replace-match
4800 (format "%s %s"
4801 (ps-float-format
4802 (- (+ (/ (- (aref box 2) (aref box 0)) 2.0)
4803 (aref box 0))))
4804 (ps-float-format
4805 (- (+ (/ (- (aref box 3) (aref box 1)) 2.0)
4806 (aref box 1)))))
4807 t)))))
c3d6d211 4808 (ps-output "\nEndBackImage}def\n")
41481e4b
KH
4809 (ps-background-pages (nthcdr 6 image) ; page list
4810 (format "ShowBackImage-%d\n"
4811 ps-background-image-count)))))
87a16a06
RS
4812 ps-print-background-image))
4813
4814
a18ed129 4815(defun ps-background (page-number)
87a16a06 4816 (let (has-local-background)
42af7493
VJL
4817 (mapc #'(lambda (range)
4818 (and (<= (aref range 0) page-number)
4819 (<= page-number (aref range 1))
4820 (if has-local-background
4821 (ps-output (aref range 2))
4822 (setq has-local-background t)
4823 (ps-output "/printLocalBackground{\n"
4824 (aref range 2)))))
4825 ps-background-pages)
c3d6d211 4826 (and has-local-background (ps-output "}def\n"))))
87a16a06
RS
4827
4828
0140c600
EZ
4829;; Return a list of the distinct elements of LIST.
4830;; Elements are compared with `equal'.
4831(defun ps-remove-duplicates (list)
4832 (let (new (tail list))
4833 (while tail
4834 (or (member (car tail) new)
4835 (setq new (cons (car tail) new)))
4836 (setq tail (cdr tail)))
4837 (nreverse new)))
4838
c82b4a75 4839
6bdb808e
RS
4840;; Find the first occurrence of ITEM in LIST.
4841;; Return the index of the matching item, or nil if not found.
4842;; Elements are compared with `eq'.
7ae35a2f 4843(defun ps-alist-position (item list)
6bdb808e
RS
4844 (let ((tail list) (index 0) found)
4845 (while tail
7ae35a2f 4846 (if (setq found (eq (car (car tail)) item))
6bdb808e
RS
4847 (setq tail nil)
4848 (setq index (1+ index)
4849 tail (cdr tail))))
4850 (and found index)))
4851
4852
bc0d41bd
KH
4853(defconst ps-n-up-database
4854 '((a4
4855 (1 nil 1 1 0)
4856 (2 t 1 2 0)
4857 (4 nil 2 2 0)
4858 (6 t 2 3 1)
4859 (8 t 2 4 0)
4860 (9 nil 3 3 0)
4861 (12 t 3 4 2)
4862 (16 nil 4 4 0)
4863 (18 t 3 6 0)
4864 (20 nil 5 4 1)
4865 (25 nil 5 5 0)
4866 (30 nil 6 5 1)
4867 (32 t 4 8 0)
4868 (36 nil 6 6 0)
4869 (42 nil 7 6 1)
4870 (49 nil 7 7 0)
4871 (50 t 5 10 0)
4872 (56 nil 8 7 1)
4873 (64 nil 8 8 0)
4874 (72 nil 9 8 1)
4875 (81 nil 9 9 0)
4876 (90 nil 10 9 1)
4877 (100 nil 10 10 0))
4878 (a3
4879 (1 nil 1 1 0)
4880 (2 t 1 2 0)
4881 (4 nil 2 2 0)
4882 (6 t 2 3 1)
4883 (8 t 2 4 0)
4884 (9 nil 3 3 0)
4885 (12 nil 4 3 1)
4886 (16 nil 4 4 0)
4887 (18 t 3 6 0)
4888 (20 nil 5 4 1)
4889 (25 nil 5 5 0)
4890 (30 nil 6 5 1)
4891 (32 t 4 8 0)
4892 (36 nil 6 6 0)
4893 (42 nil 7 6 1)
4894 (49 nil 7 7 0)
4895 (50 t 5 10 0)
4896 (56 nil 8 7 1)
4897 (64 nil 8 8 0)
4898 (72 nil 9 8 1)
4899 (81 nil 9 9 0)
4900 (90 nil 10 9 1)
4901 (100 nil 10 10 0))
4902 (letter
4903 (1 nil 1 1 0)
8e234846 4904 (2 t 1 2 0) ; adjusted by PostScript code
bc0d41bd
KH
4905 (4 nil 2 2 0)
4906 (6 t 2 3 0)
4907 (9 nil 3 3 0)
4908 (12 nil 4 3 1)
4909 (16 nil 4 4 0)
4910 (20 nil 5 4 1)
4911 (25 nil 5 5 0)
4912 (30 nil 6 5 1)
4913 (36 nil 6 6 0)
4914 (40 t 5 8 0)
4915 (42 nil 7 6 1)
4916 (49 nil 7 7 0)
4917 (56 nil 8 7 1)
4918 (64 nil 8 8 0)
4919 (72 nil 9 8 1)
4920 (81 nil 9 9 0)
4921 (90 nil 10 9 1)
4922 (100 nil 10 10 0))
4923 (legal
4924 (1 nil 1 1 0)
4925 (2 t 1 2 0)
4926 (4 nil 2 2 0)
4927 (6 nil 3 2 1)
4928 (9 nil 3 3 0)
4929 (10 t 2 5 0)
4930 (12 nil 4 3 1)
4931 (16 nil 4 4 0)
4932 (20 nil 5 4 1)
4933 (25 nil 5 5 0)
4934 (30 nil 6 5 1)
4935 (36 nil 6 6 0)
4936 (42 nil 7 6 1)
4937 (49 nil 7 7 0)
4938 (56 nil 8 7 1)
4939 (64 nil 8 8 0)
4940 (70 t 5 14 0)
4941 (72 nil 9 8 1)
4942 (81 nil 9 9 0)
4943 (90 nil 10 9 1)
4944 (100 nil 10 10 0))
4945 (letter-small
4946 (1 nil 1 1 0)
8e234846 4947 (2 t 1 2 0) ; adjusted by PostScript code
bc0d41bd
KH
4948 (4 nil 2 2 0)
4949 (6 t 2 3 0)
4950 (9 nil 3 3 0)
4951 (12 t 3 4 1)
4952 (15 t 3 5 0)
4953 (16 nil 4 4 0)
4954 (20 nil 5 4 1)
4955 (25 nil 5 5 0)
4956 (28 t 4 7 0)
4957 (30 nil 6 5 1)
4958 (36 nil 6 6 0)
4959 (40 t 5 8 0)
4960 (42 nil 7 6 1)
4961 (49 nil 7 7 0)
4962 (56 nil 8 7 1)
4963 (60 t 6 10 0)
4964 (64 nil 8 8 0)
4965 (72 ni 9 8 1)
4966 (81 nil 9 9 0)
4967 (84 t 7 12 0)
4968 (90 nil 10 9 1)
4969 (100 nil 10 10 0))
4970 (tabloid
4971 (1 nil 1 1 0)
4972 (2 t 1 2 0)
4973 (4 nil 2 2 0)
4974 (6 t 2 3 1)
4975 (8 t 2 4 0)
4976 (9 nil 3 3 0)
4977 (12 nil 4 3 1)
4978 (16 nil 4 4 0)
4979 (20 nil 5 4 1)
4980 (25 nil 5 5 0)
4981 (30 nil 6 5 1)
4982 (36 nil 6 6 0)
4983 (42 nil 7 6 1)
4984 (49 nil 7 7 0)
4985 (56 nil 8 7 1)
4986 (64 nil 8 8 0)
4987 (72 nil 9 8 1)
4988 (81 nil 9 9 0)
4989 (84 t 6 14 0)
4990 (90 nil 10 9 1)
4991 (100 nil 10 10 0))
4992 ;; Ledger paper size is a special case, it is the only paper size where the
4993 ;; normal size is landscaped, that is, the height is smaller than width.
4994 ;; So, we use the special value `pag' in the `landscape' field.
4995 (ledger
4996 (1 nil 1 1 0)
4997 (2 pag 1 2 0)
4998 (4 nil 2 2 0)
4999 (6 pag 2 3 1)
5000 (8 pag 2 4 0)
5001 (9 nil 3 3 0)
5002 (12 nil 4 3 1)
5003 (16 nil 4 4 0)
5004 (20 nil 5 4 1)
5005 (25 nil 5 5 0)
5006 (30 nil 6 5 1)
5007 (36 nil 6 6 0)
5008 (42 nil 7 6 1)
5009 (49 nil 7 7 0)
5010 (56 nil 8 7 1)
5011 (64 nil 8 8 0)
5012 (72 nil 9 8 1)
5013 (81 nil 9 9 0)
5014 (84 pag 6 14 0)
5015 (90 nil 10 9 1)
5016 (100 nil 10 10 0))
5017 (statement
5018 (1 nil 1 1 0)
5019 (2 t 1 2 0)
5020 (4 nil 2 2 0)
5021 (6 nil 3 2 1)
5022 (9 nil 3 3 0)
5023 (10 t 2 5 0)
5024 (12 nil 4 3 1)
5025 (16 nil 4 4 0)
5026 (20 nil 5 4 1)
5027 (21 t 3 7 0)
5028 (25 nil 5 5 0)
5029 (30 nil 6 5 1)
5030 (36 nil 6 6 0)
5031 (40 t 4 10 0)
5032 (42 nil 7 6 1)
5033 (49 nil 7 7 0)
5034 (56 nil 8 7 1)
5035 (60 t 5 12 0)
5036 (64 nil 8 8 0)
5037 (72 nil 9 8 1)
5038 (81 nil 9 9 0)
5039 (90 nil 10 9 1)
5040 (100 nil 10 10 0))
5041 (executive
5042 (1 nil 1 1 0)
8e234846 5043 (2 t 1 2 0) ; adjusted by PostScript code
bc0d41bd
KH
5044 (4 nil 2 2 0)
5045 (6 t 2 3 0)
5046 (9 nil 3 3 0)
5047 (12 nil 4 3 1)
5048 (16 nil 4 4 0)
5049 (20 nil 5 4 1)
5050 (25 nil 5 5 0)
5051 (28 t 4 7 0)
5052 (30 nil 6 5 1)
5053 (36 nil 6 6 0)
5054 (42 nil 7 6 1)
5055 (45 t 5 9 0)
5056 (49 nil 7 7 0)
5057 (56 nil 8 7 1)
5058 (60 t 6 10 0)
5059 (64 nil 8 8 0)
5060 (72 nil 9 8 1)
5061 (81 nil 9 9 0)
5062 (84 t 7 12 0)
5063 (90 nil 10 9 1)
5064 (100 nil 10 10 0))
5065 (a4small
5066 (1 nil 1 1 0)
5067 (2 t 1 2 0)
5068 (4 nil 2 2 0)
5069 (6 t 2 3 1)
5070 (8 t 2 4 0)
5071 (9 nil 3 3 0)
5072 (12 nil 4 3 1)
5073 (16 nil 4 4 0)
5074 (18 t 3 6 0)
5075 (20 nil 5 4 1)
5076 (25 nil 5 5 0)
5077 (30 nil 6 5 1)
5078 (32 t 4 8 0)
5079 (36 nil 6 6 0)
5080 (42 nil 7 6 1)
5081 (49 nil 7 7 0)
5082 (50 t 5 10 0)
5083 (56 nil 8 7 1)
5084 (64 nil 8 8 0)
5085 (72 nil 9 8 1)
5086 (78 t 6 13 0)
5087 (81 nil 9 9 0)
5088 (90 nil 10 9 1)
5089 (100 nil 10 10 0))
5090 (b4
5091 (1 nil 1 1 0)
5092 (2 t 1 2 0)
5093 (4 nil 2 2 0)
5094 (6 t 2 3 1)
5095 (8 t 2 4 0)
5096 (9 nil 3 3 0)
5097 (12 nil 4 3 1)
5098 (16 nil 4 4 0)
5099 (18 t 3 6 0)
5100 (20 nil 5 4 1)
5101 (25 nil 5 5 0)
5102 (30 nil 6 5 1)
5103 (32 t 4 8 0)
5104 (36 nil 6 6 0)
5105 (42 nil 7 6 1)
5106 (49 nil 7 7 0)
5107 (50 t 5 10 0)
5108 (56 nil 8 7 1)
5109 (64 nil 8 8 0)
5110 (72 nil 9 8 1)
5111 (81 nil 9 9 0)
5112 (90 nil 10 9 1)
5113 (100 nil 10 10 0))
5114 (b5
5115 (1 nil 1 1 0)
5116 (2 t 1 2 0)
5117 (4 nil 2 2 0)
5118 (6 t 2 3 1)
5119 (8 t 2 4 0)
5120 (9 nil 3 3 0)
5121 (12 nil 4 3 1)
5122 (16 nil 4 4 0)
5123 (18 t 3 6 0)
5124 (20 nil 5 4 1)
5125 (25 nil 5 5 0)
5126 (30 nil 6 5 1)
5127 (32 t 4 8 0)
5128 (36 nil 6 6 0)
5129 (42 nil 7 6 1)
5130 (49 nil 7 7 0)
5131 (50 t 5 10 0)
5132 (56 nil 8 7 1)
5133 (64 nil 8 8 0)
5134 (72 nil 9 8 0)
5135 (81 nil 9 9 0)
5136 (90 nil 10 9 1)
5137 (98 t 7 14 0)
5138 (100 nil 10 10 0)))
5139 "Alist which is the page matrix database used for N-up printing.
5140
5141Each element has the following form:
5142
5143 (PAGE
5144 (MAX LANDSCAPE LINES COLUMNS COL-MISSING)
5145 ...)
5146
5147Where:
5148PAGE is the page size used (see `ps-paper-type').
5149MAX is the maximum elements of this page matrix.
5150LANDSCAPE specifies if page matrix is landscaped, has the following valid
5151 values:
5152 nil the sheet is in portrait mode.
5153 t the sheet is in landscape mode.
5154 pag the sheet is in portrait mode and page is in landscape mode.
5155LINES is the number of lines of page matrix.
5156COLUMNS is the number of columns of page matrix.
5157COL-MISSING is the number of columns missing to fill the sheet.")
5158
5159
5160(defmacro ps-n-up-landscape (mat) `(nth 1 ,mat))
5161(defmacro ps-n-up-lines (mat) `(nth 2 ,mat))
5162(defmacro ps-n-up-columns (mat) `(nth 3 ,mat))
5163(defmacro ps-n-up-missing (mat) `(nth 4 ,mat))
5164
5165
5166(defun ps-n-up-printing ()
5167 ;; force `ps-n-up-printing' be in range 1 to 100.
5168 (setq ps-n-up-printing (max (min ps-n-up-printing 100) 1))
5169 ;; find suitable page matrix for a given `ps-paper-type'.
5170 (let ((the-list (cdr (assq ps-paper-type ps-n-up-database))))
5171 (and the-list
5172 (while (> ps-n-up-printing (caar the-list))
5173 (setq the-list (cdr the-list))))
5174 (car the-list)))
5175
5176
5177(defconst ps-n-up-filling-database
5178 '((left-top
5179 "PageWidth" ; N-Up-XColumn
5180 "0" ; N-Up-YColumn
5181 "N-Up-End 1 sub PageWidth mul neg" ; N-Up-XLine
5182 "LandscapePageHeight neg" ; N-Up-YLine
5183 "N-Up-Lines" ; N-Up-Repeat
5184 "N-Up-Columns" ; N-Up-End
5185 "0" ; N-Up-XStart
5186 "0") ; N-Up-YStart
5187 (left-bottom
5188 "PageWidth" ; N-Up-XColumn
5189 "0" ; N-Up-YColumn
5190 "N-Up-End 1 sub PageWidth mul neg" ; N-Up-XLine
5191 "LandscapePageHeight" ; N-Up-YLine
5192 "N-Up-Lines" ; N-Up-Repeat
5193 "N-Up-Columns" ; N-Up-End
5194 "0" ; N-Up-XStart
5195 "N-Up-Repeat 1 sub LandscapePageHeight mul neg") ; N-Up-YStart
5196 (right-top
5197 "PageWidth neg" ; N-Up-XColumn
5198 "0" ; N-Up-YColumn
5199 "N-Up-End 1 sub PageWidth mul" ; N-Up-XLine
5200 "LandscapePageHeight neg" ; N-Up-YLine
5201 "N-Up-Lines" ; N-Up-Repeat
5202 "N-Up-Columns" ; N-Up-End
5203 "N-Up-End 1 sub PageWidth mul" ; N-Up-XStart
5204 "0") ; N-Up-YStart
5205 (right-bottom
5206 "PageWidth neg" ; N-Up-XColumn
5207 "0" ; N-Up-YColumn
5208 "N-Up-End 1 sub PageWidth mul" ; N-Up-XLine
5209 "LandscapePageHeight" ; N-Up-YLine
5210 "N-Up-Lines" ; N-Up-Repeat
5211 "N-Up-Columns" ; N-Up-End
5212 "N-Up-End 1 sub PageWidth mul" ; N-Up-XStart
5213 "N-Up-Repeat 1 sub LandscapePageHeight mul neg") ; N-Up-YStart
5214 (top-left
5215 "0" ; N-Up-XColumn
5216 "LandscapePageHeight neg" ; N-Up-YColumn
5217 "PageWidth" ; N-Up-XLine
5218 "N-Up-End 1 sub LandscapePageHeight mul" ; N-Up-YLine
5219 "N-Up-Columns" ; N-Up-Repeat
5220 "N-Up-Lines" ; N-Up-End
5221 "0" ; N-Up-XStart
5222 "0") ; N-Up-YStart
5223 (bottom-left
5224 "0" ; N-Up-XColumn
5225 "LandscapePageHeight" ; N-Up-YColumn
5226 "PageWidth" ; N-Up-XLine
5227 "N-Up-End 1 sub LandscapePageHeight mul neg" ; N-Up-YLine
5228 "N-Up-Columns" ; N-Up-Repeat
5229 "N-Up-Lines" ; N-Up-End
5230 "0" ; N-Up-XStart
5231 "N-Up-End 1 sub LandscapePageHeight mul neg") ; N-Up-YStart
5232 (top-right
5233 "0" ; N-Up-XColumn
5234 "LandscapePageHeight neg" ; N-Up-YColumn
5235 "PageWidth neg" ; N-Up-XLine
5236 "N-Up-End 1 sub LandscapePageHeight mul" ; N-Up-YLine
5237 "N-Up-Columns" ; N-Up-Repeat
5238 "N-Up-Lines" ; N-Up-End
5239 "N-Up-Repeat 1 sub PageWidth mul" ; N-Up-XStart
5240 "0") ; N-Up-YStart
5241 (bottom-right
5242 "0" ; N-Up-XColumn
5243 "LandscapePageHeight" ; N-Up-YColumn
5244 "PageWidth neg" ; N-Up-XLine
5245 "N-Up-End 1 sub LandscapePageHeight mul neg" ; N-Up-YLine
5246 "N-Up-Columns" ; N-Up-Repeat
5247 "N-Up-Lines" ; N-Up-End
5248 "N-Up-Repeat 1 sub PageWidth mul" ; N-Up-XStart
5249 "N-Up-End 1 sub LandscapePageHeight mul neg")) ; N-Up-YStart
5250 "Alist for n-up printing initializations.
5251
5252Each element has the following form:
5253
5254 (KIND XCOL YCOL XLIN YLIN REPEAT END XSTART YSTART)
5255
5256Where:
5257KIND is a valid value of `ps-n-up-filling'.
5258XCOL YCOL are the relative position for the next column.
5259XLIN YLIN are the relative position for the beginning of next line.
5260REPEAT is the number of repetions for external loop.
5261END is the number of repetions for internal loop and also the number of pages in
5262 a row.
5263XSTART YSTART are the relative position for the first page in a sheet.")
5264
5265
5266(defun ps-n-up-filling ()
5267 (cdr (or (assq ps-n-up-filling ps-n-up-filling-database)
5268 (assq 'left-top ps-n-up-filling-database))))
5269
5270
5271(defmacro ps-n-up-xcolumn (init) `(nth 0 ,init))
5272(defmacro ps-n-up-ycolumn (init) `(nth 1 ,init))
5273(defmacro ps-n-up-xline (init) `(nth 2 ,init))
5274(defmacro ps-n-up-yline (init) `(nth 3 ,init))
5275(defmacro ps-n-up-repeat (init) `(nth 4 ,init))
5276(defmacro ps-n-up-end (init) `(nth 5 ,init))
5277(defmacro ps-n-up-xstart (init) `(nth 6 ,init))
5278(defmacro ps-n-up-ystart (init) `(nth 7 ,init))
5279
5280
66e63857
GM
5281(defconst ps-error-handler-alist
5282 '((none . 0)
5283 (paper . 1)
5284 (system . 2)
5285 (paper-and-system . 3))
2bd80d73
GM
5286 "Alist for error handler message.")
5287
5288
5289(defconst ps-zebra-stripe-alist
5290 '((follow . 1)
5291 (full . 2)
5292 (full-follow . 3))
5293 "Alist for zebra stripe continuation.")
66e63857
GM
5294
5295
ef2cbb24 5296(defun ps-begin-file ()
7bb054a5 5297 (setq ps-page-order 0
4b3eb10f 5298 ps-page-printed 0
87a16a06
RS
5299 ps-background-text-count 0
5300 ps-background-image-count 0
5301 ps-background-pages nil
5302 ps-background-all-pages nil)
12d89a2e 5303
bc0d41bd
KH
5304 (let ((dimensions (cdr (assq ps-paper-type ps-page-dimensions-database)))
5305 (tumble (if ps-landscape-mode (not ps-spool-tumble) ps-spool-tumble))
5306 (n-up (ps-n-up-printing))
5307 (n-up-filling (ps-n-up-filling)))
98f2fbe7 5308 (and ps-n-up-on (setq tumble (not tumble)))
bc0d41bd
KH
5309 (ps-output
5310 ps-adobe-tag
5311 "%%Title: " (buffer-name) ; Take job name from name of
8bd22fcf 5312 ; first buffer printed
9586e1d3
VJL
5313 "\n%%Creator: ps-print v" ps-print-version
5314 "\n%%For: " (user-full-name)
5315 "\n%%CreationDate: " (format-time-string "%T %b %d %Y")
bc0d41bd
KH
5316 "\n%%Orientation: "
5317 (if ps-landscape-mode "Landscape" "Portrait")
5318 "\n%%DocumentNeededResources: font Times-Roman Times-Italic\n%%+ font "
5319 (mapconcat 'identity
5320 (ps-remove-duplicates
5321 (append (ps-fonts 'ps-font-for-text)
5322 (list (ps-font 'ps-font-for-header 'normal)
9586e1d3
VJL
5323 (ps-font 'ps-font-for-header 'bold)
5324 (ps-font 'ps-font-for-footer 'normal)
5325 (ps-font 'ps-font-for-footer 'bold))))
bc0d41bd 5326 "\n%%+ font ")
9586e1d3 5327 "\n%%DocumentSuppliedResources: procset PSPrintUserDefinedPrologue-" (user-login-name) " 0 0"
bc0d41bd
KH
5328 "\n%%DocumentMedia: " (ps-page-dimensions-get-media dimensions)
5329 (format " %d" (round (ps-page-dimensions-get-width dimensions)))
5330 (format " %d" (round (ps-page-dimensions-get-height dimensions)))
5331 " 0 () ()\n%%PageOrder: Ascend\n%%Pages: (atend)\n%%Requirements:"
5332 (if ps-spool-duplex
8e234846 5333 (if tumble " duplex(tumble)\n" " duplex\n")
bc0d41bd
KH
5334 "\n"))
5335
66e63857 5336 (ps-insert-string ps-print-prologue-header)
bc0d41bd 5337
8e234846
GM
5338 (ps-output "%%EndComments\n%%BeginDefaults\n%%PageMedia: "
5339 (ps-page-dimensions-get-media dimensions)
6bf5fb46 5340 "\n%%EndDefaults\n\n%%BeginProlog\n\n"
6e1b1da6
GM
5341 "/languagelevel where{pop}{/languagelevel 1 def}ifelse\n"
5342 (format "/ErrorMessage %s def\n\n"
66e63857
GM
5343 (or (cdr (assoc ps-error-handler-message
5344 ps-error-handler-alist))
5345 1)) ; send to paper
5346 ps-print-prologue-0
9586e1d3 5347 "\n%%BeginResource: procset PSPrintUserDefinedPrologue-" (user-login-name) " 0 0\n\n")
66e63857
GM
5348
5349 (ps-insert-string ps-user-defined-prologue)
5350
9586e1d3 5351 (ps-output "\n%%EndResource\n\n")
bc0d41bd 5352
bc0d41bd
KH
5353 (ps-output-boolean "LandscapeMode "
5354 (or ps-landscape-mode
5355 (eq (ps-n-up-landscape n-up) 'pag)))
906d41a7 5356 (ps-output-boolean "UpsideDown " ps-print-upside-down)
bc0d41bd
KH
5357 (ps-output (format "/NumberOfColumns %d def\n" ps-number-of-columns)
5358
5359 (format "/LandscapePageHeight %s def\n" ps-landscape-page-height)
5360 (format "/PrintPageWidth %s def\n"
5361 (- (* (+ ps-print-width ps-inter-column)
5362 ps-number-of-columns)
5363 ps-inter-column))
5364 (format "/PrintWidth %s def\n" ps-print-width)
5365 (format "/PrintHeight %s def\n" ps-print-height)
5366
5367 (format "/LeftMargin %s def\n" ps-left-margin)
5368 (format "/RightMargin %s def\n" ps-right-margin)
5369 (format "/InterColumn %s def\n" ps-inter-column)
5370
5371 (format "/BottomMargin %s def\n" ps-bottom-margin)
5372 (format "/TopMargin %s def\n" ps-top-margin) ; not used
5373 (format "/HeaderOffset %s def\n" ps-header-offset)
319acba0
GM
5374 (format "/HeaderPad %s def\n" ps-header-pad)
5375 (format "/FooterOffset %s def\n" ps-footer-offset)
5376 (format "/FooterPad %s def\n" ps-footer-pad)
5377 (format "/FooterLines %s def\n" ps-footer-lines))
bc0d41bd 5378
319acba0 5379 (ps-output-boolean "ShowNofN " ps-show-n-of-n)
8e234846
GM
5380 (ps-output-boolean "SwitchHeader " (if (eq ps-switch-header 'duplex)
5381 ps-spool-duplex
5382 ps-switch-header))
319acba0
GM
5383 (ps-output-boolean "PrintOnlyOneHeader" ps-print-only-one-header)
5384 (ps-output-boolean "PrintHeader " ps-print-header)
5385 (ps-output-boolean "PrintHeaderFrame " ps-print-header-frame)
5386 (ps-output-frame-properties "HeaderFrameProperties" ps-header-frame-alist)
5387 (ps-output-boolean "PrintFooter " ps-print-footer)
5388 (ps-output-boolean "PrintFooterFrame " ps-print-footer-frame)
5389 (ps-output-frame-properties "FooterFrameProperties" ps-footer-frame-alist)
bc0d41bd
KH
5390
5391 (let ((line-height (ps-line-height 'ps-font-for-text)))
6bf5fb46
GM
5392 (ps-output (format "/LineSpacing %s def\n" ps-line-spacing-internal)
5393 (format "/ParagraphSpacing %s def\n"
5394 ps-paragraph-spacing-internal)
5395 (format "/LineHeight %s def\n" line-height)
2bd80d73 5396 (format "/LinesPerColumn %d def\n"
6bf5fb46
GM
5397 (let ((height (+ line-height
5398 ps-line-spacing-internal)))
5399 (round (/ (+ ps-print-height
5400 (* height 0.45))
5401 height))))))
bc0d41bd 5402
8e234846 5403 (ps-output-boolean "WarnPaperSize " ps-warn-paper-type)
bc0d41bd
KH
5404 (ps-output-boolean "Zebra " ps-zebra-stripes)
5405 (ps-output-boolean "PrintLineNumber " ps-line-number)
906d41a7 5406 (ps-output-boolean "SyncLineZebra " (not (integerp ps-line-number-step)))
2bd80d73
GM
5407 (ps-output (format "/ZebraFollow %d def\n"
5408 (or (cdr (assq ps-zebra-stripe-follow
5409 ps-zebra-stripe-alist))
5410 0))
5411 (format "/PrintLineStep %d def\n"
906d41a7
GM
5412 (if (integerp ps-line-number-step)
5413 ps-line-number-step
98f2fbe7
GM
5414 ps-zebra-stripe-height))
5415 (format "/PrintLineStart %d def\n" ps-line-number-start)
319acba0
GM
5416 "/LineNumberColor "
5417 (ps-format-color ps-line-number-color 0.0)
5418 (format "def\n/ZebraHeight %d def\n"
5419 ps-zebra-stripe-height)
6e1b1da6
GM
5420 "/ZebraColor "
5421 (ps-format-color ps-zebra-color 0.95)
3f0257cb
VJL
5422 "def\n")
5423 (ps-output "/BackgroundColor "
e59d29d6 5424 (ps-format-color ps-default-background 1.0)
3f0257cb
VJL
5425 "def\n")
5426 (ps-output "/UseSetpagedevice "
bc0d41bd 5427 (if (eq ps-spool-config 'setpagedevice)
6e1b1da6
GM
5428 "/setpagedevice where{pop languagelevel 2 eq}{false}ifelse"
5429 "false")
5430 " def\n\n/PageWidth "
bc0d41bd
KH
5431 "PrintPageWidth LeftMargin add RightMargin add def\n\n"
5432 (format "/N-Up %d def\n" ps-n-up-printing))
5433 (ps-output-boolean "N-Up-Landscape" (eq (ps-n-up-landscape n-up) t))
5434 (ps-output-boolean "N-Up-Border " ps-n-up-border-p)
5435 (ps-output (format "/N-Up-Lines %d def\n" (ps-n-up-lines n-up))
5436 (format "/N-Up-Columns %d def\n" (ps-n-up-columns n-up))
5437 (format "/N-Up-Missing %d def\n" (ps-n-up-missing n-up))
6e1b1da6
GM
5438 (format "/N-Up-Margin %s def\n" ps-n-up-margin)
5439 "/N-Up-Repeat "
bc0d41bd
KH
5440 (if ps-landscape-mode
5441 (ps-n-up-end n-up-filling)
5442 (ps-n-up-repeat n-up-filling))
5443 " def\n/N-Up-End "
5444 (if ps-landscape-mode
5445 (ps-n-up-repeat n-up-filling)
5446 (ps-n-up-end n-up-filling))
5447 " def\n/N-Up-XColumn " (ps-n-up-xcolumn n-up-filling)
5448 " def\n/N-Up-YColumn " (ps-n-up-ycolumn n-up-filling)
5449 " def\n/N-Up-XLine " (ps-n-up-xline n-up-filling)
5450 " def\n/N-Up-YLine " (ps-n-up-yline n-up-filling)
5451 " def\n/N-Up-XStart " (ps-n-up-xstart n-up-filling)
5452 " def\n/N-Up-YStart " (ps-n-up-ystart n-up-filling) " def\n")
5453
5454 (ps-background-text)
5455 (ps-background-image)
5456 (setq ps-background-all-pages (nreverse ps-background-all-pages)
5457 ps-background-pages (nreverse ps-background-pages))
5458
47a97a6d
VJL
5459 (ps-output "\n" ps-print-prologue-1
5460 "\n/printGlobalBackground{\n")
42af7493 5461 (mapc 'ps-output ps-background-all-pages)
9586e1d3 5462 (ps-output
47a97a6d
VJL
5463 "}def\n/printLocalBackground{\n}def\n"
5464 "\n%%EndProlog\n\n%%BeginSetup\n"
9586e1d3 5465 "\n%%IncludeResource: font Times-Roman"
47a97a6d
VJL
5466 "\n%%IncludeResource: font Times-Italic"
5467 "\n%%IncludeResource: font "
9586e1d3
VJL
5468 (mapconcat 'identity
5469 (ps-remove-duplicates
5470 (append (ps-fonts 'ps-font-for-text)
5471 (list (ps-font 'ps-font-for-header 'normal)
5472 (ps-font 'ps-font-for-header 'bold)
5473 (ps-font 'ps-font-for-footer 'normal)
5474 (ps-font 'ps-font-for-footer 'bold))))
5475 "\n%%IncludeResource: font ")
47a97a6d
VJL
5476 ;; Header/line number fonts
5477 (format "\n/h0 %s(%s)cvn DefFont\n" ; /h0 14/Helvetica-Bold DefFont
5478 ps-header-title-font-size-internal
5479 (ps-font 'ps-font-for-header 'bold))
5480 (format "/h1 %s(%s)cvn DefFont\n" ; /h1 12/Helvetica DefFont
5481 ps-header-font-size-internal
5482 (ps-font 'ps-font-for-header 'normal))
5483 (format "/L0 %s(%s)cvn DefFont\n" ; /L0 6/Times-Italic DefFont
5484 (ps-get-font-size 'ps-line-number-font-size)
5485 ps-line-number-font)
5486 (format "/H0 %s(%s)cvn DefFont\n" ; /H0 12/Helvetica DefFont
5487 ps-footer-font-size-internal
5488 (ps-font 'ps-font-for-footer 'normal))
5489 "\n\n% ---- These lines must be kept together because...
6bf5fb46
GM
5490
5491/h0 F
5492/HeaderTitleLineHeight FontHeight def
5493
5494/h1 F
5495/HeaderLineHeight FontHeight def
5496/HeaderDescent Descent def
5497
319acba0
GM
5498/H0 F
5499/FooterLineHeight FontHeight def
5500/FooterDescent Descent def
5501
6bf5fb46 5502% ---- ...because `F' has a side-effect on `FontHeight' and `Descent'\n\n")
bc0d41bd
KH
5503
5504 ;; Text fonts
5505 (let ((font (ps-font-alist 'ps-font-for-text))
5506 (i 0))
5507 (while font
c3d6d211 5508 (ps-output (format "/f%d %s(%s)cvn DefFont\n"
bc0d41bd
KH
5509 i
5510 ps-font-size-internal
5511 (ps-font 'ps-font-for-text (car (car font)))))
5512 (setq font (cdr font)
5513 i (1+ i))))
5514
5515 (let ((font-entry (cdr (assq ps-font-family ps-font-info-database))))
5516 (ps-output (format "/SpaceWidthRatio %f def\n"
5517 (/ (ps-lookup 'space-width) (ps-lookup 'size)))))
5518
bc0d41bd
KH
5519 (unless (eq ps-spool-config 'lpr-switches)
5520 (ps-output "\n%%BeginFeature: *Duplex "
5521 (ps-boolean-capitalized ps-spool-duplex)
5522 " *Tumble "
5523 (ps-boolean-capitalized tumble)
c3d6d211
GM
5524 "\nUseSetpagedevice\n{BMark/Duplex "
5525 (ps-boolean-constant ps-spool-duplex)
5526 "/Tumble "
5527 (ps-boolean-constant tumble)
5528 " EMark setpagedevice}\n{statusdict begin "
5529 (ps-boolean-constant ps-spool-duplex)
5530 " setduplexmode "
5531 (ps-boolean-constant tumble)
5532 " settumble end}ifelse\n%%EndFeature\n")))
8e234846
GM
5533 (ps-output "\n%%BeginFeature: *ManualFeed "
5534 (ps-boolean-capitalized ps-manual-feed)
5535 "\nBMark /ManualFeed "
5536 (ps-boolean-constant ps-manual-feed)
ef1159c2 5537 " EMark setpagedevice\n%%EndFeature\n\nBeginDoc\n%%EndSetup\n")
47d2ac75 5538 (and ps-banner-page-when-duplexing
98f2fbe7 5539 (ps-output "\n%%Page: banner 0\nsave showpage restore\n")))
bc0d41bd
KH
5540
5541
6e1b1da6
GM
5542(defun ps-format-color (color &optional default)
5543 (let ((the-color (if (stringp color)
5544 (ps-color-scale color)
5545 color)))
5546 (if (and the-color (listp the-color))
5547 (concat "["
5548 (format ps-color-format
efa89c1f
GM
5549 (* (nth 0 the-color) 1.0) ; force float number
5550 (* (nth 1 the-color) 1.0) ; force float number
5551 (* (nth 2 the-color) 1.0)) ; force float number
6e1b1da6
GM
5552 "] ")
5553 (ps-float-format (if (numberp the-color) the-color default)))))
5554
5555
66e63857
GM
5556(defun ps-insert-string (prologue)
5557 (let ((str (if (functionp prologue)
5558 (funcall prologue)
5559 prologue)))
5560 (and (stringp str)
5561 (ps-output str))))
5562
5563
bc0d41bd
KH
5564(defun ps-boolean-capitalized (bool)
5565 (if bool "True" "False"))
5566
ef2cbb24 5567
8e234846
GM
5568(defun ps-boolean-constant (bool)
5569 (if bool "true" "false"))
5570
5571
12d89a2e
RS
5572(defun ps-header-dirpart ()
5573 (let ((fname (buffer-file-name)))
5574 (if fname
5575 (if (string-equal (buffer-name) (file-name-nondirectory fname))
68e684a0 5576 (abbreviate-file-name (file-name-directory fname))
12d89a2e
RS
5577 fname)
5578 "")))
ef2cbb24 5579
bc0d41bd 5580
12d89a2e 5581(defun ps-get-buffer-name ()
bcc0d457
RS
5582 (cond
5583 ;; Indulge Jim this little easter egg:
5584 ((string= (buffer-name) "ps-print.el")
5585 "Hey, Cool! It's ps-print.el!!!")
5586 ;; Indulge Jack this other little easter egg:
5587 ((string= (buffer-name) "sokoban.el")
5588 "Super! C'est sokoban.el!")
87a16a06 5589 (t (concat
bc0d41bd 5590 (and ps-printing-region-p "Subset of: ")
87a16a06
RS
5591 (buffer-name)
5592 (and (buffer-modified-p) " (unsaved)")))))
ef2cbb24 5593
7d8b7e8e 5594
6bf5fb46
GM
5595(defun ps-get-size (size mess &optional arg)
5596 (let ((siz (cond ((numberp size)
5597 size)
5598 ((and (consp size)
5599 (numberp (car size))
5600 (numberp (cdr size)))
5601 (if ps-landscape-mode
5602 (car size)
5603 (cdr size)))
5604 (t
5605 -1))))
5606 (and (< siz 0)
5607 (error "Invalid %s `%S'%s"
5608 mess size
5609 (if arg
5610 (format " for `%S'" arg)
5611 "")))
5612 siz))
5613
5614
7d8b7e8e 5615(defun ps-get-font-size (font-sym)
6bf5fb46 5616 (ps-get-size (symbol-value font-sym) "font size" font-sym))
7d8b7e8e
KH
5617
5618
c8296a63
VJL
5619(defun ps-rgb-color (color unspecified default)
5620 (cond
5621 ;; (float float float) ==> (R G B)
5622 ((and color (listp color) (= (length color) 3)
5623 (let ((cl color)
5624 (ok t) e)
5625 (while (and ok cl)
5626 (setq e (car cl)
5627 cl (cdr cl)
5628 ok (and (floatp e) (<= 0.0 e) (<= e 1.0))))
5629 ok))
5630 color)
5631 ;; float ==> 0.0 = black .. 1.0 = white
5632 ((and (floatp color) (<= 0.0 color) (<= color 1.0))
5633 (list color color color))
5634 ;; "colorName" but different from "unspecified-[bf]g"
5635 ((and (stringp color) (not (string= color unspecified)))
5636 (ps-color-scale color))
5637 ;; ok, use the default
5638 (t
5639 (list default default default))))
319acba0 5640
f07bb446 5641(defvar ps-basic-plot-string-function 'ps-basic-plot-string)
319acba0 5642
e85cca87 5643(defun ps-begin-job (genfunc)
1fd9b7fe 5644 ;; prologue files
41481e4b 5645 (or (equal ps-mark-code-directory ps-postscript-code-directory)
c3d6d211
GM
5646 (setq ps-print-prologue-0 (ps-prologue-file 0)
5647 ps-print-prologue-1 (ps-prologue-file 1)
c3d6d211 5648 ps-mark-code-directory ps-postscript-code-directory))
1fd9b7fe
GM
5649 ;; selected pages
5650 (let (new page)
5651 (while ps-selected-pages
5652 (setq page (car ps-selected-pages)
5653 ps-selected-pages (cdr ps-selected-pages))
5654 (cond ((integerp page)
5655 (and (> page 0)
5656 (setq new (cons (cons page page) new))))
5657 ((consp page)
5658 (and (integerp (car page)) (integerp (cdr page))
5659 (> (car page) 0)
5660 (<= (car page) (cdr page))
5661 (setq new (cons page new))))))
5662 (setq ps-selected-pages (sort new #'(lambda (one other)
5663 (< (car one) (car other))))
5664 ps-last-selected-pages ps-selected-pages
5665 ps-first-page nil
5666 ps-last-page nil))
5667 ;; face background
906d41a7
GM
5668 (or (listp ps-use-face-background)
5669 (setq ps-use-face-background t))
1fd9b7fe 5670 ;; line number
906d41a7
GM
5671 (and (integerp ps-line-number-step)
5672 (<= ps-line-number-step 0)
5673 (setq ps-line-number-step 1))
98f2fbe7
GM
5674 (setq ps-n-up-on (> ps-n-up-printing 1)
5675 ps-line-number-start (max 1 (min ps-line-number-start
5676 (if (integerp ps-line-number-step)
5677 ps-line-number-step
5678 ps-zebra-stripe-height))))
1fd9b7fe 5679 ;; spooling buffer
7da17ab6
RS
5680 (save-excursion
5681 (set-buffer ps-spool-buffer)
5682 (goto-char (point-max))
5683 (and (re-search-backward "^%%Trailer$" nil t)
5684 (delete-region (match-beginning 0) (point-max))))
1fd9b7fe 5685 ;; miscellaneous
2bd80d73
GM
5686 (setq ps-zebra-stripe-full-p (memq ps-zebra-stripe-follow
5687 '(full full-follow))
5688 ps-page-postscript 0
7bb054a5
GM
5689 ps-page-sheet 0
5690 ps-page-n-up 0
4b3eb10f 5691 ps-page-column 0
bd7a2e26 5692 ps-lines-printed 0
7bb054a5
GM
5693 ps-print-page-p t
5694 ps-showline-count (car ps-printing-region)
6bf5fb46
GM
5695 ps-line-spacing-internal (ps-get-size ps-line-spacing
5696 "line spacing")
5697 ps-paragraph-spacing-internal (ps-get-size ps-paragraph-spacing
5698 "paragraph spacing")
7d8b7e8e
KH
5699 ps-font-size-internal (ps-get-font-size 'ps-font-size)
5700 ps-header-font-size-internal (ps-get-font-size 'ps-header-font-size)
5701 ps-header-title-font-size-internal
5702 (ps-get-font-size 'ps-header-title-font-size)
319acba0 5703 ps-footer-font-size-internal (ps-get-font-size 'ps-footer-font-size)
857686a6 5704 ps-control-or-escape-regexp
298bfad9
KH
5705 (cond ((eq ps-print-control-characters '8-bit)
5706 (string-as-unibyte "[\000-\037\177-\377]"))
5707 ((eq ps-print-control-characters 'control-8-bit)
5708 (string-as-unibyte "[\000-\037\177-\237]"))
5709 ((eq ps-print-control-characters 'control)
5710 "[\000-\037\177]")
6e1b1da6 5711 (t "[\t\n\f]"))
f1024355
VJL
5712 ;; Set the color scale. We do it here instead of in the defvar so
5713 ;; that ps-print can be dumped into emacs. This expression can't be
5714 ;; evaluated at dump-time because X isn't initialized.
5715 ps-color-p (and ps-print-color-p (ps-color-device))
5716 ps-print-color-scale (if ps-color-p
5717 (float (car (ps-color-values "white")))
5718 1.0)
e59d29d6 5719 ps-default-background (ps-rgb-color
830f437e 5720 (cond
905350be
VJL
5721 ((or (member ps-print-color-p
5722 '(nil back-white))
f1024355 5723 (eq genfunc 'ps-generate-postscript))
e85cca87 5724 nil)
830f437e 5725 ((eq ps-default-bg 'frame-parameter)
cf04718a 5726 (ps-frame-parameter nil 'background-color))
830f437e
VJL
5727 ((eq ps-default-bg t)
5728 (ps-face-background-name 'default))
5729 (t
5730 ps-default-bg))
c8296a63 5731 "unspecified-bg"
e59d29d6 5732 1.0)
c794a94d 5733 ps-default-foreground (ps-rgb-color
830f437e 5734 (cond
905350be
VJL
5735 ((or (member ps-print-color-p
5736 '(nil back-white))
f1024355 5737 (eq genfunc 'ps-generate-postscript))
e85cca87 5738 nil)
830f437e 5739 ((eq ps-default-fg 'frame-parameter)
cf04718a 5740 (ps-frame-parameter nil 'foreground-color))
830f437e
VJL
5741 ((eq ps-default-fg t)
5742 (ps-face-foreground-name 'default))
5743 (t
5744 ps-default-fg))
c8296a63 5745 "unspecified-fg"
c794a94d 5746 0.0)
905350be
VJL
5747 ps-default-color (and (not (member ps-print-color-p
5748 '(nil back-white)))
f1024355
VJL
5749 ps-default-foreground)
5750 ps-current-color ps-default-color
f07bb446
KH
5751 ;; Set up default functions. They may be overridden by
5752 ;; ps-mule-begin-job.
5753 ps-basic-plot-string-function 'ps-basic-plot-string
5754 ps-encode-header-string-function nil)
319acba0 5755 ;; initialize page dimensions
e59d29d6
VJL
5756 (ps-get-page-dimensions)
5757 ;; final check
5758 (and ps-color-p
5759 (equal ps-default-background ps-default-foreground)
5760 (error
5761 (concat
5762 "`ps-default-fg' and `ps-default-bg' have the same color.\n"
5763 "Text won't appear on page. Please, check these variables."))))
6e1b1da6 5764
ef2cbb24 5765
ea0c615d
GM
5766(defun ps-page-number ()
5767 (if ps-print-only-one-header
4b3eb10f
GM
5768 (1+ (/ (1- ps-page-column) ps-number-of-columns))
5769 ps-page-column))
87a16a06
RS
5770
5771
319acba0
GM
5772(defsubst ps-end-page ()
5773 (ps-output "EndPage\nEndDSCPage\n"))
5774
5775
5776(defsubst ps-next-page ()
ef2cbb24 5777 (ps-end-page)
12d89a2e
RS
5778 (ps-flush-output)
5779 (ps-begin-page))
5780
bc0d41bd 5781
9dae638c
VJL
5782(defun ps-end-sheet ()
5783 (and ps-print-page-p (> ps-page-sheet 0)
5784 (ps-output "EndSheet\n")))
5785
5786
bc0d41bd
KH
5787(defun ps-header-sheet ()
5788 ;; Print only when a new sheet begins.
9dae638c 5789 (ps-end-sheet)
4b3eb10f
GM
5790 (setq ps-page-sheet (1+ ps-page-sheet))
5791 (when (ps-print-sheet-p)
5792 (setq ps-page-order (1+ ps-page-order))
5793 (ps-output (if ps-n-up-on
5794 (format "\n%%%%Page: (%d \\(%d\\)) %d\n"
5795 ps-page-order ps-page-postscript ps-page-order)
5796 (format "\n%%%%Page: %d %d\n"
5797 ps-page-postscript ps-page-order))
ef1159c2
EZ
5798 ;; spooling needs to redefine Lines and PageCount on each page
5799 "/Lines 0 def\n/PageCount 0 def\n"
4b3eb10f
GM
5800 (format "%d BeginSheet\nBeginDSCPage\n"
5801 ps-n-up-printing))))
ea0c615d
GM
5802
5803
5804(defun ps-header-page ()
7da17ab6
RS
5805 ;; set total line and page number when printing has finished
5806 ;; (see `ps-generate')
4b3eb10f 5807 (if (zerop (mod ps-page-column ps-number-of-columns))
ea0c615d
GM
5808 (progn
5809 (setq ps-page-postscript (1+ ps-page-postscript))
5810 (when (ps-print-page-p)
4b3eb10f 5811 (ps-print-sheet-p)
ea0c615d
GM
5812 (if (zerop (mod ps-page-n-up ps-n-up-printing))
5813 ;; Print only when a new sheet begins.
5814 (progn
5815 (ps-header-sheet)
5816 (run-hooks 'ps-print-begin-sheet-hook))
5817 ;; Print only when a new page begins.
5818 (ps-output "BeginDSCPage\n")
5819 (run-hooks 'ps-print-begin-page-hook))
5820 (ps-background ps-page-postscript)
4b3eb10f
GM
5821 (setq ps-page-n-up (1+ ps-page-n-up))
5822 (and ps-print-page-p
5823 (setq ps-page-printed (1+ ps-page-printed)))))
ea0c615d
GM
5824 ;; Print only when a new column begins.
5825 (ps-output "BeginDSCPage\n")
5826 (run-hooks 'ps-print-begin-column-hook))
4b3eb10f 5827 (setq ps-page-column (1+ ps-page-column)))
a18ed129 5828
8bd22fcf 5829(defun ps-begin-page ()
8bd22fcf 5830 (setq ps-width-remaining ps-print-width
298bfad9 5831 ps-height-remaining ps-print-height)
12d89a2e 5832
a18ed129 5833 (ps-header-page)
12d89a2e 5834
87a16a06 5835 (ps-output (format "/LineNumber %d def\n" ps-showline-count)
ea0c615d 5836 (format "/PageNumber %d def\n" (ps-page-number)))
12d89a2e 5837
090be653 5838 (when ps-print-header
f07bb446
KH
5839 (ps-generate-header "HeaderLinesLeft" "/h0" "/h1" ps-left-header)
5840 (ps-generate-header "HeaderLinesRight" "/h0" "/h1" ps-right-header)
5841 (ps-output (format "%d SetHeaderLines\n" ps-header-lines)))
12d89a2e 5842
319acba0 5843 (when ps-print-footer
f07bb446
KH
5844 (ps-generate-header "FooterLinesLeft" "/H0" "/H0" ps-left-footer)
5845 (ps-generate-header "FooterLinesRight" "/H0" "/H0" ps-right-footer)
5846 (ps-output (format "%d SetFooterLines\n" ps-footer-lines)))
319acba0 5847
bd7a2e26 5848 (ps-output (number-to-string ps-lines-printed) " BeginPage\n")
87a16a06
RS
5849 (ps-set-font ps-current-font)
5850 (ps-set-bg ps-current-bg)
f07bb446 5851 (ps-set-color ps-current-color))
ef2cbb24 5852
319acba0 5853(defsubst ps-skip-newline (limit)
bd7a2e26
GM
5854 (setq ps-showline-count (1+ ps-showline-count)
5855 ps-lines-printed (1+ ps-lines-printed))
5856 (and (< (point) limit)
5857 (forward-char 1)))
5858
6bf5fb46 5859(defsubst ps-next-line ()
bd7a2e26
GM
5860 (setq ps-showline-count (1+ ps-showline-count)
5861 ps-lines-printed (1+ ps-lines-printed))
6bf5fb46
GM
5862 (let* ((paragraph-p (and ps-paragraph-regexp
5863 (looking-at ps-paragraph-regexp)))
5864 (lh (+ (ps-line-height 'ps-font-for-text)
5865 (if paragraph-p
5866 ps-paragraph-spacing-internal
5867 ps-line-spacing-internal))))
12b88fff
RS
5868 (if (< ps-height-remaining lh)
5869 (ps-next-page)
5870 (setq ps-width-remaining ps-print-width
5871 ps-height-remaining (- ps-height-remaining lh))
6bf5fb46 5872 (ps-output (if paragraph-p "PHL\n" "LHL\n")))))
ef2cbb24
RS
5873
5874(defun ps-continue-line ()
bd7a2e26 5875 (setq ps-lines-printed (1+ ps-lines-printed))
6bf5fb46 5876 (let ((lh (+ (ps-line-height 'ps-font-for-text) ps-line-spacing-internal)))
12b88fff
RS
5877 (if (< ps-height-remaining lh)
5878 (ps-next-page)
5879 (setq ps-width-remaining ps-print-width
5880 ps-height-remaining (- ps-height-remaining lh))
5881 (ps-output "SL\n"))))
12d89a2e
RS
5882
5883(defun ps-find-wrappoint (from to char-width)
5884 (let ((avail (truncate (/ ps-width-remaining char-width)))
5885 (todo (- to from)))
5886 (if (< todo avail)
5887 (cons to (* todo char-width))
5888 (cons (+ from avail) ps-width-remaining))))
5889
c86f4619
GM
5890(defun ps-basic-plot-str (from to string)
5891 (let* ((wrappoint (ps-find-wrappoint from to
5892 (ps-avg-char-width 'ps-font-for-text)))
5893 (to (car wrappoint))
5894 (str (substring string from to)))
c86f4619
GM
5895 (ps-output-string str)
5896 (ps-output " S\n")
5897 wrappoint))
5898
12d89a2e 5899(defun ps-basic-plot-string (from to &optional bg-color)
12b88fff
RS
5900 (let* ((wrappoint (ps-find-wrappoint from to
5901 (ps-avg-char-width 'ps-font-for-text)))
12d89a2e 5902 (to (car wrappoint))
298bfad9 5903 (string (buffer-substring-no-properties from to)))
12d89a2e 5904 (ps-output-string string)
bcc0d457 5905 (ps-output " S\n")
12d89a2e
RS
5906 wrappoint))
5907
5908(defun ps-basic-plot-whitespace (from to &optional bg-color)
12b88fff
RS
5909 (let* ((wrappoint (ps-find-wrappoint from to
5910 (ps-space-width 'ps-font-for-text)))
12d89a2e 5911 (to (car wrappoint)))
12d89a2e
RS
5912 (ps-output (format "%d W\n" (- to from)))
5913 wrappoint))
5914
5915(defun ps-plot (plotfunc from to &optional bg-color)
ef2cbb24 5916 (while (< from to)
12d89a2e
RS
5917 (let* ((wrappoint (funcall plotfunc from to bg-color))
5918 (plotted-to (car wrappoint))
5919 (plotted-width (cdr wrappoint)))
8bd22fcf
KH
5920 (setq from plotted-to
5921 ps-width-remaining (- ps-width-remaining plotted-width))
12d89a2e
RS
5922 (if (< from to)
5923 (ps-continue-line))))
ef2cbb24
RS
5924 (if ps-razzle-dazzle
5925 (let* ((q-todo (- (point-max) (point-min)))
12d89a2e 5926 (q-done (- (point) (point-min)))
ef2cbb24 5927 (chunkfrac (/ q-todo 8))
857686a6 5928 (chunksize (min chunkfrac 1000)))
ef2cbb24 5929 (if (> (- q-done ps-razchunk) chunksize)
8bd22fcf 5930 (progn
ef2cbb24 5931 (setq ps-razchunk q-done)
8bd22fcf
KH
5932 (message "Formatting...%3d%%"
5933 (if (< q-todo 100)
5934 (/ (* 100 q-done) q-todo)
5935 (/ q-done (/ q-todo 100)))
5936 ))))))
12d89a2e 5937
374b7675 5938(defvar ps-last-font nil)
298bfad9 5939
12d89a2e 5940(defun ps-set-font (font)
e65df0a1
KH
5941 (setq ps-last-font (format "f%d" (setq ps-current-font font)))
5942 (ps-output (format "/%s F\n" ps-last-font)))
12d89a2e 5943
12d89a2e
RS
5944(defun ps-set-bg (color)
5945 (if (setq ps-current-bg color)
8bd22fcf
KH
5946 (ps-output (format ps-color-format
5947 (nth 0 color) (nth 1 color) (nth 2 color))
12d89a2e
RS
5948 " true BG\n")
5949 (ps-output "false BG\n")))
5950
5951(defun ps-set-color (color)
6e1b1da6 5952 (setq ps-current-color (or color ps-default-foreground))
8bd22fcf
KH
5953 (ps-output (format ps-color-format
5954 (nth 0 ps-current-color)
043620f4
KH
5955 (nth 1 ps-current-color) (nth 2 ps-current-color))
5956 " FG\n"))
12d89a2e 5957
12d89a2e 5958
c86f4619
GM
5959(defsubst ps-plot-string (string)
5960 (ps-plot 'ps-basic-plot-str 0 (length string) string))
5961
5962
87a16a06 5963(defvar ps-current-effect 0)
12d89a2e 5964
3409eda2
KH
5965(defvar ps-print-translation-table
5966 (let ((tbl (make-char-table 'translation-table nil)))
5967 (if (and (boundp 'ucs-mule-8859-to-mule-unicode)
5968 (char-table-p ucs-mule-8859-to-mule-unicode))
5969 (map-char-table
640477ee 5970 #'(lambda (k v)
3409eda2
KH
5971 (if (and v (eq (char-charset v) 'latin-iso8859-1) (/= k v))
5972 (aset tbl k v)))
5973 ucs-mule-8859-to-mule-unicode))
5974 tbl)
5975 "Translation table for PostScript printing.
5976The default value is a table that translates non-Latin-1 Latin characters
5977to the equivalent Latin-1 characters.")
87a16a06
RS
5978
5979(defun ps-plot-region (from to font &optional fg-color bg-color effects)
efa89c1f 5980 (or (equal font ps-current-font)
12d89a2e 5981 (ps-set-font font))
06fb6aab 5982
12d89a2e
RS
5983 ;; Specify a foreground color only if one's specified and it's
5984 ;; different than the current.
efa89c1f
GM
5985 (let ((fg (or fg-color ps-default-foreground)))
5986 (or (equal fg ps-current-color)
5987 (ps-set-color fg)))
06fb6aab 5988
efa89c1f 5989 (or (equal bg-color ps-current-bg)
12d89a2e 5990 (ps-set-bg bg-color))
06fb6aab 5991
87a16a06
RS
5992 ;; Specify effects (underline, overline, box, etc)
5993 (cond
5994 ((not (integerp effects))
5995 (ps-output "0 EF\n")
5996 (setq ps-current-effect 0))
5997 ((/= effects ps-current-effect)
5998 (ps-output (number-to-string effects) " EF\n")
5999 (setq ps-current-effect effects)))
ef2cbb24 6000
12d89a2e 6001 ;; Starting at the beginning of the specified region...
ef2cbb24
RS
6002 (save-excursion
6003 (goto-char from)
12d89a2e
RS
6004
6005 ;; ...break the region up into chunks separated by tabs, linefeeds,
87a16a06 6006 ;; pagefeeds, control characters, and plot each chunk.
ef2cbb24 6007 (while (< from to)
6bf5fb46
GM
6008 ;; skip lines between cut markers
6009 (and ps-begin-cut-regexp ps-end-cut-regexp
6010 (looking-at ps-begin-cut-regexp)
6011 (progn
6012 (goto-char (match-end 0))
6013 (and (re-search-forward ps-end-cut-regexp to 'noerror)
6014 (= (following-char) ?\n)
6015 (forward-char 1))
6016 (setq from (point))))
857686a6 6017 (if (re-search-forward ps-control-or-escape-regexp to t)
024ced4d 6018 ;; region with some control characters or some multi-byte characters
12b88fff 6019 (let* ((match-point (match-beginning 0))
f07bb446 6020 (match (char-after match-point)))
e65df0a1 6021 (when (< from match-point)
f07bb446
KH
6022 (ps-plot ps-basic-plot-string-function
6023 from match-point bg-color))
857686a6
RS
6024 (cond
6025 ((= match ?\t) ; tab
be415ea7 6026 (let ((linestart (line-beginning-position)))
857686a6
RS
6027 (forward-char -1)
6028 (setq from (+ linestart (current-column)))
e65df0a1 6029 (when (re-search-forward "[ \t]+" to t)
e65df0a1
KH
6030 (ps-plot 'ps-basic-plot-whitespace
6031 from (+ linestart (current-column))
6032 bg-color))))
857686a6
RS
6033
6034 ((= match ?\n) ; newline
bd7a2e26
GM
6035 (if (looking-at "\f[^\n]")
6036 ;; \n\ftext\n ==>> next page, but keep line counting!!
6037 (progn
6038 (ps-skip-newline to)
6039 (ps-next-page))
6040 ;; \n\f\n ==>> it'll be handled by form feed
6041 ;; \ntext\n ==>> next line
6042 (ps-next-line)))
857686a6
RS
6043
6044 ((= match ?\f) ; form feed
12b88fff
RS
6045 ;; do not skip page if previous character is NEWLINE and
6046 ;; it is a beginning of page.
bd7a2e26
GM
6047 (unless (and (equal (char-after (1- match-point)) ?\n)
6048 (= ps-height-remaining ps-print-height))
6049 ;; \f\n ==>> skip \n, but keep line counting!!
6050 (and (equal (following-char) ?\n)
6051 (ps-skip-newline to))
6052 (ps-next-page)))
e65df0a1 6053
857686a6
RS
6054 (t ; characters from 127 to 255
6055 (ps-control-character match)))
87a16a06 6056 (setq from (point)))
f07bb446
KH
6057 ;; region without control characters
6058 (ps-plot ps-basic-plot-string-function from to bg-color)
87a16a06
RS
6059 (setq from to)))))
6060
857686a6
RS
6061(defvar ps-string-control-codes
6062 (let ((table (make-vector 256 nil))
6063 (char ?\000))
6064 ;; control character
6065 (while (<= char ?\037)
6066 (aset table char (format "^%c" (+ char ?@)))
6067 (setq char (1+ char)))
6068 ;; printable character
6069 (while (< char ?\177)
6070 (aset table char (format "%c" char))
6071 (setq char (1+ char)))
6072 ;; DEL
6073 (aset table char "^?")
6074 ;; 8-bit character
6075 (while (<= (setq char (1+ char)) ?\377)
6076 (aset table char (format "\\%o" char)))
6077 table)
6078 "Vector used to map characters to a printable string.")
6079
6080(defun ps-control-character (char)
6081 (let* ((str (aref ps-string-control-codes char))
6082 (from (1- (point)))
87a16a06
RS
6083 (len (length str))
6084 (to (+ from len))
12b88fff
RS
6085 (char-width (ps-avg-char-width 'ps-font-for-text))
6086 (wrappoint (ps-find-wrappoint from to char-width)))
87a16a06
RS
6087 (if (< (car wrappoint) to)
6088 (ps-continue-line))
12b88fff 6089 (setq ps-width-remaining (- ps-width-remaining (* len char-width)))
87a16a06
RS
6090 (ps-output-string str)
6091 (ps-output " S\n")))
ef2cbb24 6092
87a16a06 6093
42af7493
VJL
6094(defsubst ps-face-foreground-color-p (attr)
6095 (memq attr '(foreground-color :foreground)))
6096
6097
6098(defsubst ps-face-background-color-p (attr)
6099 (memq attr '(background-color :background)))
6100
6101
6102(defsubst ps-face-color-p (attr)
6103 (memq attr '(foreground-color :foreground background-color :background)))
6104
6105
a18ed129
RS
6106(defun ps-face-attributes (face)
6107 "Return face attribute vector.
87a16a06 6108
a18ed129
RS
6109If FACE is not in `ps-print-face-extension-alist' or in
6110`ps-print-face-alist', insert it on `ps-print-face-alist' and
6111return the attribute vector.
87a16a06 6112
e85cca87 6113If FACE is not a valid face name, use default face."
df5e6194 6114 (cond
55732434
GM
6115 (ps-black-white-faces-alist
6116 (or (and (symbolp face)
6117 (cdr (assq face ps-black-white-faces-alist)))
6118 (vector 0 nil nil)))
df5e6194
GM
6119 ((symbolp face)
6120 (cdr (or (assq face ps-print-face-extension-alist)
6121 (assq face ps-print-face-alist)
6122 (let* ((the-face (if (facep face) face 'default))
6123 (new-face (ps-screen-to-bit-face the-face)))
6124 (or (and (eq the-face 'default)
6125 (assq the-face ps-print-face-alist))
6126 (setq ps-print-face-alist
6127 (cons new-face ps-print-face-alist)))
6128 new-face))))
42af7493 6129 ((ps-face-foreground-color-p (car face))
df5e6194 6130 (vector 0 (cdr face) nil))
42af7493 6131 ((ps-face-background-color-p (car face))
df5e6194
GM
6132 (vector 0 nil (cdr face)))
6133 (t
6134 (vector 0 nil nil))))
87a16a06 6135
043620f4 6136
906d41a7 6137(defun ps-face-background (face background)
e85cca87
VJL
6138 (and (cond ((eq ps-use-face-background t)) ; always
6139 ((null ps-use-face-background) nil) ; never
6140 ;; ps-user-face-background is a symbol face list
6141 ((symbolp face)
6142 (memq face ps-use-face-background))
6143 ((listp face)
42af7493 6144 (or (ps-face-color-p (car face))
e85cca87
VJL
6145 (let (ok)
6146 (while face
6147 (if (or (memq (car face) ps-use-face-background)
42af7493 6148 (ps-face-color-p (car face)))
e85cca87
VJL
6149 (setq face nil
6150 ok t)
6151 (setq face (cdr face))))
6152 ok)))
6153 (t
6154 nil)
6155 )
906d41a7
GM
6156 background))
6157
6158
043620f4 6159(defun ps-face-attribute-list (face-or-list)
df5e6194
GM
6160 (cond
6161 ;; simple face
6162 ((not (listp face-or-list))
6163 (ps-face-attributes face-or-list))
6164 ;; only foreground color, not a `real' face
42af7493 6165 ((ps-face-foreground-color-p (car face-or-list))
df5e6194
GM
6166 (vector 0 (cdr face-or-list) nil))
6167 ;; only background color, not a `real' face
42af7493 6168 ((ps-face-background-color-p (car face-or-list))
df5e6194
GM
6169 (vector 0 nil (cdr face-or-list)))
6170 ;; list of faces
6171 (t
6172 (let ((effects 0)
6173 foreground background face-attr face)
6174 (while face-or-list
6175 (setq face (car face-or-list)
6176 face-or-list (cdr face-or-list)
6177 face-attr (ps-face-attributes face)
6178 effects (logior effects (aref face-attr 0)))
6179 (or foreground (setq foreground (aref face-attr 1)))
6180 (or background
6181 (setq background (ps-face-background face (aref face-attr 2)))))
6182 (vector effects foreground background)))))
043620f4 6183
87a16a06 6184
12b88fff
RS
6185(defconst ps-font-type (vector nil 'bold 'italic 'bold-italic))
6186
6187
12d89a2e 6188(defun ps-plot-with-face (from to face)
12b88fff
RS
6189 (cond
6190 ((null face) ; print text with null face
87a16a06 6191 (ps-plot-region from to 0))
12b88fff
RS
6192 ((eq face 'emacs--invisible--face)) ; skip invisible text!!!
6193 (t ; otherwise, text has a valid face
6194 (let* ((face-bit (ps-face-attribute-list face))
6195 (effect (aref face-bit 0))
6196 (foreground (aref face-bit 1))
906d41a7 6197 (background (ps-face-background face (aref face-bit 2)))
d3ab8dac 6198 (fg-color (if (and ps-color-p foreground)
6e1b1da6 6199 (ps-color-scale foreground)
12b88fff 6200 ps-default-color))
d3ab8dac 6201 (bg-color (and ps-color-p background
6e1b1da6 6202 (ps-color-scale background))))
12b88fff
RS
6203 (ps-plot-region
6204 from to
6205 (ps-font-number 'ps-font-for-text
6206 (or (aref ps-font-type (logand effect 3))
6207 face))
6208 fg-color bg-color (lsh effect -2)))))
87a16a06 6209 (goto-char to))
12d89a2e
RS
6210
6211
043620f4
KH
6212;; Ensure that face-list is fbound.
6213(or (fboundp 'face-list) (defalias 'face-list 'list-faces))
12d89a2e 6214
a18ed129 6215
12d89a2e 6216(defun ps-build-reference-face-lists ()
857686a6
RS
6217 ;; Ensure that face database is updated with faces on
6218 ;; `font-lock-face-attributes' (obsolete stuff)
6219 (ps-font-lock-face-attributes)
6220 ;; Now, rebuild reference face lists
a18ed129 6221 (setq ps-print-face-alist nil)
12d89a2e 6222 (if ps-auto-font-detect
42af7493
VJL
6223 (mapc 'ps-map-face (face-list))
6224 (mapc 'ps-set-face-bold ps-bold-faces)
6225 (mapc 'ps-set-face-italic ps-italic-faces)
6226 (mapc 'ps-set-face-underline ps-underlined-faces))
12d89a2e 6227 (setq ps-build-face-reference nil))
ef2cbb24 6228
a18ed129
RS
6229
6230(defun ps-set-face-bold (face)
6231 (ps-set-face-attribute face 1))
6232
6233(defun ps-set-face-italic (face)
6234 (ps-set-face-attribute face 2))
6235
6236(defun ps-set-face-underline (face)
6237 (ps-set-face-attribute face 4))
6238
6239
6240(defun ps-set-face-attribute (face effect)
6241 (let ((face-bit (cdr (ps-map-face face))))
6242 (aset face-bit 0 (logior (aref face-bit 0) effect))))
6243
6244
6245(defun ps-map-face (face)
6246 (let* ((face-map (ps-screen-to-bit-face face))
6247 (ps-face-bit (cdr (assq (car face-map) ps-print-face-alist))))
6248 (if ps-face-bit
6249 ;; if face exists, merge both
6250 (let ((face-bit (cdr face-map)))
6251 (aset ps-face-bit 0 (logior (aref ps-face-bit 0) (aref face-bit 0)))
6252 (or (aref ps-face-bit 1) (aset ps-face-bit 1 (aref face-bit 1)))
6253 (or (aref ps-face-bit 2) (aset ps-face-bit 2 (aref face-bit 2))))
6254 ;; if face does not exist, insert it
6255 (setq ps-print-face-alist (cons face-map ps-print-face-alist)))
6256 face-map))
6257
6258
6259(defun ps-screen-to-bit-face (face)
6260 (cons face
6261 (vector (logior (if (ps-face-bold-p face) 1 0) ; bold
6262 (if (ps-face-italic-p face) 2 0) ; italic
6263 (if (ps-face-underlined-p face) 4 0)) ; underline
8e234846
GM
6264 (ps-face-foreground-name face)
6265 (ps-face-background-name face))))
a18ed129
RS
6266
6267
b6d0ac87
VJL
6268;; to avoid compilation gripes
6269(defalias 'ps-jitify 'jit-lock-fontify-now)
6270(defalias 'ps-lazify 'lazy-lock-fontify-region)
6271
6272
3e9cb08f 6273;; to avoid compilation gripes
ea0c615d 6274(defun ps-print-ensure-fontified (start end)
b6d0ac87
VJL
6275 (cond ((and (boundp 'jit-lock-mode) (symbol-value 'jit-lock-mode))
6276 (ps-jitify start end))
6277 ((and (boundp 'lazy-lock-mode) (symbol-value 'lazy-lock-mode))
6278 (ps-lazify start end))))
043620f4 6279
043620f4 6280
ef2cbb24 6281(defun ps-generate-postscript-with-faces (from to)
87a16a06 6282 ;; Some initialization...
857686a6 6283 (setq ps-current-effect 0)
87a16a06 6284
00aa16af 6285 ;; Build the reference lists of faces if necessary.
8e234846
GM
6286 (when (or ps-always-build-face-reference
6287 ps-build-face-reference)
6288 (message "Collecting face information...")
6289 (ps-build-reference-face-lists))
55732434
GM
6290
6291 ;; Black/white printer.
6292 (setq ps-black-white-faces-alist nil)
6293 (and (eq ps-print-color-p 'black-white)
6294 (ps-extend-face-list ps-black-white-faces nil
6295 'ps-black-white-faces-alist))
6296
00aa16af 6297 ;; Generate some PostScript.
ef2cbb24
RS
6298 (save-restriction
6299 (narrow-to-region from to)
d3ab8dac 6300 (ps-print-ensure-fontified from to)
c97a3f22 6301 (ps-generate-postscript-with-faces1 from to)))
ef2cbb24
RS
6302
6303(defun ps-generate-postscript (from to)
e85cca87 6304 (ps-plot-region from to 0))
ef2cbb24
RS
6305
6306(defun ps-generate (buffer from to genfunc)
87a16a06
RS
6307 (save-excursion
6308 (let ((from (min to from))
6309 (to (max to from))
6310 ;; This avoids trouble if chars with read-only properties
6311 ;; are copied into ps-spool-buffer.
6312 (inhibit-read-only t))
6313 (save-restriction
6314 (narrow-to-region from to)
857686a6
RS
6315 (and ps-razzle-dazzle
6316 (message "Formatting...%3d%%" (setq ps-razchunk 0)))
8bd22fcf
KH
6317 (setq ps-source-buffer buffer
6318 ps-spool-buffer (get-buffer-create ps-spool-buffer-name))
87a16a06
RS
6319 (ps-init-output-queue)
6320 (let (safe-marker completed-safely needs-begin-file)
6321 (unwind-protect
00aa16af
RS
6322 (progn
6323 (set-buffer ps-spool-buffer)
7da17ab6 6324 (set-buffer-multibyte nil)
915293a2 6325
87a16a06
RS
6326 ;; Get a marker and make it point to the current end of the
6327 ;; buffer, If an error occurs, we'll delete everything from
6328 ;; the end of this marker onwards.
6329 (setq safe-marker (make-marker))
6330 (set-marker safe-marker (point-max))
6331
6332 (goto-char (point-min))
8bd22fcf
KH
6333 (or (looking-at (regexp-quote ps-adobe-tag))
6334 (setq needs-begin-file t))
ea0c615d
GM
6335
6336 (set-buffer ps-source-buffer)
87a16a06 6337 (save-excursion
ea0c615d
GM
6338 (let ((ps-print-page-p t)
6339 ps-even-or-odd-pages)
e85cca87 6340 (ps-begin-job genfunc)
70f57a72
GM
6341 (when needs-begin-file
6342 (ps-begin-file)
6343 (ps-mule-initialize))
6344 (ps-mule-begin-job from to)
ea0c615d
GM
6345 (ps-selected-pages)))
6346 (ps-begin-page)
87a16a06
RS
6347 (funcall genfunc from to)
6348 (ps-end-page)
f07bb446 6349 (ps-mule-end-job)
ea0c615d 6350 (ps-end-job needs-begin-file)
87a16a06
RS
6351
6352 ;; Setting this variable tells the unwind form that the
8bd22fcf 6353 ;; the PostScript was generated without error.
87a16a06
RS
6354 (setq completed-safely t))
6355
6356 ;; Unwind form: If some bad mojo occurred while generating
8bd22fcf 6357 ;; PostScript, delete all the PostScript that was generated.
87a16a06
RS
6358 ;; This protects the previously spooled files from getting
6359 ;; corrupted.
8bd22fcf
KH
6360 (and (markerp safe-marker) (not completed-safely)
6361 (progn
6362 (set-buffer ps-spool-buffer)
6363 (delete-region (marker-position safe-marker) (point-max))))))
87a16a06 6364
857686a6 6365 (and ps-razzle-dazzle (message "Formatting...done"))))))
ef2cbb24 6366
e65df0a1 6367
ea0c615d 6368(defun ps-end-job (needs-begin-file)
9dae638c 6369 (let ((ps-print-page-p t))
ea0c615d
GM
6370 (ps-flush-output)
6371 (save-excursion
4b3eb10f 6372 (let ((pages-per-sheet (mod ps-page-printed ps-n-up-printing))
ea0c615d 6373 (total-lines (cdr ps-printing-region))
ef1159c2 6374 (total-pages (ps-page-number)))
ea0c615d 6375 (set-buffer ps-spool-buffer)
ef1159c2
EZ
6376 (let (case-fold-search)
6377 ;; Back to the PS output buffer to set the last page n-up printing
6378 (goto-char (point-max))
6379 (and (> pages-per-sheet 0)
6380 (re-search-backward "^[0-9]+ BeginSheet$" nil t)
6381 (replace-match (format "%d BeginSheet" pages-per-sheet) t))
6382 ;; Back to the PS output buffer to set the page count
6383 (goto-char (point-min))
6384 (while (re-search-forward "^/Lines 0 def\n/PageCount 0 def$" nil t)
6385 (replace-match (format "/Lines %d def\n/PageCount %d def"
6386 total-lines total-pages) t)))))
ea0c615d
GM
6387 ;; Set dummy page
6388 (and ps-spool-duplex (= (mod ps-page-order 2) 1)
6389 (let ((ps-n-up-printing 0))
6390 (ps-header-sheet)
6391 (ps-output "/PrintHeader false def\n/ColumnIndex 0 def\n"
bd7a2e26
GM
6392 "/PrintLineNumber false def\n"
6393 (number-to-string ps-lines-printed) " BeginPage\n")
ea0c615d
GM
6394 (ps-end-page)))
6395 ;; Set end of PostScript file
9dae638c 6396 (ps-end-sheet)
4b3eb10f 6397 (ps-output "\n%%Trailer\n%%Pages: "
ea0c615d
GM
6398 (number-to-string
6399 (if (and needs-begin-file
6400 ps-banner-page-when-duplexing)
6401 (1+ ps-page-order)
6402 ps-page-order))
6403 "\n\nEndDoc\n\n%%EOF\n")
ef1159c2
EZ
6404 (and ps-end-with-control-d
6405 (ps-output "\C-d"))
ea0c615d
GM
6406 (ps-flush-output))
6407 ;; disable selected pages
1fd9b7fe 6408 (setq ps-selected-pages nil))
7d8b7e8e
KH
6409
6410
857686a6 6411;; Permit dynamic evaluation at print time of `ps-lpr-switches'.
ef2cbb24 6412(defun ps-do-despool (filename)
12d89a2e 6413 (if (or (not (boundp 'ps-spool-buffer))
bcc0d457 6414 (not (symbol-value 'ps-spool-buffer)))
12d89a2e 6415 (message "No spooled PostScript to print")
ef2cbb24
RS
6416 (if filename
6417 (save-excursion
857686a6 6418 (and ps-razzle-dazzle (message "Saving..."))
12d89a2e 6419 (set-buffer ps-spool-buffer)
ef2cbb24 6420 (setq filename (expand-file-name filename))
7ffaf659
EZ
6421 (let ((coding-system-for-write 'raw-text-unix))
6422 (write-region (point-min) (point-max) filename))
857686a6 6423 (and ps-razzle-dazzle (message "Wrote %s" filename)))
ef2cbb24 6424 ;; Else, spool to the printer
857686a6 6425 (and ps-razzle-dazzle (message "Printing..."))
ef2cbb24 6426 (save-excursion
12d89a2e 6427 (set-buffer ps-spool-buffer)
200127fd 6428 (let* ((coding-system-for-write 'raw-text-unix)
298bfad9
KH
6429 (ps-printer-name (or ps-printer-name
6430 (and (boundp 'printer-name)
2bd80d73 6431 (symbol-value 'printer-name))))
200127fd 6432 (ps-lpr-switches
3556c6dd
GM
6433 (append ps-lpr-switches
6434 (and (stringp ps-printer-name)
6435 (string< "" ps-printer-name)
6436 (list (concat
6437 (and (stringp ps-printer-name-option)
6438 ps-printer-name-option)
6439 ps-printer-name))))))
830f437e
VJL
6440 (or (stringp ps-printer-name)
6441 (setq ps-printer-name nil))
52cf535f
AI
6442 (apply (or ps-print-region-function 'call-process-region)
6443 (point-min) (point-max) ps-lpr-command nil
6444 (and (fboundp 'start-process) 0)
6445 nil
6446 (ps-flatten-list ; dynamic evaluation
6447 (mapcar 'ps-eval-switch ps-lpr-switches)))))
857686a6 6448 (and ps-razzle-dazzle (message "Printing...done")))
12d89a2e
RS
6449 (kill-buffer ps-spool-buffer)))
6450
857686a6
RS
6451;; Dynamic evaluation
6452(defun ps-eval-switch (arg)
6453 (cond ((stringp arg) arg)
6454 ((functionp arg) (apply arg nil))
6455 ((symbolp arg) (symbol-value arg))
6456 ((consp arg) (apply (car arg) (cdr arg)))
6457 (t nil)))
6458
6459;; `ps-flatten-list' is defined here (copied from "message.el" and
6460;; enhanced to handle dotted pairs as well) until we can get some
6461;; sensible autoloads, or `flatten-list' gets put somewhere decent.
6462
6463;; (ps-flatten-list '((a . b) c (d . e) (f g h) i . j))
6464;; => (a b c d e f g h i j)
6465
6466(defun ps-flatten-list (&rest list)
6467 (ps-flatten-list-1 list))
6468
6469(defun ps-flatten-list-1 (list)
6470 (cond ((null list) nil)
6471 ((consp list) (append (ps-flatten-list-1 (car list))
6472 (ps-flatten-list-1 (cdr list))))
6473 (t (list list))))
6474
12d89a2e
RS
6475(defun ps-kill-emacs-check ()
6476 (let (ps-buffer)
8bd22fcf 6477 (and (setq ps-buffer (get-buffer ps-spool-buffer-name))
6b61353c 6478 (buffer-name ps-buffer) ; check if it's not killed
8bd22fcf
KH
6479 (buffer-modified-p ps-buffer)
6480 (y-or-n-p "Unprinted PostScript waiting; print now? ")
6481 (ps-despool))
6482 (and (setq ps-buffer (get-buffer ps-spool-buffer-name))
6b61353c 6483 (buffer-name ps-buffer) ; check if it's not killed
8bd22fcf
KH
6484 (buffer-modified-p ps-buffer)
6485 (not (yes-or-no-p "Unprinted PostScript waiting; exit anyway? "))
6486 (error "Unprinted PostScript"))))
12d89a2e 6487
d3ab8dac
KH
6488(cond ((fboundp 'add-hook)
6489 (funcall 'add-hook 'kill-emacs-hook 'ps-kill-emacs-check))
6490 (kill-emacs-hook
6491 (message "Won't override existing `kill-emacs-hook'"))
6492 (t
6493 (setq kill-emacs-hook 'ps-kill-emacs-check)))
ef2cbb24 6494
298bfad9 6495\f
298bfad9
KH
6496;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
6497;; To make this file smaller, some commands go in a separate file.
6498;; But autoload them here to make the separation invisible.
231f3e66 6499\f
4dacf5c5 6500;;;### (autoloads (ps-mule-end-job ps-mule-begin-job ps-mule-initialize
985773c9 6501;;;;;; ps-multibyte-buffer) "ps-mule" "ps-mule.el" "ba0ba38bf1f9831ca12701290fd4b211")
231f3e66 6502;;; Generated autoloads from ps-mule.el
298bfad9 6503
231f3e66
SM
6504(defvar ps-multibyte-buffer nil "\
6505*Specifies the multi-byte buffer handling.
298bfad9 6506
231f3e66 6507Valid values are:
298bfad9 6508
5da6890d
SM
6509 nil This is the value to use the default settings;
6510 by default, this only works to print buffers with
6511 only ASCII and Latin characters. But this default
6512 setting can be changed by setting the variable
231f3e66
SM
6513 `ps-mule-font-info-database-default' differently.
6514 The initial value of this variable is
6515 `ps-mule-font-info-database-latin' (see
6516 documentation).
6517
5da6890d 6518 `non-latin-printer' This is the value to use when you have a Japanese
231f3e66
SM
6519 or Korean PostScript printer and want to print
6520 buffer with ASCII, Latin-1, Japanese (JISX0208 and
6521 JISX0201-Kana) and Korean characters. At present,
6fb87e51
VJL
6522 it was not tested with the Korean characters
6523 printing. If you have a korean PostScript printer,
6524 please, test it.
231f3e66 6525
5da6890d 6526 `bdf-font' This is the value to use when you want to print
231f3e66
SM
6527 buffer with BDF fonts. BDF fonts include both latin
6528 and non-latin fonts. BDF (Bitmap Distribution
6529 Format) is a format used for distributing X's font
6530 source file. BDF fonts are included in
6531 `intlfonts-1.2' which is a collection of X11 fonts
6532 for all characters supported by Emacs. In order to
6533 use this value, be sure to have installed
6534 `intlfonts-1.2' and set the variable
6535 `bdf-directory-list' appropriately (see ps-bdf.el for
6536 documentation of this variable).
6537
5da6890d 6538 `bdf-font-except-latin' This is like `bdf-font' except that it uses
231f3e66
SM
6539 PostScript default fonts to print ASCII and Latin-1
6540 characters. This is convenient when you want or
6541 need to use both latin and non-latin characters on
6542 the same buffer. See `ps-font-family',
6543 `ps-header-font-family' and `ps-font-info-database'.
6544
6545Any other value is treated as nil.")
6546
985773c9 6547(custom-autoload 'ps-multibyte-buffer "ps-mule" t)
231f3e66 6548
985773c9 6549(autoload 'ps-mule-initialize "ps-mule" "\
231f3e66
SM
6550Initialize global data for printing multi-byte characters.
6551
6552\(fn)" nil nil)
6553
985773c9 6554(autoload 'ps-mule-begin-job "ps-mule" "\
231f3e66 6555Start printing job for multi-byte chars between FROM and TO.
5ef05ae3 6556It checks if all multi-byte characters in the region are printable or not.
298bfad9 6557
231f3e66 6558\(fn FROM TO)" nil nil)
298bfad9 6559
985773c9 6560(autoload 'ps-mule-end-job "ps-mule" "\
4dacf5c5 6561Finish printing job for multi-byte chars.
298bfad9 6562
231f3e66 6563\(fn)" nil nil)
6bf5fb46 6564
231f3e66 6565;;;***
298bfad9
KH
6566\f
6567;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
6568
12d89a2e 6569(provide 'ps-print)
b87c5d3d 6570
231f3e66 6571;; arch-tag: fb06a585-1112-4206-885d-a57d95d50579
12d89a2e 6572;;; ps-print.el ends here