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