-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathhui.el
2056 lines (1917 loc) · 81.4 KB
/
hui.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
;;; hui.el --- GNU Hyperbole button and hyperlink user interface -*- lexical-binding: t; -*-
;;
;; Author: Bob Weiner
;;
;; Orig-Date: 19-Sep-91 at 21:42:03
;; Last-Mod: 21-Jan-25 at 00:23:41 by Mats Lidell
;;
;; 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:
;;; Code:
;;; ************************************************************************
;;; Other required Elisp libraries
;;; ************************************************************************
(require 'hversion)
(require 'hargs)
;; Avoid any potential library name conflict by giving the load directory.
(require 'set (expand-file-name "set" hyperb:dir))
(require 'hmail)
(require 'hbut)
(eval-when-compile (require 'hactypes))
;;; ************************************************************************
;;; Public declarations
;;; ************************************************************************
(defvar cmpl-last-insert-location) ; "completion.el"
(defvar cmpl-original-string) ; "completion.el"
(defvar completion-to-accept) ; "completion.el"
(defvar hyperbole-mode-map) ; "hyperbole.el"
(declare-function bookmark-bmenu-bookmark "bookmark")
(declare-function hui:menu-choose "hui-mini")
(declare-function kcell-view:absolute-reference "kotl/kview")
(declare-function kcell-view:idstamp "kotl/kview")
(declare-function klink:absolute "kotl/klink")
(declare-function kotl-mode:copy-region-as-kill "kotl-mode")
(declare-function kotl-mode:kill-region "kotl-mode")
(declare-function texinfo-copy-node-name "texnfo-upd")
;;; ************************************************************************
;;; Public variables
;;; ************************************************************************
(defcustom hui:hbut-delete-confirm-flag t
"*Non-nil means prompt before interactively deleting explicit buttons."
:type 'boolean
:group 'hyperbole-buttons)
(defcustom hui:ebut-prompt-for-action nil
"*Non-nil prompts for a button-specific action on explicit button creation."
:type 'boolean
:group 'hyperbole-buttons)
;;; ************************************************************************
;;; Private variables
;;; ************************************************************************
(defvar hui:ebut-label-prev nil
"String value of previous button name during an explicit button rename.
At other times, value must be nil.")
(defvar hui:ignore-buffers-regexp "\\`\\( \\|BLANK\\'\\|\\*Pp \\|TAGS\\|*quelpa\\)"
"When prompting for a buffer name, ignore any buffers whose names match to this.")
;;; ************************************************************************
;;; Public Commands Bound to Keys
;;; ************************************************************************
;; Derived from copy-to-register of "register.el"
;;;###autoload
(defun hui-copy-to-register (register start end &optional delete-flag region-flag)
"Copy region or thing into REGISTER. With prefix arg, delete as well.
Called from program, takes five args: REGISTER, START, END, DELETE-FLAG,
and REGION-FLAG. START and END are buffer positions indicating what to copy.
The optional argument REGION-FLAG if non-nil, indicates that we're not just
copying some text between START and END, but we're copying the region.
Interactively, reads the register using `register-read-with-preview'.
If called interactively, `transient-mark-mode' is non-nil, and
there is no active region, copy any delimited selectable thing at
point; see `hui:delimited-selectable-thing'."
(interactive (list (register-read-with-preview "Copy to register: ")
(when mark-active (region-beginning))
(when mark-active (region-end))
current-prefix-arg
t))
(let (thing-and-bounds
thing
str)
(prog1 (setq str
;; If called interactively, transient-mark-mode is
;; enabled, and no region is active, copy thing at
;; point, current kcell ref when in kotl-mode or
;; button if on an ibut or ebut.
(cond ((and (called-interactively-p 'interactive)
transient-mark-mode
(not (use-region-p))
(or (ebut:label-p) (ibut:label-p)))
(hui-register-struct-at-point))
((and (called-interactively-p 'interactive)
transient-mark-mode
(not (use-region-p))
(prog1 (setq thing-and-bounds (hui:delimited-selectable-thing-and-bounds)
start (nth 1 thing-and-bounds)
end (nth 2 thing-and-bounds)
thing (nth 0 thing-and-bounds))
(when (and delete-flag start end)
(delete-region start end))))
thing)
((and start end region-flag)
(funcall region-extract-function delete-flag))
((and start end)
(filter-buffer-substring start end delete-flag))
(t ;; no region
(signal 'mark-inactive nil))))
(set-register register str)
(setq deactivate-mark t)
(cond (delete-flag)
((called-interactively-p 'interactive)
(if thing
(message "Saved selectable thing: %s" thing)
(indicate-copied-region)))))))
;; In "hyperbole.el", use this to override the {C-w} command from
;; either "completion.el" or "simple.el" when hyperbole-mode is active
;; to allow killing kcell references, active regions and delimited
;; areas (like sexpressions).
;;;###autoload
(defun hui-kill-region (beg end &optional region interactive)
"Kill (\"cut\") between point and mark.
The text is deleted but saved in the kill ring.
The command \\[yank] can retrieve it from there.
\(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
This is the primitive for programs to kill text (as opposed to deleting it).
Supply two arguments, character positions indicating the stretch of text
to be killed.
Any command that calls this function is a \"kill command\".
If the previous command was also a kill command,
the text killed this time appends to the text killed last time
to make one entry in the kill ring.
Patched to remove the most recent completion."
;; Pass mark first, then point, because the order matters when
;; calling `kill-append'.
(interactive (list (when mark-active (mark))
(when mark-active (point))
'region (prefix-numeric-value current-prefix-arg)))
(cond ((and transient-mark-mode
(or (use-region-p)
(not interactive)))
(unless (and beg end)
(setq beg (region-beginning)
end (region-end))))
((and transient-mark-mode (not mark-even-if-inactive)
(let* ((major-mode 'fundamental-mode)
;; Setting the major mode prevents hui-select from
;; suppressing use of `hui-select-syntax-table'
;; if in one of `hui-select-ignore-quoted-sexp-modes'.
(sel-func (hui-select-at-delimited-thing-p))
beg-end)
(when sel-func
(setq beg-end (funcall sel-func (point))
beg (car beg-end)
end (cdr beg-end)
region nil)
t)))))
;; If there is no mark, this call should trigger an error
(hui:kill-region beg end region))
;; In "hyperbole.el", use this to override the {M-w} command from
;; "simple.el" when hyperbole-mode is active to allow copying kcell
;; references, active regions and delimited areas (like sexpressions).
;;;###autoload
(defun hui-kill-ring-save (beg end &optional region)
"Save the active region as if killed, but don't kill it.
In Transient Mark mode, deactivate the mark.
If `interprogram-cut-function' is non-nil, also save the text for a window
system cut and paste.
If called interactively, `transient-mark-mode' is non-nil, and
there is no active region, copy any delimited selectable thing at
point; see `hui:delimited-selectable-thing'.
If you want to append the killed region to the last killed text,
use \\[append-next-kill] before \\[kill-ring-save].
The copied text is filtered by `filter-buffer-substring' before it is
saved in the kill ring, so the actual saved text might be different
from what was in the buffer.
When called from Lisp, save in the kill ring the stretch of text
between BEG and END, unless the optional argument REGION is
non-nil, in which case ignore BEG and END, and save the current
region instead.
This command is similar to `copy-region-as-kill', except that it gives
visual feedback indicating the extent of the region being copied."
;; Pass mark first, then point, because the order matters when
;; calling `kill-append'.
(interactive (list (when mark-active (mark))
(when mark-active (point))
(prefix-numeric-value current-prefix-arg)))
(let (thing)
(if (or (use-region-p)
(null transient-mark-mode)
(not (called-interactively-p 'interactive)))
(if (derived-mode-p 'kotl-mode)
(kotl-mode:copy-region-as-kill beg end)
(hui:validate-region beg end region)
(copy-region-as-kill beg end region))
(setq thing (hui:delimited-selectable-thing))
(if (stringp thing)
(progn (kill-new thing)
(setq deactivate-mark t))
(hui:validate-region beg end region)
(copy-region-as-kill beg end region)))
;; This use of called-interactively-p is correct because the code it
;; controls just gives the user visual feedback.
(when (called-interactively-p 'interactive)
(if thing
(message "Saved selectable thing: %s" thing)
(indicate-copied-region)))))
;;; ************************************************************************
;;; Public functions
;;; ************************************************************************
(defun hui:global-bind-key (cmd &optional new-key)
"Remove existing global key binding for CMD, rebind it to optional NEW-KEY.
If NEW-KEY is not provided, prompt for it. Display a message confirming
the binding."
(interactive "CCommand to change key binding of: \nKNew key to bind: ")
(if (not (functionp cmd))
(error "(hui:global-bind-key): Invalid command, `%s'" cmd))
(let* ((old-key (where-is-internal cmd (current-global-map) t))
;; Force multi-character key sequences to echo in the minibuffer
(echo-keystrokes 1)
old-key-text
new-key-text)
(when old-key (setq old-key-text (key-description old-key)))
(when (null new-key)
(setq new-key
(with-selected-window (minibuffer-window)
(read-key-sequence
(if old-key
(format "{%s} runs `%s'; change it to key: " old-key-text cmd)
(format "New key to run `%s': " cmd))))))
(cond ((equal new-key (kbd "\C-g"))
(keyboard-quit))
(new-key (global-set-key new-key cmd)
(setq new-key-text (key-description new-key))))
(if old-key
(progn (global-unset-key old-key)
(message "{%s} now runs `%s'; prior global {%s} binding removed" new-key-text cmd old-key-text))
(message "{%s} now runs `%s'" new-key-text cmd))))
(defun hui:bind-key (cmd &optional new-key)
"Remove existing Hyperbole key binding for CMD, rebind it to optional NEW-KEY.
If NEW-KEY is not provided, prompt for it. Display a message confirming the
binding."
(interactive "CCommand to change key binding of: \nKNew key to bind: ")
(if (not (functionp cmd))
(error "(hui:bind-key): Invalid command, `%s'" cmd))
(let* ((old-key (where-is-internal cmd hyperbole-mode-map t))
;; Force multi-character key sequences to echo in the minibuffer
(echo-keystrokes 1)
old-key-text
new-key-text)
(when old-key
(setq old-key-text (key-description old-key)))
(when (null new-key)
(setq new-key
(with-selected-window (minibuffer-window)
(read-key-sequence
(if old-key
(format "{%s} runs `%s'; change it to key: " old-key-text cmd)
(format "New key to run `%s': " cmd))))))
(cond ((equal new-key (kbd "\C-g"))
(keyboard-quit))
(new-key (define-key hyperbole-mode-map new-key cmd)
(setq new-key-text (key-description new-key))))
(if old-key
(progn (define-key hyperbole-mode-map old-key nil)
(message "{%s} now runs `%s'; prior Hyperbole {%s} binding removed" new-key-text cmd old-key-text))
(message "{%s} now runs `%s'" new-key-text cmd))))
(defun hui:delimited-selectable-thing ()
"Return any delimited selectable thing at point as a string or nil if none.
With point:
in a Koutline klink, copy the klink;
in a Koutline cell, outside any klink,
copy a klink reference to the current cell;
on a Hyperbole button, copy the text of the button excluding delimiters;
at the start of a paired delimiter,
copy the text including the delimiters."
(cond ((klink:absolute (klink:at-p)))
((derived-mode-p 'kotl-mode)
(kcell-view:absolute-reference))
((and (not (hyperb:stack-frame '(hui-kill-ring-save hbut:at-p ibut:at-p ebut:at-p)))
(let* ((hbut (hbut:at-p))
(start (when hbut (hattr:get hbut 'lbl-start)))
(end (when hbut (hattr:get hbut 'lbl-end))))
(and start end
(buffer-substring-no-properties start end)))))
((hui-select-at-delimited-thing-p)
(hui-select-get-thing))))
(defun hui:delimited-selectable-thing-and-bounds ()
"Return a list of any delimited selectable thing at point.
The list is (<thing-string> <thing-start> <thing-end>)
or nil if none. Start and end may be nil if the thing
was generated rather than extracted from a region."
(let (thing-and-bounds thing start end)
(cond ((setq thing-and-bounds (klink:at-p))
(when thing-and-bounds
(setcar thing-and-bounds (klink:absolute thing-and-bounds))
thing-and-bounds))
((derived-mode-p 'kotl-mode)
(list (kcell-view:absolute-reference)))
((and (not (hyperb:stack-frame '(hui-kill-ring-save hbut:at-p ibut:at-p ebut:at-p)))
(setq thing (hbut:at-p)
start (when thing (hattr:get thing 'lbl-start))
end (when thing (hattr:get thing 'lbl-end))))
(and start end
(list (buffer-substring-no-properties start end) start end)))
((hui-select-at-delimited-thing-p)
(when (setq thing-and-bounds (hui-select-get-region-boundaries))
(list (buffer-substring-no-properties (car thing-and-bounds) (cdr thing-and-bounds))
(car thing-and-bounds)
(cdr thing-and-bounds)))))))
(defun hui:ebut-act (&optional but)
"Activate optional explicit button symbol BUT in current buffer.
Default is the current button."
(interactive
(let ((but (ebut:at-p)) (lst))
(list
(cond (but)
((setq lst (ebut:alist))
(ebut:get (ebut:label-to-key
(hargs:read-match "Activate explicit button: " lst nil t
(ebut:label-p 'as-label) 'ebut))))
(t
(hypb:error "(ebut-act): No explicit buttons in buffer"))))))
(hui:hbut-operate #'hbut:act "Activate explicit button: " but))
(defun hui:ebut-create (&optional start end)
"Interactively create an explicit Hyperbole button.
Use any label between optional START and END region points.
Indicate button creation by delimiting and adding any necessary
instance number to the button label.
For programmatic creation, use `ebut:program' instead."
(interactive (list (when (use-region-p) (region-beginning))
(when (use-region-p) (region-end))))
(hypb:assert-same-start-and-end-buffer
(let ((default-lbl) lbl but-buf actype)
(save-excursion
(setq default-lbl (hui:hbut-label-default start end (not (called-interactively-p 'interactive)))
lbl (hui:hbut-label default-lbl "ebut-create"))
(unless (equal lbl default-lbl)
(setq default-lbl nil))
(setq but-buf (current-buffer))
(hui:buf-writable-err but-buf "ebut-create")
(hattr:set 'hbut:current 'categ 'explicit)
(hattr:set 'hbut:current 'loc (hui:key-src but-buf))
(hattr:set 'hbut:current 'dir (hui:key-dir but-buf))
(setq actype (hui:actype))
(hattr:set 'hbut:current 'actype actype)
(hattr:set 'hbut:current 'args (hargs:actype-get actype))
(hattr:set 'hbut:current 'action
(and hui:ebut-prompt-for-action (hui:action actype)))
;; Adds instance number to in-buffer label if necessary
(ebut:operate lbl nil)
(when (called-interactively-p 'interactive)
(hui:ebut-message nil))))))
(defun hui:ebut-delete (but-key &optional key-src)
"Delete explicit Hyperbole button given by BUT-KEY in optional KEY-SRC.
KEY-SRC may be a buffer or a pathname, when nil the current buffer is used.
Return t if button is deleted, nil if user chooses not to delete or signal
an error otherwise. If called interactively, prompt user whether to delete
and derive BUT-KEY from the button that point is within.
Signal an error if point is not within a button."
(interactive (list (when (ebut:at-p)
(hattr:get 'hbut:current 'lbl-key))))
(cond ((null but-key)
(hypb:error
"(ebut-delete): Point is not over the label of an existing button"))
((not (stringp but-key))
(hypb:error
"(ebut-delete): Invalid label key argument: '%s'" but-key)))
(let ((interactive (called-interactively-p 'interactive)))
(if (and hui:hbut-delete-confirm-flag interactive)
(if (y-or-n-p (format "Delete button %s%s%s? "
ebut:label-start
(hbut:key-to-label but-key) ebut:label-end))
(hui:ebut-delete-op interactive but-key key-src)
(message "")
nil)
(hui:ebut-delete-op interactive but-key key-src))))
(defun hui:ebut-edit-region ()
"Create or edit an explicit Hyperbole button when conditions are met.
A region must have been delimited with the action-key and point must now be
within it before this function is called or it will do nothing. The region
must be no larger than the size given by a call to (hbut:max-len). It must
be entirely within or entirely outside of an existing explicit button. When
region is within the button, the button is interactively edited. Otherwise,
a new button is created interactively with the region as the default label."
(interactive)
(let ((m (mark))
(op action-key-depress-prev-point) (p (point)) (lbl-key))
(if (and m (eq (marker-buffer m) (marker-buffer op))
(< op m) (<= (- m op) (hbut:max-len))
(<= p m) (<= op p))
(progn
(if (setq lbl-key (ebut:label-p))
(hui:ebut-edit lbl-key)
(hui:ebut-create op m))
t))))
(defun hui:ebut-edit (lbl-key)
"Edit an explicit Hyperbole button given by LBL-KEY.
Signal an error when no such button is found in the current buffer."
(interactive (list (save-excursion
(hui:buf-writable-err (current-buffer) "ebut-edit")
(ebut:label-to-key
(hargs:read-match "Button to edit: "
(ebut:alist) nil t
(ebut:label-p t) 'ebut)))))
(unless (stringp lbl-key)
(if (called-interactively-p 'interactive)
(error "(hui:ebut-edit): No explicit button to edit")
(error "(hui:ebut-edit): 'lbl-key' argument must be a string, not '%s'" lbl-key)))
(hypb:assert-same-start-and-end-buffer
(let ((lbl (ebut:key-to-label lbl-key))
(but-buf (current-buffer))
actype but new-lbl)
(hattr:set 'hbut:current 'loc (hui:key-src but-buf))
(hattr:set 'hbut:current 'dir (hui:key-dir but-buf))
(save-excursion
(unless (called-interactively-p 'interactive)
(hui:buf-writable-err but-buf "ebut-edit"))
(unless (setq but (ebut:get lbl-key but-buf))
(pop-to-buffer but-buf)
(hypb:error "(ebut-edit): Invalid button, no data for '%s'" lbl))
(setq new-lbl
(hargs:read
"Change button label to: "
(lambda (lbl)
(and (not (string-match-p "\\`\\s-*\\'" lbl))
(<= (length lbl) (hbut:max-len))))
lbl
(format "(ebut-edit): Enter a non-blank string of at most %s chars."
(hbut:max-len))
'string))
(setq actype (hui:actype (hattr:get but 'actype)))
(hattr:set 'hbut:current 'actype actype)
(hattr:set 'hbut:current 'args (hargs:actype-get actype t))
(hattr:set 'hbut:current 'action
(and hui:ebut-prompt-for-action (hui:action actype)))
(set-buffer but-buf)
(save-excursion
(ebut:operate lbl new-lbl)))
(when (called-interactively-p 'interactive)
(hui:ebut-message t)))))
(defun hui:ebut-rename (curr-label new-label)
"Rename explicit Hyperbole button given by CURR-LABEL to NEW-LABEL.
If called interactively when point is within an explicit button:
save button label and tell user to: 1. edit label and 2. invoke this
same command again. The second invocation changes the button's name
from the stored value to the new value.
If called interactively when point is not within an explicit button:
prompt for old and new button label values and perform the rename.
Signal an error if any problem occurs."
(interactive
(save-excursion
(let (curr-label new-label)
(hui:buf-writable-err (current-buffer) "ebut-rename")
(if hui:ebut-label-prev
(setq curr-label hui:ebut-label-prev
new-label (ebut:label-p 'as-label))
(setq new-label nil
curr-label
(or (ebut:label-p 'as-label)
(let ((buts (ebut:alist)))
(if (null buts)
(hypb:error "(ebut-rename): No explicit buttons in buffer")
(prog1 (hargs:read-match
"Button label to rename: "
buts nil t nil 'ebut)
(setq new-label
(hargs:read
"Rename button label to: "
(lambda (lbl)
(and (not (string-equal lbl ""))
(<= (length lbl) (hbut:max-len))))
curr-label
(format
"(ebut-rename): Use a quoted string of at most %s chars."
(hbut:max-len))
'string))))))))
(list curr-label new-label))))
(save-excursion
(unless (called-interactively-p 'interactive)
(hui:buf-writable-err (current-buffer) "ebut-rename")
(if (or (not (stringp curr-label)) (string-equal curr-label ""))
(hypb:error "(ebut-rename): 'curr-label' must be a non-empty string: %s"
curr-label))
(and (stringp new-label) (string-equal new-label "")
(hypb:error "(ebut-rename): 'new-label' must be a non-empty string: %s"
new-label)))
(or (ebut:get (ebut:label-to-key curr-label))
(hypb:error "(ebut-rename): Can't rename %s since no button data"
curr-label)))
(cond (new-label
(if (equal curr-label new-label)
(message "Current and new label are the same; '%s' unchanged."
curr-label)
(ebut:operate curr-label new-label)
(setq hui:ebut-label-prev nil)
(message "Renamed from '%s' to '%s'." curr-label new-label)))
(curr-label
(setq hui:ebut-label-prev curr-label)
(message "Edit button label and use the same command to finish rename."))
(t (hypb:error "(ebut-rename): Move point to within a button label"))))
(defun hui:ebut-search (string &optional match-part)
"Show lines of files/buffers containing an explicit but match for STRING.
Return number of buttons matched and displayed.
By default, find only matches for whole button labels; optional MATCH-PART
enables partial matches. Show matched lines in a buffer which serves as
a menu to find any of the occurrences."
(interactive (list (read-string "Search for button string: ")
(y-or-n-p "Enable partial matches? ")))
(if (not (stringp string))
(hypb:error "(ebut-search): String to search for is required"))
(let* ((prefix (if (> (length string) 14)
(substring string 0 13) string))
(out-buf (get-buffer-create (concat "*" prefix " Hypb Search*")))
(total (ebut:search string out-buf match-part)))
(if (> total 0)
(progn
(set-buffer out-buf)
(moccur-mode)
(when (fboundp 'outline-minor-mode)
(and (progn (goto-char 1)
(search-forward "\C-m" nil t))
(outline-minor-mode 1)))
(when (fboundp 'hproperty:but-create)
(hproperty:but-create (regexp-quote
(if match-part
string
(concat ebut:label-start string ebut:label-end)))))
(goto-char (point-min))
(pop-to-buffer out-buf)
(if (called-interactively-p 'interactive)
(message "%d match%s." total (if (> total 1) "es" ""))
total))
(if (called-interactively-p 'interactive)
(message "No matches.")
total))))
(defun hui:gbut-create (lbl ibut-flag)
"Create a Hyperbole global button with LBL.
By default, create an explicit button.
With prefix arg IBUT-FLAG non-nil, create a global implicit
button with LBL as its name instead. See `hui:gibut-create' for
details."
(interactive (list nil current-prefix-arg))
(unless lbl
(setq lbl (hui:hbut-label nil "gbut-create"
(if current-prefix-arg
"Create global implicit button named: "
"Create global explicit button labeled: "))))
(hypb:assert-same-start-and-end-buffer
(if ibut-flag
(hui:gibut-create lbl (hui:hbut-label nil "gbut-create"
"Implicit button text (with any delimiters): "))
(let (actype
but-buf
src-dir)
(save-excursion
(setq src-dir default-directory
actype (hui:actype)
but-buf (find-file-noselect (gbut:file)))
(set-buffer but-buf)
(hui:buf-writable-err (current-buffer) "gbut-create")
;; This prevents movement of point which might be useful to user.
(save-excursion
(goto-char (point-max))
(unless (bolp)
(insert "\n"))
;; loc = Directory of the global button file
(hattr:set 'hbut:current 'loc (hui:key-src but-buf))
;; dir = default-directory of current buffer at the start of
;; this `hui:gbut-create' function call (when button is created)
(hattr:set 'hbut:current 'dir src-dir)
(hattr:set 'hbut:current 'actype actype)
(hattr:set 'hbut:current 'args (hargs:actype-get actype))
(hattr:set 'hbut:current 'action (when hui:ebut-prompt-for-action
(hui:action actype)))
;; Ensure ebut:operate is given but-buf as the current buffer
(set-buffer but-buf)
(setq lbl (concat lbl (ebut:operate lbl nil)))
(goto-char (point-max))
(insert "\n")
(save-buffer))
(message "`%s' global explicit button created." lbl))))))
(defun hui:gbut-delete (but-key)
"Delete global Hyperbole button given by BUT-KEY.
Return t if button is deleted, nil if user chooses not to delete or signal
an error otherwise. If called interactively, prompt user whether to delete
and derive BUT-KEY from the button that point is within.
Signal an error if point is not within a button."
(interactive (list (save-excursion
(hui:buf-writable-err
(find-file-noselect (gbut:file)) "gbut-delete")
(hbut:label-to-key
(hargs:read-match "Global button to delete: "
(mapcar #'list (gbut:label-list))
nil t nil 'gbut)))))
(prog1 (hui:hbut-delete but-key (gbut:file))
(gbut:save-buffer)))
(defun hui:gbut-edit (lbl-key)
"Edit a global Hyperbole button given by LBL-KEY.
The button may be explicit or a labeled implicit button.
When called interactively, save the global button buffer after the
modification. Signal an error when no such button is found."
(interactive (list (save-excursion
(hui:buf-writable-err
(find-file-noselect (gbut:file)) "gbut-edit")
(hbut:label-to-key
(hargs:read-match "Global button to edit: "
(mapcar #'list (gbut:label-list))
nil t (gbut:label-p t) 'gbut)))))
(unless (stringp lbl-key)
(if (called-interactively-p 'interactive)
(error "(hui:gbut-edit): No global button to edit")
(error "(hui:gbut-edit): 'lbl-key' argument must be a string, not '%s'" lbl-key)))
(hypb:assert-same-start-and-end-buffer
(let ((lbl (hbut:key-to-label lbl-key))
(interactive-flag (called-interactively-p 'interactive))
(but-buf (find-file-noselect (gbut:file)))
(src-dir (file-name-directory (gbut:file)))
actype but new-lbl)
(save-excursion
(unless interactive-flag
(hui:buf-writable-err but-buf "gbut-edit"))
(unless (setq but (gbut:get lbl-key))
(pop-to-buffer but-buf)
(hypb:error "(gbut-edit): Invalid button, no data for '%s'" lbl))
(setq new-lbl
(hargs:read
"Change global button label to: "
(lambda (lbl)
(and (not (string-match-p "\\`\\s-*\\'" lbl))
(<= (length lbl) (hbut:max-len))))
lbl
(format "(gbut-edit): Enter a non-blank string of at most %s chars."
(hbut:max-len))
'string))
(if (eq (hattr:get but 'categ) 'explicit)
(progn
;; Explicit buttons
(hattr:set 'hbut:current 'loc (hui:key-src but-buf))
(hattr:set 'hbut:current 'dir src-dir)
(setq actype (hui:actype (hattr:get but 'actype)))
(hattr:set 'hbut:current 'actype actype)
(hattr:set 'hbut:current 'args (hargs:actype-get actype t))
(hattr:set 'hbut:current 'action
(and hui:ebut-prompt-for-action (hui:action actype)))
;; Ensure ebut:operate is given but-buf as the current buffer
(set-buffer but-buf)
(save-excursion
(ebut:operate lbl new-lbl))
(when interactive-flag
(save-buffer)))
;; Implicit buttons
(with-current-buffer but-buf
(save-excursion
(ibut:to lbl-key)
(if (and interactive-flag (ibut:at-p))
(progn
;; lbl-start and lbl-end mark the text of the ibut, not
;; its name.
(when (hattr:get 'hbut:current 'lbl-end)
(let* ((start (hattr:get 'hbut:current 'lbl-start))
(end (hattr:get 'hbut:current 'lbl-end))
(old-text (buffer-substring-no-properties start end))
(new-text (read-string "Edit ibut text: " old-text)))
(save-excursion
(goto-char start)
(delete-region start end)
(insert new-text))
(hattr:set 'hbut:current 'lbl-key (ibut:label-to-key new-lbl))))
;; Have to do name change after lbl-start/lbl-end are
;; used so buffer positions do not change.
(ibut:rename lbl new-lbl)
(save-buffer)
(hui:ibut-message t))
(when (and interactive-flag
(ibut:rename lbl new-lbl))
(save-buffer)
(message "Button renamed to %s%s%s"
ibut:label-start
new-lbl
ibut:label-end))))))))))
(defun hui:gbut-link-directly (&optional arg)
"Prompt for a new global link button name and add it.
Open a blank line at the end of the global/personal button file
and insert a new global button. By default, add an explicit
button. With optional prefix ARG non-nil, insert a named
implicit button. See also documentation for
`hui:link-possible-types'."
(interactive "P")
(hattr:clear 'hbut:current)
(save-window-excursion
(when (or (= (count-windows) 1)
(= (hypb:count-visible-windows) 1))
(split-window-vertically))
(find-file (gbut:file))
(hui:buf-writable-err (current-buffer) "gbut-link-directly")
(cl-multiple-value-bind (link-but-window referent-window)
(hmouse-choose-link-and-referent-windows)
(goto-char (point-max))
(beginning-of-line)
(unless (looking-at-p "[ \t]*$")
(end-of-line)
(newline))
(let ((standard-output (current-buffer))
edit-flag)
(if arg
(progn (setq edit-flag (hui:ibut-link-directly link-but-window referent-window t))
(when (called-interactively-p 'interactive)
(hui:ibut-message edit-flag)))
(setq edit-flag (hui:ebut-link-directly link-but-window referent-window))
(gbut:save-buffer)
(when (called-interactively-p 'interactive)
(hui:ebut-message edit-flag)))))))
(defun hui:gbut-rename (label)
"Interactively rename a Hyperbole global button with LABEL.
When in the global button buffer, the default is the button at point."
(interactive (list (save-excursion
(hui:buf-writable-err
(find-file-noselect (gbut:file)) "gbut-rename")
(hbut:label-to-key
(hargs:read-match "Global button to rename: "
(mapcar #'list (gbut:label-list))
nil t nil 'gbut)))))
(prog1 (hbut:rename (gbut:to label))
(gbut:save-buffer)))
(defun hui:gibut-create (name text)
"Create a Hyperbole global implicit button with NAME and button TEXT at point.
Button is stored as the properties of the symbol, \\='hbut:current.
Use `hui:gbut-create' to create a global explicit button."
(interactive "sCreate global implicit button named: \nsButton text (with any delimiters): ")
(let (but-buf
opoint
delimited-name)
(save-excursion
(setq delimited-name (concat ibut:label-start name ibut:label-end)
but-buf (hpath:find-noselect (gbut:file)))
(hui:buf-writable-err but-buf "gibut-create")
;; This prevents movement of point which might be useful to user.
(set-buffer but-buf)
(save-excursion
(goto-char (point-max))
(unless (bolp)
(insert "\n"))
(setq opoint (point))
(insert delimited-name ": " text "\n")
(save-excursion
(goto-char (+ opoint (length ibut:label-start)))
;; Create button object from ibut at point
(ibut:create))
(save-buffer))
(message "`%s' global implicit button created." name))))
(defun hui:hbut-act (&optional but)
"Execute action for optional Hyperbole button symbol BUT in current buffer.
The default is the current button."
(interactive (list (hbut:get (hargs:read-match "Activate named Hyperbole button: "
(nconc (ebut:alist) (ibut:alist))
nil t nil 'hbut))))
(hui:hbut-operate #'hbut:act "Activate Hyperbole button: " but))
(defun hui:hbut-buf (&optional prompt)
"PROMPT for and return a buffer in which to place a button."
(let ((buf-name))
(while
(progn
(setq buf-name
(hargs:read-match
(or prompt "Button's buffer: ")
(delq nil
(mapcar
;; Filter only buffer whose names start with a
;; space, are read-only or are known not to be
;; editable, since buttons can be
;; in buffers without attached files now.
(lambda (buf)
(let ((b (buffer-name buf)))
(unless (or (string-match-p hui:ignore-buffers-regexp b)
(buffer-local-value 'buffer-read-only buf))
(cons b nil))))
(buffer-list)))
nil t (buffer-name) 'buffer))
(or (null buf-name) (equal buf-name "")))
(beep))
(get-buffer buf-name)))
(defun hui:hbut-current-act ()
"Activate Hyperbole button at point or signal an error if there is none."
(interactive)
(let ((but (hbut:at-p)))
(cond ((null but)
(hypb:error "(hbut-act): No current button to activate"))
((not (hbut:is-p but))
(hypb:error "(hbut-act): Button is invalid ; it has no attributes"))
(t (hui:but-flash) (hbut:act but)))))
(defun hui:hbut-delete (&optional but-key key-src)
"Delete a Hyperbole button given by optional BUT-KEY in optional KEY-SRC.
For an implicit button, the BUT-KEY is the text key, not the name key.
Use current buffer if no KEY-SRC is given. Return t if button
is deleted, nil if user chooses not to delete, or signal an error
otherwise. If called interactively, prompt user for whether to
delete and derive BUT-KEY from the button that point is within.
Signal an error if point is not within a button."
(interactive)
(when (and (null but-key) (hbut:at-p))
(setq but-key (hattr:get 'hbut:current 'lbl-key)))
(unless key-src
(setq key-src (or (hypb:buffer-file-name) (current-buffer))))
(cond ((null but-key)
(hypb:error
"(hbut-delete): Point is not over the label of an existing button"))
((not (stringp but-key))
(hypb:error
"(hbut-delete): Invalid label key argument: '%s'" but-key)))
(save-excursion
(with-current-buffer (if (bufferp key-src) key-src (find-file-noselect key-src))
(let ((interactive (called-interactively-p 'interactive))
(label (hbut:key-to-label but-key)))
(cond ((ebut:to but-key)
(if (and hui:hbut-delete-confirm-flag interactive)
(if (y-or-n-p (format "Delete button %s%s%s? "
ebut:label-start label ebut:label-end))
(hui:ebut-delete-op interactive but-key key-src)
(message "")
nil)
(hui:ebut-delete-op interactive but-key key-src)))
((ibut:to but-key)
(if (and hui:hbut-delete-confirm-flag interactive)
(if (y-or-n-p (format "Delete button %s%s%s? "
ibut:label-start label ibut:label-end))
(hui:ibut-delete-op interactive but-key key-src)
(message "")
nil)
(hui:ibut-delete-op interactive but-key key-src)))
(t (hypb:error "(hbut-delete): Invalid button '%s'" label)))))))
(defun hui:hbut-help (&optional but)
"Check for and explain an optional button given by symbol, BUT.
BUT defaults to the button whose label point is within."
(interactive)
(setq but (or but (hbut:at-p)
(hbut:get (hbut:label-to-key
(hargs:read-match "Help for button: "
(hbut:alist) nil t nil 'hbut)))))
(unless but
(hypb:error "(hbut-help): Move point to a valid Hyperbole button"))
(unless (hbut:is-p but)
(cond (but (hypb:error "(hbut-help): Invalid button"))
(t (hypb:error
"(hbut-help): Not on an implicit button and no buffer explicit buttons"))))
(let ((type-help-func (intern-soft
(concat
(htype:names 'ibtypes (hattr:get but 'categ))
":help"))))
(unless (equal (hypb:indirect-function 'hui:but-flash)
(lambda nil))
;; Only flash button if point is on it.
(let ((lbl-key (hattr:get but 'lbl-key))
lbl-start
lbl-end)
(and lbl-key
(or (equal lbl-key (ebut:label-p))
;; Matches only ibuts with named labels
(equal lbl-key (ibut:label-p))
;; If ibut text region specified, check that.
(progn
(setq lbl-start (hattr:get but 'lbl-start)
lbl-end (hattr:get but 'lbl-end))
(when (and lbl-start lbl-end)
(equal lbl-key
(buffer-substring-no-properties lbl-start lbl-end)))))
(hui:but-flash))))
(if (functionp type-help-func)
(funcall type-help-func but)
(let ((total (hbut:report but)))
(when total (hui:help-ebut-highlight))))
(or type-help-func 'hbut:report)))
(defun hui:hbut-label (default-label func-name &optional prompt)
"Read button label from user using DEFAULT-LABEL and caller's FUNC-NAME.
Optional PROMPT string replaces the standard prompt of `Button label: '."
(hargs:read (if (stringp prompt) prompt "Button label: ")
(lambda (lbl)
(and (not (string-match-p "\\`\\s-*\\'" lbl))
(<= (length lbl) (hbut:max-len))))
default-label
(format "(%s): Enter a non-blank string of at most %s chars."
func-name (hbut:max-len))
'string))
(defun hui:hbut-label-default (start end &optional skip-len-test)
"Return default label based on START and END region markers or positions.
Optional SKIP-LEN-TEST means don't limit label to (hbut:max-len) length.
Return nil if START or END are invalid or if region fails length test.
Also has side effect of moving point to start of default label, if any."
(when (markerp start) (setq start (marker-position start)))
(when (markerp end) (setq end (marker-position end)))
;; Test whether to use region as default button label.
(when (and (integerp start) (integerp end)
(or skip-len-test
(<= (max (- end start) (- start end)) (hbut:max-len))))
(goto-char start)
(buffer-substring-no-properties start end)))
(defun hui:hbut-rename ()
"Interactively rename a Hyperbole button from the current buffer.
The default is the button at point."
(cond ((ebut:at-p)
(call-interactively #'hui:ebut-rename))
((ibut:at-p)
(call-interactively #'hui:ibut-rename))
(t
(hui:hbut-operate #'hbut:rename "Rename Hyperbole button: "))))
(defun hui:hbut-report (&optional arg)
"Pretty print attributes of current button, using optional prefix ARG.
See `hbut:report'."
(interactive "P")
(if (and arg (symbolp arg))
(hui:hbut-help arg)
(let ((total (hbut:report arg)))
(when total
(hui:help-ebut-highlight)
(message "%d button%s." total (if (/= total 1) "s" ""))))))
(defalias 'hui:hbut-summarize #'hui:hbut-report)
(defun hui:ibut-act (&optional ibut)
"Activate optional named implicit button symbol IBUT in current buffer.
Default is any implicit button at point."
(interactive
(let ((ibut (ibut:at-p)) (lst))
(list
(cond (ibut)
((setq lst (ibut:alist))
(ibut:get (ibut:label-to-key
(hargs:read-match "Activate named implicit button: " lst nil t
(ibut:label-p 'as-label) 'ibut))))
(t
(hypb:error "(ibut-act): No named implicit buttons in buffer"))))))