com.cloudbees.groovy.cps

Class SandboxCpsTransformer

java.lang.Object

org.codehaus.groovy.control.CompilationUnit.PrimaryClassNodeOperation

org.codehaus.groovy.control.customizers.CompilationCustomizer

com.cloudbees.groovy.cps.CpsTransformer

com.cloudbees.groovy.cps.SandboxCpsTransformer

All Implemented Interfaces:

org.codehaus.groovy.ast.GroovyCodeVisitor

public class SandboxCpsTransformer
extends CpsTransformer

CpsTransformer + SandboxTransformer

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class com.cloudbees.groovy.cps.CpsTransformer

CpsTransformer.ParentClosure

Field Summary

Fields inherited from class com.cloudbees.groovy.cps.CpsTransformer

classNode, config, iota, parent

Constructor Summary

Constructors

Constructor and Description
SandboxCpsTransformer()

Method Summary

Modifier and Type	Method and Description
void	call(org.codehaus.groovy.control.SourceUnit source, org.codehaus.groovy.classgen.GeneratorContext context, org.codehaus.groovy.ast.ClassNode classNode)
protected void	getMultipleAssignmentValueOrCast(org.codehaus.groovy.ast.expr.VariableExpression varExp, org.codehaus.groovy.ast.expr.Expression rhs, org.codehaus.groovy.ast.expr.Expression index)
protected Class	getTrustTag() Trusted or Untrusted tag that gets added to call site.
protected void	processConstructors(org.codehaus.groovy.ast.ClassNode classNode) Constructors can't be transformed - if we throw a CpsCallableInvocation from inside a constructor, there's no way to get back to the continuation.
protected void	visitAssignmentOrCast(org.codehaus.groovy.ast.expr.VariableExpression varExp, org.codehaus.groovy.ast.expr.Expression rhs)
void	visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression exp)
void	visitMethod(org.codehaus.groovy.ast.MethodNode m) Overriding to allow for rejecting finalize methods when sandboxed.
protected void	visitNontransformedField(org.codehaus.groovy.ast.FieldNode f) Field initializers are never transformed, but we still need to run the sandbox transformer on them.
protected void	visitNontransformedMethod(org.codehaus.groovy.ast.MethodNode m) If the method is not CPS transformed, we need to sandbox-transform that method to intercept calls that happen in these methods.
protected void	visitNontransformedStatement(org.codehaus.groovy.ast.stmt.Statement s) Miscellaneous statements like object initializers are never transformed, but we still need to run the sandbox transformer on them.

Methods inherited from class com.cloudbees.groovy.cps.CpsTransformer

literal, literal, literal, literal, loc, makeBuilder, makeChildren, makeChildren, makeNode, makeNode, makeNode, makeNode, prepostfixOperatorSuffix, setConfiguration, shouldBeTransformed, visit, visit, visitArgumentlistExpression, visitArrayExpression, visitAssertStatement, visitAttributeExpression, visitBinaryExpression, visitBitwiseNegationExpression, visitBlockStatement, visitBooleanExpression, visitBreakStatement, visitBytecodeExpression, visitCaseStatement, visitCatchStatement, visitClassExpression, visitClosureExpression, visitClosureListExpression, visitConstantExpression, visitConstructorCallExpression, visitContinueStatement, visitDeclarationExpression, visitDoWhileLoop, visitExpressionStatement, visitFieldExpression, visitForLoop, visitGStringExpression, visitIfElse, visitListExpression, visitMapEntryExpression, visitMapExpression, visitMethodCallExpression, visitMethodPointerExpression, visitNotExpression, visitPostfixExpression, visitPrefixExpression, visitPropertyExpression, visitRangeExpression, visitReturnStatement, visitShortTernaryExpression, visitSpreadExpression, visitSpreadMapExpression, visitStaticMethodCallExpression, visitSwitch, visitSynchronizedStatement, visitTernaryExpression, visitThrowStatement, visitTryCatchFinally, visitTupleExpression, visitUnaryMinusExpression, visitUnaryPlusExpression, visitVariableExpression, visitWhileLoop, visitWithSafepoint

Methods inherited from class org.codehaus.groovy.control.customizers.CompilationCustomizer

getPhase

Methods inherited from class org.codehaus.groovy.control.CompilationUnit.PrimaryClassNodeOperation

needSortedInput

Methods inherited from class java.lang.Object

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

Constructor Detail

SandboxCpsTransformer

public SandboxCpsTransformer()

Method Detail

call

public void call(org.codehaus.groovy.control.SourceUnit source,
                 org.codehaus.groovy.classgen.GeneratorContext context,
                 org.codehaus.groovy.ast.ClassNode classNode)

Overrides:

call in class CpsTransformer

processConstructors

protected void processConstructors(org.codehaus.groovy.ast.ClassNode classNode)

Description copied from class: CpsTransformer

Constructors can't be transformed - if we throw a CpsCallableInvocation from inside a constructor, there's no way to get back to the continuation. The object does not get created and so we're unable to proceed with it. The same thing applies for object initializers.

Overrides:

processConstructors in class CpsTransformer

visitNontransformedMethod

protected void visitNontransformedMethod(org.codehaus.groovy.ast.MethodNode m)

If the method is not CPS transformed, we need to sandbox-transform that method to intercept calls that happen in these methods. This includes all constructor bodies.

Overrides:

visitNontransformedMethod in class CpsTransformer

See Also:

SandboxTransformer.call(org.codehaus.groovy.control.SourceUnit, org.codehaus.groovy.classgen.GeneratorContext, org.codehaus.groovy.ast.ClassNode)

visitNontransformedField

protected void visitNontransformedField(org.codehaus.groovy.ast.FieldNode f)

Field initializers are never transformed, but we still need to run the sandbox transformer on them.

Overrides:

visitNontransformedField in class CpsTransformer

See Also:

SandboxTransformer.call(org.codehaus.groovy.control.SourceUnit, org.codehaus.groovy.classgen.GeneratorContext, org.codehaus.groovy.ast.ClassNode)

visitNontransformedStatement

protected void visitNontransformedStatement(org.codehaus.groovy.ast.stmt.Statement s)

Miscellaneous statements like object initializers are never transformed, but we still need to run the sandbox transformer on them.

Overrides:

visitNontransformedStatement in class CpsTransformer

See Also:

SandboxTransformer.call(org.codehaus.groovy.control.SourceUnit, org.codehaus.groovy.classgen.GeneratorContext, org.codehaus.groovy.ast.ClassNode)

visitMethod

public void visitMethod(org.codehaus.groovy.ast.MethodNode m)

Overriding to allow for rejecting finalize methods when sandboxed.

Overrides:

visitMethod in class CpsTransformer

visitCastExpression

public void visitCastExpression(org.codehaus.groovy.ast.expr.CastExpression exp)

Specified by:

visitCastExpression in interface org.codehaus.groovy.ast.GroovyCodeVisitor

Overrides:

visitCastExpression in class CpsTransformer

visitAssignmentOrCast

protected void visitAssignmentOrCast(org.codehaus.groovy.ast.expr.VariableExpression varExp,
                                     org.codehaus.groovy.ast.expr.Expression rhs)

Overrides:

visitAssignmentOrCast in class CpsTransformer

getMultipleAssignmentValueOrCast

protected void getMultipleAssignmentValueOrCast(org.codehaus.groovy.ast.expr.VariableExpression varExp,
                                                org.codehaus.groovy.ast.expr.Expression rhs,
                                                org.codehaus.groovy.ast.expr.Expression index)

Overrides:

getMultipleAssignmentValueOrCast in class CpsTransformer

getTrustTag

protected Class getTrustTag()

Description copied from class: CpsTransformer

Trusted or Untrusted tag that gets added to call site.

Overrides:

getTrustTag in class CpsTransformer

See Also:

"doc/sandbox.md"