annotate lispref/functions.texi @ 8534:a446d13c46ea

(mouse-set-mark): Select the window before saving point.
author Richard M. Stallman <rms@gnu.org>
date Sat, 13 Aug 1994 20:29:54 +0000
parents 03103053974d
children a6eb5f12b0f3
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.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
4 @c See the file elisp.texi for copying conditions.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
5 @setfilename ../info/functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
6 @node Functions, Macros, Variables, Top
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
7 @chapter Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
8
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
9 A Lisp program is composed mainly of Lisp functions. This chapter
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
10 explains what functions are, how they accept arguments, and how to
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
11 define them.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
12
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
13 @menu
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
14 * What Is a Function:: Lisp functions vs. primitives; terminology.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
15 * Lambda Expressions:: How functions are expressed as Lisp objects.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
16 * Function Names:: A symbol can serve as the name of a function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
17 * Defining Functions:: Lisp expressions for defining functions.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
18 * Calling Functions:: How to use an existing function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
19 * Mapping Functions:: Applying a function to each element of a list, etc.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
20 * Anonymous Functions:: Lambda expressions are functions with no names.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
21 * Function Cells:: Accessing or setting the function definition
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
22 of a symbol.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
23 * Inline Functions:: Defining functions that the compiler will open code.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
24 * Related Topics:: Cross-references to specific Lisp primitives
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
25 that have a special bearing on how functions work.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
26 @end menu
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
27
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
28 @node What Is a Function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
29 @section What Is a Function?
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
30
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
31 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
32 given several values called @dfn{arguments}. The result of the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
33 computation is called the value of the function. The computation can
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
34 also have side effects: lasting changes in the values of variables or
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
35 the contents of data structures.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
36
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
37 Here are important terms for functions in Emacs Lisp and for other
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
38 function-like objects.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
39
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
40 @table @dfn
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
41 @item function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
42 @cindex function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
43 In Emacs Lisp, a @dfn{function} is anything that can be applied to
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
44 arguments in a Lisp program. In some cases, we use it more
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
45 specifically to mean a function written in Lisp. Special forms and
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
46 macros are not functions.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
47
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
48 @item primitive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
49 @cindex primitive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
50 @cindex subr
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
51 @cindex built-in function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
52 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
53 such as @code{car} or @code{append}. These functions are also called
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
54 @dfn{built-in} functions or @dfn{subrs}. (Special forms are also
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
55 considered primitives.)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
56
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
57 Usually the reason that a function is a primitives is because it is
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
58 fundamental, because it provides a low-level interface to operating
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
59 system services, or because it needs to run fast. Primitives can be
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
60 modified or added only by changing the C sources and recompiling the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
61 editor. See @ref{Writing Emacs Primitives}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
62
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
63 @item lambda expression
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
64 A @dfn{lambda expression} is a function written in Lisp.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
65 These are described in the following section.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
66 @ifinfo
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
67 @xref{Lambda Expressions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
68 @end ifinfo
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
69
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
70 @item special form
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
71 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
72 evaluate all of its arguments in the usual way. It may evaluate only
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
73 some of the arguments, or may evaluate them in an unusual order, or
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
74 several times. Many special forms are described in @ref{Control
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
75 Structures}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
76
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
77 @item macro
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
78 @cindex macro
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
79 A @dfn{macro} is a construct defined in Lisp by the programmer. It
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
80 differs from a function in that it translates a Lisp expression that you
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
81 write into an equivalent expression to be evaluated instead of the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
82 original expression. @xref{Macros}, for how to define and use macros.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
83
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
84 @item command
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
85 @cindex command
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
86 A @dfn{command} is an object that @code{command-execute} can invoke; it
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
87 is a possible definition for a key sequence. Some functions are
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
88 commands; a function written in Lisp is a command if it contains an
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
89 interactive declaration (@pxref{Defining Commands}). Such a function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
90 can be called from Lisp expressions like other functions; in this case,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
91 the fact that the function is a command makes no difference.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
92
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
93 Keyboard macros (strings and vectors) are commands also, even though
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
94 they are not functions. A symbol is a command if its function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
95 definition is a command; such symbols can be invoked with @kbd{M-x}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
96 The symbol is a function as well if the definition is a function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
97 @xref{Command Overview}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
98
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
99 @item keystroke command
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
100 @cindex keystroke command
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
101 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
102 (typically one to three keystrokes). The distinction is made here
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
103 merely to avoid confusion with the meaning of ``command'' in non-Emacs
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
104 editors; for Lisp programs, the distinction is normally unimportant.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
105
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
106 @item byte-code function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
107 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
108 byte compiler. @xref{Byte-Code Type}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
109 @end table
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
110
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
111 @defun subrp object
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
112 This function returns @code{t} if @var{object} is a built-in function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
113 (i.e., a Lisp primitive).
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
114
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
115 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
116 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
117 (subrp 'message) ; @r{@code{message} is a symbol,}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
118 @result{} nil ; @r{not a subr object.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
119 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
120 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
121 (subrp (symbol-function 'message))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
122 @result{} t
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
123 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
124 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
125 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
126
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
127 @defun byte-code-function-p object
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
128 This function returns @code{t} if @var{object} is a byte-code
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
129 function. For example:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
130
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
131 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
132 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
133 (byte-code-function-p (symbol-function 'next-line))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
134 @result{} t
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
135 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
136 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
137 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
138
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
139 @node Lambda Expressions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
140 @section Lambda Expressions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
141 @cindex lambda expression
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
142
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
143 A function written in Lisp is a list that looks like this:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
144
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
145 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
146 (lambda (@var{arg-variables}@dots{})
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
147 @r{[}@var{documentation-string}@r{]}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
148 @r{[}@var{interactive-declaration}@r{]}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
149 @var{body-forms}@dots{})
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
150 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
151
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
152 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
153 (Such a list is called a @dfn{lambda expression} for historical reasons,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
154 even though it is not really an expression at all---it is not a form
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
155 that can be evaluated meaningfully.)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
156
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
157 @menu
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
158 * Lambda Components:: The parts of a lambda expression.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
159 * Simple Lambda:: A simple example.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
160 * Argument List:: Details and special features of argument lists.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
161 * Function Documentation:: How to put documentation in a function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
162 @end menu
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
163
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
164 @node Lambda Components
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
165 @subsection Components of a Lambda Expression
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
166
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
167 @ifinfo
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
168
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
169 A function written in Lisp (a ``lambda expression'') is a list that
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
170 looks like this:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
171
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
172 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
173 (lambda (@var{arg-variables}@dots{})
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
174 [@var{documentation-string}]
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
175 [@var{interactive-declaration}]
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
176 @var{body-forms}@dots{})
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
177 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
178 @end ifinfo
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
179
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
180 @cindex lambda list
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
181 The first element of a lambda expression is always the symbol
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
182 @code{lambda}. This indicates that the list represents a function. The
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
183 reason functions are defined to start with @code{lambda} is so that
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
184 other lists, intended for other uses, will not accidentally be valid as
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
185 functions.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
186
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
187 The second element is a list of symbols--the argument variable names.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
188 This is called the @dfn{lambda list}. When a Lisp function is called,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
189 the argument values are matched up against the variables in the lambda
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
190 list, which are given local bindings with the values provided.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
191 @xref{Local Variables}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
192
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
193 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
194 function definition to describe the function for the Emacs help
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
195 facilities. @xref{Function Documentation}.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
196
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
197 The interactive declaration is a list of the form @code{(interactive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
198 @var{code-string})}. This declares how to provide arguments if the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
199 function is used interactively. Functions with this declaration are called
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
200 @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
201 Functions not intended to be called in this way should not have interactive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
202 declarations. @xref{Defining Commands}, for how to write an interactive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
203 declaration.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
204
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
205 @cindex body of function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
206 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
207 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
208 ``a list of Lisp forms to evaluate''). The value returned by the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
209 function is the value returned by the last element of the body.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
210
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
211 @node Simple Lambda
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
212 @subsection A Simple Lambda-Expression Example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
213
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
214 Consider for example the following function:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
215
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
216 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
217 (lambda (a b c) (+ a b c))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
218 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
219
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
220 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
221 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
222 expression, like this:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
223
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
224 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
225 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
226 ((lambda (a b c) (+ a b c))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
227 1 2 3)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
228 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
229 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
230
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
231 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
232 This call evaluates the body of the lambda expression with the variable
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
233 @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
234 Evaluation of the body adds these three numbers, producing the result 6;
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
235 therefore, this call to the function returns the value 6.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
236
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
237 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
238 this example:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
239
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
240 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
241 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
242 ((lambda (a b c) (+ a b c))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
243 1 (* 2 3) (- 5 4))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
244 @end group
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 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
249 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
250 argument values 1, 6 and 1 to produce the value 8.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
251
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
252 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
253 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
254 variables and giving them values, using the special form @code{let}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
255 (@pxref{Local Variables}). And @code{let} is clearer and easier to use.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
256 In practice, lambda expressions are either stored as the function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
257 definitions of symbols, to produce named functions, or passed as
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
258 arguments to other functions (@pxref{Anonymous Functions}).
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
259
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
260 However, calls to explicit lambda expressions were very useful in the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
261 old days of Lisp, before the special form @code{let} was invented. At
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
262 that time, they were the only way to bind and initialize local
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
263 variables.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
264
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
265 @node Argument List
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
266 @subsection Advanced Features of Argument Lists
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
267 @kindex wrong-number-of-arguments
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
268 @cindex argument binding
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
269 @cindex binding arguments
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
270
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
271 Our simple sample function, @code{(lambda (a b c) (+ a b c))},
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
272 specifies three argument variables, so it must be called with three
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
273 arguments: if you try to call it with only two arguments or four
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
274 arguments, you get a @code{wrong-number-of-arguments} error.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
275
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
276 It is often convenient to write a function that allows certain
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
277 arguments to be omitted. For example, the function @code{substring}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
278 accepts three arguments---a string, the start index and the end
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
279 index---but the third argument defaults to the @var{length} of the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
280 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
281 accept an indefinite number of arguments, as the functions @code{list}
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
282 and @code{+} do.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
283
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
284 @cindex optional arguments
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
285 @cindex rest arguments
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
286 @kindex &optional
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
287 @kindex &rest
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
288 To specify optional arguments that may be omitted when a function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
289 is called, simply include the keyword @code{&optional} before the optional
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
290 arguments. To specify a list of zero or more extra arguments, include the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
291 keyword @code{&rest} before one final argument.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
292
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
293 Thus, the complete syntax for an argument list is as follows:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
294
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
295 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
296 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
297 (@var{required-vars}@dots{}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
298 @r{[}&optional @var{optional-vars}@dots{}@r{]}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
299 @r{[}&rest @var{rest-var}@r{]})
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
300 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
301 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
302
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
303 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
304 The square brackets indicate that the @code{&optional} and @code{&rest}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
305 clauses, and the variables that follow them, are optional.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
306
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
307 A call to the function requires one actual argument for each of the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
308 @var{required-vars}. There may be actual arguments for zero or more of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
309 the @var{optional-vars}, and there cannot be any actual arguments beyond
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
310 that unless the lambda list uses @code{&rest}. In that case, there may
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
311 be any number of extra actual arguments.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
312
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
313 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
314 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
315 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
316 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
317 consider @code{nil} an abbreviation for some other meaningful value.
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
318 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
319 @code{substring} means to use the length of the string supplied.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
320
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
321 @cindex CL note---default optional arg
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
322 @quotation
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
323 @b{Common Lisp note:} Common Lisp allows the function to specify what
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
324 default value to use when an optional argument is omitted; Emacs Lisp
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
325 always uses @code{nil}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
326 @end quotation
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
327
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
328 For example, an argument list that looks like this:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
329
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
330 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
331 (a b &optional c d &rest e)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
332 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
333
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
334 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
335 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
336 required. If one or two more arguments are provided, @code{c} and
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
337 @code{d} are bound to them respectively; any arguments after the first
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
338 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
339 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
340 arguments, @code{d} is @code{nil}; if four arguments or fewer, @code{e}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
341 is @code{nil}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
342
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
343 There is no way to have required arguments following optional
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
344 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
345 that @code{c} in the example were optional and @code{d} were required.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
346 Suppose three actual arguments are given; which variable would the third
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
347 argument be for? Similarly, it makes no sense to have any more
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
348 arguments (either required or optional) after a @code{&rest} argument.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
349
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
350 Here are some examples of argument lists and proper calls:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
351
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
352 @smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
353 ((lambda (n) (1+ n)) ; @r{One required:}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
354 1) ; @r{requires exactly one argument.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
355 @result{} 2
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
356 ((lambda (n &optional n1) ; @r{One required and one optional:}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
357 (if n1 (+ n n1) (1+ n))) ; @r{1 or 2 arguments.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
358 1 2)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
359 @result{} 3
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
360 ((lambda (n &rest ns) ; @r{One required and one rest:}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
361 (+ n (apply '+ ns))) ; @r{1 or more arguments.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
362 1 2 3 4 5)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
363 @result{} 15
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
364 @end smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
365
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
366 @node Function Documentation
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
367 @subsection Documentation Strings of Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
368 @cindex documentation of function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
369
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
370 A lambda expression may optionally have a @dfn{documentation string} just
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
371 after the lambda list. This string does not affect execution of the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
372 function; it is a kind of comment, but a systematized comment which
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
373 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
374 facilities. @xref{Documentation}, for how the @var{documentation-string} is
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
375 accessed.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
376
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
377 It is a good idea to provide documentation strings for all commands,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
378 and for all other functions in your program that users of your program
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
379 should know about; internal functions might as well have only comments,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
380 since comments don't take up any room when your program is loaded.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
381
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
382 The first line of the documentation string should stand on its own,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
383 because @code{apropos} displays just this first line. It should consist
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
384 of one or two complete sentences that summarize the function's purpose.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
385
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
386 The start of the documentation string is usually indented, but since
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
387 these spaces come before the starting double-quote, they are not part of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
388 the string. Some people make a practice of indenting any additional
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
389 lines of the string so that the text lines up in the program source.
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
390 @emph{This is a mistake.} The indentation of the following lines is
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
391 inside the string; what looks nice in the source code will look ugly
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
392 when displayed by the help commands.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
393
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
394 You may wonder how the documentation string could be optional, since
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
395 there are required components of the function that follow it (the body).
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
396 Since evaluation of a string returns that string, without any side effects,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
397 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
398 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
399 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
400 as the return value and as the documentation.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
401
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
402 @node Function Names
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
403 @section Naming a Function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
404 @cindex function definition
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
405 @cindex named function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
406 @cindex function name
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
407
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
408 In most computer languages, every function has a name; the idea of a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
409 function without a name is nonsensical. In Lisp, a function in the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
410 strictest sense has no name. It is simply a list whose first element is
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
411 @code{lambda}, or a primitive subr-object.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
412
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
413 However, a symbol can serve as the name of a function. This happens
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
414 when you put the function in the symbol's @dfn{function cell}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
415 (@pxref{Symbol Components}). Then the symbol itself becomes a valid,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
416 callable function, equivalent to the list or subr-object that its
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
417 function cell refers to. The contents of the function cell are also
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
418 called the symbol's @dfn{function definition}. The procedure of using a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
419 symbol's function definition in place of the symbol is called
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
420 @dfn{symbol function indirection}; see @ref{Function Indirection}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
421
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
422 In practice, nearly all functions are given names in this way and
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
423 referred to through their names. For example, the symbol @code{car} works
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
424 as a function and does what it does because the primitive subr-object
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
425 @code{#<subr car>} is stored in its function cell.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
426
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
427 We give functions names because it is convenient to refer to them by
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
428 their names in Lisp expressions. For primitive subr-objects such as
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
429 @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
430 is no read syntax for such objects. For functions written in Lisp, the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
431 name is more convenient to use in a call than an explicit lambda
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
432 expression. Also, a function with a name can refer to itself---it can
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
433 be recursive. Writing the function's name in its own definition is much
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
434 more convenient than making the function definition point to itself
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
435 (something that is not impossible but that has various disadvantages in
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
436 practice).
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
437
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
438 We often identify functions with the symbols used to name them. For
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
439 example, we often speak of ``the function @code{car}'', not
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
440 distinguishing between the symbol @code{car} and the primitive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
441 subr-object that is its function definition. For most purposes, there
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
442 is no need to distinguish.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
443
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
444 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
445 a given function object @emph{usually} appears in the function cell of only
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
446 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
447 it in several symbols using @code{fset}; then each of the symbols is
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
448 equally well a name for the same function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
449
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
450 A symbol used as a function name may also be used as a variable;
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
451 these two uses of a symbol are independent and do not conflict.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
452
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
453 @node Defining Functions
7115
9a9e88e65617 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6455
diff changeset
454 @section Defining Functions
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
455 @cindex defining a function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
456
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
457 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
458 is called @dfn{defining a function}, and it is done with the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
459 @code{defun} special form.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
460
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
461 @defspec defun name argument-list body-forms
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
462 @code{defun} is the usual way to define new Lisp functions. It
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
463 defines the symbol @var{name} as a function that looks like this:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
464
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
465 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
466 (lambda @var{argument-list} . @var{body-forms})
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
467 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
468
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
469 @code{defun} stores this lambda expression in the function cell of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
470 @var{name}. It returns the value @var{name}, but usually we ignore this
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
471 value.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
472
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
473 As described previously (@pxref{Lambda Expressions}),
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
474 @var{argument-list} is a list of argument names and may include the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
475 keywords @code{&optional} and @code{&rest}. Also, the first two forms
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
476 in @var{body-forms} may be a documentation string and an interactive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
477 declaration.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
478
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
479 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
480 variable, since the symbol's value cell is independent of the function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
481 cell. @xref{Symbol Components}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
482
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
483 Here are some examples:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
484
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
485 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
486 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
487 (defun foo () 5)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
488 @result{} foo
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
489 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
490 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
491 (foo)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
492 @result{} 5
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
493 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
494
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
495 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
496 (defun bar (a &optional b &rest c)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
497 (list a b c))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
498 @result{} bar
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
499 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
500 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
501 (bar 1 2 3 4 5)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
502 @result{} (1 2 (3 4 5))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
503 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
504 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
505 (bar 1)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
506 @result{} (1 nil nil)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
507 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
508 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
509 (bar)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
510 @error{} Wrong number of arguments.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
511 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
512
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
513 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
514 (defun capitalize-backwards ()
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
515 "Upcase the last letter of a word."
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
516 (interactive)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
517 (backward-word 1)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
518 (forward-word 1)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
519 (backward-char 1)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
520 (capitalize-word 1))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
521 @result{} capitalize-backwards
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
522 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
523 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
524
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
525 Be careful not to redefine existing functions unintentionally.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
526 @code{defun} redefines even primitive functions such as @code{car}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
527 without any hesitation or notification. Redefining a function already
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
528 defined is often done deliberately, and there is no way to distinguish
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
529 deliberate redefinition from unintentional redefinition.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
530 @end defspec
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
531
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
532 @defun defalias name definition
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
533 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
534 definition @var{definition} (which can be any valid Lisp function).
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
535 It's best to use this rather than @code{fset} when defining a function
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
536 in a file, because @code{defalias} records which file defined the
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
537 function (@pxref{Unloading}), while @code{fset} does not.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
538 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
539
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
540 @node Calling Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
541 @section Calling Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
542 @cindex function invocation
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
543 @cindex calling a function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
544
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
545 Defining functions is only half the battle. Functions don't do
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
546 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
547 function is also known as @dfn{invocation}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
548
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
549 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
550 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
551 function @code{concat} with arguments @code{"a"} and @code{"b"}.
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
552 @xref{Evaluation}, for a description of evaluation.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
553
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
554 When you write a list as an expression in your program, the function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
555 name is part of the program. This means that you choose which function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
556 to call, and how many arguments to give it, when you write the program.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
557 Usually that's just what you want. Occasionally you need to decide at
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
558 run time which function to call. To do that, use the functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
559 @code{funcall} and @code{apply}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
560
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
561 @defun funcall function &rest arguments
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
562 @code{funcall} calls @var{function} with @var{arguments}, and returns
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
563 whatever @var{function} returns.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
564
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
565 Since @code{funcall} is a function, all of its arguments, including
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
566 @var{function}, are evaluated before @code{funcall} is called. This
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
567 means that you can use any expression to obtain the function to be
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
568 called. It also means that @code{funcall} does not see the expressions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
569 you write for the @var{arguments}, only their values. These values are
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
570 @emph{not} evaluated a second time in the act of calling @var{function};
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
571 @code{funcall} enters the normal procedure for calling a function at the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
572 place where the arguments have already been evaluated.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
573
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
574 The argument @var{function} must be either a Lisp function or a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
575 primitive function. Special forms and macros are not allowed, because
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
576 they make sense only when given the ``unevaluated'' argument
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
577 expressions. @code{funcall} cannot provide these because, as we saw
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
578 above, it never knows them in the first place.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
579
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
580 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
581 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
582 (setq f 'list)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
583 @result{} list
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
584 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
585 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
586 (funcall f 'x 'y 'z)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
587 @result{} (x y z)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
588 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
589 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
590 (funcall f 'x 'y '(z))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
591 @result{} (x y (z))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
592 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
593 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
594 (funcall 'and t nil)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
595 @error{} Invalid function: #<subr and>
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
596 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
597 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
598
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
599 Compare these example with the examples of @code{apply}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
600 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
601
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
602 @defun apply function &rest arguments
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
603 @code{apply} calls @var{function} with @var{arguments}, just like
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
604 @code{funcall} but with one difference: the last of @var{arguments} is a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
605 list of arguments to give to @var{function}, rather than a single
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
606 argument. We also say that @code{apply} @dfn{spreads} this list so that
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
607 each individual element becomes an argument.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
608
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
609 @code{apply} returns the result of calling @var{function}. As with
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
610 @code{funcall}, @var{function} must either be a Lisp function or a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
611 primitive function; special forms and macros do not make sense in
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
612 @code{apply}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
613
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
614 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
615 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
616 (setq f 'list)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
617 @result{} list
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
618 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
619 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
620 (apply f 'x 'y 'z)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
621 @error{} Wrong type argument: listp, z
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
622 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
623 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
624 (apply '+ 1 2 '(3 4))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
625 @result{} 10
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
626 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
627 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
628 (apply '+ '(1 2 3 4))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
629 @result{} 10
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
630 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
631
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
632 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
633 (apply 'append '((a b c) nil (x y z) nil))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
634 @result{} (a b c x y z)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
635 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
636 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
637
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
638 For an interesting example of using @code{apply}, see the description of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
639 @code{mapcar}, in @ref{Mapping Functions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
640 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
641
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
642 @cindex functionals
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
643 It is common for Lisp functions to accept functions as arguments or
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
644 find them in data structures (especially in hook variables and property
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
645 lists) and call them using @code{funcall} or @code{apply}. Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
646 that accept function arguments are often called @dfn{functionals}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
647
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
648 Sometimes, when you call such a function, it is useful to supply a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
649 no-op function as the argument. Here are two different kinds of no-op
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
650 function:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
651
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
652 @defun identity arg
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
653 This function returns @var{arg} and has no side effects.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
654 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
655
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
656 @defun ignore &rest args
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
657 This function ignores any arguments and returns @code{nil}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
658 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
659
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
660 @node Mapping Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
661 @section Mapping Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
662 @cindex mapping functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
663
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
664 A @dfn{mapping function} applies a given function to each element of a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
665 list or other collection. Emacs Lisp has three such functions;
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
666 @code{mapcar} and @code{mapconcat}, which scan a list, are described
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
667 here. For the third mapping function, @code{mapatoms}, see
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
668 @ref{Creating Symbols}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
669
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
670 @defun mapcar function sequence
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
671 @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
672 in turn, and returns a list of the results.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
673
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
674 The argument @var{sequence} may be a list, a vector, or a string. The
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
675 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
676 length of @var{sequence}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
677
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
678 @smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
679 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
680 @exdent @r{For example:}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
681
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
682 (mapcar 'car '((a b) (c d) (e f)))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
683 @result{} (a c e)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
684 (mapcar '1+ [1 2 3])
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
685 @result{} (2 3 4)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
686 (mapcar 'char-to-string "abc")
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
687 @result{} ("a" "b" "c")
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
688 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
689
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
690 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
691 ;; @r{Call each function in @code{my-hooks}.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
692 (mapcar 'funcall my-hooks)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
693 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
694
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
695 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
696 (defun mapcar* (f &rest args)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
697 "Apply FUNCTION to successive cars of all ARGS.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
698 Return the list of results."
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
699 ;; @r{If no list is exhausted,}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
700 (if (not (memq 'nil args))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
701 ;; @r{apply function to @sc{CAR}s.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
702 (cons (apply f (mapcar 'car args))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
703 (apply 'mapcar* f
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
704 ;; @r{Recurse for rest of elements.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
705 (mapcar 'cdr args)))))
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
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
708 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
709 (mapcar* 'cons '(a b c) '(1 2 3 4))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
710 @result{} ((a . 1) (b . 2) (c . 3))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
711 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
712 @end smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
713 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
714
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
715 @defun mapconcat function sequence separator
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
716 @code{mapconcat} applies @var{function} to each element of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
717 @var{sequence}: the results, which must be strings, are concatenated.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
718 Between each pair of result strings, @code{mapconcat} inserts the string
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
719 @var{separator}. Usually @var{separator} contains a space or comma or
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
720 other suitable punctuation.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
721
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
722 The argument @var{function} must be a function that can take one
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
723 argument and return a string.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
724
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
725 @smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
726 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
727 (mapconcat 'symbol-name
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
728 '(The cat in the hat)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
729 " ")
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
730 @result{} "The cat in the hat"
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
731 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
732
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
733 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
734 (mapconcat (function (lambda (x) (format "%c" (1+ x))))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
735 "HAL-8000"
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
736 "")
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
737 @result{} "IBM.9111"
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
738 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
739 @end smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
740 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
741
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
742 @node Anonymous Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
743 @section Anonymous Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
744 @cindex anonymous function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
745
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
746 In Lisp, a function is a list that starts with @code{lambda}, a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
747 byte-code function compiled from such a list, or alternatively a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
748 primitive subr-object; names are ``extra''. Although usually functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
749 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
750 occasionally more concise to use an explicit lambda expression---an
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
751 anonymous function. Such a list is valid wherever a function name is.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
752
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
753 Any method of creating such a list makes a valid function. Even this:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
754
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
755 @smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
756 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
757 (setq silly (append '(lambda (x)) (list (list '+ (* 3 4) 'x))))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
758 @result{} (lambda (x) (+ 12 x))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
759 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
760 @end smallexample
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
761
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
762 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
763 This computes a list that looks like @code{(lambda (x) (+ 12 x))} and
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
764 makes it the value (@emph{not} the function definition!) of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
765 @code{silly}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
766
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
767 Here is how we might call this function:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
768
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
769 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
770 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
771 (funcall silly 1)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
772 @result{} 13
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
773 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
774 @end 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 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
777 (It does @emph{not} work to write @code{(silly 1)}, because this function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
778 is not the @emph{function definition} of @code{silly}. We have not given
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
779 @code{silly} any function definition, just a value as a variable.)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
780
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
781 Most of the time, anonymous functions are constants that appear in
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
782 your program. For example, you might want to pass one as an argument
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
783 to the function @code{mapcar}, which applies any given function to each
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
784 element of a list. Here we pass an anonymous function that multiplies
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
785 a number by two:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
786
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
787 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
788 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
789 (defun double-each (list)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
790 (mapcar '(lambda (x) (* 2 x)) list))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
791 @result{} double-each
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
792 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
793 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
794 (double-each '(2 11))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
795 @result{} (4 22)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
796 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
797 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
798
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
799 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
800 In such cases, we usually use the special form @code{function} instead
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
801 of simple quotation to quote the anonymous function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
802
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
803 @defspec function function-object
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
804 @cindex function quoting
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
805 This special form returns @var{function-object} without evaluating it.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
806 In this, it is equivalent to @code{quote}. However, it serves as a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
807 note to the Emacs Lisp compiler that @var{function-object} is intended
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
808 to be used only as a function, and therefore can safely be compiled.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
809 Contrast this with @code{quote}, in @ref{Quoting}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
810 @end defspec
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
811
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
812 Using @code{function} instead of @code{quote} makes a difference
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
813 inside a function or macro that you are going to compile. For example:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
814
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
815 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
816 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
817 (defun double-each (list)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
818 (mapcar (function (lambda (x) (* 2 x))) list))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
819 @result{} double-each
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
820 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
821 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
822 (double-each '(2 11))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
823 @result{} (4 22)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
824 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
825 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
826
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
827 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
828 If this definition of @code{double-each} is compiled, the anonymous
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
829 function is compiled as well. By contrast, in the previous definition
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
830 where ordinary @code{quote} is used, the argument passed to
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
831 @code{mapcar} is the precise list shown:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
832
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
833 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
834 (lambda (x) (* x 2))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
835 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
836
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
837 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
838 The Lisp compiler cannot assume this list is a function, even though it
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
839 looks like one, since it does not know what @code{mapcar} does with the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
840 list. Perhaps @code{mapcar} will check that the @sc{car} of the third
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
841 element is the symbol @code{*}! The advantage of @code{function} is
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
842 that it tells the compiler to go ahead and compile the constant
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
843 function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
844
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
845 We sometimes write @code{function} instead of @code{quote} when
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
846 quoting the name of a function, but this usage is just a sort of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
847 comment.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
848
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
849 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
850 (function @var{symbol}) @equiv{} (quote @var{symbol}) @equiv{} '@var{symbol}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
851 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
852
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
853 See @code{documentation} in @ref{Accessing Documentation}, for a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
854 realistic example using @code{function} and an anonymous function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
855
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
856 @node Function Cells
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
857 @section Accessing Function Cell Contents
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
858
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
859 The @dfn{function definition} of a symbol is the object stored in the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
860 function cell of the symbol. The functions described here access, test,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
861 and set the function cell of symbols.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
862
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
863 See also the function @code{indirect-function} in @ref{Function
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
864 Indirection}.
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
865
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
866 @defun symbol-function symbol
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
867 @kindex void-function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
868 This returns the object in the function cell of @var{symbol}. If the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
869 symbol's function cell is void, a @code{void-function} error is
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
870 signaled.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
871
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
872 This function does not check that the returned object is a legitimate
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
873 function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
874
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
875 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
876 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
877 (defun bar (n) (+ n 2))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
878 @result{} bar
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
879 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
880 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
881 (symbol-function 'bar)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
882 @result{} (lambda (n) (+ n 2))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
883 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
884 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
885 (fset 'baz 'bar)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
886 @result{} bar
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
887 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
888 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
889 (symbol-function 'baz)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
890 @result{} bar
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
891 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
892 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
893 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
894
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
895 @cindex void function cell
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
896 If you have never given a symbol any function definition, we say that
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
897 that symbol's function cell is @dfn{void}. In other words, the function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
898 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
899 as a function, it signals a @code{void-function} error.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
900
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
901 Note that void is not the same as @code{nil} or the symbol
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
902 @code{void}. The symbols @code{nil} and @code{void} are Lisp objects,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
903 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
904 (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
905 @code{defun}). A void function cell contains no object whatsoever.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
906
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
907 You can test the voidness of a symbol's function definition with
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
908 @code{fboundp}. After you have given a symbol a function definition, you
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
909 can make it void once more using @code{fmakunbound}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
910
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
911 @defun fboundp symbol
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
912 This function returns @code{t} if the symbol has an object in its
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
913 function cell, @code{nil} otherwise. It does not check that the object
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
914 is a legitimate function.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
915 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
916
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
917 @defun fmakunbound symbol
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
918 This function makes @var{symbol}'s function cell void, so that a
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
919 subsequent attempt to access this cell will cause a @code{void-function}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
920 error. (See also @code{makunbound}, in @ref{Local Variables}.)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
921
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
922 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
923 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
924 (defun foo (x) x)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
925 @result{} x
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
926 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
927 @group
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
928 (foo 1)
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
929 @result{}1
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
930 @end group
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
931 @group
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
932 (fmakunbound 'foo)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
933 @result{} x
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
934 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
935 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
936 (foo 1)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
937 @error{} Symbol's function definition is void: foo
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
938 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
939 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
940 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
941
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
942 @defun fset symbol object
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
943 This function stores @var{object} in the function cell of @var{symbol}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
944 The result is @var{object}. Normally @var{object} should be a function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
945 or the name of a function, but this is not checked.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
946
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
947 There are three normal uses of this function:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
948
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
949 @itemize @bullet
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
950 @item
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
951 Copying one symbol's function definition to another. (In other words,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
952 making an alternate name for a function.)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
953
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
954 @item
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
955 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
956 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
957 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
958 @code{s2}; then @code{s1} serves as an alias for whatever definition
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
959 @code{s2} presently has.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
960
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
961 @item
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
962 In constructs for defining or altering functions. If @code{defun}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
963 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
964 @code{fset}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
965 @end itemize
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
966
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
967 Here are examples of the first two uses:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
968
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
969 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
970 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
971 ;; @r{Give @code{first} the same definition @code{car} has.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
972 (fset 'first (symbol-function 'car))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
973 @result{} #<subr car>
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
974 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
975 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
976 (first '(1 2 3))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
977 @result{} 1
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
978 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
979
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
980 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
981 ;; @r{Make the symbol @code{car} the function definition of @code{xfirst}.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
982 (fset 'xfirst 'car)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
983 @result{} car
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
984 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
985 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
986 (xfirst '(1 2 3))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
987 @result{} 1
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
988 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
989 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
990 (symbol-function 'xfirst)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
991 @result{} car
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
992 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
993 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
994 (symbol-function (symbol-function 'xfirst))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
995 @result{} #<subr car>
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
996 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
997
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
998 @group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
999 ;; @r{Define a named keyboard macro.}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1000 (fset 'kill-two-lines "\^u2\^k")
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1001 @result{} "\^u2\^k"
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1002 @end group
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1003 @end example
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
1004
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
1005 See also the related function @code{defalias}, in @ref{Defining
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
1006 Functions}.
6455
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1007 @end defun
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1008
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1009 When writing a function that extends a previously defined function,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1010 the following idiom is often used:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1011
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1012 @example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1013 (fset 'old-foo (symbol-function 'foo))
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1014 (defun foo ()
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1015 "Just like old-foo, except more so."
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 (old-foo)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1018 (more-so))
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 @end example
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1021
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1022 @noindent
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1023 This does not work properly if @code{foo} has been defined to autoload.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1024 In such a case, when @code{foo} calls @code{old-foo}, Lisp attempts
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1025 to define @code{old-foo} by loading a file. Since this presumably
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1026 defines @code{foo} rather than @code{old-foo}, it does not produce the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1027 proper results. The only way to avoid this problem is to make sure the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1028 file is loaded before moving aside the old definition of @code{foo}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1029
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1030 @node Inline Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1031 @section Inline Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1032 @cindex inline functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1033
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1034 @findex defsubst
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1035 You can define an @dfn{inline function} by using @code{defsubst} instead
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1036 of @code{defun}. An inline function works just like an ordinary
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1037 function except for one thing: when you compile a call to the function,
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1038 the function's definition is open-coded into the caller.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1039
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1040 Making a function inline makes explicit calls run faster. But it also
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1041 has disadvantages. For one thing, it reduces flexibility; if you change
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1042 the definition of the function, calls already inlined still use the old
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1043 definition until you recompile them. Since the flexibility of
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1044 redefining functions is an important feature of Emacs, you should not
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1045 make a function inline unless its speed is really crucial.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1046
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1047 Another disadvantage is that making a large function inline can increase
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1048 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
1049 advantage of inline functions is greatest for small functions, you
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1050 generally should not make large functions inline.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1051
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1052 It's possible to define a macro to expand into the same code that an
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1053 inline function would execute. But the macro would have a limitation:
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1054 you can use it only explicitly---a macro cannot be called with
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1055 @code{apply}, @code{mapcar} and so on. Also, it takes some work to
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1056 convert an ordinary function into a macro. (@xref{Macros}.) To convert
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1057 it into an inline function is very easy; simply replace @code{defun}
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1058 with @code{defsubst}. Since each argument of an inline function is
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1059 evaluated exactly once, you needn't worry about how many times the
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1060 body uses the arguments, as you do for macros. (@xref{Argument
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1061 Evaluation}.)
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1062
7193
03103053974d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7115
diff changeset
1063 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
1064 following the definition, just like macros.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1065
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1066 Emacs versions prior to 19 did not have inline functions.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1067
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1068 @node Related Topics
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1069 @section Other Topics Related to Functions
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1070
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1071 Here is a table of several functions that do things related to
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1072 function calling and function definitions. They are documented
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1073 elsewhere, but we provide cross references here.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1074
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1075 @table @code
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1076 @item apply
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1077 See @ref{Calling Functions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1078
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1079 @item autoload
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1080 See @ref{Autoload}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1081
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1082 @item call-interactively
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1083 See @ref{Interactive Call}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1084
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1085 @item commandp
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1086 See @ref{Interactive Call}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1087
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1088 @item documentation
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1089 See @ref{Accessing Documentation}.
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 eval
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1092 See @ref{Eval}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1093
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1094 @item funcall
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1095 See @ref{Calling Functions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1096
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1097 @item ignore
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1098 See @ref{Calling Functions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1099
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1100 @item indirect-function
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1101 See @ref{Function Indirection}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1102
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1103 @item interactive
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1104 See @ref{Using Interactive}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1105
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1106 @item interactive-p
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1107 See @ref{Interactive Call}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1108
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1109 @item mapatoms
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1110 See @ref{Creating Symbols}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1111
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1112 @item mapcar
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1113 See @ref{Mapping Functions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1114
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1115 @item mapconcat
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1116 See @ref{Mapping Functions}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1117
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1118 @item undefined
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1119 See @ref{Key Lookup}.
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1120 @end table
2fc99253fb65 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1121