annotate lispref/functions.texi @ 70553:09d3b5632463

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