The main goal of this project is to speed up the process of learning a new language by suggesting ways to fix source code.
Tidyparse recognizes files ending in *.tidy which contain a context-free grammar, followed by three consecutive dashes (---), followed by the string to parse (with optional holes). If the string is valid according to the CFG, it will print out the parse tree, otherwise if the line contains errors, it will print out suggestions how the string in question can be fixed, alongside the fragments which can be parsed.
To use this plugin, first clone the parent repository and initialize the submodule like so:
git clone https://github.com/breandan/tidyparse && \
cd tidyparse && \
git submodule update --init --recursiveThen, depending on whether you want to run the IntelliJ Plugin or browser demo, run ./gradlew runIde or ./gradlew browserDevelopmentRun --continuous.
Create a new file, if_lang.tidy, containing the following context-free grammar:
S -> X
X -> B | I | F | P
P -> I O I
F -> IF | BF
IF -> if B then I else I
BF -> if B then B else B
O -> + | - | * | /
I -> 1 | 2 | 3 | 4 | IF
B -> true | false | B BO B | ( B ) | BF
BO -> and | or
---
The same file may also contain a test case, for example:
if true then if true then 1 else 2 else 3
If the string is valid, as shown above, Tidyparse should display the following output:
✅ Current line parses! Tree:
START [0..10]
├── if
├── true
├── then
├── I [3..8]
│ ├── if
│ ├── true
│ ├── then
│ ├── 1
│ ├── else
│ └── 2
├── else
└── 1
If Tidyparse is unable to parse the string, for example, as shown below:
if ( true or false ) then true else 1
It will instead display admissible fixes ranked by edit distance and partial AST branches for all syntactically valid substrings:
❌ Current line invalid, possible fixes:
if ( true or false ) then <I> else 1
if ( true or false ) then true else <B>
if ( true or false ) then true else ! <B>
if ( true or false ) then true else <N> <B>
if ( true or false ) then true else ! ! <B>
if ( true or false ) then true else ! <N> <B>
if ( true or false ) then true else <N> <N> <B>
if ( true or false ) then true else <B> <BO> <B>
if ( true or false ) then true else ( ! <B> )
if ( true or false ) then true else <N> ! ! <B>
if ( true or false ) then true else <N> ! <N> <B>
if ( true or false ) then true else ! <B> <BO> <B>
if ( true or false ) then true else <N> <N> <N> <B>
if ( true or false ) then true else <N> <B> <BO> <B>
──────────────────────────────────────────────────
Parseable subtrees (5 leaves / 1 branch)
🌿 🌿 🌿
└── if [0] └── then [6] └── true [7]
🌿 🌿
└── else [8] └── 1 [9]
🌿
└── B [1..5]
├── ( [1]
├── B [2..4]
│ ├── true [2]
│ ├── or [3]
│ └── false [4]
└── ) [5]
Tidyparse also accepts holes in the test case. Holes may either be _, or a nonterminal enclosed in angle brackets such as <BO>:
if _ _ _ _ _ _ <BO> _ _ _ _ _
Providing such a test case will suggest candidates that are consistent with the provided CFG, ranked by length:
if <B> then <B> else <B> <BO> <B>
if <B> then <B> else ! <B> <BO> <B>
if <B> then <B> else <N> <B> <BO> <B>
if <B> then <B> else ( <B> <BO> <B> )
if <B> then <B> else <N> <B> <BO> ! <B>
if <B> then <B> else <N> <B> <BO> <N> <B>
if <B> then <B> else <B> <BO> <B> <BO> <B>
if <B> then <B> else ( <B> <BO> <N> <B> )
if <B> then <B> else <N> <B> <BO> ! <N> <B>
if <B> then <B> else ! <B> <BO> <B> <BO> <B>
if <B> then <B> else <N> <B> <BO> <N> <N> <B>
if <B> then <B> else <N> <B> <BO> <B> <BO> <B>
if ( <B> ) then <N> <B> <BO> <N> <B> else <B>
if <B> then <B> else ( <B> <BO> <B> ) <BO> <B>
if <N> <N> ! <B> then <B> <BO> <N> <B> else <B>
if <B> then <B> else ! <B> <BO> <B> <BO> <N> <B>
if <N> <B> then <B> else <B> <BO> <N> <N> <N> <B>
if <B> then <B> else <N> <B> <BO> <B> <BO> <N> <B>
if <B> then <B> else ( <B> <BO> <B> ) <BO> ! <B>
if <B> then <B> else ( <B> <BO> <B> ) <BO> <N> <B>
if <B> then <B> else <N> <B> <BO> <N> <B> <BO> <N> <B>
Note how synthesized repairs need not necessarily use the entire sketch template: this is because Tidyparse adds an invisible ε (representing the empty token) to every production in the original CFG, in addition to various other cosmetic transformations. For diagnostic purposes, Tidyparse will display the CFG at various stages during the rewrite process, e.g.:
─────────────────────────────────────────────────────────────────────────────
Original form (12 nonterminals / 18 terminals / 38 productions)
O → + I → IF START → N
O → - F → IF START → IF
O → * F → BF START → BF
O → / BO → or START → BO
X → I BO → and B → BF
X → F P → I O I B → N B
X → P START → S B → true
N → ! START → X B → false
S → X START → P B → ( B )
I → 1 START → F B → B BO B
I → 2 START → O BF → if B then B else B
I → 3 START → I IF → if B then I else I
I → 4 START → B
─────────────────────────────────────────────────────────────────────────────
Normal form (24 nonterminals / 24 terminals / 72 productions)
F.( → ( else.B → F.else B START → 2
F.) → ) else.I → F.else I START → 3
F.ε → ε B.else.B → B else.B START → 4
O → * I.else.I → I else.I START → !
O → + B → N B START → or
O → - B → <B> START → N B
O → / B → true START → and
O → <O> B → B ε+ START → O ε+
O → O ε+ B → false START → N ε+
N → ! B → B BO.B START → B ε+
N → <N> B → F.( B.) START → true
N → N ε+ B → F.if B.then.B.else.B START → I ε+
F.if → if I → 1 START → BO ε+
O.I → O I I → 2 START → I O.I
BO → or I → 3 START → false
BO → and I → 4 START → B BO.B
BO → <BO> I → <I> START → F.( B.)
BO → BO ε+ I → I ε+ START → START F.ε
ε+ → ε I → F.if B.then.I.else.I START → F.if B.then.I.else.I
ε+ → ε+ ε+ START → * START → F.if B.then.B.else.B
B.) → B F.) START → + then.B.else.B → F.then B.else.B
BO.B → BO B START → - then.I.else.I → F.then I.else.I
F.else → else START → / B.then.B.else.B → B then.B.else.B
F.then → then START → 1 B.then.I.else.I → B then.I.else.I
For further examples, please refer to the examples subdirectory.
- Tidyparse treats contiguous non-whitespace characters as a single token and makes no distinction between lexical and syntactic analysis: tokens must be separated by one or more whitespace characters, and each terminal in the grammar corresponds to exactly one token.
- Nonterminal stubs are surrounded by angle brackets, e.g.,
<F>. If the autocompletion dialog is invoked while the caret is surrounded by a nonterminal, Tidyparse will display a list of possible expansions. - Rendering is done on-the-fly but may not reflect the current state of the editor. To refresh the display, type an extra whitespace character.
- By default, Tidyparse adds ε-productions
{V} -> ε {V} | {V} εand terminal literals{V} -> <V>for each nonterminalVin the CFG. For further details about these transformations and the repair procedure, please refer to our whitepaper. - The token
εis reserved and must not be used anywhere in the grammar, or the results are undefined. - Any token appearing on the left-hand side of a production is considered a nonterminal and all other tokens are considered terminals.
- The strings
---and->are reserved and should only be used in the following contexts:---is used to separate the CFG from the test cases.->is used to separate the nonterminal from the RHS of a production.
- Any line in the grammar which does not contain
->is considered a comment and will be ignored. - If the grammar does not contain a nonterminal named
START, Tidyparse will add one with a productionSTART -> {V}for every nonterminalVin the grammar. - BNF can be translated to Tidyparse by replacing
::=with->, removing the enclosing angle brackets from nonterminals, and"from terminals.
The following individuals have helped shape this project through their thoughtful feedback. Please check out their work.