public void Completion_Grammar_Antlr()
{
var cwd = System.IO.Directory.GetCurrentDirectory();
// arrange
var input = System.IO.File.ReadAllText("../../../Grammar/Expr.g4");
var inputStream = new AntlrInputStream(input);
var lexer = new ANTLRv4Lexer(inputStream);
var tokenStream = new CommonTokenStream(lexer);
var parser = new ANTLRv4Parser(tokenStream);
lexer.RemoveErrorListeners();
parser.RemoveErrorListeners();
var errorListener = new CountingErrorListener();
parser.AddErrorListener(errorListener);
// act
// assert
// Specify our entry point
var tree = parser.grammarSpec();
Check.That(errorListener.ErrorCount).IsEqualTo(0);
var core = new CodeCompletionCore(parser, null, null);
// 1) At the input start.
var candidates = core.CollectCandidates(0, null);
Check.That(candidates.Tokens).HasSize(4);
Check.That(candidates.Tokens).ContainsKey(ANTLRv4Lexer.DOC_COMMENT);
Check.That(candidates.Tokens).ContainsKey(ANTLRv4Lexer.LEXER);
Check.That(candidates.Tokens).ContainsKey(ANTLRv4Lexer.PARSER);
Check.That(candidates.Tokens).ContainsKey(ANTLRv4Lexer.GRAMMAR);
Check.That(candidates.Tokens[ANTLRv4Lexer.LEXER]).IsEqualTo(new[] { ANTLRv4Lexer.GRAMMAR });
Check.That(candidates.Tokens[ANTLRv4Lexer.PARSER]).IsEqualTo(new[] { ANTLRv4Lexer.GRAMMAR });
Check.That(candidates.Tokens[ANTLRv4Lexer.DOC_COMMENT]).HasSize(0);
Check.That(candidates.Tokens[ANTLRv4Lexer.GRAMMAR]).HasSize(0);
Check.That(candidates.Rules.Count == 0);
// 2) Go to token index = 3 => ";"
candidates = core.CollectCandidates(3, null);
Check.That(candidates.Tokens).HasSize(1);
Check.That(candidates.Tokens).ContainsKey(ANTLRv4Lexer.SEMI);
Check.That(candidates.Rules.Count == 0);
// 3) Go to token index = 14 => just after the ";" of the rule for "expression".
candidates = core.CollectCandidates(14, null);
Check.That(candidates.Tokens).HasSize(3);
Check.That(candidates.Tokens).ContainsKey(ANTLRv4Lexer.CATCH);
Check.That(candidates.Tokens).ContainsKey(ANTLRv4Lexer.FINALLY);
Check.That(candidates.Tokens).ContainsKey(ANTLRv4Lexer.RULE_REF); // CRASH because -2 is not a token, it is epsilon!
}
public void Completion_Grammar_X()
{
var cwd = System.IO.Directory.GetCurrentDirectory();
// arrange
var input = @"A B G";
var inputStream = new AntlrInputStream(input);
var lexer = new XLexer(inputStream);
var tokenStream = new CommonTokenStream(lexer);
var parser = new XParser(tokenStream);
lexer.RemoveErrorListeners();
parser.RemoveErrorListeners();
var errorListener = new CountingErrorListener();
parser.AddErrorListener(errorListener);
// act
// assert
// Specify our entry point
var tree = parser.a();
Check.That(errorListener.ErrorCount).IsEqualTo(0);
var core = new CodeCompletionCore(parser, null, null);
// 1) At the input start index = 0 => ". A B G"
var candidates = core.CollectCandidates(0, null);
Check.That(candidates.Tokens).HasSize(1);
Check.That(candidates.Tokens).ContainsKey(XLexer.A);
Check.That(candidates.Rules.Count == 0);
// 2) Go to token index = 3 => "A B ."
// candidates = core.CollectCandidates(3, null);
candidates = core.CollectCandidates(2, null);
Check.That(candidates.Tokens).HasSize(10);
// Set should contain C, D, E, F, G, X, Y, Z, M, N
// e.g., "A B C D G" is parsed fine.
// Instead, what we see is C, X, Y, and of course, -2 = epsilon.
}
public void Completion_Grammar_TypicalExpression()
{
// arrange
var expression = "var c = a + b";
var inputStream = new AntlrInputStream(expression);
var lexer = new ExprLexer(inputStream);
var tokenStream = new CommonTokenStream(lexer);
var parser = new ExprParser(tokenStream);
parser.Interpreter.PredictionMode = PredictionMode.LlExactAmbigDetection;
lexer.RemoveErrorListeners();
parser.RemoveErrorListeners();
var errorListener = new CountingErrorListener();
parser.AddErrorListener(errorListener);
// act
// assert
// Specify our entry point
var tree = parser.expression();
Check.That(errorListener.ErrorCount).IsEqualTo(0);
// Tell the engine to return certain rules to us, which we could use to look up values in a symbol table.
var preferredRules = new HashSet <int>()
{
ExprParser.RULE_functionRef, ExprParser.RULE_variableRef
};
// Ignore operators and the generic ID token.
var ignoredTokens = new HashSet <int>()
{
ExprLexer.PLUS, ExprLexer.MINUS,
ExprLexer.MULTIPLY, ExprLexer.DIVIDE
};
var core = new CodeCompletionCore(parser, preferredRules, ignoredTokens);
// 1) At the input start.
var candidates = core.CollectCandidates(0, null);
Check.That(candidates.Tokens).HasSize(2);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.VAR);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.LET);
Check.That(candidates.Tokens
.TryGetValue(ExprLexer.VAR, out var varCandidates))
.IsTrue();
Check.That(candidates.Tokens
.TryGetValue(ExprLexer.LET, out var letCandidates))
.IsTrue();
Check.That(varCandidates).HasSize(2);
Check.That(letCandidates).HasSize(2);
Check.That(varCandidates).IsEqualTo(new[] { ExprLexer.ID, ExprLexer.EQUAL });
Check.That(letCandidates).IsEqualTo(new[] { ExprLexer.ID, ExprLexer.EQUAL });
// 2) On the variable name ('c').
ignoredTokens = new HashSet <int>()
{
ExprLexer.ID, ExprLexer.PLUS, ExprLexer.MINUS,
ExprLexer.MULTIPLY, ExprLexer.DIVIDE, ExprLexer.EQUAL
};
core = new CodeCompletionCore(parser, preferredRules, ignoredTokens);
candidates = core.CollectCandidates(2, null);
Check.That(candidates.Tokens).HasSize(0);
// 4) On the equal sign (ignoring whitespace positions from now on).
candidates = core.CollectCandidates(4, null);
Check.That(candidates.Tokens).HasSize(0);
// 5) On the variable reference 'a'.
candidates = core.CollectCandidates(6, null);
Check.That(candidates.Tokens).HasSize(0);
Check.That(candidates.Rules).HasSize(2);
// Here we get 2 rule indexes, derived from 2 different IDs possible at this caret position.
// These are what we told the engine above to be preferred rules for us.
var found = 0;
foreach (var candidate in candidates.Rules)
{
switch (candidate.Key)
{
case ExprParser.RULE_functionRef:
{
found++;
break;
}
case ExprParser.RULE_variableRef:
{
found++;
break;
}
}
}
Check.That(found).Equals(2);
// 6) On the whitespace after the 'a'
candidates = core.CollectCandidates(7, null);
Check.That(candidates.Tokens).HasSize(0);
Check.That(candidates.Rules).HasSize(1);
// Here we get 2 rule indexes
found = 0;
foreach (var candidate in candidates.Rules)
{
switch (candidate.Key)
{
case ExprParser.RULE_functionRef:
{
found++;
break;
}
case ExprParser.RULE_variableRef:
{
found++;
break;
}
}
}
Check.That(found).Equals(1);
}
public void Completion_Grammar_SimpleExpression()
{
// arrange
var input = "var c = a + b()";
var inputStream = new AntlrInputStream(input);
var lexer = new ExprLexer(inputStream);
var tokenStream = new CommonTokenStream(lexer);
var parser = new ExprParser(tokenStream);
lexer.RemoveErrorListeners();
parser.RemoveErrorListeners();
var errorListener = new CountingErrorListener();
parser.AddErrorListener(errorListener);
// act
// assert
// Specify our entry point
var tree = parser.expression();
Check.That(errorListener.ErrorCount).IsEqualTo(0);
var core = new CodeCompletionCore(parser, null, null);
// 1) At the input start.
var candidates = core.CollectCandidates(0, null);
Check.That(candidates.Tokens).HasSize(3);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.VAR);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.LET);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.ID);
Check.That(candidates.Tokens[ExprLexer.VAR]).IsEqualTo(new[] { ExprLexer.ID, ExprLexer.EQUAL });
Check.That(candidates.Tokens[ExprLexer.LET]).IsEqualTo(new[] { ExprLexer.ID, ExprLexer.EQUAL });
Check.That(candidates.Tokens[ExprLexer.ID]).HasSize(0);
// 2) On the first whitespace. In real implementations you would do some additional checks where in the whitespace
// the caret is, as the outcome is different depending on that position.
candidates = core.CollectCandidates(1, null);
Check.That(candidates.Tokens).HasSize(1);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.ID);
// 3) On the variable name ('c').
candidates = core.CollectCandidates(2, null);
Check.That(candidates.Tokens).HasSize(1);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.ID);
// 4) On the equal sign (ignoring whitespace positions from now on).
candidates = core.CollectCandidates(4, null);
Check.That(candidates.Tokens).HasSize(1);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.EQUAL);
// 5) On the variable reference 'a'. But since we have not configure the c3 engine to return us var refs
// (or function refs for that matter) we only get an ID here.
candidates = core.CollectCandidates(6, null);
Check.That(candidates.Tokens).HasSize(1);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.ID);
// 6) On the '+' operator. Usually you would not show operators as candidates, but we have not set up the c3 engine
// yet to not return them.
candidates = core.CollectCandidates(8, null);
Check.That(candidates.Tokens).HasSize(5);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.PLUS);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.MINUS);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.MULTIPLY);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.DIVIDE);
Check.That(candidates.Tokens).ContainsKey(ExprLexer.OPEN_PAR);
}
public void Test1()
{
{
var input = @"grammar Expr;
expression: assignment | simpleExpression;
assignment
: (VAR | LET) ID EQUAL simpleExpression
;
simpleExpression
: simpleExpression (PLUS | MINUS) simpleExpression
| simpleExpression (MULTIPLY | DIVIDE) simpleExpression
| variableRef
| functionRef
;
variableRef
: ID
;
functionRef
: ID OPEN_PAR CLOSE_PAR
;
VAR: [vV] [aA] [rR];
LET: [lL] [eE] [tT];
PLUS: '+';
MINUS: '-';
MULTIPLY: '*';
DIVIDE: '/';
EQUAL: '=';
OPEN_PAR: '(';
CLOSE_PAR: ')';
ID: [a-zA-Z] [a-zA-Z0-9_]*;
WS: [ \n\r\t] -> channel(HIDDEN);
";
var inputStream = new AntlrInputStream(input);
var lexer = new ANTLRv4Lexer(inputStream);
var tokenStream = new CommonTokenStream(lexer);
var parser = new ANTLRv4Parser(tokenStream);
lexer.RemoveErrorListeners();
parser.RemoveErrorListeners();
var errorListener = new CountingErrorListener();
parser.AddErrorListener(errorListener);
var tree = parser.grammarSpec();
Assert.True(errorListener.ErrorCount == 0);
var core = new CodeCompletionCore(parser, null, null);
{
var candidates = core.CollectCandidates(0, null);
var t1 = candidates.Tokens.Count == 4;
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.DOC_COMMENT));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.GRAMMAR));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.PARSER));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.LEXER));
}
{
int index = 0;
foreach (var t in tokenStream.GetTokens())
{
if (t.Text == "assignment") // Stop on first "assignment"
{
index = t.TokenIndex;
break;
}
}
var candidates = core.CollectCandidates(index, null);
Assert.True(index == 8);
Assert.True(candidates.Tokens.Count == 9);
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.TOKEN_REF));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.RULE_REF));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.STRING_LITERAL));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.BEGIN_ACTION));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.LPAREN));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.LT));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.DOT));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.NOT));
Assert.True(candidates.Tokens.ContainsKey(-2));
}
{
int index = 0;
foreach (var t in tokenStream.GetTokens())
{
if (t.Text == ":") // Stop on first ":"
{
index = t.TokenIndex;
break;
}
}
var candidates = core.CollectCandidates(index, null);
Assert.True(index == 6);
Assert.True(candidates.Tokens.Count == 7);
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.BEGIN_ARGUMENT));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.OPTIONS));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.RETURNS));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.LOCALS));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.THROWS));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.COLON));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.AT));
}
}
{
var input = @"grammar Expr;
expression: assignment | simpleExpression;
assignment
: (VAR | LET) ID EQUAL simpleExpression
;
";
var inputStream = new AntlrInputStream(input);
var lexer = new ANTLRv4Lexer(inputStream);
var tokenStream = new CommonTokenStream(lexer);
var parser = new ANTLRv4Parser(tokenStream);
lexer.RemoveErrorListeners();
parser.RemoveErrorListeners();
var errorListener = new CountingErrorListener();
parser.AddErrorListener(errorListener);
var tree = parser.grammarSpec();
Assert.True(errorListener.ErrorCount == 0);
var core = new CodeCompletionCore(parser, null, null);
{
var candidates = core.CollectCandidates(0, null);
var t1 = candidates.Tokens.Count == 4;
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.DOC_COMMENT));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.GRAMMAR));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.PARSER));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.LEXER));
}
{
int index = 0;
foreach (var t in tokenStream.GetTokens())
{
if (t.Text == "assignment") // Stop on first "assignment"
{
index = t.TokenIndex;
break;
}
}
var candidates = core.CollectCandidates(index, null);
Assert.True(index == 8);
Assert.True(candidates.Tokens.Count == 9);
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.TOKEN_REF));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.RULE_REF));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.STRING_LITERAL));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.BEGIN_ACTION));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.LPAREN));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.LT));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.DOT));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.NOT));
Assert.True(candidates.Tokens.ContainsKey(-2));
}
{
int index = 0;
foreach (var t in tokenStream.GetTokens())
{
if (t.Text == ":") // Stop on first ":"
{
index = t.TokenIndex;
break;
}
}
var candidates = core.CollectCandidates(index, null);
Assert.True(index == 6);
Assert.True(candidates.Tokens.Count == 7);
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.BEGIN_ARGUMENT));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.OPTIONS));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.RETURNS));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.LOCALS));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.THROWS));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.COLON));
Assert.True(candidates.Tokens.ContainsKey(ANTLRv4Parser.AT));
}
{
int index = 0;
int times = 0;
foreach (var t in tokenStream.GetTokens())
{
if (t.Text == ";") // Stop on ";"
{
if (++times == 3)
{
index = t.TokenIndex + 1;
break;
}
}
}
var candidates = core.CollectCandidates(index, null);
// candidates includes CATCH, FINALLY, -2. Why? Why not include
// DOC_COMMENT, RULE_REF, ...?
}
}
}