proguard.analysis.cpa.interfaces.ProgramLocationDependentTransferRelation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of proguard-core Show documentation

ProGuardCORE is a free library to read, analyze, modify, and write Java class files.

There is a newer version: 9.1.6

/*
 * ProGuardCORE -- library to process Java bytecode.
 *
 * Copyright (c) 2002-2022 Guardsquare NV
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package proguard.analysis.cpa.interfaces;

import static proguard.exception.ErrorId.ANALYSIS_PROGRAM_LOCATION_DEPENDENT_TRANSFER_RELATION_STATE_UNSUPPORTED;

import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import proguard.classfile.Signature;
import proguard.exception.ProguardCoreException;

/**
 * An interface for {@link TransferRelation}s that depend on the {@link
 * proguard.analysis.cpa.defaults.Cfa} location for which the successor can be defined for the edges
 * of the current location.
 *
 * @author Carlo Alberto Pozzoli
 */
public interface ProgramLocationDependentTransferRelation<
        CfaNodeT extends CfaNode,
        CfaEdgeT extends CfaEdge,
        SignatureT extends Signature>
    extends TransferRelation {

  /** Computes the successor states for the CFA {@code edge}. */
  Collection generateEdgeAbstractSuccessors(
      AbstractState abstractState, CfaEdgeT edge, Precision precision);

  default Collection wrapAbstractSuccessorInCollection(
      AbstractState abstractState) {
    if (abstractState == null) {
      return Collections.emptyList();
    }
    return Collections.singleton(abstractState);
  }
  // implementations for TransferRelation

  @Override
  default Collection generateAbstractSuccessors(
      AbstractState abstractState, Precision precision) {
    if (!(abstractState instanceof ProgramLocationDependent)) {
      throw new ProguardCoreException.Builder(
              "%s does not support %s",
              ANALYSIS_PROGRAM_LOCATION_DEPENDENT_TRANSFER_RELATION_STATE_UNSUPPORTED)
          .errorParameters(getClass().getName(), abstractState.getClass().getName())
          .build();
    }
    ProgramLocationDependent state =
        (ProgramLocationDependent) abstractState;
    Set successors = new LinkedHashSet<>();
    for (CfaEdgeT edge : getEdges(state)) {
      Collection edgeSuccessors =
          generateEdgeAbstractSuccessors(abstractState, edge, precision);
      if (edgeSuccessors != null) {
        successors.addAll(edgeSuccessors);
      }
    }
    return successors;
  }

  List getEdges(ProgramLocationDependent state);
}