Class Parser

java.lang.Object

org.apache.jasper.compiler.Parser

All Implemented Interfaces:

TagConstants

class Parser
extends Object
implements TagConstants

This class implements a parser for a JSP page (non-xml view). JSP page grammar is included here for reference. The token '#' that appears in the production indicates the current input token location in the production.

Field Summary

Fields

Modifier and Type	Field	Description
private JspCompilationContext	ctxt
private boolean	directivesOnly
private ErrorDispatcher	err
private boolean	errorOnUndeclaredNamespace
private boolean	isTagFile
private URL	jarFileUrl
private static final String	JAVAX_BODY_CONTENT_PARAM
private static final String	JAVAX_BODY_CONTENT_PLUGIN
private static final String	JAVAX_BODY_CONTENT_TEMPLATE_TEXT
private PageInfo	pageInfo
private ParserController	parserController
private JspReader	reader
private int	scriptlessCount
private Mark	start

Fields inherited from interface TagConstants

ATTRIBUTE_ACTION, ATTRIBUTE_DIRECTIVE_ACTION, BODY_ACTION, DECLARATION_ACTION, DIRECTIVE_ACTION, DOBODY_ACTION, ELEMENT_ACTION, EXPRESSION_ACTION, FALLBACK_ACTION, FORWARD_ACTION, GET_PROPERTY_ACTION, INCLUDE_ACTION, INCLUDE_DIRECTIVE_ACTION, INVOKE_ACTION, JSP_ATTRIBUTE_ACTION, JSP_ATTRIBUTE_DIRECTIVE_ACTION, JSP_BODY_ACTION, JSP_DECLARATION_ACTION, JSP_DOBODY_ACTION, JSP_ELEMENT_ACTION, JSP_EXPRESSION_ACTION, JSP_FALLBACK_ACTION, JSP_FORWARD_ACTION, JSP_GET_PROPERTY_ACTION, JSP_INCLUDE_ACTION, JSP_INCLUDE_DIRECTIVE_ACTION, JSP_INVOKE_ACTION, JSP_OUTPUT_ACTION, JSP_PAGE_DIRECTIVE_ACTION, JSP_PARAM_ACTION, JSP_PARAMS_ACTION, JSP_PLUGIN_ACTION, JSP_ROOT_ACTION, JSP_SCRIPTLET_ACTION, JSP_SET_PROPERTY_ACTION, JSP_TAG_DIRECTIVE_ACTION, JSP_TAGLIB_DIRECTIVE_ACTION, JSP_TEXT_ACTION, JSP_TEXT_ACTION_END, JSP_URI, JSP_USE_BEAN_ACTION, JSP_VARIABLE_DIRECTIVE_ACTION, OUTPUT_ACTION, PAGE_DIRECTIVE_ACTION, PARAM_ACTION, PARAMS_ACTION, PLUGIN_ACTION, ROOT_ACTION, SCRIPTLET_ACTION, SET_PROPERTY_ACTION, TAG_DIRECTIVE_ACTION, TAGLIB_DIRECTIVE_ACTION, TEXT_ACTION, URN_JSPTAGDIR, URN_JSPTLD, USE_BEAN_ACTION, VARIABLE_DIRECTIVE_ACTION

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Parser(ParserController pc, JspReader reader, boolean isTagFile, boolean directivesOnly, URL jarFileUrl, boolean hasBom)	The constructor

Method Summary

Modifier and Type	Method	Description
private void	addInclude(Node parent, List files)	Add a list of files.
private void	checkUnbalancedEndTag()
private String	getAttributeBodyType(Node n, String name)	Determine the body type of invalid input: '<'jsp:attribute> from the enclosing node
static Node.Nodes	parse(ParserController pc, String path, JspReader reader, Node parent, boolean isTagFile, boolean directivesOnly, URL jarFileUrl, String pageEnc, String jspConfigPageEnc, boolean isDefaultPageEncoding, boolean hasBom)	The main entry for Parser
private boolean	parseAttribute(AttributesImpl attrs)	Attribute ::= Name S? Eq S? ( '"invalid input: '<'%=' RTAttributeValueDouble | '"' AttributeValueDouble | "'invalid input: '<'%=" RTAttributeValueSingle | "'" AttributeValueSingle } Note: JSP and XML spec does not allow while spaces around Eq.
private void	parseAttributeDirective(Node parent)
(package private) Attributes	parseAttributes()	Attributes ::= (S Attribute)* S?
static Attributes	parseAttributes(ParserController pc, JspReader reader)	Parse Attributes for a reader, provided for external use
private String	parseAttributeValue(String watch)	AttributeValueDouble ::= (QuotedChar - '"')* ('"' | ) RTAttributeValueDouble ::= ((QuotedChar - '"')* - ((QuotedChar-'"')'%>"') ('%>"' | TRANSLATION_ERROR)
private void	parseBody(Node parent, String tag, String bodyType)
private void	parseComment(Node parent)
private boolean	parseCustomTag(Node parent)
private void	parseDeclaration(Node parent)
private void	parseDirective(Node parent)
private void	parseDoBody(Node parent)
private void	parseElement(Node parent)
private void	parseElements(Node parent)
private void	parseElementsScriptless(Node parent)
private void	parseElementsTemplateText(Node parent)
private void	parseELExpression(Node parent, String typeEL)
private void	parseEmptyBody(Node parent, String tag)
private void	parseExpression(Node parent)
private void	parseFallBack(Node parent)
private void	parseForward(Node parent)
private void	parseGetProperty(Node parent)
private void	parseInclude(Node parent)
private void	parseIncludeDirective(Node parent)
private void	parseInvoke(Node parent)
private boolean	parseJspAttributeAndBody(Node parent, String tag, String bodyType)	Attempts to parse 'JspAttributeAndBody' production.
private void	parseJspBody(Node parent, String bodyType)
private void	parseJspParams(Node parent)
private String	parseName()	Name ::= (Letter | '_' | ':') (Letter | Digit | '.' | '_' | '-' | ':')*
private void	parseNamedAttributes(Node parent)
private void	parseOptionalBody(Node parent, String tag, String bodyType)
private void	parsePageDirective(Node parent)
private void	parseParam(Node parent)	Param ::= 'invalid input: '<'jsp:param' S Attributes S? EmptyBody S?
private void	parsePlugin(Node parent)
private void	parsePluginTags(Node parent)
private String	parseQuoted(String tx)	QuotedChar ::= ''' | '"' | '\\' | '\"' | "\'" | '\>' | '\$' | '\#' | Char
private void	parseScriptlet(Node parent)
private String	parseScriptText(String tx)
private void	parseSetProperty(Node parent)
private void	parseStandardAction(Node parent)
private void	parseTagDependentBody(Node parent, String tag)	TagDependentBody :=
private void	parseTagDirective(Node parent)
private void	parseTagFileDirectives(Node parent)
private void	parseTaglibDirective(Node parent)
private void	parseTemplateText(Node parent)
private void	parseUseBean(Node parent)
private void	parseVariableDirective(Node parent)
private void	parseXMLDeclaration(Node parent)
private void	parseXMLDirective(Node parent)
private void	parseXMLExpression(Node parent)
private void	parseXMLScriptlet(Node parent)
private void	parseXMLTemplateText(Node parent)
private void	processIncludeDirective(String file, Node parent)

Methods inherited from class Object

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

Field Details

parserController

private ParserController parserController

ctxt

private JspCompilationContext ctxt

reader

private JspReader reader

start

private Mark start

err

private ErrorDispatcher err

scriptlessCount

private int scriptlessCount

isTagFile

private boolean isTagFile

directivesOnly

private boolean directivesOnly

jarFileUrl

private URL jarFileUrl

pageInfo

private PageInfo pageInfo

errorOnUndeclaredNamespace

private boolean errorOnUndeclaredNamespace

JAVAX_BODY_CONTENT_PARAM

private static final String JAVAX_BODY_CONTENT_PARAM

See Also:

• Constant Field Values

JAVAX_BODY_CONTENT_PLUGIN

private static final String JAVAX_BODY_CONTENT_PLUGIN

See Also:

• Constant Field Values

JAVAX_BODY_CONTENT_TEMPLATE_TEXT

private static final String JAVAX_BODY_CONTENT_TEMPLATE_TEXT

See Also:

• Constant Field Values

Constructor Details

Parser

private Parser(ParserController pc,
 JspReader reader,
 boolean isTagFile,
 boolean directivesOnly,
 URL jarFileUrl,
 boolean hasBom)

The constructor

Method Details

parse

public static Node.Nodes parse(ParserController pc,
 String path,
 JspReader reader,
 Node parent,
 boolean isTagFile,
 boolean directivesOnly,
 URL jarFileUrl,
 String pageEnc,
 String jspConfigPageEnc,
 boolean isDefaultPageEncoding,
 boolean hasBom)
                        throws JasperException

The main entry for Parser

Parameters:

pc - The ParseController, use for getting other objects in compiler and for parsing included pages

reader - To read the page

parent - The parent node to this page, null for top level page

Returns:

list of nodes representing the parsed page

Throws:

JasperException

parseAttributes

Attributes parseAttributes()
                    throws JasperException

Attributes ::= (S Attribute)* S?

Throws:

JasperException

parseAttributes

public static Attributes parseAttributes(ParserController pc,
 JspReader reader)
                                  throws JasperException

Parse Attributes for a reader, provided for external use

Throws:

JasperException

parseAttribute

private boolean parseAttribute(AttributesImpl attrs)
                        throws JasperException

Attribute ::= Name S? Eq S? ( '"invalid input: '<'%=' RTAttributeValueDouble | '"' AttributeValueDouble | "'invalid input: '<'%=" RTAttributeValueSingle | "'" AttributeValueSingle } Note: JSP and XML spec does not allow while spaces around Eq. It is added to be backward compatible with Tomcat, and with other xml parsers.

Throws:

JasperException

parseName

private String parseName()
                  throws JasperException

Name ::= (Letter | '_' | ':') (Letter | Digit | '.' | '_' | '-' | ':')*

Throws:

JasperException

parseAttributeValue

private String parseAttributeValue(String watch)
                            throws JasperException

AttributeValueDouble ::= (QuotedChar - '"')* ('"' | ) RTAttributeValueDouble ::= ((QuotedChar - '"')* - ((QuotedChar-'"')'%>"') ('%>"' | TRANSLATION_ERROR)

Throws:

JasperException

parseQuoted

private String parseQuoted(String tx)

QuotedChar ::= ''' | '"' | '\\' | '\"' | "\'" | '\>' | '\$' | '\#' | Char

parseScriptText

private String parseScriptText(String tx)

processIncludeDirective

private void processIncludeDirective(String file,
 Node parent)
                              throws JasperException

Throws:

JasperException

parsePageDirective

private void parsePageDirective(Node parent)
                         throws JasperException

Throws:

JasperException

parseIncludeDirective

private void parseIncludeDirective(Node parent)
                            throws JasperException

Throws:

JasperException

addInclude

private void addInclude(Node parent,
 List files)
                 throws JasperException

Add a list of files. This is used for implementing include-prelude and include-coda of jsp-config element in web.xml

Throws:

JasperException

parseTaglibDirective

private void parseTaglibDirective(Node parent)
                           throws JasperException

Throws:

JasperException

parseDirective

private void parseDirective(Node parent)
                     throws JasperException

Throws:

JasperException

parseXMLDirective

private void parseXMLDirective(Node parent)
                        throws JasperException

Throws:

JasperException

parseTagDirective

private void parseTagDirective(Node parent)
                        throws JasperException

Throws:

JasperException

parseAttributeDirective

private void parseAttributeDirective(Node parent)
                              throws JasperException

Throws:

JasperException

parseVariableDirective

private void parseVariableDirective(Node parent)
                             throws JasperException

Throws:

JasperException

parseComment

private void parseComment(Node parent)
                   throws JasperException

Throws:

JasperException

parseDeclaration

private void parseDeclaration(Node parent)
                       throws JasperException

Throws:

JasperException

parseXMLDeclaration

private void parseXMLDeclaration(Node parent)
                          throws JasperException

Throws:

JasperException

parseExpression

private void parseExpression(Node parent)
                      throws JasperException

Throws:

JasperException

parseXMLExpression

private void parseXMLExpression(Node parent)
                         throws JasperException

Throws:

JasperException

parseELExpression

private void parseELExpression(Node parent,
 String typeEL)
                        throws JasperException

Throws:

JasperException

parseScriptlet

private void parseScriptlet(Node parent)
                     throws JasperException

Throws:

JasperException

parseXMLScriptlet

private void parseXMLScriptlet(Node parent)
                        throws JasperException

Throws:

JasperException

parseParam

private void parseParam(Node parent)
                 throws JasperException

Param ::= 'invalid input: '<'jsp:param' S Attributes S? EmptyBody S?

Throws:

JasperException

parseInclude

private void parseInclude(Node parent)
                   throws JasperException

Throws:

JasperException

parseForward

private void parseForward(Node parent)
                   throws JasperException

Throws:

JasperException

parseInvoke

private void parseInvoke(Node parent)
                  throws JasperException

Throws:

JasperException

parseDoBody

private void parseDoBody(Node parent)
                  throws JasperException

Throws:

JasperException

parseElement

private void parseElement(Node parent)
                   throws JasperException

Throws:

JasperException

parseGetProperty

private void parseGetProperty(Node parent)
                       throws JasperException

Throws:

JasperException

parseSetProperty

private void parseSetProperty(Node parent)
                       throws JasperException

Throws:

JasperException

parseEmptyBody

private void parseEmptyBody(Node parent,
 String tag)
                     throws JasperException

Throws:

JasperException

parseUseBean

private void parseUseBean(Node parent)
                   throws JasperException

Throws:

JasperException

parseOptionalBody

private void parseOptionalBody(Node parent,
 String tag,
 String bodyType)
                        throws JasperException

Throws:

JasperException

parseJspAttributeAndBody

private boolean parseJspAttributeAndBody(Node parent,
 String tag,
 String bodyType)
                                  throws JasperException

Attempts to parse 'JspAttributeAndBody' production. Returns true if it matched, or false if not. Assumes EmptyBody is okay as well. JspAttributeAndBody ::= ( '>' # S? ( 'invalid input: '<'jsp:attribute' NamedAttributes )? 'invalid input: '<'jsp:body' ( JspBodyBody | ) S? ETag )

Throws:

JasperException

parseJspParams

private void parseJspParams(Node parent)
                     throws JasperException

Throws:

JasperException

parseFallBack

private void parseFallBack(Node parent)
                    throws JasperException

Throws:

JasperException

parsePlugin

private void parsePlugin(Node parent)
                  throws JasperException

Throws:

JasperException

parsePluginTags

private void parsePluginTags(Node parent)
                      throws JasperException

Throws:

JasperException

parseStandardAction

private void parseStandardAction(Node parent)
                          throws JasperException

Throws:

JasperException

parseCustomTag

private boolean parseCustomTag(Node parent)
                        throws JasperException

Throws:

JasperException

parseTemplateText

private void parseTemplateText(Node parent)
                        throws JasperException

Throws:

JasperException

parseXMLTemplateText

private void parseXMLTemplateText(Node parent)
                           throws JasperException

Throws:

JasperException

parseElements

private void parseElements(Node parent)
                    throws JasperException

Throws:

JasperException

parseElementsScriptless

private void parseElementsScriptless(Node parent)
                              throws JasperException

Throws:

JasperException

parseElementsTemplateText

private void parseElementsTemplateText(Node parent)
                                throws JasperException

Throws:

JasperException

checkUnbalancedEndTag

private void checkUnbalancedEndTag()
                            throws JasperException

Throws:

JasperException

parseTagDependentBody

private void parseTagDependentBody(Node parent,
 String tag)
                            throws JasperException

TagDependentBody :=

Throws:

JasperException

parseJspBody

private void parseJspBody(Node parent,
 String bodyType)
                   throws JasperException

Throws:

JasperException

parseBody

private void parseBody(Node parent,
 String tag,
 String bodyType)
                throws JasperException

Throws:

JasperException

parseNamedAttributes

private void parseNamedAttributes(Node parent)
                           throws JasperException

Throws:

JasperException

getAttributeBodyType

private String getAttributeBodyType(Node n,
 String name)

Determine the body type of invalid input: '<'jsp:attribute> from the enclosing node

parseTagFileDirectives

private void parseTagFileDirectives(Node parent)
                             throws JasperException

Throws:

JasperException