-
-
Notifications
You must be signed in to change notification settings - Fork 8
/
gkroam.el
2088 lines (1883 loc) · 81.1 KB
/
gkroam.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
;;; gkroam.el --- A lightweight org-mode Roam Research replica -*- lexical-binding: t; -*-
;; Copyright (C) 2020 Kinney Zhang
;;
;; Version: 2.4.3
;; Keywords: org, convenience
;; Author: Kinney Zhang <kinneyzhang666@gmail.com>
;; URL: https://github.com/Kinneyzhang/gkroam
;; Package-Requires: ((emacs "26.3") (db "0.0.6") (company "0.9.10"))
;; This file is not part of GNU Emacs.
;; 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, 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, write to the Free Software
;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
;;; Commentary:
;; Gkroam is a lightweight Roam Research repica, built on top of Org-mode.
;;; ChangeLog:
;; v1.0 - Auto update link references at the buttom of page buffer.
;; v2.0 - Use overlay to hide and show gkroam brackets accordingly
;; and fix some bugs.
;; v2.0.1 - Fix 'hide and show brackets' problems in some main occasion.
;; Such as newline, etc.
;; v2.0.2 - Fix 'gkroam-publish-current-file' and 'gkroam-preview-current',
;; automatically convert gkroam link to org link and convert it back after
;; published (use 'undo', not reliable). But it has problem with publishing
;; the whole project.
;; v2.0.3 - Fix 'gkroam-publish-site' and 'gkroam-preview'.
;; Now you can publish and preview the whole roam site.
;; v2.0.4 - Many bugs fixed and code improvement.
;; v2.1.0 - A more powerful linked references system.
;; v2.1.1 - Change package name to 'gkroam' from 'gk-roam'.
;; v2.2.0 - Edit many pages in one side window and save changes separately.
;; v2.2.1 - Many bug fixed and misc code optimization.
;; v2.3.0 - Implement headline references, add a new minor mode
;; 'gkroam-dynamic-brackets-mode' and rename 'gkroam-edit' to `gkroam-capture'.
;; v2.3.1 - A more resonable way to insert link.
;; Press "C-p RET" or "C-M-j" to skip headline completion for ivy user
;; or just press "RET" for vanilla user.
;; v2.3.2 - Beautify page: unify org list bullet and beautify org checkbox.
;; Better to turn it off when editing the page.
;; v2.3.3 - Make page filename customizable, delete index file
;; and show index in buffer.
;; v2.3.4 - Delete 'gkroam-dynamic-brackets-mode'
;; and add `gkroam-toggle-dynamic' function.
;; v2.3.5 - Optimize gkroam page prettification, change 'gkroam-toggle-beautify'
;; to `gkroam-toggle-prettify' for precise semanteme.
;; v2.3.6 - Implement a perfect linked references workflow.
;; When a link is the item of org plain list, the whole list structure will be shown.
;; v2.3.7 - Add headline id only when you insert a gkroam link.
;; Use `gkroam-rebuild-caches' command to rebuild headline and id caches.
;; v2.4.0
;; 1. Delete =gkroam-toggle-dynamic= command
;; 2. Set gkroam-mode as a minor mode, instead of a major mode derived from org-mode
;; 3. Use text properties to render gkroam links.
;; 4. More caches and a big improvement in performance.
;; 4.1 Cache gkroam pages and their filenames.
;; 4.2 Cache gkroam pages and their references.
;; 5. Prettify and enhance linked references
;; 5.1 Change backlink format to "{{page::line-number}{alias}}"
;; 5.2 Show list item's parent items above it and shadow them.
;; 5.3 Highlight each reference region.
;; 5.4 Jump back to the specific line when click backlink.
;; v2.4.1
;; 1. Implement a roam research like index buffer.
;; 2. Add new command `gkroam-delete'.
;; 3. Rename 'gkroam-smart-new' to `gkroam-dwim'.
;; v2.4.2 - Implement 'unlinked references'.
;; Use command `gkroam-show-unlinked' to show pages' unlinked references in a side window.
;; Click link in unlinked references to link it to reference.
;; v2.4.3 - Change backlink format to org-link format and delete 'gkroam-capture'.
;;; Code:
(require 'cl-lib)
(require 'org)
(require 'org-id)
(require 'org-element)
(require 'db)
(require 'company)
(eval-when-compile
(require 'subr-x)
(require 'hl-line)
(require 'crm))
;;;; Declarations
(defvar org-link-frame-setup)
(defvar ivy-use-selectable-prompt)
;;;; Variables
(defgroup gkroam nil
"A roam replica on top of emacs org-mode."
:tag "gkroam"
:group 'org)
(defcustom gkroam-root-dir "~/gkroam/org/"
"Gkroam's root directory, with org files in it."
:type '(choice directory sexp)
:group 'gkroam)
(defcustom gkroam-cache-dir (concat user-emacs-directory "gkroam/")
"Gkroam's cache directory."
:type 'directory
:group 'gkroam)
(defcustom gkroam-index-title "GKROAM"
"Title of index page."
:type 'string
:group 'gkroam)
(defcustom gkroam-window-margin 2
"Gkroam window's left and right margin."
:type 'integer
:group 'gkroam)
(defcustom gkroam-use-default-filename nil
"Non-nil means use default filename for gkroam page.
The default format is '%Y%m%d%H%M%S' time string."
:type 'boolean
:group 'gkroam)
(defcustom gkroam-show-brackets-p nil
"Non-nil means to show brackets in page link."
:type 'boolean
:group 'gkroam)
(defcustom gkroam-title-height 300
"Height of gkroam page title when prettifying."
:type 'integer
:group 'gkroam)
(defvar gkroam-crm-separator "[ \t]*|[ \t]*"
"Default value of `crm-separator' in gkroam.")
(defvar gkroam-link-face 'font-lock-type-face
"Face for gkroam link.")
(defvar gkroam-headline-db
(db-make
`(db-hash
:filename ,(concat gkroam-cache-dir "gkroam-headline-db")))
"Database fot caching gkroam's headline and headline id.")
(defvar gkroam-page-db
(db-make
`(db-hash
:filename ,(concat gkroam-cache-dir "gkroam-page-db")))
"Database for caching gkroam page's filename.")
(defvar gkroam-linked-reference-db
(db-make
`(db-hash
:filename ,(concat gkroam-cache-dir "gkroam-linked-reference-db")))
"Database for caching gkroam page's linked references.")
(defvar gkroam-unlinked-reference-db
(db-make
`(db-hash
:filename ,(concat gkroam-cache-dir "gkroam-unlinked-reference-db")))
"Database for caching gkroam page's unlinked references.")
(defvar gkroam-org-list-re
"^ *\\([0-9]+[).]\\|[*+-]\\) \\(\\[[ X-]\\] \\)?"
"Org list bullet and checkbox regexp.")
(defvar gkroam-has-link-p nil
"Judge if has link or hashtag in gkroam buffer.")
(defvar gkroam-link-regexp
(rx (seq (group "{[")
(group (+? not-newline))
(group (?? (seq (group " » ")
(group (+? not-newline)))))
(group "]")
(group (?? (seq (group "[")
(group (+? not-newline))
(group "]"))))
(group "}")))
"Regular expression that matches a gkroam link.")
(defvar gkroam-hashtag-regexp
(rx (seq (group "#")
(group "{[")
(group (+? not-newline))
(group "]}")))
"Regular expression that matches a gkroam hashtag.")
(defvar gkroam-linked-reference-delimiter-re
"^* \\([0-9]+\\) Linked References to \"\\(.+?\\)\".*"
"Delimiter string regexp to separate page contents from references region.")
(defvar gkroam-unlinked-reference-delimiter-re
"^* \\([0-9]+\\) Unlinked References to \"\\(.+?\\)\".*"
"Delimiter string regexp to separate page contents from references region.")
(defvar gkroam-backlink-regexp
"\\[\\[file:\\(.+?\\)::[0-9]+\\]\\[.+?\\]\\]"
"Regular expression that matches a gkroam backlink.")
(defvar gkroam-prettify-page-p nil
"Non-nil means to prettify gkroam page.")
(defvar gkroam-return-wconf nil
"Current saved window configuration.")
(defvar gkroam-mentions-flag nil
"Non-nil means it's in process of gkroam mentions.")
(defvar gkroam-index-buf "*Gkroam Index*"
"Gkroam index buffer name.")
(defvar gkroam-capture-buf "*Gkroam Capture*"
"Gkroam capture buffer name.")
(defvar gkroam-linked-buf "*Gkroam Linked*"
"Gkroam linked references buffer name.")
(defvar gkroam-unlinked-buf "*Gkroam Unlinked*"
"Gkroam unlinked references buffer name.")
;;;; Functions
(defun gkroam-link-frame-setup (func)
"Alter `org-link-frame-setup' for gkroam.
Use FUNC function to open file link."
(setq org-link-frame-setup
`((vm . vm-visit-folder-other-frame)
(vm-imap . vm-visit-imap-folder-other-frame)
(gnus . org-gnus-no-new-news)
(file . ,func)
(wl . wl-other-frame))))
(defun gkroam-at-root-p ()
"Check if current file exists in `gkroam-root-dir'."
(when (buffer-file-name)
(file-equal-p (file-name-directory (buffer-file-name))
(expand-file-name gkroam-root-dir))))
(defun gkroam-at-index-buf ()
"Check if current buffer is `gkroam-index-buf'."
(string= (buffer-name) gkroam-index-buf))
(defun gkroam-at-capture-buf ()
"Check if current buffer is `gkroam-capture-buf'."
(string= (buffer-name) gkroam-capture-buf))
(defun gkroam-at-linked-buf ()
"Check if current buffer is `gkroam-linked-buf'."
(string= (buffer-name) gkroam-linked-buf))
(defun gkroam-at-unlinked-buf ()
"Check if current buffer is `gkroam-unlinked-buf'."
(string= (buffer-name) gkroam-unlinked-buf))
(defun gkroam-work-p ()
"Check if current file or buffer is where gkroam has to be in work."
(or (gkroam-at-root-p)
(gkroam-at-index-buf)
(gkroam-at-capture-buf)
(gkroam-at-linked-buf)
(gkroam-at-unlinked-buf)))
(defun gkroam-case-fold-string= (a b)
"Ignore case sensitive when compare A and B using `string='."
(eq t (compare-strings a nil nil b nil nil t)))
(defun gkroam-title-exist-p (title)
"Check if the case fold TITLE page exists in `gkroam-root-dir'.
Return the original title if TITLE does't equal to the original title.
Return non-nil if TITLE equals to the original title.
Return nil if TITLE doesn't exist in gkroam pages."
(let ((case-title (car (cl-member title (gkroam-retrive-all-titles)
:test #'gkroam-case-fold-string=))))
(when case-title
(when (string= title case-title)
(setq case-title t)))
case-title))
(defun gkroam-retrive-page (title)
"Retrive page's filename from database.
The page has a title named TITLE."
(gkroam-db-get gkroam-page-db title "page"))
(defun gkroam-retrive-title (page)
"Retrive page's title from database.
The page has a filename named PAGE."
(caar (db-query gkroam-page-db `(= "page" ,page))))
(defun gkroam-retrive-all-titles ()
"Retrive all gkroam pages' titles from database."
(mapcar #'car (db-query gkroam-page-db nil)))
(defun gkroam--get-file (page)
"Get gkroam file accroding to PAGE."
(expand-file-name page gkroam-root-dir))
(defun gkroam--gen-file ()
"Generate new gkroam file path."
(expand-file-name (gkroam--gen-page) gkroam-root-dir))
(defun gkroam--gen-page ()
"Generate new gkroam page filename, without directory prefix."
(let* (slug slug-format)
(if gkroam-use-default-filename
(setq slug-format (format-time-string "%Y%m%d%H%M%S"))
(setq slug (completing-read "Input filename or press \"RET\" to use the default: "
nil nil nil nil nil (format-time-string "%Y%m%d%H%M%S")))
(setq slug-format (string-join (split-string slug) "-")))
(format "%s.org" slug-format)))
(defun gkroam--format-backlink (page line-number alias)
"Format gkroam backlink for PAGE, refer to a link
in LINE-NUMBER line, display a description ALIAS."
(format "[[file:%s::%d][%s]]" page line-number alias))
(defun gkroam--narrow-to-content ()
"Narrow region to gkroam page contents if there is a reference region."
(save-excursion
(let ((content-beg (point-min)))
(goto-char (point-min))
(when (re-search-forward "\\(^ *#+.+:.+\n+\\)+" nil t)
(setq content-beg (point)))
(when (re-search-forward gkroam-linked-reference-delimiter-re nil t)
(unless (> (point-min) (1- (line-beginning-position)))
(narrow-to-region content-beg (1- (line-beginning-position))))))))
(defun gkroam--narrow-to-reference ()
"Narrow region to page references if there is a reference region."
(save-excursion
(goto-char (point-min))
(when (re-search-forward gkroam-linked-reference-delimiter-re nil t)
(narrow-to-region (line-beginning-position) (point-max)))))
(defun gkroam-new (title)
"Just create a new gkroam page titled with TITLE."
(let ((file (gkroam--gen-file)))
(with-current-buffer (find-file-noselect file t)
(insert (format "#+TITLE: %s\n\n" title))
(save-buffer))
(gkroam-cache-curr-page title)
file))
;; ----------------------------------------
;;;;; linked references
(defvar gkroam-link-re-format "{\\[%s.*?\\]}"
"Gkroam link regexp format used for searching link context.")
(defun gkroam-start-process (buf-name args)
"Start a rg process with output buffer named BUF-NAME.
ARGS are the arguments of rg process."
(let ((name (generate-new-buffer-name buf-name)))
(apply #'start-process `(,name ,name "rg" ,@args
,(expand-file-name gkroam-root-dir)))))
(defun gkroam-search-process (process callback)
"Call CALLBACK After the PROCESS finished."
(unless (executable-find "rg")
(user-error "Cannot find program 'ripgrep'"))
(let ((sentinel
(lambda (process event)
(if (string-match-p (rx (or "finished" "exited"))
event)
(if-let ((buf (process-buffer process)))
(with-current-buffer buf
(save-excursion
(funcall callback (buffer-string))))
(error "Gkroam’s rg process’ buffer is killed"))
(error "Gkroam’s rg process failed with signal: %s"
event)))))
(set-process-sentinel process sentinel)))
(defun gkroam--process-linked-backlink (string page line-number)
"Convert gkroam link to backlink in STRING.
The backlink refers to a link in LINE-NUMBER line of PAGE."
(with-temp-buffer
(insert string)
;; (goto-char (point-min))
;; (while (re-search-forward gkroam-hashtag-regexp nil t)
;; (replace-match (gkroam--format-backlink
;; page line-number
;; (concat "#" (match-string-no-properties 3)))))
(goto-char (point-min))
(while (re-search-forward gkroam-link-regexp nil t)
(let* ((title (match-string-no-properties 2))
(alias (match-string-no-properties 9))
(headline (match-string-no-properties 5)))
(if alias
(replace-match (gkroam--format-backlink page line-number alias))
(if headline
(replace-match (gkroam--format-backlink page line-number headline))
(replace-match (gkroam--format-backlink page line-number title))))))
(buffer-string)))
(defun gkroam--format-linked-reference-content ()
"Format the content of linked reference."
(save-excursion
(goto-char (line-beginning-position))
(let* ((blank-num (skip-chars-forward "[ ]"))
(elem (org-element-at-point))
(level-1-blank-num (cadr (car (org-element-property :structure elem))))
(elem-type (org-element-type elem))
(elem-start (org-element-property :begin elem))
(elem-end (org-element-property :end elem))
(elem-str (buffer-substring-no-properties elem-start elem-end))
reference-str)
(pcase elem-type
('item
(let* ((parent-strs "")
(relative-level 0)
parent parent-beg parent-str)
(catch 'break
(while (point)
(if (= blank-num level-1-blank-num)
(throw 'break nil)
(setq parent (org-element-property :parent (org-element-at-point)))
(setq parent-beg (org-element-property :begin parent))
(setq blank-num
(progn
(goto-char parent-beg)
(forward-line -1)
(skip-chars-forward "[ ]")))
(save-excursion
(goto-char (line-beginning-position))
(re-search-forward gkroam-org-list-re (line-end-position) t)
(cl-incf relative-level)
(setq parent-str
(buffer-substring-no-properties (point)
(line-end-position))))
(when (= relative-level 1)
(setq parent-strs (concat parent-str "\n" parent-strs)))
(when (> relative-level 1)
(setq parent-strs (concat parent-str " > " parent-strs))))))
(setq reference-str (concat parent-strs elem-str))))
('plain-list
(let* ((plain-lst (org-element-property :structure (org-element-at-point)))
(item (car plain-lst)))
(setq elem-start (car item))
(setq elem-end (car (last item)))
(setq reference-str (buffer-substring-no-properties elem-start elem-end))))
(_ (setq reference-str elem-str)))
reference-str)))
(defvar gkroam-file-path-re
(concat "^" (expand-file-name gkroam-root-dir) ".+\\.org")
"Regular expression to match gkroam file path.")
(defun gkroam--get-rg-output-region ()
"Split rg output to different regions according to different pages.
Each region is a list consist of '(beg-postion end-position page-name)'.
Return a list of all region lists."
(let ((beg (point-min))
(end (point))
page region-lst)
(save-excursion
(while (not (= end (point-max)))
(goto-char beg)
(save-excursion
(when (re-search-forward gkroam-file-path-re nil t)
(setq page (file-name-nondirectory
(match-string-no-properties 0)))
(setq beg (1+ (point)))))
(if (re-search-forward gkroam-file-path-re nil t 2)
(setq end (line-beginning-position))
(setq end (point-max)))
(push `(,beg ,end ,page) region-lst)
(setq beg end)))
(reverse region-lst)))
(defun gkroam--process-searched-string (type string title)
"Process the TYPE type of searched STRING by 'rg',
get the whole contents of TITLE page.
If type is 'linked', it means to process linked references.
If type is 'unlinked', it means to process unlinked references."
(if (string-empty-p string)
(cons 0 "")
(with-temp-buffer
(insert string)
(goto-char (point-min))
(let ((region-lst (gkroam--get-rg-output-region))
(num 0) references)
(dolist (region region-lst)
(let ((beg (nth 0 region))
(end (nth 1 region))
(page (nth 2 region))
(regexp-format
(pcase type
('linked gkroam-link-re-format)
('unlinked "%s")))
(context nil))
(goto-char beg)
(save-restriction
(let (bound-end
(last-headline "")
(last-content ""))
(narrow-to-region beg end)
;; 'narrow in narrow' does not succeed.
(goto-char (point-min))
(re-search-forward "\\(^ *#+.+:.+\n+\\)+" nil t)
(save-excursion
(if (re-search-forward gkroam-linked-reference-delimiter-re nil t)
(setq bound-end (match-beginning 0))
(setq bound-end (point-max))))
(while (re-search-forward
(format regexp-format (regexp-quote title))
bound-end t)
(let* ((headline "")
(line-number (line-number-at-pos))
(raw-content
(pcase type
('linked (string-trim
(gkroam--format-linked-reference-content)
nil "[ \t\n\r]+"))
('unlinked
(when-let
((unlinked-content
(gkroam--format-unlinked-reference-content)))
(string-trim unlinked-content nil "[ \t\n\r]+")))))
(content
(pcase type
('linked (gkroam--process-linked-backlink
raw-content page line-number))
('unlinked
(when raw-content
(gkroam--process-unlinked-title
title raw-content line-number))))))
(when content
(save-excursion
(when (re-search-backward "^*+ .+\n" nil t)
(setq headline
(string-trim (match-string-no-properties 0) "*+ +" nil))
(setq headline (concat "*** " headline))))
(if (string= headline last-headline)
(pcase type
('linked
(setq num (1+ num))
(setq context (concat context content "\n\n")))
('unlinked
(unless (string= last-content content)
(setq num (1+ num))
(setq context (concat context content "\n\n")))))
(setq num (1+ num))
(setq context (concat context headline "\n" content "\n\n"))
(setq last-headline headline))
;; always set current content to last-content
;; regardless of headline equal or not.
(setq last-content content))))))
(when context
(setq references
(concat references
(format "** %s\n\n%s"
(gkroam--format-backlink
page 1 (gkroam-retrive-title page))
context))))))
(if references
(setq references
(with-temp-buffer
(insert (string-trim references))
(org-mode)
(indent-region (point-min) (point-max))
(buffer-string)))
(setq references ""))
(cons num references)))))
(defun gkroam-search-page-link (title)
"Return a rg process to search a specific TITLE page's link.
Output matched files' path and context."
(gkroam-start-process " *gkroam-rg*"
`(,(format "\\{\\[%s( ».*)?\\](\\[.+?\\])?\\}"
title)
;; Write a funciton to generate rg regexp
;; format for title!
"--ignore-case" "--sortr" "path"
"-C" ,(number-to-string 9999)
"-N" "--heading"
"-g" "!index.org*")))
(defun gkroam-update-linked-references (title)
"Update gkroam TITLE page's linked reference."
(gkroam-search-process
(gkroam-search-page-link title)
(lambda (string)
(let* ((page (gkroam-retrive-page title))
(file (gkroam--get-file page))
(file-buf (find-file-noselect file t))
(processed-str (gkroam--process-searched-string
'linked string title))
(num (number-to-string (car processed-str)))
(references (cdr processed-str))
(reference-db gkroam-linked-reference-db)
(cached-references (cdar (db-get title reference-db)))
(delimiter-re gkroam-linked-reference-delimiter-re)
(delimiter-format "* %s Linked References to \"%s\"\n\n")
reference-start curr-references reference-content-start)
(unless (string= references cached-references)
(db-put title `(("reference" . ,references)) reference-db)
(setq cached-references (cdar (db-get title reference-db))))
;; compare searched references string with cached references string.
;; If not equal, cache searched one.
(with-current-buffer file-buf
(save-excursion
(goto-char (point-max))
(re-search-backward delimiter-re nil t)
(setq reference-start (point))
(forward-line 2)
(setq reference-content-start (point))
(setq curr-references
(string-trim (buffer-substring-no-properties
reference-content-start (point-max))))
;; Unindent current page's rerferences string and compare with
;; the cached ones. If they are different,
;; update current page's references.
(unless (string= curr-references cached-references)
(let ((inhibit-read-only t))
(remove-text-properties reference-start (point-max) '(read-only nil)))
(delete-region reference-start (point-max))
(unless (string-empty-p string)
(insert (format delimiter-format num title))
(insert references)
;; use overlay to hide part of reference. (filter)
;; (gkroam-overlay-region beg (point-max) 'invisible t)
(indent-region reference-content-start (point-max))
(save-buffer)
(gkroam-db-update gkroam-page-db title "mention" num)
(message "%s reference updated" page)))
(gkroam-list-parent-item-overlay reference-start)
(gkroam-reference-region-overlay reference-start)
(when gkroam-prettify-page-p
(gkroam-org-list-fontify reference-start (point-max)))
(unless (get-text-property reference-start 'read-only)
(put-text-property reference-start (point-max)
'read-only "References region is uneditable."))))))))
;;;;; unlinked references
(defvar gkroam-unlinked-regexp
"{{\\([0-9]+\\)::\\(.+?\\)}}"
"Regular expression that matches unlinked links.")
(define-button-type 'gkroam-unlinked-link
'action #'gkroam-follow-unlinked-link
'face '(:underline t)
'line-number nil
'title nil
'follow-link t
'help-echo "Link it to reference")
(defun gkroam-follow-unlinked-link (button)
"Link the unlinked title to reference after push BUTTON."
(with-demoted-errors "Error when following the link: %s"
(let ((line-number (string-to-number
(button-get button 'line-number)))
(title (button-get button 'title)))
(gkroam-link-unlinked title line-number))))
(defun gkroam-unlinked-title-fontify (beg end)
"Highlight gkroam backlink between BEG and END."
(save-excursion
(goto-char beg)
(while (re-search-forward gkroam-unlinked-regexp end t)
(let ((line-number (match-string-no-properties 1))
(title (match-string-no-properties 2)))
(with-silent-modifications
(add-text-properties (match-beginning 0) (match-beginning 2)
'(display ""))
(add-text-properties (match-end 2) (match-end 0)
'(display ""))
(make-text-button (match-beginning 2)
(match-end 2)
:type 'gkroam-unlinked-link
'line-number line-number
'title title))))))
(defun gkroam--format-unlinked-title (line-number title)
"Format the unlinked title with LINE-NUMBER and TITLE."
(format "{{%d::%s}}" line-number title))
(defun gkroam--process-unlinked-title (title string line-number)
"Highlight unlinked TITLE in STRING,
include the original LINE-NUMBER in text property."
(with-temp-buffer
(insert string)
(goto-char (point-min))
(while (re-search-forward (regexp-quote title) nil t)
(when (gkroam--unlinked-title-valid-p)
(replace-match (gkroam--format-unlinked-title line-number title))))
(buffer-string)))
(defun gkroam--between-org-link-p ()
"Check if current point is between a org link."
(let (beg end)
(and (save-excursion
(setq beg (re-search-backward "\\[\\[" (line-beginning-position) t)))
(not (save-excursion
(re-search-backward "\\]\\]" beg t)))
(save-excursion
(setq end (re-search-forward "\\]\\]" (line-end-position) t)))
(not (save-excursion
(re-search-forward "\\[\\[" end t))))))
(defun gkroam--between-gkroam-link-p ()
"Check if current point is between a gkroam link."
(let (beg end)
(save-excursion
(and (save-excursion
(setq beg (re-search-backward "{\\[" (line-beginning-position) t)))
(not (save-excursion
(re-search-backward "\\]]" beg t)))
(save-excursion
(setq end (re-search-forward "\\]}" (line-end-position) t)))
(not (save-excursion
(re-search-forward "{\\[" end t)))))))
(defun gkroam--unlinked-title-valid-p ()
"Judge if current macth is a valid unlinked title after searching.
The following conditions should be excluded:
1. title is in a org headline.
2. title is a substring of words or phrase. (Chinese excluded)
3. title is in a gkroam link, hashtag or org link."
(save-excursion
(let* ((title (match-string-no-properties 0))
(is-ascii (equal (find-charset-string title)
'(ascii)))
valid-p)
(pcase title
;; case 1
((guard (save-excursion
(goto-char (line-beginning-position))
(looking-at "^*+ .+")))
(setq valid-p nil))
;; case 2
((and (guard is-ascii)
(guard (or (not (string= (thing-at-point 'word t) title))
(when (char-after (match-end 0))
(or (string= "-" (string (char-after (match-end 0))))
(string= "_" (string (char-after (match-end 0))))))
(when (< (+ 2 (match-end 0)) (point-max))
(string= "}}" (buffer-substring-no-properties
(match-end 0) (+ 2 (match-end 0))))))))
(setq valid-p nil))
;; case 3
((guard (or (gkroam--between-org-link-p)
(gkroam--between-gkroam-link-p)))
(setq valid-p nil))
(_ (setq valid-p t)))
valid-p)))
(defun gkroam--format-unlinked-reference-content ()
"Format the content of unlinked reference."
(when (gkroam--unlinked-title-valid-p)
(buffer-substring-no-properties (line-beginning-position)
(line-end-position))))
(defun gkroam-search-page-title (title)
"Return a rg process to search a specific PAGE's title.
Output the context including the TITLE."
(gkroam-start-process " *gkroam-unlinked-references*"
`(,title
;; Write a funciton to generate rg regexp
;; format for title!
"--ignore-case" "--sortr" "path"
"-C" ,(number-to-string 9999)
"-N" "--heading"
"-g" ,(format
"!%s"
(gkroam-retrive-page title)))))
(defun gkroam-set-unlinked-references (title)
"Set unlinked references of TITLE gkroam page to `gkroam-unlinked-buf'."
(gkroam-search-process
(gkroam-search-page-title title)
(lambda (string)
(let* ((buf (get-buffer-create gkroam-unlinked-buf))
(processed-str (gkroam--process-searched-string
'unlinked string title))
(num (number-to-string (car processed-str)))
(references (cdr processed-str))
(reference-db gkroam-unlinked-reference-db)
(cached-references (cdar (db-get title reference-db)))
(reference-title "* %s unlinked references to \"%s\"\n\n"))
(unless (string= references cached-references)
(db-put title `(("reference" . ,references)) reference-db)
(setq cached-references (cdar (db-get title reference-db))))
(with-current-buffer buf
(let ((inhibit-read-only t))
(remove-text-properties (point-min) (point-max) '(read-only nil)))
(erase-buffer)
(insert "#+TITLE: UNLINKED REFERENCES\n\n")
(if (string-empty-p references)
(progn
(org-mode)
(insert (format "* None unlinked references to \"%s\"\n" title))
(gkroam-org-title-overlay (point-min)))
(insert (format reference-title num title))
(insert cached-references)
(org-mode)
(indent-region (point-min) (point-max))
(gkroam-prettify-page)
(gkroam-unlinked-title-fontify (point-min) (point-max)))
(goto-char (point-min))
(put-text-property (point-min) (point-max)
'read-only "References region is uneditable.")
(gkroam-mentions-mode 1)))))
(let ((buf gkroam-unlinked-buf)
win-width)
(when (null gkroam-mentions-flag)
(setq gkroam-return-wconf (current-window-configuration)))
(setq gkroam-mentions-flag t)
(if (get-buffer-window buf)
(progn
(select-window (get-buffer-window buf))
(let ((inhibit-read-only t))
(remove-text-properties (point-min) (point-max) '(read-only nil))
(erase-buffer)
(insert "Calculating unlinked references...")))
(delete-other-windows)
(if (car (window-margins))
(setq win-width (+ (window-width) (* 2 (car (window-margins)))))
(setq win-width (window-width)))
(if (< win-width 100)
(split-window-below)
(split-window-right))
(other-window 1)
(switch-to-buffer buf)
(insert "Calculating unlinked references..."))))
;;;###autoload
(defun gkroam-show-unlinked ()
"Show unlinked references of current page in a side window."
(interactive)
(if (gkroam-at-root-p)
(let ((title (gkroam-retrive-title
(file-name-nondirectory (buffer-file-name)))))
(gkroam-set-unlinked-references title))
(message "Not in the gkroam directory!")))
;;;###autoload
(defun gkroam-link-unlinked (title line-number)
"Transform unlinked references in LINE-NUMBER line
to linked references for TITLE page."
(interactive)
(let* ((page
(save-excursion
(when (re-search-backward gkroam-backlink-regexp nil t)
(match-string-no-properties 1))))
(page-buf (find-file-noselect (gkroam--get-file page))))
(save-excursion
(with-current-buffer page-buf
(forward-line (- line-number (line-number-at-pos)))
(catch 'break
(while (re-search-forward title (line-end-position) t)
(when (gkroam--unlinked-title-valid-p)
(gkroam-new-from-region (match-beginning 0) (match-end 0) t)
(gkroam-set-unlinked-references title)
(throw 'break
(message "Have linked this to references.")))))))))
;; ----------------------------------------
;;;;; headline linked references
(defun gkroam--get-headlines (title)
"Get page's headline list, the page is titled with TITLE."
(with-temp-buffer
(insert-file-contents
;; do not use `insert-file-contents-literally',
;; it cannot show chinese normally.
(gkroam--get-file (gkroam-retrive-page title)))
(save-restriction
(gkroam--narrow-to-content)
(org-element-map (org-element-parse-buffer) 'headline
(lambda (headline)
(org-element-property :raw-value headline))))))
(defun gkroam-goto-headline (id)
"Goto headline with id ID."
(org-id-goto id)
(gkroam-update)
(gkroam-fontify-link)
(gkroam-prettify-page))
(defun gkroam-set-headline-id (title headline)
"Cache the HEADLINE's id of page titled with TITLE in db."
(when-let ((page (gkroam-retrive-page title)))
(let* ((file (gkroam--get-file page))
(page-buf (find-file-noselect file t))
headline-id)
(with-current-buffer page-buf
(save-excursion
(goto-char (point-min))
(re-search-forward (concat "^*+ " headline " *$") nil t)
(let ((alist (db-get title gkroam-headline-db)))
(if alist
(let ((kv (assoc headline alist)))
(setq headline-id (org-id-get-create))
(if kv
(unless (string= headline-id (cdr kv))
(setq alist (assoc-delete-all headline alist))
(push (cons headline headline-id) alist))
(push (cons headline (org-id-get-create)) alist))
(db-put title alist gkroam-headline-db))
(db-put title `(,(cons headline (org-id-get-create))) gkroam-headline-db)))
(save-buffer)))
headline-id)))
;; ----------------------------------------
;;;;; gkroam cache
(defvar gkroam-wc-regexp-chinese-char-and-punc
(rx (category chinese))
"Regular expression to match Chinese characters and punctuations.")
(defvar gkroam-wc-regexp-chinese-punc
"[。，！？；：「」『』（）、【】《》〈〉※—]"
"Regular expression to match Chinese punctuations.")
(defvar gkroam-wc-regexp-english-word
"[a-zA-Z0-9-]+"
"Regular expression to match English words.")
(defun gkroam-word-count ()
"Count gkroam page' words."
(interactive)
(let ((v-buffer-string
(if (eq major-mode 'org-mode)
(replace-regexp-in-string
"^#\\+.+" ""
(buffer-substring-no-properties
(point-min) (point-max)))
(buffer-substring-no-properties
(point-min) (point-max))))
(chinese-char-and-punc 0)
(chinese-punc 0)
(english-word 0)
(chinese-char 0))
(with-temp-buffer
(setq v-buffer-string
(replace-regexp-in-string
(format "^ *%s *.+" comment-start) "" v-buffer-string))
(insert v-buffer-string)
(goto-char (point-min))
(while (re-search-forward gkroam-wc-regexp-chinese-char-and-punc nil :no-error)
(setq chinese-char-and-punc (1+ chinese-char-and-punc)))
(goto-char (point-min))
(while (re-search-forward gkroam-wc-regexp-chinese-punc nil :no-error)
(setq chinese-punc (1+ chinese-punc)))
(goto-char (point-min))
(while (re-search-forward gkroam-wc-regexp-english-word nil :no-error)
(setq english-word (1+ english-word))))
(setq chinese-char (- chinese-char-and-punc chinese-punc))
(+ chinese-char english-word)))
(defun gkroam--get-page (title)
"Get gkroam page from TITLE."
(let ((pages (gkroam--all-pages))
file)
(catch 'break
(dolist (page pages)
(setq file (gkroam--get-file page))
(with-temp-buffer
(insert-file-contents file nil 0 2000 t)