comparison lisp/printing.el @ 56405:10b68aa88abe

Doc fix. Change name of some funs.

56404:ab69405dae2e

;; Copyright (C) 2000, 2001, 2002, 2003, 2004
;; Free Software Foundation, Inc.

;; Author: Vinicius Jose Latorre <[e-mail]>
;; Maintainer: Vinicius Jose Latorre <[e-mail]>
;; Time-stamp: <2004/07/10 18:48:24 vinicius>
;; Keywords: wp, print, PostScript
;; Version: 6.8
;; X-URL: http://www.cpqd.com.br/~vinicius/emacs/

(defconst pr-version "6.8"
  "printing.el, v 6.8 <2004/07/10 vinicius>

Please send all bug fixes and enhancements to
	Vinicius Jose Latorre <[e-mail]>
")

;; rmail-summary-mode, gnus-summary-mode, etc).  It also includes a
;; PostScript/text printer database.
;;
;; Indeed, there are two user interfaces:
;;
;;    * one is via menubar:
;;      When `printing' is loaded, the menubar is modified to use `printing'
;;      menu instead of the print options in menubar.
;;      This is the default user interface.
;;
;;    * other is via buffer interface:
;;      It is an option of `printing' menu, but it can be binded into another
;;      key, so user can activate the buffer interface directly without using
;;      a menu.  See `pr-interface' command.
;;
;; `printing' was inspired on:

;; On GNU or Unix system, `printing' depends on gs and gv utilities.
;; On NT system, `printing' depends on gstools (gswin32.exe and gsview32.exe).
;; To obtain ghostscript, ghostview and GSview see the URL
;; `http://www.gnu.org/software/ghostscript/ghostscript.html'.
;;
;; `printing' also depends on ps-print and lpr GNU Emacs packages.
;; To download the latest ps-print package see
;; `http://www.cpqd.com.br/~vinicius/emacs/ps-print.tar.gz'.
;; Please, see README file for ps-print installation instructions.
;;
;;
;; Novices (First Users)
;; ---------------------
;;

;; 4. When running Emacs on Windows (with or without cygwin), check if your
;;    printer is a text printer or not by typing in a DOS window:
;;
;;       print /D:\\host\printer somefile.txt
;;
;;    Where, `host' is the machine where your printer is directly connected,
;;    `printer' is the printer name and `somefile.txt' is a text file.
;;
;;    If the printer `\\host\printer' doesn't print the content of
;;    `somefile.txt' or, instead, it returns the following message:
;;

;;
;;
;; Acknowledgments
;; ---------------
;;
;; Thanks to Drew Adams <[e-mail]> for directory processing and
;; `pr-path-alist' suggestions.
;;
;; Thanks to Fred Labrosse <[e-mail]> for XEmacs tests.
;;
;; Thanks to Klaus Berndl <[e-mail]> for invaluable help/debugging
;; and for suggestions:

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Internal Functions (I)


(defun pr-dosify-path (path)
  "Replace unix-style directory separator character with dos/windows one."
  (interactive "sPath: ")
  (if (eq pr-path-style 'windows)
      (subst-char-in-string ?/ ?\\ path)
    path))


(defun pr-unixify-path (path)
  "Replace dos/windows-style directory separator character with unix one."
  (interactive "sPath: ")
  (if (eq pr-path-style 'windows)
      (subst-char-in-string ?\\ ?/ path)
    path))


(defun pr-standard-path (path)
  "Ensure the proper directory separator depending on the OS.
That is, if Emacs is running on DOS/Windows, ensure dos/windows-style directory
separator; otherwise, ensure unix-style directory separator."
  (if (or pr-cygwin-system ps-windows-system)
      (subst-char-in-string ?/ ?\\ path)

  :set 'pr-alist-custom-set
  :group 'printing)


(defcustom pr-temp-dir
  (pr-dosify-path
   (if (boundp 'temporary-file-directory)
       (symbol-value 'temporary-file-directory)
     ;; hacked from `temporary-file-directory' variable in files.el
     (file-name-as-directory
      (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP")

(defun pr-ps-file-using-ghostscript (filename)
  "Print PostScript file FILENAME using ghostscript."
  (interactive (list (pr-ps-infile-preprint "Print preview ")))
  (and (stringp filename) (file-exists-p filename)
       (let* ((file (pr-expand-file-name filename))
	      (tempfile (pr-dosify-path (make-temp-name file))))
	 ;; gs use
	 (pr-call-process pr-gs-command
			  (format "-sDEVICE=%s" pr-gs-device)
			  (format "-r%d" pr-gs-resolution)
			  (pr-switches-string pr-gs-switches "pr-gs-switches")

    (or ps
	(error
	 "Invalid PostScript printer name `%s' for variable `pr-ps-name'."
	 value))
    (setq pr-ps-name           value
	  pr-ps-command        (pr-dosify-path (nth 0 ps))
	  pr-ps-switches       (nth 1 ps)
	  pr-ps-printer-switch (nth 2 ps)
	  pr-ps-printer        (nth 3 ps))
    (or (stringp pr-ps-command)
	(setq pr-ps-command

  (let ((txt (cdr (assq value pr-txt-printer-alist))))
    (or txt
	(error "Invalid text printer name `%s' for variable `pr-txt-name'."
	       value))
    (setq pr-txt-name     value
	  pr-txt-command  (pr-dosify-path (nth 0 txt))
	  pr-txt-switches (nth 1 txt)
	  pr-txt-printer  (nth 2 txt)))
  (or (stringp pr-txt-command)
      (setq pr-txt-command
	    (cond (ps-windows-system "print")

(defun pr-delete-file (file)
  (and pr-delete-temp-file (delete-file file)))


(defun pr-expand-file-name (filename)
  (pr-dosify-path (expand-file-name filename)))


(defun pr-ps-outfile-preprint (&optional mess)
  (let* ((prompt (format "%soutput PostScript file name: " (or mess "")))
	 (res    (read-file-name prompt default-directory "" nil)))

       (set infile-sym (and (not (interactive-p))
			    (pr-ps-infile-preprint prompt))))
  ;; input file
  (or (symbol-value infile-sym)
      (error "%s: input PostScript file name is missing" prompt))
  (set infile-sym (pr-dosify-path (symbol-value infile-sym)))
  ;; output file
  (and (eq (symbol-value outfile-sym) t)
       (set outfile-sym (and (not (interactive-p))
			     current-prefix-arg
			     (pr-ps-outfile-preprint prompt))))
  (and (symbol-value outfile-sym)
       (set outfile-sym (pr-dosify-path (symbol-value outfile-sym))))
  (pr-ps-file (symbol-value outfile-sym)))


(defun pr-ps-utility-process (n-up infile outfile)
  (let (item)

    (setq args (pr-remove-nil-from-list args))
    (save-excursion
      (set-buffer buffer)
      (goto-char (point-max))
      (insert (format "%s %S\n" cmd args)))
    (setq status (apply 'call-process cmd nil buffer nil args))
    (save-excursion
      (set-buffer buffer)
      (goto-char (point-max))
      (insert (format "Exit status: %s\n" status)))))


(defun pr-txt-print (from to)
  (let ((lpr-command  (pr-standard-path (pr-command pr-txt-command)))
	(lpr-switches (pr-switches pr-txt-switches "pr-txt-switches"))
	(printer-name pr-txt-printer))
    (lpr-region from to)))

      (pr-ps-file-print file)
      (pr-delete-file file))))


(defun pr-ps-file (&optional filename)
  (pr-dosify-path (or filename
		      (convert-standard-filename
		       (expand-file-name pr-ps-temp-file pr-temp-dir)))))


(defun pr-interactive-n-up (mess)
  (or (stringp mess) (setq mess "*"))
  (save-match-data

       (eq (symbol-value filename-sym) t)
       (set filename-sym (and (not (interactive-p))
			      current-prefix-arg
			      (ps-print-preprint current-prefix-arg))))
  (and (symbol-value filename-sym)
       (set filename-sym (pr-dosify-path (symbol-value filename-sym)))))


(defun pr-set-n-up-and-filename (n-up-sym filename-sym mess)
  ;; n-up
  (or (symbol-value n-up-sym)

If Emacs is running on Windows 95/98/NT/2000, tries to find COMMAND,
COMMAND.exe, COMMAND.bat and COMMAND.com in this order."
  (if (string= command "")
      command
    (pr-dosify-path
     (or (pr-find-command command)
	 (pr-path-command (cond (pr-cygwin-system  'cygwin)
				(ps-windows-system 'windows)
				(t                 'unix))
			  (file-name-nondirectory command)

56405:10b68aa88abe

;; Copyright (C) 2000, 2001, 2002, 2003, 2004
;; Free Software Foundation, Inc.

;; Author: Vinicius Jose Latorre <[e-mail]>
;; Maintainer: Vinicius Jose Latorre <[e-mail]>
;; Time-stamp: <2004/07/12 21:10:35 vinicius>
;; Keywords: wp, print, PostScript
;; Version: 6.8
;; X-URL: http://www.cpqd.com.br/~vinicius/emacs/

(defconst pr-version "6.8"
  "printing.el, v 6.8 <2004/07/12 vinicius>

Please send all bug fixes and enhancements to
	Vinicius Jose Latorre <[e-mail]>
")

;; rmail-summary-mode, gnus-summary-mode, etc).  It also includes a
;; PostScript/text printer database.
;;
;; Indeed, there are two user interfaces:
;;
;;    * Menu interface:
;;      When `printing' is loaded, the menubar is modified to use `printing'
;;      menu instead of the print options in menubar.
;;      This is the default user interface.
;;
;;    * Buffer interface:
;;      It is an option of `printing' menu, but it can be binded into another
;;      key, so user can activate the buffer interface directly without using
;;      a menu.  See `pr-interface' command.
;;
;; `printing' was inspired on:

;; On GNU or Unix system, `printing' depends on gs and gv utilities.
;; On NT system, `printing' depends on gstools (gswin32.exe and gsview32.exe).
;; To obtain ghostscript, ghostview and GSview see the URL
;; `http://www.gnu.org/software/ghostscript/ghostscript.html'.
;;
;; `printing' depends on ps-print package to generate PostScript files, to
;; spool and to despool PostScript buffer.  So, `printing' provides an
;; interface to ps-print package and it also provides some extra stuff.
;;
;; To download the latest ps-print package see
;; `http://www.cpqd.com.br/~vinicius/emacs/ps-print.tar.gz'.
;; Please, see README file for ps-print installation instructions.
;;
;;
;; Log Messages
;; ------------
;;
;; The buffer *Printing Command Output* is where the `printing' log messages
;; are inserted.  All program called by `printing' has a log entry in the
;; buffer *Printing Command Output*.  A log entry has the following form:
;;
;;    PROGRAM (ARG...)
;;    MESSAGE
;;    Exit status: CODE
;;
;; Where
;; PROGRAM is the program activated by `printing',
;; ARG is an argument passed to PROGRAM (it can have more than one argument),
;; MESSAGE is an error message returned by PROGRAM (it can have no message, if
;; PROGRAM is successful),
;; and CODE is a numeric exit status or a signal description string.
;;
;; For example, after previewing a PostScript file, *Printing Command Output*
;; will have the following entry:
;;
;;    /usr/X11R6/bin/gv ("/home/user/example/file.ps")
;;    Exit status: 0
;;
;; In the example above, the previewing was successful.  If during previewing,
;; you quit gv execution (by typing C-g during Emacs session), the log entry
;; would be:
;;
;;    /usr/X11R6/bin/gv ("/home/user/example/file.ps")
;;    Exit status: Quit
;;
;; So, if something goes wrong, a good place to take a look is the buffer
;; *Printing Command Output*.  Don't forget to see also the buffer *Messages*,
;; it can help.
;;
;;
;; Novices (First Users)
;; ---------------------
;;

;; 4. When running Emacs on Windows (with or without cygwin), check if your
;;    printer is a text printer or not by typing in a DOS window:
;;
;;       print /D:\\host\printer somefile.txt
;;
;;    Where, `host' is the machine where the printer is directly connected,
;;    `printer' is the printer name and `somefile.txt' is a text file.
;;
;;    If the printer `\\host\printer' doesn't print the content of
;;    `somefile.txt' or, instead, it returns the following message:
;;

;;
;;
;; Acknowledgments
;; ---------------
;;
;; Thanks to Drew Adams <[e-mail]> for suggestions:
;;    - directory processing.
;;    - `pr-path-alist' variable.
;;    - doc fix.
;;    - a lot of tests on Windows.
;;
;; Thanks to Fred Labrosse <[e-mail]> for XEmacs tests.
;;
;; Thanks to Klaus Berndl <[e-mail]> for invaluable help/debugging
;; and for suggestions:

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Internal Functions (I)


(defun pr-dosify-file-name (path)
  "Replace unix-style directory separator character with dos/windows one."
  (interactive "sPath: ")
  (if (eq pr-path-style 'windows)
      (subst-char-in-string ?/ ?\\ path)
    path))


(defun pr-unixify-file-name (path)
  "Replace dos/windows-style directory separator character with unix one."
  (interactive "sPath: ")
  (if (eq pr-path-style 'windows)
      (subst-char-in-string ?\\ ?/ path)
    path))


(defun pr-standard-file-name (path)
  "Ensure the proper directory separator depending on the OS.
That is, if Emacs is running on DOS/Windows, ensure dos/windows-style directory
separator; otherwise, ensure unix-style directory separator."
  (if (or pr-cygwin-system ps-windows-system)
      (subst-char-in-string ?/ ?\\ path)

  :set 'pr-alist-custom-set
  :group 'printing)


(defcustom pr-temp-dir
  (pr-dosify-file-name
   (if (boundp 'temporary-file-directory)
       (symbol-value 'temporary-file-directory)
     ;; hacked from `temporary-file-directory' variable in files.el
     (file-name-as-directory
      (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP")

(defun pr-ps-file-using-ghostscript (filename)
  "Print PostScript file FILENAME using ghostscript."
  (interactive (list (pr-ps-infile-preprint "Print preview ")))
  (and (stringp filename) (file-exists-p filename)
       (let* ((file (pr-expand-file-name filename))
	      (tempfile (pr-dosify-file-name (make-temp-name file))))
	 ;; gs use
	 (pr-call-process pr-gs-command
			  (format "-sDEVICE=%s" pr-gs-device)
			  (format "-r%d" pr-gs-resolution)
			  (pr-switches-string pr-gs-switches "pr-gs-switches")

    (or ps
	(error
	 "Invalid PostScript printer name `%s' for variable `pr-ps-name'."
	 value))
    (setq pr-ps-name           value
	  pr-ps-command        (pr-dosify-file-name (nth 0 ps))
	  pr-ps-switches       (nth 1 ps)
	  pr-ps-printer-switch (nth 2 ps)
	  pr-ps-printer        (nth 3 ps))
    (or (stringp pr-ps-command)
	(setq pr-ps-command

  (let ((txt (cdr (assq value pr-txt-printer-alist))))
    (or txt
	(error "Invalid text printer name `%s' for variable `pr-txt-name'."
	       value))
    (setq pr-txt-name     value
	  pr-txt-command  (pr-dosify-file-name (nth 0 txt))
	  pr-txt-switches (nth 1 txt)
	  pr-txt-printer  (nth 2 txt)))
  (or (stringp pr-txt-command)
      (setq pr-txt-command
	    (cond (ps-windows-system "print")

(defun pr-delete-file (file)
  (and pr-delete-temp-file (delete-file file)))


(defun pr-expand-file-name (filename)
  (pr-dosify-file-name (expand-file-name filename)))


(defun pr-ps-outfile-preprint (&optional mess)
  (let* ((prompt (format "%soutput PostScript file name: " (or mess "")))
	 (res    (read-file-name prompt default-directory "" nil)))

       (set infile-sym (and (not (interactive-p))
			    (pr-ps-infile-preprint prompt))))
  ;; input file
  (or (symbol-value infile-sym)
      (error "%s: input PostScript file name is missing" prompt))
  (set infile-sym (pr-dosify-file-name (symbol-value infile-sym)))
  ;; output file
  (and (eq (symbol-value outfile-sym) t)
       (set outfile-sym (and (not (interactive-p))
			     current-prefix-arg
			     (pr-ps-outfile-preprint prompt))))
  (and (symbol-value outfile-sym)
       (set outfile-sym (pr-dosify-file-name (symbol-value outfile-sym))))
  (pr-ps-file (symbol-value outfile-sym)))


(defun pr-ps-utility-process (n-up infile outfile)
  (let (item)

    (setq args (pr-remove-nil-from-list args))
    (save-excursion
      (set-buffer buffer)
      (goto-char (point-max))
      (insert (format "%s %S\n" cmd args)))
    (setq status
	  (condition-case data
	      (apply 'call-process cmd nil buffer nil args)
	    ((quit error)
	     (error-message-string data))))
    (save-excursion
      (set-buffer buffer)
      (goto-char (point-max))
      (insert (format "Exit status: %s\n" status)))))


(defun pr-txt-print (from to)
  (let ((lpr-command  (pr-standard-file-name (pr-command pr-txt-command)))
	(lpr-switches (pr-switches pr-txt-switches "pr-txt-switches"))
	(printer-name pr-txt-printer))
    (lpr-region from to)))

      (pr-ps-file-print file)
      (pr-delete-file file))))


(defun pr-ps-file (&optional filename)
  (pr-dosify-file-name (or filename
			   (convert-standard-filename
			    (expand-file-name pr-ps-temp-file pr-temp-dir)))))


(defun pr-interactive-n-up (mess)
  (or (stringp mess) (setq mess "*"))
  (save-match-data

       (eq (symbol-value filename-sym) t)
       (set filename-sym (and (not (interactive-p))
			      current-prefix-arg
			      (ps-print-preprint current-prefix-arg))))
  (and (symbol-value filename-sym)
       (set filename-sym (pr-dosify-file-name (symbol-value filename-sym)))))


(defun pr-set-n-up-and-filename (n-up-sym filename-sym mess)
  ;; n-up
  (or (symbol-value n-up-sym)

If Emacs is running on Windows 95/98/NT/2000, tries to find COMMAND,
COMMAND.exe, COMMAND.bat and COMMAND.com in this order."
  (if (string= command "")
      command
    (pr-dosify-file-name
     (or (pr-find-command command)
	 (pr-path-command (cond (pr-cygwin-system  'cygwin)
				(ps-windows-system 'windows)
				(t                 'unix))
			  (file-name-nondirectory command)