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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446
|
;;; pdf-view.el --- View PDF documents. -*- lexical-binding:t -*-
;; Copyright (C) 2013 Andreas Politz
;; Author: Andreas Politz <politza@fh-trier.de>
;; 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:
;;
;;; Code:
;;
(require 'image-mode)
(require 'pdf-util)
(require 'pdf-info)
(require 'pdf-cache)
(require 'jka-compr)
(require 'bookmark)
;; * ================================================================== *
;; * 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 down for rendering.
This variable has no effect, if imagemagick was not compiled into
Emacs or `pdf-view-use-imagemagick' is nil. FIXME: Explain
dis-/advantages of imagemagick and png."
: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"))
;; * ================================================================== *
;; * 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)
`(image-mode-window-get 'page ,window))
(defmacro pdf-view-current-overlay (&optional window)
`(image-mode-window-get 'overlay ,window))
(defmacro pdf-view-current-image (&optional window)
`(image-mode-window-get 'image ,window))
(defmacro pdf-view-current-slice (&optional window)
`(image-mode-window-get 'slice ,window))
(defmacro pdf-view-current-window-size (&optional window)
`(image-mode-window-get 'window-size ,window))
(defun pdf-view-active-region-p nil
(not (null pdf-view-active-region)))
(defmacro pdf-view-assert-active-region ()
`(unless (pdf-view-active-region-p)
(error "The region is not active")))
;; * ================================================================== *
;; * 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)))
;; 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)))
"/" (:eval (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)
;; 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)
(add-hook 'window-configuration-change-hook
'pdf-view-maybe-redisplay-resized-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)
;; Setup initial page and start display
(pdf-view-goto-page (or (pdf-view-current-page) 1)))
(defun pdf-view-buffer-file-name ()
"Return the local filename of the PDF in the current buffer.
This may be different from `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
(pdf-info-close pdf-view--server-file-name)
(copy-file tempfile (buffer-file-name) t)
(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)
"Like `revert-buffer', but preserves the buffer's current modes."
(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 ()
"Like `pdf-info-close', but returns immediately."
(when (pdf-info-running-p)
(let ((pdf-info-asynchronous 'ignore))
(pdf-info-close))))
;; * ================================================================== *
;; * Scaling
;; * ================================================================== *
(defun pdf-view-fit-page-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 ()
(interactive)
(setq pdf-view-display-size 'fit-height)
(image-set-window-vscroll 0)
(pdf-view-redisplay t))
(defun pdf-view-fit-width-to-window ()
(interactive)
(setq pdf-view-display-size 'fit-width)
(image-set-window-hscroll 0)
(pdf-view-redisplay t))
(defun pdf-view-enlarge (factor)
(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)
(interactive
(list (float pdf-view-resize-factor)))
(pdf-view-enlarge (/ 1.0 factor)))
(defun pdf-view-scale-reset ()
(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)
(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)
(interactive "p")
(pdf-view-goto-page (+ (pdf-view-current-page)
(or n 1))))
(defun pdf-view-previous-page (&optional n)
(interactive "p")
(pdf-view-next-page (- (or n 1))))
(defun pdf-view-next-page-command (&optional n)
(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)
(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 goto next page.
When `pdf-view-continuous' is non-nil, scrolling upward
at the bottom edge of the page moves to the next page.
Otherwise, goto next page only on typing SPC (ARG is nil)."
(interactive "P")
(if (or pdf-view-continuous (null arg))
(let ((hscroll (window-hscroll))
(cur-page (pdf-view-current-page)))
(when (or (= (window-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))
(set-window-hscroll (selected-window) hscroll)))
(image-scroll-up arg)))
(defun pdf-view-scroll-down-or-previous-page (&optional arg)
"Scroll page down ARG lines if possible, else goto previous page.
When `pdf-view-continuous' is non-nil, scrolling downward
at the top edge of the page moves to the previous page.
Otherwise, goto previous page only on typing DEL (ARG is nil)."
(interactive "P")
(if (or pdf-view-continuous (null arg))
(let ((hscroll (window-hscroll))
(cur-page (pdf-view-current-page)))
(when (or (= (window-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))
(set-window-hscroll (selected-window) hscroll)))
(image-scroll-down arg)))
(defun pdf-view-next-line-or-next-page (&optional arg)
"Scroll upward by ARG lines if possible, else goto 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) (image-next-line arg))
(pdf-view-next-page)
(when (/= cur-page (pdf-view-current-page))
(image-bob)
(image-bol 1))
(set-window-hscroll (selected-window) hscroll)))
(image-next-line 1)))
(defun pdf-view-previous-line-or-previous-page (&optional arg)
"Scroll downward by ARG lines if possible, else goto 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) (image-previous-line arg))
(pdf-view-previous-page)
(when (/= cur-page (pdf-view-current-page))
(image-eob)
(image-bol 1))
(set-window-hscroll (selected-window) hscroll)))
(image-previous-line arg)))
(defun pdf-view-goto-label (label)
"Goto the page corresponding to LABEL.
Usually the label of a document's page is the same as it's
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)
"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.
You 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)
"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)
"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 which 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 'png)
'png)
((fboundp 'imagemagick-types)
'imagemagick)
(t
(error "PNG image supported not compiled into Emacs"))))
(defun pdf-view-use-scaling-p ()
(and (eq 'imagemagick
(pdf-view-image-type))
pdf-view-use-scaling))
(defmacro pdf-view-create-image (data &rest props)
"Like `create-image', but with set DATA-P and TYPE arguments."
(declare (indent 1) (debug t))
`(create-image ,data (pdf-view-image-type) t ,@props
:relief (or pdf-view-image-relief 0)))
(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)
"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)
"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."
(pdf-view-display-image
(pdf-view-create-page page window)
window))
(defun pdf-view-display-image (image &optional window inhibit-slice-p)
(let ((ol (pdf-view-current-overlay window)))
(when (window-live-p (overlay-get ol 'window))
(let* ((size (image-size image t))
(slice (if (not inhibit-slice-p)
(pdf-view-current-slice window)))
(displayed-width (floor
(if slice
(* (nth 2 slice)
(car (image-size image)))
(car (image-size image))))))
(setf (pdf-view-current-image window) image)
(move-overlay ol (point-min) (point-max))
;; In case the window is wider than the image, center the image
;; horizontally.
(overlay-put ol 'before-string
(when (> (window-width window)
displayed-width)
(propertize " " 'display
`(space :align-to
,(/ (- (window-width window)
displayed-width) 2)))))
(overlay-put ol 'display
(if slice
(list (cons 'slice
(pdf-util-scale slice size 'round))
image)
image))
(let* ((win (overlay-get ol 'window))
(hscroll (image-mode-window-get 'hscroll win))
(vscroll (image-mode-window-get 'vscroll win)))
;; Reset scroll settings, in case they were changed.
(if hscroll (set-window-hscroll win hscroll))
(if vscroll (set-window-vscroll win vscroll)))))))
(defun pdf-view-redisplay (&optional window)
"Redisplay page in WINDOW.
If WINDOW is t, redisplay pages in all windows."
(unless pdf-view-inhibit-redisplay
(if (not (eq t window))
(pdf-view-display-page
(pdf-view-current-page window)
window)
(dolist (win (get-buffer-window-list nil nil t))
(pdf-view-display-page
(pdf-view-current-page win)
win)))
(force-mode-line-update)))
(defun pdf-view-redisplay-pages (&rest pages)
(pdf-util-assert-pdf-buffer)
(dolist (window (get-buffer-window-list nil nil t))
(when (memq (pdf-view-current-page window)
pages)
(pdf-view-redisplay window))))
(defun pdf-view-maybe-redisplay-resized-windows ()
"Redisplay some windows needing redisplay."
(unless (or (numberp pdf-view-display-size)
(pdf-view-active-region-p)
(> (minibuffer-depth) 0))
(dolist (window (get-buffer-window-list nil nil t))
(let ((stored (pdf-view-current-window-size window))
(size (cons (window-width window)
(window-height window))))
(unless (equal size stored)
(setf (pdf-view-current-window-size window) size)
(unless (or (null stored)
(and (eq pdf-view-display-size 'fit-width)
(eq (car size) (car stored)))
(and (eq pdf-view-display-size 'fit-height)
(eq (cdr size) (cdr stored))))
(pdf-view-redisplay window)))))))
(defun pdf-view-new-window-function (winprops)
;; (message "New window %s for buf %s" (car winprops) (current-buffer))
(cl-assert (or (eq t (car winprops))
(eq (window-buffer (car winprops)) (current-buffer))))
(let ((ol (image-mode-window-get 'overlay winprops)))
(if ol
(progn
(setq ol (copy-overlay ol))
;; `ol' might actually be dead.
(move-overlay ol (point-min) (point-max)))
(setq ol (make-overlay (point-min) (point-max) nil t))
(overlay-put ol 'pdf-view t))
(overlay-put ol 'window (car winprops))
(unless (windowp (car winprops))
;; It's a pseudo entry. Let's make sure it's not displayed (the
;; `window' property is only effective if its value is a window).
(cl-assert (eq t (car winprops)))
(delete-overlay ol))
(image-mode-window-put 'overlay ol winprops)
;; Clean up some overlays.
(dolist (ov (overlays-in (point-min) (point-max)))
(when (and (windowp (overlay-get ov 'window))
(not (window-live-p (overlay-get ov 'window))))
(delete-overlay ov)))
(when (and (windowp (car winprops))
(null (image-mode-window-get 'image winprops)))
;; We're not displaying an image yet, so let's do so. This
;; happens when the buffer is displayed for the first time.
(with-selected-window (car winprops)
(pdf-view-goto-page
(or (image-mode-window-get 'page t) 1))))))
(defun pdf-view-desired-image-size (&optional page window)
(let* ((pagesize (pdf-cache-pagesize
(or page (pdf-view-current-page window))))
(slice (pdf-view-current-slice window))
(width-scale (/ (/ (float (pdf-util-window-pixel-width window))
(or (nth 2 slice) 1.0))
(float (car pagesize))))
(height (- (nth 3 (window-inside-pixel-edges window))
(nth 1 (window-inside-pixel-edges window))
1))
(height-scale (/ (/ (float height)
(or (nth 3 slice) 1.0))
(float (cdr pagesize))))
(scale width-scale))
(if (numberp pdf-view-display-size)
(setq scale (float pdf-view-display-size))
(cl-case pdf-view-display-size
(fit-page
(setq scale (min height-scale width-scale)))
(fit-height
(setq scale height-scale))
(t
(setq scale width-scale))))
(let ((width (floor (* (car pagesize) scale)))
(height (floor (* (cdr pagesize) scale))))
(when (> width (max 1 (or pdf-view-max-image-width width)))
(setq width pdf-view-max-image-width
height (* height (/ (float pdf-view-max-image-width) width))))
(cons (max 1 width) (max 1 height)))))
(defun pdf-view-text-regions-hotspots-function (page size)
"Return a list of hotspots for text regions on PAGE using SIZE.
This will display a text cursor, when hovering over them."
(local-set-key [pdf-view-text-region t]
'pdf-util-image-map-mouse-event-proxy)
(mapcar (lambda (region)
(let ((e (pdf-util-scale region size 'round)))
`((rect . ((,(nth 0 e) . ,(nth 1 e))
. (,(nth 2 e) . ,(nth 3 e))))
pdf-view-text-region
(pointer text))))
(pdf-cache-textregions page)))
(define-minor-mode pdf-view-dark-minor-mode
"Mode for PDF documents with dark background.
This tells the various modes to use their face's dark colors."
nil nil nil
(pdf-util-assert-pdf-buffer)
;; FIXME: This should really be run in a hook.
(when (bound-and-true-p pdf-isearch-active-mode)
(with-no-warnings
(pdf-isearch-redisplay)
(pdf-isearch-message
(if pdf-view-dark-minor-mode "dark mode" "light mode")))))
(define-minor-mode pdf-view-printer-minor-mode
"Display the PDF as it would be printed."
nil " Prn" nil
(pdf-util-assert-pdf-buffer)
(let ((enable (lambda ()
(pdf-info-setoptions :render/printed t))))
(cond
(pdf-view-printer-minor-mode
(add-hook 'after-save-hook enable nil t)
(add-hook 'after-revert-hook enable nil t))
(t
(remove-hook 'after-save-hook enable t)
(remove-hook 'after-revert-hook enable t))))
(pdf-info-setoptions :render/printed pdf-view-printer-minor-mode)
(pdf-cache-clear-images)
(pdf-view-redisplay t))
(define-minor-mode pdf-view-midnight-minor-mode
"Apply a color-filter appropriate for past midnight reading.
The colors are determined by the variable
`pdf-view-midnight-colors', which see. "
nil " Mid" nil
(pdf-util-assert-pdf-buffer)
;; FIXME: Maybe these options should be passed stateless to pdf-info-renderpage ?
(let ((enable (lambda ()
(pdf-info-setoptions
:render/foreground (or (car pdf-view-midnight-colors) "black")
:render/background (or (cdr pdf-view-midnight-colors) "white")
:render/usecolors t))))
(cond
(pdf-view-midnight-minor-mode
(add-hook 'after-save-hook enable nil t)
(add-hook 'after-revert-hook enable nil t)
(funcall enable))
(t
(remove-hook 'after-save-hook enable t)
(remove-hook 'after-revert-hook enable t)
(pdf-info-setoptions :render/usecolors nil))))
(pdf-cache-clear-images)
(pdf-view-redisplay t))
(and (char-displayable-p ?⎙)
(setcdr (assq 'pdf-view-printer-minor-mode minor-mode-alist)
(list " ⎙" )))
(and (char-displayable-p ?🌙)
(setcdr (assq 'pdf-view-midnight-minor-mode minor-mode-alist)
(list " 🌙" )))
;; * ================================================================== *
;; * Hotspot handling
;; * ================================================================== *
(defun pdf-view-add-hotspot-function (fn &optional layer)
"Register FN as a hotspot function in the current buffer, using LAYER.
FN will be called in the PDF buffer with the page-number and the
image size \(WIDTH . HEIGHT\) as arguments. It should return a
list of hotspots applicable to the the :map image-property.
LAYER determines the order: Functions in a higher LAYER will
supercede hotspots in lower ones."
(push (cons (or layer 0) fn)
pdf-view--hotspot-functions))
(defun pdf-view-remove-hotspot-function (fn)
"Unregister FN as a hotspot function in the current buffer."
(setq pdf-view--hotspot-functions
(cl-remove fn pdf-view--hotspot-functions
:key 'cdr)))
(defun pdf-view-sorted-hotspot-functions ()
(mapcar 'cdr (cl-sort (copy-sequence pdf-view--hotspot-functions)
'> :key 'car)))
(defun pdf-view-apply-hotspot-functions (window page image-size)
(unless pdf-view-inhibit-hotspots
(save-selected-window
(when window (select-window window))
(apply 'nconc
(mapcar (lambda (fn)
(funcall fn page image-size))
(pdf-view-sorted-hotspot-functions))))))
;; * ================================================================== *
;; * Region
;; * ================================================================== *
(defun pdf-view--push-mark ()
(let (mark-ring)
(push-mark-command nil))
(setq deactivate-mark nil))
(defun pdf-view-active-region (&optional deactivate-p)
"Return the active region, a list of edges.
Deactivate the region if DEACTIVATE-P is non-nil."
(pdf-view-assert-active-region)
(prog1
pdf-view-active-region
(when deactivate-p
(pdf-view-deactivate-region))))
(defun pdf-view-deactivate-region ()
"Deactivate the region."
(interactive)
(when pdf-view-active-region
(setq pdf-view-active-region nil)
(deactivate-mark)
(pdf-view-redisplay t)))
(defun pdf-view-mouse-set-region (event &optional allow-extend-p
rectangle-p)
"Selects a region of text using the mouse.
Allow for stacking of regions, if ALLOW-EXTEND-P is non-nil.
Create a rectangular region, if RECTANGLE-P is non-nil.
Stores the region in `pdf-view-active-region'."
(interactive "@e")
(setq pdf-view--have-rectangle-region rectangle-p)
(unless (and (eventp event)
(mouse-event-p event))
(signal 'wrong-type-argument (list 'mouse-event-p event)))
(unless (and allow-extend-p
(or (null (get this-command 'pdf-view-region-window))
(equal (get this-command 'pdf-view-region-window)
(selected-window))))
(pdf-view-deactivate-region))
(put this-command 'pdf-view-region-window
(selected-window))
(let* ((window (selected-window))
(pos (event-start event))
(begin-inside-image-p t)
(begin (if (posn-image pos)
(posn-object-x-y pos)
(setq begin-inside-image-p nil)
(posn-x-y pos)))
(abs-begin (posn-x-y pos))
pdf-view-continuous
region)
(when (pdf-util-track-mouse-dragging (event 0.15)
(let* ((pos (event-start event))
(end (posn-object-x-y pos))
(end-inside-image-p
(and (eq window (posn-window pos))
(posn-image pos))))
(when (or end-inside-image-p
begin-inside-image-p)
(cond
((and end-inside-image-p
(not begin-inside-image-p))
;; Started selection ouside the image, setup begin.
(let* ((xy (posn-x-y pos))
(dxy (cons (- (car xy) (car begin))
(- (cdr xy) (cdr begin))))
(size (pdf-view-image-size t)))
(setq begin (cons (max 0 (min (car size)
(- (car end) (car dxy))))
(max 0 (min (cdr size)
(- (cdr end) (cdr dxy)))))
;; Store absolute position for later.
abs-begin (cons (- (car xy)
(- (car end)
(car begin)))
(- (cdr xy)
(- (cdr end)
(cdr begin))))
begin-inside-image-p t)))
((and begin-inside-image-p
(not end-inside-image-p))
;; Moved outside the image, setup end.
(let* ((xy (posn-x-y pos))
(dxy (cons (- (car xy) (car abs-begin))
(- (cdr xy) (cdr abs-begin))))
(size (pdf-view-image-size t)))
(setq end (cons (max 0 (min (car size)
(+ (car begin) (car dxy))))
(max 0 (min (cdr size)
(+ (cdr begin) (cdr dxy)))))))))
(let ((iregion (if rectangle-p
(list (min (car begin) (car end))
(min (cdr begin) (cdr end))
(max (car begin) (car end))
(max (cdr begin) (cdr end)))
(list (car begin) (cdr begin)
(car end) (cdr end)))))
(setq region
(pdf-util-scale-pixel-to-relative iregion))
(pdf-view-display-region
(cons region pdf-view-active-region)
rectangle-p)
(pdf-util-scroll-to-edges iregion)))))
(setq pdf-view-active-region
(append pdf-view-active-region
(list region)))
(pdf-view--push-mark))))
(defun pdf-view-mouse-extend-region (event)
"Extend the currently active region."
(interactive "@e")
(pdf-view-mouse-set-region
event t pdf-view--have-rectangle-region))
(defun pdf-view-mouse-set-region-rectangle (event)
"Like `pdf-view-mouse-set-region' but displays as a rectangle.
This is more useful for commands like
`pdf-view-extract-region-image'."
(interactive "@e")
(pdf-view-mouse-set-region event nil t))
(defun pdf-view-display-region (&optional region rectangle-p)
(unless region
(pdf-view-assert-active-region)
(setq region pdf-view-active-region))
(let ((colors (pdf-util-face-colors
(if rectangle-p 'pdf-view-rectangle 'pdf-view-region)
(bound-and-true-p pdf-view-dark-minor-mode)))
(page (pdf-view-current-page))
(width (car (pdf-view-image-size))))
(pdf-view-display-image
(pdf-view-create-image
(if rectangle-p
(pdf-info-renderpage-highlight
page width nil
`(,(car colors) ,(cdr colors) 0.35 ,@region))
(pdf-info-renderpage-text-regions
page width nil nil
`(,(car colors) ,(cdr colors) ,@region)))))))
(defun pdf-view-kill-ring-save ()
"Copy the region to the `kill-ring'."
(interactive)
(pdf-view-assert-active-region)
(let* ((txt (pdf-view-active-region-text)))
(pdf-view-deactivate-region)
(kill-new (mapconcat 'identity txt "\n"))))
(defun pdf-view-mark-whole-page ()
"Mark the whole page."
(interactive)
(pdf-view-deactivate-region)
(setq pdf-view-active-region
(list (list 0 0 1 1)))
(pdf-view--push-mark)
(pdf-view-display-region))
(defun pdf-view-active-region-text ()
"Return the text of the active region as a list of strings."
(pdf-view-assert-active-region)
(mapcar
(apply-partially 'pdf-info-gettext (pdf-view-current-page))
pdf-view-active-region))
(defun pdf-view-extract-region-image (regions &optional page size
output-buffer no-display-p)
"Create a PNG image of REGIONS.
REGIONS should have the same form as `pdf-view-active-region',
which see. PAGE and size are the page resp. base-size of the
image from which the image-regions will be created; they default
to `pdf-view-current-page' resp. `pdf-view-image-size'.
Put the image in OUTPUT-BUFFER, defaulting to \"*PDF region
image*\" and display it, unless NO-DISPLAY-P is non-nil.
In case of multiple regions, the resulting image is constructed
by joining them horizontally. For this operation (and this only)
the `convert' programm is used. "
(interactive
(list (if (pdf-view-active-region-p)
(pdf-view-active-region t)
'((0 0 1 1)))))
(unless page
(setq page (pdf-view-current-page)))
(unless size
(setq size (pdf-view-image-size)))
(unless output-buffer
(setq output-buffer (get-buffer-create "*PDF image*")))
(let* ((images (mapcar (lambda (edges)
(let ((file (make-temp-file "pdf-view"))
(coding-system-for-write 'binary))
(write-region
(pdf-info-renderpage
page (car size)
:crop-to edges)
nil file nil 'no-message)
file))
regions))
result)
(unwind-protect
(progn
(if (= (length images) 1)
(setq result (car images))
(setq result (make-temp-file "pdf-view"))
;; Join the images horizontally with a gap of 10 pixel.
(pdf-util-convert
"-noop" ;; workaround limitations of this function
result
:commands `("("
,@images
"-background" "white"
"-splice" "0x10+0+0"
")"
"-gravity" "Center"
"-append"
"+gravity"
"-chop" "0x10+0+0")
:apply '((0 0 0 0))))
(with-current-buffer output-buffer
(let ((inhibit-read-only t))
(erase-buffer))
(set-buffer-multibyte nil)
(insert-file-contents-literally result)
(image-mode)
(unless no-display-p
(pop-to-buffer (current-buffer)))))
(dolist (f (cons result images))
(when (file-exists-p f)
(delete-file f))))))
;; * ================================================================== *
;; * Bookmark + Register Integration
;; * ================================================================== *
(defun pdf-view-bookmark-make-record (&optional no-page no-slice no-size no-origin)
"Create a bookmark PDF record.
The optional, boolean args exclude certain attributes."
(let ((displayed-p (eq (current-buffer)
(window-buffer))))
(cons (buffer-name)
(append (bookmark-make-record-default nil t 1)
`(,(unless no-page
(cons 'page (pdf-view-current-page)))
,(unless no-slice
(cons 'slice (and displayed-p
(pdf-view-current-slice))))
,(unless no-size
(cons 'size pdf-view-display-size))
,(unless no-origin
(cons 'origin
(and displayed-p
(let ((edges (pdf-util-image-displayed-edges nil t)))
(pdf-util-scale-pixel-to-relative
(cons (car edges) (cadr edges)) nil t)))))
(handler . pdf-view-bookmark-jump-handler))))))
;;;###autoload
(defun pdf-view-bookmark-jump-handler (bmk)
"The bookmark handler-function interface for PDF bookmarks.
See also `pdf-view-bookmark-make-record'."
(let ((page (bookmark-prop-get bmk 'page))
(slice (bookmark-prop-get bmk 'slice))
(size (bookmark-prop-get bmk 'size))
(origin (bookmark-prop-get bmk 'origin))
(file (bookmark-prop-get bmk 'filename))
(show-fn-sym (make-symbol "pdf-view-bookmark-after-jump-hook")))
(fset show-fn-sym
(lambda ()
(remove-hook 'bookmark-after-jump-hook show-fn-sym)
(unless (derived-mode-p 'pdf-view-mode)
(pdf-view-mode))
(with-selected-window
(or (get-buffer-window (current-buffer) 0)
(selected-window))
(when size
(setq-local pdf-view-display-size size))
(when slice
(apply 'pdf-view-set-slice slice))
(when (numberp page)
(pdf-view-goto-page page))
(when origin
(let ((size (pdf-view-image-size t)))
(image-set-window-hscroll
(round (/ (* (car origin) (car size))
(frame-char-width))))
(image-set-window-vscroll
(round (/ (* (cdr origin) (cdr size))
(frame-char-height)))))))))
(add-hook 'bookmark-after-jump-hook show-fn-sym)
(set-buffer (or (find-buffer-visiting file)
(find-file-noselect file)))))
(defun pdf-view-bookmark-jump (bmk)
"Switch to bookmark BMK.
This function is like `bookmark-jump', but it always uses the
selected window for display and does not run any hooks. Also, it
works only with bookmarks created by
`pdf-view-bookmark-make-record'."
(let* ((file (bookmark-prop-get bmk 'filename))
(buffer (or (find-buffer-visiting file)
(find-file-noselect file))))
(switch-to-buffer buffer)
(let (bookmark-after-jump-hook)
(pdf-view-bookmark-jump-handler bmk)
(run-hooks 'bookmark-after-jump-hook))))
(defun pdf-view-registerv-make ()
"Create a PDF register entry of the current position."
(registerv-make
(pdf-view-bookmark-make-record nil t t)
:print-func 'pdf-view-registerv-print-func
:jump-func 'pdf-view-bookmark-jump
:insert-func (lambda (bmk)
(insert (format "%S" bmk)))))
(defun pdf-view-registerv-print-func (bmk)
"Print a textual representation of bookmark BMK.
This function is used as the `:print-func' property with
`registerv-make'."
(let* ((file (bookmark-prop-get bmk 'filename))
(buffer (find-buffer-visiting file))
(page (bookmark-prop-get bmk 'page))
(origin (bookmark-prop-get bmk 'origin)))
(princ (format "PDF position: %s, page %d, %d%%"
(if buffer
(buffer-name buffer)
file)
(or page 1)
(if origin
(round (* 100 (cdr origin)))
0)))))
(defmacro pdf-view-with-register-alist (&rest body)
"Setup the proper binding for `register-alist' in body.
This macro may not work as desired when it is nested. See also
`pdf-view-use-dedicated-register'."
(declare (debug t) (indent 0))
(let ((dedicated-p (make-symbol "dedicated-p")))
`(let* ((,dedicated-p pdf-view-use-dedicated-register)
(register-alist
(if ,dedicated-p
pdf-view-register-alist
register-alist)))
(unwind-protect
(progn ,@body)
(when ,dedicated-p
(setq pdf-view-register-alist register-alist))))))
(defun pdf-view-position-to-register (register)
"Store current PDF position in register REGISTER.
See also `point-to-register'."
(interactive
(list (pdf-view-with-register-alist
(register-read-with-preview "Position to register: "))))
(pdf-view-with-register-alist
(set-register register (pdf-view-registerv-make))))
(defun pdf-view-jump-to-register (register &optional delete return-register)
"Move point to a position stored in a REGISTER."
(interactive
(pdf-view-with-register-alist
(list
(register-read-with-preview "Jump to register: ")
current-prefix-arg
(and (or pdf-view-use-dedicated-register
(local-variable-p 'register-alist))
(characterp last-command-event)
last-command-event))))
(pdf-view-with-register-alist
(let ((return-pos (and return-register
(pdf-view-registerv-make))))
(jump-to-register register delete)
(when return-register
(set-register return-register return-pos)))))
(provide 'pdf-view)
;;; pdf-view.el ends here
|