Package com.google.common.css.compiler.passes

Class ResolveCustomFunctionNodes

java.lang.Object

com.google.common.css.compiler.ast.DefaultTreeVisitor

com.google.common.css.compiler.passes.ResolveCustomFunctionNodes

All Implemented Interfaces:

AtRuleHandler, CssCompilerPass, CssTreeVisitor

Direct Known Subclasses:

ResolveCustomFunctionNodesForChunks

public class ResolveCustomFunctionNodes
extends DefaultTreeVisitor
implements CssCompilerPass

This compiler pass replaces CssCustomFunctionNode instances with the list of nodes returned by the GssFunction.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,GssFunction>	functionMap

Constructor Summary

Constructors

Constructor	Description
ResolveCustomFunctionNodes(MutatingVisitController visitController, ErrorManager errorManager, java.util.Map<java.lang.String,GssFunction> functionMap)	Constructs the pass.
ResolveCustomFunctionNodes(MutatingVisitController visitController, ErrorManager errorManager, java.util.Map<java.lang.String,GssFunction> functionMap, boolean allowUnknownFunctions)	Constructs the pass.
ResolveCustomFunctionNodes(MutatingVisitController visitController, ErrorManager errorManager, java.util.Map<java.lang.String,GssFunction> functionMap, boolean allowUnknownFunctions, java.util.Set<java.lang.String> allowedNonStandardFunctions)	Constructs the pass.

Method Summary

Modifier and Type	Method	Description
protected java.util.List<CssValueNode>	evaluateFunction(CssCustomFunctionNode node, GssFunction function, java.util.List<CssValueNode> arguments, ErrorManager errorManager)	Evaluates the given function node.
void	leaveFunctionNode(CssFunctionNode functionNode)	Called after visiting a CssFunctionNode's sub trees.
void	runPass()

Methods inherited from class com.google.common.css.compiler.ast.DefaultTreeVisitor

enterArgumentNode, enterAttributeSelector, enterBlock, enterCharSet, enterClassSelector, enterCombinator, enterComponent, enterCompositeValueNode, enterCompositeValueNodeOperator, enterConditionalBlock, enterConditionalRule, enterDeclaration, enterDeclarationBlock, enterDefinition, enterFontFace, enterForLoop, enterFunctionNode, enterIdSelector, enterImportBlock, enterImportRule, enterKey, enterKeyBlock, enterKeyframeRuleset, enterKeyframesRule, enterMediaRule, enterMediaTypeListDelimiter, enterMixin, enterMixinDefinition, enterPageRule, enterPageSelector, enterPropertyValue, enterProvideNode, enterPseudoClass, enterPseudoElement, enterRequireNode, enterRuleset, enterSelector, enterSelectorBlock, enterTree, enterUnknownAtRule, enterValueNode, leaveArgumentNode, leaveAttributeSelector, leaveBlock, leaveCharSet, leaveClassSelector, leaveCombinator, leaveComponent, leaveCompositeValueNode, leaveCompositeValueNodeOperator, leaveConditionalBlock, leaveConditionalRule, leaveDeclaration, leaveDeclarationBlock, leaveDefinition, leaveFontFace, leaveForLoop, leaveIdSelector, leaveImportBlock, leaveImportRule, leaveKey, leaveKeyBlock, leaveKeyframeRuleset, leaveKeyframesRule, leaveMediaRule, leaveMediaTypeListDelimiter, leaveMixin, leaveMixinDefinition, leavePageRule, leavePageSelector, leavePropertyValue, leaveProvideNode, leavePseudoClass, leavePseudoElement, leaveRequireNode, leaveRuleset, leaveSelector, leaveSelectorBlock, leaveTree, leaveUnknownAtRule, leaveValueNode

Methods inherited from class java.lang.Object

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

Field Detail

functionMap

protected final java.util.Map<java.lang.String,GssFunction> functionMap

Constructor Detail

ResolveCustomFunctionNodes

public ResolveCustomFunctionNodes(MutatingVisitController visitController,
                                  ErrorManager errorManager,
                                  java.util.Map<java.lang.String,GssFunction> functionMap)

Constructs the pass.

Parameters:

visitController - The visit controller

errorManager - The error manager

functionMap - The map from function names to resolve to GSS functions

ResolveCustomFunctionNodes

public ResolveCustomFunctionNodes(MutatingVisitController visitController,
                                  ErrorManager errorManager,
                                  java.util.Map<java.lang.String,GssFunction> functionMap,
                                  boolean allowUnknownFunctions)

Constructs the pass.

Parameters:

visitController - The visit controller

errorManager - The error manager

functionMap - The map from function names to resolve to GSS functions

allowUnknownFunctions - Whether to allow unknown function calls, leaving them as is, instead of reporting an error

ResolveCustomFunctionNodes

public ResolveCustomFunctionNodes(MutatingVisitController visitController,
                                  ErrorManager errorManager,
                                  java.util.Map<java.lang.String,GssFunction> functionMap,
                                  boolean allowUnknownFunctions,
                                  java.util.Set<java.lang.String> allowedNonStandardFunctions)

Constructs the pass.

Parameters:

visitController - The visit controller

errorManager - The error manager

functionMap - The map from function names to resolve to GSS functions

allowUnknownFunctions - Whether to allow unknown function calls, leaving them as is, instead of reporting an error

allowedNonStandardFunctions - functions that should not yield a warning if they appear in a stylesheet

Method Detail

leaveFunctionNode

public void leaveFunctionNode(CssFunctionNode functionNode)

Description copied from interface: CssTreeVisitor

Called after visiting a CssFunctionNode's sub trees.

Specified by:

leaveFunctionNode in interface CssTreeVisitor

Overrides:

leaveFunctionNode in class DefaultTreeVisitor

evaluateFunction

protected java.util.List<CssValueNode> evaluateFunction(CssCustomFunctionNode node,
                                                        GssFunction function,
                                                        java.util.List<CssValueNode> arguments,
                                                        ErrorManager errorManager)
                                                 throws GssFunctionException

Evaluates the given function node.

Subclasses may sublcass this method to change the evaluation process in some circumstances.

Parameters:

node - the function node to evaluate

function - the GSS function matching this node

arguments - the arguments of this node

errorManager - the error manager passed into the GSS function call

Returns:

the result of the evaluation as a list of value nodes

Throws:

GssFunctionException - if the function call is invalid

java.lang.RuntimeException - if the function call fails to complete

runPass

public void runPass()

Specified by:

runPass in interface CssCompilerPass