📝 Artifact evaluation files

artifact-clean/INSTRUCTIONS.md → artifact-clean/INSTALL.md

@@ -1,4 +1,4 @@
-# Trocq
+# Install instructions
 
 0. We use the Opam package manager, please install it from the
    official Opam webpage: https://opam.ocaml.org/doc/Install.html
@@ -30,3 +30,12 @@
    - 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 <n> <k>` instead of `Type`, meaning the universes in the source goal were annotated with inferred parametricity classes.

artifact-clean/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ 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.

artifact-clean/README.md

@@ -0,0 +1,31 @@
+# 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

artifact-clean/REQUIREMENTS.md

@@ -0,0 +1,5 @@
+# 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.

artifact-clean/STATUS.md

@@ -0,0 +1,15 @@
+# Badges applied for
+
+We apply for the Functional, Reusable and Available badges on this artifact.
+
+## Functional
+
+We believe that this artifact covers the content of the paper. Indeed, the Coq files include a formalisation of the parametricity witness types presented in the paper, proofs of equivalence of the highest witness type with univalent parametricity, and various lemmas (symmetry, reflexivity, *etc.*). The fact that these proofs are formal proofs gives extra confidence that our results are correct. The Elpi files contain a parametricity framework implementation on top of this hierarchy of parametricity witness types. The architecture of the plugin enables the presentation of readable code, such as the `param.elpi` file corresponding to the core of the inference rules presented in the paper.
+
+## Reusable
+
+This artifact is in reality a specially packaged version of a Coq plugin that, as such, aims to be installed by a substantial number of users and to evolve with the proof assistant in the mid term. To that end, we provide extensive documentation, both for users and developers, and the architecture of the plugin is made so that a user can actually make use of it in conditions of a real Coq formalisation.
+
+## Available
+
+todo (Zenodo?)