proguard.analysis.cpa.jvm.witness.JvmHeapLocation 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.jvm.witness;

import java.util.Comparator;
import java.util.Objects;
import java.util.stream.Collectors;
import proguard.analysis.cpa.defaults.LatticeAbstractState;
import proguard.analysis.cpa.defaults.SetAbstractState;
import proguard.analysis.cpa.jvm.domain.reference.Reference;
import proguard.analysis.cpa.jvm.state.JvmAbstractState;

/**
 * The {@link JvmHeapLocation} is a memory location corresponding to a dynamic memory entity.
 *
 * @author Dmitry Ivanov
 */
public class JvmHeapLocation extends JvmMemoryLocation {

  public final SetAbstractState reference;
  public final String field;

  /**
   * Create a heap location.
   *
   * @param reference a reference to dynamic memory
   */
  public JvmHeapLocation(SetAbstractState reference, String field) {
    this.reference = reference;
    this.field = field;
  }

  // implementations for MemoryLocation

  @Override
  public  T extractValueOrDefault(
      JvmAbstractState abstractState, T defaultValue) {
    return (T) abstractState.getHeap().getFieldOrDefault(reference, field, defaultValue);
  }

  // implementations for Object

  @Override
  public boolean equals(Object obj) {
    if (!(obj instanceof JvmHeapLocation)) {
      return false;
    }
    JvmHeapLocation other = (JvmHeapLocation) obj;
    return reference.equals(other.reference);
  }

  @Override
  public int hashCode() {
    return Objects.hash(reference.hashCode());
  }

  @Override
  public String toString() {
    return "JvmHeapLocation("
        + reference.stream()
            .sorted(Comparator.comparingInt(Reference::hashCode))
            .collect(Collectors.toList())
        + (field.length() > 0 ? ", " + field + ")" : "");
  }
}