-
Notifications
You must be signed in to change notification settings - Fork 11
/
hibtypes.el
1726 lines (1585 loc) · 77.6 KB
/
hibtypes.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
;;; hibtypes.el --- GNU Hyperbole default implicit button types -*- lexical-binding: t; -*-
;;
;; Author: Bob Weiner
;;
;; Orig-Date: 19-Sep-91 at 20:45:31
;; Last-Mod: 1-Dec-24 at 20:33:59 by Bob Weiner
;;
;; SPDX-License-Identifier: GPL-3.0-or-later
;;
;; Copyright (C) 1991-2024 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
;;
;; This file is part of GNU Hyperbole.
;;; Commentary:
;;
;; Implicit button types (ibtypes) in this file are defined in increasing
;; order of priority within this file (last one is highest priority).
;;
;; To return a list of the implicit button types in priority order (highest
;; to lowest), evaluate:
;;
;; (symset:get 'ibtypes 'symbols)
;;
;; If you need to reset the priorities of all ibtypes, evaluate:
;;
;; (symset:clear 'ibtypes)
;;
;; and then reload this file.
;;
;; To get a list of all loaded action types, evaluate:
;;
;; (symset:get 'actypes 'symbols)
;;; Code:
;;; ************************************************************************
;;; Other required Elisp libraries
;;; ************************************************************************
(require 'cl-lib) ;; for cl-count
(require 'find-func) ;; used by grep-msg ibtype
(eval-when-compile (require 'hversion))
(require 'hactypes)
(require 'hypb)
(require 'org-macs) ;; for org-uuid-regexp
(require 'subr-x) ;; for string-trim
(require 'thingatpt)
;;; ************************************************************************
;;; Public declarations
;;; ************************************************************************
(defvar cscope-output-line-regexp)
(defvar id-cflow-repeated-indicator)
(defvar markdown-regex-link-reference)
(defvar markdown-regex-reference-definition)
(defvar org-uuid-regexp)
(declare-function actype:eval "hact")
(declare-function actype:identity "hact")
(declare-function ert-test-boundp "ert")
(declare-function hact "hact")
(declare-function hpath:display-buffer "hpath")
(declare-function htype:def-symbol "hact")
(declare-function hui:help-ebut-highlight "hui")
(declare-function hyperb:stack-frame "hversion")
(declare-function hyrolo-get-file-list "hyrolo")
(declare-function hywiki-get-singular-wikiword "hywiki")
(declare-function hywiki-referent-exists-p "hywiki")
(declare-function markdown-footnote-goto-text "ext:markdown")
(declare-function markdown-footnote-marker-positions "ext:markdown")
(declare-function markdown-footnote-return "ext:markdown")
(declare-function markdown-footnote-text-positions "ext:markdown")
(declare-function markdown-link-p "ext:markdown")
(declare-function markdown-link-url "ext:markdown")
(declare-function markdown-reference-goto-definition "ext:markdown")
(declare-function markdown-reference-goto-link "ext:markdown")
(declare-function markdown-wiki-link-p "ext:markdown")
(declare-function org-roam-id-find "ext:org-roam")
(declare-function set:member "set")
(declare-function symset:add "hact")
(declare-function symtable:add "hact")
;;; ************************************************************************
;;; Public implicit button types
;;; ************************************************************************
(run-hooks 'hibtypes-begin-load-hook)
;; Don't use require below here for any libraries with ibtypes in
;; them. Use load instead to ensure are reloaded when resetting
;; ibtype priorities.
;;; ========================================================================
;;; Displays Org and Org Roam files and sections by name link
;;; ========================================================================
(load "hynote")
;;; ========================================================================
;;; Creates and displays personal wiki pages and sections with auto-wikiword links
;;; ========================================================================
(load "hywiki")
;;; ========================================================================
;;; Jumps to source line from Python traceback lines
;;; ========================================================================
(defib python-tb-previous-line ()
"Move to prior line with potential Python line ref.
In Python, tracebacks may be on a line just below the source
reference line so since not on a Hyperbole button, move back a
line and check for a source reference line again."
(save-excursion
(unless (/= (forward-line -1) 0)
(ibut:label-set "temp") ;; Real value set in action call below
(hib-python-traceback))))
;;; ========================================================================
;;; Action Button Types that run Hyperbole tests;
;;; ert-deftest ibtype executes current ert test when on first line of def.
;;; ========================================================================
(load "hypb-ert")
;;; ========================================================================
;;; Handles social media hashtag and username references, e.g. twitter#myhashtag
;;; ========================================================================
(load "hib-social")
;;; ========================================================================
;;; Displays Org Roam and Org IDs.
;;; ========================================================================
(defib org-id ()
"Display Org roam or Org node referenced by uuid at point, if any.
If on the :ID: definition line, display a message about how to copy the uuid.
If the referenced location is found, return non-nil. Match to uuids
only to prevent false matches."
(when (featurep 'org-id)
(let* ((id (thing-at-point 'symbol t)) ;; Could be a uuid or some other form of id
(bounds (when id (bounds-of-thing-at-point 'symbol)))
(start (when bounds (car bounds)))
(end (when bounds (cdr bounds)))
m)
;; Ignore ID definitions or when not on a possible ID
(when (and id (if (fboundp 'org-uuidgen-p)
(org-uuidgen-p id)
(string-match org-uuid-regexp (downcase id))))
(when (and start end)
(ibut:label-set id start end))
(if (and (not assist-flag)
(save-excursion (beginning-of-line)
(re-search-forward ":\\(CUSTOM_\\)?ID:[ \t]+"
(line-end-position) t)))
(hact 'message "On ID definition; use {C-u M-RET} to copy a link to an ID.")
(when (let ((inhibit-message t) ;; Inhibit org-id-find status msgs
(obuf (current-buffer))
(omode major-mode))
(prog1 (setq m (or (and (featurep 'org-roam)
(org-roam-id-find id 'marker))
(org-id-find id 'marker)))
;; org-find-id sets current buffer mode to Org
;; mode even if ID is not found; switch it back
;; when necessary.
(when (and (eq obuf (current-buffer))
(not (eq omode major-mode)))
(funcall omode))))
(hact 'link-to-org-id-marker m)))))))
(defun org-id:help (_hbut)
"Copy link to kill ring of an Org roam or Org node referenced by id at point.
If on the :ID: definition line, do nothing and return nil.
If the referenced location is found, return non-nil."
(when (featurep 'org-id)
(let ((id (thing-at-point 'symbol t)) ;; Could be a uuid or some other form of id
m
mpos)
;; Ignore ID definitions or when not on a possible ID
(when (and id
(let ((inhibit-message t)) ;; Inhibit org-id-find status msgs
(setq m (or (and (featurep 'org-roam) (org-roam-id-find id 'marker))
(org-id-find id 'marker)))))
(save-excursion
(setq mpos (marker-position m))
(set-buffer (marker-buffer m))
(save-restriction
(widen)
(goto-char mpos)
(kill-new (message (org-id-store-link)))))))))
;;; ========================================================================
;;; Composes mail, in another window, to the e-mail address at point.
;;; ========================================================================
(defun mail-address-at-p ()
"Return e-mail address, a string, that point is within or nil."
(let ((case-fold-search t))
(save-excursion
(skip-chars-backward "^ \t\n\r\f\"\'(){}[];:<>|")
(and (or (looking-at hypb:mail-address-regexp)
(looking-at (concat "mailto:" hypb:mail-address-regexp)))
(save-match-data
(string-match hypb:mail-address-tld-regexp (match-string-no-properties 1)))
(match-string-no-properties 1)))))
(defib mail-address ()
"If on an e-mail address, compose mail to that address in another window.
Applies to any major mode in `hypb:mail-address-mode-list', the HyRolo match
buffer, any buffer attached to a file in `hyrolo-file-list', or any buffer with
\"mail\" or \"rolo\" (case-insensitive) within its name.
If `hypb:mail-address-mode-list' is set to nil, this button type is active
in all buffers."
(when (let ((case-fold-search t))
(or
(and (or (null hypb:mail-address-mode-list)
(apply #'derived-mode-p hypb:mail-address-mode-list))
(not (string-match "-Elements\\'" (buffer-name)))
;; Don't want this to trigger within an OOBR-FTR buffer.
(not (string-match "\\`\\(OOBR.*-FTR\\|oobr.*-ftr\\)"
(buffer-name)))
(not (string-equal "*Implementors*" (buffer-name))))
(and
(string-match "mail\\|rolo" (buffer-name))
;; Don't want this to trigger in a mail/news summary buffer.
(not (or (hmail:lister-p) (hnews:lister-p))))
(when (boundp 'hyrolo-display-buffer)
(equal (buffer-name) hyrolo-display-buffer))
(and buffer-file-name
(boundp 'hyrolo-file-list)
(set:member (current-buffer)
(mapcar #'get-file-buffer (hyrolo-get-file-list))))))
(let ((address (mail-address-at-p)))
(when address
(ibut:label-set address (match-beginning 1) (match-end 1))
(hact 'compose-mail-other-window address)))))
;;; ========================================================================
;;; Displays files and directories when a valid pathname is activated.
;;; ========================================================================
(defib pathname ()
"Make a valid pathname at point display the path entry.
If instead is a PATH-style variable name, .e.g. MANPATH, will prompt
with completion for one of the paths and will then display that. If
it is the colon or semicolon-separated string of paths value from a
PATH-style variable, the path at point is used; empty paths, e.g. ::
represent the current directory, '.'.
Also works for delimited and non-delimited remote pathnames,
recursive \\='ls' listings, Texinfo @file{} entries, and hash-style
link references to HTML, XML, SGML, Markdown or Emacs outline
headings, shell script comments, and MSWindows paths (see
\"${hyperb:dir}/DEMO#POSIX and MSWindows Paths\" for details).
Emacs Lisp library files (filenames without any directory
component that end in .el, .elc or .eln) are looked up using the
`load-path' directory list.
The pathname may contain references to Emacs Lisp variables or
shell environment variables using the syntax, \"${variable-name}\".
See `hpath:at-p' function documentation for possible delimiters.
See `hpath:suffixes' variable documentation for suffixes that are
added to or removed from pathname when searching for a valid
match. See `hpath:find' function documentation for special file
display options."
;;
;; Ignore paths in Buffer menu, dired and helm modes.
(unless (or (derived-mode-p 'helm-major-mode)
(delq nil (mapcar (lambda (substring)
(string-match substring (format-mode-line mode-name)))
'("Buffer Menu" "IBuffer" "Dired"))))
(let* ((orig-path (hpath:delimited-possible-path))
;; Normalized and expanded path
(path (hpath:at-p))
elisp-suffix
full-path)
;; If an Info path without parens, don't handle it here, use the
;; `Info-node' ibtype
(unless (and path (string-match-p ".+\\.info\\([.#]\\|\\'\\)" path))
(if path
(cond ((and (not (string-empty-p path))
(= (aref path 0) ?-)
(or (setq elisp-suffix (string-match "\\`[^\\\\/~]+\\.el[cn]?\\(\\.gz\\)?\\'" path))
(string-match "\\`[^.\\/\t\n\r\f]+\\'" path))
(string-match hpath:prefix-regexp path))
(setq path (substring path (match-end 0))
full-path (locate-library path elisp-suffix))
(cond (full-path
(setq path (concat "-" path))
(apply #'ibut:label-set orig-path (hpath:start-end orig-path))
(hact 'hpath:find path))
(elisp-suffix
(hact 'error "(pathname): \"%s\" not found in `load-path'" path))
;; Don't match as a pathname ibut; could be a Lisp
;; symbol or something else starting with a '-'.
(t nil)))
(t (when (string-match "\\`file://" path)
(setq path (substring path (match-end 0))))
(if (or (> (cl-count ?: orig-path) 2)
(> (cl-count ?\; orig-path) 2))
;; PATH-like set of values; select just the one point is on
(apply #'ibut:label-set path (hpath:start-end path))
;; Otherwise, use the unchanged orig-path
(apply #'ibut:label-set orig-path (hpath:start-end orig-path)))
(hact 'link-to-file path)))
;;
;; Match PATH-related Environment and Lisp variable names and
;; Emacs Lisp and Info files without any directory component.
(when (setq path orig-path)
(cond ((and (string-match hpath:path-variable-regexp path)
(setq path (match-string-no-properties 1 path))
(hpath:is-path-variable-p path))
(setq path (if (or assist-flag (hyperb:stack-frame '(hkey-help)))
path
(hpath:choose-from-path-variable path "Display")))
(unless (or (null path) (string-blank-p path)
;; Could be a shell command from a semicolon
;; separated list; ignore if so.
(and (string-match "\\`\\s-*\\([^; ]+\\)" path)
(executable-find (match-string-no-properties 1 path))))
(apply #'ibut:label-set path (hpath:start-end path))
(hact 'link-to-file path)))
((setq elisp-suffix (string-match "\\`[^\\\\/~]+\\.el[cn]?\\(\\.gz\\)?\\'" path))
(cond ((string-match hpath:prefix-regexp path)
(apply #'ibut:label-set path (hpath:start-end path))
(hact 'hpath:find path))
((setq full-path
(let ((load-suffixes '(".el")))
(locate-library path elisp-suffix)))
(apply #'ibut:label-set orig-path (hpath:start-end orig-path))
(hact 'link-to-file full-path))
(elisp-suffix
(hact 'error "(pathname): \"%s\" not found in `load-path'" path))
;; Don't match as a pathname ibut; could be a Lisp
;; symbol or something else starting with a '-'.
(t nil)))
;; Match only if "(filename)" references a valid Info file
;; and point is within the filename, not on any delimiters
;; so that delimited thing matches trigger later.
((and (not (looking-at "[\"()]"))
(string-match "\\`(\\([^ \t\n\r\f]+\\))\\'" path)
(save-match-data (require 'info))
(Info-find-file (match-string-no-properties 1 path) t))
(apply #'ibut:label-set orig-path (hpath:start-end orig-path))
(hact 'link-to-Info-node (format "%sTop" path)))
((string-match hpath:info-suffix path)
(apply #'ibut:label-set orig-path (hpath:start-end orig-path))
(hact 'link-to-Info-node (format "(%s)Top" path)))
;; Otherwise, fall through and allow other implicit
;; button types to handle this context.
)))))))
;;; ========================================================================
;;; Follows URLs by invoking a web browser.
;;; ========================================================================
(load "hsys-www")
;;; ========================================================================
;;; Uses web browser to display links to Hyperbole HTML manual sections;
;;; Links are of the form "hyperbole.html#Smart Keys"
;;; ========================================================================
(defib hyp-manual ()
"When on a Hyperbole manual file path, display it.
For example, display \"hyperbole.html#Smart Keys\" in a web
browser using the local html version of the Hyperbole manual.
When on \"hyperbole.texi#Smart Keys\", jump to the \"Smart Keys\"
node in the local Texinfo manual. Without a node name, go to the
top node.
Info file links like \"hyperbole.info#Smart Keys\" are handled by
the `Info-node' implicit button type and displayed in the Emacs
Info browser."
(let* ((path-start-end (hargs:delimited "\"" "\"" nil nil t))
(path (nth 0 path-start-end))
(start (nth 1 path-start-end))
(end (nth 2 path-start-end))
node)
(when (stringp path)
(setq path (string-trim path))
(when (string-match "\\`hyperbole.\\(html\\|texi\\)\\(#.*\\)?\\'" path)
(save-match-data
(setq node (match-string 2 path))
(when node
(setq node (string-trim (substring node 1))))
(ibut:label-set path start end))
(if (equal "html" (match-string 1 path))
(progn
;; Any spaces in #section must be replaced with dashes to match html ids
(when node
(setq node (replace-regexp-in-string "\\s-+" "-" node)))
(hact 'www-url (concat "file://"
(expand-file-name "hyperbole.html" (hpath:expand "${hyperb:dir}/man/"))
(when node "#") node)))
;; texi file
(hact 'link-to-file (concat
(expand-file-name
"hyperbole.texi"
(hpath:expand "${hyperb:dir}/man/"))
(when node "#") node)))))))
;;; ========================================================================
;;; Handles internal references within an annotated bibliography, delimiters=[]
;;; ========================================================================
(defib annot-bib ()
"Display annotated bibliography entries referenced internally.
References must be delimited by square brackets, must begin with a word
constituent character, not contain @ or # characters, must not be
in buffers whose names begin with a space or asterisk character, must
not be in a programming mode, Markdown or Org buffer and must have an
attached file."
(and (not (bolp))
buffer-file-name
(let ((chr (aref (buffer-name) 0)))
(not (or (eq chr ?\ ) (eq chr ?*))))
(not (apply #'derived-mode-p
'(c++-mode c++-ts-mode c-mode c-ts-mode java-mode java-ts-mode
markdown-mode objc-mode org-mode prog-mode)))
(unless (ibut:label-p t "[[" "]]" t) ;; Org link
(let ((ref (hattr:get 'hbut:current 'lbl-key))
(lbl-start (hattr:get 'hbut:current 'lbl-start))
lbl-start-end)
(and ref
lbl-start
(eq ?w (char-syntax (aref ref 0)))
(not (string-match "[#@]" ref))
(save-excursion
(goto-char lbl-start)
(setq lbl-start-end (ibut:label-p t "[" "]" t)))
(apply #'ibut:label-set lbl-start-end)
(hact 'annot-bib ref))))))
;;; ========================================================================
;;; Follows Org links that are in non-Org mode buffers
;;; ========================================================================
;; Org links in Org mode are handled at the highest priority; see the last
;; section at the end of this file.
(defib org-link-outside-org-mode ()
"Follow an Org link in a non-Org mode buffer.
This should be a very low priority so other Hyperbole types
handle any links they recognize first."
(when (and (not (funcall hsys-org-mode-function))
;; Prevent infinite recursion, e.g. if called via
;; `org-metareturn-hook' from `org-meta-return' invocation.
(not (hyperb:stack-frame '(ibtypes::debugger-source org-meta-return))))
(require 'hsys-org)
(declare-function hsys-org-link-at-p "hsys-org" ())
(declare-function hsys-org-set-ibut-label "hsys-org" (start-end))
(let ((start-end (hsys-org-link-at-p)))
(when start-end
(hsys-org-set-ibut-label start-end)
(hact #'org-open-at-point-global)))))
;;; ========================================================================
;;; Displays in-file Markdown link referents.
;;; ========================================================================
(defun markdown-follow-link-p ()
"Jump between reference links and definitions or footnote markers and text.
Return t if jump and nil otherwise."
(cond
;; Footnote definition
((markdown-footnote-text-positions)
(markdown-footnote-return)
t)
;; Footnote marker
((markdown-footnote-marker-positions)
(markdown-footnote-goto-text)
t)
;; Reference link
((thing-at-point-looking-at markdown-regex-link-reference)
(markdown-reference-goto-definition)
t)
;; Reference definition
((thing-at-point-looking-at markdown-regex-reference-definition)
(markdown-reference-goto-link (match-string-no-properties 2))
t)))
(defun markdown-follow-inline-link-p (opoint)
"If on an inline link, jump to its referent if it is absolute and return non-nil.
Absolute means not relative within the file. Otherwise, if an
internal link, move back to OPOINT and return nil."
;; Caller already checked not on a URL (handled elsewhere).
(let ((path (markdown-link-url)))
(goto-char opoint)
(when (markdown-link-p)
(ibut:label-set (match-string-no-properties 0) (match-beginning 0) (match-end 0))
(if path
(hact 'link-to-file path)
(hpath:display-buffer (current-buffer))
(hact 'markdown-follow-link-at-point)))))
(defib markdown-internal-link ()
"Display any in-file Markdown link referent at point.
Url links are handled elsewhere."
(when (and (derived-mode-p 'markdown-mode)
(not (hpath:www-at-p)))
(let ((opoint (point))
npoint)
(cond ((markdown-link-p)
(condition-case ()
;; Follows a reference link or footnote to its referent.
(if (markdown-follow-link-p)
(when (/= opoint (point))
(ibut:label-set (match-string-no-properties 0) (match-beginning 0) (match-end 0))
(setq npoint (point))
(goto-char opoint)
(hact 'link-to-file buffer-file-name npoint))
;; Follows an absolute file link.
(markdown-follow-inline-link-p opoint))
;; May be on the name of an infile link, so move to the
;; link itself and then display it as a pathname.
(error (markdown-follow-inline-link-p opoint))))
((markdown-wiki-link-p)
(ibut:label-set (match-string-no-properties 0) (match-beginning 0) (match-end 0))
(hpath:display-buffer (current-buffer))
(hact 'markdown-follow-wiki-link-at-point))))))
;;; ========================================================================
;;; Summarizes an Internet rfc for random access browsing by section.
;;; ========================================================================
(defib rfc-toc ()
"Summarize the contents of an Internet rfc from anywhere within an rfc buffer.
Each line in the summary may be selected to jump to a section."
(let ((case-fold-search t)
(toc)
(opoint (point))
sections-start)
(if (and (string-match "\\`rfc[-_]?[0-9]" (buffer-name))
(not (string-match "toc" (buffer-name)))
(goto-char (point-min))
(progn (setq toc (search-forward "Table of Contents" nil t))
(re-search-forward "^[ \t]*1.0?[ \t]+[^ \t\n\r]" nil t
(and toc 2))))
(progn (beginning-of-line)
(setq sections-start (point))
(ibut:label-set (buffer-name))
(goto-char opoint)
(hact 'rfc-toc (buffer-name) nil sections-start))
(goto-char opoint)
nil)))
;;; ========================================================================
;;; Expands or collapses C call trees and jumps to code definitions.
;;; ========================================================================
(defib id-cflow ()
"Expand or collapse C call trees and jump to code definitions.
Require cross-reference tables built by the external `cxref' program of Cflow."
(when (and (derived-mode-p 'id-cflow-mode)
(not (eolp)))
(let ((pnt (point)))
(save-excursion
(cond
;; If on a repeated function mark, display its previously
;; expanded tree.
((progn (skip-chars-backward " ")
(looking-at id-cflow-repeated-indicator))
(let ((end (point))
start entry)
(beginning-of-line)
(skip-chars-forward "| ")
(setq start (point)
entry (buffer-substring-no-properties start end))
(ibut:label-set entry start end)
(condition-case ()
(hact 'link-to-regexp-match
(concat "^[| ]*[&%%]*" (regexp-quote entry) "$")
1 (current-buffer) t)
(error
(goto-char end)
(error "(id-cflow): No prior expansion found")))))
;; If to the left of an entry, expand or contract its tree.
((progn (beginning-of-line)
(or (= pnt (point))
(and (looking-at "[| ]+")
(<= pnt (match-end 0)))))
(hact 'id-cflow-expand-or-contract current-prefix-arg))
;; Within an entry's filename, display the file.
((search-forward "\(" pnt t)
(let* ((start (point))
(end (1- (search-forward "\)" nil t)))
(file (buffer-substring-no-properties start end)))
(ibut:label-set file start end)
(hact 'link-to-file file)))
;; Within an entry's function name, jump to its definition.
(t
(hact 'smart-c)))))))
;;; ========================================================================
;;; Jumps to the source line associated with a ctags file entry.
;;; ========================================================================
(defib ctags ()
"Jump to the source line associated with a ctags file entry in any buffer."
(save-excursion
(beginning-of-line)
(cond
((looking-at "^\\(\\S-+\\) \\(\\S-+\\.[a-zA-Z]+\\) \\([1-9][0-9]*\\)$")
;; identifier pathname line-number
;; ctags vgrind output format entry
(let ((identifier (match-string-no-properties 1))
(file (expand-file-name (match-string-no-properties 2)))
(line-num (string-to-number (match-string-no-properties 3))))
(ibut:label-set identifier (match-beginning 1) (match-end 1))
(hact 'link-to-file-line file line-num)))
((looking-at "^\\(\\S-+\\) +\\([1-9][0-9]*\\) \\(\\S-+\\.[a-zA-Z]+\\) ")
;; ctags cxref output format entry
;; identifier line-number pathname
(let ((identifier (match-string-no-properties 1))
(line-num (string-to-number (match-string-no-properties 2)))
(file (expand-file-name (match-string-no-properties 3))))
(ibut:label-set identifier (match-beginning 1) (match-end 1))
(hact 'link-to-file-line file line-num))))))
;;; ========================================================================
;;; Jumps to the source line associated with an etags file entry in a TAGS buffer.
;;; ========================================================================
(defib etags ()
"Jump to the source line associated with an etags file entry in a TAGS buffer.
If on a tag entry line, jump to the source line for the tag. If on a
pathname line or line preceding it, jump to the associated file."
(when (let (case-fold-search) (string-match "^TAGS" (buffer-name)))
(save-excursion
(beginning-of-line)
(cond
((save-excursion
(and (or (and (eq (following-char) ?\^L)
(zerop (forward-line 1)))
(and (zerop (forward-line -1))
(eq (following-char) ?\^L)
(zerop (forward-line 1))))
(looking-at "\\([^,\n\r]+\\),[0-9]+$")))
(let ((file (match-string-no-properties 1)))
(ibut:label-set file (match-beginning 1) (match-end 1))
(hact 'link-to-file file)))
((looking-at
"\\([^\^?\n\r]+\\)[ ]*\^?\\([^\^A\n\r]+\^A\\)?\\([1-9][0-9]+\\),")
(let* ((tag-grouping (if (match-beginning 2) 2 1))
(tag (buffer-substring-no-properties (match-beginning tag-grouping)
(1- (match-end tag-grouping))))
(line (string-to-number (match-string-no-properties 3)))
file)
(ibut:label-set tag (match-beginning tag-grouping)
(1- (match-end tag-grouping)))
(save-excursion
(if (re-search-backward "\^L\r?\n\\([^,\n\r]+\\),[0-9]+$" nil t)
(setq file (expand-file-name (match-string-no-properties 1)))
(setq file "No associated file name")))
(hact 'link-to-file-line file line)))))))
;;; ========================================================================
;;; Jumps to C/C++ source line associated with Cscope C analyzer output line.
;;; ========================================================================
(defib cscope ()
"Jump to C/C++ source line associated with Cscope C analyzer output line.
The cscope.el Lisp library available from the Emacs package manager
must be loaded and the open source cscope program available from
http://cscope.sf.net must be installed for this button type to do
anything."
(and (boundp 'cscope:bname-prefix) ;; (featurep 'cscope)
(stringp cscope:bname-prefix)
(string-match (regexp-quote cscope:bname-prefix)
(buffer-name))
(= (match-beginning 0) 0)
(save-excursion
(beginning-of-line)
(looking-at cscope-output-line-regexp))
(let (start end)
(skip-chars-backward "^\n\r")
(setq start (point))
(skip-chars-forward "^\n\r")
(setq end (point))
(ibut:label-set (buffer-substring start end)
start end)
(hact 'cscope-interpret-output-line))))
;;; ========================================================================
;;; Makes README table of contents entries jump to associated sections.
;;; ========================================================================
(defib text-toc ()
"Jump to the text file section referenced by a table of contents entry at point.
Buffer must be in a text mode or must contain DEMO, README or
TUTORIAL and there must be a `Table of Contents' or `Contents'
label on a line by itself (it optionally may begin with an
asterisk), preceding the table of contents. Each toc entry must
begin with optional whitespace followed by one or more asterisks.
Each section header linked to by the toc must start with optional
whitespace and then one or more asterisks at the beginning of the
line."
(let (section)
(when (and (or (derived-mode-p 'text-mode)
(string-match "DEMO\\|README\\|TUTORIAL" (buffer-name)))
(save-excursion (re-search-backward
"^\\*?*[ \t]*\\(Table of \\)?Contents[ \t]*$"
nil t))
(save-excursion
(beginning-of-line)
;; Entry line within a TOC
(when (and (or
;; Next line is typically in RFCs,
;; e.g. "1.1. Scope ..... 1"
(looking-at "^[ \t]*\\([0-9.]+\\([ \t]+[^ \t\n\r]+\\)+\\) \\.+")
(looking-at "[ \t]+\\([-+*o]+[ \t]+.*\\)$"))
(setq section (string-trim (match-string-no-properties 1))))
(ibut:label-set section (match-beginning 1) (match-end 1))
t)))
(hact 'text-toc section))))
;;; ========================================================================
;;; Makes directory summaries into file list menus.
;;; ========================================================================
(defib dir-summary ()
"Detect filename buttons in files named \"MANIFEST\" or \"DIR\".
Display selected files. Each file name must be at the beginning of the line
or may be preceded by some semicolons and must be followed by one or more
spaces and then another non-space, non-parenthesis, non-brace character."
(when buffer-file-name
(let ((file (file-name-nondirectory buffer-file-name))
entry start end)
(when (and (or (string-equal file "DIR")
(string-match "\\`MANIFEST\\(\\..+\\)?\\'" file))
(save-excursion
(beginning-of-line)
(when (looking-at "\\(;+[ \t]*\\)?\\([^(){}* \t\n\r]+\\)")
(setq entry (match-string-no-properties 2)
start (match-beginning 2)
end (match-end 2))
(file-exists-p entry))))
(ibut:label-set entry start end)
(hact 'link-to-file entry)))))
;;; ========================================================================
;;; Handles Gnu debbugs issue ids, e.g. bug#45678 or just 45678.
;;; ========================================================================
(load "hib-debbugs")
;;; ========================================================================
;;; Executes or documents command bindings of brace delimited key sequences.
;;; ========================================================================
(load "hib-kbd")
;;; ========================================================================
;;; Makes Internet RFC references retrieve the RFC.
;;; ========================================================================
(defib rfc ()
"Retrieve and display an Internet Request for Comments (RFC) at point.
The following formats are recognized: RFC822, rfc-822, and RFC 822. The
`hpath:rfc' variable specifies the location from which to retrieve RFCs.
Requires the Emacs builtin Tramp library for ftp file retrievals."
(let ((case-fold-search t)
(rfc-num nil))
(and (not (memq major-mode '(dired-mode monkey-mode)))
(boundp 'hpath:rfc)
(stringp hpath:rfc)
(or (looking-at " *\\(rfc[- ]?\\([0-9]+\\)\\)")
(save-excursion
(skip-chars-backward "0-9")
(skip-chars-backward "- ")
(skip-chars-backward "rRfFcC")
(looking-at " *\\(rfc[- ]?\\([0-9]+\\)\\)")))
(progn (setq rfc-num (match-string-no-properties 2))
(ibut:label-set (match-string-no-properties 1)
(match-beginning 1)
(match-end 1))
t)
;; Ensure remote file access is available for retrieving a remote
;; RFC, if need be.
(if (string-match "^/.+:" hpath:rfc)
;; This is a remote path.
(hpath:remote-available-p)
;; local path
t)
(hact 'link-to-rfc rfc-num))))
;;; ========================================================================
;;; Shows man page associated with a man apropos entry.
;;; ========================================================================
(defib man-apropos ()
"Make man apropos entries display associated man pages when selected."
(save-excursion
(beginning-of-line)
(let ((nm "[^ \t\n\r!@,:;(){}][^ \t\n\r,(){}]*[^ \t\n\r@.,:;(){}]")
topic)
(and (looking-at
(concat
"^\\(\\*[ \t]+[!@]\\)?\\(" nm "[ \t]*,[ \t]*\\)*\\(" nm "\\)[ \t]*"
"\\(([-0-9a-zA-z]+)\\)\\(::\\)?[ \t]+-[ \t]+[^ \t\n\r]"))
(setq topic (concat (match-string-no-properties 3)
(match-string-no-properties 4)))
(ibut:label-set topic (match-beginning 3) (match-end 4))
;; Use 'man' instead of 'actypes::man-show' in next line so
;; can follow cross-references within the same window when
;; Hyperbole is set to display other referents in another window.
(hact 'man topic)))))
;;; ========================================================================
;;; Follows links to Hyperbole Koutliner cells.
;;; ========================================================================
(load "klink")
;;; ========================================================================
;;; Links to Hyperbole button types
;;; ========================================================================
(defun hlink (link-actype label-prefix start-delim end-delim)
"Call LINK-ACTYPE and use LABEL-PREFIX if point is within an implicit button.
LINK-ACTYPE is the action type and button is prefixed with
LABEL-PREFIX. The button must be delimited by START-DELIM and
END-DELIM."
;; Used by e/g/ilink implicit buttons."
(let* ((label-start-end (hbut:label-p t start-delim end-delim t t))
(label-and-file (nth 0 label-start-end))
(start-pos (nth 1 label-start-end))
(end-pos (nth 2 label-start-end))
but-key lbl-key key-file partial-lbl)
(when label-and-file
(setq label-and-file (hlink:parse-label-and-file label-and-file)
partial-lbl (nth 0 label-and-file)
but-key (hbut:label-to-key partial-lbl)
key-file (nth 1 label-and-file)
lbl-key (when but-key (concat label-prefix but-key)))
(ibut:label-set (hbut:key-to-label lbl-key) start-pos end-pos)
(hact link-actype but-key key-file))))
(defun hlink:parse-label-and-file (label-and-file)
"Parse colon-separated string LABEL-AND-FILE into a list of label and file path."
;; Can't use split-string here because file path may contain colons;
;; we want to split only on the first colon.
(let ((i 0)
(len (length label-and-file))
label
file)
(while (< i len)
(when (= ?: (aref label-and-file i))
(when (zerop i)
(error "(hlink:parse-label-and-file): Missing label: '%s'" label-and-file))
(setq label (hpath:trim (substring label-and-file 0 i))
file (hpath:trim (substring label-and-file (1+ i))))
(when (string-empty-p label) (setq label nil))
(when (string-empty-p file) (setq file nil))
(setq i len))
(setq i (1+ i)))
(unless (or label (string-empty-p label-and-file))
(setq label label-and-file))
(delq nil (list label file))))
(defconst elink:start "<elink:"
"String matching the start of a link to a Hyperbole explicit button.")
(defconst elink:end ">"
"String matching the end of a link to a Hyperbole explicit button.")
(defib elink ()
"At point, activate a link to an explicit button.
This executes the linked to explicit button's action in the
context of the current buffer.
Recognizes the format '<elink:' button_label [':' button_file_path] '>',
where : button_file_path is given only when the link is to another file,
e.g. <elink: project-list: ~/projs>."
(progn
(ibut:label-set "temp") ;; Real value set in action call below
(hlink 'link-to-ebut "" elink:start elink:end)))
(defconst glink:start "<glink:"
"String matching the start of a link to a Hyperbole global button.")
(defconst glink:end ">"
"String matching the end of a link to a Hyperbole global button.")
(defib glink ()
"At point, activates a link to a global button.
This executes the linked to global button's action in the context
of the current buffer.
Recognizes the format '<glink:' button_label '>',
e.g. <glink: open todos>."
(progn
(ibut:label-set "temp") ;; Real value set in action call below
(hlink 'link-to-gbut "" glink:start glink:end)))
(defconst ilink:start "<ilink:"
"String matching the start of a link to a Hyperbole implicit button.")
(defconst ilink:end ">"
"String matching the end of a link to a Hyperbole implicit button.")
(defib ilink ()
"At point, activate a link to a labeled implicit button.
This executes the linked to implicit button's action in the context of the
current buffer.
Recognizes the format '<ilink:' button_label [':' button_file_path] '>',
where button_file_path is given only when the link is to another file,
e.g. <ilink: my series of keys: ${hyperb:dir}/HYPB>."
(progn
(ibut:label-set "temp") ;; Real value set in action call below
(hlink 'link-to-ibut "" ilink:start ilink:end)))
;;; ========================================================================
;;; Displays files at specific lines and optional column number
;;; locations.
;;; ========================================================================
(defib pathname-line-and-column ()
"Display path at position given by a pathname:line-num[:column-num] pattern.
Also works for remote pathnames.
May also contain hash-style link references with the following format:
\"<path>[#<link-anchor>]:[L]<line-num>[:[C]<column-num>]}\".
See `hpath:at-p' function documentation for possible delimiters.
See `hpath:suffixes' variable documentation for suffixes that are added to or
removed from pathname when searching for a valid match.
See `hpath:find' function documentation for special file display options."
(let* ((path-start-and-end (hpath:delimited-possible-path nil t))
(path-line-and-col (nth 0 path-start-and-end))
(start (nth 1 path-start-and-end)))
(when (and (stringp path-line-and-col)
(string-match hpath:section-line-and-column-regexp path-line-and-col))
(let* ((line-num (string-to-number (match-string-no-properties 3 path-line-and-col)))
(col-num (when (match-end 4)
(string-to-number (match-string-no-properties 5 path-line-and-col))))
(label (match-string-no-properties 1 path-line-and-col))
;; Next variable must come last as it can overwrite the match-data
(file (hpath:expand label)))
(when (setq file (hpath:is-p file))
(ibut:label-set label start (+ start (length label)))
(if col-num
(hact 'link-to-file-line-and-column file line-num col-num)
(hact 'link-to-file-line file line-num)))))))
;;; ========================================================================
;;; Jumps to source line associated with ipython, ripgrep, grep or
;;; compilation errors or HyRolo stuck position error messages.
;;; ========================================================================
(defun hib-link-to-file-line (file line-num)
"Expand FILE and jump to its LINE-NUM in Hyperbole specified window.
The variable `hpath:display-where' determines where to display the file.
LINE-NUM may be an integer or string."
;; RSW 12-05-2021 - Added hpath:expand in next line to
;; resolve any variables in the path before checking if absolute.
(let ((source-loc (unless (file-name-absolute-p (hpath:expand file))
(hbut:to-key-src t)))
ext)
(if (stringp source-loc)
(setq file (expand-file-name file (file-name-directory source-loc)))
(setq file (or (hpath:prepend-shell-directory file)
;; find-library-name will strip file
;; suffixes, so use it only when the file
;; either doesn't have a suffix or has a
;; library suffix.
(and (or (null (setq ext (file-name-extension file)))
(member (concat "." ext) (get-load-suffixes)))
(ignore-errors (find-library-name file)))
(expand-file-name file))))
(when (file-exists-p file)
(actypes::link-to-file-line file line-num))))
(defib ipython-stack-frame ()
"Jump to the line associated with an ipython stack frame line numbered msg.
ipython outputs each pathname once followed by all matching lines
in that pathname. Messages are recognized in any buffer (other
than a helm completion buffer)."
;; Locate and parse ipython stack trace messages found in any buffer other than a
;; helm completion buffer.
;;
;; Sample ipython stack trace command output:
;;
;; ~/Dropbox/py/inview/inview_pr.py in ap(name_filter, value_filter, print_func)
;; 1389 apc(name_filter, value_filter, print_func, defined_only=True)
;; 1390 print('\n**** Modules/Packages ****')
;; -> 1391 apm(name_filter, value_filter, print_func, defined_only=True)
;; 1392
;; 1393 def apa(name_filter=None, value_filter=None, print_func=pd1, defined_only=False):
(unless (derived-mode-p 'helm-major-mode)
(save-excursion
(beginning-of-line)
(let ((line-num-regexp "\\( *\\|-+> \\)?\\([1-9][0-9]*\\) ")
line-num
file)
(when (looking-at line-num-regexp)