annotate doc/lispref/functions.texi @ 94409:e0901c47caf2

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