annotate doc/lispref/loading.texi @ 112228:417b1e4d63cd

Merge from emacs-23
author Stefan Monnier <monnier@iro.umontreal.ca>
date Fri, 14 Jan 2011 12:18:41 -0500
parents 28f569136b3e 376148b31b5e
children ef719132ddfa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
112218
376148b31b5e Add 2011 to FSF/AIST copyright years.
Glenn Morris <rgm@gnu.org>
parents: 111608
diff changeset
4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
109267
71353caf35e3 Untabify doc/lispref/*.texi.
Glenn Morris <rgm@gnu.org>
parents: 108366
diff changeset
5 @c Free Software Foundation, Inc.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6 @c See the file elisp.texi for copying conditions.
84116
0ba80d073e27 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84081
diff changeset
7 @setfilename ../../info/loading
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @node Loading, Byte Compilation, Customization, Top
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @chapter Loading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10 @cindex loading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 @cindex library
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 @cindex Lisp library
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 Loading a file of Lisp code means bringing its contents into the Lisp
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 environment in the form of Lisp objects. Emacs finds and opens the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 file, reads the text, evaluates each form, and then closes the file.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 The load functions evaluate all the expressions in a file just
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 as the @code{eval-buffer} function evaluates all the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 expressions in a buffer. The difference is that the load functions
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21 read and evaluate the text in the file as found on disk, not the text
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 in an Emacs buffer.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24 @cindex top-level form
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 The loaded file must contain Lisp expressions, either as source code
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 or as byte-compiled code. Each form in the file is called a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 @dfn{top-level form}. There is no special format for the forms in a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 loadable file; any form in a file may equally well be typed directly
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29 into a buffer and evaluated there. (Indeed, most code is tested this
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 way.) Most often, the forms are function definitions and variable
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 definitions.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33 A file containing Lisp code is often called a @dfn{library}. Thus,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34 the ``Rmail library'' is a file containing code for Rmail mode.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35 Similarly, a ``Lisp library directory'' is a directory of files
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 containing Lisp code.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
38 @menu
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 * How Programs Do Loading:: The @code{load} function and others.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40 * Load Suffixes:: Details about the suffixes that @code{load} tries.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 * Library Search:: Finding a library to load.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 * Loading Non-ASCII:: Non-@acronym{ASCII} characters in Emacs Lisp files.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43 * Autoload:: Setting up a function to autoload.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44 * Repeated Loading:: Precautions about loading a file twice.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 * Named Features:: Loading a library if it isn't already loaded.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 * Where Defined:: Finding which file defined a certain symbol.
109267
71353caf35e3 Untabify doc/lispref/*.texi.
Glenn Morris <rgm@gnu.org>
parents: 108366
diff changeset
47 * Unloading:: How to "unload" a library that was loaded.
71353caf35e3 Untabify doc/lispref/*.texi.
Glenn Morris <rgm@gnu.org>
parents: 108366
diff changeset
48 * Hooks for Loading:: Providing code to be run when
71353caf35e3 Untabify doc/lispref/*.texi.
Glenn Morris <rgm@gnu.org>
parents: 108366
diff changeset
49 particular libraries are loaded.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 @end menu
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 @node How Programs Do Loading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53 @section How Programs Do Loading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 Emacs Lisp has several interfaces for loading. For example,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 @code{autoload} creates a placeholder object for a function defined in a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 file; trying to call the autoloading function loads the file to get the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58 function's real definition (@pxref{Autoload}). @code{require} loads a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 file if it isn't already loaded (@pxref{Named Features}). Ultimately,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 all these facilities call the @code{load} function to do the work.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 @defun load filename &optional missing-ok nomessage nosuffix must-suffix
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 This function finds and opens a file of Lisp code, evaluates all the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 forms in it, and closes the file.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 To find the file, @code{load} first looks for a file named
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67 @file{@var{filename}.elc}, that is, for a file whose name is
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 @var{filename} with the extension @samp{.elc} appended. If such a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 file exists, it is loaded. If there is no file by that name, then
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 @code{load} looks for a file named @file{@var{filename}.el}. If that
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 file exists, it is loaded. Finally, if neither of those names is
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 found, @code{load} looks for a file named @var{filename} with nothing
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 appended, and loads it if it exists. (The @code{load} function is not
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74 clever about looking at @var{filename}. In the perverse case of a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 file named @file{foo.el.el}, evaluation of @code{(load "foo.el")} will
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 indeed find it.)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 If Auto Compression mode is enabled, as it is by default, then if
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 @code{load} can not find a file, it searches for a compressed version
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 of the file before trying other file names. It decompresses and loads
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 it if it exists. It looks for compressed versions by appending each
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 of the suffixes in @code{jka-compr-load-suffixes} to the file name.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83 The value of this variable must be a list of strings. Its standard
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 value is @code{(".gz")}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 If the optional argument @var{nosuffix} is non-@code{nil}, then
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 @code{load} does not try the suffixes @samp{.elc} and @samp{.el}. In
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 this case, you must specify the precise file name you want, except
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 that, if Auto Compression mode is enabled, @code{load} will still use
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 @code{jka-compr-load-suffixes} to find compressed versions. By
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 specifying the precise file name and using @code{t} for
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 @var{nosuffix}, you can prevent perverse file names such as
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 @file{foo.el.el} from being tried.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 If the optional argument @var{must-suffix} is non-@code{nil}, then
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 @code{load} insists that the file name used must end in either
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 @samp{.el} or @samp{.elc} (possibly extended with a compression
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 suffix), unless it contains an explicit directory name.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 If @var{filename} is a relative file name, such as @file{foo} or
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 @file{baz/foo.bar}, @code{load} searches for the file using the variable
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 @code{load-path}. It appends @var{filename} to each of the directories
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 listed in @code{load-path}, and loads the first file it finds whose name
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 matches. The current default directory is tried only if it is specified
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 in @code{load-path}, where @code{nil} stands for the default directory.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106 @code{load} tries all three possible suffixes in the first directory in
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 @code{load-path}, then all three suffixes in the second directory, and
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108 so on. @xref{Library Search}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109
111608
2f23047ca654 Fix bug #7346: document load-file-name.
Eli Zaretskii <eliz@gnu.org>
parents: 109267
diff changeset
110 Whatever the name under which the file is eventually found, and the
2f23047ca654 Fix bug #7346: document load-file-name.
Eli Zaretskii <eliz@gnu.org>
parents: 109267
diff changeset
111 directory where Emacs found it, Emacs sets the value of the variable
2f23047ca654 Fix bug #7346: document load-file-name.
Eli Zaretskii <eliz@gnu.org>
parents: 109267
diff changeset
112 @code{load-file-name} to that file's name.
2f23047ca654 Fix bug #7346: document load-file-name.
Eli Zaretskii <eliz@gnu.org>
parents: 109267
diff changeset
113
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 If you get a warning that @file{foo.elc} is older than @file{foo.el}, it
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115 means you should consider recompiling @file{foo.el}. @xref{Byte
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116 Compilation}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118 When loading a source file (not compiled), @code{load} performs
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 character set translation just as Emacs would do when visiting the file.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120 @xref{Coding Systems}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122 Messages like @samp{Loading foo...} and @samp{Loading foo...done} appear
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 in the echo area during loading unless @var{nomessage} is
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 non-@code{nil}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 @cindex load errors
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127 Any unhandled errors while loading a file terminate loading. If the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128 load was done for the sake of @code{autoload}, any function definitions
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129 made during the loading are undone.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 @kindex file-error
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 If @code{load} can't find the file to load, then normally it signals the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133 error @code{file-error} (with @samp{Cannot open load file
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134 @var{filename}}). But if @var{missing-ok} is non-@code{nil}, then
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 @code{load} just returns @code{nil}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137 You can use the variable @code{load-read-function} to specify a function
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 for @code{load} to use instead of @code{read} for reading expressions.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 See below.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 @code{load} returns @code{t} if the file loads successfully.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 @end defun
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 @deffn Command load-file filename
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 This command loads the file @var{filename}. If @var{filename} is a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 relative file name, then the current default directory is assumed.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 This command does not use @code{load-path}, and does not append
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 suffixes. However, it does look for compressed versions (if Auto
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 Compression Mode is enabled). Use this command if you wish to specify
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 precisely the file name to load.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 @end deffn
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 @deffn Command load-library library
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154 This command loads the library named @var{library}. It is equivalent to
104283
131617b1ba40 * customize.texi (Common Keywords): Add xref to Loading.
Chong Yidong <cyd@stupidchicken.com>
parents: 103951
diff changeset
155 @code{load}, except for the way it reads its argument interactively.
131617b1ba40 * customize.texi (Common Keywords): Add xref to Loading.
Chong Yidong <cyd@stupidchicken.com>
parents: 103951
diff changeset
156 @xref{Lisp Libraries,,,emacs, The GNU Emacs Manual}.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157 @end deffn
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 @defvar load-in-progress
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 This variable is non-@code{nil} if Emacs is in the process of loading a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161 file, and it is @code{nil} otherwise.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 @end defvar
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163
111608
2f23047ca654 Fix bug #7346: document load-file-name.
Eli Zaretskii <eliz@gnu.org>
parents: 109267
diff changeset
164 @defvar load-file-name
2f23047ca654 Fix bug #7346: document load-file-name.
Eli Zaretskii <eliz@gnu.org>
parents: 109267
diff changeset
165 When Emacs is in the process of loading a file, this variable's value
2f23047ca654 Fix bug #7346: document load-file-name.
Eli Zaretskii <eliz@gnu.org>
parents: 109267
diff changeset
166 is the name of that file, as Emacs found it during the search
2f23047ca654 Fix bug #7346: document load-file-name.
Eli Zaretskii <eliz@gnu.org>
parents: 109267
diff changeset
167 described earlier in this section.
2f23047ca654 Fix bug #7346: document load-file-name.
Eli Zaretskii <eliz@gnu.org>
parents: 109267
diff changeset
168 @end defvar
2f23047ca654 Fix bug #7346: document load-file-name.
Eli Zaretskii <eliz@gnu.org>
parents: 109267
diff changeset
169
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170 @defvar load-read-function
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 @anchor{Definition of load-read-function}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 @c do not allow page break at anchor; work around Texinfo deficiency.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 This variable specifies an alternate expression-reading function for
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 @code{load} and @code{eval-region} to use instead of @code{read}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175 The function should accept one argument, just as @code{read} does.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177 Normally, the variable's value is @code{nil}, which means those
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 functions should use @code{read}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180 Instead of using this variable, it is cleaner to use another, newer
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 feature: to pass the function as the @var{read-function} argument to
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 @code{eval-region}. @xref{Definition of eval-region,, Eval}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183 @end defvar
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 For information about how @code{load} is used in building Emacs, see
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186 @ref{Building Emacs}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188 @node Load Suffixes
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189 @section Load Suffixes
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190 We now describe some technical details about the exact suffixes that
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 @code{load} tries.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 @defvar load-suffixes
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194 This is a list of suffixes indicating (compiled or source) Emacs Lisp
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 files. It should not include the empty string. @code{load} uses
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 these suffixes in order when it appends Lisp suffixes to the specified
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 file name. The standard value is @code{(".elc" ".el")} which produces
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 the behavior described in the previous section.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199 @end defvar
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201 @defvar load-file-rep-suffixes
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202 This is a list of suffixes that indicate representations of the same
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203 file. This list should normally start with the empty string.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204 When @code{load} searches for a file it appends the suffixes in this
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205 list, in order, to the file name, before searching for another file.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
206
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207 Enabling Auto Compression mode appends the suffixes in
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208 @code{jka-compr-load-suffixes} to this list and disabling Auto
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 Compression mode removes them again. The standard value of
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210 @code{load-file-rep-suffixes} if Auto Compression mode is disabled is
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211 @code{("")}. Given that the standard value of
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212 @code{jka-compr-load-suffixes} is @code{(".gz")}, the standard value
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213 of @code{load-file-rep-suffixes} if Auto Compression mode is enabled
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214 is @code{("" ".gz")}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215 @end defvar
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217 @defun get-load-suffixes
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218 This function returns the list of all suffixes that @code{load} should
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219 try, in order, when its @var{must-suffix} argument is non-@code{nil}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220 This takes both @code{load-suffixes} and @code{load-file-rep-suffixes}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 into account. If @code{load-suffixes}, @code{jka-compr-load-suffixes}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222 and @code{load-file-rep-suffixes} all have their standard values, this
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223 function returns @code{(".elc" ".elc.gz" ".el" ".el.gz")} if Auto
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224 Compression mode is enabled and @code{(".elc" ".el")} if Auto
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 Compression mode is disabled.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226 @end defun
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228 To summarize, @code{load} normally first tries the suffixes in the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229 value of @code{(get-load-suffixes)} and then those in
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
230 @code{load-file-rep-suffixes}. If @var{nosuffix} is non-@code{nil},
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 it skips the former group, and if @var{must-suffix} is non-@code{nil},
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232 it skips the latter group.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 @node Library Search
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 @section Library Search
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 @cindex library search
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237 @cindex find library
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 When Emacs loads a Lisp library, it searches for the library
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 in a list of directories specified by the variable @code{load-path}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 @defopt load-path
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 @cindex @code{EMACSLOADPATH} environment variable
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 The value of this variable is a list of directories to search when
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 loading files with @code{load}. Each element is a string (which must be
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 a directory name) or @code{nil} (which stands for the current working
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 directory).
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 @end defopt
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 The value of @code{load-path} is initialized from the environment
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 variable @code{EMACSLOADPATH}, if that exists; otherwise its default
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252 value is specified in @file{emacs/src/epaths.h} when Emacs is built.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 Then the list is expanded by adding subdirectories of the directories
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 in the list.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256 The syntax of @code{EMACSLOADPATH} is the same as used for @code{PATH};
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257 @samp{:} (or @samp{;}, according to the operating system) separates
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 directory names, and @samp{.} is used for the current default directory.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259 Here is an example of how to set your @code{EMACSLOADPATH} variable from
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260 a @code{csh} @file{.login} file:
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262 @smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 setenv EMACSLOADPATH .:/user/bil/emacs:/usr/local/share/emacs/20.3/lisp
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 @end smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266 Here is how to set it using @code{sh}:
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 @smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 export EMACSLOADPATH
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 EMACSLOADPATH=.:/user/bil/emacs:/usr/local/share/emacs/20.3/lisp
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 @end smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273 Here is an example of code you can place in your init file (@pxref{Init
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 File}) to add several directories to the front of your default
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 @code{load-path}:
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 @smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278 @group
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 (setq load-path
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280 (append (list nil "/user/bil/emacs"
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 "/usr/local/lisplib"
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282 "~/emacs")
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283 load-path))
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284 @end group
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 @end smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 @c Wordy to rid us of an overfull hbox. --rjc 15mar92
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 @noindent
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289 In this example, the path searches the current working directory first,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 followed then by the @file{/user/bil/emacs} directory, the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291 @file{/usr/local/lisplib} directory, and the @file{~/emacs} directory,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 which are then followed by the standard directories for Lisp code.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 Dumping Emacs uses a special value of @code{load-path}. If the value of
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295 @code{load-path} at the end of dumping is unchanged (that is, still the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 same special value), the dumped Emacs switches to the ordinary
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297 @code{load-path} value when it starts up, as described above. But if
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298 @code{load-path} has any other value at the end of dumping, that value
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299 is used for execution of the dumped Emacs also.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301 Therefore, if you want to change @code{load-path} temporarily for
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 loading a few libraries in @file{site-init.el} or @file{site-load.el},
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303 you should bind @code{load-path} locally with @code{let} around the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304 calls to @code{load}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306 The default value of @code{load-path}, when running an Emacs which has
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 been installed on the system, includes two special directories (and
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 their subdirectories as well):
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310 @smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 "/usr/local/share/emacs/@var{version}/site-lisp"
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 @end smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 @noindent
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 and
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 @smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318 "/usr/local/share/emacs/site-lisp"
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 @end smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321 @noindent
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 The first one is for locally installed packages for a particular Emacs
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 version; the second is for locally installed packages meant for use with
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 all installed Emacs versions.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 There are several reasons why a Lisp package that works well in one
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 Emacs version can cause trouble in another. Sometimes packages need
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 updating for incompatible changes in Emacs; sometimes they depend on
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 undocumented internal Emacs data that can change without notice;
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 sometimes a newer Emacs version incorporates a version of the package,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 and should be used only with that version.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333 Emacs finds these directories' subdirectories and adds them to
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 @code{load-path} when it starts up. Both immediate subdirectories and
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335 subdirectories multiple levels down are added to @code{load-path}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337 Not all subdirectories are included, though. Subdirectories whose
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338 names do not start with a letter or digit are excluded. Subdirectories
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 named @file{RCS} or @file{CVS} are excluded. Also, a subdirectory which
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 contains a file named @file{.nosearch} is excluded. You can use these
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 methods to prevent certain subdirectories of the @file{site-lisp}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342 directories from being searched.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 If you run Emacs from the directory where it was built---that is, an
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 executable that has not been formally installed---then @code{load-path}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 normally contains two additional directories. These are the @code{lisp}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 and @code{site-lisp} subdirectories of the main build directory. (Both
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 are represented as absolute file names.)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350 @deffn Command locate-library library &optional nosuffix path interactive-call
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 This command finds the precise file name for library @var{library}. It
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352 searches for the library in the same way @code{load} does, and the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 argument @var{nosuffix} has the same meaning as in @code{load}: don't
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 add suffixes @samp{.elc} or @samp{.el} to the specified name
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 @var{library}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 If the @var{path} is non-@code{nil}, that list of directories is used
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 instead of @code{load-path}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 When @code{locate-library} is called from a program, it returns the file
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 name as a string. When the user runs @code{locate-library}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 interactively, the argument @var{interactive-call} is @code{t}, and this
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 tells @code{locate-library} to display the file name in the echo area.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 @end deffn
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366 @node Loading Non-ASCII
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 @section Loading Non-@acronym{ASCII} Characters
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 When Emacs Lisp programs contain string constants with non-@acronym{ASCII}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 characters, these can be represented within Emacs either as unibyte
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 strings or as multibyte strings (@pxref{Text Representations}). Which
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 representation is used depends on how the file is read into Emacs. If
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 it is read with decoding into multibyte representation, the text of the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 Lisp program will be multibyte text, and its string constants will be
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375 multibyte strings. If a file containing Latin-1 characters (for
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 example) is read without decoding, the text of the program will be
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 unibyte text, and its string constants will be unibyte strings.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378 @xref{Coding Systems}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 The reason Emacs is designed this way is so that Lisp programs give
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 predictable results, regardless of how Emacs was started. In addition,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 this enables programs that depend on using multibyte text to work even
104626
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104283
diff changeset
383 in a unibyte Emacs.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 In most Emacs Lisp programs, the fact that non-@acronym{ASCII} strings are
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 multibyte strings should not be noticeable, since inserting them in
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 unibyte buffers converts them to unibyte automatically. However, if
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 this does make a difference, you can force a particular Lisp file to be
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 interpreted as unibyte by writing @samp{-*-unibyte: t;-*-} in a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 comment on the file's first line. With that designator, the file will
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 unconditionally be interpreted as unibyte, even in an ordinary
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 multibyte Emacs session. This can matter when making keybindings to
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 non-@acronym{ASCII} characters written as @code{?v@var{literal}}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 @node Autoload
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 @section Autoload
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397 @cindex autoload
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 The @dfn{autoload} facility allows you to make a function or macro
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 known in Lisp, but put off loading the file that defines it. The first
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 call to the function automatically reads the proper file to install the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 real definition and other associated code, then runs the real definition
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 as if it had been loaded all along.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 There are two ways to set up an autoloaded function: by calling
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 @code{autoload}, and by writing a special ``magic'' comment in the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407 source before the real definition. @code{autoload} is the low-level
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 primitive for autoloading; any Lisp program can call @code{autoload} at
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 any time. Magic comments are the most convenient way to make a function
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410 autoload, for packages installed along with Emacs. These comments do
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 nothing on their own, but they serve as a guide for the command
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 @code{update-file-autoloads}, which constructs calls to @code{autoload}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 and arranges to execute them when Emacs is built.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 @defun autoload function filename &optional docstring interactive type
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 This function defines the function (or macro) named @var{function} so as
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 to load automatically from @var{filename}. The string @var{filename}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 specifies the file to load to get the real definition of @var{function}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 If @var{filename} does not contain either a directory name, or the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 suffix @code{.el} or @code{.elc}, then @code{autoload} insists on adding
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 one of these suffixes, and it will not load from a file whose name is
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 just @var{filename} with no added suffix. (The variable
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 @code{load-suffixes} specifies the exact required suffixes.)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 The argument @var{docstring} is the documentation string for the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427 function. Specifying the documentation string in the call to
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428 @code{autoload} makes it possible to look at the documentation without
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 loading the function's real definition. Normally, this should be
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 identical to the documentation string in the function definition
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431 itself. If it isn't, the function definition's documentation string
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 takes effect when it is loaded.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 If @var{interactive} is non-@code{nil}, that says @var{function} can be
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435 called interactively. This lets completion in @kbd{M-x} work without
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 loading @var{function}'s real definition. The complete interactive
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437 specification is not given here; it's not needed unless the user
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 actually calls @var{function}, and when that happens, it's time to load
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 the real definition.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 You can autoload macros and keymaps as well as ordinary functions.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 Specify @var{type} as @code{macro} if @var{function} is really a macro.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 Specify @var{type} as @code{keymap} if @var{function} is really a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 keymap. Various parts of Emacs need to know this information without
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 loading the real definition.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 An autoloaded keymap loads automatically during key lookup when a prefix
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 key's binding is the symbol @var{function}. Autoloading does not occur
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 for other kinds of access to the keymap. In particular, it does not
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 happen when a Lisp program gets the keymap from the value of a variable
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 and calls @code{define-key}; not even if the variable name is the same
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 symbol @var{function}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 @cindex function cell in autoload
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 If @var{function} already has a non-void function definition that is not
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 an autoload object, @code{autoload} does nothing and returns @code{nil}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457 If the function cell of @var{function} is void, or is already an autoload
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 object, then it is defined as an autoload object like this:
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460 @example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 (autoload @var{filename} @var{docstring} @var{interactive} @var{type})
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 @end example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 For example,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 @example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467 @group
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468 (symbol-function 'run-prolog)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 @result{} (autoload "prolog" 169681 t nil)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 @end group
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 @end example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 @noindent
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 In this case, @code{"prolog"} is the name of the file to load, 169681
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 refers to the documentation string in the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 @file{emacs/etc/DOC-@var{version}} file (@pxref{Documentation Basics}),
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477 @code{t} means the function is interactive, and @code{nil} that it is
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478 not a macro or a keymap.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 @end defun
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 @cindex autoload errors
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482 The autoloaded file usually contains other definitions and may require
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483 or provide one or more features. If the file is not completely loaded
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484 (due to an error in the evaluation of its contents), any function
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 definitions or @code{provide} calls that occurred during the load are
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 undone. This is to ensure that the next attempt to call any function
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487 autoloading from this file will try again to load the file. If not for
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 this, then some of the functions in the file might be defined by the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 aborted load, but fail to work properly for the lack of certain
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 subroutines not loaded successfully because they come later in the file.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492 If the autoloaded file fails to define the desired Lisp function or
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 macro, then an error is signaled with data @code{"Autoloading failed to
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 define function @var{function-name}"}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496 @findex update-file-autoloads
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 @findex update-directory-autoloads
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498 @cindex magic autoload comment
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 @cindex autoload cookie
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 @anchor{autoload cookie}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501 A magic autoload comment (often called an @dfn{autoload cookie})
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 consists of @samp{;;;###autoload}, on a line by itself,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 just before the real definition of the function in its
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504 autoloadable source file. The command @kbd{M-x update-file-autoloads}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 writes a corresponding @code{autoload} call into @file{loaddefs.el}.
100707
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
506 (The string that serves as the autoload cookie and the name of the
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
507 file generated by @code{update-file-autoloads} can be changed from the
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
508 above defaults, see below.)
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 Building Emacs loads @file{loaddefs.el} and thus calls @code{autoload}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 @kbd{M-x update-directory-autoloads} is even more powerful; it updates
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 autoloads for all files in the current directory.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 The same magic comment can copy any kind of form into
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514 @file{loaddefs.el}. If the form following the magic comment is not a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 function-defining form or a @code{defcustom} form, it is copied
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516 verbatim. ``Function-defining forms'' include @code{define-skeleton},
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 @code{define-derived-mode}, @code{define-generic-mode} and
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 @code{define-minor-mode} as well as @code{defun} and
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 @code{defmacro}. To save space, a @code{defcustom} form is converted to
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 a @code{defvar} in @file{loaddefs.el}, with some additional information
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 if it uses @code{:require}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 You can also use a magic comment to execute a form at build time
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 @emph{without} executing it when the file itself is loaded. To do this,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 write the form @emph{on the same line} as the magic comment. Since it
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 is in a comment, it does nothing when you load the source file; but
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527 @kbd{M-x update-file-autoloads} copies it to @file{loaddefs.el}, where
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 it is executed while building Emacs.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 The following example shows how @code{doctor} is prepared for
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 autoloading with a magic comment:
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 @smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 ;;;###autoload
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535 (defun doctor ()
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 "Switch to *doctor* buffer and start giving psychotherapy."
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537 (interactive)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538 (switch-to-buffer "*doctor*")
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 (doctor-mode))
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 @end smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542 @noindent
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 Here's what that produces in @file{loaddefs.el}:
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545 @smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546 (autoload (quote doctor) "doctor" "\
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 Switch to *doctor* buffer and start giving psychotherapy.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 \(fn)" t nil)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 @end smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 @noindent
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 @cindex @code{fn} in function's documentation string
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 The backslash and newline immediately following the double-quote are a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555 convention used only in the preloaded uncompiled Lisp files such as
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 @file{loaddefs.el}; they tell @code{make-docfile} to put the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 documentation string in the @file{etc/DOC} file. @xref{Building Emacs}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 See also the commentary in @file{lib-src/make-docfile.c}. @samp{(fn)}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 in the usage part of the documentation string is replaced with the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 function's name when the various help functions (@pxref{Help
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 Functions}) display it.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 If you write a function definition with an unusual macro that is not
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 one of the known and recognized function definition methods, use of an
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 ordinary magic autoload comment would copy the whole definition into
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566 @code{loaddefs.el}. That is not desirable. You can put the desired
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 @code{autoload} call into @code{loaddefs.el} instead by writing this:
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 @smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570 ;;;###autoload (autoload 'foo "myfile")
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 (mydefunmacro foo
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 ...)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 @end smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574
100707
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
575 You can use a non-default string as the autoload cookie and have the
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
576 corresponding autoload calls written into a file whose name is
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
577 different from the default @file{loaddefs.el}. Emacs provides two
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
578 variables to control this:
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
579
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
580 @defvar generate-autoload-cookie
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
581 The value of this variable should be a string whose syntax is a Lisp
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
582 comment. @kbd{M-x update-file-autoloads} copies the Lisp form that
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
583 follows the cookie into the autoload file it generates. The default
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
584 value of this variable is @code{";;;###autoload"}.
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
585 @end defvar
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
586
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
587 @defvar generated-autoload-file
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
588 The value of this variable names an Emacs Lisp file where the autoload
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
589 calls should go. The default value is @file{loaddefs.el}, but you can
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
590 override that, e.g., in the ``Local Variables'' section of a
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
591 @file{.el} file (@pxref{File Local Variables}). The autoload file is
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
592 assumed to contain a trailer starting with a formfeed character.
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
593 @end defvar
bc94c30be857 (Autoload): Document `generate-autoload-cookie' and `generated-autoload-file'.
Eli Zaretskii <eliz@gnu.org>
parents: 98106
diff changeset
594
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595 @node Repeated Loading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 @section Repeated Loading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 @cindex repeated loading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599 You can load a given file more than once in an Emacs session. For
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 example, after you have rewritten and reinstalled a function definition
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 by editing it in a buffer, you may wish to return to the original
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602 version; you can do this by reloading the file it came from.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604 When you load or reload files, bear in mind that the @code{load} and
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 @code{load-library} functions automatically load a byte-compiled file
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606 rather than a non-compiled file of similar name. If you rewrite a file
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607 that you intend to save and reinstall, you need to byte-compile the new
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 version; otherwise Emacs will load the older, byte-compiled file instead
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 of your newer, non-compiled file! If that happens, the message
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 displayed when loading the file includes, @samp{(compiled; note, source is
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 newer)}, to remind you to recompile it.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 When writing the forms in a Lisp library file, keep in mind that the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 file might be loaded more than once. For example, think about whether
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 each variable should be reinitialized when you reload the library;
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 @code{defvar} does not change the value if the variable is already
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 initialized. (@xref{Defining Variables}.)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 The simplest way to add an element to an alist is like this:
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621 @example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 (push '(leif-mode " Leif") minor-mode-alist)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623 @end example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 @noindent
102496
67578c6bcd78 (Repeated Loading): Simplify examples.
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
626 But this would add multiple elements if the library is reloaded. To
67578c6bcd78 (Repeated Loading): Simplify examples.
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
627 avoid the problem, use @code{add-to-list} (@pxref{List Variables}):
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629 @example
103951
fcd80b58a694 (Repeated Loading): Fix typo.
Glenn Morris <rgm@gnu.org>
parents: 103864
diff changeset
630 (add-to-list 'minor-mode-alist '(leif-mode " Leif"))
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 @end example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 Occasionally you will want to test explicitly whether a library has
102496
67578c6bcd78 (Repeated Loading): Simplify examples.
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
634 already been loaded. If the library uses @code{provide} to provide a
67578c6bcd78 (Repeated Loading): Simplify examples.
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
635 named feature, you can use @code{featurep} earlier in the file to test
67578c6bcd78 (Repeated Loading): Simplify examples.
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
636 whether the @code{provide} call has been executed before (@pxref{Named
67578c6bcd78 (Repeated Loading): Simplify examples.
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
637 Features}). Alternatively, you could use something like this:
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 @example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 (defvar foo-was-loaded nil)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 (unless foo-was-loaded
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 @var{execute-first-time-only}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 (setq foo-was-loaded t))
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645 @end example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 @noindent
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 @node Named Features
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650 @section Features
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 @cindex features
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 @cindex requiring features
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 @cindex providing features
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655 @code{provide} and @code{require} are an alternative to
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 @code{autoload} for loading files automatically. They work in terms of
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657 named @dfn{features}. Autoloading is triggered by calling a specific
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 function, but a feature is loaded the first time another program asks
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659 for it by name.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661 A feature name is a symbol that stands for a collection of functions,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662 variables, etc. The file that defines them should @dfn{provide} the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 feature. Another program that uses them may ensure they are defined by
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 @dfn{requiring} the feature. This loads the file of definitions if it
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 hasn't been loaded already.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666
102496
67578c6bcd78 (Repeated Loading): Simplify examples.
Chong Yidong <cyd@stupidchicken.com>
parents: 100974
diff changeset
667 @cindex load error with require
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 To require the presence of a feature, call @code{require} with the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 feature name as argument. @code{require} looks in the global variable
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 @code{features} to see whether the desired feature has been provided
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671 already. If not, it loads the feature from the appropriate file. This
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 file should call @code{provide} at the top level to add the feature to
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673 @code{features}; if it fails to do so, @code{require} signals an error.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 For example, in @file{emacs/lisp/prolog.el},
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 the definition for @code{run-prolog} includes the following code:
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678 @smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 (defun run-prolog ()
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 "Run an inferior Prolog process, with I/O via buffer *prolog*."
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681 (interactive)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 (require 'comint)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 (switch-to-buffer (make-comint "prolog" prolog-program-name))
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684 (inferior-prolog-mode))
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 @end smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687 @noindent
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 The expression @code{(require 'comint)} loads the file @file{comint.el}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 if it has not yet been loaded. This ensures that @code{make-comint} is
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 defined. Features are normally named after the files that provide them,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 so that @code{require} need not be given the file name.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 The @file{comint.el} file contains the following top-level expression:
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 @smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 (provide 'comint)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 @end smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 @noindent
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700 This adds @code{comint} to the global @code{features} list, so that
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 @code{(require 'comint)} will henceforth know that nothing needs to be
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702 done.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 @cindex byte-compiling @code{require}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 When @code{require} is used at top level in a file, it takes effect
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706 when you byte-compile that file (@pxref{Byte Compilation}) as well as
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 when you load it. This is in case the required package contains macros
86436
72447710b4f2 (Named Features): Minor cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 85688
diff changeset
708 that the byte compiler must know about. It also avoids byte compiler
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 warnings for functions and variables defined in the file loaded with
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710 @code{require}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 Although top-level calls to @code{require} are evaluated during
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713 byte compilation, @code{provide} calls are not. Therefore, you can
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714 ensure that a file of definitions is loaded before it is byte-compiled
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715 by including a @code{provide} followed by a @code{require} for the same
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 feature, as in the following example.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 @smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 @group
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720 (provide 'my-feature) ; @r{Ignored by byte compiler,}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 ; @r{evaluated by @code{load}.}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 (require 'my-feature) ; @r{Evaluated by byte compiler.}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 @end group
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724 @end smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 @noindent
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 The compiler ignores the @code{provide}, then processes the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728 @code{require} by loading the file in question. Loading the file does
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729 execute the @code{provide} call, so the subsequent @code{require} call
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730 does nothing when the file is loaded.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 @defun provide feature &optional subfeatures
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733 This function announces that @var{feature} is now loaded, or being
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 loaded, into the current Emacs session. This means that the facilities
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735 associated with @var{feature} are or will be available for other Lisp
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 programs.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737
103864
cc83b339ea18 Kevin Ryde <user42 at zip.com.au>
Glenn Morris <rgm@gnu.org>
parents: 102496
diff changeset
738 The direct effect of calling @code{provide} is if not already in
cc83b339ea18 Kevin Ryde <user42 at zip.com.au>
Glenn Morris <rgm@gnu.org>
parents: 102496
diff changeset
739 @var{features} then to add @var{feature} to the front of that list and
cc83b339ea18 Kevin Ryde <user42 at zip.com.au>
Glenn Morris <rgm@gnu.org>
parents: 102496
diff changeset
740 call any @code{eval-after-load} code waiting for it (@pxref{Hooks for
cc83b339ea18 Kevin Ryde <user42 at zip.com.au>
Glenn Morris <rgm@gnu.org>
parents: 102496
diff changeset
741 Loading}). The argument @var{feature} must be a symbol.
cc83b339ea18 Kevin Ryde <user42 at zip.com.au>
Glenn Morris <rgm@gnu.org>
parents: 102496
diff changeset
742 @code{provide} returns @var{feature}.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 If provided, @var{subfeatures} should be a list of symbols indicating
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 a set of specific subfeatures provided by this version of
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 @var{feature}. You can test the presence of a subfeature using
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 @code{featurep}. The idea of subfeatures is that you use them when a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 package (which is one @var{feature}) is complex enough to make it
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749 useful to give names to various parts or functionalities of the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 package, which might or might not be loaded, or might or might not be
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 present in a given version. @xref{Network Feature Testing}, for
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 an example.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 @smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 features
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 @result{} (bar bish)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 (provide 'foo)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 @result{} foo
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760 features
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 @result{} (foo bar bish)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762 @end smallexample
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 When a file is loaded to satisfy an autoload, and it stops due to an
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 error in the evaluation of its contents, any function definitions or
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 @code{provide} calls that occurred during the load are undone.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767 @xref{Autoload}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768 @end defun
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770 @defun require feature &optional filename noerror
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 This function checks whether @var{feature} is present in the current
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 Emacs session (using @code{(featurep @var{feature})}; see below). The
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773 argument @var{feature} must be a symbol.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775 If the feature is not present, then @code{require} loads @var{filename}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 with @code{load}. If @var{filename} is not supplied, then the name of
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777 the symbol @var{feature} is used as the base file name to load.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778 However, in this case, @code{require} insists on finding @var{feature}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 with an added @samp{.el} or @samp{.elc} suffix (possibly extended with
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 a compression suffix); a file whose name is just @var{feature} won't
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 be used. (The variable @code{load-suffixes} specifies the exact
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 required Lisp suffixes.)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 If @var{noerror} is non-@code{nil}, that suppresses errors from actual
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785 loading of the file. In that case, @code{require} returns @code{nil}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 if loading the file fails. Normally, @code{require} returns
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 @var{feature}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 If loading the file succeeds but does not provide @var{feature},
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790 @code{require} signals an error, @samp{Required feature @var{feature}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 was not provided}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 @end defun
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794 @defun featurep feature &optional subfeature
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 This function returns @code{t} if @var{feature} has been provided in
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796 the current Emacs session (i.e.@:, if @var{feature} is a member of
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797 @code{features}.) If @var{subfeature} is non-@code{nil}, then the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 function returns @code{t} only if that subfeature is provided as well
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 (i.e.@: if @var{subfeature} is a member of the @code{subfeature}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 property of the @var{feature} symbol.)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 @end defun
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803 @defvar features
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 The value of this variable is a list of symbols that are the features
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 loaded in the current Emacs session. Each symbol was put in this list
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 with a call to @code{provide}. The order of the elements in the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 @code{features} list is not significant.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 @end defvar
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 @node Where Defined
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 @section Which File Defined a Certain Symbol
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 @defun symbol-file symbol &optional type
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 This function returns the name of the file that defined @var{symbol}.
98028
59193c0c60a3 (Where Defined): Fix description of symbol-file.
Martin Rudalics <rudalics@gmx.at>
parents: 87649
diff changeset
815 If @var{type} is @code{nil}, then any kind of definition is acceptable.
59193c0c60a3 (Where Defined): Fix description of symbol-file.
Martin Rudalics <rudalics@gmx.at>
parents: 87649
diff changeset
816 If @var{type} is @code{defun}, @code{defvar}, or @code{defface}, that
59193c0c60a3 (Where Defined): Fix description of symbol-file.
Martin Rudalics <rudalics@gmx.at>
parents: 87649
diff changeset
817 specifies function definition, variable definition, or face definition
59193c0c60a3 (Where Defined): Fix description of symbol-file.
Martin Rudalics <rudalics@gmx.at>
parents: 87649
diff changeset
818 only.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819
98028
59193c0c60a3 (Where Defined): Fix description of symbol-file.
Martin Rudalics <rudalics@gmx.at>
parents: 87649
diff changeset
820 The value is normally an absolute file name. It can also be @code{nil},
59193c0c60a3 (Where Defined): Fix description of symbol-file.
Martin Rudalics <rudalics@gmx.at>
parents: 87649
diff changeset
821 if the definition is not associated with any file. If @var{symbol}
59193c0c60a3 (Where Defined): Fix description of symbol-file.
Martin Rudalics <rudalics@gmx.at>
parents: 87649
diff changeset
822 specifies an autoloaded function, the value can be a relative file name
59193c0c60a3 (Where Defined): Fix description of symbol-file.
Martin Rudalics <rudalics@gmx.at>
parents: 87649
diff changeset
823 without extension.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 @end defun
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 The basis for @code{symbol-file} is the data in the variable
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 @code{load-history}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 @defvar load-history
108366
e2da1d33db95 Fix typos (Bug#6094). From ªÞt«µp«¡n N«µmec.
Chong Yidong <cyd@stupidchicken.com>
parents: 107683
diff changeset
830 The value of this variable is an alist that associates the names of
106689
de63af995d1c * src/lread.c (syms_of_lread): Make it clearer that these are the
Chong Yidong <cyd@stupidchicken.com>
parents: 104626
diff changeset
831 loaded library files with the names of the functions and variables
de63af995d1c * src/lread.c (syms_of_lread): Make it clearer that these are the
Chong Yidong <cyd@stupidchicken.com>
parents: 104626
diff changeset
832 they defined, as well as the features they provided or required.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833
106689
de63af995d1c * src/lread.c (syms_of_lread): Make it clearer that these are the
Chong Yidong <cyd@stupidchicken.com>
parents: 104626
diff changeset
834 Each element in this alist describes one loaded library (including
de63af995d1c * src/lread.c (syms_of_lread): Make it clearer that these are the
Chong Yidong <cyd@stupidchicken.com>
parents: 104626
diff changeset
835 libraries that are preloaded at startup). It is a list whose @sc{car}
de63af995d1c * src/lread.c (syms_of_lread): Make it clearer that these are the
Chong Yidong <cyd@stupidchicken.com>
parents: 104626
diff changeset
836 is the absolute file name of the library (a string). The rest of the
de63af995d1c * src/lread.c (syms_of_lread): Make it clearer that these are the
Chong Yidong <cyd@stupidchicken.com>
parents: 104626
diff changeset
837 list elements have these forms:
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839 @table @code
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840 @item @var{var}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841 The symbol @var{var} was defined as a variable.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842 @item (defun . @var{fun})
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843 The function @var{fun} was defined.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844 @item (t . @var{fun})
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845 The function @var{fun} was previously an autoload before this library
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846 redefined it as a function. The following element is always
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847 @code{(defun . @var{fun})}, which represents defining @var{fun} as a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848 function.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 @item (autoload . @var{fun})
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 The function @var{fun} was defined as an autoload.
98106
43ea5fd8c7ad * loading.texi (Where Defined): Add `defface' item.
Juanma Barranquero <lekktu@gmail.com>
parents: 98028
diff changeset
851 @item (defface . @var{face})
43ea5fd8c7ad * loading.texi (Where Defined): Add `defface' item.
Juanma Barranquero <lekktu@gmail.com>
parents: 98028
diff changeset
852 The face @var{face} was defined.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 @item (require . @var{feature})
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 The feature @var{feature} was required.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 @item (provide . @var{feature})
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 The feature @var{feature} was provided.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857 @end table
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 The value of @code{load-history} may have one element whose @sc{car} is
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 @code{nil}. This element describes definitions made with
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861 @code{eval-buffer} on a buffer that is not visiting a file.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 @end defvar
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 The command @code{eval-region} updates @code{load-history}, but does so
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 by adding the symbols defined to the element for the file being visited,
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866 rather than replacing that element. @xref{Eval}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 @node Unloading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 @section Unloading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 @cindex unloading packages
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872 @c Emacs 19 feature
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873 You can discard the functions and variables loaded by a library to
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874 reclaim memory for other Lisp objects. To do this, use the function
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875 @code{unload-feature}:
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877 @deffn Command unload-feature feature &optional force
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 This command unloads the library that provided feature @var{feature}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879 It undefines all functions, macros, and variables defined in that
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 library with @code{defun}, @code{defalias}, @code{defsubst},
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881 @code{defmacro}, @code{defconst}, @code{defvar}, and @code{defcustom}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 It then restores any autoloads formerly associated with those symbols.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 (Loading saves these in the @code{autoload} property of the symbol.)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 Before restoring the previous definitions, @code{unload-feature} runs
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886 @code{remove-hook} to remove functions in the library from certain
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887 hooks. These hooks include variables whose names end in @samp{hook}
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 or @samp{-hooks}, plus those listed in
85688
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
889 @code{unload-feature-special-hooks}, as well as
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
890 @code{auto-mode-alist}. This is to prevent Emacs from ceasing to
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
891 function because important hooks refer to functions that are no longer
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
892 defined.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893
85688
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
894 Standard unloading activities also undoes ELP profiling of functions
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
895 in that library, unprovides any features provided by the library, and
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
896 cancels timers held in variables defined by the library.
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
897
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
898 @vindex @var{feature}-unload-function
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899 If these measures are not sufficient to prevent malfunction, a library
85688
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
900 can define an explicit unloader named @code{@var{feature}-unload-function}.
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
901 If that symbol is defined as a function, @code{unload-feature} calls
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
902 it with no arguments before doing anything else. It can do whatever
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
903 is appropriate to unload the library. If it returns @code{nil},
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
904 @code{unload-feature} proceeds to take the normal unload actions.
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
905 Otherwise it considers the job to be done.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907 Ordinarily, @code{unload-feature} refuses to unload a library on which
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 other loaded libraries depend. (A library @var{a} depends on library
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909 @var{b} if @var{a} contains a @code{require} for @var{b}.) If the
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910 optional argument @var{force} is non-@code{nil}, dependencies are
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911 ignored and you can unload any library.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 @end deffn
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 The @code{unload-feature} function is written in Lisp; its actions are
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915 based on the variable @code{load-history}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 @defvar unload-feature-special-hooks
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918 This variable holds a list of hooks to be scanned before unloading a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919 library, to remove functions defined in the library.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 @end defvar
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922 @node Hooks for Loading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 @section Hooks for Loading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924 @cindex loading hooks
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 @cindex hooks for loading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926
107683
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
927 You can ask for code to be executed each time Emacs loads a library,
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
928 by using the variable @code{after-load-functions}:
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
929
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
930 @defvar after-load-functions
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
931 This abnormal hook is run after loading a file. Each function in the
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
932 hook is called with a single argument, the absolute filename of the
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
933 file that was just loaded.
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
934 @end defvar
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
935
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
936 If you want code to be executed when a @emph{particular} library is
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
937 loaded, use the function @code{eval-after-load}:
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939 @defun eval-after-load library form
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 This function arranges to evaluate @var{form} at the end of loading
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 the file @var{library}, each time @var{library} is loaded. If
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 @var{library} is already loaded, it evaluates @var{form} right away.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943 Don't forget to quote @var{form}!
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 You don't need to give a directory or extension in the file name
107683
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
946 @var{library}. Normally, you just give a bare file name, like this:
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 @example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 (eval-after-load "edebug" '(def-edebug-spec c-point t))
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 @end example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 To restrict which files can trigger the evaluation, include a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 directory or an extension or both in @var{library}. Only a file whose
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 absolute true name (i.e., the name with all symbolic links chased out)
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 matches all the given name components will match. In the following
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 example, @file{my_inst.elc} or @file{my_inst.elc.gz} in some directory
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 @code{..../foo/bar} will trigger the evaluation, but not
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958 @file{my_inst.el}:
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960 @example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 (eval-after-load "foo/bar/my_inst.elc" @dots{})
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 @end example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 @var{library} can also be a feature (i.e.@: a symbol), in which case
112188
28f569136b3e * lisp/subr.el (eval-after-load): Fix timing for features.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 111626
diff changeset
965 @var{form} is evaluated at the end of any file where
28f569136b3e * lisp/subr.el (eval-after-load): Fix timing for features.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 111626
diff changeset
966 @code{(provide @var{library})} is called.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968 An error in @var{form} does not undo the load, but does prevent
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 execution of the rest of @var{form}.
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 @end defun
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971
107683
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
972 Normally, well-designed Lisp programs should not use
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
973 @code{eval-after-load}. If you need to examine and set the variables
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
974 defined in another library (those meant for outside use), you can do
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
975 it immediately---there is no need to wait until the library is loaded.
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
976 If you need to call functions defined by that library, you should load
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
977 the library, preferably with @code{require} (@pxref{Named Features}).
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 But it is OK to use @code{eval-after-load} in your personal
107683
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
980 customizations if you don't feel that they must meet the design
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
981 standards for programs meant for wider use.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 @defvar after-load-alist
107683
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
984 This variable stores an alist built by @code{eval-after-load},
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
985 containing the expressions to evaluate when certain libraries are
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
986 loaded. Each element looks like this:
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988 @example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989 (@var{regexp-or-feature} @var{forms}@dots{})
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 @end example
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 The key @var{regexp-or-feature} is either a regular expression or a
107683
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
993 symbol, and the value is a list of forms. The forms are evaluated
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
994 when the key matches the absolute true name or feature name of the
a7a7dd1d90a3 Document `after-load-functions'.
Chong Yidong <cyd@stupidchicken.com>
parents: 106815
diff changeset
995 library being loaded.
84081
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996 @end defvar
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998 @ignore
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999 arch-tag: df731f89-0900-4389-a436-9105241b6f7a
5900ca94f0ce Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000 @end ignore