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