/*
 * Copyright (c) 2007 IBM Corporation.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 */
package com.ibm.wala.cfg;

import com.ibm.wala.util.graph.NumberedGraph;
import java.util.Collection;
import java.util.List;

public interface MinimalCFG<T> extends NumberedGraph<T> {

  /** Return the entry basic block in the CFG */
  T entry();

  /** @return the synthetic exit block for the cfg */
  T exit();

  /**
   * The order of blocks returned must indicate the exception-handling scope. So the first block is
   * the first candidate catch block, and so on. With this invariant one can compute the exceptional
   * control flow for a given exception type.
   *
   * @return the basic blocks which may be reached from b via exceptional control flow
   */
  List<T> getExceptionalSuccessors(T b);

  /**
   * The order of blocks returned should be arbitrary but deterministic.
   *
   * @return the basic blocks which may be reached from b via normal control flow
   */
  Collection<T> getNormalSuccessors(T b);

  /**
   * The order of blocks returned should be arbitrary but deterministic.
   *
   * @return the basic blocks from which b may be reached via exceptional control flow
   */
  Collection<T> getExceptionalPredecessors(T b);

  /**
   * The order of blocks returned should be arbitrary but deterministic.
   *
   * @return the basic blocks from which b may be reached via normal control flow
   */
  Collection<T> getNormalPredecessors(T b);
}
