com.atlassian.clover.instr.groovy

Class OperatorsInstrumenter

java.lang.Object

com.atlassian.clover.instr.groovy.ClassInstumenter

com.atlassian.clover.instr.groovy.OperatorsInstrumenter

public class OperatorsInstrumenter
extends ClassInstumenter

Instruments Groovy operators like: - elvis (a ?: b) - null-safe navigation (a ?. b) - ternary expression (a ? b : c)

Field Summary

Fields inherited from class com.atlassian.clover.instr.groovy.ClassInstumenter

classRef, session

Constructor Summary

Constructors

Constructor and Description
OperatorsInstrumenter(InstrumentationSession session, org.codehaus.groovy.ast.ClassNode classRef, BranchInstrumenter branchInstrumenter)

Method Summary

Modifier and Type	Method and Description
protected org.codehaus.groovy.ast.MethodNode	createSafeEvalMethod(org.codehaus.groovy.ast.ClassNode clazz, org.codehaus.groovy.ast.ClassNode evalReturnType, String safeEvalMethodName)
protected void	createSafeEvalMethodIfNecessary(org.codehaus.groovy.ast.ClassNode evalReturnType, org.codehaus.groovy.ast.ClassNode currentClassNode) Create safeEval_X() method with a proper type signature if it does not exist and add to hashmap.
protected String	getSafeEvalMethodName(org.codehaus.groovy.ast.ClassNode classNode) e.g.
Map<String,org.codehaus.groovy.ast.MethodNode>	getSafeEvalMethods()
protected org.codehaus.groovy.ast.expr.StaticMethodCallExpression	newSafeEval(BranchInfo branch, org.codehaus.groovy.ast.expr.Expression objectExpression)
protected String	sanitizeClassName(org.codehaus.groovy.ast.ClassNode clazz)
Pair<org.codehaus.groovy.ast.expr.ElvisOperatorExpression,Boolean>	transformElvis(org.codehaus.groovy.ast.expr.ElvisOperatorExpression elvis, ContextSet currentMethodContext)
Pair<org.codehaus.groovy.ast.expr.AttributeExpression,Boolean>	transformSafeAttributeExpression(org.codehaus.groovy.ast.expr.AttributeExpression attributeExpression, org.codehaus.groovy.ast.ClassNode currentClassNode, ContextSet currentMethodContext)
Pair<org.codehaus.groovy.ast.expr.MethodCallExpression,Boolean>	transformSafeMethodCall(org.codehaus.groovy.ast.expr.MethodCallExpression methodCallExpression, org.codehaus.groovy.ast.ClassNode currentClassNode, ContextSet currentMethodContext)
Pair<org.codehaus.groovy.ast.expr.PropertyExpression,Boolean>	transformSafeProperty(org.codehaus.groovy.ast.expr.PropertyExpression propertyExpression, org.codehaus.groovy.ast.ClassNode currentClassNode, ContextSet currentMethodContext)
org.codehaus.groovy.ast.expr.TernaryExpression	transformTernary(org.codehaus.groovy.ast.expr.TernaryExpression ternary, ContextSet currentMethodContext)

Methods inherited from class com.atlassian.clover.instr.groovy.ClassInstumenter

countExpressionRegion

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorsInstrumenter

public OperatorsInstrumenter(@NotNull
                             InstrumentationSession session,
                             @NotNull
                             org.codehaus.groovy.ast.ClassNode classRef,
                             @NotNull
                             BranchInstrumenter branchInstrumenter)

Method Detail

getSafeEvalMethods

@NotNull
public Map<String,org.codehaus.groovy.ast.MethodNode> getSafeEvalMethods()

transformElvis

@NotNull
public Pair<org.codehaus.groovy.ast.expr.ElvisOperatorExpression,Boolean> transformElvis(@NotNull
                                                                                                  org.codehaus.groovy.ast.expr.ElvisOperatorExpression elvis,
                                                                                                  @NotNull
                                                                                                  ContextSet currentMethodContext)

transformSafeAttributeExpression

@NotNull
public Pair<org.codehaus.groovy.ast.expr.AttributeExpression,Boolean> transformSafeAttributeExpression(@NotNull
                                                                                                                org.codehaus.groovy.ast.expr.AttributeExpression attributeExpression,
                                                                                                                @NotNull
                                                                                                                org.codehaus.groovy.ast.ClassNode currentClassNode,
                                                                                                                @NotNull
                                                                                                                ContextSet currentMethodContext)

transformSafeMethodCall

@NotNull
public Pair<org.codehaus.groovy.ast.expr.MethodCallExpression,Boolean> transformSafeMethodCall(@NotNull
                                                                                                        org.codehaus.groovy.ast.expr.MethodCallExpression methodCallExpression,
                                                                                                        @NotNull
                                                                                                        org.codehaus.groovy.ast.ClassNode currentClassNode,
                                                                                                        @NotNull
                                                                                                        ContextSet currentMethodContext)

transformSafeProperty

@NotNull
public Pair<org.codehaus.groovy.ast.expr.PropertyExpression,Boolean> transformSafeProperty(@NotNull
                                                                                                    org.codehaus.groovy.ast.expr.PropertyExpression propertyExpression,
                                                                                                    @NotNull
                                                                                                    org.codehaus.groovy.ast.ClassNode currentClassNode,
                                                                                                    @NotNull
                                                                                                    ContextSet currentMethodContext)

transformTernary

@NotNull
public org.codehaus.groovy.ast.expr.TernaryExpression transformTernary(@NotNull
                                                                                org.codehaus.groovy.ast.expr.TernaryExpression ternary,
                                                                                @NotNull
                                                                                ContextSet currentMethodContext)

sanitizeClassName

@NotNull
protected String sanitizeClassName(@NotNull
                                            org.codehaus.groovy.ast.ClassNode clazz)

getSafeEvalMethodName

@NotNull
protected String getSafeEvalMethodName(@NotNull
                                                org.codehaus.groovy.ast.ClassNode classNode)

e.g. $CLV_safeEval_java_lang_String$

createSafeEvalMethodIfNecessary

protected void createSafeEvalMethodIfNecessary(@NotNull
                                               org.codehaus.groovy.ast.ClassNode evalReturnType,
                                               @NotNull
                                               org.codehaus.groovy.ast.ClassNode currentClassNode)

Create safeEval_X() method with a proper type signature if it does not exist and add to hashmap.

Parameters:

evalReturnType - what type eval expression has so that our wrapper should return the same type

createSafeEvalMethod

@NotNull
protected org.codehaus.groovy.ast.MethodNode createSafeEvalMethod(@NotNull
                                                                           org.codehaus.groovy.ast.ClassNode clazz,
                                                                           @NotNull
                                                                           org.codehaus.groovy.ast.ClassNode evalReturnType,
                                                                           @NotNull
                                                                           String safeEvalMethodName)

newSafeEval

@NotNull
protected org.codehaus.groovy.ast.expr.StaticMethodCallExpression newSafeEval(@NotNull
                                                                                       BranchInfo branch,
                                                                                       @NotNull
                                                                                       org.codehaus.groovy.ast.expr.Expression objectExpression)