* lisp/doc-view.el: Add some comments about desktop support
[emacs.git] / lisp / doc-view.el
blobb718f1d8b2c338847eafa64aceae9b63e511097f
1 ;;; doc-view.el --- View PDF/PostScript/DVI files in Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 2007-2015 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Tassilo Horn <tsdh@gnu.org>
6 ;; Maintainer: Tassilo Horn <tsdh@gnu.org>
7 ;; Keywords: files, pdf, ps, dvi
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Requirements:
26 ;; doc-view.el requires GNU Emacs 22.1 or newer. You also need Ghostscript,
27 ;; `dvipdf' (comes with Ghostscript) or `dvipdfm' (comes with teTeX or TeXLive)
28 ;; and `pdftotext', which comes with xpdf (http://www.foolabs.com/xpdf/) or
29 ;; poppler (http://poppler.freedesktop.org/).
31 ;;; Commentary:
33 ;; DocView is a document viewer for Emacs. It converts PDF, PS and DVI files
34 ;; to a set of PNG files, one PNG for each page, and displays the PNG images
35 ;; inside an Emacs buffer. This buffer uses `doc-view-mode' which provides
36 ;; convenient key bindings for browsing the document.
38 ;; To use it simply open a document file with
40 ;; C-x C-f ~/path/to/document RET
42 ;; and the document will be converted and displayed, if your emacs supports png
43 ;; images. With `C-c C-c' you can toggle between the rendered images
44 ;; representation and the source text representation of the document.
46 ;; Since conversion may take some time all the PNG images are cached in a
47 ;; subdirectory of `doc-view-cache-directory' and reused when you want to view
48 ;; that file again. To reconvert a document hit `g' (`doc-view-reconvert-doc')
49 ;; when displaying the document. To delete all cached files use
50 ;; `doc-view-clear-cache'. To open the cache with dired, so that you can tidy
51 ;; it out use `doc-view-dired-cache'.
53 ;; When conversion in underway the first page will be displayed as soon as it
54 ;; is available and the available pages are refreshed every
55 ;; `doc-view-conversion-refresh-interval' seconds. If that variable is nil the
56 ;; pages won't be displayed before conversion of the document finished
57 ;; completely.
59 ;; DocView lets you select a slice of the displayed pages. This slice
60 ;; will be remembered and applied to all pages of the current
61 ;; document. This enables you to cut away the margins of a document
62 ;; to save some space. To select a slice you can use
63 ;; `doc-view-set-slice' (bound to `s s') which will query you for the
64 ;; coordinates of the slice's top-left corner and its width and
65 ;; height. A much more convenient way to do the same is offered by
66 ;; the command `doc-view-set-slice-using-mouse' (bound to `s m').
67 ;; After invocation you only have to press mouse-1 at the top-left
68 ;; corner and drag it to the bottom-right corner of the desired slice.
69 ;; Even more accurate and convenient is to use
70 ;; `doc-view-set-slice-from-bounding-box' (bound to `s b') which uses
71 ;; the BoundingBox information of the current page to set an optimal
72 ;; slice. To reset the slice use `doc-view-reset-slice' (bound to `s
73 ;; r').
75 ;; You can also search within the document. The command `doc-view-search'
76 ;; (bound to `C-s') queries for a search regexp and initializes a list of all
77 ;; matching pages and messages how many match-pages were found. After that you
78 ;; can jump to the next page containing a match with an additional `C-s'. With
79 ;; `C-r' you can do the same, but backwards. To search for a new regexp give a
80 ;; prefix arg to one of the search functions, e.g. by typing `C-u C-s'. The
81 ;; searching works by using a plain text representation of the document. If
82 ;; that doesn't already exist the first invocation of `doc-view-search' (or
83 ;; `doc-view-search-backward') starts the conversion. When that finishes and
84 ;; you're still viewing the document (i.e. you didn't switch to another buffer)
85 ;; you're queried for the regexp then.
87 ;; Dired users can simply hit `v' on a document file. If it's a PS, PDF or DVI
88 ;; it will be opened using `doc-view-mode'.
91 ;;; Configuration:
93 ;; If the images are too small or too big you should set the "-rXXX" option in
94 ;; `doc-view-ghostscript-options' to another value. (The bigger your screen,
95 ;; the higher the value.)
97 ;; This and all other options can be set with the customization interface.
98 ;; Simply do
100 ;; M-x customize-group RET doc-view RET
102 ;; and modify them to your needs.
104 ;;; Todo:
106 ;; - add print command.
107 ;; - share more code with image-mode.
108 ;; - better menu.
109 ;; - Bind slicing to a drag event.
110 ;; - zoom the region around the cursor (like xdvi).
111 ;; - get rid of the silly arrow in the fringe.
112 ;; - improve anti-aliasing (pdf-utils gets it better).
114 ;;;; About isearch support
116 ;; I tried implementing isearch by setting
117 ;; `isearch-search-fun-function' buffer-locally, but that didn't
118 ;; work too good. The function doing the real search was called
119 ;; endlessly somehow. But even if we'd get that working no real
120 ;; isearch feeling comes up due to the missing match highlighting.
121 ;; Currently I display all lines containing a match in a tooltip and
122 ;; each C-s or C-r jumps directly to the next/previous page with a
123 ;; match. With isearch we could only display the current match. So
124 ;; we had to decide if another C-s jumps to the next page with a
125 ;; match (thus only the first match in a page will be displayed in a
126 ;; tooltip) or to the next match, which would do nothing visible
127 ;; (except the tooltip) if the next match is on the same page.
129 ;; And it's much slower than the current search facility, because
130 ;; isearch really searches for each step forward or backward whereas
131 ;; the current approach searches once and then it knows to which
132 ;; pages to jump.
134 ;; Anyway, if someone with better isearch knowledge wants to give it a try,
135 ;; feel free to do it. --Tassilo
137 ;;; Code:
139 (require 'cl-lib)
140 (require 'dired)
141 (require 'image-mode)
142 (require 'jka-compr)
144 ;;;; Customization Options
146 (defgroup doc-view nil
147 "In-buffer viewer for PDF, PostScript, DVI, and DJVU files."
148 :link '(function-link doc-view)
149 :version "22.2"
150 :group 'applications
151 :group 'data
152 :group 'multimedia
153 :prefix "doc-view-")
155 (defcustom doc-view-ghostscript-program "gs"
156 "Program to convert PS and PDF files to PNG."
157 :type 'file
158 :group 'doc-view)
160 (defcustom doc-view-pdfdraw-program
161 (cond
162 ((executable-find "pdfdraw") "pdfdraw")
163 (t "mudraw"))
164 "Name of MuPDF's program to convert PDF files to PNG."
165 :type 'file
166 :version "24.4")
168 (defcustom doc-view-pdf->png-converter-function
169 (if (executable-find doc-view-pdfdraw-program)
170 #'doc-view-pdf->png-converter-mupdf
171 #'doc-view-pdf->png-converter-ghostscript)
172 "Function to call to convert a PDF file into a PNG file."
173 :type '(radio
174 (function-item doc-view-pdf->png-converter-ghostscript
175 :doc "Use ghostscript")
176 (function-item doc-view-pdf->png-converter-mupdf
177 :doc "Use mupdf")
178 function)
179 :version "24.4")
181 (defcustom doc-view-ghostscript-options
182 '("-dSAFER" ;; Avoid security problems when rendering files from untrusted
183 ;; sources.
184 "-dNOPAUSE" "-sDEVICE=png16m" "-dTextAlphaBits=4"
185 "-dBATCH" "-dGraphicsAlphaBits=4" "-dQUIET")
186 "A list of options to give to ghostscript."
187 :type '(repeat string)
188 :group 'doc-view)
190 (defcustom doc-view-resolution 100
191 "Dots per inch resolution used to render the documents.
192 Higher values result in larger images."
193 :type 'number
194 :group 'doc-view)
196 (defcustom doc-view-scale-internally t
197 "Whether we should try to rescale images ourselves.
198 If nil, the document is re-rendered every time the scaling factor is modified.
199 This only has an effect if the image libraries linked with Emacs support
200 scaling."
201 :version "24.4"
202 :type 'boolean)
204 (defcustom doc-view-image-width 850
205 "Default image width.
206 Has only an effect if `doc-view-scale-internally' is non-nil and support for
207 scaling is compiled into emacs."
208 :version "24.1"
209 :type 'number
210 :group 'doc-view)
212 (defcustom doc-view-dvipdfm-program "dvipdfm"
213 "Program to convert DVI files to PDF.
215 DVI file will be converted to PDF before the resulting PDF is
216 converted to PNG.
218 If this and `doc-view-dvipdf-program' are set,
219 `doc-view-dvipdf-program' will be preferred."
220 :type 'file
221 :group 'doc-view)
223 (defcustom doc-view-dvipdf-program "dvipdf"
224 "Program to convert DVI files to PDF.
226 DVI file will be converted to PDF before the resulting PDF is
227 converted to PNG.
229 If this and `doc-view-dvipdfm-program' are set,
230 `doc-view-dvipdf-program' will be preferred."
231 :type 'file
232 :group 'doc-view)
234 (define-obsolete-variable-alias 'doc-view-unoconv-program
235 'doc-view-odf->pdf-converter-program
236 "24.4")
238 (defcustom doc-view-odf->pdf-converter-program
239 (cond
240 ((executable-find "soffice") "soffice")
241 ((executable-find "unoconv") "unoconv")
242 (t "soffice"))
243 "Program to convert any file type readable by OpenOffice.org to PDF.
245 Needed for viewing OpenOffice.org (and MS Office) files."
246 :version "24.4"
247 :type 'file
248 :group 'doc-view)
250 (defcustom doc-view-odf->pdf-converter-function
251 (cond
252 ((string-match "unoconv\\'" doc-view-odf->pdf-converter-program)
253 #'doc-view-odf->pdf-converter-unoconv)
254 ((string-match "soffice\\'" doc-view-odf->pdf-converter-program)
255 #'doc-view-odf->pdf-converter-soffice))
256 "Function to call to convert a ODF file into a PDF file."
257 :type '(radio
258 (function-item doc-view-odf->pdf-converter-unoconv
259 :doc "Use unoconv")
260 (function-item doc-view-odf->pdf-converter-soffice
261 :doc "Use LibreOffice")
262 function)
263 :version "24.4")
265 (defcustom doc-view-ps2pdf-program "ps2pdf"
266 "Program to convert PS files to PDF.
268 PS files will be converted to PDF before searching is possible."
269 :type 'file
270 :group 'doc-view)
272 (defcustom doc-view-pdftotext-program "pdftotext"
273 "Program to convert PDF files to plain text.
275 Needed for searching."
276 :type 'file
277 :group 'doc-view)
279 (defcustom doc-view-cache-directory
280 (expand-file-name (format "docview%d" (user-uid))
281 temporary-file-directory)
282 "The base directory, where the PNG images will be saved."
283 :type 'directory
284 :group 'doc-view)
286 (defvar doc-view-conversion-buffer " *doc-view conversion output*"
287 "The buffer where messages from the converter programs go to.")
289 (defcustom doc-view-conversion-refresh-interval 1
290 "Interval in seconds between refreshes of the DocView buffer while converting.
291 After such a refresh newly converted pages will be available for
292 viewing. If set to nil there won't be any refreshes and the
293 pages won't be displayed before conversion of the whole document
294 has finished."
295 :type 'integer
296 :group 'doc-view)
298 (defcustom doc-view-continuous nil
299 "In Continuous mode reaching the page edge advances to next/previous page.
300 When non-nil, scrolling a line upward at the bottom edge of the page
301 moves to the next page, and scrolling a line downward at the top edge
302 of the page moves to the previous page."
303 :type 'boolean
304 :group 'doc-view
305 :version "23.2")
307 ;;;; Internal Variables
309 (defvar-local doc-view--current-converter-processes nil
310 "Only used internally.")
312 (defun doc-view-new-window-function (winprops)
313 ;; (message "New window %s for buf %s" (car winprops) (current-buffer))
314 (cl-assert (or (eq t (car winprops))
315 (eq (window-buffer (car winprops)) (current-buffer))))
316 (let ((ol (image-mode-window-get 'overlay winprops)))
317 (if ol
318 (progn
319 (setq ol (copy-overlay ol))
320 ;; `ol' might actually be dead.
321 (move-overlay ol (point-min) (point-max)))
322 (setq ol (make-overlay (point-min) (point-max) nil t))
323 (overlay-put ol 'doc-view t))
324 (overlay-put ol 'window (car winprops))
325 (unless (windowp (car winprops))
326 ;; It's a pseudo entry. Let's make sure it's not displayed (the
327 ;; `window' property is only effective if its value is a window).
328 (cl-assert (eq t (car winprops)))
329 (delete-overlay ol))
330 (image-mode-window-put 'overlay ol winprops)
331 (when (and (windowp (car winprops))
332 (stringp (overlay-get ol 'display))
333 (null doc-view--current-converter-processes))
334 ;; We're not displaying an image yet, so let's do so. This happens when
335 ;; the buffer is displayed for the first time.
336 ;; Don't do it if there's a conversion is running, since in that case, it
337 ;; will be done later.
338 (with-selected-window (car winprops)
339 (doc-view-goto-page (image-mode-window-get 'page t))))))
341 (defvar-local doc-view--current-files nil
342 "Only used internally.")
344 (defvar-local doc-view--current-timer nil
345 "Only used internally.")
347 (defvar-local doc-view--current-cache-dir nil
348 "Only used internally.")
350 (defvar-local doc-view--current-search-matches nil
351 "Only used internally.")
353 (defvar doc-view--pending-cache-flush nil
354 "Only used internally.")
356 (defvar doc-view--previous-major-mode nil
357 "Only used internally.")
359 (defvar doc-view--buffer-file-name nil
360 "Only used internally.
361 The file name used for conversion. Normally it's the same as
362 `buffer-file-name', but for remote files, compressed files and
363 files inside an archive it is a temporary copy of
364 the (uncompressed, extracted) file residing in
365 `doc-view-cache-directory'.")
367 (defvar doc-view-doc-type nil
368 "The type of document in the current buffer.
369 Can be `dvi', `pdf', or `ps'.")
371 (defvar doc-view-single-page-converter-function nil
372 "Function to call to convert a single page of the document to a bitmap file.
373 May operate on the source document or on some intermediate (typically PDF)
374 conversion of it.")
376 (defvar-local doc-view--image-type nil
377 "The type of image in the current buffer.
378 Can be `png' or `tiff'.")
380 (defvar-local doc-view--image-file-pattern nil
381 "The `format' pattern of image file names.
382 Typically \"page-%s.png\".")
384 ;;;; DocView Keymaps
386 (defvar doc-view-mode-map
387 (let ((map (make-sparse-keymap)))
388 (set-keymap-parent map image-mode-map)
389 ;; Navigation in the document
390 (define-key map (kbd "n") 'doc-view-next-page)
391 (define-key map (kbd "p") 'doc-view-previous-page)
392 (define-key map (kbd "<next>") 'forward-page)
393 (define-key map (kbd "<prior>") 'backward-page)
394 (define-key map [remap forward-page] 'doc-view-next-page)
395 (define-key map [remap backward-page] 'doc-view-previous-page)
396 (define-key map (kbd "SPC") 'doc-view-scroll-up-or-next-page)
397 (define-key map (kbd "S-SPC") 'doc-view-scroll-down-or-previous-page)
398 (define-key map (kbd "DEL") 'doc-view-scroll-down-or-previous-page)
399 (define-key map (kbd "C-n") 'doc-view-next-line-or-next-page)
400 (define-key map (kbd "<down>") 'doc-view-next-line-or-next-page)
401 (define-key map (kbd "C-p") 'doc-view-previous-line-or-previous-page)
402 (define-key map (kbd "<up>") 'doc-view-previous-line-or-previous-page)
403 (define-key map (kbd "M-<") 'doc-view-first-page)
404 (define-key map (kbd "M->") 'doc-view-last-page)
405 (define-key map [remap goto-line] 'doc-view-goto-page)
406 (define-key map (kbd "RET") 'image-next-line)
407 ;; Zoom in/out.
408 (define-key map "+" 'doc-view-enlarge)
409 (define-key map "=" 'doc-view-enlarge)
410 (define-key map "-" 'doc-view-shrink)
411 (define-key map "0" 'doc-view-scale-reset)
412 (define-key map [remap text-scale-adjust] 'doc-view-scale-adjust)
413 ;; Fit the image to the window
414 (define-key map "W" 'doc-view-fit-width-to-window)
415 (define-key map "H" 'doc-view-fit-height-to-window)
416 (define-key map "P" 'doc-view-fit-page-to-window)
417 ;; Killing the buffer (and the process)
418 (define-key map (kbd "k") 'doc-view-kill-proc-and-buffer)
419 (define-key map (kbd "K") 'doc-view-kill-proc)
420 ;; Slicing the image
421 (define-key map (kbd "s s") 'doc-view-set-slice)
422 (define-key map (kbd "s m") 'doc-view-set-slice-using-mouse)
423 (define-key map (kbd "s b") 'doc-view-set-slice-from-bounding-box)
424 (define-key map (kbd "s r") 'doc-view-reset-slice)
425 ;; Searching
426 (define-key map (kbd "C-s") 'doc-view-search)
427 (define-key map (kbd "<find>") 'doc-view-search)
428 (define-key map (kbd "C-r") 'doc-view-search-backward)
429 ;; Show the tooltip
430 (define-key map (kbd "C-t") 'doc-view-show-tooltip)
431 ;; Toggle between text and image display or editing
432 (define-key map (kbd "C-c C-c") 'doc-view-toggle-display)
433 ;; Open a new buffer with doc's text contents
434 (define-key map (kbd "C-c C-t") 'doc-view-open-text)
435 ;; Reconvert the current document. Don't just use revert-buffer
436 ;; because that resets the scale factor, the page number, ...
437 (define-key map (kbd "g") 'doc-view-revert-buffer)
438 (define-key map (kbd "r") 'doc-view-revert-buffer)
439 map)
440 "Keymap used by `doc-view-mode' when displaying a doc as a set of images.")
442 (defun doc-view-revert-buffer (&optional ignore-auto noconfirm)
443 "Like `revert-buffer', but preserves the buffer's current modes."
444 ;; FIXME: this should probably be moved to files.el and used for
445 ;; most/all "g" bindings to revert-buffer.
446 (interactive (list (not current-prefix-arg)))
447 (revert-buffer ignore-auto noconfirm 'preserve-modes))
450 (easy-menu-define doc-view-menu doc-view-mode-map
451 "Menu for Doc View mode."
452 '("DocView"
453 ["Toggle display" doc-view-toggle-display]
454 ("Continuous"
455 ["Off" (setq doc-view-continuous nil)
456 :style radio :selected (eq doc-view-continuous nil)]
457 ["On" (setq doc-view-continuous t)
458 :style radio :selected (eq doc-view-continuous t)]
459 "---"
460 ["Save as Default"
461 (customize-save-variable 'doc-view-continuous doc-view-continuous) t]
463 "---"
464 ["Set Slice" doc-view-set-slice-using-mouse]
465 ["Set Slice (BoundingBox)" doc-view-set-slice-from-bounding-box]
466 ["Set Slice (manual)" doc-view-set-slice]
467 ["Reset Slice" doc-view-reset-slice]
468 "---"
469 ["Search" doc-view-search]
470 ["Search Backwards" doc-view-search-backward]
473 (defvar doc-view-minor-mode-map
474 (let ((map (make-sparse-keymap)))
475 ;; Toggle between text and image display or editing
476 (define-key map (kbd "C-c C-c") 'doc-view-toggle-display)
477 map)
478 "Keymap used by `doc-minor-view-mode'.")
480 ;;;; Navigation Commands
482 (defmacro doc-view-current-page (&optional win)
483 `(image-mode-window-get 'page ,win))
484 (defmacro doc-view-current-info () `(image-mode-window-get 'info))
485 (defmacro doc-view-current-overlay () `(image-mode-window-get 'overlay))
486 (defmacro doc-view-current-image () `(image-mode-window-get 'image))
487 (defmacro doc-view-current-slice () `(image-mode-window-get 'slice))
489 (defun doc-view-last-page-number ()
490 (length doc-view--current-files))
492 (defun doc-view-goto-page (page)
493 "View the page given by PAGE."
494 (interactive "nPage: ")
495 (let ((len (doc-view-last-page-number)))
496 (if (< page 1)
497 (setq page 1)
498 (when (and (> page len)
499 ;; As long as the converter is running, we don't know
500 ;; how many pages will be available.
501 (null doc-view--current-converter-processes))
502 (setq page len)))
503 (force-mode-line-update) ;To update `current-page'.
504 (setf (doc-view-current-page) page
505 (doc-view-current-info)
506 (concat
507 (propertize
508 (format "Page %d of %d." page len) 'face 'bold)
509 ;; Tell user if converting isn't finished yet
510 (if doc-view--current-converter-processes
511 " (still converting...)\n"
512 "\n")
513 ;; Display context infos if this page matches the last search
514 (when (and doc-view--current-search-matches
515 (assq page doc-view--current-search-matches))
516 (concat (propertize "Search matches:\n" 'face 'bold)
517 (let ((contexts ""))
518 (dolist (m (cdr (assq page
519 doc-view--current-search-matches)))
520 (setq contexts (concat contexts " - \"" m "\"\n")))
521 contexts)))))
522 ;; Update the buffer
523 ;; We used to find the file name from doc-view--current-files but
524 ;; that's not right if the pages are not generated sequentially
525 ;; or if the page isn't in doc-view--current-files yet.
526 (let ((file (expand-file-name
527 (format doc-view--image-file-pattern page)
528 (doc-view--current-cache-dir))))
529 (doc-view-insert-image file :pointer 'arrow)
530 (when (and (not (file-exists-p file))
531 doc-view--current-converter-processes)
532 ;; The PNG file hasn't been generated yet.
533 (funcall doc-view-single-page-converter-function
534 doc-view--buffer-file-name file page
535 (let ((win (selected-window)))
536 (lambda ()
537 (and (eq (current-buffer) (window-buffer win))
538 ;; If we changed page in the mean
539 ;; time, don't mess things up.
540 (eq (doc-view-current-page win) page)
541 ;; Make sure we don't infloop.
542 (file-readable-p file)
543 (with-selected-window win
544 (doc-view-goto-page page))))))))
545 (overlay-put (doc-view-current-overlay)
546 'help-echo (doc-view-current-info))))
548 (defun doc-view-next-page (&optional arg)
549 "Browse ARG pages forward."
550 (interactive "p")
551 (doc-view-goto-page (+ (doc-view-current-page) (or arg 1))))
553 (defun doc-view-previous-page (&optional arg)
554 "Browse ARG pages backward."
555 (interactive "p")
556 (doc-view-goto-page (- (doc-view-current-page) (or arg 1))))
558 (defun doc-view-first-page ()
559 "View the first page."
560 (interactive)
561 (doc-view-goto-page 1))
563 (defun doc-view-last-page ()
564 "View the last page."
565 (interactive)
566 (doc-view-goto-page (doc-view-last-page-number)))
568 (defun doc-view-scroll-up-or-next-page (&optional arg)
569 "Scroll page up ARG lines if possible, else goto next page.
570 When `doc-view-continuous' is non-nil, scrolling upward
571 at the bottom edge of the page moves to the next page.
572 Otherwise, goto next page only on typing SPC (ARG is nil)."
573 (interactive "P")
574 (if (or doc-view-continuous (null arg))
575 (let ((hscroll (window-hscroll))
576 (cur-page (doc-view-current-page)))
577 (when (= (window-vscroll) (image-scroll-up arg))
578 (doc-view-next-page)
579 (when (/= cur-page (doc-view-current-page))
580 (image-bob)
581 (image-bol 1))
582 (set-window-hscroll (selected-window) hscroll)))
583 (image-scroll-up arg)))
585 (defun doc-view-scroll-down-or-previous-page (&optional arg)
586 "Scroll page down ARG lines if possible, else goto previous page.
587 When `doc-view-continuous' is non-nil, scrolling downward
588 at the top edge of the page moves to the previous page.
589 Otherwise, goto previous page only on typing DEL (ARG is nil)."
590 (interactive "P")
591 (if (or doc-view-continuous (null arg))
592 (let ((hscroll (window-hscroll))
593 (cur-page (doc-view-current-page)))
594 (when (= (window-vscroll) (image-scroll-down arg))
595 (doc-view-previous-page)
596 (when (/= cur-page (doc-view-current-page))
597 (image-eob)
598 (image-bol 1))
599 (set-window-hscroll (selected-window) hscroll)))
600 (image-scroll-down arg)))
602 (defun doc-view-next-line-or-next-page (&optional arg)
603 "Scroll upward by ARG lines if possible, else goto next page.
604 When `doc-view-continuous' is non-nil, scrolling a line upward
605 at the bottom edge of the page moves to the next page."
606 (interactive "p")
607 (if doc-view-continuous
608 (let ((hscroll (window-hscroll))
609 (cur-page (doc-view-current-page)))
610 (when (= (window-vscroll) (image-next-line arg))
611 (doc-view-next-page)
612 (when (/= cur-page (doc-view-current-page))
613 (image-bob)
614 (image-bol 1))
615 (set-window-hscroll (selected-window) hscroll)))
616 (image-next-line 1)))
618 (defun doc-view-previous-line-or-previous-page (&optional arg)
619 "Scroll downward by ARG lines if possible, else goto previous page.
620 When `doc-view-continuous' is non-nil, scrolling a line downward
621 at the top edge of the page moves to the previous page."
622 (interactive "p")
623 (if doc-view-continuous
624 (let ((hscroll (window-hscroll))
625 (cur-page (doc-view-current-page)))
626 (when (= (window-vscroll) (image-previous-line arg))
627 (doc-view-previous-page)
628 (when (/= cur-page (doc-view-current-page))
629 (image-eob)
630 (image-bol 1))
631 (set-window-hscroll (selected-window) hscroll)))
632 (image-previous-line arg)))
634 ;;;; Utility Functions
636 (defun doc-view-kill-proc ()
637 "Kill the current converter process(es)."
638 (interactive)
639 (while (consp doc-view--current-converter-processes)
640 (ignore-errors ;; Some entries might not be processes, and maybe
641 ;; some are dead already?
642 (kill-process (pop doc-view--current-converter-processes))))
643 (when doc-view--current-timer
644 (cancel-timer doc-view--current-timer)
645 (setq doc-view--current-timer nil))
646 (setq mode-line-process nil))
648 (defun doc-view-kill-proc-and-buffer ()
649 "Kill the current converter process and buffer."
650 (interactive)
651 (doc-view-kill-proc)
652 (when (eq major-mode 'doc-view-mode)
653 (kill-buffer (current-buffer))))
655 (defun doc-view-make-safe-dir (dir)
656 (condition-case nil
657 ;; Create temp files with strict access rights. It's easy to
658 ;; loosen them later, whereas it's impossible to close the
659 ;; time-window of loose permissions otherwise.
660 (with-file-modes #o0700 (make-directory dir))
661 (file-already-exists
662 (when (file-symlink-p dir)
663 (error "Danger: %s points to a symbolic link" dir))
664 ;; In case it was created earlier with looser rights.
665 ;; We could check the mode info returned by file-attributes, but it's
666 ;; a pain to parse and it may not tell you what we want under
667 ;; non-standard file-systems. So let's just say what we want and let
668 ;; the underlying C code and file-system figure it out.
669 ;; This also ends up checking a bunch of useful conditions: it makes
670 ;; sure we have write-access to the directory and that we own it, thus
671 ;; closing a bunch of security holes.
672 (condition-case error
673 (set-file-modes dir #o0700)
674 (file-error
675 (error
676 (format "Unable to use temporary directory %s: %s"
677 dir (mapconcat 'identity (cdr error) " "))))))))
679 (defun doc-view--current-cache-dir ()
680 "Return the directory where the png files of the current doc should be saved.
681 It's a subdirectory of `doc-view-cache-directory'."
682 (if doc-view--current-cache-dir
683 doc-view--current-cache-dir
684 ;; Try and make sure doc-view-cache-directory exists and is safe.
685 (doc-view-make-safe-dir doc-view-cache-directory)
686 ;; Now compute the subdirectory to use.
687 (setq doc-view--current-cache-dir
688 (file-name-as-directory
689 (expand-file-name
690 (concat (subst-char-in-string ?% ?_ ;; bug#13679
691 (file-name-nondirectory doc-view--buffer-file-name))
693 (let ((file doc-view--buffer-file-name))
694 (with-temp-buffer
695 (set-buffer-multibyte nil)
696 (insert-file-contents-literally file)
697 (md5 (current-buffer)))))
698 doc-view-cache-directory)))))
700 ;;;###autoload
701 (defun doc-view-mode-p (type)
702 "Return non-nil if document type TYPE is available for `doc-view'.
703 Document types are symbols like `dvi', `ps', `pdf', or `odf' (any
704 OpenDocument format)."
705 (and (display-graphic-p)
706 (or (image-type-available-p 'imagemagick)
707 (image-type-available-p 'png))
708 (cond
709 ((eq type 'dvi)
710 (and (doc-view-mode-p 'pdf)
711 (or (and doc-view-dvipdf-program
712 (executable-find doc-view-dvipdf-program))
713 (and doc-view-dvipdfm-program
714 (executable-find doc-view-dvipdfm-program)))))
715 ((memq type '(postscript ps eps pdf))
716 ;; FIXME: allow mupdf here
717 (and doc-view-ghostscript-program
718 (executable-find doc-view-ghostscript-program)))
719 ((eq type 'odf)
720 (and doc-view-odf->pdf-converter-program
721 (executable-find doc-view-odf->pdf-converter-program)
722 (doc-view-mode-p 'pdf)))
723 ((eq type 'djvu)
724 (executable-find "ddjvu"))
725 (t ;; unknown image type
726 nil))))
728 ;;;; Conversion Functions
730 (defvar doc-view-shrink-factor 1.125)
732 (defun doc-view-enlarge (factor)
733 "Enlarge the document by FACTOR."
734 (interactive (list doc-view-shrink-factor))
735 (if (and doc-view-scale-internally
736 (eq (plist-get (cdr (doc-view-current-image)) :type)
737 'imagemagick))
738 ;; ImageMagick supports on-the-fly-rescaling.
739 (let ((new (ceiling (* factor doc-view-image-width))))
740 (unless (equal new doc-view-image-width)
741 (setq-local doc-view-image-width new)
742 (doc-view-insert-image
743 (plist-get (cdr (doc-view-current-image)) :file)
744 :width doc-view-image-width)))
745 (let ((new (ceiling (* factor doc-view-resolution))))
746 (unless (equal new doc-view-resolution)
747 (setq-local doc-view-resolution new)
748 (doc-view-reconvert-doc)))))
750 (defun doc-view-shrink (factor)
751 "Shrink the document."
752 (interactive (list doc-view-shrink-factor))
753 (doc-view-enlarge (/ 1.0 factor)))
755 (defun doc-view-scale-reset ()
756 "Reset the document size/zoom level to the initial one."
757 (interactive)
758 (if (and doc-view-scale-internally
759 (eq (plist-get (cdr (doc-view-current-image)) :type)
760 'imagemagick))
761 (progn
762 (kill-local-variable 'doc-view-image-width)
763 (doc-view-insert-image
764 (plist-get (cdr (doc-view-current-image)) :file)
765 :width doc-view-image-width))
766 (kill-local-variable 'doc-view-resolution)
767 (doc-view-reconvert-doc)))
769 (defun doc-view-scale-adjust (factor)
770 "Adjust the scale of the DocView page images by FACTOR.
771 FACTOR defaults to `doc-view-shrink-factor'.
773 The actual adjustment made depends on the final component of the
774 key-binding used to invoke the command, with all modifiers removed:
776 +, = Increase the image scale by FACTOR
777 - Decrease the image scale by FACTOR
778 0 Reset the image scale to the initial scale"
779 (interactive (list doc-view-shrink-factor))
780 (let ((ev last-command-event)
781 (echo-keystrokes nil))
782 (pcase (event-basic-type ev)
783 ((or ?+ ?=) (doc-view-enlarge factor))
784 (?- (doc-view-shrink factor))
785 (?0 (doc-view-scale-reset)))))
787 (defun doc-view-fit-width-to-window ()
788 "Fit the image width to the window width."
789 (interactive)
790 (let ((win-width (- (nth 2 (window-inside-pixel-edges))
791 (nth 0 (window-inside-pixel-edges))))
792 (slice (doc-view-current-slice)))
793 (if (not slice)
794 (let ((img-width (car (image-display-size
795 (image-get-display-property) t))))
796 (doc-view-enlarge (/ (float win-width) (float img-width))))
798 ;; If slice is set
799 (let* ((slice-width (nth 2 slice))
800 (scale-factor (/ (float win-width) (float slice-width)))
801 (new-slice (mapcar (lambda (x) (ceiling (* scale-factor x))) slice)))
803 (doc-view-enlarge scale-factor)
804 (setf (doc-view-current-slice) new-slice)
805 (doc-view-goto-page (doc-view-current-page))))))
807 (defun doc-view-fit-height-to-window ()
808 "Fit the image height to the window height."
809 (interactive)
810 (let ((win-height (- (nth 3 (window-inside-pixel-edges))
811 (nth 1 (window-inside-pixel-edges))))
812 (slice (doc-view-current-slice)))
813 (if (not slice)
814 (let ((img-height (cdr (image-display-size
815 (image-get-display-property) t))))
816 ;; When users call 'doc-view-fit-height-to-window',
817 ;; they might want to go to next page by typing SPC
818 ;; ONLY once. So I used '(- win-height 1)' instead of
819 ;; 'win-height'
820 (doc-view-enlarge (/ (float (- win-height 1)) (float img-height))))
822 ;; If slice is set
823 (let* ((slice-height (nth 3 slice))
824 (scale-factor (/ (float (- win-height 1)) (float slice-height)))
825 (new-slice (mapcar (lambda (x) (ceiling (* scale-factor x))) slice)))
827 (doc-view-enlarge scale-factor)
828 (setf (doc-view-current-slice) new-slice)
829 (doc-view-goto-page (doc-view-current-page))))))
831 (defun doc-view-fit-page-to-window ()
832 "Fit the image to the window.
833 More specifically, this function enlarges image by:
835 min {(window-width / image-width), (window-height / image-height)} times."
836 (interactive)
837 (let ((win-width (- (nth 2 (window-inside-pixel-edges))
838 (nth 0 (window-inside-pixel-edges))))
839 (win-height (- (nth 3 (window-inside-pixel-edges))
840 (nth 1 (window-inside-pixel-edges))))
841 (slice (doc-view-current-slice)))
842 (if (not slice)
843 (let ((img-width (car (image-display-size
844 (image-get-display-property) t)))
845 (img-height (cdr (image-display-size
846 (image-get-display-property) t))))
847 (doc-view-enlarge (min (/ (float win-width) (float img-width))
848 (/ (float (- win-height 1))
849 (float img-height)))))
850 ;; If slice is set
851 (let* ((slice-width (nth 2 slice))
852 (slice-height (nth 3 slice))
853 (scale-factor (min (/ (float win-width) (float slice-width))
854 (/ (float (- win-height 1))
855 (float slice-height))))
856 (new-slice (mapcar (lambda (x) (ceiling (* scale-factor x))) slice)))
857 (doc-view-enlarge scale-factor)
858 (setf (doc-view-current-slice) new-slice)
859 (doc-view-goto-page (doc-view-current-page))))))
861 (defun doc-view-reconvert-doc ()
862 "Reconvert the current document.
863 Should be invoked when the cached images aren't up-to-date."
864 (interactive)
865 (doc-view-kill-proc)
866 ;; Clear the old cached files
867 (when (file-exists-p (doc-view--current-cache-dir))
868 (delete-directory (doc-view--current-cache-dir) 'recursive))
869 (kill-local-variable 'doc-view-last-page-number)
870 (doc-view-initiate-display))
872 (defun doc-view-sentinel (proc event)
873 "Generic sentinel for doc-view conversion processes."
874 (if (not (string-match "finished" event))
875 (message "DocView: process %s changed status to %s."
876 (process-name proc)
877 (if (string-match "\\(.+\\)\n?\\'" event)
878 (match-string 1 event)
879 event))
880 (when (buffer-live-p (process-get proc 'buffer))
881 (with-current-buffer (process-get proc 'buffer)
882 (setq doc-view--current-converter-processes
883 (delq proc doc-view--current-converter-processes))
884 (setq mode-line-process
885 (if doc-view--current-converter-processes
886 (format ":%s" (car doc-view--current-converter-processes))))
887 (funcall (process-get proc 'callback))))))
889 (defun doc-view-start-process (name program args callback)
890 ;; Make sure the process is started in an existing directory, (rather than
891 ;; some file-name-handler-managed dir, for example).
892 (let* ((default-directory (or (unhandled-file-name-directory
893 default-directory)
894 (expand-file-name "~/")))
895 (proc (apply 'start-process name doc-view-conversion-buffer
896 program args)))
897 (push proc doc-view--current-converter-processes)
898 (setq mode-line-process (list (format ":%s" proc)))
899 (set-process-sentinel proc 'doc-view-sentinel)
900 (process-put proc 'buffer (current-buffer))
901 (process-put proc 'callback callback)))
903 (defun doc-view-dvi->pdf (dvi pdf callback)
904 "Convert DVI to PDF asynchronously and call CALLBACK when finished."
905 ;; Prefer dvipdf over dvipdfm, because the latter has problems if the DVI
906 ;; references and includes other PS files.
907 (if (and doc-view-dvipdf-program
908 (executable-find doc-view-dvipdf-program))
909 (doc-view-start-process "dvi->pdf" doc-view-dvipdf-program
910 (list dvi pdf)
911 callback)
912 (doc-view-start-process "dvi->pdf" doc-view-dvipdfm-program
913 (list "-o" pdf dvi)
914 callback)))
916 (defun doc-view-pdf->png-converter-ghostscript (pdf png page callback)
917 (doc-view-start-process
918 "pdf/ps->png" doc-view-ghostscript-program
919 `(,@doc-view-ghostscript-options
920 ,(format "-r%d" (round doc-view-resolution))
921 ,@(if page `(,(format "-dFirstPage=%d" page)))
922 ,@(if page `(,(format "-dLastPage=%d" page)))
923 ,(concat "-sOutputFile=" png)
924 ,pdf)
925 callback))
927 (defalias 'doc-view-ps->png-converter-ghostscript
928 'doc-view-pdf->png-converter-ghostscript)
930 (defun doc-view-djvu->tiff-converter-ddjvu (djvu tiff page callback)
931 "Convert PAGE of a DJVU file to bitmap(s) asynchronously.
932 Call CALLBACK with no arguments when done.
933 If PAGE is nil, convert the whole document."
934 (doc-view-start-process
935 "djvu->tiff" "ddjvu"
936 `("-format=tiff"
937 ;; ddjvu only accepts the range 1-999.
938 ,(format "-scale=%d" (round doc-view-resolution))
939 ;; -eachpage was only added after djvulibre-3.5.25.3!
940 ,@(unless page '("-eachpage"))
941 ,@(if page `(,(format "-page=%d" page)))
942 ,djvu
943 ,tiff)
944 callback))
946 (defun doc-view-pdf->png-converter-mupdf (pdf png page callback)
947 (doc-view-start-process
948 "pdf->png" doc-view-pdfdraw-program
949 `(,(concat "-o" png)
950 ,(format "-r%d" (round doc-view-resolution))
951 ,pdf
952 ,@(if page `(,(format "%d" page))))
953 callback))
955 (defun doc-view-odf->pdf-converter-unoconv (odf callback)
956 "Convert ODF to PDF asynchronously and call CALLBACK when finished.
957 The converted PDF is put into the current cache directory, and it
958 is named like ODF with the extension turned to pdf."
959 (doc-view-start-process "odf->pdf" doc-view-odf->pdf-converter-program
960 (list "-f" "pdf" "-o" (doc-view--current-cache-dir) odf)
961 callback))
963 (defun doc-view-odf->pdf-converter-soffice (odf callback)
964 "Convert ODF to PDF asynchronously and call CALLBACK when finished.
965 The converted PDF is put into the current cache directory, and it
966 is named like ODF with the extension turned to pdf."
967 ;; FIXME: soffice doesn't work when there's another running
968 ;; LibreOffice instance, in which case it returns success without
969 ;; actually doing anything. See LibreOffice bug
970 ;; https://bugs.freedesktop.org/show_bug.cgi?id=37531. A workaround
971 ;; is to start soffice with a separate UserInstallation directory.
972 (let ((tmp-user-install-dir (make-temp-file "libreoffice-docview" t)))
973 (doc-view-start-process "odf->pdf" doc-view-odf->pdf-converter-program
974 (list
975 (concat "-env:UserInstallation=file://"
976 tmp-user-install-dir)
977 "--headless" "--convert-to" "pdf"
978 "--outdir" (doc-view--current-cache-dir) odf)
979 (lambda ()
980 (delete-directory tmp-user-install-dir t)
981 (funcall callback)))))
983 (defun doc-view-pdf/ps->png (pdf-ps png)
984 ;; FIXME: Fix name and docstring to account for djvu&tiff.
985 "Convert PDF-PS to PNG asynchronously."
986 (funcall
987 (pcase doc-view-doc-type
988 (`pdf doc-view-pdf->png-converter-function)
989 (`djvu #'doc-view-djvu->tiff-converter-ddjvu)
990 (_ #'doc-view-ps->png-converter-ghostscript))
991 pdf-ps png nil
992 (let ((resolution doc-view-resolution))
993 (lambda ()
994 ;; Only create the resolution file when it's all done, so it also
995 ;; serves as a witness that the conversion is complete.
996 (write-region (prin1-to-string resolution) nil
997 (expand-file-name "resolution.el"
998 (doc-view--current-cache-dir))
999 nil 'silently)
1000 (when doc-view--current-timer
1001 (cancel-timer doc-view--current-timer)
1002 (setq doc-view--current-timer nil))
1003 (doc-view-display (current-buffer) 'force))))
1005 ;; Update the displayed pages as soon as they're done generating.
1006 (when doc-view-conversion-refresh-interval
1007 (setq doc-view--current-timer
1008 (run-at-time "1 secs" doc-view-conversion-refresh-interval
1009 'doc-view-display
1010 (current-buffer)))))
1012 (declare-function clear-image-cache "image.c" (&optional filter))
1014 (defun doc-view-document->bitmap (pdf png pages)
1015 "Convert a document file to bitmap images asynchronously.
1016 Start by converting PAGES, and then the rest."
1017 (if (null pages)
1018 (doc-view-pdf/ps->png pdf png)
1019 ;; We could render several `pages' with a single process if they're
1020 ;; (almost) consecutive, but since in 99% of the cases, there'll be only
1021 ;; a single page anyway, and of the remaining 1%, few cases will have
1022 ;; consecutive pages, it's not worth the trouble.
1023 (let ((rest (cdr pages)))
1024 (funcall doc-view-single-page-converter-function
1025 pdf (format png (car pages)) (car pages)
1026 (lambda ()
1027 (if rest
1028 (doc-view-document->bitmap pdf png rest)
1029 ;; Yippie, the important pages are done, update the display.
1030 (clear-image-cache)
1031 ;; For the windows that have a message (like "Welcome to
1032 ;; DocView") display property, clearing the image cache is
1033 ;; not sufficient.
1034 (dolist (win (get-buffer-window-list (current-buffer) nil 'visible))
1035 (with-selected-window win
1036 (when (stringp (overlay-get (doc-view-current-overlay) 'display))
1037 (doc-view-goto-page (doc-view-current-page)))))
1038 ;; Convert the rest of the pages.
1039 (doc-view-pdf/ps->png pdf png)))))))
1041 (defun doc-view-pdf->txt (pdf txt callback)
1042 "Convert PDF to TXT asynchronously and call CALLBACK when finished."
1043 (or (executable-find doc-view-pdftotext-program)
1044 (error "You need the `pdftotext' program to convert a PDF to text"))
1045 (doc-view-start-process "pdf->txt" doc-view-pdftotext-program
1046 (list "-raw" pdf txt)
1047 callback))
1049 (defun doc-view-current-cache-doc-pdf ()
1050 "Return the name of the doc.pdf in the current cache dir.
1051 This file exists only if the current document isn't a PDF or PS file already."
1052 (expand-file-name "doc.pdf" (doc-view--current-cache-dir)))
1054 (defun doc-view-doc->txt (txt callback)
1055 "Convert the current document to text and call CALLBACK when done."
1056 (make-directory (doc-view--current-cache-dir) t)
1057 (pcase doc-view-doc-type
1058 (`pdf
1059 ;; Doc is a PDF, so convert it to TXT
1060 (doc-view-pdf->txt doc-view--buffer-file-name txt callback))
1061 (`ps
1062 ;; Doc is a PS, so convert it to PDF (which will be converted to
1063 ;; TXT thereafter).
1064 (let ((pdf (doc-view-current-cache-doc-pdf)))
1065 (doc-view-ps->pdf doc-view--buffer-file-name pdf
1066 (lambda () (doc-view-pdf->txt pdf txt callback)))))
1067 (`dvi
1068 ;; Doc is a DVI. This means that a doc.pdf already exists in its
1069 ;; cache subdirectory.
1070 (doc-view-pdf->txt (doc-view-current-cache-doc-pdf) txt callback))
1071 (`odf
1072 ;; Doc is some ODF (or MS Office) doc. This means that a doc.pdf
1073 ;; already exists in its cache subdirectory.
1074 (doc-view-pdf->txt (doc-view-current-cache-doc-pdf) txt callback))
1075 (_ (error "DocView doesn't know what to do"))))
1077 (defun doc-view-ps->pdf (ps pdf callback)
1078 "Convert PS to PDF asynchronously and call CALLBACK when finished."
1079 (or (executable-find doc-view-ps2pdf-program)
1080 (error "You need the `ps2pdf' program to convert PS to PDF"))
1081 (doc-view-start-process "ps->pdf" doc-view-ps2pdf-program
1082 (list
1083 ;; Avoid security problems when rendering files from
1084 ;; untrusted sources.
1085 "-dSAFER"
1086 ;; in-file and out-file
1087 ps pdf)
1088 callback))
1090 (defun doc-view-active-pages ()
1091 (let ((pages ()))
1092 (dolist (win (get-buffer-window-list (current-buffer) nil 'visible))
1093 (let ((page (image-mode-window-get 'page win)))
1094 (unless (memq page pages) (push page pages))))
1095 pages))
1097 (defun doc-view-convert-current-doc ()
1098 "Convert `doc-view--buffer-file-name' to a set of png files, one file per page.
1099 Those files are saved in the directory given by the function
1100 `doc-view--current-cache-dir'."
1101 ;; Let stale files still display while we recompute the new ones, so only
1102 ;; flush the cache when the conversion is over. One of the reasons why it
1103 ;; is important to keep displaying the stale page is so that revert-buffer
1104 ;; preserves the horizontal/vertical scroll settings (which are otherwise
1105 ;; reset during the redisplay).
1106 (setq doc-view--pending-cache-flush t)
1107 (let ((png-file (expand-file-name
1108 (format doc-view--image-file-pattern "%d")
1109 (doc-view--current-cache-dir))))
1110 (make-directory (doc-view--current-cache-dir) t)
1111 (pcase doc-view-doc-type
1112 (`dvi
1113 ;; DVI files have to be converted to PDF before Ghostscript can process
1114 ;; it.
1115 (let ((pdf (doc-view-current-cache-doc-pdf)))
1116 (doc-view-dvi->pdf doc-view--buffer-file-name pdf
1117 (lambda () (doc-view-pdf/ps->png pdf png-file)))))
1118 (`odf
1119 ;; ODF files have to be converted to PDF before Ghostscript can
1120 ;; process it.
1121 (let ((pdf (doc-view-current-cache-doc-pdf))
1122 (opdf (expand-file-name
1123 (concat (file-name-base doc-view--buffer-file-name)
1124 ".pdf")
1125 doc-view--current-cache-dir))
1126 (png-file png-file))
1127 ;; The unoconv tool only supports an output directory, but no
1128 ;; file name. It's named like the input file with the
1129 ;; extension replaced by pdf.
1130 (funcall doc-view-odf->pdf-converter-function doc-view--buffer-file-name
1131 (lambda ()
1132 ;; Rename to doc.pdf
1133 (rename-file opdf pdf)
1134 (doc-view-pdf/ps->png pdf png-file)))))
1135 ((or `pdf `djvu)
1136 (let ((pages (doc-view-active-pages)))
1137 ;; Convert doc to bitmap images starting with the active pages.
1138 (doc-view-document->bitmap doc-view--buffer-file-name png-file pages)))
1140 ;; Convert to PNG images.
1141 (doc-view-pdf/ps->png doc-view--buffer-file-name png-file)))))
1143 ;;;; Slicing
1145 (declare-function image-size "image.c" (spec &optional pixels frame))
1147 (defun doc-view-set-slice (x y width height)
1148 "Set the slice of the images that should be displayed.
1149 You can use this function to tell doc-view not to display the
1150 margins of the document. It prompts for the top-left corner (X
1151 and Y) of the slice to display and its WIDTH and HEIGHT.
1153 See `doc-view-set-slice-using-mouse' and
1154 `doc-view-set-slice-from-bounding-box' for more convenient ways
1155 to do that. To reset the slice use `doc-view-reset-slice'."
1156 (interactive
1157 (let* ((size (image-size (doc-view-current-image) t))
1158 (a (read-number (format "Top-left X (0..%d): " (car size))))
1159 (b (read-number (format "Top-left Y (0..%d): " (cdr size))))
1160 (c (read-number (format "Width (0..%d): " (- (car size) a))))
1161 (d (read-number (format "Height (0..%d): " (- (cdr size) b)))))
1162 (list a b c d)))
1163 (setf (doc-view-current-slice) (list x y width height))
1164 ;; Redisplay
1165 (doc-view-goto-page (doc-view-current-page)))
1167 (defun doc-view-set-slice-using-mouse ()
1168 "Set the slice of the images that should be displayed.
1169 You set the slice by pressing mouse-1 at its top-left corner and
1170 dragging it to its bottom-right corner. See also
1171 `doc-view-set-slice' and `doc-view-reset-slice'."
1172 (interactive)
1173 (let (x y w h done)
1174 (while (not done)
1175 (let ((e (read-event
1176 (concat "Press mouse-1 at the top-left corner and "
1177 "drag it to the bottom-right corner!"))))
1178 (when (eq (car e) 'drag-mouse-1)
1179 (setq x (car (posn-object-x-y (event-start e))))
1180 (setq y (cdr (posn-object-x-y (event-start e))))
1181 (setq w (- (car (posn-object-x-y (event-end e))) x))
1182 (setq h (- (cdr (posn-object-x-y (event-end e))) y))
1183 (setq done t))))
1184 (doc-view-set-slice x y w h)))
1186 (defun doc-view-get-bounding-box ()
1187 "Get the BoundingBox information of the current page."
1188 (let* ((page (doc-view-current-page))
1189 (doc (let ((cache-doc (doc-view-current-cache-doc-pdf)))
1190 (if (file-exists-p cache-doc)
1191 cache-doc
1192 doc-view--buffer-file-name)))
1193 (o (shell-command-to-string
1194 (concat doc-view-ghostscript-program
1195 " -dSAFER -dBATCH -dNOPAUSE -q -sDEVICE=bbox "
1196 (format "-dFirstPage=%s -dLastPage=%s %s"
1197 page page doc)))))
1198 (save-match-data
1199 (when (string-match (concat "%%BoundingBox: "
1200 "\\([[:digit:]]+\\) \\([[:digit:]]+\\) "
1201 "\\([[:digit:]]+\\) \\([[:digit:]]+\\)") o)
1202 (mapcar #'string-to-number
1203 (list (match-string 1 o)
1204 (match-string 2 o)
1205 (match-string 3 o)
1206 (match-string 4 o)))))))
1208 (defvar doc-view-paper-sizes
1209 '((a4 595 842)
1210 (a4-landscape 842 595)
1211 (letter 612 792)
1212 (letter-landscape 792 612)
1213 (legal 612 1008)
1214 (legal-landscape 1008 612)
1215 (a3 842 1191)
1216 (a3-landscape 1191 842)
1217 (tabloid 792 1224)
1218 (ledger 1224 792))
1219 "An alist from paper size names to dimensions.")
1221 (defun doc-view-guess-paper-size (iw ih)
1222 "Guess the paper size according to the aspect ratio."
1223 (cl-labels ((div (x y)
1224 (round (/ (* 100.0 x) y))))
1225 (let ((ar (div iw ih))
1226 (al (mapcar (lambda (l)
1227 (list (div (nth 1 l) (nth 2 l)) (car l)))
1228 doc-view-paper-sizes)))
1229 (cadr (assoc ar al)))))
1231 (defun doc-view-scale-bounding-box (ps iw ih bb)
1232 (list (/ (* (nth 0 bb) iw) (nth 1 (assoc ps doc-view-paper-sizes)))
1233 (/ (* (nth 1 bb) ih) (nth 2 (assoc ps doc-view-paper-sizes)))
1234 (/ (* (nth 2 bb) iw) (nth 1 (assoc ps doc-view-paper-sizes)))
1235 (/ (* (nth 3 bb) ih) (nth 2 (assoc ps doc-view-paper-sizes)))))
1237 (defun doc-view-set-slice-from-bounding-box (&optional force-paper-size)
1238 "Set the slice from the document's BoundingBox information.
1239 The result is that the margins are almost completely cropped,
1240 much more accurate than could be done manually using
1241 `doc-view-set-slice-using-mouse'."
1242 (interactive "P")
1243 (let ((bb (doc-view-get-bounding-box)))
1244 (if (not bb)
1245 (message "BoundingBox couldn't be determined")
1246 (let* ((is (image-size (doc-view-current-image) t))
1247 (iw (car is))
1248 (ih (cdr is))
1249 (ps (or (and (null force-paper-size)
1250 (doc-view-guess-paper-size iw ih))
1251 (intern (completing-read "Paper size: "
1252 doc-view-paper-sizes
1253 nil t))))
1254 (bb (doc-view-scale-bounding-box ps iw ih bb))
1255 (x1 (nth 0 bb))
1256 (y1 (nth 1 bb))
1257 (x2 (nth 2 bb))
1258 (y2 (nth 3 bb)))
1259 ;; We keep a 2 pixel margin.
1260 (doc-view-set-slice (- x1 2) (- ih y2 2)
1261 (+ (- x2 x1) 4) (+ (- y2 y1) 4))))))
1263 (defun doc-view-reset-slice ()
1264 "Reset the current slice.
1265 After calling this function whole pages will be visible again."
1266 (interactive)
1267 (setf (doc-view-current-slice) nil)
1268 ;; Redisplay
1269 (doc-view-goto-page (doc-view-current-page)))
1271 ;;;; Display
1273 (defun doc-view-insert-image (file &rest args)
1274 "Insert the given png FILE.
1275 ARGS is a list of image descriptors."
1276 (when doc-view--pending-cache-flush
1277 (clear-image-cache)
1278 (setq doc-view--pending-cache-flush nil))
1279 (let ((ol (doc-view-current-overlay)))
1280 ;; Only insert the image if the buffer is visible.
1281 (when (window-live-p (overlay-get ol 'window))
1282 (let* ((image (if (and file (file-readable-p file))
1283 (if (not (and doc-view-scale-internally
1284 (fboundp 'imagemagick-types)))
1285 (apply 'create-image file doc-view--image-type nil args)
1286 (unless (member :width args)
1287 (setq args `(,@args :width ,doc-view-image-width)))
1288 (apply 'create-image file 'imagemagick nil args))))
1289 (slice (doc-view-current-slice))
1290 (img-width (and image (car (image-size image))))
1291 (displayed-img-width (if (and image slice)
1292 (* (/ (float (nth 2 slice))
1293 (car (image-size image 'pixels)))
1294 img-width)
1295 img-width))
1296 (window-width (window-width)))
1297 (setf (doc-view-current-image) image)
1298 (move-overlay ol (point-min) (point-max))
1299 ;; In case the window is wider than the image, center the image
1300 ;; horizontally.
1301 (overlay-put ol 'before-string
1302 (when (and image (> window-width displayed-img-width))
1303 (propertize " " 'display
1304 `(space :align-to (+ center (-0.5 . ,displayed-img-width))))))
1305 (overlay-put ol 'display
1306 (cond
1307 (image
1308 (if slice
1309 (list (cons 'slice slice) image)
1310 image))
1311 ;; We're trying to display a page that doesn't exist.
1312 (doc-view--current-converter-processes
1313 ;; Maybe the page doesn't exist *yet*.
1314 "Cannot display this page (yet)!")
1316 ;; Typically happens if the conversion process somehow
1317 ;; failed. Better not signal an error here because it
1318 ;; could prevent a subsequent reconversion from fixing
1319 ;; the problem.
1320 (concat "Cannot display this page!\n"
1321 "Maybe because of a conversion failure!"))))
1322 (let ((win (overlay-get ol 'window)))
1323 (if (stringp (overlay-get ol 'display))
1324 (progn ;Make sure the text is not scrolled out of view.
1325 (set-window-hscroll win 0)
1326 (set-window-vscroll win 0))
1327 (let ((hscroll (image-mode-window-get 'hscroll win))
1328 (vscroll (image-mode-window-get 'vscroll win)))
1329 ;; Reset scroll settings, in case they were changed.
1330 (if hscroll (set-window-hscroll win hscroll))
1331 (if vscroll (set-window-vscroll win vscroll)))))))))
1333 (defun doc-view-sort (a b)
1334 "Return non-nil if A should be sorted before B.
1335 Predicate for sorting `doc-view--current-files'."
1336 (or (< (length a) (length b))
1337 (and (= (length a) (length b))
1338 (string< a b))))
1340 (defun doc-view-display (buffer &optional force)
1341 "Start viewing the document in BUFFER.
1342 If FORCE is non-nil, start viewing even if the document does not
1343 have the page we want to view."
1344 (with-current-buffer buffer
1345 (let ((prev-pages doc-view--current-files))
1346 (setq doc-view--current-files
1347 (sort (directory-files (doc-view--current-cache-dir) t
1348 (format doc-view--image-file-pattern
1349 "[0-9]+")
1351 'doc-view-sort))
1352 (unless (eq (length prev-pages) (length doc-view--current-files))
1353 (force-mode-line-update))
1354 (dolist (win (or (get-buffer-window-list buffer nil t)
1355 (list t)))
1356 (let* ((page (doc-view-current-page win))
1357 (pagefile (expand-file-name
1358 (format doc-view--image-file-pattern page)
1359 (doc-view--current-cache-dir))))
1360 (when (or force
1361 (and (not (member pagefile prev-pages))
1362 (member pagefile doc-view--current-files)))
1363 (if (windowp win)
1364 (with-selected-window win
1365 (cl-assert (eq (current-buffer) buffer) t)
1366 (doc-view-goto-page page))
1367 (doc-view-goto-page page))))))))
1369 (defun doc-view-buffer-message ()
1370 ;; Only show this message initially, not when refreshing the buffer (in which
1371 ;; case it's better to keep displaying the "stale" page while computing
1372 ;; the fresh new ones).
1373 (unless (overlay-get (doc-view-current-overlay) 'display)
1374 (overlay-put (doc-view-current-overlay) 'display
1375 (concat (propertize "Welcome to DocView!" 'face 'bold)
1376 "\n"
1378 If you see this buffer it means that the document you want to view is being
1379 converted to PNG and the conversion of the first page hasn't finished yet or
1380 `doc-view-conversion-refresh-interval' is set to nil.
1382 For now these keys are useful:
1384 `q' : Bury this buffer. Conversion will go on in background.
1385 `k' : Kill the conversion process and this buffer.
1386 `K' : Kill the conversion process.\n"))))
1388 (declare-function tooltip-show "tooltip" (text &optional use-echo-area))
1390 (defun doc-view-show-tooltip ()
1391 (interactive)
1392 (tooltip-show (doc-view-current-info)))
1394 (defun doc-view-open-text ()
1395 "Display the current doc's contents as text."
1396 (interactive)
1397 (if doc-view--current-converter-processes
1398 (message "DocView: please wait till conversion finished.")
1399 (let ((txt (expand-file-name "doc.txt" (doc-view--current-cache-dir))))
1400 (if (file-readable-p txt)
1401 (let ((inhibit-read-only t)
1402 (buffer-undo-list t)
1403 (dv-bfn doc-view--buffer-file-name))
1404 (erase-buffer)
1405 (set-buffer-multibyte t)
1406 (insert-file-contents txt)
1407 (text-mode)
1408 (setq-local doc-view--buffer-file-name dv-bfn)
1409 (set-buffer-modified-p nil)
1410 (doc-view-minor-mode)
1411 (add-hook 'write-file-functions
1412 (lambda ()
1413 (when (eq major-mode 'text-mode)
1414 (error "Cannot save text contents of document %s"
1415 buffer-file-name)))
1416 nil t))
1417 (doc-view-doc->txt txt 'doc-view-open-text)))))
1419 ;;;;; Toggle between editing and viewing
1421 (defvar-local doc-view-saved-settings nil
1422 "Doc-view settings saved while in some other mode.")
1423 (put 'doc-view-saved-settings 'permanent-local t)
1425 (defun doc-view-toggle-display ()
1426 "Toggle between editing a document as text or viewing it."
1427 (interactive)
1428 (cond
1429 ((eq major-mode 'doc-view-mode)
1430 ;; Switch to editing mode
1431 (doc-view-kill-proc)
1432 (setq buffer-read-only nil)
1433 ;; Switch to the previously used major mode or fall back to
1434 ;; normal mode.
1435 (doc-view-fallback-mode)
1436 (doc-view-minor-mode 1))
1437 ((eq major-mode 'text-mode)
1438 (let ((buffer-undo-list t))
1439 ;; We're currently viewing the document's text contents, so switch
1440 ;; back to .
1441 (setq buffer-read-only nil)
1442 (insert-file-contents doc-view--buffer-file-name nil nil nil t)
1443 (doc-view-fallback-mode)
1444 (doc-view-minor-mode 1)
1445 (set-buffer-modified-p nil)))
1447 ;; Switch to doc-view-mode
1448 (when (and (buffer-modified-p)
1449 (y-or-n-p "The buffer has been modified. Save the changes? "))
1450 (save-buffer))
1451 (doc-view-mode))))
1453 ;;;; Searching
1456 (defun doc-view-search-internal (regexp file)
1457 "Return a list of FILE's pages that contain text matching REGEXP.
1458 The value is an alist of the form (PAGE CONTEXTS) where PAGE is
1459 the pagenumber and CONTEXTS are all lines of text containing a match."
1460 (with-temp-buffer
1461 (insert-file-contents file)
1462 (let ((page 1)
1463 (lastpage 1)
1464 matches)
1465 (while (re-search-forward (concat "\\(?:\\([\f]\\)\\|\\("
1466 regexp "\\)\\)") nil t)
1467 (when (match-string 1) (setq page (1+ page)))
1468 (when (match-string 2)
1469 (if (/= page lastpage)
1470 (push (cons page
1471 (list (buffer-substring
1472 (line-beginning-position)
1473 (line-end-position))))
1474 matches)
1475 (setq matches (cons
1476 (append
1478 ;; This page already is a match.
1479 (car matches)
1480 ;; This is the first match on page.
1481 (list page))
1482 (list (buffer-substring
1483 (line-beginning-position)
1484 (line-end-position))))
1485 (cdr matches))))
1486 (setq lastpage page)))
1487 (nreverse matches))))
1489 (defun doc-view-search-no-of-matches (list)
1490 "Extract the number of matches from the search result LIST."
1491 (let ((no 0))
1492 (dolist (p list)
1493 (setq no (+ no (1- (length p)))))
1494 no))
1496 (defun doc-view-search-backward (new-query)
1497 "Call `doc-view-search' for backward search.
1498 If prefix NEW-QUERY is given, ask for a new regexp."
1499 (interactive "P")
1500 (doc-view-search new-query t))
1502 (defun doc-view-search (new-query &optional backward)
1503 "Jump to the next match or initiate a new search if NEW-QUERY is given.
1504 If the current document hasn't been transformed to plain text
1505 till now do that first.
1506 If BACKWARD is non-nil, jump to the previous match."
1507 (interactive "P")
1508 (if (and (not new-query)
1509 doc-view--current-search-matches)
1510 (if backward
1511 (doc-view-search-previous-match 1)
1512 (doc-view-search-next-match 1))
1513 ;; New search, so forget the old results.
1514 (setq doc-view--current-search-matches nil)
1515 (let ((txt (expand-file-name "doc.txt"
1516 (doc-view--current-cache-dir))))
1517 (if (file-readable-p txt)
1518 (progn
1519 (setq doc-view--current-search-matches
1520 (doc-view-search-internal
1521 (read-from-minibuffer "Regexp: ")
1522 txt))
1523 (message "DocView: search yielded %d matches."
1524 (doc-view-search-no-of-matches
1525 doc-view--current-search-matches)))
1526 ;; We must convert to TXT first!
1527 (if doc-view--current-converter-processes
1528 (message "DocView: please wait till conversion finished.")
1529 (doc-view-doc->txt txt (lambda () (doc-view-search nil))))))))
1531 (defun doc-view-search-next-match (arg)
1532 "Go to the ARGth next matching page."
1533 (interactive "p")
1534 (let* ((next-pages (cl-remove-if
1535 (lambda (i) (<= (car i) (doc-view-current-page)))
1536 doc-view--current-search-matches))
1537 (page (car (nth (1- arg) next-pages))))
1538 (if page
1539 (doc-view-goto-page page)
1540 (when (and
1541 doc-view--current-search-matches
1542 (y-or-n-p "No more matches after current page. Wrap to first match? "))
1543 (doc-view-goto-page (caar doc-view--current-search-matches))))))
1545 (defun doc-view-search-previous-match (arg)
1546 "Go to the ARGth previous matching page."
1547 (interactive "p")
1548 (let* ((prev-pages (cl-remove-if
1549 (lambda (i) (>= (car i) (doc-view-current-page)))
1550 doc-view--current-search-matches))
1551 (page (car (nth (1- arg) (nreverse prev-pages)))))
1552 (if page
1553 (doc-view-goto-page page)
1554 (when (and
1555 doc-view--current-search-matches
1556 (y-or-n-p "No more matches before current page. Wrap to last match? "))
1557 (doc-view-goto-page (caar (last doc-view--current-search-matches)))))))
1559 ;;;; User interface commands and the mode
1561 (put 'doc-view-mode 'mode-class 'special)
1563 (defun doc-view-already-converted-p ()
1564 "Return non-nil if the current doc was already converted."
1565 (and (file-exists-p (doc-view--current-cache-dir))
1566 ;; Check that the resolution info is there, otherwise it means
1567 ;; the conversion is incomplete.
1568 (file-readable-p (expand-file-name "resolution.el"
1569 (doc-view--current-cache-dir)))
1570 (> (length (directory-files
1571 (doc-view--current-cache-dir)
1572 nil (format doc-view--image-file-pattern "[0-9]+")))
1573 0)))
1575 (defun doc-view-initiate-display ()
1576 ;; Switch to image display if possible.
1577 (if (doc-view-mode-p doc-view-doc-type)
1578 (progn
1579 (doc-view-buffer-message)
1580 (setf (doc-view-current-page) (or (doc-view-current-page) 1))
1581 (if (doc-view-already-converted-p)
1582 (progn
1583 (message "DocView: using cached files!")
1584 ;; Load the saved resolution.
1585 (let* ((res-file
1586 (expand-file-name "resolution.el"
1587 (doc-view--current-cache-dir)))
1588 (res
1589 (with-temp-buffer
1590 (when (file-readable-p res-file)
1591 (insert-file-contents res-file)
1592 (read (current-buffer))))))
1593 (when (numberp res)
1594 (setq-local doc-view-resolution res)))
1595 (doc-view-display (current-buffer) 'force))
1596 (doc-view-convert-current-doc))
1597 (message
1598 "%s"
1599 (substitute-command-keys
1600 (concat "Type \\[doc-view-toggle-display] to toggle between "
1601 "editing or viewing the document."))))
1602 (message
1603 "%s"
1604 (concat "No PNG support is available, or some conversion utility for "
1605 (file-name-extension doc-view--buffer-file-name)
1606 " files is missing."))
1607 (if (and (executable-find doc-view-pdftotext-program)
1608 (y-or-n-p
1609 "Unable to render file. View extracted text instead? "))
1610 (doc-view-open-text)
1611 (doc-view-toggle-display))))
1613 (defvar bookmark-make-record-function)
1615 (defun doc-view-clone-buffer-hook ()
1616 ;; FIXME: There are several potential problems linked with reconversion
1617 ;; and auto-revert when we have indirect buffers because they share their
1618 ;; /tmp cache directory. This sharing is good (you'd rather not reconvert
1619 ;; for each clone), but that means that clones need to collaborate a bit.
1620 ;; I guess it mostly means: detect when a reconversion process is already
1621 ;; running, and run the sentinel in all clones.
1623 ;; Maybe the clones should really have a separate /tmp directory
1624 ;; so they could have a different resolution and you could use clones
1625 ;; for zooming.
1626 (remove-overlays (point-min) (point-max) 'doc-view t)
1627 (if (consp image-mode-winprops-alist) (setq image-mode-winprops-alist nil)))
1629 (defun doc-view-intersection (l1 l2)
1630 (let ((l ()))
1631 (dolist (x l1) (if (memq x l2) (push x l)))
1634 (defun doc-view-set-doc-type ()
1635 "Figure out the current document type (`doc-view-doc-type')."
1636 (let ((name-types
1637 (when buffer-file-name
1638 (cdr (assoc-string
1639 (file-name-extension buffer-file-name)
1641 ;; DVI
1642 ("dvi" dvi)
1643 ;; PDF
1644 ("pdf" pdf) ("epdf" pdf)
1645 ;; PostScript
1646 ("ps" ps) ("eps" ps)
1647 ;; DjVu
1648 ("djvu" djvu)
1649 ;; OpenDocument formats.
1650 ("odt" odf) ("ods" odf) ("odp" odf) ("odg" odf)
1651 ("odc" odf) ("odi" odf) ("odm" odf) ("ott" odf)
1652 ("ots" odf) ("otp" odf) ("otg" odf)
1653 ;; Microsoft Office formats (also handled by the odf
1654 ;; conversion chain).
1655 ("doc" odf) ("docx" odf) ("xls" odf) ("xlsx" odf)
1656 ("ppt" odf) ("pps" odf) ("pptx" odf))
1657 t))))
1658 (content-types
1659 (save-excursion
1660 (goto-char (point-min))
1661 (cond
1662 ((looking-at "%!") '(ps))
1663 ((looking-at "%PDF") '(pdf))
1664 ((looking-at "\367\002") '(dvi))
1665 ((looking-at "AT&TFORM") '(djvu))))))
1666 (setq-local
1667 doc-view-doc-type
1668 (car (or (doc-view-intersection name-types content-types)
1669 (when (and name-types content-types)
1670 (error "Conflicting types: name says %s but content says %s"
1671 name-types content-types))
1672 name-types content-types
1673 (error "Cannot determine the document type"))))))
1675 (defun doc-view-set-up-single-converter ()
1676 "Find the right single-page converter for the current document type"
1677 (pcase-let ((`(,conv-function ,type ,extension)
1678 (pcase doc-view-doc-type
1679 (`djvu (list #'doc-view-djvu->tiff-converter-ddjvu 'tiff "tif"))
1680 (_ (list doc-view-pdf->png-converter-function 'png "png")))))
1681 (setq-local doc-view-single-page-converter-function conv-function)
1682 (setq-local doc-view--image-type type)
1683 (setq-local doc-view--image-file-pattern (concat "page-%s." extension))))
1685 ;; desktop.el integration
1687 (defun doc-view-desktop-save-buffer (_desktop-dirname)
1688 ;; FIXME: This is wrong, since this info is per-window but we only do it once
1689 ;; here for the buffer. IOW it should be saved via something like
1690 ;; `window-persistent-parameters'.
1691 `((page . ,(doc-view-current-page))
1692 (slice . ,(doc-view-current-slice))))
1694 (declare-function desktop-restore-file-buffer "desktop"
1695 (buffer-filename buffer-name buffer-misc))
1697 (defun doc-view-restore-desktop-buffer (file name misc)
1698 (let ((page (cdr (assq 'page misc)))
1699 (slice (cdr (assq 'slice misc))))
1700 (desktop-restore-file-buffer file name misc)
1701 ;; FIXME: We need to run this code after displaying the buffer.
1702 (with-selected-window (or (get-buffer-window (current-buffer) 0)
1703 (selected-window))
1704 ;; FIXME: This should be done for all windows restored that show
1705 ;; this buffer. Basically, the page/slice should be saved as
1706 ;; window-parameters in the window-state(s) and then restoring this
1707 ;; window-state should call us back (to interpret/use those parameters).
1708 (doc-view-goto-page page)
1709 (when slice (apply 'doc-view-set-slice slice)))))
1711 (add-to-list 'desktop-buffer-mode-handlers
1712 '(doc-view-mode . doc-view-restore-desktop-buffer))
1714 ;;;###autoload
1715 (defun doc-view-mode ()
1716 "Major mode in DocView buffers.
1718 DocView Mode is an Emacs document viewer. It displays PDF, PS
1719 and DVI files (as PNG images) in Emacs buffers.
1721 You can use \\<doc-view-mode-map>\\[doc-view-toggle-display] to
1722 toggle between displaying the document or editing it as text.
1723 \\{doc-view-mode-map}"
1724 (interactive)
1726 (if (= (point-min) (point-max))
1727 ;; The doc is empty or doesn't exist at all, so fallback to
1728 ;; another mode. We used to also check file-exists-p, but this
1729 ;; returns nil for tar members.
1730 (doc-view-fallback-mode)
1732 (let* ((prev-major-mode (if (derived-mode-p 'doc-view-mode)
1733 doc-view--previous-major-mode
1734 (unless (eq major-mode 'fundamental-mode)
1735 major-mode))))
1736 (kill-all-local-variables)
1737 (setq-local doc-view--previous-major-mode prev-major-mode))
1739 (dolist (var doc-view-saved-settings)
1740 (set (make-local-variable (car var)) (cdr var)))
1742 ;; Figure out the document type.
1743 (unless doc-view-doc-type
1744 (doc-view-set-doc-type))
1745 (doc-view-set-up-single-converter)
1747 (doc-view-make-safe-dir doc-view-cache-directory)
1748 ;; Handle compressed files, remote files, files inside archives
1749 (setq-local doc-view--buffer-file-name
1750 (cond
1751 (jka-compr-really-do-compress
1752 ;; FIXME: there's a risk of name conflicts here.
1753 (expand-file-name
1754 (file-name-nondirectory
1755 (file-name-sans-extension buffer-file-name))
1756 doc-view-cache-directory))
1757 ;; Is the file readable by local processes?
1758 ;; We used to use `file-remote-p' but it's unclear what it's
1759 ;; supposed to return nil for things like local files accessed
1760 ;; via `su' or via file://...
1761 ((let ((file-name-handler-alist nil))
1762 (not (and buffer-file-name
1763 (file-readable-p buffer-file-name))))
1764 ;; FIXME: there's a risk of name conflicts here.
1765 (expand-file-name
1766 (if buffer-file-name
1767 (file-name-nondirectory buffer-file-name)
1768 (buffer-name))
1769 doc-view-cache-directory))
1770 (t buffer-file-name)))
1771 (when (not (string= doc-view--buffer-file-name buffer-file-name))
1772 (write-region nil nil doc-view--buffer-file-name))
1774 (add-hook 'change-major-mode-hook
1775 (lambda ()
1776 (doc-view-kill-proc)
1777 (remove-overlays (point-min) (point-max) 'doc-view t))
1778 nil t)
1779 (add-hook 'clone-indirect-buffer-hook 'doc-view-clone-buffer-hook nil t)
1780 (add-hook 'kill-buffer-hook 'doc-view-kill-proc nil t)
1781 (when (and (boundp 'desktop-save-mode)
1782 desktop-save-mode)
1783 (setq-local desktop-save-buffer 'doc-view-desktop-save-buffer))
1785 (remove-overlays (point-min) (point-max) 'doc-view t) ;Just in case.
1786 ;; Keep track of display info ([vh]scroll, page number, overlay,
1787 ;; ...) for each window in which this document is shown.
1788 (add-hook 'image-mode-new-window-functions
1789 'doc-view-new-window-function nil t)
1790 (image-mode-setup-winprops)
1792 (setq-local mode-line-position
1793 '(" P" (:eval (number-to-string (doc-view-current-page)))
1794 "/" (:eval (number-to-string (doc-view-last-page-number)))))
1795 ;; Don't scroll unless the user specifically asked for it.
1796 (setq-local auto-hscroll-mode nil)
1797 (if (boundp 'mwheel-scroll-up-function) ; not --without-x build
1798 (setq-local mwheel-scroll-up-function
1799 #'doc-view-scroll-up-or-next-page))
1800 (if (boundp 'mwheel-scroll-down-function)
1801 (setq-local mwheel-scroll-down-function
1802 #'doc-view-scroll-down-or-previous-page))
1803 (setq-local cursor-type nil)
1804 (use-local-map doc-view-mode-map)
1805 (add-hook 'after-revert-hook 'doc-view-reconvert-doc nil t)
1806 (setq-local bookmark-make-record-function
1807 #'doc-view-bookmark-make-record)
1808 (setq mode-name "DocView"
1809 buffer-read-only t
1810 major-mode 'doc-view-mode)
1811 (doc-view-initiate-display)
1812 ;; Switch off view-mode explicitly, because doc-view-mode is the
1813 ;; canonical view mode for PDF/PS/DVI files. This could be
1814 ;; switched on automatically depending on the value of
1815 ;; `view-read-only'.
1816 (setq-local view-read-only nil)
1817 (run-mode-hooks 'doc-view-mode-hook)))
1819 (defun doc-view-fallback-mode ()
1820 "Fallback to the previous or next best major mode."
1821 (let ((vars (if (derived-mode-p 'doc-view-mode)
1822 (mapcar (lambda (var) (cons var (symbol-value var)))
1823 '(doc-view-resolution
1824 image-mode-winprops-alist)))))
1825 (remove-overlays (point-min) (point-max) 'doc-view t)
1826 (if doc-view--previous-major-mode
1827 (funcall doc-view--previous-major-mode)
1828 (let ((auto-mode-alist
1829 (rassq-delete-all
1830 'doc-view-mode-maybe
1831 (rassq-delete-all 'doc-view-mode
1832 (copy-alist auto-mode-alist)))))
1833 (normal-mode)))
1834 (when vars
1835 (setq-local doc-view-saved-settings vars))))
1837 ;;;###autoload
1838 (defun doc-view-mode-maybe ()
1839 "Switch to `doc-view-mode' if possible.
1840 If the required external tools are not available, then fallback
1841 to the next best mode."
1842 (condition-case nil
1843 (doc-view-set-doc-type)
1844 (error (doc-view-fallback-mode)))
1845 (if (doc-view-mode-p doc-view-doc-type)
1846 (doc-view-mode)
1847 (doc-view-fallback-mode)))
1849 ;;;###autoload
1850 (define-minor-mode doc-view-minor-mode
1851 "Toggle displaying buffer via Doc View (Doc View minor mode).
1852 With a prefix argument ARG, enable Doc View minor mode if ARG is
1853 positive, and disable it otherwise. If called from Lisp, enable
1854 the mode if ARG is omitted or nil.
1856 See the command `doc-view-mode' for more information on this mode."
1857 nil " DocView" doc-view-minor-mode-map
1858 :group 'doc-view
1859 (when doc-view-minor-mode
1860 (add-hook 'change-major-mode-hook (lambda () (doc-view-minor-mode -1)) nil t)
1861 (message
1862 "%s"
1863 (substitute-command-keys
1864 "Type \\[doc-view-toggle-display] to toggle between editing or viewing the document."))))
1866 (defun doc-view-clear-cache ()
1867 "Delete the whole cache (`doc-view-cache-directory')."
1868 (interactive)
1869 (dired-delete-file doc-view-cache-directory 'always))
1871 (defun doc-view-dired-cache ()
1872 "Open `dired' in `doc-view-cache-directory'."
1873 (interactive)
1874 (dired doc-view-cache-directory))
1877 ;;;; Bookmark integration
1879 (declare-function bookmark-make-record-default
1880 "bookmark" (&optional no-file no-context posn))
1881 (declare-function bookmark-prop-get "bookmark" (bookmark prop))
1882 (declare-function bookmark-default-handler "bookmark" (bmk))
1884 (defun doc-view-bookmark-make-record ()
1885 (nconc (bookmark-make-record-default)
1886 `((page . ,(doc-view-current-page))
1887 (handler . doc-view-bookmark-jump))))
1889 ;;;###autoload
1890 (defun doc-view-bookmark-jump (bmk)
1891 ;; This implements the `handler' function interface for record type
1892 ;; returned by `doc-view-bookmark-make-record', which see.
1893 (let ((page (bookmark-prop-get bmk 'page))
1894 (show-fn-sym (make-symbol "doc-view-bookmark-after-jump-hook")))
1895 (fset show-fn-sym
1896 (lambda ()
1897 (remove-hook 'bookmark-after-jump-hook show-fn-sym)
1898 (when (not (eq major-mode 'doc-view-mode))
1899 (doc-view-toggle-display))
1900 (with-selected-window
1901 (or (get-buffer-window (current-buffer) 0)
1902 (selected-window))
1903 (doc-view-goto-page page))))
1904 (add-hook 'bookmark-after-jump-hook show-fn-sym)
1905 (bookmark-default-handler bmk)))
1907 (provide 'doc-view)
1909 ;; Local Variables:
1910 ;; eval: (outline-minor-mode 1)
1911 ;; End:
1913 ;;; doc-view.el ends here