The introspect-environment Reference Manual

This is the introspect-environment Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:46:56 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 introspect-environment

Small interface to portable but nonstandard introspection of CL environments.

Author

Bike <>

License

WTFPL

Version

0.1

Dependency

sb-cltl2 (system).

Source

introspect-environment.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 introspect-environment/introspect-environment.asd

Source

introspect-environment.asd.

Parent Component

introspect-environment (system).

ASDF Systems

introspect-environment.


3.1.2 introspect-environment/package.lisp

Source

introspect-environment.asd.

Parent Component

introspect-environment (system).

Packages

introspect-environment.


3.1.3 introspect-environment/expander.lisp

Dependency

package.lisp (file).

Source

introspect-environment.asd.

Parent Component

introspect-environment (system).

Public Interface
Internals

valid-function-name-p (function).


3.1.4 introspect-environment/sbcl.lisp

Dependency

expander.lisp (file).

Source

introspect-environment.asd.

Parent Component

introspect-environment (system).

Public Interface

3.1.5 introspect-environment/doc.lisp

Dependency

sbcl.lisp (file).

Source

introspect-environment.asd.

Parent Component

introspect-environment (system).

Internals

defdoc (macro).


4 Packages

Packages are listed by definition order.


4.1 introspect-environment

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Macros

Macro: policy (expr &optional env)

Evaluate EXPR in an environment in which all optimization qualities (e.g. COMPILATION-SPEED) refer to their known values in ENV if possible.

For instance, (locally (optimize (speed 3) (space 0)) (policy (> speed space) env)) will evaluate to true (if supported).

Package

introspect-environment.

Source

sbcl.lisp.


5.1.2 Ordinary functions

Function: compiler-macroexpand (form &optional env)

As MACROEXPAND, but uses compiler macros rather than macros. (as a consequence of this, forms like (FUNCALL (FUNCTION FOO) ...) may be expanded with FOO’s compiler macro.)

Package

introspect-environment.

Source

expander.lisp.

Function: compiler-macroexpand-1 (form &optional env)

As MACROEXPAND-1, but uses compiler macros rather than macros. (as a consequence of this, forms like (FUNCALL (FUNCTION FOO) ...) may be expanded with FOO’s compiler macro.)

Package

introspect-environment.

Source

expander.lisp.

Function: function-type (name &optional env)

Return a known supertype of the function named NAME in ENV.

Package

introspect-environment.

Source

sbcl.lisp.

Function: parse-compiler-macro (name lambda-list body &optional env)

Like PARSE-MACRO, but the lambda expression is suited for use as a compiler macro. Meaning it’s the same, except that if it’s provided a form beginning with FUNCALL to expand it will still destructure its arguments appropriately.

Package

introspect-environment.

Source

sbcl.lisp.

Function: policy-quality (quality &optional env)

Return the value of QUALITY, an optimization quality (e.g. COMPILATION-SPEED) in ENV, if possible.

Package

introspect-environment.

Source

sbcl.lisp.

Function: specialp (name &optional env)
Package

introspect-environment.

Source

sbcl.lisp.

Function: variable-type (name &optional env)

Return a known supertype of NAME, a variable, in ENV.

Package

introspect-environment.

Source

sbcl.lisp.


5.2 Internals


5.2.1 Macros

Macro: defdoc (slot-name doc-type doc)
Package

introspect-environment.

Source

doc.lisp.


5.2.2 Ordinary functions

Function: valid-function-name-p (thing)
Package

introspect-environment.

Source

expander.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables