coq-community / dblib

Coq library for working with de Bruijn indices [maintainer=@KevOrr]

Dblib

Library with facilities for working with de Bruijn indices in Coq to reason about capture-avoiding substitution of variables in syntax with binders.

Meta

• Author(s):
  • François Pottier (initial)
• Coq-community maintainer(s):
  • Kevin Orr (@KevOrr)
• License: GNU General Public License v3.0
• Compatible Coq versions: 8.7 or later
• Additional dependencies: none
• Coq namespace: Dblib
• Related publication(s): none

Building and installation instructions

The easiest way to install the latest released version of Dblib is via OPAM:

opam repo add coq-released https://coq.inria.fr/opam/released
opam install coq-dblib

To instead build and install manually, do:

git clone https://github.com/coq-community/dblib.git
cd dblib
make   # or make -j <number-of-cores-on-your-machine> 
make install

Documentation

Workflow

The basic workflow for using the library is as follows:

1. The client manually defines the syntax of terms (or types, or whatever syntax she is interested in) as usual, as an inductive type.
2. The client manually defines a higher-order traverse function, which can be thought of as a generic, capture-avoiding substitution function. Its job is (i) to apply a user-supplied function f at every variable, and (ii) to inform f about the number of binders that have been entered. By defining traverse, the client effectively defines the binding structure.
3. The client proves that the traverse function is well-behaved, i.e., it satisfies half a dozen reasonable properties. These proofs are usually trivial, because the library provides tailor-made tactics for this purpose.
4. The library defines weakening (lift) and substitution (subst) in terms of traverse, and proves a rather large number of properties of these functions.
5. The functions lift and subst are opaque, so an application of these functions cannot be reduced by Coq's builtin tactic simpl. The library provides simpl_lift_goal and simpl_subst_goal for this purpose (plus a few variants of these tactics that perform simplification within a hypothesis, or within all hypotheses).
6. The library also provides hint databases, to be used with eauto, that can prove many of the typical equalities that arise when proving weakening or substitution lemmas.
7. The library defines a closed term as one that is invariant under lifting (and substitution), and provides lemmas/tactics for reasoning about this notion.

Everything is based on type classes: traverse, lift, subst, etc. are overloaded, so the whole process can be repeated, if desired, for another inductive type.

The library does support multiple independent namespaces: for instance, it is possible to have terms that contain term variables and types that contain type variables.

The library does not support multiple namespaces when there is interaction between them: for instance, it is not possible to have terms that contain both term variables and type variables, as in a standard presentation of System F. A possible work-around is to define a single namespace of "variables" and to use a separate well-kindedness judgement in order to distinguish between "term" variables and "type" variables. This approach has been used in a large proof, where it has turned out to be extremely beneficial.

Library Files

The library consists of the following files:

• DblibTactics.v
  A small number of hints and tactics that are used in the library. The end user should not need to worry about them, but can go and have a look.

• DeBruijn.v
  The core library. The end user is encouraged to read the first two parts of this file, which present 1- the operations and properties that the client is expected to provide; and 2- the operations and properties that the library provides. These two parts extend up to the first double dashed line, near line 432.

• Environments.v
  This auxiliary library defines a notion of environment, which is typically useful when defining a typing judgement. The use of this library is optional.

Demos

The documentation takes the form of a few demo files:

• DemoLambda.v
  Small-step operational semantics and typing judgement for the simply-typed lambda-calculus. Proof of type preservation and of a few other basic lemmas.

• DemoValueTerm.v
  Short demo of how to use the library in the case where there are two distinct syntactic categories of things in which we substitute (e.g., terms) and things that we substitute (e.g., values).

• DemoExplicitSystemF.v
  Proof of type preservation for System F, in a version where the presence of type abstractions and type applications is explicit in the syntax of terms. (Still, terms do not refer to types!)

• DemoImplicitSystemF.v
  Proof of type preservation for System F, in a version where type abstraction and type application are implicit, i.e., the syntax of terms is untyped. This proof is trickier than the one above, in that it requires induction over the height of type derivations. But as far as binding is concerned, no new problems arise.

dblib's Issues

Tactics should be more robust regarding simplification

Related: #8 (in a way, that was one instance of this issue)

This is already mostly fixed in 7ea22c0, but I had to revert that commit because it broke compatibility with coq<8.12

Some tactics fail if traverse function is anonymous

E.g.

Inductive term : Set :=
| ...
.

Instance Traverse_term : Traverse term term :=
  {traverse := (fix rec f l e := ...)}.

Goal @TraverseFunctorial term _ term _.
Proof.
  constructor. prove_traverse_functorial.

Shown to break:

• prove_traverse_functorial
• prove_traverse_relative
• prove_traverse_var_is_identity

Shown to work:

• prove_traverse_var_injective
• prove_traverse_identifies_var

Replication of releases/tags from coq-contribs repository

There are several releases and tags in the coq-contribs repos for the project. Ideally, these should be replicated in this repository to allow users of old versions of Coq to have a "one stop shop" for all dblib needs.

Release on OPAM/Update Coq Package Index entry

Don't know anything yet about how to do either of these. Any input would be helpful.

Address Coq 8.13 deprecation warnings

#11 (diff) silenced two new deprecation warnings:

• deprecated-hint-without-locality
• deprecated-instance-without-locality

We have many hints and instances that use default locality. Look into explicitly setting locality to local or export wherever possible