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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
| | ;;; apropos.el --- apropos commands for users and programmers
;; Copyright (C) 1989, 1994-1995, 2001-2015 Free Software Foundation,
;; Inc.
;; Author: Joe Wells <jbw@bigbird.bu.edu>
;; Daniel Pfeiffer <occitan@esperanto.org> (rewrite)
;; Keywords: help
;; Package: emacs
;; This file is part of GNU Emacs.
;; GNU Emacs 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.
;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; The ideas for this package were derived from the C code in
;; src/keymap.c and elsewhere. The functions in this file should
;; always be byte-compiled for speed. Someone should rewrite this in
;; C (as part of src/keymap.c) for speed.
;; The idea for super-apropos is based on the original implementation
;; by Lynn Slater <lrs@esl.com>.
;; History:
;; Fixed bug, current-local-map can return nil.
;; Change, doesn't calculate key-bindings unless needed.
;; Added super-apropos capability, changed print functions.
;; Made fast-apropos and super-apropos share code.
;; Sped up fast-apropos again.
;; Added apropos-do-all option.
;; Added fast-command-apropos.
;; Changed doc strings to comments for helping functions.
;; Made doc file buffer read-only, buried it.
;; Only call substitute-command-keys if do-all set.
;; Optionally use configurable faces to make the output more legible.
;; Differentiate between command, function and macro.
;; Apropos-command (ex command-apropos) does cmd and optionally user var.
;; Apropos shows all 3 aspects of symbols (fn, var and plist)
;; Apropos-documentation (ex super-apropos) now finds all it should.
;; New apropos-value snoops through all values and optionally plists.
;; Reading DOC file doesn't load nroff.
;; Added hypertext following of documentation, mouse-2 on variable gives value
;; from buffer in active window.
;;; Code:
(require 'button)
(defgroup apropos nil
"Apropos commands for users and programmers."
:group 'help
:prefix "apropos")
;; I see a degradation of maybe 10-20% only.
(defcustom apropos-do-all nil
"Non nil means apropos commands will search more extensively.
This may be slower. This option affects the following commands:
`apropos-user-option' will search all variables, not just user options.
`apropos-command' will also search non-interactive functions.
`apropos' will search all symbols, not just functions, variables, faces,
and those with property lists.
`apropos-value' will also search in property lists and functions.
`apropos-documentation' will search all documentation strings, not just
those in the etc/DOC documentation file.
This option only controls the default behavior. Each of the above
commands also has an optional argument to request a more extensive search.
Additionally, this option makes the function `apropos-library'
include key-binding information in its output."
:group 'apropos
:type 'boolean)
(defface apropos-symbol
'((t (:inherit bold)))
"Face for the symbol name in Apropos output."
:group 'apropos
:version "24.3")
(defface apropos-keybinding
'((t (:inherit underline)))
"Face for lists of keybinding in Apropos output."
:group 'apropos
:version "24.3")
(defface apropos-property
'((t (:inherit font-lock-builtin-face)))
"Face for property name in Apropos output, or nil for none."
:group 'apropos
:version "24.3")
(defface apropos-function-button
'((t (:inherit (font-lock-function-name-face button))))
"Button face indicating a function, macro, or command in Apropos."
:group 'apropos
:version "24.3")
(defface apropos-variable-button
'((t (:inherit (font-lock-variable-name-face button))))
"Button face indicating a variable in Apropos."
:group 'apropos
:version "24.3")
(defface apropos-user-option-button
'((t (:inherit (font-lock-variable-name-face button))))
"Button face indicating a user option in Apropos."
:group 'apropos
:version "24.4")
(defface apropos-misc-button
'((t (:inherit (font-lock-constant-face button))))
"Button face indicating a miscellaneous object type in Apropos."
:group 'apropos
:version "24.3")
(defcustom apropos-match-face 'match
"Face for matching text in Apropos documentation/value, or nil for none.
This applies when you look for matches in the documentation or variable value
for the pattern; the part that matches gets displayed in this font."
:type '(choice (const nil) face)
:group 'apropos
:version "24.3")
(defcustom apropos-sort-by-scores nil
"Non-nil means sort matches by scores; best match is shown first.
This applies to all `apropos' commands except `apropos-documentation'.
If value is `verbose', the computed score is shown for each match."
:group 'apropos
:type '(choice (const :tag "off" nil)
(const :tag "on" t)
(const :tag "show scores" verbose)))
(defcustom apropos-documentation-sort-by-scores t
"Non-nil means sort matches by scores; best match is shown first.
This applies to `apropos-documentation' only.
If value is `verbose', the computed score is shown for each match."
:group 'apropos
:type '(choice (const :tag "off" nil)
(const :tag "on" t)
(const :tag "show scores" verbose)))
(defvar apropos-mode-map
(let ((map (copy-keymap button-buffer-map)))
(set-keymap-parent map special-mode-map)
;; Use `apropos-follow' instead of just using the button
;; definition of RET, so that users can use it anywhere in an
;; apropos item, not just on top of a button.
(define-key map "\C-m" 'apropos-follow)
map)
"Keymap used in Apropos mode.")
(defvar apropos-mode-hook nil
"Hook run when mode is turned on.")
(defvar apropos-pattern nil
"Apropos pattern as entered by user.")
(defvar apropos-pattern-quoted nil
"Apropos pattern passed through `regexp-quote'.")
(defvar apropos-words ()
"Current list of apropos words extracted from `apropos-pattern'.")
(defvar apropos-all-words ()
"Current list of words and synonyms.")
(defvar apropos-regexp nil
"Regexp used in current apropos run.")
(defvar apropos-all-words-regexp nil
"Regexp matching `apropos-all-words'.")
(defvar apropos-files-scanned ()
"List of elc files already scanned in current run of `apropos-documentation'.")
(defvar apropos-accumulator ()
"Alist of symbols already found in current apropos run.
Each element has the form
(SYMBOL SCORE FUN-DOC VAR-DOC PLIST WIDGET-DOC FACE-DOC CUS-GROUP-DOC)
where SYMBOL is the symbol name, SCORE is its relevance score (a
number), FUN-DOC is the function docstring, VAR-DOC is the
variable docstring, PLIST is the list of the symbols names in the
property list, WIDGET-DOC is the widget docstring, FACE-DOC is
the face docstring, and CUS-GROUP-DOC is the custom group
docstring. Each docstring is either nil or a string.")
(defvar apropos-item ()
"Current item in or for `apropos-accumulator'.")
(defvar apropos-synonyms '(
("find" "open" "edit")
("kill" "cut")
("yank" "paste")
("region" "selection"))
"List of synonyms known by apropos.
Each element is a list of words where the first word is the standard Emacs
term, and the rest of the words are alternative terms.")
\f
;;; Button types used by apropos
(define-button-type 'apropos-symbol
'face 'apropos-symbol
'help-echo "mouse-2, RET: Display more help on this symbol"
'follow-link t
'action #'apropos-symbol-button-display-help)
(defun apropos-symbol-button-display-help (button)
"Display further help for the `apropos-symbol' button BUTTON."
(button-activate
(or (apropos-next-label-button (button-start button))
(error "There is nothing to follow for `%s'" (button-label button)))))
(define-button-type 'apropos-function
'apropos-label "Function"
'apropos-short-label "f"
'face 'apropos-function-button
'help-echo "mouse-2, RET: Display more help on this function"
'follow-link t
'action (lambda (button)
(describe-function (button-get button 'apropos-symbol))))
(define-button-type 'apropos-macro
'apropos-label "Macro"
'apropos-short-label "m"
'face 'apropos-function-button
'help-echo "mouse-2, RET: Display more help on this macro"
'follow-link t
'action (lambda (button)
(describe-function (button-get button 'apropos-symbol))))
(define-button-type 'apropos-command
'apropos-label "Command"
'apropos-short-label "c"
'face 'apropos-function-button
'help-echo "mouse-2, RET: Display more help on this command"
'follow-link t
'action (lambda (button)
(describe-function (button-get button 'apropos-symbol))))
;; We used to use `customize-variable-other-window' instead for a
;; customizable variable, but that is slow. It is better to show an
;; ordinary help buffer and let the user click on the customization
;; button in that buffer, if he wants to.
;; Likewise for `customize-face-other-window'.
(define-button-type 'apropos-variable
'apropos-label "Variable"
'apropos-short-label "v"
'face 'apropos-variable-button
'help-echo "mouse-2, RET: Display more help on this variable"
'follow-link t
'action (lambda (button)
(describe-variable (button-get button 'apropos-symbol))))
(define-button-type 'apropos-user-option
'apropos-label "User option"
'apropos-short-label "o"
'face 'apropos-user-option-button
'help-echo "mouse-2, RET: Display more help on this user option"
'follow-link t
'action (lambda (button)
(describe-variable (button-get button 'apropos-symbol))))
(define-button-type 'apropos-face
'apropos-label "Face"
'apropos-short-label "F"
'face '(font-lock-variable-name-face button)
'help-echo "mouse-2, RET: Display more help on this face"
'follow-link t
'action (lambda (button)
(describe-face (button-get button 'apropos-symbol))))
(define-button-type 'apropos-group
'apropos-label "Group"
'apropos-short-label "g"
'face 'apropos-misc-button
'help-echo "mouse-2, RET: Display more help on this group"
'follow-link t
'action (lambda (button)
(customize-group-other-window
(button-get button 'apropos-symbol))))
(define-button-type 'apropos-widget
'apropos-label "Widget"
'apropos-short-label "w"
'face 'apropos-misc-button
'help-echo "mouse-2, RET: Display more help on this widget"
'follow-link t
'action (lambda (button)
(widget-browse-other-window (button-get button 'apropos-symbol))))
(define-button-type 'apropos-plist
'apropos-label "Properties"
'apropos-short-label "p"
'face 'apropos-misc-button
'help-echo "mouse-2, RET: Display more help on this plist"
'follow-link t
'action (lambda (button)
(apropos-describe-plist (button-get button 'apropos-symbol))))
(define-button-type 'apropos-library
'help-echo "mouse-2, RET: Display more help on this library"
'follow-link t
'action (lambda (button)
(apropos-library (button-get button 'apropos-symbol))))
(defun apropos-next-label-button (pos)
"Return the next apropos label button after POS, or nil if there's none.
Will also return nil if more than one `apropos-symbol' button is encountered
before finding a label."
(let* ((button (next-button pos t))
(already-hit-symbol nil)
(label (and button (button-get button 'apropos-label)))
(type (and button (button-get button 'type))))
(while (and button
(not label)
(or (not (eq type 'apropos-symbol))
(not already-hit-symbol)))
(when (eq type 'apropos-symbol)
(setq already-hit-symbol t))
(setq button (next-button (button-start button)))
(when button
(setq label (button-get button 'apropos-label))
(setq type (button-get button 'type))))
(and label button)))
\f
(defun apropos-words-to-regexp (words wild)
"Make regexp matching any two of the words in WORDS.
WILD should be a subexpression matching wildcards between matches."
(setq words (delete-dups (copy-sequence words)))
(if (null (cdr words))
(car words)
(mapconcat
(lambda (w)
(concat "\\(?:" w "\\)" ;; parens for synonyms
wild "\\(?:"
(mapconcat 'identity
(delq w (copy-sequence words))
"\\|")
"\\)"))
words
"\\|")))
;;;###autoload
(defun apropos-read-pattern (subject)
"Read an apropos pattern, either a word list or a regexp.
Returns the user pattern, either a list of words which are matched
literally, or a string which is used as a regexp to search for.
SUBJECT is a string that is included in the prompt to identify what
kind of objects to search."
(let ((pattern
(read-string (concat "Search for " subject " (word list or regexp): "))))
(if (string-equal (regexp-quote pattern) pattern)
;; Split into words
(or (split-string pattern "[ \t]+" t)
(user-error "No word list given"))
pattern)))
(defun apropos-parse-pattern (pattern)
"Rewrite a list of words to a regexp matching all permutations.
If PATTERN is a string, that means it is already a regexp.
This updates variables `apropos-pattern', `apropos-pattern-quoted',
`apropos-regexp', `apropos-words', and `apropos-all-words-regexp'."
(setq apropos-words nil
apropos-all-words nil)
(if (consp pattern)
;; We don't actually make a regexp matching all permutations.
;; Instead, for e.g. "a b c", we make a regexp matching
;; any combination of two or more words like this:
;; (a|b|c).*(a|b|c) which may give some false matches,
;; but as long as it also gives the right ones, that's ok.
(let ((words pattern))
(setq apropos-pattern (mapconcat 'identity pattern " ")
apropos-pattern-quoted (regexp-quote apropos-pattern))
(dolist (word words)
(let ((syn apropos-synonyms) (s word) (a word))
(while syn
(if (member word (car syn))
(progn
(setq a (mapconcat 'identity (car syn) "\\|"))
(if (member word (cdr (car syn)))
(setq s a))
(setq syn nil))
(setq syn (cdr syn))))
(setq apropos-words (cons s apropos-words)
apropos-all-words (cons a apropos-all-words))))
(setq apropos-all-words-regexp
(apropos-words-to-regexp apropos-all-words ".+"))
(setq apropos-regexp
(apropos-words-to-regexp apropos-words ".*?")))
(setq apropos-pattern-quoted (regexp-quote pattern)
apropos-all-words-regexp pattern
apropos-pattern pattern
apropos-regexp pattern)))
(defun apropos-calc-scores (str words)
"Return apropos scores for string STR matching WORDS.
Value is a list of offsets of the words into the string."
(let (scores i)
(if words
(dolist (word words scores)
(if (setq i (string-match word str))
(setq scores (cons i scores))))
;; Return list of start and end position of regexp
(and (string-match apropos-pattern str)
(list (match-beginning 0) (match-end 0))))))
(defun apropos-score-str (str)
"Return apropos score for string STR."
(if str
(let* ((l (length str))
(score (- (/ l 10))))
(dolist (s (apropos-calc-scores str apropos-all-words) score)
(setq score (+ score 1000 (/ (* (- l s) 1000) l)))))
0))
(defun apropos-score-doc (doc)
"Return apropos score for documentation string DOC."
(let ((l (length doc)))
(if (> l 0)
(let ((score 0))
(when (string-match apropos-pattern-quoted doc)
(setq score 10000))
(dolist (s (apropos-calc-scores doc apropos-all-words) score)
(setq score (+ score 50 (/ (* (- l s) 50) l)))))
0)))
(defun apropos-score-symbol (symbol &optional weight)
"Return apropos score for SYMBOL."
(setq symbol (symbol-name symbol))
(let ((score 0)
(l (length symbol)))
(dolist (s (apropos-calc-scores symbol apropos-words) (* score (or weight 3)))
(setq score (+ score (- 60 l) (/ (* (- l s) 60) l))))))
(defun apropos-true-hit (str words)
"Return t if STR is a genuine hit.
This may fail if only one of the keywords is matched more than once.
This requires at least two keywords (unless only one was given)."
(or (not str)
(not words)
(not (cdr words))
(> (length (apropos-calc-scores str words)) 1)))
(defun apropos-false-hit-symbol (symbol)
"Return t if SYMBOL is not really matched by the current keywords."
(not (apropos-true-hit (symbol-name symbol) apropos-words)))
(defun apropos-false-hit-str (str)
"Return t if STR is not really matched by the current keywords."
(not (apropos-true-hit str apropos-words)))
(defun apropos-true-hit-doc (doc)
"Return t if DOC is really matched by the current keywords."
(apropos-true-hit doc apropos-all-words))
(define-derived-mode apropos-mode special-mode "Apropos"
"Major mode for following hyperlinks in output of apropos commands.
\\{apropos-mode-map}")
(defvar apropos-multi-type t
"If non-nil, this apropos query concerns multiple types.
This is used to decide whether to print the result's type or not.")
;;;###autoload
(defun apropos-user-option (pattern &optional do-all)
"Show user options that match PATTERN.
PATTERN can be a word, a list of words (separated by spaces),
or a regexp (using some regexp special characters). If it is a word,
search for matches for that word as a substring. If it is a list of words,
search for matches for any two (or more) of those words.
With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also show
variables, not just user options."
(interactive (list (apropos-read-pattern
(if (or current-prefix-arg apropos-do-all)
"variable" "user option"))
current-prefix-arg))
(apropos-command pattern nil
(if (or do-all apropos-do-all)
#'(lambda (symbol)
(and (boundp symbol)
(get symbol 'variable-documentation)))
'custom-variable-p)))
;;;###autoload
(defun apropos-variable (pattern &optional do-not-all)
"Show variables that match PATTERN.
When DO-NOT-ALL is non-nil, show user options only, i.e. behave
like `apropos-user-option'."
(interactive (list (apropos-read-pattern
(if current-prefix-arg "user option" "variable"))
current-prefix-arg))
(let ((apropos-do-all (if do-not-all nil t)))
(apropos-user-option pattern)))
;; For auld lang syne:
;;;###autoload
(defalias 'command-apropos 'apropos-command)
;;;###autoload
(defun apropos-command (pattern &optional do-all var-predicate)
"Show commands (interactively callable functions) that match PATTERN.
PATTERN can be a word, a list of words (separated by spaces),
or a regexp (using some regexp special characters). If it is a word,
search for matches for that word as a substring. If it is a list of words,
search for matches for any two (or more) of those words.
With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also show
noninteractive functions.
If VAR-PREDICATE is non-nil, show only variables, and only those that
satisfy the predicate VAR-PREDICATE.
When called from a Lisp program, a string PATTERN is used as a regexp,
while a list of strings is used as a word list."
(interactive (list (apropos-read-pattern
(if (or current-prefix-arg apropos-do-all)
"command or function" "command"))
current-prefix-arg))
(apropos-parse-pattern pattern)
(let ((message
(let ((standard-output (get-buffer-create "*Apropos*")))
(help-print-return-message 'identity))))
(or do-all (setq do-all apropos-do-all))
(setq apropos-accumulator
(apropos-internal apropos-regexp
(or var-predicate
;; We used to use `functionp' here, but this
;; rules out macros. `fboundp' rules in
;; keymaps, but it seems harmless.
(if do-all 'fboundp 'commandp))))
(let ((tem apropos-accumulator))
(while tem
(if (or (get (car tem) 'apropos-inhibit)
(apropos-false-hit-symbol (car tem)))
(setq apropos-accumulator (delq (car tem) apropos-accumulator)))
(setq tem (cdr tem))))
(let ((p apropos-accumulator)
doc symbol score)
(while p
(setcar p (list
(setq symbol (car p))
(setq score (apropos-score-symbol symbol))
(unless var-predicate
(if (fboundp symbol)
(if (setq doc (condition-case nil
(documentation symbol t)
(error 'error)))
;; Eg alias to undefined function.
(if (eq doc 'error)
"(documentation error)"
(setq score (+ score (apropos-score-doc doc)))
(substring doc 0 (string-match "\n" doc)))
"(not documented)")))
(and var-predicate
(funcall var-predicate symbol)
(if (setq doc (documentation-property
symbol 'variable-documentation t))
(progn
(setq score (+ score (apropos-score-doc doc)))
(substring doc 0
(string-match "\n" doc)))))))
(setcar (cdr (car p)) score)
(setq p (cdr p))))
(and (let ((apropos-multi-type do-all))
(apropos-print t nil nil t))
message
(message "%s" message))))
;;;###autoload
(defun apropos-documentation-property (symbol property raw)
"Like (documentation-property SYMBOL PROPERTY RAW) but handle errors."
(condition-case ()
(let ((doc (documentation-property symbol property raw)))
(if doc (substring doc 0 (string-match "\n" doc))
"(not documented)"))
(error "(error retrieving documentation)")))
;;;###autoload
(defun apropos (pattern &optional do-all)
"Show all meaningful Lisp symbols whose names match PATTERN.
Symbols are shown if they are defined as functions, variables, or
faces, or if they have nonempty property lists.
PATTERN can be a word, a list of words (separated by spaces),
or a regexp (using some regexp special characters). If it is a word,
search for matches for that word as a substring. If it is a list of words,
search for matches for any two (or more) of those words.
With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil,
consider all symbols (if they match PATTERN).
Returns list of symbols and documentation found."
(interactive (list (apropos-read-pattern "symbol")
current-prefix-arg))
(apropos-parse-pattern pattern)
(apropos-symbols-internal
(apropos-internal apropos-regexp
(and (not do-all)
(not apropos-do-all)
(lambda (symbol)
(or (fboundp symbol)
(boundp symbol)
(facep symbol)
(symbol-plist symbol)))))
(or do-all apropos-do-all)))
(defun apropos-library-button (sym)
(if (null sym)
"<nothing>"
(let ((name (copy-sequence (symbol-name sym))))
(make-text-button name nil
'type 'apropos-library
'face 'apropos-symbol
'apropos-symbol name)
name)))
;;;###autoload
(defun apropos-library (file)
"List the variables and functions defined by library FILE.
FILE should be one of the libraries currently loaded and should
thus be found in `load-history'. If `apropos-do-all' is non-nil,
the output includes key-bindings of commands."
(interactive
(let* ((libs (delq nil (mapcar 'car load-history)))
(libs
(nconc (delq nil
(mapcar
(lambda (l)
(setq l (file-name-nondirectory l))
(while
(not (equal (setq l (file-name-sans-extension l))
l)))
l)
libs))
libs)))
(list (completing-read "Describe library: " libs nil t))))
(let ((symbols nil)
;; (autoloads nil)
(provides nil)
(requires nil)
(lh-entry (assoc file load-history)))
(unless lh-entry
;; `file' may be the "shortname".
(let ((lh load-history)
(re (concat "\\(?:\\`\\|[\\/]\\)" (regexp-quote file)
"\\(\\.\\|\\'\\)")))
(while (and lh (null lh-entry))
(if (and (caar lh) (string-match re (caar lh)))
(setq lh-entry (car lh))
(setq lh (cdr lh)))))
(unless lh-entry (error "Unknown library `%s'" file)))
(dolist (x (cdr lh-entry))
(pcase (car-safe x)
;; (autoload (push (cdr x) autoloads))
(`require (push (cdr x) requires))
(`provide (push (cdr x) provides))
(_ (push (or (cdr-safe x) x) symbols))))
(let ((apropos-pattern "")) ;Dummy binding for apropos-symbols-internal.
(apropos-symbols-internal
symbols apropos-do-all
(concat
(format "Library `%s' provides: %s\nand requires: %s"
file
(mapconcat 'apropos-library-button
(or provides '(nil)) " and ")
(mapconcat 'apropos-library-button
(or requires '(nil)) " and ")))))))
(defun apropos-symbols-internal (symbols keys &optional text)
;; Filter out entries that are marked as apropos-inhibit.
(let ((all nil))
(dolist (symbol symbols)
(unless (get symbol 'apropos-inhibit)
(push symbol all)))
(setq symbols all))
(let ((apropos-accumulator
(mapcar
(lambda (symbol)
(let (doc properties)
(list
symbol
(apropos-score-symbol symbol)
(when (fboundp symbol)
(if (setq doc (condition-case nil
(documentation symbol t)
(void-function
"(alias for undefined function)")
(error
"(can't retrieve function documentation)")))
(substring doc 0 (string-match "\n" doc))
"(not documented)"))
(when (boundp symbol)
(apropos-documentation-property
symbol 'variable-documentation t))
(when (setq properties (symbol-plist symbol))
(setq doc (list (car properties)))
(while (setq properties (cdr (cdr properties)))
(setq doc (cons (car properties) doc)))
(mapconcat (lambda (p) (format "%s" p)) (nreverse doc) " "))
(when (get symbol 'widget-type)
(apropos-documentation-property
symbol 'widget-documentation t))
(when (facep symbol)
(let ((alias (get symbol 'face-alias)))
(if alias
(if (facep alias)
(format "%slias for the face `%s'."
(if (get symbol 'obsolete-face)
"Obsolete a"
"A")
alias)
;; Never happens in practice because fails
;; (facep symbol) test.
"(alias for undefined face)")
(apropos-documentation-property
symbol 'face-documentation t))))
(when (get symbol 'custom-group)
(apropos-documentation-property
symbol 'group-documentation t)))))
symbols)))
(apropos-print keys nil text)))
;;;###autoload
(defun apropos-value (pattern &optional do-all)
"Show all symbols whose value's printed representation matches PATTERN.
PATTERN can be a word, a list of words (separated by spaces),
or a regexp (using some regexp special characters). If it is a word,
search for matches for that word as a substring. If it is a list of words,
search for matches for any two (or more) of those words.
With \\[universal-argument] prefix, or if `apropos-do-all' is non-nil, also looks
at function definitions (arguments, documentation and body) and at the
names and values of properties.
Returns list of symbols and values found."
(interactive (list (apropos-read-pattern "value")
current-prefix-arg))
(apropos-parse-pattern pattern)
(or do-all (setq do-all apropos-do-all))
(setq apropos-accumulator ())
(let (f v p)
(mapatoms
(lambda (symbol)
(setq f nil v nil p nil)
(or (memq symbol '(apropos-regexp
apropos-pattern apropos-all-words-regexp
apropos-words apropos-all-words
do-all apropos-accumulator
symbol f v p))
(setq v (apropos-value-internal 'boundp symbol 'symbol-value)))
(if do-all
(setq f (apropos-value-internal 'fboundp symbol 'symbol-function)
p (apropos-format-plist symbol "\n " t)))
(if (apropos-false-hit-str v)
(setq v nil))
(if (apropos-false-hit-str f)
(setq f nil))
(if (apropos-false-hit-str p)
(setq p nil))
(if (or f v p)
(setq apropos-accumulator (cons (list symbol
(+ (apropos-score-str f)
(apropos-score-str v)
(apropos-score-str p))
f v p)
apropos-accumulator))))))
(let ((apropos-multi-type do-all))
(apropos-print nil "\n----------------\n")))
;;;###autoload
(defun apropos-documentation (pattern &optional do-all)
"Show symbols whose documentation contains matches for PATTERN.
PATTERN can be a word, a list of words (separated by spaces),
or a regexp (using some regexp special characters). If it is a word,
search for matches for that word as a substring. If it is a list of words,
search for matches for any two (or more) of those words.
Note that by default this command only searches in the file specified by
`internal-doc-file-name'; i.e., the etc/DOC file. With \\[universal-argument] prefix,
or if `apropos-do-all' is non-nil, it searches all currently defined
documentation strings.
Returns list of symbols and documentation found."
;; The doc used to say that DO-ALL includes key-bindings info in the
;; output, but I cannot see that that is true.
(interactive (list (apropos-read-pattern "documentation")
current-prefix-arg))
(apropos-parse-pattern pattern)
(or do-all (setq do-all apropos-do-all))
(setq apropos-accumulator () apropos-files-scanned ())
(let ((standard-input (get-buffer-create " apropos-temp"))
(apropos-sort-by-scores apropos-documentation-sort-by-scores)
f v sf sv)
(unwind-protect
(with-current-buffer standard-input
(apropos-documentation-check-doc-file)
(if do-all
(mapatoms
(lambda (symbol)
(setq f (apropos-safe-documentation symbol)
v (get symbol 'variable-documentation))
(if (integerp v) (setq v))
(setq f (apropos-documentation-internal f)
v (apropos-documentation-internal v))
(setq sf (apropos-score-doc f)
sv (apropos-score-doc v))
(if (or f v)
(if (setq apropos-item
(cdr (assq symbol apropos-accumulator)))
(progn
(if f
(progn
(setcar (nthcdr 1 apropos-item) f)
(setcar apropos-item (+ (car apropos-item) sf))))
(if v
(progn
(setcar (nthcdr 2 apropos-item) v)
(setcar apropos-item (+ (car apropos-item) sv)))))
(setq apropos-accumulator
(cons (list symbol
(+ (apropos-score-symbol symbol 2) sf sv)
f v)
apropos-accumulator)))))))
(apropos-print nil "\n----------------\n" nil t))
(kill-buffer standard-input))))
\f
(defun apropos-value-internal (predicate symbol function)
(if (funcall predicate symbol)
(progn
(setq symbol (prin1-to-string (funcall function symbol)))
(if (string-match apropos-regexp symbol)
(progn
(if apropos-match-face
(put-text-property (match-beginning 0) (match-end 0)
'face apropos-match-face
symbol))
symbol)))))
(defun apropos-documentation-internal (doc)
(if (consp doc)
(apropos-documentation-check-elc-file (car doc))
(if (and doc
(string-match apropos-all-words-regexp doc)
(apropos-true-hit-doc doc))
(when apropos-match-face
(setq doc (substitute-command-keys (copy-sequence doc)))
(if (or (string-match apropos-pattern-quoted doc)
(string-match apropos-all-words-regexp doc))
(put-text-property (match-beginning 0)
(match-end 0)
'face apropos-match-face doc))
doc))))
(defun apropos-format-plist (pl sep &optional compare)
(setq pl (symbol-plist pl))
(let (p p-out)
(while pl
(setq p (format "%s %S" (car pl) (nth 1 pl)))
(if (or (not compare) (string-match apropos-regexp p))
(put-text-property 0 (length (symbol-name (car pl)))
'face 'apropos-property p)
(setq p nil))
(if p
(progn
(and compare apropos-match-face
(put-text-property (match-beginning 0) (match-end 0)
'face apropos-match-face
p))
(setq p-out (concat p-out (if p-out sep) p))))
(setq pl (nthcdr 2 pl)))
p-out))
;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
(defun apropos-documentation-check-doc-file ()
(let (type symbol (sepa 2) sepb doc)
(insert ?\^_)
(backward-char)
(insert-file-contents (concat doc-directory internal-doc-file-name))
(forward-char)
(while (save-excursion
(setq sepb (search-forward "\^_"))
(not (eobp)))
(beginning-of-line 2)
(if (save-restriction
(narrow-to-region (point) (1- sepb))
(re-search-forward apropos-all-words-regexp nil t))
(progn
(goto-char (1+ sepa))
(setq type (if (eq ?F (preceding-char))
2 ; function documentation
3) ; variable documentation
symbol (read)
doc (buffer-substring (1+ (point)) (1- sepb)))
(when (and (apropos-true-hit-doc doc)
;; The DOC file lists all built-in funcs and vars.
;; If any are not currently bound, they can
;; only be platform-specific stuff (eg NS) not
;; in use on the current platform.
;; So we exclude them.
(cond ((= 3 type) (boundp symbol))
((= 2 type) (fboundp symbol))))
(or (and (setq apropos-item (assq symbol apropos-accumulator))
(setcar (cdr apropos-item)
(apropos-score-doc doc)))
(setq apropos-item (list symbol
(+ (apropos-score-symbol symbol 2)
(apropos-score-doc doc))
nil nil)
apropos-accumulator (cons apropos-item
apropos-accumulator)))
(when apropos-match-face
(setq doc (substitute-command-keys doc))
(if (or (string-match apropos-pattern-quoted doc)
(string-match apropos-all-words-regexp doc))
(put-text-property (match-beginning 0)
(match-end 0)
'face apropos-match-face doc)))
(setcar (nthcdr type apropos-item) doc))))
(setq sepa (goto-char sepb)))))
(defun apropos-documentation-check-elc-file (file)
(if (member file apropos-files-scanned)
nil
(let (symbol doc beg end this-is-a-variable)
(setq apropos-files-scanned (cons file apropos-files-scanned))
(erase-buffer)
(insert-file-contents file)
(while (search-forward "\n#@" nil t)
;; Read the comment length, and advance over it.
(setq end (read)
beg (1+ (point))
end (+ (point) end -1))
(forward-char)
(if (save-restriction
;; match ^ and $ relative to doc string
(narrow-to-region beg end)
(re-search-forward apropos-all-words-regexp nil t))
(progn
(goto-char (+ end 2))
(setq doc (buffer-substring beg end)
end (- (match-end 0) beg)
beg (- (match-beginning 0) beg))
(when (apropos-true-hit-doc doc)
(setq this-is-a-variable (looking-at "(def\\(var\\|const\\) ")
symbol (progn
(skip-chars-forward "(a-z")
(forward-char)
(read))
symbol (if (consp symbol)
(nth 1 symbol)
symbol))
(if (if this-is-a-variable
(get symbol 'variable-documentation)
(and (fboundp symbol) (apropos-safe-documentation symbol)))
(progn
(or (and (setq apropos-item (assq symbol apropos-accumulator))
(setcar (cdr apropos-item)
(+ (cadr apropos-item) (apropos-score-doc doc))))
(setq apropos-item (list symbol
(+ (apropos-score-symbol symbol 2)
(apropos-score-doc doc))
nil nil)
apropos-accumulator (cons apropos-item
apropos-accumulator)))
(when apropos-match-face
(setq doc (substitute-command-keys doc))
(if (or (string-match apropos-pattern-quoted doc)
(string-match apropos-all-words-regexp doc))
(put-text-property (match-beginning 0)
(match-end 0)
'face apropos-match-face doc)))
(setcar (nthcdr (if this-is-a-variable 3 2)
apropos-item)
doc))))))))))
(defun apropos-safe-documentation (function)
"Like `documentation', except it avoids calling `get_doc_string'.
Will return nil instead."
(while (and function (symbolp function))
(setq function (symbol-function function)))
(if (eq (car-safe function) 'macro)
(setq function (cdr function)))
(setq function (if (byte-code-function-p function)
(if (> (length function) 4)
(aref function 4))
(if (autoloadp function)
(nth 2 function)
(if (eq (car-safe function) 'lambda)
(if (stringp (nth 2 function))
(nth 2 function)
(if (stringp (nth 3 function))
(nth 3 function)))))))
(if (integerp function)
nil
function))
(defcustom apropos-compact-layout nil
"If non-nil, use a single line per binding."
:type 'boolean)
(defun apropos-print (do-keys spacing &optional text nosubst)
"Output result of apropos searching into buffer `*Apropos*'.
The value of `apropos-accumulator' is the list of items to output.
Each element should have the format
(SYMBOL SCORE FN-DOC VAR-DOC [PLIST-DOC WIDGET-DOC FACE-DOC GROUP-DOC]).
The return value is the list that was in `apropos-accumulator', sorted
alphabetically by symbol name; but this function also sets
`apropos-accumulator' to nil before returning.
If SPACING is non-nil, it should be a string; separate items with that string.
If non-nil, TEXT is a string that will be printed as a heading."
(if (null apropos-accumulator)
(message "No apropos matches for `%s'" apropos-pattern)
(setq apropos-accumulator
(sort apropos-accumulator
(lambda (a b)
(if apropos-sort-by-scores
(or (> (cadr a) (cadr b))
(and (= (cadr a) (cadr b))
(string-lessp (car a) (car b))))
(string-lessp (car a) (car b))))))
(with-output-to-temp-buffer "*Apropos*"
(let ((p apropos-accumulator)
(old-buffer (current-buffer))
(inhibit-read-only t)
(button-end 0)
symbol item)
(set-buffer standard-output)
(apropos-mode)
(insert (substitute-command-keys "Type \\[apropos-follow] on ")
(if apropos-multi-type "a type label" "an entry")
" to view its full documentation.\n\n")
(if text (insert text "\n\n"))
(dolist (apropos-item p)
(when (and spacing (not (bobp)))
(princ spacing))
(setq symbol (car apropos-item))
;; Insert dummy score element for backwards compatibility with 21.x
;; apropos-item format.
(if (not (numberp (cadr apropos-item)))
(setq apropos-item
(cons (car apropos-item)
(cons nil (cdr apropos-item)))))
(when (= (point) button-end) (terpri))
(insert-text-button (symbol-name symbol)
'type 'apropos-symbol
'skip apropos-multi-type
'face 'apropos-symbol)
(setq button-end (point))
(if (and (eq apropos-sort-by-scores 'verbose)
(cadr apropos-item))
(insert " (" (number-to-string (cadr apropos-item)) ") "))
;; Calculate key-bindings if we want them.
(unless apropos-compact-layout
(and do-keys
(commandp symbol)
(not (eq symbol 'self-insert-command))
(indent-to 30 1)
(if (let ((keys
(with-current-buffer old-buffer
(where-is-internal symbol)))
filtered)
;; Copy over the list of key sequences,
;; omitting any that contain a buffer or a frame.
;; FIXME: Why omit keys that contain buffers and
;; frames? This looks like a bad workaround rather
;; than a proper fix. Does anybody know what problem
;; this is trying to address? --Stef
(dolist (key keys)
(let ((i 0)
loser)
(while (< i (length key))
(if (or (framep (aref key i))
(bufferp (aref key i)))
(setq loser t))
(setq i (1+ i)))
(or loser
(push key filtered))))
(setq item filtered))
;; Convert the remaining keys to a string and insert.
(insert
(mapconcat
(lambda (key)
(setq key (condition-case ()
(key-description key)
(error)))
(put-text-property 0 (length key)
'face 'apropos-keybinding
key)
key)
item ", "))
(insert "M-x ... RET")
(put-text-property (- (point) 11) (- (point) 8)
'face 'apropos-keybinding)
(put-text-property (- (point) 3) (point)
'face 'apropos-keybinding)))
(terpri))
(apropos-print-doc 2
(if (commandp symbol)
'apropos-command
(if (macrop symbol)
'apropos-macro
'apropos-function))
(not nosubst))
(apropos-print-doc 3
(if (custom-variable-p symbol)
'apropos-user-option
'apropos-variable)
(not nosubst))
(apropos-print-doc 7 'apropos-group t)
(apropos-print-doc 6 'apropos-face t)
(apropos-print-doc 5 'apropos-widget t)
(apropos-print-doc 4 'apropos-plist nil))
(set (make-local-variable 'truncate-partial-width-windows) t)
(set (make-local-variable 'truncate-lines) t))))
(prog1 apropos-accumulator
(setq apropos-accumulator ()))) ; permit gc
(defun apropos-print-doc (i type do-keys)
(let ((doc (nth i apropos-item)))
(when (stringp doc)
(if apropos-compact-layout
(insert (propertize "\t" 'display '(space :align-to 32)) " ")
(insert " "))
(if apropos-multi-type
(let ((button-face (button-type-get type 'face)))
(unless (consp button-face)
(setq button-face (list button-face)))
(insert-text-button
(if apropos-compact-layout
(format "<%s>" (button-type-get type 'apropos-short-label))
(button-type-get type 'apropos-label))
'type type
'apropos-symbol (car apropos-item))
(insert (if apropos-compact-layout " " ": ")))
;; If the query is only for a single type, there's no point
;; writing it over and over again. Insert a blank button, and
;; put the 'apropos-label property there (needed by
;; apropos-symbol-button-display-help).
(insert-text-button
" " 'type type 'skip t
'face 'default 'apropos-symbol (car apropos-item)))
(let ((opoint (point))
(ocol (current-column)))
(cond ((equal doc "")
(setq doc "(not documented)"))
(do-keys
(setq doc (substitute-command-keys doc))))
(insert doc)
(if (equal doc "(not documented)")
(put-text-property opoint (point) 'font-lock-face 'shadow))
;; The labeling buttons might make the line too long, so fill it if
;; necessary.
(let ((fill-column (+ 5 (if (integerp emacs-lisp-docstring-fill-column)
emacs-lisp-docstring-fill-column
fill-column)))
(fill-prefix (make-string ocol ?\s)))
(fill-region opoint (point) nil t)))
(or (bolp) (terpri)))))
(defun apropos-follow ()
"Invokes any button at point, otherwise invokes the nearest label button."
(interactive)
(button-activate
(or (apropos-next-label-button (line-beginning-position))
(error "There is nothing to follow here"))))
(defun apropos-describe-plist (symbol)
"Display a pretty listing of SYMBOL's plist."
(help-setup-xref (list 'apropos-describe-plist symbol)
(called-interactively-p 'interactive))
(with-help-window (help-buffer)
(set-buffer standard-output)
(princ "Symbol ")
(prin1 symbol)
(princ "'s plist is\n (")
(put-text-property (+ (point-min) 7) (- (point) 14)
'face 'apropos-symbol)
(insert (apropos-format-plist symbol "\n "))
(princ ")")))
(provide 'apropos)
;;; apropos.el ends here
|