-
Notifications
You must be signed in to change notification settings - Fork 5
/
slime-help.el
1213 lines (1057 loc) · 48.5 KB
/
slime-help.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
;;; slime-help.el --- Fancier SLIME documentation buffers -*- lexical-binding: t -*-
;; Copyright (C) 2021 Mariano Montone
;; Author: Mariano Montone <marianomontone@gmail.com>
;; URL: https://github.com/mmontone/slime-doc-contribs
;; Keywords: help, lisp, slime, common-lisp
;; Version: 0.1
;; Package-Requires: ((emacs "25"))
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; slime-help is a SLIME extension that improves SLIME documentation buffers.
;;; Code:
(require 'map)
(require 'button)
(require 'lisp-mode)
(require 'slime)
(require 'subr-x)
(require 'cl-lib)
(defgroup slime-help nil
"Common Lisp documentation browser."
:prefix "slime-help-"
:group 'slime)
(defcustom slime-help-ansicl-lookup-function
'slime-hyperspec-lookup
"Function for looking up a symbol in ANSICL spec."
:type 'symbol
:group 'slime-help)
(defun slime-help-ansicl-lookup (symbol-name)
"Lookup SYMBOL-NAME in ANSICL spec."
(interactive (list (common-lisp-hyperspec-read-symbol-name
(slime-symbol-at-point))))
(funcall slime-help-ansicl-lookup-function symbol-name))
(defgroup slime-help-faces nil
"Faces of SLIME-HELP."
:group 'slime-help)
(defface slime-help-heading-1
'((t :weight bold
:height 1.4
;;:underline t
))
"Slime help face for headings"
:group 'slime-help-faces)
(defface slime-help-heading-2
'((t :weight bold
:height 1.3
;;:underline t
))
"Slime help face for headings"
:group 'slime-help-faces)
(defface slime-help-heading-3
'((t :weight bold
:height 1.2
;;:underline t
))
"Slime help face for headings"
:group 'slime-help-faces)
(defface slime-help-argument
'((t (:inherit font-lock-type-face)))
"Face for variables in Slime help"
:group 'slime-help-faces)
(defface slime-help-variable
'((t :foreground "darkgreen"))
"Face for variables in Slime help"
:group 'slime-help-faces)
(defface slime-help-keyword
'((t :foreground "violet red"))
"Face for keywords in Slime help"
:group 'slime-help-faces)
(defface slime-help-name
'((t :foreground "orange"))
"Face for name in Slime help"
:group 'slime-help-faces)
(defface slime-help-type
'((t :foreground "purple"))
"Face for type in Slime help"
:group 'slime-help-faces)
(defface slime-help-apropos-label
'((t :weight bold))
"Slime help face for apropos items"
:group 'slime-help-faces)
(defface slime-help-info
'((t :foreground "green"))
"Face for displaying slime-help information"
:group 'slime-help-faces)
(defface slime-help-warning
'((t :foreground "orange"))
"Face for displaying slime-help warnings"
:group 'slime-help-faces)
(defface slime-help-error
'((t :foreground "red"))
"Face for displaying slime-help errors"
:group 'slime-help-faces)
(defface slime-help-button
'((t (:box (:line-width 2 :color "dark grey") :background "light grey" :foreground "black")))
"Face for slime-help buttons"
:group 'slime-help-faces)
(defun slime-help--heading-1 (text)
(propertize text 'face 'slime-help-heading-1))
(defun slime-help--heading-2 (text)
(propertize text 'face 'slime-help-heading-2))
(defun slime-help--heading-3 (text)
(propertize text 'face 'slime-help-heading-3))
(defun slime-help--horizontal-line (&rest width)
(make-string (or width 80) ?\u2500))
(defun slime-help--info (text)
(propertize text 'face 'slime-help-info))
(defun slime-help--warning (text)
(propertize text 'face 'slime-help-warning))
(defun slime-help--error (text)
(propertize text 'face 'slime-help-error))
(defun slime-help--propertize-docstring (string)
(slime-help--propertize-links
(slime-help--propertize-bare-links string)))
(defun slime-help--insert-documentation (info &optional package)
(if slime-help-parse-docstrings
(slime-help--format-parsed-docstring
(cdr (assoc :parsed-documentation info))
(or package (cdr (assoc :package info))))
(insert (slime-help--propertize-docstring (cdr (assoc :documentation info))))))
;; copied from helpful.el library
(defun slime-help--button (text type &rest properties)
;; `make-text-button' mutates our string to add properties. Copy
;; TEXT to prevent mutating our arguments, and to support 'pure'
;; strings, which are read-only.
(setq text (substring-no-properties text))
(apply #'make-text-button
text nil
:type type
properties))
(define-button-type 'slime-help-link-button
'action #'slime-help--follow-link
'follow-link t
'help-echo "Follow this link")
(define-button-type 'slime-help-lookup-in-manuals-button
'action #'slime-help--lookup-in-manuals
'follow-link t
'face 'slime-help-button
'help-echo "Lookup in manuals")
(defun slime-help--lookup-in-manuals (btn)
(funcall slime-help-lookup-in-manuals-function
(prin1-to-string (button-get btn 'symbol))))
(defun slime-help--propertize-links (docstring)
"Convert URL links in docstrings to buttons."
(replace-regexp-in-string
(rx "URL `" (group (*? any)) "'")
(lambda (match)
(let ((url (match-string 1 match)))
(concat "URL "
(slime-help--button
url
'slime-help-link-button
'url url))))
docstring))
(defun slime-help--propertize-bare-links (docstring)
"Convert URL links in docstrings to buttons."
(replace-regexp-in-string
(rx (group (or string-start space "<"))
(group "http" (? "s") "://" (+? (not (any space))))
(group (? (any "." ">" ")"))
(or space string-end ">")))
(lambda (match)
(let ((space-before (match-string 1 match))
(url (match-string 2 match))
(after (match-string 3 match)))
(concat
space-before
(slime-help--button
url
'slime-help-link-button
'url url)
after)))
docstring))
(defun slime-help--follow-link (button)
"Follow the URL specified by BUTTON."
(browse-url (button-get button 'url)))
;; helpful.el stuff ends here
(defun slime-help--qualify-cl-symbol-name (symbol-name &optional package)
"Qualify a Common Lisp SYMBOL-NAME using PACKAGE.
If SYMBOL-NAME is already qualified, nothing is done.
If PACKAGE is not given, SLIME-CURRENT-PACKAGE is used instead."
(let ((package (or package (slime-current-package))))
(if (cl-position ?: symbol-name)
;; already qualified
symbol-name
(format "%s::%s" package symbol-name))))
(defun slime-help--format-parsed-docstring (docstring _package)
(dolist (word docstring)
(cond
((stringp word) (insert (slime-help--propertize-docstring word)))
((and (listp word) (eql (cl-first word) :arg))
(insert (propertize (cl-second word) 'face 'slime-help-argument)))
((and (listp word) (eql (cl-first word) :fn))
(insert-button (cl-second word)
'action (lambda (_btn)
(slime-help-function (cl-third word)))
'follow-link t
'help-echo "Describe function"))
((and (listp word) (eql (cl-first word) :macro))
(insert-button (cl-second word)
'action (lambda (_btn)
(slime-help-macro (cl-third word)))
'follow-link t
'help-echo "Describe function"))
((and (listp word) (eql (cl-first word) :class))
(insert-button (cl-second word)
'action (lambda (_btn)
(slime-help-class (cl-third word)))
'follow-link t
'help-echo "Describe class"))
((and (listp word) (eql (cl-first word) :key))
(insert (propertize (cl-second word) 'face 'slime-help-keyword)))
((and (listp word) (eql (cl-first word) :var))
(insert-button (cl-second word)
'action (lambda (_btn)
(slime-help-variable (cl-third word)))
'follow-link t
'help-echo "Describe variable"))
((and (listp word) (eql (cl-first word) :special-operator))
(insert-button (cl-second word)
'action (lambda (_btn)
(slime-help-special-operator (cl-third word)))
'follow-link t
'help-echo "Describe special operator"))
(t (error "Don't know how to format: %s" word)))))
(defun slime-help-symbol (symbol-name)
"Open a help buffer for each kind of SYMBOL-NAME."
(interactive (list (slime-read-symbol-name "Describe symbol: ")))
(when (not symbol-name)
(error "No symbol given"))
(let ((symbol-infos (slime-eval `(swank-help:read-emacs-symbol-info (cl:read-from-string ,(slime-qualify-cl-symbol-name symbol-name))))))
(dolist (symbol-info symbol-infos)
(cl-case (cdr (assoc :type symbol-info))
(:function (slime-help-function symbol-name))
(:generic-function (slime-help-generic-function symbol-name))
(:macro (slime-help-macro symbol-name))
(:package (slime-help-package symbol-name))
(:variable (slime-help-variable symbol-name))
(:class (slime-help-class symbol-name))
(:special-operator (slime-help-special-operator symbol-name))
(t (error "TODO"))))))
;;(slime-help-symbol "ALEXANDRIA:FLATTEN")
;;(slime-help-symbol "ALEXANDRIA:WITH-GENSYMS")
(defun slime-help--first-line (string)
"Return the first line of the `STRING'."
(let ((pos (cl-position ?\n string)))
(if (null pos) string (cl-subseq string 0 pos))))
(defun slime-help--kill-current-buffer ()
(interactive)
(kill-buffer (current-buffer)))
(defun slime-help-quit ()
"Kill all slime-help buffers at once."
(interactive)
(mapcar 'kill-buffer
(cl-remove-if-not
(lambda (buffer)
(string-prefix-p "*slime-help" (buffer-name buffer)))
(buffer-list))))
(defun slime-help--open-buffer ()
(let ((buffer (current-buffer)))
(setq buffer-read-only t)
(local-set-key "q" 'slime-help--kill-current-buffer)
(buffer-disable-undo)
(set (make-local-variable 'kill-buffer-query-functions) nil)
(slime-mode)
(slime-help-mode)
(goto-char 0)
(pop-to-buffer buffer)))
(cl-defun slime-help-package (package-name)
"Display information about Common Lisp package named PACKAGE-NAME."
(interactive (list (slime-read-package-name "Describe package: ")))
(when (not package-name)
(error "No package name given"))
(let ((buffer-name (format "*slime-help: %s package*" package-name)))
(when (get-buffer buffer-name)
(pop-to-buffer buffer-name)
(cl-return-from slime-help-package))
(let* ((package-info (slime-eval `(swank-help:read-emacs-package-info ,package-name)))
(buffer (get-buffer-create buffer-name)))
(with-current-buffer buffer
(insert (slime-help--heading-1 (upcase (string-trim package-name))))
(newline 2)
(insert (format "This is a Common Lisp package with %d external symbols" (length (cdr (assoc :external-symbols package-info)))))
(newline 2)
(when (cdr (assoc :documentation package-info))
(insert (slime-help--propertize-docstring (cdr (assoc :documentation package-info))))
(newline 2))
(cl-flet ((goto-source (_btn)
(slime-edit-definition-other-window package-name)))
(insert-button "Source"
'action (function goto-source)
'face 'slime-help-button
'follow-link t
'help-echo "Go to package source code"))
(newline 2)
(insert (slime-help--heading-2 "Exported definitions"))
(newline 2)
(cl-flet ((format-exported-definition
(symbol-info)
(insert (propertize (cl-subseq (symbol-name (cdr (assoc :type symbol-info))) 1) 'face 'slime-help-type))
(insert " ")
(insert-button (format "%s" (cdr (assoc :name symbol-info)))
'action (lambda (_btn)
(slime-help-symbol (prin1-to-string (cdr (assoc :symbol symbol-info)))))
'follow-link t
'help-echo "Describe symbol")
(newline)
(if (cdr (assoc :documentation symbol-info))
(insert (slime-help--first-line (cdr (assoc :documentation symbol-info))))
(insert "Not documented"))
(newline)
(insert (slime-help--horizontal-line))
(newline)))
(let ((def-types '(("Variables" . :variable)
("Classes" . :class)
("Macros" . :macro)
("Functions" . :function)
("Generic functions" . :generic-function))))
(dolist (def-type def-types)
(let ((symbol-infos (cl-remove-if-not (lambda (x)
(cl-equalp (cdr (assoc :type x)) (cdr def-type)))
(cdr (assoc :external-symbols package-info)))))
(when symbol-infos
(insert (slime-help--heading-3 (car def-type)))
(newline 2)
(dolist (symbol-info symbol-infos)
(format-exported-definition symbol-info))
(newline 2))))))
(slime-help--open-buffer)
nil))))
;;(slime-help-package "ALEXANDRIA")
(cl-defun slime-help-packages ()
"Display information about Common Lisp packages."
(interactive)
(let ((buffer-name "*slime-help: COMMON LISP packages*"))
(when (get-buffer buffer-name)
(pop-to-buffer buffer-name)
(cl-return-from slime-help-packages))
(let* ((packages-info (slime-eval `(swank-help:read-emacs-packages-info)))
(buffer (get-buffer-create buffer-name)))
(with-current-buffer buffer
(dolist (package-info packages-info)
(let ((package-name (cdr (assoc :name package-info))))
(insert-button package-name
'action (lambda (btn)
(ignore btn)
(slime-help-package package-name))
'follow-link t
'help-echo "Describe package"))
(newline)
(when (cdr (assoc :documentation package-info))
(insert (slime-oneliner (cdr (assoc :documentation package-info))))
(newline)))
(slime-help--open-buffer)
nil))))
(cl-defun slime-help-systems ()
"Display information about registered ASDF systems."
(interactive)
(let ((buffer-name "*slime-help: registered ASDF systems*"))
(when (get-buffer buffer-name)
(pop-to-buffer buffer-name)
(cl-return-from slime-help-systems))
(let* ((systems-info (slime-eval `(swank-help:read-emacs-systems-info)))
(buffer (get-buffer-create buffer-name)))
(with-current-buffer buffer
(dolist (system-info systems-info)
(let ((cl-system-name (cdr (assoc :name system-info))))
(insert-button cl-system-name
'action (lambda (btn)
(ignore btn)
(slime-help-system cl-system-name))
'follow-link t
'help-echo "Describe system"))
(newline)
(when (cdr (assoc :documentation system-info))
(insert (cdr (assoc :documentation system-info)))
(newline)))
(slime-help--open-buffer)
nil))))
(defun slime-help-function (symbol-name)
"Display documentation about Common Lisp function bound to SYMBOL-NAME."
(interactive (list (slime-read-symbol-name "Describe function: ")))
(when (not symbol-name)
(error "No symbol given"))
(let ((symbol-info (slime-eval `(swank-help:read-emacs-symbol-info (cl:read-from-string ,(slime-qualify-cl-symbol-name symbol-name)) :function))))
(when (null symbol-info)
(error "Could not read symbol information %s" symbol-name))
(slime-help--funcallable symbol-name symbol-info :function)))
;; (slime-help-function "ALEXANDRIA:FLATTEN")
(defun slime-help-macro (symbol-name)
"Display documentation about Common Lisp macro bound to SYMBOL-NAME."
(interactive (list (slime-read-symbol-name "Describe macro: ")))
(when (not symbol-name)
(error "No symbol given"))
(let ((symbol-info (slime-eval `(swank-help:read-emacs-symbol-info (cl:read-from-string ,(slime-qualify-cl-symbol-name symbol-name)) :macro))))
(when (null symbol-info)
(error "Could not read symbol information: %s" symbol-name))
(slime-help--funcallable symbol-name symbol-info
:macro
'extra-buttons
(lambda ()
(cl-flet ((browse-expanders (btn)
(ignore btn)
(slime-who-macroexpands (prin1-to-string (cdr (assoc :symbol symbol-info))))))
(insert-button "Expanders"
'face 'slime-help-button
'action (function browse-expanders)
'follow-link t
'help-echo "Show all known expanders of the macro"))
(insert " ")))))
;; (slime-help-macro "ALEXANDRIA:WITH-GENSYMS")
(cl-defun slime-help-special-operator (symbol-name)
"Display documentation about Common Lisp macro bound to SYMBOL-NAME."
(interactive (list (slime-read-symbol-name "Describe special operator: ")))
(when (not symbol-name)
(error "No symbol given"))
(let ((symbol-info (slime-eval `(swank-help:read-emacs-symbol-info (cl:read-from-string ,(slime-qualify-cl-symbol-name symbol-name)) :special-operator))))
(when (null symbol-info)
(error "Could not read symbol information: %s" symbol-name))
(let ((buffer-name (format "*slime-help: %s special operator*" symbol-name)))
(when (get-buffer buffer-name)
(pop-to-buffer buffer-name)
(cl-return-from slime-help-special-operator))
(let* ((package-name (cdr (assoc :package symbol-info)))
(buffer (get-buffer-create buffer-name)))
(with-current-buffer buffer
(insert (slime-help--heading-1 (cdr (assoc :name symbol-info))))
(newline 2)
(insert (format "This is a special operator in package "))
(insert-button package-name
'action (lambda (btn)
(ignore btn)
(slime-help-package package-name))
'follow-link t
'help-echo "Describe package")
(when (cdr (assoc :documentation symbol-info))
(newline 2)
(slime-help--insert-documentation symbol-info)
(newline 2))
(when (cl-member (cdr (assoc :package symbol-info))
'("COMMON-LISP" "CL") :test 'cl-equalp)
(insert-button "Lookup in ANSICL spec"
'face 'slime-help-button
'action (lambda (_btn)
(funcall slime-help-ansicl-lookup-function
(prin1-to-string (cdr (assoc :symbol symbol-info)))))
'follow-link t
'help-echo "Lookup variable in ANSICL spec"))
(slime-help--open-buffer)
nil)))))
;; (slime-help-special-operator "CL:IF")
(defun slime-help-generic-function (symbol-name)
"Display documentation about Common Lisp generic function bound to SYMBOL-NAME."
(interactive (list (slime-read-symbol-name "Describe generic function: ")))
(when (not symbol-name)
(error "No symbol given"))
(let ((symbol-info (slime-eval `(swank-help:read-emacs-symbol-info (cl:read-from-string ,(slime-qualify-cl-symbol-name symbol-name)) :generic-function))))
(when (null symbol-info)
(error "Could not read symbol information %s" symbol-name))
(slime-help--funcallable
symbol-name symbol-info
:generic-function
'continuation
(lambda ()
(let ((methods (slime-find-definitions (slime-qualify-cl-symbol-name symbol-name))))
(newline 2)
(insert (slime-help--heading-2 "Methods"))
(newline 2)
(cl-loop for (label location) in methods do
(slime-insert-propertized
(list 'slime-location location
'face 'font-lock-keyword-face)
" " (slime-one-line-ify label) "\n")))
(slime-xref-mode)))))
;; (slime-help-generic-function "CL:PRINT-OBJECT")
;; TODO: remove the following function. I think it is better to implement individual functions for
;; each type of funcallable (macro, function, generic-functions), as they have significant differences.
(cl-defun slime-help--funcallable (symbol-name symbol-info function-type &rest args)
"Display documentation about CL funcallable FUNCTION-TYPE to SYMBOL-NAME.
SYMBOL-INFO contains the collected SWANK documentation.
ARGS contains additional arguments, like 'extra-buttons."
(let* ((function-type-name (cl-subseq (symbol-name function-type) 1))
(buffer-name (format "*slime-help: %s %s*" symbol-name function-type-name)))
(when (get-buffer buffer-name)
(pop-to-buffer buffer-name)
(cl-return-from slime-help--funcallable))
(let* ((package-name (cdr (assoc :package symbol-info)))
(buffer (get-buffer-create buffer-name)))
(with-current-buffer buffer
(insert (slime-help--heading-1 (cdr (assoc :name symbol-info))))
(newline 2)
(insert (format "This is a %s in package " function-type-name))
(insert-button package-name
'action (lambda (btn)
(ignore btn)
(slime-help-package package-name))
'follow-link t
'help-echo "Describe package")
(newline 2)
(insert (slime-help--heading-3 "Signature"))
(newline)
(insert (slime-help--highlight-syntax (cdr (assoc :args symbol-info))))
(newline 2)
(when (cdr (assoc :documentation symbol-info))
(slime-help--insert-documentation symbol-info)
(newline 2))
(cl-flet ((goto-source (btn)
(ignore btn)
(slime-edit-definition-other-window (prin1-to-string (cdr (assoc :symbol symbol-info))))))
(insert-button "Source"
'action (function goto-source)
'face 'slime-help-button
'follow-link t
'help-echo "Go to definition source code"))
(insert " ")
(cl-flet ((browse-references (_btn)
(slime-who-calls (prin1-to-string (cdr (assoc :symbol symbol-info))))))
(insert-button "References"
'action (function browse-references)
'face 'slime-help-button
'follow-link t
'help-echo "Browse references"))
(insert " ")
(cl-flet ((disassemble-function (_btn)
(slime-disassemble-symbol (prin1-to-string (cdr (assoc :symbol symbol-info))))))
(insert-button "Disassemble"
'action (function disassemble-function)
'face 'slime-help-button
'follow-link t
'help-echo "Disassemble function"))
(insert " ")
(when (cl-getf args 'extra-buttons)
(funcall (cl-getf args 'extra-buttons)))
(insert (slime-help--button "Lookup in manuals"
'slime-help-lookup-in-manuals-button
'symbol (cdr (assoc :symbol symbol-info))))
(insert " ")
(when (cl-member (cdr (assoc :package symbol-info))
'("COMMON-LISP" "CL") :test 'cl-equalp)
(insert-button "Lookup in ANSICL spec"
'face 'slime-help-button
'action (lambda (_btn)
(funcall slime-help-ansicl-lookup-function
(prin1-to-string (cdr (assoc :symbol symbol-info)))))
'follow-link t
'help-echo "Lookup variable in ANSICL spec"))
;; TODO: add a collapsible extra section with debugging actions, like toggle tracing, toggle profiling, perhaps disassemble too.
(when (cl-getf args 'continuation)
(funcall (cl-getf args 'continuation)))
(slime-help--open-buffer)
nil))))
;;(slime-help-function "CL:REMOVE")
;;(slime-help-function "ALEXANDRIA:FLATTEN")
;;(slime-help-function "SPLIT-SEQUENCE:SPLIT-SEQUENCE")
;;(slime-help-macro "ALEXANDRIA:WITH-GENSYMS")
(cl-defun slime-help-variable (symbol-name)
"Display documentation about Common Lisp variable bound to SYMBOL-NAME."
(interactive (list (slime-read-symbol-name "Describe variable: ")))
(when (not symbol-name)
(error "No symbol given"))
(let ((buffer-name (format "*slime-help: %s variable*" symbol-name)))
(when (get-buffer buffer-name)
(pop-to-buffer buffer-name)
(cl-return-from slime-help-variable))
(let* ((symbol-info (slime-eval `(swank-help:read-emacs-symbol-info (cl:read-from-string ,(slime-qualify-cl-symbol-name symbol-name)) :variable)))
(package-name (cdr (assoc :package symbol-info)))
(buffer (get-buffer-create buffer-name)))
(when (null symbol-info)
(error "Could not read variable info"))
(with-current-buffer buffer
(insert (slime-help--heading-1 (cdr (assoc :name symbol-info))))
(newline 2)
(insert (format "This is a VARIABLE in package "))
(insert-button package-name
'action (lambda (btn)
(ignore btn)
(slime-help-package package-name))
'follow-link t
'help-echo "Describe package")
(newline 2)
(when (cdr (assoc :documentation symbol-info))
(slime-help--insert-documentation symbol-info)
(newline 2))
(if (not (cdr (assoc :boundp symbol-info)))
(insert (slime-help--warning "The variable is UNBOUND"))
(progn
(insert (propertize "Value: " 'face 'bold))
(insert (slime-help--info (cdr (assoc :value symbol-info))))))
(newline 2)
(cl-flet ((goto-source (btn)
(ignore btn)
(slime-edit-definition-other-window (prin1-to-string (cdr (assoc :symbol symbol-info))))))
(insert-button "Source"
'action (function goto-source)
'face 'slime-help-button
'follow-link t
'help-echo "Go to definition source code"))
(insert " ")
(cl-flet ((browse-references (_btn)
(slime-who-references (prin1-to-string (cdr (assoc :symbol symbol-info))))))
(insert-button "References"
'face 'slime-help-button
'action (function browse-references)
'follow-link t
'help-echo "Browse references"))
(insert " ")
(cl-flet ((browse-binders (_btn)
(slime-who-binds (prin1-to-string (cdr (assoc :symbol symbol-info))))))
(insert-button "Binders"
'face 'slime-help-button
'action (function browse-binders)
'follow-link t
'help-echo "Show all known binders of the global variable"))
(insert " ")
(cl-flet ((browse-setters (_btn)
(slime-who-sets (prin1-to-string (cdr (assoc :symbol symbol-info))))))
(insert-button "Setters"
'face 'slime-help-button
'action (function browse-setters)
'follow-link t
'help-echo "Show all known setters of the global variable"))
(insert " ")
(insert (slime-help--button "Lookup in manuals"
'slime-help-lookup-in-manuals-button
'symbol (cdr (assoc :symbol symbol-info))))
(insert " ")
(when (cl-member (cdr (assoc :package symbol-info))
'("COMMON-LISP" "CL") :test 'cl-equalp)
(insert-button "Lookup in ANSICL spec"
'face 'slime-help-button
'action (lambda (_btn)
(funcall slime-help-ansicl-lookup-function
(prin1-to-string (cdr (assoc :symbol symbol-info)))))
'follow-link t
'help-echo "Lookup variable in ANSICL spec"))
(slime-help--open-buffer)
nil))))
;; (slime-help-variable "*STANDARD-OUTPUT*")
(cl-defun slime-help-class (symbol-name)
"Display documentation about Common Lisp class bound to SYMBOL-NAME."
(interactive (list (slime-read-symbol-name "Describe class: ")))
(when (not symbol-name)
(error "No symbol given"))
(let ((buffer-name (format "*slime-help: %s class*" symbol-name)))
(when (get-buffer buffer-name)
(pop-to-buffer buffer-name)
(cl-return-from slime-help-class))
(let* ((symbol-info (slime-eval `(swank-help:read-emacs-symbol-info (cl:read-from-string ,(slime-qualify-cl-symbol-name symbol-name)) :class)))
(package-name (cdr (assoc :package symbol-info)))
(buffer (get-buffer-create buffer-name)))
(when (null symbol-info)
(error "Could not read class info"))
(with-current-buffer buffer
(insert (slime-help--heading-1 (cdr (assoc :name symbol-info))))
(newline 2)
(insert (format "This is a CLASS in package "))
(insert-button package-name
'action (lambda (_btn)
(slime-help-package package-name))
'follow-link t
'help-echo "Describe package")
(newline 2)
(when (cdr (assoc :documentation symbol-info))
(slime-help--insert-documentation symbol-info)
(newline 2))
;; buttons
(cl-flet ((goto-source (_btn)
(slime-edit-definition-other-window (prin1-to-string (cdr (assoc :symbol symbol-info))))))
(insert-button "Source"
'face 'slime-help-button
'action (function goto-source)
'follow-link t
'help-echo "Go to definition source code"))
(insert " ")
(cl-flet ((browse-references (_btn)
(slime-who-references (prin1-to-string (cdr (assoc :symbol symbol-info))))))
(insert-button "References"
'face 'slime-help-button
'action (function browse-references)
'follow-link t
'help-echo "Browse references"))
(insert " ")
(insert (slime-help--button "Lookup in manuals"
'slime-help-lookup-in-manuals-button
'symbol (cdr (assoc :symbol symbol-info))))
(insert " ")
(when (cl-member (cdr (assoc :package symbol-info))
'("COMMON-LISP" "CL") :test 'cl-equalp)
(insert-button "Lookup in ANSICL spec"
'face 'slime-help-button
'action (lambda (_btn)
(funcall slime-help-ansicl-lookup-function
(prin1-to-string (cdr (assoc :symbol symbol-info)))))
'follow-link t
'help-echo "Lookup variable in ANSICL spec"))
(newline 2)
(insert (slime-help--heading-2 "Direct superclasses"))
(newline 2)
(dolist (class-name (cdr (assoc :direct-superclasses symbol-info)))
(insert-button (upcase (symbol-name class-name))
'action (lambda (_btn)
(slime-help-class (symbol-name class-name)))
'follow-link t
'help-echo "Describe class")
(insert " "))
(newline 2)
;; TODO: show a collapsable (outline-mode?) section with more information about the class
;; like class descendants and list of subclasses
;; let's show direct-subclasses for now, with a limit
(let ((max-subclasses 25)
(subclasses (cdr (assoc :direct-subclasses symbol-info))))
(when (not (zerop (length subclasses)))
(insert (slime-help--heading-2 "Direct subclasses"))
(newline 2)
(dolist (class-name (cl-subseq subclasses 0 (min max-subclasses (length subclasses))))
(insert-button (upcase (symbol-name class-name))
'action (lambda (_btn)
(slime-help-class (symbol-name class-name)))
'follow-link t
'help-echo "Describe class")
(insert " "))
(when (> (length subclasses) max-subclasses)
(insert "and more"))
(newline 2)))
;; TODO: show more information about slots
(let ((slots (cdr (assoc :slots symbol-info))))
(insert (slime-help--heading-2 "Slots"))
(newline 2)
(if (zerop (length slots))
(progn (insert "No slots") (newline))
(dolist (slot slots)
(insert (propertize (format "- %s" (cdr (assoc :name slot))) 'face 'bold))
(newline)
(when (cdr (assoc :documentation slot))
(slime-help--insert-documentation slot (cdr (assoc :package symbol-info)))
(newline))))
(newline))
(let ((methods-start (point))
(methods (cdr (assoc :methods symbol-info))))
(insert (slime-help--heading-2 "Methods"))
(make-text-button methods-start (point)
'action (lambda (_btn)
(goto-char methods-start)
(outline-toggle-children))
'follow-link t)
(newline 2)
(if (zerop (length methods))
(insert "No methods")
(dolist (symbol-info methods)
(insert-button (format "%s" (upcase (prin1-to-string (cdr (assoc :name symbol-info)))))
'action (lambda (_btn)
(slime-help-symbol (prin1-to-string (cdr (assoc :name symbol-info)))))
'follow-link t
'help-echo "Describe symbol")
(newline)
(if (cdr (assoc :documentation symbol-info))
(insert (slime-help--first-line (cdr (assoc :documentation symbol-info))))
(insert "Not documented"))
(newline)
(insert (slime-help--horizontal-line))
(newline))))
;; Outlines configuration
;;(setq outline-regexp "Methods")
;;(outline-minor-mode)
;;(outline-hide-body)
(slime-help--open-buffer)
nil))))
;;(slime-help-class "HUNCHENTOOT:ACCEPTOR")
;; This was copied from help.el
(defun slime-help--highlight-syntax (source &optional mode)
"Return a propertized version of SOURCE in MODE."
(unless mode
(setq mode #'lisp-mode))
(if (or
(< (length source) 5000)
(eq mode 'emacs-lisp-mode))
(with-temp-buffer
(insert source)
;; Switch to major-mode MODE, but don't run any hooks.
(delay-mode-hooks (funcall mode))
;; `delayed-mode-hooks' contains mode hooks like
;; `emacs-lisp-mode-hook'. Build a list of functions that are run
;; when the mode hooks run.
(let (hook-funcs)
(dolist (hook delayed-mode-hooks)
(let ((funcs (symbol-value hook)))
(setq hook-funcs (append hook-funcs funcs)))))
(if (fboundp 'font-lock-ensure)
(font-lock-ensure)
(with-no-warnings
(font-lock-fontify-buffer)))
(buffer-string))
;; SOURCE was too long to highlight in a reasonable amount of
;; time.
source))
(cl-defun slime-help-system (cl-system-name)
"Display documentation about ASDF system named CL-SYSTEM-NAME."
(interactive (list (slime-read-system-name "Describe system")))
(when (not cl-system-name)
(error "No system name given"))
(let ((buffer-name (format "*slime-help: %s system*" cl-system-name)))
(when (get-buffer buffer-name)
(pop-to-buffer buffer-name)
(cl-return-from slime-help-system))
(let* ((system-info (slime-eval `(swank-help:read-emacs-system-info ,cl-system-name)))
(buffer (get-buffer-create buffer-name)))
(with-current-buffer buffer
(insert (slime-help--heading-1 (upcase cl-system-name)))
(newline 2)
(insert (format "This is a Common Lisp ASDF system with %d dependencies" (length (cdr (assoc :dependencies system-info)))))
(newline)
(if (cdr (assoc :loaded-p system-info))
(insert (slime-help--info "This system is already loaded."))
(insert (slime-help--error "This system is not loaded.")))
(newline 2)
(when (cdr (assoc :documentation system-info))
(insert (slime-help--propertize-docstring (cdr (assoc :documentation system-info))))
(newline 2))
;; buttons
(cl-flet ((browse-system (_btn)
(slime-browse-system cl-system-name)))
(insert-button "Browse"
'action (function browse-system)
'follow-link t
'help-echo "Browse system"))
(insert " ")
(when (not (cdr (assoc :loaded-p system-info)))
(cl-flet ((load-system (_btn)
(slime-load-system cl-system-name)))
(insert-button "Load"
'action (function load-system)
'follow-link t
'help-echo "Load system")))
(newline 2)
(insert (slime-help--heading-2 "Dependencies"))
(newline 2)
(if (zerop (length (cdr (assoc :dependencies system-info))))
(insert "It has no dependencies")
;; else
(dolist (dependency (cdr (assoc :dependencies system-info)))
(insert "* ")
(insert-button dependency
'action (lambda (_btn)
(slime-help-system dependency))
'follow-link t
'help-echo "Describe system")
(newline)))
(when (and (cdr (assoc :loaded-p system-info))
(cdr (assoc :packages system-info)))
(newline 2)
(insert (slime-help--heading-2 "Packages"))
(newline 2)
(dolist (package-name (cdr (assoc :packages system-info)))
(insert-button package-name
'action (lambda (_btn)
(slime-help-package package-name))
'follow-link t
'help-echo "Describe package")
(insert " ")))