Module io.sf.carte.css4j

Package io.sf.carte.doc.style.css.parser

Class CSSParser

java.lang.Object

io.sf.carte.doc.style.css.parser.CSSParser

All Implemented Interfaces:

Parser, Cloneable

Direct Known Subclasses:

CSSOMParser

public class CSSParser
extends Object
implements Parser, Cloneable

CSS parser implementing the NSAC API.

Additionally to NSAC, it includes several other methods.

By default, the methods that take a Reader or an InputSource as argument can process streams up to 0x6000000 (100MB) in size, and throw a SecurityException if they hit that limit. See also setStreamSizeLimit(int).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CSSParser.DeclarationRuleHandler	Small extension to CSSHandler to deal with declaration rules.

Nested classes/interfaces inherited from interface io.sf.carte.doc.style.css.nsac.Parser

Parser.Flag, Parser.NamespaceMap

Constructor Summary

Constructors

Modifier	Constructor	Description
	CSSParser()	Instantiate a parser instance with no flags.
protected	CSSParser(CSSParser copyMe)
	CSSParser(EnumSet<Parser.Flag> parserFlags)	Instantiate a parser instance with the given flags.

Method Summary

Modifier and Type	Method	Description
CSSParser	clone()
protected SupportsConditionFactory	createSupportsConditionFactory(SheetContext parentSheet)	Create a new factory for @supports conditions.
protected MediaQueryFactory	getMediaQueryFactory()
void	parseDeclarationRule(Reader reader)	Parse any simple (non-nesting) at-rule containing descriptors, using a generic CSSParser.DeclarationRuleHandler.
void	parseFontFeatureValuesBody(String blockList)
void	parseKeyFramesBody(String blockList)
void	parseMediaQueryList(String media, MediaQueryFactory queryFactory, MediaQueryHandler mqhandler)	Parse a media query string into the given handler.
MediaQueryList	parseMediaQueryList(String media, Node owner)	Parse a media query string.
void	parsePageRuleBody(String blockList)
PageSelectorList	parsePageSelectorList(String pageSelectorStr)
boolean	parsePriority(Reader reader)	Parse a CSS priority value (e.g. "!
LexicalUnit	parsePropertyValue(InputSource source)
LexicalUnit	parsePropertyValue(Reader reader)	Parse a CSS property value.
LexicalUnit	parsePropertyValue(String propertyName, Reader reader)
Condition	parsePseudoElement(String pseudoElement)	Parse a pseudo-element.
void	parseRule(InputSource source)
void	parseRule(Reader reader)	Parse a namespaceless CSS rule.
void	parseRule(Reader reader, Parser.NamespaceMap nsmap)	Parse a CSS rule.
SelectorList	parseSelectors(InputSource source)
SelectorList	parseSelectors(Reader reader)	Parse a comma separated list of selectors.
SelectorList	parseSelectors(String seltext)
SelectorList	parseSelectors(String selectorText, Parser.NamespaceMap nsmap)	Parse a comma separated list of selectors.
void	parseStyleDeclaration(InputSource source)
void	parseStyleDeclaration(Reader reader)	Parse a CSS style declaration (without '{' and '}').
void	parseStyleSheet(InputSource source)	Parse a CSS style sheet.
void	parseStyleSheet(Reader reader)	Parse a CSS style sheet.
void	parseStyleSheet(String uri)	Parse a CSS sheet from a URI.
BooleanCondition	parseSupportsCondition(String conditionText, CSSRule rule)	Parse the condition text of a @supports rule.
BooleanCondition	parseSupportsCondition(String conditionText, CSSRule rule, SheetContext parentStyleSheet)	Parse the condition text of a @supports rule.
void	setDocumentHandler(CSSHandler handler)	Allow an application to set a document event handler.
void	setErrorHandler(CSSErrorHandler handler)	Allow an application to set an error event handler.
void	setFlag(Parser.Flag flag)	Set a parser flag.
void	setStreamSizeLimit(int streamSizeLimit)	Set a new limit for the stream size that can be processed.
void	unsetFlag(Parser.Flag flag)	Unset a parser flag.

Methods inherited from class java.lang.Object

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

Constructor Details

CSSParser

public CSSParser()

Instantiate a parser instance with no flags.

CSSParser

public CSSParser(EnumSet<Parser.Flag> parserFlags)

Instantiate a parser instance with the given flags.

Parameters:

parserFlags - the flags.

CSSParser

protected CSSParser(CSSParser copyMe)

Method Details

setDocumentHandler

public void setDocumentHandler(CSSHandler handler)

Description copied from interface: Parser

Allow an application to set a document event handler.

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 Parser

Parameters:

handler - The document handler.

See Also:

• CSSHandler

setErrorHandler

public void setErrorHandler(CSSErrorHandler handler)

Description copied from interface: Parser

Allow an application to set an error event handler.

If the application does not register an error event handler, any error will result in a CSSParseException being thrown.

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 Parser

Parameters:

handler - The error handler.

See Also:

• CSSErrorHandler
• CSSParseException

setFlag

public void setFlag(Parser.Flag flag)

Set a parser flag.

Currently only STARHACK is supported, and it only applies to the parsing of full sheets.

Specified by:

setFlag in interface Parser

Parameters:

flag - the flag.

unsetFlag

public void unsetFlag(Parser.Flag flag)

Unset a parser flag.

Specified by:

unsetFlag in interface Parser

Parameters:

flag - the flag.

setStreamSizeLimit

public void setStreamSizeLimit(int streamSizeLimit)

Set a new limit for the stream size that can be processed.

Calling this method does not affect the parsing that was already ongoing.

Parameters:

streamSizeLimit - the new limit to be enforced by new processing by this parser.

Throws:

IllegalArgumentException - if a limit below 64K was used.

parseStyleSheet

public void parseStyleSheet(Reader reader)
                     throws CSSParseException,
IOException,
IllegalStateException

Description copied from interface: Parser

Parse a CSS style sheet.

Note: in addition to the listed exceptions, this method may raise runtime exceptions produced by the CSSHandler.

Specified by:

parseStyleSheet in interface Parser

Parameters:

reader - the character stream containing the CSS sheet.

Throws:

CSSParseException - if an error was found and no error handler was set.

IOException - if a I/O error was found while retrieving the sheet.

IllegalStateException - if the CSSHandler is not set.

See Also:

• Parser.setDocumentHandler(io.sf.carte.doc.style.css.nsac.CSSHandler)
• Parser.setErrorHandler(io.sf.carte.doc.style.css.nsac.CSSErrorHandler)

parseStyleSheet

public void parseStyleSheet(String uri)
                     throws CSSParseException,
IOException,
IllegalStateException

Parse a CSS sheet from a URI.

The sheet is parsed as a rule list, that is, XML's CDO-CDC comments are not expected.

The timeout to establish a connection is of 30 seconds.

Usage of this method may have security implications. Please make sure that the URI being passed is safe to use.

Specified by:

parseStyleSheet in interface Parser

Parameters:

uri - The URI locating the sheet.

Throws:

CSSParseException - if an error was found and no error handler was set.

IOException - if uri is an invalid URL or a I/O error was found while retrieving the sheet.

IllegalStateException - if the CSSHandler is not set.

See Also:

• setDocumentHandler(io.sf.carte.doc.style.css.nsac.CSSHandler)
• setErrorHandler(io.sf.carte.doc.style.css.nsac.CSSErrorHandler)

parseStyleSheet

public void parseStyleSheet(InputSource source)
                     throws CSSParseException,
IOException,
IllegalStateException,
IllegalArgumentException

Description copied from interface: Parser

Parse a CSS style sheet.

Note: in addition to the listed exceptions, this method may raise runtime exceptions produced by the CSSHandler.

Specified by:

parseStyleSheet in interface Parser

Parameters:

source - the input source of the CSS sheet.

Throws:

CSSParseException - if an error was found and no error handler was set.

IOException - if a I/O error was found while retrieving the sheet.

IllegalStateException - if the CSSHandler is not set.

IllegalArgumentException - if no stream could be obtained from the source.

See Also:

• Parser.setDocumentHandler(io.sf.carte.doc.style.css.nsac.CSSHandler)
• Parser.setErrorHandler(io.sf.carte.doc.style.css.nsac.CSSErrorHandler)

parseStyleDeclaration

public void parseStyleDeclaration(Reader reader)
                           throws CSSParseException,
IOException,
IllegalStateException

Description copied from interface: Parser

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

Specified by:

parseStyleDeclaration in interface Parser

Parameters:

reader - the character stream containing the CSS style declaration.

Throws:

CSSParseException - if an error was found and no error handler was set.

IOException - if a I/O error was found while retrieving the declaration.

IllegalStateException - if the CSSHandler is not set.

parseStyleDeclaration

public void parseStyleDeclaration(InputSource source)
                           throws CSSException,
IOException,
IllegalStateException

Throws:

CSSException

IOException

IllegalStateException

parseDeclarationRule

public void parseDeclarationRule(Reader reader)
                          throws CSSParseException,
IOException

Parse any simple (non-nesting) at-rule containing descriptors, using a generic CSSParser.DeclarationRuleHandler.

In general it is recommended to use parseRule(Reader) to parse individual at-rules, however this method can be useful for generic rules that are not yet supported by the CSSHandler interface, as well as for @keyframe which isn't a top-level rule.

As mentioned, the rule cannot have nested rules.

Note: in addition to the listed exceptions, this method may raise runtime exceptions produced by the DeclarationRuleHandler.

Parameters:

reader - the character stream containing the CSS rule.

Throws:

CSSParseException - if an error was found and no error handler was set.

IOException - if a I/O error was found while retrieving the rule.

IllegalStateException - if the CSSHandler is not set or is not a DeclarationRuleHandler.

parsePageSelectorList

public PageSelectorList parsePageSelectorList(String pageSelectorStr)
                                       throws DOMException

Throws:

DOMException

parseRule

public void parseRule(Reader reader)
               throws CSSParseException,
IOException,
IllegalStateException

Description copied from interface: Parser

Parse a namespaceless CSS rule.

Note: in addition to the listed exceptions, this method may raise runtime exceptions produced by the CSSHandler.

Specified by:

parseRule in interface Parser

Parameters:

reader - the character stream containing the CSS rule.

Throws:

CSSParseException - if an error was found and no error handler was set.

IOException - if a I/O error was found while retrieving the rule.

IllegalStateException - if the CSSHandler is not set.

parseRule

public void parseRule(Reader reader,
 Parser.NamespaceMap nsmap)
               throws CSSParseException,
IOException,
IllegalStateException

Description copied from interface: Parser

Parse a CSS rule.

Note: in addition to the listed exceptions, this method may raise runtime exceptions produced by the CSSHandler.

Specified by:

parseRule in interface Parser

Parameters:

reader - the character stream containing the CSS rule.

nsmap - the namespace map.

Throws:

CSSParseException - if an error was found and no error handler was set.

IOException - if a I/O error was found while retrieving the rule.

IllegalStateException - if the CSSHandler is not set.

parseRule

public void parseRule(InputSource source)
               throws CSSParseException,
IOException

Throws:

CSSParseException

IOException

parsePageRuleBody

public void parsePageRuleBody(String blockList)
                       throws CSSParseException

Throws:

CSSParseException

parseKeyFramesBody

public void parseKeyFramesBody(String blockList)
                        throws CSSParseException

Throws:

CSSParseException

parseFontFeatureValuesBody

public void parseFontFeatureValuesBody(String blockList)
                                throws CSSParseException

Throws:

CSSParseException

parseSupportsCondition

public BooleanCondition parseSupportsCondition(String conditionText,
 CSSRule rule)
                                        throws CSSParseException,
CSSBudgetException

Parse the condition text of a @supports rule.

Parameters:

conditionText - the condition text.

rule - the rule that would process the error. If null, a problem while parsing shall result in an exception. Note that NOT_SUPPORTED_ERR exceptions are always thrown instead of being processed by the rule. Please use parseSupportsCondition(String, CSSRule, SheetContext) with a style sheet argument if you do not want to supply a rule, otherwise namespace-related errors may be produced.

Returns:

the @supports condition, or null if a rule was specified to handle the errors, and an error was produced.

Throws:

CSSParseException - if there is a syntax problem and there is no error handler.

CSSBudgetException - if a hard-coded limit in nested expressions was reached.

See Also:

• parseSupportsCondition(String, CSSRule, SheetContext)

parseSupportsCondition

public BooleanCondition parseSupportsCondition(String conditionText,
 CSSRule rule,
 SheetContext parentStyleSheet)
                                        throws CSSParseException,
CSSBudgetException

Parse the condition text of a @supports rule.

Parameters:

conditionText - the condition text.

rule - the rule that would process the error. If null, a problem while parsing shall result in an exception. Note that NOT_SUPPORTED_ERR exceptions are always thrown instead of being processed by the rule.

parentStyleSheet - the parent style sheet context. It is necessary to provide information related to namespaces, as well as customizing the serialization.

Returns:

the @supports condition, or null if a rule was specified to handle the errors, and an error was produced.

Throws:

CSSParseException - if there is a syntax problem and there is no error handler.

CSSBudgetException - if a hard-coded limit in nested expressions was reached.

createSupportsConditionFactory

protected SupportsConditionFactory createSupportsConditionFactory(SheetContext parentSheet)

Create a new factory for @supports conditions.

Parameters:

parentSheet - the @supports rule's parent style sheet context.

Returns:

the factory.

parseMediaQueryList

public void parseMediaQueryList(String media,
 MediaQueryFactory queryFactory,
 MediaQueryHandler mqhandler)
                         throws CSSBudgetException

Parse a media query string into the given handler.

Specified by:

parseMediaQueryList in interface Parser

Parameters:

media - the media query text.

queryFactory - the query factory.

mqhandler - the media query list handler.

Throws:

CSSBudgetException - if a hard-coded limit in nested expressions was reached.

parseMediaQueryList

public MediaQueryList parseMediaQueryList(String media,
 Node owner)
                                   throws CSSBudgetException

Parse a media query string.

Specified by:

parseMediaQueryList in interface Parser

Parameters:

media - the media query text.

owner - the node that owns the responsibility to handle the errors in the query list.

Returns:

the media query list.

Throws:

CSSBudgetException - if a hard-coded limit in nested expressions was reached.

getMediaQueryFactory

protected MediaQueryFactory getMediaQueryFactory()

parseSelectors

public SelectorList parseSelectors(Reader reader)
                            throws CSSParseException,
CSSBudgetException,
IOException

Description copied from interface: Parser

Parse a comma separated list of selectors.

Specified by:

parseSelectors in interface Parser

Parameters:

reader - the character stream containing the selector list.

Returns:

the selector list.

Throws:

CSSParseException - if an error was found and no error handler was set.

IOException - if a I/O error was found while retrieving the list.

CSSBudgetException

parseSelectors

public SelectorList parseSelectors(String selectorText,
 Parser.NamespaceMap nsmap)
                            throws CSSParseException

Description copied from interface: Parser

Parse a comma separated list of selectors.

Specified by:

parseSelectors in interface Parser

Parameters:

selectorText - the String containing the selector list.

nsmap - the namespace map to apply to the selector list, if it contains namespace prefixes.

Returns:

the selector list.

Throws:

CSSParseException - if an error was found and no error handler was set.

parseSelectors

public SelectorList parseSelectors(InputSource source)
                            throws CSSParseException,
IOException

Throws:

CSSParseException

IOException

parseSelectors

public SelectorList parseSelectors(String seltext)
                            throws CSSException

Throws:

CSSException

parsePseudoElement

public Condition parsePseudoElement(String pseudoElement)
                             throws CSSException

Description copied from interface: Parser

Parse a pseudo-element.

Specified by:

parsePseudoElement in interface Parser

Parameters:

pseudoElement - the string representation of a pseudo-element.

Returns:

the pseudo-element condition.

Throws:

CSSException - if the argument is not a parsable pseudo-element.

parsePropertyValue

public LexicalUnit parsePropertyValue(Reader reader)
                               throws CSSParseException,
IOException

Description copied from interface: Parser

Parse a CSS property value.

Specified by:

parsePropertyValue in interface Parser

Parameters:

reader - the character stream containing the CSS property value.

Returns:

the lexical unit containing the value, possibly chained to subsequent lexical units.

Throws:

CSSParseException - if an error was found and no error handler was set.

IOException - if a I/O error was found while retrieving the value.

parsePropertyValue

public LexicalUnit parsePropertyValue(String propertyName,
 Reader reader)
                               throws CSSParseException,
IOException

Throws:

CSSParseException

IOException

parsePropertyValue

public LexicalUnit parsePropertyValue(InputSource source)
                               throws CSSParseException,
IOException

Throws:

CSSParseException

IOException

parsePriority

public boolean parsePriority(Reader reader)
                      throws IOException

Description copied from interface: Parser

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

Specified by:

parsePriority in interface Parser

Parameters:

reader - the character stream containing the CSS priority.

Returns:

true if the priority is important.

Throws:

IOException - if a I/O error was found while retrieving the priority.

clone

public CSSParser clone()

Overrides:

clone in class Object