1 /*
   2  * reserved comment block
   3  * DO NOT REMOVE OR ALTER!
   4  */
   5 package com.sun.org.apache.bcel.internal.generic;
   6 
   7 /* ====================================================================
   8  * The Apache Software License, Version 1.1
   9  *
  10  * Copyright (c) 2001 The Apache Software Foundation.  All rights
  11  * reserved.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  *
  17  * 1. Redistributions of source code must retain the above copyright
  18  *    notice, this list of conditions and the following disclaimer.
  19  *
  20  * 2. Redistributions in binary form must reproduce the above copyright
  21  *    notice, this list of conditions and the following disclaimer in
  22  *    the documentation and/or other materials provided with the
  23  *    distribution.
  24  *
  25  * 3. The end-user documentation included with the redistribution,
  26  *    if any, must include the following acknowledgment:
  27  *       "This product includes software developed by the
  28  *        Apache Software Foundation (http://www.apache.org/)."
  29  *    Alternately, this acknowledgment may appear in the software itself,
  30  *    if and wherever such third-party acknowledgments normally appear.
  31  *
  32  * 4. The names "Apache" and "Apache Software Foundation" and
  33  *    "Apache BCEL" must not be used to endorse or promote products
  34  *    derived from this software without prior written permission. For
  35  *    written permission, please contact apache@apache.org.
  36  *
  37  * 5. Products derived from this software may not be called "Apache",
  38  *    "Apache BCEL", nor may "Apache" appear in their name, without
  39  *    prior written permission of the Apache Software Foundation.
  40  *
  41  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  42  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  43  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  44  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  45  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  46  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  47  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  48  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  49  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  50  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  51  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52  * SUCH DAMAGE.
  53  * ====================================================================
  54  *
  55  * This software consists of voluntary contributions made by many
  56  * individuals on behalf of the Apache Software Foundation.  For more
  57  * information on the Apache Software Foundation, please see
  58  * <http://www.apache.org/>.
  59  */
  60 import java.io.*;
  61 import com.sun.org.apache.bcel.internal.util.ByteSequence;
  62 import com.sun.org.apache.bcel.internal.classfile.ConstantPool;
  63 import com.sun.org.apache.bcel.internal.ExceptionConstants;
  64 
  65 /**
  66  * MULTIANEWARRAY - Create new mutidimensional array of references
  67  * <PRE>Stack: ..., count1, [count2, ...] -&gt; ..., arrayref</PRE>
  68  *
  69  * @author  <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
  70  */
  71 public class MULTIANEWARRAY extends CPInstruction implements LoadClass, AllocationInstruction, ExceptionThrower {
  72   private short dimensions;
  73 
  74   /**
  75    * Empty constructor needed for the Class.newInstance() statement in
  76    * Instruction.readInstruction(). Not to be used otherwise.
  77    */
  78   MULTIANEWARRAY() {}
  79 
  80   public MULTIANEWARRAY(int index, short dimensions) {
  81     super(com.sun.org.apache.bcel.internal.Constants.MULTIANEWARRAY, index);
  82 
  83     if(dimensions < 1)
  84       throw new ClassGenException("Invalid dimensions value: " + dimensions);
  85 
  86     this.dimensions = dimensions;
  87     length = 4;
  88   }
  89 
  90   /**
  91    * Dump instruction as byte code to stream out.
  92    * @param out Output stream
  93    */
  94   public void dump(DataOutputStream out) throws IOException {
  95     out.writeByte(opcode);
  96     out.writeShort(index);
  97     out.writeByte(dimensions);
  98   }
  99 
 100   /**
 101    * Read needed data (i.e., no. dimension) from file.
 102    */
 103   protected void initFromFile(ByteSequence bytes, boolean wide)
 104        throws IOException
 105   {
 106     super.initFromFile(bytes, wide);
 107     dimensions = bytes.readByte();
 108     length     = 4;
 109   }
 110 
 111   /**
 112    * @return number of dimensions to be created
 113    */
 114   public final short getDimensions() { return dimensions; }
 115 
 116   /**
 117    * @return mnemonic for instruction
 118    */
 119   public String toString(boolean verbose) {
 120     return super.toString(verbose) + " " + index + " " + dimensions;
 121   }
 122 
 123   /**
 124    * @return mnemonic for instruction with symbolic references resolved
 125    */
 126   public String toString(ConstantPool cp) {
 127     return super.toString(cp) + " " + dimensions;
 128   }
 129 
 130   /**
 131    * Also works for instructions whose stack effect depends on the
 132    * constant pool entry they reference.
 133    * @return Number of words consumed from stack by this instruction
 134    */
 135   public int consumeStack(ConstantPoolGen cpg) { return dimensions; }
 136 
 137   public Class[] getExceptions() {
 138     Class[] cs = new Class[2 + ExceptionConstants.EXCS_CLASS_AND_INTERFACE_RESOLUTION.length];
 139 
 140     System.arraycopy(ExceptionConstants.EXCS_CLASS_AND_INTERFACE_RESOLUTION, 0,
 141                      cs, 0, ExceptionConstants.EXCS_CLASS_AND_INTERFACE_RESOLUTION.length);
 142 
 143     cs[ExceptionConstants.EXCS_CLASS_AND_INTERFACE_RESOLUTION.length+1] = ExceptionConstants.NEGATIVE_ARRAY_SIZE_EXCEPTION;
 144     cs[ExceptionConstants.EXCS_CLASS_AND_INTERFACE_RESOLUTION.length]   = ExceptionConstants.ILLEGAL_ACCESS_ERROR;
 145 
 146     return cs;
 147   }
 148 
 149   public ObjectType getLoadClassType(ConstantPoolGen cpg) {
 150     Type t = getType(cpg);
 151 
 152     if (t instanceof ArrayType){
 153       t = ((ArrayType) t).getBasicType();
 154     }
 155 
 156     return (t instanceof ObjectType)? (ObjectType) t : null;
 157   }
 158 
 159   /**
 160    * Call corresponding visitor method(s). The order is:
 161    * Call visitor methods of implemented interfaces first, then
 162    * call methods according to the class hierarchy in descending order,
 163    * i.e., the most specific visitXXX() call comes last.
 164    *
 165    * @param v Visitor object
 166    */
 167   public void accept(Visitor v) {
 168     v.visitLoadClass(this);
 169     v.visitAllocationInstruction(this);
 170     v.visitExceptionThrower(this);
 171     v.visitTypedInstruction(this);
 172     v.visitCPInstruction(this);
 173     v.visitMULTIANEWARRAY(this);
 174   }
 175 }