---

JArrayRef.java

package ca.mcgill.sable.soot.jimple;

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Jimple, a 3-address code Java(TM) bytecode representation.        *
 * Copyright (C) 1997, 1998 Raja Vallee-Rai (kor@sable.mcgill.ca)    *
 * All rights reserved.                                              *
 *                                                                   *
 * Modifications by Patrick Lam (plam@sable.mcgill.ca) are           *
 * Copyright (C) 1999 Patrick Lam.  All rights reserved.             *
 *                                                                   *
 * This work was done as a project of the Sable Research Group,      *
 * School of Computer Science, McGill University, Canada             *
 * (http://www.sable.mcgill.ca/).  It is understood that any         *
 * modification not identified as such is not covered by the         *
 * preceding statement.                                              *
 *                                                                   *
 * This work is free software; you can redistribute it and/or        *
 * modify it under the terms of the GNU Library General Public       *
 * License as published by the Free Software Foundation; either      *
 * version 2 of the License, or (at your option) any later version.  *
 *                                                                   *
 * This work is distributed in the hope that it will be useful,      *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of    *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU *
 * Library General Public License for more details.                  *
 *                                                                   *
 * You should have received a copy of the GNU Library General Public *
 * License along with this library; if not, write to the             *
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,      *
 * Boston, MA  02111-1307, USA.                                      *
 *                                                                   *
 * Java is a trademark of Sun Microsystems, Inc.                     *
 *                                                                   *
 * To submit a bug report, send a comment, or get the latest news on *
 * this project and other Sable Research Group projects, please      *
 * visit the web site: http://www.sable.mcgill.ca/                   *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 Reference Version
 -----------------
 This is the latest official version on which this file is based.
 The reference version is: $SootVersion: 1.beta.4 $

 Change History
 --------------
 A) Notes:

 Please use the following template.  Most recent changes should
 appear at the top of the list.

 - Modified on [date (March 1, 1900)] by [name]. [(*) if appropriate]
   [description of modification].

 Any Modification flagged with "(*)" was done as a project of the
 Sable Research Group, School of Computer Science,
 McGill University, Canada (http://www.sable.mcgill.ca/).

 You should add your copyright, using the following template, at
 the top of this file, along with other copyrights.

 *                                                                   *
 * Modifications by [name] are                                       *
 * Copyright (C) [year(s)] [your name (or company)].  All rights     *
 * reserved.                                                         *
 *                                                                   *

 B) Changes:

 - Modified on March 5, 1999 by Raja Vallee-Rai (rvalleerai@sable.mcgill.ca) (*)
   Decided that array references with a null base such as null[0] has type NullType().
 
 - Modified on February 28, 1999 by Raja Vallee-Rai (rvalleerai@sable.mcgill.ca) (*)
   Fixed bug with use boxes.

 - Modified on February 3, 1999 by Patrick Lam (plam@sable.mcgill.ca) (*)
   Added changes in support of the Grimp intermediate
   representation (with aggregated-expressions).

 - Modified on November 2, 1998 by Raja Vallee-Rai (kor@sable.mcgill.ca) (*)
   Repackaged all source files and performed extensive modifications.
   First initial release of Soot.

 - Modified on September 22, 1998 by Raja Vallee-Rai (kor@sable.mcgill.ca). (*)
   Changed the base from Immediate to Local.

 - Modified on 15-Jun-1998 by Raja Vallee-Rai (kor@sable.mcgill.ca). (*)
   First internal release (Version 0.1).
*/

import ca.mcgill.sable.soot.*;
import ca.mcgill.sable.util.*;

public class JArrayRef implements ArrayRef
{
    ValueBox baseBox;
    ValueBox indexBox;


    JArrayRef(Value base, Value index)
    {
    this(Jimple.v().newLocalBox(base),
         Jimple.v().newImmediateBox(index));
    }
    protected JArrayRef(ValueBox baseBox, ValueBox indexBox)
    {
        this.baseBox = baseBox;
        this.indexBox = indexBox;
    }
    public void apply(Switch sw)
    {
        ((RefSwitch) sw).caseArrayRef(this);
    }
    public boolean equals(Object o)
    {
        if (o instanceof ArrayRef)
          {
            return (getBase().equals(((ArrayRef)o).getBase())
                    && getIndex().equals(((ArrayRef)o).getIndex()));
          }
        return false;
    }
    public Value getBase()
    {
        return baseBox.getValue();
    }
    public ValueBox getBaseBox()
    {
        return baseBox;
    }
    public Value getIndex()
    {
        return indexBox.getValue();
    }
    public ValueBox getIndexBox()
    {
        return indexBox;
    }
    public Type getType()
    {
        Value base = (Value) baseBox.getValue();
        Type type = base.getType();

        if(type.equals(UnknownType.v()))
            return UnknownType.v();
        else if(type.equals(NullType.v()))
            return NullType.v();
        else {
            ArrayType arrayType = (ArrayType) type;

            if(arrayType.numDimensions == 1)
                return arrayType.baseType;
            else
                return ArrayType.v(arrayType.baseType, arrayType.numDimensions - 1);
        }
    }
    public List getUseBoxes()
    {
        List useBoxes = new ArrayList();

        useBoxes.addAll(baseBox.getValue().getUseBoxes());
        useBoxes.add(baseBox);

        useBoxes.addAll(indexBox.getValue().getUseBoxes());
        useBoxes.add(indexBox);

        return useBoxes;
    }
    public void setBase(Local base)
    {
        baseBox.setValue(base);
    }
    public void setIndex(Value index)
    {
        indexBox.setValue(index);
    }
    public String toBriefString()
    {
        return ((ToBriefString) baseBox.getValue()).toBriefString() + 
            "[" + ((ToBriefString) indexBox.getValue()).toBriefString() 
            + "]";
    }
    public String toString()
    {
        return baseBox.getValue().toString() + "[" + indexBox.getValue().toString() + "]";
    }
}

---