Module org.glavo.classfile
Package org.glavo.classfile.components

Interface CodeStackTracker

All Superinterfaces:
ClassFileTransform<CodeTransform,CodeElement,CodeBuilder>, CodeTransform
All Known Implementing Classes:
CodeStackTrackerImpl
public sealed interface CodeStackTracker extends CodeTransform permits CodeStackTrackerImpl
CodeStackTracker is a CodeTransform tracking stack content and calculating max stack size.

Sample use: 

    var stackTracker = CodeStackTracker.of();
    codeBuilder.transforming(stackTracker, trackedBuilder -> {
        trackedBuilder.aload(0);
        trackedBuilder.lconst_0();
        trackedBuilder.ifThen(...);
        ...
        var stack = stackTracker.stack().get();
        int maxStack = stackTracker.maxStackSize().get();
    });
Since:
22

  • Method Details

    • of

      static CodeStackTracker of(TypeKind... initialStack)
      Creates new instance of CodeStackTracker initialized with provided stack items.
      Parameters:
      initialStack - initial stack content
      Returns:
      new instance of CodeStackTracker

    • stack

      Optional<Collection<TypeKind>> stack()
      Returns Collection of TypeKind representing current stack. Returns an empty Optional when the Stack content is unknown (right after xRETURN, ATHROW, GOTO, GOTO_W, LOOKUPSWITCH, TABLESWITCH instructions).

      Temporary unknown stack content can be recovered by binding of a Label used as target of a branch instruction from existing code with known stack (forward branch target), or by binding of a Label defining an exception handler (exception handler code start).

      Returns:
      actual stack content, or an empty Optional if unknown

    • maxStackSize

      Optional<Integer> maxStackSize()
      Returns tracked max stack size. Returns an empty Optional when max stack size tracking has been lost.

      Max stack size tracking is permanently lost when a stack instruction appears and the actual stack content is unknown.

      Returns:
      tracked max stack size, or an empty Optional if tracking has been lost