soot.Trap Maven / Gradle / Ivy
Show all versions of soot Show documentation
package soot;
/*-
* #%L
* Soot - a J*va Optimization Framework
* %%
* Copyright (C) 1997 - 1999 Raja Vallee-Rai
* %%
* 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.List;
/**
* A trap (exception catcher), used within Body classes. Intermediate representations must use an implementation of Trap to
* describe caught exceptions.
*/
public interface Trap extends UnitBoxOwner {
/**
*
* Returns the first trapped unit, unless this Trap does not trap any units at all.
*
*
*
* If this is a degenerate Trap which traps no units (which can occur if all the units originally trapped by
* the exception handler have been optimized away), returns an untrapped unit. The returned unit will likely be the first
* unit remaining after the point where the trapped units were once located, but the only guarantee provided is that for
* such an empty trap, getBeginUnit() will return the same value as {@link #getEndUnit()}.
*
*/
public Unit getBeginUnit();
/**
*
* Returns the unit following the last trapped unit (that is, the first succeeding untrapped unit in the underlying
* Chain), unless this Trap does not trap any units at all.
*
*
*
* In the case of a degenerate Trap which traps no units, returns the same untrapped unit as
* getBeginUnit()
*
*
*
* Note that a weakness of marking the end of the trapped region with the first untrapped unit is that Soot has no good
* mechanism for describing a Trap which traps the last unit in a method.
*
*/
public Unit getEndUnit();
/**
* Returns the unit handling the exception being trapped.
*/
public Unit getHandlerUnit();
/**
* Returns the box holding the unit returned by {@link #getBeginUnit()}.
*/
public UnitBox getBeginUnitBox();
/**
* Returns the box holding the unit returned by {@link #getEndUnit()}.
*/
public UnitBox getEndUnitBox();
/**
* Returns the box holding the exception handler unit.
*/
public UnitBox getHandlerUnitBox();
/**
* Returns the boxes for first, last, and handler units.
*/
@Override
public List getUnitBoxes();
/**
* Returns the exception being caught.
*/
public SootClass getException();
/**
* Sets the value to be returned by {@link #getBeginUnit()} to beginUnit.
*/
public void setBeginUnit(Unit beginUnit);
/**
* Sets the value to be returned by {@link #getEndUnit()} to endUnit.
*/
public void setEndUnit(Unit endUnit);
/**
* Sets the unit handling the exception to handlerUnit.
*/
public void setHandlerUnit(Unit handlerUnit);
/**
* Sets the exception being caught to exception.
*/
public void setException(SootClass exception);
/**
* Performs a shallow clone of this trap.
*/
public Object clone();
}