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