Conflate Qnil and Qunbound for `symbol-function'.
[emacs.git] / doc / lispref / functions.texi
blob05fd2486fd652c245eb0b18c6d0673d8d52612b6
1 @c -*-texinfo-*-
2 @c This is part of the GNU Emacs Lisp Reference Manual.
3 @c Copyright (C) 1990-1995, 1998-1999, 2001-2012
4 @c   Free Software Foundation, Inc.
5 @c See the file elisp.texi for copying conditions.
6 @node Functions
7 @chapter Functions
9   A Lisp program is composed mainly of Lisp functions.  This chapter
10 explains what functions are, how they accept arguments, and how to
11 define them.
13 @menu
14 * What Is a Function::    Lisp functions vs. primitives; terminology.
15 * Lambda Expressions::    How functions are expressed as Lisp objects.
16 * Function Names::        A symbol can serve as the name of a function.
17 * Defining Functions::    Lisp expressions for defining functions.
18 * Calling Functions::     How to use an existing function.
19 * Mapping Functions::     Applying a function to each element of a list, etc.
20 * Anonymous Functions::   Lambda expressions are functions with no names.
21 * Function Cells::        Accessing or setting the function definition
22                             of a symbol.
23 * Closures::              Functions that enclose a lexical environment.
24 * Obsolete Functions::    Declaring functions obsolete.
25 * Inline Functions::      Functions that the compiler will expand inline.
26 * Declare Form::          Adding additional information about a function.
27 * Declaring Functions::   Telling the compiler that a function is defined.
28 * Function Safety::       Determining whether a function is safe to call.
29 * Related Topics::        Cross-references to specific Lisp primitives
30                             that have a special bearing on how functions work.
31 @end menu
33 @node What Is a Function
34 @section What Is a Function?
36 @cindex return value
37 @cindex value of function
38 @cindex argument
39   In a general sense, a function is a rule for carrying out a
40 computation given input values called @dfn{arguments}.  The result of
41 the computation is called the @dfn{value} or @dfn{return value} of the
42 function.  The computation can also have side effects, such as lasting
43 changes in the values of variables or the contents of data structures.
45   In most computer languages, every function has a name.  But in Lisp,
46 a function in the strictest sense has no name: it is an object which
47 can @emph{optionally} be associated with a symbol (e.g.@: @code{car})
48 that serves as the function name.  @xref{Function Names}.  When a
49 function has been given a name, we usually also refer to that symbol
50 as a ``function'' (e.g.@: we refer to ``the function @code{car}'').
51 In this manual, the distinction between a function name and the
52 function object itself is usually unimportant, but we will take note
53 wherever it is relevant.
55   Certain function-like objects, called @dfn{special forms} and
56 @dfn{macros}, also accept arguments to carry out computations.
57 However, as explained below, these are not considered functions in
58 Emacs Lisp.
60   Here are important terms for functions and function-like objects:
62 @table @dfn
63 @item lambda expression
64 A function (in the strict sense, i.e.@: a function object) which is
65 written in Lisp.  These are described in the following section.
66 @ifnottex
67 @xref{Lambda Expressions}.
68 @end ifnottex
70 @item primitive
71 @cindex primitive
72 @cindex subr
73 @cindex built-in function
74 A function which is callable from Lisp but is actually written in C.
75 Primitives are also called @dfn{built-in functions}, or @dfn{subrs}.
76 Examples include functions like @code{car} and @code{append}.  In
77 addition, all special forms (see below) are also considered
78 primitives.
80 Usually, a function is implemented as a primitive because it is a
81 fundamental part of Lisp (e.g.@: @code{car}), or because it provides a
82 low-level interface to operating system services, or because it needs
83 to run fast.  Unlike functions defined in Lisp, primitives can be
84 modified or added only by changing the C sources and recompiling
85 Emacs.  See @ref{Writing Emacs Primitives}.
87 @item special form
88 A primitive that is like a function but does not evaluate all of its
89 arguments in the usual way.  It may evaluate only some of the
90 arguments, or may evaluate them in an unusual order, or several times.
91 Examples include @code{if}, @code{and}, and @code{while}.
92 @xref{Special Forms}.
94 @item macro
95 @cindex macro
96 A construct defined in Lisp, which differs from a function in that it
97 translates a Lisp expression into another expression which is to be
98 evaluated instead of the original expression.  Macros enable Lisp
99 programmers to do the sorts of things that special forms can do.
100 @xref{Macros}.
102 @item command
103 @cindex command
104 An object which can be invoked via the @code{command-execute}
105 primitive, usually due to the user typing in a key sequence
106 @dfn{bound} to that command.  @xref{Interactive Call}.  A command is
107 usually a function; if the function is written in Lisp, it is made
108 into a command by an @code{interactive} form in the function
109 definition (@pxref{Defining Commands}).  Commands that are functions
110 can also be called from Lisp expressions, just like other functions.
112 Keyboard macros (strings and vectors) are commands also, even though
113 they are not functions.  @xref{Keyboard Macros}.  We say that a symbol
114 is a command if its function cell contains a command (@pxref{Symbol
115 Components}); such a @dfn{named command} can be invoked with
116 @kbd{M-x}.
118 @item closure
119 A function object that is much like a lambda expression, except that
120 it also encloses an ``environment'' of lexical variable bindings.
121 @xref{Closures}.
123 @item byte-code function
124 A function that has been compiled by the byte compiler.
125 @xref{Byte-Code Type}.
127 @item autoload object
128 @cindex autoload object
129 A place-holder for a real function.  If the autoload object is called,
130 Emacs loads the file containing the definition of the real function,
131 and then calls the real function.  @xref{Autoload}.
132 @end table
134   You can use the function @code{functionp} to test if an object is a
135 function:
137 @defun functionp object
138 This function returns @code{t} if @var{object} is any kind of
139 function, i.e.@: can be passed to @code{funcall}.  Note that
140 @code{functionp} returns @code{t} for symbols that are function names,
141 and returns @code{nil} for special forms.
142 @end defun
144 @noindent
145 Unlike @code{functionp}, the next three functions do @emph{not} treat
146 a symbol as its function definition.
148 @defun subrp object
149 This function returns @code{t} if @var{object} is a built-in function
150 (i.e., a Lisp primitive).
152 @example
153 @group
154 (subrp 'message)            ; @r{@code{message} is a symbol,}
155      @result{} nil                 ;   @r{not a subr object.}
156 @end group
157 @group
158 (subrp (symbol-function 'message))
159      @result{} t
160 @end group
161 @end example
162 @end defun
164 @defun byte-code-function-p object
165 This function returns @code{t} if @var{object} is a byte-code
166 function.  For example:
168 @example
169 @group
170 (byte-code-function-p (symbol-function 'next-line))
171      @result{} t
172 @end group
173 @end example
174 @end defun
176 @defun subr-arity subr
177 This function provides information about the argument list of a
178 primitive, @var{subr}.  The returned value is a pair
179 @code{(@var{min} . @var{max})}.  @var{min} is the minimum number of
180 args.  @var{max} is the maximum number or the symbol @code{many}, for a
181 function with @code{&rest} arguments, or the symbol @code{unevalled} if
182 @var{subr} is a special form.
183 @end defun
185 @node Lambda Expressions
186 @section Lambda Expressions
187 @cindex lambda expression
189   A lambda expression is a function object written in Lisp.  Here is
190 an example:
192 @example
193 (lambda (x)
194   "Return the hyperbolic cosine of X."
195   (* 0.5 (+ (exp x) (exp (- x)))))
196 @end example
198 @noindent
199 In Emacs Lisp, such a list is valid as an expression---it evaluates to
200 itself.  But its main use is not to be evaluated as an expression, but
201 to be called as a function.
203   A lambda expression, by itself, has no name; it is an @dfn{anonymous
204 function}.  Although lambda expressions can be used this way
205 (@pxref{Anonymous Functions}), they are more commonly associated with
206 symbols to make @dfn{named functions} (@pxref{Function Names}).
207 Before going into these details, the following subsections describe
208 the components of a lambda expression and what they do.
210 @menu
211 * Lambda Components::       The parts of a lambda expression.
212 * Simple Lambda::           A simple example.
213 * Argument List::           Details and special features of argument lists.
214 * Function Documentation::  How to put documentation in a function.
215 @end menu
217 @node Lambda Components
218 @subsection Components of a Lambda Expression
220   A lambda expression is a list that looks like this:
222 @example
223 (lambda (@var{arg-variables}@dots{})
224   [@var{documentation-string}]
225   [@var{interactive-declaration}]
226   @var{body-forms}@dots{})
227 @end example
229 @cindex lambda list
230   The first element of a lambda expression is always the symbol
231 @code{lambda}.  This indicates that the list represents a function.  The
232 reason functions are defined to start with @code{lambda} is so that
233 other lists, intended for other uses, will not accidentally be valid as
234 functions.
236   The second element is a list of symbols---the argument variable names.
237 This is called the @dfn{lambda list}.  When a Lisp function is called,
238 the argument values are matched up against the variables in the lambda
239 list, which are given local bindings with the values provided.
240 @xref{Local Variables}.
242   The documentation string is a Lisp string object placed within the
243 function definition to describe the function for the Emacs help
244 facilities.  @xref{Function Documentation}.
246   The interactive declaration is a list of the form @code{(interactive
247 @var{code-string})}.  This declares how to provide arguments if the
248 function is used interactively.  Functions with this declaration are called
249 @dfn{commands}; they can be called using @kbd{M-x} or bound to a key.
250 Functions not intended to be called in this way should not have interactive
251 declarations.  @xref{Defining Commands}, for how to write an interactive
252 declaration.
254 @cindex body of function
255   The rest of the elements are the @dfn{body} of the function: the Lisp
256 code to do the work of the function (or, as a Lisp programmer would say,
257 ``a list of Lisp forms to evaluate'').  The value returned by the
258 function is the value returned by the last element of the body.
260 @node Simple Lambda
261 @subsection A Simple Lambda Expression Example
263   Consider the following example:
265 @example
266 (lambda (a b c) (+ a b c))
267 @end example
269 @noindent
270 We can call this function by passing it to @code{funcall}, like this:
272 @example
273 @group
274 (funcall (lambda (a b c) (+ a b c))
275          1 2 3)
276 @end group
277 @end example
279 @noindent
280 This call evaluates the body of the lambda expression  with the variable
281 @code{a} bound to 1, @code{b} bound to 2, and @code{c} bound to 3.
282 Evaluation of the body adds these three numbers, producing the result 6;
283 therefore, this call to the function returns the value 6.
285   Note that the arguments can be the results of other function calls, as in
286 this example:
288 @example
289 @group
290 (funcall (lambda (a b c) (+ a b c))
291          1 (* 2 3) (- 5 4))
292 @end group
293 @end example
295 @noindent
296 This evaluates the arguments @code{1}, @code{(* 2 3)}, and @code{(- 5
297 4)} from left to right.  Then it applies the lambda expression to the
298 argument values 1, 6 and 1 to produce the value 8.
300   As these examples show, you can use a form with a lambda expression
301 as its @sc{car} to make local variables and give them values.  In the
302 old days of Lisp, this technique was the only way to bind and
303 initialize local variables.  But nowadays, it is clearer to use the
304 special form @code{let} for this purpose (@pxref{Local Variables}).
305 Lambda expressions are mainly used as anonymous functions for passing
306 as arguments to other functions (@pxref{Anonymous Functions}), or
307 stored as symbol function definitions to produce named functions
308 (@pxref{Function Names}).
310 @node Argument List
311 @subsection Other Features of Argument Lists
312 @kindex wrong-number-of-arguments
313 @cindex argument binding
314 @cindex binding arguments
315 @cindex argument lists, features
317   Our simple sample function, @code{(lambda (a b c) (+ a b c))},
318 specifies three argument variables, so it must be called with three
319 arguments: if you try to call it with only two arguments or four
320 arguments, you get a @code{wrong-number-of-arguments} error.
322   It is often convenient to write a function that allows certain
323 arguments to be omitted.  For example, the function @code{substring}
324 accepts three arguments---a string, the start index and the end
325 index---but the third argument defaults to the @var{length} of the
326 string if you omit it.  It is also convenient for certain functions to
327 accept an indefinite number of arguments, as the functions @code{list}
328 and @code{+} do.
330 @cindex optional arguments
331 @cindex rest arguments
332 @kindex &optional
333 @kindex &rest
334   To specify optional arguments that may be omitted when a function
335 is called, simply include the keyword @code{&optional} before the optional
336 arguments.  To specify a list of zero or more extra arguments, include the
337 keyword @code{&rest} before one final argument.
339   Thus, the complete syntax for an argument list is as follows:
341 @example
342 @group
343 (@var{required-vars}@dots{}
344  @r{[}&optional @var{optional-vars}@dots{}@r{]}
345  @r{[}&rest @var{rest-var}@r{]})
346 @end group
347 @end example
349 @noindent
350 The square brackets indicate that the @code{&optional} and @code{&rest}
351 clauses, and the variables that follow them, are optional.
353   A call to the function requires one actual argument for each of the
354 @var{required-vars}.  There may be actual arguments for zero or more of
355 the @var{optional-vars}, and there cannot be any actual arguments beyond
356 that unless the lambda list uses @code{&rest}.  In that case, there may
357 be any number of extra actual arguments.
359   If actual arguments for the optional and rest variables are omitted,
360 then they always default to @code{nil}.  There is no way for the
361 function to distinguish between an explicit argument of @code{nil} and
362 an omitted argument.  However, the body of the function is free to
363 consider @code{nil} an abbreviation for some other meaningful value.
364 This is what @code{substring} does; @code{nil} as the third argument to
365 @code{substring} means to use the length of the string supplied.
367 @cindex CL note---default optional arg
368 @quotation
369 @b{Common Lisp note:} Common Lisp allows the function to specify what
370 default value to use when an optional argument is omitted; Emacs Lisp
371 always uses @code{nil}.  Emacs Lisp does not support ``supplied-p''
372 variables that tell you whether an argument was explicitly passed.
373 @end quotation
375   For example, an argument list that looks like this:
377 @example
378 (a b &optional c d &rest e)
379 @end example
381 @noindent
382 binds @code{a} and @code{b} to the first two actual arguments, which are
383 required.  If one or two more arguments are provided, @code{c} and
384 @code{d} are bound to them respectively; any arguments after the first
385 four are collected into a list and @code{e} is bound to that list.  If
386 there are only two arguments, @code{c} is @code{nil}; if two or three
387 arguments, @code{d} is @code{nil}; if four arguments or fewer, @code{e}
388 is @code{nil}.
390   There is no way to have required arguments following optional
391 ones---it would not make sense.  To see why this must be so, suppose
392 that @code{c} in the example were optional and @code{d} were required.
393 Suppose three actual arguments are given; which variable would the
394 third argument be for?  Would it be used for the @var{c}, or for
395 @var{d}?  One can argue for both possibilities.  Similarly, it makes
396 no sense to have any more arguments (either required or optional)
397 after a @code{&rest} argument.
399   Here are some examples of argument lists and proper calls:
401 @example
402 (funcall (lambda (n) (1+ n))        ; @r{One required:}
403          1)                         ; @r{requires exactly one argument.}
404      @result{} 2
405 (funcall (lambda (n &optional n1)   ; @r{One required and one optional:}
406            (if n1 (+ n n1) (1+ n))) ; @r{1 or 2 arguments.}
407          1 2)
408      @result{} 3
409 (funcall (lambda (n &rest ns)       ; @r{One required and one rest:}
410            (+ n (apply '+ ns)))     ; @r{1 or more arguments.}
411          1 2 3 4 5)
412      @result{} 15
413 @end example
415 @node Function Documentation
416 @subsection Documentation Strings of Functions
417 @cindex documentation of function
419   A lambda expression may optionally have a @dfn{documentation string}
420 just after the lambda list.  This string does not affect execution of
421 the function; it is a kind of comment, but a systematized comment
422 which actually appears inside the Lisp world and can be used by the
423 Emacs help facilities.  @xref{Documentation}, for how the
424 documentation string is accessed.
426   It is a good idea to provide documentation strings for all the
427 functions in your program, even those that are called only from within
428 your program.  Documentation strings are like comments, except that they
429 are easier to access.
431   The first line of the documentation string should stand on its own,
432 because @code{apropos} displays just this first line.  It should consist
433 of one or two complete sentences that summarize the function's purpose.
435   The start of the documentation string is usually indented in the
436 source file, but since these spaces come before the starting
437 double-quote, they are not part of the string.  Some people make a
438 practice of indenting any additional lines of the string so that the
439 text lines up in the program source.  @emph{That is a mistake.}  The
440 indentation of the following lines is inside the string; what looks
441 nice in the source code will look ugly when displayed by the help
442 commands.
444   You may wonder how the documentation string could be optional, since
445 there are required components of the function that follow it (the body).
446 Since evaluation of a string returns that string, without any side effects,
447 it has no effect if it is not the last form in the body.  Thus, in
448 practice, there is no confusion between the first form of the body and the
449 documentation string; if the only body form is a string then it serves both
450 as the return value and as the documentation.
452   The last line of the documentation string can specify calling
453 conventions different from the actual function arguments.  Write
454 text like this:
456 @example
457 \(fn @var{arglist})
458 @end example
460 @noindent
461 following a blank line, at the beginning of the line, with no newline
462 following it inside the documentation string.  (The @samp{\} is used
463 to avoid confusing the Emacs motion commands.)  The calling convention
464 specified in this way appears in help messages in place of the one
465 derived from the actual arguments of the function.
467   This feature is particularly useful for macro definitions, since the
468 arguments written in a macro definition often do not correspond to the
469 way users think of the parts of the macro call.
471 @node Function Names
472 @section Naming a Function
473 @cindex function definition
474 @cindex named function
475 @cindex function name
477   A symbol can serve as the name of a function.  This happens when the
478 symbol's @dfn{function cell} (@pxref{Symbol Components}) contains a
479 function object (e.g.@: a lambda expression).  Then the symbol itself
480 becomes a valid, callable function, equivalent to the function object
481 in its function cell.
483   The contents of the function cell are also called the symbol's
484 @dfn{function definition}.  The procedure of using a symbol's function
485 definition in place of the symbol is called @dfn{symbol function
486 indirection}; see @ref{Function Indirection}.  If you have not given a
487 symbol a function definition, its function cell is said to be
488 @dfn{void}, and it cannot be used as a function.
490   In practice, nearly all functions have names, and are referred to by
491 their names.  You can create a named Lisp function by defining a
492 lambda expression and putting it in a function cell (@pxref{Function
493 Cells}).  However, it is more common to use the @code{defun} special
494 form, described in the next section.
495 @ifnottex
496 @xref{Defining Functions}.
497 @end ifnottex
499   We give functions names because it is convenient to refer to them by
500 their names in Lisp expressions.  Also, a named Lisp function can
501 easily refer to itself---it can be recursive.  Furthermore, primitives
502 can only be referred to textually by their names, since primitive
503 function objects (@pxref{Primitive Function Type}) have no read
504 syntax.
506   A function need not have a unique name.  A given function object
507 @emph{usually} appears in the function cell of only one symbol, but
508 this is just a convention.  It is easy to store it in several symbols
509 using @code{fset}; then each of the symbols is a valid name for the
510 same function.
512   Note that a symbol used as a function name may also be used as a
513 variable; these two uses of a symbol are independent and do not
514 conflict.  (This is not the case in some dialects of Lisp, like
515 Scheme.)
517 @node Defining Functions
518 @section Defining Functions
519 @cindex defining a function
521   We usually give a name to a function when it is first created.  This
522 is called @dfn{defining a function}, and it is done with the
523 @code{defun} macro.
525 @defmac defun name args [doc] [declare] [interactive] body@dots{}
526 @code{defun} is the usual way to define new Lisp functions.  It
527 defines the symbol @var{name} as a function with argument list
528 @var{args} and body forms given by @var{body}.  Neither @var{name} nor
529 @var{args} should be quoted.
531 @var{doc}, if present, should be a string specifying the function's
532 documentation string (@pxref{Function Documentation}).  @var{declare},
533 if present, should be a @code{declare} form specifying function
534 metadata (@pxref{Declare Form}).  @var{interactive}, if present,
535 should be an @code{interactive} form specifying how the function is to
536 be called interactively (@pxref{Interactive Call}).
538 The return value of @code{defun} is undefined.
540 Here are some examples:
542 @example
543 @group
544 (defun foo () 5)
545 (foo)
546      @result{} 5
547 @end group
549 @group
550 (defun bar (a &optional b &rest c)
551     (list a b c))
552 (bar 1 2 3 4 5)
553      @result{} (1 2 (3 4 5))
554 @end group
555 @group
556 (bar 1)
557      @result{} (1 nil nil)
558 @end group
559 @group
560 (bar)
561 @error{} Wrong number of arguments.
562 @end group
564 @group
565 (defun capitalize-backwards ()
566   "Upcase the last letter of the word at point."
567   (interactive)
568   (backward-word 1)
569   (forward-word 1)
570   (backward-char 1)
571   (capitalize-word 1))
572 @end group
573 @end example
575 Be careful not to redefine existing functions unintentionally.
576 @code{defun} redefines even primitive functions such as @code{car}
577 without any hesitation or notification.  Emacs does not prevent you
578 from doing this, because redefining a function is sometimes done
579 deliberately, and there is no way to distinguish deliberate
580 redefinition from unintentional redefinition.
581 @end defmac
583 @cindex function aliases
584 @defun defalias name definition &optional doc
585 @anchor{Definition of defalias}
586 This function defines the symbol @var{name} as a function, with
587 definition @var{definition} (which can be any valid Lisp function).
588 Its return value is @emph{undefined}.
590 If @var{doc} is non-@code{nil}, it becomes the function documentation
591 of @var{name}.  Otherwise, any documentation provided by
592 @var{definition} is used.
594 The proper place to use @code{defalias} is where a specific function
595 name is being defined---especially where that name appears explicitly in
596 the source file being loaded.  This is because @code{defalias} records
597 which file defined the function, just like @code{defun}
598 (@pxref{Unloading}).
600 By contrast, in programs that manipulate function definitions for other
601 purposes, it is better to use @code{fset}, which does not keep such
602 records.  @xref{Function Cells}.
603 @end defun
605   You cannot create a new primitive function with @code{defun} or
606 @code{defalias}, but you can use them to change the function definition of
607 any symbol, even one such as @code{car} or @code{x-popup-menu} whose
608 normal definition is a primitive.  However, this is risky: for
609 instance, it is next to impossible to redefine @code{car} without
610 breaking Lisp completely.  Redefining an obscure function such as
611 @code{x-popup-menu} is less dangerous, but it still may not work as
612 you expect.  If there are calls to the primitive from C code, they
613 call the primitive's C definition directly, so changing the symbol's
614 definition will have no effect on them.
616   See also @code{defsubst}, which defines a function like @code{defun}
617 and tells the Lisp compiler to perform inline expansion on it.
618 @xref{Inline Functions}.
620 @node Calling Functions
621 @section Calling Functions
622 @cindex function invocation
623 @cindex calling a function
625   Defining functions is only half the battle.  Functions don't do
626 anything until you @dfn{call} them, i.e., tell them to run.  Calling a
627 function is also known as @dfn{invocation}.
629   The most common way of invoking a function is by evaluating a list.
630 For example, evaluating the list @code{(concat "a" "b")} calls the
631 function @code{concat} with arguments @code{"a"} and @code{"b"}.
632 @xref{Evaluation}, for a description of evaluation.
634   When you write a list as an expression in your program, you specify
635 which function to call, and how many arguments to give it, in the text
636 of the program.  Usually that's just what you want.  Occasionally you
637 need to compute at run time which function to call.  To do that, use
638 the function @code{funcall}.  When you also need to determine at run
639 time how many arguments to pass, use @code{apply}.
641 @defun funcall function &rest arguments
642 @code{funcall} calls @var{function} with @var{arguments}, and returns
643 whatever @var{function} returns.
645 Since @code{funcall} is a function, all of its arguments, including
646 @var{function}, are evaluated before @code{funcall} is called.  This
647 means that you can use any expression to obtain the function to be
648 called.  It also means that @code{funcall} does not see the
649 expressions you write for the @var{arguments}, only their values.
650 These values are @emph{not} evaluated a second time in the act of
651 calling @var{function}; the operation of @code{funcall} is like the
652 normal procedure for calling a function, once its arguments have
653 already been evaluated.
655 The argument @var{function} must be either a Lisp function or a
656 primitive function.  Special forms and macros are not allowed, because
657 they make sense only when given the ``unevaluated'' argument
658 expressions.  @code{funcall} cannot provide these because, as we saw
659 above, it never knows them in the first place.
661 @example
662 @group
663 (setq f 'list)
664      @result{} list
665 @end group
666 @group
667 (funcall f 'x 'y 'z)
668      @result{} (x y z)
669 @end group
670 @group
671 (funcall f 'x 'y '(z))
672      @result{} (x y (z))
673 @end group
674 @group
675 (funcall 'and t nil)
676 @error{} Invalid function: #<subr and>
677 @end group
678 @end example
680 Compare these examples with the examples of @code{apply}.
681 @end defun
683 @defun apply function &rest arguments
684 @code{apply} calls @var{function} with @var{arguments}, just like
685 @code{funcall} but with one difference: the last of @var{arguments} is a
686 list of objects, which are passed to @var{function} as separate
687 arguments, rather than a single list.  We say that @code{apply}
688 @dfn{spreads} this list so that each individual element becomes an
689 argument.
691 @code{apply} returns the result of calling @var{function}.  As with
692 @code{funcall}, @var{function} must either be a Lisp function or a
693 primitive function; special forms and macros do not make sense in
694 @code{apply}.
696 @example
697 @group
698 (setq f 'list)
699      @result{} list
700 @end group
701 @group
702 (apply f 'x 'y 'z)
703 @error{} Wrong type argument: listp, z
704 @end group
705 @group
706 (apply '+ 1 2 '(3 4))
707      @result{} 10
708 @end group
709 @group
710 (apply '+ '(1 2 3 4))
711      @result{} 10
712 @end group
714 @group
715 (apply 'append '((a b c) nil (x y z) nil))
716      @result{} (a b c x y z)
717 @end group
718 @end example
720 For an interesting example of using @code{apply}, see @ref{Definition
721 of mapcar}.
722 @end defun
724 @cindex partial application of functions
725 @cindex currying
726   Sometimes it is useful to fix some of the function's arguments at
727 certain values, and leave the rest of arguments for when the function
728 is actually called.  The act of fixing some of the function's
729 arguments is called @dfn{partial application} of the function@footnote{
730 This is related to, but different from @dfn{currying}, which
731 transforms a function that takes multiple arguments in such a way that
732 it can be called as a chain of functions, each one with a single
733 argument.}.
734 The result is a new function that accepts the rest of
735 arguments and calls the original function with all the arguments
736 combined.
738   Here's how to do partial application in Emacs Lisp:
740 @defun apply-partially func &rest args
741 This function returns a new function which, when called, will call
742 @var{func} with the list of arguments composed from @var{args} and
743 additional arguments specified at the time of the call.  If @var{func}
744 accepts @var{n} arguments, then a call to @code{apply-partially} with
745 @w{@code{@var{m} < @var{n}}} arguments will produce a new function of
746 @w{@code{@var{n} - @var{m}}} arguments.
748 Here's how we could define the built-in function @code{1+}, if it
749 didn't exist, using @code{apply-partially} and @code{+}, another
750 built-in function:
752 @example
753 @group
754 (defalias '1+ (apply-partially '+ 1)
755   "Increment argument by one.")
756 @end group
757 @group
758 (1+ 10)
759      @result{} 11
760 @end group
761 @end example
762 @end defun
764 @cindex functionals
765   It is common for Lisp functions to accept functions as arguments or
766 find them in data structures (especially in hook variables and property
767 lists) and call them using @code{funcall} or @code{apply}.  Functions
768 that accept function arguments are often called @dfn{functionals}.
770   Sometimes, when you call a functional, it is useful to supply a no-op
771 function as the argument.  Here are two different kinds of no-op
772 function:
774 @defun identity arg
775 This function returns @var{arg} and has no side effects.
776 @end defun
778 @defun ignore &rest args
779 This function ignores any arguments and returns @code{nil}.
780 @end defun
782   Some functions are user-visible @dfn{commands}, which can be called
783 interactively (usually by a key sequence).  It is possible to invoke
784 such a command exactly as though it was called interactively, by using
785 the @code{call-interactively} function.  @xref{Interactive Call}.
787 @node Mapping Functions
788 @section Mapping Functions
789 @cindex mapping functions
791   A @dfn{mapping function} applies a given function (@emph{not} a
792 special form or macro) to each element of a list or other collection.
793 Emacs Lisp has several such functions; this section describes
794 @code{mapcar}, @code{mapc}, and @code{mapconcat}, which map over a
795 list.  @xref{Definition of mapatoms}, for the function @code{mapatoms}
796 which maps over the symbols in an obarray.  @xref{Definition of
797 maphash}, for the function @code{maphash} which maps over key/value
798 associations in a hash table.
800   These mapping functions do not allow char-tables because a char-table
801 is a sparse array whose nominal range of indices is very large.  To map
802 over a char-table in a way that deals properly with its sparse nature,
803 use the function @code{map-char-table} (@pxref{Char-Tables}).
805 @defun mapcar function sequence
806 @anchor{Definition of mapcar}
807 @code{mapcar} applies @var{function} to each element of @var{sequence}
808 in turn, and returns a list of the results.
810 The argument @var{sequence} can be any kind of sequence except a
811 char-table; that is, a list, a vector, a bool-vector, or a string.  The
812 result is always a list.  The length of the result is the same as the
813 length of @var{sequence}.  For example:
815 @example
816 @group
817 (mapcar 'car '((a b) (c d) (e f)))
818      @result{} (a c e)
819 (mapcar '1+ [1 2 3])
820      @result{} (2 3 4)
821 (mapcar 'string "abc")
822      @result{} ("a" "b" "c")
823 @end group
825 @group
826 ;; @r{Call each function in @code{my-hooks}.}
827 (mapcar 'funcall my-hooks)
828 @end group
830 @group
831 (defun mapcar* (function &rest args)
832   "Apply FUNCTION to successive cars of all ARGS.
833 Return the list of results."
834   ;; @r{If no list is exhausted,}
835   (if (not (memq nil args))
836       ;; @r{apply function to @sc{car}s.}
837       (cons (apply function (mapcar 'car args))
838             (apply 'mapcar* function
839                    ;; @r{Recurse for rest of elements.}
840                    (mapcar 'cdr args)))))
841 @end group
843 @group
844 (mapcar* 'cons '(a b c) '(1 2 3 4))
845      @result{} ((a . 1) (b . 2) (c . 3))
846 @end group
847 @end example
848 @end defun
850 @defun mapc function sequence
851 @code{mapc} is like @code{mapcar} except that @var{function} is used for
852 side-effects only---the values it returns are ignored, not collected
853 into a list.  @code{mapc} always returns @var{sequence}.
854 @end defun
856 @defun mapconcat function sequence separator
857 @code{mapconcat} applies @var{function} to each element of
858 @var{sequence}: the results, which must be strings, are concatenated.
859 Between each pair of result strings, @code{mapconcat} inserts the string
860 @var{separator}.  Usually @var{separator} contains a space or comma or
861 other suitable punctuation.
863 The argument @var{function} must be a function that can take one
864 argument and return a string.  The argument @var{sequence} can be any
865 kind of sequence except a char-table; that is, a list, a vector, a
866 bool-vector, or a string.
868 @example
869 @group
870 (mapconcat 'symbol-name
871            '(The cat in the hat)
872            " ")
873      @result{} "The cat in the hat"
874 @end group
876 @group
877 (mapconcat (function (lambda (x) (format "%c" (1+ x))))
878            "HAL-8000"
879            "")
880      @result{} "IBM.9111"
881 @end group
882 @end example
883 @end defun
885 @node Anonymous Functions
886 @section Anonymous Functions
887 @cindex anonymous function
889   Although functions are usually defined with @code{defun} and given
890 names at the same time, it is sometimes convenient to use an explicit
891 lambda expression---an @dfn{anonymous function}.  Anonymous functions
892 are valid wherever function names are.  They are often assigned as
893 variable values, or as arguments to functions; for instance, you might
894 pass one as the @var{function} argument to @code{mapcar}, which
895 applies that function to each element of a list (@pxref{Mapping
896 Functions}).  @xref{describe-symbols example}, for a realistic example
897 of this.
899   When defining a lambda expression that is to be used as an anonymous
900 function, you can in principle use any method to construct the list.
901 But typically you should use the @code{lambda} macro, or the
902 @code{function} special form, or the @code{#'} read syntax:
904 @defmac lambda args [doc] [interactive] body@dots{}
905 This macro returns an anonymous function with argument list
906 @var{args}, documentation string @var{doc} (if any), interactive spec
907 @var{interactive} (if any), and body forms given by @var{body}.
909 In effect, this macro makes @code{lambda} forms ``self-quoting'':
910 evaluating a form whose @sc{car} is @code{lambda} yields the form
911 itself:
913 @example
914 (lambda (x) (* x x))
915      @result{} (lambda (x) (* x x))
916 @end example
918 The @code{lambda} form has one other effect: it tells the Emacs
919 evaluator and byte-compiler that its argument is a function, by using
920 @code{function} as a subroutine (see below).
921 @end defmac
923 @defspec function function-object
924 @cindex function quoting
925 This special form returns @var{function-object} without evaluating it.
926 In this, it is similar to @code{quote} (@pxref{Quoting}).  But unlike
927 @code{quote}, it also serves as a note to the Emacs evaluator and
928 byte-compiler that @var{function-object} is intended to be used as a
929 function.  Assuming @var{function-object} is a valid lambda
930 expression, this has two effects:
932 @itemize
933 @item
934 When the code is byte-compiled, @var{function-object} is compiled into
935 a byte-code function object (@pxref{Byte Compilation}).
937 @item
938 When lexical binding is enabled, @var{function-object} is converted
939 into a closure.  @xref{Closures}.
940 @end itemize
941 @end defspec
943 @cindex @samp{#'} syntax
944 The read syntax @code{#'} is a short-hand for using @code{function}.
945 The following forms are all equivalent:
947 @example
948 (lambda (x) (* x x))
949 (function (lambda (x) (* x x)))
950 #'(lambda (x) (* x x))
951 @end example
953   In the following example, we define a @code{change-property}
954 function that takes a function as its third argument, followed by a
955 @code{double-property} function that makes use of
956 @code{change-property} by passing it an anonymous function:
958 @example
959 @group
960 (defun change-property (symbol prop function)
961   (let ((value (get symbol prop)))
962     (put symbol prop (funcall function value))))
963 @end group
965 @group
966 (defun double-property (symbol prop)
967   (change-property symbol prop (lambda (x) (* 2 x))))
968 @end group
969 @end example
971 @noindent
972 Note that we do not quote the @code{lambda} form.
974   If you compile the above code, the anonymous function is also
975 compiled.  This would not happen if, say, you had constructed the
976 anonymous function by quoting it as a list:
978 @example
979 @group
980 (defun double-property (symbol prop)
981   (change-property symbol prop (lambda (x) (* 2 x))))
982 @end group
983 @end example
985 @noindent
986 In that case, the anonymous function is kept as a lambda expression in
987 the compiled code.  The byte-compiler cannot assume this list is a
988 function, even though it looks like one, since it does not know that
989 @code{change-property} intends to use it as a function.
991 @node Function Cells
992 @section Accessing Function Cell Contents
994   The @dfn{function definition} of a symbol is the object stored in the
995 function cell of the symbol.  The functions described here access, test,
996 and set the function cell of symbols.
998   See also the function @code{indirect-function}.  @xref{Definition of
999 indirect-function}.
1001 @defun symbol-function symbol
1002 @kindex void-function
1003 This returns the object in the function cell of @var{symbol}.  If the
1004 symbol's function cell is void, a @code{void-function} error is
1005 signaled.
1007 This function does not check that the returned object is a legitimate
1008 function.
1010 @example
1011 @group
1012 (defun bar (n) (+ n 2))
1013 (symbol-function 'bar)
1014      @result{} (lambda (n) (+ n 2))
1015 @end group
1016 @group
1017 (fset 'baz 'bar)
1018      @result{} bar
1019 @end group
1020 @group
1021 (symbol-function 'baz)
1022      @result{} bar
1023 @end group
1024 @end example
1025 @end defun
1027 @cindex void function cell
1028   If you have never given a symbol any function definition, we say that
1029 that symbol's function cell is @dfn{void}.  In other words, the function
1030 cell does not have any Lisp object in it.  If you try to call such a symbol
1031 as a function, it signals a @code{void-function} error.
1033   Note that void is not the same as @code{nil} or the symbol
1034 @code{void}.  The symbols @code{nil} and @code{void} are Lisp objects,
1035 and can be stored into a function cell just as any other object can be
1036 (and they can be valid functions if you define them in turn with
1037 @code{defun}).  A void function cell contains no object whatsoever.
1039   You can test the voidness of a symbol's function definition with
1040 @code{fboundp}.  After you have given a symbol a function definition, you
1041 can make it void once more using @code{fmakunbound}.
1043 @defun fboundp symbol
1044 This function returns @code{t} if the symbol has an object in its
1045 function cell, @code{nil} otherwise.  It does not check that the object
1046 is a legitimate function.
1047 @end defun
1049 @defun fmakunbound symbol
1050 This function makes @var{symbol}'s function cell void, so that a
1051 subsequent attempt to access this cell will cause a
1052 @code{void-function} error.  It returns @var{symbol}.  (See also
1053 @code{makunbound}, in @ref{Void Variables}.)
1055 @example
1056 @group
1057 (defun foo (x) x)
1058 (foo 1)
1059      @result{}1
1060 @end group
1061 @group
1062 (fmakunbound 'foo)
1063      @result{} foo
1064 @end group
1065 @group
1066 (foo 1)
1067 @error{} Symbol's function definition is void: foo
1068 @end group
1069 @end example
1070 @end defun
1072 @defun fset symbol definition
1073 This function stores @var{definition} in the function cell of
1074 @var{symbol}.  The result is @var{definition}.  Normally
1075 @var{definition} should be a function or the name of a function, but
1076 this is not checked.  The argument @var{symbol} is an ordinary evaluated
1077 argument.
1079 The primary use of this function is as a subroutine by constructs that
1080 define or alter functions, like @code{defadvice} (@pxref{Advising
1081 Functions}).  (If @code{defun} were not a primitive, it could be
1082 written as a Lisp macro using @code{fset}.)  You can also use it to
1083 give a symbol a function definition that is not a list, e.g.@: a
1084 keyboard macro (@pxref{Keyboard Macros}):
1086 @example
1087 ;; @r{Define a named keyboard macro.}
1088 (fset 'kill-two-lines "\^u2\^k")
1089      @result{} "\^u2\^k"
1090 @end example
1092 It you wish to use @code{fset} to make an alternate name for a
1093 function, consider using @code{defalias} instead.  @xref{Definition of
1094 defalias}.
1095 @end defun
1097 @node Closures
1098 @section Closures
1100   As explained in @ref{Variable Scoping}, Emacs can optionally enable
1101 lexical binding of variables.  When lexical binding is enabled, any
1102 named function that you create (e.g.@: with @code{defun}), as well as
1103 any anonymous function that you create using the @code{lambda} macro
1104 or the @code{function} special form or the @code{#'} syntax
1105 (@pxref{Anonymous Functions}), is automatically converted into a
1106 @dfn{closure}.
1108 @cindex closure
1109   A closure is a function that also carries a record of the lexical
1110 environment that existed when the function was defined.  When it is
1111 invoked, any lexical variable references within its definition use the
1112 retained lexical environment.  In all other respects, closures behave
1113 much like ordinary functions; in particular, they can be called in the
1114 same way as ordinary functions.
1116   @xref{Lexical Binding}, for an example of using a closure.
1118   Currently, an Emacs Lisp closure object is represented by a list
1119 with the symbol @code{closure} as the first element, a list
1120 representing the lexical environment as the second element, and the
1121 argument list and body forms as the remaining elements:
1123 @example
1124 ;; @r{lexical binding is enabled.}
1125 (lambda (x) (* x x))
1126      @result{} (closure (t) (x) (* x x))
1127 @end example
1129 @noindent
1130 However, the fact that the internal structure of a closure is
1131 ``exposed'' to the rest of the Lisp world is considered an internal
1132 implementation detail.  For this reason, we recommend against directly
1133 examining or altering the structure of closure objects.
1135 @node Obsolete Functions
1136 @section Declaring Functions Obsolete
1138   You can mark a named function as @dfn{obsolete}, meaning that it may
1139 be removed at some point in the future.  This causes Emacs to warn
1140 that the function is obsolete whenever it byte-compiles code
1141 containing that function, and whenever it displays the documentation
1142 for that function.  In all other respects, an obsolete function
1143 behaves like any other function.
1145   The easiest way to mark a function as obsolete is to put a
1146 @code{(declare (obsolete @dots{}))} form in the function's
1147 @code{defun} definition.  @xref{Declare Form}.  Alternatively, you can
1148 use the @code{make-obsolete} function, described below.
1150   A macro (@pxref{Macros}) can also be marked obsolete with
1151 @code{make-obsolete}; this has the same effects as for a function.  An
1152 alias for a function or macro can also be marked as obsolete; this
1153 makes the alias itself obsolete, not the function or macro which it
1154 resolves to.
1156 @defun make-obsolete obsolete-name current-name &optional when
1157 This function marks @var{obsolete-name} as obsolete.
1158 @var{obsolete-name} should be a symbol naming a function or macro, or
1159 an alias for a function or macro.
1161 If @var{current-name} is a symbol, the warning message says to use
1162 @var{current-name} instead of @var{obsolete-name}.  @var{current-name}
1163 does not need to be an alias for @var{obsolete-name}; it can be a
1164 different function with similar functionality.  @var{current-name} can
1165 also be a string, which serves as the warning message.  The message
1166 should begin in lower case, and end with a period.  It can also be
1167 @code{nil}, in which case the warning message provides no additional
1168 details.
1170 If provided, @var{when} should be a string indicating when the function
1171 was first made obsolete---for example, a date or a release number.
1172 @end defun
1174 @defmac define-obsolete-function-alias obsolete-name current-name &optional when doc
1175 This convenience macro marks the function @var{obsolete-name} obsolete
1176 and also defines it as an alias for the function @var{current-name}.
1177 It is equivalent to the following:
1179 @example
1180 (defalias @var{obsolete-name} @var{current-name} @var{doc})
1181 (make-obsolete @var{obsolete-name} @var{current-name} @var{when})
1182 @end example
1183 @end defmac
1185 In addition, you can mark a certain a particular calling convention
1186 for a function as obsolete:
1188 @defun set-advertised-calling-convention function signature when
1189 This function specifies the argument list @var{signature} as the
1190 correct way to call @var{function}.  This causes the Emacs byte
1191 compiler to issue a warning whenever it comes across an Emacs Lisp
1192 program that calls @var{function} any other way (however, it will
1193 still allow the code to be byte compiled).  @var{when} should be a
1194 string indicating when the variable was first made obsolete (usually a
1195 version number string).
1197 For instance, in old versions of Emacs the @code{sit-for} function
1198 accepted three arguments, like this
1200 @example
1201   (sit-for seconds milliseconds nodisp)
1202 @end example
1204 However, calling @code{sit-for} this way is considered obsolete
1205 (@pxref{Waiting}).  The old calling convention is deprecated like
1206 this:
1208 @example
1209 (set-advertised-calling-convention
1210   'sit-for '(seconds &optional nodisp) "22.1")
1211 @end example
1212 @end defun
1214 @node Inline Functions
1215 @section Inline Functions
1216 @cindex inline functions
1218   An @dfn{inline function} is a function that works just like an
1219 ordinary function, except for one thing: when you byte-compile a call
1220 to the function (@pxref{Byte Compilation}), the function's definition
1221 is expanded into the caller.  To define an inline function, use
1222 @code{defsubst} instead of @code{defun}.
1224 @defmac defsubst name args [doc] [declare] [interactive] body@dots{}
1225 This macro defines an inline function.  Its syntax is exactly the same
1226 as @code{defun} (@pxref{Defining Functions}).
1227 @end defmac
1229   Making a function inline often makes its function calls run faster.
1230 But it also has disadvantages.  For one thing, it reduces flexibility;
1231 if you change the definition of the function, calls already inlined
1232 still use the old definition until you recompile them.
1234   Another disadvantage is that making a large function inline can
1235 increase the size of compiled code both in files and in memory.  Since
1236 the speed advantage of inline functions is greatest for small
1237 functions, you generally should not make large functions inline.
1239   Also, inline functions do not behave well with respect to debugging,
1240 tracing, and advising (@pxref{Advising Functions}).  Since ease of
1241 debugging and the flexibility of redefining functions are important
1242 features of Emacs, you should not make a function inline, even if it's
1243 small, unless its speed is really crucial, and you've timed the code
1244 to verify that using @code{defun} actually has performance problems.
1246   It's possible to define a macro to expand into the same code that an
1247 inline function would execute (@pxref{Macros}).  But the macro would
1248 be limited to direct use in expressions---a macro cannot be called
1249 with @code{apply}, @code{mapcar} and so on.  Also, it takes some work
1250 to convert an ordinary function into a macro.  To convert it into an
1251 inline function is easy; just replace @code{defun} with
1252 @code{defsubst}.  Since each argument of an inline function is
1253 evaluated exactly once, you needn't worry about how many times the
1254 body uses the arguments, as you do for macros.
1256   After an inline function is defined, its inline expansion can be
1257 performed later on in the same file, just like macros.
1259 @node Declare Form
1260 @section The @code{declare} Form
1261 @findex declare
1263   @code{declare} is a special macro which can be used to add ``meta''
1264 properties to a function or macro: for example, marking it as
1265 obsolete, or giving its forms a special @key{TAB} indentation
1266 convention in Emacs Lisp mode.
1268 @anchor{Definition of declare}
1269 @defmac declare @var{specs}@dots{}
1270 This macro ignores its arguments and evaluates to @code{nil}; it has
1271 no run-time effect.  However, when a @code{declare} form occurs in the
1272 @var{declare} argument of a @code{defun} or @code{defsubst} function
1273 definition (@pxref{Defining Functions}) or a @code{defmacro} macro
1274 definition (@pxref{Defining Macros}), it appends the properties
1275 specified by @var{specs} to the function or macro.  This work is
1276 specially performed by @code{defun}, @code{defsubst}, and
1277 @code{defmacro}.
1279 Each element in @var{specs} should have the form @code{(@var{property}
1280 @var{args}@dots{})}, which should not be quoted.  These have the
1281 following effects:
1283 @table @code
1284 @item (advertised-calling-convention @var{signature} @var{when})
1285 This acts like a call to @code{set-advertised-calling-convention}
1286 (@pxref{Obsolete Functions}); @var{signature} specifies the correct
1287 argument list for calling the function or macro, and @var{when} should
1288 be a string indicating when the variable was first made obsolete.
1290 @item (debug @var{edebug-form-spec})
1291 This is valid for macros only.  When stepping through the macro with
1292 Edebug, use @var{edebug-form-spec}.  @xref{Instrumenting Macro Calls}.
1294 @item (doc-string @var{n})
1295 Use element number @var{n}, if any, as the documentation string.
1297 @item (indent @var{indent-spec})
1298 Indent calls to this function or macro according to @var{indent-spec}.
1299 This is typically used for macros, though it works for functions too.
1300 @xref{Indenting Macros}.
1302 @item (obsolete @var{current-name} @var{when})
1303 Mark the function or macro as obsolete, similar to a call to
1304 @code{make-obsolete} (@pxref{Obsolete Functions}).  @var{current-name}
1305 should be a symbol (in which case the warning message says to use that
1306 instead), a string (specifying the warning message), or @code{nil} (in
1307 which case the warning message gives no extra details).  @var{when}
1308 should be a string indicating when the function or macro was first
1309 made obsolete.
1310 @end table
1311 @end defmac
1313 @node Declaring Functions
1314 @section Telling the Compiler that a Function is Defined
1315 @cindex function declaration
1316 @cindex declaring functions
1317 @findex declare-function
1319 Byte-compiling a file often produces warnings about functions that the
1320 compiler doesn't know about (@pxref{Compiler Errors}).  Sometimes this
1321 indicates a real problem, but usually the functions in question are
1322 defined in other files which would be loaded if that code is run.  For
1323 example, byte-compiling @file{fortran.el} used to warn:
1325 @example
1326 In end of data:
1327 fortran.el:2152:1:Warning: the function `gud-find-c-expr' is not
1328     known to be defined.
1329 @end example
1331 In fact, @code{gud-find-c-expr} is only used in the function that
1332 Fortran mode uses for the local value of
1333 @code{gud-find-expr-function}, which is a callback from GUD; if it is
1334 called, the GUD functions will be loaded.  When you know that such a
1335 warning does not indicate a real problem, it is good to suppress the
1336 warning.  That makes new warnings which might mean real problems more
1337 visible.  You do that with @code{declare-function}.
1339 All you need to do is add a @code{declare-function} statement before the
1340 first use of the function in question:
1342 @example
1343 (declare-function gud-find-c-expr "gud.el" nil)
1344 @end example
1346 This says that @code{gud-find-c-expr} is defined in @file{gud.el} (the
1347 @samp{.el} can be omitted).  The compiler takes for granted that that file
1348 really defines the function, and does not check.
1350   The optional third argument specifies the argument list of
1351 @code{gud-find-c-expr}.  In this case, it takes no arguments
1352 (@code{nil} is different from not specifying a value).  In other
1353 cases, this might be something like @code{(file &optional overwrite)}.
1354 You don't have to specify the argument list, but if you do the
1355 byte compiler can check that the calls match the declaration.
1357 @defmac declare-function function file &optional arglist fileonly
1358 Tell the byte compiler to assume that @var{function} is defined, with
1359 arguments @var{arglist}, and that the definition should come from the
1360 file @var{file}.  @var{fileonly} non-@code{nil} means only check that
1361 @var{file} exists, not that it actually defines @var{function}.
1362 @end defmac
1364   To verify that these functions really are declared where
1365 @code{declare-function} says they are, use @code{check-declare-file}
1366 to check all @code{declare-function} calls in one source file, or use
1367 @code{check-declare-directory} check all the files in and under a
1368 certain directory.
1370   These commands find the file that ought to contain a function's
1371 definition using @code{locate-library}; if that finds no file, they
1372 expand the definition file name relative to the directory of the file
1373 that contains the @code{declare-function} call.
1375   You can also say that a function is a primitive by specifying a file
1376 name ending in @samp{.c} or @samp{.m}.  This is useful only when you
1377 call a primitive that is defined only on certain systems.  Most
1378 primitives are always defined, so they will never give you a warning.
1380   Sometimes a file will optionally use functions from an external package.
1381 If you prefix the filename in the @code{declare-function} statement with
1382 @samp{ext:}, then it will be checked if it is found, otherwise skipped
1383 without error.
1385   There are some function definitions that @samp{check-declare} does not
1386 understand (e.g. @code{defstruct} and some other macros).  In such cases,
1387 you can pass a non-@code{nil} @var{fileonly} argument to
1388 @code{declare-function}, meaning to only check that the file exists, not
1389 that it actually defines the function.  Note that to do this without
1390 having to specify an argument list, you should set the @var{arglist}
1391 argument to @code{t} (because @code{nil} means an empty argument list, as
1392 opposed to an unspecified one).
1394 @node Function Safety
1395 @section Determining whether a Function is Safe to Call
1396 @cindex function safety
1397 @cindex safety of functions
1399 Some major modes, such as SES, call functions that are stored in user
1400 files.  (@inforef{Top, ,ses}, for more information on SES.)  User
1401 files sometimes have poor pedigrees---you can get a spreadsheet from
1402 someone you've just met, or you can get one through email from someone
1403 you've never met.  So it is risky to call a function whose source code
1404 is stored in a user file until you have determined that it is safe.
1406 @defun unsafep form &optional unsafep-vars
1407 Returns @code{nil} if @var{form} is a @dfn{safe} Lisp expression, or
1408 returns a list that describes why it might be unsafe.  The argument
1409 @var{unsafep-vars} is a list of symbols known to have temporary
1410 bindings at this point; it is mainly used for internal recursive
1411 calls.  The current buffer is an implicit argument, which provides a
1412 list of buffer-local bindings.
1413 @end defun
1415 Being quick and simple, @code{unsafep} does a very light analysis and
1416 rejects many Lisp expressions that are actually safe.  There are no
1417 known cases where @code{unsafep} returns @code{nil} for an unsafe
1418 expression.  However, a ``safe'' Lisp expression can return a string
1419 with a @code{display} property, containing an associated Lisp
1420 expression to be executed after the string is inserted into a buffer.
1421 This associated expression can be a virus.  In order to be safe, you
1422 must delete properties from all strings calculated by user code before
1423 inserting them into buffers.
1425 @ignore
1426 What is a safe Lisp expression?  Basically, it's an expression that
1427 calls only built-in functions with no side effects (or only innocuous
1428 ones).  Innocuous side effects include displaying messages and
1429 altering non-risky buffer-local variables (but not global variables).
1431 @table @dfn
1432 @item Safe expression
1433 @itemize
1434 @item
1435 An atom or quoted thing.
1436 @item
1437 A call to a safe function (see below), if all its arguments are
1438 safe expressions.
1439 @item
1440 One of the special forms @code{and}, @code{catch}, @code{cond},
1441 @code{if}, @code{or}, @code{prog1}, @code{prog2}, @code{progn},
1442 @code{while}, and @code{unwind-protect}], if all its arguments are
1443 safe.
1444 @item
1445 A form that creates temporary bindings (@code{condition-case},
1446 @code{dolist}, @code{dotimes}, @code{lambda}, @code{let}, or
1447 @code{let*}), if all args are safe and the symbols to be bound are not
1448 explicitly risky (see @pxref{File Local Variables}).
1449 @item
1450 An assignment using @code{add-to-list}, @code{setq}, @code{push}, or
1451 @code{pop}, if all args are safe and the symbols to be assigned are
1452 not explicitly risky and they already have temporary or buffer-local
1453 bindings.
1454 @item
1455 One of [apply, mapc, mapcar, mapconcat] if the first argument is a
1456 safe explicit lambda and the other args are safe expressions.
1457 @end itemize
1459 @item Safe function
1460 @itemize
1461 @item
1462 A lambda containing safe expressions.
1463 @item
1464 A symbol on the list @code{safe-functions}, so the user says it's safe.
1465 @item
1466 A symbol with a non-@code{nil} @code{side-effect-free} property.
1467 @item
1468 A symbol with a non-@code{nil} @code{safe-function} property.  The
1469 value @code{t} indicates a function that is safe but has innocuous
1470 side effects.  Other values will someday indicate functions with
1471 classes of side effects that are not always safe.
1472 @end itemize
1474 The @code{side-effect-free} and @code{safe-function} properties are
1475 provided for built-in functions and for low-level functions and macros
1476 defined in @file{subr.el}.  You can assign these properties for the
1477 functions you write.
1478 @end table
1479 @end ignore
1481 @node Related Topics
1482 @section Other Topics Related to Functions
1484   Here is a table of several functions that do things related to
1485 function calling and function definitions.  They are documented
1486 elsewhere, but we provide cross references here.
1488 @table @code
1489 @item apply
1490 See @ref{Calling Functions}.
1492 @item autoload
1493 See @ref{Autoload}.
1495 @item call-interactively
1496 See @ref{Interactive Call}.
1498 @item called-interactively-p
1499 See @ref{Distinguish Interactive}.
1501 @item commandp
1502 See @ref{Interactive Call}.
1504 @item documentation
1505 See @ref{Accessing Documentation}.
1507 @item eval
1508 See @ref{Eval}.
1510 @item funcall
1511 See @ref{Calling Functions}.
1513 @item function
1514 See @ref{Anonymous Functions}.
1516 @item ignore
1517 See @ref{Calling Functions}.
1519 @item indirect-function
1520 See @ref{Function Indirection}.
1522 @item interactive
1523 See @ref{Using Interactive}.
1525 @item interactive-p
1526 See @ref{Distinguish Interactive}.
1528 @item mapatoms
1529 See @ref{Creating Symbols}.
1531 @item mapcar
1532 See @ref{Mapping Functions}.
1534 @item map-char-table
1535 See @ref{Char-Tables}.
1537 @item mapconcat
1538 See @ref{Mapping Functions}.
1540 @item undefined
1541 See @ref{Functions for Key Lookup}.
1542 @end table