https://github.com/ztellman/riddley

code-walking without caveats
https://github.com/ztellman/riddley

Last synced: 6 days ago
JSON representation

code-walking without caveats

• Host: GitHub
• URL: https://github.com/ztellman/riddley
• Owner: ztellman
• Created: 2013-09-02T17:36:06.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-09-04T21:25:42.000Z (over 2 years ago)
• Last Synced: 2025-01-15T07:44:25.465Z (17 days ago)
• Language: Clojure
• Size: 635 KB
• Stars: 196
• Watchers: 8
• Forks: 30
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
    Walker is my name

    and I am the same.

    Riddley Walker.

    Walking my riddels

    where ever theyve took me

    and walking them now

    on this paper the same.

from [Riddley Walker](http://en.wikipedia.org/wiki/Riddley_Walker) by Russell Hoban

---

Code may be data, but only some of that data is executable.  If we want to perform a pervasive code transformation, using something like `clojure.walk` presents a few problems:

* binding forms are treated the same as actual expressions

* `clojure.walk/macroexpand-all` will pass in a nil `&env` to all macros

* macroexpansion doesn't expand inlined functions

This means that transforms that we intend to apply to expressions may have unintended consequences on a `fn`, `let`, or `case` form.  It also means that any macro which relies on `&env` will not compose with our transformation.  Finally, if inlined functions aren't expanded, certain transformations will break.

### usage

[![Build Status](https://travis-ci.org/ztellman/riddley.png?branch=master)](https://travis-ci.org/ztellman/riddley)

```clj

[riddley "0.2.0"]

```

Riddley provides a correct `riddley.walk/macroexpand-all`, which preserves the binding information in `&env` and expands inlined functions, and `riddley.walk/walk-exprs`, which is a general mechanism for code walking and transformation.

`walk-exprs` takes two arguments, a `predicate` for whether it should transform the sub-form, and a `handler` for doing the transformation.

```clj

riddley.walk> (walk-exprs number? inc '(let [n 1] (+ n 1)))

(let* [n 2] (. clojure.lang.Numbers (add n 2)))

```

Notice that `walk-exprs` implicitly macroexpands the form, including the inline form for `+`.  Unlike `clojure.walk`, if `handler` is called, sub-forms will not be walked.  The handler function is responsible for recursively calling `walk-exprs` on the form it's handed.

Access to `&env` is available via `(riddley.compiler/locals)` if you need it as part of your transformation.

Full documentation can be found [here](http://aleph.io/codox/riddley/).

### license

Copyright © 2013 Zachary Tellman

Distributed under the MIT License.