uwplse / coq-plugin-lib

Library of useful utility functions for Coq plugins

This is a library of useful utility functions for Coq plugins. These functions originally come from PUMPKIN PATCH and DEVOID, but may be useful for plugin development more broadly.

To build this library with a test plugin, run:

./build.sh

See PUMPKIN PATCH and DEVOID for examples of loading it as a submodule.

Guide

• LICENSE: License
• README.md: You are here!
• build.sh: Build script for example plugin
• theories: Example plugin that loads the library
• src: Main source directory
  • plib.mlpack
  • plibrary.ml4: Top-level file
  • utilities: General OCaml utilities
  • coq: Coq utilities
    • constants: Useful Coq constants, like sigma types and equality
    • devutils: Utilities for development, like printing terms with deBruijn indices
    • logicutils: Utilities for the core logic of Coq
      • contexts: Contexts, environments, and state for unification
      • hofs: Useful higher-order functions, like flexible reduction and substistution functions
      • inductive: Inductive types
      • transformation: Transforming types and terms
      • typesandequality: Type checking & inference, unification, convertibility, and so on
    • representationutils: Definitions, names, and dealing with different representations of terms
    • termutils: Utilities for constructing and reasoning about certain kinds of terms, like constants and functions

Contributors

This library was developed by Talia Ringer, Nate Yazdani, and RanDair Porter.

Licensing

We use the MIT license because we think Coq plugins have a right not to use GPL. If this is wrong, please let us know kindly so we can fix this.

coq-plugin-lib's Issues

Favor econstr when possible instead of constantly converting

Clean up / consolidate substitutions

Including in debruijn

Clean HOF type signatures

Include in DEVOID build process

Refactor code that has to do with relating two terms

See uwplse/PUMPKIN-PATCH#43

Comments

Break coqterms into smaller files

Refactor code from DEVOID

Address all warnings

Name collision with reverse

File organization

Remove unused functions

Better error messaging practices

Update docs

Build process?

Document the build process for this library and how to include it in other tools. Maybe include a build script in here.

Move TODOs in code into issues

Refactor code from PUMPKIN PATCH

Credit Nate

Decompiler Sigma

Make sure that state is carried through all of the decompiler.
A difficult function will be try_custom_tactics since it produces different sigmas for each subgoal.

Include in PUMPKIN PATCH build process

Clean code

Fix debruijn bugs, or use built-in Coq functions

License

Update to latest Coq version

Use good evar_map hygiene