annotate lispref/loading.texi @ 80604:234fcb1810c9

(keycode_to_xkeysym_table): Add entries for f17, f18, and f19. [MAC_OSX] (fn_keycode_to_keycode_table): Likewise.
author YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
date Fri, 11 Jul 2008 08:53:12 +0000
parents a1e16e813aed
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
75250
6d19c76d81c5 Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents: 74704
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
79750
a1e16e813aed Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 79197
diff changeset
4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 @chapter Loading
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 @cindex loading
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 @cindex library
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 @cindex Lisp library
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 Loading a file of Lisp code means bringing its contents into the Lisp
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 environment in the form of Lisp objects. Emacs finds and opens the
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 file, reads the text, evaluates each form, and then closes the file.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 expressions in a buffer. The difference is that the load functions
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 read and evaluate the text in the file as found on disk, not the text
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 in an Emacs buffer.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 @cindex top-level form
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 The loaded file must contain Lisp expressions, either as source code
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
25 or as byte-compiled code. Each form in the file is called a
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
26 @dfn{top-level form}. There is no special format for the forms in a
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 loadable file; any form in a file may equally well be typed directly
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 into a buffer and evaluated there. (Indeed, most code is tested this
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 way.) Most often, the forms are function definitions and variable
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 definitions.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 A file containing Lisp code is often called a @dfn{library}. Thus,
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 the ``Rmail library'' is a file containing code for Rmail mode.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 Similarly, a ``Lisp library directory'' is a directory of files
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 containing Lisp code.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 @menu
59139
e95aeb133905 Realign menu.
Richard M. Stallman <rms@gnu.org>
parents: 59134
diff changeset
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
e95aeb133905 Realign menu.
Richard M. Stallman <rms@gnu.org>
parents: 59134
diff changeset
40 * Library Search:: Finding a library to load.
e95aeb133905 Realign menu.
Richard M. Stallman <rms@gnu.org>
parents: 59134
diff changeset
41 * Loading Non-ASCII:: Non-@acronym{ASCII} characters in Emacs Lisp files.
e95aeb133905 Realign menu.
Richard M. Stallman <rms@gnu.org>
parents: 59134
diff changeset
42 * Autoload:: Setting up a function to autoload.
e95aeb133905 Realign menu.
Richard M. Stallman <rms@gnu.org>
parents: 59134
diff changeset
43 * Repeated Loading:: Precautions about loading a file twice.
e95aeb133905 Realign menu.
Richard M. Stallman <rms@gnu.org>
parents: 59134
diff changeset
44 * Named Features:: Loading a library if it isn't already loaded.
e95aeb133905 Realign menu.
Richard M. Stallman <rms@gnu.org>
parents: 59134
diff changeset
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
e95aeb133905 Realign menu.
Richard M. Stallman <rms@gnu.org>
parents: 59134
diff changeset
47 * Hooks for Loading:: Providing code to be run when
e95aeb133905 Realign menu.
Richard M. Stallman <rms@gnu.org>
parents: 59134
diff changeset
48 particular libraries are loaded.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 @end menu
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 @node How Programs Do Loading
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 @section How Programs Do Loading
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 This function finds and opens a file of Lisp code, evaluates all the
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 forms in it, and closes the file.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 To find the file, @code{load} first looks for a file named
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 @file{@var{filename}.elc}, that is, for a file whose name is
76878
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
67 @var{filename} with the extension @samp{.elc} appended. If such a
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
68 file exists, it is loaded. If there is no file by that name, then
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
69 @code{load} looks for a file named @file{@var{filename}.el}. If that
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
70 file exists, it is loaded. Finally, if neither of those names is
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
71 found, @code{load} looks for a file named @var{filename} with nothing
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
72 appended, and loads it if it exists. (The @code{load} function is not
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
73 clever about looking at @var{filename}. In the perverse case of a
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
74 file named @file{foo.el.el}, evaluation of @code{(load "foo.el")} will
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
75 indeed find it.)
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76
76878
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
77 If Auto Compression mode is enabled, as it is by default, then if
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
78 @code{load} can not find a file, it searches for a compressed version
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
79 of the file before trying other file names. It decompresses and loads
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
80 it if it exists. It looks for compressed versions by appending each
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
81 of the suffixes in @code{jka-compr-load-suffixes} to the file name.
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
82 The value of this variable must be a list of strings. Its standard
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
83 value is @code{(".gz")}.
69200
63fbed8d9ae0 (Loading): Include new node "Load Suffixes" in menu.
Luc Teirlinck <teirllm@auburn.edu>
parents: 68648
diff changeset
84
63fbed8d9ae0 (Loading): Include new node "Load Suffixes" in menu.
Luc Teirlinck <teirllm@auburn.edu>
parents: 68648
diff changeset
85 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
86 @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
87 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
88 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
89 @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
90 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
91 @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
92 @file{foo.el.el} from being tried.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
93
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
94 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
95 @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
96 @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
97 suffix), unless it contains an explicit directory name.
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
98
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 If @var{filename} is a relative file name, such as @file{foo} or
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100 @file{baz/foo.bar}, @code{load} searches for the file using the variable
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 @code{load-path}. It appends @var{filename} to each of the directories
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 listed in @code{load-path}, and loads the first file it finds whose name
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 matches. The current default directory is tried only if it is specified
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 in @code{load-path}, where @code{nil} stands for the default directory.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105 @code{load} tries all three possible suffixes in the first directory in
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 @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
107 so on. @xref{Library Search}.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
109 If you get a warning that @file{foo.elc} is older than @file{foo.el}, it
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
110 means you should consider recompiling @file{foo.el}. @xref{Byte
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111 Compilation}.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
113 When loading a source file (not compiled), @code{load} performs
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
114 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
115 @xref{Coding Systems}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
116
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
117 Messages like @samp{Loading foo...} and @samp{Loading foo...done} appear
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118 in the echo area during loading unless @var{nomessage} is
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 non-@code{nil}.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121 @cindex load errors
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 Any unhandled errors while loading a file terminate loading. If the
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
123 load was done for the sake of @code{autoload}, any function definitions
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
124 made during the loading are undone.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126 @kindex file-error
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127 If @code{load} can't find the file to load, then normally it signals the
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
128 error @code{file-error} (with @samp{Cannot open load file
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129 @var{filename}}). But if @var{missing-ok} is non-@code{nil}, then
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130 @code{load} just returns @code{nil}.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
131
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10913
diff changeset
132 You can use the variable @code{load-read-function} to specify a function
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10913
diff changeset
133 for @code{load} to use instead of @code{read} for reading expressions.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10913
diff changeset
134 See below.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10913
diff changeset
135
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
136 @code{load} returns @code{t} if the file loads successfully.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137 @end defun
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139 @deffn Command load-file filename
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
140 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
141 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
142 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
143 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
144 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
145 precisely the file name to load.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146 @end deffn
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
147
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
148 @deffn Command load-library library
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
149 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
150 @code{load}, except in how it reads its argument interactively.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
151 @end deffn
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
152
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
153 @defvar load-in-progress
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
154 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
155 file, and it is @code{nil} otherwise.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
156 @end defvar
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
157
56215
c9aa4127a482 Reposition @anchor's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 55860
diff changeset
158 @defvar load-read-function
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
26c633d614ed fix bad page breaks
Karl Berry <karl@gnu.org>
parents: 71958
diff changeset
160 @c do not allow page break at anchor; work around Texinfo deficiency.
76143
6bf81a05463e Fix anchor position.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 75672
diff changeset
161 This 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
fe75563f4d13 Avoid @strong{Note:}.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
168 Instead of using this variable, it is cleaner to use another, newer
fe75563f4d13 Avoid @strong{Note:}.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
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
76837
4f96f3f74c69 Improve indexing.
Eli Zaretskii <eliz@gnu.org>
parents: 76143
diff changeset
224 @cindex library search
4f96f3f74c69 Improve indexing.
Eli Zaretskii <eliz@gnu.org>
parents: 76143
diff changeset
225 @cindex find library
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
226
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
227 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
228 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
229
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
230 @defopt load-path
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
231 @cindex @code{EMACSLOADPATH} environment variable
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
232 The value of this variable is a list of directories to search when
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
233 loading files with @code{load}. Each element is a string (which must be
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
234 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
235 directory).
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
236 @end defopt
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
237
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
238 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
239 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
240 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
241 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
242 in the list.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
243
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
244 The syntax of @code{EMACSLOADPATH} is the same as used for @code{PATH};
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
245 @samp{:} (or @samp{;}, according to the operating system) separates
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
246 directory names, and @samp{.} is used for the current default directory.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
247 Here is an example of how to set your @code{EMACSLOADPATH} variable from
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
248 a @code{csh} @file{.login} file:
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
249
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
250 @smallexample
22271
71f954d59214 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22252
diff changeset
251 setenv EMACSLOADPATH .:/user/bil/emacs:/usr/local/share/emacs/20.3/lisp
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
252 @end smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
253
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
254 Here is how to set it using @code{sh}:
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
255
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
256 @smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
257 export EMACSLOADPATH
22271
71f954d59214 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22252
diff changeset
258 EMACSLOADPATH=.:/user/bil/emacs:/usr/local/share/emacs/20.3/lisp
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
259 @end smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
260
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
261 Here is an example of code you can place in your init file (@pxref{Init
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
262 File}) to add several directories to the front of your default
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
263 @code{load-path}:
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
264
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
265 @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
266 @group
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
267 (setq load-path
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
268 (append (list nil "/user/bil/emacs"
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
269 "/usr/local/lisplib"
12315
49a48bf414c7 Fix up load-path example.
Richard M. Stallman <rms@gnu.org>
parents: 12282
diff changeset
270 "~/emacs")
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
271 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
272 @end group
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
273 @end smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
274
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
275 @c Wordy to rid us of an overfull hbox. --rjc 15mar92
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
276 @noindent
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
277 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
278 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
279 @file{/usr/local/lisplib} directory, and the @file{~/emacs} directory,
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
280 which are then followed by the standard directories for Lisp code.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
281
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
282 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
283 @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
284 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
285 @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
286 @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
287 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
288
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
289 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
290 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
291 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
292 calls to @code{load}.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
293
15767
039b338d9656 Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents: 13087
diff changeset
294 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
295 been installed on the system, includes two special directories (and
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
296 their subdirectories as well):
15767
039b338d9656 Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents: 13087
diff changeset
297
039b338d9656 Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents: 13087
diff changeset
298 @smallexample
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
299 "/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
300 @end smallexample
039b338d9656 Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents: 13087
diff changeset
301
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
302 @noindent
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
303 and
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
304
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
305 @smallexample
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
306 "/usr/local/share/emacs/site-lisp"
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
307 @end smallexample
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
308
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
309 @noindent
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
310 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
311 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
312 all installed Emacs versions.
15767
039b338d9656 Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents: 13087
diff changeset
313
039b338d9656 Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents: 13087
diff changeset
314 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
315 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
316 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
317 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
318 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
319 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
320
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
321 Emacs finds these directories' subdirectories and adds them to
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
322 @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
323 subdirectories multiple levels down are added to @code{load-path}.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
324
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
325 Not all subdirectories are included, though. Subdirectories whose
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
326 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
327 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
328 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
329 methods to prevent certain subdirectories of the @file{site-lisp}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
330 directories from being searched.
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
331
15767
039b338d9656 Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents: 13087
diff changeset
332 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
333 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
334 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
335 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
336 are represented as absolute file names.)
039b338d9656 Describe the version-specific site-list directory.
Richard M. Stallman <rms@gnu.org>
parents: 13087
diff changeset
337
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
338 @deffn Command locate-library library &optional nosuffix path interactive-call
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
339 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
340 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
341 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
342 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
343 @var{library}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
344
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
345 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
346 instead of @code{load-path}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
347
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
348 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
349 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
350 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
351 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
352 @end deffn
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
353
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
354 @node Loading Non-ASCII
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52764
diff changeset
355 @section Loading Non-@acronym{ASCII} Characters
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
356
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52764
diff changeset
357 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
358 characters, these can be represented within Emacs either as unibyte
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
359 strings or as multibyte strings (@pxref{Text Representations}). Which
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
360 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
361 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
362 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
363 multibyte strings. If a file containing Latin-1 characters (for
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
364 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
365 unibyte text, and its string constants will be unibyte strings.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
366 @xref{Coding Systems}.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
367
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
368 To make the results more predictable, Emacs always performs decoding
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
369 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
370 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
371 constants with non-@acronym{ASCII} characters translate into multibyte
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
372 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
373 decoding.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
374
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
375 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
376 predictable results, regardless of how Emacs was started. In addition,
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
377 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
378 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
379 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
380 @code{default-enable-multibyte-characters}, and convert representations
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
381 appropriately.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
382
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52764
diff changeset
383 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
384 multibyte strings should not be noticeable, since inserting them in
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
385 unibyte buffers converts them to unibyte automatically. However, if
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
386 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
387 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
388 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
389 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
390 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
391 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
392
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
393 @node Autoload
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
394 @section Autoload
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
395 @cindex autoload
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
396
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
397 The @dfn{autoload} facility allows you to make a function or macro
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
398 known in Lisp, but put off loading the file that defines it. The first
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
399 call to the function automatically reads the proper file to install the
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
400 real definition and other associated code, then runs the real definition
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
401 as if it had been loaded all along.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
402
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403 There are two ways to set up an autoloaded function: by calling
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
404 @code{autoload}, and by writing a special ``magic'' comment in the
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405 source before the real definition. @code{autoload} is the low-level
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406 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
407 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
408 autoload, for packages installed along with Emacs. These comments do
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
409 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
410 @code{update-file-autoloads}, which constructs calls to @code{autoload}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
411 and arranges to execute them when Emacs is built.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
413 @defun autoload function filename &optional docstring interactive type
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
414 This function defines the function (or macro) named @var{function} so as
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
415 to load automatically from @var{filename}. The string @var{filename}
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
416 specifies the file to load to get the real definition of @var{function}.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
417
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
418 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
419 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
420 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
421 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
422 @code{load-suffixes} specifies the exact required suffixes.)
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
423
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
424 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
425 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
426 @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
427 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
428 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
429 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
430 takes effect when it is loaded.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
431
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
432 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
433 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
434 loading @var{function}'s real definition. The complete interactive
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
435 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
436 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
437 the real definition.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
438
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
439 You can autoload macros and keymaps as well as ordinary functions.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
440 Specify @var{type} as @code{macro} if @var{function} is really a macro.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
441 Specify @var{type} as @code{keymap} if @var{function} is really a
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
442 keymap. Various parts of Emacs need to know this information without
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
443 loading the real definition.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
444
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
445 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
446 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
447 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
448 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
449 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
450 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
451
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
452 @cindex function cell in autoload
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
453 If @var{function} already has a non-void function definition that is not
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
454 an autoload object, @code{autoload} does nothing and returns @code{nil}.
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
455 If the function cell of @var{function} is void, or is already an autoload
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
456 object, then it is defined as an autoload object like this:
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
457
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
458 @example
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
459 (autoload @var{filename} @var{docstring} @var{interactive} @var{type})
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
460 @end example
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
461
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48733
diff changeset
462 For example,
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
463
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
464 @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
465 @group
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
466 (symbol-function 'run-prolog)
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
467 @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
468 @end group
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
469 @end example
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
470
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
471 @noindent
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
472 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
473 refers to the documentation string in the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
474 @file{emacs/etc/DOC-@var{version}} file (@pxref{Documentation Basics}),
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
475 @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
476 not a macro or a keymap.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
477 @end defun
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
478
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
479 @cindex autoload errors
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
480 The autoloaded file usually contains other definitions and may require
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
481 or provide one or more features. If the file is not completely loaded
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
482 (due to an error in the evaluation of its contents), any function
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
483 definitions or @code{provide} calls that occurred during the load are
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
484 undone. This is to ensure that the next attempt to call any function
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
485 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
486 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
487 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
488 subroutines not loaded successfully because they come later in the file.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
489
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
490 If the autoloaded file fails to define the desired Lisp function or
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
491 macro, then an error is signaled with data @code{"Autoloading failed to
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
492 define function @var{function-name}"}.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
493
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
494 @findex update-file-autoloads
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
495 @findex update-directory-autoloads
62342
32b9b0540e8a (Autoload): Mention `autoload cookie' as synonym for
Luc Teirlinck <teirllm@auburn.edu>
parents: 60052
diff changeset
496 @cindex magic autoload comment
32b9b0540e8a (Autoload): Mention `autoload cookie' as synonym for
Luc Teirlinck <teirllm@auburn.edu>
parents: 60052
diff changeset
497 @cindex autoload cookie
32b9b0540e8a (Autoload): Mention `autoload cookie' as synonym for
Luc Teirlinck <teirllm@auburn.edu>
parents: 60052
diff changeset
498 @anchor{autoload cookie}
32b9b0540e8a (Autoload): Mention `autoload cookie' as synonym for
Luc Teirlinck <teirllm@auburn.edu>
parents: 60052
diff changeset
499 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
500 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
501 just before the real definition of the function in its
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
502 autoloadable source file. The command @kbd{M-x update-file-autoloads}
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
503 writes a corresponding @code{autoload} call into @file{loaddefs.el}.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
504 Building Emacs loads @file{loaddefs.el} and thus calls @code{autoload}.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
505 @kbd{M-x update-directory-autoloads} is even more powerful; it updates
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
506 autoloads for all files in the current directory.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
507
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
508 The same magic comment can copy any kind of form into
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
509 @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
510 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
511 verbatim. ``Function-defining forms'' include @code{define-skeleton},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
512 @code{define-derived-mode}, @code{define-generic-mode} and
28603
cb9db16dba12 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
513 @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
514 @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
515 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
516 if it uses @code{:require}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
517
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
518 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
519 @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
520 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
521 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
522 @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
523 it is executed while building Emacs.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
524
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
525 The following example shows how @code{doctor} is prepared for
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
526 autoloading with a magic comment:
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
527
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
528 @smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
529 ;;;###autoload
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
530 (defun doctor ()
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
531 "Switch to *doctor* buffer and start giving psychotherapy."
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
532 (interactive)
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
533 (switch-to-buffer "*doctor*")
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
534 (doctor-mode))
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535 @end smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537 @noindent
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
538 Here's what that produces in @file{loaddefs.el}:
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540 @smallexample
64609
68b56bb47e55 (Autoload): Make the `doctor' example be consistent
Eli Zaretskii <eliz@gnu.org>
parents: 62342
diff changeset
541 (autoload (quote doctor) "doctor" "\
68b56bb47e55 (Autoload): Make the `doctor' example be consistent
Eli Zaretskii <eliz@gnu.org>
parents: 62342
diff changeset
542 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
543
68b56bb47e55 (Autoload): Make the `doctor' example be consistent
Eli Zaretskii <eliz@gnu.org>
parents: 62342
diff changeset
544 \(fn)" t nil)
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
545 @end smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
546
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547 @noindent
64609
68b56bb47e55 (Autoload): Make the `doctor' example be consistent
Eli Zaretskii <eliz@gnu.org>
parents: 62342
diff changeset
548 @cindex @code{fn} in function's documentation string
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
549 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
550 convention used only in the preloaded uncompiled Lisp files such as
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
551 @file{loaddefs.el}; they tell @code{make-docfile} to put the
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
552 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
553 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
554 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
555 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
556 Functions}) display it.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
557
42769
c3e528c6c110 (Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents: 39169
diff changeset
558 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
559 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
560 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
561 @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
562 @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
563
c3e528c6c110 (Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents: 39169
diff changeset
564 @smallexample
c3e528c6c110 (Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents: 39169
diff changeset
565 ;;;###autoload (autoload 'foo "myfile")
c3e528c6c110 (Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents: 39169
diff changeset
566 (mydefunmacro foo
c3e528c6c110 (Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents: 39169
diff changeset
567 ...)
c3e528c6c110 (Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents: 39169
diff changeset
568 @end smallexample
c3e528c6c110 (Autoload): Explain how to autoload function definitions that use
Richard M. Stallman <rms@gnu.org>
parents: 39169
diff changeset
569
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570 @node Repeated Loading
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
571 @section Repeated Loading
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
572 @cindex repeated loading
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
573
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
574 You can load a given file more than once in an Emacs session. For
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
575 example, after you have rewritten and reinstalled a function definition
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
576 by editing it in a buffer, you may wish to return to the original
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
577 version; you can do this by reloading the file it came from.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
578
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
579 When you load or reload files, bear in mind that the @code{load} and
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
580 @code{load-library} functions automatically load a byte-compiled file
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
581 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
582 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
583 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
584 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
585 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
586 newer)}, to remind you to recompile it.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
587
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
588 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
589 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
590 each variable should be reinitialized when you reload the library;
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
591 @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
592 initialized. (@xref{Defining Variables}.)
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
593
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
594 The simplest way to add an element to an alist is like this:
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
595
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
596 @example
60041
123a4dbb8a87 (Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents: 59164
diff changeset
597 (push '(leif-mode " Leif") minor-mode-alist)
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
598 @end example
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
599
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
600 @noindent
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
601 But this would add multiple elements if the library is reloaded.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
602 To avoid the problem, write this:
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
603
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
604 @example
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
605 (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
606 (push '(leif-mode " Leif") minor-mode-alist))
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
607 @end example
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608
60041
123a4dbb8a87 (Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents: 59164
diff changeset
609 @noindent
123a4dbb8a87 (Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents: 59164
diff changeset
610 or this:
123a4dbb8a87 (Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents: 59164
diff changeset
611
123a4dbb8a87 (Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents: 59164
diff changeset
612 @example
123a4dbb8a87 (Autoload): defun's doc string overrides autoload's doc string.
Richard M. Stallman <rms@gnu.org>
parents: 59164
diff changeset
613 (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
614 @end example
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
615
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
616 Occasionally you will want to test explicitly whether a library has
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
617 already been loaded. Here's one way to test, in a library, whether it
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
618 has been loaded before:
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
619
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
620 @example
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
621 (defvar foo-was-loaded nil)
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
622
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
623 (unless foo-was-loaded
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
624 @var{execute-first-time-only}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
625 (setq foo-was-loaded t))
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
626 @end example
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
627
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
628 @noindent
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
629 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
630 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
631 @code{provide} call has been executed before.
27193
89afca54a135 @ifinto -> @ifnottex.
Gerd Moellmann <gerd@gnu.org>
parents: 27189
diff changeset
632 @ifnottex
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
633 @xref{Named Features}.
27193
89afca54a135 @ifinto -> @ifnottex.
Gerd Moellmann <gerd@gnu.org>
parents: 27189
diff changeset
634 @end ifnottex
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
635
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
636 @node Named Features
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
637 @section Features
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
638 @cindex features
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
639 @cindex requiring features
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 @cindex providing features
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
641
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
642 @code{provide} and @code{require} are an alternative to
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
643 @code{autoload} for loading files automatically. They work in terms of
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
644 named @dfn{features}. Autoloading is triggered by calling a specific
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
645 function, but a feature is loaded the first time another program asks
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
646 for it by name.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
647
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
648 A feature name is a symbol that stands for a collection of functions,
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
649 variables, etc. The file that defines them should @dfn{provide} the
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
650 feature. Another program that uses them may ensure they are defined by
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
651 @dfn{requiring} the feature. This loads the file of definitions if it
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
652 hasn't been loaded already.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
653
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
654 To require the presence of a feature, call @code{require} with the
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
655 feature name as argument. @code{require} looks in the global variable
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
656 @code{features} to see whether the desired feature has been provided
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
657 already. If not, it loads the feature from the appropriate file. This
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
658 file should call @code{provide} at the top level to add the feature to
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
659 @code{features}; if it fails to do so, @code{require} signals an error.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
660 @cindex load error with require
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
661
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48733
diff changeset
662 For example, in @file{emacs/lisp/prolog.el},
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
663 the definition for @code{run-prolog} includes the following code:
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
664
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
665 @smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
666 (defun run-prolog ()
16736
981e116b4ac6 Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents: 15767
diff changeset
667 "Run an inferior Prolog process, with I/O via buffer *prolog*."
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
668 (interactive)
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
669 (require 'comint)
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
670 (switch-to-buffer (make-comint "prolog" prolog-program-name))
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
671 (inferior-prolog-mode))
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
672 @end smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
673
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
674 @noindent
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
675 The expression @code{(require 'comint)} loads the file @file{comint.el}
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
676 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
677 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
678 so that @code{require} need not be given the file name.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
679
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
680 The @file{comint.el} file contains the following top-level expression:
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
681
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
682 @smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
683 (provide 'comint)
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
684 @end smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
685
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
686 @noindent
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
687 This adds @code{comint} to the global @code{features} list, so that
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
688 @code{(require 'comint)} will henceforth know that nothing needs to be
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
689 done.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
690
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
691 @cindex byte-compiling @code{require}
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
692 When @code{require} is used at top level in a file, it takes effect
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
693 when you byte-compile that file (@pxref{Byte Compilation}) as well as
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
694 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
695 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
696 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
697 @code{require}.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
698
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
699 Although top-level calls to @code{require} are evaluated during
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
700 byte compilation, @code{provide} calls are not. Therefore, you can
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
701 ensure that a file of definitions is loaded before it is byte-compiled
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
702 by including a @code{provide} followed by a @code{require} for the same
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
703 feature, as in the following example.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
704
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
705 @smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
706 @group
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
707 (provide 'my-feature) ; @r{Ignored by byte compiler,}
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
708 ; @r{evaluated by @code{load}.}
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
709 (require 'my-feature) ; @r{Evaluated by byte compiler.}
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
710 @end group
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
711 @end smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
712
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
713 @noindent
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
714 The compiler ignores the @code{provide}, then processes the
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
715 @code{require} by loading the file in question. Loading the file does
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
716 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
717 does nothing when the file is loaded.
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
718
45979
87962bf716e3 *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42769
diff changeset
719 @defun provide feature &optional subfeatures
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
720 This function announces that @var{feature} is now loaded, or being
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
721 loaded, into the current Emacs session. This means that the facilities
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
722 associated with @var{feature} are or will be available for other Lisp
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
723 programs.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
724
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
725 The direct effect of calling @code{provide} is to add @var{feature} to
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
726 the front of the list @code{features} if it is not already in the list.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
727 The argument @var{feature} must be a symbol. @code{provide} returns
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
728 @var{feature}.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
729
45979
87962bf716e3 *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42769
diff changeset
730 If provided, @var{subfeatures} should be a list of symbols indicating
74704
ea5c96e3cad9 (Named Features): Explain subfeatures better.
Richard M. Stallman <rms@gnu.org>
parents: 71995
diff changeset
731 a set of specific subfeatures provided by this version of
ea5c96e3cad9 (Named Features): Explain subfeatures better.
Richard M. Stallman <rms@gnu.org>
parents: 71995
diff changeset
732 @var{feature}. You can test the presence of a subfeature using
ea5c96e3cad9 (Named Features): Explain subfeatures better.
Richard M. Stallman <rms@gnu.org>
parents: 71995
diff changeset
733 @code{featurep}. The idea of subfeatures is that you use them when a
ea5c96e3cad9 (Named Features): Explain subfeatures better.
Richard M. Stallman <rms@gnu.org>
parents: 71995
diff changeset
734 package (which is one @var{feature}) is complex enough to make it
ea5c96e3cad9 (Named Features): Explain subfeatures better.
Richard M. Stallman <rms@gnu.org>
parents: 71995
diff changeset
735 useful to give names to various parts or functionalities of the
ea5c96e3cad9 (Named Features): Explain subfeatures better.
Richard M. Stallman <rms@gnu.org>
parents: 71995
diff changeset
736 package, which might or might not be loaded, or might or might not be
ea5c96e3cad9 (Named Features): Explain subfeatures better.
Richard M. Stallman <rms@gnu.org>
parents: 71995
diff changeset
737 present in a given version. @xref{Network Feature Testing}, for
ea5c96e3cad9 (Named Features): Explain subfeatures better.
Richard M. Stallman <rms@gnu.org>
parents: 71995
diff changeset
738 an example.
45979
87962bf716e3 *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42769
diff changeset
739
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
740 @smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
741 features
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
742 @result{} (bar bish)
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
743
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
744 (provide 'foo)
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
745 @result{} foo
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
746 features
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
747 @result{} (foo bar bish)
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
748 @end smallexample
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
749
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
750 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
751 error in the evaluation of its contents, any function definitions or
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
752 @code{provide} calls that occurred during the load are undone.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
753 @xref{Autoload}.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
754 @end defun
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
755
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22675
diff changeset
756 @defun require feature &optional filename noerror
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
757 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
758 Emacs session (using @code{(featurep @var{feature})}; see below). The
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
759 argument @var{feature} must be a symbol.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
760
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16736
diff changeset
761 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
762 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
763 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
764 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
765 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
766 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
767 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
768 required Lisp suffixes.)
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
769
55860
c1864c2911cf (Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents: 54035
diff changeset
770 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
771 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
772 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
773 @var{feature}.
c1864c2911cf (Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents: 54035
diff changeset
774
c1864c2911cf (Named Features): Clarify return value and meaning of NOERROR.
Richard M. Stallman <rms@gnu.org>
parents: 54035
diff changeset
775 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
776 @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
777 was not provided}.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
778 @end defun
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
779
45979
87962bf716e3 *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42769
diff changeset
780 @defun featurep feature &optional subfeature
51681
0a1f20d3fa89 Fix minor Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
781 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
782 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
783 @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
784 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
785 (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
786 property of the @var{feature} symbol.)
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
787 @end defun
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
788
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
789 @defvar features
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
790 The value of this variable is a list of symbols that are the features
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
791 loaded in the current Emacs session. Each symbol was put in this list
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
792 with a call to @code{provide}. The order of the elements in the
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
793 @code{features} list is not significant.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
794 @end defvar
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
795
59134
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
796 @node Where Defined
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
797 @section Which File Defined a Certain Symbol
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
798
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
799 @defun symbol-file symbol &optional type
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
800 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
801 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
802 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
803 specifies function definition only or variable definition only.
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
804
66289
53d622f10d15 (Where Defined): load-history contains abs file names.
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
805 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
806 @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
807 @end defun
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 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
810 @code{load-history}.
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
811
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
812 @defvar load-history
66289
53d622f10d15 (Where Defined): load-history contains abs file names.
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
813 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
814 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
815 and the features they require.
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
816
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
817 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
818 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
819 of the list elements have these forms:
59134
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
820
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
821 @table @code
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
822 @item @var{var}
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
823 The symbol @var{var} was defined as a variable.
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
824 @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
825 The function @var{fun} was defined.
59134
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
826 @item (t . @var{fun})
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
827 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
828 redefined it as a function. The following element is always
60052
cfd3265fdbc5 (Where Defined): Fix typo.
Lute Kamstra <lute@gnu.org>
parents: 60041
diff changeset
829 @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
830 function.
59134
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
831 @item (autoload . @var{fun})
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
832 The function @var{fun} was defined as an autoload.
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
833 @item (require . @var{feature})
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
834 The feature @var{feature} was required.
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
835 @item (provide . @var{feature})
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
836 The feature @var{feature} was provided.
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
837 @end table
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
838
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
839 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
840 @code{nil}. This element describes definitions made with
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
841 @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
842 @end defvar
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
843
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
844 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
845 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
846 rather than replacing that element. @xref{Eval}.
26d02bae850d (Where Defined): New node.
Richard M. Stallman <rms@gnu.org>
parents: 56215
diff changeset
847
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
848 @node Unloading
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
849 @section Unloading
76989
038943a0a75a (Unloading): Improve index entry.
Richard M. Stallman <rms@gnu.org>
parents: 76878
diff changeset
850 @cindex unloading packages
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
851
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
852 @c Emacs 19 feature
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
853 You can discard the functions and variables loaded by a library to
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
854 reclaim memory for other Lisp objects. To do this, use the function
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
855 @code{unload-feature}:
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
856
10513
e4423ed2b4cb Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents: 7212
diff changeset
857 @deffn Command unload-feature feature &optional force
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
858 This command unloads the library that provided feature @var{feature}.
7212
2f1305fcecf6 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 6453
diff changeset
859 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
860 library with @code{defun}, @code{defalias}, @code{defsubst},
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
861 @code{defmacro}, @code{defconst}, @code{defvar}, and @code{defcustom}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
862 It then restores any autoloads formerly associated with those symbols.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
863 (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
864
22623
ccc1f8081ef1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22419
diff changeset
865 Before restoring the previous definitions, @code{unload-feature} runs
ccc1f8081ef1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22419
diff changeset
866 @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
867 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
868 or @samp{-hooks}, plus those listed in
79197
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
869 @code{unload-feature-special-hooks}, as well as
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
870 @code{auto-mode-alist}. This is to prevent Emacs from ceasing to
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
871 function because important hooks refer to functions that are no longer
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
872 defined.
22623
ccc1f8081ef1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22419
diff changeset
873
79197
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
874 Standard unloading activities also undoes ELP profiling of functions
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
875 in that library, unprovides any features provided by the library, and
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
876 cancels timers held in variables defined by the library.
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
877
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
878 @vindex @var{feature}-unload-function
22623
ccc1f8081ef1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22419
diff changeset
879 If these measures are not sufficient to prevent malfunction, a library
79197
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
880 can define an explicit unloader named @code{@var{feature}-unload-function}.
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
881 If that symbol is defined as a function, @code{unload-feature} calls
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
882 it with no arguments before doing anything else. It can do whatever
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
883 is appropriate to unload the library. If it returns @code{nil},
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
884 @code{unload-feature} proceeds to take the normal unload actions.
05ea1c83f761 (Unloading): Document FEATURE-unload-function instead of FEATURE-unload-hook.
Richard M. Stallman <rms@gnu.org>
parents: 76989
diff changeset
885 Otherwise it considers the job to be done.
22623
ccc1f8081ef1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22419
diff changeset
886
10513
e4423ed2b4cb Document force arg in unload-feature.
Richard M. Stallman <rms@gnu.org>
parents: 7212
diff changeset
887 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
888 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
889 @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
890 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
891 ignored and you can unload any library.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
892 @end deffn
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
893
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
894 The @code{unload-feature} function is written in Lisp; its actions are
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
895 based on the variable @code{load-history}.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
896
54035
5089d03a2061 (Unloading): Document unload-feature-special-hooks.
Richard M. Stallman <rms@gnu.org>
parents: 53299
diff changeset
897 @defvar unload-feature-special-hooks
22623
ccc1f8081ef1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22419
diff changeset
898 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
899 library, to remove functions defined in the library.
ccc1f8081ef1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22419
diff changeset
900 @end defvar
ccc1f8081ef1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22419
diff changeset
901
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
902 @node Hooks for Loading
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
903 @section Hooks for Loading
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
904 @cindex loading hooks
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
905 @cindex hooks for loading
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
906
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
907 You can ask for code to be executed if and when a particular library is
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
908 loaded, by calling @code{eval-after-load}.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
909
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
910 @defun eval-after-load library form
75672
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
911 This function arranges to evaluate @var{form} at the end of loading
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
912 the file @var{library}, each time @var{library} is loaded. If
10913
880d7c28921c Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents: 10659
diff changeset
913 @var{library} is already loaded, it evaluates @var{form} right away.
75672
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
914 Don't forget to quote @var{form}!
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
915
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
916 You don't need to give a directory or extension in the file name
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
917 @var{library}---normally you just give a bare file name, like this:
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
918
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
919 @example
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
920 (eval-after-load "edebug" '(def-edebug-spec c-point t))
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
921 @end example
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
922
75672
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
923 To restrict which files can trigger the evaluation, include a
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
924 directory or an extension or both in @var{library}. Only a file whose
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
925 absolute true name (i.e., the name with all symbolic links chased out)
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
926 matches all the given name components will match. In the following
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
927 example, @file{my_inst.elc} or @file{my_inst.elc.gz} in some directory
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
928 @code{..../foo/bar} will trigger the evaluation, but not
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
929 @file{my_inst.el}:
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
930
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
931 @example
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
932 (eval-after-load "foo/bar/my_inst.elc" @dots{})
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
933 @end example
45979
87962bf716e3 *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42769
diff changeset
934
47625
8a11d295c3f3 *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45979
diff changeset
935 @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
936 @var{form} is evaluated when @code{(provide @var{library})} is called.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
937
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
938 An error in @var{form} does not undo the load, but does prevent
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
939 execution of the rest of @var{form}.
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
940 @end defun
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
941
10913
880d7c28921c Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents: 10659
diff changeset
942 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
943 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
944 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
945 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
946 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
947 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
948 with @code{require}).
880d7c28921c Change in eval-after-load; advise not using it.
Richard M. Stallman <rms@gnu.org>
parents: 10659
diff changeset
949
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
950 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
951 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
952 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
953
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
954 @defvar after-load-alist
75672
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
955 This variable, an alist built by @code{eval-after-load}, holds the
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
956 expressions to evaluate when particular libraries are loaded. Each
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
957 element looks like this:
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
958
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
959 @example
75672
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
960 (@var{regexp-or-feature} @var{forms}@dots{})
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
961 @end example
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
962
75672
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
963 The key @var{regexp-or-feature} is either a regular expression or a
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
964 symbol, and the value is a list of forms. The forms are evaluated when
76878
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
965 the key matches the absolute true name of the file being
75672
be4d65a36b11 (Hooks for Loading): Make the description of `eval-after-load' more
Alan Mackenzie <acm@muc.de>
parents: 75250
diff changeset
966 @code{load}ed or the symbol being @code{provide}d.
6453
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
967 @end defvar
974a37e5c414 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
968
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51915
diff changeset
969 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51915
diff changeset
970 arch-tag: df731f89-0900-4389-a436-9105241b6f7a
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51915
diff changeset
971 @end ignore