Mercurial > emacs
annotate lispref/loading.texi @ 82966:28d9e552d178
Merge some changes from Emacs/trunk:
2004-08-22 Reiner Steib <Reiner.Steib@gmx.de>
* gnus-mlspl.el (gnus-group-split-update): Fix docstring.
2004-08-22 Stefan Monnier <monnier@iro.umontreal.ca>
* gnus-art.el: Use inhibit-read-only instead of buffer-read-only.
(gnus-narrow-to-page): Don't assume point-min == 1.
(gnus-article-edit-mode): Derive from message-mode.
* gnus-score.el (gnus-score-find-bnews): Simplify and don't assume
point-min == 1.
* imap.el (imap-parse-address-list, imap-parse-body-ext):
Disable incorrect use of `assert'.
[Emacs/trunk 2004-03-22]
* message.el (message-mode): Set comment-start-skip.
[Emacs/trunk 2004-03-04]
2004-08-22 Sam Steingold <sds@gnu.org>
* pop3.el (pop3-leave-mail-on-server): New user variable.
(pop3-movemail): Delete mail only when it is nil.
[Emacs/trunk 2003-06-11]
author | Reiner Steib <Reiner.Steib@gmx.de> |
---|---|
date | Sun, 22 Aug 2004 19:35:29 +0000 |
parents | c9aa4127a482 |
children | 26d02bae850d 59dcbfe97385 |
rev | line source |
---|---|
6453 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
56215 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, |
4 @c 2003, 2004 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48733
diff
changeset
|
5 @c Free Software Foundation, Inc. |
6453 | 6 @c See the file elisp.texi for copying conditions. |
7 @setfilename ../info/loading | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
8 @node Loading, Byte Compilation, Customization, Top |
6453 | 9 @chapter Loading |
10 @cindex loading | |
11 @cindex library | |
12 @cindex Lisp library | |
13 | |
14 Loading a file of Lisp code means bringing its contents into the Lisp | |
15 environment in the form of Lisp objects. Emacs finds and opens the | |
16 file, reads the text, evaluates each form, and then closes the file. | |
17 | |
18 The load functions evaluate all the expressions in a file just | |
19 as the @code{eval-current-buffer} function evaluates all the | |
20 expressions in a buffer. The difference is that the load functions | |
21 read and evaluate the text in the file as found on disk, not the text | |
22 in an Emacs buffer. | |
23 | |
24 @cindex top-level form | |
25 The loaded file must contain Lisp expressions, either as source code | |
7212 | 26 or as byte-compiled code. Each form in the file is called a |
27 @dfn{top-level form}. There is no special format for the forms in a | |
6453 | 28 loadable file; any form in a file may equally well be typed directly |
29 into a buffer and evaluated there. (Indeed, most code is tested this | |
30 way.) Most often, the forms are function definitions and variable | |
31 definitions. | |
32 | |
33 A file containing Lisp code is often called a @dfn{library}. Thus, | |
34 the ``Rmail library'' is a file containing code for Rmail mode. | |
35 Similarly, a ``Lisp library directory'' is a directory of files | |
36 containing Lisp code. | |
37 | |
38 @menu | |
39 * How Programs Do Loading:: The @code{load} function and others. | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
40 * Library Search:: Finding a library to load. |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52764
diff
changeset
|
41 * Loading Non-ASCII:: Non-@acronym{ASCII} characters in Emacs Lisp files. |
6453 | 42 * Autoload:: Setting up a function to autoload. |
43 * Repeated Loading:: Precautions about loading a file twice. | |
12098 | 44 * Named Features:: Loading a library if it isn't already loaded. |
6453 | 45 * Unloading:: How to ``unload'' a library that was loaded. |
46 * Hooks for Loading:: Providing code to be run when | |
47 particular libraries are loaded. | |
48 @end menu | |
49 | |
50 @node How Programs Do Loading | |
51 @section How Programs Do Loading | |
52 | |
53 Emacs Lisp has several interfaces for loading. For example, | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
54 @code{autoload} creates a placeholder object for a function defined in a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
55 file; trying to call the autoloading function loads the file to get the |
6453 | 56 function's real definition (@pxref{Autoload}). @code{require} loads a |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
57 file if it isn't already loaded (@pxref{Named Features}). Ultimately, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
58 all these facilities call the @code{load} function to do the work. |
6453 | 59 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
60 @defun load filename &optional missing-ok nomessage nosuffix must-suffix |
6453 | 61 This function finds and opens a file of Lisp code, evaluates all the |
62 forms in it, and closes the file. | |
63 | |
64 To find the file, @code{load} first looks for a file named | |
65 @file{@var{filename}.elc}, that is, for a file whose name is | |
66 @var{filename} with @samp{.elc} appended. If such a file exists, it is | |
67 loaded. If there is no file by that name, then @code{load} looks for a | |
7212 | 68 file named @file{@var{filename}.el}. If that file exists, it is loaded. |
6453 | 69 Finally, if neither of those names is found, @code{load} looks for a |
70 file named @var{filename} with nothing appended, and loads it if it | |
71 exists. (The @code{load} function is not clever about looking at | |
72 @var{filename}. In the perverse case of a file named @file{foo.el.el}, | |
73 evaluation of @code{(load "foo.el")} will indeed find it.) | |
74 | |
75 If the optional argument @var{nosuffix} is non-@code{nil}, then the | |
76 suffixes @samp{.elc} and @samp{.el} are not tried. In this case, you | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
77 must specify the precise file name you want. By specifying the precise |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
78 file name and using @code{t} for @var{nosuffix}, you can prevent |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
79 perverse file names such as @file{foo.el.el} from being tried. |
6453 | 80 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
81 If the optional argument @var{must-suffix} is non-@code{nil}, then |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
82 @code{load} insists that the file name used must end in either |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
83 @samp{.el} or @samp{.elc}, unless it contains an explicit directory |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
84 name. If @var{filename} does not contain an explicit directory name, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
85 and does not end in a suffix, then @code{load} insists on adding one. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
86 |
6453 | 87 If @var{filename} is a relative file name, such as @file{foo} or |
88 @file{baz/foo.bar}, @code{load} searches for the file using the variable | |
89 @code{load-path}. It appends @var{filename} to each of the directories | |
90 listed in @code{load-path}, and loads the first file it finds whose name | |
91 matches. The current default directory is tried only if it is specified | |
92 in @code{load-path}, where @code{nil} stands for the default directory. | |
93 @code{load} tries all three possible suffixes in the first directory in | |
94 @code{load-path}, then all three suffixes in the second directory, and | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
95 so on. @xref{Library Search}. |
6453 | 96 |
97 If you get a warning that @file{foo.elc} is older than @file{foo.el}, it | |
98 means you should consider recompiling @file{foo.el}. @xref{Byte | |
99 Compilation}. | |
100 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
101 When loading a source file (not compiled), @code{load} performs |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
102 character set translation just as Emacs would do when visiting the file. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
103 @xref{Coding Systems}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
104 |
6453 | 105 Messages like @samp{Loading foo...} and @samp{Loading foo...done} appear |
106 in the echo area during loading unless @var{nomessage} is | |
107 non-@code{nil}. | |
108 | |
109 @cindex load errors | |
110 Any unhandled errors while loading a file terminate loading. If the | |
7212 | 111 load was done for the sake of @code{autoload}, any function definitions |
112 made during the loading are undone. | |
6453 | 113 |
114 @kindex file-error | |
115 If @code{load} can't find the file to load, then normally it signals the | |
116 error @code{file-error} (with @samp{Cannot open load file | |
117 @var{filename}}). But if @var{missing-ok} is non-@code{nil}, then | |
118 @code{load} just returns @code{nil}. | |
119 | |
12067 | 120 You can use the variable @code{load-read-function} to specify a function |
121 for @code{load} to use instead of @code{read} for reading expressions. | |
122 See below. | |
123 | |
6453 | 124 @code{load} returns @code{t} if the file loads successfully. |
125 @end defun | |
126 | |
127 @deffn Command load-file filename | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
128 This command loads the file @var{filename}. If @var{filename} is a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
129 relative file name, then the current default directory is assumed. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
130 @code{load-path} is not used, and suffixes are not appended. Use this |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
131 command if you wish to specify precisely the file name to load. |
6453 | 132 @end deffn |
133 | |
134 @deffn Command load-library library | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
135 This command loads the library named @var{library}. It is equivalent to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
136 @code{load}, except in how it reads its argument interactively. |
6453 | 137 @end deffn |
138 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
139 @defvar load-in-progress |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
140 This variable is non-@code{nil} if Emacs is in the process of loading a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
141 file, and it is @code{nil} otherwise. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
142 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
143 |
56215 | 144 @defvar load-read-function |
53299
3abc89cd99a2
(How Programs Do Loading): Add anchor.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
145 @anchor{Definition of load-read-function} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
146 This variable specifies an alternate expression-reading function for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
147 @code{load} and @code{eval-region} to use instead of @code{read}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
148 The function should accept one argument, just as @code{read} does. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
149 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
150 Normally, the variable's value is @code{nil}, which means those |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
151 functions should use @code{read}. |
22419
3967db186db6
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
152 |
52626 | 153 Instead of using this variable, it is cleaner to use another, newer |
154 feature: to pass the function as the @var{read-function} argument to | |
53299
3abc89cd99a2
(How Programs Do Loading): Add anchor.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52978
diff
changeset
|
155 @code{eval-region}. @xref{Definition of eval-region,, Eval}. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
156 @end defvar |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
157 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
158 For information about how @code{load} is used in building Emacs, see |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
159 @ref{Building Emacs}. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
160 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
161 @node Library Search |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
162 @section Library Search |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
163 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
164 When Emacs loads a Lisp library, it searches for the library |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
165 in a list of directories specified by the variable @code{load-path}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
166 |
6453 | 167 @defopt load-path |
168 @cindex @code{EMACSLOADPATH} environment variable | |
169 The value of this variable is a list of directories to search when | |
170 loading files with @code{load}. Each element is a string (which must be | |
171 a directory name) or @code{nil} (which stands for the current working | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
172 directory). |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
173 @end defopt |
6453 | 174 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
175 The value of @code{load-path} is initialized from the environment |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
176 variable @code{EMACSLOADPATH}, if that exists; otherwise its default |
54035
5089d03a2061
(Unloading): Document unload-feature-special-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
53299
diff
changeset
|
177 value is specified in @file{emacs/src/epaths.h} when Emacs is built. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
178 Then the list is expanded by adding subdirectories of the directories |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
179 in the list. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
180 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
181 The syntax of @code{EMACSLOADPATH} is the same as used for @code{PATH}; |
12098 | 182 @samp{:} (or @samp{;}, according to the operating system) separates |
183 directory names, and @samp{.} is used for the current default directory. | |
184 Here is an example of how to set your @code{EMACSLOADPATH} variable from | |
185 a @code{csh} @file{.login} file: | |
6453 | 186 |
187 @smallexample | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
188 setenv EMACSLOADPATH .:/user/bil/emacs:/usr/local/share/emacs/20.3/lisp |
6453 | 189 @end smallexample |
190 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
191 Here is how to set it using @code{sh}: |
6453 | 192 |
193 @smallexample | |
194 export EMACSLOADPATH | |
22271
71f954d59214
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
195 EMACSLOADPATH=.:/user/bil/emacs:/usr/local/share/emacs/20.3/lisp |
6453 | 196 @end smallexample |
197 | |
25875 | 198 Here is an example of code you can place in your init file (@pxref{Init |
199 File}) to add several directories to the front of your default | |
200 @code{load-path}: | |
6453 | 201 |
202 @smallexample | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
203 @group |
6453 | 204 (setq load-path |
205 (append (list nil "/user/bil/emacs" | |
206 "/usr/local/lisplib" | |
12315
49a48bf414c7
Fix up load-path example.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
207 "~/emacs") |
6453 | 208 load-path)) |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
209 @end group |
6453 | 210 @end smallexample |
211 | |
212 @c Wordy to rid us of an overfull hbox. --rjc 15mar92 | |
213 @noindent | |
214 In this example, the path searches the current working directory first, | |
12315
49a48bf414c7
Fix up load-path example.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
215 followed then by the @file{/user/bil/emacs} directory, the |
49a48bf414c7
Fix up load-path example.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
216 @file{/usr/local/lisplib} directory, and the @file{~/emacs} directory, |
6453 | 217 which are then followed by the standard directories for Lisp code. |
218 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
219 Dumping Emacs uses a special value of @code{load-path}. If the value of |
10659
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
220 @code{load-path} at the end of dumping is unchanged (that is, still the |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
221 same special value), the dumped Emacs switches to the ordinary |
12128
27144f55d1c6
fixed errors that appeared during update to 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
222 @code{load-path} value when it starts up, as described above. But if |
10659
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
223 @code{load-path} has any other value at the end of dumping, that value |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
224 is used for execution of the dumped Emacs also. |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
225 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
226 Therefore, if you want to change @code{load-path} temporarily for |
10659
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
227 loading a few libraries in @file{site-init.el} or @file{site-load.el}, |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
228 you should bind @code{load-path} locally with @code{let} around the |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
229 calls to @code{load}. |
6453 | 230 |
15767
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
231 The default value of @code{load-path}, when running an Emacs which has |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
232 been installed on the system, includes two special directories (and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
233 their subdirectories as well): |
15767
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
234 |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
235 @smallexample |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
236 "/usr/local/share/emacs/@var{version}/site-lisp" |
15767
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
237 @end smallexample |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
238 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
239 @noindent |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
240 and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
241 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
242 @smallexample |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
243 "/usr/local/share/emacs/site-lisp" |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
244 @end smallexample |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
245 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
246 @noindent |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
247 The first one is for locally installed packages for a particular Emacs |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
248 version; the second is for locally installed packages meant for use with |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
249 all installed Emacs versions. |
15767
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
250 |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
251 There are several reasons why a Lisp package that works well in one |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
252 Emacs version can cause trouble in another. Sometimes packages need |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
253 updating for incompatible changes in Emacs; sometimes they depend on |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
254 undocumented internal Emacs data that can change without notice; |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
255 sometimes a newer Emacs version incorporates a version of the package, |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
256 and should be used only with that version. |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
257 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
258 Emacs finds these directories' subdirectories and adds them to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
259 @code{load-path} when it starts up. Both immediate subdirectories and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
260 subdirectories multiple levels down are added to @code{load-path}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
261 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
262 Not all subdirectories are included, though. Subdirectories whose |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
263 names do not start with a letter or digit are excluded. Subdirectories |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
264 named @file{RCS} or @file{CVS} are excluded. Also, a subdirectory which |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
265 contains a file named @file{.nosearch} is excluded. You can use these |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
266 methods to prevent certain subdirectories of the @file{site-lisp} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
267 directories from being searched. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
268 |
15767
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
269 If you run Emacs from the directory where it was built---that is, an |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
270 executable that has not been formally installed---then @code{load-path} |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
271 normally contains two additional directories. These are the @code{lisp} |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
272 and @code{site-lisp} subdirectories of the main build directory. (Both |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
273 are represented as absolute file names.) |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
274 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
275 @deffn Command locate-library library &optional nosuffix path interactive-call |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
276 This command finds the precise file name for library @var{library}. It |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
277 searches for the library in the same way @code{load} does, and the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
278 argument @var{nosuffix} has the same meaning as in @code{load}: don't |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
279 add suffixes @samp{.elc} or @samp{.el} to the specified name |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
280 @var{library}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
281 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
282 If the @var{path} is non-@code{nil}, that list of directories is used |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
283 instead of @code{load-path}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
284 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
285 When @code{locate-library} is called from a program, it returns the file |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
286 name as a string. When the user runs @code{locate-library} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
287 interactively, the argument @var{interactive-call} is @code{t}, and this |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
288 tells @code{locate-library} to display the file name in the echo area. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
289 @end deffn |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
290 |
51915
ac3f1b24be99
(Library Search): Add load-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
51681
diff
changeset
|
291 @defvar load-suffixes |
ac3f1b24be99
(Library Search): Add load-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
51681
diff
changeset
|
292 This variable is a list of suffixes (strings) that @code{load} should |
ac3f1b24be99
(Library Search): Add load-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
51681
diff
changeset
|
293 try adding to the specified file name. The default value is |
52764
f2fb09e111f7
(Library Search): Correct default value of load-suffixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52760
diff
changeset
|
294 @code{(".elc" ".el")}. There is no need to include the null suffix. |
51915
ac3f1b24be99
(Library Search): Add load-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
51681
diff
changeset
|
295 @end defvar |
ac3f1b24be99
(Library Search): Add load-suffixes.
Richard M. Stallman <rms@gnu.org>
parents:
51681
diff
changeset
|
296 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
297 @node Loading Non-ASCII |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52764
diff
changeset
|
298 @section Loading Non-@acronym{ASCII} Characters |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
299 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52764
diff
changeset
|
300 When Emacs Lisp programs contain string constants with non-@acronym{ASCII} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
301 characters, these can be represented within Emacs either as unibyte |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
302 strings or as multibyte strings (@pxref{Text Representations}). Which |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
303 representation is used depends on how the file is read into Emacs. If |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
304 it is read with decoding into multibyte representation, the text of the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
305 Lisp program will be multibyte text, and its string constants will be |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
306 multibyte strings. If a file containing Latin-1 characters (for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
307 example) is read without decoding, the text of the program will be |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
308 unibyte text, and its string constants will be unibyte strings. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
309 @xref{Coding Systems}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
310 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
311 To make the results more predictable, Emacs always performs decoding |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
312 into the multibyte representation when loading Lisp files, even if it |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
313 was started with the @samp{--unibyte} option. This means that string |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52764
diff
changeset
|
314 constants with non-@acronym{ASCII} characters translate into multibyte |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
315 strings. The only exception is when a particular file specifies no |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
316 decoding. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
317 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
318 The reason Emacs is designed this way is so that Lisp programs give |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
319 predictable results, regardless of how Emacs was started. In addition, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
320 this enables programs that depend on using multibyte text to work even |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
321 in a unibyte Emacs. Of course, such programs should be designed to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
322 notice whether the user prefers unibyte or multibyte text, by checking |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
323 @code{default-enable-multibyte-characters}, and convert representations |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
324 appropriately. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
325 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52764
diff
changeset
|
326 In most Emacs Lisp programs, the fact that non-@acronym{ASCII} strings are |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
327 multibyte strings should not be noticeable, since inserting them in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
328 unibyte buffers converts them to unibyte automatically. However, if |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
329 this does make a difference, you can force a particular Lisp file to be |
22675
cbab915f61bb
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22623
diff
changeset
|
330 interpreted as unibyte by writing @samp{-*-unibyte: t;-*-} in a |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
331 comment on the file's first line. With that designator, the file will |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
332 unconditionally be interpreted as unibyte, even in an ordinary |
30499
e603bf6a21ad
Mention keybindings of non-ASCII chars.
Dave Love <fx@gnu.org>
parents:
28603
diff
changeset
|
333 multibyte Emacs session. This can matter when making keybindings to |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52764
diff
changeset
|
334 non-@acronym{ASCII} characters written as @code{?v@var{literal}}. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
335 |
6453 | 336 @node Autoload |
337 @section Autoload | |
338 @cindex autoload | |
339 | |
340 The @dfn{autoload} facility allows you to make a function or macro | |
12098 | 341 known in Lisp, but put off loading the file that defines it. The first |
342 call to the function automatically reads the proper file to install the | |
343 real definition and other associated code, then runs the real definition | |
6453 | 344 as if it had been loaded all along. |
345 | |
346 There are two ways to set up an autoloaded function: by calling | |
347 @code{autoload}, and by writing a special ``magic'' comment in the | |
348 source before the real definition. @code{autoload} is the low-level | |
349 primitive for autoloading; any Lisp program can call @code{autoload} at | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
350 any time. Magic comments are the most convenient way to make a function |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
351 autoload, for packages installed along with Emacs. These comments do |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
352 nothing on their own, but they serve as a guide for the command |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
353 @code{update-file-autoloads}, which constructs calls to @code{autoload} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
354 and arranges to execute them when Emacs is built. |
6453 | 355 |
7212 | 356 @defun autoload function filename &optional docstring interactive type |
357 This function defines the function (or macro) named @var{function} so as | |
6453 | 358 to load automatically from @var{filename}. The string @var{filename} |
359 specifies the file to load to get the real definition of @var{function}. | |
360 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
361 If @var{filename} does not contain either a directory name, or the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
362 suffix @code{.el} or @code{.elc}, then @code{autoload} insists on adding |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
363 one of these suffixes, and it will not load from a file whose name is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
364 just @var{filename} with no added suffix. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
365 |
6453 | 366 The argument @var{docstring} is the documentation string for the |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
367 function. Normally, this should be identical to the documentation string |
6453 | 368 in the function definition itself. Specifying the documentation string |
369 in the call to @code{autoload} makes it possible to look at the | |
370 documentation without loading the function's real definition. | |
371 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
372 If @var{interactive} is non-@code{nil}, that says @var{function} can be |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
373 called interactively. This lets completion in @kbd{M-x} work without |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
374 loading @var{function}'s real definition. The complete interactive |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
375 specification is not given here; it's not needed unless the user |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
376 actually calls @var{function}, and when that happens, it's time to load |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
377 the real definition. |
6453 | 378 |
379 You can autoload macros and keymaps as well as ordinary functions. | |
380 Specify @var{type} as @code{macro} if @var{function} is really a macro. | |
381 Specify @var{type} as @code{keymap} if @var{function} is really a | |
382 keymap. Various parts of Emacs need to know this information without | |
383 loading the real definition. | |
384 | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
385 An autoloaded keymap loads automatically during key lookup when a prefix |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
386 key's binding is the symbol @var{function}. Autoloading does not occur |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
387 for other kinds of access to the keymap. In particular, it does not |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
388 happen when a Lisp program gets the keymap from the value of a variable |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
389 and calls @code{define-key}; not even if the variable name is the same |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
390 symbol @var{function}. |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
391 |
6453 | 392 @cindex function cell in autoload |
7212 | 393 If @var{function} already has a non-void function definition that is not |
6453 | 394 an autoload object, @code{autoload} does nothing and returns @code{nil}. |
7212 | 395 If the function cell of @var{function} is void, or is already an autoload |
6453 | 396 object, then it is defined as an autoload object like this: |
397 | |
398 @example | |
399 (autoload @var{filename} @var{docstring} @var{interactive} @var{type}) | |
400 @end example | |
401 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48733
diff
changeset
|
402 For example, |
6453 | 403 |
404 @example | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
405 @group |
6453 | 406 (symbol-function 'run-prolog) |
407 @result{} (autoload "prolog" 169681 t nil) | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
408 @end group |
6453 | 409 @end example |
410 | |
411 @noindent | |
412 In this case, @code{"prolog"} is the name of the file to load, 169681 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
413 refers to the documentation string in the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
414 @file{emacs/etc/DOC-@var{version}} file (@pxref{Documentation Basics}), |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
415 @code{t} means the function is interactive, and @code{nil} that it is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
416 not a macro or a keymap. |
6453 | 417 @end defun |
418 | |
419 @cindex autoload errors | |
420 The autoloaded file usually contains other definitions and may require | |
421 or provide one or more features. If the file is not completely loaded | |
422 (due to an error in the evaluation of its contents), any function | |
423 definitions or @code{provide} calls that occurred during the load are | |
424 undone. This is to ensure that the next attempt to call any function | |
425 autoloading from this file will try again to load the file. If not for | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
426 this, then some of the functions in the file might be defined by the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
427 aborted load, but fail to work properly for the lack of certain |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
428 subroutines not loaded successfully because they come later in the file. |
6453 | 429 |
430 If the autoloaded file fails to define the desired Lisp function or | |
431 macro, then an error is signaled with data @code{"Autoloading failed to | |
432 define function @var{function-name}"}. | |
433 | |
434 @findex update-file-autoloads | |
435 @findex update-directory-autoloads | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
436 A magic autoload comment consists of @samp{;;;###autoload}, on a line |
6453 | 437 by itself, just before the real definition of the function in its |
438 autoloadable source file. The command @kbd{M-x update-file-autoloads} | |
439 writes a corresponding @code{autoload} call into @file{loaddefs.el}. | |
440 Building Emacs loads @file{loaddefs.el} and thus calls @code{autoload}. | |
441 @kbd{M-x update-directory-autoloads} is even more powerful; it updates | |
442 autoloads for all files in the current directory. | |
443 | |
444 The same magic comment can copy any kind of form into | |
445 @file{loaddefs.el}. If the form following the magic comment is not a | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
446 function-defining form or a @code{defcustom} form, it is copied |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
447 verbatim. ``Function-defining forms'' include @code{define-skeleton}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
448 @code{define-derived-mode}, @code{define-generic-mode} and |
28603
cb9db16dba12
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
449 @code{define-minor-mode} as well as @code{defun} and |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
450 @code{defmacro}. To save space, a @code{defcustom} form is converted to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
451 a @code{defvar} in @file{loaddefs.el}, with some additional information |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
452 if it uses @code{:require}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
453 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
454 You can also use a magic comment to execute a form at build time |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
455 @emph{without} executing it when the file itself is loaded. To do this, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
456 write the form @emph{on the same line} as the magic comment. Since it |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
457 is in a comment, it does nothing when you load the source file; but |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
458 @kbd{M-x update-file-autoloads} copies it to @file{loaddefs.el}, where |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
459 it is executed while building Emacs. |
6453 | 460 |
461 The following example shows how @code{doctor} is prepared for | |
462 autoloading with a magic comment: | |
463 | |
464 @smallexample | |
465 ;;;###autoload | |
466 (defun doctor () | |
467 "Switch to *doctor* buffer and start giving psychotherapy." | |
468 (interactive) | |
469 (switch-to-buffer "*doctor*") | |
470 (doctor-mode)) | |
471 @end smallexample | |
472 | |
473 @noindent | |
474 Here's what that produces in @file{loaddefs.el}: | |
475 | |
476 @smallexample | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
477 (autoload 'doctor "doctor" "\ |
6453 | 478 Switch to *doctor* buffer and start giving psychotherapy." |
479 t) | |
480 @end smallexample | |
481 | |
482 @noindent | |
483 The backslash and newline immediately following the double-quote are a | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
484 convention used only in the preloaded uncompiled Lisp files such as |
6453 | 485 @file{loaddefs.el}; they tell @code{make-docfile} to put the |
486 documentation string in the @file{etc/DOC} file. @xref{Building Emacs}. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
487 See also the commentary in @file{lib-src/make-docfile.c}. |
6453 | 488 |
42769
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
489 If you write a function definition with an unusual macro that is not |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
490 one of the known and recognized function definition methods, use of an |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
491 ordinary magic autoload comment would copy the whole definition into |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
492 @code{loaddefs.el}. That is not desirable. You can put the desired |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
493 @code{autoload} call into @code{loaddefs.el} instead by writing this: |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
494 |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
495 @smallexample |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
496 ;;;###autoload (autoload 'foo "myfile") |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
497 (mydefunmacro foo |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
498 ...) |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
499 @end smallexample |
c3e528c6c110
(Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents:
39169
diff
changeset
|
500 |
6453 | 501 @node Repeated Loading |
502 @section Repeated Loading | |
503 @cindex repeated loading | |
504 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
505 You can load a given file more than once in an Emacs session. For |
6453 | 506 example, after you have rewritten and reinstalled a function definition |
507 by editing it in a buffer, you may wish to return to the original | |
508 version; you can do this by reloading the file it came from. | |
509 | |
510 When you load or reload files, bear in mind that the @code{load} and | |
511 @code{load-library} functions automatically load a byte-compiled file | |
512 rather than a non-compiled file of similar name. If you rewrite a file | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
513 that you intend to save and reinstall, you need to byte-compile the new |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
514 version; otherwise Emacs will load the older, byte-compiled file instead |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
515 of your newer, non-compiled file! If that happens, the message |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
516 displayed when loading the file includes, @samp{(compiled; note, source is |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
517 newer)}, to remind you to recompile it. |
6453 | 518 |
519 When writing the forms in a Lisp library file, keep in mind that the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
520 file might be loaded more than once. For example, think about whether |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
521 each variable should be reinitialized when you reload the library; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
522 @code{defvar} does not change the value if the variable is already |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
523 initialized. (@xref{Defining Variables}.) |
6453 | 524 |
525 The simplest way to add an element to an alist is like this: | |
526 | |
527 @example | |
528 (setq minor-mode-alist | |
529 (cons '(leif-mode " Leif") minor-mode-alist)) | |
530 @end example | |
531 | |
532 @noindent | |
533 But this would add multiple elements if the library is reloaded. | |
534 To avoid the problem, write this: | |
535 | |
536 @example | |
537 (or (assq 'leif-mode minor-mode-alist) | |
538 (setq minor-mode-alist | |
539 (cons '(leif-mode " Leif") minor-mode-alist))) | |
540 @end example | |
541 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
542 To add an element to a list just once, you can also use @code{add-to-list} |
12098 | 543 (@pxref{Setting Variables}). |
544 | |
6453 | 545 Occasionally you will want to test explicitly whether a library has |
546 already been loaded. Here's one way to test, in a library, whether it | |
547 has been loaded before: | |
548 | |
549 @example | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
550 (defvar foo-was-loaded nil) |
12098 | 551 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
552 (unless foo-was-loaded |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
553 @var{execute-first-time-only} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
554 (setq foo-was-loaded t)) |
6453 | 555 @end example |
556 | |
557 @noindent | |
558 If the library uses @code{provide} to provide a named feature, you can | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
559 use @code{featurep} earlier in the file to test whether the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
560 @code{provide} call has been executed before. |
27193 | 561 @ifnottex |
12098 | 562 @xref{Named Features}. |
27193 | 563 @end ifnottex |
6453 | 564 |
12098 | 565 @node Named Features |
6453 | 566 @section Features |
567 @cindex features | |
568 @cindex requiring features | |
569 @cindex providing features | |
570 | |
571 @code{provide} and @code{require} are an alternative to | |
572 @code{autoload} for loading files automatically. They work in terms of | |
573 named @dfn{features}. Autoloading is triggered by calling a specific | |
574 function, but a feature is loaded the first time another program asks | |
575 for it by name. | |
576 | |
577 A feature name is a symbol that stands for a collection of functions, | |
578 variables, etc. The file that defines them should @dfn{provide} the | |
579 feature. Another program that uses them may ensure they are defined by | |
580 @dfn{requiring} the feature. This loads the file of definitions if it | |
581 hasn't been loaded already. | |
582 | |
583 To require the presence of a feature, call @code{require} with the | |
584 feature name as argument. @code{require} looks in the global variable | |
585 @code{features} to see whether the desired feature has been provided | |
586 already. If not, it loads the feature from the appropriate file. This | |
7212 | 587 file should call @code{provide} at the top level to add the feature to |
6453 | 588 @code{features}; if it fails to do so, @code{require} signals an error. |
589 @cindex load error with require | |
590 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48733
diff
changeset
|
591 For example, in @file{emacs/lisp/prolog.el}, |
6453 | 592 the definition for @code{run-prolog} includes the following code: |
593 | |
594 @smallexample | |
595 (defun run-prolog () | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15767
diff
changeset
|
596 "Run an inferior Prolog process, with I/O via buffer *prolog*." |
6453 | 597 (interactive) |
598 (require 'comint) | |
599 (switch-to-buffer (make-comint "prolog" prolog-program-name)) | |
600 (inferior-prolog-mode)) | |
601 @end smallexample | |
602 | |
603 @noindent | |
604 The expression @code{(require 'comint)} loads the file @file{comint.el} | |
605 if it has not yet been loaded. This ensures that @code{make-comint} is | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
606 defined. Features are normally named after the files that provide them, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
607 so that @code{require} need not be given the file name. |
6453 | 608 |
609 The @file{comint.el} file contains the following top-level expression: | |
610 | |
611 @smallexample | |
612 (provide 'comint) | |
613 @end smallexample | |
614 | |
615 @noindent | |
616 This adds @code{comint} to the global @code{features} list, so that | |
617 @code{(require 'comint)} will henceforth know that nothing needs to be | |
618 done. | |
619 | |
620 @cindex byte-compiling @code{require} | |
7212 | 621 When @code{require} is used at top level in a file, it takes effect |
6453 | 622 when you byte-compile that file (@pxref{Byte Compilation}) as well as |
623 when you load it. This is in case the required package contains macros | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
624 that the byte compiler must know about. It also avoids byte-compiler |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
625 warnings for functions and variables defined in the file loaded with |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
626 @code{require}. |
6453 | 627 |
628 Although top-level calls to @code{require} are evaluated during | |
629 byte compilation, @code{provide} calls are not. Therefore, you can | |
630 ensure that a file of definitions is loaded before it is byte-compiled | |
631 by including a @code{provide} followed by a @code{require} for the same | |
632 feature, as in the following example. | |
633 | |
634 @smallexample | |
635 @group | |
636 (provide 'my-feature) ; @r{Ignored by byte compiler,} | |
637 ; @r{evaluated by @code{load}.} | |
638 (require 'my-feature) ; @r{Evaluated by byte compiler.} | |
639 @end group | |
640 @end smallexample | |
641 | |
7212 | 642 @noindent |
643 The compiler ignores the @code{provide}, then processes the | |
644 @code{require} by loading the file in question. Loading the file does | |
645 execute the @code{provide} call, so the subsequent @code{require} call | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
646 does nothing when the file is loaded. |
7212 | 647 |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
648 @defun provide feature &optional subfeatures |
6453 | 649 This function announces that @var{feature} is now loaded, or being |
650 loaded, into the current Emacs session. This means that the facilities | |
651 associated with @var{feature} are or will be available for other Lisp | |
652 programs. | |
653 | |
654 The direct effect of calling @code{provide} is to add @var{feature} to | |
655 the front of the list @code{features} if it is not already in the list. | |
656 The argument @var{feature} must be a symbol. @code{provide} returns | |
657 @var{feature}. | |
658 | |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
659 If provided, @var{subfeatures} should be a list of symbols indicating |
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
660 a set of specific subfeatures provided by this version of @var{feature}. |
52760
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
661 You can test the presence of a subfeature using @code{featurep}. |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
662 |
6453 | 663 @smallexample |
664 features | |
665 @result{} (bar bish) | |
666 | |
667 (provide 'foo) | |
668 @result{} foo | |
669 features | |
670 @result{} (foo bar bish) | |
671 @end smallexample | |
672 | |
12098 | 673 When a file is loaded to satisfy an autoload, and it stops due to an |
52764
f2fb09e111f7
(Library Search): Correct default value of load-suffixes.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52760
diff
changeset
|
674 error in the evaluation of its contents, any function definitions or |
12098 | 675 @code{provide} calls that occurred during the load are undone. |
676 @xref{Autoload}. | |
6453 | 677 @end defun |
678 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22675
diff
changeset
|
679 @defun require feature &optional filename noerror |
6453 | 680 This function checks whether @var{feature} is present in the current |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
681 Emacs session (using @code{(featurep @var{feature})}; see below). The |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
682 argument @var{feature} must be a symbol. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
683 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
684 If the feature is not present, then @code{require} loads @var{filename} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
685 with @code{load}. If @var{filename} is not supplied, then the name of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
686 the symbol @var{feature} is used as the base file name to load. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
687 However, in this case, @code{require} insists on finding @var{feature} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
688 with an added suffix; a file whose name is just @var{feature} won't be |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
689 used. |
6453 | 690 |
55860
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
691 If @var{noerror} is non-@code{nil}, that suppresses errors from actual |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
692 loading of the file. In that case, @code{require} returns @code{nil} |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
693 if loading the file fails. Normally, @code{require} returns |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
694 @var{feature}. |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
695 |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
696 If loading the file succeeds but does not provide @var{feature}, |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
697 @code{require} signals an error, @samp{Required feature @var{feature} |
c1864c2911cf
(Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents:
54035
diff
changeset
|
698 was not provided}. |
6453 | 699 @end defun |
700 | |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
701 @defun featurep feature &optional subfeature |
51681
0a1f20d3fa89
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
702 This function returns @code{t} if @var{feature} has been provided in |
0a1f20d3fa89
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
703 the current Emacs session (i.e.@:, if @var{feature} is a member of |
0a1f20d3fa89
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
704 @code{features}.) If @var{subfeature} is non-@code{nil}, then the |
0a1f20d3fa89
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
705 function returns @code{t} only if that subfeature is provided as well |
0a1f20d3fa89
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
706 (i.e.@: if @var{subfeature} is a member of the @code{subfeature} |
0a1f20d3fa89
Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
707 property of the @var{feature} symbol.) |
6453 | 708 @end defun |
709 | |
710 @defvar features | |
711 The value of this variable is a list of symbols that are the features | |
712 loaded in the current Emacs session. Each symbol was put in this list | |
713 with a call to @code{provide}. The order of the elements in the | |
714 @code{features} list is not significant. | |
715 @end defvar | |
716 | |
717 @node Unloading | |
718 @section Unloading | |
719 @cindex unloading | |
720 | |
721 @c Emacs 19 feature | |
722 You can discard the functions and variables loaded by a library to | |
723 reclaim memory for other Lisp objects. To do this, use the function | |
724 @code{unload-feature}: | |
725 | |
10513
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
726 @deffn Command unload-feature feature &optional force |
6453 | 727 This command unloads the library that provided feature @var{feature}. |
7212 | 728 It undefines all functions, macros, and variables defined in that |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
729 library with @code{defun}, @code{defalias}, @code{defsubst}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
730 @code{defmacro}, @code{defconst}, @code{defvar}, and @code{defcustom}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
731 It then restores any autoloads formerly associated with those symbols. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
732 (Loading saves these in the @code{autoload} property of the symbol.) |
10513
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
733 |
52760
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
734 @vindex unload-feature-special-hooks |
22623
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
735 Before restoring the previous definitions, @code{unload-feature} runs |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
736 @code{remove-hook} to remove functions in the library from certain |
52760
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
737 hooks. These hooks include variables whose names end in @samp{hook} |
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
738 or @samp{-hooks}, plus those listed in |
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
739 @code{unload-feature-special-hooks}. This is to prevent Emacs from |
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
740 ceasing to function because important hooks refer to functions that |
584aca98f911
(Named Features): In `provide', say how to test for subfeatures.
Richard M. Stallman <rms@gnu.org>
parents:
52626
diff
changeset
|
741 are no longer defined. |
22623
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
742 |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
743 @vindex @var{feature}-unload-hook |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
744 If these measures are not sufficient to prevent malfunction, a library |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
745 can define an explicit unload hook. If @code{@var{feature}-unload-hook} |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
746 is defined, it is run as a normal hook before restoring the previous |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
747 definitions, @emph{instead of} the usual hook-removing actions. The |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
748 unload hook ought to undo all the global state changes made by the |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
749 library that might cease to work once the library is unloaded. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
750 @code{unload-feature} can cause problems with libraries that fail to do |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
751 this, so it should be used with caution. |
22623
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
752 |
10513
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
753 Ordinarily, @code{unload-feature} refuses to unload a library on which |
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
754 other loaded libraries depend. (A library @var{a} depends on library |
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
755 @var{b} if @var{a} contains a @code{require} for @var{b}.) If the |
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
756 optional argument @var{force} is non-@code{nil}, dependencies are |
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
757 ignored and you can unload any library. |
6453 | 758 @end deffn |
759 | |
760 The @code{unload-feature} function is written in Lisp; its actions are | |
761 based on the variable @code{load-history}. | |
762 | |
763 @defvar load-history | |
764 This variable's value is an alist connecting library names with the | |
765 names of functions and variables they define, the features they provide, | |
766 and the features they require. | |
767 | |
768 Each element is a list and describes one library. The @sc{car} of the | |
48729
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
769 list is the name of the library, as a string. The rest of the list |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
770 elements have these forms: |
6453 | 771 |
48729
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
772 @table @code |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
773 @item @var{fun} |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
774 The function @var{fun} was defined by this library. |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
775 @item (t . @var{fun}) |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
776 The function @var{fun} was previously an autoload before this library |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
777 redefined it as a function. The following element is always the |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
778 symbol @var{fun}, which signifies that the library defined @var{fun} |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
779 as a function. |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
780 @item (autoload . @var{fun}) |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
781 The function @var{fun} was defined as an autoload. |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
782 @item (defvar . @var{var}) |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
783 The symbol @var{var} was defined as a variable. |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
784 @item (require . @var{feature}) |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
785 The feature @var{feature} was required. |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
786 @item (provide . @var{feature}) |
ddd01000bda9
Update defn of load-history.
Richard M. Stallman <rms@gnu.org>
parents:
47625
diff
changeset
|
787 The feature @var{feature} was provided. |
48733
ce58108a36d0
(Unloading): Fix last change for load-history.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
48729
diff
changeset
|
788 @end table |
6453 | 789 |
790 The value of @code{load-history} may have one element whose @sc{car} is | |
791 @code{nil}. This element describes definitions made with | |
792 @code{eval-buffer} on a buffer that is not visiting a file. | |
793 @end defvar | |
794 | |
795 The command @code{eval-region} updates @code{load-history}, but does so | |
796 by adding the symbols defined to the element for the file being visited, | |
22419
3967db186db6
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22271
diff
changeset
|
797 rather than replacing that element. @xref{Eval}. |
6453 | 798 |
54035
5089d03a2061
(Unloading): Document unload-feature-special-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
53299
diff
changeset
|
799 @defvar unload-feature-special-hooks |
22623
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
800 This variable holds a list of hooks to be scanned before unloading a |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
801 library, to remove functions defined in the library. |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
802 @end defvar |
ccc1f8081ef1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22419
diff
changeset
|
803 |
6453 | 804 @node Hooks for Loading |
805 @section Hooks for Loading | |
806 @cindex loading hooks | |
807 @cindex hooks for loading | |
808 | |
809 You can ask for code to be executed if and when a particular library is | |
810 loaded, by calling @code{eval-after-load}. | |
811 | |
812 @defun eval-after-load library form | |
813 This function arranges to evaluate @var{form} at the end of loading the | |
10913
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
814 library @var{library}, if and when @var{library} is loaded. If |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
815 @var{library} is already loaded, it evaluates @var{form} right away. |
6453 | 816 |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
817 If @var{library} is a string, it must exactly match the argument of |
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
818 @code{load} used to load the library. To get the proper results when an |
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
819 installed library is found by searching @code{load-path}, you should not |
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
820 include any directory names in @var{library}. |
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
821 |
47625
8a11d295c3f3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45979
diff
changeset
|
822 @var{library} can also be a feature (i.e.@: a symbol), in which case |
45979
87962bf716e3
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
42769
diff
changeset
|
823 @var{form} is evaluated when @code{(provide @var{library})} is called. |
6453 | 824 |
825 An error in @var{form} does not undo the load, but does prevent | |
826 execution of the rest of @var{form}. | |
827 @end defun | |
828 | |
10913
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
829 In general, well-designed Lisp programs should not use this feature. |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
830 The clean and modular ways to interact with a Lisp library are (1) |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
831 examine and set the library's variables (those which are meant for |
12128
27144f55d1c6
fixed errors that appeared during update to 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
832 outside use), and (2) call the library's functions. If you wish to |
10913
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
833 do (1), you can do it immediately---there is no need to wait for when |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
834 the library is loaded. To do (2), you must load the library (preferably |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
835 with @code{require}). |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
836 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
837 But it is OK to use @code{eval-after-load} in your personal |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
838 customizations if you don't feel they must meet the design standards for |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
839 programs meant for wider use. |
10913
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
840 |
6453 | 841 @defvar after-load-alist |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
842 This variable holds an alist of expressions to evaluate if and when |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
843 particular libraries are loaded. Each element looks like this: |
6453 | 844 |
845 @example | |
846 (@var{filename} @var{forms}@dots{}) | |
847 @end example | |
848 | |
849 The function @code{load} checks @code{after-load-alist} in order to | |
850 implement @code{eval-after-load}. | |
851 @end defvar | |
852 | |
853 @c Emacs 19 feature | |
52401 | 854 |
855 @ignore | |
856 arch-tag: df731f89-0900-4389-a436-9105241b6f7a | |
857 @end ignore |