Package org.codehaus.groovy.transform.stc

Class StaticTypeCheckingSupport

java.lang.Object

org.codehaus.groovy.transform.stc.StaticTypeCheckingSupport

public abstract class StaticTypeCheckingSupport
extends Object

Support methods for StaticTypeCheckingVisitor.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StaticTypeCheckingSupport.BooleanArrayStaticTypesHelper
static class	StaticTypeCheckingSupport.ByteArrayStaticTypesHelper
static class	StaticTypeCheckingSupport.CharArrayStaticTypesHelper
static class	StaticTypeCheckingSupport.DoubleArrayStaticTypesHelper
static class	StaticTypeCheckingSupport.FloatArrayStaticTypesHelper
static class	StaticTypeCheckingSupport.IntArrayStaticTypesHelper
static class	StaticTypeCheckingSupport.LongArrayStaticTypesHelper
static class	StaticTypeCheckingSupport.ObjectArrayStaticTypesHelper	A DGM-like class which adds support for method calls which are handled specifically by the Groovy compiler.
static class	StaticTypeCheckingSupport.ShortArrayStaticTypesHelper

Field Summary

Fields

Modifier and Type	Field	Description
protected static ClassNode	ArrayList_TYPE
protected static ClassNode	Collection_TYPE
protected static ClassNode	Deprecated_TYPE
protected static Comparator<MethodNode>	DGM_METHOD_NODE_COMPARATOR	This comparator is used when we return the list of methods from DGM which name correspond to a given name.
protected static ExtensionMethodCache	EXTENSION_METHOD_CACHE
protected static ClassNode	GSTRING_STRING_CLASSNODE
protected static ClassNode	Matcher_TYPE
protected static Map<String,Integer>	NUMBER_OPS
protected static Map<ClassNode,Integer>	NUMBER_TYPES
protected static ClassNode	UNKNOWN_PARAMETER_TYPE	This is for internal use only.

Constructor Summary

Constructors

Constructor	Description
StaticTypeCheckingSupport()

Method Summary

Modifier and Type	Method	Description
static int	allParametersAndArgumentsMatch(Parameter[] parameters, ClassNode[] argumentTypes)	Checks that arguments and parameter types match.
static boolean	checkCompatibleAssignmentTypes(ClassNode left, ClassNode right)	Returns true or false depending on whether the right classnode can be assigned to the left classnode.
static boolean	checkCompatibleAssignmentTypes(ClassNode left, ClassNode right, Expression rightExpression)
static boolean	checkCompatibleAssignmentTypes(ClassNode left, ClassNode right, Expression rightExpression, boolean allowConstructorCoercion)
static List<MethodNode>	chooseBestMethod(ClassNode receiver, Collection<MethodNode> methods, ClassNode... argumentTypes)	Returns the method(s) which best fit the argument types.
static void	clearExtensionMethodCache()
static void	clearExtensionMethodCache(ClassLoader loader)
static Set<ClassNode>	collectAllInterfaces(ClassNode node)	Collects all interfaces of a class node, including those defined by the super class.
static Object	evaluateExpression(Expression expr, CompilerConfiguration config)	A helper method that can be used to evaluate expressions as found in annotation parameters.
static List<MethodNode>	filterMethodsByVisibility(List<MethodNode> methodNodeList, ClassNode enclosingClassNode)	Filter methods according to visibility
static List<MethodNode>	findDGMMethodsByNameAndArguments(ClassLoader loader, ClassNode receiver, String name, ClassNode[] args)
static List<MethodNode>	findDGMMethodsByNameAndArguments(ClassLoader loader, ClassNode receiver, String name, ClassNode[] args, List<MethodNode> methods)
static List<MethodNode>	findDGMMethodsByNameAndArguments(ClassNode receiver, String name, ClassNode[] args)	Deprecated. Use findDGMMethodsByNameAndArguments(ClassLoader, ClassNode, String, ClassNode[], List) instead
static List<MethodNode>	findDGMMethodsByNameAndArguments(ClassNode receiver, String name, ClassNode[] args, List<MethodNode> methods)	Deprecated. Use findDGMMethodsByNameAndArguments(ClassLoader, ClassNode, String, ClassNode[], List) instead
static Set<MethodNode>	findDGMMethodsForClassNode(ClassLoader loader, ClassNode clazz, String name)
protected static void	findDGMMethodsForClassNode(ClassLoader loader, ClassNode clazz, String name, TreeSet<MethodNode> accumulator)
protected static Set<MethodNode>	findDGMMethodsForClassNode(ClassNode clazz, String name)	Deprecated. Use findDGMMethodsForClassNode(ClassLoader, ClassNode, String) instead
protected static void	findDGMMethodsForClassNode(ClassNode clazz, String name, TreeSet<MethodNode> accumulator)	Deprecated. Use findDGMMethodsForClassNode(ClassLoader, ClassNode, String, TreeSet) instead
static List<MethodNode>	findSetters(ClassNode cn, String setterName, boolean voidOnly)
protected static Variable	findTargetVariable(VariableExpression ve)	Given a variable expression, returns the ultimately accessed variable.
protected static GenericsType	fullyResolve(GenericsType gt, Map<GenericsType.GenericsTypeName,GenericsType> placeholders)	Given a generics type representing SomeClass<T,V> and a resolved placeholder map, returns a new generics type for which placeholders are resolved recursively.
protected static ClassNode	fullyResolveType(ClassNode type, Map<GenericsType.GenericsTypeName,GenericsType> placeholders)
static ClassNode	getCorrectedClassNode(ClassNode type, ClassNode superClass, boolean handlingGenerics)
static boolean	implementsInterfaceOrIsSubclassOf(ClassNode type, ClassNode superOrInterface)
protected static boolean	isArrayAccessExpression(Expression expression)	Returns true for expressions of the form x[...]
static boolean	isAssignableTo(ClassNode type, ClassNode toBeAssignedTo)	Checks if a class node is assignable to another.
static boolean	isAssignment(int op)
static boolean	isBeingCompiled(ClassNode node)
static boolean	isClassClassNodeWrappingConcreteType(ClassNode classNode)	Returns true if the class node represents a the class node for the Class class and if the parametrized type is a neither a placeholder or a wildcard.
static boolean	isCompareToBoolean(int op)
static boolean	isGStringOrGStringStringLUB(ClassNode node)
static boolean	isParameterizedWithGStringOrGStringString(ClassNode node)
static boolean	isParameterizedWithString(ClassNode node)
static ClassNode	isTraitSelf(VariableExpression vexp)
static boolean	isUnboundedWildcard(GenericsType gt)
static boolean	isUsingGenericsOrIsArrayUsingGenerics(ClassNode cn)	Returns true if a class node makes use of generic types.
static boolean	isUsingUncheckedGenerics(ClassNode node)	Returns true if the provided class node, when considered as a receiver of a message or as a parameter, is using a placeholder in its generics type.
static boolean	isWildcardLeftHandSide(ClassNode node)	Tells if a class is one of the "accept all" classes as the left hand side of an assignment.
static boolean	isWithCall(String name, Expression arguments)	Called on method call checks in order to determine if a method call corresponds to the idiomatic o.with { ...
static boolean	missesGenericsTypes(ClassNode cn)	Determines if node is a raw type or references any generics placeholders.
static Parameter[]	parameterizeArguments(ClassNode receiver, MethodNode m)	Given a receiver and a method node, parameterize the method arguments using available generic type information.
static ClassNode	resolveClassNodeGenerics(Map<GenericsType.GenericsTypeName,GenericsType> resolvedPlaceholders, Map<GenericsType.GenericsTypeName,GenericsType> placeholdersFromContext, ClassNode currentType)
protected static boolean	typeCheckMethodArgumentWithGenerics(ClassNode parameterType, ClassNode argumentType, boolean lastArg)	Checks that the parameterized generics of an argument are compatible with the generics of the parameter.
protected static boolean	typeCheckMethodsWithGenerics(ClassNode receiver, ClassNode[] argumentTypes, MethodNode candidateMethod)

Methods inherited from class java.lang.Object

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

Field Details

Matcher_TYPE

protected static final ClassNode Matcher_TYPE

ArrayList_TYPE

protected static final ClassNode ArrayList_TYPE

Collection_TYPE

protected static final ClassNode Collection_TYPE

Deprecated_TYPE

protected static final ClassNode Deprecated_TYPE

EXTENSION_METHOD_CACHE

protected static final ExtensionMethodCache EXTENSION_METHOD_CACHE

NUMBER_TYPES

protected static final Map<ClassNode,Integer> NUMBER_TYPES

NUMBER_OPS

protected static final Map<String,Integer> NUMBER_OPS

GSTRING_STRING_CLASSNODE

protected static final ClassNode GSTRING_STRING_CLASSNODE

UNKNOWN_PARAMETER_TYPE

protected static final ClassNode UNKNOWN_PARAMETER_TYPE

This is for internal use only. When an argument method is null, we cannot determine its type, so we use this one as a wildcard.

DGM_METHOD_NODE_COMPARATOR

protected static final Comparator<MethodNode> DGM_METHOD_NODE_COMPARATOR

This comparator is used when we return the list of methods from DGM which name correspond to a given name. As we also lookup for DGM methods of superclasses or interfaces, it may be possible to find two methods which have the same name and the same arguments. In that case, we should not add the method from superclass or interface otherwise the system won't be able to select the correct method, resulting in an ambiguous method selection for similar methods.

Constructor Details

StaticTypeCheckingSupport

public StaticTypeCheckingSupport()

Method Details

clearExtensionMethodCache

public static void clearExtensionMethodCache()

clearExtensionMethodCache

public static void clearExtensionMethodCache(ClassLoader loader)

isArrayAccessExpression

protected static boolean isArrayAccessExpression(Expression expression)

Returns true for expressions of the form x[...]

Parameters:

expression - an expression

Returns:

true for array access expressions

isWithCall

public static boolean isWithCall(String name, Expression arguments)

Called on method call checks in order to determine if a method call corresponds to the idiomatic o.with { ... } structure

Parameters:

name - name of the method called

arguments - method call arguments

Returns:

true if the name is "with" and arguments consist of a single closure

findTargetVariable

protected static Variable findTargetVariable(VariableExpression ve)

Given a variable expression, returns the ultimately accessed variable.

Parameters:

ve - a variable expression

Returns:

the target variable

findDGMMethodsForClassNode

@Deprecated protected static Set<MethodNode> findDGMMethodsForClassNode(ClassNode clazz, String name)

Deprecated.

Use findDGMMethodsForClassNode(ClassLoader, ClassNode, String) instead

findDGMMethodsForClassNode

public static Set<MethodNode> findDGMMethodsForClassNode(ClassLoader loader, ClassNode clazz, String name)

findDGMMethodsForClassNode

@Deprecated protected static void findDGMMethodsForClassNode(ClassNode clazz, String name, TreeSet<MethodNode> accumulator)

Deprecated.

Use findDGMMethodsForClassNode(ClassLoader, ClassNode, String, TreeSet) instead

findDGMMethodsForClassNode

protected static void findDGMMethodsForClassNode(ClassLoader loader, ClassNode clazz, String name, TreeSet<MethodNode> accumulator)

allParametersAndArgumentsMatch

public static int allParametersAndArgumentsMatch(Parameter[] parameters, ClassNode[] argumentTypes)

Checks that arguments and parameter types match.

Returns:

-1 if arguments do not match, 0 if arguments are of the exact type and > 0 when one or more argument is not of the exact type but still match

isAssignableTo

public static boolean isAssignableTo(ClassNode type, ClassNode toBeAssignedTo)

Checks if a class node is assignable to another. This is used for example in assignment checks where you want to verify that the assignment is valid.

Returns:

true if the class node is assignable to the other class node, false otherwise

isCompareToBoolean

public static boolean isCompareToBoolean(int op)

isAssignment

public static boolean isAssignment(int op)

checkCompatibleAssignmentTypes

public static boolean checkCompatibleAssignmentTypes(ClassNode left, ClassNode right)

Returns true or false depending on whether the right classnode can be assigned to the left classnode. This method should not add errors by itself: we let the caller decide what to do if an incompatible assignment is found.

Parameters:

left - the class to be assigned to

right - the assignee class

Returns:

false if types are incompatible

checkCompatibleAssignmentTypes

public static boolean checkCompatibleAssignmentTypes(ClassNode left, ClassNode right, Expression rightExpression)

checkCompatibleAssignmentTypes

public static boolean checkCompatibleAssignmentTypes(ClassNode left, ClassNode right, Expression rightExpression, boolean allowConstructorCoercion)

isWildcardLeftHandSide

public static boolean isWildcardLeftHandSide(ClassNode node)

Tells if a class is one of the "accept all" classes as the left hand side of an assignment.

Parameters:

node - the classnode to test

Returns:

true if it's an Object, String, boolean, Boolean or Class.

isBeingCompiled

public static boolean isBeingCompiled(ClassNode node)

implementsInterfaceOrIsSubclassOf

public static boolean implementsInterfaceOrIsSubclassOf(ClassNode type, ClassNode superOrInterface)

findDGMMethodsByNameAndArguments

@Deprecated public static List<MethodNode> findDGMMethodsByNameAndArguments(ClassNode receiver, String name, ClassNode[] args)

Deprecated.

Use findDGMMethodsByNameAndArguments(ClassLoader, ClassNode, String, ClassNode[], List) instead

findDGMMethodsByNameAndArguments

public static List<MethodNode> findDGMMethodsByNameAndArguments(ClassLoader loader, ClassNode receiver, String name, ClassNode[] args)

findDGMMethodsByNameAndArguments

@Deprecated public static List<MethodNode> findDGMMethodsByNameAndArguments(ClassNode receiver, String name, ClassNode[] args, List<MethodNode> methods)

Deprecated.

Use findDGMMethodsByNameAndArguments(ClassLoader, ClassNode, String, ClassNode[], List) instead

findDGMMethodsByNameAndArguments

public static List<MethodNode> findDGMMethodsByNameAndArguments(ClassLoader loader, ClassNode receiver, String name, ClassNode[] args, List<MethodNode> methods)

isUsingUncheckedGenerics

public static boolean isUsingUncheckedGenerics(ClassNode node)

Returns true if the provided class node, when considered as a receiver of a message or as a parameter, is using a placeholder in its generics type. In this case, we're facing unchecked generics and type checking is limited (ex: void foo(Set s) { s.keySet() }

Parameters:

node - the node to test

Returns:

true if it is using any placeholder in generics types

chooseBestMethod

public static List<MethodNode> chooseBestMethod(ClassNode receiver, Collection<MethodNode> methods, ClassNode... argumentTypes)

Returns the method(s) which best fit the argument types.

Returns:

zero or more results

parameterizeArguments

public static Parameter[] parameterizeArguments(ClassNode receiver, MethodNode m)

Given a receiver and a method node, parameterize the method arguments using available generic type information.

Parameters:

receiver - the class

m - the method

Returns:

the parameterized arguments

isUsingGenericsOrIsArrayUsingGenerics

public static boolean isUsingGenericsOrIsArrayUsingGenerics(ClassNode cn)

Returns true if a class node makes use of generic types. If the class node represents an array type, then checks if the component type is using generics.

Parameters:

cn - a class node for which to check if it is using generics

Returns:

true if the type (or component type) is using generics

fullyResolve

protected static GenericsType fullyResolve(GenericsType gt, Map<GenericsType.GenericsTypeName,GenericsType> placeholders)

Given a generics type representing SomeClass<T,V> and a resolved placeholder map, returns a new generics type for which placeholders are resolved recursively.

fullyResolveType

protected static ClassNode fullyResolveType(ClassNode type, Map<GenericsType.GenericsTypeName,GenericsType> placeholders)

typeCheckMethodArgumentWithGenerics

protected static boolean typeCheckMethodArgumentWithGenerics(ClassNode parameterType, ClassNode argumentType, boolean lastArg)

Checks that the parameterized generics of an argument are compatible with the generics of the parameter.

Parameters:

parameterType - the parameter type of a method

argumentType - the type of the argument passed to the method

typeCheckMethodsWithGenerics

protected static boolean typeCheckMethodsWithGenerics(ClassNode receiver, ClassNode[] argumentTypes, MethodNode candidateMethod)

resolveClassNodeGenerics

public static ClassNode resolveClassNodeGenerics(Map<GenericsType.GenericsTypeName,GenericsType> resolvedPlaceholders, Map<GenericsType.GenericsTypeName,GenericsType> placeholdersFromContext, ClassNode currentType)

getCorrectedClassNode

public static ClassNode getCorrectedClassNode(ClassNode type, ClassNode superClass, boolean handlingGenerics)

isUnboundedWildcard

public static boolean isUnboundedWildcard(GenericsType gt)

filterMethodsByVisibility

public static List<MethodNode> filterMethodsByVisibility(List<MethodNode> methodNodeList, ClassNode enclosingClassNode)

Filter methods according to visibility

Parameters:

methodNodeList - method nodes to filter

enclosingClassNode - the enclosing class

Returns:

filtered method nodes

Since:

3.0.0

isGStringOrGStringStringLUB

public static boolean isGStringOrGStringStringLUB(ClassNode node)

Returns:

true if the class node is either a GString or the LUB of String and GString.

isParameterizedWithGStringOrGStringString

public static boolean isParameterizedWithGStringOrGStringString(ClassNode node)

Parameters:

node - the node to be tested

Returns:

true if the node is using generics types and one of those types is a gstring or string/gstring lub

isParameterizedWithString

public static boolean isParameterizedWithString(ClassNode node)

Parameters:

node - the node to be tested

Returns:

true if the node is using generics types and one of those types is a string

missesGenericsTypes

public static boolean missesGenericsTypes(ClassNode cn)

Determines if node is a raw type or references any generics placeholders.

evaluateExpression

public static Object evaluateExpression(Expression expr, CompilerConfiguration config)

A helper method that can be used to evaluate expressions as found in annotation parameters. For example, it will evaluate a constant, be it referenced directly as an integer or as a reference to a field.

If this method throws an exception, then the expression cannot be evaluated on its own.

Parameters:

expr - the expression to be evaluated

config - the compiler configuration

Returns:

the result of the expression

collectAllInterfaces

public static Set<ClassNode> collectAllInterfaces(ClassNode node)

Collects all interfaces of a class node, including those defined by the super class.

Parameters:

node - a class for which we want to retrieve all interfaces

Returns:

a set of interfaces implemented by this class node

isClassClassNodeWrappingConcreteType

public static boolean isClassClassNodeWrappingConcreteType(ClassNode classNode)

Returns true if the class node represents a the class node for the Class class and if the parametrized type is a neither a placeholder or a wildcard. For example, the class node Class<Foo> where Foo is a class would return true, but the class node for Class<?> would return false.

Parameters:

classNode - a class node to be tested

Returns:

true if it is the class node for Class and its generic type is a real class

findSetters

public static List<MethodNode> findSetters(ClassNode cn, String setterName, boolean voidOnly)

isTraitSelf

public static ClassNode isTraitSelf(VariableExpression vexp)