pascal.taie.analysis.dataflow.fact.MapFact Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tai-e Show documentation
An easy-to-learn/use static analysis framework for Java
The newest version!
/*
 * Tai-e: A Static Analysis Framework for Java
 *
 * Copyright (C) 2022 Tian Tan 
 * Copyright (C) 2022 Yue Li 
 *
 * This file is part of Tai-e.
 *
 * Tai-e 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 3
 * of the License, or (at your option) any later version.
 *
 * Tai-e 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 Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Tai-e. If not, see .
 */

package pascal.taie.analysis.dataflow.fact;

import pascal.taie.util.Copyable;
import pascal.taie.util.collection.Maps;

import java.util.Comparator;
import java.util.ConcurrentModificationException;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * Represents map-like data-flow facts.
 *
 * @param  type of keys
 * @param  type of values
 */
public class MapFact implements Copyable> {

    /**
     * The map holding the mappings of this MapFact.
     */
    protected final Map map;

    /**
     * Constructs a new MapFact with the same mappings as specified Map.
     *
     * @param map the map whose mappings are to be placed in this map.
     */
    public MapFact(Map map) {
        this.map = Maps.newHybridMap(map);
    }

    /**
     * @return the value to which the specified key is mapped,
     * or null if this map contains no mapping for the key.
     */
    public V get(K key) {
        return map.get(key);
    }

    /**
     * Updates the key-value mapping in this fact.
     *
     * @return if the update changes this fact.
     */
    public boolean update(K key, V value) {
        return !Objects.equals(map.put(key, value), value);
    }

    /**
     * Removes the key-value mapping for given key.
     *
     * @return the previous value associated with key,
     * or null if there was no mapping for key.
     */
    public V remove(K key) {
        return map.remove(key);
    }

    /**
     * Copies the content from given fact to this fact.
     *
     * @return true if this fact changed as a result of the call, otherwise false.
     */
    public boolean copyFrom(MapFact fact) {
        boolean changed = false;
        for (Map.Entry entry : fact.map.entrySet()) {
            changed |= update(entry.getKey(), entry.getValue());
        }
        return changed;
    }

    /**
     * Creates and returns a copy of this fact.
     */
    @Override
    public MapFact copy() {
        return new MapFact<>(this.map);
    }

    /**
     * Clears all content in this fact.
     */
    public void clear() {
        map.clear();
    }

    /**
     * @return a {@link Set} view of the keys contained in this fact.
     */
    public Set keySet() {
        return map.keySet();
    }

    /**
     * @return all entries (key-value mappings) in this fact.
     */
    public Stream> entries() {
        return map.entrySet().stream();
    }

    /**
     * Performs the given action for each entry(key-value mapping) in this fact
     * until all entries have been processed or the action throws an exception.
     *
     * @param action the action to be performed for each entry.
     */
    public void forEach(BiConsumer action) {
        Objects.requireNonNull(action);
        entries().forEach(entry -> {
            K k;
            V v;
            try {
                k = entry.getKey();
                v = entry.getValue();
            } catch (IllegalStateException ise) {
                // this usually means the entry is no longer in the map.
                throw new ConcurrentModificationException(ise);
            }
            action.accept(k, v);
        });
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        MapFact that = (MapFact) o;
        return map.equals(that.map);
    }

    @Override
    public int hashCode() {
        return map.hashCode();
    }

    @Override
    public String toString() {
        // Sort key-value pairs by key's string representation, so that the
        // fact representation is stable across executions. This is useful
        // for comparing expected results and the ones given by the analysis.
        return "{" + entries()
                .sorted(Comparator.comparing(e -> e.getKey().toString()))
                .map(e -> e.getKey() + "=" + e.getValue())
                .collect(Collectors.joining(", ")) + "}";
    }
}