---

LocalVariableInstruction.java

package de.fub.bytecode.generic;

import java.io.*;
import de.fub.bytecode.util.ByteSequence;
import de.fub.bytecode.classfile.Utility;
import de.fub.bytecode.Constants;

/**
 * Abstract super class for instructions dealing with local variables.
 *
 * @version $Id: LocalVariableInstruction.java,v 1.1.1.1 2002/01/24 03:41:41 pserver Exp $
 * @author  <A HREF="http://www.inf.fu-berlin.de/~dahm">M. Dahm</A>
 */
public abstract class LocalVariableInstruction extends Instruction
  implements TypedInstruction, IndexedInstruction {
  private int     n;     // index of referenced variable
  private short   c_tag; // compact version, such as ILOAD_0
  private short   canon_tag; // canonical tag such as ILOAD

  /**
   * Empty constructor needed for the Class.newInstance() statement in
   * Instruction.readInstruction(). Not to be used otherwise.
   * tag and length are defined in readInstruction and initFromFile, respectively.
   */
  LocalVariableInstruction(short canon_tag, short c_tag) {
    super();
    this.canon_tag = canon_tag;
    this.c_tag     = c_tag;
  }  
  /**
   * @param tag Instruction number
   * @param c_tag Instruction number for compact version, ALOAD_0, e.g.
   * @param n local variable index (unsigned short)
   */
  protected LocalVariableInstruction(short tag, short c_tag, int n) {
    super(tag, (short)2);

    this.c_tag = c_tag;
    canon_tag  = tag;

    setIndex(n);
  }  
  /**
   * Dump instruction as byte code to stream out.
   * @param out Output stream
   */
  public void dump(DataOutputStream out) throws IOException {
    if(wide()) // Need WIDE prefix ?
      out.writeByte(Constants.WIDE);

    out.writeByte(tag);

    if(length > 1) { // Otherwise ILOAD_n, instruction, e.g.
      if(wide())
    out.writeShort(n);
      else
    out.writeByte(n);
    }
  }  
  /** @return canonical tag for instrucion, e.g., ALOAD for ALOAD_0
   */
  public short getCanonicalTag() {
    return canon_tag;
  }  
  /**
   * @return local variable index  referred by this instruction.
   */
  public final int getIndex() { return n; }  
  /** @return type associated with the instruction
   */
  public Type getType(ConstantPoolGen cp) {
    switch(canon_tag) {
    case Constants.ILOAD: case Constants.ISTORE: 
      return Type.INT;
    case Constants.LLOAD: case Constants.LSTORE: 
      return Type.LONG;
    case Constants.DLOAD: case Constants.DSTORE: 
      return Type.DOUBLE;
    case Constants.FLOAD: case Constants.FSTORE: 
      return Type.FLOAT;
    case Constants.ALOAD: case Constants.ASTORE:
      return Type.OBJECT;

    default: throw new ClassGenException("Oops: unknown case in switch" + canon_tag);
    }
  }  
  /**
   * Read needed data (e.g. index) from file.
   * PRE: (ILOAD <= tag <= ALOAD_3) || (ISTORE <= tag <= ASTORE_3)
   */
  protected void initFromFile(ByteSequence bytes, boolean wide)
    throws IOException
  {
    if(wide) {
      n         = bytes.readUnsignedShort();
      length    = 4;
    } else if(((tag >= Constants.ILOAD) &&
           (tag <= Constants.ALOAD)) ||
          ((tag >= Constants.ISTORE) &&
           (tag <= Constants.ASTORE))) {
      n      = bytes.readUnsignedByte();
      length = 2;
    } else if(tag <= Constants.ALOAD_3) { // compact load instruction such as ILOAD_2
      n      = (tag - Constants.ILOAD_0) % 4;
      length = 1;
    } else { // Assert ISTORE_0 <= tag <= ASTORE_3
      n      = (tag - Constants.ISTORE_0) % 4;
      length = 1;
    }
 } 
  /**
   * Set the local variable index
   */
  public final void setIndex(int n) { 
    if((n < 0) || (n > Constants.MAX_SHORT))
      throw new ClassGenException("Illegal value: " + n);

    this.n = n;

    if(n >= 0 && n <= 3) { // Use more compact instruction xLOAD_n
      tag    = (short)(c_tag + n);
      length = 1;
    } else {
      tag = canon_tag;
      
      if(wide()) // Need WIDE prefix ?
    length = 4;
      else
    length = 2;
    }
  }  
  /**
   * Long output format:
   *
   * &lt;name of opcode&gt; "["&lt;opcode number&gt;"]" 
   * "("&lt;length of instruction&gt;")" "&lt;"&lt; local variable index&gt;"&gt;"
   *
   * @param verbose long/short format switch
   * @return mnemonic for instruction
   */
  public String toString(boolean verbose) {
    if(((tag >= Constants.ILOAD_0) &&
    (tag <= Constants.ALOAD_3)) ||
       ((tag >= Constants.ISTORE_0) &&
    (tag <= Constants.ASTORE_3)))
      return super.toString(verbose);
    else
      return super.toString(verbose) + " " + n;
  }  
  private final boolean wide() { return n > Constants.MAX_BYTE; }  
}

---