Moving FStar.Pprint into the (normal, application) library #3582
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Stubs namespace is for pointing to internal compiler modules, where Pprint is implemented (FStarC_Pprint.ml). However, it makes sense for applications to want to use pretty-printing without any relation to the compiler internals, so this module should just be a normal module in the library, which is what this patch does. Ideally, we would also remove the FStarC.Pprint.fsti from src/, and use this, but there are some problems wrt effect polymorphism. So, we just duplicate them for now (the interface was already duplicated partly due to that).
We had essentially a type error, likely since extraction did not know about FStar.Pprint. This is more reason to ditch FStar.Stubs and just use FStarC.
mtzguido
added a commit
to mtzguido/pulse
that referenced
this pull request
Oct 17, 2024
mtzguido
added a commit
to mtzguido/steel
that referenced
this pull request
Oct 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This exposes the pretty-printing module for all F* applications by placing it into
FStar.Pprint.fsti, instead ofFStar.Stubs.Pprint.fsti. TheFStar.Stubsnamespace is for interacting with compiler internals, which made sense since FStarC_Pprint.ml is the implementation of this module, but prevents normal applications from using pretty printing without bringing in the rest of the compiler.This removes this problem by just making this a normal ulib module. The compile still uses a different version internally, due to needing it in the ML effect, but this does not concern F* application writers.
It also fixes a nasty issue I hadn't noticed where extracting a literal doc was essentially returning
Obj.magic (). This is since extraction does not know aboutFStar.Pprint.docwhich is what FStar.Stubs.Pprint (with --codegen OCaml) was translated to, since the FStar.Pprint module doesn't exist. The right thing here, now that FStar and FStarC are distinguished, is drop the Stubs namespace and have an FStarC namespace of interfaces in ulib, avoiding the name wrangling.