Package com.google.common.css.compiler.ast

Class CssCustomFunctionNode

java.lang.Object

com.google.common.css.compiler.ast.CssNode

com.google.common.css.compiler.ast.CssValueNode

com.google.common.css.compiler.ast.CssFunctionNode

com.google.common.css.compiler.ast.CssCustomFunctionNode

All Implemented Interfaces:

ChunkAware, Proxiable<CssCustomFunctionNode>, Locatable

Direct Known Subclasses:

CssCustomFunctionNode.CssCustomFunctionNodeProxy

public class CssCustomFunctionNode
extends CssFunctionNode
implements Proxiable<CssCustomFunctionNode>

A node representing a custom GSS function call.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CssCustomFunctionNode.CssCustomFunctionNodeProxy	Copy-on-Write proxy for CssCustomFunctionNode used to avoid copying of function call subtrees in ReplaceConstantReferences pass.

Nested classes/interfaces inherited from class com.google.common.css.compiler.ast.CssFunctionNode

CssFunctionNode.Function

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<CssValueNode>	resultNodes

Constructor Summary

Constructors

Constructor	Description
CssCustomFunctionNode(CssCustomFunctionNode function)	Copy constructor.
CssCustomFunctionNode(java.lang.String gssFunctionName, SourceCodeLocation sourceCodeLocation)	Constructor of the node.

Method Summary

Modifier and Type	Method	Description
CssCustomFunctionNode	createProxy()	Creates the proxy object.
CssCustomFunctionNode	deepCopy()
static java.util.List<CssValueNode>	fixupFunctionArguments(java.lang.Iterable<CssValueNode> functionParameters)	Turns functionParameters containing comma and space literals into a correctly-grouped list of CssValueNodes.
java.lang.String	getFunctionName()
java.util.List<CssValueNode>	getResult()
void	setArguments(CssFunctionArgumentsNode arguments)
void	setResult(java.util.List<CssValueNode> functionResult)	Saves the value of function computation for later use.
java.lang.String	toString()	Use for debugging only.

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

getArguments, getChunk, getFunction, getValue, setChunk

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

getIsDefault, setIsDefault, setValue

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

ancestors, appendComment, deepCopyNodes, equals, getComments, getParent, getShouldBeFlipped, getSourceCodeLocation, getVisitController, hasComment, hashCode, inFunArgs, setComments, setShouldBeFlipped, setSourceCodeLocation

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

resultNodes

protected java.util.List<CssValueNode> resultNodes

Constructor Detail

CssCustomFunctionNode

public CssCustomFunctionNode(java.lang.String gssFunctionName,
                             SourceCodeLocation sourceCodeLocation)

Constructor of the node.

Parameters:

gssFunctionName - name of the function "called" by this node

sourceCodeLocation - location of this node

CssCustomFunctionNode

public CssCustomFunctionNode(CssCustomFunctionNode function)

Copy constructor.

Parameters:

function - the copied custom function node

Method Detail

deepCopy

public CssCustomFunctionNode deepCopy()

Overrides:

deepCopy in class CssFunctionNode

getFunctionName

public java.lang.String getFunctionName()

Overrides:

getFunctionName in class CssFunctionNode

toString

public java.lang.String toString()

Description copied from class: CssValueNode

Use for debugging only.

Overrides:

toString in class CssFunctionNode

See Also:

Object.toString()

setArguments

public void setArguments(CssFunctionArgumentsNode arguments)

Overrides:

setArguments in class CssFunctionNode

createProxy

public CssCustomFunctionNode createProxy()

Description copied from interface: Proxiable

Creates the proxy object. If the original object is immutable and does not have any children, it can return itself.

Specified by:

createProxy in interface Proxiable<CssCustomFunctionNode>

Returns:

the copy-on-write proxy for this node

getResult

public java.util.List<CssValueNode> getResult()

Returns:

cached result of function value computation

setResult

public void setResult(java.util.List<CssValueNode> functionResult)

Saves the value of function computation for later use.

Parameters:

functionResult - the list of nodes returned by the call to the GssFunction

fixupFunctionArguments

public static java.util.List<CssValueNode> fixupFunctionArguments(java.lang.Iterable<CssValueNode> functionParameters)

Turns functionParameters containing comma and space literals into a correctly-grouped list of CssValueNodes. For example, in this code:

* @def A 1 2 3 4; @def B 6 7 8 9; @def USE_A true; @def MARGIN selectFrom(USE_A, A, B);
 

the selectFrom gets expanded to:

* @def MARGIN selectFrom([true][,][1][ ][2][ ][3][ ][4][,][6][ ][7][ ][8][ ][9])
 

where each value in braces is one parameter. That's 17 parameters. Passing that parameter list to this function returns a list with 3 values: true, 1 2 3 4, and 6 7 8 9.

Note that this function must be passed value nodes that are already expanded as it will create CssLiteralNodes out of the values between commas via concatenation of their toString methods.

Parameters:

functionParameters - an iterable that contains resolved parameter values (no references)

Returns:

a list values that represent the actual arguments to the function, one value per argument