1 ;;; doc-view.el --- View PDF/PostScript/DVI files in Emacs -*- lexical-binding: t -*-
4 ;; Copyright (C) 2007-2013 Free Software Foundation, Inc.
6 ;; Author: Tassilo Horn <tsdh@gnu.org>
7 ;; Maintainer: Tassilo Horn <tsdh@gnu.org>
8 ;; Keywords: files, pdf, ps, dvi
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; doc-view.el requires GNU Emacs 22.1 or newer. You also need Ghostscript,
28 ;; `dvipdf' (comes with Ghostscript) or `dvipdfm' (comes with teTeX or TeXLive)
29 ;; and `pdftotext', which comes with xpdf (http://www.foolabs.com/xpdf/) or
30 ;; poppler (http://poppler.freedesktop.org/).
34 ;; DocView is a document viewer for Emacs. It converts PDF, PS and DVI files
35 ;; to a set of PNG files, one PNG for each page, and displays the PNG images
36 ;; inside an Emacs buffer. This buffer uses `doc-view-mode' which provides
37 ;; convenient key bindings for browsing the document.
39 ;; To use it simply open a document file with
41 ;; C-x C-f ~/path/to/document RET
43 ;; and the document will be converted and displayed, if your emacs supports png
44 ;; images. With `C-c C-c' you can toggle between the rendered images
45 ;; representation and the source text representation of the document.
47 ;; Since conversion may take some time all the PNG images are cached in a
48 ;; subdirectory of `doc-view-cache-directory' and reused when you want to view
49 ;; that file again. To reconvert a document hit `g' (`doc-view-reconvert-doc')
50 ;; when displaying the document. To delete all cached files use
51 ;; `doc-view-clear-cache'. To open the cache with dired, so that you can tidy
52 ;; it out use `doc-view-dired-cache'.
54 ;; When conversion in underway the first page will be displayed as soon as it
55 ;; is available and the available pages are refreshed every
56 ;; `doc-view-conversion-refresh-interval' seconds. If that variable is nil the
57 ;; pages won't be displayed before conversion of the document finished
60 ;; DocView lets you select a slice of the displayed pages. This slice
61 ;; will be remembered and applied to all pages of the current
62 ;; document. This enables you to cut away the margins of a document
63 ;; to save some space. To select a slice you can use
64 ;; `doc-view-set-slice' (bound to `s s') which will query you for the
65 ;; coordinates of the slice's top-left corner and its width and
66 ;; height. A much more convenient way to do the same is offered by
67 ;; the command `doc-view-set-slice-using-mouse' (bound to `s m').
68 ;; After invocation you only have to press mouse-1 at the top-left
69 ;; corner and drag it to the bottom-right corner of the desired slice.
70 ;; Even more accurate and convenient is to use
71 ;; `doc-view-set-slice-from-bounding-box' (bound to `s b') which uses
72 ;; the BoundingBox information of the current page to set an optimal
73 ;; slice. To reset the slice use `doc-view-reset-slice' (bound to `s
76 ;; You can also search within the document. The command `doc-view-search'
77 ;; (bound to `C-s') queries for a search regexp and initializes a list of all
78 ;; matching pages and messages how many match-pages were found. After that you
79 ;; can jump to the next page containing a match with an additional `C-s'. With
80 ;; `C-r' you can do the same, but backwards. To search for a new regexp give a
81 ;; prefix arg to one of the search functions, e.g. by typing `C-u C-s'. The
82 ;; searching works by using a plain text representation of the document. If
83 ;; that doesn't already exist the first invocation of `doc-view-search' (or
84 ;; `doc-view-search-backward') starts the conversion. When that finishes and
85 ;; you're still viewing the document (i.e. you didn't switch to another buffer)
86 ;; you're queried for the regexp then.
88 ;; Dired users can simply hit `v' on a document file. If it's a PS, PDF or DVI
89 ;; it will be opened using `doc-view-mode'.
94 ;; If the images are too small or too big you should set the "-rXXX" option in
95 ;; `doc-view-ghostscript-options' to another value. (The bigger your screen,
96 ;; the higher the value.)
98 ;; This and all other options can be set with the customization interface.
101 ;; M-x customize-group RET doc-view RET
103 ;; and modify them to your needs.
107 ;; - add print command.
108 ;; - share more code with image-mode.
110 ;; - Bind slicing to a drag event.
111 ;; - zoom the region around the cursor (like xdvi).
112 ;; - get rid of the silly arrow in the fringe.
113 ;; - improve anti-aliasing (pdf-utils gets it better).
115 ;;;; About isearch support
117 ;; I tried implementing isearch by setting
118 ;; `isearch-search-fun-function' buffer-locally, but that didn't
119 ;; work too good. The function doing the real search was called
120 ;; endlessly somehow. But even if we'd get that working no real
121 ;; isearch feeling comes up due to the missing match highlighting.
122 ;; Currently I display all lines containing a match in a tooltip and
123 ;; each C-s or C-r jumps directly to the next/previous page with a
124 ;; match. With isearch we could only display the current match. So
125 ;; we had to decide if another C-s jumps to the next page with a
126 ;; match (thus only the first match in a page will be displayed in a
127 ;; tooltip) or to the next match, which would do nothing visible
128 ;; (except the tooltip) if the next match is on the same page.
130 ;; And it's much slower than the current search facility, because
131 ;; isearch really searches for each step forward or backward whereas
132 ;; the current approach searches once and then it knows to which
135 ;; Anyway, if someone with better isearch knowledge wants to give it a try,
136 ;; feel free to do it. --Tassilo
140 (eval-when-compile (require 'cl-lib
))
142 (require 'image-mode
)
145 ;;;; Customization Options
147 (defgroup doc-view nil
148 "In-buffer viewer for PDF, PostScript, DVI, and DJVU files."
149 :link
'(function-link doc-view
)
156 (defcustom doc-view-ghostscript-program
"gs"
157 "Program to convert PS and PDF files to PNG."
161 (defcustom doc-view-pdfdraw-program
163 ((executable-find "pdfdraw") "pdfdraw")
165 "Name of MuPDF's program to convert PDF files to PNG."
169 (defcustom doc-view-pdf-
>png-converter-function
170 (if (executable-find doc-view-pdfdraw-program
)
171 #'doc-view-pdf-
>png-converter-mupdf
172 #'doc-view-pdf-
>png-converter-ghostscript
)
173 "Function to call to convert a PDF file into a PNG file."
175 (function-item doc-view-pdf-
>png-converter-ghostscript
176 :doc
"Use ghostscript")
177 (function-item doc-view-pdf-
>png-converter-mupdf
182 (defcustom doc-view-ghostscript-options
183 '("-dSAFER" ;; Avoid security problems when rendering files from untrusted
185 "-dNOPAUSE" "-sDEVICE=png16m" "-dTextAlphaBits=4"
186 "-dBATCH" "-dGraphicsAlphaBits=4" "-dQUIET")
187 "A list of options to give to ghostscript."
188 :type
'(repeat string
)
191 (defcustom doc-view-resolution
100
192 "Dots per inch resolution used to render the documents.
193 Higher values result in larger images."
197 (defcustom doc-view-scale-internally t
198 "Whether we should try to rescale images ourselves.
199 If nil, the document is re-rendered every time the scaling factor is modified.
200 This only has an effect if the image libraries linked with Emacs support
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."
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
218 If this and `doc-view-dvipdf-program' are set,
219 `doc-view-dvipdf-program' will be preferred."
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
229 If this and `doc-view-dvipdfm-program' are set,
230 `doc-view-dvipdf-program' will be preferred."
234 (define-obsolete-variable-alias 'doc-view-unoconv-program
235 'doc-view-odf-
>pdf-converter-program
238 (defcustom doc-view-odf-
>pdf-converter-program
240 ((executable-find "soffice") "soffice")
241 ((executable-find "unoconv") "unoconv")
243 "Program to convert any file type readable by OpenOffice.org to PDF.
245 Needed for viewing OpenOffice.org (and MS Office) files."
250 (defcustom doc-view-odf-
>pdf-converter-function
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."
258 (function-item doc-view-odf-
>pdf-converter-unoconv
260 (function-item doc-view-odf-
>pdf-converter-soffice
261 :doc
"Use LibreOffice")
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."
272 (defcustom doc-view-pdftotext-program
"pdftotext"
273 "Program to convert PDF files to plain text.
275 Needed for searching."
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."
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
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."
307 ;;;; Internal Variables
309 (defun doc-view-new-window-function (winprops)
310 ;; (message "New window %s for buf %s" (car winprops) (current-buffer))
311 (cl-assert (or (eq t
(car winprops
))
312 (eq (window-buffer (car winprops
)) (current-buffer))))
313 (let ((ol (image-mode-window-get 'overlay winprops
)))
316 (setq ol
(copy-overlay ol
))
317 ;; `ol' might actually be dead.
318 (move-overlay ol
(point-min) (point-max)))
319 (setq ol
(make-overlay (point-min) (point-max) nil t
))
320 (overlay-put ol
'doc-view t
))
321 (overlay-put ol
'window
(car winprops
))
322 (unless (windowp (car winprops
))
323 ;; It's a pseudo entry. Let's make sure it's not displayed (the
324 ;; `window' property is only effective if its value is a window).
325 (cl-assert (eq t
(car winprops
)))
327 (image-mode-window-put 'overlay ol winprops
)))
329 (defvar doc-view-current-files nil
330 "Only used internally.")
331 (make-variable-buffer-local 'doc-view-current-files
)
333 (defvar doc-view-current-converter-processes nil
334 "Only used internally.")
335 (make-variable-buffer-local 'doc-view-current-converter-processes
)
337 (defvar doc-view-current-timer nil
338 "Only used internally.")
339 (make-variable-buffer-local 'doc-view-current-timer
)
341 (defvar doc-view-current-cache-dir nil
342 "Only used internally.")
343 (make-variable-buffer-local 'doc-view-current-cache-dir
)
345 (defvar doc-view-current-search-matches nil
346 "Only used internally.")
347 (make-variable-buffer-local 'doc-view-current-search-matches
)
349 (defvar doc-view-pending-cache-flush nil
350 "Only used internally.")
352 (defvar doc-view-previous-major-mode nil
353 "Only used internally.")
355 (defvar doc-view-buffer-file-name nil
356 "Only used internally.
357 The file name used for conversion. Normally it's the same as
358 `buffer-file-name', but for remote files, compressed files and
359 files inside an archive it is a temporary copy of
360 the (uncompressed, extracted) file residing in
361 `doc-view-cache-directory'.")
363 (defvar doc-view-doc-type nil
364 "The type of document in the current buffer.
365 Can be `dvi', `pdf', or `ps'.")
367 (defvar doc-view-single-page-converter-function nil
368 "Function to call to convert a single page of the document to a bitmap file.
369 May operate on the source document or on some intermediate (typically PDF)
372 (defvar-local doc-view--image-type nil
373 "The type of image in the current buffer.
374 Can be `png' or `tiff'.")
376 (defvar-local doc-view--image-file-pattern nil
377 "The `format' pattern of image file names.
378 Typically \"page-%s.png\".")
382 (defvar doc-view-mode-map
383 (let ((map (make-sparse-keymap)))
384 (set-keymap-parent map image-mode-map
)
385 ;; Navigation in the document
386 (define-key map
(kbd "n") 'doc-view-next-page
)
387 (define-key map
(kbd "p") 'doc-view-previous-page
)
388 (define-key map
(kbd "<next>") 'forward-page
)
389 (define-key map
(kbd "<prior>") 'backward-page
)
390 (define-key map
[remap forward-page
] 'doc-view-next-page
)
391 (define-key map
[remap backward-page
] 'doc-view-previous-page
)
392 (define-key map
(kbd "SPC") 'doc-view-scroll-up-or-next-page
)
393 (define-key map
(kbd "DEL") 'doc-view-scroll-down-or-previous-page
)
394 (define-key map
(kbd "C-n") 'doc-view-next-line-or-next-page
)
395 (define-key map
(kbd "<down>") 'doc-view-next-line-or-next-page
)
396 (define-key map
(kbd "C-p") 'doc-view-previous-line-or-previous-page
)
397 (define-key map
(kbd "<up>") 'doc-view-previous-line-or-previous-page
)
398 (define-key map
(kbd "M-<") 'doc-view-first-page
)
399 (define-key map
(kbd "M->") 'doc-view-last-page
)
400 (define-key map
[remap goto-line
] 'doc-view-goto-page
)
401 (define-key map
(kbd "RET") 'image-next-line
)
403 (define-key map
"+" 'doc-view-enlarge
)
404 (define-key map
"-" 'doc-view-shrink
)
405 ;; Fit the image to the window
406 (define-key map
"W" 'doc-view-fit-width-to-window
)
407 (define-key map
"H" 'doc-view-fit-height-to-window
)
408 (define-key map
"P" 'doc-view-fit-page-to-window
)
409 ;; Killing the buffer (and the process)
410 (define-key map
(kbd "k") 'doc-view-kill-proc-and-buffer
)
411 (define-key map
(kbd "K") 'doc-view-kill-proc
)
413 (define-key map
(kbd "s s") 'doc-view-set-slice
)
414 (define-key map
(kbd "s m") 'doc-view-set-slice-using-mouse
)
415 (define-key map
(kbd "s b") 'doc-view-set-slice-from-bounding-box
)
416 (define-key map
(kbd "s r") 'doc-view-reset-slice
)
418 (define-key map
(kbd "C-s") 'doc-view-search
)
419 (define-key map
(kbd "<find>") 'doc-view-search
)
420 (define-key map
(kbd "C-r") 'doc-view-search-backward
)
422 (define-key map
(kbd "C-t") 'doc-view-show-tooltip
)
423 ;; Toggle between text and image display or editing
424 (define-key map
(kbd "C-c C-c") 'doc-view-toggle-display
)
425 ;; Open a new buffer with doc's text contents
426 (define-key map
(kbd "C-c C-t") 'doc-view-open-text
)
427 ;; Reconvert the current document. Don't just use revert-buffer
428 ;; because that resets the scale factor, the page number, ...
429 (define-key map
(kbd "g") 'doc-view-revert-buffer
)
430 (define-key map
(kbd "r") 'doc-view-revert-buffer
)
432 "Keymap used by `doc-view-mode' when displaying a doc as a set of images.")
434 (defun doc-view-revert-buffer (&optional ignore-auto noconfirm
)
435 "Like `revert-buffer', but preserves the buffer's current modes."
436 ;; FIXME: this should probably be moved to files.el and used for
437 ;; most/all "g" bindings to revert-buffer.
438 (interactive (list (not current-prefix-arg
)))
439 (revert-buffer ignore-auto noconfirm
'preserve-modes
))
442 (easy-menu-define doc-view-menu doc-view-mode-map
443 "Menu for Doc View mode."
445 ["Toggle display" doc-view-toggle-display
]
447 ["Off" (setq doc-view-continuous nil
)
448 :style radio
:selected
(eq doc-view-continuous nil
)]
449 ["On" (setq doc-view-continuous t
)
450 :style radio
:selected
(eq doc-view-continuous t
)]
453 (customize-save-variable 'doc-view-continuous doc-view-continuous
) t
]
456 ["Set Slice" doc-view-set-slice-using-mouse
]
457 ["Set Slice (BoundingBox)" doc-view-set-slice-from-bounding-box
]
458 ["Set Slice (manual)" doc-view-set-slice
]
459 ["Reset Slice" doc-view-reset-slice
]
461 ["Search" doc-view-search
]
462 ["Search Backwards" doc-view-search-backward
]
465 (defvar doc-view-minor-mode-map
466 (let ((map (make-sparse-keymap)))
467 ;; Toggle between text and image display or editing
468 (define-key map
(kbd "C-c C-c") 'doc-view-toggle-display
)
470 "Keymap used by `doc-minor-view-mode'.")
472 ;;;; Navigation Commands
474 (defmacro doc-view-current-page
(&optional win
)
475 `(image-mode-window-get 'page
,win
))
476 (defmacro doc-view-current-info
() `(image-mode-window-get 'info
))
477 (defmacro doc-view-current-overlay
() `(image-mode-window-get 'overlay
))
478 (defmacro doc-view-current-image
() `(image-mode-window-get 'image
))
479 (defmacro doc-view-current-slice
() `(image-mode-window-get 'slice
))
481 (defun doc-view-last-page-number ()
482 (length doc-view-current-files
))
484 (defun doc-view-goto-page (page)
485 "View the page given by PAGE."
486 (interactive "nPage: ")
487 (let ((len (doc-view-last-page-number))
488 (hscroll (window-hscroll)))
491 (when (and (> page len
)
492 ;; As long as the converter is running, we don't know
493 ;; how many pages will be available.
494 (null doc-view-current-converter-processes
))
496 (setf (doc-view-current-page) page
497 (doc-view-current-info)
500 (format "Page %d of %d." page len
) 'face
'bold
)
501 ;; Tell user if converting isn't finished yet
502 (if doc-view-current-converter-processes
503 " (still converting...)\n"
505 ;; Display context infos if this page matches the last search
506 (when (and doc-view-current-search-matches
507 (assq page doc-view-current-search-matches
))
508 (concat (propertize "Search matches:\n" 'face
'bold
)
510 (dolist (m (cdr (assq page
511 doc-view-current-search-matches
)))
512 (setq contexts
(concat contexts
" - \"" m
"\"\n")))
515 ;; We used to find the file name from doc-view-current-files but
516 ;; that's not right if the pages are not generated sequentially
517 ;; or if the page isn't in doc-view-current-files yet.
518 (let ((file (expand-file-name
519 (format doc-view--image-file-pattern page
)
520 (doc-view-current-cache-dir))))
521 (doc-view-insert-image file
:pointer
'arrow
)
522 (set-window-hscroll (selected-window) hscroll
)
523 (when (and (not (file-exists-p file
))
524 doc-view-current-converter-processes
)
525 ;; The PNG file hasn't been generated yet.
526 (funcall doc-view-single-page-converter-function
527 doc-view-buffer-file-name file page
528 (let ((win (selected-window)))
530 (and (eq (current-buffer) (window-buffer win
))
531 ;; If we changed page in the mean
532 ;; time, don't mess things up.
533 (eq (doc-view-current-page win
) page
)
534 ;; Make sure we don't infloop.
535 (file-readable-p file
)
536 (with-selected-window win
537 (doc-view-goto-page page
))))))))
538 (overlay-put (doc-view-current-overlay)
539 'help-echo
(doc-view-current-info))))
541 (defun doc-view-next-page (&optional arg
)
542 "Browse ARG pages forward."
544 (doc-view-goto-page (+ (doc-view-current-page) (or arg
1))))
546 (defun doc-view-previous-page (&optional arg
)
547 "Browse ARG pages backward."
549 (doc-view-goto-page (- (doc-view-current-page) (or arg
1))))
551 (defun doc-view-first-page ()
552 "View the first page."
554 (doc-view-goto-page 1))
556 (defun doc-view-last-page ()
557 "View the last page."
559 (doc-view-goto-page (doc-view-last-page-number)))
561 (defun doc-view-scroll-up-or-next-page (&optional arg
)
562 "Scroll page up ARG lines if possible, else goto next page.
563 When `doc-view-continuous' is non-nil, scrolling upward
564 at the bottom edge of the page moves to the next page.
565 Otherwise, goto next page only on typing SPC (ARG is nil)."
567 (if (or doc-view-continuous
(null arg
))
568 (let ((hscroll (window-hscroll))
569 (cur-page (doc-view-current-page)))
570 (when (= (window-vscroll) (image-scroll-up arg
))
572 (when (/= cur-page
(doc-view-current-page))
575 (set-window-hscroll (selected-window) hscroll
)))
576 (image-scroll-up arg
)))
578 (defun doc-view-scroll-down-or-previous-page (&optional arg
)
579 "Scroll page down ARG lines if possible, else goto previous page.
580 When `doc-view-continuous' is non-nil, scrolling downward
581 at the top edge of the page moves to the previous page.
582 Otherwise, goto previous page only on typing DEL (ARG is nil)."
584 (if (or doc-view-continuous
(null arg
))
585 (let ((hscroll (window-hscroll))
586 (cur-page (doc-view-current-page)))
587 (when (= (window-vscroll) (image-scroll-down arg
))
588 (doc-view-previous-page)
589 (when (/= cur-page
(doc-view-current-page))
592 (set-window-hscroll (selected-window) hscroll
)))
593 (image-scroll-down arg
)))
595 (defun doc-view-next-line-or-next-page (&optional arg
)
596 "Scroll upward by ARG lines if possible, else goto next page.
597 When `doc-view-continuous' is non-nil, scrolling a line upward
598 at the bottom edge of the page moves to the next page."
600 (if doc-view-continuous
601 (let ((hscroll (window-hscroll))
602 (cur-page (doc-view-current-page)))
603 (when (= (window-vscroll) (image-next-line arg
))
605 (when (/= cur-page
(doc-view-current-page))
608 (set-window-hscroll (selected-window) hscroll
)))
609 (image-next-line 1)))
611 (defun doc-view-previous-line-or-previous-page (&optional arg
)
612 "Scroll downward by ARG lines if possible, else goto previous page.
613 When `doc-view-continuous' is non-nil, scrolling a line downward
614 at the top edge of the page moves to the previous page."
616 (if doc-view-continuous
617 (let ((hscroll (window-hscroll))
618 (cur-page (doc-view-current-page)))
619 (when (= (window-vscroll) (image-previous-line arg
))
620 (doc-view-previous-page)
621 (when (/= cur-page
(doc-view-current-page))
624 (set-window-hscroll (selected-window) hscroll
)))
625 (image-previous-line arg
)))
627 ;;;; Utility Functions
629 (defun doc-view-kill-proc ()
630 "Kill the current converter process(es)."
632 (while (consp doc-view-current-converter-processes
)
633 (ignore-errors ;; Some entries might not be processes, and maybe
634 ;; some are dead already?
635 (kill-process (pop doc-view-current-converter-processes
))))
636 (when doc-view-current-timer
637 (cancel-timer doc-view-current-timer
)
638 (setq doc-view-current-timer nil
))
639 (setq mode-line-process nil
))
641 (defun doc-view-kill-proc-and-buffer ()
642 "Kill the current converter process and buffer."
645 (when (eq major-mode
'doc-view-mode
)
646 (kill-buffer (current-buffer))))
648 (defun doc-view-make-safe-dir (dir)
650 (let ((umask (default-file-modes)))
653 ;; Create temp files with strict access rights. It's easy to
654 ;; loosen them later, whereas it's impossible to close the
655 ;; time-window of loose permissions otherwise.
656 (set-default-file-modes #o0700
)
657 (make-directory dir
))
659 (set-default-file-modes umask
)))
661 (when (file-symlink-p dir
)
662 (error "Danger: %s points to a symbolic link" dir
))
663 ;; In case it was created earlier with looser rights.
664 ;; We could check the mode info returned by file-attributes, but it's
665 ;; a pain to parse and it may not tell you what we want under
666 ;; non-standard file-systems. So let's just say what we want and let
667 ;; the underlying C code and file-system figure it out.
668 ;; This also ends up checking a bunch of useful conditions: it makes
669 ;; sure we have write-access to the directory and that we own it, thus
670 ;; closing a bunch of security holes.
671 (condition-case error
672 (set-file-modes dir
#o0700
)
675 (format "Unable to use temporary directory %s: %s"
676 dir
(mapconcat 'identity
(cdr error
) " "))))))))
678 (defun doc-view-current-cache-dir ()
679 "Return the directory where the png files of the current doc should be saved.
680 It's a subdirectory of `doc-view-cache-directory'."
681 (if doc-view-current-cache-dir
682 doc-view-current-cache-dir
683 ;; Try and make sure doc-view-cache-directory exists and is safe.
684 (doc-view-make-safe-dir doc-view-cache-directory
)
685 ;; Now compute the subdirectory to use.
686 (setq doc-view-current-cache-dir
687 (file-name-as-directory
689 (concat (file-name-nondirectory doc-view-buffer-file-name
)
691 (let ((file doc-view-buffer-file-name
))
693 (set-buffer-multibyte nil
)
694 (insert-file-contents-literally file
)
695 (md5 (current-buffer)))))
696 doc-view-cache-directory
)))))
698 (defun doc-view-remove-if (predicate list
)
699 "Return LIST with all items removed that satisfy PREDICATE."
702 (when (not (funcall predicate item
))
703 (setq new-list
(cons item new-list
))))
704 (nreverse new-list
)))
707 (defun doc-view-mode-p (type)
708 "Return non-nil if document type TYPE is available for `doc-view'.
709 Document types are symbols like `dvi', `ps', `pdf', or `odf' (any
710 OpenDocument format)."
711 (and (display-graphic-p)
712 (or (image-type-available-p 'imagemagick
)
713 (image-type-available-p 'png
))
716 (and (doc-view-mode-p 'pdf
)
717 (or (and doc-view-dvipdf-program
718 (executable-find doc-view-dvipdf-program
))
719 (and doc-view-dvipdfm-program
720 (executable-find doc-view-dvipdfm-program
)))))
721 ((memq type
'(postscript ps eps pdf
))
722 ;; FIXME: allow mupdf here
723 (and doc-view-ghostscript-program
724 (executable-find doc-view-ghostscript-program
)))
726 (and doc-view-odf-
>pdf-converter-program
727 (executable-find doc-view-odf-
>pdf-converter-program
)
728 (doc-view-mode-p 'pdf
)))
730 (executable-find "ddjvu"))
731 (t ;; unknown image type
734 ;;;; Conversion Functions
736 (defvar doc-view-shrink-factor
1.125)
738 (defun doc-view-enlarge (factor)
739 "Enlarge the document by FACTOR."
740 (interactive (list doc-view-shrink-factor
))
741 (if (and doc-view-scale-internally
742 (eq (plist-get (cdr (doc-view-current-image)) :type
)
744 ;; ImageMagick supports on-the-fly-rescaling.
745 (let ((new (ceiling (* factor doc-view-image-width
))))
746 (unless (equal new doc-view-image-width
)
747 (setq-local doc-view-image-width new
)
748 (doc-view-insert-image
749 (plist-get (cdr (doc-view-current-image)) :file
)
750 :width doc-view-image-width
)))
751 (let ((new (ceiling (* factor doc-view-resolution
))))
752 (unless (equal new doc-view-resolution
)
753 (setq-local doc-view-resolution new
)
754 (doc-view-reconvert-doc)))))
756 (defun doc-view-shrink (factor)
757 "Shrink the document."
758 (interactive (list doc-view-shrink-factor
))
759 (doc-view-enlarge (/ 1.0 factor
)))
761 (defun doc-view-fit-width-to-window ()
762 "Fit the image width to the window width."
764 (let ((win-width (- (nth 2 (window-inside-pixel-edges))
765 (nth 0 (window-inside-pixel-edges))))
766 (slice (doc-view-current-slice)))
768 (let ((img-width (car (image-display-size
769 (image-get-display-property) t
))))
770 (doc-view-enlarge (/ (float win-width
) (float img-width
))))
773 (let* ((slice-width (nth 2 slice
))
774 (scale-factor (/ (float win-width
) (float slice-width
)))
775 (new-slice (mapcar (lambda (x) (ceiling (* scale-factor x
))) slice
)))
777 (doc-view-enlarge scale-factor
)
778 (setf (doc-view-current-slice) new-slice
)
779 (doc-view-goto-page (doc-view-current-page))))))
781 (defun doc-view-fit-height-to-window ()
782 "Fit the image height to the window height."
784 (let ((win-height (- (nth 3 (window-inside-pixel-edges))
785 (nth 1 (window-inside-pixel-edges))))
786 (slice (doc-view-current-slice)))
788 (let ((img-height (cdr (image-display-size
789 (image-get-display-property) t
))))
790 ;; When users call 'doc-view-fit-height-to-window',
791 ;; they might want to go to next page by typing SPC
792 ;; ONLY once. So I used '(- win-height 1)' instead of
794 (doc-view-enlarge (/ (float (- win-height
1)) (float img-height
))))
797 (let* ((slice-height (nth 3 slice
))
798 (scale-factor (/ (float (- win-height
1)) (float slice-height
)))
799 (new-slice (mapcar (lambda (x) (ceiling (* scale-factor x
))) slice
)))
801 (doc-view-enlarge scale-factor
)
802 (setf (doc-view-current-slice) new-slice
)
803 (doc-view-goto-page (doc-view-current-page))))))
805 (defun doc-view-fit-page-to-window ()
806 "Fit the image to the window.
807 More specifically, this function enlarges image by:
809 min {(window-width / image-width), (window-height / image-height)} times."
811 (let ((win-width (- (nth 2 (window-inside-pixel-edges))
812 (nth 0 (window-inside-pixel-edges))))
813 (win-height (- (nth 3 (window-inside-pixel-edges))
814 (nth 1 (window-inside-pixel-edges))))
815 (slice (doc-view-current-slice)))
817 (let ((img-width (car (image-display-size
818 (image-get-display-property) t
)))
819 (img-height (cdr (image-display-size
820 (image-get-display-property) t
))))
821 (doc-view-enlarge (min (/ (float win-width
) (float img-width
))
822 (/ (float (- win-height
1))
823 (float img-height
)))))
825 (let* ((slice-width (nth 2 slice
))
826 (slice-height (nth 3 slice
))
827 (scale-factor (min (/ (float win-width
) (float slice-width
))
828 (/ (float (- win-height
1))
829 (float slice-height
))))
830 (new-slice (mapcar (lambda (x) (ceiling (* scale-factor x
))) slice
)))
831 (doc-view-enlarge scale-factor
)
832 (setf (doc-view-current-slice) new-slice
)
833 (doc-view-goto-page (doc-view-current-page))))))
835 (defun doc-view-reconvert-doc ()
836 "Reconvert the current document.
837 Should be invoked when the cached images aren't up-to-date."
840 ;; Clear the old cached files
841 (when (file-exists-p (doc-view-current-cache-dir))
842 (delete-directory (doc-view-current-cache-dir) 'recursive
))
843 (kill-local-variable 'doc-view-last-page-number
)
844 (doc-view-initiate-display))
846 (defun doc-view-sentinel (proc event
)
847 "Generic sentinel for doc-view conversion processes."
848 (if (not (string-match "finished" event
))
849 (message "DocView: process %s changed status to %s."
851 (if (string-match "\\(.+\\)\n?\\'" event
)
852 (match-string 1 event
)
854 (when (buffer-live-p (process-get proc
'buffer
))
855 (with-current-buffer (process-get proc
'buffer
)
856 (setq doc-view-current-converter-processes
857 (delq proc doc-view-current-converter-processes
))
858 (setq mode-line-process
859 (if doc-view-current-converter-processes
860 (format ":%s" (car doc-view-current-converter-processes
))))
861 (funcall (process-get proc
'callback
))))))
863 (defun doc-view-start-process (name program args callback
)
864 ;; Make sure the process is started in an existing directory, (rather than
865 ;; some file-name-handler-managed dir, for example).
866 (let* ((default-directory (if (file-readable-p default-directory
)
868 (expand-file-name "~/")))
869 (proc (apply 'start-process name doc-view-conversion-buffer
871 (push proc doc-view-current-converter-processes
)
872 (setq mode-line-process
(list (format ":%s" proc
)))
873 (set-process-sentinel proc
'doc-view-sentinel
)
874 (process-put proc
'buffer
(current-buffer))
875 (process-put proc
'callback callback
)))
877 (defun doc-view-dvi->pdf
(dvi pdf callback
)
878 "Convert DVI to PDF asynchronously and call CALLBACK when finished."
879 ;; Prefer dvipdf over dvipdfm, because the latter has problems if the DVI
880 ;; references and includes other PS files.
881 (if (and doc-view-dvipdf-program
882 (executable-find doc-view-dvipdf-program
))
883 (doc-view-start-process "dvi->pdf" doc-view-dvipdf-program
886 (doc-view-start-process "dvi->pdf" doc-view-dvipdfm-program
890 (defun doc-view-pdf->png-converter-ghostscript
(pdf png page callback
)
891 (doc-view-start-process
892 "pdf/ps->png" doc-view-ghostscript-program
893 `(,@doc-view-ghostscript-options
894 ,(format "-r%d" (round doc-view-resolution
))
895 ,@(if page
`(,(format "-dFirstPage=%d" page
)))
896 ,@(if page
`(,(format "-dLastPage=%d" page
)))
897 ,(concat "-sOutputFile=" png
)
901 (defalias 'doc-view-ps-
>png-converter-ghostscript
902 'doc-view-pdf-
>png-converter-ghostscript
)
904 (defun doc-view-djvu->tiff-converter-ddjvu
(djvu tiff page callback
)
905 "Convert PAGE of a DJVU file to bitmap(s) asynchronously.
906 Call CALLBACK with no arguments when done.
907 If PAGE is nil, convert the whole document."
908 (doc-view-start-process
911 ;; ddjvu only accepts the range 1-999.
912 ,(format "-scale=%d" (round doc-view-resolution
))
913 ;; -eachpage was only added after djvulibre-3.5.25.3!
914 ,@(unless page
'("-eachpage"))
915 ,@(if page
`(,(format "-page=%d" page
)))
920 (defun doc-view-pdf->png-converter-mupdf
(pdf png page callback
)
921 (doc-view-start-process
922 "pdf->png" doc-view-pdfdraw-program
924 ,(format "-r%d" (round doc-view-resolution
))
926 ,@(if page
`(,(format "%d" page
))))
929 (defun doc-view-odf->pdf-converter-unoconv
(odf callback
)
930 "Convert ODF to PDF asynchronously and call CALLBACK when finished.
931 The converted PDF is put into the current cache directory, and it
932 is named like ODF with the extension turned to pdf."
933 (doc-view-start-process "odf->pdf" doc-view-odf-
>pdf-converter-program
934 (list "-f" "pdf" "-o" (doc-view-current-cache-dir) odf
)
937 (defun doc-view-odf->pdf-converter-soffice
(odf callback
)
938 "Convert ODF to PDF asynchronously and call CALLBACK when finished.
939 The converted PDF is put into the current cache directory, and it
940 is named like ODF with the extension turned to pdf."
941 (doc-view-start-process "odf->pdf" doc-view-odf-
>pdf-converter-program
942 (list "--headless" "--convert-to" "pdf"
943 "--outdir" (doc-view-current-cache-dir) odf
)
946 (defun doc-view-pdf/ps-
>png
(pdf-ps png
)
947 ;; FIXME: Fix name and docstring to account for djvu&tiff.
948 "Convert PDF-PS to PNG asynchronously."
950 (pcase doc-view-doc-type
951 (`pdf doc-view-pdf-
>png-converter-function
)
952 (`djvu
#'doc-view-djvu-
>tiff-converter-ddjvu
)
953 (_ #'doc-view-ps-
>png-converter-ghostscript
))
955 (let ((resolution doc-view-resolution
))
957 ;; Only create the resolution file when it's all done, so it also
958 ;; serves as a witness that the conversion is complete.
959 (write-region (prin1-to-string resolution
) nil
960 (expand-file-name "resolution.el"
961 (doc-view-current-cache-dir))
963 (when doc-view-current-timer
964 (cancel-timer doc-view-current-timer
)
965 (setq doc-view-current-timer nil
))
966 (doc-view-display (current-buffer) 'force
))))
968 ;; Update the displayed pages as soon as they're done generating.
969 (when doc-view-conversion-refresh-interval
970 (setq doc-view-current-timer
971 (run-at-time "1 secs" doc-view-conversion-refresh-interval
975 (declare-function clear-image-cache
"image.c" (&optional filter
))
977 (defun doc-view-document->bitmap
(pdf png pages
)
978 "Convert a document file to bitmap images asynchronously.
979 Start by converting PAGES, and then the rest."
981 (doc-view-pdf/ps-
>png pdf png
)
982 ;; We could render several `pages' with a single process if they're
983 ;; (almost) consecutive, but since in 99% of the cases, there'll be only
984 ;; a single page anyway, and of the remaining 1%, few cases will have
985 ;; consecutive pages, it's not worth the trouble.
986 (let ((rest (cdr pages
)))
987 (funcall doc-view-single-page-converter-function
988 pdf
(format png
(car pages
)) (car pages
)
991 (doc-view-document->bitmap pdf png rest
)
992 ;; Yippie, the important pages are done, update the display.
994 ;; For the windows that have a message (like "Welcome to
995 ;; DocView") display property, clearing the image cache is
997 (dolist (win (get-buffer-window-list (current-buffer) nil
'visible
))
998 (with-selected-window win
999 (when (stringp (get-char-property (point-min) 'display
))
1000 (doc-view-goto-page (doc-view-current-page)))))
1001 ;; Convert the rest of the pages.
1002 (doc-view-pdf/ps-
>png pdf png
)))))))
1004 (defun doc-view-pdf->txt
(pdf txt callback
)
1005 "Convert PDF to TXT asynchronously and call CALLBACK when finished."
1006 (or (executable-find doc-view-pdftotext-program
)
1007 (error "You need the `pdftotext' program to convert a PDF to text"))
1008 (doc-view-start-process "pdf->txt" doc-view-pdftotext-program
1009 (list "-raw" pdf txt
)
1012 (defun doc-view-current-cache-doc-pdf ()
1013 "Return the name of the doc.pdf in the current cache dir.
1014 This file exists only if the current document isn't a PDF or PS file already."
1015 (expand-file-name "doc.pdf" (doc-view-current-cache-dir)))
1017 (defun doc-view-doc->txt
(txt callback
)
1018 "Convert the current document to text and call CALLBACK when done."
1019 (make-directory (doc-view-current-cache-dir) t
)
1020 (pcase doc-view-doc-type
1022 ;; Doc is a PDF, so convert it to TXT
1023 (doc-view-pdf->txt doc-view-buffer-file-name txt callback
))
1025 ;; Doc is a PS, so convert it to PDF (which will be converted to
1027 (let ((pdf (doc-view-current-cache-doc-pdf)))
1028 (doc-view-ps->pdf doc-view-buffer-file-name pdf
1029 (lambda () (doc-view-pdf->txt pdf txt callback
)))))
1031 ;; Doc is a DVI. This means that a doc.pdf already exists in its
1032 ;; cache subdirectory.
1033 (doc-view-pdf->txt
(doc-view-current-cache-doc-pdf) txt callback
))
1035 ;; Doc is some ODF (or MS Office) doc. This means that a doc.pdf
1036 ;; already exists in its cache subdirectory.
1037 (doc-view-pdf->txt
(doc-view-current-cache-doc-pdf) txt callback
))
1038 (_ (error "DocView doesn't know what to do"))))
1040 (defun doc-view-ps->pdf
(ps pdf callback
)
1041 "Convert PS to PDF asynchronously and call CALLBACK when finished."
1042 (or (executable-find doc-view-ps2pdf-program
)
1043 (error "You need the `ps2pdf' program to convert PS to PDF"))
1044 (doc-view-start-process "ps->pdf" doc-view-ps2pdf-program
1046 ;; Avoid security problems when rendering files from
1047 ;; untrusted sources.
1049 ;; in-file and out-file
1053 (defun doc-view-active-pages ()
1055 (dolist (win (get-buffer-window-list (current-buffer) nil
'visible
))
1056 (let ((page (image-mode-window-get 'page win
)))
1057 (unless (memq page pages
) (push page pages
))))
1060 (defun doc-view-convert-current-doc ()
1061 "Convert `doc-view-buffer-file-name' to a set of png files, one file per page.
1062 Those files are saved in the directory given by the function
1063 `doc-view-current-cache-dir'."
1064 ;; Let stale files still display while we recompute the new ones, so only
1065 ;; flush the cache when the conversion is over. One of the reasons why it
1066 ;; is important to keep displaying the stale page is so that revert-buffer
1067 ;; preserves the horizontal/vertical scroll settings (which are otherwise
1068 ;; resets during the redisplay).
1069 (setq doc-view-pending-cache-flush t
)
1070 (let ((png-file (expand-file-name
1071 (format doc-view--image-file-pattern
"%d")
1072 (doc-view-current-cache-dir))))
1073 (make-directory (doc-view-current-cache-dir) t
)
1074 (pcase doc-view-doc-type
1076 ;; DVI files have to be converted to PDF before Ghostscript can process
1078 (let ((pdf (doc-view-current-cache-doc-pdf)))
1079 (doc-view-dvi->pdf doc-view-buffer-file-name pdf
1080 (lambda () (doc-view-pdf/ps-
>png pdf png-file
)))))
1082 ;; ODF files have to be converted to PDF before Ghostscript can
1084 (let ((pdf (doc-view-current-cache-doc-pdf))
1085 (opdf (expand-file-name
1086 (concat (file-name-base doc-view-buffer-file-name
)
1088 doc-view-current-cache-dir
))
1089 (png-file png-file
))
1090 ;; The unoconv tool only supports an output directory, but no
1091 ;; file name. It's named like the input file with the
1092 ;; extension replaced by pdf.
1093 (funcall doc-view-odf-
>pdf-converter-function doc-view-buffer-file-name
1095 ;; Rename to doc.pdf
1096 (rename-file opdf pdf
)
1097 (doc-view-pdf/ps-
>png pdf png-file
)))))
1099 (let ((pages (doc-view-active-pages)))
1100 ;; Convert doc to bitmap images starting with the active pages.
1101 (doc-view-document->bitmap doc-view-buffer-file-name png-file pages
)))
1103 ;; Convert to PNG images.
1104 (doc-view-pdf/ps-
>png doc-view-buffer-file-name png-file
)))))
1108 (declare-function image-size
"image.c" (spec &optional pixels frame
))
1110 (defun doc-view-set-slice (x y width height
)
1111 "Set the slice of the images that should be displayed.
1112 You can use this function to tell doc-view not to display the
1113 margins of the document. It prompts for the top-left corner (X
1114 and Y) of the slice to display and its WIDTH and HEIGHT.
1116 See `doc-view-set-slice-using-mouse' and
1117 `doc-view-set-slice-from-bounding-box' for more convenient ways
1118 to do that. To reset the slice use `doc-view-reset-slice'."
1120 (let* ((size (image-size (doc-view-current-image) t
))
1121 (a (read-number (format "Top-left X (0..%d): " (car size
))))
1122 (b (read-number (format "Top-left Y (0..%d): " (cdr size
))))
1123 (c (read-number (format "Width (0..%d): " (- (car size
) a
))))
1124 (d (read-number (format "Height (0..%d): " (- (cdr size
) b
)))))
1126 (setf (doc-view-current-slice) (list x y width height
))
1128 (doc-view-goto-page (doc-view-current-page)))
1130 (defun doc-view-set-slice-using-mouse ()
1131 "Set the slice of the images that should be displayed.
1132 You set the slice by pressing mouse-1 at its top-left corner and
1133 dragging it to its bottom-right corner. See also
1134 `doc-view-set-slice' and `doc-view-reset-slice'."
1138 (let ((e (read-event
1139 (concat "Press mouse-1 at the top-left corner and "
1140 "drag it to the bottom-right corner!"))))
1141 (when (eq (car e
) 'drag-mouse-1
)
1142 (setq x
(car (posn-object-x-y (event-start e
))))
1143 (setq y
(cdr (posn-object-x-y (event-start e
))))
1144 (setq w
(- (car (posn-object-x-y (event-end e
))) x
))
1145 (setq h
(- (cdr (posn-object-x-y (event-end e
))) y
))
1147 (doc-view-set-slice x y w h
)))
1149 (defun doc-view-get-bounding-box ()
1150 "Get the BoundingBox information of the current page."
1151 (let* ((page (doc-view-current-page))
1152 (doc (let ((cache-doc (doc-view-current-cache-doc-pdf)))
1153 (if (file-exists-p cache-doc
)
1155 doc-view-buffer-file-name
)))
1156 (o (shell-command-to-string
1157 (concat doc-view-ghostscript-program
1158 " -dSAFER -dBATCH -dNOPAUSE -q -sDEVICE=bbox "
1159 (format "-dFirstPage=%s -dLastPage=%s %s"
1162 (when (string-match (concat "%%BoundingBox: "
1163 "\\([[:digit:]]+\\) \\([[:digit:]]+\\) "
1164 "\\([[:digit:]]+\\) \\([[:digit:]]+\\)") o
)
1165 (mapcar #'string-to-number
1166 (list (match-string 1 o
)
1169 (match-string 4 o
)))))))
1171 (defvar doc-view-paper-sizes
1173 (a4-landscape 842 595)
1175 (letter-landscape 792 612)
1177 (legal-landscape 1008 612)
1179 (a3-landscape 1191 842)
1182 "An alist from paper size names to dimensions.")
1184 (defun doc-view-guess-paper-size (iw ih
)
1185 "Guess the paper size according to the aspect ratio."
1186 (cl-labels ((div (x y
)
1187 (round (/ (* 100.0 x
) y
))))
1188 (let ((ar (div iw ih
))
1189 (al (mapcar (lambda (l)
1190 (list (div (nth 1 l
) (nth 2 l
)) (car l
)))
1191 doc-view-paper-sizes
)))
1192 (cadr (assoc ar al
)))))
1194 (defun doc-view-scale-bounding-box (ps iw ih bb
)
1195 (list (/ (* (nth 0 bb
) iw
) (nth 1 (assoc ps doc-view-paper-sizes
)))
1196 (/ (* (nth 1 bb
) ih
) (nth 2 (assoc ps doc-view-paper-sizes
)))
1197 (/ (* (nth 2 bb
) iw
) (nth 1 (assoc ps doc-view-paper-sizes
)))
1198 (/ (* (nth 3 bb
) ih
) (nth 2 (assoc ps doc-view-paper-sizes
)))))
1200 (defun doc-view-set-slice-from-bounding-box (&optional force-paper-size
)
1201 "Set the slice from the document's BoundingBox information.
1202 The result is that the margins are almost completely cropped,
1203 much more accurate than could be done manually using
1204 `doc-view-set-slice-using-mouse'."
1206 (let ((bb (doc-view-get-bounding-box)))
1208 (message "BoundingBox couldn't be determined")
1209 (let* ((is (image-size (doc-view-current-image) t
))
1212 (ps (or (and (null force-paper-size
)
1213 (doc-view-guess-paper-size iw ih
))
1214 (intern (completing-read "Paper size: "
1215 doc-view-paper-sizes
1217 (bb (doc-view-scale-bounding-box ps iw ih bb
))
1222 ;; We keep a 2 pixel margin.
1223 (doc-view-set-slice (- x1
2) (- ih y2
2)
1224 (+ (- x2 x1
) 4) (+ (- y2 y1
) 4))))))
1226 (defun doc-view-reset-slice ()
1227 "Reset the current slice.
1228 After calling this function whole pages will be visible again."
1230 (setf (doc-view-current-slice) nil
)
1232 (doc-view-goto-page (doc-view-current-page)))
1236 (defun doc-view-insert-image (file &rest args
)
1237 "Insert the given png FILE.
1238 ARGS is a list of image descriptors."
1239 (when doc-view-pending-cache-flush
1241 (setq doc-view-pending-cache-flush nil
))
1242 (let ((ol (doc-view-current-overlay))
1243 (image (if (and file
(file-readable-p file
))
1244 (if (not (and doc-view-scale-internally
1245 (fboundp 'imagemagick-types
)))
1246 (apply 'create-image file doc-view--image-type nil args
)
1247 (unless (member :width args
)
1248 (setq args
`(,@args
:width
,doc-view-image-width
)))
1249 (apply 'create-image file
'imagemagick nil args
))))
1250 (slice (doc-view-current-slice)))
1251 (setf (doc-view-current-image) image
)
1252 (move-overlay ol
(point-min) (point-max))
1253 (overlay-put ol
'display
1257 (list (cons 'slice slice
) image
)
1259 ;; We're trying to display a page that doesn't exist.
1260 (doc-view-current-converter-processes
1261 ;; Maybe the page doesn't exist *yet*.
1262 "Cannot display this page (yet)!")
1264 ;; Typically happens if the conversion process somehow
1265 ;; failed. Better not signal an error here because it
1266 ;; could prevent a subsequent reconversion from fixing
1268 (concat "Cannot display this page!\n"
1269 "Maybe because of a conversion failure!"))))
1270 (let ((win (overlay-get ol
'window
)))
1271 (if (stringp (overlay-get ol
'display
))
1272 (progn ;Make sure the text is not scrolled out of view.
1273 (set-window-hscroll win
0)
1274 (set-window-vscroll win
0))
1275 (let ((hscroll (image-mode-window-get 'hscroll win
))
1276 (vscroll (image-mode-window-get 'vscroll win
)))
1277 ;; Reset scroll settings, in case they were changed.
1278 (if hscroll
(set-window-hscroll win hscroll
))
1279 (if vscroll
(set-window-vscroll win vscroll
)))))))
1281 (defun doc-view-sort (a b
)
1282 "Return non-nil if A should be sorted before B.
1283 Predicate for sorting `doc-view-current-files'."
1284 (or (< (length a
) (length b
))
1285 (and (= (length a
) (length b
))
1288 (defun doc-view-display (buffer &optional force
)
1289 "Start viewing the document in BUFFER.
1290 If FORCE is non-nil, start viewing even if the document does not
1291 have the page we want to view."
1292 (with-current-buffer buffer
1293 (let ((prev-pages doc-view-current-files
))
1294 (setq doc-view-current-files
1295 (sort (directory-files (doc-view-current-cache-dir) t
1296 (format doc-view--image-file-pattern
1300 (unless (eq (length prev-pages
) (length doc-view-current-files
))
1301 (force-mode-line-update))
1302 (dolist (win (or (get-buffer-window-list buffer nil t
)
1304 (let* ((page (doc-view-current-page win
))
1305 (pagefile (expand-file-name
1306 (format doc-view--image-file-pattern page
)
1307 (doc-view-current-cache-dir))))
1309 (and (not (member pagefile prev-pages
))
1310 (member pagefile doc-view-current-files
)))
1312 (with-selected-window win
1313 (cl-assert (eq (current-buffer) buffer
) t
)
1314 (doc-view-goto-page page
))
1315 (doc-view-goto-page page
))))))))
1317 (defun doc-view-buffer-message ()
1318 ;; Only show this message initially, not when refreshing the buffer (in which
1319 ;; case it's better to keep displaying the "stale" page while computing
1320 ;; the fresh new ones).
1321 (unless (overlay-get (doc-view-current-overlay) 'display
)
1322 (overlay-put (doc-view-current-overlay) 'display
1323 (concat (propertize "Welcome to DocView!" 'face
'bold
)
1326 If you see this buffer it means that the document you want to view is being
1327 converted to PNG and the conversion of the first page hasn't finished yet or
1328 `doc-view-conversion-refresh-interval' is set to nil.
1330 For now these keys are useful:
1332 `q' : Bury this buffer. Conversion will go on in background.
1333 `k' : Kill the conversion process and this buffer.
1334 `K' : Kill the conversion process.\n"))))
1336 (declare-function tooltip-show
"tooltip" (text &optional use-echo-area
))
1338 (defun doc-view-show-tooltip ()
1340 (tooltip-show (doc-view-current-info)))
1342 (defun doc-view-open-text ()
1343 "Open a buffer with the current doc's contents as text."
1345 (if doc-view-current-converter-processes
1346 (message "DocView: please wait till conversion finished.")
1347 (let ((txt (expand-file-name "doc.txt" (doc-view-current-cache-dir))))
1348 (if (file-readable-p txt
)
1349 (let ((name (concat "Text contents of "
1350 (file-name-nondirectory buffer-file-name
)))
1351 (dir (file-name-directory buffer-file-name
)))
1352 (with-current-buffer (find-file txt
)
1353 (rename-buffer name
)
1354 (setq default-directory dir
)))
1355 (doc-view-doc->txt txt
'doc-view-open-text
)))))
1357 ;;;;; Toggle between editing and viewing
1359 (defvar-local doc-view-saved-settings nil
1360 "Doc-view settings saved while in some other mode.")
1361 (put 'doc-view-saved-settings
'permanent-local t
)
1363 (defun doc-view-toggle-display ()
1364 "Toggle between editing a document as text or viewing it."
1366 (if (eq major-mode
'doc-view-mode
)
1367 ;; Switch to editing mode
1369 (doc-view-kill-proc)
1370 (setq buffer-read-only nil
)
1371 (remove-overlays (point-min) (point-max) 'doc-view t
)
1372 (setq-local image-mode-winprops-alist t
)
1373 ;; Switch to the previously used major mode or fall back to
1375 (doc-view-fallback-mode)
1376 (doc-view-minor-mode 1))
1377 ;; Switch to doc-view-mode
1378 (when (and (buffer-modified-p)
1379 (y-or-n-p "The buffer has been modified. Save the changes? "))
1386 (defun doc-view-search-internal (regexp file
)
1387 "Return a list of FILE's pages that contain text matching REGEXP.
1388 The value is an alist of the form (PAGE CONTEXTS) where PAGE is
1389 the pagenumber and CONTEXTS are all lines of text containing a match."
1391 (insert-file-contents file
)
1395 (while (re-search-forward (concat "\\(?:\\([\f]\\)\\|\\("
1396 regexp
"\\)\\)") nil t
)
1397 (when (match-string 1) (setq page
(1+ page
)))
1398 (when (match-string 2)
1399 (if (/= page lastpage
)
1401 (list (buffer-substring
1402 (line-beginning-position)
1403 (line-end-position))))
1408 ;; This page already is a match.
1410 ;; This is the first match on page.
1412 (list (buffer-substring
1413 (line-beginning-position)
1414 (line-end-position))))
1416 (setq lastpage page
)))
1417 (nreverse matches
))))
1419 (defun doc-view-search-no-of-matches (list)
1420 "Extract the number of matches from the search result LIST."
1423 (setq no
(+ no
(1- (length p
)))))
1426 (defun doc-view-search-backward (new-query)
1427 "Call `doc-view-search' for backward search.
1428 If prefix NEW-QUERY is given, ask for a new regexp."
1430 (doc-view-search new-query t
))
1432 (defun doc-view-search (new-query &optional backward
)
1433 "Jump to the next match or initiate a new search if NEW-QUERY is given.
1434 If the current document hasn't been transformed to plain text
1435 till now do that first.
1436 If BACKWARD is non-nil, jump to the previous match."
1438 (if (and (not new-query
)
1439 doc-view-current-search-matches
)
1441 (doc-view-search-previous-match 1)
1442 (doc-view-search-next-match 1))
1443 ;; New search, so forget the old results.
1444 (setq doc-view-current-search-matches nil
)
1445 (let ((txt (expand-file-name "doc.txt"
1446 (doc-view-current-cache-dir))))
1447 (if (file-readable-p txt
)
1449 (setq doc-view-current-search-matches
1450 (doc-view-search-internal
1451 (read-from-minibuffer "Regexp: ")
1453 (message "DocView: search yielded %d matches."
1454 (doc-view-search-no-of-matches
1455 doc-view-current-search-matches
)))
1456 ;; We must convert to TXT first!
1457 (if doc-view-current-converter-processes
1458 (message "DocView: please wait till conversion finished.")
1459 (doc-view-doc->txt txt
(lambda () (doc-view-search nil
))))))))
1461 (defun doc-view-search-next-match (arg)
1462 "Go to the ARGth next matching page."
1464 (let* ((next-pages (doc-view-remove-if
1465 (lambda (i) (<= (car i
) (doc-view-current-page)))
1466 doc-view-current-search-matches
))
1467 (page (car (nth (1- arg
) next-pages
))))
1469 (doc-view-goto-page page
)
1471 doc-view-current-search-matches
1472 (y-or-n-p "No more matches after current page. Wrap to first match? "))
1473 (doc-view-goto-page (caar doc-view-current-search-matches
))))))
1475 (defun doc-view-search-previous-match (arg)
1476 "Go to the ARGth previous matching page."
1478 (let* ((prev-pages (doc-view-remove-if
1479 (lambda (i) (>= (car i
) (doc-view-current-page)))
1480 doc-view-current-search-matches
))
1481 (page (car (nth (1- arg
) (nreverse prev-pages
)))))
1483 (doc-view-goto-page page
)
1485 doc-view-current-search-matches
1486 (y-or-n-p "No more matches before current page. Wrap to last match? "))
1487 (doc-view-goto-page (caar (last doc-view-current-search-matches
)))))))
1489 ;;;; User interface commands and the mode
1491 (put 'doc-view-mode
'mode-class
'special
)
1493 (defun doc-view-already-converted-p ()
1494 "Return non-nil if the current doc was already converted."
1495 (and (file-exists-p (doc-view-current-cache-dir))
1496 ;; Check that the resolution info is there, otherwise it means
1497 ;; the conversion is incomplete.
1498 (file-readable-p (expand-file-name "resolution.el"
1499 (doc-view-current-cache-dir)))
1500 (> (length (directory-files
1501 (doc-view-current-cache-dir)
1502 nil
(format doc-view--image-file-pattern
"[0-9]+")))
1505 (defun doc-view-initiate-display ()
1506 ;; Switch to image display if possible.
1507 (if (doc-view-mode-p doc-view-doc-type
)
1509 (doc-view-buffer-message)
1510 (setf (doc-view-current-page) (or (doc-view-current-page) 1))
1511 (if (doc-view-already-converted-p)
1513 (message "DocView: using cached files!")
1514 ;; Load the saved resolution.
1515 (let* ((res-file (expand-file-name "resolution.el"
1516 (doc-view-current-cache-dir)))
1519 (when (file-readable-p res-file
)
1520 (insert-file-contents res-file
)
1521 (read (current-buffer))))))
1523 (setq-local doc-view-resolution res
)))
1524 (doc-view-display (current-buffer) 'force
))
1525 (doc-view-convert-current-doc))
1528 (substitute-command-keys
1529 (concat "Type \\[doc-view-toggle-display] to toggle between "
1530 "editing or viewing the document."))))
1533 (concat "No PNG support is available, or some conversion utility for "
1534 (file-name-extension doc-view-buffer-file-name
)
1535 " files is missing."))
1536 (when (and (executable-find doc-view-pdftotext-program
)
1538 "Unable to render file. View extracted text instead? "))
1539 (doc-view-open-text))
1540 (doc-view-toggle-display)))
1542 (defvar bookmark-make-record-function
)
1544 (defun doc-view-clone-buffer-hook ()
1545 ;; FIXME: There are several potential problems linked with reconversion
1546 ;; and auto-revert when we have indirect buffers because they share their
1547 ;; /tmp cache directory. This sharing is good (you'd rather not reconvert
1548 ;; for each clone), but that means that clones need to collaborate a bit.
1549 ;; I guess it mostly means: detect when a reconversion process is already
1550 ;; running, and run the sentinel in all clones.
1552 ;; Maybe the clones should really have a separate /tmp directory
1553 ;; so they could have a different resolution and you could use clones
1555 (remove-overlays (point-min) (point-max) 'doc-view t
)
1556 (if (consp image-mode-winprops-alist
) (setq image-mode-winprops-alist nil
)))
1558 (defun doc-view-intersection (l1 l2
)
1560 (dolist (x l1
) (if (memq x l2
) (push x l
)))
1563 (defun doc-view-set-doc-type ()
1564 "Figure out the current document type (`doc-view-doc-type')."
1566 (when buffer-file-name
1567 (cdr (assoc (file-name-extension buffer-file-name
)
1572 ("pdf" pdf
) ("epdf" pdf
)
1574 ("ps" ps
) ("eps" ps
)
1577 ;; OpenDocument formats
1578 ("odt" odf
) ("ods" odf
) ("odp" odf
) ("odg" odf
)
1579 ("odc" odf
) ("odi" odf
) ("odm" odf
) ("ott" odf
)
1580 ("ots" odf
) ("otp" odf
) ("otg" odf
)
1581 ;; Microsoft Office formats (also handled
1582 ;; by the odf conversion chain)
1583 ("doc" odf
) ("docx" odf
) ("xls" odf
) ("xlsx" odf
)
1584 ("ppt" odf
) ("pptx" odf
))))))
1587 (goto-char (point-min))
1589 ((looking-at "%!") '(ps))
1590 ((looking-at "%PDF") '(pdf))
1591 ((looking-at "\367\002") '(dvi))
1592 ((looking-at "AT&TFORM") '(djvu))))))
1593 (setq-local doc-view-doc-type
1594 (car (or (doc-view-intersection name-types content-types
)
1595 (when (and name-types content-types
)
1596 (error "Conflicting types: name says %s but content says %s"
1597 name-types content-types
))
1598 name-types content-types
1599 (error "Cannot determine the document type"))))))
1601 (defun doc-view-set-up-single-converter ()
1602 "Find the right single-page converter for the current document type"
1603 (pcase-let ((`(,conv-function
,type
,extension
)
1604 (pcase doc-view-doc-type
1605 (`djvu
(list #'doc-view-djvu-
>tiff-converter-ddjvu
'tiff
"tif"))
1606 (_ (list doc-view-pdf-
>png-converter-function
'png
"png")))))
1607 (setq-local doc-view-single-page-converter-function conv-function
)
1608 (setq-local doc-view--image-type type
)
1609 (setq-local doc-view--image-file-pattern
(concat "page-%s." extension
))))
1612 (defun doc-view-mode ()
1613 "Major mode in DocView buffers.
1615 DocView Mode is an Emacs document viewer. It displays PDF, PS
1616 and DVI files (as PNG images) in Emacs buffers.
1618 You can use \\<doc-view-mode-map>\\[doc-view-toggle-display] to
1619 toggle between displaying the document or editing it as text.
1620 \\{doc-view-mode-map}"
1623 (if (= (point-min) (point-max))
1624 ;; The doc is empty or doesn't exist at all, so fallback to
1625 ;; another mode. We used to also check file-exists-p, but this
1626 ;; returns nil for tar members.
1627 (doc-view-fallback-mode)
1629 (let* ((prev-major-mode (if (derived-mode-p 'doc-view-mode
)
1630 doc-view-previous-major-mode
1631 (unless (eq major-mode
'fundamental-mode
)
1633 (kill-all-local-variables)
1634 (setq-local doc-view-previous-major-mode prev-major-mode
))
1636 (dolist (var doc-view-saved-settings
)
1637 (set (make-local-variable (car var
)) (cdr var
)))
1639 ;; Figure out the document type.
1640 (unless doc-view-doc-type
1641 (doc-view-set-doc-type))
1642 (doc-view-set-up-single-converter)
1644 (doc-view-make-safe-dir doc-view-cache-directory
)
1645 ;; Handle compressed files, remote files, files inside archives
1646 (setq-local doc-view-buffer-file-name
1648 (jka-compr-really-do-compress
1649 ;; FIXME: there's a risk of name conflicts here.
1651 (file-name-nondirectory
1652 (file-name-sans-extension buffer-file-name
))
1653 doc-view-cache-directory
))
1654 ;; Is the file readable by local processes?
1655 ;; We used to use `file-remote-p' but it's unclear what it's
1656 ;; supposed to return nil for things like local files accessed via
1657 ;; `su' or via file://...
1658 ((let ((file-name-handler-alist nil
))
1659 (not (and buffer-file-name
(file-readable-p buffer-file-name
))))
1660 ;; FIXME: there's a risk of name conflicts here.
1662 (if buffer-file-name
1663 (file-name-nondirectory buffer-file-name
)
1665 doc-view-cache-directory
))
1666 (t buffer-file-name
)))
1667 (when (not (string= doc-view-buffer-file-name buffer-file-name
))
1668 (write-region nil nil doc-view-buffer-file-name
))
1670 (add-hook 'change-major-mode-hook
1672 (doc-view-kill-proc)
1673 (remove-overlays (point-min) (point-max) 'doc-view t
))
1675 (add-hook 'clone-indirect-buffer-hook
'doc-view-clone-buffer-hook nil t
)
1676 (add-hook 'kill-buffer-hook
'doc-view-kill-proc nil t
)
1678 (remove-overlays (point-min) (point-max) 'doc-view t
) ;Just in case.
1679 ;; Keep track of display info ([vh]scroll, page number, overlay,
1680 ;; ...) for each window in which this document is shown.
1681 (add-hook 'image-mode-new-window-functions
1682 'doc-view-new-window-function nil t
)
1683 (image-mode-setup-winprops)
1685 (setq-local mode-line-position
1686 '(" P" (:eval
(number-to-string (doc-view-current-page)))
1687 "/" (:eval
(number-to-string (doc-view-last-page-number)))))
1688 ;; Don't scroll unless the user specifically asked for it.
1689 (setq-local auto-hscroll-mode nil
)
1690 (setq-local mwheel-scroll-up-function
#'doc-view-scroll-up-or-next-page
)
1691 (setq-local mwheel-scroll-down-function
1692 #'doc-view-scroll-down-or-previous-page
)
1693 (setq-local cursor-type nil
)
1694 (use-local-map doc-view-mode-map
)
1695 (add-hook 'after-revert-hook
'doc-view-reconvert-doc nil t
)
1696 (setq-local bookmark-make-record-function
1697 #'doc-view-bookmark-make-record
)
1698 (setq mode-name
"DocView"
1700 major-mode
'doc-view-mode
)
1701 (doc-view-initiate-display)
1702 ;; Switch off view-mode explicitly, because doc-view-mode is the
1703 ;; canonical view mode for PDF/PS/DVI files. This could be
1704 ;; switched on automatically depending on the value of
1705 ;; `view-read-only'.
1706 (setq-local view-read-only nil
)
1707 (run-mode-hooks 'doc-view-mode-hook
)))
1709 (defun doc-view-fallback-mode ()
1710 "Fallback to the previous or next best major mode."
1711 (let ((vars (if (derived-mode-p 'doc-view-mode
)
1712 (mapcar (lambda (var) (cons var
(symbol-value var
)))
1713 '(doc-view-resolution
1714 image-mode-winprops-alist
)))))
1715 (if doc-view-previous-major-mode
1716 (funcall doc-view-previous-major-mode
)
1717 (let ((auto-mode-alist
1719 'doc-view-mode-maybe
1720 (rassq-delete-all 'doc-view-mode
1721 (copy-alist auto-mode-alist
)))))
1724 (setq-local doc-view-saved-settings vars
))))
1727 (defun doc-view-mode-maybe ()
1728 "Switch to `doc-view-mode' if possible.
1729 If the required external tools are not available, then fallback
1730 to the next best mode."
1732 (doc-view-set-doc-type)
1733 (error (doc-view-fallback-mode)))
1734 (if (doc-view-mode-p doc-view-doc-type
)
1736 (doc-view-fallback-mode)))
1739 (define-minor-mode doc-view-minor-mode
1740 "Toggle displaying buffer via Doc View (Doc View minor mode).
1741 With a prefix argument ARG, enable Doc View minor mode if ARG is
1742 positive, and disable it otherwise. If called from Lisp, enable
1743 the mode if ARG is omitted or nil.
1745 See the command `doc-view-mode' for more information on this mode."
1746 nil
" DocView" doc-view-minor-mode-map
1748 (when doc-view-minor-mode
1749 (add-hook 'change-major-mode-hook
(lambda () (doc-view-minor-mode -
1)) nil t
)
1752 (substitute-command-keys
1753 "Type \\[doc-view-toggle-display] to toggle between editing or viewing the document."))))
1755 (defun doc-view-clear-cache ()
1756 "Delete the whole cache (`doc-view-cache-directory')."
1758 (dired-delete-file doc-view-cache-directory
'always
))
1760 (defun doc-view-dired-cache ()
1761 "Open `dired' in `doc-view-cache-directory'."
1763 (dired doc-view-cache-directory
))
1766 ;;;; Bookmark integration
1768 (declare-function bookmark-make-record-default
1769 "bookmark" (&optional no-file no-context posn
))
1770 (declare-function bookmark-prop-get
"bookmark" (bookmark prop
))
1771 (declare-function bookmark-default-handler
"bookmark" (bmk))
1773 (defun doc-view-bookmark-make-record ()
1774 (nconc (bookmark-make-record-default)
1775 `((page .
,(doc-view-current-page))
1776 (handler . doc-view-bookmark-jump
))))
1780 (defun doc-view-bookmark-jump (bmk)
1781 ;; This implements the `handler' function interface for record type
1782 ;; returned by `doc-view-bookmark-make-record', which see.
1783 (prog1 (bookmark-default-handler bmk
)
1784 (let ((page (bookmark-prop-get bmk
'page
)))
1785 (when (not (eq major-mode
'doc-view-mode
))
1786 (doc-view-toggle-display))
1787 (with-selected-window
1788 (or (get-buffer-window (current-buffer) 0)
1790 (doc-view-goto-page page
)))))
1796 ;; eval: (outline-minor-mode 1)
1799 ;;; doc-view.el ends here