This repository has been archived by the owner on Aug 7, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 160
/
Copy pathpdf-view.el
1676 lines (1451 loc) · 62.2 KB
/
pdf-view.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; pdf-view.el --- View PDF documents. -*- lexical-binding:t -*-
;; Copyright (C) 2013 Andreas Politz
;; Author: Andreas Politz <[email protected]>
;; Keywords: files, doc-view, pdf
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Functions related to viewing PDF documents.
;;; Code:
(require 'image-mode)
(require 'pdf-util)
(require 'pdf-info)
(require 'pdf-cache)
(require 'jka-compr)
(require 'bookmark)
(require 'password-cache)
(declare-function cua-copy-region "cua-base")
;; * ================================================================== *
;; * Customizations
;; * ================================================================== *
(defgroup pdf-view nil
"View PDF documents."
:group 'pdf-tools)
(defcustom pdf-view-display-size 'fit-width
"The desired size of displayed pages.
This may be one of `fit-height', `fit-width', `fit-page' or a
number as a scale factor applied to the document's size. Any
other value behaves like `fit-width'."
:group 'pdf-view
:type '(choice number
(const fit-height)
(const fit-width)
(const fit-page)))
(make-variable-buffer-local 'pdf-view-display-size)
(defcustom pdf-view-resize-factor 1.25
"Fractional amount of resizing of one resize command."
:group 'pdf-view
:type 'number)
(defcustom pdf-view-continuous t
"In Continuous mode reaching the page edge advances to next/previous page.
When non-nil, scrolling a line upward at the bottom edge of the page
moves to the next page, and scrolling a line downward at the top edge
of the page moves to the previous page."
:type 'boolean
:group 'pdf-view)
(defcustom pdf-view-bounding-box-margin 0.05
"Fractional margin used for slicing with the bounding-box."
:group 'pdf-view
:type 'number)
(defcustom pdf-view-use-imagemagick nil
"Whether imagemagick should be used for rendering.
This variable has no effect, if imagemagick was not compiled into
Emacs or if imagemagick is the only way to display PNG images.
FIXME: Explain dis-/advantages of imagemagick and png."
:group 'pdf-view
:type 'boolean)
(defcustom pdf-view-use-scaling nil
"Whether images should be allowed to be scaled for rendering.
This variable affects both the reuse of higher-resolution images
as lower-resolution ones by down-scaling the image. As well as
the rendering of higher-resolution for high-resolution displays,
if available.
It has no effect, unless either the imagemagick or image-io
image-format is available."
:group 'pdf-view
:type 'boolean)
(defface pdf-view-region
'((((background dark)) (:inherit region))
(((background light)) (:inherit region)))
"Face used to determine the colors of the region."
:group 'pdf-view
:group 'pdf-tools-faces)
(defface pdf-view-rectangle
'((((background dark)) (:inherit highlight))
(((background light)) (:inherit highlight)))
"Face used to determine the colors of the highlighted rectangle."
:group 'pdf-view
:group 'pdf-tools-faces)
(defcustom pdf-view-midnight-colors '("#839496" . "#002b36" )
"Colors used when `pdf-view-midnight-minor-mode' is activated.
This should be a cons \(FOREGROUND . BACKGROUND\) of colors."
:group 'pdf-view
:type '(cons (color :tag "Foreground")
(color :tag "Background")))
(defcustom pdf-view-change-page-hook nil
"Hook run after changing to another page, but before displaying it.
See also `pdf-view-before-change-page-hook' and
`pdf-view-after-change-page-hook'."
:group 'pdf-view
:type 'hook)
(defcustom pdf-view-before-change-page-hook nil
"Hook run before changing to another page.
See also `pdf-view-change-page-hook' and
`pdf-view-after-change-page-hook'."
:group 'pdf-view
:type 'hook)
(defcustom pdf-view-after-change-page-hook nil
"Hook run after changing to and displaying another page.
See also `pdf-view-change-page-hook' and
`pdf-view-before-change-page-hook'."
:group 'pdf-view
:type 'hook)
(defcustom pdf-view-use-dedicated-register t
"Whether to use dedicated register for PDF positions.
If this is non-nil, the commands `pdf-view-position-to-register'
and `pdf-view-jump-to-register' use the buffer-local variable
`pdf-view-register-alist' to store resp. retrieve marked
positions. Otherwise the common variable `register-alist' is
used."
:group 'pdf-view
:type 'boolean)
(defcustom pdf-view-image-relief 0
"Add a shadow rectangle around the page's image.
See :relief property in Info node `(elisp) Image Descriptors'."
:group 'pdf-view
:type '(integer :tag "Pixel")
:link '(info-link "(elisp) Image Descriptors"))
(defcustom pdf-view-max-image-width 4800
"Maximum width of any image displayed in pixel."
:group 'pdf-view
:type '(integer :tag "Pixel"))
(defcustom pdf-view-use-unicode-ligther t
"Whether to use unicode symbols in the mode-line
On some systems finding a font which supports those symbols can
take some time. If you don't want to spend that time waiting and
don't care for a nicer looking mode-line, set this variable to
nil.
Note, that this option has only an effect when this library is
loaded."
:group 'pdf-view
:type 'boolean)
(defcustom pdf-view-incompatible-modes
'(linum-mode linum-relative-mode helm-linum-relative-mode
nlinum-mode nlinum-hl-mode nlinum-relative-mode yalinum-mode)
"A list of modes incompatible with `pdf-view-mode'.
Issue a warning, if one of them is active in a PDF buffer."
:group 'pdf-view
:type '(repeat symbol))
;; * ================================================================== *
;; * Internal variables and macros
;; * ================================================================== *
(defvar-local pdf-view-active-region nil
"The active region as a list of edges.
Edge values are relative coordinates.")
(defvar-local pdf-view--have-rectangle-region nil
"Non-nil if the region is currently rendered as a rectangle.
This variable is set in `pdf-view-mouse-set-region' and used in
`pdf-view-mouse-extend-region' to determine the right choice
regarding display of the region in the later function.")
(defvar-local pdf-view--buffer-file-name nil
"Local copy of remote file or nil.")
(defvar-local pdf-view--server-file-name nil
"The servers notion of this buffer's filename.")
(defvar-local pdf-view--next-page-timer nil
"Timer used in `pdf-view-next-page-command'.")
(defvar-local pdf-view--hotspot-functions nil
"Alist of hotspot functions.")
(defvar-local pdf-view-register-alist nil
"Local, dedicated register for PDF positions.")
(defmacro pdf-view-current-page (&optional window)
;;TODO: write documentation!
`(image-mode-window-get 'page ,window))
(defmacro pdf-view-current-overlay (&optional window)
;;TODO: write documentation!
`(image-mode-window-get 'overlay ,window))
(defmacro pdf-view-current-image (&optional window)
;;TODO: write documentation!
`(image-mode-window-get 'image ,window))
(defmacro pdf-view-current-slice (&optional window)
;;TODO: write documentation!
`(image-mode-window-get 'slice ,window))
(defmacro pdf-view-current-window-size (&optional window)
;;TODO: write documentation!
`(image-mode-window-get 'window-size ,window))
(defmacro pdf-view-window-needs-redisplay (&optional window)
`(image-mode-window-get 'needs-redisplay ,window))
(defun pdf-view-current-pagelabel (&optional window)
(nth (1- (pdf-view-current-page window)) (pdf-info-pagelabels)))
(defun pdf-view-active-region-p nil
"Return t if there are active regions."
(not (null pdf-view-active-region)))
(defmacro pdf-view-assert-active-region ()
"Signal an error if there are no active regions."
`(unless (pdf-view-active-region-p)
(error "The region is not active")))
(defconst pdf-view-have-image-mode-pixel-vscroll
(>= emacs-major-version 27)
"Whether image-mode scrolls vertically by pixels.")
;; * ================================================================== *
;; * Major Mode
;; * ================================================================== *
(defvar pdf-view-mode-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map image-mode-map)
(define-key map (kbd "Q") 'kill-this-buffer)
;; Navigation in the document
(define-key map (kbd "n") 'pdf-view-next-page-command)
(define-key map (kbd "p") 'pdf-view-previous-page-command)
(define-key map (kbd "<next>") 'forward-page)
(define-key map (kbd "<prior>") 'backward-page)
(define-key map [remap forward-page] 'pdf-view-next-page-command)
(define-key map [remap backward-page] 'pdf-view-previous-page-command)
(define-key map (kbd "SPC") 'pdf-view-scroll-up-or-next-page)
(define-key map (kbd "S-SPC") 'pdf-view-scroll-down-or-previous-page)
(define-key map (kbd "DEL") 'pdf-view-scroll-down-or-previous-page)
(define-key map (kbd "C-n") 'pdf-view-next-line-or-next-page)
(define-key map (kbd "<down>") 'pdf-view-next-line-or-next-page)
(define-key map (kbd "C-p") 'pdf-view-previous-line-or-previous-page)
(define-key map (kbd "<up>") 'pdf-view-previous-line-or-previous-page)
(define-key map (kbd "M-<") 'pdf-view-first-page)
(define-key map (kbd "M->") 'pdf-view-last-page)
(define-key map [remap goto-line] 'pdf-view-goto-page)
(define-key map (kbd "M-g l") 'pdf-view-goto-label)
(define-key map (kbd "RET") 'image-next-line)
;; Zoom in/out.
(define-key map "+" 'pdf-view-enlarge)
(define-key map "=" 'pdf-view-enlarge)
(define-key map "-" 'pdf-view-shrink)
(define-key map "0" 'pdf-view-scale-reset)
;; Fit the image to the window
(define-key map "W" 'pdf-view-fit-width-to-window)
(define-key map "H" 'pdf-view-fit-height-to-window)
(define-key map "P" 'pdf-view-fit-page-to-window)
;; Slicing the image
(define-key map (kbd "s m") 'pdf-view-set-slice-using-mouse)
(define-key map (kbd "s b") 'pdf-view-set-slice-from-bounding-box)
(define-key map (kbd "s r") 'pdf-view-reset-slice)
;; Reconvert
(define-key map (kbd "C-c C-c") 'doc-view-mode)
(define-key map (kbd "g") 'revert-buffer)
(define-key map (kbd "r") 'revert-buffer)
;; Region
(define-key map [down-mouse-1] 'pdf-view-mouse-set-region)
(define-key map [M-down-mouse-1] 'pdf-view-mouse-set-region-rectangle)
(define-key map [C-down-mouse-1] 'pdf-view-mouse-extend-region)
(define-key map [remap kill-region] 'pdf-view-kill-ring-save)
(define-key map [remap kill-ring-save] 'pdf-view-kill-ring-save)
(define-key map [remap mark-whole-buffer] 'pdf-view-mark-whole-page)
;; Other
(define-key map (kbd "C-c C-d") 'pdf-view-dark-minor-mode)
(define-key map (kbd "m") 'pdf-view-position-to-register)
(define-key map (kbd "'") 'pdf-view-jump-to-register)
(define-key map (kbd "C-c C-i") 'pdf-view-extract-region-image)
;; Rendering
(define-key map (kbd "C-c C-r m") 'pdf-view-midnight-minor-mode)
(define-key map (kbd "C-c C-r p") 'pdf-view-printer-minor-mode)
map)
"Keymap used by `pdf-view-mode' when displaying a doc as a set of images.")
(define-derived-mode pdf-view-mode special-mode "PDFView"
"Major mode in PDF buffers.
PDFView Mode is an Emacs PDF viewer. It displays PDF files as
PNG images in Emacs buffers."
:group 'pdf-view
:abbrev-table nil
:syntax-table nil
;; Setup a local copy for remote files.
(when (and (or jka-compr-really-do-compress
(let ((file-name-handler-alist nil))
(not (and buffer-file-name
(file-readable-p buffer-file-name)))))
(pdf-tools-pdf-buffer-p))
(let ((tempfile (pdf-util-make-temp-file
(concat (if buffer-file-name
(file-name-nondirectory
buffer-file-name)
(buffer-name))
"-"))))
(write-region nil nil tempfile nil 'no-message)
(setq-local pdf-view--buffer-file-name tempfile)))
;; Decryption needs to be done before any other function calls into
;; pdf-info.el (e.g. from the mode-line during redisplay during
;; waiting for process output).
(pdf-view-decrypt-document)
;; Setup scroll functions
(if (boundp 'mwheel-scroll-up-function) ; not --without-x build
(setq-local mwheel-scroll-up-function
#'pdf-view-scroll-up-or-next-page))
(if (boundp 'mwheel-scroll-down-function)
(setq-local mwheel-scroll-down-function
#'pdf-view-scroll-down-or-previous-page))
;; Clearing overlays
(add-hook 'change-major-mode-hook
(lambda ()
(remove-overlays (point-min) (point-max) 'pdf-view t))
nil t)
(remove-overlays (point-min) (point-max) 'pdf-view t) ;Just in case.
;; Setup other local variables.
(setq-local mode-line-position
'(" P" (:eval (number-to-string (pdf-view-current-page)))
;; Avoid errors during redisplay.
"/" (:eval (or (ignore-errors
(number-to-string (pdf-cache-number-of-pages)))
"???"))))
(setq-local auto-hscroll-mode nil)
(setq-local pdf-view--server-file-name (pdf-view-buffer-file-name))
;; High values of scroll-conservatively seem to trigger
;; some display bug in xdisp.c:try_scrolling .
(setq-local scroll-conservatively 0)
(setq-local cursor-type nil)
(setq-local buffer-read-only t)
(setq-local view-read-only nil)
(setq-local bookmark-make-record-function
'pdf-view-bookmark-make-record)
(setq-local revert-buffer-function #'pdf-view-revert-buffer)
;; No auto-save at the moment.
(setq-local buffer-auto-save-file-name nil)
;; Disable image rescaling.
(when (boundp 'image-scaling-factor)
(setq-local image-scaling-factor 1))
;; No undo at the moment.
(unless buffer-undo-list
(buffer-disable-undo))
;; Enable transient-mark-mode, so region deactivation when quitting
;; will work.
(setq-local transient-mark-mode t)
;; In Emacs >= 24.4, `cua-copy-region' should have been advised when
;; loading pdf-view.el so as to make it work with
;; pdf-view-mode. Disable cua-mode if that is not the case.
;; FIXME: cua-mode is a global minor-mode, but setting cua-mode to
;; nil seems to do the trick.
(when (and (bound-and-true-p cua-mode)
(version< emacs-version "24.4"))
(setq-local cua-mode nil))
(add-hook 'window-configuration-change-hook
'pdf-view-redisplay-some-windows nil t)
(add-hook 'deactivate-mark-hook 'pdf-view-deactivate-region nil t)
(add-hook 'write-contents-functions
'pdf-view--write-contents-function nil t)
(add-hook 'kill-buffer-hook 'pdf-view-close-document nil t)
(pdf-view-add-hotspot-function
'pdf-view-text-regions-hotspots-function -9)
;; Keep track of display info
(add-hook 'image-mode-new-window-functions
'pdf-view-new-window-function nil t)
(image-mode-setup-winprops)
;; Issue a warning in the future about incompatible modes.
(run-with-timer 1 nil (lambda (buffer)
(when (buffer-live-p buffer)
(pdf-view-check-incompatible-modes buffer)))
(current-buffer)))
(unless (version< emacs-version "24.4")
(defun cua-copy-region--pdf-view-advice (&rest _)
"If the current buffer is in `pdf-view' mode, call
`pdf-view-kill-ring-save'."
(when (eq major-mode 'pdf-view-mode)
(pdf-view-kill-ring-save)
t))
(advice-add 'cua-copy-region
:before-until
#'cua-copy-region--pdf-view-advice))
(defun pdf-view-check-incompatible-modes (&optional buffer)
"Check BUFFER for incompatible modes, maybe issue a warning."
(with-current-buffer (or buffer (current-buffer))
(let ((modes
(cl-remove-if-not
(lambda (mode) (and (symbolp mode)
(boundp mode)
(symbol-value mode)))
pdf-view-incompatible-modes)))
(when modes
(display-warning
'pdf-view
(format "These modes are incompatible with `pdf-view-mode',
please deactivate them (or customize pdf-view-incompatible-modes): %s"
(mapconcat #'symbol-name modes ",")))))))
(defun pdf-view-decrypt-document ()
"Read a password, if the document is encrypted and open it."
(interactive)
(when (pdf-info-encrypted-p)
(let ((prompt (format "Enter password for `%s': "
(abbreviate-file-name
(buffer-file-name))))
(key (concat "/pdf-tools" (buffer-file-name)))
(i 3)
password)
(while (and (> i 0)
(pdf-info-encrypted-p))
(setq i (1- i))
(setq password (password-read prompt key))
(setq prompt "Invalid password, try again: ")
(ignore-errors (pdf-info-open nil password)))
(pdf-info-open nil password)
(password-cache-add key password)))
nil)
(defun pdf-view-buffer-file-name ()
"Return the local filename of the PDF in the current buffer.
This may be different from variable `buffer-file-name' when
operating on a local copy of a remote file."
(or pdf-view--buffer-file-name
(buffer-file-name)))
(defun pdf-view--write-contents-function ()
"Function for `write-contents-functions' to save the buffer."
(when (pdf-util-pdf-buffer-p)
(let ((tempfile (pdf-info-save pdf-view--server-file-name)))
(unwind-protect
(progn
;; Order matters here: We need to first copy the new
;; content (tempfile) to the PDF, and then close the PDF.
;; Since while closing the file (and freeing its resources
;; in the process), it may be immediately reopened due to
;; redisplay happening inside the pdf-info-close function
;; (while waiting for a response from the process.).
(copy-file tempfile (buffer-file-name) t)
(pdf-info-close pdf-view--server-file-name)
(when pdf-view--buffer-file-name
(copy-file tempfile pdf-view--buffer-file-name t))
(clear-visited-file-modtime)
(set-buffer-modified-p nil)
(setq pdf-view--server-file-name
(pdf-view-buffer-file-name))
t)
(when (file-exists-p tempfile)
(delete-file tempfile))))))
(defun pdf-view-revert-buffer (&optional ignore-auto noconfirm)
"Revert buffer while preserving current modes.
Optional parameters IGNORE-AUTO and NOCONFIRM are defined as in
`revert-buffer'."
(interactive (list (not current-prefix-arg)))
;; Bind to default so that we can use pdf-view-revert-buffer as
;; revert-buffer-function. A binding of nil is needed in Emacs 24.3, but in
;; later versions the semantics that nil means the default function should
;; not relied upon.
(let ((revert-buffer-function (when (fboundp #'revert-buffer--default)
#'revert-buffer--default))
(after-revert-hook
(cons #'pdf-info-close
after-revert-hook)))
(prog1
(revert-buffer ignore-auto noconfirm 'preserve-modes)
(pdf-view-redisplay t))))
(defun pdf-view-close-document ()
"Return immediately after closing document.
This function always succeeds. See also `pdf-info-close', which
does not return immediately."
(when (pdf-info-running-p)
(let ((pdf-info-asynchronous 'ignore))
(ignore-errors
(pdf-info-close)))))
;; * ================================================================== *
;; * Scaling
;; * ================================================================== *
(defun pdf-view-fit-page-to-window ()
"Fit PDF to window.
Choose the larger of PDF's height and width, and fits that
dimension to window."
(interactive)
(setq pdf-view-display-size 'fit-page)
(image-set-window-vscroll 0)
(image-set-window-hscroll 0)
(pdf-view-redisplay t))
(defun pdf-view-fit-height-to-window ()
"Fit PDF height to window."
(interactive)
(setq pdf-view-display-size 'fit-height)
(image-set-window-vscroll 0)
(pdf-view-redisplay t))
(defun pdf-view-fit-width-to-window ()
"Fit PDF size to window."
(interactive)
(setq pdf-view-display-size 'fit-width)
(image-set-window-hscroll 0)
(pdf-view-redisplay t))
(defun pdf-view-enlarge (factor)
"Enlarge PDF by FACTOR.
When called interactively, uses the value of
`pdf-view-resize-factor'.
For example, (pdf-view-enlarge 1.25) increases size by 25%."
(interactive
(list (float pdf-view-resize-factor)))
(let* ((size (pdf-view-image-size))
(pagesize (pdf-cache-pagesize
(pdf-view-current-page)))
(scale (/ (float (car size))
(float (car pagesize)))))
(setq pdf-view-display-size
(* factor scale))
(pdf-view-redisplay t)))
(defun pdf-view-shrink (factor)
"Shrink PDF by FACTOR.
When called interactively, uses the value of
`pdf-view-resize-factor'.
For example, (pdf-view-shrink 1.25) decreases size by 20%."
(interactive
(list (float pdf-view-resize-factor)))
(pdf-view-enlarge (/ 1.0 factor)))
(defun pdf-view-scale-reset ()
"Reset PDF to its default set."
(interactive)
(setq pdf-view-display-size 1.0)
(pdf-view-redisplay t))
;; * ================================================================== *
;; * Moving by pages and scrolling
;; * ================================================================== *
(defun pdf-view-goto-page (page &optional window)
"Go to PAGE in PDF.
If optional parameter WINDOW, go to PAGE in all `pdf-view'
windows."
(interactive
(list (if current-prefix-arg
(prefix-numeric-value current-prefix-arg)
(read-number "Page: "))))
(unless (and (>= page 1)
(<= page (pdf-cache-number-of-pages)))
(error "No such page: %d" page))
(unless window
(setq window
(if (pdf-util-pdf-window-p)
(selected-window)
t)))
(save-selected-window
;; Select the window for the hooks below.
(when (window-live-p window)
(select-window window))
(let ((changing-p
(not (eq page (pdf-view-current-page window)))))
(when changing-p
(run-hooks 'pdf-view-before-change-page-hook)
(setf (pdf-view-current-page window) page)
(run-hooks 'pdf-view-change-page-hook))
(when (window-live-p window)
(pdf-view-redisplay window))
(when changing-p
(pdf-view-deactivate-region)
(force-mode-line-update)
(run-hooks 'pdf-view-after-change-page-hook))))
nil)
(defun pdf-view-next-page (&optional n)
"View the next page in the PDF.
Optional parameter N moves N pages forward."
(interactive "p")
(pdf-view-goto-page (+ (pdf-view-current-page)
(or n 1))))
(defun pdf-view-previous-page (&optional n)
"View the previous page in the PDF.
Optional parameter N moves N pages backward."
(interactive "p")
(pdf-view-next-page (- (or n 1))))
(defun pdf-view-next-page-command (&optional n)
"View the next page in the PDF.
Optional parameter N moves N pages forward.
This command is a wrapper for `pdf-view-next-page' that will
indicate to the user if they are on the last page and more."
(declare (interactive-only pdf-view-next-page))
(interactive "p")
(unless n (setq n 1))
(when (> (+ (pdf-view-current-page) n)
(pdf-cache-number-of-pages))
(user-error "Last page"))
(when (< (+ (pdf-view-current-page) n) 1)
(user-error "First page"))
(let ((pdf-view-inhibit-redisplay t))
(pdf-view-goto-page
(+ (pdf-view-current-page) n)))
(force-mode-line-update)
(sit-for 0)
(when pdf-view--next-page-timer
(cancel-timer pdf-view--next-page-timer)
(setq pdf-view--next-page-timer nil))
(if (or (not (input-pending-p))
(and (> n 0)
(= (pdf-view-current-page)
(pdf-cache-number-of-pages)))
(and (< n 0)
(= (pdf-view-current-page) 1)))
(pdf-view-redisplay)
(setq pdf-view--next-page-timer
(run-with-idle-timer 0.001 nil 'pdf-view-redisplay (selected-window)))))
(defun pdf-view-previous-page-command (&optional n)
"View the previous page in the PDF.
Optional parameter N moves N pages backward.
This command is a wrapper for `pdf-view-previous-page'."
(declare (interactive-only pdf-view-previous-page))
(interactive "p")
(with-no-warnings
(pdf-view-next-page-command (- (or n 1)))))
(defun pdf-view-first-page ()
"View the first page."
(interactive)
(pdf-view-goto-page 1))
(defun pdf-view-last-page ()
"View the last page."
(interactive)
(pdf-view-goto-page (pdf-cache-number-of-pages)))
(defun pdf-view-scroll-up-or-next-page (&optional arg)
"Scroll page up ARG lines if possible, else go to the next page.
When `pdf-view-continuous' is non-nil, scrolling upward at the
bottom edge of the page moves to the next page. Otherwise, go to
next page only on typing SPC (ARG is nil)."
(interactive "P")
(if (or pdf-view-continuous (null arg))
(let ((hscroll (window-hscroll))
(cur-page (pdf-view-current-page)))
(when (or (= (window-vscroll nil pdf-view-have-image-mode-pixel-vscroll)
(image-scroll-up arg))
;; Workaround rounding/off-by-one issues.
(memq pdf-view-display-size
'(fit-height fit-page)))
(pdf-view-next-page)
(when (/= cur-page (pdf-view-current-page))
(image-bob)
(image-bol 1))
(image-set-window-hscroll hscroll)))
(image-scroll-up arg)))
(defun pdf-view-scroll-down-or-previous-page (&optional arg)
"Scroll page down ARG lines if possible, else go to the previous page.
When `pdf-view-continuous' is non-nil, scrolling downward at the
top edge of the page moves to the previous page. Otherwise, go
to previous page only on typing DEL (ARG is nil)."
(interactive "P")
(if (or pdf-view-continuous (null arg))
(let ((hscroll (window-hscroll))
(cur-page (pdf-view-current-page)))
(when (or (= (window-vscroll nil pdf-view-have-image-mode-pixel-vscroll)
(image-scroll-down arg))
;; Workaround rounding/off-by-one issues.
(memq pdf-view-display-size
'(fit-height fit-page)))
(pdf-view-previous-page)
(when (/= cur-page (pdf-view-current-page))
(image-eob)
(image-bol 1))
(image-set-window-hscroll hscroll)))
(image-scroll-down arg)))
(defun pdf-view-next-line-or-next-page (&optional arg)
"Scroll upward by ARG lines if possible, else go to the next page.
When `pdf-view-continuous' is non-nil, scrolling a line upward
at the bottom edge of the page moves to the next page."
(interactive "p")
(if pdf-view-continuous
(let ((hscroll (window-hscroll))
(cur-page (pdf-view-current-page)))
(when (= (window-vscroll nil pdf-view-have-image-mode-pixel-vscroll)
(image-next-line arg))
(pdf-view-next-page)
(when (/= cur-page (pdf-view-current-page))
(image-bob)
(image-bol 1))
(image-set-window-hscroll hscroll)))
(image-next-line 1)))
(defun pdf-view-previous-line-or-previous-page (&optional arg)
"Scroll downward by ARG lines if possible, else go to the previous page.
When `pdf-view-continuous' is non-nil, scrolling a line downward
at the top edge of the page moves to the previous page."
(interactive "p")
(if pdf-view-continuous
(let ((hscroll (window-hscroll))
(cur-page (pdf-view-current-page)))
(when (= (window-vscroll nil pdf-view-have-image-mode-pixel-vscroll)
(image-previous-line arg))
(pdf-view-previous-page)
(when (/= cur-page (pdf-view-current-page))
(image-eob)
(image-bol 1))
(image-set-window-hscroll hscroll)))
(image-previous-line arg)))
(defun pdf-view-goto-label (label)
"Go to the page corresponding to LABEL.
Usually, the label of a document's page is the same as its
displayed page number."
(interactive
(list (let ((labels (pdf-info-pagelabels)))
(completing-read "Goto label: " labels nil t))))
(let ((index (cl-position label (pdf-info-pagelabels) :test 'equal)))
(unless index
(error "No such label: %s" label))
(pdf-view-goto-page (1+ index))))
;; * ================================================================== *
;; * Slicing
;; * ================================================================== *
(defun pdf-view-set-slice (x y width height &optional window)
;; TODO: add WINDOW to docstring.
"Set the slice of the pages that should be displayed.
X, Y, WIDTH and HEIGHT should be relative coordinates, i.e. in
\[0;1\]. To reset the slice use `pdf-view-reset-slice'."
(unless (equal (pdf-view-current-slice window)
(list x y width height))
(setf (pdf-view-current-slice window)
(mapcar (lambda (v)
(max 0 (min 1 v)))
(list x y width height)))
(pdf-view-redisplay window)))
(defun pdf-view-set-slice-using-mouse ()
"Set the slice of the images that should be displayed.
Set the slice by pressing `mouse-1' at its top-left corner and
dragging it to its bottom-right corner. See also
`pdf-view-set-slice' and `pdf-view-reset-slice'."
(interactive)
(let ((size (pdf-view-image-size))
x y w h done)
(while (not done)
(let ((e (read-event
(concat "Press mouse-1 at the top-left corner and "
"drag it to the bottom-right corner!"))))
(when (eq (car e) 'drag-mouse-1)
(setq x (car (posn-object-x-y (event-start e))))
(setq y (cdr (posn-object-x-y (event-start e))))
(setq w (- (car (posn-object-x-y (event-end e))) x))
(setq h (- (cdr (posn-object-x-y (event-end e))) y))
(setq done t))))
(apply 'pdf-view-set-slice
(pdf-util-scale
(list x y w h)
(cons (/ 1.0 (float (car size)))
(/ 1.0 (float (cdr size))))))))
(defun pdf-view-set-slice-from-bounding-box (&optional window)
;; TODO: add WINDOW to docstring.
"Set the slice from the page's bounding-box.
The result is that the margins are almost completely cropped,
much more accurate than could be done manually using
`pdf-view-set-slice-using-mouse'.
See also `pdf-view-bounding-box-margin'."
(interactive)
(let* ((bb (pdf-cache-boundingbox (pdf-view-current-page window)))
(margin (max 0 (or pdf-view-bounding-box-margin 0)))
(slice (list (- (nth 0 bb)
(/ margin 2.0))
(- (nth 1 bb)
(/ margin 2.0))
(+ (- (nth 2 bb) (nth 0 bb))
margin)
(+ (- (nth 3 bb) (nth 1 bb))
margin))))
(apply 'pdf-view-set-slice
(append slice (and window (list window))))))
(defun pdf-view-reset-slice (&optional window)
;; TODO: add WINDOW to doctring.
"Reset the current slice.
After calling this function the whole page will be visible
again."
(interactive)
(when (pdf-view-current-slice window)
(setf (pdf-view-current-slice window) nil)
(pdf-view-redisplay window))
nil)
(define-minor-mode pdf-view-auto-slice-minor-mode
"Automatically slice pages according to their bounding boxes.
See also `pdf-view-set-slice-from-bounding-box'."
nil nil nil
(pdf-util-assert-pdf-buffer)
(cond
(pdf-view-auto-slice-minor-mode
(dolist (win (get-buffer-window-list nil nil t))
(when (pdf-util-pdf-window-p win)
(pdf-view-set-slice-from-bounding-box win)))
(add-hook 'pdf-view-change-page-hook
'pdf-view-set-slice-from-bounding-box nil t))
(t
(remove-hook 'pdf-view-change-page-hook
'pdf-view-set-slice-from-bounding-box t))))
;; * ================================================================== *
;; * Display
;; * ================================================================== *
(defvar pdf-view-inhibit-redisplay nil)
(defvar pdf-view-inhibit-hotspots nil)
(defun pdf-view-image-type ()
"Return the image type that should be used.
The return value is either `imagemagick' (if available and wanted
or if png is not available) or `png'.
Signal an error, if neither `imagemagick' nor `png' is available.
See also `pdf-view-use-imagemagick'."
(cond ((and pdf-view-use-imagemagick
(fboundp 'imagemagick-types))
'imagemagick)
((image-type-available-p 'image-io)
'image-io)
((image-type-available-p 'png)
'png)
((fboundp 'imagemagick-types)
'imagemagick)
(t
(error "PNG image supported not compiled into Emacs"))))
(defun pdf-view-use-scaling-p ()
"Return t if scaling should be used."
(and (memq (pdf-view-image-type)
'(imagemagick image-io))
pdf-view-use-scaling))
(defmacro pdf-view-create-image (data &rest props)
;; TODO: add DATA and PROPS to docstring.
"Like `create-image', but with set DATA-P and TYPE arguments."
(declare (indent 1) (debug t))
(let ((image-data (make-symbol "data")))
`(let ((,image-data ,data))
(apply #'create-image ,image-data (pdf-view-image-type) t ,@props
(cl-list*
:relief (or pdf-view-image-relief 0)
(when (and (eq (framep-on-display) 'mac)
(= (pdf-util-frame-scale-factor) 2))
(list :data-2x ,image-data)))))))
(defun pdf-view-create-page (page &optional window)
"Create an image of PAGE for display on WINDOW."
(let* ((size (pdf-view-desired-image-size page window))
(data (pdf-cache-renderpage
page (car size)
(if (not (pdf-view-use-scaling-p))
(car size)
(* 2 (car size)))))
(hotspots (pdf-view-apply-hotspot-functions
window page size)))
(pdf-view-create-image data
:width (car size)
:map hotspots
:pointer 'arrow)))
(defun pdf-view-image-size (&optional displayed-p window)
;; TODO: add WINDOW to docstring.
"Return the size in pixel of the current image.
If DISPLAYED-P is non-nil, return the size of the displayed
image. These values may be different, if slicing is used."
(if displayed-p
(with-selected-window (or window (selected-window))
(image-display-size
(image-get-display-property) t))
(image-size (pdf-view-current-image window) t)))
(defun pdf-view-image-offset (&optional window)
;; TODO: add WINDOW to docstring.
"Return the offset of the current image.
It is equal to \(LEFT . TOP\) of the current slice in pixel."
(let* ((slice (pdf-view-current-slice window)))
(cond
(slice
(pdf-util-scale-relative-to-pixel
(cons (nth 0 slice) (nth 1 slice))
window))
(t
(cons 0 0)))))
(defun pdf-view-display-page (page &optional window)
"Display page PAGE in WINDOW."
(setf (pdf-view-window-needs-redisplay window) nil)
(pdf-view-display-image
(pdf-view-create-page page window)
window))
(defun pdf-view-display-image (image &optional window inhibit-slice-p)
;; TODO: write documentation!
(let ((ol (pdf-view-current-overlay window)))