forked from fuxialexander/org-pdftools
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathorg-noter-pdftools.el
802 lines (726 loc) · 35.4 KB
/
org-noter-pdftools.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
;;; org-noter-pdftools.el --- Integration between org-pdftools and org-noter
;; Copyright (C) 2020 Alexander Fu Xi
;; Author: Alexander Fu Xi <[email protected]>
;; Maintainer: Yayu Wang <[email protected]>
;; Homepage: https://github.com/st-saint/org-pdftools
;; Version: 1.4
;; Keywords: convenience
;; 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 <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Add integration between org-pdftools and org-noter.
;;; Code:
(require 'org-id)
(require 'org-pdftools)
(require 'org-noter)
(require 'image-mode)
(declare-function pdf-info-editannot "ext:pdf-info")
(declare-function pdf-annot-add-text-annotation "ext:pdf-annot")
(declare-function pdf-annot-get-id "ext:pdf-annot")
(defcustom org-noter-pdftools-markup-pointer-function 'pdf-annot-add-highlight-markup-annotation
"Color for markup pointer annotations.
Can be one of highlight/underline/strikeout/squiggly."
:group 'org-noter
:type 'function)
(defcustom org-noter-pdftools-path-generator #'abbreviate-file-name
"Translate your PDF file path the way you like. Take buffer-file-name as the argument."
:group 'org-pdftools
:type 'function)
(defcustom org-noter-pdftools-markup-pointer-color "#A9A9A9"
"Color for markup pointer annotations."
:group 'org-noter
:type 'string)
(defcustom org-noter-pdftools-markup-pointer-opacity 1.0
"Color for markup pointer annotations."
:group 'org-noter
:type 'float)
(defcustom org-noter-pdftools-free-pointer-icon "Circle"
"Color for free pointer annotations. Refer to `pdf-annot-standard-text-icons`."
:group 'org-noter
:type 'string)
(defcustom org-noter-pdftools-free-pointer-color "#FFFFFF"
"Color for free pointer annotations."
:group 'org-noter
:type 'string)
(defcustom org-noter-pdftools-free-pointer-opacity 1.0
"Color for free pointer annotations."
:group 'org-noter
:type 'float)
(defcustom org-noter-pdftools-use-pdftools-link-location t
"When non-nil, org-pdftools link is used instead of location-cons when inserting notes."
:group 'org-noter
:type 'boolean)
(defcustom org-noter-pdftools-use-org-id t
"When non-nil, an org-id is generated for each heading for linking with PDF annotations and record entry parents."
:group 'org-noter
:type 'boolean)
(defcustom org-noter-pdftools-export-to-pdf t
"TODO: Whether you want to export the org notes to pdf annotation contents.
To use this, `org-noter-pdftools-use-org-id' has to be t."
:group 'org-noter
:type 'boolean)
(defcustom org-noter-pdftools-export-to-pdf-with-structure t
"TODO: Whether you want to export the org notes to pdf annotation contents.
To use this, `org-noter-pdftools-use-org-id' has to be t."
:group 'org-noter
:type 'boolean)
(defcustom org-noter-pdftools-use-unique-org-id t
"When non-nil, an org-id is generated for each heading for linking with PDF annotations and record entry parents."
:group 'org-noter
:type 'boolean)
(defcustom org-noter-pdftools-insert-content-heading t
"When non-nil, insert a \"Content\" heading above the content of an annotation (underline, highlight)"
:group 'org-noter
:type 'boolean)
(defcustom org-noter-pdftools-insert-comment-heading t
"When non-nil, insert a \"Content\" heading above the content of an annotation (underline, highlight)"
:group 'org-noter
:type 'boolean)
(cl-defstruct org-noter-pdftools--location
path page height annot-id search-string original-property)
(defun org-noter-pdftools--location-link-p (location)
"Check whether LOCATION is a org-pdftools link."
(and location
(stringp location)
(or
(string-prefix-p
(concat "[[" org-pdftools-link-prefix ":")
location)
(string-prefix-p
(concat org-pdftools-link-prefix ":")
location))))
(defun org-noter-pdftools--location-cons-to-link (location)
"Convert LOCATION cons to link."
(cond ((consp location)
(concat
"::"
(number-to-string
(car location))
"++"
(format "%.2f" (cadr location))))
((integerp location)
(concat
"::"
(number-to-string
(car location))))))
(defun org-noter-pdftools--location-link-to-cons (location)
"Convert a org-pdftools link to old LOCATION cons."
(cons (org-noter-pdftools--location-page location) (or (org-noter-pdftools--location-height location) 0.0)))
;; --------------------------------------------------------------------------------
;; NOTE(nox): Interface
(defun org-noter-pdftools--check-link (property)
"Interface for checking PROPERTY link."
(org-noter-pdftools--location-link-p property))
(defun org-noter-pdftools--parse-link (property)
"Interface for parse PROPERTY link."
(when (org-noter-pdftools--location-link-p property)
(setq property (string-trim property "\\[\\[" "\\]\\]"))
(let ((link-regexp (concat "\\(.*\\)::\\([0-9]*\\)\\(\\+\\+\\)?\\([[0-9]\\.*[0-9]*\\)?\\(;;\\|"
(regexp-quote org-pdftools-search-string-separator)
"\\)?\\(.*\\)?")))
(string-match link-regexp property)
(let ((path (match-string 1 property))
(page (match-string 2 property))
(height (match-string 4 property))
annot-id search-string)
(condition-case nil
(cond ((string-equal (match-string 5 property) ";;")
(setq annot-id (match-string 6 property)))
((string-equal (match-string 5 property) org-pdftools-search-string-separator)
(setq search-string (replace-regexp-in-string "%20" " " (match-string 6 property)))))
(error nil))
(make-org-noter-pdftools--location
:path path
:page (and page (string-to-number page))
:height (and height (string-to-number height))
:annot-id annot-id
:search-string search-string
:original-property property)))))
(defun org-noter-pdftools--pretty-print-location (location)
"Function for print the LOCATION link."
(org-noter--with-valid-session
(if (memq (org-noter--session-doc-mode session) '(doc-view-mode pdf-view-mode))
(let ((loc (if (org-noter-pdftools--location-p location)
location
(org-noter-pdftools--parse-link location))))
(concat "[["
(org-noter-pdftools--location-original-property loc)
"]]"))
nil)))
(defun org-noter-pdftools--convert-to-location-cons (location)
"Function for converting the LOCATION link to cons."
(if (and location (consp location))
location
(let ((loc (if (org-noter-pdftools--location-p location)
location
(org-noter-pdftools--parse-link location))))
(org-noter-pdftools--location-link-to-cons loc))))
(defun org-noter-pdftools--doc-goto-location (mode location &optional _window)
"Goto LOCATION in the corresponding MODE."
(when
(and
(eq mode 'pdf-view-mode)
(org-noter-pdftools--location-p location))
(let
((page
(org-noter-pdftools--location-page location))
(annot-id
(org-noter-pdftools--location-annot-id location))
(heading
(org-noter-pdftools--location-search-string location)))
(if page
(pdf-view-goto-page page))
(if annot-id
(pdf-annot-show-annotation
(pdf-info-getannot annot-id)
t))
(if heading
(org-pdftools-occur-goto-heading heading page)))
t))
(defun org-noter-pdftools--note-after-tipping-point (point location view)
"Call `org-noter--note-after-tipping-point' relative to POINT based on LOCATION and VIEW."
(when (org-noter-pdftools--location-p location)
(cons t (org-noter--note-after-tipping-point point (org-noter-pdftools--location-link-to-cons location) view))))
(defun org-noter-pdftools--relative-position-to-view (location view)
"Get relative position based on LOCATION and VIEW."
(when (org-noter-pdftools--location-p location)
(org-noter--relative-position-to-view (org-noter-pdftools--location-link-to-cons location) view)))
(defun org-noter-pdftools--get-precise-info (mode &optional _window)
"Get precise info from MODE."
(when (eq mode 'pdf-view-mode)
(let ((org-pdftools-free-pointer-icon org-noter-pdftools-free-pointer-icon)
(org-pdftools-free-pointer-color org-noter-pdftools-free-pointer-color)
(org-pdftools-free-pointer-opacity org-noter-pdftools-free-pointer-opacity)
(org-pdftools-markup-pointer-color org-noter-pdftools-markup-pointer-color)
(org-pdftools-markup-pointer-opacity org-noter-pdftools-markup-pointer-opacity)
(org-pdftools-markup-pointer-function org-noter-pdftools-markup-pointer-function))
(org-noter-pdftools--parse-link (org-pdftools-get-link)))))
(defun org-noter-pdftools--doc-approx-location (mode precise-info force-new-ref)
"Get approximate location in MODE buffer based on PRECISE-INFO and FORCE-NEW-REF."
(org-noter--with-valid-session
(when (eq mode 'pdf-view-mode)
(cond ((or (numberp precise-info) (not precise-info))
(org-noter-pdftools--parse-link
(concat org-pdftools-link-prefix ":" (expand-file-name (org-noter--session-property-text session)) "::"
(number-to-string (image-mode-window-get 'page))
(when precise-info (concat "++" (number-to-string precise-info))))))
((org-noter-pdftools--location-p precise-info) precise-info)
((eq precise-info 'interactive)
(when force-new-ref
(setf (gv-deref force-new-ref) t))
(org-noter-pdftools--get-precise-info mode))
(t (error "Invalid pdftools precise-info case: %s" precise-info))))))
(defun org-noter-pdftools--insert-heading ()
"Insert heading in the `org-noter' org document."
(let* ((location-property (org-entry-get nil org-noter-property-note-location)))
(when location-property
(if (string-suffix-p "]]" location-property)
(setq location-property (substring location-property 0 -2)))
(when (string-match ".*;;\\(.*\\)" location-property)
(org-noter--with-valid-session
(let ((id (match-string 1 location-property)))
(if org-noter-pdftools-use-org-id
(org-entry-put nil "ID"
(if org-noter-pdftools-use-unique-org-id
(concat
(org-noter--session-property-text session)
"-"
id)
id)))))))))
(dolist (pair '((org-noter--check-location-property-hook . org-noter-pdftools--check-link)
(org-noter--parse-location-property-hook . org-noter-pdftools--parse-link)
(org-noter--pretty-print-location-hook . org-noter-pdftools--pretty-print-location)
(org-noter--convert-to-location-cons-hook . org-noter-pdftools--convert-to-location-cons)
(org-noter--doc-goto-location-hook . org-noter-pdftools--doc-goto-location)
(org-noter--note-after-tipping-point-hook . org-noter-pdftools--note-after-tipping-point)
(org-noter--relative-position-to-view-hook . org-noter-pdftools--relative-position-to-view)
(org-noter--get-precise-info-hook . org-noter-pdftools--get-precise-info)
(org-noter--doc-approx-location-hook . org-noter-pdftools--doc-approx-location)
(org-noter-insert-heading-hook . org-noter-pdftools--insert-heading)))
(add-hook (car pair) (cdr pair)))
;; --------------------------------------------------------------------------------
;; NOTE(nox): User commands
(defun org-noter-pdftools-convert-old-org-heading ()
"Covert an old org heading to a new one for compatiblility."
(interactive)
(org-noter--with-valid-session
(cond ((eq (org-noter--session-doc-mode
session)
'pdf-view-mode)
(let* ((document-property (org-noter--session-property-text
session)))
(let* ((location (org-noter--parse-location-property
(org-entry-get
nil
org-noter-property-note-location)))
(path document-property)
(page (if (consp location)
(car location)
location))
(height (if (consp location)
(cadr location)
0.0))
(pos `(0 . ,(round
(*
(cdr (with-current-buffer
(org-noter--session-doc-buffer
session)
(pdf-view-image-size)))
height))))
(annot-id (symbol-name
(pdf-annot-get-id
(save-excursion
(with-selected-window
(org-noter--get-doc-window)
(pdf-view-goto-page page)
(funcall-interactively
#'pdf-annot-add-text-annotation
pos
org-pdftools-free-pointer-icon
`((color . ,org-pdftools-free-pointer-color)
(opacity . ,org-pdftools-free-pointer-opacity)))))))))
(org-entry-put
nil
org-noter-property-note-location
(concat
"[["
org-pdftools-link-prefix
":"
path
(org-noter-pdftools--location-cons-to-link
location)
";;"
annot-id
"]]"))
(when org-noter-pdftools-use-org-id
(org-entry-put
nil
"ID"
(if org-noter-pdftools-use-unique-org-id
(concat
document-property
"-"
annot-id)
annot-id)))
(when org-noter-pdftools-export-to-pdf
(let* ((content (if (and (> (org-current-level) 2)
org-noter-pdftools-export-to-pdf-with-structure)
(let ((parent-id (save-excursion
(org-up-heading-safe)
(org-id-get))))
(if parent-id
(concat
"#+PROPERTY: PARENT "
parent-id
"\n"
(save-excursion
(org-back-to-heading nil)
(buffer-substring-no-properties
(point)
(org-end-of-subtree nil t))))))
(save-excursion
(org-back-to-heading nil)
(buffer-substring-no-properties
(point)
(org-end-of-subtree nil t))))))
(with-selected-window
(org-noter--get-doc-window)
(pdf-info-editannot
(intern annot-id)
`((contents . ,content)))))))))
(t
(error
"This command is only supported on PDF Tools")))))
(defun org-noter-pdftools-convert-old-notes ()
"Convert old notes (location cons based) to new format (link based)."
(interactive)
(org-noter--with-valid-session
(goto-char (point-min))
(when (org-before-first-heading-p)
(org-next-visible-heading 1))
(while (not (eq (point) (point-max)))
(org-next-visible-heading 1)
(goto-char (point-at-eol))
(let ((prop (org-entry-get
nil
org-noter-property-note-location)))
(if (and prop
(not (string-prefix-p
org-pdftools-link-prefix ":"
prop)))
(call-interactively
#'org-noter-pdftools-convert-old-org-heading))))))
(defun org-noter-pdftools-jump-to-note (a)
"Jump from a PDF annotation A to the corresponding org heading."
(interactive (list
(with-selected-window
(org-noter--get-doc-window)
(pdf-annot-read-annotation
"Left click the annotation "))))
(unless org-noter-pdftools-use-org-id
"You have to enable `org-noter-pdftools-use-org-id'!")
(org-noter--with-valid-session
(let ((id (symbol-name
(pdf-annot-get-id a))))
;; (select-window
;; (org-noter--get-notes-window 'force))
(with-selected-window (org-noter--get-notes-window)
(let ((exist-id (org-id-find-id-in-file
(if org-noter-pdftools-use-unique-org-id
(concat (org-noter--session-property-text session) "-" id)
id)
buffer-file-name)))
(if exist-id (progn (goto-char (cdr exist-id))
(outline-show-branches)
(org-noter-sync-current-note))
nil))))))
;; TODO(nox): Implement interface for skeleton creation
(defun org-noter-pdftools-create-skeleton ()
"Create notes skeleton with the PDF outline or annotations.
Only available with PDF Tools."
(interactive)
(org-noter--with-valid-session
(cond
((eq (org-noter--session-doc-mode session) 'pdf-view-mode)
(let* ((ast (org-noter--parse-root))
(top-level (org-element-property :level ast))
(options '(("Outline" . (outline))
("Annotations" . (annots))
("Both" . (outline annots))))
answer output-data)
(with-current-buffer (org-noter--session-doc-buffer session)
(setq answer (assoc (completing-read "What do you want to import? " options nil t) options))
(when (memq 'outline answer)
(dolist (item (pdf-info-outline))
(let ((type (alist-get 'type item))
(page (alist-get 'page item))
(depth (alist-get 'depth item))
(title (alist-get 'title item))
(top (alist-get 'top item))
pdftools-link path)
(when (and (eq type 'goto-dest)
(> page 0))
(when org-noter-pdftools-use-pdftools-link-location
(setq path
(funcall org-noter-pdftools-path-generator (buffer-file-name)))
(if title
(setq pdftools-link
(concat
org-pdftools-link-prefix ":"
path
"::"
(number-to-string page)
"++"
(if top
(number-to-string top)
"0")
org-pdftools-search-string-separator
(replace-regexp-in-string
" "
"%20"
title)))
(setq pdftools-link
(concat
org-pdftools-link-prefix ":"
path
"::"
(number-to-string page)
"++"
(number-to-string top)))))
(push
(vector
title
(if org-noter-pdftools-use-pdftools-link-location pdftools-link
(cons page top))
(1+ depth)
nil)
output-data)))))
(when (memq 'annots answer)
(let ((possible-annots (list '("Highlights" . highlight)
'("Underlines" . underline)
'("Squigglies" . squiggly)
'("Text notes" . text)
'("Strikeouts" . strike-out)
'("Links" . link)
'("ALL" . all)))
chosen-annots insert-contents pages-with-links)
(while (> (length possible-annots) 1)
(let* ((chosen-string (completing-read "Which types of annotations do you want? "
possible-annots nil t))
(chosen-pair (assoc chosen-string possible-annots)))
(cond ((eq (cdr chosen-pair) 'all)
(dolist (annot possible-annots)
(when (and (cdr annot) (not (eq (cdr annot) 'all)))
(push (cdr annot) chosen-annots)))
(setq possible-annots nil))
((cdr chosen-pair)
(push (cdr chosen-pair) chosen-annots)
(setq possible-annots (delq chosen-pair possible-annots))
(when (= 1 (length chosen-annots)) (push '("DONE") possible-annots)))
(t
(setq possible-annots nil)))))
(setq insert-contents (y-or-n-p "Should we insert the annotations contents? "))
(dolist (item (pdf-info-getannots))
(let* ((type (alist-get 'type item))
(page (alist-get 'page item))
(edges (or (org-noter--pdf-tools-edges-to-region (alist-get 'markup-edges item))
(alist-get 'edges item)))
(top (nth 1 edges))
(item-subject (alist-get 'subject item))
(item-contents (alist-get 'contents item))
(id (symbol-name (alist-get 'id item)))
name contents pdftools-link path)
(when org-noter-pdftools-use-pdftools-link-location
(setq path (funcall org-noter-pdftools-path-generator (buffer-file-name)))
(setq pdftools-link (concat org-pdftools-link-prefix ":" path "::"
(number-to-string page) "++"
(number-to-string top) ";;"
id)))
(when (and (memq type chosen-annots) (> page 0))
(if (eq type 'link)
(cl-pushnew page pages-with-links)
(setq name (cond ((eq type 'highlight) "Highlight")
((eq type 'underline) "Underline")
((eq type 'squiggly) "Squiggly")
((eq type 'text) "Text note")
((eq type 'strike-out) "Strikeout")))
(when insert-contents
(setq contents (cons (pdf-info-gettext page edges)
(and (or (and item-subject (> (length item-subject) 0))
(and item-contents (> (length item-contents) 0)))
(concat (or item-subject "")
(if (and item-subject item-contents) "\n" "")
(or item-contents ""))))))
(push (vector (format "%s on page %d" name page) (if org-noter-pdftools-use-pdftools-link-location
pdftools-link
(cons page top)) 'inside contents)
output-data)))))
(dolist (page pages-with-links)
(let ((links (pdf-info-pagelinks page))
type)
(dolist (link links)
(setq type (alist-get 'type link))
(unless (eq type 'goto-dest) ;; NOTE(nox): Ignore internal links
(let* ((edges (alist-get 'edges link))
(title (alist-get 'title link))
(top (nth 1 edges))
(target-page (alist-get 'page link))
target heading-text pdftools-link path)
(when org-noter-pdftools-use-pdftools-link-location
(setq path
(funcall org-noter-pdftools-path-generator (buffer-file-name)))
(setq pdftools-link (concat org-pdftools-link-prefix ":" path "::"
(number-to-string page) "++"
(number-to-string top))))
(unless (and title (> (length title) 0)) (setq title (pdf-info-gettext page edges)))
(cond
((eq type 'uri)
(setq target (alist-get 'uri link)
heading-text (format "Link on page %d: [[%s][%s]]" page target title)))
((eq type 'goto-remote)
(setq target (concat "file:" (alist-get 'filename link))
heading-text (format "Link to document on page %d: [[%s][%s]]" page target title))
(when target-page
(setq heading-text (concat heading-text (format " (target page: %d)" target-page)))))
(t (error "Unexpected link type")))
(push
(vector
heading-text
(if org-noter-pdftools-use-pdftools-link-location
pdftools-link
(cons page top))
'inside
nil)
output-data))))))))
(when output-data
(if (memq 'annots answer)
(setq output-data
(sort output-data
(lambda (e1 e2)
(or (not (aref e1 1))
(and (aref e2 1)
(org-noter--compare-locations '< (aref e1 1) (aref e2 1)))))))
(setq output-data (nreverse output-data)))
(push (vector "Skeleton" nil 1 nil) output-data)))
(with-current-buffer (org-noter--session-notes-buffer session)
;; NOTE(nox): org-with-wide-buffer can't be used because we want to reset the
;; narrow region to include the new headings
(widen)
(save-excursion
(goto-char (org-element-property :end ast))
(let (last-absolute-level
title location relative-level contents
level)
(dolist (data output-data)
(setq title (aref data 0)
location (aref data 1)
relative-level (aref data 2)
contents (aref data 3))
(if (symbolp relative-level)
(setq level (1+ last-absolute-level))
(setq last-absolute-level (+ top-level relative-level)
level last-absolute-level))
(org-noter--insert-heading level title nil location)
(when (car contents)
(when org-noter-pdftools-insert-content-heading
(org-noter--insert-heading (1+ level) "Contents"))
(insert (car contents)))
(when (cdr contents)
(when org-noter-pdftools-insert-comment-heading
(org-noter--insert-heading (1+ level) "Comment"))
(insert (cdr contents)))))
(setq ast (org-noter--parse-root))
(org-noter--narrow-to-root ast)
(goto-char (org-element-property :begin ast))
(outline-hide-subtree)
(org-fold-show-children 2)))))
(t (error "This command is only supported on PDF Tools")))))
(defun org-noter-pdftools-insert-precise-note (&optional toggle-no-questions)
(interactive "P")
(org-noter--with-valid-session
(let ((org-noter-insert-note-no-questions
(if toggle-no-questions
(not org-noter-insert-note-no-questions)
org-noter-insert-note-no-questions))
(org-pdftools-use-isearch-link t)
(org-pdftools-use-freepointer-annot t))
(org-noter-insert-note (org-noter--get-precise-info)))))
(defun org-noter-pdftools-insert-precise-note-highlight (&optional read-color-t)
(interactive)
(org-noter--with-valid-session
(setq org-noter-pdftools-markup-pointer-color (if read-color-t (read-color) "#d3d3d3")
org-noter-pdftools-markup-pointer-function 'pdf-annot-add-highlight-markup-annotation
org-noter-insert-note-no-questions t)
(org-noter-insert-precise-note)))
(defun org-noter-pdftools-insert-precise-note-keyunderstand ()
(interactive)
(setq org-noter-pdftools-markup-pointer-color "#6ce964"
org-noter-pdftools-markup-pointer-function 'pdf-annot-add-highlight-markup-annotation
org-noter-insert-note-no-questions t)
(org-noter-insert-precise-note))
(defun org-noter-pdftools-insert-precise-note-rectangle ()
(interactive)
(setq org-noter-pdftools-markup-pointer-color "#cce0f8"
org-noter-pdftools-markup-pointer-function 'pdf-annot-add-highlight-markup-annotation
org-noter-insert-note-no-questions t)
(org-noter-insert-precise-note))
(defun org-noter-pdftools-insert-precise-note-squiggly ()
(interactive)
(setq org-noter-pdftools-markup-pointer-color "#ffa500"
org-noter-pdftools-markup-pointer-function 'pdf-annot-add-squiggly-markup-annotation
org-noter-insert-note-no-questions t)
(org-noter-insert-precise-note))
(defun org-noter-pdftools-insert-precise-note-strikeout ()
(interactive)
(setq org-noter-pdftools-markup-pointer-color "#ff0000"
org-noter-pdftools-markup-pointer-function 'pdf-annot-add-strikeout-markup-annotation)
(org-noter-insert-precise-note))
(defun org-noter-pdftools-insert-precise-note-underline ()
(interactive)
(setq org-noter-pdftools-markup-pointer-color "#228b22"
org-noter-pdftools-markup-pointer-function 'pdf-annot-add-underline-markup-annotation)
(org-noter-insert-precise-note))
(defun org-noter-pdftools-activate-org-note ()
(interactive)
(org-noter--with-valid-session
(unless
(equal
(selected-window)
(org-noter--get-notes-window))
(error "You should use this command in an org-noter note buffer"))
(let*
((org-id
(org-id-get)))
(unless
(and
(string-match ".*\\(annot-.*-.*\\)" org-id)
org-noter-pdftools-use-org-id
org-noter-pdftools-use-pdftools-link-location)
(error "This can only be run on an org heading with a valid org-pdftools annotation ID.
Please also make sure `org-noter-pdftools-use-org-id' and `org-noter-pdftools-use-pdftools-link-location' are enabled"))
(let*
((annot-id
(match-string 1 org-id))
note)
(select-window
(org-noter--get-doc-window))
(pdf-annot-activate-annotation
(pdf-annot-getannot annot-id))
(pdf-annot-default-activate-handler
(pdf-annot-getannot annot-id))))))
(defun org-noter-pdftools-embed-org-note-to-pdf ()
"Embed a org subtree to its corresponding PDF annotation."
(interactive)
(org-noter--with-valid-session
(unless (equal (selected-window) (org-noter--get-notes-window))
(error "You should use this command in an org-noter note buffer"))
(let* ((org-id (org-id-get)))
(unless (and (string-match ".*\\(annot-.*-.*\\)" org-id)
org-noter-pdftools-use-org-id
org-noter-pdftools-use-pdftools-link-location)
(error "This can only be run on an org heading with a valid org-pdftools annotation ID.
Please also make sure `org-noter-pdftools-use-org-id' and `org-noter-pdftools-use-pdftools-link-location' are enabled"))
(let* ((annot-id (match-string 1 org-id))
note)
(setq kr kill-ring)
(org-copy-subtree)
(setq note (car kill-ring))
(setq kill-ring kr)
(with-selected-window
(org-noter--get-doc-window)
(let ((annot (pdf-annot-getannot (intern annot-id))))
(with-current-buffer (pdf-annot-edit-contents-noselect annot)
(insert note)
(pdf-annot-edit-contents-finalize t)
(save-buffer))))
(select-window (org-noter--get-doc-window))
(pdf-annot-default-activate-handler (pdf-annot-getannot annot-id))))))
(defun org-noter-pdftools-embed-all-org-note-to-pdf ()
(interactive)
(org-noter--with-valid-session
(with-selected-window (org-noter--get-notes-window)
(save-excursion
(org-map-entries #'org-noter-pdftools-embed-org-note-to-pdf "ID={annot-}")))))
(defun org-noter-pdftools-embed-org-buffer-to-pdf ()
"Embed the whole org-noter doc buffer to a PDF annotation."
(interactive)
(org-noter--with-valid-session
(let* ((note (with-selected-window (org-noter--get-notes-window)
(save-excursion
(buffer-substring-no-properties
(point-min) (point-max)))))
annot-id)
(with-selected-window
(org-noter--get-doc-window)
(save-excursion
(pdf-view-goto-page 1)
(setq annot-id
(pdf-annot-get-id
(let ((annot (ignore-errors (pdf-annot-at-position '(0 . 0)))))
(if annot
annot
(funcall-interactively
#'pdf-annot-add-text-annotation
'(0 . 0)
org-pdftools-free-pointer-icon
`((color . ,org-pdftools-free-pointer-color)
(opacity . ,org-pdftools-free-pointer-opacity))))))))
(with-selected-window
(org-noter--get-doc-window)
(let ((annot (pdf-annot-getannot annot-id)))
(with-current-buffer (pdf-annot-edit-contents-noselect annot)
(insert note)
(pdf-annot-edit-contents-finalize t)))
(save-buffer))))))
(provide 'org-noter-pdftools)
;;; org-noter-pdftools.el ends here