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