freemarker.core

Class FMParser

java.lang.Object

freemarker.core.FMParser

All Implemented Interfaces:

FMParserConstants

public class FMParser
extends Object
implements FMParserConstants

This class is generated by JavaCC from a grammar file.

Field Summary

Fields

Modifier and Type	Field and Description
Token	jj_nt Next token.
Token	token Current token.
FMParserTokenManager	token_source Generated Token Manager.

Fields inherited from interface freemarker.core.FMParserConstants

_INCLUDE, AND, AS, ASCII_DIGIT, ASSIGN, ATTEMPT, BLANK, BREAK, BUILT_IN, CALL, CASE, CLOSE_BRACKET, CLOSE_PAREN, CLOSE_TAG1, CLOSE_TAG2, CLOSING_CURLY_BRACKET, COLON, COMMA, COMMENT, COMPRESS, DECIMAL, DEFAUL, DEFAULT, DIRECTIVE_END, DIV_EQUALS, DIVIDE, DOLLAR_INTERPOLATION_OPENING, DOT, DOT_DOT, DOT_DOT_ASTERISK, DOT_DOT_LESS, DOUBLE_EQUALS, DOUBLE_STAR, ELLIPSIS, ELSE, ELSE_IF, EMPTY_DIRECTIVE_END, END_ASSIGN, END_ATTEMPT, END_COMPRESS, END_ESCAPE, END_FOREACH, END_FUNCTION, END_GLOBAL, END_IF, END_ITEMS, END_LIST, END_LOCAL, END_MACRO, END_NOESCAPE, END_RECOVER, END_SEP, END_SWITCH, END_TAG, END_TRANSFORM, EOF, EQUALS, ESCAPE, ESCAPED_CHAR, ESCAPED_GT, ESCAPED_GTE, ESCAPED_ID_CHAR, EXCLAM, EXISTS, EXPRESSION_COMMENT, FALLBACK, FALSE, FLUSH, FM_EXPRESSION, FOREACH, FTL_HEADER, FUNCTION, GLOBALASSIGN, HALT, HASH_INTERPOLATION_OPENING, ID, ID_START_CHAR, IF, IMPORT, IN, IN_PAREN, INTEGER, ITEMS, KEEP_GOING, LESS_THAN, LESS_THAN_EQUALS, LIST, LOCALASSIGN, LONE_LESS_THAN_OR_DASH, LTRIM, MACRO, MAYBE_END, MINUS, MINUS_EQUALS, MINUS_MINUS, MOD_EQUALS, NAMED_PARAMETER_EXPRESSION, NATURAL_GT, NATURAL_GTE, NESTED, NO_PARSE, NO_SPACE_EXPRESSION, NODIRECTIVE, NOESCAPE, NON_ESCAPED_ID_START_CHAR, NOPARSE, NOT_EQUALS, NOTRIM, OPEN_BRACKET, OPEN_MISPLACED_INTERPOLATION, OPEN_PAREN, OPENING_CURLY_BRACKET, OR, PERCENT, PLUS, PLUS_EQUALS, PLUS_PLUS, RAW_STRING, RECOVER, RECURSE, RETURN, RTRIM, SEMICOLON, SEP, SETTING, SIMPLE_NESTED, SIMPLE_RECURSE, SIMPLE_RETURN, START_TAG, STATIC_TEXT_FALSE_ALARM, STATIC_TEXT_NON_WS, STATIC_TEXT_WS, STOP, STRING_LITERAL, SWITCH, TERMINATING_EXCLAM, TERMINATING_WHITESPACE, TERSE_COMMENT, TERSE_COMMENT_END, TIMES, TIMES_EQUALS, tokenImage, TRANSFORM, TRIM, TRIVIAL_FTL_HEADER, TRUE, UNIFIED_CALL, UNIFIED_CALL_END, UNKNOWN_DIRECTIVE, USING, VISIT

Constructor Summary

Constructors

Constructor and Description
FMParser(FMParserTokenManager tm) Constructor with generated Token Manager.
FMParser(InputStream stream) Constructor with InputStream.
FMParser(InputStream stream, String encoding) Constructor with InputStream and supplied encoding
FMParser(Reader stream) Constructor.
FMParser(String template)
FMParser(Template template, Reader reader, boolean strictEscapeSyntax, boolean stripWhitespace) Constructs a new parser object.
FMParser(Template template, Reader reader, boolean strictEscapeSyntax, boolean stripWhitespace, int tagSyntax)
FMParser(Template template, Reader reader, boolean strictEscapeSyntax, boolean stripWhitespace, int tagSyntax, int incompatibleImprovements)
FMParser(Template template, Reader reader, boolean strictEscapeSyntax, boolean stripWhitespace, int tagSyntax, int namingConvention, int incompatibleImprovements)

Method Summary

Modifier and Type	Method and Description
int	_getLastNamingConvention() Don't use it, unless you are developing FreeMarker itself.
int	_getLastTagSyntax() Don't use it, unless you are developing FreeMarker itself.
Expression	AdditiveExpression()
Expression	AddSubExpression(Expression exp) Production that builds up an expression using the dot or dynamic key name or the args list if this is a method invocation.
Expression	AndExpression()
TemplateElement	Assign()
freemarker.core.AttemptBlock	Attempt()
Expression	BooleanLiteral()
freemarker.core.BreakInstruction	Break() Production used to break out of a loop or a switch block.
Expression	BuiltIn(Expression lhoExp)
freemarker.core.BuiltinVariable	BuiltinVariable()
TemplateElement	Call()
freemarker.core.Case	Case()
Comment	Comment()
freemarker.core.CompressedBlock	Compress()
static FMParser	createExpressionParser(String s) Create an FM expression parser using a string.
Expression	DefaultTo(Expression exp)
void	disable_tracing() Disable tracing.
Expression	DotVariable(Expression exp) production for when a key is specified by + keyname
Expression	DynamicKey(Expression exp) production for when the key is specified in brackets.
freemarker.core.ElseOfList	ElseOfList()
void	enable_tracing() Enable tracing.
Expression	EqualityExpression()
freemarker.core.EscapeBlock	Escape()
Expression	Exists(Expression exp)
Expression	Expression() This is the same as OrExpression, since the OR is the operator with the lowest precedence.
freemarker.core.FallbackInstruction	FallBack()
TemplateElement	Flush()
freemarker.core.IteratorBlock	ForEach()
TemplateElement	FreemarkerDirective() A production for FreeMarker directives.
TemplateElement	FreeMarkerText() A production freemarker text that may contain ${...} and #{...} but no directives.
ParseException	generateParseException() Generate ParseException.
Token	getNextToken() Get the next Token.
Token	getToken(int index) Get the specific Token.
freemarker.core.HashLiteral	HashLiteral()
void	HeaderElement()
freemarker.core.Identifier	Identifier()
Expression	IdentifierOrStringLiteral()
TemplateElement	If()
LibraryLoad	Import()
freemarker.core.Include	Include()
freemarker.core.Items	Items()
TemplateElement	List()
freemarker.core.ListLiteral	ListLiteral()
Token	LooseDirectiveEnd() Production to terminate potentially empty elements.
Macro	Macro()
freemarker.core.MethodCall	MethodArgs(Expression exp) production for an arglist part of a method invocation.
freemarker.core.MixedContent	MixedContent()
Expression	MultiplicativeExpression() A unary expression followed by zero or more unary expressions with operators in between.
HashMap	NamedArgs()
TemplateElement	Nested()
freemarker.core.NoEscapeBlock	NoEscape()
TextBlock	NoParse()
Expression	NotExpression()
Expression	NumberLiteral()
freemarker.core.NumericalOutput	NumericalOutput()
TemplateElement	OptionalBlock() A production for a block of optional content.
Expression	OrExpression()
Map	ParamList()
Expression	Parenthesis()
TextBlock	PCData() Production for a block of raw text i.e.
ArrayList	PositionalArgs()
Expression	PrimaryExpression() Lowest level expression, a literal, a variable, or a possibly more complex expression bounded by parentheses.
Expression	RangeExpression()
freemarker.core.RecoveryBlock	Recover()
freemarker.core.RecurseNode	Recurse()
void	ReInit(FMParserTokenManager tm) Reinitialise.
void	ReInit(InputStream stream) Reinitialise.
void	ReInit(InputStream stream, String encoding) Reinitialise.
void	ReInit(Reader stream) Reinitialise.
Expression	RelationalExpression()
ReturnInstruction	Return() Production used to jump out of a macro.
TemplateElement	Root() Root production to be used when parsing an entire file.
freemarker.core.Sep	Sep()
freemarker.core.PropertySetting	Setting()
freemarker.core.StopInstruction	Stop()
freemarker.core.StringLiteral	StringLiteral(boolean interpolate)
freemarker.core.DollarVariable	StringOutput() A production representing the ${...} that outputs a variable.
freemarker.core.SwitchBlock	Switch()
freemarker.core.TransformBlock	Transform()
TemplateElement	Trim()
Expression	UnaryExpression() A primary expression preceded by zero or more unary operators.
Expression	UnaryPlusMinusExpression()
TemplateElement	UnifiedMacroTransform()
Token	UnparsedContent(Token start, StringBuffer buf) Production for dealing with unparsed content, i.e.
freemarker.core.VisitNode	Visit()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

token_source

public FMParserTokenManager token_source

Generated Token Manager.

token

public Token token

Current token.

jj_nt

public Token jj_nt

Next token.

Constructor Detail

FMParser

public FMParser(Template template,
                Reader reader,
                boolean strictEscapeSyntax,
                boolean stripWhitespace)

Constructs a new parser object.

Parameters:

template - The template associated with this parser.

reader - The character stream to use as input

strictEscapeSyntax - Whether FreeMarker directives must start with a #

FMParser

public FMParser(Template template,
                Reader reader,
                boolean strictEscapeSyntax,
                boolean stripWhitespace,
                int tagSyntax)

FMParser

public FMParser(Template template,
                Reader reader,
                boolean strictEscapeSyntax,
                boolean stripWhitespace,
                int tagSyntax,
                int incompatibleImprovements)

FMParser

public FMParser(Template template,
                Reader reader,
                boolean strictEscapeSyntax,
                boolean stripWhitespace,
                int tagSyntax,
                int namingConvention,
                int incompatibleImprovements)

FMParser

public FMParser(String template)

FMParser

public FMParser(InputStream stream)

Constructor with InputStream.

FMParser

public FMParser(InputStream stream,
                String encoding)

Constructor with InputStream and supplied encoding

FMParser

public FMParser(Reader stream)

Constructor.

FMParser

public FMParser(FMParserTokenManager tm)

Constructor with generated Token Manager.

Method Detail

createExpressionParser

public static FMParser createExpressionParser(String s)

Create an FM expression parser using a string.

_getLastTagSyntax

public int _getLastTagSyntax()

Don't use it, unless you are developing FreeMarker itself.

_getLastNamingConvention

public int _getLastNamingConvention()

Don't use it, unless you are developing FreeMarker itself. The naming convention used by this template; if it couldn't be detected so far, it will be the most probable one. This could be used for formatting error messages, but not for anything serious.

Expression

public final Expression Expression()
                            throws ParseException

This is the same as OrExpression, since the OR is the operator with the lowest precedence.

Throws:

ParseException

PrimaryExpression

public final Expression PrimaryExpression()
                                   throws ParseException

Lowest level expression, a literal, a variable, or a possibly more complex expression bounded by parentheses.

Throws:

ParseException

Parenthesis

public final Expression Parenthesis()
                             throws ParseException

Throws:

ParseException

UnaryExpression

public final Expression UnaryExpression()
                                 throws ParseException

A primary expression preceded by zero or more unary operators. (The only unary operator we currently have is the NOT.)

Throws:

ParseException

NotExpression

public final Expression NotExpression()
                               throws ParseException

Throws:

ParseException

UnaryPlusMinusExpression

public final Expression UnaryPlusMinusExpression()
                                          throws ParseException

Throws:

ParseException

AdditiveExpression

public final Expression AdditiveExpression()
                                    throws ParseException

Throws:

ParseException

MultiplicativeExpression

public final Expression MultiplicativeExpression()
                                          throws ParseException

A unary expression followed by zero or more unary expressions with operators in between.

Throws:

ParseException

EqualityExpression

public final Expression EqualityExpression()
                                    throws ParseException

Throws:

ParseException

RelationalExpression

public final Expression RelationalExpression()
                                      throws ParseException

Throws:

ParseException

RangeExpression

public final Expression RangeExpression()
                                 throws ParseException

Throws:

ParseException

AndExpression

public final Expression AndExpression()
                               throws ParseException

Throws:

ParseException

OrExpression

public final Expression OrExpression()
                              throws ParseException

Throws:

ParseException

ListLiteral

public final freemarker.core.ListLiteral ListLiteral()
                                              throws ParseException

Throws:

ParseException

NumberLiteral

public final Expression NumberLiteral()
                               throws ParseException

Throws:

ParseException

Identifier

public final freemarker.core.Identifier Identifier()
                                            throws ParseException

Throws:

ParseException

IdentifierOrStringLiteral

public final Expression IdentifierOrStringLiteral()
                                           throws ParseException

Throws:

ParseException

BuiltinVariable

public final freemarker.core.BuiltinVariable BuiltinVariable()
                                                      throws ParseException

Throws:

ParseException

AddSubExpression

public final Expression AddSubExpression(Expression exp)
                                  throws ParseException

Production that builds up an expression using the dot or dynamic key name or the args list if this is a method invocation.

Throws:

ParseException

DefaultTo

public final Expression DefaultTo(Expression exp)
                           throws ParseException

Throws:

ParseException

Exists

public final Expression Exists(Expression exp)
                        throws ParseException

Throws:

ParseException

BuiltIn

public final Expression BuiltIn(Expression lhoExp)
                         throws ParseException

Throws:

ParseException

DotVariable

public final Expression DotVariable(Expression exp)
                             throws ParseException

production for when a key is specified by + keyname

Throws:

ParseException

DynamicKey

public final Expression DynamicKey(Expression exp)
                            throws ParseException

production for when the key is specified in brackets.

Throws:

ParseException

MethodArgs

public final freemarker.core.MethodCall MethodArgs(Expression exp)
                                            throws ParseException

production for an arglist part of a method invocation.

Throws:

ParseException

StringLiteral

public final freemarker.core.StringLiteral StringLiteral(boolean interpolate)
                                                  throws ParseException

Throws:

ParseException

BooleanLiteral

public final Expression BooleanLiteral()
                                throws ParseException

Throws:

ParseException

HashLiteral

public final freemarker.core.HashLiteral HashLiteral()
                                              throws ParseException

Throws:

ParseException

StringOutput

public final freemarker.core.DollarVariable StringOutput()
                                                  throws ParseException

A production representing the ${...} that outputs a variable.

Throws:

ParseException

NumericalOutput

public final freemarker.core.NumericalOutput NumericalOutput()
                                                      throws ParseException

Throws:

ParseException

If

public final TemplateElement If()
                         throws ParseException

Throws:

ParseException

Attempt

public final freemarker.core.AttemptBlock Attempt()
                                           throws ParseException

Throws:

ParseException

Recover

public final freemarker.core.RecoveryBlock Recover()
                                            throws ParseException

Throws:

ParseException

List

public final TemplateElement List()
                           throws ParseException

Throws:

ParseException

ElseOfList

public final freemarker.core.ElseOfList ElseOfList()
                                            throws ParseException

Throws:

ParseException

ForEach

public final freemarker.core.IteratorBlock ForEach()
                                            throws ParseException

Throws:

ParseException

Items

public final freemarker.core.Items Items()
                                  throws ParseException

Throws:

ParseException

Sep

public final freemarker.core.Sep Sep()
                              throws ParseException

Throws:

ParseException

Visit

public final freemarker.core.VisitNode Visit()
                                      throws ParseException

Throws:

ParseException

Recurse

public final freemarker.core.RecurseNode Recurse()
                                          throws ParseException

Throws:

ParseException

FallBack

public final freemarker.core.FallbackInstruction FallBack()
                                                   throws ParseException

Throws:

ParseException

Break

public final freemarker.core.BreakInstruction Break()
                                             throws ParseException

Production used to break out of a loop or a switch block.

Throws:

ParseException

Return

public final ReturnInstruction Return()
                               throws ParseException

Production used to jump out of a macro. The stop instruction terminates the rendering of the template.

Throws:

ParseException

Stop

public final freemarker.core.StopInstruction Stop()
                                           throws ParseException

Throws:

ParseException

Nested

public final TemplateElement Nested()
                             throws ParseException

Throws:

ParseException

Flush

public final TemplateElement Flush()
                            throws ParseException

Throws:

ParseException

Trim

public final TemplateElement Trim()
                           throws ParseException

Throws:

ParseException

Assign

public final TemplateElement Assign()
                             throws ParseException

Throws:

ParseException

Include

public final freemarker.core.Include Include()
                                      throws ParseException

Throws:

ParseException

Import

public final LibraryLoad Import()
                         throws ParseException

Throws:

ParseException

Macro

public final Macro Macro()
                  throws ParseException

Throws:

ParseException

Compress

public final freemarker.core.CompressedBlock Compress()
                                               throws ParseException

Throws:

ParseException

UnifiedMacroTransform

public final TemplateElement UnifiedMacroTransform()
                                            throws ParseException

Throws:

ParseException

Call

public final TemplateElement Call()
                           throws ParseException

Throws:

ParseException

NamedArgs

public final HashMap NamedArgs()
                        throws ParseException

Throws:

ParseException

PositionalArgs

public final ArrayList PositionalArgs()
                               throws ParseException

Throws:

ParseException

Comment

public final Comment Comment()
                      throws ParseException

Throws:

ParseException

NoParse

public final TextBlock NoParse()
                        throws ParseException

Throws:

ParseException

Transform

public final freemarker.core.TransformBlock Transform()
                                               throws ParseException

Throws:

ParseException

Switch

public final freemarker.core.SwitchBlock Switch()
                                         throws ParseException

Throws:

ParseException

Case

public final freemarker.core.Case Case()
                                throws ParseException

Throws:

ParseException

Escape

public final freemarker.core.EscapeBlock Escape()
                                         throws ParseException

Throws:

ParseException

NoEscape

public final freemarker.core.NoEscapeBlock NoEscape()
                                             throws ParseException

Throws:

ParseException

LooseDirectiveEnd

public final Token LooseDirectiveEnd()
                              throws ParseException

Production to terminate potentially empty elements. Either a ">" or "/>"

Throws:

ParseException

Setting

public final freemarker.core.PropertySetting Setting()
                                              throws ParseException

Throws:

ParseException

FreemarkerDirective

public final TemplateElement FreemarkerDirective()
                                          throws ParseException

A production for FreeMarker directives.

Throws:

ParseException

PCData

public final TextBlock PCData()
                       throws ParseException

Production for a block of raw text i.e. text that contains no FreeMarker directives.

Throws:

ParseException

UnparsedContent

public final Token UnparsedContent(Token start,
                                   StringBuffer buf)
                            throws ParseException

Production for dealing with unparsed content, i.e. what is inside a comment or noparse tag. It returns the ending token. The content of the tag is put in buf.

Throws:

ParseException

MixedContent

public final freemarker.core.MixedContent MixedContent()
                                                throws ParseException

Throws:

ParseException

FreeMarkerText

public final TemplateElement FreeMarkerText()
                                     throws ParseException

A production freemarker text that may contain ${...} and #{...} but no directives.

Throws:

ParseException

OptionalBlock

public final TemplateElement OptionalBlock()
                                    throws ParseException

A production for a block of optional content. Returns an empty Text block if there is no content.

Throws:

ParseException

HeaderElement

public final void HeaderElement()
                         throws ParseException

Throws:

ParseException

ParamList

public final Map ParamList()
                    throws ParseException

Throws:

ParseException

Root

public final TemplateElement Root()
                           throws ParseException

Root production to be used when parsing an entire file.

Throws:

ParseException

ReInit

public void ReInit(InputStream stream)

Reinitialise.

ReInit

public void ReInit(InputStream stream,
                   String encoding)

Reinitialise.

ReInit

public void ReInit(Reader stream)

Reinitialise.

ReInit

public void ReInit(FMParserTokenManager tm)

Reinitialise.

getNextToken

public final Token getNextToken()

Get the next Token.

getToken

public final Token getToken(int index)

Get the specific Token.

generateParseException

public ParseException generateParseException()

Generate ParseException.

enable_tracing

public final void enable_tracing()

Enable tracing.

disable_tracing

public final void disable_tracing()

Disable tracing.