diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md new file mode 100644 index 0000000..9977a6f --- /dev/null +++ b/GETTING_STARTED.md @@ -0,0 +1,95 @@ +# Getting started + +## What is Trocq? + +Trocq is a prototype of a modular parametricity plugin for Coq, aiming +to perform proof transfer by translating the goal into an associated +goal featuring the target data structures as well as a rich +parametricity witness from which a function justifying the goal +substitution can be extracted. + +The plugin features a hierarchy of parametricity witness types, +ranging from structure-less relations to a new formulation of type +equivalence, gathering several pre-existing parametricity +translations, including +[univalent parametricity](https://doi.org/10.1145/3429979) and +[CoqEAL](https://github.com/coq-community/coqeal), in the same framework. + +This modular translation performs a fine-grained analysis and +generates witnesses that are rich enough to preprocess the goal yet +are not always a full-blown type equivalence, allowing to perform +proof transfer with the power of univalent parametricity, but trying +not to pull in the univalence axiom in cases where it is not required. + +The translation is implemented in Coq-Elpi and features transparent +and readable code with respect to a sequent-style theoretical presentation. + +## Getting the right setup + +This artifact contains an implementation of the Trocq parametricity framework as +a plugin for the Coq proof assistant. As such, we offer several possibilities +for the reader, according to their level of familiarity with the ecosystem and +interest in our work for their own use. All methods were tested on Linux and +macOS, we therefore recommend that the reader use one of these operating +systems. + +### Via VSCode and Docker (recommended) + +In this set-up, the reader considers this code mainly as the artifact for our +paper, and thus wants to check it is working properly. To that end, we propose +to interact in an easy way with a Docker container containing our code. The main +requirement for the reader is to have [Docker](https://www.docker.com) and +[VSCode](https://code.visualstudio.com) installed on their machine. You also +need to ensure you have more than 6GB of disk space available. + +Here are the instructions: +- Make sure your VSCode has the [Dev + Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) + extension by running `code --install-extension + ms-vscode-remote.remote-containers` or from the menus. +- Clone or download the repository of the [Trocq + plugin](https://github.com/coq-community/trocq), e.g. + `curl -L -O https://github.com/coq-community/trocq/archive/master.zip && unzip master.zip` +- Run VSCode in it (e.g. `code trocq-master`) and immediately after opening it + will suggest to "Reopen in Container", click this (otherwise type F1 and + "Reopen in Container"). +- Wait for VSCode to download a 1.28 GB archive that extracts to about 6 GB, on + our system this takes about 2 min. +- Wait for VSCode to compile the code of the plugin, this takes about 30s. + +### Via Opam (ocaml/coq/opam users only) or Nix (nix/nixos users only) + +Please refer to the main README.md + +## Exploring the examples + +After completing the **Getting the right setup** phase above, the `examples` +folder can be unfolded and the files can be inspected by clicking on them. + +When a file is clicked, it is displayed and a `Goals` tab opens. It shows the +state of step-by-step execution of the file by Coq. The main actions related to +the Trocq plugin are the `Trocq Use` commands feeding the database of the +plugin, and the `trocq` tactic actually performing the expected proof transfer +step. + +One can check that this tactic is working as expected by clicking right before +it in the Coq file, waiting for Coq to execute the file until the pointer and +update the proof state in the `Goals` panel, then clicking right after the dot +after `trocq` and waiting for the proof state to be updated with the associated +goal generated by Trocq to replace the initial one. Please note that on the +first time a line is clicked in a file, the proof state can take a few seconds +to update. + +### Example from the artifact paper + +In file `artifact_paper_example.v`, this amounts to putting the pointer on line +38 column 7 (counter visible on the bottom right-hand side of the editor), then +on line 38 column 14 and checking the updated goal is the expected one (in this +particular case, featuring `nat` in the associated goal instead of `N` in the +initial goal). + +### Examples from the Trocq paper + +## Exploring the code + +### \ No newline at end of file diff --git a/artifact-clean/GETTING_STARTED.md b/artifact-clean/GETTING_STARTED.md deleted file mode 100644 index ae65dd5..0000000 --- a/artifact-clean/GETTING_STARTED.md +++ /dev/null @@ -1,38 +0,0 @@ -# Getting started - -This artifact contains an implementation of the Trocq parametricity framework as a plugin for the Coq proof assistant. As such, we offer several possibilities for the reader, according to their level of familiarity with the ecosystem and interest in our work for their own use. All methods were tested on Linux and macOS, we therefore recommend that the reader use one of these operating systems. - -## Getting the right setup - -### Via VSCode and Docker (recommended) - -In this set-up, the reader considers this code mainly as the artifact for our paper, and thus wants to check it is working properly. To that end, we propose to interact in an easy way with a Docker container containing our code. The main requirement for the reader is to have [Docker](https://www.docker.com) and [VSCode](https://code.visualstudio.com) installed on their machine. You also need to ensure you have more than 6GB of disk space available. - -Here are the instructions: -- Make sure your VSCode has the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension by running `code --install-extension ms-vscode-remote.remote-containers` or from the menus. -- Clone or download the repository of the [Trocq plugin](https://github.com/coq-community/trocq), e.g. - `curl -L -O https://github.com/coq-community/trocq/archive/master.zip && unzip master.zip` -- Run VSCode in it (e.g. `code trocq-master`) and immediately after opening it will suggest to "Reopen in Container", click this (otherwise type F1 and "Reopen in Container"). -- Wait for VSCode to download a 1.28 GB archive that extracts to about 6 GB, on our system this takes about 2 min. -- Wait for VSCode to compile the code of the pluging, this takes about 30s. - -### Via Opam (ocaml/coq/opam users only) or Nix (nix/nixos users only) - -Please refer to the main README.md - -## Exploring the examples - -After completing the **Getting the right setup** phase above, -the `examples` folder can be unfolded and the files can be inspected by clicking on them. - -When a file is clicked, it is displayed and a `Goals` tab opens. It shows the state of step-by-step execution of the file by Coq. The main actions related to the Trocq plugin are the `Trocq Use` commands feeding the database of the plugin, and the `trocq` tactic actually performing the expected proof transfer step. - -One can check that this tactic is working as expected by clicking right before it in the Coq file, waiting for Coq to execute the file until the pointer and update the proof state in the `Goals` panel, then clicking right after the dot after `trocq` and waiting for the proof state to be updated with the associated goal generated by Trocq to replace the initial one. Please note that on the first time a line is clicked in a file, the proof state can take a few seconds to update. - -In file `artifact_paper_example.v`, this amounts to putting the pointer on line 38 column 7 (counter visible on the bottom right-hand side of the editor), then on line 38 column 14 and checking the updated goal is the expected one (in this particular case, featuring `nat` in the associated goal instead of `N` in the initial goal). - -## Examples from the paper - -### Example from the artifact paper - -### Examples from the Trocq paper diff --git a/artifact-clean/INSTALL.md b/artifact-clean/INSTALL.md deleted file mode 100644 index f1398f9..0000000 --- a/artifact-clean/INSTALL.md +++ /dev/null @@ -1,41 +0,0 @@ -# Install instructions - -0. We use the Opam package manager, please install it from the - official Opam webpage: https://opam.ocaml.org/doc/Install.html - and add the Coq opam repository, with the following command: - `opam repo add coq-released https://coq.*/opam/released` - -1. Create a fresh Opam switch (development was done with - OCaml 4.12.0, but anything newer should work). An existing switch may - also be used, if: - - the version the `coq` package is at least 8.17 and - - the `coq-hott` packaged is either not installed or at version 8.17 and - - package `coq-elpi` is **not** installed. - - The plugin indeed requires a custom version of Coq-Elpi, with features - related to universe polymorphism that are still experimental. This - is why a version of the Coq-Elpi sources is included in this - artifact. - -2. Install Trocq and its dependencies by running `make` in the root - directory of the archive. - -3. Open your IDE at the root of the `trocq` directory. Open and execute - any of the example files present in the `trocq/examples` directory. - - The examples have been put inside the `trocq` project for the sake of - convenience, so that the `-noinit` and `-indices-matter` options of `coqtop` are taken into account in the IDE. - - Please use either: - - CoqIDE (available in your switch via `opam install coqide`) - - VSCode or VSCodium with the **VSCoq Legacy** extension. - - emacs together with proof-general - -# Success indicators - -As the `_CoqProject` file in Trocq contains the example files, successfully installing Trocq, *i.e.*, seeing the following lines in your console, means that the code works as intended: -``` -* installed trocq.dev -Done. -``` -Another way to be sure it works is to execute step by step the `Example.v` file and see that the displayed goal after running the tactic features `PType ` instead of `Type`, meaning the universes in the source goal were annotated with inferred parametricity classes. diff --git a/artifact-clean/LICENSE b/artifact-clean/LICENSE deleted file mode 100644 index 0a04128..0000000 --- a/artifact-clean/LICENSE +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser 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 -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/artifact-clean/Makefile b/artifact-clean/Makefile deleted file mode 100644 index 428c2a7..0000000 --- a/artifact-clean/Makefile +++ /dev/null @@ -1,8 +0,0 @@ -.PHONY: all - -all: - opam install -y ./coq-elpi - opam install -y ./trocq - -clean: - opam uninstall coq-elpi coq-trocq \ No newline at end of file diff --git a/artifact-clean/README.md b/artifact-clean/README.md deleted file mode 100644 index ade825d..0000000 --- a/artifact-clean/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# Trocq - -Trocq is a prototype of a modular parametricity plugin for Coq, aiming -to perform proof transfer by translating the goal into an associated -goal featuring the target data structures as well as a rich -parametricity witness from which a function justifying the goal -substitution can be extracted. - -The plugin features a hierarchy of parametricity witness types, -ranging from structure-less relations to a new formulation of type -equivalence, gathering several pre-existing parametricity -translations, including -[univalent parametricity](https://doi.org/10.1145/3429979) and -[CoqEAL](https://github.com/coq-community/coqeal), in the same framework. - -This modular translation performs a fine-grained analysis and -generates witnesses that are rich enough to preprocess the goal yet -are not always a full-blown type equivalence, allowing to perform -proof transfer with the power of univalent parametricity, but trying -not to pull in the univalence axiom in cases where it is not required. - -The translation is implemented in Coq-Elpi and features transparent -and readable code with respect to a sequent-style theoretical presentation. - -## How to reproduce the results of the paper - -todo - -## Relation between the files and the theoretical presentation in the paper - -todo \ No newline at end of file diff --git a/artifact-clean/REQUIREMENTS.md b/artifact-clean/REQUIREMENTS.md deleted file mode 100644 index dfdb812..0000000 --- a/artifact-clean/REQUIREMENTS.md +++ /dev/null @@ -1,5 +0,0 @@ -# Requirements - -Trocq can be installed by using the provided Makefile, which mainly uses the `coq-trocq.opam` Opam file listing the various dependencies of the project. They can be installed on the fly from a blank switch. The main software requirement is therefore having Opam installed on your machine. - -This plugin was tested on Linux and macOS. \ No newline at end of file diff --git a/artifact-clean/coq-elpi b/artifact-clean/coq-elpi deleted file mode 160000 index 8cb61ed..0000000 --- a/artifact-clean/coq-elpi +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 8cb61ede0077079129f08801f13023b3d93b5d20 diff --git a/artifact-clean/STATUS.md b/artifact/STATUS.md similarity index 100% rename from artifact-clean/STATUS.md rename to artifact/STATUS.md diff --git a/make_artifact.sh b/make_artifact.sh deleted file mode 100755 index fd5bf3e..0000000 --- a/make_artifact.sh +++ /dev/null @@ -1,26 +0,0 @@ -#!/bin/sh -rm -rf artifact-clean/trocq artifact-clean/coq-elpi -git clone -b strat --depth 1 https://github.com/ecranceMERCE/coq-elpi/ artifact-clean/coq-elpi -rm -f theories/.*.aux theories/*.glob theories/*.vo theories/*.vok theories/*.vos -mkdir artifact-clean/trocq/ -mkdir artifact-clean/trocq/theories -mkdir artifact-clean/trocq/examples -cp theories/*.v artifact-clean/trocq/theories/ -cp examples/*.v artifact-clean/trocq/examples/ -rm -f artifact-clean/trocq/theories/Inductives.v -rm -f artifact-clean/trocq/examples/list_to_seq.v -cp -R elpi artifact-clean/trocq/elpi -cp _CoqProject artifact-clean/trocq/ -cp Makefile artifact-clean/trocq/ -cp coq-trocq.opam artifact-clean/trocq/ -find artifact-clean/trocq -type f -exec sed -i 's/assia//gIm' {} + -find artifact-clean/trocq -type f -exec sed -i 's/cyril//gIm' {} + -find artifact-clean/trocq -type f -exec sed -i 's/enzo//gIm' {} + -find artifact-clean/trocq -type f -exec sed -i 's/mahboubi//gIm' {} + -find artifact-clean/trocq -type f -exec sed -i 's/cohen//gIm' {} + -find artifact-clean/trocq -type f -exec sed -i 's/crance//gIm' {} + -find artifact-clean/trocq -type f -exec sed -i 's/inria.fr//gIm' {} + -find artifact-clean/trocq -type f -exec sed -i 's/inria//gIm' {} + -find artifact-clean/trocq -type f -exec sed -i 's/merce//gIm' {} + -find artifact-clean/trocq -type f -exec sed -i 's/mitsubishi electric r.d centre europe//gIm' {} + -zip -u -r artifact-clean artifact-clean