forked from vedang/pdf-tools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pdf-annot.el
1660 lines (1407 loc) · 60.5 KB
/
pdf-annot.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-annot.el --- Annotation support for PDF files. -*- lexical-binding: t -*-
;; Copyright (C) 2013, 2014 Andreas Politz
;; Author: Andreas Politz <politza@fh-trier.de>
;; Keywords:
;; 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:
;;
(require 'pdf-view)
(require 'pdf-info)
(require 'pdf-cache)
(require 'pdf-misc)
(require 'facemenu) ;; list-colors-duplicates
(require 'faces) ;; color-values
(require 'org) ;; org-create-formula-image
(require 'tablist)
(require 'cl-lib)
;; * ================================================================== *
;; * Customizations
;; * ================================================================== *
(defgroup pdf-annot nil
"Annoatation support for PDF documents."
:group 'pdf-tools)
(defcustom pdf-annot-activate-handler-functions nil
"A list of functions to activate a annotation.
The functions on this hook will be called when some annotation is
activated, usually by a mouse-click. Each one is called with the
annotation as a single argument and it should return a non-nil
value if it has `handled' it. If no such function exists, the
default handler `pdf-annot-default-handler' will be
called.
This hook is ment to allow for custom annotations. FIXME:
Implement and describe basic org example."
:group 'pdf-annot
:type 'hook)
(defcustom pdf-annot-default-text-annotation-properties
`((icon . "Note")
(color . "#ff0000")
(label . ,user-full-name)
(popup-is-open . nil))
"Alist of initial properties for new text annotations.
FIXME: Describe. Restrict keys and values."
:group 'pdf-annot)
(defcustom pdf-annot-default-markup-annotation-properties
`((label . ,user-full-name)
(popup-is-open . nil))
"Alist of initial properties for new markup annotations.
FIXME: Describe. Restrict keys and values."
:group 'pdf-annot)
(defcustom pdf-annot-print-annotation-functions
'(pdf-annot-print-annotation-latex-maybe)
"A alist of functions for printing annotations, e.g. for the tooltip.
The functions receive the annotation as single argument and
should return either a string or nil. The first string returned
will be used.
If all of them return nil, the default function
`pdf-annot-print-annotation-default' is used."
:group 'pdf-annot
:type 'hook)
(defcustom pdf-annot-latex-string-predicate
(lambda (str)
(and str (string-match "\\`[[:space:]\n]*[$\\]" str)))
"A predicate for recognizing LaTeX fragments.
It receives a string and should return non-nil, if string is a
LaTeX fragment."
:group 'pdf-annot
:type 'function)
(defcustom pdf-annot-latex-header
(concat org-format-latex-header
"\n\\setlength{\\textwidth}{12cm}")
"Header used when latex compiling annotations.
The default value is `org-format-latex-header' + \
\"\\n\\\\setlength{\\\\textwidth}{12cm}\"."
:group 'pdf-annot
:type 'string)
(defcustom pdf-annot-tweak-tooltips t
"Whether this package should tweak some settings regarding tooltips.
If this variable has a non-nil value,
`x-gtk-use-system-tooltips' is set to nil if appropriate, in
order to display text properties;
`tooltip-hide-delay' is set to infinity, in order to not beeing
annoyed while reading the annotations."
:group 'pdf-annot)
(defcustom pdf-annot-activate-created-annotations nil
"Whether to activate (i.e. edit) created annotations."
:group 'pdf-annot
:type 'boolean)
(defcustom pdf-annot-attachment-display-buffer-action nil
"The display action used when displaying attachments."
:group 'pdf-annot
:type display-buffer--action-custom-type)
(defconst pdf-annot-annotation-types
'(3d caret circle file
free-text highlight ink line link movie poly-line polygon popup
printer-mark screen sound square squiggly stamp strike-out text
trap-net underline unknown watermark widget)
"Complete list of annotation types.")
(defcustom pdf-annot-list-listed-types
(if (pdf-info-markup-annotations-p)
(list 'text 'file 'squiggly 'highlight 'underline 'strike-out)
(list 'text 'file))
"A list of annotation types displayed in the list buffer."
:group 'pdf-annot
:type `(set ,@(mapcar (lambda (type)
(list 'const type))
pdf-annot-annotation-types)))
;; * ================================================================== *
;; * Variables and Macros
;; * ================================================================== *
(defvar pdf-annot-color-history nil
"A list of recently used colors for annotations.")
(defvar-local pdf-annot-modified-functions nil
"Functions to call, when an annotation was modified.
A function on this hook should accept one argument: A CLOSURE
containing inserted, changed and deleted annotations.
It may access theses annotations by calling CLOSURE with one of
these arguments:
`:inserted' The list of recently added annotations.
`:deleted' The list of recently deleted annotations.
`:changed' The list of recently changed annotations.
`t' The union of recently added, deleted or changed annotations.
`nil' Just returns nil.
Any other argument signals an error.")
(defconst pdf-annot-text-annotation-size '(24 . 24)
"The Size of text and file annotations in PDF points.
These values are hard-coded in poppler. And while the size of
these annotations may be changed, i.e. the edges property, it has
no effect on the rendering.")
(defconst pdf-annot-markup-annotation-types
'(text link free-text line square
circle polygon poly-line highlight underline squiggly
strike-out stamp caret ink file sound)
"List of defined markup annotation types.")
(defconst pdf-annot-standard-text-icons
'("Note" "Comment" "Key" "Help" "NewParagraph"
"Paragraph" "Insert" "Cross" "Circle")
"A list of standard icon properties for text annotations.")
(defvar pdf-annot-inhibit-modification-hooks nil
"Non-nil, if running `pdf-annot-modified-functions' should be
inhibited after some annotation has changed.")
(defvar-local pdf-annot-delayed-modified-annotations nil
"A plist of not yet propagated modifications.
It contains three entries :change, :delete and :insert. Each one
having a list of annotations as value.")
(defvar-local pdf-annot--attachment-file-alist nil
"Alist mapping attachment ids to unique relative filenames.")
(defmacro pdf-annot-with-atomic-modifications (&rest body)
"Execute BODY joining multiple modifications.
The effect is, that `pdf-annot-modified-functions' will be called
only once at the end of BODY.
BODY should not modify annotations in a different then the
current buffer, because that won't run the hooks properly."
(declare (indent 0) (debug t))
`(unwind-protect
(save-current-buffer
(let ((pdf-annot-inhibit-modification-hooks t))
(progn ,@body)))
(pdf-annot-run-modified-hooks)))
;; * ================================================================== *
;; * Minor mode
;; * ================================================================== *
(defcustom pdf-annot-minor-mode-map-prefix (kbd "C-c C-a")
"The prefix to use for `pdf-annot-minor-mode-map'.
Setting this after the package was loaded has no effect."
:group 'pdf-annot
:type 'key-sequence)
(defvar pdf-annot-minor-mode-map
(let ((kmap (make-sparse-keymap))
(smap (make-sparse-keymap)))
(define-key kmap pdf-annot-minor-mode-map-prefix smap)
(define-key smap "l" 'pdf-annot-list-annotations)
;; (define-key smap "d" 'pdf-annot-toggle-display-annotations)
(define-key smap "a" 'pdf-annot-attachment-dired)
(when (pdf-info-writable-annotations-p)
(define-key smap "D" 'pdf-annot-delete)
(define-key smap "t" 'pdf-annot-add-text-annotation)
(when (pdf-info-markup-annotations-p)
(define-key smap "m" 'pdf-annot-add-markup-annotation)
(define-key smap "s" 'pdf-annot-add-squiggly-markup-annotation)
(define-key smap "u" 'pdf-annot-add-underline-markup-annotation)
(define-key smap "o" 'pdf-annot-add-strikeout-markup-annotation)
(define-key smap "h" 'pdf-annot-add-highlight-markup-annotation)))
kmap)
"Keymap used for `pdf-annot-minor-mode'.")
(defvar savehist-minibuffer-history-variables)
;;;###autoload
(define-minor-mode pdf-annot-minor-mode
"Support for PDF Annotations.
\\{pdf-annot-minor-mode-map}"
nil nil nil
(cond
(pdf-annot-minor-mode
(when pdf-annot-tweak-tooltips
(when (boundp 'x-gtk-use-system-tooltips)
(setq x-gtk-use-system-tooltips nil))
(setq tooltip-hide-delay 3600))
(pdf-view-add-hotspot-function 'pdf-annot-hotspot-function 9)
(add-hook 'pdf-info-close-document-hook
'pdf-annot-attachment-delete-base-directory nil t)
(when (featurep 'savehist)
(add-to-list 'savehist-minibuffer-history-variables
'pdf-annot-color-history)))
(t
(pdf-view-remove-hotspot-function 'pdf-annot-hotspot-function)
(remove-hook 'pdf-info-close-document-hook
'pdf-annot-attachment-delete-base-directory t)))
(pdf-view-redisplay t))
(defun pdf-annot-create-context-menu (a)
"Create a appropriate context menu for annotation A."
(let ((menu (make-sparse-keymap)))
;; (when (and (bound-and-true-p pdf-misc-menu-bar-minor-mode)
;; (bound-and-true-p pdf-misc-install-popup-menu))
;; (set-keymap-parent menu
;; (lookup-key pdf-misc-menu-bar-minor-mode-map
;; [menu-bar pdf-tools]))
;; (define-key menu [sep-99] menu-bar-separator))
(when (pdf-info-writable-annotations-p)
(define-key menu [delete-annotation]
`(menu-item "Delete annotation"
,(lambda ()
(interactive)
(pdf-annot-delete a)
(message "Annotation deleted"))
:help
"Delete this annotation.")))
(define-key menu [goto-annotation]
`(menu-item "List annotation"
,(lambda ()
(interactive)
(pdf-annot-show-annotation a t)
(pdf-annot-list-annotations)
(pdf-annot-list-goto-annotation a))
:help "Find this annotation in the list buffer."))
(when (pdf-annot-text-annotation-p a)
(define-key menu [change-text-icon]
`(menu-item "Change icon"
,(pdf-annot-create-icon-submenu a)
:help "Change the appearance of this annotation.")))
(define-key menu [change-color]
`(menu-item "Change color"
,(pdf-annot-create-color-submenu a)
:help "Change the appearance of this annotation."))
(define-key menu [activate-annotation]
`(menu-item "Activate"
,(lambda ()
(interactive)
(pdf-annot-activate-annotation a))
:help "Activate this annotation."))
menu))
(defun pdf-annot-create-color-submenu (a)
(let ((menu (make-sparse-keymap)))
(define-key menu [color-chooser]
`(menu-item "Choose ..."
,(lambda ()
(interactive)
(list-colors-display
nil "*Choose annotation color*"
;; list-colors-print does not like closures.
(let ((callback (make-symbol "xcallback")))
(fset callback
(lambda (color)
(pdf-annot-put a 'color color)
(setq pdf-annot-color-history
(cons color
(remove color pdf-annot-color-history)))
(quit-window t)))
(list 'function callback))))))
(dolist (color (butlast (reverse pdf-annot-color-history)
(max 0 (- (length pdf-annot-color-history)
12))))
(define-key menu (vector (intern (format "color-%s" color)))
`(menu-item ,color
,(lambda nil
(interactive)
(pdf-annot-put a 'color color)))))
menu))
(defun pdf-annot-create-icon-submenu (a)
(let ((menu (make-sparse-keymap)))
(dolist (icon (reverse pdf-annot-standard-text-icons))
(define-key menu (vector (intern (format "icon-%s" icon)))
`(menu-item ,icon
,(lambda nil
(interactive)
(pdf-annot-put a 'icon icon)))))
menu))
;; * ================================================================== *
;; * Annotation Basics
;; * ================================================================== *
(defun pdf-annot-create (alist &optional buffer)
"Create a annotation from ALIST in BUFFER.
ALIST should be a property list as returned by
`pdf-cache-getannots'. BUFFER should be the buffer of the
corresponding PDF document. It defaults to the current buffer."
(cons `(buffer . ,(or buffer (current-buffer)))
alist))
(defun pdf-annot-getannots (&optional pages types buffer)
"Return a list of annotations on PAGES of TYPES in BUFFER.
See `pdf-info-normalize-pages' for valid values of PAGES. TYPES
may be a symbol or list of symbols denoting annotation types.
PAGES defaults to all pages, TYPES to all types and BUFFER to the
current buffer."
(pdf-util-assert-pdf-buffer buffer)
(unless buffer
(setq buffer (current-buffer)))
(unless (listp types)
(setq types (list types)))
(with-current-buffer buffer
(let (result)
(dolist (a (pdf-info-getannots pages))
(when (or (null types)
(memq (pdf-annot-get a 'type) types))
(push (pdf-annot-create a) result)))
result)))
(defun pdf-annot-getannot (id &optional buffer)
(pdf-annot-create
(pdf-info-getannot id buffer)
buffer))
(defun pdf-annot-get (a property &optional default)
"Get annotation A's value of PROPERTY.
Return DEFAULT, if value is nil."
(or (cdr (assq property a)) default))
(defun pdf-annot-put (a property value)
"Set annotation A's PROPERTY to VALUE.
Unless VALUE is `equal' to the current value, sets A's buffer's
modified flag and runs the hook `pdf-annot-modified-functions'.
Signals an error, if PROPERTY is not modifiable.
Returns the modified annotation."
(declare (indent 2))
(unless (equal value (pdf-annot-get a property))
(unless (pdf-annot-property-modifiable-p a property)
(error "Property `%s' is read-only for this annotation"
property))
(with-current-buffer (pdf-annot-get-buffer a)
(setq a (pdf-annot-create
(pdf-info-editannot
(pdf-annot-get-id a)
`((,property . ,value)))))
(set-buffer-modified-p t)
(pdf-annot-run-modified-hooks :change a)))
a)
(defun pdf-annot-run-modified-hooks (&optional operation &rest annotations)
"Run `pdf-annot-modified-functions' using OPERATION on ANNOTATIONS.
OPERATION should be one of nil, :change, :insert or :delete. If
nil, annotations should be empty.
Redisplay modified pages.
If `pdf-annot-inhibit-modification-hooks' in non-nil, this just
saves ANNOTATIONS and does not call the hooks until later, when
the variable is nil and this function is called again."
(unless (memq operation '(nil :insert :change :delete))
(error "Invalid operation: %s" operation))
(when (and (null operation) annotations)
(error "Missing operation argument"))
(when operation
(let ((list (plist-get pdf-annot-delayed-modified-annotations operation)))
(dolist (a annotations)
(cl-pushnew a list :test 'pdf-annot-equal))
(setq pdf-annot-delayed-modified-annotations
(plist-put pdf-annot-delayed-modified-annotations
operation list))))
(unless pdf-annot-inhibit-modification-hooks
(let* ((changed (plist-get pdf-annot-delayed-modified-annotations :change))
(inserted (mapcar (lambda (a)
(or (car (cl-member a changed :test 'pdf-annot-equal))
a))
(plist-get pdf-annot-delayed-modified-annotations :insert)))
(deleted (plist-get pdf-annot-delayed-modified-annotations :delete))
(union (cl-union (cl-union changed inserted :test 'pdf-annot-equal)
deleted :test 'pdf-annot-equal))
(closure (lambda (arg)
(cl-ecase arg
(:inserted (copy-sequence inserted))
(:changed (copy-sequence changed))
(:deleted (copy-sequence deleted))
(t (copy-sequence union))
(nil nil))))
(pages (mapcar (lambda (a) (pdf-annot-get a 'page)) union)))
(when union
(unwind-protect
(run-hook-with-args
'pdf-annot-modified-functions closure)
(setq pdf-annot-delayed-modified-annotations nil)
(apply 'pdf-view-redisplay-pages pages))))))
(defun pdf-annot-equal (a1 a2)
"Return non-nil, if annotations A1 and A2 are equal.
Two annotations are equal, if they belong to the same buffer and
have identical id properties."
(and (eq (pdf-annot-get-buffer a1)
(pdf-annot-get-buffer a2))
(eq (pdf-annot-get-id a1)
(pdf-annot-get-id a2))))
(defun pdf-annot-get-buffer (a)
"Return annotation A's buffer."
(pdf-annot-get a 'buffer))
(defun pdf-annot-get-id (a)
"Return id property of annotation A."
(pdf-annot-get a 'id))
(defun pdf-annot-get-type (a)
"Return type property of annotation A."
(pdf-annot-get a 'type))
(defun pdf-annot-get-display-edges (a)
"Return a list of EDGES used for display for annotation A.
This returns a list of \(LEFT TOP RIGHT BOT\) demarking the
rectangles of the page where A is rendered."
(or (pdf-annot-get a 'markup-edges)
(list (pdf-annot-get a 'edges))))
(defun pdf-annot-delete (a)
"Delete annotation A.
Sets A's buffer's modified flag and runs the hook
`pdf-annot-modified-functions'.
This function alwasy returns nil."
(interactive
(list (pdf-annot-read-annotation
"Click on the annotation you wish to delete")))
(with-current-buffer (pdf-annot-get-buffer a)
(pdf-info-delannot
(pdf-annot-get-id a))
(set-buffer-modified-p t)
(pdf-annot-run-modified-hooks :delete a))
(when (called-interactively-p 'any)
(message "Annotation deleted"))
nil)
(defun pdf-annot-text-annotation-p (a)
(eq 'text (pdf-annot-get a 'type)))
(defun pdf-annot-markup-annotation-p (a)
(not (null
(memq (pdf-annot-get a 'type)
pdf-annot-markup-annotation-types))))
(defun pdf-annot-property-modifiable-p (a property)
(or (memq property '(edges color flags contents))
(and (pdf-annot-markup-annotation-p a)
(memq property '(label opacity popup popup-is-open)))
(and (pdf-annot-text-annotation-p a)
(memq property '(icon is-open)))))
(defun pdf-annot-activate-annotation (a)
(or (run-hook-with-args-until-success
'pdf-annot-activate-handler-functions
a)
(pdf-annot-default-activate-handler a)))
(defun pdf-annot-default-activate-handler (a)
(cond
((pdf-annot-has-attachment-p a)
(pdf-annot-pop-to-attachment a))
(t (pdf-annot-edit-contents a))))
;; * ================================================================== *
;; * Handling attachments
;; * ================================================================== *
(defun pdf-annot-has-attachment-p (a)
"Return non-nil if annotation A's has data attached."
(eq 'file (pdf-annot-get a 'type)))
(defun pdf-annot-get-attachment (a &optional do-save)
"Retrieve annotation A's attachment.
The DO-SAVE argument is given to
`pdf-info-getattachment-from-annot', which see."
(unless (pdf-annot-has-attachment-p a)
(error "Annotation has no data attached: %s" a))
(pdf-info-getattachment-from-annot
(pdf-annot-get-id a)
do-save
(pdf-annot-get-buffer a)))
(defun pdf-annot-attachment-base-directory ()
"Return the base directory for saving attachments."
(let ((dir (pdf-util-expand-file-name "attachments")))
(unless (file-exists-p dir)
(make-directory dir))
dir))
(defun pdf-annot-attachment-delete-base-directory ()
"Delete all saved attachment files of the current buffer."
(setq pdf-annot--attachment-file-alist nil)
(delete-directory (pdf-annot-attachment-base-directory) t))
(defun pdf-annot-attachment-unique-filename (attachment)
"Return a unique absolute filename for ATTACHMENT."
(let* ((filename (or (cdr (assq 'filename attachment))
"attachment"))
(id (cdr (assq 'id attachment)))
(unique
(or (cdr (assoc id pdf-annot--attachment-file-alist))
(let* ((sans-ext
(expand-file-name
(concat (file-name-as-directory ".")
(file-name-sans-extension filename))
(pdf-annot-attachment-base-directory)))
(ext (file-name-extension filename))
(newname (concat sans-ext "." ext))
(i 0))
(while (rassoc newname pdf-annot--attachment-file-alist)
(setq newname (format "%s-%d.%s" sans-ext (cl-incf i) ext)))
(push (cons id newname) pdf-annot--attachment-file-alist)
newname)))
(directory (file-name-directory unique)))
(unless (file-exists-p directory)
(make-directory directory t))
unique))
(defun pdf-annot-attachment-save (attachment &optional regenrate-p)
"Save ATTACHMENT's data to a unique filename and return it's name.
If REGENRATE-P is non-nil, copy attachment's file even if the
copy already exists.
Signal an error, if ATTACHMENT has no, or a non-existing, `file'
property, i.e. it was retrieved with an unset do-save argument.
See `pdf-info-getattachments'"
(let ((datafile (cdr (assq 'file attachment))))
(unless (and datafile
(file-exists-p datafile))
(error "Attachment's file property is invalid"))
(let* ((filename
(pdf-annot-attachment-unique-filename attachment)))
(when (or regenrate-p
(not (file-exists-p filename)))
(copy-file datafile filename nil nil t t))
filename)))
(defun pdf-annot-find-attachment-noselect (a)
"Find annotation A's attachment in a buffer, without selecting it.
Signals an error, if A has no data attached."
(let ((attachment (pdf-annot-get-attachment a t)))
(unwind-protect
(find-file-noselect
(pdf-annot-attachment-save attachment))
(let ((tmpfile (cdr (assq 'file attachment))))
(when (and tmpfile
(file-exists-p tmpfile))
(delete-file tmpfile))))))
(defun pdf-annot-attachment-dired (&optional regenerate-p)
"List all attachments in a dired buffer.
If REGENERATE-P is non-nil, create attachment's files even if
they already exist. Interactively REGENERATE-P is non-nil if a
prefix argument was given.
Return the dired buffer."
(interactive (list current-prefix-arg))
(let ((attachments (pdf-info-getattachments t)))
(unwind-protect
(progn
(dolist (a (pdf-annot-getannots nil 'file))
(push (pdf-annot-get-attachment a t)
attachments ))
(dolist (att attachments)
(pdf-annot-attachment-save att regenerate-p))
(unless attachments
(error "Document has no data attached"))
(dired (pdf-annot-attachment-base-directory)))
(dolist (att attachments)
(let ((tmpfile (cdr (assq 'file att))))
(when (and tmpfile (file-exists-p tmpfile))
(delete-file tmpfile)))))))
(defun pdf-annot-display-attachment (a &optional display-action select-window-p)
"Display file annotation A's data in a buffer.
DISPLAY-ACTION should be a valid `display-buffer' action. If
nil, `pdf-annot-attachment-display-buffer-action' is used.
Select the window, if SELECT-WINDOW-P is non-nil.
Return the window attachment is displayed in."
(interactive
(list (pdf-annot-read-annotation
"Select a file annotation by clicking on it")))
(let* ((buffer (pdf-annot-find-attachment-noselect a))
(window (display-buffer
buffer (or display-action
pdf-annot-attachment-display-buffer-action))))
(when select-window-p
(select-window window))
window))
(defun pdf-annot-pop-to-attachment (a)
"Display annotation A's attachment in a window and select it."
(interactive
(list (pdf-annot-read-annotation
"Select a file annotation by clicking on it")))
(pdf-annot-display-attachment a nil t))
;; * ================================================================== *
;; * Interfacing with the display
;; * ================================================================== *
(defun pdf-annot-image-position (a &optional image-size)
"Return the position of annotation A in image coordinates.
IMAGE-SIZE should be a cons \(WIDTH . HEIGHT\) and defaults to
the page-image of the selected window."
(unless image-size
(pdf-util-assert-pdf-window)
(setq image-size (pdf-view-image-size)))
(let ((e (pdf-util-scale
(pdf-annot-get a 'edges)
image-size)))
(pdf-util-with-edges (e)
`(,e-left . ,e-top))))
(defun pdf-annot-image-set-position (a x y &optional image-size)
"Set annotation A's position to X,Y in image coordinates.
See `pdf-annot-image-position' for IMAGE-SIZE."
(unless image-size
(pdf-util-assert-pdf-window)
(setq image-size (pdf-view-image-size)))
(let* ((edges (pdf-annot-get a 'edges))
(x (/ x (float (car image-size))))
(y (/ y (float (cdr image-size)))))
(pdf-util-with-edges (edges)
(let* ((w edges-width)
(h edges-height)
(x (max 0 (min x (- 1 w))))
(y (max 0 (min y (- 1 h)))))
(pdf-annot-put a 'edges
(list x y -1 -1))))))
(defun pdf-annot-image-size (a &optional image-size)
"Return the size of annotation A in image coordinates.
Returns \(WIDTH . HEIGHT\).
See `pdf-annot-image-position' for IMAGE-SIZE."
(unless image-size
(pdf-util-assert-pdf-window)
(setq image-size (pdf-view-image-size)))
(let ((edges (pdf-util-scale
(pdf-annot-get a 'edges) image-size)))
(pdf-util-with-edges (edges)
(cons edges-width edges-height))))
(defun pdf-annot-image-set-size (a &optional width height image-size)
"Set annotation A's size in image to WIDTH and/or HEIGHT.
See `pdf-annot-image-position' for IMAGE-SIZE."
(unless image-size
(pdf-util-assert-pdf-window)
(setq image-size (pdf-view-image-size)))
(let* ((edges (pdf-annot-get a 'edges))
(w (and width
(/ width (float (car image-size)))))
(h (and height
(/ height (float (cdr image-size))))))
(pdf-util-with-edges (edges)
(pdf-annot-put a 'edges
(list edges-left
edges-top
(if w (+ edges-left w) edges-right)
(if h (+ edges-top h) edges-bot))))))
(defun pdf-annot-at-position (pos)
"Return annotation at POS in the selected window.
POS should be an absolute image position as a cons \(X . Y\).
Alternatively POS may also be an event position, in which case
`posn-window' and `posn-object-x-y' is used to find the image
position.
Return nil, if no annotation was found."
(let (window)
(when (posnp pos)
(setq window (posn-window pos)
pos (posn-object-x-y pos)))
(save-selected-window
(when window (select-window window))
(let* ((annots (pdf-annot-getannots (pdf-view-current-page)))
(size (pdf-view-image-size))
(offset (pdf-view-image-offset))
(rx (+ (/ (car pos) (float (car size)))
(car offset)))
(ry (+ (/ (cdr pos) (float (cdr size)))
(cdr offset)))
(rpos (cons rx ry)))
(or (cl-some (lambda (a)
(and (cl-some
(lambda (e)
(pdf-util-edges-inside-p e rpos))
(pdf-annot-get-display-edges a))
a))
annots)
(error "No annotation at this position"))))))
(defun pdf-annot-mouse-move (event &optional annot)
"Start moving an annotation at EVENT's position.
EVENT should be a mouse event originating the request and is used
as a reference point.
ANNOT is the annotation to operate on and defaults to the
annotation at EVENT's start position.
This function does not return until the operation is completed,
i.e. a non mouse-movement event is read."
(interactive "@e")
(pdf-util-assert-pdf-window (posn-window (event-start event)))
(select-window (posn-window (event-start event)))
(let* ((mpos (posn-object-x-y (event-start event)))
(a (or annot
(pdf-annot-at-position mpos))))
(unless a
(error "No annotation at this position: %s" mpos))
(let* ((apos (pdf-annot-image-position a))
(offset (cons (- (car mpos) (car apos))
(- (cdr mpos) (cdr apos))))
(window (selected-window))
make-pointer-invisible)
(when (pdf-util-track-mouse-dragging (ev 0.1)
(when (and (eq window (posn-window (event-start ev)))
(eq 'image (car-safe (posn-object (event-start ev)))))
(let ((pdf-view-inhibit-hotspots t)
(pdf-annot-inhibit-modification-hooks t)
(pdf-cache-image-inihibit t)
(xy (posn-object-x-y (event-start ev))))
(pdf-annot-image-set-position
a (- (car xy) (car offset))
(- (cdr xy) (cdr offset)))
(pdf-view-redisplay))))
(pdf-annot-run-modified-hooks)))
nil))
(defun pdf-annot-hotspot-function (page size)
"Create image hotspots for page PAGE of size SIZE."
(apply 'nconc (mapcar (lambda (a)
(unless (eq (pdf-annot-get a 'type)
'link)
(pdf-annot-create-hotspots a size)))
(pdf-annot-getannots page))))
(defun pdf-annot-create-hotspots (a size)
"Return a list of image hotspots for annotation A."
(let ((id (pdf-annot-get-id a))
(edges (pdf-util-scale
(pdf-annot-get-display-edges a)
size 'round))
(moveable-p (memq (pdf-annot-get a 'type)
'(file text)))
hotspots)
(dolist (e edges)
(pdf-util-with-edges (e)
(push `((rect . ((,e-left . ,e-top) . (,e-right . ,e-bot)))
,id
(pointer
hand
help-echo
,(pdf-annot-print-annotation a)))
hotspots)))
(pdf-annot-create-hotspot-binding id moveable-p a)
hotspots))
;; FIXME: Define a keymap as a template for this. Much cleaner.
(defun pdf-annot-create-hotspot-binding (id moveable-p annotation)
;; Activating
(local-set-key
(vector id 'mouse-1)
(lambda ()
(interactive)
(pdf-annot-activate-annotation annotation)))
;; Move
(when moveable-p
(local-set-key
(vector id 'down-mouse-1)
(lambda (ev)
(interactive "@e")
(pdf-annot-mouse-move ev annotation))))
;; Context Menu
(local-set-key
(vector id 'down-mouse-3)
(lambda ()
(interactive "@")
(popup-menu (pdf-annot-create-context-menu annotation))))
;; Everything else
(local-set-key
(vector id t)
'pdf-util-image-map-mouse-event-proxy))
(defun pdf-annot-show-annotation (a &optional highlight-p window)
"Make annotation A visible.
Turn to A's page in WINDOW, and scroll it if necessary.
If HIGHLIGHT-P is non-nil, visually distinguish annotation A from
other annotations."
(save-selected-window
(when window (select-window window))
(pdf-util-assert-pdf-window)
(let ((page (pdf-annot-get a 'page))
(size (pdf-view-image-size)))
(unless (= page (pdf-view-current-page))
(pdf-view-goto-page page))
(let ((edges (pdf-annot-get-display-edges a)))
(when highlight-p
(pdf-view-display-image
(pdf-view-create-image
(pdf-cache-renderpage-highlight
page (car size)
`("white" "steel blue" 0.35 ,@edges))
:map (pdf-view-apply-hotspot-functions
window page size))))
(pdf-util-scroll-to-edges
(pdf-util-scale-relative-to-pixel (car edges)))))))
(defun pdf-annot-read-annotation (&optional prompt)
"Let the user choose a annotation a mouse click using PROMPT."
(pdf-annot-at-position
(pdf-util-read-image-position
(or prompt "Choose a annotation by clicking on it"))))
;; * ================================================================== *
;; * Creating annotations
;; * ================================================================== *
(defun pdf-annot-add-annotation (type edges &optional property-alist page)
"Creates and adds a new annotation of type TYPE to the document.
TYPE determines the kind of annotation to add and maybe one of
`text', `squiggly', `underline', `strike-out' or `highlight'.
EDGES determines where the annotation will appear on the page.
If type is `text', this should be a single list of \(LEFT TOP
RIGHT BOT\). Though, in this case only LEFT and TOP are used,
since the size of text annotations is fixed. Otherwise EDGES may
be a list of such elements. All values should be image relative
coordinates, i.e. in the range \[0;1\].
PROPERTY-ALIST is a list of annotation properties, which will be
put on the created annotation.
PAGE determines the page of the annotation. It defaults to the
page currently displayed in the selected window.
Signal an error, if PROPERTY-ALIST contains non-modifiable
properties or PAGE is nil and the selected window does not
display a PDF document or creating annotations of type TYPE is
not supported.
Set buffers modified flag and calls
`pdf-annot-activate-annotation' if
`pdf-annot-activate-created-annotations' is non-nil.
Return the new annotation."
(unless (memq type (pdf-info-creatable-annotation-types))
(error "Unsupported annotation type: %s" type))
(unless page
(pdf-util-assert-pdf-window)
(setq page (pdf-view-current-page)))
(unless (consp (car-safe edges))
(setq edges (list edges)))
(when (and (eq type 'text)
(> (length edges) 1))
(error "Edges argument should be a single edge-list for text annotations"))
(let* ((a (apply 'pdf-info-addannot
page
(if (eq type 'text)
(car edges)
'(0 0 0 0))
type
nil
(if (not (eq type 'text)) edges)))
(id (pdf-annot-get-id a)))
(when property-alist
(condition-case err
(setq a (pdf-info-editannot id property-alist))
(error
(pdf-info-delannot id)
(signal (car err) (cdr err)))))
(setq a (pdf-annot-create a))
(set-buffer-modified-p t)
(pdf-annot-run-modified-hooks :insert a)
(when pdf-annot-activate-created-annotations
(pdf-annot-activate-annotation a))
a))