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