-
Notifications
You must be signed in to change notification settings - Fork 4
/
paw-annotation.el
1794 lines (1648 loc) · 78.8 KB
/
paw-annotation.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
;;; paw-annotation.el -*- lexical-binding: t; -*-
(require 'paw-vars)
(require 'paw-db)
(require 'paw-util)
(require 'paw-faces)
(require 'paw-svg)
(require 'paw-gptel)
(require 'paw-request)
(require 'paw-focus)
(require 'paw-search)
(require 'org)
(require 's)
(require 'dash)
(require 'focus)
(require 'thingatpt)
(require 'evil-core nil t)
(require 'immersive-translate nil t)
(declare-function evil-define-key* "ext:evil-core.el" t t)
(defcustom paw-annotation-mode-supported-modes
'(nov-mode org-mode paw-view-note-mode wallabag-entry-mode eww-mode eaf-mode)
"Supported modes for paw-annotation-mode."
:group 'paw
:type 'list)
(defvar paw-annotation-current-highlight-type (assoc 'highlight-1 paw-note-type-alist))
(defcustom paw-annotation-stamps
'("❗"
"❤"
"😊")
"Stamps could be a list of display properties, it can make use of svg-lib rich icons library, and no limit how many items."
:group 'paw
:type 'list)
(defcustom paw-annotation-after-string-space (if (eq system-type 'android) " " "\u2009")
"TODO Space string for annotation. Currently only support Japanese.
This is disabled since it does not work well, please don't use it at this moment."
:group 'paw
:type '(choice (const :tag "Normal space" " ")
(const :tag "Thin space" "\u2009")
(const :tag "Hair space" "\u200A")
(string :tag "Custom string")))
(defvar paw-annotation-map
(let ((map (make-sparse-keymap)))
;; (define-key map "," 'paw-list-annotations)
(define-key map (kbd "<RET>") 'paw-goto-dashboard)
(define-key map "D" 'paw-delete-annotation) ;; d is used for scroll
(define-key map "n" 'paw-next-annotation)
(define-key map "N" 'paw-previous-annotation)
(define-key map "p" 'paw-previous-annotation) ;; may impact edit mode
(define-key map "y" 'paw-copy-annotation)
(define-key map "r" 'paw-view-note-play)
(define-key map "s" 'paw-view-note-in-minibuffer)
(define-key map "i" 'paw-find-note)
(define-key map "&" 'paw-find-note)
(define-key map "I" 'paw-find-notes)
(define-key map "v" 'paw-view-note)
(define-key map "V" 'paw-view-notes)
(define-key map "c" 'paw-change-word-learning-level)
(define-key map "C" 'paw-change-note_type)
(define-key map "f" 'paw-follow-link)
;; (define-key map (kbd "<mouse-8>") 'paw-mouse-8)
;; (define-key map (kbd "<mouse-9>") 'paw-mouse-9)
;; (define-key map (kbd "<mouse-1>") 'paw-mouse-2) ; have to enable mouse 2 will also binds mouse 1 (no idea)
;; (define-key map (kbd "<mouse-2>") 'paw-mouse-2) ; have to enable mouse 2 will also binds mouse 1 (no idea)
map)
"Keymap for annotation overlay.")
(defun paw-mouse-8 (event)
"Browser the url click on with eww.
Argument EVENT mouse event."
(interactive "e")
(let ((window (posn-window (event-end event)))
(pos (posn-point (event-end event))))
(if (not (windowp window))
(error "No word chosen"))
(with-current-buffer (window-buffer window)
(goto-char pos)
(paw-view-note))))
(defun paw-mouse-9 (event)
"Browser the url click on with eww.
Argument EVENT mouse event."
(interactive "e")
(let ((window (posn-window (event-end event)))
(pos (posn-point (event-end event))))
(if (not (windowp window))
(error "No word chosen"))
(with-current-buffer (window-buffer window)
(goto-char pos)
(paw-view-notes))))
(defun paw-mouse-2 (event)
"Browser the url click on with eww.
Argument EVENT mouse event."
(interactive "e")
(let ((window (posn-window (event-end event)))
(pos (posn-point (event-end event))))
(if (not (windowp window))
(error "No word chosen"))
(with-current-buffer (window-buffer window)
(goto-char pos)
(paw-view-note))))
(defcustom paw-cache-dir
(expand-file-name (concat user-emacs-directory ".cache/paw"))
"paw cache directory."
:group 'paw
:type 'directory)
(defun paw-add-general (word type location &optional gptel note path)
(let* ((word (pcase (car type)
('bookmark
(pcase major-mode
('eaf-mode (pcase eaf--buffer-app-name
("browser" eaf--bookmark-title)
("pdf-viewer" (file-name-nondirectory eaf--buffer-url ))
(_ nil)))
('eww-mode (plist-get eww-data :title))
(_ (format "Bookmark %s" (pp location)))))
(_ word)))
(id (concat word ":id:" (org-id-uuid))))
(paw-db-insert
`(((word . ,id) (exp . nil)))
:content (pcase (car type)
('image (let ((image (condition-case nil
(or (plist-get (cdr (image--get-image)) :file)
(plist-get (cdr (image--get-image)) :data))
(error nil))))
(if image
(paw-image-content-json image) ; if image under point, no need to prompt, just add it as attachment
(let* ((png (format "%s.png" (org-id-uuid)))
(path (expand-file-name png paw-note-dir))
(json (json-encode `((filename . "screenshot.png") (path . ,png)))))
(let ((result
(shell-command-to-string
(format
(cl-case system-type
(gnu/linux
(if (string= "wayland" (getenv "XDG_SESSION_TYPE"))
(if (executable-find "wl-paste")
"wl-paste -t image/png > %s"
(user-error
"Please install the \"wl-paste\" program included in wl-clipboard"))
(if (executable-find "xclip")
"xclip -selection clipboard -t image/png -o > %s"
(user-error
"Please install the \"xclip\" program"))))
((windows-nt cygwin)
(if (executable-find "convert")
"/mingw64/bin/convert.exe clipboard: %s"
(user-error
"Please install the \"convert\" program included in ImageMagick")))
((darwin berkeley-unix)
(if (executable-find "pngpaste")
"pngpaste %s"
(user-error
"Please install the \"pngpaste\" program from Homebrew.")))) path))))
(if (s-contains? "No image data found on the clipboard" result)
(error (s-collapse-whitespace result))))
json))))
('attachment (let* ((image (condition-case nil
(or (plist-get (cdr (image--get-image)) :file)
(plist-get (cdr (image--get-image)) :data))
(error nil))))
(if image
(paw-image-content-json image) ; if image under point, no need to prompt, just add it as attachment
(let* ((src (read-file-name "Select the attachment: "))
(attachment (format "%s.%s" (org-id-uuid) (file-name-extension (file-name-nondirectory src))))
(dst (expand-file-name attachment paw-note-dir))
(json (json-encode `((filename . ,(file-name-nondirectory src)) (path . ,attachment)))))
(copy-file src dst t)
json))))
('link (let* ((type (ido-completing-read "Select the link type: " '("file" "url" "annotation" "org")))
(link
(pcase type
("file"
(read-file-name "Select a file as link: "))
("url"
(read-from-minibuffer "Please insert an url link: "))
("annotation"
(let* ((entry (get-text-property 0 'paw-entry
(ivy-read "Please insert an annotation: " (paw-candidates-format t)
:sort nil)))
(word (alist-get 'word entry)))
word))
("org"
(with-temp-buffer
(call-interactively 'org-insert-link)
(buffer-string)))))
(json (json-encode `((type . ,type) (link . ,link)))))
json))
('bookmark
(pcase major-mode
('eaf-mode (pcase eaf--buffer-app-name
("browser" eaf--bookmark-title)
("pdf-viewer" (file-name-nondirectory eaf--buffer-url ))
(_ nil)))
('eww-mode (plist-get eww-data :title))
(_ (format "Bookmark %s" (pp location)))))
(_ word))
:serverp 2
:note (or note
(pcase (car type)
('attachment "") ; attachment empty note, mark also empty
('image "")
('bookmark "")
('word (paw-get-note))
(_ (if mark-active
"" ; mark is empty, since the note not that useful, if need sentence note, use `paw-add-word'
(paw-get-note)))) )
:note_type type
:origin_type (if (derived-mode-p 'eaf-mode)
eaf--buffer-app-name
major-mode)
:origin_path (or path (paw-get-origin-path))
:origin_id (paw-get-id)
:origin_point location
:created_at (format-time-string "%Y-%m-%d %H:%M:%S" (current-time)))
;; update content with gptel
(if gptel
(paw-gptel-update-note id word (car type)
(lambda ()
(if (eq major-mode 'paw-search-mode)
(paw-search-refresh)))))
;; quit mark
(if (featurep 'evil)
(evil-force-normal-state))
;; query back the entry and add overylay
(let ((candidates (paw-candidate-by-id (if (string-match ":id:\\(.*\\)" id)
(match-string 1 id)
id))))
;; attachment do not need overlay
(pcase (car type)
((or 'attachment 'image)
(paw-find-note (car candidates)))
('bookmark
(paw-download-ico (paw-get-origin-path))
(message (format "Added bookmark: %s -> %s" (paw-get-origin-path) location)))
('sdcv
(message (format "Added sdcv: %s" word)))
(_ (pcase major-mode
('pdf-view-mode nil)
('eaf-mode nil)
('paw-search-mode nil)
(_ (paw-add-annotation-overlay (car candidates))))))
;; update *paw* buffer
(if (buffer-live-p (get-buffer "*paw*"))
(paw t)))
;; enable paw annotation mode after adding
(unless paw-annotation-mode
(paw-annotation-mode 1))
))
(defun paw-download-ico (&optional location)
"Download ico file from location."
(interactive)
(let* ((location (or location (alist-get 'origin_path (paw-find-candidate-at-point))) )
(location (let* ((url (url-generic-parse-url location))
(https (url-type url))
(host (url-host url)))
(concat https "://" host)))
(ico-file-hash (md5 location))
(icon-file-path (concat (expand-file-name ico-file-hash paw-cache-dir) ".ico"))
(output-icon-file-path (concat (expand-file-name ico-file-hash paw-cache-dir) ".png")))
(when (string-match-p "http" location)
(unless (file-exists-p output-icon-file-path)
(message "Downloading ico file from %s" location)
(request location
:parser 'buffer-string
:headers `(("User-Agent" . "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.101 Safari/537.36")
("Content-Type" . "application/xml"))
:timeout 5
:success (cl-function
(lambda (&key data &allow-other-keys)
(when-let* ((parsed-html (with-temp-buffer
(insert data)
(libxml-parse-html-region (point-min) (point-max))))
(icons (dom-elements parsed-html 'rel "icon"))
(icon (dom-attr icons 'href))
(icon (if (string-match-p "https" icon)
icon
(let* ((url (url-generic-parse-url location))
(https (url-type url))
(host (url-host url)))
(concat https "://" host icon)))))
(message "Found ico: %s" icon)
(make-directory paw-cache-dir t)
(set-process-sentinel
(start-process
(executable-find "curl")
"*paw-favicon-downloder*"
(executable-find "curl")
"-L"
"--user-agent"
"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.101 Safari/537.36"
icon
"--output"
icon-file-path)
(lambda (process event)
(when (string= event "finished\n")
(call-process-shell-command (format "convert %s -thumbnail 16x16 -alpha on -background none -flatten %s" icon-file-path output-icon-file-path) nil 0)
(message "Download ico to %s" output-icon-file-path)
(paw-search-refresh)))))))
:error
(cl-function (lambda (&rest args &key error-thrown &allow-other-keys)
(message "%s" error-thrown))))))))
(defun paw-download-all-icos()
"Download all ico files. Be careful, it will try to download all
icos of all links (`paw-list-all-links') in database."
(interactive)
(cl-loop for entry in (paw-candidates-only-links) do
(paw-download-ico (alist-get 'origin_path entry) )))
(defun paw-image-content-json (image)
(if (file-exists-p image)
(let* ((src image)
(attachment (format "%s.%s" (org-id-uuid) (file-name-extension (file-name-nondirectory src))))
(dst (expand-file-name attachment paw-note-dir))
(json (json-encode `((filename . ,(file-name-nondirectory src)) (path . ,attachment)))))
(copy-file src dst t)
json)
(let* ((src (expand-file-name (concat "picture." (symbol-name (plist-get (cdr (image--get-image)) :type) )) temporary-file-directory))
(attachment (format "%s.%s" (org-id-uuid) (file-name-extension (file-name-nondirectory src))))
(dst (expand-file-name attachment paw-note-dir))
(json (json-encode `((filename . ,(file-name-nondirectory src)) (path . ,attachment)))))
(with-temp-buffer
(insert image)
(write-region (point-min) (point-max) src))
(copy-file src dst t)
json)))
;;;###autoload
(defun paw-add-highlight (prefix)
"Add an annotation."
(interactive "P")
(let* ((word (cond ((eq major-mode 'paw-search-mode) "")
((eq major-mode 'pdf-view-mode)
(if (pdf-view-active-region-p)
(mapconcat 'identity (pdf-view-active-region-text) ? )
"EMPTY ANNOTATION"))
((eq major-mode 'eaf-mode)
(pcase eaf--buffer-app-name
("browser"
(eaf-execute-app-cmd 'eaf-py-proxy-copy_text)
(sleep-for 0.01) ;; TODO small delay to wait for the clipboard
(eaf-call-sync "execute_function" eaf--buffer-id "get_clipboard_text"))
("pdf-viewer"
(eaf-execute-app-cmd 'eaf-py-proxy-copy_select)
(sleep-for 0.01) ;; TODO small delay to wait for the clipboard
(eaf-call-sync "execute_function" eaf--buffer-id "get_clipboard_text"))))
(mark-active (if (eq major-mode 'nov-mode)
(paw-remove-spaces-based-on-ascii-rate (buffer-substring-no-properties (region-beginning) (region-end)))
(buffer-substring-no-properties (region-beginning) (region-end))))
(t (substring-no-properties (or (thing-at-point 'symbol t) "")))))
(type paw-annotation-current-highlight-type )
(location (pcase major-mode
('nov-mode
(if mark-active
(cons nov-documents-index (cons (region-beginning) (region-end)))
(cons nov-documents-index (save-excursion
(let (beg end)
(forward-thing 'symbol 1)
(setq end (point))
(forward-thing 'symbol -1)
(setq beg (point))
(cons beg end)) ))))
('pdf-view-mode
(require 'org-noter)
(org-noter--doc-approx-location
(org-noter--conv-page-scroll-percentage
(+ (window-vscroll)
(cdr (posn-col-row (event-start (read-event "Click the location"))))))))
('eaf-mode
(pcase eaf--buffer-app-name
("pdf-viewer"
(string-to-number (eaf-call-sync "execute_function" eaf--buffer-id "current_page")))
("browser" 0)
(_ 0)))
(_ (if mark-active
(cons (region-beginning) (region-end))
(save-excursion
(let (beg end)
(forward-thing 'symbol 1)
(setq end (point))
(forward-thing 'symbol -1)
(setq beg (point))
(cons beg end))))))))
(paw-add-general word type location prefix)))
;;;###autoload
(defun paw-add-stamp (prefix)
"Add an annotation."
(interactive "P")
(let* ((word (paw-get-word))
(type (paw-get-stamp))
(location (paw-get-location)))
(paw-add-general word type location prefix)))
(defun paw-get-stamp ()
(cons 'stamp (ido-completing-read "Select a stamp: " paw-annotation-stamps)))
(defun paw-get-location ()
"Get location at point or marked region."
(pcase major-mode
('nov-mode
(if mark-active
(cons nov-documents-index (cons (region-beginning) (region-end)))
(cons nov-documents-index (point))))
('pdf-view-mode
(require 'org-noter)
(org-noter--doc-approx-location
(org-noter--conv-page-scroll-percentage
(+ (window-vscroll)
(cdr (posn-col-row (event-start (read-event "Click the location"))))))))
('eaf-mode
(pcase eaf--buffer-app-name
("pdf-viewer"
(string-to-number (eaf-call-sync "execute_function" eaf--buffer-id "current_page")))
("browser" 0)
(_ 0)))
(_ (if mark-active (cons (region-beginning) (region-end))
(point)))))
;;;###autoload (autoload 'paw-add "paw-annotation")
(defmacro paw-add (field)
`(defun ,(intern (format "paw-add-%s" field)) (prefix)
(interactive "P")
(let* ((word (paw-get-word))
(type (assoc ',(intern field) paw-note-type-alist))
(location (paw-get-location)))
(paw-add-general word type location prefix))))
(paw-add "word")
(paw-add "todo")
(paw-add "done")
(paw-add "cancel")
(paw-add "question")
(paw-add "link")
(paw-add "bookmark")
(defun paw-follow-link ()
(interactive)
(let* ((entry (get-char-property (point) 'paw-entry))
(note-type (alist-get 'note_type entry))
(content (alist-get 'content entry)))
(pcase (car note-type)
('link
(let* ((json (condition-case nil
(let ((output (json-read-from-string content)))
(if (and (not (eq output nil))
(not (arrayp output))
(not (numberp output)))
output
nil))
(error nil)))
(type (or (alist-get 'type json) ""))
(link (or (alist-get 'link json) "")))
(pcase type
("file"
(if (file-exists-p link)
(find-file link)))
("url"
(browse-url link))
("annotation"
(paw-find-origin
(cl-find-if (lambda (x) (equal link (alist-get 'word x))) paw-search-entries)))))))))
;;;###autoload
(defun paw-add-attachment (&optional word)
"Add an attachment."
(interactive)
(let ((word (or word "ATTACHMENT"))
(location (pcase major-mode
('nov-mode
(cons nov-documents-index (point)))
('pdf-view-mode
(require 'org-noter)
(org-noter--doc-approx-location
(org-noter--conv-page-scroll-percentage
(+ (window-vscroll)
(cdr (posn-col-row (event-start (read-event "Click the location"))))))))
('eaf-mode
(string-to-number (eaf-call-sync "execute_function" eaf--buffer-id "current_page")))
(_ (point))))
(type (assoc 'attachment paw-note-type-alist)))
(paw-add-general word type location)))
;;;###autoload
(defun paw-add-image (&optional word)
"Add an image."
(interactive)
(let ((word (or word "IMAGE"))
(location (pcase major-mode
('nov-mode
(cons nov-documents-index (point)))
('pdf-view-mode
(require 'org-noter)
(org-noter--doc-approx-location
(org-noter--conv-page-scroll-percentage
(+ (window-vscroll)
(cdr (posn-col-row (event-start (read-event "Click the location"))))))))
('eaf-mode
(string-to-number (eaf-call-sync "execute_function" eaf--buffer-id "current_page")))
(_ (point))))
(type (assoc 'image paw-note-type-alist)))
(paw-add-general word type location)))
(defun paw-show-all-annotations (&optional candidates)
"when candidates, just check and show the candidates overlays, this is much faster"
(interactive)
(if (or candidates paw-annotation-mode)
(if (eq major-mode 'eaf-mode)
(eaf-call-async "execute_function_with_args" eaf--buffer-id "paw_annotation_mode" `,paw-db-file)
(let ((candidates (if candidates candidates (paw-candidates-by-origin-path-serverp) )))
(save-excursion
(cl-loop for entry in candidates do
(pcase (car (alist-get 'note_type entry))
('attachment)
('bookmark)
('image)
(_ (paw-add-annotation-overlay entry)))))) )))
(defun paw-get-highlight-type ()
(interactive)
(let ((choice (read-char-from-minibuffer
(format "Annotation Type: %s %s %s %s (o)ther (q)uit "
(propertize "highlight-(1)" 'face 'paw-highlight-1-face)
(propertize "highlight-(2)" 'face 'paw-highlight-2-face)
(propertize "highlight-(3)" 'face 'paw-highlight-3-face)
(propertize "highlight-(4)" 'face 'paw-highlight-4-face)) '(?1 ?2 ?3 ?4 ?o ?q))))
(unless (eq choice ?q)
(let* ((c (char-to-string choice))
(uppercasep (and (stringp c) (string-equal c (upcase c)) ))
(cc (downcase c)))
(cond
((string-equal cc "1") (message "") (assoc 'highlight-1 paw-note-type-alist))
((string-equal cc "2") (message "") (assoc 'highlight-2 paw-note-type-alist))
((string-equal cc "3") (message "") (assoc 'highlight-3 paw-note-type-alist))
((string-equal cc "4") (message "") (assoc 'highlight-4 paw-note-type-alist))
((string-equal cc "o")
(message "")
(cons 'highlight (let* ((names (mapcar #'symbol-name (face-list)))
(counsel--faces-format
(format "%%-%ds %%s"
(apply #'max 0 (mapcar #'string-width names)))))
(intern (ivy-read "Face: " names
:require-match t
:history 'face-name-history
:preselect (counsel--face-at-point)
:caller 'counsel-faces)))))
((string-equal cc "q") (message "") (error "quit"))
(t (message "") (assoc 'highlight-1 paw-note-type-alist)))))))
(defun paw-get-todo-type ()
(interactive)
(let ((choice (read-char-from-minibuffer
(format "TODO Type: %s %s %s (q)uit "
(propertize "(t/T)ODO" 'face 'paw-todo-face)
(propertize "(d/D)ONE" 'face 'paw-done-face)
(propertize "(c/C)ANCEL" 'face 'paw-cancel-face)) '(?t ?T ?d ?D ?c ?C ?q))))
(unless (eq choice ?q)
(let* ((c (char-to-string choice))
(uppercasep (and (stringp c) (string-equal c (upcase c)) ))
(cc (downcase c)))
(cond
((string-equal cc "t") (message "") (assoc 'todo paw-note-type-alist))
((string-equal cc "d") (message "") (assoc 'done paw-note-type-alist))
((string-equal cc "c") (message "") (assoc 'cancel paw-note-type-alist))
((string-equal cc "q") (message "") (error "quit"))
(t (message "") (assoc 'todo paw-note-type-alist)))))))
(defun paw-add-annotation-overlay (entry &optional type)
(let* ((location (alist-get 'origin_point entry))
(note (alist-get 'note entry))
(word (alist-get 'word entry))
(serverp (alist-get 'serverp entry))
(real-word (paw-get-real-word word))
(note-type (if type
(pcase (car (alist-get 'note_type entry))
('word
(let ((wd (read-from-minibuffer "Insert the annotation symbol: ")))
;; update note type
(paw-update-note_type word `(word . ,wd))
;; delete overlay
(delete-overlay
(cl-find-if
(lambda (o)
(equal (alist-get 'word (overlay-get o 'paw-entry)) word))
(overlays-at (point))))
(cons 'word wd)))
('question
(let ((wd (read-from-minibuffer "Insert the question symbol: ")))
;; update note type
(paw-update-note_type word `(question . ,wd))
;; delete overlay
(delete-overlay
(cl-find-if
(lambda (o)
(equal (alist-get 'word (overlay-get o 'paw-entry)) word))
(overlays-at (point))))
(cons 'question wd)))
((or 'todo 'done 'cancel)
(let ((td (paw-get-todo-type)))
;; update note type
(paw-update-note_type word td)
;; delete overlay
(delete-overlay
(cl-find-if
(lambda (o)
(equal (alist-get 'word (overlay-get o 'paw-entry)) word))
(overlays-at (point))))
td))
('stamp
(let ((td (paw-get-stamp)))
;; update note type
(paw-update-note_type word td)
;; delete overlay
(delete-overlay
(cl-find-if
(lambda (o)
(equal (alist-get 'word (overlay-get o 'paw-entry)) word))
(overlays-at (point))))
td))
(_
(let ((tp (setq paw-annotation-current-highlight-type (paw-get-highlight-type))))
;; update note type
(paw-update-note_type word tp)
;; delete overlay
(delete-overlay
(cl-find-if
(lambda (o)
(equal (alist-get 'word (overlay-get o 'paw-entry)) word))
(overlays-at (point))))
tp)))
(alist-get 'note_type entry)))
beg end)
;; if `type' is provided, the entry should be updated
;; here, we update the note-type back to entry
(if type
(setf (alist-get 'note_type entry) note-type))
(unless (eq major-mode 'pdf-view-mode)
;; get the location, beg, and end based on modes
(setq location
(pcase major-mode
('nov-mode
(cond ((stringp location) nil) ;; it is an online word
((consp (cdr location)) ;; it is a highlight
(if (eq nov-documents-index (car location))
(progn
(setq beg (cadr location))
(setq end (cddr location))
(cdr location))
nil))
((consp location) ;; it is an offline word
(if (eq nov-documents-index (car location))
(cdr location)
"unmatch-index"))
(t nil)))
(_
(cond ((consp location)
(setq beg (car location))
(setq end (cdr location))
location)
((numberp location) location)
(t nil)))))
;; add overlay to location
(cond ((numberp location)
;; if has location, that means it is local word, hightlight one occurrence in that location
(goto-char location)
;; serch and verify the word
(if (string-match-p (regexp-quote (or (thing-at-point 'word t) "")) real-word)
(progn
(forward-thing 'word 1)
(setq end (point))
(forward-thing 'word -1)
(setq beg (point)))
;; first search -50 ~ 50
(goto-char (- location 50))
(cond ((re-search-forward (regexp-quote real-word) (+ location 50) t)
(setq beg (match-beginning 0))
(setq end (match-end 0)))
(t
;; second search (point-min) (point-max)
(goto-char (point-min))
(when (re-search-forward (concat "\\b" real-word "\\b") (point-max) t)
(setq beg (match-beginning 0))
(setq end (match-end 0))))))
(if (and beg end)
(unless (cl-find-if
(lambda (o)
(equal (alist-get 'word (overlay-get o 'paw-entry)) word))
(overlays-in (point-min) (point-max)))
(paw-add-overlay beg end note-type note entry))
(message "Can not find word \"%s\", maybe the location is changed." real-word)))
;; if it is offline word, major-mode is nov-mode, and no location is
;; found, just skip it.
((and (stringp location) (string= "unmatch-index" location) ) nil)
;; if serverp is 1, that means it is an online word, hightlight all occurrences in the buffer
;; if location is nil, that means it is not in current buffer, hightlight all occurrences in the buffer
((or (paw-online-p serverp) (eq location nil))
(goto-char (point-min))
(let ((case-fold-search t)
(cur-loc)
(last-loc)) ; or nil for case-sensitive
(while (if (string-match-p "[[:ascii:]]+" real-word)
;; english
(progn
(setq cur-loc (re-search-forward (concat "\\b" real-word "\\b") nil t))
(if (eq cur-loc last-loc)
nil ;; if always the same, quit the while to avoid forever loop
(setq last-loc cur-loc)))
;; non-english
(setq cur-loc (re-search-forward real-word nil t))
(if (eq cur-loc last-loc)
nil ;; if always the same, quit the while to avoid forever loop
(setq last-loc cur-loc)))
(let* ((beg (match-beginning 0))
(end (match-end 0))
(existing-overlays (overlays-in beg end)))
(unless (cl-find-if
(lambda (o)
(equal (alist-get 'word (overlay-get o 'paw-entry)) word))
existing-overlays)
(paw-add-overlay beg end note-type note entry))))))
(t
;; TODO the match is not robust
;; first check string between beg and end
(if (string-match-p (regexp-quote (s-trim (s-collapse-whitespace (buffer-substring-no-properties beg end)) ) ) (s-trim (s-collapse-whitespace real-word) ))
(unless (cl-find-if
(lambda (o)
(equal (alist-get 'word (overlay-get o 'paw-entry)) word))
(overlays-in (point-min) (point-max)))
(paw-add-overlay beg end note-type note entry))
;; find the beg and end
;; first search -500 ~ 500
;; TODO the buffer search is not robust
(goto-char (- beg 500))
(if (re-search-forward (regexp-quote real-word) (+ end 500) t)
(progn
(setq beg (match-beginning 0))
(setq end (match-end 0)))
(goto-char (point-min))
;; second search 0 (point-max)
(if (re-search-forward (regexp-quote real-word) (point-max) t)
(progn
(setq beg (match-beginning 0))
(setq end (match-end 0)))
;; (message "Location of \"%s\"is incorrect."
;; (s-truncate 40 (s-collapse-whitespace real-word)))
))
(goto-char beg)
;; add overlay even if it can not be found
(unless (cl-find-if
(lambda (o)
(equal (alist-get 'word (overlay-get o 'paw-entry)) word))
(overlays-at (point)))
(paw-add-overlay beg end note-type note entry))))))))
(defun paw-previous-annotation ()
"Go to the previous annotation, if run it in *paw-view-note* buffer,
it will go to the previous annotation and view it."
(interactive)
(cond ((eq major-mode 'paw-search-mode)
(progn
(paw-previous)
(paw-find-origin)))
((bound-and-true-p focus-mode)
(paw-focus-find-prev-thing-segment))
((eq major-mode 'paw-view-note-mode)
(if (buffer-live-p paw-note-target-buffer)
(let ((window (get-buffer-window paw-note-target-buffer)))
(if (window-live-p window)
(progn
(with-selected-window (select-window window)
(call-interactively 'paw-previous-annotation))
(recenter)
(call-interactively 'paw-view-note) )
(switch-to-buffer-other-window paw-note-target-buffer)
(call-interactively 'paw-previous-annotation)
(recenter)
(call-interactively 'paw-view-note)))
(message "The original buffer is already closed.")))
(t (let* ((previous-overlays (reverse (-filter
(lambda (o)
(overlay-get o 'paw-entry))
(overlays-in (point-min) (point))) ))
(overlay (car previous-overlays))
(beg (if overlay (overlay-start overlay)))
(end (if overlay (overlay-end overlay)))
(next-overlay (nth 1 previous-overlays))
(next-beg (if next-overlay (overlay-start next-overlay)))
(next-end (if next-overlay (overlay-end next-overlay))))
(cond
((and (equal beg (point)) next-beg)
(goto-char next-beg))
((not next-beg)
(if overlay (goto-char beg))
(message "This is the first annotation."))
(overlay (goto-char beg)))) )))
(defun paw-next-annotation ()
"Go to the next annotation, if run it in *paw-view-note* buffer,
it will go to the next annotation and view it."
(interactive)
(cond ((eq major-mode 'paw-search-mode)
(progn
(paw-next)
(paw-find-origin)) )
((bound-and-true-p focus-mode)
(paw-focus-find-next-thing-segment))
((eq major-mode 'paw-view-note-mode)
(if (buffer-live-p paw-note-target-buffer)
(let ((window (get-buffer-window paw-note-target-buffer)))
(if (window-live-p window)
(progn
(with-selected-window (select-window window)
(call-interactively 'paw-next-annotation))
(recenter)
(call-interactively 'paw-view-note))
(switch-to-buffer-other-window paw-note-target-buffer)
(call-interactively 'paw-next-annotation)
(recenter)
(call-interactively 'paw-view-note)))
(message "The original buffer is already closed.")))
(t (let* ((overlay (cl-find-if
(lambda (o)
(overlay-get o 'paw-entry))
(overlays-in (point) (point-max))))
(beg (if overlay (overlay-start overlay)))
(end (if overlay (overlay-end overlay)))
(next-overlay (cl-find-if
(lambda (o)
(overlay-get o 'paw-entry))
(overlays-in end (point-max))))
(next-beg (if next-overlay (overlay-start next-overlay)))
(next-end (if next-overlay (overlay-end next-overlay))))
(cond
((and (equal beg (point)) next-beg)
(goto-char next-beg))
((not next-beg)
(if overlay (goto-char beg))
(message "This is the last annotation."))
(overlay (goto-char beg)))) )))
(defun paw-copy-annotation ()
(interactive)
(let ((entry (get-char-property (point) 'paw-entry)))
(if entry
(let ((word (or (paw-get-real-word entry) "")))
(kill-new word)
(message "Copied \"%s\"" word)))))
(defun paw-delete-annotation (&optional entry)
(interactive)
(paw-delete-word (or entry (get-char-property (point) 'paw-entry))))
(defun paw-clear-annotation-overlay (&optional overlays)
"Clear overlays or all paw-entry overlays in the buffer."
(interactive)
(with-current-buffer (current-buffer)
(let ((ovs (if overlays overlays (paw-get-all-overlays))))
(dolist (ov ovs)
(delete-overlay ov)))))
(defun paw-get-all-overlays()
(-filter
(lambda (o)
(overlay-get o 'paw-entry))
(overlays-in (point-min) (point-max))))
(defvar paw-get-note-during-paw-view-notes nil)
(defvar paw-get-note-limit-during-paw-view-notes 200
"The limit of getting note during paw-view-notes for unknown
words. If more than it, it will not get note. If the buffer has
too many unknown words, the process of getting note for each word
will be very slow, make a resonable limit is a workaround.
Only when the note is empty, it will get note for unknown words.
That means if the note is not empty (already set by last time),
it will not get note for unknown words.
100 words ~ 1 second on my laptop.
For example, if a buffer has 200 words. The first time we run
`paw-view-notes', the notes of first 100 words will be updated.
The second time we run `paw-view-notes', the notes of last 100
words will be updated.")
(defun paw-get-all-entries-from-overlays()
(let ((overlays (overlays-in (point-min) (point-max)))
(counter 0))
(cl-remove-duplicates
(mapcar
(lambda (o)
(let ((entry (overlay-get o 'paw-entry)))
(if (and entry paw-get-note-during-paw-view-notes)
;; only unknown words
(when (eq (alist-get 'serverp entry) 3)
;; if note is not empty, that means it already had note
(when (string= (alist-get 'note entry) "")
(setq counter (1+ counter))
(when (<= counter paw-get-note-limit-during-paw-view-notes)
;; (message "%s \n" counter)
(setf (alist-get 'note entry)
(save-excursion
(goto-char (overlay-start o))
(paw-get-note)))
(setf (alist-get 'origin_point entry) (overlay-end o))
))))
entry))
overlays))))
(defun paw-list-default-action (x)
(let* ((entry (get-text-property 0 'paw-entry x))
(word (paw-get-real-word entry))
(origin-point (alist-get 'origin_point entry))
(note-type (alist-get 'note_type entry))
(old-origin-path (alist-get 'origin_path entry))
(new-origin-path (paw-get-origin-path)))
(if entry
(pcase (car note-type)
('attachment (paw-find-note entry))
('image (paw-find-note entry))
;; if same path, we just need to call `paw-goto-location'
(_ (if (equal old-origin-path new-origin-path)
(paw-goto-location origin-point word)
(paw-find-origin entry))))
(paw-add-attachment x))))
(defun paw-list-delete-action (x)
(let* ((entry (get-text-property 0 'paw-entry x)))
(if entry
(paw-delete-annotation entry))))
;;;###autoload
(defun paw-list-annotations (whole-file)
(interactive "P")
(consult--read (paw-candidates-format nil whole-file t t)
:prompt "Annotations: "
:sort nil
:history nil
:lookup (lambda(cand candidates input-string _)
(let* ((entry (get-text-property 0 'paw-entry (cl-find-if
(lambda (input)
(string= input cand)) candidates) ))
(word (paw-get-real-word entry))
(origin-point (alist-get 'origin_point entry))
(note-type (alist-get 'note_type entry))
(old-origin-path (alist-get 'origin_path entry))
(new-origin-path (paw-get-origin-path))
(note-type (car (alist-get 'note_type entry))))
(pcase note-type
('bookmark (if (equal old-origin-path new-origin-path)
(paw-goto-location origin-point word)
(paw-find-origin entry)))
(_ (paw-find-note entry)))))))
;;;###autoload
(defun paw-list-all-annotations ()
(interactive)
(consult--read (paw-candidates-format t)
:prompt "All Annotations: "
:sort nil
:history nil
:lookup (lambda(cand candidates input-string _)
(paw-list-default-action
(cl-find-if
(lambda (input)
(string= input cand)) candidates)))))
(defvar paw-annotation-links-source
(list
:name "Annotation Links"