soot.jimple.toolkits.typing.TypeNode Maven / Gradle / Ivy

package soot.jimple.toolkits.typing;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 1997 - 2000 Etienne Gagnon.  All rights reserved.
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 2.1 of the
 * License, or (at your option) any later version.
 * 
 * This program 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 General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import soot.ArrayType;
import soot.NullType;
import soot.PrimType;
import soot.RefType;
import soot.SootClass;
import soot.Type;
import soot.options.Options;
import soot.util.BitVector;

/**
 * Each instance of this class represents one type in the class hierarchy (or basic types).
 **/
class TypeNode {
  private static final Logger logger = LoggerFactory.getLogger(TypeNode.class);
  private static final boolean DEBUG = false;

  private final int id;
  private final Type type;
  private final ClassHierarchy hierarchy;

  private TypeNode parentClass;
  private TypeNode element;
  private TypeNode array;

  private List parents = Collections.emptyList();
  private final BitVector ancestors = new BitVector(0);
  private final BitVector descendants = new BitVector(0);

  public TypeNode(int id, Type type, ClassHierarchy hierarchy) {
    if (type == null || hierarchy == null) {
      throw new InternalTypingException();
    }

    if (!((type instanceof PrimType) || (type instanceof RefType) || (type instanceof ArrayType)
        || (type instanceof NullType))) {
      logger.debug("Unhandled type: " + type);
      throw new InternalTypingException();
    }

    this.id = id;
    this.type = type;
    this.hierarchy = hierarchy;

    if (DEBUG) {
      logger.debug("creating node " + this);
    }
  }

  public TypeNode(int id, RefType type, ClassHierarchy hierarchy) {
    this(id, (Type) type, hierarchy);

    {
      SootClass sClass = type.getSootClass();
      if (sClass == null) {
        throw new RuntimeException("Oops, forgot to load " + type);
      }
      if (sClass.isPhantomClass()) {
        throw new RuntimeException("Jimplification requires " + sClass + ", but it is a phantom ref.");
      }
      List plist = new LinkedList();

      SootClass superclass = sClass.getSuperclassUnsafe();
      if (superclass != null && !sClass.getName().equals("java.lang.Object")) {
        TypeNode parent = hierarchy.typeNode(RefType.v(sClass.getSuperclass().getName()));
        plist.add(parent);
        parentClass = parent;
      }

      for (Iterator i = sClass.getInterfaces().iterator(); i.hasNext();) {
        TypeNode parent = hierarchy.typeNode(RefType.v((i.next()).getName()));
        plist.add(parent);
      }

      parents = Collections.unmodifiableList(plist);
    }

    descendants.set(hierarchy.NULL.id);
    hierarchy.NULL.ancestors.set(id);

    for (Iterator parentIt = parents.iterator(); parentIt.hasNext();) {

      final TypeNode parent = parentIt.next();
      ancestors.set(parent.id);
      ancestors.or(parent.ancestors);
      parent.fixDescendants(id);
    }
  }

  public TypeNode(int id, ArrayType type, ClassHierarchy hierarchy) {
    this(id, (Type) type, hierarchy);

    if (type.numDimensions < 1) {
      throw new InternalTypingException();
    }

    if (type.numDimensions == 1) {
      element = hierarchy.typeNode(type.baseType);
    } else {
      element = hierarchy.typeNode(ArrayType.v(type.baseType, type.numDimensions - 1));
    }

    if (element != hierarchy.INT) {
      if (element.array != null) {
        throw new InternalTypingException();
      }

      element.array = this;
    }

    {
      List plist = new LinkedList();
      if (type.baseType instanceof RefType) {
        RefType baseType = (RefType) type.baseType;
        SootClass sClass = baseType.getSootClass();
        SootClass superClass = sClass.getSuperclassUnsafe();
        if (superClass != null && !superClass.getName().equals("java.lang.Object")) {
          TypeNode parent = hierarchy.typeNode(ArrayType.v(RefType.v(sClass.getSuperclass().getName()), type.numDimensions));
          plist.add(parent);
          parentClass = parent;
        } else if (type.numDimensions == 1) {
          plist.add(hierarchy.OBJECT);

          // hack for J2ME library, reported by Stephen Cheng
          if (!Options.v().j2me()) {
            plist.add(hierarchy.CLONEABLE);
            plist.add(hierarchy.SERIALIZABLE);
          }

          parentClass = hierarchy.OBJECT;
        } else {
          plist.add(hierarchy.typeNode(ArrayType.v(hierarchy.OBJECT.type(), type.numDimensions - 1)));

          // hack for J2ME library, reported by Stephen Cheng
          if (!Options.v().j2me()) {
            plist.add(hierarchy.typeNode(ArrayType.v(hierarchy.CLONEABLE.type(), type.numDimensions - 1)));
            plist.add(hierarchy.typeNode(ArrayType.v(hierarchy.SERIALIZABLE.type(), type.numDimensions - 1)));
          }

          parentClass = hierarchy.typeNode(ArrayType.v(hierarchy.OBJECT.type(), type.numDimensions - 1));
        }

        for (Iterator i = sClass.getInterfaces().iterator(); i.hasNext();) {
          TypeNode parent = hierarchy.typeNode(ArrayType.v(RefType.v((i.next()).getName()), type.numDimensions));
          plist.add(parent);
        }
      } else if (type.numDimensions == 1) {
        plist.add(hierarchy.OBJECT);

        // hack for J2ME library, reported by Stephen Cheng
        if (!Options.v().j2me()) {
          plist.add(hierarchy.CLONEABLE);
          plist.add(hierarchy.SERIALIZABLE);
        }

        parentClass = hierarchy.OBJECT;
      } else {
        plist.add(hierarchy.typeNode(ArrayType.v(hierarchy.OBJECT.type(), type.numDimensions - 1)));
        // hack for J2ME library, reported by Stephen Cheng
        if (!Options.v().j2me()) {
          plist.add(hierarchy.typeNode(ArrayType.v(hierarchy.CLONEABLE.type(), type.numDimensions - 1)));
          plist.add(hierarchy.typeNode(ArrayType.v(hierarchy.SERIALIZABLE.type(), type.numDimensions - 1)));
        }

        parentClass = hierarchy.typeNode(ArrayType.v(hierarchy.OBJECT.type(), type.numDimensions - 1));
      }

      parents = Collections.unmodifiableList(plist);
    }

    descendants.set(hierarchy.NULL.id);
    hierarchy.NULL.ancestors.set(id);

    for (Iterator parentIt = parents.iterator(); parentIt.hasNext();) {

      final TypeNode parent = parentIt.next();
      ancestors.set(parent.id);
      ancestors.or(parent.ancestors);
      parent.fixDescendants(id);
    }
  }

  /** Adds the given node to the list of descendants of this node and its ancestors. **/
  private void fixDescendants(int id) {
    if (descendants.get(id)) {
      return;
    }

    for (Iterator parentIt = parents.iterator(); parentIt.hasNext();) {

      final TypeNode parent = parentIt.next();
      parent.fixDescendants(id);
    }

    descendants.set(id);
  }

  /** Returns the unique id of this type node. **/
  public int id() {
    return id;
  }

  /** Returns the type represented by this type node. **/
  public Type type() {
    return type;
  }

  public boolean hasAncestor(TypeNode typeNode) {
    return ancestors.get(typeNode.id);
  }

  public boolean hasAncestorOrSelf(TypeNode typeNode) {
    if (typeNode == this) {
      return true;
    }

    return ancestors.get(typeNode.id);
  }

  public boolean hasDescendant(TypeNode typeNode) {
    return descendants.get(typeNode.id);
  }

  public boolean hasDescendantOrSelf(TypeNode typeNode) {
    if (typeNode == this) {
      return true;
    }

    return descendants.get(typeNode.id);
  }

  public List parents() {
    return parents;
  }

  public TypeNode parentClass() {
    return parentClass;
  }

  @Override
  public String toString() {
    return type.toString() + "(" + id + ")";
  }

  public TypeNode lca(TypeNode type) throws TypeException {
    if (type == null) {
      throw new InternalTypingException();
    }

    if (type == this) {
      return this;
    }

    if (hasAncestor(type)) {
      return type;
    }

    if (hasDescendant(type)) {
      return this;
    }

    do {
      type = type.parentClass;

      if (type == null) {
        try {
          TypeVariable.error("Type Error(12)");
        } catch (TypeException e) {
          if (DEBUG) {
            logger.error(e.getMessage(), e);
          }
          throw e;
        }
      }
    } while (!hasAncestor(type));

    return type;
  }

  public TypeNode lcaIfUnique(TypeNode type) throws TypeException {
    TypeNode initial = type;

    if (type == null) {
      throw new InternalTypingException();
    }

    if (type == this) {
      return this;
    }

    if (hasAncestor(type)) {
      return type;
    }

    if (hasDescendant(type)) {
      return this;
    }

    do {
      if (type.parents.size() == 1) {
        type = type.parents.get(0);
      } else {
        if (DEBUG) {
          logger.debug("lca " + initial + " (" + type + ") & " + this + " =");
          for (Iterator i = type.parents.iterator(); i.hasNext();) {
            logger.debug("  " + i.next());
          }
        }
        return null;
      }
    } while (!hasAncestor(type));

    return type;
  }

  public boolean hasElement() {
    return element != null;
  }

  public TypeNode element() {
    if (element == null) {
      throw new InternalTypingException();
    }

    return element;
  }

  public TypeNode array() {
    if (array != null) {
      return array;
    }

    if (type instanceof ArrayType) {
      ArrayType atype = (ArrayType) type;
      array = hierarchy.typeNode(ArrayType.v(atype.baseType, atype.numDimensions + 1));
      return array;
    }

    if (type instanceof PrimType || type instanceof RefType) {
      array = hierarchy.typeNode(ArrayType.v(type, 1));
      return array;
    }

    throw new InternalTypingException();
  }

  public boolean isNull() {
    if (type instanceof NullType) {
      return true;
    }

    return false;
  }

  public boolean isClass() {
    if (type instanceof ArrayType || type instanceof NullType
        || (type instanceof RefType && !((RefType) type).getSootClass().isInterface())) {
      return true;
    }

    return false;
  }

  public boolean isClassOrInterface() {
    if (type instanceof ArrayType || type instanceof NullType || type instanceof RefType) {
      return true;
    }

    return false;
  }

  public boolean isArray() {
    if (type instanceof ArrayType || type instanceof NullType) {
      return true;
    }

    return false;
  }
}