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

java.lang.Object
- org.apache.flex.abc.instructionlist.InstructionList

All Implemented Interfaces:

Cloneable
```
public class InstructionList
extends Object
implements Cloneable
```
An InstructionList is a structure that holds a sequence of Instructions, and manages sets of labels, which act as relocatable address constants, to compose control-flow constructs from their constituent parts.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InstructionList.IFilter` Interface used by code-gen clients that need a chance to adjust the instruction list after it is generated.

Constructor Summary

Constructors
Constructor and Description
`InstructionList()` Default constructor.
`InstructionList(int capacity)` Construct an InstructionList capable of holding a specified number of instructions.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAll(InstructionList src_list)` Add another InstructionList to the sequence.
`void`	`addAllPendingLabels(Collection<Label> prev_pending)` Add pending labels acquired from a component list to this list's pendingLabels collection.
`Instruction`	`addInstruction(Instruction insn)` Add an instruction to the sequence.
`Instruction`	`addInstruction(int opcode)` Convenience method adds an instruction with no operands.
`Instruction`	`addInstruction(int opcode, int immed)` Convenience method adds an instruction with an immediate operand.
`Instruction`	`addInstruction(int opcode, Object operand)` Convenience method adds an instruction with a single operand.
`Instruction`	`addInstruction(int opcode, Object[] operands)` Convenience method adds an instruction with operands.
`void`	`addLabelAt(Label l, int pos)` Add a label at an arbitrary position.
`boolean`	`canFallThrough()`
`Object`	`clone()` Clone this InstructionList; make a shallow copy of the Instructions, deep copies of the labels.
`int`	`countOccurrences(int opcode)` Count occurrences of an Instruction with a specific opcode.
`int`	`findOccurrences(int opcode, boolean stop_after_first)` Find occurrences of an Instruction with a specific opcode.
`Instruction`	`firstElement()`
`ArrayList<Label>`	`getActiveLabels()`
`ArrayList<Instruction>`	`getInstructions()` Fetch an InstructionList to which instructions can be appended.
`Label`	`getLabel()` Fetch this InstructionList's label.
`Label`	`getLastLabel()`
`boolean`	`hasPendingLabels()`
`boolean`	`hasSuchInstruction(int opcode)` Search for an Instruction with a specific opcode.
`boolean`	`isEmpty()`
`void`	`labelCurrent(Label l)` Label the last executable instruction in this InstructionList.
`void`	`labelFirst(Label l)` Label the first executable instruction in this InstructionList.
`void`	`labelNext(Label l)` Add a Label to this InstructionList's pendingLabels.
`Instruction`	`lastElement()`
`void`	`pushNumericConstant(long value)` Add an Instruction to this InstructionList to push a numeric constant onto the value stack.
`int`	`size()`
`Collection<Label>`	`stripPendingLabels()` This InstructionList is the "body" of a statement that needs to add more logic.
`String`	`toString()` Format the InstructionList for debugging purposes.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InstructionList
```
public InstructionList()
```
    Default constructor.
  - InstructionList
```
public InstructionList(int capacity)
```
    Construct an InstructionList capable of holding a specified number of instructions.
    
    Parameters:
    capacity - - the required capacity.
- Method Detail
  - firstElement
```
public Instruction firstElement()
```
    Returns:
    the first Instruction in this list.
    
    Throws:
    
    NoSuchElementException - if there are no instructions.
  - lastElement
```
public Instruction lastElement()
```
    Returns:
    the last element found.
    
    Throws:
    
    NoSuchElementException - if there are no instructions.
  - isEmpty
```
public boolean isEmpty()
```
    Returns:
    true if no Instructions are found.
  - getInstructions
```
public ArrayList<Instruction> getInstructions()
```
    Fetch an InstructionList to which instructions can be appended. Synthesizes one if not already present.
    
    Returns:
    said list.
  - getLabel
```
public Label getLabel()
```
    Fetch this InstructionList's label.
    
    Returns:
    a synthetic Label that identifies this InstructionList.
  - addInstruction
```
public Instruction addInstruction(Instruction insn)
```
    Add an instruction to the sequence.
    
    Parameters:
    insn - the instruction to be added.
    
    Returns:
    the input insn.
  - addInstruction
```
public Instruction addInstruction(int opcode)
```
    Convenience method adds an instruction with no operands.
    
    Parameters:
    opcode - - the instruction's opcode.
    
    Returns:
    the generated instruction.
  - addInstruction
```
public Instruction addInstruction(int opcode,
                         int immed)
```
    Convenience method adds an instruction with an immediate operand.
    
    Parameters:
    opcode - - the instruction's opcode.
    immed - - the immediate operand.
  - addInstruction
```
public Instruction addInstruction(int opcode,
                         Object[] operands)
```
    Convenience method adds an instruction with operands.
    
    Parameters:
    opcode - - the instruction's opcode.
    operands - - the operands.
  - addInstruction
```
public Instruction addInstruction(int opcode,
                         Object operand)
```
    Convenience method adds an instruction with a single operand.
    
    Parameters:
    opcode - - the instruction's opcode.
    operand - - the operand.
  - addAll
```
public void addAll(InstructionList src_list)
```
    Add another InstructionList to the sequence.
    
    Parameters:
    src_list - the InstructionList to be added.
  - labelFirst
```
public void labelFirst(Label l)
```
    Label the first executable instruction in this InstructionList.
    
    Parameters:
    l - - the Label to be associated with the first executable instruction in the list.
  - labelCurrent
```
public void labelCurrent(Label l)
```
    Label the last executable instruction in this InstructionList.
    
    Parameters:
    l - - the Label to be associated with the last executable instruction in the list.
  - addLabelAt
```
public void addLabelAt(Label l,
              int pos)
```
    Add a label at an arbitrary position.
    
    Parameters:
    l - - the label.
    pos - - the label's position.
  - getActiveLabels
```
public ArrayList<Label> getActiveLabels()
```
    Returns:
    this InstructionList's active labels (i.e., labels resolved to a known offset within this InstructionList).
  - getLastLabel
```
public Label getLastLabel()
```
    Returns:
    a Label bound to the last position in this InstructionList.
  - labelNext
```
public void labelNext(Label l)
```
    Add a Label to this InstructionList's pendingLabels.
    
    Parameters:
    l - - the Label to be set pending.
  - size
```
public int size()
```
    Returns:
    the size of this InstructionList; zero if the list has no instructions, or the number of instructions.
  - hasPendingLabels
```
public boolean hasPendingLabels()
```
    Returns:
    true if this InstructionList has unresolved pending labels.
  - stripPendingLabels
```
public Collection<Label> stripPendingLabels()
```
    This InstructionList is the "body" of a statement that needs to add more logic. Any pending labels from the body statement(s) need to be re-assigned to the owning InstructionList at a later time.
    
    Returns:
    this list's [former] pendingLabels.
  - addAllPendingLabels
```
public void addAllPendingLabels(Collection<Label> prev_pending)
```
    Add pending labels acquired from a component list to this list's pendingLabels collection.
    
    Parameters:
    prev_pending - - pending labels returned by a call to stripPendingLabels().
  - canFallThrough
```
public boolean canFallThrough()
```
    Returns:
    true if the given InstructionList does not have an unconditional transfer of control as its last instruction.
  - toString
```
public String toString()
```
    Format the InstructionList for debugging purposes.
    
    Overrides:
    
    toString in class Object
  - clone
```
public Object clone()
```
    Clone this InstructionList; make a shallow copy of the Instructions, deep copies of the labels.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    a cloned InstructionList.
  - hasSuchInstruction
```
public boolean hasSuchInstruction(int opcode)
```
    Search for an Instruction with a specific opcode.
    
    Parameters:
    opcode - - the opcode of interest.
    
    Returns:
    true if an instruction with this opcode is part of this InstructionList.
  - countOccurrences
```
public int countOccurrences(int opcode)
```
    Count occurrences of an Instruction with a specific opcode.
    
    Parameters:
    opcode - - the opcode of interest.
    
    Returns:
    the count of occurrences.
  - findOccurrences
```
public int findOccurrences(int opcode,
                  boolean stop_after_first)
```
    Find occurrences of an Instruction with a specific opcode.
    
    Parameters:
    opcode - - the opcode of interest.
    stop_after_first - - return a nonzero count after finding at least one occurence (1-3 occurences in the fixed storage, the first occurence in variable storage).
    
    Returns:
    the count of occurrences, or 0/1/2/3 if stop_after_first is set.
  - pushNumericConstant
```
public void pushNumericConstant(long value)
```
    Add an Instruction to this InstructionList to push a numeric constant onto the value stack.
    
    Parameters:
    value - - the value to push.

Class InstructionList

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstructionList

InstructionList

Method Detail

firstElement

lastElement

isEmpty

getInstructions

getLabel

addInstruction

addInstruction

addInstruction

addInstruction

addInstruction

addAll

labelFirst

labelCurrent

addLabelAt

getActiveLabels

getLastLabel

labelNext

size

hasPendingLabels

stripPendingLabels

addAllPendingLabels

canFallThrough

toString

clone

hasSuchInstruction

countOccurrences

findOccurrences

pushNumericConstant