Mercurial > emacs
annotate lisp/emacs-lisp/eldoc.el @ 50507:110c0e29159c
Handle multiple desktop files in different dirs.
Other cleanups.
Command line option --no-desktop introduced.
(desktop-read): Record buffers in the desktop file in
the same order as that in the buffer list,
(desktop-save): Put buffers in the order given in desktop file,
regardless of what handlers do.
(desktop-file-version): New variable. Version number of desktop
file format.
(desktop-create-buffer-form): Variable deleted.
(desktop-save): New customizable variable.
(desktop-kill): Changed to use `desktop-save'.
(desktop-file-name-format): New option: format in
which desktop file names should be saved.
(desktop-file-name): New function to convert a filename to the
format specified in `desktop-file-name-format'.
(desktop-create-buffer): Parameters renamed to descriptive
systematic names. These parameters are visible to handlers.
Renames:
ver -> desktop-file-version
mim -> desktop-buffer-minor-modes
pt -> desktop-buffer-point
mk -> desktop-buffer-mark
ro -> desktop-buffer-read-only
locals -> desktop-buffer-locals
(desktop-buffer-major-mode, desktop-buffer-file-name)
(desktop-buffer-name): Unused customizable variables deleted.
(desktop-buffer-misc): Unused variable deleted.
(desktop-save, desktop-buffer-dired-misc-data):
Use `desktop-file-name'.
(desktop-path): New customizable variable. List of directories in
which to lookup the desktop file. Replaces hardcoded list.
(desktop-globals-to-clear): New variable replaces hardcoded list.
(desktop-clear-preserve-buffers-regexp): New customizable variable.
(desktop-after-read-hook): New hook run after a desktop is read.
(desktop-no-desktop-file-hook): New hook when no desktop file found.
(desktop-change-dir): New function.
(desktop-save-in-load-dir): New function. Save desktop in
directory from witch it was loaded.
(desktop-revert): New function. Revert to the last loaded desktop.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 09 Apr 2003 01:37:56 +0000 |
parents | eb34aebd1084 |
children | 3a65ede5c70c d7ddb3e565de |
rev | line source |
---|---|
13530 | 1 ;;; eldoc.el --- show function arglist or variable docstring in echo area |
2 | |
49018 | 3 ;; Copyright (C) 1996, 97, 98, 99, 2000, 2003 Free Software Foundation, Inc. |
13530 | 4 |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
5 ;; Author: Noah Friedman <friedman@splode.com> |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
6 ;; Maintainer: friedman@splode.com |
13530 | 7 ;; Keywords: extensions |
8 ;; Created: 1995-10-06 | |
9 | |
49697
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
10 ;; $Id: eldoc.el,v 1.23 2003/01/03 11:53:46 jpw Exp $ |
13530 | 11 |
16969
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
12 ;; This file is part of GNU Emacs. |
13530 | 13 |
16969
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
14 ;; GNU Emacs is free software; you can redistribute it and/or modify |
13530 | 15 ;; it under the terms of the GNU General Public License as published by |
16 ;; the Free Software Foundation; either version 2, or (at your option) | |
17 ;; any later version. | |
16969
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
18 |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
19 ;; GNU Emacs is distributed in the hope that it will be useful, |
13530 | 20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
22 ;; GNU General Public License for more details. | |
16969
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
23 |
13530 | 24 ;; You should have received a copy of the GNU General Public License |
16969
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
27 ;; Boston, MA 02111-1307, USA. |
13530 | 28 |
29 ;;; Commentary: | |
30 | |
16969
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
31 ;; This program was inspired by the behavior of the "mouse documentation |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
32 ;; window" on many Lisp Machine systems; as you type a function's symbol |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
33 ;; name as part of a sexp, it will print the argument list for that |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
34 ;; function. Behavior is not identical; for example, you need not actually |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
35 ;; type the function name, you need only move point around in a sexp that |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
36 ;; calls it. Also, if point is over a documented variable, it will print |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
37 ;; the one-line documentation for that variable instead, to remind you of |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
38 ;; that variable's meaning. |
13530 | 39 |
40 ;; One useful way to enable this minor mode is to put the following in your | |
41 ;; .emacs: | |
42 ;; | |
43 ;; (autoload 'turn-on-eldoc-mode "eldoc" nil t) | |
44 ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-eldoc-mode) | |
45 ;; (add-hook 'lisp-interaction-mode-hook 'turn-on-eldoc-mode) | |
16975
188c4da9bf5d
(eldoc-display-message-p): New function.
Noah Friedman <friedman@splode.com>
parents:
16969
diff
changeset
|
46 ;; (add-hook 'ielm-mode-hook 'turn-on-eldoc-mode) |
13530 | 47 |
48 ;;; Code: | |
49 | |
48470
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
50 (require 'help-fns) ;For fundoc-usage handling functions. |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
51 |
17445
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
52 (defgroup eldoc nil |
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
53 "Show function arglist or variable docstring in echo area." |
30389
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
54 :group 'lisp |
17445
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
55 :group 'extensions) |
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
56 |
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
57 (defcustom eldoc-idle-delay 0.50 |
13530 | 58 "*Number of seconds of idle time to wait before printing. |
59 If user input arrives before this interval of time has elapsed after the | |
60 last input, no documentation will be printed. | |
61 | |
17445
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
62 If this variable is set to 0, no idle time is required." |
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
63 :type 'number |
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
64 :group 'eldoc) |
13530 | 65 |
30389
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
66 ;;;###autoload |
17445
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
67 (defcustom eldoc-minor-mode-string " ElDoc" |
42623
365f0cb0170e
(eldoc-minor-mode-string): Fix custom type.
Richard M. Stallman <rms@gnu.org>
parents:
41167
diff
changeset
|
68 "*String to display in mode line when Eldoc Mode is enabled; nil for none." |
365f0cb0170e
(eldoc-minor-mode-string): Fix custom type.
Richard M. Stallman <rms@gnu.org>
parents:
41167
diff
changeset
|
69 :type '(choice string (const :tag "None" nil)) |
17445
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
70 :group 'eldoc) |
16969
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
71 |
17445
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
72 (defcustom eldoc-argument-case 'upcase |
13530 | 73 "Case to display argument names of functions, as a symbol. |
74 This has two preferred values: `upcase' or `downcase'. | |
75 Actually, any name of a function which takes a string as an argument and | |
17445
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
76 returns another string is acceptable." |
30389
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
77 :type '(radio (function-item upcase) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
78 (function-item downcase) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
79 function) |
17445
f2db4e8bb6ed
Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents:
17253
diff
changeset
|
80 :group 'eldoc) |
13530 | 81 |
30389
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
82 (defcustom eldoc-echo-area-use-multiline-p 'truncate-sym-name-if-fit |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
83 "*Allow long eldoc messages to resize echo area display. |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
84 If value is `t', never attempt to truncate messages; complete symbol name |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
85 and function arglist or 1-line variable documentation will be displayed |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
86 even if echo area must be resized to fit. |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
87 |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
88 If value is any non-nil value other than `t', symbol name may be truncated |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
89 if it will enable the function arglist or documentation string to fit on a |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
90 single line without resizing window. Otherwise, behavior is just like |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
91 former case. |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
92 |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
93 If value is nil, messages are always truncated to fit in a single line of |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
94 display in the echo area. Function or variable symbol name may be |
49697
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
95 truncated to make more of the arglist or documentation string visible." |
30389
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
96 :type '(radio (const :tag "Always" t) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
97 (const :tag "Never" nil) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
98 (const :tag "Yes, but truncate symbol names if it will\ |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
99 enable argument list to fit on one line" truncate-sym-name-if-fit)) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
100 :group 'eldoc) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
101 |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
102 ;;; No user options below here. |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
103 |
17920
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
104 ;; Commands after which it is appropriate to print in the echo area. |
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
105 ;; Eldoc does not try to print function arglists, etc. after just any command, |
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
106 ;; because some commands print their own messages in the echo area and these |
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
107 ;; functions would instantly overwrite them. But self-insert-command as well |
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
108 ;; as most motion commands are good candidates. |
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
109 ;; This variable contains an obarray of symbols; do not manipulate it |
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
110 ;; directly. Instead, use `eldoc-add-command' and `eldoc-remove-command'. |
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
111 (defvar eldoc-message-commands nil) |
13530 | 112 |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
113 ;; This is used by eldoc-add-command to initialize eldoc-message-commands |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
114 ;; as an obarray. |
17920
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
115 ;; It should probably never be necessary to do so, but if you |
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
116 ;; choose to increase the number of buckets, you must do so before loading |
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
117 ;; this file since the obarray is initialized at load time. |
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
118 ;; Remember to keep it a prime number to improve hash performance. |
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
119 (defvar eldoc-message-commands-table-size 31) |
13530 | 120 |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
121 ;; Bookkeeping; elements are as follows: |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
122 ;; 0 - contains the last symbol read from the buffer. |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
123 ;; 1 - contains the string last displayed in the echo area for that |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
124 ;; symbol, so it can be printed again if necessary without reconsing. |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
125 ;; 2 - 'function if function args, 'variable if variable documentation. |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
126 (defvar eldoc-last-data (make-vector 3 nil)) |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
127 (defvar eldoc-last-message nil) |
13530 | 128 |
49697
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
129 ;; eldoc's timer object. |
16969
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
130 (defvar eldoc-timer nil) |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
131 |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
132 ;; idle time delay currently in use by timer. |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
133 ;; This is used to determine if eldoc-idle-delay is changed by the user. |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
134 (defvar eldoc-current-idle-delay eldoc-idle-delay) |
13530 | 135 |
136 | |
137 ;;;###autoload | |
41167
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
138 (define-minor-mode eldoc-mode |
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
139 "Toggle ElDoc mode on or off. |
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
140 Show the defined parameters for the elisp function near point. |
16969
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
141 |
41167
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
142 For the emacs lisp function at the beginning of the sexp which point is |
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
143 within, show the defined parameters for the function in the echo area. |
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
144 This information is extracted directly from the function or macro if it is |
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
145 in pure lisp. If the emacs function is a subr, the parameters are obtained |
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
146 from the documentation string if possible. |
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
147 |
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
148 If point is over a documented variable, print that variable's docstring |
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
149 instead. |
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
150 |
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
151 With prefix ARG, turn ElDoc mode on if and only if ARG is positive." |
ae8862effdf5
(eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
34127
diff
changeset
|
152 nil eldoc-minor-mode-string nil |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
153 (setq eldoc-last-message nil) |
49697
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
154 (if eldoc-mode |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
155 (progn |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
156 (add-hook 'post-command-hook 'eldoc-schedule-timer nil t) |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
157 (add-hook 'pre-command-hook 'eldoc-pre-command-refresh-echo-area t)) |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
158 (remove-hook 'post-command-hook 'eldoc-schedule-timer) |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
159 (remove-hook 'pre-command-hook 'eldoc-pre-command-refresh-echo-area))) |
13530 | 160 |
161 ;;;###autoload | |
162 (defun turn-on-eldoc-mode () | |
163 "Unequivocally turn on eldoc-mode (see variable documentation)." | |
164 (interactive) | |
165 (eldoc-mode 1)) | |
166 | |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
167 |
16969
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
168 ;; Idle timers are part of Emacs 19.31 and later. |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
169 (defun eldoc-schedule-timer () |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
170 (or (and eldoc-timer |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
171 (memq eldoc-timer timer-idle-list)) |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
172 (setq eldoc-timer |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
173 (run-with-idle-timer eldoc-idle-delay t |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
174 'eldoc-print-current-symbol-info))) |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
175 |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
176 ;; If user has changed the idle delay, update the timer. |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
177 (cond ((not (= eldoc-idle-delay eldoc-current-idle-delay)) |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
178 (setq eldoc-current-idle-delay eldoc-idle-delay) |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
179 (timer-set-idle-time eldoc-timer eldoc-idle-delay t)))) |
436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents:
16385
diff
changeset
|
180 |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
181 (defun eldoc-message (&rest args) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
182 (let ((omessage eldoc-last-message)) |
49697
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
183 (setq eldoc-last-message |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
184 (cond ((eq (car args) eldoc-last-message) eldoc-last-message) |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
185 ((null (car args)) nil) |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
186 ;; If only one arg, no formatting to do, so put it in |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
187 ;; eldoc-last-message so eq test above might succeed on |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
188 ;; subsequent calls. |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
189 ((null (cdr args)) (car args)) |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
190 (t (apply 'format args)))) |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
191 ;; In emacs 19.29 and later, and XEmacs 19.13 and later, all messages |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
192 ;; are recorded in a log. Do not put eldoc messages in that log since |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
193 ;; they are Legion. |
49697
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
194 ;; Emacs way of preventing log messages. |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
195 (let ((message-log-max nil)) |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
196 (cond (eldoc-last-message (message "%s" eldoc-last-message)) |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
197 (omessage (message nil))))) |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
198 eldoc-last-message) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
199 |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
200 ;; This function goes on pre-command-hook for XEmacs or when using idle |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
201 ;; timers in Emacs. Motion commands clear the echo area for some reason, |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
202 ;; which make eldoc messages flicker or disappear just before motion |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
203 ;; begins. This function reprints the last eldoc message immediately |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
204 ;; before the next command executes, which does away with the flicker. |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
205 ;; This doesn't seem to be required for Emacs 19.28 and earlier. |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
206 (defun eldoc-pre-command-refresh-echo-area () |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
207 (and eldoc-last-message |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
208 (if (eldoc-display-message-no-interference-p) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
209 (eldoc-message eldoc-last-message) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
210 (setq eldoc-last-message nil)))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
211 |
16975
188c4da9bf5d
(eldoc-display-message-p): New function.
Noah Friedman <friedman@splode.com>
parents:
16969
diff
changeset
|
212 ;; Decide whether now is a good time to display a message. |
188c4da9bf5d
(eldoc-display-message-p): New function.
Noah Friedman <friedman@splode.com>
parents:
16969
diff
changeset
|
213 (defun eldoc-display-message-p () |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
214 (and (eldoc-display-message-no-interference-p) |
49697
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
215 ;; If this-command is non-nil while running via an idle |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
216 ;; timer, we're still in the middle of executing a command, |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
217 ;; e.g. a query-replace where it would be annoying to |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
218 ;; overwrite the echo area. |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
219 (and (not this-command) |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
220 (symbolp last-command) |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
221 (intern-soft (symbol-name last-command) |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
222 eldoc-message-commands)))) |
13530 | 223 |
30389
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
224 ;; Check various conditions about the current environment that might make |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
225 ;; it undesirable to print eldoc messages right this instant. |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
226 (defun eldoc-display-message-no-interference-p () |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
227 (and eldoc-mode |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
228 (not executing-kbd-macro) |
30389
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
229 (not (and (boundp 'edebug-active) edebug-active)) |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
230 ;; Having this mode operate in an active minibuffer/echo area causes |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
231 ;; interference with what's going on there. |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
232 (not cursor-in-echo-area) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
233 (not (eq (selected-window) (minibuffer-window))))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
234 |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
235 |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
236 (defun eldoc-print-current-symbol-info () |
48470
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
237 (condition-case err |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
238 (and (eldoc-display-message-p) |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
239 (let* ((current-symbol (eldoc-current-symbol)) |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
240 (current-fnsym (eldoc-fnsym-in-current-sexp)) |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
241 (doc (cond |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
242 ((eq current-symbol current-fnsym) |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
243 (or (eldoc-get-fnsym-args-string current-fnsym) |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
244 (eldoc-get-var-docstring current-symbol))) |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
245 (t |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
246 (or (eldoc-get-var-docstring current-symbol) |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
247 (eldoc-get-fnsym-args-string current-fnsym)))))) |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
248 (eldoc-message doc))) |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
249 ;; This is run from post-command-hook or some idle timer thing, |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
250 ;; so we need to be careful that errors aren't ignored. |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
251 (error (message "eldoc error: %s" err)))) |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
252 |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
253 ;; Return a string containing the function parameter list, or 1-line |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
254 ;; docstring if function is a subr and no arglist is obtainable from the |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
255 ;; docstring or elsewhere. |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
256 (defun eldoc-get-fnsym-args-string (sym) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
257 (let ((args nil) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
258 (doc nil)) |
49697
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
259 (cond ((not (and sym (symbolp sym) (fboundp sym)))) |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
260 ((and (eq sym (aref eldoc-last-data 0)) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
261 (eq 'function (aref eldoc-last-data 2))) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
262 (setq doc (aref eldoc-last-data 1))) |
48470
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
263 ((setq doc (help-split-fundoc (documentation sym t) sym)) |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
264 (setq args (car doc)) |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
265 (string-match "\\`[^ )]* ?" args) |
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
266 (setq args (concat "(" (substring args (match-end 0))))) |
13530 | 267 (t |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
268 (setq args (eldoc-function-argstring sym)))) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
269 (cond (args |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
270 (setq doc (eldoc-docstring-format-sym-doc sym args)) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
271 (eldoc-last-data-store sym doc 'function))) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
272 doc)) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
273 |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
274 ;; Return a string containing a brief (one-line) documentation string for |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
275 ;; the variable. |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
276 (defun eldoc-get-var-docstring (sym) |
49017
09ff6e632947
(eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents:
48470
diff
changeset
|
277 (when sym |
09ff6e632947
(eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents:
48470
diff
changeset
|
278 (cond ((and (eq sym (aref eldoc-last-data 0)) |
09ff6e632947
(eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents:
48470
diff
changeset
|
279 (eq 'variable (aref eldoc-last-data 2))) |
09ff6e632947
(eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents:
48470
diff
changeset
|
280 (aref eldoc-last-data 1)) |
09ff6e632947
(eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents:
48470
diff
changeset
|
281 (t |
09ff6e632947
(eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents:
48470
diff
changeset
|
282 (let ((doc (documentation-property sym 'variable-documentation t))) |
09ff6e632947
(eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents:
48470
diff
changeset
|
283 (cond (doc |
09ff6e632947
(eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents:
48470
diff
changeset
|
284 (setq doc (eldoc-docstring-format-sym-doc |
09ff6e632947
(eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents:
48470
diff
changeset
|
285 sym (eldoc-docstring-first-line doc))) |
09ff6e632947
(eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents:
48470
diff
changeset
|
286 (eldoc-last-data-store sym doc 'variable))) |
09ff6e632947
(eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents:
48470
diff
changeset
|
287 doc))))) |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
288 |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
289 (defun eldoc-last-data-store (symbol doc type) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
290 (aset eldoc-last-data 0 symbol) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
291 (aset eldoc-last-data 1 doc) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
292 (aset eldoc-last-data 2 type)) |
13530 | 293 |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
294 ;; Note that any leading `*' in the docstring (which indicates the variable |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
295 ;; is a user option) is removed. |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
296 (defun eldoc-docstring-first-line (doc) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
297 (and (stringp doc) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
298 (substitute-command-keys |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
299 (save-match-data |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
300 (let ((start (if (string-match "^\\*" doc) (match-end 0) 0))) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
301 (cond ((string-match "\n" doc) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
302 (substring doc start (match-beginning 0))) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
303 ((zerop start) doc) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
304 (t (substring doc start)))))))) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
305 |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
306 ;; If the entire line cannot fit in the echo area, the symbol name may be |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
307 ;; truncated or eliminated entirely from the output to make room for the |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
308 ;; description. |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
309 (defun eldoc-docstring-format-sym-doc (sym doc) |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
310 (save-match-data |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
311 (let* ((name (symbol-name sym)) |
49697
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
312 (ea-multi eldoc-echo-area-use-multiline-p) |
30389
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
313 ;; Subtract 1 from window width since emacs will not write |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
314 ;; any chars to the last column, or in later versions, will |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
315 ;; cause a wraparound and resize of the echo area. |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
316 (ea-width (1- (window-width (minibuffer-window)))) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
317 (strip (- (+ (length name) (length ": ") (length doc)) ea-width))) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
318 (cond ((or (<= strip 0) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
319 (eq ea-multi t) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
320 (and ea-multi (> (length doc) ea-width))) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
321 (format "%s: %s" sym doc)) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
322 ((> (length doc) ea-width) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
323 (substring (format "%s" doc) 0 ea-width)) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
324 ((>= strip (length name)) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
325 (format "%s" doc)) |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
326 (t |
30389
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
327 ;; Show the end of the partial symbol name, rather |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
328 ;; than the beginning, since the former is more likely |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
329 ;; to be unique given package namespace conventions. |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
330 (setq name (substring name strip)) |
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
331 (format "%s: %s" name doc)))))) |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
332 |
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
333 |
13530 | 334 (defun eldoc-fnsym-in-current-sexp () |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
335 (let ((p (point))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
336 (eldoc-beginning-of-sexp) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
337 (prog1 |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
338 ;; Don't do anything if current word is inside a string. |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
339 (if (= (or (char-after (1- (point))) 0) ?\") |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
340 nil |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
341 (eldoc-current-symbol)) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
342 (goto-char p)))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
343 |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
344 (defun eldoc-beginning-of-sexp () |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
345 (let ((parse-sexp-ignore-comments t)) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
346 (condition-case err |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
347 (while (progn |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
348 (forward-sexp -1) |
48470
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
349 (or (= (char-before) ?\") |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
350 (> (point) (point-min))))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
351 (error nil)))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
352 |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
353 ;; returns nil unless current word is an interned symbol. |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
354 (defun eldoc-current-symbol () |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
355 (let ((c (char-after (point)))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
356 (and c |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
357 (memq (char-syntax c) '(?w ?_)) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
358 (intern-soft (current-word))))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
359 |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
360 ;; Do indirect function resolution if possible. |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
361 (defun eldoc-symbol-function (fsym) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
362 (let ((defn (and (fboundp fsym) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
363 (symbol-function fsym)))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
364 (and (symbolp defn) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
365 (condition-case err |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
366 (setq defn (indirect-function fsym)) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
367 (error (setq defn nil)))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
368 defn)) |
13530 | 369 |
30389
38f19553e93d
(eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents:
23586
diff
changeset
|
370 (defun eldoc-function-argstring (fn) |
48470
5a25c61f2c8b
(eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42623
diff
changeset
|
371 (eldoc-function-argstring-format (help-function-arglist fn))) |
13530 | 372 |
373 (defun eldoc-function-argstring-format (arglist) | |
374 (cond ((not (listp arglist)) | |
375 (setq arglist nil)) | |
376 ((symbolp (car arglist)) | |
377 (setq arglist | |
378 (mapcar (function (lambda (s) | |
379 (if (memq s '(&optional &rest)) | |
380 (symbol-name s) | |
381 (funcall eldoc-argument-case | |
382 (symbol-name s))))) | |
383 arglist))) | |
384 ((stringp (car arglist)) | |
385 (setq arglist | |
386 (mapcar (function (lambda (s) | |
387 (if (member s '("&optional" "&rest")) | |
388 s | |
389 (funcall eldoc-argument-case s)))) | |
390 arglist)))) | |
391 (concat "(" (mapconcat 'identity arglist " ") ")")) | |
392 | |
393 | |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
394 ;; When point is in a sexp, the function args are not reprinted in the echo |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
395 ;; area after every possible interactive command because some of them print |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
396 ;; their own messages in the echo area; the eldoc functions would instantly |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
397 ;; overwrite them unless it is more restrained. |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
398 ;; These functions do display-command table management. |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
399 |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
400 (defun eldoc-add-command (&rest cmds) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
401 (or eldoc-message-commands |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
402 (setq eldoc-message-commands |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
403 (make-vector eldoc-message-commands-table-size 0))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
404 |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
405 (let (name sym) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
406 (while cmds |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
407 (setq name (car cmds)) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
408 (setq cmds (cdr cmds)) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
409 |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
410 (cond ((symbolp name) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
411 (setq sym name) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
412 (setq name (symbol-name sym))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
413 ((stringp name) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
414 (setq sym (intern-soft name)))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
415 |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
416 (and (symbolp sym) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
417 (fboundp sym) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
418 (set (intern name eldoc-message-commands) t))))) |
13530 | 419 |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
420 (defun eldoc-add-command-completions (&rest names) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
421 (while names |
49697
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
422 (apply 'eldoc-add-command |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
423 (all-completions (car names) obarray 'fboundp)) |
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
424 (setq names (cdr names)))) |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
425 |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
426 (defun eldoc-remove-command (&rest cmds) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
427 (let (name) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
428 (while cmds |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
429 (setq name (car cmds)) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
430 (setq cmds (cdr cmds)) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
431 |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
432 (and (symbolp name) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
433 (setq name (symbol-name name))) |
13530 | 434 |
49697
eb34aebd1084
(eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49018
diff
changeset
|
435 (unintern name eldoc-message-commands)))) |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
436 |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
437 (defun eldoc-remove-command-completions (&rest names) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
438 (while names |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
439 (apply 'eldoc-remove-command |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
440 (all-completions (car names) eldoc-message-commands)) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
441 (setq names (cdr names)))) |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
442 |
23283
2442a5dce1a8
(eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents:
18699
diff
changeset
|
443 |
16996
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
444 ;; Prime the command list. |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
445 (eldoc-add-command-completions |
2d67501c45b9
(eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents:
16975
diff
changeset
|
446 "backward-" "beginning-of-" "delete-other-windows" "delete-window" |
17920
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
447 "end-of-" "forward-" "indent-for-tab-command" "goto-" "mouse-set-point" |
161cc8316f98
(eldoc-message-commands): Move docstring into comments, since this isn't
Noah Friedman <friedman@splode.com>
parents:
17445
diff
changeset
|
448 "next-" "other-window" "previous-" "recenter" "scroll-" |
18699
c6cf53a7da72
[top level]: Add `up-list' and `down-list' to eldoc-message-commands.
Noah Friedman <friedman@splode.com>
parents:
17920
diff
changeset
|
449 "self-insert-command" "split-window-" |
c6cf53a7da72
[top level]: Add `up-list' and `down-list' to eldoc-message-commands.
Noah Friedman <friedman@splode.com>
parents:
17920
diff
changeset
|
450 "up-list" "down-list") |
13530 | 451 |
452 (provide 'eldoc) | |
453 | |
454 ;;; eldoc.el ends here |