Package org.codehaus.groovy.classgen.asm

Class DelegatingController

java.lang.Object
org.codehaus.groovy.classgen.asm.WriterController
org.codehaus.groovy.classgen.asm.DelegatingController
Direct Known Subclasses:
StaticTypesWriterController
public class DelegatingController extends WriterController
This class will delegate all calls to a WriterController given in the constructor.

  • Constructor Details

    • DelegatingController

      public DelegatingController(WriterController normalController)

  • Method Details

    • init

      public void init(AsmClassGenerator asmClassGenerator, GeneratorContext gcon, org.objectweb.asm.ClassVisitor cv, ClassNode cn)
      Description copied from class: WriterController
      Initializes this controller with compilation context and ASM infrastructure. Must be called exactly once before any bytecode generation operations. Sets up all supporting writers (call site, closure, lambda, etc.) and configures optimization strategies based on compiler configuration.
      Overrides:
      init in class WriterController
      Parameters:
      asmClassGenerator - the class generator managing the overall compilation
      gcon - the compilation context tracking state across the compilation unit
      cv - the ASM ClassVisitor for emitting bytecode directives
      cn - the ClassNode being compiled

    • setMethodNode

      public void setMethodNode(MethodNode mn)
      Description copied from class: WriterController
      Sets the MethodNode for the method currently being compiled. Automatically clears any active constructor node, since only one can be active. Used during compilation to track which method's bytecode is being generated.
      Overrides:
      setMethodNode in class WriterController
      Parameters:
      mn - the MethodNode to compile, or null to deactivate

    • setConstructorNode

      public void setConstructorNode(ConstructorNode cn)
      Description copied from class: WriterController
      Sets the ConstructorNode for the constructor currently being compiled. Automatically clears any active method node, since only one can be active. Used during compilation to track which constructor's bytecode is being generated.
      Overrides:
      setConstructorNode in class WriterController
      Parameters:
      cn - the ConstructorNode to compile, or null to deactivate

    • isFastPath

      public boolean isFastPath()
      Description copied from class: WriterController
      Returns true if the compiler is currently in fast-path mode, emitting specialized bytecode for primitive type operations. Use this to determine whether expression helpers should apply optimizations.
      Overrides:
      isFastPath in class WriterController
      Returns:
      true if fast-path compilation mode is active

    • getCallSiteWriter

      public CallSiteWriter getCallSiteWriter()
      Description copied from class: WriterController
      Returns the CallSiteWriter responsible for generating dynamic call site infrastructure. Behavior depends on bytecode strategy: either invokedynamic for modern JVMs or traditional call-site caching for broader compatibility.
      Overrides:
      getCallSiteWriter in class WriterController

    • getCallSiteWriterFor

      public CallSiteWriter getCallSiteWriterFor(Expression expression)
      Description copied from class: WriterController
      Returns the CallSiteWriter for a specific expression. Currently delegates to the default CallSiteWriter; reserved for future expression-specific optimization strategies.
      Overrides:
      getCallSiteWriterFor in class WriterController
      Parameters:
      expression - the expression being processed
      Returns:
      the appropriate call site writer for this expression

    • getStatementWriter

      public StatementWriter getStatementWriter()
      Description copied from class: WriterController
      Returns the StatementWriter for compiling Groovy statements into bytecode. Selection depends on optimization mode: OptimizingStatementWriter for WriterController.optimizeForInt, otherwise generic StatementWriter.
      Overrides:
      getStatementWriter in class WriterController

    • getTypeChooser

      public TypeChooser getTypeChooser()
      Description copied from class: WriterController
      Returns the TypeChooser used to select appropriate type representations for expressions during compilation, supporting both dynamic and typed paths.
      Overrides:
      getTypeChooser in class WriterController

    • getAcg

      public AsmClassGenerator getAcg()
      Description copied from class: WriterController
      Returns the AsmClassGenerator managing overall compilation for this class. Provides access to source units, compiler configuration, and other compilation-wide state.
      Overrides:
      getAcg in class WriterController

    • getAssertionWriter

      public AssertionWriter getAssertionWriter()
      Description copied from class: WriterController
      Returns the AssertionWriter for compiling Groovy assert statements into bytecode that evaluates conditions and raises AssertionError.
      Overrides:
      getAssertionWriter in class WriterController

    • getBinaryExpressionHelper

      public BinaryExpressionHelper getBinaryExpressionHelper()
      Description copied from class: WriterController
      Returns the appropriate BinaryExpressionHelper for the current code path. Selects fast-path specialized handling when WriterController.isFastPath() is true, otherwise delegates to the general-purpose binary expression handler. Fast-path optimization is controlled by WriterController.optimizeForInt.
      Overrides:
      getBinaryExpressionHelper in class WriterController
      Returns:
      the binary expression writer for the active compilation mode

    • getUnaryExpressionHelper

      public UnaryExpressionHelper getUnaryExpressionHelper()
      Description copied from class: WriterController
      Returns the appropriate UnaryExpressionHelper for the current code path. Selects fast-path specialized handling when WriterController.isFastPath() is true, otherwise delegates to the general-purpose unary expression handler. Fast-path optimization is controlled by WriterController.optimizeForInt.
      Overrides:
      getUnaryExpressionHelper in class WriterController
      Returns:
      the unary expression writer for the active compilation mode

    • getClassName

      public String getClassName()
      Description copied from class: WriterController
      Returns the internal (JVM) name of the class being compiled. For interface types with a helper loading class, returns the helper class name; otherwise returns the standard internal class name. Format: package segments separated by '/', e.g., "java/lang/String"
      Overrides:
      getClassName in class WriterController
      Returns:
      the fully-qualified internal class name

    • getClassNode

      public ClassNode getClassNode()
      Description copied from class: WriterController
      Returns the ClassNode representing the class currently being compiled. Contains the complete AST structure including fields, methods, and metadata. This is immutable for the duration of the compilation process.
      Overrides:
      getClassNode in class WriterController
      Returns:
      the ClassNode for this compilation unit

    • getClassVisitor

      public org.objectweb.asm.ClassVisitor getClassVisitor()
      Description copied from class: WriterController
      Returns the ASM ClassVisitor for emitting class-level bytecode directives. This is the primary interface for writing class metadata, fields, methods, and attributes to the compiled bytecode.
      Overrides:
      getClassVisitor in class WriterController

    • getClosureWriter

      public ClosureWriter getClosureWriter()
      Description copied from class: WriterController
      Returns the ClosureWriter for compiling Groovy closure literals into inner classes implementing GroovyObject and supporting variable capture.
      Overrides:
      getClosureWriter in class WriterController

    • getLambdaWriter

      public LambdaWriter getLambdaWriter()
      Description copied from class: WriterController
      Returns the LambdaWriter for compiling Java-style lambda expressions (using the -> operator) into functional interfaces.
      Overrides:
      getLambdaWriter in class WriterController

    • getMethodPointerExpressionWriter

      public MethodPointerExpressionWriter getMethodPointerExpressionWriter()
      Description copied from class: WriterController
      Returns the MethodPointerExpressionWriter for compiling method pointer expressions (e.g., String.&length) into method reference objects.
      Overrides:
      getMethodPointerExpressionWriter in class WriterController

    • getMethodReferenceExpressionWriter

      public MethodReferenceExpressionWriter getMethodReferenceExpressionWriter()
      Description copied from class: WriterController
      Returns the MethodReferenceExpressionWriter for compiling method reference expressions compatible with Java functional interface targets.
      Overrides:
      getMethodReferenceExpressionWriter in class WriterController

    • getCompileStack

      public CompileStack getCompileStack()
      Description copied from class: WriterController
      Returns the CompileStack managing local variable slots, scope boundaries, and control flow labels during method compilation.
      Overrides:
      getCompileStack in class WriterController

    • getConstructorNode

      public ConstructorNode getConstructorNode()
      Description copied from class: WriterController
      Returns the ConstructorNode for the constructor currently being compiled, or null if no constructor is active or a method is being compiled instead.
      Overrides:
      getConstructorNode in class WriterController
      Returns:
      the current ConstructorNode, or null if none is active

    • getContext

      public GeneratorContext getContext()
      Description copied from class: WriterController
      Returns the GeneratorContext tracking compilation state across the entire compilation unit, including helper classes and shared resources.
      Overrides:
      getContext in class WriterController

    • getCv

      @Deprecated public org.objectweb.asm.ClassVisitor getCv()
      Deprecated.
      Description copied from class: WriterController
      Returns the ASM ClassVisitor for emitting class-level bytecode directives.
      Overrides:
      getCv in class WriterController

    • getInterfaceClassLoadingClass

      public InterfaceHelperClassNode getInterfaceClassLoadingClass()
      Description copied from class: WriterController
      Returns the InterfaceHelperClassNode used for interface static method loading, or null if the compiled class is not an interface or needs no helper class. Interface helper classes bridge the gap between interface static methods and their actual implementation in Java 8+ runtime environments.
      Overrides:
      getInterfaceClassLoadingClass in class WriterController
      Returns:
      the helper class node, or null if not applicable

    • getInternalBaseClassName

      public String getInternalBaseClassName()
      Description copied from class: WriterController
      Returns the internal (JVM) name of the immediate superclass. The internal name format uses '/' as package separator, e.g., "java/lang/Object". Typically "java/lang/Object" for classes without explicit superclass, or the superclass name for classes with explicit inheritance.
      Overrides:
      getInternalBaseClassName in class WriterController
      Returns:
      the fully-qualified internal name of the parent class

    • getInternalClassName

      public String getInternalClassName()
      Description copied from class: WriterController
      Returns the internal (JVM) name of the class being compiled. The internal name format uses '/' as package separator, e.g., "org/groovy/MyClass". This corresponds to the formal name used in bytecode class descriptors.
      Overrides:
      getInternalClassName in class WriterController
      Returns:
      the fully-qualified internal class name

    • getInvocationWriter

      public InvocationWriter getInvocationWriter()
      Description copied from class: WriterController
      Returns the InvocationWriter for compiling method calls and dynamic function invocations into appropriate bytecode patterns.
      Overrides:
      getInvocationWriter in class WriterController

    • getMethodNode

      public MethodNode getMethodNode()
      Description copied from class: WriterController
      Returns the MethodNode for the method currently being compiled, or null if no method is active or a constructor is being compiled instead.
      Overrides:
      getMethodNode in class WriterController
      Returns:
      the current MethodNode, or null if none is active

    • getMethodVisitor

      public org.objectweb.asm.MethodVisitor getMethodVisitor()
      Description copied from class: WriterController
      Returns the ASM MethodVisitor for emitting bytecode instructions within the currently-active method or constructor. Null if no method is active.
      Overrides:
      getMethodVisitor in class WriterController

    • getOperandStack

      public OperandStack getOperandStack()
      Description copied from class: WriterController
      Returns the OperandStack managing the JVM operand stack, tracking stack depth and type information for bytecode verification and optimization.
      Overrides:
      getOperandStack in class WriterController

    • getOutermostClass

      public ClassNode getOutermostClass()
      Description copied from class: WriterController
      Returns the outermost enclosing class in the nesting hierarchy. For top-level classes, returns the class itself. For nested classes, traverses outward to find the top-level class.
      Overrides:
      getOutermostClass in class WriterController
      Returns:
      the outermost ClassNode in the nest

    • getReturnType

      public ClassNode getReturnType()
      Description copied from class: WriterController
      Returns the declared return type of the current method or constructor. The return type reflects the method signature from the source code.
      Overrides:
      getReturnType in class WriterController
      Returns:
      the return type ClassNode

    • getSourceUnit

      public SourceUnit getSourceUnit()
      Description copied from class: WriterController
      Returns the SourceUnit containing the source code being compiled. Provides access to source URLs, encoding, and error reporting infrastructure.
      Overrides:
      getSourceUnit in class WriterController

    • isConstructor

      public boolean isConstructor()
      Description copied from class: WriterController
      Returns true if a constructor is currently being compiled. False if a regular instance or static method is active, or if no method is active.
      Overrides:
      isConstructor in class WriterController
      Returns:
      true if in constructor compilation context

    • isInGeneratedFunction

      public boolean isInGeneratedFunction()
      Description copied from class: WriterController
      Returns true if the class being compiled is a generated function wrapper (e.g., an inner class synthesized for a closure or lambda expression). Generated functions have an outer class and are marked as generated.
      Overrides:
      isInGeneratedFunction in class WriterController
      Returns:
      true if compiling a closure or lambda's wrapper class

    • isInGeneratedFunctionConstructor

      public boolean isInGeneratedFunctionConstructor()
      Description copied from class: WriterController
      Returns true if compiling a constructor within a generated function class. Combines two checks: that we're in constructor context AND in a generated function. This condition indicates we're initializing a closure or lambda wrapper.
      Overrides:
      isInGeneratedFunctionConstructor in class WriterController
      Returns:
      true if in a generated function's constructor

    • isNotClinit

      public boolean isNotClinit()
      Description copied from class: WriterController
      Returns true if the current method is NOT a static class initializer (<clinit>). Equivalent to: no method is active OR the method is not a static constructor. Used to guard code that should not execute in class initialization.
      Overrides:
      isNotClinit in class WriterController
      Returns:
      true if not in static initializer context

    • isInScriptBody

      public boolean isInScriptBody()
      Overrides:
      isInScriptBody in class WriterController
      Returns:
      true if we are in a script body, where all variables declared are no longer local variables but are properties

    • isStaticConstructor

      public boolean isStaticConstructor()
      Description copied from class: WriterController
      Returns true if the current method is a static class initializer (<clinit>). The static initializer runs once when the class is loaded by the JVM. Returns false if no method is active or the method is not static.
      Overrides:
      isStaticConstructor in class WriterController
      Returns:
      true if the current method is the static class initializer

    • isStaticContext

      public boolean isStaticContext()
      Description copied from class: WriterController
      Determines whether the current execution context is statically scoped. Returns true when compiling inside a static method or static class initializer. For instance constructors, checks whether we're in a special constructor call (e.g., super or this call) which requires static semantics.
      Overrides:
      isStaticContext in class WriterController
      Returns:
      true if executing in static context, false for instance context

    • isStaticMethod

      public boolean isStaticMethod()
      Description copied from class: WriterController
      Returns true if the current method is explicitly declared as static. Returns false if no method is active or the method is instance-scoped.
      Overrides:
      isStaticMethod in class WriterController
      Returns:
      true if the current method has the static modifier

    • setInterfaceClassLoadingClass

      public void setInterfaceClassLoadingClass(InterfaceHelperClassNode ihc)
      Description copied from class: WriterController
      Sets the InterfaceHelperClassNode for interface static method loading. Called during interface compilation to register the synthesized helper class that provides access to static interface methods in compatible runtimes. The helper class allows proper method lookup and invocation for interface statics.
      Overrides:
      setInterfaceClassLoadingClass in class WriterController
      Parameters:
      ihc - the helper class node, or null to deactivate

    • setMethodVisitor

      public void setMethodVisitor(org.objectweb.asm.MethodVisitor methodVisitor)
      Description copied from class: WriterController
      Sets the ASM MethodVisitor for the currently-active method or constructor. Called before each method body compilation to direct bytecode emission.
      Overrides:
      setMethodVisitor in class WriterController
      Parameters:
      methodVisitor - the visitor for the current method, or null to deactivate

    • shouldOptimizeForInt

      public boolean shouldOptimizeForInt()
      Description copied from class: WriterController
      Returns true if the bytecode generator should emit optimized fast-path code for integer operations. Corresponds to the WriterController.optimizeForInt configuration which is disabled when invokedynamic is enabled.
      Overrides:
      shouldOptimizeForInt in class WriterController
      Returns:
      true if integer-optimized fast-path code generation is enabled

    • switchToFastPath

      public void switchToFastPath()
      Description copied from class: WriterController
      Switches compilation to fast-path mode for specialized numeric handling. In fast-path mode, the compiler emits optimized bytecode for common operations on primitive integer types, bypassing dynamic method invocation overhead. Also resets line number tracking to allow proper debug attribute synchronization.
      Overrides:
      switchToFastPath in class WriterController

    • switchToSlowPath

      public void switchToSlowPath()
      Description copied from class: WriterController
      Switches compilation to slow-path mode, reverting to general-purpose bytecode generation. Slow-path mode uses dynamic method dispatch for all operations, suitable when type information is insufficient for safe optimization or type specialization is not beneficial. Also resets line number tracking.
      Overrides:
      switchToSlowPath in class WriterController

    • getBytecodeVersion

      public int getBytecodeVersion()
      Description copied from class: WriterController
      Returns the bytecode version (target JVM version) for classes being compiled. Examples: V1_8 (Java 8), V11 (Java 11), V17 (Java 17), etc. Determined from compiler configuration and affects class file format and available bytecode features in generated code.
      Overrides:
      getBytecodeVersion in class WriterController
      Returns:
      the target bytecode version constant from ASM

    • setLineNumber

      public void setLineNumber(int n)
      Description copied from class: WriterController
      Updates the current source line number being compiled. The line number is used for debug information (LineNumberTable attribute) and must be set before emitting bytecode for the corresponding source line.
      Overrides:
      setLineNumber in class WriterController
      Parameters:
      n - the new source line number, or -1 to reset

    • getLineNumber

      public int getLineNumber()
      Description copied from class: WriterController
      Returns the source line number currently being compiled. Line numbers are tracked for debug attribute generation in the bytecode, allowing debuggers and profilers to map bytecode instructions to source lines. Returns -1 when no valid line number is active.
      Overrides:
      getLineNumber in class WriterController
      Returns:
      the current source line number, or -1 if invalid/not set

    • resetLineNumber

      public void resetLineNumber()
      Description copied from class: WriterController
      Resets the tracked line number to -1 (invalid). Called when switching compilation modes or after line number emission to avoid stale line number information in subsequent bytecode.
      Overrides:
      resetLineNumber in class WriterController