com.gargoylesoftware.css.parser

Class AbstractCSSParser

java.lang.Object

com.gargoylesoftware.css.parser.AbstractCSSParser

All Implemented Interfaces:

CSSParser

public abstract class AbstractCSSParser
extends Object
implements CSSParser

Base implementation of CSSParser.

Author:

Ronald Brill

Constructor Summary

Constructors

Constructor and Description
AbstractCSSParser()

Method Summary

Modifier and Type	Method and Description
protected String	add_escapes(String str)
protected Locator	createLocator(com.gargoylesoftware.css.parser.javacc.Token t)
protected CSSParseException	createSkipWarning(String key, CSSParseException e)
protected abstract LexicalUnit	expr()
protected float	floatValue(char op, String s)
protected LexicalUnit	functionInternal(LexicalUnit prev, String funct, LexicalUnit params)
protected DocumentHandler	getDocumentHandler()
protected CSSErrorHandler	getErrorHandler()
protected abstract String	getGrammarUri()
protected InputSource	getInputSource()
protected int	getLastNumPos(String s)
protected String	getParserMessage(String key)
abstract String	getParserVersion()
protected void	handleCharset(String characterEncoding, Locator locator)
protected void	handleEndDocument()
protected void	handleEndFontFace()
protected void	handleEndMedia(MediaQueryList media)
protected void	handleEndPage(String name, String pseudoPage)
protected void	handleEndSelector(SelectorList selectors)
protected void	handleIgnorableAtRule(String s, Locator locator)
protected void	handleImportStyle(String uri, MediaQueryList media, String defaultNamespaceURI, Locator locator)
protected void	handleMedium(String medium, Locator locator)
protected void	handleProperty(String name, LexicalUnit value, boolean important, Locator locator)
protected void	handleSelector(Selector selector)
protected void	handleStartDocument()
protected void	handleStartFontFace(Locator locator)
protected void	handleStartMedia(MediaQueryList media, Locator locator)
protected void	handleStartPage(String name, String pseudoPage, Locator locator)
protected void	handleStartSelector(SelectorList selectors, Locator locator)
protected LexicalUnit	hexcolorInternal(LexicalUnit prev, com.gargoylesoftware.css.parser.javacc.Token t)
protected int	intValue(char op, String s)
boolean	isIeStarHackAccepted()
protected abstract void	mediaList(MediaQueryList ml)
MediaQueryList	parseMedia(InputSource source)
boolean	parsePriority(InputSource source) Parse a CSS priority value (e.g. "!
LexicalUnit	parsePropertyValue(InputSource source) Parse a CSS property value.
void	parseRule(InputSource source) Parse a CSS rule.
SelectorList	parseSelectors(InputSource source) Parse a comma separated list of selectors.
protected abstract SelectorList	parseSelectorsInternal()
void	parseStyleDeclaration(InputSource source) Parse a CSS style declaration (without '{' and '}').
void	parseStyleSheet(InputSource source) Parse a CSS document.
void	parseStyleSheet(String uri) Parse a CSS document from a URI.
protected abstract boolean	prio()
protected abstract void	ReInit(com.gargoylesoftware.css.parser.javacc.CharStream charStream)
protected abstract SelectorList	selectorList()
void	setDocumentHandler(DocumentHandler handler) Allow an application to register a document event handler.
void	setErrorHandler(CSSErrorHandler eh) Allow an application to register an error event handler.
void	setIeStarHackAccepted(boolean accepted)
protected abstract void	styleDeclaration()
protected abstract void	styleSheet()
protected abstract void	styleSheetRuleSingle()
protected CSSParseException	toCSSParseException(DOMException e)
protected CSSParseException	toCSSParseException(String messageKey, Object[] msgParams, Locator locator)
protected CSSParseException	toCSSParseException(String key, com.gargoylesoftware.css.parser.javacc.ParseException e)
protected CSSParseException	toCSSParseException(com.gargoylesoftware.css.parser.javacc.TokenMgrError e)
String	unescape(String s, boolean unescapeDoubleQuotes) Unescapes escaped characters in the specified string, according to the CSS specification.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCSSParser

public AbstractCSSParser()

Method Detail

getDocumentHandler

protected DocumentHandler getDocumentHandler()

setDocumentHandler

public void setDocumentHandler(DocumentHandler handler)

Description copied from interface: CSSParser

Allow an application to register a document event handler.

If the application does not register a document handler, all document events reported by the CSS parser will be silently ignored (this is the default behaviour implemented by HandlerBase).

Applications may register a new or different handler in the middle of a parse, and the CSS parser must begin using the new handler immediately.

Specified by:

setDocumentHandler in interface CSSParser

Parameters:

handler - The document handler.

See Also:

DocumentHandler

getErrorHandler

protected CSSErrorHandler getErrorHandler()

setErrorHandler

public void setErrorHandler(CSSErrorHandler eh)

Description copied from interface: CSSParser

Allow an application to register an error event handler.

If the application does not register an error event handler, all error events reported by the CSS parser will be silently ignored, except for fatalError, which will throw a CSSException (this is the default behaviour implemented by HandlerBase).

Applications may register a new or different handler in the middle of a parse, and the CSS parser must begin using the new handler immediately.

Specified by:

setErrorHandler in interface CSSParser

Parameters:

eh - The error handler.

See Also:

CSSErrorHandler, CSSException

getInputSource

protected InputSource getInputSource()

setIeStarHackAccepted

public void setIeStarHackAccepted(boolean accepted)

Specified by:

setIeStarHackAccepted in interface CSSParser

Parameters:

accepted - trur if the parser should accept ie star hack

isIeStarHackAccepted

public boolean isIeStarHackAccepted()

Specified by:

isIeStarHackAccepted in interface CSSParser

Returns:

accepted trur if the parser should accept ie star hack

getParserMessage

protected String getParserMessage(String key)

createLocator

protected Locator createLocator(com.gargoylesoftware.css.parser.javacc.Token t)

add_escapes

protected String add_escapes(String str)

toCSSParseException

protected CSSParseException toCSSParseException(String key,
                                                com.gargoylesoftware.css.parser.javacc.ParseException e)

toCSSParseException

protected CSSParseException toCSSParseException(DOMException e)

toCSSParseException

protected CSSParseException toCSSParseException(com.gargoylesoftware.css.parser.javacc.TokenMgrError e)

toCSSParseException

protected CSSParseException toCSSParseException(String messageKey,
                                                Object[] msgParams,
                                                Locator locator)

createSkipWarning

protected CSSParseException createSkipWarning(String key,
                                              CSSParseException e)

parseStyleSheet

public void parseStyleSheet(InputSource source)
                     throws IOException

Description copied from interface: CSSParser

Parse a CSS document.

The application can use this method to instruct the CSS parser to begin parsing an CSS document from any valid input source (a character stream, a byte stream, or a URI).

Applications may not invoke this method while a parse is in progress (they should create a new Parser instead for each additional CSS document). Once a parse is complete, an application may reuse the same Parser object, possibly with a different input source.

Specified by:

parseStyleSheet in interface CSSParser

Parameters:

source - The input source for the top-level of the CSS document.

Throws:

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

See Also:

InputSource, CSSParser.parseStyleSheet(java.lang.String), CSSParser.setDocumentHandler(com.gargoylesoftware.css.parser.DocumentHandler), CSSParser.setErrorHandler(com.gargoylesoftware.css.parser.CSSErrorHandler)

parseStyleSheet

public void parseStyleSheet(String uri)
                     throws IOException

Description copied from interface: CSSParser

Parse a CSS document from a URI.

This method is a shortcut for the common case of reading a document from a URI. It is the exact equivalent of the following:

 parse(new InputSource(uri));
 

The URI must be fully resolved by the application before it is passed to the parser.

Specified by:

parseStyleSheet in interface CSSParser

Parameters:

uri - The URI.

Throws:

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

See Also:

CSSParser.parseStyleSheet(InputSource)

parseStyleDeclaration

public void parseStyleDeclaration(InputSource source)
                           throws IOException

Description copied from interface: CSSParser

Parse a CSS style declaration (without '{' and '}').

Specified by:

parseStyleDeclaration in interface CSSParser

Parameters:

source - source to be parsed

Throws:

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

parseRule

public void parseRule(InputSource source)
               throws IOException

Description copied from interface: CSSParser

Parse a CSS rule.

Specified by:

parseRule in interface CSSParser

Parameters:

source - source to be parsed

Throws:

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

parseSelectors

public SelectorList parseSelectors(InputSource source)
                            throws IOException

Description copied from interface: CSSParser

Parse a comma separated list of selectors.

Specified by:

parseSelectors in interface CSSParser

Parameters:

source - source to be parsed

Returns:

a selector list

Throws:

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

parsePropertyValue

public LexicalUnit parsePropertyValue(InputSource source)
                               throws IOException

Description copied from interface: CSSParser

Parse a CSS property value.

Specified by:

parsePropertyValue in interface CSSParser

Parameters:

source - source to be parsed

Returns:

a lexical unit

Throws:

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

parsePriority

public boolean parsePriority(InputSource source)
                      throws IOException

Description copied from interface: CSSParser

Parse a CSS priority value (e.g. "!important").

Specified by:

parsePriority in interface CSSParser

Parameters:

source - source to be parsed

Returns:

true or flase

Throws:

IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

parseMedia

public MediaQueryList parseMedia(InputSource source)
                          throws IOException

Throws:

IOException

getParserVersion

public abstract String getParserVersion()

Specified by:

getParserVersion in interface CSSParser

Returns:

a string about which CSS language is supported by this parser. For CSS Level 1, it returns "http://www.w3.org/TR/REC-CSS1", for CSS Level 2, it returns "http://www.w3.org/TR/REC-CSS2". Note that a "CSSx" parser can return lexical unit other than those allowed by CSS Level x but this usage is not recommended.

getGrammarUri

protected abstract String getGrammarUri()

ReInit

protected abstract void ReInit(com.gargoylesoftware.css.parser.javacc.CharStream charStream)

styleSheet

protected abstract void styleSheet()
                            throws CSSParseException,
                                   com.gargoylesoftware.css.parser.javacc.ParseException

Throws:

CSSParseException

com.gargoylesoftware.css.parser.javacc.ParseException

styleDeclaration

protected abstract void styleDeclaration()
                                  throws com.gargoylesoftware.css.parser.javacc.ParseException

Throws:

com.gargoylesoftware.css.parser.javacc.ParseException

styleSheetRuleSingle

protected abstract void styleSheetRuleSingle()
                                      throws com.gargoylesoftware.css.parser.javacc.ParseException

Throws:

com.gargoylesoftware.css.parser.javacc.ParseException

parseSelectorsInternal

protected abstract SelectorList parseSelectorsInternal()
                                                throws com.gargoylesoftware.css.parser.javacc.ParseException

Throws:

com.gargoylesoftware.css.parser.javacc.ParseException

selectorList

protected abstract SelectorList selectorList()
                                      throws com.gargoylesoftware.css.parser.javacc.ParseException

Throws:

com.gargoylesoftware.css.parser.javacc.ParseException

expr

protected abstract LexicalUnit expr()
                             throws com.gargoylesoftware.css.parser.javacc.ParseException

Throws:

com.gargoylesoftware.css.parser.javacc.ParseException

prio

protected abstract boolean prio()
                         throws com.gargoylesoftware.css.parser.javacc.ParseException

Throws:

com.gargoylesoftware.css.parser.javacc.ParseException

mediaList

protected abstract void mediaList(MediaQueryList ml)
                           throws com.gargoylesoftware.css.parser.javacc.ParseException

Throws:

com.gargoylesoftware.css.parser.javacc.ParseException

handleStartDocument

protected void handleStartDocument()

handleEndDocument

protected void handleEndDocument()

handleIgnorableAtRule

protected void handleIgnorableAtRule(String s,
                                     Locator locator)

handleCharset

protected void handleCharset(String characterEncoding,
                             Locator locator)

handleImportStyle

protected void handleImportStyle(String uri,
                                 MediaQueryList media,
                                 String defaultNamespaceURI,
                                 Locator locator)

handleStartMedia

protected void handleStartMedia(MediaQueryList media,
                                Locator locator)

handleMedium

protected void handleMedium(String medium,
                            Locator locator)

handleEndMedia

protected void handleEndMedia(MediaQueryList media)

handleStartPage

protected void handleStartPage(String name,
                               String pseudoPage,
                               Locator locator)

handleEndPage

protected void handleEndPage(String name,
                             String pseudoPage)

handleStartFontFace

protected void handleStartFontFace(Locator locator)

handleEndFontFace

protected void handleEndFontFace()

handleSelector

protected void handleSelector(Selector selector)

handleStartSelector

protected void handleStartSelector(SelectorList selectors,
                                   Locator locator)

handleEndSelector

protected void handleEndSelector(SelectorList selectors)

handleProperty

protected void handleProperty(String name,
                              LexicalUnit value,
                              boolean important,
                              Locator locator)

functionInternal

protected LexicalUnit functionInternal(LexicalUnit prev,
                                       String funct,
                                       LexicalUnit params)

hexcolorInternal

protected LexicalUnit hexcolorInternal(LexicalUnit prev,
                                       com.gargoylesoftware.css.parser.javacc.Token t)

intValue

protected int intValue(char op,
                       String s)

floatValue

protected float floatValue(char op,
                           String s)

getLastNumPos

protected int getLastNumPos(String s)

unescape

public String unescape(String s,
                       boolean unescapeDoubleQuotes)

Unescapes escaped characters in the specified string, according to the CSS specification. This could be done directly in the parser, but portions of the lexer would have to be moved to the parser, meaning that the grammar would no longer match the standard grammar specified by the W3C. This would make the parser and lexer much less maintainable.