soot.util.cfgcmd.CFGGraphType Maven / Gradle / Ivy

package soot.util.cfgcmd;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 2003 John Jorgensen
 * %%
 * 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.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;

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

import soot.Body;
import soot.toolkits.graph.ArrayRefBlockGraph;
import soot.toolkits.graph.BriefBlockGraph;
import soot.toolkits.graph.BriefUnitGraph;
import soot.toolkits.graph.ClassicCompleteBlockGraph;
import soot.toolkits.graph.ClassicCompleteUnitGraph;
import soot.toolkits.graph.CompleteBlockGraph;
import soot.toolkits.graph.CompleteUnitGraph;
import soot.toolkits.graph.DirectedGraph;
import soot.toolkits.graph.ExceptionalBlockGraph;
import soot.toolkits.graph.ExceptionalUnitGraph;
import soot.toolkits.graph.TrapUnitGraph;
import soot.toolkits.graph.ZonedBlockGraph;
import soot.util.dot.DotGraph;

/**
 * An enumeration type for representing the varieties of control flow graph available, for use in tools that compare or
 * display CFGs.
 */
public abstract class CFGGraphType extends CFGOptionMatcher.CFGOption {
  private static final Logger logger = LoggerFactory.getLogger(CFGGraphType.class);

  private static final boolean DEBUG = true;

  /**
   * Method that will build a graph of this type.
   *
   * @param b
   *          The method Body from which to build the graph.
   *
   * @return The control flow graph corresponding to b
   */
  public abstract DirectedGraph buildGraph(Body b);

  /**
   * Method that will draw a {@link DotGraph} representation of the control flow in this type of graph. This method is
   * intended for use within {@link soot.tools.CFGViewer CFGViewer}.
   *
   * @param drawer
   *          The {@link CFGToDotGraph} object that will draw the graph.
   *
   * @param g
   *          The graph to draw.
   *
   * @param b
   *          The body associated with the graph, g.
   *
   * @return a DotGraph visualizing the control flow in g.
   */
  public abstract DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b);

  private CFGGraphType(String name) {
    super(name);
  }

  /**
   * Returns the CFGGraphType identified by the passed name.
   *
   * @param name
   *          A {@link String} identifying the graph type.
   *
   * @return A {@link CFGGraphType} object whose {@link #buildGraph()} method will create the desired sort of control flow
   *         graph and whose {@link #drawGraph} method will produce a {@link DotGraph} corresponding to the graph.
   */
  public static CFGGraphType getGraphType(String option) {
    return (CFGGraphType) graphTypeOptions.match(option);
  }

  /**
   * Returns a string containing the names of all the available {@link CFGGraphType}s, separated by '|' characters.
   *
   * @param initialIndent
   *          The number of blank spaces to insert at the beginning of the returned string. Ignored if negative.
   *
   * @param rightMargin
   *          If positive, newlines will be inserted to try to keep the length of each line in the returned string less than
   *          or equal to rightMargin.
   *
   * @param hangingIndent
   *          If positive, this number of spaces will be inserted immediately after each newline inserted to respect the
   *          rightMargin.
   */
  public static String help(int initialIndent, int rightMargin, int hangingIndent) {
    return graphTypeOptions.help(initialIndent, rightMargin, hangingIndent);
  }

  public static final CFGGraphType BRIEF_UNIT_GRAPH = new CFGGraphType("BriefUnitGraph") {
    public DirectedGraph buildGraph(Body b) {
      return new BriefUnitGraph(b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType EXCEPTIONAL_UNIT_GRAPH = new CFGGraphType("ExceptionalUnitGraph") {
    public DirectedGraph buildGraph(Body b) {
      return new ExceptionalUnitGraph(b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG((ExceptionalUnitGraph) g);
    }
  };

  public static final CFGGraphType COMPLETE_UNIT_GRAPH = new CFGGraphType("CompleteUnitGraph") {
    public DirectedGraph buildGraph(Body b) {
      return new CompleteUnitGraph(b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG((CompleteUnitGraph) g);
    }
  };

  public static final CFGGraphType TRAP_UNIT_GRAPH = new CFGGraphType("TrapUnitGraph") {
    public DirectedGraph buildGraph(Body b) {
      return new TrapUnitGraph(b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType CLASSIC_COMPLETE_UNIT_GRAPH = new CFGGraphType("ClassicCompleteUnitGraph") {
    public DirectedGraph buildGraph(Body b) {
      return new ClassicCompleteUnitGraph(b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType BRIEF_BLOCK_GRAPH = new CFGGraphType("BriefBlockGraph") {
    public DirectedGraph buildGraph(Body b) {
      return new BriefBlockGraph(b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType EXCEPTIONAL_BLOCK_GRAPH = new CFGGraphType("ExceptionalBlockGraph") {
    public DirectedGraph buildGraph(Body b) {
      return new ExceptionalBlockGraph(b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG((ExceptionalBlockGraph) g);
    }
  };

  public static final CFGGraphType COMPLETE_BLOCK_GRAPH = new CFGGraphType("CompleteBlockGraph") {
    public DirectedGraph buildGraph(Body b) {
      return new CompleteBlockGraph(b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType CLASSIC_COMPLETE_BLOCK_GRAPH = new CFGGraphType("ClassicCompleteBlockGraph") {
    public DirectedGraph buildGraph(Body b) {
      return new ClassicCompleteBlockGraph(b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType ARRAY_REF_BLOCK_GRAPH = new CFGGraphType("ArrayRefBlockGraph") {
    public DirectedGraph buildGraph(Body b) {
      return new ArrayRefBlockGraph(b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType ZONED_BLOCK_GRAPH = new CFGGraphType("ZonedBlockGraph") {
    public DirectedGraph buildGraph(Body b) {
      return new ZonedBlockGraph(b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  private static DirectedGraph loadAltGraph(String className, Body b) {
    try {
      Class graphClass = AltClassLoader.v().loadClass(className);
      Class[] paramTypes = new Class[] { Body.class };
      Constructor constructor = graphClass.getConstructor(paramTypes);
      DirectedGraph result = (DirectedGraph) constructor.newInstance(new Object[] { b });
      return result;
    }
    // Turn class loading exceptions into RuntimeExceptions, so callers
    // don't need to declare them: perhaps a shoddy tactic.
    catch (ClassNotFoundException e) {
      if (DEBUG) {
        logger.error(e.getMessage(), e);
      }
      throw new IllegalArgumentException("Unable to find " + className + " in alternate classpath: " + e.getMessage());
    } catch (NoSuchMethodException e) {
      if (DEBUG) {
        logger.error(e.getMessage(), e);
      }
      throw new IllegalArgumentException("There is no " + className + "(Body) constructor: " + e.getMessage());
    } catch (InstantiationException e) {
      if (DEBUG) {
        logger.error(e.getMessage(), e);
      }
      throw new IllegalArgumentException(
          "Unable to instantiate " + className + " in alternate classpath: " + e.getMessage());
    } catch (IllegalAccessException e) {
      if (DEBUG) {
        logger.error(e.getMessage(), e);
      }
      throw new IllegalArgumentException(
          "Unable to access " + className + "(Body) in alternate classpath: " + e.getMessage());
    } catch (InvocationTargetException e) {
      if (DEBUG) {
        logger.error(e.getMessage(), e);
      }
      throw new IllegalArgumentException(
          "Unable to invoke " + className + "(Body) in alternate classpath: " + e.getMessage());
    }
  }

  public static final CFGGraphType ALT_BRIEF_UNIT_GRAPH = new CFGGraphType("AltBriefUnitGraph") {
    public DirectedGraph buildGraph(Body b) {
      return loadAltGraph("soot.toolkits.graph.BriefUnitGraph", b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType ALT_COMPLETE_UNIT_GRAPH = new CFGGraphType("AltCompleteUnitGraph") {
    public DirectedGraph buildGraph(Body b) {
      return loadAltGraph("soot.toolkits.graph.CompleteUnitGraph", b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType ALT_TRAP_UNIT_GRAPH = new CFGGraphType("AltTrapUnitGraph") {
    public DirectedGraph buildGraph(Body b) {
      return loadAltGraph("soot.toolkits.graph.TrapUnitGraph", b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType ALT_ARRAY_REF_BLOCK_GRAPH = new CFGGraphType("AltArrayRefBlockGraph") {
    public DirectedGraph buildGraph(Body b) {
      return loadAltGraph("soot.toolkits.graph.ArrayRefBlockGraph", b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType ALT_BRIEF_BLOCK_GRAPH = new CFGGraphType("AltBriefBlockGraph") {
    public DirectedGraph buildGraph(Body b) {
      return loadAltGraph("soot.toolkits.graph.BriefBlockGraph", b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType ALT_COMPLETE_BLOCK_GRAPH = new CFGGraphType("AltCompleteBlockGraph") {
    public DirectedGraph buildGraph(Body b) {
      return loadAltGraph("soot.toolkits.graph.CompleteBlockGraph", b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  public static final CFGGraphType ALT_ZONED_BLOCK_GRAPH = new CFGGraphType("AltZonedBlockGraph") {
    public DirectedGraph buildGraph(Body b) {
      return loadAltGraph("soot.toolkits.graph.ZonedBlockGraph", b);
    }

    public DotGraph drawGraph(CFGToDotGraph drawer, DirectedGraph g, Body b) {
      return drawer.drawCFG(g, b);
    }
  };

  private final static CFGOptionMatcher graphTypeOptions = new CFGOptionMatcher(new CFGGraphType[] { BRIEF_UNIT_GRAPH,
      EXCEPTIONAL_UNIT_GRAPH, COMPLETE_UNIT_GRAPH, TRAP_UNIT_GRAPH, CLASSIC_COMPLETE_UNIT_GRAPH, BRIEF_BLOCK_GRAPH,
      EXCEPTIONAL_BLOCK_GRAPH, COMPLETE_BLOCK_GRAPH, CLASSIC_COMPLETE_BLOCK_GRAPH, ARRAY_REF_BLOCK_GRAPH, ZONED_BLOCK_GRAPH,
      ALT_ARRAY_REF_BLOCK_GRAPH, ALT_BRIEF_UNIT_GRAPH, ALT_COMPLETE_UNIT_GRAPH, ALT_TRAP_UNIT_GRAPH, ALT_BRIEF_BLOCK_GRAPH,
      ALT_COMPLETE_BLOCK_GRAPH, ALT_ZONED_BLOCK_GRAPH, });
}