com.vaadin.sass.internal.parser
Class SassExpression

java.lang.Object
  com.vaadin.sass.internal.parser.SassExpression

All Implemented Interfaces:

SassListItem, Serializable

public class SassExpression
extends Object
implements SassListItem, Serializable

SassExpressions are used for representing and evaluating arithmetic expressions.

Author:

Vaadin

See Also:

Serialized Form

Method Summary

String	buildString(Node.BuildStringStrategy strategy) Return a string representation of this item using the given strategy of converting items to strings.
boolean	containsArithmeticalOperator() Checks whether the item contains an arithmetic expression.
boolean	containsVariable() Checks whether this item contains a variable.
static SassListItem	createExpression(List<SassListItem> items) Creates a new expression containing the elements of the parameter items but with trailing whitespace items eliminated.
static SassListItem	createExpression(SassListItem... items) Creates a new expression containing the elements of the parameter items but with trailing whitespace items eliminated.
boolean	equals(Object o) Tests whether this and o are equal expressions.
SassListItem	evaluateFunctionsAndExpressions(ScssContext context, boolean evaluateArithmetics) Evaluates the arithmetic expressions and functions of this item without modifying this item.
int	getColumnNumber()
LexicalUnitImpl	getContainedValue()
int	getLineNumber()
static int	getNextNonspaceIndex(List<SassListItem> list, int startIndex) Returns the index of the next non-whitespace item in list, starting from startIndex (inclusive).
int	hashCode()
static boolean	isWhitespace(SassListItem item)
String	printState() Returns a string representation of this item.
SassExpression	replaceVariables(ScssContext context) Returns a new item that is otherwise equal to this one but all occurrences of variables have been replaced by the values in the current variable scope.
String	toString()
String	unquotedString() Returns a string representation of this item with surrounding quotation marks of the same type (" or ') removed.
SassExpression	updateUrl(String prefix) Returns a new item that is obtained from this by updating all url's by, e.g., adding the prefix to an url not starting with slash "/" and not containing the symbol ":".

Methods inherited from class java.lang.Object

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

Method Detail

createExpression

public static SassListItem createExpression(SassListItem... items)

Creates a new expression containing the elements of the parameter items but with trailing whitespace items eliminated. If items contains only one element excluding the trailing whitespace, returns the only contained element. Otherwise returns a SassExpression.

Parameters:

items - one or more SassListItems.

Returns:

A SassExpression corresponding to items. If there is only one item after the removal of whitespace, returns that item instead of a SassExpression.

createExpression

public static SassListItem createExpression(List<SassListItem> items)

Creates a new expression containing the elements of the parameter items but with trailing whitespace items eliminated. If items contains only one element excluding the trailing whitespace, returns the only contained element. Otherwise returns a SassExpression.

Parameters:

items - A list of SassListItems.

Returns:

A SassExpression corresponding to items. If there is only one item after the removal of whitespace, returns that item instead of a SassExpression.

getLineNumber

public int getLineNumber()

Specified by:

getLineNumber in interface SassListItem

getColumnNumber

public int getColumnNumber()

Specified by:

getColumnNumber in interface SassListItem

containsArithmeticalOperator

public boolean containsArithmeticalOperator()

Description copied from interface: SassListItem

Checks whether the item contains an arithmetic expression.

Specified by:

containsArithmeticalOperator in interface SassListItem

getNextNonspaceIndex

public static int getNextNonspaceIndex(List<SassListItem> list,
                                       int startIndex)

Returns the index of the next non-whitespace item in list, starting from startIndex (inclusive). If there are no non-whitespace items in list[startIndex...list.size() - 1], returns list.size().

Parameters:

list - A list.

startIndex - The first index included in the search.

Returns:

The smallest index i such that i >= startIndex && list.get(i) does not represent whitespace. If no such index exists, returns list.size().

evaluateFunctionsAndExpressions

public SassListItem evaluateFunctionsAndExpressions(ScssContext context,
                                                    boolean evaluateArithmetics)

Description copied from interface: SassListItem

Evaluates the arithmetic expressions and functions of this item without modifying this item.

Specified by:

evaluateFunctionsAndExpressions in interface SassListItem

Parameters:

context - the compilation context in which to evaluate functions, variables etc.

evaluateArithmetics - True indicates that the arithmetic expressions in this item should be evaluated. This parameter is used to handle the case where the operator '/' should not be interpreted as an arithmetic operation. The arithmetic expressions occurring in the parameter lists of functions will be evaluated even if evaluateArithmetics is false.

Returns:

For single values, the result of the arithmetic expression or function. For a list, a copy of the list where the arithmetic expressions and functions have been replaced with their evaluated values.

replaceVariables

public SassExpression replaceVariables(ScssContext context)

Description copied from interface: SassListItem

Returns a new item that is otherwise equal to this one but all occurrences of variables have been replaced by the values in the current variable scope. Does not modify this item.

Specified by:

replaceVariables in interface SassListItem

Parameters:

context - the compilation context in which to evaluate functions, variables etc.

Returns:

A SassListItem where all occurrences of variables have been replaced by their values.

updateUrl

public SassExpression updateUrl(String prefix)

Description copied from interface: SassListItem

Returns a new item that is obtained from this by updating all url's by, e.g., adding the prefix to an url not starting with slash "/" and not containing the symbol ":". Does not modify this item.

Specified by:

updateUrl in interface SassListItem

Parameters:

prefix - The prefix to be added.

printState

public String printState()

Description copied from interface: SassListItem

Returns a string representation of this item. See LexicalUnitImpl.printState(). For a list, the string representation contains the list items separated with the separator character of the list. No parentheses appear in the string representation of a list, for valid CSS output.

Specified by:

printState in interface SassListItem

Returns:

A string representation of this item.

buildString

public String buildString(Node.BuildStringStrategy strategy)

Description copied from interface: SassListItem

Return a string representation of this item using the given strategy of converting items to strings. See LexicalUnitImpl#buildString(BuildStringStrategy).

Specified by:

buildString in interface SassListItem

Parameters:

strategy - Specifies how an item is converted to a string. The strategy may use the toString- and printState-methods.

Returns:

A string representation of this string.

toString

public String toString()

Overrides:

toString in class Object

unquotedString

public String unquotedString()

Description copied from interface: SassListItem

Returns a string representation of this item with surrounding quotation marks of the same type (" or ') removed. Quotation marks are only removed from a single item or a list containing a single element and only one pair of quotation marks is removed.

Specified by:

unquotedString in interface SassListItem

Returns:

An unquoted string representation of this item.

getContainedValue

public LexicalUnitImpl getContainedValue()

Specified by:

getContainedValue in interface SassListItem

isWhitespace

public static boolean isWhitespace(SassListItem item)

containsVariable

public boolean containsVariable()

Description copied from interface: SassListItem

Checks whether this item contains a variable. This method is used to avoid the evaluation of expressions when unset variables remain. That situation can happen as a result of calling replaceVariables for the children of a @mixin node. The replaceVariables method in MixinNodeHandler then replaces the variables corresponding to the parameter list of the @mixin but other variables remain unset until the node is traversed again. The evaluation of interpolation and expressions should then be deferred until all variables of the SassListItem have a value.

Specified by:

containsVariable in interface SassListItem

Returns:

Whether this expression contains variables.

equals

public boolean equals(Object o)

Tests whether this and o are equal expressions. Two expressions are considered to be equal only if they have equal operands and operators in the same order. In most cases the results of the expressions should be compared to each other instead of the expressions themselves. For this the expressions can be evaluated using evaluateFunctionsAndExpressions after replacing any variables occurring in the expressions.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object