annotate lisp/apropos.el @ 49822:02529e3b1f2c

(vc-cvs-dir-state): Protect against DIR not being under CVS control.
author André Spiegel <spiegel@gnu.org>
date Mon, 17 Feb 2003 08:11:13 +0000
parents 37645a051842
children 58bf3c3670d8 d7ddb3e565de
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38436
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 33921
diff changeset
1 ;;; apropos.el --- apropos commands for users and programmers
662
8a533acedb77 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 444
diff changeset
2
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
3 ;; Copyright (C) 1989, 1994, 1995, 2001, 2002 Free Software Foundation, Inc.
845
213978acbc1e entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 811
diff changeset
4
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
5 ;; Author: Joe Wells <jbw@bigbird.bu.edu>
23867
9c1495be5676 Update address.
Karl Heuer <kwzh@gnu.org>
parents: 23386
diff changeset
6 ;; Rewritten: Daniel Pfeiffer <occitan@esperanto.org>
2247
2c7997f249eb Add or correct keywords
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 1894
diff changeset
7 ;; Keywords: help
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
8
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 ;; This file is part of GNU Emacs.
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 ;; any later version.
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14150
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14150
diff changeset
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14150
diff changeset
24 ;; Boston, MA 02111-1307, USA.
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
26 ;;; Commentary:
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 ;; The ideas for this package were derived from the C code in
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 ;; src/keymap.c and elsewhere. The functions in this file should
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 ;; always be byte-compiled for speed. Someone should rewrite this in
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 ;; C (as part of src/keymap.c) for speed.
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 ;; The idea for super-apropos is based on the original implementation
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 ;; by Lynn Slater <lrs@esl.com>.
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 ;; History:
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 ;; Fixed bug, current-local-map can return nil.
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 ;; Change, doesn't calculate key-bindings unless needed.
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 ;; Added super-apropos capability, changed print functions.
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
40 ;;; Made fast-apropos and super-apropos share code.
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
41 ;;; Sped up fast-apropos again.
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 ;; Added apropos-do-all option.
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
43 ;;; Added fast-command-apropos.
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 ;; Changed doc strings to comments for helping functions.
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
45 ;;; Made doc file buffer read-only, buried it.
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 ;; Only call substitute-command-keys if do-all set.
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
48 ;; Optionally use configurable faces to make the output more legible.
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
49 ;; Differentiate between command, function and macro.
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
50 ;; Apropos-command (ex command-apropos) does cmd and optionally user var.
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
51 ;; Apropos shows all 3 aspects of symbols (fn, var and plist)
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
52 ;; Apropos-documentation (ex super-apropos) now finds all it should.
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
53 ;; New apropos-value snoops through all values and optionally plists.
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
54 ;; Reading DOC file doesn't load nroff.
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
55 ;; Added hypertext following of documentation, mouse-2 on variable gives value
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
56 ;; from buffer in active window.
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
57
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
58 ;;; Code:
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 662
diff changeset
59
39730
620762a412a6 (button): New require.
Miles Bader <miles@gnu.org>
parents: 39706
diff changeset
60 (require 'button)
620762a412a6 (button): New require.
Miles Bader <miles@gnu.org>
parents: 39706
diff changeset
61
18941
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
62 (defgroup apropos nil
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
63 "Apropos commands for users and programmers"
25297
bbfc1bd58fcc Don't capitalize custom group name.
Dave Love <fx@gnu.org>
parents: 23867
diff changeset
64 :group 'help
18941
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
65 :prefix "apropos")
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
66
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
67 ;; I see a degradation of maybe 10-20% only.
18941
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
68 (defcustom apropos-do-all nil
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
69 "*Whether the apropos commands should do more.
18941
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
70
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
71 Slows them down more or less. Set this non-nil if you have a fast machine."
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
72 :group 'apropos
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
73 :type 'boolean)
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
74
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
75
25752
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
76 (defcustom apropos-symbol-face 'bold
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
77 "*Face for symbol name in Apropos output, or nil for none."
18941
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
78 :group 'apropos
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
79 :type 'face)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
80
25752
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
81 (defcustom apropos-keybinding-face 'underline
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
82 "*Face for lists of keybinding in Apropos output, or nil for none."
18941
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
83 :group 'apropos
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
84 :type 'face)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
85
25752
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
86 (defcustom apropos-label-face 'italic
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
87 "*Face for label (`Command', `Variable' ...) in Apropos output.
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
88 A value of nil means don't use any special font for them, and also
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
89 turns off mouse highlighting."
18941
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
90 :group 'apropos
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
91 :type 'face)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
92
25752
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
93 (defcustom apropos-property-face 'bold-italic
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
94 "*Face for property name in apropos output, or nil for none."
18941
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
95 :group 'apropos
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
96 :type 'face)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
97
25752
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
98 (defcustom apropos-match-face 'secondary-selection
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
99 "*Face for matching text in Apropos documentation/value, or nil for none.
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
100 This applies when you look for matches in the documentation or variable value
bb28bbb732db (apropos-symbol-face): Non-nil even for ttys.
Richard M. Stallman <rms@gnu.org>
parents: 25297
diff changeset
101 for the regexp; the part that matches gets displayed in this font."
18941
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
102 :group 'apropos
3fcfe59102ac Customized.
Richard M. Stallman <rms@gnu.org>
parents: 18815
diff changeset
103 :type 'face)
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
104
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
105
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
106 (defvar apropos-mode-map
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
107 (let ((map (make-sparse-keymap)))
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
108 (set-keymap-parent map button-buffer-map)
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
109 ;; Use `apropos-follow' instead of just using the button
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
110 ;; definition of RET, so that users can use it anywhere in an
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
111 ;; apropos item, not just on top of a button.
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
112 (define-key map "\C-m" 'apropos-follow)
21897
7f104a4fc567 (apropos-mode-map): Bind q to quit-window.
Richard M. Stallman <rms@gnu.org>
parents: 20508
diff changeset
113 (define-key map " " 'scroll-up)
7f104a4fc567 (apropos-mode-map): Bind q to quit-window.
Richard M. Stallman <rms@gnu.org>
parents: 20508
diff changeset
114 (define-key map "\177" 'scroll-down)
7f104a4fc567 (apropos-mode-map): Bind q to quit-window.
Richard M. Stallman <rms@gnu.org>
parents: 20508
diff changeset
115 (define-key map "q" 'quit-window)
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
116 map)
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
117 "Keymap used in Apropos mode.")
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
118
29498
4b79925ce8fa *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29199
diff changeset
119 (defvar apropos-mode-hook nil
4b79925ce8fa *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29199
diff changeset
120 "*Hook run when mode is turned on.")
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
121
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
122 (defvar apropos-show-scores nil
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
123 "*Show apropos scores if non-nil.")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
124
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
125 (defvar apropos-regexp nil
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
126 "Regexp used in current apropos run.")
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
128 (defvar apropos-orig-regexp nil
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
129 "Regexp as entered by user.")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
130
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
131 (defvar apropos-all-regexp nil
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
132 "Regexp matching apropos-all-words.")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
133
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
134 (defvar apropos-files-scanned ()
13965
3453c54100b5 (apropos-files-scanned): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 13752
diff changeset
135 "List of elc files already scanned in current run of `apropos-documentation'.")
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
136
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
137 (defvar apropos-accumulator ()
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
138 "Alist of symbols already found in current apropos run.")
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
139
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
140 (defvar apropos-item ()
29764
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
141 "Current item in or for `apropos-accumulator'.")
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
142
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
143 (defvar apropos-synonyms '(
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
144 ("find" "open" "edit")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
145 ("kill" "cut")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
146 ("yank" "paste"))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
147 "List of synonyms known by apropos.
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
148 Each element is a list of words where the first word is the standard emacs
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
149 term, and the rest of the words are alternative terms.")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
150
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
151 (defvar apropos-words ()
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
152 "Current list of words.")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
153
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
154 (defvar apropos-all-words ()
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
155 "Current list of words and synonyms.")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
156
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
157
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
158 ;;; Button types used by apropos
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
159
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
160 (define-button-type 'apropos-symbol
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
161 'face apropos-symbol-face
39677
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
162 'help-echo "mouse-2, RET: Display more help on this symbol"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
163 'action #'apropos-symbol-button-display-help
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
164 'skip t)
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
165
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
166 (defun apropos-symbol-button-display-help (button)
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
167 "Display further help for the `apropos-symbol' button BUTTON."
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
168 (button-activate
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
169 (or (apropos-next-label-button (button-start button))
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
170 (error "There is nothing to follow for `%s'" (button-label button)))))
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
171
39677
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
172 (define-button-type 'apropos-function
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
173 'apropos-label "Function"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
174 'action (lambda (button)
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
175 (describe-function (button-get button 'apropos-symbol)))
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
176 'help-echo "mouse-2, RET: Display more help on this function")
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
177 (define-button-type 'apropos-macro
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
178 'apropos-label "Macro"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
179 'action (lambda (button)
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
180 (describe-function (button-get button 'apropos-symbol)))
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
181 'help-echo "mouse-2, RET: Display more help on this macro")
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
182 (define-button-type 'apropos-command
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
183 'apropos-label "Command"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
184 'action (lambda (button)
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
185 (describe-function (button-get button 'apropos-symbol)))
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
186 'help-echo "mouse-2, RET: Display more help on this command")
42560
099200f97432 Remove unnecessary whitespaces.
Pavel Janík <Pavel@Janik.cz>
parents: 42256
diff changeset
187
39677
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
188 ;; We used to use `customize-variable-other-window' instead for a
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
189 ;; customizable variable, but that is slow. It is better to show an
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
190 ;; ordinary help buffer and let the user click on the customization
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
191 ;; button in that buffer, if he wants to.
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
192 ;; Likewise for `customize-face-other-window'.
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
193 (define-button-type 'apropos-variable
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
194 'apropos-label "Variable"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
195 'help-echo "mouse-2, RET: Display more help on this variable"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
196 'action (lambda (button)
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
197 (describe-variable (button-get button 'apropos-symbol))))
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
198
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
199 (define-button-type 'apropos-face
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
200 'apropos-label "Face"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
201 'help-echo "mouse-2, RET: Display more help on this face"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
202 'action (lambda (button)
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
203 (describe-face (button-get button 'apropos-symbol))))
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
204
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
205 (define-button-type 'apropos-group
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
206 'apropos-label "Group"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
207 'help-echo "mouse-2, RET: Display more help on this group"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
208 'action (lambda (button)
47960
ba7e99fa7b11 (apropos-group): Use customize-group-other-window.
Andreas Schwab <schwab@suse.de>
parents: 47024
diff changeset
209 (customize-group-other-window
39677
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
210 (button-get button 'apropos-symbol))))
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
211
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
212 (define-button-type 'apropos-widget
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
213 'apropos-label "Widget"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
214 'help-echo "mouse-2, RET: Display more help on this widget"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
215 'action (lambda (button)
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
216 (widget-browse-other-window (button-get button 'apropos-symbol))))
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
217
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
218 (define-button-type 'apropos-plist
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
219 'apropos-label "Plist"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
220 'help-echo "mouse-2, RET: Display more help on this plist"
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
221 'action (lambda (button)
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
222 (apropos-describe-plist (button-get button 'apropos-symbol))))
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
223
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
224 (defun apropos-next-label-button (pos)
41154
dfe41fbdcaa0 (apropos-next-label-button): Doc fix.
Pavel Janík <Pavel@Janik.cz>
parents: 39730
diff changeset
225 "Return the next apropos label button after POS, or nil if there's none.
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
226 Will also return nil if more than one `apropos-symbol' button is encountered
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
227 before finding a label."
39669
149659ed7eca (apropos-next-label-button): Update arguments to `next-button'.
Miles Bader <miles@gnu.org>
parents: 39649
diff changeset
228 (let* ((button (next-button pos t))
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
229 (already-hit-symbol nil)
39706
4825323bc19f (apropos-next-label-button): Use the presence of a
Miles Bader <miles@gnu.org>
parents: 39677
diff changeset
230 (label (and button (button-get button 'apropos-label)))
4825323bc19f (apropos-next-label-button): Use the presence of a
Miles Bader <miles@gnu.org>
parents: 39677
diff changeset
231 (type (and button (button-get button 'type))))
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
232 (while (and button
39706
4825323bc19f (apropos-next-label-button): Use the presence of a
Miles Bader <miles@gnu.org>
parents: 39677
diff changeset
233 (not label)
4825323bc19f (apropos-next-label-button): Use the presence of a
Miles Bader <miles@gnu.org>
parents: 39677
diff changeset
234 (or (not (eq type 'apropos-symbol))
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
235 (not already-hit-symbol)))
39706
4825323bc19f (apropos-next-label-button): Use the presence of a
Miles Bader <miles@gnu.org>
parents: 39677
diff changeset
236 (when (eq type 'apropos-symbol)
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
237 (setq already-hit-symbol t))
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
238 (setq button (next-button (button-start button)))
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
239 (when button
39706
4825323bc19f (apropos-next-label-button): Use the presence of a
Miles Bader <miles@gnu.org>
parents: 39677
diff changeset
240 (setq label (button-get button 'apropos-label))
4825323bc19f (apropos-next-label-button): Use the presence of a
Miles Bader <miles@gnu.org>
parents: 39677
diff changeset
241 (setq type (button-get button 'type))))
4825323bc19f (apropos-next-label-button): Use the presence of a
Miles Bader <miles@gnu.org>
parents: 39677
diff changeset
242 (and label button)))
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
243
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
244
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
245 (defun apropos-words-to-regexp (words wild)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
246 "Make regexp matching any two of the words in WORDS."
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
247 (concat "\\("
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
248 (mapconcat 'identity words "\\|")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
249 "\\)" wild
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49231
diff changeset
250 (if (cdr words)
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
251 (concat "\\("
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
252 (mapconcat 'identity words "\\|")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
253 "\\)")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
254 "")))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
255
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
256 (defun apropos-rewrite-regexp (regexp)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
257 "Rewrite a list of words to a regexp matching all permutations.
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
258 If REGEXP is already a regexp, don't modify it."
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
259 (setq apropos-orig-regexp regexp)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
260 (setq apropos-words () apropos-all-words ())
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
261 (if (string-equal (regexp-quote regexp) regexp)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
262 ;; We don't actually make a regexp matching all permutations.
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
263 ;; Instead, for e.g. "a b c", we make a regexp matching
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
264 ;; any combination of two or more words like this:
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
265 ;; (a|b|c).*(a|b|c) which may give some false matches,
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
266 ;; but as long as it also gives the right ones, that's ok.
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
267 (let ((words (split-string regexp "[ \t]+")))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
268 (dolist (word words)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
269 (let ((syn apropos-synonyms) (s word) (a word))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
270 (while syn
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
271 (if (member word (car syn))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
272 (progn
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
273 (setq a (mapconcat 'identity (car syn) "\\|"))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
274 (if (member word (cdr (car syn)))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
275 (setq s a))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
276 (setq syn nil))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
277 (setq syn (cdr syn))))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
278 (setq apropos-words (cons s apropos-words)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
279 apropos-all-words (cons a apropos-all-words))))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
280 (setq apropos-all-regexp (apropos-words-to-regexp apropos-all-words ".+"))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
281 (apropos-words-to-regexp apropos-words ".*?"))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
282 (setq apropos-all-regexp regexp)))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
283
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
284 (defun apropos-calc-scores (str words)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
285 "Return apropos scores for string STR matching WORDS.
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
286 Value is a list of offsets of the words into the string."
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
287 (let ((scores ())
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
288 i)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
289 (if words
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
290 (dolist (word words scores)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
291 (if (setq i (string-match word str))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
292 (setq scores (cons i scores))))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
293 ;; Return list of start and end position of regexp
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
294 (string-match apropos-regexp str)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
295 (list (match-beginning 0) (match-end 0)))))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
296
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
297 (defun apropos-score-str (str)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
298 "Return apropos score for string STR."
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
299 (if str
45484
642d016eb216 Only reduce string score for lengthy strings once.
Kim F. Storm <storm@cua.dk>
parents: 45482
diff changeset
300 (let* (
642d016eb216 Only reduce string score for lengthy strings once.
Kim F. Storm <storm@cua.dk>
parents: 45482
diff changeset
301 (l (length str))
642d016eb216 Only reduce string score for lengthy strings once.
Kim F. Storm <storm@cua.dk>
parents: 45482
diff changeset
302 (score (- (/ l 10)))
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
303 i)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
304 (dolist (s (apropos-calc-scores str apropos-all-words) score)
45484
642d016eb216 Only reduce string score for lengthy strings once.
Kim F. Storm <storm@cua.dk>
parents: 45482
diff changeset
305 (setq score (+ score 1000 (/ (* (- l s) 1000) l)))))
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
306 0))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
307
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
308 (defun apropos-score-doc (doc)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
309 "Return apropos score for documentation string DOC."
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
310 (if doc
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
311 (let ((score 0)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
312 (l (length doc))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
313 i)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
314 (dolist (s (apropos-calc-scores doc apropos-all-words) score)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
315 (setq score (+ score 50 (/ (* (- l s) 50) l)))))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
316 0))
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49231
diff changeset
317
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
318 (defun apropos-score-symbol (symbol &optional weight)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
319 "Return apropos score for SYMBOL."
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
320 (setq symbol (symbol-name symbol))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
321 (let ((score 0)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
322 (l (length symbol))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
323 i)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
324 (dolist (s (apropos-calc-scores symbol apropos-words) (* score (or weight 3)))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
325 (setq score (+ score (- 60 l) (/ (* (- l s) 60) l))))))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
326
45488
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
327 (defun apropos-true-hit (str words)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
328 "Return t if STR is a genuine hit.
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
329 This may fail if only one of the keywords is matched more than once.
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
330 This requires that at least 2 keywords (unless only one was given)."
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
331 (or (not str)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
332 (not words)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
333 (not (cdr words))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
334 (> (length (apropos-calc-scores str words)) 1)))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
335
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
336 (defun apropos-false-hit-symbol (symbol)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
337 "Return t if SYMBOL is not really matched by the current keywords."
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
338 (not (apropos-true-hit (symbol-name symbol) apropos-words)))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
339
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
340 (defun apropos-false-hit-str (str)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
341 "Return t if STR is not really matched by the current keywords."
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
342 (not (apropos-true-hit str apropos-words)))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
343
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
344 (defun apropos-true-hit-doc (doc)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
345 "Return t if DOC is really matched by the current keywords."
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
346 (apropos-true-hit doc apropos-all-words))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
347
26719
8a6fd8991465 (apropos-mode): Add autoload cookie.
Gerd Moellmann <gerd@gnu.org>
parents: 25752
diff changeset
348 ;;;###autoload
32147
f7c3f0fff3e7 (apropos-mode): Use define-derived-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 29764
diff changeset
349 (define-derived-mode apropos-mode fundamental-mode "Apropos"
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
350 "Major mode for following hyperlinks in output of apropos commands.
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
351
32147
f7c3f0fff3e7 (apropos-mode): Use define-derived-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 29764
diff changeset
352 \\{apropos-mode-map}")
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
353
20335
445110a43268 (apropos-variable): New command.
Richard M. Stallman <rms@gnu.org>
parents: 20208
diff changeset
354 ;;;###autoload
22218
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
355 (defun apropos-variable (regexp &optional do-all)
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
356 "Show user variables that match REGEXP.
29764
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
357 With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also show
22218
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
358 normal variables."
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
359 (interactive (list (read-string
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
360 (concat "Apropos "
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
361 (if (or current-prefix-arg apropos-do-all)
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
362 "variable"
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
363 "user option")
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
364 " (regexp or words): "))
22218
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
365 current-prefix-arg))
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
366 (apropos-command regexp nil
22326
a049e7c748d9 (apropos-variable): Fixed argument to apropos-command.
Karl Heuer <kwzh@gnu.org>
parents: 22219
diff changeset
367 (if (or do-all apropos-do-all)
22218
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
368 #'(lambda (symbol)
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
369 (and (boundp symbol)
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
370 (get symbol 'variable-documentation)))
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
371 'user-variable-p)))
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
372
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
373 ;; For auld lang syne:
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
374 ;;;###autoload
47024
15430c8d0eaa * startup.el (normal-splash-screen): Ensure splash buffer is
John Paul Wallington <jpw@pobox.com>
parents: 45488
diff changeset
375 (defalias 'command-apropos 'apropos-command)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
376 ;;;###autoload
22218
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
377 (defun apropos-command (apropos-regexp &optional do-all var-predicate)
29764
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
378 "Show commands (interactively callable functions) that match APROPOS-REGEXP.
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
379 With optional prefix DO-ALL, or if `apropos-do-all' is non-nil, also show
22219
0d635ed37f07 (apropos-command): If DO-ALL is set, search functions, not variables.
Richard M. Stallman <rms@gnu.org>
parents: 22218
diff changeset
380 noninteractive functions.
22218
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
381
22219
0d635ed37f07 (apropos-command): If DO-ALL is set, search functions, not variables.
Richard M. Stallman <rms@gnu.org>
parents: 22218
diff changeset
382 If VAR-PREDICATE is non-nil, show only variables, and only those that
22218
eb4deede0c5a (apropos-command): Change 3rd arg to VAR-PREDICATE
Richard M. Stallman <rms@gnu.org>
parents: 22182
diff changeset
383 satisfy the predicate VAR-PREDICATE."
20335
445110a43268 (apropos-variable): New command.
Richard M. Stallman <rms@gnu.org>
parents: 20208
diff changeset
384 (interactive (list (read-string (concat
445110a43268 (apropos-variable): New command.
Richard M. Stallman <rms@gnu.org>
parents: 20208
diff changeset
385 "Apropos command "
445110a43268 (apropos-variable): New command.
Richard M. Stallman <rms@gnu.org>
parents: 20208
diff changeset
386 (if (or current-prefix-arg
445110a43268 (apropos-variable): New command.
Richard M. Stallman <rms@gnu.org>
parents: 20208
diff changeset
387 apropos-do-all)
22219
0d635ed37f07 (apropos-command): If DO-ALL is set, search functions, not variables.
Richard M. Stallman <rms@gnu.org>
parents: 22218
diff changeset
388 "or function ")
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
389 "(regexp or words): "))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
390 current-prefix-arg))
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
391 (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
392 (let ((message
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
393 (let ((standard-output (get-buffer-create "*Apropos*")))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
394 (print-help-return-message 'identity))))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
395 (or do-all (setq do-all apropos-do-all))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
396 (setq apropos-accumulator
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
397 (apropos-internal apropos-regexp
22326
a049e7c748d9 (apropos-variable): Fixed argument to apropos-command.
Karl Heuer <kwzh@gnu.org>
parents: 22219
diff changeset
398 (or var-predicate
a049e7c748d9 (apropos-variable): Fixed argument to apropos-command.
Karl Heuer <kwzh@gnu.org>
parents: 22219
diff changeset
399 (if do-all 'functionp 'commandp))))
20480
048c8ad9bcaa (apropos, apropos-command): Ignore symbols that have apropos-inhibit property.
Richard M. Stallman <rms@gnu.org>
parents: 20335
diff changeset
400 (let ((tem apropos-accumulator))
048c8ad9bcaa (apropos, apropos-command): Ignore symbols that have apropos-inhibit property.
Richard M. Stallman <rms@gnu.org>
parents: 20335
diff changeset
401 (while tem
45488
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
402 (if (or (get (car tem) 'apropos-inhibit)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
403 (apropos-false-hit-symbol (car tem)))
20480
048c8ad9bcaa (apropos, apropos-command): Ignore symbols that have apropos-inhibit property.
Richard M. Stallman <rms@gnu.org>
parents: 20335
diff changeset
404 (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
048c8ad9bcaa (apropos, apropos-command): Ignore symbols that have apropos-inhibit property.
Richard M. Stallman <rms@gnu.org>
parents: 20335
diff changeset
405 (setq tem (cdr tem))))
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
406 (let ((p apropos-accumulator)
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
407 doc symbol score)
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
408 (while p
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
409 (setcar p (list
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
410 (setq symbol (car p))
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
411 (setq score (apropos-score-symbol symbol))
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
412 (unless var-predicate
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
413 (if (functionp symbol)
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
414 (if (setq doc (documentation symbol t))
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
415 (progn
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49231
diff changeset
416 (setq score (+ score (apropos-score-doc doc)))
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
417 (substring doc 0 (string-match "\n" doc)))
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
418 "(not documented)")))
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
419 (and var-predicate
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
420 (funcall var-predicate symbol)
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
421 (if (setq doc (documentation-property
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
422 symbol 'variable-documentation t))
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
423 (progn
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
424 (setq score (+ score (apropos-score-doc doc)))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
425 (substring doc 0
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
426 (string-match "\n" doc)))))))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
427 (setcar (cdr (car p)) score)
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
428 (setq p (cdr p))))
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
429 (and (apropos-print t nil)
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
430 message
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
431 (message message))))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
432
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
433
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
434 ;;;###autoload
49190
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
435 (defun apropos-documentation-property (symbol property raw)
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
436 "Like (documentation-property SYMBOL PROPERTY RAW) but handle errors."
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
437 (condition-case ()
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
438 (let ((doc (documentation-property symbol property raw)))
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
439 (if doc (substring doc 0 (string-match "\n" doc))
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
440 "(not documented)"))
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
441 (error "(error retrieving documentation)")))
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
442
49231
1cc18f262eab (apropos): Restore autoload cookie. Fix error
John Paul Wallington <jpw@pobox.com>
parents: 49190
diff changeset
443
1cc18f262eab (apropos): Restore autoload cookie. Fix error
John Paul Wallington <jpw@pobox.com>
parents: 49190
diff changeset
444 ;;;###autoload
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
445 (defun apropos (apropos-regexp &optional do-all)
29764
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
446 "Show all bound symbols whose names match APROPOS-REGEXP.
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
447 With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
448 show unbound symbols and key bindings, which is a little more
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
449 time-consuming. Returns list of symbols and documentation found."
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
450 (interactive "sApropos symbol (regexp or words): \nP")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
451 (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
452 (setq apropos-accumulator
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
453 (apropos-internal apropos-regexp
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
454 (and (not do-all)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
455 (not apropos-do-all)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
456 (lambda (symbol)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
457 (or (fboundp symbol)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
458 (boundp symbol)
17417
c351a7e1880c (apropos): Add support for faces, widgets, and user options.
Richard M. Stallman <rms@gnu.org>
parents: 17167
diff changeset
459 (facep symbol)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
460 (symbol-plist symbol))))))
20480
048c8ad9bcaa (apropos, apropos-command): Ignore symbols that have apropos-inhibit property.
Richard M. Stallman <rms@gnu.org>
parents: 20335
diff changeset
461 (let ((tem apropos-accumulator))
048c8ad9bcaa (apropos, apropos-command): Ignore symbols that have apropos-inhibit property.
Richard M. Stallman <rms@gnu.org>
parents: 20335
diff changeset
462 (while tem
048c8ad9bcaa (apropos, apropos-command): Ignore symbols that have apropos-inhibit property.
Richard M. Stallman <rms@gnu.org>
parents: 20335
diff changeset
463 (if (get (car tem) 'apropos-inhibit)
048c8ad9bcaa (apropos, apropos-command): Ignore symbols that have apropos-inhibit property.
Richard M. Stallman <rms@gnu.org>
parents: 20335
diff changeset
464 (setq apropos-accumulator (delq (car tem) apropos-accumulator)))
048c8ad9bcaa (apropos, apropos-command): Ignore symbols that have apropos-inhibit property.
Richard M. Stallman <rms@gnu.org>
parents: 20335
diff changeset
465 (setq tem (cdr tem))))
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
466 (let ((p apropos-accumulator)
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
467 symbol doc properties)
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
468 (while p
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
469 (setcar p (list
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
470 (setq symbol (car p))
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
471 0
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
472 (when (fboundp symbol)
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
473 (if (setq doc (condition-case nil
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
474 (documentation symbol t)
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
475 (void-function
49190
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
476 "(alias for undefined function)")
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
477 (error
49231
1cc18f262eab (apropos): Restore autoload cookie. Fix error
John Paul Wallington <jpw@pobox.com>
parents: 49190
diff changeset
478 "(error retrieving function documentation)")))
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
479 (substring doc 0 (string-match "\n" doc))
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
480 "(not documented)"))
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
481 (when (boundp symbol)
49190
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
482 (apropos-documentation-property
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
483 symbol 'variable-documentation t))
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
484 (when (setq properties (symbol-plist symbol))
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
485 (setq doc (list (car properties)))
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
486 (while (setq properties (cdr (cdr properties)))
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
487 (setq doc (cons (car properties) doc)))
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
488 (mapconcat #'symbol-name (nreverse doc) " "))
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
489 (when (get symbol 'widget-type)
49190
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
490 (apropos-documentation-property
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
491 symbol 'widget-documentation t))
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
492 (when (facep symbol)
49190
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
493 (apropos-documentation-property
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
494 symbol 'face-documentation t))
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
495 (when (get symbol 'custom-group)
49190
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
496 (apropos-documentation-property
bcb627207749 (apropos-documentation-property): New function.
Richard M. Stallman <rms@gnu.org>
parents: 47960
diff changeset
497 symbol 'group-documentation t))))
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
498 (setq p (cdr p))))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
499 (apropos-print
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
500 (or do-all apropos-do-all)
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
501 nil))
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
502
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
503
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
504 ;;;###autoload
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
505 (defun apropos-value (apropos-regexp &optional do-all)
29764
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
506 "Show all symbols whose value's printed image matches APROPOS-REGEXP.
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
507 With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also looks
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
508 at the function and at the names and values of properties.
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
509 Returns list of symbols and values found."
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
510 (interactive "sApropos value (regexp or words): \nP")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
511 (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
512 (or do-all (setq do-all apropos-do-all))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
513 (setq apropos-accumulator ())
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
514 (let (f v p)
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
515 (mapatoms
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
516 (lambda (symbol)
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
517 (setq f nil v nil p nil)
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
518 (or (memq symbol '(apropos-regexp
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
519 apropos-orig-regexp apropos-all-regexp
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
520 apropos-words apropos-all-words
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
521 do-all apropos-accumulator
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
522 symbol f v p))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
523 (setq v (apropos-value-internal 'boundp symbol 'symbol-value)))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
524 (if do-all
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
525 (setq f (apropos-value-internal 'fboundp symbol 'symbol-function)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
526 p (apropos-format-plist symbol "\n " t)))
45488
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
527 (if (apropos-false-hit-str v)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
528 (setq v nil))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
529 (if (apropos-false-hit-str f)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
530 (setq f nil))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
531 (if (apropos-false-hit-str p)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
532 (setq p nil))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
533 (if (or f v p)
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49231
diff changeset
534 (setq apropos-accumulator (cons (list symbol
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
535 (+ (apropos-score-str f)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
536 (apropos-score-str v)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
537 (apropos-score-str p))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
538 f v p)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
539 apropos-accumulator))))))
42256
f06cb3ff301f (apropos-print): SPACING is now nil or a separator string.
Richard M. Stallman <rms@gnu.org>
parents: 41154
diff changeset
540 (apropos-print nil "\n----------------\n"))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
541
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
542
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
543 ;;;###autoload
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
544 (defun apropos-documentation (apropos-regexp &optional do-all)
29764
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
545 "Show symbols whose documentation contain matches for APROPOS-REGEXP.
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
546 With optional prefix DO-ALL or if `apropos-do-all' is non-nil, also use
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
547 documentation that is not stored in the documentation file and show key
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
548 bindings.
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
549 Returns list of symbols and documentation found."
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
550 (interactive "sApropos documentation (regexp or words): \nP")
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
551 (setq apropos-regexp (apropos-rewrite-regexp apropos-regexp))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
552 (or do-all (setq do-all apropos-do-all))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
553 (setq apropos-accumulator () apropos-files-scanned ())
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
554 (let ((standard-input (get-buffer-create " apropos-temp"))
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
555 f v sf sv)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
556 (unwind-protect
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
557 (save-excursion
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
558 (set-buffer standard-input)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
559 (apropos-documentation-check-doc-file)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
560 (if do-all
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
561 (mapatoms
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
562 (lambda (symbol)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
563 (setq f (apropos-safe-documentation symbol)
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
564 v (get symbol 'variable-documentation))
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
565 (if (integerp v) (setq v))
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
566 (setq f (apropos-documentation-internal f)
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
567 v (apropos-documentation-internal v))
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
568 (setq sf (apropos-score-doc f)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
569 sv (apropos-score-doc v))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
570 (if (or f v)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
571 (if (setq apropos-item
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
572 (cdr (assq symbol apropos-accumulator)))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
573 (progn
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
574 (if f
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
575 (progn
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
576 (setcar (nthcdr 1 apropos-item) f)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
577 (setcar apropos-item (+ (car apropos-item) sf))))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
578 (if v
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
579 (progn
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
580 (setcar (nthcdr 2 apropos-item) v)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
581 (setcar apropos-item (+ (car apropos-item) sv)))))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
582 (setq apropos-accumulator
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49231
diff changeset
583 (cons (list symbol
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
584 (+ (apropos-score-symbol symbol 2) sf sv)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
585 f v)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
586 apropos-accumulator)))))))
42256
f06cb3ff301f (apropos-print): SPACING is now nil or a separator string.
Richard M. Stallman <rms@gnu.org>
parents: 41154
diff changeset
587 (apropos-print nil "\n----------------\n"))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
588 (kill-buffer standard-input))))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
589
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
590
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
591 (defun apropos-value-internal (predicate symbol function)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
592 (if (funcall predicate symbol)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
593 (progn
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
594 (setq symbol (prin1-to-string (funcall function symbol)))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
595 (if (string-match apropos-regexp symbol)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
596 (progn
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
597 (if apropos-match-face
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
598 (put-text-property (match-beginning 0) (match-end 0)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
599 'face apropos-match-face
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
600 symbol))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
601 symbol)))))
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
602
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
603 (defun apropos-documentation-internal (doc)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
604 (if (consp doc)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
605 (apropos-documentation-check-elc-file (car doc))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
606 (and doc
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
607 (string-match apropos-all-regexp doc)
45488
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
608 (save-match-data (apropos-true-hit-doc doc))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
609 (progn
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
610 (if apropos-match-face
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
611 (put-text-property (match-beginning 0)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
612 (match-end 0)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
613 'face apropos-match-face
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
614 (setq doc (copy-sequence doc))))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
615 doc))))
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
616
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
617 (defun apropos-format-plist (pl sep &optional compare)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
618 (setq pl (symbol-plist pl))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
619 (let (p p-out)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
620 (while pl
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
621 (setq p (format "%s %S" (car pl) (nth 1 pl)))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
622 (if (or (not compare) (string-match apropos-regexp p))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
623 (if apropos-property-face
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
624 (put-text-property 0 (length (symbol-name (car pl)))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
625 'face apropos-property-face p))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
626 (setq p nil))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
627 (if p
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
628 (progn
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
629 (and compare apropos-match-face
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
630 (put-text-property (match-beginning 0) (match-end 0)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
631 'face apropos-match-face
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
632 p))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
633 (setq p-out (concat p-out (if p-out sep) p))))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
634 (setq pl (nthcdr 2 pl)))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
635 p-out))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
636
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
637
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
638 ;; Finds all documentation related to APROPOS-REGEXP in internal-doc-file-name.
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
639
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
640 (defun apropos-documentation-check-doc-file ()
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
641 (let (type symbol (sepa 2) sepb beg end)
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
642 (insert ?\^_)
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
643 (backward-char)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
644 (insert-file-contents (concat doc-directory internal-doc-file-name))
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
645 (forward-char)
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
646 (while (save-excursion
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
647 (setq sepb (search-forward "\^_"))
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
648 (not (eobp)))
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
649 (beginning-of-line 2)
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
650 (if (save-restriction
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
651 (narrow-to-region (point) (1- sepb))
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
652 (re-search-forward apropos-all-regexp nil t))
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
653 (progn
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
654 (setq beg (match-beginning 0)
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
655 end (point))
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
656 (goto-char (1+ sepa))
45488
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
657 (setq type (if (eq ?F (preceding-char))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
658 2 ; function documentation
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
659 3) ; variable documentation
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
660 symbol (read)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
661 beg (- beg (point) 1)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
662 end (- end (point) 1)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
663 doc (buffer-substring (1+ (point)) (1- sepb)))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
664 (when (apropos-true-hit-doc doc)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
665 (or (and (setq apropos-item (assq symbol apropos-accumulator))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
666 (setcar (cdr apropos-item)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
667 (+ (cadr apropos-item) (apropos-score-doc doc))))
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49231
diff changeset
668 (setq apropos-item (list symbol
45488
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
669 (+ (apropos-score-symbol symbol 2)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
670 (apropos-score-doc doc))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
671 nil nil)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
672 apropos-accumulator (cons apropos-item
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
673 apropos-accumulator)))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
674 (if apropos-match-face
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
675 (put-text-property beg end 'face apropos-match-face doc))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
676 (setcar (nthcdr type apropos-item) doc))))
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
677 (setq sepa (goto-char sepb)))))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
678
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
679 (defun apropos-documentation-check-elc-file (file)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
680 (if (member file apropos-files-scanned)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
681 nil
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
682 (let (symbol doc beg end this-is-a-variable)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
683 (setq apropos-files-scanned (cons file apropos-files-scanned))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
684 (erase-buffer)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
685 (insert-file-contents file)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
686 (while (search-forward "\n#@" nil t)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
687 ;; Read the comment length, and advance over it.
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
688 (setq end (read)
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
689 beg (1+ (point))
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
690 end (+ (point) end -1))
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
691 (forward-char)
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
692 (if (save-restriction
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
693 ;; match ^ and $ relative to doc string
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
694 (narrow-to-region beg end)
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
695 (re-search-forward apropos-all-regexp nil t))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
696 (progn
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
697 (goto-char (+ end 2))
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
698 (setq doc (buffer-substring beg end)
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
699 end (- (match-end 0) beg)
45488
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
700 beg (- (match-beginning 0) beg))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
701 (when (apropos-true-hit-doc doc)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
702 (setq this-is-a-variable (looking-at "(def\\(var\\|const\\) ")
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
703 symbol (progn
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
704 (skip-chars-forward "(a-z")
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
705 (forward-char)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
706 (read))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
707 symbol (if (consp symbol)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
708 (nth 1 symbol)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
709 symbol))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
710 (if (if this-is-a-variable
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
711 (get symbol 'variable-documentation)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
712 (and (fboundp symbol) (apropos-safe-documentation symbol)))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
713 (progn
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
714 (or (and (setq apropos-item (assq symbol apropos-accumulator))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
715 (setcar (cdr apropos-item)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
716 (+ (cadr apropos-item) (apropos-score-doc doc))))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
717 (setq apropos-item (list symbol
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
718 (+ (apropos-score-symbol symbol 2)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
719 (apropos-score-doc doc))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
720 nil nil)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
721 apropos-accumulator (cons apropos-item
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
722 apropos-accumulator)))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
723 (if apropos-match-face
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
724 (put-text-property beg end 'face apropos-match-face
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
725 doc))
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
726 (setcar (nthcdr (if this-is-a-variable 3 2)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
727 apropos-item)
7d28e8eeee0d (apropos-true-hit, apropos-false-hit-symbol)
Kim F. Storm <storm@cua.dk>
parents: 45484
diff changeset
728 doc))))))))))
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
729
10283
1d1c5ea9eb86 (super-apropos-check-elc-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 10282
diff changeset
730
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
731
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
732 (defun apropos-safe-documentation (function)
29764
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
733 "Like `documentation', except it avoids calling `get_doc_string'.
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
734 Will return nil instead."
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
735 (while (and function (symbolp function))
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
736 (setq function (if (fboundp function)
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
737 (symbol-function function))))
3563
804e4f30b7ce (safe-documentation): Don't crash on byte-compiled macro.
Richard M. Stallman <rms@gnu.org>
parents: 2946
diff changeset
738 (if (eq (car-safe function) 'macro)
804e4f30b7ce (safe-documentation): Don't crash on byte-compiled macro.
Richard M. Stallman <rms@gnu.org>
parents: 2946
diff changeset
739 (setq function (cdr function)))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
740 (setq function (if (byte-code-function-p function)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
741 (if (> (length function) 4)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
742 (aref function 4))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
743 (if (eq (car-safe function) 'autoload)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
744 (nth 2 function)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
745 (if (eq (car-safe function) 'lambda)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
746 (if (stringp (nth 2 function))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
747 (nth 2 function)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
748 (if (stringp (nth 3 function))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
749 (nth 3 function)))))))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
750 (if (integerp function)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
751 nil
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
752 function))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
753
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
754
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
755 (defun apropos-print (do-keys spacing)
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
756 "Output result of apropos searching into buffer `*Apropos*'.
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
757 The value of `apropos-accumulator' is the list of items to output.
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49231
diff changeset
758 Each element should have the format
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
759 (SYMBOL SCORE FN-DOC VAR-DOC [PLIST-DOC WIDGET-DOC FACE-DOC GROUP-DOC]).
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
760 The return value is the list that was in `apropos-accumulator', sorted
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
761 alphabetically by symbol name; but this function also sets
42256
f06cb3ff301f (apropos-print): SPACING is now nil or a separator string.
Richard M. Stallman <rms@gnu.org>
parents: 41154
diff changeset
762 `apropos-accumulator' to nil before returning.
f06cb3ff301f (apropos-print): SPACING is now nil or a separator string.
Richard M. Stallman <rms@gnu.org>
parents: 41154
diff changeset
763
f06cb3ff301f (apropos-print): SPACING is now nil or a separator string.
Richard M. Stallman <rms@gnu.org>
parents: 41154
diff changeset
764 If SPACING is non-nil, it should be a string;
f06cb3ff301f (apropos-print): SPACING is now nil or a separator string.
Richard M. Stallman <rms@gnu.org>
parents: 41154
diff changeset
765 separate items with that string."
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
766 (if (null apropos-accumulator)
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
767 (message "No apropos matches for `%s'" apropos-orig-regexp)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
768 (setq apropos-accumulator
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
769 (sort apropos-accumulator (lambda (a b)
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
770 (or (> (cadr a) (cadr b))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
771 (and (= (cadr a) (cadr b))
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
772 (string-lessp (car a) (car b)))))))
13470
0bfd3ae57234 (apropos-print): Use buffer *Apropos*, not *Help*.
Richard M. Stallman <rms@gnu.org>
parents: 12640
diff changeset
773 (with-output-to-temp-buffer "*Apropos*"
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
774 (let ((p apropos-accumulator)
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
775 (old-buffer (current-buffer))
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
776 symbol item)
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
777 (set-buffer standard-output)
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
778 (apropos-mode)
29199
cc07870ddb45 (apropos-print): Use display-mouse-p instead of
Eli Zaretskii <eliz@gnu.org>
parents: 28844
diff changeset
779 (if (display-mouse-p)
45115
237374f1a28e (apropos-print): Fix the reference to mouse-2.
Eli Zaretskii <eliz@gnu.org>
parents: 42560
diff changeset
780 (insert
237374f1a28e (apropos-print): Fix the reference to mouse-2.
Eli Zaretskii <eliz@gnu.org>
parents: 42560
diff changeset
781 "If moving the mouse over text changes the text's color, "
237374f1a28e (apropos-print): Fix the reference to mouse-2.
Eli Zaretskii <eliz@gnu.org>
parents: 42560
diff changeset
782 "you can click\n"
237374f1a28e (apropos-print): Fix the reference to mouse-2.
Eli Zaretskii <eliz@gnu.org>
parents: 42560
diff changeset
783 "mouse-2 (second button from right) on that text to "
237374f1a28e (apropos-print): Fix the reference to mouse-2.
Eli Zaretskii <eliz@gnu.org>
parents: 42560
diff changeset
784 "get more information.\n"))
39491
1f81f55f4241 (apropos-print): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 39489
diff changeset
785 (insert "In this buffer, go to the name of the command, or function,"
39489
464552acc8a0 (apropos-print): Make the directions inserted at the
Eli Zaretskii <eliz@gnu.org>
parents: 38436
diff changeset
786 " or variable,\n"
464552acc8a0 (apropos-print): Make the directions inserted at the
Eli Zaretskii <eliz@gnu.org>
parents: 38436
diff changeset
787 (substitute-command-keys
464552acc8a0 (apropos-print): Make the directions inserted at the
Eli Zaretskii <eliz@gnu.org>
parents: 38436
diff changeset
788 "and type \\[apropos-follow] to get full documentation.\n\n"))
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
789 (while (consp p)
42256
f06cb3ff301f (apropos-print): SPACING is now nil or a separator string.
Richard M. Stallman <rms@gnu.org>
parents: 41154
diff changeset
790 (when (and spacing (not (bobp)))
f06cb3ff301f (apropos-print): SPACING is now nil or a separator string.
Richard M. Stallman <rms@gnu.org>
parents: 41154
diff changeset
791 (princ spacing))
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
792 (setq apropos-item (car p)
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
793 symbol (car apropos-item)
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
794 p (cdr p))
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
795 (insert-text-button (symbol-name symbol)
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
796 'type 'apropos-symbol
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
797 ;; Can't use default, since user may have
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
798 ;; changed the variable!
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
799 ;; Just say `no' to variables containing faces!
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
800 'face apropos-symbol-face)
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
801 (if apropos-show-scores
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
802 (insert " (" (number-to-string (cadr apropos-item)) ") "))
14395
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
803 ;; Calculate key-bindings if we want them.
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
804 (and do-keys
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
805 (commandp symbol)
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
806 (indent-to 30 1)
14395
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
807 (if (let ((keys
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
808 (save-excursion
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
809 (set-buffer old-buffer)
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
810 (where-is-internal symbol)))
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
811 filtered)
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
812 ;; Copy over the list of key sequences,
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
813 ;; omitting any that contain a buffer or a frame.
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
814 (while keys
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
815 (let ((key (car keys))
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
816 (i 0)
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
817 loser)
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
818 (while (< i (length key))
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
819 (if (or (framep (aref key i))
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
820 (bufferp (aref key i)))
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
821 (setq loser t))
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
822 (setq i (1+ i)))
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
823 (or loser
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
824 (setq filtered (cons key filtered))))
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
825 (setq keys (cdr keys)))
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
826 (setq item filtered))
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
827 ;; Convert the remaining keys to a string and insert.
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
828 (insert
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
829 (mapconcat
14395
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
830 (lambda (key)
29764
dbfcedec53b3 Doc fixes.
Dave Love <fx@gnu.org>
parents: 29498
diff changeset
831 (setq key (condition-case ()
23386
ac8f85b1733c (apropos-print): control invalid characters.
Karl Heuer <kwzh@gnu.org>
parents: 22532
diff changeset
832 (key-description key)
ac8f85b1733c (apropos-print): control invalid characters.
Karl Heuer <kwzh@gnu.org>
parents: 22532
diff changeset
833 (error)))
14395
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
834 (if apropos-keybinding-face
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
835 (put-text-property 0 (length key)
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
836 'face apropos-keybinding-face
14395
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
837 key))
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
838 key)
8e97dadccf2b (apropos-print): Omit key sequences that contain a frame.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
839 item ", "))
15159
b22de331ee43 (apropos-print): If command has no key bindings, say how to run it with M-x.
Richard M. Stallman <rms@gnu.org>
parents: 14400
diff changeset
840 (insert "M-x")
b22de331ee43 (apropos-print): If command has no key bindings, say how to run it with M-x.
Richard M. Stallman <rms@gnu.org>
parents: 14400
diff changeset
841 (put-text-property (- (point) 3) (point)
b22de331ee43 (apropos-print): If command has no key bindings, say how to run it with M-x.
Richard M. Stallman <rms@gnu.org>
parents: 14400
diff changeset
842 'face apropos-keybinding-face)
b22de331ee43 (apropos-print): If command has no key bindings, say how to run it with M-x.
Richard M. Stallman <rms@gnu.org>
parents: 14400
diff changeset
843 (insert " " (symbol-name symbol) " ")
b22de331ee43 (apropos-print): If command has no key bindings, say how to run it with M-x.
Richard M. Stallman <rms@gnu.org>
parents: 14400
diff changeset
844 (insert "RET")
b22de331ee43 (apropos-print): If command has no key bindings, say how to run it with M-x.
Richard M. Stallman <rms@gnu.org>
parents: 14400
diff changeset
845 (put-text-property (- (point) 3) (point)
b22de331ee43 (apropos-print): If command has no key bindings, say how to run it with M-x.
Richard M. Stallman <rms@gnu.org>
parents: 14400
diff changeset
846 'face apropos-keybinding-face)))
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
847 (terpri)
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
848 (apropos-print-doc 2
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
849 (if (commandp symbol)
39677
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
850 'apropos-command
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
851 (if (apropos-macrop symbol)
39677
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
852 'apropos-macro
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
853 'apropos-function))
20508
16f1fd128350 (apropos-print): Pass t instead of DO-KEYS
Richard M. Stallman <rms@gnu.org>
parents: 20480
diff changeset
854 t)
45482
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
855 (apropos-print-doc 3 'apropos-variable t)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
856 (apropos-print-doc 7 'apropos-group t)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
857 (apropos-print-doc 6 'apropos-face t)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
858 (apropos-print-doc 5 'apropos-widget t)
7928b3acfb90 (apropos-show-scores, apropos-orig-regexp)
Kim F. Storm <storm@cua.dk>
parents: 45115
diff changeset
859 (apropos-print-doc 4 'apropos-plist nil))
22532
5a83f0f3b29d (apropos-print): Delete arg DOC-FN.
Karl Heuer <kwzh@gnu.org>
parents: 22408
diff changeset
860 (setq buffer-read-only t))))
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
861 (prog1 apropos-accumulator
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
862 (setq apropos-accumulator ()))) ; permit gc
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
863
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
864
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
865 (defun apropos-macrop (symbol)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
866 "T if SYMBOL is a Lisp macro."
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
867 (and (fboundp symbol)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
868 (consp (setq symbol
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
869 (symbol-function symbol)))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
870 (or (eq (car symbol) 'macro)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
871 (if (eq (car symbol) 'autoload)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
872 (memq (nth 4 symbol)
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
873 '(macro t))))))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
874
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
875
39677
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
876 (defun apropos-print-doc (i type do-keys)
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
877 (if (stringp (setq i (nth i apropos-item)))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
878 (progn
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
879 (insert " ")
39677
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
880 (insert-text-button (button-type-get type 'apropos-label)
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
881 'type type
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
882 ;; Can't use the default button face, since
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
883 ;; user may have changed the variable!
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
884 ;; Just say `no' to variables containing faces!
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
885 'face apropos-label-face
39677
05b7a0e7b426 (apropos-symbol): Add `skip' property.
Miles Bader <miles@gnu.org>
parents: 39669
diff changeset
886 'apropos-symbol (car apropos-item))
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
887 (insert ": ")
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
888 (insert (if do-keys (substitute-command-keys i) i))
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
889 (or (bolp) (terpri)))))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
890
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
891
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
892 (defun apropos-follow ()
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
893 "Invokes any button at point, otherwise invokes the nearest label button."
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
894 (interactive)
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
895 (button-activate
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
896 (or (apropos-next-label-button (line-beginning-position))
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
897 (error "There is nothing to follow here"))))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
898
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
899
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
900 (defun apropos-describe-plist (symbol)
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
901 "Display a pretty listing of SYMBOL's plist."
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
902 (with-output-to-temp-buffer "*Help*"
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
903 (set-buffer standard-output)
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
904 (princ "Symbol ")
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
905 (prin1 symbol)
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
906 (princ "'s plist is\n (")
12640
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
907 (if apropos-symbol-face
d194c63cb75c Add latest changes of old library and some more.
Karl Heuer <kwzh@gnu.org>
parents: 12498
diff changeset
908 (put-text-property 8 (- (point) 14) 'face apropos-symbol-face))
12498
9fb6a9b6658b Restructured, largely rewritten and extended.
Karl Heuer <kwzh@gnu.org>
parents: 11190
diff changeset
909 (insert (apropos-format-plist symbol "\n "))
13752
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
910 (princ ")")
e3b945c8141e (apropos-match-face): Use `secondary-selection' rather
Karl Heuer <kwzh@gnu.org>
parents: 13656
diff changeset
911 (print-help-return-message)))
367
6c230193acf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
912
39649
7edeec63e660 (apropos-symbol, apropos-label): New button types.
Miles Bader <miles@gnu.org>
parents: 39491
diff changeset
913
18383
11218164bc54 Add provide call.
Richard M. Stallman <rms@gnu.org>
parents: 17559
diff changeset
914 (provide 'apropos)
11218164bc54 Add provide call.
Richard M. Stallman <rms@gnu.org>
parents: 17559
diff changeset
915
662
8a533acedb77 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 444
diff changeset
916 ;;; apropos.el ends here