Mercurial > emacs
annotate lispref/loading.texi @ 21963:b717a61747c5
(regex_compile): When checking after exactn
for a repetition operator, don't look beyond end of pattern arg.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 06 May 1998 20:46:35 +0000 |
parents | 90da2489c498 |
children | d4ac295a98b3 |
rev | line source |
---|---|
6453 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998 Free Software Foundation, Inc. |
6453 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/loading | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
6 @node Loading, Byte Compilation, Customization, Top |
6453 | 7 @chapter Loading |
8 @cindex loading | |
9 @cindex library | |
10 @cindex Lisp library | |
11 | |
12 Loading a file of Lisp code means bringing its contents into the Lisp | |
13 environment in the form of Lisp objects. Emacs finds and opens the | |
14 file, reads the text, evaluates each form, and then closes the file. | |
15 | |
16 The load functions evaluate all the expressions in a file just | |
17 as the @code{eval-current-buffer} function evaluates all the | |
18 expressions in a buffer. The difference is that the load functions | |
19 read and evaluate the text in the file as found on disk, not the text | |
20 in an Emacs buffer. | |
21 | |
22 @cindex top-level form | |
23 The loaded file must contain Lisp expressions, either as source code | |
7212 | 24 or as byte-compiled code. Each form in the file is called a |
25 @dfn{top-level form}. There is no special format for the forms in a | |
6453 | 26 loadable file; any form in a file may equally well be typed directly |
27 into a buffer and evaluated there. (Indeed, most code is tested this | |
28 way.) Most often, the forms are function definitions and variable | |
29 definitions. | |
30 | |
31 A file containing Lisp code is often called a @dfn{library}. Thus, | |
32 the ``Rmail library'' is a file containing code for Rmail mode. | |
33 Similarly, a ``Lisp library directory'' is a directory of files | |
34 containing Lisp code. | |
35 | |
36 @menu | |
37 * How Programs Do Loading:: The @code{load} function and others. | |
38 * Autoload:: Setting up a function to autoload. | |
39 * Repeated Loading:: Precautions about loading a file twice. | |
12098 | 40 * Named Features:: Loading a library if it isn't already loaded. |
6453 | 41 * Unloading:: How to ``unload'' a library that was loaded. |
42 * Hooks for Loading:: Providing code to be run when | |
43 particular libraries are loaded. | |
44 @end menu | |
45 | |
46 @node How Programs Do Loading | |
47 @section How Programs Do Loading | |
48 | |
49 Emacs Lisp has several interfaces for loading. For example, | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
50 @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
|
51 file; trying to call the autoloading function loads the file to get the |
6453 | 52 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
|
53 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
|
54 all these facilities call the @code{load} function to do the work. |
6453 | 55 |
56 @defun load filename &optional missing-ok nomessage nosuffix | |
57 This function finds and opens a file of Lisp code, evaluates all the | |
58 forms in it, and closes the file. | |
59 | |
60 To find the file, @code{load} first looks for a file named | |
61 @file{@var{filename}.elc}, that is, for a file whose name is | |
62 @var{filename} with @samp{.elc} appended. If such a file exists, it is | |
63 loaded. If there is no file by that name, then @code{load} looks for a | |
7212 | 64 file named @file{@var{filename}.el}. If that file exists, it is loaded. |
6453 | 65 Finally, if neither of those names is found, @code{load} looks for a |
66 file named @var{filename} with nothing appended, and loads it if it | |
67 exists. (The @code{load} function is not clever about looking at | |
68 @var{filename}. In the perverse case of a file named @file{foo.el.el}, | |
69 evaluation of @code{(load "foo.el")} will indeed find it.) | |
70 | |
71 If the optional argument @var{nosuffix} is non-@code{nil}, then the | |
72 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
|
73 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
|
74 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
|
75 perverse file names such as @file{foo.el.el} from being tried. |
6453 | 76 |
77 If @var{filename} is a relative file name, such as @file{foo} or | |
78 @file{baz/foo.bar}, @code{load} searches for the file using the variable | |
79 @code{load-path}. It appends @var{filename} to each of the directories | |
80 listed in @code{load-path}, and loads the first file it finds whose name | |
81 matches. The current default directory is tried only if it is specified | |
82 in @code{load-path}, where @code{nil} stands for the default directory. | |
83 @code{load} tries all three possible suffixes in the first directory in | |
84 @code{load-path}, then all three suffixes in the second directory, and | |
85 so on. | |
86 | |
87 If you get a warning that @file{foo.elc} is older than @file{foo.el}, it | |
88 means you should consider recompiling @file{foo.el}. @xref{Byte | |
89 Compilation}. | |
90 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
91 When loading a source file (not compiled), @code{load} performs |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
92 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
|
93 @xref{Coding Systems}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
94 |
6453 | 95 Messages like @samp{Loading foo...} and @samp{Loading foo...done} appear |
96 in the echo area during loading unless @var{nomessage} is | |
97 non-@code{nil}. | |
98 | |
99 @cindex load errors | |
100 Any unhandled errors while loading a file terminate loading. If the | |
7212 | 101 load was done for the sake of @code{autoload}, any function definitions |
102 made during the loading are undone. | |
6453 | 103 |
104 @kindex file-error | |
105 If @code{load} can't find the file to load, then normally it signals the | |
106 error @code{file-error} (with @samp{Cannot open load file | |
107 @var{filename}}). But if @var{missing-ok} is non-@code{nil}, then | |
108 @code{load} just returns @code{nil}. | |
109 | |
12067 | 110 You can use the variable @code{load-read-function} to specify a function |
111 for @code{load} to use instead of @code{read} for reading expressions. | |
112 See below. | |
113 | |
6453 | 114 @code{load} returns @code{t} if the file loads successfully. |
115 @end defun | |
116 | |
117 @deffn Command load-file filename | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
118 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
|
119 relative file name, then the current default directory is assumed. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
120 @code{load-path} is not used, and suffixes are not appended. Use this |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
121 command if you wish to specify the file to be loaded exactly. |
6453 | 122 @end deffn |
123 | |
124 @deffn Command load-library library | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
125 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
|
126 @code{load}, except in how it reads its argument interactively. |
6453 | 127 @end deffn |
128 | |
129 @defopt load-path | |
130 @cindex @code{EMACSLOADPATH} environment variable | |
131 The value of this variable is a list of directories to search when | |
132 loading files with @code{load}. Each element is a string (which must be | |
133 a directory name) or @code{nil} (which stands for the current working | |
134 directory). The value of @code{load-path} is initialized from the | |
135 environment variable @code{EMACSLOADPATH}, if that exists; otherwise its | |
136 default value is specified in @file{emacs/src/paths.h} when Emacs is | |
137 built. | |
138 | |
139 The syntax of @code{EMACSLOADPATH} is the same as used for @code{PATH}; | |
12098 | 140 @samp{:} (or @samp{;}, according to the operating system) separates |
141 directory names, and @samp{.} is used for the current default directory. | |
142 Here is an example of how to set your @code{EMACSLOADPATH} variable from | |
143 a @code{csh} @file{.login} file: | |
6453 | 144 |
145 @c This overfull hbox is OK. --rjc 16mar92 | |
146 @smallexample | |
147 setenv EMACSLOADPATH .:/user/bil/emacs:/usr/lib/emacs/lisp | |
148 @end smallexample | |
149 | |
150 Here is how to set it using @code{sh}: | |
151 | |
152 @smallexample | |
153 export EMACSLOADPATH | |
154 EMACSLOADPATH=.:/user/bil/emacs:/usr/local/lib/emacs/lisp | |
155 @end smallexample | |
156 | |
157 Here is an example of code you can place in a @file{.emacs} file to add | |
158 several directories to the front of your default @code{load-path}: | |
159 | |
160 @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
|
161 @group |
6453 | 162 (setq load-path |
163 (append (list nil "/user/bil/emacs" | |
164 "/usr/local/lisplib" | |
12315
49a48bf414c7
Fix up load-path example.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
165 "~/emacs") |
6453 | 166 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
|
167 @end group |
6453 | 168 @end smallexample |
169 | |
170 @c Wordy to rid us of an overfull hbox. --rjc 15mar92 | |
171 @noindent | |
172 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
|
173 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
|
174 @file{/usr/local/lisplib} directory, and the @file{~/emacs} directory, |
6453 | 175 which are then followed by the standard directories for Lisp code. |
176 | |
10659
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
177 Dumping Emacs uses a special value of @code{load-path}. If the value of |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
178 @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
|
179 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
|
180 @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
|
181 @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
|
182 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
|
183 |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
184 Therefore, if you want to change @code{load-path} temporarily for |
a0efedb217ed
Explain load-path and dumping.
Richard M. Stallman <rms@gnu.org>
parents:
10513
diff
changeset
|
185 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
|
186 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
|
187 calls to @code{load}. |
6453 | 188 @end defopt |
189 | |
15767
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
190 The default value of @code{load-path}, when running an Emacs which has |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
191 been installed on the system, looks like this: |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
192 |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
193 @smallexample |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
194 ("/usr/local/share/emacs/@var{version}/site-lisp" |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
195 "/usr/local/share/emacs/site-lisp" |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
196 "/usr/local/share/emacs/@var{version}/lisp") |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
197 @end smallexample |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
198 |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
199 The last of these three directories is where the Lisp files of Emacs |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
200 itself are installed; the first two are for additional Lisp packages |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
201 installed at your site. The first directory is for locally installed |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
202 packages that belong with a particular Emacs version; the second is for |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
203 locally installed packages that can be used with any installed Emacs |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
204 version. |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
205 |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
206 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
|
207 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
|
208 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
|
209 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
|
210 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
|
211 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
|
212 |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
213 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
|
214 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
|
215 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
|
216 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
|
217 are represented as absolute file names.) |
039b338d9656
Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents:
13087
diff
changeset
|
218 |
6453 | 219 @defvar load-in-progress |
220 This variable is non-@code{nil} if Emacs is in the process of loading a | |
12098 | 221 file, and it is @code{nil} otherwise. |
6453 | 222 @end defvar |
223 | |
12067 | 224 @defvar load-read-function |
225 This variable specifies an alternate expression-reading function for | |
226 @code{load} and @code{eval-region} to use instead of @code{read}. | |
227 The function should accept one argument, just as @code{read} does. | |
228 | |
229 Normally, the variable's value is @code{nil}, which means those | |
230 functions should use @code{read}. | |
231 @end defvar | |
232 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
233 For how @code{load} is used to build Emacs, see @ref{Building Emacs}. |
6453 | 234 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
235 @deffn Command locate-library library &optional nosuffix path interactive-call |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
236 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
|
237 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
|
238 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
|
239 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
|
240 @var{library}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
241 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
242 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
|
243 instead of @code{load-path}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
244 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
245 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
|
246 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
|
247 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
|
248 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
|
249 @end deffn |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
250 |
6453 | 251 @node Autoload |
252 @section Autoload | |
253 @cindex autoload | |
254 | |
255 The @dfn{autoload} facility allows you to make a function or macro | |
12098 | 256 known in Lisp, but put off loading the file that defines it. The first |
257 call to the function automatically reads the proper file to install the | |
258 real definition and other associated code, then runs the real definition | |
6453 | 259 as if it had been loaded all along. |
260 | |
261 There are two ways to set up an autoloaded function: by calling | |
262 @code{autoload}, and by writing a special ``magic'' comment in the | |
263 source before the real definition. @code{autoload} is the low-level | |
264 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
|
265 any time. Magic comments are the most convenient way to make a function |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
266 autoload, for packages installed along with Emacs. They do nothing on |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
267 their own, but they serve as a guide for the command |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
268 @code{update-file-autoloads}, which constructs calls to @code{autoload} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
269 and arranges to execute them when Emacs is built. |
6453 | 270 |
7212 | 271 @defun autoload function filename &optional docstring interactive type |
272 This function defines the function (or macro) named @var{function} so as | |
6453 | 273 to load automatically from @var{filename}. The string @var{filename} |
274 specifies the file to load to get the real definition of @var{function}. | |
275 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
276 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
|
277 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
|
278 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
|
279 just @var{filename} with no added suffix. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
280 |
6453 | 281 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
|
282 function. Normally, this should be identical to the documentation string |
6453 | 283 in the function definition itself. Specifying the documentation string |
284 in the call to @code{autoload} makes it possible to look at the | |
285 documentation without loading the function's real definition. | |
286 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
287 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
|
288 called interactively. This lets completion in @kbd{M-x} work without |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
289 loading its real definition. The complete interactive specification is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
290 not given here; it's not needed unless the user actually calls |
6453 | 291 @var{function}, and when that happens, it's time to load the real |
292 definition. | |
293 | |
294 You can autoload macros and keymaps as well as ordinary functions. | |
295 Specify @var{type} as @code{macro} if @var{function} is really a macro. | |
296 Specify @var{type} as @code{keymap} if @var{function} is really a | |
297 keymap. Various parts of Emacs need to know this information without | |
298 loading the real definition. | |
299 | |
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
|
300 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
|
301 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
|
302 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
|
303 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
|
304 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
|
305 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
|
306 |
6453 | 307 @cindex function cell in autoload |
7212 | 308 If @var{function} already has a non-void function definition that is not |
6453 | 309 an autoload object, @code{autoload} does nothing and returns @code{nil}. |
7212 | 310 If the function cell of @var{function} is void, or is already an autoload |
6453 | 311 object, then it is defined as an autoload object like this: |
312 | |
313 @example | |
314 (autoload @var{filename} @var{docstring} @var{interactive} @var{type}) | |
315 @end example | |
316 | |
317 For example, | |
318 | |
319 @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
|
320 @group |
6453 | 321 (symbol-function 'run-prolog) |
322 @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
|
323 @end group |
6453 | 324 @end example |
325 | |
326 @noindent | |
327 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
|
328 refers to the documentation string in the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
329 @file{emacs/etc/DOC-@var{version}} file (@pxref{Documentation Basics}), |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
330 @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
|
331 not a macro or a keymap. |
6453 | 332 @end defun |
333 | |
334 @cindex autoload errors | |
335 The autoloaded file usually contains other definitions and may require | |
336 or provide one or more features. If the file is not completely loaded | |
337 (due to an error in the evaluation of its contents), any function | |
338 definitions or @code{provide} calls that occurred during the load are | |
339 undone. This is to ensure that the next attempt to call any function | |
340 autoloading from this file will try again to load the file. If not for | |
341 this, then some of the functions in the file might appear defined, but | |
342 they might fail to work properly for the lack of certain subroutines | |
343 defined later in the file and not loaded successfully. | |
344 | |
345 If the autoloaded file fails to define the desired Lisp function or | |
346 macro, then an error is signaled with data @code{"Autoloading failed to | |
347 define function @var{function-name}"}. | |
348 | |
349 @findex update-file-autoloads | |
350 @findex update-directory-autoloads | |
351 A magic autoload comment looks like @samp{;;;###autoload}, on a line | |
352 by itself, just before the real definition of the function in its | |
353 autoloadable source file. The command @kbd{M-x update-file-autoloads} | |
354 writes a corresponding @code{autoload} call into @file{loaddefs.el}. | |
355 Building Emacs loads @file{loaddefs.el} and thus calls @code{autoload}. | |
356 @kbd{M-x update-directory-autoloads} is even more powerful; it updates | |
357 autoloads for all files in the current directory. | |
358 | |
359 The same magic comment can copy any kind of form into | |
360 @file{loaddefs.el}. If the form following the magic comment is not a | |
361 function definition, it is copied verbatim. You can also use a magic | |
7212 | 362 comment to execute a form at build time @emph{without} executing it when |
13087 | 363 the file itself is loaded. To do this, write the form @emph{on the same |
7212 | 364 line} as the magic comment. Since it is in a comment, it does nothing |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
365 when you load the source file; but @kbd{M-x update-file-autoloads} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
366 copies it to @file{loaddefs.el}, where it is executed while building |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
367 Emacs. |
6453 | 368 |
369 The following example shows how @code{doctor} is prepared for | |
370 autoloading with a magic comment: | |
371 | |
372 @smallexample | |
373 ;;;###autoload | |
374 (defun doctor () | |
375 "Switch to *doctor* buffer and start giving psychotherapy." | |
376 (interactive) | |
377 (switch-to-buffer "*doctor*") | |
378 (doctor-mode)) | |
379 @end smallexample | |
380 | |
381 @noindent | |
382 Here's what that produces in @file{loaddefs.el}: | |
383 | |
384 @smallexample | |
385 (autoload 'doctor "doctor" | |
386 "\ | |
387 Switch to *doctor* buffer and start giving psychotherapy." | |
388 t) | |
389 @end smallexample | |
390 | |
391 @noindent | |
392 The backslash and newline immediately following the double-quote are a | |
393 convention used only in the preloaded Lisp files such as | |
394 @file{loaddefs.el}; they tell @code{make-docfile} to put the | |
395 documentation string in the @file{etc/DOC} file. @xref{Building Emacs}. | |
396 | |
397 @node Repeated Loading | |
398 @section Repeated Loading | |
399 @cindex repeated loading | |
400 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
401 You can load one file more than once in an Emacs session. For |
6453 | 402 example, after you have rewritten and reinstalled a function definition |
403 by editing it in a buffer, you may wish to return to the original | |
404 version; you can do this by reloading the file it came from. | |
405 | |
406 When you load or reload files, bear in mind that the @code{load} and | |
407 @code{load-library} functions automatically load a byte-compiled file | |
408 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
|
409 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
|
410 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
|
411 of your newer, non-compiled file! If that happens, the message |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
412 displayed when loading the file includes, @samp{(compiled; source is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
413 newer)}, to remind you to recompile it. |
6453 | 414 |
415 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
|
416 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
|
417 each variable should be reinitialized when you reload the library; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
418 @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
|
419 initialized. (@xref{Defining Variables}.) |
6453 | 420 |
421 The simplest way to add an element to an alist is like this: | |
422 | |
423 @example | |
424 (setq minor-mode-alist | |
425 (cons '(leif-mode " Leif") minor-mode-alist)) | |
426 @end example | |
427 | |
428 @noindent | |
429 But this would add multiple elements if the library is reloaded. | |
430 To avoid the problem, write this: | |
431 | |
432 @example | |
433 (or (assq 'leif-mode minor-mode-alist) | |
434 (setq minor-mode-alist | |
435 (cons '(leif-mode " Leif") minor-mode-alist))) | |
436 @end example | |
437 | |
12098 | 438 To add an element to a list just once, use @code{add-to-list} |
439 (@pxref{Setting Variables}). | |
440 | |
6453 | 441 Occasionally you will want to test explicitly whether a library has |
442 already been loaded. Here's one way to test, in a library, whether it | |
443 has been loaded before: | |
444 | |
445 @example | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
446 (defvar foo-was-loaded nil) |
12098 | 447 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
448 (unless foo-was-loaded |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
449 @var{execute-first-time-only} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
450 (setq foo-was-loaded t)) |
6453 | 451 @end example |
452 | |
453 @noindent | |
454 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
|
455 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
|
456 @code{provide} call has been executed before. |
7212 | 457 @ifinfo |
12098 | 458 @xref{Named Features}. |
7212 | 459 @end ifinfo |
6453 | 460 |
12098 | 461 @node Named Features |
6453 | 462 @section Features |
463 @cindex features | |
464 @cindex requiring features | |
465 @cindex providing features | |
466 | |
467 @code{provide} and @code{require} are an alternative to | |
468 @code{autoload} for loading files automatically. They work in terms of | |
469 named @dfn{features}. Autoloading is triggered by calling a specific | |
470 function, but a feature is loaded the first time another program asks | |
471 for it by name. | |
472 | |
473 A feature name is a symbol that stands for a collection of functions, | |
474 variables, etc. The file that defines them should @dfn{provide} the | |
475 feature. Another program that uses them may ensure they are defined by | |
476 @dfn{requiring} the feature. This loads the file of definitions if it | |
477 hasn't been loaded already. | |
478 | |
479 To require the presence of a feature, call @code{require} with the | |
480 feature name as argument. @code{require} looks in the global variable | |
481 @code{features} to see whether the desired feature has been provided | |
482 already. If not, it loads the feature from the appropriate file. This | |
7212 | 483 file should call @code{provide} at the top level to add the feature to |
6453 | 484 @code{features}; if it fails to do so, @code{require} signals an error. |
485 @cindex load error with require | |
486 | |
487 For example, in @file{emacs/lisp/prolog.el}, | |
488 the definition for @code{run-prolog} includes the following code: | |
489 | |
490 @smallexample | |
491 (defun run-prolog () | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15767
diff
changeset
|
492 "Run an inferior Prolog process, with I/O via buffer *prolog*." |
6453 | 493 (interactive) |
494 (require 'comint) | |
495 (switch-to-buffer (make-comint "prolog" prolog-program-name)) | |
496 (inferior-prolog-mode)) | |
497 @end smallexample | |
498 | |
499 @noindent | |
500 The expression @code{(require 'comint)} loads the file @file{comint.el} | |
501 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
|
502 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
|
503 so that @code{require} need not be given the file name. |
6453 | 504 |
505 The @file{comint.el} file contains the following top-level expression: | |
506 | |
507 @smallexample | |
508 (provide 'comint) | |
509 @end smallexample | |
510 | |
511 @noindent | |
512 This adds @code{comint} to the global @code{features} list, so that | |
513 @code{(require 'comint)} will henceforth know that nothing needs to be | |
514 done. | |
515 | |
516 @cindex byte-compiling @code{require} | |
7212 | 517 When @code{require} is used at top level in a file, it takes effect |
6453 | 518 when you byte-compile that file (@pxref{Byte Compilation}) as well as |
519 when you load it. This is in case the required package contains macros | |
520 that the byte compiler must know about. | |
521 | |
522 Although top-level calls to @code{require} are evaluated during | |
523 byte compilation, @code{provide} calls are not. Therefore, you can | |
524 ensure that a file of definitions is loaded before it is byte-compiled | |
525 by including a @code{provide} followed by a @code{require} for the same | |
526 feature, as in the following example. | |
527 | |
528 @smallexample | |
529 @group | |
530 (provide 'my-feature) ; @r{Ignored by byte compiler,} | |
531 ; @r{evaluated by @code{load}.} | |
532 (require 'my-feature) ; @r{Evaluated by byte compiler.} | |
533 @end group | |
534 @end smallexample | |
535 | |
7212 | 536 @noindent |
537 The compiler ignores the @code{provide}, then processes the | |
538 @code{require} by loading the file in question. Loading the file does | |
539 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
|
540 does nothing when the file is loaded. |
7212 | 541 |
6453 | 542 @defun provide feature |
543 This function announces that @var{feature} is now loaded, or being | |
544 loaded, into the current Emacs session. This means that the facilities | |
545 associated with @var{feature} are or will be available for other Lisp | |
546 programs. | |
547 | |
548 The direct effect of calling @code{provide} is to add @var{feature} to | |
549 the front of the list @code{features} if it is not already in the list. | |
550 The argument @var{feature} must be a symbol. @code{provide} returns | |
551 @var{feature}. | |
552 | |
553 @smallexample | |
554 features | |
555 @result{} (bar bish) | |
556 | |
557 (provide 'foo) | |
558 @result{} foo | |
559 features | |
560 @result{} (foo bar bish) | |
561 @end smallexample | |
562 | |
12098 | 563 When a file is loaded to satisfy an autoload, and it stops due to an |
564 error in the evaluating its contents, any function definitions or | |
565 @code{provide} calls that occurred during the load are undone. | |
566 @xref{Autoload}. | |
6453 | 567 @end defun |
568 | |
569 @defun require feature &optional filename | |
570 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
|
571 Emacs session (using @code{(featurep @var{feature})}; see below). The |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
572 argument @var{feature} must be a symbol. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
573 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
574 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
|
575 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
|
576 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
|
577 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
|
578 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
|
579 used. |
6453 | 580 |
581 If loading the file fails to provide @var{feature}, @code{require} | |
582 signals an error, @samp{Required feature @var{feature} was not | |
583 provided}. | |
584 @end defun | |
585 | |
586 @defun featurep feature | |
587 This function returns @code{t} if @var{feature} has been provided in the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
588 current Emacs session (i.e., if @var{feature} is a member of |
6453 | 589 @code{features}.) |
590 @end defun | |
591 | |
592 @defvar features | |
593 The value of this variable is a list of symbols that are the features | |
594 loaded in the current Emacs session. Each symbol was put in this list | |
595 with a call to @code{provide}. The order of the elements in the | |
596 @code{features} list is not significant. | |
597 @end defvar | |
598 | |
599 @node Unloading | |
600 @section Unloading | |
601 @cindex unloading | |
602 | |
603 @c Emacs 19 feature | |
604 You can discard the functions and variables loaded by a library to | |
605 reclaim memory for other Lisp objects. To do this, use the function | |
606 @code{unload-feature}: | |
607 | |
10513
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
608 @deffn Command unload-feature feature &optional force |
6453 | 609 This command unloads the library that provided feature @var{feature}. |
7212 | 610 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
|
611 library with @code{defun}, @code{defalias}, @code{defsubst}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
612 @code{defmacro}, @code{defconst}, @code{defvar}, and @code{defcustom}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
613 It then restores any autoloads formerly associated with those symbols. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
614 (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
|
615 |
e4423ed2b4cb
Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents:
7212
diff
changeset
|
616 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
|
617 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
|
618 @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
|
619 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
|
620 ignored and you can unload any library. |
6453 | 621 @end deffn |
622 | |
623 The @code{unload-feature} function is written in Lisp; its actions are | |
624 based on the variable @code{load-history}. | |
625 | |
626 @defvar load-history | |
627 This variable's value is an alist connecting library names with the | |
628 names of functions and variables they define, the features they provide, | |
629 and the features they require. | |
630 | |
631 Each element is a list and describes one library. The @sc{car} of the | |
632 list is the name of the library, as a string. The rest of the list is | |
633 composed of these kinds of objects: | |
634 | |
635 @itemize @bullet | |
636 @item | |
7212 | 637 Symbols that were defined by this library. |
6453 | 638 @item |
639 Lists of the form @code{(require . @var{feature})} indicating | |
640 features that were required. | |
641 @item | |
642 Lists of the form @code{(provide . @var{feature})} indicating | |
643 features that were provided. | |
644 @end itemize | |
645 | |
646 The value of @code{load-history} may have one element whose @sc{car} is | |
647 @code{nil}. This element describes definitions made with | |
648 @code{eval-buffer} on a buffer that is not visiting a file. | |
649 @end defvar | |
650 | |
651 The command @code{eval-region} updates @code{load-history}, but does so | |
652 by adding the symbols defined to the element for the file being visited, | |
653 rather than replacing that element. | |
654 | |
655 @node Hooks for Loading | |
656 @section Hooks for Loading | |
657 @cindex loading hooks | |
658 @cindex hooks for loading | |
659 | |
660 You can ask for code to be executed if and when a particular library is | |
661 loaded, by calling @code{eval-after-load}. | |
662 | |
663 @defun eval-after-load library form | |
664 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
|
665 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
|
666 @var{library} is already loaded, it evaluates @var{form} right away. |
6453 | 667 |
668 The library name @var{library} must exactly match the argument of | |
669 @code{load}. To get the proper results when an installed library is | |
670 found by searching @code{load-path}, you should not include any | |
671 directory names in @var{library}. | |
672 | |
673 An error in @var{form} does not undo the load, but does prevent | |
674 execution of the rest of @var{form}. | |
675 @end defun | |
676 | |
10913
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
677 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
|
678 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
|
679 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
|
680 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
|
681 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
|
682 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
|
683 with @code{require}). |
880d7c28921c
Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents:
10659
diff
changeset
|
684 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
685 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
|
686 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
|
687 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
|
688 |
6453 | 689 @defvar after-load-alist |
690 An alist of expressions to evaluate if and when particular libraries are | |
691 loaded. Each element looks like this: | |
692 | |
693 @example | |
694 (@var{filename} @var{forms}@dots{}) | |
695 @end example | |
696 | |
697 The function @code{load} checks @code{after-load-alist} in order to | |
698 implement @code{eval-after-load}. | |
699 @end defvar | |
700 | |
701 @c Emacs 19 feature |