Module io.sf.carte.css4j

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

Interface Parser

All Known Implementing Classes:

CSSOMParser, CSSParser

public interface Parser

A low-level CSS parser.

Based on SAC's Parser interface by Philippe Le Hegaret.

Compared to SAC, this interface replaces some of the methods that use an InputSource with a Reader. The reason is that, in opinion of the NSAC author, the InputSource (a concept coming from SAX) adds bloat and in the worst case may widen the attack surface if the application using the library is somehow abused. It is generally better that the main application takes the responsibility of opening connections to files or remote sources.

The reference implementation includes the replaced InputSource methods, in case you want to use them.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Parser.Flag	NSAC parser flags: the Parser.Flag.STARHACK, Parser.Flag.IEVALUES, Parser.Flag.IEPRIO and Parser.Flag.IEPRIOCHAR flags are supported.
static interface	Parser.NamespaceMap	Interface giving access to namespace URI from the prefix.

Method Summary

Modifier and Type	Method	Description
void	parseMediaQueryList(String media, MediaQueryFactory queryFactory, MediaQueryHandler mqhandler)	Parse a media query string into the given handler.
MediaQueryList	parseMediaQueryList(String media, Node owner)	Parse an individual list of media queries.
boolean	parsePriority(Reader reader)	Parse a CSS priority value (e.g. "!
LexicalUnit	parsePropertyValue(Reader reader)	Parse a CSS property value.
void	parseRule(Reader reader)	Parse a namespaceless CSS rule.
void	parseRule(Reader reader, Parser.NamespaceMap nsmap)	Parse a CSS rule.
SelectorList	parseSelectors(Reader reader)	Parse a comma separated list of selectors.
SelectorList	parseSelectors(String selectorText, Parser.NamespaceMap nsmap)	Parse a comma separated list of selectors.
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.
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	unsetFlag(Parser.Flag flag)	Unset a parser flag.

Method Details

setFlag

void setFlag(Parser.Flag flag)

Set a parser flag.

Parameters:

flag - the flag.

unsetFlag

void unsetFlag(Parser.Flag flag)

Unset a parser flag.

Parameters:

flag - the flag.

setDocumentHandler

void setDocumentHandler(CSSHandler handler)

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.

Parameters:

handler - The document handler.

See Also:

• CSSHandler

setErrorHandler

void setErrorHandler(CSSErrorHandler handler)

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.

Parameters:

handler - The error handler.

See Also:

• CSSErrorHandler
• CSSParseException

parseStyleSheet

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

Parse a CSS style sheet.

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

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:

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

parseStyleSheet

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

Parse a CSS style sheet.

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

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:

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

parseStyleSheet

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.

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

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

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)

parseSelectors

SelectorList parseSelectors(Reader reader)
                     throws CSSParseException,
IOException

Parse a comma separated list of selectors.

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.

parseSelectors

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

Parse a comma separated list of selectors.

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.

parseStyleDeclaration

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

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

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.

parsePropertyValue

LexicalUnit parsePropertyValue(Reader reader)
                        throws CSSParseException,
IOException

Parse a CSS property value.

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.

NullPointerException - if reader is null.

parsePriority

boolean parsePriority(Reader reader)
               throws IOException,
NullPointerException

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

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.

NullPointerException - if reader is null.

parseRule

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

Parse a namespaceless CSS rule.

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

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

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

Parse a CSS rule.

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

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.

parseMediaQueryList

MediaQueryList parseMediaQueryList(String media,
 Node owner)
                            throws CSSBudgetException

Parse an individual list of media queries.

Parameters:

media - the string representation of the list of media queries.

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.

parseMediaQueryList

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

Parse a media query string into the given handler.

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.