annotate lispref/functions.texi @ 50175:1f1ed66e618f

($(BLD)/xdisp.$(O)): Depend also on atimer.h and systime.h.
author Juanma Barranquero <lekktu@gmail.com>
date Mon, 17 Mar 2003 18:54:19 +0000
parents 23a1cea22d13
children 080a8041fef7 d7ddb3e565de
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
27189
d2e5f1b7d8e2 Update copyrights.
Gerd Moellmann <gerd@gnu.org>
parents: 27187
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47667
diff changeset
4 @c Free Software Foundation, Inc.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
6 @setfilename ../info/functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
7 @node Functions, Macros, Variables, Top
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
8 @chapter Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
9
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
10 A Lisp program is composed mainly of Lisp functions. This chapter
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
11 explains what functions are, how they accept arguments, and how to
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
12 define them.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
13
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
14 @menu
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
15 * What Is a Function:: Lisp functions vs. primitives; terminology.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
16 * Lambda Expressions:: How functions are expressed as Lisp objects.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
17 * Function Names:: A symbol can serve as the name of a function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
18 * Defining Functions:: Lisp expressions for defining functions.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
19 * Calling Functions:: How to use an existing function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
20 * Mapping Functions:: Applying a function to each element of a list, etc.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47667
diff changeset
21 * Anonymous Functions:: Lambda expressions are functions with no names.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
22 * Function Cells:: Accessing or setting the function definition
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
23 of a symbol.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
24 * Inline Functions:: Defining functions that the compiler will open code.
47667
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
25 * Function safety:: Determining whether a function is safe to call.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
26 * Related Topics:: Cross-references to specific Lisp primitives
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
27 that have a special bearing on how functions work.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
28 @end menu
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
29
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
30 @node What Is a Function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
31 @section What Is a Function?
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
32
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
33 In a general sense, a function is a rule for carrying on a computation
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
34 given several values called @dfn{arguments}. The result of the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
35 computation is called the value of the function. The computation can
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
36 also have side effects: lasting changes in the values of variables or
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
37 the contents of data structures.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
38
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
39 Here are important terms for functions in Emacs Lisp and for other
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
40 function-like objects.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
41
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
42 @table @dfn
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
43 @item function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
44 @cindex function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
45 In Emacs Lisp, a @dfn{function} is anything that can be applied to
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
46 arguments in a Lisp program. In some cases, we use it more
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
47 specifically to mean a function written in Lisp. Special forms and
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
48 macros are not functions.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
49
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
50 @item primitive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
51 @cindex primitive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
52 @cindex subr
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
53 @cindex built-in function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
54 A @dfn{primitive} is a function callable from Lisp that is written in C,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
55 such as @code{car} or @code{append}. These functions are also called
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
56 @dfn{built-in} functions or @dfn{subrs}. (Special forms are also
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
57 considered primitives.)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
58
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
59 Usually the reason we implement a function as a primitive is either
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
60 because it is fundamental, because it provides a low-level interface to
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
61 operating system services, or because it needs to run fast. Primitives
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
62 can be modified or added only by changing the C sources and recompiling
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
63 the editor. See @ref{Writing Emacs Primitives}.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
64
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
65 @item lambda expression
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
66 A @dfn{lambda expression} is a function written in Lisp.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
67 These are described in the following section.
27193
89afca54a135 @ifinto -> @ifnottex.
Gerd Moellmann <gerd@gnu.org>
parents: 27189
diff changeset
68 @ifnottex
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
69 @xref{Lambda Expressions}.
27193
89afca54a135 @ifinto -> @ifnottex.
Gerd Moellmann <gerd@gnu.org>
parents: 27189
diff changeset
70 @end ifnottex
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
71
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
72 @item special form
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
73 A @dfn{special form} is a primitive that is like a function but does not
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
74 evaluate all of its arguments in the usual way. It may evaluate only
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
75 some of the arguments, or may evaluate them in an unusual order, or
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
76 several times. Many special forms are described in @ref{Control
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
77 Structures}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
78
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
79 @item macro
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
80 @cindex macro
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
81 A @dfn{macro} is a construct defined in Lisp by the programmer. It
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
82 differs from a function in that it translates a Lisp expression that you
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
83 write into an equivalent expression to be evaluated instead of the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
84 original expression. Macros enable Lisp programmers to do the sorts of
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
85 things that special forms can do. @xref{Macros}, for how to define and
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
86 use macros.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
87
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
88 @item command
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
89 @cindex command
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
90 A @dfn{command} is an object that @code{command-execute} can invoke; it
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
91 is a possible definition for a key sequence. Some functions are
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
92 commands; a function written in Lisp is a command if it contains an
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
93 interactive declaration (@pxref{Defining Commands}). Such a function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
94 can be called from Lisp expressions like other functions; in this case,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
95 the fact that the function is a command makes no difference.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
96
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
97 Keyboard macros (strings and vectors) are commands also, even though
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
98 they are not functions. A symbol is a command if its function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
99 definition is a command; such symbols can be invoked with @kbd{M-x}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
100 The symbol is a function as well if the definition is a function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
101 @xref{Command Overview}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
102
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
103 @item keystroke command
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
104 @cindex keystroke command
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
105 A @dfn{keystroke command} is a command that is bound to a key sequence
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
106 (typically one to three keystrokes). The distinction is made here
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
107 merely to avoid confusion with the meaning of ``command'' in non-Emacs
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
108 editors; for Lisp programs, the distinction is normally unimportant.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
109
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
110 @item byte-code function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
111 A @dfn{byte-code function} is a function that has been compiled by the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
112 byte compiler. @xref{Byte-Code Type}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
113 @end table
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
114
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
115 @defun functionp object
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
116 This function returns @code{t} if @var{object} is any kind of function,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
117 or a special form or macro.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
118 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
119
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
120 @defun subrp object
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
121 This function returns @code{t} if @var{object} is a built-in function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
122 (i.e., a Lisp primitive).
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
123
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
124 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
125 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
126 (subrp 'message) ; @r{@code{message} is a symbol,}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
127 @result{} nil ; @r{not a subr object.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
128 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
129 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
130 (subrp (symbol-function 'message))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
131 @result{} t
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
132 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
133 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
134 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
135
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
136 @defun byte-code-function-p object
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
137 This function returns @code{t} if @var{object} is a byte-code
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
138 function. For example:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
139
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
140 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
141 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
142 (byte-code-function-p (symbol-function 'next-line))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
143 @result{} t
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
144 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
145 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
146 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
147
33999
fa2cc4f8942e subr-arity
Dave Love <fx@gnu.org>
parents: 28556
diff changeset
148 @defun subr-arity subr
fa2cc4f8942e subr-arity
Dave Love <fx@gnu.org>
parents: 28556
diff changeset
149 @tindex subr-arity
fa2cc4f8942e subr-arity
Dave Love <fx@gnu.org>
parents: 28556
diff changeset
150 This function provides information about the argument list of a
fa2cc4f8942e subr-arity
Dave Love <fx@gnu.org>
parents: 28556
diff changeset
151 primitive, @var{subr}. The returned value is a pair
fa2cc4f8942e subr-arity
Dave Love <fx@gnu.org>
parents: 28556
diff changeset
152 @code{(@var{min} . @var{max})}. @var{min} is the minimum number of
fa2cc4f8942e subr-arity
Dave Love <fx@gnu.org>
parents: 28556
diff changeset
153 args. @var{max} is the maximum number or the symbol @code{many}, for a
fa2cc4f8942e subr-arity
Dave Love <fx@gnu.org>
parents: 28556
diff changeset
154 function with @code{&rest} arguments, or the symbol @code{unevalled} if
fa2cc4f8942e subr-arity
Dave Love <fx@gnu.org>
parents: 28556
diff changeset
155 @var{subr} is a special form.
fa2cc4f8942e subr-arity
Dave Love <fx@gnu.org>
parents: 28556
diff changeset
156 @end defun
fa2cc4f8942e subr-arity
Dave Love <fx@gnu.org>
parents: 28556
diff changeset
157
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
158 @node Lambda Expressions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
159 @section Lambda Expressions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
160 @cindex lambda expression
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
161
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
162 A function written in Lisp is a list that looks like this:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
163
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
164 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
165 (lambda (@var{arg-variables}@dots{})
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
166 @r{[}@var{documentation-string}@r{]}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
167 @r{[}@var{interactive-declaration}@r{]}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
168 @var{body-forms}@dots{})
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
169 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
170
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
171 @noindent
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
172 Such a list is called a @dfn{lambda expression}. In Emacs Lisp, it
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
173 actually is valid as an expression---it evaluates to itself. In some
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
174 other Lisp dialects, a lambda expression is not a valid expression at
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
175 all. In either case, its main use is not to be evaluated as an
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
176 expression, but to be called as a function.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
177
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
178 @menu
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
179 * Lambda Components:: The parts of a lambda expression.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
180 * Simple Lambda:: A simple example.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
181 * Argument List:: Details and special features of argument lists.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
182 * Function Documentation:: How to put documentation in a function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
183 @end menu
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
184
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
185 @node Lambda Components
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
186 @subsection Components of a Lambda Expression
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
187
27193
89afca54a135 @ifinto -> @ifnottex.
Gerd Moellmann <gerd@gnu.org>
parents: 27189
diff changeset
188 @ifnottex
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
189
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
190 A function written in Lisp (a ``lambda expression'') is a list that
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
191 looks like this:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
192
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
193 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
194 (lambda (@var{arg-variables}@dots{})
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
195 [@var{documentation-string}]
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
196 [@var{interactive-declaration}]
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
197 @var{body-forms}@dots{})
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
198 @end example
27193
89afca54a135 @ifinto -> @ifnottex.
Gerd Moellmann <gerd@gnu.org>
parents: 27189
diff changeset
199 @end ifnottex
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
200
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
201 @cindex lambda list
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
202 The first element of a lambda expression is always the symbol
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
203 @code{lambda}. This indicates that the list represents a function. The
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
204 reason functions are defined to start with @code{lambda} is so that
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
205 other lists, intended for other uses, will not accidentally be valid as
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
206 functions.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
207
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
208 The second element is a list of symbols---the argument variable names.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
209 This is called the @dfn{lambda list}. When a Lisp function is called,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
210 the argument values are matched up against the variables in the lambda
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
211 list, which are given local bindings with the values provided.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
212 @xref{Local Variables}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
213
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
214 The documentation string is a Lisp string object placed within the
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
215 function definition to describe the function for the Emacs help
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
216 facilities. @xref{Function Documentation}.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
217
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
218 The interactive declaration is a list of the form @code{(interactive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
219 @var{code-string})}. This declares how to provide arguments if the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
220 function is used interactively. Functions with this declaration are called
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
221 @dfn{commands}; they can be called using @kbd{M-x} or bound to a key.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
222 Functions not intended to be called in this way should not have interactive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
223 declarations. @xref{Defining Commands}, for how to write an interactive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
224 declaration.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
225
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
226 @cindex body of function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
227 The rest of the elements are the @dfn{body} of the function: the Lisp
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
228 code to do the work of the function (or, as a Lisp programmer would say,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
229 ``a list of Lisp forms to evaluate''). The value returned by the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
230 function is the value returned by the last element of the body.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
231
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
232 @node Simple Lambda
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
233 @subsection A Simple Lambda-Expression Example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
234
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
235 Consider for example the following function:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
236
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
237 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
238 (lambda (a b c) (+ a b c))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
239 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
240
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
241 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
242 We can call this function by writing it as the @sc{car} of an
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
243 expression, like this:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
244
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
245 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
246 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
247 ((lambda (a b c) (+ a b c))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
248 1 2 3)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
249 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
250 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
251
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
252 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
253 This call evaluates the body of the lambda expression with the variable
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
254 @code{a} bound to 1, @code{b} bound to 2, and @code{c} bound to 3.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
255 Evaluation of the body adds these three numbers, producing the result 6;
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
256 therefore, this call to the function returns the value 6.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
257
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
258 Note that the arguments can be the results of other function calls, as in
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
259 this example:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
260
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
261 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
262 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
263 ((lambda (a b c) (+ a b c))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
264 1 (* 2 3) (- 5 4))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
265 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
266 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
267
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
268 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
269 This evaluates the arguments @code{1}, @code{(* 2 3)}, and @code{(- 5
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
270 4)} from left to right. Then it applies the lambda expression to the
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
271 argument values 1, 6 and 1 to produce the value 8.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
272
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
273 It is not often useful to write a lambda expression as the @sc{car} of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
274 a form in this way. You can get the same result, of making local
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
275 variables and giving them values, using the special form @code{let}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
276 (@pxref{Local Variables}). And @code{let} is clearer and easier to use.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
277 In practice, lambda expressions are either stored as the function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
278 definitions of symbols, to produce named functions, or passed as
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
279 arguments to other functions (@pxref{Anonymous Functions}).
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
280
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
281 However, calls to explicit lambda expressions were very useful in the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
282 old days of Lisp, before the special form @code{let} was invented. At
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
283 that time, they were the only way to bind and initialize local
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
284 variables.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
285
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
286 @node Argument List
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
287 @subsection Other Features of Argument Lists
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
288 @kindex wrong-number-of-arguments
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
289 @cindex argument binding
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
290 @cindex binding arguments
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
291
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
292 Our simple sample function, @code{(lambda (a b c) (+ a b c))},
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
293 specifies three argument variables, so it must be called with three
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
294 arguments: if you try to call it with only two arguments or four
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
295 arguments, you get a @code{wrong-number-of-arguments} error.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
296
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
297 It is often convenient to write a function that allows certain
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
298 arguments to be omitted. For example, the function @code{substring}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
299 accepts three arguments---a string, the start index and the end
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
300 index---but the third argument defaults to the @var{length} of the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
301 string if you omit it. It is also convenient for certain functions to
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
302 accept an indefinite number of arguments, as the functions @code{list}
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
303 and @code{+} do.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
304
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
305 @cindex optional arguments
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
306 @cindex rest arguments
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
307 @kindex &optional
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
308 @kindex &rest
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
309 To specify optional arguments that may be omitted when a function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
310 is called, simply include the keyword @code{&optional} before the optional
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
311 arguments. To specify a list of zero or more extra arguments, include the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
312 keyword @code{&rest} before one final argument.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
313
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
314 Thus, the complete syntax for an argument list is as follows:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
315
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
316 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
317 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
318 (@var{required-vars}@dots{}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
319 @r{[}&optional @var{optional-vars}@dots{}@r{]}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
320 @r{[}&rest @var{rest-var}@r{]})
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
321 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
322 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
323
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
324 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
325 The square brackets indicate that the @code{&optional} and @code{&rest}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
326 clauses, and the variables that follow them, are optional.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
327
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
328 A call to the function requires one actual argument for each of the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
329 @var{required-vars}. There may be actual arguments for zero or more of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
330 the @var{optional-vars}, and there cannot be any actual arguments beyond
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
331 that unless the lambda list uses @code{&rest}. In that case, there may
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
332 be any number of extra actual arguments.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
333
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
334 If actual arguments for the optional and rest variables are omitted,
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
335 then they always default to @code{nil}. There is no way for the
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
336 function to distinguish between an explicit argument of @code{nil} and
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
337 an omitted argument. However, the body of the function is free to
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
338 consider @code{nil} an abbreviation for some other meaningful value.
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
339 This is what @code{substring} does; @code{nil} as the third argument to
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
340 @code{substring} means to use the length of the string supplied.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
341
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
342 @cindex CL note---default optional arg
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
343 @quotation
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
344 @b{Common Lisp note:} Common Lisp allows the function to specify what
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
345 default value to use when an optional argument is omitted; Emacs Lisp
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
346 always uses @code{nil}. Emacs Lisp does not support ``supplied-p''
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
347 variables that tell you whether an argument was explicitly passed.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
348 @end quotation
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
349
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
350 For example, an argument list that looks like this:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
351
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
352 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
353 (a b &optional c d &rest e)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
354 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
355
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
356 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
357 binds @code{a} and @code{b} to the first two actual arguments, which are
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
358 required. If one or two more arguments are provided, @code{c} and
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
359 @code{d} are bound to them respectively; any arguments after the first
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
360 four are collected into a list and @code{e} is bound to that list. If
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
361 there are only two arguments, @code{c} is @code{nil}; if two or three
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
362 arguments, @code{d} is @code{nil}; if four arguments or fewer, @code{e}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
363 is @code{nil}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
364
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
365 There is no way to have required arguments following optional
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
366 ones---it would not make sense. To see why this must be so, suppose
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
367 that @code{c} in the example were optional and @code{d} were required.
39168
0317f0f05c37 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 34179
diff changeset
368 Suppose three actual arguments are given; which variable would the
0317f0f05c37 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 34179
diff changeset
369 third argument be for? Would it be used for the @var{c}, or for
0317f0f05c37 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 34179
diff changeset
370 @var{d}? One can argue for both possibilities. Similarly, it makes
0317f0f05c37 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 34179
diff changeset
371 no sense to have any more arguments (either required or optional)
0317f0f05c37 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 34179
diff changeset
372 after a @code{&rest} argument.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
373
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
374 Here are some examples of argument lists and proper calls:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
375
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
376 @smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
377 ((lambda (n) (1+ n)) ; @r{One required:}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
378 1) ; @r{requires exactly one argument.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
379 @result{} 2
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
380 ((lambda (n &optional n1) ; @r{One required and one optional:}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
381 (if n1 (+ n n1) (1+ n))) ; @r{1 or 2 arguments.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
382 1 2)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
383 @result{} 3
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
384 ((lambda (n &rest ns) ; @r{One required and one rest:}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
385 (+ n (apply '+ ns))) ; @r{1 or more arguments.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
386 1 2 3 4 5)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
387 @result{} 15
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
388 @end smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
389
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
390 @node Function Documentation
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
391 @subsection Documentation Strings of Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
392 @cindex documentation of function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
393
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
394 A lambda expression may optionally have a @dfn{documentation string} just
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
395 after the lambda list. This string does not affect execution of the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
396 function; it is a kind of comment, but a systematized comment which
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
397 actually appears inside the Lisp world and can be used by the Emacs help
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
398 facilities. @xref{Documentation}, for how the @var{documentation-string} is
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
399 accessed.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
400
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
401 It is a good idea to provide documentation strings for all the
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
402 functions in your program, even those that are called only from within
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
403 your program. Documentation strings are like comments, except that they
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
404 are easier to access.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
405
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
406 The first line of the documentation string should stand on its own,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
407 because @code{apropos} displays just this first line. It should consist
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
408 of one or two complete sentences that summarize the function's purpose.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
409
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
410 The start of the documentation string is usually indented in the source file,
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
411 but since these spaces come before the starting double-quote, they are not part of
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
412 the string. Some people make a practice of indenting any additional
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
413 lines of the string so that the text lines up in the program source.
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
414 @emph{This is a mistake.} The indentation of the following lines is
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
415 inside the string; what looks nice in the source code will look ugly
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
416 when displayed by the help commands.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
417
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
418 You may wonder how the documentation string could be optional, since
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
419 there are required components of the function that follow it (the body).
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
420 Since evaluation of a string returns that string, without any side effects,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
421 it has no effect if it is not the last form in the body. Thus, in
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
422 practice, there is no confusion between the first form of the body and the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
423 documentation string; if the only body form is a string then it serves both
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
424 as the return value and as the documentation.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
425
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
426 @node Function Names
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
427 @section Naming a Function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
428 @cindex function definition
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
429 @cindex named function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
430 @cindex function name
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
431
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
432 In most computer languages, every function has a name; the idea of a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
433 function without a name is nonsensical. In Lisp, a function in the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
434 strictest sense has no name. It is simply a list whose first element is
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
435 @code{lambda}, a byte-code function object, or a primitive subr-object.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
436
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
437 However, a symbol can serve as the name of a function. This happens
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
438 when you put the function in the symbol's @dfn{function cell}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
439 (@pxref{Symbol Components}). Then the symbol itself becomes a valid,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
440 callable function, equivalent to the list or subr-object that its
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
441 function cell refers to. The contents of the function cell are also
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
442 called the symbol's @dfn{function definition}. The procedure of using a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
443 symbol's function definition in place of the symbol is called
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
444 @dfn{symbol function indirection}; see @ref{Function Indirection}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
445
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
446 In practice, nearly all functions are given names in this way and
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
447 referred to through their names. For example, the symbol @code{car} works
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
448 as a function and does what it does because the primitive subr-object
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
449 @code{#<subr car>} is stored in its function cell.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
450
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
451 We give functions names because it is convenient to refer to them by
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
452 their names in Lisp expressions. For primitive subr-objects such as
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
453 @code{#<subr car>}, names are the only way you can refer to them: there
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
454 is no read syntax for such objects. For functions written in Lisp, the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
455 name is more convenient to use in a call than an explicit lambda
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
456 expression. Also, a function with a name can refer to itself---it can
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
457 be recursive. Writing the function's name in its own definition is much
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
458 more convenient than making the function definition point to itself
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
459 (something that is not impossible but that has various disadvantages in
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
460 practice).
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
461
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
462 We often identify functions with the symbols used to name them. For
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
463 example, we often speak of ``the function @code{car}'', not
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
464 distinguishing between the symbol @code{car} and the primitive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
465 subr-object that is its function definition. For most purposes, there
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
466 is no need to distinguish.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
467
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
468 Even so, keep in mind that a function need not have a unique name. While
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
469 a given function object @emph{usually} appears in the function cell of only
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
470 one symbol, this is just a matter of convenience. It is easy to store
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
471 it in several symbols using @code{fset}; then each of the symbols is
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
472 equally well a name for the same function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
473
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
474 A symbol used as a function name may also be used as a variable; these
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
475 two uses of a symbol are independent and do not conflict. (Some Lisp
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
476 dialects, such as Scheme, do not distinguish between a symbol's value
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
477 and its function definition; a symbol's value as a variable is also its
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
478 function definition.) If you have not given a symbol a function
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
479 definition, you cannot use it as a function; whether the symbol has a
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
480 value as a variable makes no difference to this.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
481
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
482 @node Defining Functions
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6455
diff changeset
483 @section Defining Functions
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
484 @cindex defining a function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
485
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
486 We usually give a name to a function when it is first created. This
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
487 is called @dfn{defining a function}, and it is done with the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
488 @code{defun} special form.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
489
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
490 @defspec defun name argument-list body-forms
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
491 @code{defun} is the usual way to define new Lisp functions. It
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
492 defines the symbol @var{name} as a function that looks like this:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
493
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
494 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
495 (lambda @var{argument-list} . @var{body-forms})
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
496 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
497
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
498 @code{defun} stores this lambda expression in the function cell of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
499 @var{name}. It returns the value @var{name}, but usually we ignore this
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
500 value.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
501
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
502 As described previously (@pxref{Lambda Expressions}),
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
503 @var{argument-list} is a list of argument names and may include the
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
504 keywords @code{&optional} and @code{&rest}. Also, the first two of the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
505 @var{body-forms} may be a documentation string and an interactive
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
506 declaration.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
507
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
508 There is no conflict if the same symbol @var{name} is also used as a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
509 variable, since the symbol's value cell is independent of the function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
510 cell. @xref{Symbol Components}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
511
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
512 Here are some examples:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
513
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
514 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
515 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
516 (defun foo () 5)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
517 @result{} foo
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
518 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
519 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
520 (foo)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
521 @result{} 5
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
522 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
523
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
524 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
525 (defun bar (a &optional b &rest c)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
526 (list a b c))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
527 @result{} bar
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
528 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
529 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
530 (bar 1 2 3 4 5)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
531 @result{} (1 2 (3 4 5))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
532 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
533 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
534 (bar 1)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
535 @result{} (1 nil nil)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
536 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
537 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
538 (bar)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
539 @error{} Wrong number of arguments.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
540 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
541
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
542 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
543 (defun capitalize-backwards ()
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
544 "Upcase the last letter of a word."
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
545 (interactive)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
546 (backward-word 1)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
547 (forward-word 1)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
548 (backward-char 1)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
549 (capitalize-word 1))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
550 @result{} capitalize-backwards
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
551 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
552 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
553
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
554 Be careful not to redefine existing functions unintentionally.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
555 @code{defun} redefines even primitive functions such as @code{car}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
556 without any hesitation or notification. Redefining a function already
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
557 defined is often done deliberately, and there is no way to distinguish
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
558 deliberate redefinition from unintentional redefinition.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
559 @end defspec
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
560
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
561 @defun defalias name definition
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
562 This special form defines the symbol @var{name} as a function, with
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
563 definition @var{definition} (which can be any valid Lisp function).
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
564
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
565 The proper place to use @code{defalias} is where a specific function
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
566 name is being defined---especially where that name appears explicitly in
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
567 the source file being loaded. This is because @code{defalias} records
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
568 which file defined the function, just like @code{defun}
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
569 (@pxref{Unloading}).
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
570
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
571 By contrast, in programs that manipulate function definitions for other
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
572 purposes, it is better to use @code{fset}, which does not keep such
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
573 records.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
574 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
575
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
576 See also @code{defsubst}, which defines a function like @code{defun}
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
577 and tells the Lisp compiler to open-code it. @xref{Inline Functions}.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
578
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
579 @node Calling Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
580 @section Calling Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
581 @cindex function invocation
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
582 @cindex calling a function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
583
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
584 Defining functions is only half the battle. Functions don't do
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
585 anything until you @dfn{call} them, i.e., tell them to run. Calling a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
586 function is also known as @dfn{invocation}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
587
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
588 The most common way of invoking a function is by evaluating a list.
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
589 For example, evaluating the list @code{(concat "a" "b")} calls the
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
590 function @code{concat} with arguments @code{"a"} and @code{"b"}.
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
591 @xref{Evaluation}, for a description of evaluation.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
592
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
593 When you write a list as an expression in your program, the function
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
594 name it calls is written in your program. This means that you choose
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
595 which function to call, and how many arguments to give it, when you
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
596 write the program. Usually that's just what you want. Occasionally you
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
597 need to compute at run time which function to call. To do that, use the
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
598 function @code{funcall}. When you also need to determine at run time
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
599 how many arguments to pass, use @code{apply}.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
600
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
601 @defun funcall function &rest arguments
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
602 @code{funcall} calls @var{function} with @var{arguments}, and returns
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
603 whatever @var{function} returns.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
604
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
605 Since @code{funcall} is a function, all of its arguments, including
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
606 @var{function}, are evaluated before @code{funcall} is called. This
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
607 means that you can use any expression to obtain the function to be
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
608 called. It also means that @code{funcall} does not see the expressions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
609 you write for the @var{arguments}, only their values. These values are
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
610 @emph{not} evaluated a second time in the act of calling @var{function};
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
611 @code{funcall} enters the normal procedure for calling a function at the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
612 place where the arguments have already been evaluated.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
613
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
614 The argument @var{function} must be either a Lisp function or a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
615 primitive function. Special forms and macros are not allowed, because
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
616 they make sense only when given the ``unevaluated'' argument
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
617 expressions. @code{funcall} cannot provide these because, as we saw
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
618 above, it never knows them in the first place.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
619
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
620 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
621 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
622 (setq f 'list)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
623 @result{} list
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
624 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
625 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
626 (funcall f 'x 'y 'z)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
627 @result{} (x y z)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
628 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
629 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
630 (funcall f 'x 'y '(z))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
631 @result{} (x y (z))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
632 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
633 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
634 (funcall 'and t nil)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
635 @error{} Invalid function: #<subr and>
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
636 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
637 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
638
26192
01d4feb7e1e4 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 25751
diff changeset
639 Compare these examples with the examples of @code{apply}.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
640 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
641
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
642 @defun apply function &rest arguments
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
643 @code{apply} calls @var{function} with @var{arguments}, just like
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
644 @code{funcall} but with one difference: the last of @var{arguments} is a
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
645 list of objects, which are passed to @var{function} as separate
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
646 arguments, rather than a single list. We say that @code{apply}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
647 @dfn{spreads} this list so that each individual element becomes an
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
648 argument.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
649
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
650 @code{apply} returns the result of calling @var{function}. As with
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
651 @code{funcall}, @var{function} must either be a Lisp function or a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
652 primitive function; special forms and macros do not make sense in
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
653 @code{apply}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
654
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
655 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
656 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
657 (setq f 'list)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
658 @result{} list
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
659 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
660 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
661 (apply f 'x 'y 'z)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
662 @error{} Wrong type argument: listp, z
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
663 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
664 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
665 (apply '+ 1 2 '(3 4))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
666 @result{} 10
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
667 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
668 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
669 (apply '+ '(1 2 3 4))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
670 @result{} 10
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
671 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
672
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
673 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
674 (apply 'append '((a b c) nil (x y z) nil))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
675 @result{} (a b c x y z)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
676 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
677 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
678
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
679 For an interesting example of using @code{apply}, see the description of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
680 @code{mapcar}, in @ref{Mapping Functions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
681 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
682
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
683 @cindex functionals
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
684 It is common for Lisp functions to accept functions as arguments or
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
685 find them in data structures (especially in hook variables and property
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
686 lists) and call them using @code{funcall} or @code{apply}. Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
687 that accept function arguments are often called @dfn{functionals}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
688
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
689 Sometimes, when you call a functional, it is useful to supply a no-op
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
690 function as the argument. Here are two different kinds of no-op
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
691 function:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
692
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
693 @defun identity arg
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
694 This function returns @var{arg} and has no side effects.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
695 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
696
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
697 @defun ignore &rest args
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
698 This function ignores any arguments and returns @code{nil}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
699 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
700
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
701 @node Mapping Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
702 @section Mapping Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
703 @cindex mapping functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
704
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
705 A @dfn{mapping function} applies a given function to each element of a
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
706 list or other collection. Emacs Lisp has several such functions;
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
707 @code{mapcar} and @code{mapconcat}, which scan a list, are described
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
708 here. @xref{Creating Symbols}, for the function @code{mapatoms} which
26192
01d4feb7e1e4 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 25751
diff changeset
709 maps over the symbols in an obarray. @xref{Hash Access}, for the
01d4feb7e1e4 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 25751
diff changeset
710 function @code{maphash} which maps over key/value associations in a
01d4feb7e1e4 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 25751
diff changeset
711 hash table.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
712
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
713 These mapping functions do not allow char-tables because a char-table
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
714 is a sparse array whose nominal range of indices is very large. To map
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
715 over a char-table in a way that deals properly with its sparse nature,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
716 use the function @code{map-char-table} (@pxref{Char-Tables}).
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
717
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
718 @defun mapcar function sequence
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
719 @code{mapcar} applies @var{function} to each element of @var{sequence}
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
720 in turn, and returns a list of the results.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
721
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
722 The argument @var{sequence} can be any kind of sequence except a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
723 char-table; that is, a list, a vector, a bool-vector, or a string. The
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
724 result is always a list. The length of the result is the same as the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
725 length of @var{sequence}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
726
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
727 @smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
728 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
729 @exdent @r{For example:}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
730
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
731 (mapcar 'car '((a b) (c d) (e f)))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
732 @result{} (a c e)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
733 (mapcar '1+ [1 2 3])
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
734 @result{} (2 3 4)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
735 (mapcar 'char-to-string "abc")
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
736 @result{} ("a" "b" "c")
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
737 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
738
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
739 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
740 ;; @r{Call each function in @code{my-hooks}.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
741 (mapcar 'funcall my-hooks)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
742 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
743
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
744 @group
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
745 (defun mapcar* (function &rest args)
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
746 "Apply FUNCTION to successive cars of all ARGS.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
747 Return the list of results."
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
748 ;; @r{If no list is exhausted,}
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47667
diff changeset
749 (if (not (memq 'nil args))
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
750 ;; @r{apply function to @sc{car}s.}
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47667
diff changeset
751 (cons (apply function (mapcar 'car args))
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47667
diff changeset
752 (apply 'mapcar* function
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
753 ;; @r{Recurse for rest of elements.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
754 (mapcar 'cdr args)))))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
755 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
756
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
757 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
758 (mapcar* 'cons '(a b c) '(1 2 3 4))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
759 @result{} ((a . 1) (b . 2) (c . 3))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
760 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
761 @end smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
762 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
763
28556
Dave Love <fx@gnu.org>
parents: 27193
diff changeset
764 @defun mapc function sequence
Dave Love <fx@gnu.org>
parents: 27193
diff changeset
765 @tindex mapc
Dave Love <fx@gnu.org>
parents: 27193
diff changeset
766 @code{mapc} is like @code{mapcar} except that @var{function} is used for
Dave Love <fx@gnu.org>
parents: 27193
diff changeset
767 side-effects only---the values it returns are ignored, not collected
Dave Love <fx@gnu.org>
parents: 27193
diff changeset
768 into a list. @code{mapc} always returns @var{sequence}.
Dave Love <fx@gnu.org>
parents: 27193
diff changeset
769 @end defun
Dave Love <fx@gnu.org>
parents: 27193
diff changeset
770
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
771 @defun mapconcat function sequence separator
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
772 @code{mapconcat} applies @var{function} to each element of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
773 @var{sequence}: the results, which must be strings, are concatenated.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
774 Between each pair of result strings, @code{mapconcat} inserts the string
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
775 @var{separator}. Usually @var{separator} contains a space or comma or
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
776 other suitable punctuation.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
777
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
778 The argument @var{function} must be a function that can take one
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
779 argument and return a string. The argument @var{sequence} can be any
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
780 kind of sequence except a char-table; that is, a list, a vector, a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
781 bool-vector, or a string.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47667
diff changeset
782
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
783 @smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
784 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
785 (mapconcat 'symbol-name
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
786 '(The cat in the hat)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
787 " ")
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
788 @result{} "The cat in the hat"
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
789 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
790
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
791 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
792 (mapconcat (function (lambda (x) (format "%c" (1+ x))))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
793 "HAL-8000"
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
794 "")
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
795 @result{} "IBM.9111"
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
796 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
797 @end smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
798 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
799
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
800 @node Anonymous Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
801 @section Anonymous Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
802 @cindex anonymous function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
803
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
804 In Lisp, a function is a list that starts with @code{lambda}, a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
805 byte-code function compiled from such a list, or alternatively a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
806 primitive subr-object; names are ``extra''. Although usually functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
807 are defined with @code{defun} and given names at the same time, it is
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
808 occasionally more concise to use an explicit lambda expression---an
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
809 anonymous function. Such a list is valid wherever a function name is.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
810
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
811 Any method of creating such a list makes a valid function. Even this:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
812
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
813 @smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
814 @group
42687
fdabb5076442 Restore the quote in the `silly' example.
Richard M. Stallman <rms@gnu.org>
parents: 42647
diff changeset
815 (setq silly (append '(lambda (x)) (list (list '+ (* 3 4) 'x))))
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
816 @result{} (lambda (x) (+ 12 x))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
817 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
818 @end smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
819
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
820 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
821 This computes a list that looks like @code{(lambda (x) (+ 12 x))} and
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
822 makes it the value (@emph{not} the function definition!) of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
823 @code{silly}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
824
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
825 Here is how we might call this function:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
826
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
827 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
828 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
829 (funcall silly 1)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
830 @result{} 13
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
831 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
832 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
833
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
834 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
835 (It does @emph{not} work to write @code{(silly 1)}, because this function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
836 is not the @emph{function definition} of @code{silly}. We have not given
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
837 @code{silly} any function definition, just a value as a variable.)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
838
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
839 Most of the time, anonymous functions are constants that appear in
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
840 your program. For example, you might want to pass one as an argument to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
841 the function @code{mapcar}, which applies any given function to each
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
842 element of a list.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
843
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47667
diff changeset
844 Here we define a function @code{change-property} which
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
845 uses a function as its third argument:
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
846
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
847 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
848 @group
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
849 (defun change-property (symbol prop function)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
850 (let ((value (get symbol prop)))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
851 (put symbol prop (funcall function value))))
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
852 @end group
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
853 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
854
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
855 @noindent
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
856 Here we define a function that uses @code{change-property},
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
857 passing it a function to double a number:
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
858
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
859 @example
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
860 @group
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
861 (defun double-property (symbol prop)
42647
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
862 (change-property symbol prop '(lambda (x) (* 2 x))))
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
863 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
864 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
865
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
866 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
867 In such cases, we usually use the special form @code{function} instead
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
868 of simple quotation to quote the anonymous function, like this:
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
869
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
870 @example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
871 @group
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
872 (defun double-property (symbol prop)
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
873 (change-property symbol prop
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
874 (function (lambda (x) (* 2 x)))))
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
875 @end group
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
876 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
877
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
878 Using @code{function} instead of @code{quote} makes a difference if you
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
879 compile the function @code{double-property}. For example, if you
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
880 compile the second definition of @code{double-property}, the anonymous
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
881 function is compiled as well. By contrast, if you compile the first
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
882 definition which uses ordinary @code{quote}, the argument passed to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
883 @code{change-property} is the precise list shown:
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
884
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
885 @example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
886 (lambda (x) (* x 2))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
887 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
888
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
889 @noindent
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
890 The Lisp compiler cannot assume this list is a function, even though it
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
891 looks like one, since it does not know what @code{change-property} will
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
892 do with the list. Perhaps it will check whether the @sc{car} of the third
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
893 element is the symbol @code{*}! Using @code{function} tells the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
894 compiler it is safe to go ahead and compile the constant function.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
895
42647
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
896 Nowadays it is possible to omit @code{function} entirely, like this:
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
897
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
898 @example
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
899 @group
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
900 (defun double-property (symbol prop)
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
901 (change-property symbol prop (lambda (x) (* 2 x))))
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
902 @end group
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
903 @end example
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
904
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
905 @noindent
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
906 This is because @code{lambda} itself implies @code{function}.
3e0b4b8d4f7e Fix the double-property examples. Include one with a bare lambda.
Richard M. Stallman <rms@gnu.org>
parents: 39168
diff changeset
907
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
908 We sometimes write @code{function} instead of @code{quote} when
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
909 quoting the name of a function, but this usage is just a sort of
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
910 comment:
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
911
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
912 @example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
913 (function @var{symbol}) @equiv{} (quote @var{symbol}) @equiv{} '@var{symbol}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
914 @end example
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
915
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
916 @cindex @samp{#'} syntax
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
917 The read syntax @code{#'} is a short-hand for using @code{function}.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47667
diff changeset
918 For example,
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
919
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
920 @example
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
921 #'(lambda (x) (* x x))
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
922 @end example
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
923
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
924 @noindent
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
925 is equivalent to
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
926
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
927 @example
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
928 (function (lambda (x) (* x x)))
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
929 @end example
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
930
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
931 @defspec function function-object
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
932 @cindex function quoting
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
933 This special form returns @var{function-object} without evaluating it.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
934 In this, it is equivalent to @code{quote}. However, it serves as a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
935 note to the Emacs Lisp compiler that @var{function-object} is intended
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
936 to be used only as a function, and therefore can safely be compiled.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
937 Contrast this with @code{quote}, in @ref{Quoting}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
938 @end defspec
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
939
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
940 See @code{documentation} in @ref{Accessing Documentation}, for a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
941 realistic example using @code{function} and an anonymous function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
942
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
943 @node Function Cells
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
944 @section Accessing Function Cell Contents
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
945
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
946 The @dfn{function definition} of a symbol is the object stored in the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
947 function cell of the symbol. The functions described here access, test,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
948 and set the function cell of symbols.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
949
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
950 See also the function @code{indirect-function} in @ref{Function
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
951 Indirection}.
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
952
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
953 @defun symbol-function symbol
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
954 @kindex void-function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
955 This returns the object in the function cell of @var{symbol}. If the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
956 symbol's function cell is void, a @code{void-function} error is
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
957 signaled.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
958
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
959 This function does not check that the returned object is a legitimate
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
960 function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
961
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
962 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
963 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
964 (defun bar (n) (+ n 2))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
965 @result{} bar
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
966 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
967 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
968 (symbol-function 'bar)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
969 @result{} (lambda (n) (+ n 2))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
970 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
971 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
972 (fset 'baz 'bar)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
973 @result{} bar
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
974 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
975 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
976 (symbol-function 'baz)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
977 @result{} bar
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
978 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
979 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
980 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
981
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
982 @cindex void function cell
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
983 If you have never given a symbol any function definition, we say that
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
984 that symbol's function cell is @dfn{void}. In other words, the function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
985 cell does not have any Lisp object in it. If you try to call such a symbol
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
986 as a function, it signals a @code{void-function} error.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
987
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
988 Note that void is not the same as @code{nil} or the symbol
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
989 @code{void}. The symbols @code{nil} and @code{void} are Lisp objects,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
990 and can be stored into a function cell just as any other object can be
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
991 (and they can be valid functions if you define them in turn with
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
992 @code{defun}). A void function cell contains no object whatsoever.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
993
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
994 You can test the voidness of a symbol's function definition with
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
995 @code{fboundp}. After you have given a symbol a function definition, you
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
996 can make it void once more using @code{fmakunbound}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
997
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
998 @defun fboundp symbol
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
999 This function returns @code{t} if the symbol has an object in its
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1000 function cell, @code{nil} otherwise. It does not check that the object
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1001 is a legitimate function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1002 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1003
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1004 @defun fmakunbound symbol
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1005 This function makes @var{symbol}'s function cell void, so that a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1006 subsequent attempt to access this cell will cause a @code{void-function}
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1007 error. (See also @code{makunbound}, in @ref{Void Variables}.)
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1008
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1009 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1010 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1011 (defun foo (x) x)
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
1012 @result{} foo
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1013 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1014 @group
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
1015 (foo 1)
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
1016 @result{}1
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
1017 @end group
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
1018 @group
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1019 (fmakunbound 'foo)
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
1020 @result{} foo
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1021 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1022 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1023 (foo 1)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1024 @error{} Symbol's function definition is void: foo
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1025 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1026 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1027 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1028
16755
e3abbf649bee Change arg name for fset.
Richard M. Stallman <rms@gnu.org>
parents: 12098
diff changeset
1029 @defun fset symbol definition
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
1030 This function stores @var{definition} in the function cell of
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
1031 @var{symbol}. The result is @var{definition}. Normally
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
1032 @var{definition} should be a function or the name of a function, but
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
1033 this is not checked. The argument @var{symbol} is an ordinary evaluated
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16755
diff changeset
1034 argument.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1035
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1036 There are three normal uses of this function:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1037
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1038 @itemize @bullet
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1039 @item
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1040 Copying one symbol's function definition to another---in other words,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1041 making an alternate name for a function. (If you think of this as the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1042 definition of the new name, you should use @code{defalias} instead of
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1043 @code{fset}; see @ref{Defining Functions}.)
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1044
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1045 @item
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1046 Giving a symbol a function definition that is not a list and therefore
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
1047 cannot be made with @code{defun}. For example, you can use @code{fset}
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
1048 to give a symbol @code{s1} a function definition which is another symbol
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
1049 @code{s2}; then @code{s1} serves as an alias for whatever definition
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1050 @code{s2} presently has. (Once again use @code{defalias} instead of
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1051 @code{fset} if you think of this as the definition of @code{s1}.)
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1052
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1053 @item
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1054 In constructs for defining or altering functions. If @code{defun}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1055 were not a primitive, it could be written in Lisp (as a macro) using
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1056 @code{fset}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1057 @end itemize
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1058
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1059 Here are examples of these uses:
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1060
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1061 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1062 @group
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1063 ;; @r{Save @code{foo}'s definition in @code{old-foo}.}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1064 (fset 'old-foo (symbol-function 'foo))
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1065 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1066
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1067 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1068 ;; @r{Make the symbol @code{car} the function definition of @code{xfirst}.}
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1069 ;; @r{(Most likely, @code{defalias} would be better than @code{fset} here.)}
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1070 (fset 'xfirst 'car)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1071 @result{} car
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1072 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1073 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1074 (xfirst '(1 2 3))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1075 @result{} 1
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1076 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1077 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1078 (symbol-function 'xfirst)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1079 @result{} car
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1080 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1081 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1082 (symbol-function (symbol-function 'xfirst))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1083 @result{} #<subr car>
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1084 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1085
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1086 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1087 ;; @r{Define a named keyboard macro.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1088 (fset 'kill-two-lines "\^u2\^k")
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1089 @result{} "\^u2\^k"
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1090 @end group
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1091
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1092 @group
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1093 ;; @r{Here is a function that alters other functions.}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1094 (defun copy-function-definition (new old)
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1095 "Define NEW with the same function definition as OLD."
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1096 (fset new (symbol-function old)))
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1097 @end group
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1098 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1099 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1100
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1101 When writing a function that extends a previously defined function,
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
1102 the following idiom is sometimes used:
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1103
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1104 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1105 (fset 'old-foo (symbol-function 'foo))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1106 (defun foo ()
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1107 "Just like old-foo, except more so."
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1108 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1109 (old-foo)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1110 (more-so))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1111 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1112 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1113
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1114 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1115 This does not work properly if @code{foo} has been defined to autoload.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1116 In such a case, when @code{foo} calls @code{old-foo}, Lisp attempts
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1117 to define @code{old-foo} by loading a file. Since this presumably
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1118 defines @code{foo} rather than @code{old-foo}, it does not produce the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1119 proper results. The only way to avoid this problem is to make sure the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1120 file is loaded before moving aside the old definition of @code{foo}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1121
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
1122 But it is unmodular and unclean, in any case, for a Lisp file to
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1123 redefine a function defined elsewhere. It is cleaner to use the advice
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1124 facility (@pxref{Advising Functions}).
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
1125
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1126 @node Inline Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1127 @section Inline Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1128 @cindex inline functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1129
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1130 @findex defsubst
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1131 You can define an @dfn{inline function} by using @code{defsubst} instead
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1132 of @code{defun}. An inline function works just like an ordinary
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1133 function except for one thing: when you compile a call to the function,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1134 the function's definition is open-coded into the caller.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1135
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1136 Making a function inline makes explicit calls run faster. But it also
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1137 has disadvantages. For one thing, it reduces flexibility; if you change
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1138 the definition of the function, calls already inlined still use the old
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1139 definition until you recompile them. Since the flexibility of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1140 redefining functions is an important feature of Emacs, you should not
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1141 make a function inline unless its speed is really crucial.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1142
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1143 Another disadvantage is that making a large function inline can increase
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1144 the size of compiled code both in files and in memory. Since the speed
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1145 advantage of inline functions is greatest for small functions, you
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1146 generally should not make large functions inline.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1147
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1148 It's possible to define a macro to expand into the same code that an
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1149 inline function would execute. (@xref{Macros}.) But the macro would be
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1150 limited to direct use in expressions---a macro cannot be called with
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1151 @code{apply}, @code{mapcar} and so on. Also, it takes some work to
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1152 convert an ordinary function into a macro. To convert it into an inline
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1153 function is very easy; simply replace @code{defun} with @code{defsubst}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1154 Since each argument of an inline function is evaluated exactly once, you
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1155 needn't worry about how many times the body uses the arguments, as you
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1156 do for macros. (@xref{Argument Evaluation}.)
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1157
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
1158 Inline functions can be used and open-coded later on in the same file,
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1159 following the definition, just like macros.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1160
47667
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1161 @node Function safety
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1162 @section Determining whether a function is safe to call
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1163 @cindex function safety
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1164 @cindex safety of functions
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1165 @cindex virus detection
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1166 @cindex Trojan-horse detection
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1167 @cindex DDoS attacks
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1168
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1169 Some major modes such as SES (see @pxref{Top,,,ses}) will call
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1170 functions that are stored in user files. User files sometimes have
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1171 poor pedigrees---you can get a spreadsheet from someone you've just
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1172 met, or you can get one through email from someone you've never met.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1173 Such files can contain viruses and other Trojan horses that could
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1174 corrupt your operating system environment, delete your files, or even
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1175 turn your computer into a DDoS zombie! To avoid this terrible fate,
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1176 you should not call a function whose source code is stored in a user
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1177 file until you have determined that it is safe.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1178
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1179 @defun unsafep form &optional unsafep-vars
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1180 Returns nil if @var{form} is a @dfn{safe} lisp expression, or returns
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1181 a list that describes why it might be unsafe. The argument
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1182 @var{unsafep-vars} is a list of symbols known to have temporary
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1183 bindings at this point; it is mainly used for internal recursive
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1184 calls. The current buffer is an implicit argument, which provides a
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1185 list of buffer-local bindings.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1186 @end defun
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1187
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1188 Being quick and simple, @code{unsafep} does a very light analysis and
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1189 rejects many Lisp expressions that are actually safe. There are no
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1190 known cases where @code{unsafep} returns nil for an unsafe expression.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1191 However, a ``safe'' Lisp expression can return a string with a
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1192 @code{display} property, containing an associated Lisp expression to
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1193 be executed after the string is inserted into a buffer. This
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1194 associated expression can be a virus. In order to be safe, you must
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1195 delete properties from all strings calculated by user code before
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1196 inserting them into buffers.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1197
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1198 What is a safe Lisp expression? Basically, it's an expression that
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1199 calls only built-in functions with no side effects (or only innocuous
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1200 ones). Innocuous side effects include displaying messages and
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1201 altering non-risky buffer-local variables (but not global variables).
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1202
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1203 @table @dfn
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1204 @item Safe expression
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1205 @itemize
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1206 @item
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1207 An atom or quoted thing.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1208 @item
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1209 A call to a safe function (see below), if all its arguments are
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1210 safe expressions.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1211 @item
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1212 One of the special forms [and, catch, cond, if, or, prog1, prog2,
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1213 progn, while, unwind-protect], if all its arguments are safe.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1214 @item
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1215 A form that creates temporary bindings [condition-case, dolist,
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1216 dotimes, lambda, let, let*], if all args are safe and the symbols to
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1217 be bound are not explicitly risky (see @pxref{File Local Variables}).
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1218 @item
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1219 An assignment [add-to-list, setq, push, pop], if all args are safe and
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1220 the symbols to be assigned are not explicitly risky and they already
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1221 have temporary or buffer-local bindings.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1222 @item
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1223 One of [apply, mapc, mapcar, mapconcat] if the first argument is a
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1224 safe explicit lambda and the other args are safe expressions.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1225 @end itemize
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1226
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1227 @item Safe function
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1228 @itemize
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1229 @item
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1230 A lambda containing safe expressions.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1231 @item
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1232 A symbol on the list @code{safe-functions}, so the user says it's safe.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1233 @item
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1234 A symbol with a non-nil @code{side-effect-free} property.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1235 @item
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1236 A symbol with a non-nil @code{safe-function} property. Value t
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1237 indicates a function that is safe but has innocuous side effects.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1238 Other values will someday indicate functions with classes of side
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1239 effects that are not always safe.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1240 @end itemize
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1241
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1242 The @code{side-effect-free} and @code{safe-function} properties are
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1243 provided for built-in functions and for low-level functions and macros
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1244 defined in @file{subr.el}. You can assign these properties for the
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1245 functions you write.
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1246
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1247 @end table
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1248
96b260e0ff3d New major mode "SES" for spreadsheets.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 42687
diff changeset
1249
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 7193
diff changeset
1250 @c Emacs versions prior to 19 did not have inline functions.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1251
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1252 @node Related Topics
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1253 @section Other Topics Related to Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1254
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1255 Here is a table of several functions that do things related to
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1256 function calling and function definitions. They are documented
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1257 elsewhere, but we provide cross references here.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1258
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1259 @table @code
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1260 @item apply
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1261 See @ref{Calling Functions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1262
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1263 @item autoload
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1264 See @ref{Autoload}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1265
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1266 @item call-interactively
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1267 See @ref{Interactive Call}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1268
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1269 @item commandp
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1270 See @ref{Interactive Call}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1271
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1272 @item documentation
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1273 See @ref{Accessing Documentation}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1274
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1275 @item eval
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1276 See @ref{Eval}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1277
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1278 @item funcall
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1279 See @ref{Calling Functions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1280
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1281 @item function
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1282 See @ref{Anonymous Functions}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1283
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1284 @item ignore
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1285 See @ref{Calling Functions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1286
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1287 @item indirect-function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1288 See @ref{Function Indirection}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1289
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1290 @item interactive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1291 See @ref{Using Interactive}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1292
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1293 @item interactive-p
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1294 See @ref{Interactive Call}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1295
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1296 @item mapatoms
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1297 See @ref{Creating Symbols}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1298
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1299 @item mapcar
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1300 See @ref{Mapping Functions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1301
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1302 @item map-char-table
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1303 See @ref{Char-Tables}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1304
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1305 @item mapconcat
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1306 See @ref{Mapping Functions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1307
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1308 @item undefined
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1309 See @ref{Key Lookup}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1310 @end table
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1311