FrameModelVisitor (Apache Flex - FlexJS: Compiler: Parent 0.8.0-SNAPSHOT API)

```
public interface FrameModelVisitor<T>
```
The FrameModelVisitor interface presents an abstract view of ABC bytecode semantics, focused on maintenance of the AVM "frame" (the local variable slots, the scope stack, and the value stack).

Method Summary

Methods
Modifier and Type	Method and Description
`T`	`branch(Instruction i, IBasicBlock target)` Handle a branch instruction.
`T`	`consumeAndProduceValue(Instruction i, int consumeCount)` Handle an instruction that consumes value stack elements, and then pushes a new value onto the stack.
`T`	`consumeValue(Instruction i, int count)` Handle an instruction that consumes value stack elements.
`T`	`dup(Instruction i)` Duplicate the top of the stack.
`T`	`getlocal(Instruction i, int idx)` Get a local variable, leaving its value on the stack.
`T`	`getScopeobject(Instruction i, int idx)` Get a value from the scope stack.
`T`	`hasnext2(Instruction i)` Special-case the hasnext2 instruction.
`void`	`modifyLocal(Instruction i, int idx)` Modify (i.e., increment, decrement, or kill) a local variable.
`T`	`moveValueToScopeStack(Instruction i)` Move the top of the value stack to the top of the scope stack.
`T`	`multiwayBranch(Instruction i, Collection<IBasicBlock> targets)` Handle a multibranch instruction.
`T`	`noFrameEffect(Instruction i)` Handle an instruction that does not affect the frame.
`T`	`popscope(Instruction i)` Pop the top of the scope stack.
`T`	`produceValue(Instruction i)` Handle an instruction that pushes a value onto the stack.
`T`	`setlocal(Instruction i, int idx)` Set a local variable, comsuming a value from the stack.
`T`	`swap(Instruction i)` Swap the two top values on the stack.
`void`	`visit(FrameModelEncoder encoder)` Begin a visit to a method body.
`boolean`	`visitBlock(IBasicBlock b)` Visit a new Block.
`void`	`visitEdge(IBasicBlock from, IBasicBlock to)` Visit a control-flow edge from one Block to another.
`void`	`visitEnd()` Finish visiting a method body.
`void`	`visitEndBlock(IBasicBlock b)` End a visit to a block.

- Method Detail
  - visit
```
void visit(FrameModelEncoder encoder)
```
    Begin a visit to a method body.
    
    Parameters:
    encoder - - the FrameModelEncoder driving the visit.
  - visitEnd
```
void visitEnd()
```
    Finish visiting a method body.
  - noFrameEffect
```
T noFrameEffect(Instruction i)
```
    Handle an instruction that does not affect the frame.
    
    Parameters:
    i - - the Instruction.
    
    Returns:
    a representation of the Instruction, which may be null if the visitor works by internal side effect.
  - consumeValue
```
T consumeValue(Instruction i,
             int count)
```
    Handle an instruction that consumes value stack elements.
    
    Parameters:
    i - - the Instruction.
    count - - the number of value stack elements consumed.
    
    Returns:
    a representation of the Instruction and its operands, which may be null if the visitor works by internal side effect.
  - produceValue
```
T produceValue(Instruction i)
```
    Handle an instruction that pushes a value onto the stack.
    
    Parameters:
    i - - the Instruction.
    
    Returns:
    a representation of the Instruction, which may be null if the visitor works by internal side effect.
  - consumeAndProduceValue
```
T consumeAndProduceValue(Instruction i,
                       int consumeCount)
```
    Handle an instruction that consumes value stack elements, and then pushes a new value onto the stack.
    
    Parameters:
    i - - the Instruction.
    consumeCount - - the number of value stack elements consumed.
    
    Returns:
    a representation of the Instruction and its operands, which may be null if the visitor works by internal side effect.
  - branch
```
T branch(Instruction i,
       IBasicBlock target)
```
    Handle a branch instruction.
    
    Parameters:
    i - - the Instruction.
    target - - the Instruction's target. Instructions with fall-through semantics also implicitly target the next Block.
    
    Returns:
    a representation of the Instruction, which may be null if the visitor works by internal side effect.
  - multiwayBranch
```
T multiwayBranch(Instruction i,
               Collection<IBasicBlock> targets)
```
    Handle a multibranch instruction.
    
    Parameters:
    i - - the Instruction.
    targets - - the Instruction's targets.
    
    Returns:
    a representation of the Instruction, which may be null if the visitor works by internal side effect.
  - getlocal
```
T getlocal(Instruction i,
         int idx)
```
    Get a local variable, leaving its value on the stack.
    
    Parameters:
    i - - the Instruction.
    idx - - the variable's index.
    
    Returns:
    a representation of the Instruction, which may be null if the visitor works by internal side effect.
  - setlocal
```
T setlocal(Instruction i,
         int idx)
```
    Set a local variable, comsuming a value from the stack.
    
    Parameters:
    i - - the Instruction.
    idx - - the variable's index.
    
    Returns:
    a representation of the Instruction, which may be null if the visitor works by internal side effect.
  - modifyLocal
```
void modifyLocal(Instruction i,
               int idx)
```
    Modify (i.e., increment, decrement, or kill) a local variable. Note that this does not yield an Instruction, it's a notification.
    
    Parameters:
    i - - the Instruction.
    idx - - the variable's index.
  - moveValueToScopeStack
```
T moveValueToScopeStack(Instruction i)
```
    Move the top of the value stack to the top of the scope stack.
    
    Parameters:
    i - - the Instruction.
    
    Returns:
    a representation of the Instruction, which may be null if the visitor works by internal side effect.
  - popscope
```
T popscope(Instruction i)
```
    Pop the top of the scope stack.
    
    Parameters:
    i - - the Instruction.
    
    Returns:
    a representation of the Instruction, which may be null if the visitor works by internal side effect.
  - getScopeobject
```
T getScopeobject(Instruction i,
               int idx)
```
    Get a value from the scope stack.
    
    Parameters:
    i - - the Instruction.
    idx - - the index of the object in the scope stack.
    
    Returns:
    a representation of the Instruction, which may be null if the visitor works by internal side effect.
  - hasnext2
```
T hasnext2(Instruction i)
```
    Special-case the hasnext2 instruction.
    
    Parameters:
    i - - the Instruction.
    
    Returns:
    a representation of the Instruction, which may be null if the visitor works by internal side effect.
  - dup
```
T dup(Instruction i)
```
    Duplicate the top of the stack.
    
    Parameters:
    i - - the Instruction.
    
    Returns:
    a representation of the Instruction, which may be null if the visitor works by internal side effect.
  - swap
```
T swap(Instruction i)
```
    Swap the two top values on the stack.
    
    Parameters:
    i - - the Instruction.
    
    Returns:
    a representation of the Instruction, which may be null if the visitor works by internal side effect.
  - visitBlock
```
boolean visitBlock(IBasicBlock b)
```
    Visit a new Block.
    
    Parameters:
    b - - the Block.
    
    Returns:
    true if the stack encoder should continue visiting the Block.
  - visitEndBlock
```
void visitEndBlock(IBasicBlock b)
```
    End a visit to a block.
    
    Parameters:
    b - - the Block. Must be the block passed to the most recent visitBlock(b) call that returned true.
  - visitEdge
```
void visitEdge(IBasicBlock from,
             IBasicBlock to)
```
    Visit a control-flow edge from one Block to another.

Interface FrameModelVisitor<T>

Method Summary

Method Detail

visit

visitEnd

noFrameEffect

consumeValue

produceValue

consumeAndProduceValue

branch

multiwayBranch

getlocal

setlocal

modifyLocal

moveValueToScopeStack

popscope

getScopeobject

hasnext2

dup

swap

visitBlock

visitEndBlock

visitEdge