pascal.taie.config.ConfigManager 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.config;

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

import java.util.ArrayDeque;
import java.util.Collections;
import java.util.Deque;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static pascal.taie.util.collection.Maps.newMap;

/**
 * Manages a collection of {@link AnalysisConfig}.
 */
public class ConfigManager {

    /**
     * Map from analysis id to corresponding AnalysisConfig.
     */
    private final Map configs = Maps.newLinkedHashMap();

    /**
     * Map from AnalysisConfig to its required AnalysisConfigs.
     */
    private final Map> requires = newMap();

    public ConfigManager(List configs) {
        configs.forEach(this::addConfig);
    }

    private void addConfig(AnalysisConfig config) {
        if (configs.containsKey(config.getId())) {
            throw new ConfigException("There are multiple analyses for the same id " +
                    config.getId() + " in " + Configs.getAnalysisConfigURL());
        }
        configs.put(config.getId(), config);
    }

    /**
     * Given an analysis id, returns the corresponding AnalysisConfig.
     *
     * @throws ConfigException when the manager does not contain
     *                         the AnalysisConfig for the given id.
     */
    AnalysisConfig getConfig(String id) {
        AnalysisConfig config = configs.get(id);
        if (config == null) {
            throw new ConfigException("Analysis \"" + id + "\" is not found in " +
                    Configs.getAnalysisConfigURL());
        }
        return config;
    }

    /**
     * Overwrites the AnalysisConfig.options by corresponding PlanConfig.options.
     */
    public void overwriteOptions(List planConfigs) {
        planConfigs.forEach(pc ->
                getConfig(pc.getId()).getOptions()
                        .update(pc.getOptions()));
    }

    /**
     * Obtains the required analyses of given analysis (represented by AnalysisConfig).
     * This computation is based on the options given in PlanConfig,
     * thus this method should be called after invoking {@link #overwriteOptions}.
     * NOTE: we should obtain required configs by this method, instead of
     * {@link AnalysisConfig#getRequires()}.
     */
    List getRequiredConfigs(AnalysisConfig config) {
        return requires.computeIfAbsent(config, c ->
                c.getRequires()
                        .stream()
                        .filter(required -> {
                            String conditions = Configs.extractConditions(required);
                            return Configs.satisfyConditions(conditions, c.getOptions());
                        })
                        .map(required -> getConfig(Configs.extractId(required)))
                        .toList());
    }

    /**
     * @return all configs (directly and indirectly) required by the given config
     */
    Set getAllRequiredConfigs(AnalysisConfig config) {
        Set visited = Sets.newHybridSet();
        Deque queue = new ArrayDeque<>(
                getRequiredConfigs(config));
        while (!queue.isEmpty()) {
            AnalysisConfig curr = queue.pop();
            visited.add(curr);
            getRequiredConfigs(curr)
                    .stream()
                    .filter(c -> !visited.contains(c))
                    .forEach(queue::add);
        }
        return Collections.unmodifiableSet(visited);
    }
}