[Java] Class GroovyRecognizer
- org.codehaus.groovy.antlr.parser.GroovyRecognizer
- All Implemented Interfaces and Traits:
- GroovyTokenTypes
public class GroovyRecognizer extends LLkParser
JSR-241 Groovy Recognizer. Run 'java Main [-showtree] directory-full-of-groovy-files' [The -showtree option pops up a Swing frame that shows the AST constructed from the parser.] Contributing authors: John Mitchell johnm
- non.net:
- Terence Parr [email protected] John Lilley [email protected] Scott Stanchfield [email protected] Markus Mohnen [email protected] Peter Williams [email protected] Allan Jacobs [email protected] Steve Messick [email protected] James Strachan [email protected] John Pybus [email protected] John Rose [email protected] Jeremy Rayner [email protected] Alex Popescu [email protected] Martin Kempf [email protected] Reto Kleeb [email protected] Version 1.00 December 9, 1997 -- initial release Version 1.01 December 10, 1997 fixed bug in octal def (0..7 not 0..8) Version 1.10 August 1998 (parrt) added tree construction fixed definition of WS,comments for mac,pc,unix newlines added unary plus Version 1.11 (Nov 20, 1998) Added "shutup" option to turn off last ambig warning. Fixed inner class def to allow named class defs as statements synchronized requires compound not simple statement add [] after builtInType DOT class in primaryExpression "const" is reserved but not valid..removed from modifiers Version 1.12 (Feb 2, 1999) Changed LITERAL_xxx to xxx in tree grammar. Updated java.g to use tokens {...} now for 2.6.0 (new feature). Version 1.13 (Apr 23, 1999) Didn't have (stat)? for else clause in tree parser. Didn't gen ASTs for interface extends. Updated tree parser too. Updated to 2.6.0. Version 1.14 (Jun 20, 1999) Allowed final/abstract on local classes. Removed local interfaces from methods Put instanceof precedence where it belongs...in relationalExpr It also had expr not type as arg; fixed it. Missing ! on SEMI in classBlock fixed: (expr) + "string" was parsed incorrectly (+ as unary plus). fixed: didn't like Object[].class in parser or tree parser Version 1.15 (Jun 26, 1999) Screwed up rule with instanceof in it. :( Fixed. Tree parser didn't like (expr).something; fixed. Allowed multiple inheritance in tree grammar. oops. Version 1.16 (August 22, 1999) Extending an interface built a wacky tree: had extra EXTENDS. Tree grammar didn't allow multiple superinterfaces. Tree grammar didn't allow empty var initializer: {} Version 1.17 (October 12, 1999) ESC lexer rule allowed 399 max not 377 max. java.tree.g didn't handle the expression of synchronized statements. Version 1.18 (August 12, 2001) Terence updated to Java 2 Version 1.3 by observing/combining work of Allan Jacobs and Steve Messick. Handles 1.3 src. Summary: o primary didn't include boolean.class kind of thing o constructor calls parsed explicitly now: see explicitConstructorInvocation o add strictfp modifier o missing objBlock after new expression in tree grammar o merged local class definition alternatives, moved after declaration o fixed problem with ClassName.super.field o reordered some alternatives to make things more efficient o long and double constants were not differentiated from int/float o whitespace rule was inefficient: matched only one char o add an examples directory with some nasty 1.3 cases o made Main.java use buffered IO and a Reader for Unicode support o supports UNICODE? Using Unicode charVocabulary makes code file big, but only in the bitsets at the end. I need to make ANTLR generate unicode bitsets more efficiently. Version 1.19 (April 25, 2002) Terence added in nice fixes by John Pybus concerning floating constants and problems with super() calls. John did a nice reorg of the primary/postfix expression stuff to read better and makes f.g.super() parse properly (it was METHOD_CALL not a SUPER_CTOR_CALL). Also: o "finally" clause was a root...made it a child of "try" o Added stuff for asserts too for Java 1.4, but *commented out* as it is not backward compatible. Version 1.20 (October 27, 2002) Terence ended up reorging John Pybus' stuff to remove some nondeterminisms and some syntactic predicates. Note that the grammar is stricter now; e.g., this(...) must be the first statement. Trinary ?: operator wasn't working as array name: (isBig ? bigDigits : digits)[i]; Checked parser/tree parser on source for Resin-2.0.5, jive-2.1.1, jdk 1.3.1, Lucene, antlr 2.7.2a4, and the 110k-line jGuru server source. Version 1.21 (October 17, 2003) Fixed lots of problems including: Ray Waldin: add typeDefinition to interfaceBlock in java.tree.g He found a problem/fix with floating point that start with 0 Ray also fixed problem that (int.class) was not recognized. Thorsten van Ellen noticed that \n are allowed incorrectly in strings. TJP fixed CHAR_LITERAL analogously. Version 1.21.2 (March, 2003) Changes by Matt Quail to support generics (as per JDK1.5/JSR14) Notes: o We only allow the "extends" keyword and not the "implements" keyword, since that's what JSR14 seems to imply. o Thanks to Monty Zukowski for his help on the antlr-interest mail list. o Thanks to Alan Eliasen for testing the grammar over his Fink source base Version 1.22 (July, 2004) Changes by Michael Studman to support Java 1.5 language extensions Notes: o Added support for annotations types o Finished off Matt Quail's generics enhancements to support bound type arguments o Added support for new for statement syntax o Added support for static import syntax o Added support for enum types o Tested against JDK 1.5 source base and source base of jdigraph project o Thanks to Matt Quail for doing the hard part by doing most of the generics work Version 1.22.1 (July 28, 2004) Bug/omission fixes for Java 1.5 language support o Fixed tree structure bug with classOrInterface - thanks to Pieter Vangorpto for spotting this o Fixed bug where incorrect handling of SR and BSR tokens would cause type parameters to be recognised as type arguments. o Enabled type parameters on constructors, annotations on enum constants and package definitions o Fixed problems when parsing if ((char.class.equals(c))) {} - solution by Matt Quail at Cenqua Version 1.22.2 (July 28, 2004) Slight refactoring of Java 1.5 language support o Refactored for/"foreach" productions so that original literal "for" literal is still used but the for sub-clauses vary by token type o Fixed bug where type parameter was not included in generic constructor's branch of AST Version 1.22.3 (August 26, 2004) Bug fixes as identified by Michael Stahl; clean up of tabs/spaces and other refactorings o Fixed typeParameters omission in identPrimary and newStatement o Replaced GT reconcilliation code with simple semantic predicate o Adapted enum/assert keyword checking support from Michael Stahl's java15 grammar o Refactored typeDefinition production and field productions to reduce duplication Version 1.22.4 (October 21, 2004) Small bux fixes o Added typeArguments to explicitConstructorInvocation, e.g. new
MyParameterised() o Added typeArguments to postfixExpression productions for anonymous inner class super constructor invocation, e.g. new Outer(). super() o Fixed bug in array declarations identified by Geoff Roy Version 1.22.4.g.1 o I have taken java.g for Java1.5 from Michael Studman (1.22.4) and have applied the groovy.diff from java.g (1.22) by John Rose back onto the new root (1.22.4) - Jeremy Rayner (Jan 2005) Version 1.22.4.g.2 o mkempf, rkleeb, Dec 2007 o fixed various rules so that they call the correct Create Method to make sure that the line information are correct Based on an original grammar released in the PUBLIC DOMAIN
Field Summary
Constructor Summary
Constructor and description |
---|
protected GroovyRecognizer
(TokenBuffer tokenBuf, int k) |
GroovyRecognizer
(TokenBuffer tokenBuf) |
protected GroovyRecognizer
(TokenStream lexer, int k) |
GroovyRecognizer
(TokenStream lexer) |
GroovyRecognizer
(ParserSharedInputState state) |
Methods Summary
Type Params | Return Type | Name and description |
---|---|---|
void |
aCase() | |
void |
addWarning(String warning, String solution) | |
void |
additiveExpression(int lc_stmt) | |
void |
andExpression(int lc_stmt) | |
void |
annotation() | |
void |
annotationArguments() | |
void |
annotationBlock() | |
void |
annotationDefinition(AST modifiers) | |
void |
annotationField() | |
void |
annotationIdent() | |
void |
annotationMemberValueInitializer() | |
void |
annotationMemberValuePair() | |
void |
annotationMemberValuePairs() | |
void |
annotationsInternal() | |
void |
annotationsOpt() | |
void |
appendedBlock(AST callee) An appended block follows any expression. | |
void |
argList() | |
byte |
argument() A single argument in (...) or [...]. | |
void |
argumentLabel() A label for an argument is of the form a:b, 'a':b, "a":b, (a):b, etc.. | |
void |
argumentLabelStart() For lookahead only. | |
void |
assignmentExpression(int lc_stmt) | |
void |
assignmentLessExpression() | |
void |
balancedBrackets() Fast lookahead across balanced brackets of all sorts. | |
void |
balancedTokens() | |
void |
blockBody(int prevToken) A block body is a parade of zero or more statements or expressions. | |
void |
branchStatement() In Groovy, return, break, continue, throw, and assert can be used in a parenthesized expression context. | |
protected void |
buildTokenTypeASTClassMap() | |
void |
builtInType() | |
void |
builtInTypeArraySpec(boolean addImagNode) | |
void |
builtInTypeSpec(boolean addImagNode) | |
void |
caseSList() | |
void |
casesGroup() | |
void |
checkSuspiciousExpressionStatement(int prevToken) If two statements are separated by newline (not SEMI), the second had better not look like the latter half of an expression. | |
void |
classBlock() | |
void |
classDefinition(AST modifiers) | |
void |
classField() | |
void |
classOrInterfaceType(boolean addImagNode) | |
void |
classTypeSpec(boolean addImagNode) | |
Token |
cloneToken(Token t) Clones the token | |
void |
closableBlock() A block which is known to be a closure, even if it has no apparent arguments. | |
void |
closableBlockConstructorExpression() | |
void |
closableBlockParam() Simple names, as in {x|...}, are completely equivalent to {(def x)|...}. | |
void |
closableBlockParamsOpt(boolean addImplicit) Closure parameters are exactly like method parameters, except that they are not enclosed in parentheses, but rather are prepended to the front of a block, just after the brace. | |
void |
closableBlockParamsStart() Lookahead to check whether a block begins with explicit closure arguments. | |
void |
closureList() | |
void |
commandArgument() | |
void |
commandArguments(AST head) A member name (x.y) or element name (x[y]) can serve as a command name, which may be followed by a list of arguments. | |
void |
commandArgumentsGreedy(AST head) | |
void |
compatibleBodyStatement() In Java, "if", "while", and "for" statements can take random, non-braced statements as their bodies. | |
void |
compilationUnit() | |
void |
compoundStatement() | |
void |
conditionalExpression(int lc_stmt) | |
void |
constant() Numeric, string, regexp, boolean, or null constant. | |
void |
constantNumber() Numeric constant. | |
void |
constructorBody() | |
void |
constructorDefinition(AST mods) I've split out constructors separately; we could maybe integrate back into variableDefinitions later on if we maybe simplified 'def' to be a type declaration? | |
void |
constructorStart() Used to look ahead for a constructor | |
void |
controlExpressionList() | |
AST |
create(int type, String txt, AST first) Create an AST node with the token type and text passed in, but with the same background information as another supplied Token (e.g. | |
AST |
create(int type, String txt, Token first, Token last) | |
AST |
create(int type, String txt, AST first, Token last) | |
AST |
create(int type, String txt, AST first, AST last) | |
void |
declaration() A declaration is the creation of a reference or primitive-type variable, or (if arguments are present) of a method. | |
void |
declarationStart() Used only as a lookahead predicate, before diving in and parsing a declaration. | |
void |
declaratorBrackets(AST typ) After some type names, where zero or more empty bracket pairs are allowed. | |
void |
dynamicMemberName() If a dot is followed by a parenthesized or quoted expression, the member is computed dynamically, and the member selection is done only at runtime. | |
void |
enumBlock() | |
void |
enumConstant() | |
void |
enumConstantBlock() | |
void |
enumConstantField() | |
protected void |
enumConstantFieldInternal(AST mods, AST tp, AST t, Token first) | |
void |
enumConstants() Comma-separated list of one or more enum constant definitions. | |
void |
enumConstantsStart() Guard for enumConstants. | |
void |
enumDefinition(AST modifiers) | |
void |
equalityExpression(int lc_stmt) | |
void |
exclusiveOrExpression(int lc_stmt) | |
void |
explicitConstructorInvocation() Catch obvious constructor calls, but not the expr.super(...) calls | |
void |
expression(int lc_stmt) | |
void |
expressionStatement(int prevToken) An expression statement can be any general expression. | |
void |
expressionStatementNoCheck() | |
void |
finallyClause() | |
void |
forCond() | |
void |
forInClause() | |
void |
forInit() | |
void |
forIter() | |
void |
forStatement() | |
void |
genericMethod() | |
void |
genericMethodStart() lookahead predicate for usage of generics in methods as parameter for the method. | |
org.codehaus.groovy.antlr.parser.GroovyLexer |
getLexer() | |
List |
getWarningList() | |
void |
handler() | |
void |
identifier() | |
void |
identifierStar() | |
void |
implementsClause() | |
void |
implicitParameters() A block known to be a closure, but which omits its arguments, is given this placeholder. | |
void |
importStatement() | |
void |
inclusiveOrExpression(int lc_stmt) | |
void |
indexPropertyArgs(AST indexee) An expression may be followed by [...]. | |
void |
interfaceBlock() | |
void |
interfaceDefinition(AST modifiers) | |
void |
interfaceExtends() | |
void |
interfaceField() | |
void |
keywordPropertyNames() | |
void |
listOfVariables(AST mods, AST t, Token first) | |
void |
listOrMapConstructorExpression() A list constructor is a argument list enclosed in square brackets, without labels. | |
void |
logicalAndExpression(int lc_stmt) | |
void |
logicalOrExpression(int lc_stmt) | |
static GroovyRecognizer |
make(org.codehaus.groovy.antlr.parser.GroovyLexer lexer) This factory is the correct way to wire together a Groovy parser and lexer. | |
static GroovyRecognizer |
make(InputStream in) | |
static GroovyRecognizer |
make(Reader in) | |
static GroovyRecognizer |
make(InputBuffer in) | |
static GroovyRecognizer |
make(LexerSharedInputState in) | |
void |
matchGenericTypeBracketsFailed(String problem, String solution) | |
void |
methodCallArgs(AST callee) An expression may be followed by one or both of (...) and {...}. | |
void |
modifier() | |
void |
modifiers() A list of one or more modifier, annotation, or "def". | |
void |
modifiersInternal() | |
void |
modifiersOpt() A list of zero or more modifiers, annotations, or "def". | |
void |
multicatch() | |
void |
multicatch_types() | |
void |
multipleAssignment(int lc_stmt) | |
void |
multipleAssignmentDeclaration() | |
void |
multipleAssignmentDeclarationStart() | |
void |
multiplicativeExpression(int lc_stmt) | |
void |
namePart() This is the grammar for what can follow a dot: x.a, x. | |
void |
newArrayDeclarator() | |
void |
newExpression() object instantiation. | |
void |
nls() Zero or more insignificant newlines, all gobbled up and thrown away. | |
void |
nlsWarn() Zero or more insignificant newlines, all gobbled up and thrown away, but a warning message is left for the user, if there was a newline. | |
void |
openBlock() An open block is not allowed to have closure arguments. | |
void |
openOrClosableBlock() A sub-block of a block can be either open or closable. | |
void |
packageDefinition() | |
void |
parameterDeclaration() A formal parameter for a method or closure. | |
void |
parameterDeclarationList() A list of zero or more formal parameters. | |
void |
parameterModifiersOpt() | |
void |
parenthesizedExpression() | |
void |
pathChain(int lc_stmt, AST prefix) | |
void |
pathElement(AST prefix) | |
void |
pathElementStart() | |
void |
pathExpression(int lc_stmt) A "path expression" is a name or other primary, possibly qualified by various forms of dot, and/or followed by various kinds of brackets. | |
void |
postfixExpression(int lc_stmt) | |
void |
powerExpression(int lc_stmt) | |
void |
powerExpressionNotPlusMinus(int lc_stmt) | |
void |
primaryExpression() | |
void |
qualifiedTypeName() | |
void |
regexExpression(int lc_stmt) | |
void |
relationalExpression(int lc_stmt) | |
void |
requireFailed(String problem, String solution) | |
void |
sep() A statement separator is either a semicolon or a significant newline. | |
void |
setFilename(String f) | |
void |
setSourceBuffer(SourceBuffer sourceBuffer) | |
void |
shiftExpression(int lc_stmt) | |
void |
singleDeclaration() A declaration with one declarator and optional initialization, like a parameterDeclaration. | |
void |
singleDeclarationNoInit() A declaration with one declarator and no initialization, like a parameterDeclaration. | |
void |
singleVariable(AST mods, AST t) Used in cases where a declaration cannot have commas, or ends with the "in" operator instead of '='. | |
void |
snippetUnit() A Groovy script or simple expression. | |
void |
statement(int prevToken) A statement is an element of a block. | |
void |
statementLabelPrefix() A labeled statement, consisting of a vanilla identifier followed by a colon. | |
boolean |
strictContextExpression(boolean allowDeclaration) Things that can show up as expressions, but only in strict contexts like inside parentheses, argument lists, and list constructors. | |
void |
stringConstructorExpression() | |
void |
stringConstructorValuePart() | |
void |
superClassClause() | |
void |
suspiciousExpressionStatementStart() Lookahead for suspicious statement warnings and errors. | |
void |
throwsClause() | |
void |
traceIn(String rname) | |
void |
traceOut(String rname) | |
void |
traitDefinition(AST modifiers) | |
void |
tryBlock() | |
void |
type() | |
void |
typeArgument() | |
void |
typeArgumentBounds() | |
void |
typeArgumentSpec() | |
void |
typeArguments() | |
void |
typeArgumentsDiamond() | |
protected void |
typeArgumentsOrParametersEnd() | |
protected void |
typeDefinitionInternal(AST mods) | |
void |
typeDefinitionStart() Used only as a lookahead predicate for nested type definitions. | |
void |
typeNamePairs(AST mods, Token first) | |
void |
typeParameter() | |
void |
typeParameterBounds() | |
void |
typeParameters() | |
void |
typeSpec(boolean addImagNode) | |
void |
unaryExpression(int lc_stmt) | |
void |
unaryExpressionNotPlusMinus(int lc_stmt) | |
void |
upperCaseIdent() An IDENT token whose spelling is required to start with an uppercase letter. | |
void |
varInitializer() An assignment operator '=' followed by an expression. | |
void |
variableDeclarator(AST mods, AST t, Token first) Declaration of a variable. | |
void |
variableDefinitions(AST mods, AST t) The tail of a declaration. | |
void |
variableName() | |
void |
wildcardType() |
Inherited Methods Summary
Field Detail
public static final String[] _tokenNames
public static final BitSet _tokenSet_0
public static final BitSet _tokenSet_1
public static final BitSet _tokenSet_10
public static final BitSet _tokenSet_100
public static final BitSet _tokenSet_101
public static final BitSet _tokenSet_102
public static final BitSet _tokenSet_103
public static final BitSet _tokenSet_104
public static final BitSet _tokenSet_105
public static final BitSet _tokenSet_106
public static final BitSet _tokenSet_107
public static final BitSet _tokenSet_108
public static final BitSet _tokenSet_109
public static final BitSet _tokenSet_11
public static final BitSet _tokenSet_110
public static final BitSet _tokenSet_111
public static final BitSet _tokenSet_112
public static final BitSet _tokenSet_12
public static final BitSet _tokenSet_13
public static final BitSet _tokenSet_14
public static final BitSet _tokenSet_15
public static final BitSet _tokenSet_16
public static final BitSet _tokenSet_17
public static final BitSet _tokenSet_18
public static final BitSet _tokenSet_19
public static final BitSet _tokenSet_2
public static final BitSet _tokenSet_20
public static final BitSet _tokenSet_21
public static final BitSet _tokenSet_22
public static final BitSet _tokenSet_23
public static final BitSet _tokenSet_24
public static final BitSet _tokenSet_25
public static final BitSet _tokenSet_26
public static final BitSet _tokenSet_27
public static final BitSet _tokenSet_28
public static final BitSet _tokenSet_29
public static final BitSet _tokenSet_3
public static final BitSet _tokenSet_30
public static final BitSet _tokenSet_31
public static final BitSet _tokenSet_32
public static final BitSet _tokenSet_33
public static final BitSet _tokenSet_34
public static final BitSet _tokenSet_35
public static final BitSet _tokenSet_36
public static final BitSet _tokenSet_37
public static final BitSet _tokenSet_38
public static final BitSet _tokenSet_39
public static final BitSet _tokenSet_4
public static final BitSet _tokenSet_40
public static final BitSet _tokenSet_41
public static final BitSet _tokenSet_42
public static final BitSet _tokenSet_43
public static final BitSet _tokenSet_44
public static final BitSet _tokenSet_45
public static final BitSet _tokenSet_46
public static final BitSet _tokenSet_47
public static final BitSet _tokenSet_48
public static final BitSet _tokenSet_49
public static final BitSet _tokenSet_5
public static final BitSet _tokenSet_50
public static final BitSet _tokenSet_51
public static final BitSet _tokenSet_52
public static final BitSet _tokenSet_53
public static final BitSet _tokenSet_54
public static final BitSet _tokenSet_55
public static final BitSet _tokenSet_56
public static final BitSet _tokenSet_57
public static final BitSet _tokenSet_58
public static final BitSet _tokenSet_59
public static final BitSet _tokenSet_6
public static final BitSet _tokenSet_60
public static final BitSet _tokenSet_61
public static final BitSet _tokenSet_62
public static final BitSet _tokenSet_63
public static final BitSet _tokenSet_64
public static final BitSet _tokenSet_65
public static final BitSet _tokenSet_66
public static final BitSet _tokenSet_67
public static final BitSet _tokenSet_68
public static final BitSet _tokenSet_69
public static final BitSet _tokenSet_7
public static final BitSet _tokenSet_70
public static final BitSet _tokenSet_71
public static final BitSet _tokenSet_72
public static final BitSet _tokenSet_73
public static final BitSet _tokenSet_74
public static final BitSet _tokenSet_75
public static final BitSet _tokenSet_76
public static final BitSet _tokenSet_77
public static final BitSet _tokenSet_78
public static final BitSet _tokenSet_79
public static final BitSet _tokenSet_8
public static final BitSet _tokenSet_80
public static final BitSet _tokenSet_81
public static final BitSet _tokenSet_82
public static final BitSet _tokenSet_83
public static final BitSet _tokenSet_84
public static final BitSet _tokenSet_85
public static final BitSet _tokenSet_86
public static final BitSet _tokenSet_87
public static final BitSet _tokenSet_88
public static final BitSet _tokenSet_89
public static final BitSet _tokenSet_9
public static final BitSet _tokenSet_90
public static final BitSet _tokenSet_91
public static final BitSet _tokenSet_92
public static final BitSet _tokenSet_93
public static final BitSet _tokenSet_94
public static final BitSet _tokenSet_95
public static final BitSet _tokenSet_96
public static final BitSet _tokenSet_97
public static final BitSet _tokenSet_98
public static final BitSet _tokenSet_99
public static boolean tracing
Constructor Detail
protected GroovyRecognizer(TokenBuffer tokenBuf, int k)
public GroovyRecognizer(TokenBuffer tokenBuf)
protected GroovyRecognizer(TokenStream lexer, int k)
public GroovyRecognizer(TokenStream lexer)
public GroovyRecognizer(ParserSharedInputState state)
Method Detail
public final void aCase()
public void addWarning(String warning, String solution)
public final void additiveExpression(int lc_stmt)
public final void andExpression(int lc_stmt)
public final void annotation()
public final void annotationArguments()
public final void annotationBlock()
public final void annotationDefinition(AST modifiers)
public final void annotationField()
public final void annotationIdent()
public final void annotationMemberValueInitializer()
public final void annotationMemberValuePair()
public final void annotationMemberValuePairs()
public final void annotationsInternal()
public final void annotationsOpt()
public final void appendedBlock(AST callee)
An appended block follows any expression. If the expression is not a method call, it is given an empty argument list.
public final void argList()
public final byte argument()
A single argument in (...) or [...]. Corresponds to to a method or closure parameter. May be labeled. May be modified by the spread operator '*' ('*:' for keywords).
public final void argumentLabel()
A label for an argument is of the form a:b, 'a':b, "a":b, (a):b, etc.. The labels in (a:b), ('a':b), and ("a":b) are in all ways equivalent, except that the quotes allow more spellings. Equivalent dynamically computed labels are (('a'):b) and ("${'a'}":b) but not ((a):b) or "$a":b, since the latter cases evaluate (a) as a normal identifier. Bottom line: If you want a truly variable label, use parens and say ((a):b).
public final void argumentLabelStart()
For lookahead only. Fast approximate parse of an argumentLabel followed by a colon.
public final void assignmentExpression(int lc_stmt)
public final void assignmentLessExpression()
public final void balancedBrackets()
Fast lookahead across balanced brackets of all sorts.
public final void balancedTokens()
public final void blockBody(int prevToken)
A block body is a parade of zero or more statements or expressions.
public final void branchStatement()
In Groovy, return, break, continue, throw, and assert can be used in a parenthesized expression context. Example: println (x || (return)); println assert x, "won't print a false value!" If an optional expression is missing, its value is void (this coerces to null when a value is required).
protected void buildTokenTypeASTClassMap()
public final void builtInType()
public final void builtInTypeArraySpec(boolean addImagNode)
public final void builtInTypeSpec(boolean addImagNode)
public final void caseSList()
public final void casesGroup()
public final void checkSuspiciousExpressionStatement(int prevToken)
If two statements are separated by newline (not SEMI), the second had better not look like the latter half of an expression. If it does, issue a warning.
Also, if the expression starts with a closure, it needs to have an explicit parameter list, in order to avoid the appearance of a compound statement. This is a hard error.
These rules are different from Java's "dumb expression" restriction. Unlike Java, Groovy blocks can end with arbitrary (even dumb) expressions, as a consequence of optional 'return' and 'continue' tokens.
To make the programmer's intention clear, a leading closure must have an explicit parameter list, and must not follow a previous statement separated only by newlines.
public final void classBlock()
public final void classDefinition(AST modifiers)
public final void classField()
public final void classOrInterfaceType(boolean addImagNode)
public final void classTypeSpec(boolean addImagNode)
public Token cloneToken(Token t)
Clones the token
public final void closableBlock()
A block which is known to be a closure, even if it has no apparent arguments. A block inside an expression or after a method call is always assumed to be a closure. Only labeled, unparameterized blocks which occur directly as substatements are kept open.
public final void closableBlockConstructorExpression()
public final void closableBlockParam()
Simple names, as in {x|...}, are completely equivalent to {(def x)|...}. Build the right AST.
public final void closableBlockParamsOpt(boolean addImplicit)
Closure parameters are exactly like method parameters, except that they are not enclosed in parentheses, but rather are prepended to the front of a block, just after the brace. They are separated from the closure body by a CLOSABLE_BLOCK_OP token '->'.
public final void closableBlockParamsStart()
Lookahead to check whether a block begins with explicit closure arguments.
public final void closureList()
public final void commandArgument()
public final void commandArguments(AST head)
A member name (x.y) or element name (x[y]) can serve as a command name, which may be followed by a list of arguments. Unlike parenthesized arguments, these must be plain expressions, without labels or spread operators.
public final void commandArgumentsGreedy(AST head)
public final void compatibleBodyStatement()
In Java, "if", "while", and "for" statements can take random, non-braced statements as their bodies. Support this practice, even though it isn't very Groovy.
public final void compilationUnit()
public final void compoundStatement()
public final void conditionalExpression(int lc_stmt)
public final void constant()
Numeric, string, regexp, boolean, or null constant.
public final void constantNumber()
Numeric constant.
public final void constructorBody()
public final void constructorDefinition(AST mods)
I've split out constructors separately; we could maybe integrate back into variableDefinitions later on if we maybe simplified 'def' to be a type declaration?
public final void constructorStart()
Used to look ahead for a constructor
public final void controlExpressionList()
public AST create(int type, String txt, AST first)
Create an AST node with the token type and text passed in, but with the same background information as another supplied Token (e.g. line numbers). To be used in place of antlr tree construction syntax, i.e. #[TOKEN,"text"] becomes create(TOKEN,"text",anotherToken) todo - change antlr.ASTFactory to do this instead...
public AST create(int type, String txt, Token first, Token last)
public AST create(int type, String txt, AST first, Token last)
public AST create(int type, String txt, AST first, AST last)
public final void declaration()
A declaration is the creation of a reference or primitive-type variable, or (if arguments are present) of a method. Generically, this is called a 'variable' definition, even in the case of a class field or method. It may start with the modifiers and/or a declaration keyword "def". It may also start with the modifiers and a capitalized type name.
AST effect: Create a separate Type/Var tree for each var in the var list. Must be guarded, as in (declarationStart) => declaration.
public final void declarationStart()
Used only as a lookahead predicate, before diving in and parsing a declaration. A declaration can be unambiguously introduced with "def", an annotation or a modifier token like "final". It may also be introduced by a simple identifier whose first character is an uppercase letter, as in {String x}. A declaration can also be introduced with a built in type like 'int' or 'void'. Brackets (array and generic) are allowed, as in {List[] x} or {int[][] y}. Anything else is parsed as a statement of some sort (expression or command).
(In the absence of explicit method-call parens, we assume a capitalized name is a type name. Yes, this is a little hacky. Alternatives are to complicate the declaration or command syntaxes, or to have the parser query the symbol table. Parse-time queries are evil. And we want both {String x} and {println x}. So we need a syntactic razor-edge to slip between 'println' and 'String'.)
public final void declaratorBrackets(AST typ)
After some type names, where zero or more empty bracket pairs are allowed. We use ARRAY_DECLARATOR to represent this.
public final void dynamicMemberName()
If a dot is followed by a parenthesized or quoted expression, the member is computed dynamically, and the member selection is done only at runtime. This forces a statically unchecked member access.
public final void enumBlock()
public final void enumConstant()
public final void enumConstantBlock()
public final void enumConstantField()
protected final void enumConstantFieldInternal(AST mods, AST tp, AST t, Token first)
public final void enumConstants()
Comma-separated list of one or more enum constant definitions.
public final void enumConstantsStart()
Guard for enumConstants.
public final void enumDefinition(AST modifiers)
public final void equalityExpression(int lc_stmt)
public final void exclusiveOrExpression(int lc_stmt)
public final void explicitConstructorInvocation()
Catch obvious constructor calls, but not the expr.super(...) calls
public final void expression(int lc_stmt)
public final void expressionStatement(int prevToken)
An expression statement can be any general expression.
An expression statement can also be a command, which is a simple method call in which the outermost parentheses are omitted.
Certain "suspicious" looking forms are flagged for the user to disambiguate.
public final void expressionStatementNoCheck()
public final void finallyClause()
public final void forCond()
public final void forInClause()
public final void forInit()
public final void forIter()
public final void forStatement()
public final void genericMethod()
public final void genericMethodStart()
lookahead predicate for usage of generics in methods as parameter for the method. Example: static
public org.codehaus.groovy.antlr.parser.GroovyLexer getLexer()
public List getWarningList()
public final void handler()
public final void identifier()
public final void identifierStar()
public final void implementsClause()
public final void implicitParameters()
A block known to be a closure, but which omits its arguments, is given this placeholder. A subsequent pass is responsible for deciding if there is an implicit 'it' parameter, or if the parameter list should be empty.
public final void importStatement()
public final void inclusiveOrExpression(int lc_stmt)
public final void indexPropertyArgs(AST indexee)
An expression may be followed by [...]. Unlike Java, these brackets may contain a general argument list, which is passed to the array element operator, which can make of it what it wants. The brackets may also be empty, as in T[]. This is how Groovy names array types.
Returned AST is [INDEX_OP, indexee, ELIST].
public final void interfaceBlock()
public final void interfaceDefinition(AST modifiers)
public final void interfaceExtends()
public final void interfaceField()
public final void keywordPropertyNames()
public final void listOfVariables(AST mods, AST t, Token first)
public final void listOrMapConstructorExpression()
A list constructor is a argument list enclosed in square brackets, without labels. Any argument can be decorated with a spread operator (*x), but not a label (a:x). Examples: [], [1], [1,2], [1,*l1,2], [*l1,*l2]. (The l1, l2 must be a sequence or null.)
A map constructor is an argument list enclosed in square brackets, with labels everywhere, except on spread arguments, which stand for whole maps spliced in. A colon alone between the brackets also forces the expression to be an empty map constructor. Examples: [:], [a:1], [a:1,b:2], [a:1,*:m1,b:2], [*:m1,*:m2] (The m1, m2 must be a map or null.) Values associated with identical keys overwrite from left to right: [a:1,a:2] === [a:2]
Some malformed constructor expressions are not detected in the parser, but in a post-pass. Bad examples: [1,b:2], [a:1,2], [:1]. (Note that method call arguments, by contrast, can be a mix of keyworded and non-keyworded arguments.)
public final void logicalAndExpression(int lc_stmt)
public final void logicalOrExpression(int lc_stmt)
public static GroovyRecognizer make(org.codehaus.groovy.antlr.parser.GroovyLexer lexer)
This factory is the correct way to wire together a Groovy parser and lexer.
public static GroovyRecognizer make(InputStream in)
public static GroovyRecognizer make(Reader in)
public static GroovyRecognizer make(InputBuffer in)
public static GroovyRecognizer make(LexerSharedInputState in)
public void matchGenericTypeBracketsFailed(String problem, String solution)
public final void methodCallArgs(AST callee)
An expression may be followed by one or both of (...) and {...}. Note: If either is (...) or {...} present, it is a method call. The {...} is appended to the argument list, and matches a formal of type Closure. If there is no method member, a property (or field) is used instead, and must itself be callable.
If the methodCallArgs are absent, it is a property reference. If there is no property, it is treated as a field reference, but never a method reference.
Arguments in the (...) can be labeled, and the appended block can be labeled also. If there is a mix of unlabeled and labeled arguments, all the labeled arguments must follow the unlabeled arguments, except that the closure (labeled or not) is always a separate final argument. Labeled arguments are collected up and passed as a single argument to a formal of type Map.
Therefore, f(x,y, a:p, b:q) {s} is equivalent in all ways to f(x,y, [a:p,b:q], {s}). Spread arguments of sequence type count as unlabeled arguments, while spread arguments of map type count as labeled arguments. (This distinction must sometimes be checked dynamically.) A plain unlabeled argument is allowed to match a trailing Map or Closure argument: f(x, a:p) {s} === f(*[ x, [a:p], {s} ])
public final void modifier()
public final void modifiers()
A list of one or more modifier, annotation, or "def".
public final void modifiersInternal()
public final void modifiersOpt()
A list of zero or more modifiers, annotations, or "def".
public final void multicatch()
public final void multicatch_types()
public final void multipleAssignment(int lc_stmt)
public final void multipleAssignmentDeclaration()
public final void multipleAssignmentDeclarationStart()
public final void multiplicativeExpression(int lc_stmt)
public final void namePart()
This is the grammar for what can follow a dot: x.a, x.@a, x.&a, x.'a', etc. Note: typeArguments
is handled by the caller of namePart
.
public final void newArrayDeclarator()
public final void newExpression()
object instantiation. Trees are built as illustrated by the following input/tree pairs: new T() new | T -- ELIST | arg1 -- arg2 -- .. -- argn new int[] new | int -- ARRAY_DECLARATOR new int[] {1,2} new | int -- ARRAY_DECLARATOR -- ARRAY_INIT | EXPR -- EXPR | | 1 2 new int[3] new | int -- ARRAY_DECLARATOR | EXPR | 3 new int[1][2] new | int -- ARRAY_DECLARATOR | ARRAY_DECLARATOR -- EXPR | | EXPR 1 | 2
public final void nls()
Zero or more insignificant newlines, all gobbled up and thrown away.
public final void nlsWarn()
Zero or more insignificant newlines, all gobbled up and thrown away, but a warning message is left for the user, if there was a newline.
public final void openBlock()
An open block is not allowed to have closure arguments.
public final void openOrClosableBlock()
A sub-block of a block can be either open or closable. It is closable if and only if there are explicit closure arguments. Compare this to a block which is appended to a method call, which is given closure arguments, even if they are not explicit in the code.
public final void packageDefinition()
public final void parameterDeclaration()
A formal parameter for a method or closure.
public final void parameterDeclarationList()
A list of zero or more formal parameters. If a parameter is variable length (e.g. String... myArg) it should be to the right of any other parameters of the same kind. General form: (req, ..., opt, ..., [rest], key, ..., [restKeys], [block] This must be sorted out after parsing, since the various declaration forms are impossible to tell apart without backtracking.
public final void parameterModifiersOpt()
public final void parenthesizedExpression()
public final void pathChain(int lc_stmt, AST prefix)
public final void pathElement(AST prefix)
public final void pathElementStart()
public final void pathExpression(int lc_stmt)
A "path expression" is a name or other primary, possibly qualified by various forms of dot, and/or followed by various kinds of brackets. It can be used for value or assigned to, or else further qualified, indexed, or called. It is called a "path" because it looks like a linear path through a data structure. Examples: x.y, x?.y, x*.y, x.@y; x[], x[y], x[y,z]; x(), x(y), x(y,z); x{s}; a.b[n].c(x).d{s} (Compare to a C lvalue, or LeftHandSide in the JLS section 15.26.) General expressions are built up from path expressions, using operators like '+' and '='.
public final void postfixExpression(int lc_stmt)
public final void powerExpression(int lc_stmt)
public final void powerExpressionNotPlusMinus(int lc_stmt)
public final void primaryExpression()
public final void qualifiedTypeName()
public final void regexExpression(int lc_stmt)
public final void relationalExpression(int lc_stmt)
public void requireFailed(String problem, String solution)
public final void sep()
A statement separator is either a semicolon or a significant newline. Any number of additional (insignificant) newlines may accompany it.
public void setFilename(String f)
public void setSourceBuffer(SourceBuffer sourceBuffer)
public final void shiftExpression(int lc_stmt)
public final void singleDeclaration()
A declaration with one declarator and optional initialization, like a parameterDeclaration. Used to parse declarations used for both binding and effect, in places like argument lists and while
statements.
public final void singleDeclarationNoInit()
A declaration with one declarator and no initialization, like a parameterDeclaration. Used to parse loops like for (int x in y)
(up to the in
keyword).
public final void singleVariable(AST mods, AST t)
Used in cases where a declaration cannot have commas, or ends with the "in" operator instead of '='.
public final void snippetUnit()
A Groovy script or simple expression. Can be anything legal inside {...}.
public final void statement(int prevToken)
A statement is an element of a block. Typical statements are declarations (which are scoped to the block) and expressions.
public final void statementLabelPrefix()
A labeled statement, consisting of a vanilla identifier followed by a colon.
public final boolean strictContextExpression(boolean allowDeclaration)
Things that can show up as expressions, but only in strict contexts like inside parentheses, argument lists, and list constructors.
public final void stringConstructorExpression()
public final void stringConstructorValuePart()
public final void superClassClause()
public final void suspiciousExpressionStatementStart()
Lookahead for suspicious statement warnings and errors.
public final void throwsClause()
public void traceIn(String rname)
public void traceOut(String rname)
public final void traitDefinition(AST modifiers)
public final void tryBlock()
public final void type()
public final void typeArgument()
public final void typeArgumentBounds()
public final void typeArgumentSpec()
public final void typeArguments()
public final void typeArgumentsDiamond()
protected final void typeArgumentsOrParametersEnd()
protected final void typeDefinitionInternal(AST mods)
public final void typeDefinitionStart()
Used only as a lookahead predicate for nested type definitions.
public final void typeNamePairs(AST mods, Token first)
public final void typeParameter()
public final void typeParameterBounds()
public final void typeParameters()
public final void typeSpec(boolean addImagNode)
public final void unaryExpression(int lc_stmt)
public final void unaryExpressionNotPlusMinus(int lc_stmt)
public final void upperCaseIdent()
An IDENT token whose spelling is required to start with an uppercase letter. In the case of a simple statement {UpperID name} the identifier is taken to be a type name, not a command name.
public final void varInitializer()
An assignment operator '=' followed by an expression. (Never empty.)
public final void variableDeclarator(AST mods, AST t, Token first)
Declaration of a variable. This can be a class/instance variable, or a local variable in a method It can also include possible initialization.
public final void variableDefinitions(AST mods, AST t)
The tail of a declaration. Either v1, v2, ... (with possible initializers) or else m(args){body}. The two arguments are the modifier list (if any) and the declaration head (if any). The declaration head is the variable type, or (for a method) the return type. If it is missing, then the variable type is taken from its initializer (if there is one). Otherwise, the variable type defaults to 'any'. DECIDE: Method return types default to the type of the method body, as an expression.
public final void variableName()
public final void wildcardType()
© 2003-2020 The Apache Software Foundation
Licensed under the Apache license.
https://docs.groovy-lang.org/2.5.14/html/gapi/org/codehaus/groovy/antlr/parser/GroovyRecognizer.html