Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the agnostic-lizard Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:42:33 2018 GMT+0.
| • Introduction: | What agnostic-lizard is all about | |
| • Systems: | The systems documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
Agnostic Lizard is a portable implementation of a code walker and in particular of the macroexpand-all function (and macro) that makes a best effort to be correct while not expecting much beyond what the Common Lisp standard requires. It aims to be implementation-agnostic and to climb the syntax trees. Alternatives: macroexpand-dammit (only macroexpansion, removes macrolet), hu.dwim.walker (significant implementation-specific code, not all implementation support up to date, removes macrolet), trivial-macroexpand-all (only macroexpansion, maximally implementation-specific but supports a lot of implementations), swank (implementation-specific but supports a lot of implementations, no code walker)
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The agnostic-lizard system: |
Michael Raskin <38a938c2@rambler.ru>
GPLv3+
A portable code walker that makes a best effort to be correct in most cases
agnostic-lizard.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: | ||
| • Other files: |
Next: Other files, Previous: Files, Up: Files [Contents][Index]
Next: The agnostic-lizard/package<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
agnostic-lizard.asd
agnostic-lizard (system)
Next: The agnostic-lizard/utils<dot>lisp file, Previous: The agnostic-lizard<dot>asd file, Up: Lisp files [Contents][Index]
agnostic-lizard (system)
package.lisp
Next: The agnostic-lizard/env-wrappers<dot>lisp file, Previous: The agnostic-lizard/package<dot>lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
agnostic-lizard (system)
utils.lisp
Next: The agnostic-lizard/metaenv<dot>lisp file, Previous: The agnostic-lizard/utils<dot>lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
agnostic-lizard (system)
env-wrappers.lisp
Next: The agnostic-lizard/lexenv<dot>lisp file, Previous: The agnostic-lizard/env-wrappers<dot>lisp file, Up: Lisp files [Contents][Index]
agnostic-lizard (system)
metaenv.lisp
Next: The agnostic-lizard/pure-expansion<dot>lisp file, Previous: The agnostic-lizard/metaenv<dot>lisp file, Up: Lisp files [Contents][Index]
agnostic-lizard (system)
lexenv.lisp
environment-entries-for-name (function)
Next: The agnostic-lizard/special-form-handlers<dot>lisp file, Previous: The agnostic-lizard/lexenv<dot>lisp file, Up: Lisp files [Contents][Index]
agnostic-lizard (system)
pure-expansion.lisp
Next: The agnostic-lizard/generic-walking<dot>lisp file, Previous: The agnostic-lizard/pure-expansion<dot>lisp file, Up: Lisp files [Contents][Index]
agnostic-lizard (system)
special-form-handlers.lisp
Next: The agnostic-lizard/macro-based-walking<dot>lisp file, Previous: The agnostic-lizard/special-form-handlers<dot>lisp file, Up: Lisp files [Contents][Index]
agnostic-lizard (system)
generic-walking.lisp
Next: The agnostic-lizard/local-variables<dot>lisp file, Previous: The agnostic-lizard/generic-walking<dot>lisp file, Up: Lisp files [Contents][Index]
agnostic-lizard (system)
macro-based-walking.lisp
Next: The agnostic-lizard/wrapping-reader<dot>lisp file, Previous: The agnostic-lizard/macro-based-walking<dot>lisp file, Up: Lisp files [Contents][Index]
agnostic-lizard (system)
local-variables.lisp
Previous: The agnostic-lizard/local-variables<dot>lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
agnostic-lizard (system)
wrapping-reader.lisp
Previous: Lisp files, Up: Files [Contents][Index]
| • The agnostic-lizard/readme file: | ||
| • The agnostic-lizard/authors file: | ||
| • The agnostic-lizard/copying file: | ||
| • The agnostic-lizard/gpl-3.0.txt file: | ||
| • The agnostic-lizard/examples.lisp file: |
Next: The agnostic-lizard/authors file, Previous: Other files, Up: Other files [Contents][Index]
agnostic-lizard (system)
README
Next: The agnostic-lizard/copying file, Previous: The agnostic-lizard/readme file, Up: Other files [Contents][Index]
agnostic-lizard (system)
AUTHORS
Next: The agnostic-lizard/gpl-3<dot>0<dot>txt file, Previous: The agnostic-lizard/authors file, Up: Other files [Contents][Index]
agnostic-lizard (system)
COPYING
Next: The agnostic-lizard/examples<dot>lisp file, Previous: The agnostic-lizard/copying file, Up: Other files [Contents][Index]
agnostic-lizard (system)
gpl-3.0.txt
Previous: The agnostic-lizard/gpl-3<dot>0<dot>txt file, Up: Other files [Contents][Index]
agnostic-lizard (system)
examples.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The agnostic-lizard package: | ||
| • The agnostic-lizard-lexenv-wrapper package: |
Next: The agnostic-lizard-lexenv-wrapper package, Previous: Packages, Up: Packages [Contents][Index]
package.lisp (file)
common-lisp
Previous: The agnostic-lizard package, Up: Packages [Contents][Index]
local-variables.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: | ||
| • Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported macros: | ||
| • Exported functions: | ||
| • Exported generic functions: | ||
| • Exported classes: |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
local-variables.lisp (file)
local-variables.lisp (file)
Produce code returning the full macroexpansion of the form in the current lexical environment.
Optionally, run handlers. :on-every-form will be run before quoting and wrapping in environment handling helpers.
macro-based-walking.lisp (file)
Walk the form inside the current lexical environment using the handlers from handler-definitions.
See walk-form for details about handlers.
The resulting form after walking is returned as the macroexpansion.
macro-based-walking.lisp (file)
Walk the form wrapping each expression into saving of the lexical environment
local-variables.lisp (file)
Execute body using a modified readtable so that every top-level form read by the reader is modified using the callback
wrapping-reader.lisp (file)
Modify each top-level form in the rest of the current file with the callback
wrapping-reader.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
Add an entry to the readtable that reads top-level forms normally, then applies the callback to each form
wrapping-reader.lisp (file)
local-variables.lisp (file)
local-variables.lisp (file)
local-variables.lisp (file)
Recursively expand all macro calls in form with initial environment described by env
pure-expansion.lisp (file)
lexenv.lisp (file)
lexenv.lisp (file)
Launch an interactive debugging session
local-variables.lisp (file)
Walk the form inside the environment described by env using the handlers from handler-definitions.
Handlers get a form and a walker-metaenv environment description.
The return value of a handler is used instead of the form passed to the handler during further processing.
Handlers can be:
:on-every-form-pre — called before processing each form in an executable position
:on-macroexpanded-form — called for each form after macroexpanding its top operation; hardwired macros are passed unexpanded
:on-special-form-pre — called before processing a special form or a hardwired macro
:on-function-form-pre — called before processing a function call
:on-special-form — called after processing a special form or a hardwired macro
:on-every-atom — called after processing a form expanded to an atom
:on-function-form — called after processing a function call
:on-every-form — called after expanding each form in an executable position
env can be metaenv or walker-metaenv
generic-walking.lisp (file)
Prepare a special reader for the readtable that reads every top-level form using normal-readtable, then applies the callback to the form
wrapping-reader.lisp (file)
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Query the list of defined blocks from a metaenv object
metaenv.lisp (file)
(setf metaenv-blocks) (generic function)
automatically generated reader method
metaenv-blocks (generic function)
automatically generated writer method
metaenv.lisp (file)
Query the list of function-like entries from a metaenv object
metaenv.lisp (file)
(setf metaenv-function-like-entries) (generic function)
automatically generated reader method
metaenv-function-like-entries (generic function)
automatically generated writer method
metaenv.lisp (file)
Expand all macros on all levels of form in the environment env
pure-expansion.lisp (file)
macro-based-walking.lisp (file)
generic-walking.lisp (file)
Query the list of defined tags from a metaenv object
metaenv.lisp (file)
(setf metaenv-tags) (generic function)
automatically generated reader method
metaenv-tags (generic function)
automatically generated writer method
metaenv.lisp (file)
Query the list of variable-like entries from a metaenv object
metaenv.lisp (file)
(setf metaenv-variable-like-entries) (generic function)
automatically generated reader method
metaenv-variable-like-entries (generic function)
automatically generated writer method
metaenv.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
A version of walker-metaenv that can store additional information for expanding to a form with macro calls.
This approach allows to use Common Lisp implementation’s own handling of environment.
We still keep track of environment just for portable access to the list of discovered lexical environment entries.
metaenv.lisp (file)
walker-metaenv (class)
Whether to do expansion or just create a macro call that will be able to get proper environment
:create-macro
t
metaenv-create-macro (generic function)
(setf metaenv-create-macro) (generic function)
A label to distinguish the forms freshly created in relation to the current environment.
:recursive-label
(gensym)
metaenv-recursive-label (generic function)
(setf metaenv-recursive-label) (generic function)
A handler invoked when macro-walker creates a new macro
:on-macro-walker-create-macro
(quote values)
metaenv-on-macro-walker-create-macro (generic function)
(setf metaenv-on-macro-walker-create-macro) (generic function)
The basic object holding the lexical environment data for macroexpansion
metaenv.lisp (file)
standard-object (class)
walker-metaenv (class)
:fn, :fun, :func, :function-like
metaenv-function-like-entries (generic function)
(setf metaenv-function-like-entries) (generic function)
:var, :variable-like
metaenv-variable-like-entries (generic function)
(setf metaenv-variable-like-entries) (generic function)
:block, :blocks
metaenv-blocks (generic function)
(setf metaenv-blocks) (generic function)
:tag, :tags
metaenv-tags (generic function)
(setf metaenv-tags) (generic function)
A slot for storing environment obtained via an &environment parameter
:env, :fallback-env
metaenv-fallback-env (generic function)
(setf metaenv-fallback-env) (generic function)
A slot storing the policy switch for never passing the fallback env to macroexpand-1
:never-pass-fallback-env
metaenv-never-pass-fallback-env (generic function)
(setf metaenv-never-pass-fallback-env) (generic function)
An extended walker environment object.
Here we keep a few handlers to allow transformations of the code during walking.
metaenv.lisp (file)
metaenv (class)
macro-walker-metaenv (class)
:on-function-form
(function values)
metaenv-on-function-form (generic function)
(setf metaenv-on-function-form) (generic function)
:on-function-form-pre
(function values)
metaenv-on-function-form-pre (generic function)
(setf metaenv-on-function-form-pre) (generic function)
:on-every-atom
(function values)
metaenv-on-every-atom (generic function)
(setf metaenv-on-every-atom) (generic function)
:on-every-form
(function values)
metaenv-on-every-form (generic function)
(setf metaenv-on-every-form) (generic function)
:on-every-form-pre
(function values)
metaenv-on-every-form-pre (generic function)
(setf metaenv-on-every-form-pre) (generic function)
:on-special-form-pre
(function values)
metaenv-on-special-form-pre (generic function)
(setf metaenv-on-special-form-pre) (generic function)
:on-special-form
(function values)
metaenv-on-special-form (generic function)
(setf metaenv-on-special-form) (generic function)
:on-macroexpanded-form
(function values)
metaenv-on-macroexpanded-form (generic function)
(setf metaenv-on-macroexpanded-form) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables: | ||
| • Internal macros: | ||
| • Internal functions: | ||
| • Internal generic functions: |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
The list of hardwired macros; they are code-walked without macroexpansion
pure-expansion.lisp (file)
The current position on the lexenv stack
local-variables.lisp (file)
A stack of saved lexical environments
local-variables.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
special-form-handlers.lisp (file)
Evaluate code in a lexical environment where var is bound to the lexical environment object corresponding to the macro call position
utils.lisp (file)
A helper macro for recapturing environment
macro-based-walking.lisp (file)
This wrapper does nothing but protects form from metaenv-macro-walker-turn-to-quoted
macro-based-walking.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
Create metaenv entries corresponding to environment for name.
Returns a list: variable-like entry, function-like entry.
lexenv.lisp (file)
Wrap a chunk of code with a pseudo-flet;
it is for macroexpansion only, so there is no body
env-wrappers.lisp (file)
utils.lisp (file)
utils.lisp (file)
Wrap a chunk of code with a pseudo-let;
it is for macroexpansion only, so there is no body;
some globals don’t like to ever be bound to nil, so try a global value first
env-wrappers.lisp (file)
Wrap a chunk of code with a macrolet given a literal macrolet definition
env-wrappers.lisp (file)
Wrap a chunk of code with a macrolet defined by a macro-function
env-wrappers.lisp (file)
Check if the metaenv obj is the same as the fallback environment for macroexpand-1
metaenv.lisp (file)
Convert a partially walked form into code producing the expansion of the form after the walk is completed
macro-based-walking.lisp (file)
Perform full macroexpansion of the top level of the form in the environment env
pure-expansion.lisp (file)
Apply metaenv-macroexpand-all to all the forms using the same env
pure-expansion.lisp (file)
Apply metaenv-map-macroexpand-all to all the forms among the entries, but use the declarations as-is
pure-expansion.lisp (file)
Wrap the form into environment-setting wrappers corresponding to all the entries of obj.
metaenv.lisp (file)
Separate a list of entries into declarations and forms, with a possible docstring, if enabled
utils.lisp (file)
Wrap a chunk of code with a symbol-macrolet
env-wrappers.lisp (file)
Evaluate code in the lexical environment where var is bound to the lexical environment object described by obj
metaenv.lisp (file)
Wrap a form to make sure all the blocks listed in entries are defined
env-wrappers.lisp (file)
Wrap a form using the function-like entries.
An entry can be:
(name nil) — not defined in this environment
(name (:plain)) — an flet
(name (:macro macro-function)) — a macrolet, defined by a macro-function
(name (:macro-from environment)) — a macrolet that should be copied from an environment object
(name (:macro-code)) — a macrolet, defined by literal macrolet code
(name (:macro-function-code)) — a macrolet, defined by the code to define the macro-function
env-wrappers.lisp (file)
Wrap a form to make sure all the tags listed in entries are defined
env-wrappers.lisp (file)
Wrap a form using variable-like entries.
An entry can be:
(name nil) — not defined in this environment
(name (:plain)) — a let
(name (:macro expansion)) — a symbol-macro, defined by the expansion
(name (:macro-from environment)) — a symbol-macro to be copied from an environment
env-wrappers.lisp (file)
Previous: Internal functions, Up: Internal definitions [Contents][Index]
Add a block into the metaenv object.
metaenv.lisp (file)
Add a function-like entry into the metaenv object.
The entry should follow the format described in wrap-function-like-env.
The entry will shadow previously available entries with the same name.
metaenv.lisp (file)
Add a tag into the metaenv object.
metaenv.lisp (file)
Add a variable-like entry into the metaenv object.
The entry should follow the format described in wrap-variable-like-env.
The entry will shadow previously available entries with the same name.
metaenv.lisp (file)
Create a copy of a metaenv-related object
metaenv.lisp (file)
The needed initargs for copying a metaenv-related object
metaenv.lisp (file)
Whether to do expansion or just create a macro call that will be able to get proper environment
metaenv.lisp (file)
Expand a lambda expression or a named-lambda expression
special-form-handlers.lisp (file)
Query the fallback environment object from a metaenv object
metaenv.lisp (file)
(setf metaenv-fallback-env) (generic function)
A slot for storing environment obtained via an &environment parameter
metaenv-fallback-env (generic function)
A slot for storing environment obtained via an &environment parameter
metaenv.lisp (file)
Do a single step of macroexpansion on the top level of form in the environment env
pure-expansion.lisp (file)
macro-based-walking.lisp (file)
A handler for dispatching macroexpand-all handling of special forms and some macros
pure-expansion.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
special-form-handlers.lisp (file)
Expand a form that is similar to defun
special-form-handlers.lisp (file)
Expand a form similar to flet
special-form-handlers.lisp (file)
Expand a form similar to function
special-form-handlers.lisp (file)
Expand a form that is similar to let
special-form-handlers.lisp (file)
Expand a form similar to macrolet
special-form-handlers.lisp (file)
Expand a form similar to a funcall or to a progn
special-form-handlers.lisp (file)
Expand a special form similar to the
special-form-handlers.lisp (file)
Macroexpand assignments/default values in entries and destructively add the names to env
special-form-handlers.lisp (file)
Query whether the fallback environment object should never be passed to macroexpand-1
metaenv.lisp (file)
(setf metaenv-never-pass-fallback-env) (generic function)
A slot storing the policy switch for never passing the fallback env to macroexpand-1
metaenv-never-pass-fallback-env (generic function)
A slot storing the policy switch for never passing the fallback env to macroexpand-1
metaenv.lisp (file)
automatically generated reader method
metaenv.lisp (file)
automatically generated writer method
metaenv.lisp (file)
automatically generated reader method
metaenv.lisp (file)
automatically generated writer method
metaenv.lisp (file)
automatically generated reader method
metaenv.lisp (file)
automatically generated writer method
metaenv.lisp (file)
automatically generated reader method
metaenv.lisp (file)
automatically generated writer method
metaenv.lisp (file)
automatically generated reader method
metaenv.lisp (file)
automatically generated writer method
metaenv.lisp (file)
A handler invoked when macro-walker creates a new macro
metaenv.lisp (file)
automatically generated reader method
metaenv.lisp (file)
automatically generated writer method
metaenv.lisp (file)
automatically generated reader method
metaenv.lisp (file)
automatically generated writer method
metaenv.lisp (file)
automatically generated reader method
metaenv.lisp (file)
automatically generated writer method
metaenv.lisp (file)
metaenv.lisp (file)
A label to distinguish the forms freshly created in relation to the current environment.
metaenv.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | A F L O |
|---|
| Jump to: | A F L O |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | (
D E F G I L M P S W |
|---|
| Jump to: | (
D E F G I L M P S W |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
B C F N O R S T V |
|---|
| Jump to: | *
B C F N O R S T V |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | A C M P S W |
|---|
| Jump to: | A C M P S W |
|---|