com.google.template.soy.jbcsrc.restricted

Class BytecodeUtils

java.lang.Object

com.google.template.soy.jbcsrc.restricted.BytecodeUtils

public final class BytecodeUtils
extends Object

A set of utilities for generating simple expressions in bytecode

Field Summary

Fields

Modifier and Type	Field and Description
static org.objectweb.asm.Type	ARRAY_LIST_TYPE
static org.objectweb.asm.commons.Method	CLASS_INIT
static org.objectweb.asm.Type	CLOSEABLE_TYPE
static org.objectweb.asm.Type	COMPILED_TEMPLATE_TYPE
static org.objectweb.asm.Type	CONTENT_KIND_TYPE
static org.objectweb.asm.Type	DIR_TYPE
static org.objectweb.asm.Type	ILLEGAL_STATE_EXCEPTION_TYPE
static org.objectweb.asm.Type	INTEGER_DATA_TYPE
static org.objectweb.asm.Type	LINKED_HASH_MAP_TYPE
static org.objectweb.asm.Type	LIST_TYPE
static org.objectweb.asm.Type	LOGGING_ADVISING_APPENDABLE_TYPE
static org.objectweb.asm.Type	LOGGING_ADVISING_BUILDER_TYPE
static org.objectweb.asm.Type	MAP_ENTRY_TYPE
static org.objectweb.asm.Type	MAP_TYPE
static org.objectweb.asm.Type	MESSAGE_TYPE
static org.objectweb.asm.Type	NULL_POINTER_EXCEPTION_TYPE
static org.objectweb.asm.commons.Method	NULLARY_INIT
static TypeInfo	OBJECT
static org.objectweb.asm.Type	RENDER_CONTEXT_TYPE
static org.objectweb.asm.Type	RENDER_RESULT_TYPE
static org.objectweb.asm.Type	SANITIZED_CONTENT_TYPE
static org.objectweb.asm.Type	SOY_LEGACY_OBJECT_MAP_TYPE
static org.objectweb.asm.Type	SOY_LIST_TYPE
static org.objectweb.asm.Type	SOY_MAP_TYPE
static org.objectweb.asm.Type	SOY_PROTO_VALUE_IMPL_TYPE
static org.objectweb.asm.Type	SOY_RECORD_TYPE
static org.objectweb.asm.Type	SOY_VALUE_PROVIDER_TYPE
static org.objectweb.asm.Type	SOY_VALUE_TYPE
static org.objectweb.asm.Type	STRING_TYPE
static org.objectweb.asm.Type	THROWABLE_TYPE

Method Summary

Modifier and Type	Method and Description
static Expression	asImmutableList(Iterable<? extends Expression> items) Returns an expression that returns a new ImmutableList containing the given items.
static Expression	asList(Iterable<? extends Expression> items) Returns an expression that returns a new ArrayList containing all the given items.
static Class<?>	classFromAsmType(org.objectweb.asm.Type type) Returns the runtime class represented by the given type.
static Expression	compare(int comparisonOpcode, Expression left, Expression right) Compares the two primitive valued expressions using the provided comparison operation.
static Expression	compareSoyEquals(SoyExpression left, SoyExpression right) Compares two SoyExpressions for equality using soy == semantics.
static Expression	constant(boolean value) Returns an Expression that can load the given boolean constant.
static Expression	constant(char value) Returns an Expression that can load the given char constant.
static Expression	constant(Dir dir) Returns an Expression that evaluates to the given Dir, or null.
static Expression	constant(double value) Returns an Expression that can load the given double constant.
static Expression	constant(int value) Returns an Expression that can load the given int constant.
static Expression	constant(long value) Returns an Expression that can load the given long constant.
static Expression	constant(SanitizedContent.ContentKind kind) Returns an Expression that evaluates to the given ContentKind, or null.
static Expression	constant(String value) Returns an Expression that can load the given String constant.
static Expression	constant(String value, ClassFieldManager manager) Returns an Expression that can load the given String constant.
static Expression	constantNull(org.objectweb.asm.Type type) Returns an Expression with the given type that always returns null.
static Expression	constantSanitizedContentKindAsContentKind(SanitizedContentKind kind) Returns an Expression that evaluates to the SanitizedContent.ContentKind value that is equivalent to the given SanitizedContentKind, or null.
static void	defineDefaultConstructor(org.objectweb.asm.ClassVisitor cv, TypeInfo ownerType) Generates a default nullary public constructor for the given type on the ClassVisitor.
static Expression	firstNonNull(Expression left, Expression right) Returns an expression that evaluates to left if left is non null, and evaluates to right otherwise.
static boolean	isDefinitelyAssignableFrom(org.objectweb.asm.Type left, org.objectweb.asm.Type right) Returns true if left is definitely assignable from right.
static boolean	isPossiblyAssignableFrom(org.objectweb.asm.Type left, org.objectweb.asm.Type right) Returns true if left is possibly assignable from right.
static boolean	isPrimitive(org.objectweb.asm.Type type) Returns true if Type is a primitive type.
static Expression	logicalAnd(Expression... expressions) Implements the short circuiting logical and (&&) operator over the list of boolean expressions.
static Expression	logicalAnd(List<? extends Expression> expressions) Implements the short circuiting logical and (&&) operator over the list of boolean expressions.
static Expression	logicalNot(Expression baseExpr) Returns an expression that evaluates to the logical negation of the given boolean valued expression.
static Expression	logicalOr(Expression... expressions) Implements the short circuiting logical or (||) operator over the list of boolean expressions.
static Expression	logicalOr(List<? extends Expression> expressions) Implements the short circuiting logical or (||) operator over the list of boolean expressions.
static Expression	newLinkedHashMap(Iterable<? extends Expression> keys, Iterable<? extends Expression> values) Returns an expression that returns a new LinkedHashMap containing all the given entries.
static void	nullCoalesce(CodeBuilder builder, org.objectweb.asm.Label nullExit) Outputs bytecode that will test the item at the top of the stack for null, and branch to nullExit if it is null.
static Expression	numericConversion(Expression expr, org.objectweb.asm.Type to) Returns an expression that does a numeric conversion cast from the given expression to the given type.
static Expression	ternary(Expression condition, Expression trueBranch, Expression falseBranch) Returns an expression that evaluates equivalently to a java ternary expression: condition ? left : right
static org.objectweb.asm.Type	unboxUnchecked(CodeBuilder cb, SoyRuntimeType soyType, Class<?> asType) Outputs bytecode that unboxes the current top element of the stack as asType.

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT

public static final TypeInfo OBJECT

LOGGING_ADVISING_APPENDABLE_TYPE

public static final org.objectweb.asm.Type LOGGING_ADVISING_APPENDABLE_TYPE

LOGGING_ADVISING_BUILDER_TYPE

public static final org.objectweb.asm.Type LOGGING_ADVISING_BUILDER_TYPE

ARRAY_LIST_TYPE

public static final org.objectweb.asm.Type ARRAY_LIST_TYPE

COMPILED_TEMPLATE_TYPE

public static final org.objectweb.asm.Type COMPILED_TEMPLATE_TYPE

CONTENT_KIND_TYPE

public static final org.objectweb.asm.Type CONTENT_KIND_TYPE

CLOSEABLE_TYPE

public static final org.objectweb.asm.Type CLOSEABLE_TYPE

DIR_TYPE

public static final org.objectweb.asm.Type DIR_TYPE

INTEGER_DATA_TYPE

public static final org.objectweb.asm.Type INTEGER_DATA_TYPE

LINKED_HASH_MAP_TYPE

public static final org.objectweb.asm.Type LINKED_HASH_MAP_TYPE

LIST_TYPE

public static final org.objectweb.asm.Type LIST_TYPE

MAP_TYPE

public static final org.objectweb.asm.Type MAP_TYPE

MAP_ENTRY_TYPE

public static final org.objectweb.asm.Type MAP_ENTRY_TYPE

MESSAGE_TYPE

public static final org.objectweb.asm.Type MESSAGE_TYPE

NULL_POINTER_EXCEPTION_TYPE

public static final org.objectweb.asm.Type NULL_POINTER_EXCEPTION_TYPE

RENDER_CONTEXT_TYPE

public static final org.objectweb.asm.Type RENDER_CONTEXT_TYPE

RENDER_RESULT_TYPE

public static final org.objectweb.asm.Type RENDER_RESULT_TYPE

SANITIZED_CONTENT_TYPE

public static final org.objectweb.asm.Type SANITIZED_CONTENT_TYPE

SOY_LIST_TYPE

public static final org.objectweb.asm.Type SOY_LIST_TYPE

SOY_LEGACY_OBJECT_MAP_TYPE

public static final org.objectweb.asm.Type SOY_LEGACY_OBJECT_MAP_TYPE

SOY_MAP_TYPE

public static final org.objectweb.asm.Type SOY_MAP_TYPE

SOY_PROTO_VALUE_IMPL_TYPE

public static final org.objectweb.asm.Type SOY_PROTO_VALUE_IMPL_TYPE

SOY_RECORD_TYPE

public static final org.objectweb.asm.Type SOY_RECORD_TYPE

SOY_VALUE_TYPE

public static final org.objectweb.asm.Type SOY_VALUE_TYPE

SOY_VALUE_PROVIDER_TYPE

public static final org.objectweb.asm.Type SOY_VALUE_PROVIDER_TYPE

STRING_TYPE

public static final org.objectweb.asm.Type STRING_TYPE

THROWABLE_TYPE

public static final org.objectweb.asm.Type THROWABLE_TYPE

ILLEGAL_STATE_EXCEPTION_TYPE

public static final org.objectweb.asm.Type ILLEGAL_STATE_EXCEPTION_TYPE

CLASS_INIT

public static final org.objectweb.asm.commons.Method CLASS_INIT

NULLARY_INIT

public static final org.objectweb.asm.commons.Method NULLARY_INIT

Method Detail

isPossiblyAssignableFrom

public static boolean isPossiblyAssignableFrom(org.objectweb.asm.Type left,
                                               org.objectweb.asm.Type right)

Returns true if left is possibly assignable from right.

Analogous to right instanceof left.

isDefinitelyAssignableFrom

public static boolean isDefinitelyAssignableFrom(org.objectweb.asm.Type left,
                                                 org.objectweb.asm.Type right)

Returns true if left is definitely assignable from right.

Analogous to right instanceof left.

classFromAsmType

public static Class<?> classFromAsmType(org.objectweb.asm.Type type)

Returns the runtime class represented by the given type.

Throws:

IllegalArgumentException - if the class cannot be found. It is expected that this method will only be called for types that have a runtime on the compilers classpath.

constant

public static Expression constant(boolean value)

Returns an Expression that can load the given boolean constant.

constant

public static Expression constant(int value)

Returns an Expression that can load the given int constant.

constant

public static Expression constant(char value)

Returns an Expression that can load the given char constant.

constant

public static Expression constant(long value)

Returns an Expression that can load the given long constant.

constant

public static Expression constant(double value)

Returns an Expression that can load the given double constant.

constant

public static Expression constant(String value)

Returns an Expression that can load the given String constant.

constant

public static Expression constant(String value,
                                  ClassFieldManager manager)

Returns an Expression that can load the given String constant.

Unlike constant(String) this can handle strings larger than 65K bytes.

constant

public static Expression constant(@Nullable
                                  SanitizedContent.ContentKind kind)

Returns an Expression that evaluates to the given ContentKind, or null.

constantSanitizedContentKindAsContentKind

public static Expression constantSanitizedContentKindAsContentKind(@Nullable
                                                                   SanitizedContentKind kind)

Returns an Expression that evaluates to the SanitizedContent.ContentKind value that is equivalent to the given SanitizedContentKind, or null.

constant

public static Expression constant(@Nullable
                                  Dir dir)

Returns an Expression that evaluates to the given Dir, or null.

constantNull

public static Expression constantNull(org.objectweb.asm.Type type)

Returns an Expression with the given type that always returns null.

numericConversion

public static Expression numericConversion(Expression expr,
                                           org.objectweb.asm.Type to)

Returns an expression that does a numeric conversion cast from the given expression to the given type.

Throws:

IllegalArgumentException - if either the expression or the target type is not a numeric primitive

isPrimitive

public static boolean isPrimitive(org.objectweb.asm.Type type)

Returns true if Type is a primitive type.

defineDefaultConstructor

public static void defineDefaultConstructor(org.objectweb.asm.ClassVisitor cv,
                                            TypeInfo ownerType)

Generates a default nullary public constructor for the given type on the ClassVisitor.

For java classes this is normally generated by the compiler and looks like:

 public Foo() {
   super();
 }
 

compare

public static Expression compare(int comparisonOpcode,
                                 Expression left,
                                 Expression right)

Compares the two primitive valued expressions using the provided comparison operation.

logicalNot

public static Expression logicalNot(Expression baseExpr)

Returns an expression that evaluates to the logical negation of the given boolean valued expression.

compareSoyEquals

public static Expression compareSoyEquals(SoyExpression left,
                                          SoyExpression right)

Compares two SoyExpressions for equality using soy == semantics.

firstNonNull

public static Expression firstNonNull(Expression left,
                                      Expression right)

Returns an expression that evaluates to left if left is non null, and evaluates to right otherwise.

ternary

public static Expression ternary(Expression condition,
                                 Expression trueBranch,
                                 Expression falseBranch)

Returns an expression that evaluates equivalently to a java ternary expression: condition ? left : right

logicalOr

public static Expression logicalOr(Expression... expressions)

Implements the short circuiting logical or (||) operator over the list of boolean expressions.

logicalOr

public static Expression logicalOr(List<? extends Expression> expressions)

Implements the short circuiting logical or (||) operator over the list of boolean expressions.

logicalAnd

public static Expression logicalAnd(Expression... expressions)

Implements the short circuiting logical and (&&) operator over the list of boolean expressions.

logicalAnd

public static Expression logicalAnd(List<? extends Expression> expressions)

Implements the short circuiting logical and (&&) operator over the list of boolean expressions.

asImmutableList

public static Expression asImmutableList(Iterable<? extends Expression> items)

Returns an expression that returns a new ImmutableList containing the given items.

NOTE: ImmutableList rejects null elements.

asList

public static Expression asList(Iterable<? extends Expression> items)

Returns an expression that returns a new ArrayList containing all the given items.

nullCoalesce

public static void nullCoalesce(CodeBuilder builder,
                                org.objectweb.asm.Label nullExit)

Outputs bytecode that will test the item at the top of the stack for null, and branch to nullExit if it is null. At nullSafeExit there will be a null value at the top of the stack.

unboxUnchecked

public static org.objectweb.asm.Type unboxUnchecked(CodeBuilder cb,
                                                    SoyRuntimeType soyType,
                                                    Class<?> asType)

Outputs bytecode that unboxes the current top element of the stack as asType. Top of stack must not be null.

Always prefer using SoyExpression.unboxAs(java.lang.Class<?>) over this method, whenever possible.

Guarantees: * Bytecode output will not change stack height * Output will only change the top element, and nothing below that

Returns:

the type of the result of the unbox operation

newLinkedHashMap

public static Expression newLinkedHashMap(Iterable<? extends Expression> keys,
                                          Iterable<? extends Expression> values)

Returns an expression that returns a new LinkedHashMap containing all the given entries.