Tidy the SAWCore parser #2331
Merged
Tidy the SAWCore parser #2331
Conversation
This file contains hidden or 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
No functional change intended. Part 1; part 2 with purely whitespace will follow separately to make it easier to audit the overall changes.
(part 2 of legibility cleanup)
Previously, if you wrote "module where" at the top of a SAWCore file (instead of "module Foo where"), it was accepted by the grammar and then called Haskell "error" to bail out. Fix the grammar so this is a parse error, and change the error call involved to a panic. This degrades the message printed a bit, maybe, since there's no longer an explicit "empty module name" message; but it now includes the offending source position, which is quite a bit more important. Add a test. Note that the source position prints as rubbish; that's a different problem (#2140)
It's important for readability to keep the grammar and the actions visually separate, but also good to not become super-wide when doing so.
sauclovian-g
requested review from
brianhuffman,
RyanGlScott,
mtullsen and
peterohanley-galois
RyanGlScott
approved these changes
May 14, 2025
Comment on lines
+194
to
+197
| | IdentRec { Recursor Nothing $1 } | ||
| | 'Prop' { Sort (pos $1) propSort noFlags } | ||
| | Sort nat { Sort (pos $1) (mkSort (tokNat (val $2))) (val $1) } | ||
| | AtomTerm '.' Ident { RecordProj $1 (val $3) } |
There was a problem hiding this comment.
The { Sort (pos $1) (mkSort (tokNat (val $2))) (val $1) } part is indented differently from the others—intentional?
There was a problem hiding this comment.
Yes, that's so it fits the advertised edit width. Which isn't obvious from here.
Comment on lines
+110
to
+112
| 'data' Ident VarCtx ':' LTerm 'where' '{' list(CtorDecl) '}' { DataDecl $2 $3 $5 $8 } | ||
| | 'primitive' Ident ':' LTerm ';' { mkPrimitive $2 $4 } | ||
| | 'axiom' Ident ':' LTerm ';' { mkAxiom $2 $4 } |
There was a problem hiding this comment.
Similar comment here about { DataDecl $2 $3 $5 $8 }.
There was a problem hiding this comment.
And that's to avoid indenting all the others by one more just because the LHS doesn't quite fit. I guess currently indenting all the others by one more would still fit the edit width (I think that wasn't true up front) so I could change it if you object strongly.
peterohanley-galois
approved these changes
May 14, 2025
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.
Make it more legible, fix a couple minor problems found while doing so.