doc-view.el 44.7 KB
Newer Older
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
1 2
;;; doc-view.el --- View PDF/PostScript/DVI files in Emacs

3
;; Copyright (C) 2007, 2008 Free Software Foundation, Inc.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
;;
;; Author: Tassilo Horn <tassilo@member.fsf.org>
;; Maintainer: Tassilo Horn <tassilo@member.fsf.org>
;; 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, 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
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Requirements:

28 29
;; doc-view.el requires GNU Emacs 22.1 or newer.  You also need Ghostscript,
;; `dvipdfm' which comes with teTeX and `pdftotext', which comes with xpdf
30
;; (http://www.foolabs.com/xpdf/) or poppler (http://poppler.freedesktop.org/).
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
31 32 33 34 35 36 37 38

;;; 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.
;;
39
;; To use it simply open a document file with
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
40
;;
41
;;     C-x C-f ~/path/to/document RET
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
42
;;
43 44
;; 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
45
;; representation and the source text representation of the document.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
46 47 48
;;
;; 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
49 50
;; that file again.  To reconvert a document hit `g' (`doc-view-reconvert-doc')
;; when displaying the document.  To delete all cached files use
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
;; `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 invokation 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
74 75 76 77 78 79 80 81
;; 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 invokation 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.
82 83 84 85
;;
;; 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'.
;;
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
86 87 88

;;; Configuration:

89 90 91
;; 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.)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
92 93 94 95 96 97 98 99
;;
;; 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.

100
;;; Todo:
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
101

102 103
;; - add print command.
;; - share more code with image-mode.
104 105
;; - better menu.
;; - Bind slicing to a drag event.
106
;; - doc-view-fit-doc-to-window and doc-view-fit-window-to-doc?
107
;; - zoom the region around the cursor (like xdvi).
108 109
;; - get rid of the silly arrow in the fringe.
;; - improve anti-aliasing (pdf-utils gets it better).
110

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
;;;; 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:

Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
136
(require 'dired)
137
(require 'image-mode)
138
(require 'jka-compr)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
139 140 141 142 143 144 145 146 147 148 149

;;;; 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-")

Reiner Steib's avatar
Reiner Steib committed
150
(defcustom doc-view-ghostscript-program (executable-find "gs")
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
151
  "Program to convert PS and PDF files to PNG."
Reiner Steib's avatar
Reiner Steib committed
152
  :type 'file
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
153 154 155
  :group 'doc-view)

(defcustom doc-view-ghostscript-options
156 157 158
  '("-dSAFER" ;; Avoid security problems when rendering files from untrusted
	      ;; sources.
    "-dNOPAUSE" "-sDEVICE=png16m" "-dTextAlphaBits=4"
159
    "-dBATCH" "-dGraphicsAlphaBits=4" "-dQUIET")
160
  "A list of options to give to ghostscript."
Reiner Steib's avatar
Reiner Steib committed
161
  :type '(repeat string)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
162 163
  :group 'doc-view)

164 165 166
(defcustom doc-view-resolution 100
  "Dots per inch resolution used to render the documents.
Higher values result in larger images."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
167 168
  :type 'number
  :group 'doc-view)
169

Reiner Steib's avatar
Reiner Steib committed
170
(defcustom doc-view-dvipdfm-program (executable-find "dvipdfm")
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
171 172 173 174
  "Program to convert DVI files to PDF.

DVI file will be converted to PDF before the resulting PDF is
converted to PNG."
Reiner Steib's avatar
Reiner Steib committed
175
  :type 'file
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
176 177
  :group 'doc-view)

Reiner Steib's avatar
Reiner Steib committed
178
(defcustom doc-view-ps2pdf-program (executable-find "ps2pdf")
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
179 180 181
  "Program to convert PS files to PDF.

PS files will be converted to PDF before searching is possible."
Reiner Steib's avatar
Reiner Steib committed
182
  :type 'file
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
183 184
  :group 'doc-view)

Reiner Steib's avatar
Reiner Steib committed
185
(defcustom doc-view-pdftotext-program (executable-find "pdftotext")
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
186 187 188
  "Program to convert PDF files to plain text.

Needed for searching."
Reiner Steib's avatar
Reiner Steib committed
189
  :type 'file
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
190 191
  :group 'doc-view)

192
(defcustom doc-view-cache-directory
193
  (expand-file-name (format "docview%d" (user-uid))
194
		    temporary-file-directory)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
195
  "The base directory, where the PNG images will be saved."
Reiner Steib's avatar
Reiner Steib committed
196
  :type 'directory
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
197 198
  :group 'doc-view)

199 200
(defvar doc-view-conversion-buffer " *doc-view conversion output*"
  "The buffer where messages from the converter programs go to.")
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
201

202
(defcustom doc-view-conversion-refresh-interval 1
203 204
  "Interval in seconds between refreshes of the DocView buffer while converting.
After such a refresh newly converted pages will be available for
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
205 206 207
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."
Reiner Steib's avatar
Reiner Steib committed
208
  :type 'integer
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
209 210 211 212
  :group 'doc-view)

;;;; Internal Variables

213 214 215 216
(defun doc-view-new-window-function (winprops)
  (let ((ol (image-mode-window-get 'overlay winprops)))
    (if ol
        (setq ol (copy-overlay ol))
217
      (assert (not (get-char-property (point-min) 'display (car winprops))))
218 219 220 221
      (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)))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
222

223
(defvar doc-view-current-files nil
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237
  "Only used internally.")

(defvar doc-view-current-converter-process nil
  "Only used internally.")

(defvar doc-view-current-timer nil
  "Only used internally.")

(defvar doc-view-current-cache-dir nil
  "Only used internally.")

(defvar doc-view-current-search-matches nil
  "Only used internally.")

238 239
(defvar doc-view-pending-cache-flush nil
  "Only used internally.")
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
240

241
(defvar doc-view-previous-major-mode nil
242 243
  "Only used internally.")

244 245 246 247 248 249 250 251
(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
`doc-view-cache-directory'.")

252 253 254 255
(defvar doc-view-doc-type nil
  "The type of document in the current buffer.
Can be `dvi', `pdf', or `ps'.")

256
;;;; DocView Keymaps
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
257 258 259

(defvar doc-view-mode-map
  (let ((map (make-sparse-keymap)))
260
    (suppress-keymap map)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
261 262 263
    ;; Navigation in the document
    (define-key map (kbd "n")         'doc-view-next-page)
    (define-key map (kbd "p")         'doc-view-previous-page)
264 265 266 267
    (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)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
268 269 270 271
    (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 "M-<")       'doc-view-first-page)
    (define-key map (kbd "M->")       'doc-view-last-page)
272
    (define-key map [remap goto-line] 'doc-view-goto-page)
273 274
    (define-key map [remap scroll-up] 'image-scroll-up)
    (define-key map [remap scroll-down] 'image-scroll-down)
275 276 277
    ;; Zoom in/out.
    (define-key map "+"               'doc-view-enlarge)
    (define-key map "-"               'doc-view-shrink)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
278 279 280
    ;; Killing/burying the buffer (and the process)
    (define-key map (kbd "q")         'bury-buffer)
    (define-key map (kbd "k")         'doc-view-kill-proc-and-buffer)
281
    (define-key map (kbd "K")         'doc-view-kill-proc)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
282 283 284 285 286 287 288
    ;; 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)
289
    (define-key map (kbd "C-r")       'doc-view-search-backward)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
290
    ;; Scrolling
291 292 293 294
    (define-key map [remap forward-char]  'image-forward-hscroll)
    (define-key map [remap backward-char] 'image-backward-hscroll)
    (define-key map [remap next-line]     'image-next-line)
    (define-key map [remap previous-line] 'image-previous-line)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
295 296
    ;; Show the tooltip
    (define-key map (kbd "C-t")       'doc-view-show-tooltip)
297 298
    ;; Toggle between text and image display or editing
    (define-key map (kbd "C-c C-c")   'doc-view-toggle-display)
299 300
    ;; Open a new buffer with doc's text contents
    (define-key map (kbd "C-c C-t")   'doc-view-open-text)
301
    ;; Reconvert the current document
302 303
    (define-key map (kbd "g")         'revert-buffer)
    (define-key map (kbd "r")         'revert-buffer)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
304
    map)
305 306
  "Keymap used by `doc-view-mode' when displaying a doc as a set of images.")

307 308 309 310 311 312 313 314
(easy-menu-define doc-view-menu doc-view-mode-map
  "Menu for Doc View mode."
  '("DocView"
    ["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]
315
    ["Search Backwards"         doc-view-search-backward]
316 317 318
    ["Toggle display"		doc-view-toggle-display]
    ))

319
(defvar doc-view-minor-mode-map
320 321 322 323
  (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)
    map)
324
  "Keymap used by `doc-minor-view-mode'.")
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
325 326 327

;;;; Navigation Commands

328 329
(defmacro doc-view-current-page (&optional win)
  `(image-mode-window-get 'page ,win))
330 331 332 333 334
(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))

Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
335 336 337 338 339
(defun doc-view-goto-page (page)
  "View the page given by PAGE."
  (interactive "nPage: ")
  (let ((len (length doc-view-current-files)))
    (if (< page 1)
340
	(setq page 1)
341 342 343 344
      (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-process))
345
	(setq page len)))
346 347
    (setf (doc-view-current-page) page
	  (doc-view-current-info)
348 349
	  (concat
	   (propertize
350
	    (format "Page %d of %d." page len) 'face 'bold)
351 352 353 354 355 356
	   ;; Tell user if converting isn't finished yet
	   (if doc-view-current-converter-process
	       " (still converting...)\n"
	     "\n")
	   ;; Display context infos if this page matches the last search
	   (when (and doc-view-current-search-matches
357
		      (assq page doc-view-current-search-matches))
358 359
	     (concat (propertize "Search matches:\n" 'face 'bold)
		     (let ((contexts ""))
360
		       (dolist (m (cdr (assq page
361 362 363
					     doc-view-current-search-matches)))
			 (setq contexts (concat contexts "  - \"" m "\"\n")))
		       contexts)))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
364
    ;; Update the buffer
365 366 367 368 369
    ;; 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.
    (doc-view-insert-image (expand-file-name (format "page-%d.png" page)
                                             (doc-view-current-cache-dir))
370
                           :pointer 'arrow)
371 372
    (overlay-put (doc-view-current-overlay)
                 'help-echo (doc-view-current-info))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
373 374 375 376

(defun doc-view-next-page (&optional arg)
  "Browse ARG pages forward."
  (interactive "p")
377
  (doc-view-goto-page (+ (doc-view-current-page) (or arg 1))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
378 379 380 381

(defun doc-view-previous-page (&optional arg)
  "Browse ARG pages backward."
  (interactive "p")
382
  (doc-view-goto-page (- (doc-view-current-page) (or arg 1))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
383 384 385 386 387 388 389 390 391 392 393 394 395 396

(defun doc-view-first-page ()
  "View the first page."
  (interactive)
  (doc-view-goto-page 1))

(defun doc-view-last-page ()
  "View the last page."
  (interactive)
  (doc-view-goto-page (length doc-view-current-files)))

(defun doc-view-scroll-up-or-next-page ()
  "Scroll page up if possible, else goto next page."
  (interactive)
397
  (when (= (window-vscroll) (image-scroll-up nil))
398
    (let ((cur-page (doc-view-current-page)))
399
      (doc-view-next-page)
400
      (when (/= cur-page (doc-view-current-page))
401
	(set-window-vscroll nil 0)))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
402 403 404 405

(defun doc-view-scroll-down-or-previous-page ()
  "Scroll page down if possible, else goto previous page."
  (interactive)
406
  (when (= (window-vscroll) (image-scroll-down nil))
407
    (let ((cur-page (doc-view-current-page)))
408
      (doc-view-previous-page)
409
      (when (/= cur-page (doc-view-current-page))
410
	(image-scroll-up nil)))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
411

412 413
;;;; Utility Functions

414 415 416 417
(defun doc-view-kill-proc ()
  "Kill the current converter process."
  (interactive)
  (when doc-view-current-converter-process
418 419
    (ignore-errors ;; Maybe it's dead already?
      (kill-process doc-view-current-converter-process))
420
    (setq doc-view-current-converter-process nil))
421 422 423 424 425
  (when doc-view-current-timer
    (cancel-timer doc-view-current-timer)
    (setq doc-view-current-timer nil))
  (setq mode-line-process nil))

Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
426 427 428
(defun doc-view-kill-proc-and-buffer ()
  "Kill the current converter process and buffer."
  (interactive)
429
  (doc-view-kill-proc)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
430 431 432
  (when (eq major-mode 'doc-view-mode)
    (kill-buffer (current-buffer))))

433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
(defun doc-view-make-safe-dir (dir)
  (condition-case nil
      (let ((umask (default-file-modes)))
        (unwind-protect
            (progn
              ;; 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)))
    (file-already-exists
     (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))))

458 459 460 461 462
(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
      doc-view-current-cache-dir
463 464 465
    ;; 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.
466 467
    (setq doc-view-current-cache-dir
	  (file-name-as-directory
468
	   (expand-file-name
469 470 471 472
	    (concat (file-name-nondirectory buffer-file-name)
		    "-"
		    (let ((file doc-view-buffer-file-name))
		      (with-temp-buffer
473
			(set-buffer-multibyte nil)
474 475
			(insert-file-contents-literally file)
			(md5 (current-buffer)))))
476
            doc-view-cache-directory)))))
477 478 479 480 481 482 483 484

(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))))))

485 486 487 488 489 490 491 492 493 494 495
;;;###autoload
(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)
       (cond
	((eq type 'dvi)
	 (and (doc-view-mode-p 'pdf)
	      doc-view-dvipdfm-program
	      (executable-find doc-view-dvipdfm-program)))
496
	((or (eq type 'postscript) (eq type 'ps) (eq type 'eps)
497 498 499 500 501 502
	     (eq type 'pdf))
	 (and doc-view-ghostscript-program
	      (executable-find doc-view-ghostscript-program)))
	(t ;; unknown image type
	 nil))))

Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
503 504
;;;; Conversion Functions

505 506 507 508 509 510 511 512 513 514 515 516 517 518
(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))
  (doc-view-reconvert-doc))

(defun doc-view-shrink (factor)
  "Shrink the document."
  (interactive (list doc-view-shrink-factor))
  (doc-view-enlarge (/ 1.0 factor)))

519
(defun doc-view-reconvert-doc ()
520 521 522
  "Reconvert the current document.
Should be invoked when the cached images aren't up-to-date."
  (interactive)
523 524 525 526
  (doc-view-kill-proc)
  ;; Clear the old cached files
  (when (file-exists-p (doc-view-current-cache-dir))
    (dired-delete-file (doc-view-current-cache-dir) 'always))
527
  (doc-view-initiate-display))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
528

529 530
(defun doc-view-sentinel (proc event)
  "Generic sentinel for doc-view conversion processes."
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
531
  (if (not (string-match "finished" event))
532 533
      (message "DocView: process %s changed status to %s."
               (process-name proc) event)
534
    (with-current-buffer (process-get proc 'buffer)
535 536 537 538 539 540
      (setq doc-view-current-converter-process nil
            mode-line-process nil)
      (funcall (process-get proc 'callback)))))

(defun doc-view-dvi->pdf (dvi pdf callback)
  "Convert DVI to PDF asynchronously and call CALLBACK when finished."
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
541
  (setq doc-view-current-converter-process
542
	(start-process "dvi->pdf" doc-view-conversion-buffer
543
		       doc-view-dvipdfm-program
544 545
		       "-o" pdf dvi)
	mode-line-process (list (format ":%s" doc-view-current-converter-process)))
546
  (set-process-sentinel doc-view-current-converter-process 'doc-view-sentinel)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
547
  (process-put doc-view-current-converter-process 'buffer   (current-buffer))
548
  (process-put doc-view-current-converter-process 'callback callback))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
549 550 551 552 553

(defun doc-view-pdf/ps->png-sentinel (proc event)
  "If PDF/PS->PNG conversion was successful, update the display."
  (if (not (string-match "finished" event))
      (message "DocView: converter process changed status to %s." event)
554 555 556 557 558 559 560 561 562 563
    ;; FIXME: kill the process if we kill the buffer?
    (when (buffer-live-p (process-get proc 'buffer))
      (with-current-buffer (process-get proc 'buffer)
        (setq doc-view-current-converter-process nil
              mode-line-process nil)
        (when doc-view-current-timer
          (cancel-timer doc-view-current-timer)
          (setq doc-view-current-timer nil))
        ;; Yippie, finished.  Update the display!
        (doc-view-display (current-buffer) 'force)))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
564 565

(defun doc-view-pdf/ps->png (pdf-ps png)
566
  "Convert PDF-PS to PNG asynchronously."
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
567
  (setq doc-view-current-converter-process
568 569 570 571 572 573 574 575 576 577
        ;; Make sure the process is started in an existing directory,
        ;; (rather than some file-name-handler-managed dir, for example).
        (let ((default-directory (file-name-directory pdf-ps)))
          (apply 'start-process
                 (append (list "pdf/ps->png" doc-view-conversion-buffer
                               doc-view-ghostscript-program)
                         doc-view-ghostscript-options
                         (list (format "-r%d" (round doc-view-resolution)))
                         (list (concat "-sOutputFile=" png))
                         (list pdf-ps))))
578
	mode-line-process (list (format ":%s" doc-view-current-converter-process)))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
579
  (process-put doc-view-current-converter-process
580
	       'buffer (current-buffer))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
581
  (set-process-sentinel doc-view-current-converter-process
582
			'doc-view-pdf/ps->png-sentinel)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
583 584
  (when doc-view-conversion-refresh-interval
    (setq doc-view-current-timer
585
	  (run-at-time "1 secs" doc-view-conversion-refresh-interval
586
		       'doc-view-display
587
		       (current-buffer)))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
588

589 590
(defun doc-view-pdf->txt (pdf txt callback)
  "Convert PDF to TXT asynchronously and call CALLBACK when finished."
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
591
  (setq doc-view-current-converter-process
592
	(start-process "pdf->txt" doc-view-conversion-buffer
593
		       doc-view-pdftotext-program "-raw"
594 595
		       pdf txt)
	mode-line-process (list (format ":%s" doc-view-current-converter-process)))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
596
  (set-process-sentinel doc-view-current-converter-process
597
			'doc-view-sentinel)
598
  (process-put doc-view-current-converter-process 'buffer (current-buffer))
599
  (process-put doc-view-current-converter-process 'callback callback))
600

601 602
(defun doc-view-doc->txt (txt callback)
  "Convert the current document to text and call CALLBACK when done."
603 604
  (unless (file-exists-p (doc-view-current-cache-dir))
    (make-directory (doc-view-current-cache-dir)))
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
  (case doc-view-doc-type
    (pdf
     ;; Doc is a PDF, so convert it to TXT
     (doc-view-pdf->txt doc-view-buffer-file-name txt callback))
    (ps
     ;; Doc is a PS, so convert it to PDF (which will be converted to
     ;; TXT thereafter).
     (lexical-let ((pdf (expand-file-name "doc.pdf"
                                          (doc-view-current-cache-dir)))
                   (txt txt)
                   (callback callback))
       (doc-view-ps->pdf doc-view-buffer-file-name pdf
                         (lambda () (doc-view-pdf->txt pdf txt callback)))))
    (dvi
     ;; 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"
                                          (doc-view-current-cache-dir))
                        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."
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
628
  (setq doc-view-current-converter-process
629
	(start-process "ps->pdf" doc-view-conversion-buffer
630
		       doc-view-ps2pdf-program
631 632
		       ;; Avoid security problems when rendering files from
		       ;; untrusted sources.
633 634 635
		       "-dSAFER"
		       ;; in-file and out-file
		       ps pdf)
636
	mode-line-process (list (format ":%s" doc-view-current-converter-process)))
637
  (set-process-sentinel doc-view-current-converter-process 'doc-view-sentinel)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
638
  (process-put doc-view-current-converter-process 'buffer   (current-buffer))
639
  (process-put doc-view-current-converter-process 'callback callback))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
640

641
(defun doc-view-convert-current-doc ()
642
  "Convert `doc-view-buffer-file-name' to a set of png files, one file per page.
643 644
Those files are saved in the directory given by the function
`doc-view-current-cache-dir'."
645 646 647 648 649 650 651 652
  ;; 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"
                                    (doc-view-current-cache-dir))))
653 654
    (unless (file-exists-p (doc-view-current-cache-dir))
      (make-directory (doc-view-current-cache-dir)))
655 656 657 658
    (case doc-view-doc-type
      (dvi
       ;; DVI files have to be converted to PDF before Ghostscript can process
       ;; it.
659 660 661 662 663
       (lexical-let
           ((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)))))
664 665 666
      (t
       ;; Convert to PNG images.
       (doc-view-pdf/ps->png doc-view-buffer-file-name png-file)))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
667 668 669 670 671 672 673 674 675 676 677 678

;;;; Slicing

(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'."
  (interactive
679
   (let* ((size (image-size (doc-view-current-image) t))
680 681 682 683
	  (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)))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
684
     (list a b c d)))
685
  (setf (doc-view-current-slice) (list x y width height))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
686
  ;; Redisplay
687
  (doc-view-goto-page (doc-view-current-page)))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
688 689 690 691 692 693 694 695 696 697

(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'."
  (interactive)
  (let (x y w h done)
    (while (not done)
      (let ((e (read-event
698 699 700 701 702 703 704 705
		(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))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
706 707 708
    (doc-view-set-slice x y w h)))

(defun doc-view-reset-slice ()
709
  "Reset the current slice.
710
After calling this function whole pages will be visible again."
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
711
  (interactive)
712
  (setf (doc-view-current-slice) nil)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
713
  ;; Redisplay
714
  (doc-view-goto-page (doc-view-current-page)))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
715 716 717 718 719

;;;; Display

(defun doc-view-insert-image (file &rest args)
  "Insert the given png FILE.
720
ARGS is a list of image descriptors."
721 722 723
  (when doc-view-pending-cache-flush
    (clear-image-cache)
    (setq doc-view-pending-cache-flush nil))
724
  (let ((ol (doc-view-current-overlay))
725 726
        (image (if (and file (file-readable-p file))
                   (apply 'create-image file 'png nil args)))
727 728
        (slice (doc-view-current-slice)))
    (setf (doc-view-current-image) image)
729
    (move-overlay ol (point-min) (point-max))
730
    (overlay-put ol 'display
731 732
                 (cond
                  (image
733 734
                   (if slice
                       (list (cons 'slice slice) image)
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
                     image))
                  ;; We're trying to display a page that doesn't exist.
                  (doc-view-current-converter-process
                   ;; Maybe the page doesn't exist *yet*.
                   "Cannot display this page (yet)!")
                  (t
                   ;; 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)))))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
757 758 759 760

(defun doc-view-sort (a b)
  "Return non-nil if A should be sorted before B.
Predicate for sorting `doc-view-current-files'."
761 762 763
  (or (< (length a) (length b))
      (and (= (length a) (length b))
           (string< a b))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
764

765 766
(defun doc-view-display (buffer &optional force)
  "Start viewing the document in BUFFER.
767 768
If FORCE is non-nil, start viewing even if the document does not
have the page we want to view."
769
  (with-current-buffer buffer
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
    (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)
                  'doc-view-sort))
      (dolist (win (get-buffer-window-list buffer nil t))
        (let* ((page (doc-view-current-page win))
               (pagefile (expand-file-name (format "page-%d.png" page)
                                             (doc-view-current-cache-dir))))
          (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))))))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
785 786

(defun doc-view-buffer-message ()
787 788 789
  ;; 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).
790 791
  (unless (overlay-get (doc-view-current-overlay) 'display)
    (overlay-put (doc-view-current-overlay) 'display
792 793 794
                 (concat (propertize "Welcome to DocView!" 'face 'bold)
                         "\n"
                         "
795
If you see this buffer it means that the document you want to view is being
796
converted to PNG and the conversion of the first page hasn't finished yet or
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
797 798 799 800
`doc-view-conversion-refresh-interval' is set to nil.

For now these keys are useful:

801
`q' : Bury this buffer.  Conversion will go on in background.
802
`k' : Kill the conversion process and this buffer.
803
`K' : Kill the conversion process.\n"))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
804 805 806

(defun doc-view-show-tooltip ()
  (interactive)
807
  (tooltip-show (doc-view-current-info)))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
808

809 810 811 812 813 814 815 816
(defun doc-view-open-text ()
  "Open a buffer with the current doc's contents as text."
  (interactive)
  (if doc-view-current-converter-process
      (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)
817
	(doc-view-doc->txt txt 'doc-view-open-text)))))
818

819
;;;;; Toggle between editing and viewing
820

821

822
(defun doc-view-toggle-display ()
823
  "Toggle between editing a document as text or viewing it."
824
  (interactive)
825 826 827 828 829
  (if (eq major-mode 'doc-view-mode)
      ;; Switch to editing mode
      (progn
	(doc-view-kill-proc)
	(setq buffer-read-only nil)
830 831
	(remove-overlays (point-min) (point-max) 'doc-view t)
	(set (make-local-variable 'image-mode-winprops-alist) t)
832 833 834 835 836
	;; 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)
	  (fundamental-mode))
837
	(doc-view-minor-mode 1))
838 839 840 841 842
    ;; Switch to doc-view-mode
    (when (and (buffer-modified-p)
	       (y-or-n-p "The buffer has been modified.  Save the changes? "))
      (save-buffer))
    (doc-view-mode)))
843

Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
844 845
;;;; Searching

846

Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
847 848
(defun doc-view-search-internal (regexp file)
  "Return a list of FILE's pages that contain text matching REGEXP.
849 850
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."
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
851 852 853
  (with-temp-buffer
    (insert-file-contents file)
    (let ((page 1)
854 855
	  (lastpage 1)
	  matches)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
856
      (while (re-search-forward (concat "\\(?:\\([]\\)\\|\\("
857
					regexp "\\)\\)") nil t)
858
	(when (match-string 1) (setq page (1+ page)))
859 860
	(when (match-string 2)
	  (if (/= page lastpage)
861
	      (push (cons page
862 863 864 865
			  (list (buffer-substring
				 (line-beginning-position)
				 (line-end-position))))
		    matches)
866 867 868 869 870 871 872 873 874 875 876 877
	    (setq matches (cons
			   (append
			    (or
			     ;; This page already is a match.
			     (car matches)
			     ;; This is the first match on page.
			     (list page))
			    (list (buffer-substring
				   (line-beginning-position)
				   (line-end-position))))
			   (cdr matches))))
	  (setq lastpage page)))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
878 879 880 881 882 883 884 885 886
      (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)))))
    no))

887 888 889 890
(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")
891
  (doc-view-search new-query t))
892 893 894

(defun doc-view-search (new-query &optional backward)
  "Jump to the next match or initiate a new search if NEW-QUERY is given.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
895
If the current document hasn't been transformed to plain text
896 897 898
till now do that first.
If BACKWARD is non-nil, jump to the previous match."
  (interactive "P")
899
  (if (and (not new-query)
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
	   doc-view-current-search-matches)
      (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"
				 (doc-view-current-cache-dir))))
      (if (file-readable-p txt)
	  (progn
	    (setq doc-view-current-search-matches
		  (doc-view-search-internal
		   (read-from-minibuffer "Regexp: ")
		   txt))
	    (message "DocView: search yielded %d matches."
		     (doc-view-search-no-of-matches
		      doc-view-current-search-matches)))
	;; We must convert to TXT first!
	(if doc-view-current-converter-process
	    (message "DocView: please wait till conversion finished.")
920
	  (doc-view-doc->txt txt (lambda () (doc-view-search nil))))))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
921 922 923 924

(defun doc-view-search-next-match (arg)
  "Go to the ARGth next matching page."
  (interactive "p")
925
  (let* ((next-pages (doc-view-remove-if
926
		      (lambda (i) (<= (car i) (doc-view-current-page)))
927
		      doc-view-current-search-matches))
928
	 (page (car (nth (1- arg) next-pages))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
929
    (if page
930
	(doc-view-goto-page page)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
931
      (when (and
932 933 934
	     doc-view-current-search-matches
	     (y-or-n-p "No more matches after current page.  Wrap to first match? "))
	(doc-view-goto-page (caar doc-view-current-search-matches))))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
935 936 937 938

(defun doc-view-search-previous-match (arg)
  "Go to the ARGth previous matching page."
  (interactive "p")
939
  (let* ((prev-pages (doc-view-remove-if
940
		      (lambda (i) (>= (car i) (doc-view-current-page)))
941
		      doc-view-current-search-matches))
942
	 (page (car (nth (1- arg) (nreverse prev-pages)))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
943
    (if page
944
	(doc-view-goto-page page)
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
945
      (when (and
946 947 948
	     doc-view-current-search-matches
	     (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)))))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
949

950
;;;; User interface commands and the mode
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
951

952 953
;; (put 'doc-view-mode 'mode-class 'special)

954 955 956 957 958
(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))
       (> 0 (length (directory-files (doc-view-current-cache-dir) nil "\\.png$")))))

959 960
(defun doc-view-initiate-display ()
  ;; Switch to image display if possible
961
  (if (doc-view-mode-p (intern (file-name-extension doc-view-buffer-file-name)))
962 963
      (progn
	(doc-view-buffer-message)
964
	(setf (doc-view-current-page) (or (doc-view-current-page) 1))
965
	(if (doc-view-already-converted-p)
966 967
	    (progn
	      (message "DocView: using cached files!")
968
	      (doc-view-display (current-buffer) 'force))
969 970 971 972 973 974 975 976 977
	  (doc-view-convert-current-doc))
	(message
	 "%s"
	 (substitute-command-keys
	  (concat "Type \\[doc-view-toggle-display] to toggle between "
		  "editing or viewing the document."))))
    (message
     "%s"
     (substitute-command-keys
978
      (concat "No image (png) support available or some conversion utility for "
979
	      (file-name-extension doc-view-buffer-file-name)" files is missing.  "
980 981
	      "Type \\[doc-view-toggle-display] to switch to an editing mode or "
	      "\\[doc-view-open-text] to open a buffer showing the doc as text.")))))
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
982

983
(defvar bookmark-make-record-function)
984

985 986 987 988 989 990 991
(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.