]> code.delx.au - gnu-emacs/blobdiff - lisp/ps-print.el
(ps-zebra-stripe-follow): Don't quote nil and t in docstrings.
[gnu-emacs] / lisp / ps-print.el
index 54fbf2d6c854dddccf8e54ec1529467e5665cd68..9a6a555f0ffc7bf2cb41e0d34bd69605fd47ea9e 100644 (file)
@@ -1,28 +1,28 @@
 ;;; ps-print.el --- print text from the buffer as PostScript
 
-;; Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
-;; Free Software Foundation, Inc.
+;; Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
+;; 2003 Free Software Foundation, Inc.
 
 ;; Author: Jim Thompson (was <thompson@wg2.waii.com>)
 ;;     Jacques Duthen (was <duthen@cegelec-red.fr>)
-;;     Vinicius Jose Latorre <vinicius@cpqd.com.br>
+;;     Vinicius Jose Latorre <viniciusjl@ig.com.br>
 ;;     Kenichi Handa <handa@etl.go.jp> (multi-byte characters)
 ;; Maintainer: Kenichi Handa <handa@etl.go.jp> (multi-byte characters)
-;;     Vinicius Jose Latorre <vinicius@cpqd.com.br>
+;;     Vinicius Jose Latorre <viniciusjl@ig.com.br>
 ;; Keywords: wp, print, PostScript
-;; Time-stamp: <2002/09/06 20:11:00 vinicius>
-;; Version: 6.5.6
+;; Time-stamp: <2003/03/05 21:54:55 vinicius>
+;; Version: 6.6
 ;; X-URL: http://www.cpqd.com.br/~vinicius/emacs/
 
-(defconst ps-print-version "6.5.6"
-  "ps-print.el, v 6.5.6 <2002/09/06 vinicius>
+(defconst ps-print-version "6.6"
+  "ps-print.el, v 6.6 <2003/03/05 vinicius>
 
 Vinicius's last change version -- this file may have been edited as part of
 Emacs without changes to the version number.  When reporting bugs, please also
 report the version of Emacs, if any, that ps-print was distributed with.
 
 Please send all bug fixes and enhancements to
-       Vinicius Jose Latorre <vinicius@cpqd.com.br>.")
+       Vinicius Jose Latorre <viniciusjl@ig.com.br>.")
 
 ;; This file is part of GNU Emacs.
 
@@ -49,8 +49,8 @@ Please send all bug fixes and enhancements to
 ;;
 ;; This package provides printing of Emacs buffers on PostScript printers; the
 ;; buffer's bold and italic text attributes are preserved in the printer
-;; output.  ps-print is intended for use with Emacs or Lucid Emacs, together
-;; with a fontifying package such as font-lock or hilit.
+;; output.  ps-print is intended for use with Emacs or XEmacs, together with a
+;; fontifying package such as font-lock or hilit.
 ;;
 ;; ps-print uses the same face attributes defined through font-lock or hilit to
 ;; print a PostScript file, but some faces are better seeing on the screen than
@@ -1075,7 +1075,7 @@ Please send all bug fixes and enhancements to
 ;;    (face...)        list of faces whose background color will be used.
 ;;
 ;; Any other value will be treated as t.
-;; The default value is t.
+;; The default value is nil.
 ;;
 ;;
 ;; How Ps-Print Deals With Color
@@ -1211,7 +1211,7 @@ Please send all bug fixes and enhancements to
 ;; New since version 2.8
 ;; ---------------------
 ;;
-;; [vinicius] Vinicius Jose Latorre <vinicius@cpqd.com.br>
+;; [vinicius] Vinicius Jose Latorre <viniciusjl@ig.com.br>
 ;;
 ;;    20010619
 ;;      `ps-time-stamp-locale-default'
@@ -1263,7 +1263,7 @@ Please send all bug fixes and enhancements to
 ;;
 ;; `ps-print-region-function'
 ;;
-;; [vinicius] Vinicius Jose Latorre <vinicius@cpqd.com.br>
+;; [vinicius] Vinicius Jose Latorre <viniciusjl@ig.com.br>
 ;;
 ;;    19990301
 ;;      PostScript tumble and setpagedevice.
@@ -1276,7 +1276,7 @@ Please send all bug fixes and enhancements to
 ;;
 ;; Multi-byte buffer handling.
 ;;
-;; [vinicius] Vinicius Jose Latorre <vinicius@cpqd.com.br>
+;; [vinicius] Vinicius Jose Latorre <viniciusjl@ig.com.br>
 ;;
 ;;    19980306
 ;;      Skip invisible text.
@@ -1329,7 +1329,7 @@ Please send all bug fixes and enhancements to
 ;;
 ;; Faces are always treated as opaque.
 ;;
-;; Epoch and Emacs 19 not supported.  At all.
+;; Epoch, Lucid and Emacs 19 not supported.  At all.
 ;;
 ;; Fixed-pitch fonts work better for line folding, but are not required.
 ;;
@@ -1442,6 +1442,20 @@ Please send all bug fixes and enhancements to
       (error "`ps-print' requires floating point support"))
 
 
+  (defvar ps-print-emacs-type
+    (let ((case-fold-search t))
+      (cond ((string-match "XEmacs" emacs-version) 'xemacs)
+           ((string-match "Lucid" emacs-version)
+            (error "`ps-print' doesn't support Lucid"))
+           ((string-match "Epoch" emacs-version)
+            (error "`ps-print' doesn't support Epoch"))
+           (t
+            (unless (and (boundp 'emacs-major-version)
+                         (> emacs-major-version 19))
+              (error "`ps-print' only supports Emacs 20 and higher"))
+            'emacs))))
+
+
   ;; For Emacs 20.2 and the earlier version.
 
   (or (fboundp 'set-buffer-multibyte)
@@ -1510,11 +1524,26 @@ Please send all bug fixes and enhancements to
     (memq system-type '(usg-unix-v dgux hpux irix)))
 
 
-  (defvar ps-print-emacs-type
-    (cond ((string-match "XEmacs" emacs-version) 'xemacs)
-         ((string-match "Lucid" emacs-version) 'lucid)
-         ((string-match "Epoch" emacs-version) 'epoch)
-         (t 'emacs))))
+  (defun ps-xemacs-color-name (color)
+    (if (ps-x-color-specifier-p color)
+       (ps-x-color-name color)
+      color))
+
+
+  (cond ((eq ps-print-emacs-type 'emacs) ; emacs
+        (defvar mark-active nil)
+        (defun ps-mark-active-p ()
+          mark-active)
+        (defalias 'ps-face-foreground-name 'face-foreground)
+        (defalias 'ps-face-background-name 'face-background)
+        )
+       (t                              ; xemacs
+        (defalias 'ps-mark-active-p 'region-active-p)
+        (defun ps-face-foreground-name (face)
+          (ps-xemacs-color-name (face-foreground face)))
+        (defun ps-face-background-name (face)
+          (ps-xemacs-color-name (face-background face)))
+        )))
 
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
@@ -1679,7 +1708,7 @@ more requirements put them first in `ps-print-prologue-header' using the
 requirements and set %%LanguageLevel: to 2, do:
 
  (setq ps-print-prologue-header
-      \"%%+ numcopies(3) jog\\n%%LanguageLevel: 2\\n\")
+       \"%%+ numcopies(3) jog\\n%%LanguageLevel: 2\\n\")
 
 The duplex requirement is inserted by ps-print (see `ps-spool-duplex').
 
@@ -1877,7 +1906,7 @@ If nil, print all pages.
 
 If a list, the lists element may be an integer or a cons cell (FROM . TO)
 designating FROM page to TO page; any invalid element is ignored, that is, an
-integer less than one or if FROM is greater than TO.
+integer lesser than one or if FROM is greater than TO.
 
 Otherwise, it's treated as nil.
 
@@ -2105,7 +2134,7 @@ that a line is printed):
                22       +   22          +
                --------     -----------     ---------     ----------------
 
-Any other value is treated as `nil'."
+Any other value is treated as nil."
   :type '(choice :menu-tag "Zebra Stripe Follow"
                 :tag "Zebra Stripe Follow"
                 (const :tag "Always Restart" nil)
@@ -2866,9 +2895,7 @@ uses the fonts resident in your printer."
 ;;                widget to work.
 ;;;###autoload
 (defcustom ps-print-color-p
-  (or (and (fboundp 'color-values)     ; Emacs
-          (ps-e-color-values "Green"))
-      (fboundp 'x-color-values)                ; Emacs
+  (or (fboundp 'x-color-values)                ; Emacs
       (fboundp 'color-instance-rgb-components))
                                        ; XEmacs
   "*Specify how buffer's text color is printed.
@@ -2890,10 +2917,37 @@ Any other value is treated as t."
                 (const :tag "Print Black/White Color" black-white))
   :group 'ps-print-color)
 
-(defcustom ps-default-fg '(0.0 0.0 0.0)
-  "*RGB values of the default foreground color.  Defaults to black."
+(defcustom ps-default-fg '(0.0 0.0 0.0) ; black
+  "*RGB values of the default foreground color.  Defaults to black.
+
+The `ps-default-fg' variable contains the default foreground color used by
+ps-print, that is, if there is a face in a text that doesn't have a foreground
+color, the `ps-default-fg' color should be used.
+
+Valid values are:
+
+   t           The foreground color of Emacs session will be used.
+
+   NUMBER      It's a real value between 0.0 (black) and 1.0 (white) that
+               indicate the gray color.
+
+   COLOR-NAME  It's a string wich contains the color name.  For example:
+               \"yellow\".
+
+   LIST                It's a list of RGB values, that is a list of three real values
+               of the form:
+
+                 (RED, GREEN, BLUE)
+
+               Where RED, GREEN and BLUE are reals between 0.0 (no color) and
+               1.0 (full color).
+
+Any other value is ignored and it's used the black color.
+
+It's used only when `ps-print-color-p' is non-nil."
   :type '(choice :menu-tag "Default Foreground Gray/Color"
                 :tag "Default Foreground Gray/Color"
+                (const :tag "Session Foreground" t)
                 (number :tag "Gray Scale" :value 0.0)
                 (string :tag "Color Name" :value "black")
                 (list :tag "RGB Color" :value (0.0 0.0 0.0)
@@ -2902,10 +2956,39 @@ Any other value is treated as t."
                       (number :tag "Blue")))
   :group 'ps-print-color)
 
-(defcustom ps-default-bg '(1.0 1.0 1.0)
-  "*RGB values of the default background color.  Defaults to white."
+(defcustom ps-default-bg '(1.0 1.0 1.0) ; white
+  "*RGB values of the default background color.  Defaults to white.
+
+The `ps-default-bg' variable contains the default background color used by
+ps-print, that is, if there is a face in a text that doesn't have a background
+color, the `ps-default-bg' color should be used.
+
+Valid values are:
+
+   t           The background color of Emacs session will be used.
+
+   NUMBER      It's a real value between 0.0 (black) and 1.0 (white) that
+               indicate the gray color.
+
+   COLOR-NAME  It's a string wich contains the color name.  For example:
+               \"yellow\".
+
+   LIST                It's a list of RGB values, that is a list of three real values
+               of the form:
+
+                 (RED, GREEN, BLUE)
+
+               Where RED, GREEN and BLUE are reals between 0.0 (no color) and
+               1.0 (full color).
+
+Any other value is ignored and it's used the white color.
+
+It's used only when `ps-print-color-p' is non-nil.
+
+See also `ps-use-face-background'."
   :type '(choice :menu-tag "Default Background Gray/Color"
                 :tag "Default Background Gray/Color"
+                (const :tag "Session Background" t)
                 (number :tag "Gray Scale" :value 1.0)
                 (string :tag "Color Name" :value "white")
                 (list :tag "RGB Color" :value (1.0 1.0 1.0)
@@ -3152,13 +3235,13 @@ It's like the very first character of buffer (or region) is ^L (\\014)."
   (or (cond
        ((eq ps-print-emacs-type 'emacs)        ; emacs
        data-directory)
-       ((fboundp 'locate-data-directory) ; emacsens (xemacs, etc.)
+       ((fboundp 'locate-data-directory) ; xemacs
        (locate-data-directory "ps-print"))
-       ((boundp 'data-directory)       ; emacsens (xemacs, etc.)
+       ((boundp 'data-directory)       ; xemacs
        data-directory)
        (t                              ; don't know what to do
        nil))
-      (error "ps-postscript-code-directory isn't set properly"))
+      (error "`ps-postscript-code-directory' isn't set properly"))
   "*Directory where it's located the PostScript prologue file used by ps-print.
 By default, this directory is the same as in the variable `data-directory'."
   :type 'directory
@@ -3617,13 +3700,11 @@ It can be retrieved with `(ps-get ALIST-SYM KEY)'."
 
 
 (eval-and-compile
-  (if (memq ps-print-emacs-type '(lucid xemacs))
-      ;; XEmacs change: Need to check for emacs-major-version too.
-      (if (or (< emacs-major-version 19)
-             (and (= emacs-major-version 19) (< emacs-minor-version 12)))
-         (setq ps-print-color-p nil))
-    (require 'faces))                  ; face-font, face-underline-p,
-                                       ; x-font-regexp
+  (and (eq ps-print-emacs-type 'xemacs)
+       ;; XEmacs change: Need to check for emacs-major-version too.
+       (or (< emacs-major-version 19)
+          (and (= emacs-major-version 19) (< emacs-minor-version 12)))
+       (setq ps-print-color-p nil))
 
 
   ;; Return t if the device (which can be changed during an emacs session)
@@ -3664,11 +3745,6 @@ It can be retrieved with `(ps-get ALIST-SYM KEY)'."
           (case-fold-search t))
       (and kind-spec (string-match kind-regex kind-spec))))
 
-  (defun ps-xemacs-color-name (color)
-    (if (ps-x-color-specifier-p color)
-       (ps-x-color-name color)
-      color))
-
   (cond ((eq ps-print-emacs-type 'emacs) ; emacs
 
         (defun ps-color-values (x-color)
@@ -3680,9 +3756,6 @@ It can be retrieved with `(ps-get ALIST-SYM KEY)'."
            (t
             (error "No available function to determine X color values"))))
 
-        (defalias 'ps-face-foreground-name 'face-foreground)
-        (defalias 'ps-face-background-name 'face-background)
-
         (defun ps-face-bold-p (face)
           (or (ps-e-face-bold-p face)
               (memq face ps-bold-faces)))
@@ -3691,9 +3764,8 @@ It can be retrieved with `(ps-get ALIST-SYM KEY)'."
           (or (ps-e-face-italic-p face)
               (memq face ps-italic-faces)))
         )
-                                       ; xemacs
-                                       ; lucid
-       (t                              ; epoch
+
+       (t                              ; xemacs
 
         ;; to avoid XEmacs compilation gripes
         (defvar coding-system-for-write   nil)
@@ -3718,12 +3790,6 @@ It can be retrieved with `(ps-get ALIST-SYM KEY)'."
              (t
               (error "No available function to determine X color values")))))
 
-        (defun ps-face-foreground-name (face)
-          (ps-xemacs-color-name (face-foreground face)))
-
-        (defun ps-face-background-name (face)
-          (ps-xemacs-color-name (face-background face)))
-
         (defun ps-face-bold-p (face)
           (or (ps-xemacs-face-kind-p face 'WEIGHT_NAME "bold\\|demibold")
               (memq face ps-bold-faces))) ; Kludge-compatible
@@ -3805,6 +3871,7 @@ Note: No major/minor-mode is activated and no local variables are evaluated for
 
 (defvar ps-current-font 0)
 (defvar ps-default-foreground nil)
+(defvar ps-default-background nil)
 (defvar ps-default-color nil)
 (defvar ps-current-color nil)
 (defvar ps-current-bg nil)
@@ -3821,7 +3888,7 @@ Note: No major/minor-mode is activated and no local variables are evaluated for
       ;; PostScript output.
       "%0.3f %0.3f %0.3f"
 
-    ;; Lucid emacsen will have to make do with %s (princ) for floats.
+    ;; XEmacs will have to make do with %s (princ) for floats.
     "%s %s %s"))
 
 ;; These values determine how much print-height to deduct when headers/footers
@@ -4430,10 +4497,7 @@ page-height == ((floor print-height ((th + ls) * zh)) * ((th + ls) * zh)) - th
 
 
 (defun ps-print-preprint-region (prefix-arg)
-  (or (and (fboundp 'mark-active)
-          (mark-active))
-      (and (fboundp 'region-active-p)
-          (region-active-p))
+  (or (ps-mark-active-p)
       (error "The mark is not set now"))
   (list (point) (mark) (ps-print-preprint prefix-arg)))
 
@@ -4509,7 +4573,12 @@ page-height == ((floor print-height ((th + ls) * zh)) * ((th + ls) * zh)) - th
   (while (progn (skip-chars-forward " -'*-[]-~") (not (eobp)))
     (let ((special (following-char)))
       (delete-char 1)
-      (insert (aref ps-string-escape-codes special))))
+      (insert
+       (if (and (<= 0 special) (<= special 255))
+          (aref ps-string-escape-codes special)
+        ;; insert hexadecimal representation if character code is out of range
+        (format "\\%04X" special)
+        ))))
   (goto-char (point-max))
   (insert ")"))                                ;insert end-string delimiter
 
@@ -4685,11 +4754,11 @@ page-height == ((floor print-height ((th + ls) * zh)) * ((th + ls) * zh)) - th
 
 ;; Emacs understands the %f format; we'll use it to limit color RGB values
 ;; to three decimals to cut down some on the size of the PostScript output.
-;; Lucid emacsen will have to make do with %s (princ) for floats.
+;; XEmacs will have to make do with %s (princ) for floats.
 
 (defvar ps-float-format (if (eq ps-print-emacs-type 'emacs)
                            "%0.3f "    ; emacs
-                         "%s "))       ; Lucid emacsen
+                         "%s "))       ; xemacs
 
 
 (defun ps-float-format (value &optional default)
@@ -5371,7 +5440,7 @@ XSTART YSTART are the relative position for the first page in a sheet.")
               "/ZebraColor       "
               (ps-format-color ps-zebra-color 0.95)
               "def\n/BackgroundColor  "
-              (ps-format-color ps-default-bg 1.0)
+              (ps-format-color ps-default-background 1.0)
               "def\n/UseSetpagedevice "
               (if (eq ps-spool-config 'setpagedevice)
                   "/setpagedevice where{pop languagelevel 2 eq}{false}ifelse"
@@ -5555,10 +5624,19 @@ XSTART YSTART are the relative position for the first page in a sheet.")
   (ps-get-size (symbol-value font-sym) "font size" font-sym))
 
 
-(defsubst ps-rgb-color (color default)
-  (cond ((and color (listp color)) color)
+(defun ps-rgb-color (color default)
+  (cond ((and color (listp color) (= (length color) 3)
+             (let ((cl color)
+                   (ok t) e)
+               (while (and ok cl)
+                 (setq e  (car cl)
+                       cl (cdr cl)
+                       ok (and (floatp e) (<= 0.0 e) (<= e 1.0))))
+               ok))
+        color)
+       ((and (floatp color) (<= 0.0 color) (<= color 1.0))
+        (list color color color))
        ((stringp color) (ps-color-scale color))
-       ((numberp color) (list color color color))
        (t (list default default default))
        ))
 
@@ -5632,7 +5710,16 @@ XSTART YSTART are the relative position for the first page in a sheet.")
              ((eq ps-print-control-characters 'control)
               "[\000-\037\177]")
              (t "[\t\n\f]"))
-       ps-default-foreground (ps-rgb-color ps-default-fg 0.0)
+       ps-default-background (ps-rgb-color
+                              (if (eq ps-default-bg t)
+                                  (ps-face-background-name 'default)
+                                ps-default-bg)
+                              1.0)
+       ps-default-foreground (ps-rgb-color
+                              (if (eq ps-default-fg t)
+                                  (ps-face-foreground-name 'default)
+                                ps-default-fg)
+                              0.0)
        ps-default-color (and (eq ps-print-color-p t) ps-default-foreground)
        ps-current-color ps-default-color
        ;; Set the color scale.  We do it here instead of in the defvar so
@@ -5643,7 +5730,14 @@ XSTART YSTART are the relative position for the first page in a sheet.")
                                 (float (car (ps-color-values "white")))
                               1.0))
   ;; initialize page dimensions
-  (ps-get-page-dimensions))
+  (ps-get-page-dimensions)
+  ;; final check
+  (and ps-color-p
+       (equal ps-default-background ps-default-foreground)
+       (error
+       (concat
+        "`ps-default-fg' and `ps-default-bg' have the same color.\n"
+        "Text won't appear on page.  Please, check these variables."))))
 
 
 (defun ps-page-number ()
@@ -6179,7 +6273,7 @@ If FACE is not a valid face name, it is used default face."
     (let ((face 'default)
          (position to))
       (cond
-       ((memq ps-print-emacs-type '(xemacs lucid))
+       ((eq ps-print-emacs-type 'xemacs)
        ;; Build the list of extents...
        (let ((a (cons 'dummy nil))
              record type extent extent-list)