function-information

function-information Function

Summary

Return information about the function bindings of a symbol in an environment.

Package

hcl

Signature

function-information function-name &optional env => kind, localp, decls

Arguments

`function-name`⇩	A function name.
`env`⇩	An environment or `nil`.

Values

`kind`⇩	Either `nil`, or one of the keywords `:macro`, `:function` and `:special-form`.
`localp`⇩	A boolean.
`decls`⇩	An a-list.

Description

The function function-information returns information about how function-name is bound in the environment env. function-name can be a symbol or setf function name.

The value of kind will be as follows:

`nil`	There is no information about `function-name` in `env`.
`:macro`	`function-name` has a macro binding in `env`.
`:function`	`function-name` has a function binding in `env`.
`:special-form`	`function-name` has a special operator binding in `env`.

localp will be true if function-name is bound by a form that has indefinite scope (for example flet) or false if function-name has global scope (for example defun).

decls is an a-list of declarations that refer to function-name. The cdr of each pair is specified according to the car of the pair as follows:

dynamic-extent	The cdr is non-nil if `function-name` is declared dynamic-extent in `env`.
inline	The cdr is inline or notinline if `function-name` is explicitly declared inline or notinline in `env`. The cdr is `nil` (or the pair is omitted) if this information is not known.
ftype	The cdr is the type specifier that is declared for `function-name` in `env` if any.

Notes

Not all of these declarations are supported.
function-information is part of the environment access API which is based on that specified in Common Lisp: the Language (2nd Edition).