blanks: Fill-in-the-blanks - A library factoring out substitution from ASTs

[ bsd3, language, library, program ] [ Propose Tags ]

Please see the README on GitHub at https://github.com/ejconlon/blanks#readme


[Skip to Readme]
Versions [faq] 0.3.0, 0.4.0, 0.4.1, 0.4.2
Dependencies adjunctions (>=4.4 && <5), base (>=4.12 && <5), containers (>=0.6 && <1), deepseq (>=1.4 && <2), distributive (>=0.6 && <1), mtl (>=2.2 && <3) [details]
License BSD-3-Clause
Copyright (c) 2019 Eric Conlon
Author Eric Conlon
Maintainer ejconlon@gmail.com
Category Language
Home page https://github.com/ejconlon/blanks#readme
Bug tracker https://github.com/ejconlon/blanks/issues
Source repo head: git clone https://github.com/ejconlon/blanks
Uploaded by ejconlon at 2020-10-07T21:43:38Z
Distributions NixOS:0.4.2
Downloads 484 total (69 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2020-10-07 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for blanks-0.4.2

[back to package description]

blanks

CircleCI

Fill-in-the-blanks - A library factoring out substitution from ASTs.

It's a pain to track de Bruijn indices yourself to implement capture-avoiding subsititution, so this library provides some wrappers that help. One of the best libraries for this is bound, which uses a clever representation to make these operations safe and fast. The tradeoff is that you have to define a Monad instance for your expression functor, which in practice can be tricky. (It's even trickier to derive Eq and Show!)

This library takes the simpler, slower, and rather "succ-y" free-monad-ish approach, but with a twist. It expects you to rewrite all name-binding constructors in your expression as annotations on a single "binder" constructor. This allows you to use the provided Scope type (or a variant) as a wrapper around your expression functor, which is only required to implement Functor. This representation is less safe (since you can inspect and manipulate bound variables), but if you stick to the provided combinators, things will work out fine.

You'll get most of what you want by just importing this module unqualified. See the Blanks class definition and related methods to manipulate variables and abstractions. See Scope for the basic wrapper and LocScope for a wrapper with annotations you can use for source locations and the like. See the test suite for examples.