Find file
Fetching contributors…
Cannot retrieve contributors at this time
1352 lines (1205 sloc) 51.9 KB
;;; doc-view.el --- View PDF/PostScript/DVI files in Emacs
;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: Tassilo Horn <>
;; Maintainer: Tassilo Horn <>
;; Keywords: files, pdf, ps, dvi
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <>.
;;; Requirements:
;; doc-view.el requires GNU Emacs 22.1 or newer. You also need Ghostscript,
;; `dvipdf' (comes with Ghostscript) or `dvipdfm' (comes with teTeX or TeXLive)
;; and `pdftotext', which comes with xpdf ( or
;; poppler (
;;; Commentary:
;; DocView is a document viewer for Emacs. It converts PDF, PS and DVI files
;; to a set of PNG files, one PNG for each page, and displays the PNG images
;; inside an Emacs buffer. This buffer uses `doc-view-mode' which provides
;; convenient key bindings for browsing the document.
;; To use it simply open a document file with
;; C-x C-f ~/path/to/document RET
;; and the document will be converted and displayed, if your emacs supports png
;; images. With `C-c C-c' you can toggle between the rendered images
;; representation and the source text representation of the document.
;; Since conversion may take some time all the PNG images are cached in a
;; subdirectory of `doc-view-cache-directory' and reused when you want to view
;; that file again. To reconvert a document hit `g' (`doc-view-reconvert-doc')
;; when displaying the document. To delete all cached files use
;; `doc-view-clear-cache'. To open the cache with dired, so that you can tidy
;; it out use `doc-view-dired-cache'.
;; When conversion in underway the first page will be displayed as soon as it
;; is available and the available pages are refreshed every
;; `doc-view-conversion-refresh-interval' seconds. If that variable is nil the
;; pages won't be displayed before conversion of the document finished
;; completely.
;; DocView lets you select a slice of the displayed pages. This slice will be
;; remembered and applied to all pages of the current document. This enables
;; you to cut away the margins of a document to save some space. To select a
;; slice you can use `doc-view-set-slice' (bound to `s s') which will query you
;; for the coordinates of the slice's top-left corner and its width and height.
;; A much more convenient way to do the same is offered by the command
;; `doc-view-set-slice-using-mouse' (bound to `s m'). After invocation you
;; only have to press mouse-1 at the top-left corner and drag it to the
;; bottom-right corner of the desired slice. To reset the slice use
;; `doc-view-reset-slice' (bound to `s r').
;; You can also search within the document. The command `doc-view-search'
;; (bound to `C-s') queries for a search regexp and initializes a list of all
;; matching pages and messages how many match-pages were found. After that you
;; can jump to the next page containing a match with an additional `C-s'. With
;; `C-r' you can do the same, but backwards. To search for a new regexp give a
;; prefix arg to one of the search functions, e.g. by typing `C-u C-s'. The
;; searching works by using a plain text representation of the document. If
;; that doesn't already exist the first invocation of `doc-view-search' (or
;; `doc-view-search-backward') starts the conversion. When that finishes and
;; you're still viewing the document (i.e. you didn't switch to another buffer)
;; you're queried for the regexp then.
;; Dired users can simply hit `v' on a document file. If it's a PS, PDF or DVI
;; it will be opened using `doc-view-mode'.
;;; Configuration:
;; If the images are too small or too big you should set the "-rXXX" option in
;; `doc-view-ghostscript-options' to another value. (The bigger your screen,
;; the higher the value.)
;; This and all other options can be set with the customization interface.
;; Simply do
;; M-x customize-group RET doc-view RET
;; and modify them to your needs.
;;; Todo:
;; - add print command.
;; - share more code with image-mode.
;; - better menu.
;; - Bind slicing to a drag event.
;; - doc-view-fit-doc-to-window and doc-view-fit-window-to-doc?
;; - zoom the region around the cursor (like xdvi).
;; - get rid of the silly arrow in the fringe.
;; - improve anti-aliasing (pdf-utils gets it better).
;;;; About isearch support
;; I tried implementing isearch by setting
;; `isearch-search-fun-function' buffer-locally, but that didn't
;; work too good. The function doing the real search was called
;; endlessly somehow. But even if we'd get that working no real
;; isearch feeling comes up due to the missing match highlighting.
;; Currently I display all lines containing a match in a tooltip and
;; each C-s or C-r jumps directly to the next/previous page with a
;; match. With isearch we could only display the current match. So
;; we had to decide if another C-s jumps to the next page with a
;; match (thus only the first match in a page will be displayed in a
;; tooltip) or to the next match, which would do nothing visible
;; (except the tooltip) if the next match is on the same page.
;; And it's much slower than the current search facility, because
;; isearch really searches for each step forward or backward wheras
;; the current approach searches once and then it knows to which
;; pages to jump.
;; Anyway, if someone with better isearch knowledge wants to give it a try,
;; feel free to do it. --Tassilo
;;; Code:
(eval-when-compile (require 'cl))
(require 'dired)
(require 'image-mode)
(require 'jka-compr)
;;;; Customization Options
(defgroup doc-view nil
"In-buffer viewer for PDF, PostScript and DVI files."
:link '(function-link doc-view)
:version "22.2"
:group 'applications
:group 'multimedia
:prefix "doc-view-")
(defcustom doc-view-ghostscript-program (executable-find "gs")
"Program to convert PS and PDF files to PNG."
:type 'file
:group 'doc-view)
(defcustom doc-view-ghostscript-options
'("-dSAFER" ;; Avoid security problems when rendering files from untrusted
;; sources.
"-dNOPAUSE" "-sDEVICE=png16m" "-dTextAlphaBits=4"
"-dBATCH" "-dGraphicsAlphaBits=4" "-dQUIET")
"A list of options to give to ghostscript."
:type '(repeat string)
:group 'doc-view)
(defcustom doc-view-resolution 100
"Dots per inch resolution used to render the documents.
Higher values result in larger images."
:type 'number
:group 'doc-view)
(defcustom doc-view-dvipdfm-program (executable-find "dvipdfm")
"Program to convert DVI files to PDF.
DVI file will be converted to PDF before the resulting PDF is
converted to PNG.
If this and `doc-view-dvipdf-program' are set,
`doc-view-dvipdf-program' will be preferred."
:type 'file
:group 'doc-view)
(defcustom doc-view-dvipdf-program (executable-find "dvipdf")
"Program to convert DVI files to PDF.
DVI file will be converted to PDF before the resulting PDF is
converted to PNG.
If this and `doc-view-dvipdfm-program' are set,
`doc-view-dvipdf-program' will be preferred."
:type 'file
:group 'doc-view)
(defcustom doc-view-ps2pdf-program (executable-find "ps2pdf")
"Program to convert PS files to PDF.
PS files will be converted to PDF before searching is possible."
:type 'file
:group 'doc-view)
(defcustom doc-view-pdftotext-program (executable-find "pdftotext")
"Program to convert PDF files to plain text.
Needed for searching."
:type 'file
:group 'doc-view)
(defcustom doc-view-cache-directory
(expand-file-name (format "docview%d" (user-uid))
"The base directory, where the PNG images will be saved."
:type 'directory
:group 'doc-view)
(defvar doc-view-conversion-buffer " *doc-view conversion output*"
"The buffer where messages from the converter programs go to.")
(defcustom doc-view-conversion-refresh-interval 1
"Interval in seconds between refreshes of the DocView buffer while converting.
After such a refresh newly converted pages will be available for
viewing. If set to nil there won't be any refreshes and the
pages won't be displayed before conversion of the whole document
has finished."
:type 'integer
:group 'doc-view)
(defcustom doc-view-continuous nil
"In Continuous mode reaching the page edge advances to next/previous page.
When non-nil, scrolling a line upward at the bottom edge of the page
moves to the next page, and scrolling a line downward at the top edge
of the page moves to the previous page."
:type 'boolean
:group 'doc-view
:version "23.2")
;;;; Internal Variables
(defun doc-view-new-window-function (winprops)
(let ((ol (image-mode-window-get 'overlay winprops)))
(if ol
(setq ol (copy-overlay ol))
(assert (not (get-char-property (point-min) 'display)))
(setq ol (make-overlay (point-min) (point-max) nil t))
(overlay-put ol 'doc-view t))
(overlay-put ol 'window (car winprops))
(image-mode-window-put 'overlay ol winprops)))
(defvar doc-view-current-files nil
"Only used internally.")
(make-variable-buffer-local 'doc-view-current-files)
(defvar doc-view-current-converter-processes nil
"Only used internally.")
(make-variable-buffer-local 'doc-view-current-converter-processes)
(defvar doc-view-current-timer nil
"Only used internally.")
(make-variable-buffer-local 'doc-view-current-timer)
(defvar doc-view-current-cache-dir nil
"Only used internally.")
(make-variable-buffer-local 'doc-view-current-cache-dir)
(defvar doc-view-current-search-matches nil
"Only used internally.")
(make-variable-buffer-local 'doc-view-current-search-matches)
(defvar doc-view-pending-cache-flush nil
"Only used internally.")
(defvar doc-view-previous-major-mode nil
"Only used internally.")
(defvar doc-view-buffer-file-name nil
"Only used internally.
The file name used for conversion. Normally it's the same as
`buffer-file-name', but for remote files, compressed files and
files inside an archive it is a temporary copy of
the (uncompressed, extracted) file residing in
(defvar doc-view-doc-type nil
"The type of document in the current buffer.
Can be `dvi', `pdf', or `ps'.")
;;;; DocView Keymaps
(defvar doc-view-mode-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map image-mode-map)
;; Navigation in the document
(define-key map (kbd "n") 'doc-view-next-page)
(define-key map (kbd "p") 'doc-view-previous-page)
(define-key map (kbd "<next>") 'forward-page)
(define-key map (kbd "<prior>") 'backward-page)
(define-key map [remap forward-page] 'doc-view-next-page)
(define-key map [remap backward-page] 'doc-view-previous-page)
(define-key map (kbd "SPC") 'doc-view-scroll-up-or-next-page)
(define-key map (kbd "DEL") 'doc-view-scroll-down-or-previous-page)
(define-key map (kbd "C-n") 'doc-view-next-line-or-next-page)
(define-key map (kbd "<down>") 'doc-view-next-line-or-next-page)
(define-key map (kbd "C-p") 'doc-view-previous-line-or-previous-page)
(define-key map (kbd "<up>") 'doc-view-previous-line-or-previous-page)
(define-key map (kbd "M-<") 'doc-view-first-page)
(define-key map (kbd "M->") 'doc-view-last-page)
(define-key map [remap goto-line] 'doc-view-goto-page)
(define-key map (kbd "RET") 'image-next-line)
;; Zoom in/out.
(define-key map "+" 'doc-view-enlarge)
(define-key map "-" 'doc-view-shrink)
;; Killing the buffer (and the process)
(define-key map (kbd "k") 'doc-view-kill-proc-and-buffer)
(define-key map (kbd "K") 'doc-view-kill-proc)
;; Slicing the image
(define-key map (kbd "s s") 'doc-view-set-slice)
(define-key map (kbd "s m") 'doc-view-set-slice-using-mouse)
(define-key map (kbd "s r") 'doc-view-reset-slice)
;; Searching
(define-key map (kbd "C-s") 'doc-view-search)
(define-key map (kbd "<find>") 'doc-view-search)
(define-key map (kbd "C-r") 'doc-view-search-backward)
;; Show the tooltip
(define-key map (kbd "C-t") 'doc-view-show-tooltip)
;; Toggle between text and image display or editing
(define-key map (kbd "C-c C-c") 'doc-view-toggle-display)
;; Open a new buffer with doc's text contents
(define-key map (kbd "C-c C-t") 'doc-view-open-text)
;; Reconvert the current document
(define-key map (kbd "g") 'revert-buffer)
(define-key map (kbd "r") 'revert-buffer)
"Keymap used by `doc-view-mode' when displaying a doc as a set of images.")
(easy-menu-define doc-view-menu doc-view-mode-map
"Menu for Doc View mode."
["Toggle display" doc-view-toggle-display]
["Off" (setq doc-view-continuous nil)
:style radio :selected (eq doc-view-continuous nil)]
["On" (setq doc-view-continuous t)
:style radio :selected (eq doc-view-continuous t)]
["Save as Default"
(customize-save-variable 'doc-view-continuous doc-view-continuous) t]
["Set Slice" doc-view-set-slice-using-mouse]
["Set Slice (manual)" doc-view-set-slice]
["Reset Slice" doc-view-reset-slice]
["Search" doc-view-search]
["Search Backwards" doc-view-search-backward]
(defvar doc-view-minor-mode-map
(let ((map (make-sparse-keymap)))
;; Toggle between text and image display or editing
(define-key map (kbd "C-c C-c") 'doc-view-toggle-display)
"Keymap used by `doc-minor-view-mode'.")
;;;; Navigation Commands
(defmacro doc-view-current-page (&optional win)
`(image-mode-window-get 'page ,win))
(defmacro doc-view-current-info () `(image-mode-window-get 'info))
(defmacro doc-view-current-overlay () `(image-mode-window-get 'overlay))
(defmacro doc-view-current-image () `(image-mode-window-get 'image))
(defmacro doc-view-current-slice () `(image-mode-window-get 'slice))
(defun doc-view-goto-page (page)
"View the page given by PAGE."
(interactive "nPage: ")
(let ((len (length doc-view-current-files))
(hscroll (window-hscroll)))
(if (< page 1)
(setq page 1)
(when (and (> page len)
;; As long as the converter is running, we don't know
;; how many pages will be available.
(null doc-view-current-converter-processes))
(setq page len)))
(setf (doc-view-current-page) page
(format "Page %d of %d." page len) 'face 'bold)
;; Tell user if converting isn't finished yet
(if doc-view-current-converter-processes
" (still converting...)\n"
;; Display context infos if this page matches the last search
(when (and doc-view-current-search-matches
(assq page doc-view-current-search-matches))
(concat (propertize "Search matches:\n" 'face 'bold)
(let ((contexts ""))
(dolist (m (cdr (assq page
(setq contexts (concat contexts " - \"" m "\"\n")))
;; Update the buffer
;; We used to find the file name from doc-view-current-files but
;; that's not right if the pages are not generated sequentially
;; or if the page isn't in doc-view-current-files yet.
(let ((file (expand-file-name (format "page-%d.png" page)
(doc-view-insert-image file :pointer 'arrow)
(set-window-hscroll (selected-window) hscroll)
(when (and (not (file-exists-p file))
;; The PNG file hasn't been generated yet.
(doc-view-pdf->png-1 doc-view-buffer-file-name file page
(lexical-let ((page page)
(win (selected-window)))
(lambda ()
(and (eq (current-buffer) (window-buffer win))
;; If we changed page in the mean
;; time, don't mess things up.
(eq (doc-view-current-page win) page)
(with-selected-window win
(doc-view-goto-page page))))))))
(overlay-put (doc-view-current-overlay)
'help-echo (doc-view-current-info))))
(defun doc-view-next-page (&optional arg)
"Browse ARG pages forward."
(interactive "p")
(doc-view-goto-page (+ (doc-view-current-page) (or arg 1))))
(defun doc-view-previous-page (&optional arg)
"Browse ARG pages backward."
(interactive "p")
(doc-view-goto-page (- (doc-view-current-page) (or arg 1))))
(defun doc-view-first-page ()
"View the first page."
(doc-view-goto-page 1))
(defun doc-view-last-page ()
"View the last page."
(doc-view-goto-page (length doc-view-current-files)))
(defun doc-view-scroll-up-or-next-page (&optional arg)
"Scroll page up ARG lines if possible, else goto next page.
When `doc-view-continuous' is non-nil, scrolling upward
at the bottom edge of the page moves to the next page.
Otherwise, goto next page only on typing SPC (ARG is nil)."
(interactive "P")
(if (or doc-view-continuous (null arg))
(let ((hscroll (window-hscroll))
(cur-page (doc-view-current-page)))
(when (= (window-vscroll) (image-scroll-up arg))
(when (/= cur-page (doc-view-current-page))
(image-bol 1))
(set-window-hscroll (selected-window) hscroll)))
(image-scroll-up arg)))
(defun doc-view-scroll-down-or-previous-page (&optional arg)
"Scroll page down ARG lines if possible, else goto previous page.
When `doc-view-continuous' is non-nil, scrolling downward
at the top edge of the page moves to the previous page.
Otherwise, goto previous page only on typing DEL (ARG is nil)."
(interactive "P")
(if (or doc-view-continuous (null arg))
(let ((hscroll (window-hscroll))
(cur-page (doc-view-current-page)))
(when (= (window-vscroll) (image-scroll-down arg))
(when (/= cur-page (doc-view-current-page))
(image-bol 1))
(set-window-hscroll (selected-window) hscroll)))
(image-scroll-down arg)))
(defun doc-view-next-line-or-next-page (&optional arg)
"Scroll upward by ARG lines if possible, else goto next page.
When `doc-view-continuous' is non-nil, scrolling a line upward
at the bottom edge of the page moves to the next page."
(interactive "p")
(if doc-view-continuous
(let ((hscroll (window-hscroll))
(cur-page (doc-view-current-page)))
(when (= (window-vscroll) (image-next-line arg))
(when (/= cur-page (doc-view-current-page))
(image-bol 1))
(set-window-hscroll (selected-window) hscroll)))
(image-next-line 1)))
(defun doc-view-previous-line-or-previous-page (&optional arg)
"Scroll downward by ARG lines if possible, else goto previous page.
When `doc-view-continuous' is non-nil, scrolling a line downward
at the top edge of the page moves to the previous page."
(interactive "p")
(if doc-view-continuous
(let ((hscroll (window-hscroll))
(cur-page (doc-view-current-page)))
(when (= (window-vscroll) (image-previous-line arg))
(when (/= cur-page (doc-view-current-page))
(image-bol 1))
(set-window-hscroll (selected-window) hscroll)))
(image-previous-line arg)))
;;;; Utility Functions
(defun doc-view-kill-proc ()
"Kill the current converter process(es)."
(while doc-view-current-converter-processes
(ignore-errors ;; Maybe it's dead already?
(kill-process (pop doc-view-current-converter-processes))))
(when doc-view-current-timer
(cancel-timer doc-view-current-timer)
(setq doc-view-current-timer nil))
(setq mode-line-process nil))
(defun doc-view-kill-proc-and-buffer ()
"Kill the current converter process and buffer."
(when (eq major-mode 'doc-view-mode)
(kill-buffer (current-buffer))))
(defun doc-view-make-safe-dir (dir)
(condition-case nil
(let ((umask (default-file-modes)))
;; Create temp files with strict access rights. It's easy to
;; loosen them later, whereas it's impossible to close the
;; time-window of loose permissions otherwise.
(set-default-file-modes #o0700)
(make-directory dir))
;; Reset the umask.
(set-default-file-modes umask)))
(if (file-symlink-p dir)
(error "Danger: %s points to a symbolic link" dir))
;; In case it was created earlier with looser rights.
;; We could check the mode info returned by file-attributes, but it's
;; a pain to parse and it may not tell you what we want under
;; non-standard file-systems. So let's just say what we want and let
;; the underlying C code and file-system figure it out.
;; This also ends up checking a bunch of useful conditions: it makes
;; sure we have write-access to the directory and that we own it, thus
;; closing a bunch of security holes.
(set-file-modes dir #o0700))))
(defun doc-view-current-cache-dir ()
"Return the directory where the png files of the current doc should be saved.
It's a subdirectory of `doc-view-cache-directory'."
(if doc-view-current-cache-dir
;; Try and make sure doc-view-cache-directory exists and is safe.
(doc-view-make-safe-dir doc-view-cache-directory)
;; Now compute the subdirectory to use.
(setq doc-view-current-cache-dir
(concat (file-name-nondirectory doc-view-buffer-file-name)
(let ((file doc-view-buffer-file-name))
(set-buffer-multibyte nil)
(insert-file-contents-literally file)
(md5 (current-buffer)))))
(defun doc-view-remove-if (predicate list)
"Return LIST with all items removed that satisfy PREDICATE."
(let (new-list)
(dolist (item list (nreverse new-list))
(when (not (funcall predicate item))
(setq new-list (cons item new-list))))))
(defun doc-view-mode-p (type)
"Return non-nil if image type TYPE is available for `doc-view'.
Image types are symbols like `dvi', `postscript' or `pdf'."
(and (display-graphic-p)
(image-type-available-p 'png)
((eq type 'dvi)
(and (doc-view-mode-p 'pdf)
(or (and doc-view-dvipdf-program
(executable-find doc-view-dvipdf-program))
(and doc-view-dvipdfm-program
(executable-find doc-view-dvipdfm-program)))))
((or (eq type 'postscript) (eq type 'ps) (eq type 'eps)
(eq type 'pdf))
(and doc-view-ghostscript-program
(executable-find doc-view-ghostscript-program)))
(t ;; unknown image type
;;;; Conversion Functions
(defvar doc-view-shrink-factor 1.125)
(defun doc-view-enlarge (factor)
"Enlarge the document."
(interactive (list doc-view-shrink-factor))
(set (make-local-variable 'doc-view-resolution)
(* factor doc-view-resolution))
(defun doc-view-shrink (factor)
"Shrink the document."
(interactive (list doc-view-shrink-factor))
(doc-view-enlarge (/ 1.0 factor)))
(defun doc-view-reconvert-doc ()
"Reconvert the current document.
Should be invoked when the cached images aren't up-to-date."
;; Clear the old cached files
(when (file-exists-p (doc-view-current-cache-dir))
(dired-delete-file (doc-view-current-cache-dir) 'always))
(defun doc-view-sentinel (proc event)
"Generic sentinel for doc-view conversion processes."
(if (not (string-match "finished" event))
(message "DocView: process %s changed status to %s."
(process-name proc)
(if (string-match "\\(.+\\)\n?\\'" event)
(match-string 1 event)
(when (buffer-live-p (process-get proc 'buffer))
(with-current-buffer (process-get proc 'buffer)
(setq doc-view-current-converter-processes
(delq proc doc-view-current-converter-processes))
(setq mode-line-process
(if doc-view-current-converter-processes
(format ":%s" (car doc-view-current-converter-processes))))
(funcall (process-get proc 'callback))))))
(defun doc-view-start-process (name program args callback)
;; Make sure the process is started in an existing directory, (rather than
;; some file-name-handler-managed dir, for example).
(let* ((default-directory (if (file-readable-p default-directory)
(expand-file-name "~/")))
(proc (apply 'start-process name doc-view-conversion-buffer
program args)))
(push proc doc-view-current-converter-processes)
(setq mode-line-process (list (format ":%s" proc)))
(set-process-sentinel proc 'doc-view-sentinel)
(process-put proc 'buffer (current-buffer))
(process-put proc 'callback callback)))
(defun doc-view-dvi->pdf (dvi pdf callback)
"Convert DVI to PDF asynchronously and call CALLBACK when finished."
;; Prefer dvipdf over dvipdfm, because the latter has problems if the DVI
;; references and includes other PS files.
(if (and doc-view-dvipdf-program
(executable-find doc-view-dvipdf-program))
(doc-view-start-process "dvi->pdf" doc-view-dvipdf-program
(list dvi pdf)
(doc-view-start-process "dvi->pdf" doc-view-dvipdfm-program
(list "-o" pdf dvi)
(defun doc-view-pdf/ps->png (pdf-ps png)
"Convert PDF-PS to PNG asynchronously."
"pdf/ps->png" doc-view-ghostscript-program
(append doc-view-ghostscript-options
(list (format "-r%d" (round doc-view-resolution))
(concat "-sOutputFile=" png)
(lambda ()
(when doc-view-current-timer
(cancel-timer doc-view-current-timer)
(setq doc-view-current-timer nil))
(doc-view-display (current-buffer) 'force)))
;; Update the displayed pages as soon as they're done generating.
(when doc-view-conversion-refresh-interval
(setq doc-view-current-timer
(run-at-time "1 secs" doc-view-conversion-refresh-interval
(defun doc-view-pdf->png-1 (pdf png page callback)
"Convert a PAGE of a PDF file to PNG asynchronously.
Call CALLBACK with no arguments when done."
"pdf->png-1" doc-view-ghostscript-program
(append doc-view-ghostscript-options
(list (format "-r%d" (round doc-view-resolution))
;; Sadly, `gs' only supports the page-range
;; for PDF files.
(format "-dFirstPage=%d" page)
(format "-dLastPage=%d" page)
(concat "-sOutputFile=" png)
(declare-function clear-image-cache "image.c" (&optional filter))
(defun doc-view-pdf->png (pdf png pages)
"Convert a PDF file to PNG asynchronously.
Start by converting PAGES, and then the rest."
(if (null pages)
(doc-view-pdf/ps->png pdf png)
;; We could render several `pages' with a single process if they're
;; (almost) consecutive, but since in 99% of the cases, there'll be only
;; a single page anyway, and of the remaining 1%, few cases will have
;; consecutive pages, it's not worth the trouble.
(lexical-let ((pdf pdf) (png png) (rest (cdr pages)))
pdf (format png (car pages)) (car pages)
(lambda ()
(if rest
(doc-view-pdf->png pdf png rest)
;; Yippie, the important pages are done, update the display.
;; Convert the rest of the pages.
(doc-view-pdf/ps->png pdf png)))))))
(defun doc-view-pdf->txt (pdf txt callback)
"Convert PDF to TXT asynchronously and call CALLBACK when finished."
(or doc-view-pdftotext-program
(error "You need the `pdftotext' program to convert a PDF to text"))
(doc-view-start-process "pdf->txt" doc-view-pdftotext-program
(list "-raw" pdf txt)
(defun doc-view-doc->txt (txt callback)
"Convert the current document to text and call CALLBACK when done."
(make-directory (doc-view-current-cache-dir) t)
(case doc-view-doc-type
;; Doc is a PDF, so convert it to TXT
(doc-view-pdf->txt doc-view-buffer-file-name txt callback))
;; Doc is a PS, so convert it to PDF (which will be converted to
;; TXT thereafter).
(lexical-let ((pdf (expand-file-name "doc.pdf"
(txt txt)
(callback callback))
(doc-view-ps->pdf doc-view-buffer-file-name pdf
(lambda () (doc-view-pdf->txt pdf txt callback)))))
;; Doc is a DVI. This means that a doc.pdf already exists in its
;; cache subdirectory.
(doc-view-pdf->txt (expand-file-name "doc.pdf"
txt callback))
(t (error "DocView doesn't know what to do"))))
(defun doc-view-ps->pdf (ps pdf callback)
"Convert PS to PDF asynchronously and call CALLBACK when finished."
(or doc-view-ps2pdf-program
(error "You need the `ps2pdf' program to convert PS to PDF"))
(doc-view-start-process "ps->pdf" doc-view-ps2pdf-program
;; Avoid security problems when rendering files from
;; untrusted sources.
;; in-file and out-file
ps pdf)
(defun doc-view-active-pages ()
(let ((pages ()))
(dolist (win (get-buffer-window-list (current-buffer) nil 'visible))
(let ((page (image-mode-window-get 'page win)))
(unless (memq page pages) (push page pages))))
(defun doc-view-convert-current-doc ()
"Convert `doc-view-buffer-file-name' to a set of png files, one file per page.
Those files are saved in the directory given by the function
;; Let stale files still display while we recompute the new ones, so only
;; flush the cache when the conversion is over. One of the reasons why it
;; is important to keep displaying the stale page is so that revert-buffer
;; preserves the horizontal/vertical scroll settings (which are otherwise
;; resets during the redisplay).
(setq doc-view-pending-cache-flush t)
(let ((png-file (expand-file-name "page-%d.png"
(res-file (expand-file-name "resolution.el"
(make-directory (doc-view-current-cache-dir) t)
;; Save the used resolution so that it can be restored when
;; reading the cached files.
(let ((res doc-view-resolution))
(princ res (current-buffer))
;; Don't use write-file, so as to avoid prompts for `require-newline',
;; or for pre-existing buffers with the same name, ...
(write-region nil nil res-file nil 'silently)))
(case doc-view-doc-type
;; DVI files have to be converted to PDF before Ghostscript can process
;; it.
((pdf (expand-file-name "doc.pdf" doc-view-current-cache-dir))
(png-file png-file))
(doc-view-dvi->pdf doc-view-buffer-file-name pdf
(lambda () (doc-view-pdf/ps->png pdf png-file)))))
(let ((pages (doc-view-active-pages)))
;; Convert PDF to PNG images starting with the active pages.
(doc-view-pdf->png doc-view-buffer-file-name png-file pages)))
;; Convert to PNG images.
(doc-view-pdf/ps->png doc-view-buffer-file-name png-file)))))
;;;; Slicing
(declare-function image-size "image.c" (spec &optional pixels frame))
(defun doc-view-set-slice (x y width height)
"Set the slice of the images that should be displayed.
You can use this function to tell doc-view not to display the
margins of the document. It prompts for the top-left corner (X
and Y) of the slice to display and its WIDTH and HEIGHT.
See `doc-view-set-slice-using-mouse' for a more convenient way to
do that. To reset the slice use `doc-view-reset-slice'."
(let* ((size (image-size (doc-view-current-image) t))
(a (read-number (format "Top-left X (0..%d): " (car size))))
(b (read-number (format "Top-left Y (0..%d): " (cdr size))))
(c (read-number (format "Width (0..%d): " (- (car size) a))))
(d (read-number (format "Height (0..%d): " (- (cdr size) b)))))
(list a b c d)))
(setf (doc-view-current-slice) (list x y width height))
;; Redisplay
(doc-view-goto-page (doc-view-current-page)))
(defun doc-view-set-slice-using-mouse ()
"Set the slice of the images that should be displayed.
You set the slice by pressing mouse-1 at its top-left corner and
dragging it to its bottom-right corner. See also
`doc-view-set-slice' and `doc-view-reset-slice'."
(let (x y w h done)
(while (not done)
(let ((e (read-event
(concat "Press mouse-1 at the top-left corner and "
"drag it to the bottom-right corner!"))))
(when (eq (car e) 'drag-mouse-1)
(setq x (car (posn-object-x-y (event-start e))))
(setq y (cdr (posn-object-x-y (event-start e))))
(setq w (- (car (posn-object-x-y (event-end e))) x))
(setq h (- (cdr (posn-object-x-y (event-end e))) y))
(setq done t))))
(doc-view-set-slice x y w h)))
(defun doc-view-reset-slice ()
"Reset the current slice.
After calling this function whole pages will be visible again."
(setf (doc-view-current-slice) nil)
;; Redisplay
(doc-view-goto-page (doc-view-current-page)))
;;;; Display
(defun doc-view-insert-image (file &rest args)
"Insert the given png FILE.
ARGS is a list of image descriptors."
(when doc-view-pending-cache-flush
(setq doc-view-pending-cache-flush nil))
(let ((ol (doc-view-current-overlay))
(image (if (and file (file-readable-p file))
(apply 'create-image file 'png nil args)))
(slice (doc-view-current-slice)))
(setf (doc-view-current-image) image)
(move-overlay ol (point-min) (point-max))
(overlay-put ol 'display
(if slice
(list (cons 'slice slice) image)
;; We're trying to display a page that doesn't exist.
;; Maybe the page doesn't exist *yet*.
"Cannot display this page (yet)!")
;; Typically happens if the conversion process somehow
;; failed. Better not signal an error here because it
;; could prevent a subsequent reconversion from fixing
;; the problem.
(concat "Cannot display this page!\n"
"Maybe because of a conversion failure!"))))
(let ((win (overlay-get ol 'window)))
(if (stringp (overlay-get ol 'display))
(progn ;Make sure the text is not scrolled out of view.
(set-window-hscroll win 0)
(set-window-vscroll win 0))
(let ((hscroll (image-mode-window-get 'hscroll win))
(vscroll (image-mode-window-get 'vscroll win)))
;; Reset scroll settings, in case they were changed.
(if hscroll (set-window-hscroll win hscroll))
(if vscroll (set-window-vscroll win vscroll)))))))
(defun doc-view-sort (a b)
"Return non-nil if A should be sorted before B.
Predicate for sorting `doc-view-current-files'."
(or (< (length a) (length b))
(and (= (length a) (length b))
(string< a b))))
(defun doc-view-display (buffer &optional force)
"Start viewing the document in BUFFER.
If FORCE is non-nil, start viewing even if the document does not
have the page we want to view."
(with-current-buffer buffer
(let ((prev-pages doc-view-current-files))
(setq doc-view-current-files
(sort (directory-files (doc-view-current-cache-dir) t
"page-[0-9]+\\.png" t)
(dolist (win (or (get-buffer-window-list buffer nil t)
(list (selected-window))))
(let* ((page (doc-view-current-page win))
(pagefile (expand-file-name (format "page-%d.png" page)
(when (or force
(and (not (member pagefile prev-pages))
(member pagefile doc-view-current-files)))
(with-selected-window win
(assert (eq (current-buffer) buffer))
(doc-view-goto-page page))))))))
(defun doc-view-buffer-message ()
;; Only show this message initially, not when refreshing the buffer (in which
;; case it's better to keep displaying the "stale" page while computing
;; the fresh new ones).
(unless (overlay-get (doc-view-current-overlay) 'display)
(overlay-put (doc-view-current-overlay) 'display
(concat (propertize "Welcome to DocView!" 'face 'bold)
If you see this buffer it means that the document you want to view is being
converted to PNG and the conversion of the first page hasn't finished yet or
`doc-view-conversion-refresh-interval' is set to nil.
For now these keys are useful:
`q' : Bury this buffer. Conversion will go on in background.
`k' : Kill the conversion process and this buffer.
`K' : Kill the conversion process.\n"))))
(declare-function tooltip-show "tooltip" (text &optional use-echo-area))
(defun doc-view-show-tooltip ()
(tooltip-show (doc-view-current-info)))
(defun doc-view-open-text ()
"Open a buffer with the current doc's contents as text."
(if doc-view-current-converter-processes
(message "DocView: please wait till conversion finished.")
(let ((txt (expand-file-name "doc.txt" (doc-view-current-cache-dir))))
(if (file-readable-p txt)
(find-file txt)
(doc-view-doc->txt txt 'doc-view-open-text)))))
;;;;; Toggle between editing and viewing
(defun doc-view-toggle-display ()
"Toggle between editing a document as text or viewing it."
(if (eq major-mode 'doc-view-mode)
;; Switch to editing mode
(setq buffer-read-only nil)
(remove-overlays (point-min) (point-max) 'doc-view t)
(set (make-local-variable 'image-mode-winprops-alist) t)
;; Switch to the previously used major mode or fall back to fundamental
;; mode.
(if doc-view-previous-major-mode
(funcall doc-view-previous-major-mode)
(doc-view-minor-mode 1))
;; Switch to doc-view-mode
(when (and (buffer-modified-p)
(y-or-n-p "The buffer has been modified. Save the changes? "))
;;;; Searching
(defun doc-view-search-internal (regexp file)
"Return a list of FILE's pages that contain text matching REGEXP.
The value is an alist of the form (PAGE CONTEXTS) where PAGE is
the pagenumber and CONTEXTS are all lines of text containing a match."
(insert-file-contents file)
(let ((page 1)
(lastpage 1)
(while (re-search-forward (concat "\\(?:\\([ ]\\)\\|\\("
regexp "\\)\\)") nil t)
(when (match-string 1) (setq page (1+ page)))
(when (match-string 2)
(if (/= page lastpage)
(push (cons page
(list (buffer-substring
(setq matches (cons
;; This page already is a match.
(car matches)
;; This is the first match on page.
(list page))
(list (buffer-substring
(cdr matches))))
(setq lastpage page)))
(nreverse matches))))
(defun doc-view-search-no-of-matches (list)
"Extract the number of matches from the search result LIST."
(let ((no 0))
(dolist (p list)
(setq no (+ no (1- (length p)))))
(defun doc-view-search-backward (new-query)
"Call `doc-view-search' for backward search.
If prefix NEW-QUERY is given, ask for a new regexp."
(interactive "P")
(doc-view-search new-query t))
(defun doc-view-search (new-query &optional backward)
"Jump to the next match or initiate a new search if NEW-QUERY is given.
If the current document hasn't been transformed to plain text
till now do that first.
If BACKWARD is non-nil, jump to the previous match."
(interactive "P")
(if (and (not new-query)
(if backward
(doc-view-search-previous-match 1)
(doc-view-search-next-match 1))
;; New search, so forget the old results.
(setq doc-view-current-search-matches nil)
(let ((txt (expand-file-name "doc.txt"
(if (file-readable-p txt)
(setq doc-view-current-search-matches
(read-from-minibuffer "Regexp: ")
(message "DocView: search yielded %d matches."
;; We must convert to TXT first!
(if doc-view-current-converter-processes
(message "DocView: please wait till conversion finished.")
(doc-view-doc->txt txt (lambda () (doc-view-search nil))))))))
(defun doc-view-search-next-match (arg)
"Go to the ARGth next matching page."
(interactive "p")
(let* ((next-pages (doc-view-remove-if
(lambda (i) (<= (car i) (doc-view-current-page)))
(page (car (nth (1- arg) next-pages))))
(if page
(doc-view-goto-page page)
(when (and
(y-or-n-p "No more matches after current page. Wrap to first match? "))
(doc-view-goto-page (caar doc-view-current-search-matches))))))
(defun doc-view-search-previous-match (arg)
"Go to the ARGth previous matching page."
(interactive "p")
(let* ((prev-pages (doc-view-remove-if
(lambda (i) (>= (car i) (doc-view-current-page)))
(page (car (nth (1- arg) (nreverse prev-pages)))))
(if page
(doc-view-goto-page page)
(when (and
(y-or-n-p "No more matches before current page. Wrap to last match? "))
(doc-view-goto-page (caar (last doc-view-current-search-matches)))))))
;;;; User interface commands and the mode
;; (put 'doc-view-mode 'mode-class 'special)
(defun doc-view-already-converted-p ()
"Return non-nil if the current doc was already converted."
(and (file-exists-p (doc-view-current-cache-dir))
(> (length (directory-files (doc-view-current-cache-dir) nil "\\.png$")) 0)))
(defun doc-view-initiate-display ()
;; Switch to image display if possible
(if (doc-view-mode-p doc-view-doc-type)
(setf (doc-view-current-page) (or (doc-view-current-page) 1))
(if (doc-view-already-converted-p)
(message "DocView: using cached files!")
;; Load the saved resolution
(let ((res-file (expand-file-name "resolution.el"
(res doc-view-resolution))
(when (file-exists-p res-file)
(insert-file-contents res-file)
(setq res (read (current-buffer)))))
(when (numberp res)
(set (make-local-variable 'doc-view-resolution) res)))
(doc-view-display (current-buffer) 'force))
(concat "Type \\[doc-view-toggle-display] to toggle between "
"editing or viewing the document."))))
(concat "No PNG support is available, or some conversion utility for "
(file-name-extension doc-view-buffer-file-name)
" files is missing."))
(if (and (executable-find doc-view-pdftotext-program)
"Unable to render file. View extracted text instead? "))
(defvar bookmark-make-record-function)
(defun doc-view-clone-buffer-hook ()
;; FIXME: There are several potential problems linked with reconversion
;; and auto-revert when we have indirect buffers because they share their
;; /tmp cache directory. This sharing is good (you'd rather not reconvert
;; for each clone), but that means that clones need to collaborate a bit.
;; I guess it mostly means: detect when a reconversion process is already
;; running, and run the sentinel in all clones.
;; Maybe the clones should really have a separate /tmp directory
;; so they could have a different resolution and you could use clones
;; for zooming.
(remove-overlays (point-min) (point-max) 'doc-view t)
(if (consp image-mode-winprops-alist) (setq image-mode-winprops-alist nil)))
(defun doc-view-intersection (l1 l2)
(let ((l ()))
(dolist (x l1) (if (memq x l2) (push x l)))
(defun doc-view-mode ()
"Major mode in DocView buffers.
DocView Mode is an Emacs document viewer. It displays PDF, PS
and DVI files (as PNG images) in Emacs buffers.
You can use \\<doc-view-mode-map>\\[doc-view-toggle-display] to
toggle between displaying the document or editing it as text.
(if (= (point-min) (point-max))
;; The doc is empty or doesn't exist at all, so fallback to
;; another mode. We used to also check file-exists-p, but this
;; returns nil for tar members.
(let ((auto-mode-alist (remq (rassq 'doc-view-mode auto-mode-alist)
(let* ((prev-major-mode (if (eq major-mode 'doc-view-mode)
(set (make-local-variable 'doc-view-previous-major-mode) prev-major-mode))
;; Figure out the document type.
(let ((name-types
(when buffer-file-name
(cdr (assoc (file-name-extension buffer-file-name)
'(("dvi" dvi)
("pdf" pdf)
("epdf" pdf)
("ps" ps)
("eps" ps))))))
(goto-char (point-min))
((looking-at "%!") '(ps))
((looking-at "%PDF") '(pdf))
((looking-at "\367\002") '(dvi))))))
(set (make-local-variable 'doc-view-doc-type)
(car (or (doc-view-intersection name-types content-types)
(when (and name-types content-types)
(error "Conflicting types: name says %s but content says %s"
name-types content-types))
name-types content-types
(error "Cannot determine the document type")))))
(doc-view-make-safe-dir doc-view-cache-directory)
;; Handle compressed files, remote files, files inside archives
(set (make-local-variable 'doc-view-buffer-file-name)
;; FIXME: there's a risk of name conflicts here.
(file-name-sans-extension buffer-file-name))
;; Is the file readable by local processes?
;; We used to use `file-remote-p' but it's unclear what it's
;; supposed to return nil for things like local files accessed via
;; `su' or via file://...
((let ((file-name-handler-alist nil))
(not (and buffer-file-name (file-readable-p buffer-file-name))))
;; FIXME: there's a risk of name conflicts here.
(if buffer-file-name
(file-name-nondirectory buffer-file-name)
(t buffer-file-name)))
(when (not (string= doc-view-buffer-file-name buffer-file-name))
(write-region nil nil doc-view-buffer-file-name))
(add-hook 'change-major-mode-hook
(lambda ()
(remove-overlays (point-min) (point-max) 'doc-view t))
nil t)
(add-hook 'clone-indirect-buffer-hook 'doc-view-clone-buffer-hook nil t)
(add-hook 'kill-buffer-hook 'doc-view-kill-proc nil t)
(remove-overlays (point-min) (point-max) 'doc-view t) ;Just in case.
;; Keep track of display info ([vh]scroll, page number, overlay,
;; ...) for each window in which this document is shown.
(add-hook 'image-mode-new-window-functions
'doc-view-new-window-function nil t)
(set (make-local-variable 'mode-line-position)
'(" P" (:eval (number-to-string (doc-view-current-page)))
"/" (:eval (number-to-string (length doc-view-current-files)))))
;; Don't scroll unless the user specifically asked for it.
(set (make-local-variable 'auto-hscroll-mode) nil)
(set (make-local-variable 'mwheel-scroll-up-function)
(set (make-local-variable 'mwheel-scroll-down-function)
(set (make-local-variable 'cursor-type) nil)
(use-local-map doc-view-mode-map)
(set (make-local-variable 'after-revert-hook) 'doc-view-reconvert-doc)
(set (make-local-variable 'bookmark-make-record-function)
(setq mode-name "DocView"
buffer-read-only t
major-mode 'doc-view-mode)
;; Switch off view-mode explicitly, because doc-view-mode is the
;; canonical view mode for PDF/PS/DVI files. This could be
;; switched on automatically depending on the value of
;; `view-read-only'.
(set (make-local-variable 'view-read-only) nil)
(run-mode-hooks 'doc-view-mode-hook)))
(define-minor-mode doc-view-minor-mode
"Toggle Doc view minor mode.
With arg, turn Doc view minor mode on if arg is positive, off otherwise.
See the command `doc-view-mode' for more information on this mode."
nil " DocView" doc-view-minor-mode-map
:group 'doc-view
(when doc-view-minor-mode
(add-hook 'change-major-mode-hook (lambda () (doc-view-minor-mode -1)) nil t)
"Type \\[doc-view-toggle-display] to toggle between editing or viewing the document."))))
(defun doc-view-clear-cache ()
"Delete the whole cache (`doc-view-cache-directory')."
(dired-delete-file doc-view-cache-directory 'always))
(defun doc-view-dired-cache ()
"Open `dired' in `doc-view-cache-directory'."
(dired doc-view-cache-directory))
;;;; Bookmark integration
(declare-function bookmark-make-record-default "bookmark"
(&optional point-only))
(declare-function bookmark-prop-get "bookmark" (bookmark prop))
(declare-function bookmark-default-handler "bookmark" (bmk))
(defun doc-view-bookmark-make-record ()
(nconc (bookmark-make-record-default)
`((page . ,(doc-view-current-page))
(handler . doc-view-bookmark-jump))))
(defun doc-view-bookmark-jump (bmk)
;; This implements the `handler' function interface for record type
;; returned by `doc-view-bookmark-make-record', which see.
(prog1 (bookmark-default-handler bmk)
(let ((page (bookmark-prop-get bmk 'page)))
(when (not (eq major-mode 'doc-view-mode))
(or (get-buffer-window (current-buffer) 0)
(doc-view-goto-page page)))))
(provide 'doc-view)
;; Local Variables:
;; mode: outline-minor
;; End:
;; arch-tag: 5d6e5c5e-095f-489e-b4e4-1ca90a7d79be
;;; doc-view.el ends here