soot.tagkit.ImportantTagAggregator Maven / Gradle / Ivy

package soot.tagkit;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 2003 Ondrej Lhotak
 * %%
 * 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.LinkedList;

import soot.Unit;
import soot.baf.Inst;

/**
 * A tag aggregator that associates a tag with the most important instruction that is tagged with it. An instruction
 * is important if it contains a field or array reference, a method invocation, or an object allocation.
 */
public abstract class ImportantTagAggregator extends TagAggregator {
  /** Decide whether this tag should be aggregated by this aggregator. */
  public abstract boolean wantTag(Tag t);

  /** Return name of the resulting aggregated tag. */
  public abstract String aggregatedName();

  /** Decide whether this tag should be aggregated by this aggregator. */
  @Override
  public void considerTag(Tag t, Unit u, LinkedList tags, LinkedList units) {
    Inst i = (Inst) u;
    if (!(i.containsInvokeExpr() || i.containsFieldRef() || i.containsArrayRef() || i.containsNewExpr())) {
      return;
    }
    units.add(u);
    tags.add(t);
  }
}