---

ControlFlowAnnotation.java

package edu.ksu.cis.bandera.annotation;

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Bandera, a Java(TM) analysis and transformation toolkit           *
 * Copyright (C) 1999, 2000   Robby (robby@cis.ksu.edu)              *
 * All rights reserved.                                              *
 *                                                                   *
 * This work was done as a project in the SAnToS Laboratory,         *
 * Department of Computing and Information Sciences, Kansas State    *
 * University, USA (http://www.cis.ksu.edu/santos).                  *
 * 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 toolkit; 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 SAnToS projects, please visit the web-site *
 *                http://www.cis.ksu.edu/santos                      *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
import edu.ksu.cis.bandera.jjjc.node.*;
import ca.mcgill.sable.soot.jimple.*;
import java.util.*;
public abstract class ControlFlowAnnotation extends Annotation {
    // test exp is stored in annotation
    protected boolean indefinite = false;
    protected Annotation blockAnnotation = null;
/**
 * 
 * @param node Node
 */
public ControlFlowAnnotation(Node node) {
    super(node);
}
/**
 * 
 * @return ca.mcgill.sable.soot.jimple.Stmt
 */
public abstract Stmt getBackpointStmt();
/**
 * 
 * @return edu.ksu.cis.bandera.annotations.Annotation
 */
public Annotation getBlockAnnotation() {
    return blockAnnotation;
}
/**
 * 
 * @return edu.ksu.cis.bandera.annotations.Annotation
 * @param stmt ca.mcgill.sable.soot.jimple.Stmt
 */
public Annotation getContainingAnnotation(Stmt stmt) throws AnnotationException {
    Vector result = new Vector();

    Annotation a = super.getContainingAnnotation(stmt);
    if (a != null) result.addElement(a);

    if (blockAnnotation != null) {
        a = blockAnnotation.getContainingAnnotation(stmt);
        if (a != null) result.addElement(a);
    }
    
    int size = result.size();
    if (size == 0) return null;
    else if (size == 1) return (Annotation) result.elementAt(0);
    throw new AnnotationException("Statement " + stmt + " is contained in two or more annotations");
}
/**
 * 
 * @return ca.mcgill.sable.soot.jimple.Stmt[]
 */
public Stmt[] getTestStatements() {
    return toArray();
}
/**
 * 
 * @return boolean
 */
public boolean isIndefinite() {
    return indefinite;
}
/**
 * 
 * @return boolean
 * @param stmt ca.mcgill.sable.soot.jimple.Stmt
 */
public boolean removeStmt(Stmt stmt) throws AnnotationException {
    Annotation a = getContainingAnnotation(stmt);
    if (a == null) return false;
    else if (a == this) return remove(stmt);
    else return a.removeStmt(stmt);
}
/**
 * 
 * @return boolean
 * @param stmt ca.mcgill.sable.soot.jimple.Stmt
 */
public boolean removeStmtByMark(Stmt stmt) throws AnnotationException {
    Annotation a = getContainingAnnotation(stmt);
    if (a == null) return false;
    else if (a == this) return removeByMark(stmt);
    else return a.removeStmtByMark(stmt);
}
/**
 * 
 * @return boolean
 * @param oldStmt ca.mcgill.sable.soot.jimple.Stmt
 * @param newStmt ca.mcgill.sable.soot.jimple.Stmt
 */
public boolean replaceStmt(Stmt oldStmt, Stmt newStmt) throws AnnotationException {
    Annotation a = getContainingAnnotation(oldStmt);
    if (a == null) return false;
    else if (a == this) return replace(oldStmt, newStmt);
    else return a.replaceStmt(oldStmt, newStmt);
}
/**
 * 
 * @return boolean
 * @param oldStmt ca.mcgill.sable.soot.jimple.Stmt
 * @param newStmt ca.mcgill.sable.soot.jimple.Stmt
 */
public boolean replaceStmtByMark(Stmt oldStmt, Stmt newStmt) throws AnnotationException {
    Annotation a = getContainingAnnotation(oldStmt);
    if (a == null) return false;
    else if (a == this) return replaceByMark(oldStmt, newStmt);
    else return a.replaceStmtByMark(oldStmt, newStmt);
}
/**
 * 
 * @param annotation edu.ksu.cis.bandera.annotations.Annotation
 */
public void setBlockAnnotation(Annotation annotation) {
    blockAnnotation = annotation;
    blockAnnotation.setParent(this);
}
/**
 * 
 * @param indefinite boolean
 */
public void setIndefinite(boolean indefinite) {
    this.indefinite = indefinite;
}
/**
 * 
 * @param body ca.mcgill.sable.soot.jimple.JimpleBody
 */
public void validate(JimpleBody body) {
    super.validate(body);
    if (blockAnnotation != null) blockAnnotation.validate(body);
}
}

---