summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Raskin <38a938c2@rambler.ru>2017-01-28 00:31:20 +0100
committerMichael Raskin <38a938c2@rambler.ru>2017-01-28 00:31:20 +0100
commit2bab61b73fc39d09a5f6a72fc8ac2ef871240f34 (patch)
tree7619cb75bebffe91581fa4deb050a6249f256ede
Syncing from Monotone at 20170128-003120. Last commit message was Change locvar/locfunc to macro for convenience
-rw-r--r--AUTHORS1
-rw-r--r--COPYING11
-rw-r--r--README6
-rw-r--r--agnostic-lizard.asd29
-rw-r--r--env-wrappers.lisp109
-rw-r--r--examples.lisp262
-rw-r--r--generic-walking.lisp61
-rw-r--r--gpl-3.0.txt674
-rw-r--r--local-variables.lisp87
-rw-r--r--metaenv.lisp308
-rw-r--r--package.lisp19
-rw-r--r--pure-expansion.lisp119
-rw-r--r--special-form-handlers.lisp308
-rw-r--r--test-iterate.lisp8
-rw-r--r--test-macroexpand-dammit.lisp10
-rw-r--r--utils.lisp39
16 files changed, 2051 insertions, 0 deletions
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..54ebee6
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1 @@
+Michael Raskin
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..6d6bfbb
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,11 @@
+This debugging tool is copyright by AUTHORS and can be distributed, at your
+option, under terms of:
+
+- GPLv3 or a later version as published by Free Software Foundation
+
+GPLv3 is attached in gpl-3.0.txt.
+
+If you have a specific open-source project that would benefit from availability
+of the present package under a more permissive license, please contact
+the authors.
+
diff --git a/README b/README
new file mode 100644
index 0000000..a5d9852
--- /dev/null
+++ b/README
@@ -0,0 +1,6 @@
+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.
diff --git a/agnostic-lizard.asd b/agnostic-lizard.asd
new file mode 100644
index 0000000..0194f8f
--- /dev/null
+++ b/agnostic-lizard.asd
@@ -0,0 +1,29 @@
+(asdf:defsystem
+ ; The Lizard climbs and crawls the syntax tree, and it is
+ ; implementation-agnostic
+ :agnostic-lizard
+
+ ; It is still a bit of a proof of concept — if there is an established
+ ; opensource project that would benefit from shipping agnostic-lizard
+ ; as opposed to using it as a debugging tool, adding more license options
+ ; will be considered
+ :licence "GPLv3+"
+
+ :description
+ "A portable code walker that makes a best effort to be correct in most cases"
+
+ :components
+ ((:static-file "README")
+ (:static-file "AUTHORS")
+ (:static-file "COPYING")
+ (:static-file "gpl-3.0.txt")
+ (:static-file "examples.lisp")
+ (:file "package")
+ (:file "utils" :depends-on ("package"))
+ (:file "env-wrappers" :depends-on ("package"))
+ (:file "metaenv" :depends-on ("package" "env-wrappers" "utils"))
+ (:file "pure-expansion" :depends-on ("package" "utils" "metaenv"))
+ (:file "special-form-handlers" :depends-on ("package" "utils" "metaenv" "pure-expansion"))
+ (:file "generic-walking" :depends-on ("package" "utils" "metaenv" "pure-expansion"))
+ (:file "local-variables" :depends-on ("package" "metaenv" "generic-walking"))))
+
diff --git a/env-wrappers.lisp b/env-wrappers.lisp
new file mode 100644
index 0000000..50341c7
--- /dev/null
+++ b/env-wrappers.lisp
@@ -0,0 +1,109 @@
+(in-package :agnostic-lizard)
+
+; Simple helpers to wrap a chunk of code
+
+(defun macrolet-wrap (name function body)
+ "Wrap a chunk of code with a macrolet defined by a macro-function"
+ `(macrolet
+ ((,name (&whole whole &rest args &environment environment)
+ (declare (ignorable args))
+ (funcall ,function whole environment)))
+ ,@ body))
+
+(defun macrolet-code-wrap (name code body)
+ "Wrap a chunk of code with a macrolet given a literal macrolet definition"
+ `(macrolet
+ ((,name ,@code))
+ ,@ body))
+
+(defun symbol-macrolet-wrap (name expansion body)
+ "Wrap a chunk of code with a symbol-macrolet"
+ `(symbol-macrolet ((,name ,expansion)) ,@body))
+
+(defun flet-wrap (name body)
+ "Wrap a chunk of code with a pseudo-flet;
+it is for macroexpansion only, so there is no body"
+ `(flet ((,name (&rest args) (declare (ignorable args)) nil))
+ ,@ body))
+
+(defun let-wrap (name body)
+ "Wrap a chunk of code with a pseudo-let;
+it is for macroexpansion only, so there is no body"
+ `(let ((,name nil)) (declare (ignorable ,name)) ,@body))
+
+; Wrappers with multiple names to define
+
+(defun wrap-function-like-env (entries form)
+ "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
+"
+ (loop
+ for res := form then new-res
+ for entry in entries
+ for name := (first entry)
+ for op := (second entry)
+ for kind := (first op)
+ for new-res := (ecase kind
+ ((nil) res)
+ ((:plain) (flet-wrap name (list res)))
+ ((:macro) (macrolet-wrap name (second op) (list res)))
+ ((:macro-from)
+ (macrolet-wrap
+ name (macro-function name (second op)) (list res)))
+ ((:macro-code)
+ (macrolet-code-wrap name (cdr op) (list res)))
+ ((:macro-function-code)
+ (macrolet-wrap name `(lambda ,@ (cdr op)) (list res)))
+ )
+ finally (return res)))
+
+(defun wrap-variable-like-env (entries form)
+ "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
+"
+ (loop
+ for res := form then new-res
+ for entry in entries
+ for name := (first entry)
+ for op := (second entry)
+ for kind := (first op)
+ for new-res := (ecase kind
+ ((nil) res)
+ ((:plain) (let-wrap name (list res)))
+ ((:macro) (symbol-macrolet-wrap name (second op) (list res)))
+ ((:macro-from)
+ (symbol-macrolet-wrap
+ name (macroexpand-1 name (second op)) (list res)))
+ )
+ finally (return res)))
+
+(defun wrap-block-env (entries form)
+ "Wrap a form to make sure all the blocks listed in entries are defined"
+ (loop
+ for res := form then new-res
+ for entry in entries
+ for new-res := `(block ,entry ,res)
+ finally (return res)))
+
+(defun wrap-tag-env (entries form)
+ "Wrap a form to make sure all the tags listed in entries are defined"
+ (if entries
+ (let
+ ((s (gensym)))
+ `(catch
+ ',s
+ (tagbody
+ ,@ entries
+ (throw ',s ,form))))
+ form))
+
diff --git a/examples.lisp b/examples.lisp
new file mode 100644
index 0000000..e26e30b
--- /dev/null
+++ b/examples.lisp
@@ -0,0 +1,262 @@
+; (require :agnostic-lizard)
+(asdf:load-system :agnostic-lizard)
+; (use-package :agnostic-lizard)
+
+(defpackage :agnostic-lizard-tests
+ (:use :common-lisp :agnostic-lizard))
+(in-package :agnostic-lizard-tests)
+
+; different kind of expand can be defined
+
+(defmacro expand-f (form &environment e) `(macroexpand-all ',form ',e))
+(defmacro expand-m (form) `(macro-macroexpand-all ,form))
+(defmacro to-expanded (form) `(macro-walk-form ,form))
+
+(defvar *default-verbose* nil
+ "Whether verbose debugging output has to be printed")
+
+(defmacro check-eval-form (form &key (verbose *default-verbose*))
+ "Generate code checking correctness of expanding a form that can be eval-ed.
+This means that the correct expansion of the form may not depend on any lexical
+variable/function bindings (macros are OK).
+Correctness is defined just as returning the same value.
+"
+ `(let*
+ ((form-fe (expand-f ,form))
+ (form-me (expand-m ,form))
+ (value-oe ,form)
+ (value-fe (eval form-fe))
+ (value-me (eval form-me)))
+ (if
+ (and
+ (equal value-oe value-fe)
+ (equal value-oe value-me))
+ ,(when verbose
+ `(format *trace-output* "Checking form in eval OK:~{~%~S~}~%----~%"
+ (list ',form form-fe form-me value-oe)))
+ (progn
+ (format
+ *error-output*
+ (concatenate
+ 'string
+ "Mismatch when checking form:~%~s~%"
+ "Functional expansion:~%~S~%Macro-assisted expansion:~%~S~%"
+ "Original form value:~%~S~%"
+ "Functional expansion value: ~a~%~S~%"
+ "Macro-assisted expansion value: ~a~%~S~%")
+ ',form form-fe form-me value-oe
+ (if (equal value-oe value-fe) "OK" "!!") value-fe
+ (if (equal value-oe value-me) "OK" "!!") value-me)
+ (throw :eval-check-failed "Form expansion changed behaviour")))))
+
+(defmacro check-lexenv-form (form &key (verbose *default-verbose*))
+ "Generate code checking correctness of expanding a form that does use the
+lexical bindings of variables or functions."
+ `(progn
+ ,(when verbose
+ `(format *trace-output* "Checking form in lexenv:~%~S~%~S~%~S~%----~%"
+ ',form (expand-m ,form) ,form))
+ (unless
+ (equal ,form (to-expanded ,form))
+ (throw :lexenv-check-fail "Form expansion changed behaviour"))))
+
+(defmacro full-check-form (form &key (verbose *default-verbose*))
+ "Generate code for both possible kinds of checks on a form."
+ `(progn
+ (check-eval-form ,form :verbose ,verbose)
+ (check-lexenv-form ,form :verbose ,verbose)))
+
+; Basic "making sense" checks
+(full-check-form 1)
+(full-check-form (let ((x 1)) x))
+(macrolet ((f () 1)) (full-check-form (f)))
+(macrolet ((f () 1)) (full-check-form (flet ((f () 2)) (f))))
+(full-check-form (list 2 2 (quote a)))
+(let ((x 1)) (check-lexenv-form (list x)))
+
+; A show-off of passing data through macrolet
+
+(defmacro depth-limited-macro (n-max on-failure &body body &environment env)
+ (let*
+ ((depth-value
+ (macroexpand-1
+ '(depth-counter-virtual-macro) env))
+ (depth (if (numberp depth-value) depth-value 0)))
+ (if
+ (> depth n-max)
+ ; Maximum macro depth reached
+ on-failure
+ (progn
+ `(macrolet
+ ((depth-counter-virtual-macro () ,(1+ depth)))
+ ,@body)))))
+
+(full-check-form
+ (depth-limited-macro
+ 2
+ (depth-limited-macro
+ 1
+ (depth-limited-macro 1 :max-depth :test))))
+
+(full-check-form
+ (depth-limited-macro
+ 2 :max-depth
+ (depth-limited-macro
+ 1 :max-depth
+ (depth-limited-macro 2 :max-depth :test))))
+
+(depth-limited-macro
+ 2 :max-depth
+ (depth-limited-macro
+ 1 :max-depth
+ (full-check-form
+ (depth-limited-macro 1 :max-depth :test))))
+
+(depth-limited-macro
+ 2 :max-depth
+ (depth-limited-macro
+ 1 :max-depth
+ (full-check-form
+ (depth-limited-macro 2 :max-depth :test))))
+
+(defmacro circular-depth-limited-macro ()
+ #1=(depth-limited-macro 100 :max-depth #1#))
+
+(full-check-form
+ (circular-depth-limited-macro)
+ ; printing the form is impossible
+ :verbose nil)
+
+(full-check-form (depth-limited-macro 2 nil (depth-limited-macro 3 nil (depth-counter-virtual-macro))))
+(depth-limited-macro 2 nil (depth-limited-macro 3 nil (full-check-form (depth-counter-virtual-macro))))
+(depth-limited-macro 2 nil (full-check-form (depth-limited-macro 3 nil (depth-counter-virtual-macro))))
+
+; New macroexpand-dammit fails on that
+(defmacro test-macro-just-one () 1)
+(full-check-form '(flet ((test-macro-just-one () 2)) (test-macro-just-one)))
+
+; Both old and new macroexpand-dammit fail here
+(full-check-form (macrolet ((test-macro-just-one () 2)) (macrolet () (test-macro-just-one))))
+(macrolet ((test-macro-just-one () 2)) (full-check-form (macrolet () (test-macro-just-one))))
+(macrolet ((test-macro-just-one () 2)) (macrolet () (full-check-form (test-macro-just-one))))
+
+; Parameters shadowing symbol-macros in flet
+(full-check-form
+ (symbol-macrolet
+ ((x 1))
+ (macrolet
+ ((f (x) `(+ ,x 2))
+ (g (x) `(+ ,x 3)))
+ (flet
+ ((f (x) (+ x 4))
+ (g (y) (f (+ x y 5))))
+ (g 77)))))
+(symbol-macrolet
+ ((x 1))
+ (full-check-form
+ (macrolet
+ ((f (x) `(+ ,x 2))
+ (g (x) `(+ ,x 3)))
+ (flet
+ ((f (x) (+ x 4))
+ (g (y) (f (+ x y 5))))
+ (g 77)))))
+(symbol-macrolet
+ ((x 1))
+ (macrolet
+ ((f (x) `(+ ,x 2))
+ (g (x) `(+ ,x 3)))
+ (full-check-form
+ (flet
+ ((f (x) (+ x 4))
+ (g (y) (f (+ x y 5))))
+ (g 77)))))
+(symbol-macrolet
+ ((x 1))
+ (macrolet
+ ((f (x) `(+ ,x 2))
+ (g (x) `(+ ,x 3)))
+ (flet
+ ((f (x) (+ x 4))
+ (g (y) (f (+ x y 5))))
+ (check-lexenv-form
+ (g 77)))))
+
+; the latest fork of macroexpand-dammit had a problem with that
+(full-check-form (funcall (lambda (x) x) :test))
+(full-check-form (defun just-a-test-function (x) x))
+
+; a silly set of macrolet tests
+(full-check-form
+ (macrolet ((ff (x) `(list ',x ',x)))
+ (macrolet
+ ((gg (y) `(ff ,y)))
+ (gg (1 2)))))
+(macrolet ((ff (x) `(list ',x ',x)))
+ (full-check-form
+ (macrolet
+ ((gg (y) `(ff ,y)))
+ (gg (1 2)))))
+(macrolet ((ff (x) `(list ',x ',x)))
+ (macrolet
+ ((gg (y) `(ff ,y)))
+ (full-check-form
+ (gg (1 2)))))
+
+(full-check-form
+ (macrolet ((ff (x) `(list ',x ',x)))
+ (macrolet
+ ((gg (y) `(ff ,y)))
+ (gg 3))))
+(macrolet ((ff (x) `(list ',x ',x)))
+ (full-check-form
+ (macrolet
+ ((gg (y) `(ff ,y)))
+ (gg 3))))
+(macrolet ((ff (x) `(list ',x ',x)))
+ (macrolet
+ ((gg (y) `(ff ,y)))
+ (full-check-form
+ (gg 3))))
+
+(full-check-form
+ (loop for j from 1 to 3 collect j))
+
+(full-check-form
+ (progn
+ (defun test-loop-function
+ (x y) (loop for j from 1 to 3 collect (+ x y j 1)))
+ (test-loop-function 12 36)))
+
+; quasi-unit-tests
+(full-check-form (block nil 1))
+(full-check-form (block nil (return 2) 1))
+
+(full-check-form '(1 2))
+
+(full-check-form (funcall (symbol-macrolet ((x y)) (lambda (x) (+ x 1))) 1))
+
+(macrolet
+ ((f (x) `(list ,x 1)))
+ (full-check-form (f (f 2))))
+(full-check-form
+ (macrolet
+ ((f (x) `(list ,x 1)))
+ (f (f 2))))
+
+;Tests from hu.dwim.walker
+(full-check-form
+ (macrolet ((++ (&body body)
+ (reverse body)))
+ (++ 1 2 3 -)))
+(macrolet ((++ (&body body)
+ (reverse body)))
+ (full-check-form
+ (++ 1 2 3 -)))
+
+(full-check-form
+ (let ((obj (make-instance 'metaenv)))
+ (with-slots ((x agnostic-lizard::fallback-env)) obj
+ x)))
+
+(format *error-output* "Example run complete.~%")
diff --git a/generic-walking.lisp b/generic-walking.lisp
new file mode 100644
index 0000000..11487cc
--- /dev/null
+++ b/generic-walking.lisp
@@ -0,0 +1,61 @@
+(in-package :agnostic-lizard)
+
+(defmethod metaenv-macroexpand-all (form (env walker-metaenv))
+ (let*
+ ((replacement (funcall (metaenv-on-every-form-pre env) form env))
+ (hardwiring-needed-p
+ (and (consp replacement)
+ (find (first replacement) *hardwired-operators*)))
+ (expanded-raw (if hardwiring-needed-p replacement
+ (metaenv-macroexpand replacement env)))
+ (expanded (funcall (metaenv-on-macroexpanded-form env) expanded-raw env))
+ (function-like-p (and expanded (consp expanded)))
+ (operator (and function-like-p (first expanded)))
+ ; If the operator has a dual macro/special-operator implementation,
+ ; it is already macroexpanded by that point.
+ (specialp (special-operator-p operator))
+ (function-replacement
+ (if (or specialp hardwiring-needed-p)
+ (funcall (metaenv-on-special-form-pre env) expanded env)
+ (funcall (metaenv-on-function-form-pre env) expanded env)))
+ (full-expansion
+ (cond
+ ((not function-like-p) expanded)
+ (specialp (metaenv-macroexpand-all-special-form
+ operator function-replacement env))
+ ; Default handler works fine for both progn and function call forms,
+ ; we define the same handler once more for progn just for the sake of
+ ; explicitness
+ (t (metaenv-macroexpand-all-special-form
+ operator function-replacement env))))
+ (full-expansion-replacement
+ (if (and function-like-p (not specialp))
+ (funcall (metaenv-on-function-form env) full-expansion env)
+ (funcall (metaenv-on-special-form env) full-expansion env)))
+ (result (funcall (metaenv-on-every-form env) full-expansion-replacement env)))
+ result))
+
+(defun walk-form (form env &rest handler-definitions)
+ "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-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
+"
+ (metaenv-macroexpand-all
+ form
+ (apply
+ 'make-instance 'walker-metaenv
+ (append
+ handler-definitions
+ (when (subtypep 'walker-metaenv (type-of env))
+ (metaenv-clone-args env))))))
diff --git a/gpl-3.0.txt b/gpl-3.0.txt
new file mode 100644
index 0000000..94a9ed0
--- /dev/null
+++ b/gpl-3.0.txt
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/local-variables.lisp b/local-variables.lisp
new file mode 100644
index 0000000..a307744
--- /dev/null
+++ b/local-variables.lisp
@@ -0,0 +1,87 @@
+(defpackage
+ :agnostic-lizard-lexenv-wrapper
+ (:use :agnostic-lizard :common-lisp)
+ (:export
+ #:pry
+ #:with-saved-lexenvs
+ #:list-locvars
+ #:list-locfuncs
+ #:locvar
+ #:locfunc
+ #:lexenv-cursor))
+(in-package :agnostic-lizard-lexenv-wrapper)
+
+(defvar *saved-lexenvs* nil
+ "A stack of saved lexical environments")
+(defvar *saved-lexenv-cursor* 0
+ "The current position on the lexenv stack")
+
+(defun pry (&key reason)
+ "Launch an interactive debugging session"
+ (cerror "Exit PRY session and continue execution"
+ (or reason "Lightweight PRY session invoked")))
+
+(defmacro with-saved-lexenvs (form)
+ "Walk the form wrapping each expression into saving of the lexical environment"
+ `(macro-walk-form
+ ,form
+ :on-every-form
+ (lambda (f e)
+ `(let* ((*saved-lexenvs*
+ (cons
+ (list
+ :functions
+ (list
+ ,@
+ (loop
+ for f in (metaenv-function-like-entries e)
+ when (equal (second f) '(:plain))
+ collect `',(first f)
+ when (equal (second f) '(:plain))
+ collect `(function ,(first f))))
+ :variables
+ (list
+ ,@
+ (loop
+ for v in (metaenv-variable-like-entries e)
+ when (equal (second v) '(:plain))
+ collect `',(first v)
+ when (equal (second v) '(:plain))
+ collect
+ `(lambda (&optional (x nil xp))
+ (if xp (setf ,(first v) x) ,(first v))))))
+ *saved-lexenvs*)))
+ ,f))))
+
+(defun lexenv-cursor (&optional n rel)
+ (if n
+ (progn
+ (if rel (incf *saved-lexenv-cursor* n) (setf *saved-lexenv-cursor* n))
+ (setf *saved-lexenv-cursor* (max 0 *saved-lexenv-cursor*))
+ (setf *saved-lexenv-cursor*
+ (min (1- (length *saved-lexenvs*)) *saved-lexenv-cursor*)))
+ *saved-lexenv-cursor*))
+
+(defun list-locvars (&optional (n *saved-lexenv-cursor*))
+ (loop
+ with varlist := (getf (elt *saved-lexenvs* n) :variables)
+ while varlist
+ collect (first varlist)
+ do (setf varlist (cddr varlist))))
+
+(defun list-locfuncs (&optional (n *saved-lexenv-cursor*))
+ (loop
+ with varlist := (getf (elt *saved-lexenvs* n) :functions)
+ while varlist
+ collect (first varlist)
+ do (setf varlist (cddr varlist))))
+
+(defmacro locvar (name &optional (value nil valuep))
+ `(let* ((fn (getf (getf (elt *saved-lexenvs* *saved-lexenv-cursor*)
+ :variables) ',name)))
+ ,(if valuep `(funcall fn ,value) `(funcall fn))))
+
+(defmacro locfunc (name &rest args)
+ `(let* ((fn (getf (getf (elt *saved-lexenvs* *saved-lexenv-cursor*)
+ :functions) ',name)))
+ (funcall fn ,@ args)))
diff --git a/metaenv.lisp b/metaenv.lisp
new file mode 100644
index 0000000..151c197
--- /dev/null
+++ b/metaenv.lisp
@@ -0,0 +1,308 @@
+(in-package :agnostic-lizard)
+
+; basic metaenv class interface and NOP default implementations
+
+(defgeneric metaenv-function-like-entries (obj)
+ (:documentation
+ "Query the list of function-like entries from a metaenv object"))
+(defgeneric metaenv-variable-like-entries (obj)
+ (:documentation
+ "Query the list of variable-like entries from a metaenv object"))
+(defgeneric metaenv-blocks (obj)
+ (:documentation
+ "Query the list of defined blocks from a metaenv object"))
+(defgeneric metaenv-tags (obj)
+ (:documentation
+ "Query the list of defined tags from a metaenv object"))
+(defgeneric metaenv-fallback-env (obj)
+ (:documentation
+ "Query the fallback environment object from a metaenv object"))
+
+(defgeneric metaenv-add-function-like-entry (obj entry)
+ (:documentation
+ "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."))
+(defgeneric metaenv-add-variable-like-entry (obj entry)
+ (:documentation
+ "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." ))
+(defgeneric metaenv-add-block (obj name)
+ (:documentation
+ "Add a block into the metaenv object."))
+(defgeneric metaenv-add-tag (obj name)
+ (:documentation
+ "Add a tag into the metaenv object."))
+
+(defgeneric metaenv-clone-args (obj)
+ (:documentation
+ "The needed initargs for copying a metaenv-related object"))
+(defgeneric metaenv-clone (obj &optional overrides)
+ (:documentation
+ "Create a copy of a metaenv-related object"))
+
+(defmethod metaenv-function-like-entries ((obj t)))
+(defmethod metaenv-variable-like-entries ((obj t)))
+(defmethod metaenv-blocks ((obj t)))
+(defmethod metaenv-tags ((obj t)))
+(defmethod metaenv-fallback-env ((obj t)))
+
+(defmethod metaenv-add-function-like-entry ((obj t) (entry t)))
+(defmethod metaenv-add-variable-like-entry ((obj t) (entry t)))
+(defmethod metaenv-add-block ((obj t) (name t)))
+(defmethod metaenv-add-tag ((obj t) (name t)))
+
+; The interface is enough to define building a similar environment
+
+(defun metaenv-wrap-form (obj form)
+ "Wrap the form into environment-setting wrappers corresponding to all the entries of obj."
+ (let*
+ ((form form)
+ (form
+ (wrap-function-like-env
+ (metaenv-function-like-entries obj) form))
+ (form
+ (wrap-variable-like-env
+ (metaenv-variable-like-entries obj) form))
+ (form (wrap-block-env (metaenv-blocks obj) form))
+ (form (wrap-tag-env (metaenv-tags obj) form)))
+ form))
+
+(defun with-metaenv-built-env (obj var code)
+ "Evaluate code in the lexical environment where var is bound to the lexical environment object described by obj"
+ (eval
+ (metaenv-wrap-form
+ obj
+ `(eval-with-current-environment
+ (,var) ,@code))))
+
+; The basic metaenv class and methods
+
+(defclass metaenv ()
+ ((function-like
+ :initarg :function-like :initarg :func :initarg :fun :initarg :fn
+ :initform nil :accessor metaenv-function-like-entries)
+ (variable-like :initarg :variable-like :initarg :var :initform nil
+ :accessor metaenv-variable-like-entries)
+ (blocks :initarg :blocks :initarg :block :initform nil
+ :accessor metaenv-blocks)
+ (tags :initarg :tags :initarg :tag :initform nil :accessor metaenv-tags)
+ (fallback-env
+ :initarg :fallback-env :initarg :env :initform nil
+ :accessor metaenv-fallback-env
+ :documentation "A slot for storing environment obtained via an &environment parameter"))
+ (:documentation "The basic object holding the lexical environment data for macroexpansion"))
+
+(defmethod metaenv-add-function-like-entry ((obj metaenv) (entry t))
+ (push entry (metaenv-function-like-entries obj)))
+(defmethod metaenv-add-variable-like-entry ((obj metaenv) (entry t))
+ (push entry (metaenv-variable-like-entries obj)))
+(defmethod metaenv-add-block ((obj metaenv) (name t))
+ (push name (metaenv-blocks obj)))
+(defmethod metaenv-add-tag ((obj metaenv) (name t))
+ (pushnew name (metaenv-tags obj)))
+
+(defmethod metaenv-clone-args ((obj metaenv))
+ (list
+ :function-like (metaenv-function-like-entries obj)
+ :variable-like (metaenv-variable-like-entries obj)
+ :blocks (metaenv-blocks obj)
+ :tags (metaenv-tags obj)
+ :fallback-env (metaenv-fallback-env obj)))
+
+(defmethod metaenv-clone ((obj metaenv) &optional overrides)
+ (apply
+ 'make-instance 'metaenv
+ (append
+ overrides
+ (metaenv-clone-args obj))))
+
+; A helper for output
+(defmethod print-object ((obj metaenv) stream)
+ (format stream "#<~a:~{ ~S~}>"
+ (type-of obj)
+ (loop
+ for arg in (metaenv-clone-args obj)
+ collect
+ (cond
+ ((keywordp arg) arg)
+ ((symbolp arg) `',arg)
+ ((consp arg) `',arg)
+ (t arg)))))
+
+; A useful helper for expansions
+(defun metaenv-irrelevant-for-macroexpand (obj)
+ "Check if the metaenv obj is the same as the fallback environment for macroexpand-1"
+ (and
+ (loop
+ with fbe := (metaenv-fallback-env obj)
+ with seen := (make-hash-table)
+ for fn in (metaenv-function-like-entries obj)
+ when (second fn)
+ unless (or
+ (gethash (first fn) seen)
+ (and
+ (eq (first (second fn)) :plain)
+ (null (macro-function (first fn) fbe))))
+ return nil
+ do (setf (gethash (first fn) seen) t)
+ finally (return t))
+ (loop
+ with fbe := (metaenv-fallback-env obj)
+ with seen := (make-hash-table)
+ for fn in (metaenv-variable-like-entries obj)
+ when (second fn)
+ unless (or
+ (gethash (first fn) seen)
+ (and
+ (eq (first (second fn)) :plain)
+ (eq (first fn) (macroexpand-1 (first fn) fbe))))
+ return nil
+ do (setf (gethash (first fn) seen) t)
+ finally (return t))))
+
+(defclass walker-metaenv (metaenv)
+ ((on-function-form :initform #'values :initarg :on-function-form
+ :accessor metaenv-on-function-form)
+ (on-function-form-pre
+ :initform #'values :initarg :on-function-form-pre
+ :accessor metaenv-on-function-form-pre)
+ (on-every-form :initform #'values :initarg :on-every-form
+ :accessor metaenv-on-every-form)
+ (on-every-form-pre :initform #'values :initarg :on-every-form-pre
+ :accessor metaenv-on-every-form-pre)
+ (on-special-form-pre :initform #'values :initarg :on-special-form-pre
+ :accessor metaenv-on-special-form-pre)
+ (on-special-form :initform #'values :initarg :on-special-form
+ :accessor metaenv-on-special-form)
+ (on-macroexpanded-form :initform #'values :initarg :on-macroexpanded-form
+ :accessor metaenv-on-macroexpanded-form))
+ (:documentation "An extended walker environment object.
+Here we keep a few handlers to allow transformations of the code during walking."))
+
+(defmethod metaenv-clone-args :around ((obj walker-metaenv))
+ (append
+ (call-next-method)
+ (list
+ :on-function-form (metaenv-on-function-form obj)
+ :on-function-form-pre (metaenv-on-function-form-pre obj)
+ :on-special-form (metaenv-on-special-form obj)
+ :on-special-form-pre (metaenv-on-special-form-pre obj)
+ :on-every-form (metaenv-on-every-form obj)
+ :on-every-form-pre (metaenv-on-every-form-pre obj)
+ :on-macroexpanded-form (metaenv-on-macroexpanded-form obj))))
+
+(defmethod metaenv-clone ((obj walker-metaenv) &optional overrides)
+ (apply
+ 'make-instance 'walker-metaenv
+ (append
+ overrides
+ (metaenv-clone-args obj))))
+
+(defclass macro-walker-metaenv (walker-metaenv)
+ ((create-macro
+ :initform t :initarg :create-macro
+ :accessor metaenv-create-macro
+ :documentation "Whether to do expansion or just create a macro call that will be able to get proper environment")
+ (recursive-label
+ :initform (gensym) :initarg :recursive-label
+ :accessor metaenv-recursive-label
+ :documentation
+ "A label to distinguish the forms freshly created in relation to the current environment.")
+ (on-macro-walker-create-macro
+ :initform 'values :initarg :on-macro-walker-create-macro
+ :accessor metaenv-on-macro-walker-create-macro
+ :documentation
+ "A handler invoked when macro-walker creates a new macro"))
+ (:documentation "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."))
+
+(defmethod metaenv-clone-args :around ((obj macro-walker-metaenv))
+ (append
+ (call-next-method)
+ (list
+ :create-macro (metaenv-create-macro obj)
+ :recursive-label (metaenv-recursive-label obj)
+ :on-macro-walker-create-macro (metaenv-on-macro-walker-create-macro obj))))
+
+(defmethod metaenv-clone ((obj macro-walker-metaenv) &optional overrides)
+ (apply
+ 'make-instance 'macro-walker-metaenv
+ (append
+ overrides
+ (metaenv-clone-args obj))))
+
+(defmethod metaenv-recursive-label (obj) nil)
+
+(defmacro metaenv-macro-macroexpand-all (form &environment env &optional extra-env)
+ "A helper macro for recapturing environment"
+ (let*
+ ((envcopy (cond
+ ((null extra-env) (make-instance 'macro-walker-metaenv))
+ ((consp extra-env) (eval extra-env))
+ (t (metaenv-clone extra-env)))))
+ (setf (metaenv-create-macro envcopy) nil)
+ (setf (metaenv-fallback-env envcopy) env)
+ (metaenv-macroexpand-all form envcopy)))
+
+(defmacro metaenv-macro-macroexpand-all-wrapper (form env)
+ "This wrapper does nothing but protects form from metaenv-macro-walker-turn-to-quoted"
+ (declare (ignorable env))
+ form)
+
+(defmethod metaenv-macroexpand-all :around (form (env macro-walker-metaenv))
+ (if (metaenv-create-macro env)
+ (progn
+ `(metaenv-macro-macroexpand-all-wrapper
+ ,(funcall
+ (metaenv-on-macro-walker-create-macro env)
+ `(metaenv-macro-macroexpand-all ,form ,env) env)
+ ,env))
+ (let* ((envcopy (metaenv-clone env)))
+ (setf (metaenv-create-macro envcopy) t)
+ (call-next-method form envcopy))))
+
+(defmethod metaenv-macroexpand-1 (form (env macro-walker-metaenv))
+ (macroexpand-1 form (metaenv-fallback-env env)))
+
+(defun metaenv-macro-walker-turn-to-quoted (form env &optional cdr-branch)
+ "Convert a partially walked form into code producing the expansion of the form after the walk is completed"
+ (cond
+ ((not (consp form)) `(quote ,form))
+ ((and
+ (not cdr-branch)
+ (find (first form)
+ '(metaenv-macro-macroexpand-all-wrapper))
+ (eq (metaenv-recursive-label (ignore-errors (third form)))
+ (metaenv-recursive-label env)))
+ form)
+ (t `(cons ,(metaenv-macro-walker-turn-to-quoted (car form) env)
+ ,(metaenv-macro-walker-turn-to-quoted (cdr form) env t)))))
+
+(defmacro macro-walk-form (form &rest handler-definitions)
+ "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."
+ `(metaenv-macro-macroexpand-all
+ ,form
+ (make-instance 'macro-walker-metaenv
+ ,@ handler-definitions)))
+
+(defmacro macro-macroexpand-all (form &rest handler-definitions &key
+ (on-every-form ''values)
+ (on-macro-walker-create-macro ''values))
+ "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-walk-form
+ ,form
+ :on-every-form (lambda (form env)
+ (metaenv-macro-walker-turn-to-quoted
+ (funcall ,on-every-form
+ form env) env))
+ :on-macro-walker-create-macro
+ (lambda (form env)
+ (metaenv-wrap-form env
+ (funcall ,on-macro-walker-create-macro form env)))
+ ,@ handler-definitions))
diff --git a/package.lisp b/package.lisp
new file mode 100644
index 0000000..784807d
--- /dev/null
+++ b/package.lisp
@@ -0,0 +1,19 @@
+(defpackage :agnostic-lizard
+ (:use :common-lisp)
+ (:export
+ #:metaenv
+ #:walker-metaenv
+ #:macro-walker-metaenv
+
+ #:metaenv-macroexpand-all
+
+ #:metaenv-function-like-entries
+ #:metaenv-variable-like-entries
+ #:metaenv-blocks
+ #:metaenv-tags
+
+ #:macroexpand-all
+ #:walk-form
+
+ #:macro-walk-form
+ #:macro-macroexpand-all))
diff --git a/pure-expansion.lisp b/pure-expansion.lisp
new file mode 100644
index 0000000..3b1faf7
--- /dev/null
+++ b/pure-expansion.lisp
@@ -0,0 +1,119 @@
+(in-package :agnostic-lizard)
+
+; In this file we pretend we only want a macroexpand-all function
+
+(defgeneric metaenv-macroexpand-1 (form env)
+ (:documentation
+ "Do a single step of macroexpansion on the top level of form in the environment env"))
+
+(defmethod metaenv-macroexpand-1 (x env)
+ (cond
+ ((symbolp x)
+ (let*
+ ((local-match
+ (find x (metaenv-variable-like-entries env) :key 'first))
+ (local-content (second local-match))
+ (local-payload (second local-content)))
+ (ecase (first local-content)
+ ((:plain) x)
+ ((:macro) local-payload)
+ ((:macro-from) (macroexpand-1 x local-payload))
+ ((nil) (macroexpand-1 x (metaenv-fallback-env env))))))
+ ((consp x)
+ (let*
+ ((local-match
+ (find (first x) (metaenv-function-like-entries env) :key 'first))
+ (local-content (second local-match)))
+ (ecase (first local-content)
+ ((:plain) x)
+ ((:macro :macro-from :macro-function-code :macro-code)
+ (with-metaenv-built-env env 'lisp-env `((macroexpand-1 ',x lisp-env))))
+ ((nil)
+ (cond
+ ; the fallback is the global environment anyway
+ ((null (metaenv-fallback-env env))
+ (with-metaenv-built-env env 'lisp-env `((macroexpand-1 ',x lisp-env))))
+ ; no macro defined or an flet shadows the macro
+ ((null (macro-function (first x) (metaenv-fallback-env env))) x)
+ ; metaenv does not contain anything meaningful
+ ((metaenv-irrelevant-for-macroexpand env)
+ (macroexpand-1 x (metaenv-fallback-env env)))
+ ; the macro is from the global environment or defined inside
+ ; the walked fragment
+ ((eq (macro-function (first x) nil)
+ (macro-function (first x) (metaenv-fallback-env env)))
+ (with-metaenv-built-env env 'lisp-env `((macroexpand-1 ',x lisp-env))))
+ ; The macro is from a macrolet reflected in the fallback environment
+ ; Assume macroexpand calls inside the macro function expect some other
+ ; outside macrolet to be in effect
+ (t (macroexpand-1 x (metaenv-fallback-env env))))))))
+ (t x)))
+
+(defun metaenv-macroexpand (form env)
+ "Perform full macroexpansion of the top level of the form in the environment env"
+ (let*
+ ((expansion (metaenv-macroexpand-1 form env)))
+ (if (eq expansion form) form
+ (metaenv-macroexpand expansion env))))
+
+(defgeneric metaenv-macroexpand-all (form env)
+ (:documentation
+ "Expand all macros on all levels of form in the environment env"))
+(defgeneric metaenv-macroexpand-all-special-form (operator form env)
+ (:documentation
+ "A handler for dispatching macroexpand-all handling of special forms and some macros"))
+
+; When not passing an environment, initialize a metaenv
+
+(defmethod metaenv-macroexpand-all (form (env (eql nil)))
+ (metaenv-macroexpand-all form (make-instance 'metaenv)))
+
+(defmethod metaenv-macroexpand-all-special-form (operator form (env (eql nil)))
+ (metaenv-macroexpand-all-special-form operator form (make-instance 'metaenv)))
+
+(eval-when (:compile-toplevel :load-toplevel :execute)
+ (defparameter *hardwired-operators*
+ `(
+ ; named-lambda expansions are complicated, better just to walk
+ defun defmacro
+ ; these are said to expand to something non-portable in some
+ ; implementations
+ cond multiple-value-bind handler-bind)
+ "The list of hardwired macros; they are code-walked without macroexpansion"))
+
+(defmethod metaenv-macroexpand-all (form (env metaenv))
+ (let* ((initial-operator (and (consp form) (car form)))
+ (hardwiredp (find initial-operator *hardwired-operators*))
+ (expanded (if hardwiredp form (metaenv-macroexpand form env))))
+ (and
+ expanded
+ (if (not (consp expanded)) expanded
+ (let* ((operator (car expanded)))
+ (if (not
+ (or
+ (special-operator-p operator)
+ (find operator *hardwired-operators*)))
+ (cons operator
+ (loop
+ for arg in (cdr expanded)
+ collect (metaenv-macroexpand-all arg env)))
+ (metaenv-macroexpand-all-special-form operator expanded env)))))))
+
+(defun metaenv-map-macroexpand-all (forms env)
+ "Apply metaenv-macroexpand-all to all the forms using the same env"
+ (loop for form in forms collect (metaenv-macroexpand-all form env)))
+
+(defun metaenv-map-macroexpand-all-after-declarations (entries env enable-docstring)
+ "Apply metaenv-map-macroexpand-all to all the forms among the entries, but use the declarations as-is"
+ (let*
+ ((declarations-and-forms (separate-declarations entries :enable-docstring enable-docstring)))
+ (append
+ (first declarations-and-forms)
+ (metaenv-map-macroexpand-all (second declarations-and-forms) env))))
+
+(defun macroexpand-all (form &optional env)
+ "Recursively expand all macro calls in form with initial environment described by env"
+ (cond
+ ((null env) (metaenv-macroexpand-all form nil))
+ ((typep env 'metaenv) (metaenv-macroexpand-all form env))
+ (t (metaenv-macroexpand-all form (make-instance 'metaenv :fallback-env env)))))
diff --git a/special-form-handlers.lisp b/special-form-handlers.lisp
new file mode 100644
index 0000000..caabdbe
--- /dev/null
+++ b/special-form-handlers.lisp
@@ -0,0 +1,308 @@
+(in-package :agnostic-lizard)
+
+(defmethod metaenv-macroexpand-all-special-form (operator form env)
+ `(,operator ,@(metaenv-map-macroexpand-all (cdr form) env)))
+
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'block)) form env)
+ `(block ,(second form)
+ ,@(metaenv-map-macroexpand-all (cddr form) env)))
+
+(defgeneric metaenv-macroexpand-all-special-form-let (operator form env)
+ (:documentation
+ "Expand a form that is similar to let"))
+
+(defmethod metaenv-macroexpand-all-special-form-let (operator form env)
+ (let*
+ ((envcopy (metaenv-clone env))
+ (definitions
+ (loop
+ for entry in (second form)
+ for name := (if (consp entry) (first entry) entry)
+ do (metaenv-add-variable-like-entry envcopy `(,name (:plain)))
+ collect (if (consp entry)
+ (list name (metaenv-macroexpand-all
+ (second entry) (if (eq operator 'let) env envcopy)))
+ entry))))
+ `(,operator
+ ,definitions
+ ,@ (metaenv-map-macroexpand-all-after-declarations (cddr form) envcopy nil))))
+
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'let)) form env)
+ (metaenv-macroexpand-all-special-form-let operator form env))
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'let*)) form env)
+ (metaenv-macroexpand-all-special-form-let operator form env))
+
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'setq)) form env)
+ (let*
+ ((pairs (loop
+ with source := (cdr form)
+ while source
+ collect (list (first source) (second source))
+ do (setf source (cddr source))))
+ (expanded-names
+ (loop
+ for pair in pairs
+ collect (metaenv-macroexpand (first pair) env)))
+ ; symbol macros among target variable names make setq behave like setf
+ ; on the other hand, setf to a non-symbol-macro variable name is the same as setq
+ (conversion-needed (remove-if 'symbolp expanded-names))
+ (assignment-arguments
+ (loop
+ for var in expanded-names
+ for pair in pairs
+ for value := (second pair)
+ collect (list var value))))
+ (if conversion-needed
+ (metaenv-macroexpand-all `(setf ,@ (reduce 'append assignment-arguments)) env)
+ `(setq ,@ (loop
+ for pair in assignment-arguments
+ collect (first pair)
+ collect (metaenv-macroexpand-all (second pair) env))))))
+
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'tagbody)) form env)
+ (let*
+ ((envcopy (metaenv-clone env)))
+ (loop
+ for entry in (cdr form)
+ when (go-tag-p entry)
+ do (metaenv-add-tag envcopy entry))
+ `(tagbody
+ ,@(loop
+ for entry in (cdr form)
+ for tagp := (go-tag-p entry)
+ for expansion :=
+ (and (not tagp)
+ (metaenv-macroexpand-all entry envcopy))
+ for final-entry := (if tagp entry expansion)
+ collect final-entry))))
+
+(defgeneric metaenv-expand-lambda-expression (designator env)
+ (:documentation
+ "Expand a lambda expression or a named-lambda expression"))
+
+(defmethod metaenv-expand-lambda-expression (designator env)
+ (let*
+ ((named
+ (find (symbol-name (first designator))
+ '("named-lambda" "lambda-block") :test 'equalp))
+ (arglist (if named (third designator) (second designator)))
+ (envcopy (metaenv-clone env))
+ (variables (lambda-list-variable-names arglist)))
+ (loop for name in variables do
+ (metaenv-add-variable-like-entry envcopy `(,name (:plain))))
+ `(,(first designator)
+ ,@(when named (list (second designator)))
+ ,arglist
+ ,@ (metaenv-map-macroexpand-all-after-declarations
+ (if named (cdddr designator) (cddr designator)) envcopy t))))
+
+(defgeneric metaenv-macroexpand-all-special-form-progn (operator form env)
+ (:documentation
+ "Expand a form similar to a funcall or to a progn"))
+
+(defmethod metaenv-macroexpand-all-special-form-progn (operator form env)
+ `(,(if (consp operator)
+ ; Common Lisp allows a lambda expression to be used as a function name in a normal function call form
+ ; Note that setf functions cannot be called like that
+ (metaenv-expand-lambda-expression
+ operator env)
+ operator)
+ ,@ (loop for entry in (cdr form) collect (metaenv-macroexpand-all entry env))))
+
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'if)) form env)
+ (metaenv-macroexpand-all-special-form-progn operator form env))
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'progn)) form env)
+ (metaenv-macroexpand-all-special-form-progn operator form env))
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'throw)) form env)
+ (metaenv-macroexpand-all-special-form-progn operator form env))
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'catch)) form env)
+ (metaenv-macroexpand-all-special-form-progn operator form env))
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'multiple-value-prog1)) form env)
+ (metaenv-macroexpand-all-special-form-progn operator form env))
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'multiple-value-call)) form env)
+ (metaenv-macroexpand-all-special-form-progn operator form env))
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'unwind-protect)) form env)
+ (metaenv-macroexpand-all-special-form-progn operator form env))
+
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'quote)) form env)
+ (declare (ignore env)) form)
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'go)) form env)
+ (declare (ignorable env)) form)
+
+(defgeneric metaenv-macroexpand-all-special-form-the (operator form env)
+ (:documentation
+ "Expand a special form similar to the"))
+
+(defmethod metaenv-macroexpand-all-special-form-the (operator form env)
+ `(,operator ,(second form)
+ ,@ (metaenv-map-macroexpand-all (cddr form) env)))
+
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'return-from)) form env)
+ (metaenv-macroexpand-all-special-form-the operator form env))
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'the)) form env)
+ (metaenv-macroexpand-all-special-form-the operator form env))
+(defmethod metaenv-macroexpand-all-special-form ((operator (eql 'eval-when)) form env)
+ (metaenv-macroexpand-all-special-form-the operator form env))
+
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'function)) form env)
+ (let*
+ ((designator (second form)))
+ (cond
+ ; named function in CLISP
+ ((and (third form)
+ (consp (third form))
+ (symbolp designator))
+ `(,operator
+ ,designator
+ ,(second
+ (metaenv-macroexpand-all-special-form
+ operator `(,operator ,(third form)) env))))
+ ((not (consp designator)) form)
+ ((eq (car designator) 'setf) form)
+ ((eq (car designator) 'lambda)
+ `(,operator
+ ,(metaenv-expand-lambda-expression designator env)))
+ ((and
+ (symbolp (car designator))
+ (find (symbol-name (car designator))
+ '("named-lambda" "lambda-block")
+ :test 'equalp))
+ `(,operator
+ ,(metaenv-expand-lambda-expression designator env)))
+ (t form))))
+
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'locally)) form env)
+ `(,operator
+ ,@ (metaenv-map-macroexpand-all-after-declarations (cdr form) env nil)))
+
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'load-time-value)) form env)
+ (declare (ignore env))
+ `(,operator
+ ,(metaenv-macroexpand-all (second form) nil)
+ ,@(cddr form)))
+
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'progv)) form env)
+ `(,operator
+ ,(metaenv-map-macroexpand-all (second form) env)
+ ,(metaenv-map-macroexpand-all (third form) env)
+ ,@ (metaenv-map-macroexpand-all (cdddr form) env)))
+
+(defgeneric metaenv-macroexpand-all-special-form-macrolet (operator form env)
+ (:documentation
+ "Expand a form similar to macrolet"))
+
+(defmethod metaenv-macroexpand-all-special-form-macrolet
+ (operator form env)
+ (let* ((envcopy (metaenv-clone env)))
+ (loop
+ for entry in (second form)
+ for name := (first entry)
+ for expansion := (cdr entry)
+ do
+ (if (eq operator 'macrolet)
+ (metaenv-add-function-like-entry
+ envcopy `(,name (:macro-code ,@expansion)))
+ (metaenv-add-variable-like-entry
+ envcopy `(,name (:macro ,@expansion)))))
+ `(,operator
+ ,(second form)
+ ,@ (metaenv-map-macroexpand-all-after-declarations
+ (cddr form) envcopy nil))))
+
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'macrolet)) form env)
+ (metaenv-macroexpand-all-special-form-macrolet
+ operator form env))
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'symbol-macrolet)) form env)
+ (metaenv-macroexpand-all-special-form-macrolet
+ operator form env))
+
+(defgeneric metaenv-macroexpand-all-special-form-flet (operator form env)
+ (:documentation
+ "Expand a form similar to flet"))
+
+(defmethod metaenv-macroexpand-all-special-form-flet (operator form env)
+ (let*
+ ((envcopy (metaenv-clone env))
+ (function-definitions
+ (loop
+ for f in (second form)
+ for fname := (first f)
+ for arglist := (second f)
+ for parameters := (lambda-list-variable-names arglist)
+ for envcopyfun := (metaenv-clone (if (eq operator 'flet) env envcopy))
+ for funbody := (progn
+ (loop
+ for var in parameters
+ do
+ (metaenv-add-variable-like-entry
+ envcopyfun `(,var (:plain))))
+ (metaenv-map-macroexpand-all-after-declarations
+ (cddr f) envcopyfun t))
+ do (metaenv-add-function-like-entry envcopy `(,fname (:plain)))
+ collect `(,fname ,arglist ,@ funbody))))
+ `(,operator
+ ,function-definitions
+ ,@ (metaenv-map-macroexpand-all-after-declarations (cddr form) envcopy nil))))
+
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'flet)) form env)
+ (metaenv-macroexpand-all-special-form-flet operator form env))
+
+; Refuse to expand meta-code
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'defmacro)) form env)
+ (declare (ignorable env))
+ form)
+
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'defun)) form env)
+ (let*
+ ((envcopy (metaenv-clone env))
+ (arglist (third form)))
+ (loop
+ for variable in (lambda-list-variable-names arglist)
+ do (metaenv-add-variable-like-entry env `(,variable (:plain))))
+ `(,operator
+ ,(second form)
+ ,arglist
+ ,@(metaenv-map-macroexpand-all-after-declarations
+ (cdddr form) envcopy t))))
+
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'labels)) form env)
+ (metaenv-macroexpand-all-special-form-flet operator form env))
+
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'handler-bind)) form env)
+ `(,operator
+ (,@(loop
+ for handler in (second form)
+ collect
+ (list (first handler)
+ (metaenv-macroexpand-all (second handler) env))))
+ ,@ (metaenv-map-macroexpand-all (cddr form) env)))
+
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'multiple-value-bind)) form env)
+ (let*
+ ((envcopy (metaenv-clone env)))
+ (loop for var in (second form)
+ do (metaenv-add-variable-like-entry envcopy `(,var (:plain))))
+ `(,operator
+ ,(second form)
+ ,(metaenv-macroexpand-all (third form) env)
+ ,@ (metaenv-map-macroexpand-all-after-declarations
+ (cdddr form) envcopy nil))))
+
+(defmethod metaenv-macroexpand-all-special-form
+ ((operator (eql 'cond)) form env)
+ `(,operator
+ ,@(loop
+ for clause in (cdr form)
+ collect (metaenv-map-macroexpand-all clause env))))
diff --git a/test-iterate.lisp b/test-iterate.lisp
new file mode 100644
index 0000000..8b3badb
--- /dev/null
+++ b/test-iterate.lisp
@@ -0,0 +1,8 @@
+(require :iterate)
+(use-package :iterate)
+
+(iterate
+ (for x :from 1 :to 3)
+ (macrolet
+ ((f (y) `(collect ,y)))
+ (f x)))
diff --git a/test-macroexpand-dammit.lisp b/test-macroexpand-dammit.lisp
new file mode 100644
index 0000000..5de8bd1
--- /dev/null
+++ b/test-macroexpand-dammit.lisp
@@ -0,0 +1,10 @@
+(require :macroexpand-dammit)
+
+(defmacro f () 1)
+
+(defmacro macroexpand-dammit-here (form &environment env)
+ `',(macroexpand-dammit:macroexpand-dammit form env))
+
+(macrolet ((f () 2)) (macroexpand-dammit-here (macrolet () (f))))
+
+(macrolet ((f () 2)) (macrolet () (f)))
diff --git a/utils.lisp b/utils.lisp
new file mode 100644
index 0000000..b39f8c4
--- /dev/null
+++ b/utils.lisp
@@ -0,0 +1,39 @@
+(in-package :agnostic-lizard)
+
+(defmacro eval-with-current-environment ((var) &body code &environment env)
+ "Evaluate code in a lexical environment where var is bound to the lexical
+environment object corresponding to the macro call position"
+ `',(funcall (eval `(lambda (,var) ,@code)) env))
+
+(defun separate-declarations (entries &key (enable-docstring t))
+ "Separate a list of entries into declarations and forms, with a possible docstring, if enabled"
+ (loop
+ with docstring := (not enable-docstring)
+ with declarations := nil
+ with forms := nil
+ for header := t then header-continued
+ for entry in entries
+ for operator := (and (consp entry) (car entry))
+ for header-continued :=
+ (and
+ header
+ (or
+ (and (stringp entry) (not docstring) (setf docstring entry) t)
+ (eq operator 'declare)))
+ do (if header-continued (push entry declarations) (push entry forms))
+ finally
+ (return
+ ; (lambda () "asd") is the same as (constantly "asd")
+ (if (and (null forms) (stringp docstring)
+ (eq docstring (car declarations)))
+ (list (reverse (cdr declarations)) (list docstring))
+ (list (reverse declarations) (reverse forms))))))
+
+(defun go-tag-p (x) (or (integerp x) (symbolp x)))
+
+(defun lambda-list-variable-names (l)
+ (loop
+ for name in l
+ unless (find name lambda-list-keywords)
+ collect (if (consp name) (car name) name)))
+