pascal.taie.analysis.exception.CatchResult 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.exception;

import pascal.taie.ir.stmt.Catch;
import pascal.taie.ir.stmt.Stmt;
import pascal.taie.language.type.ClassType;
import pascal.taie.util.collection.Maps;
import pascal.taie.util.collection.MultiMap;
import pascal.taie.util.collection.Sets;

import java.util.Map;
import java.util.Set;

public class CatchResult {

    private final Map> caughtImplicit = Maps.newHybridMap();

    private final MultiMap uncaughtImplicit
            = Maps.newMultiMap(Maps.newHybridMap());

    private final Map> caughtExplicit = Maps.newHybridMap();

    private final MultiMap uncaughtExplicit
            = Maps.newMultiMap(Maps.newHybridMap());

    void addCaughtImplicit(Stmt stmt, Catch catcher, ClassType exceptionType) {
        caughtImplicit.computeIfAbsent(stmt, s -> Maps.newMultiMap(Maps.newHybridMap()))
                .put(catcher, exceptionType);
    }

    void addUncaughtImplicit(Stmt stmt, ClassType exceptionType) {
        uncaughtImplicit.put(stmt, exceptionType);
    }

    /**
     * @return all exception types that may be implicitly thrown by given Stmt
     * and caught by its containing method. The result of the call is a map
     * from Catch statements to set of exception types that are caught
     * by the Catches.
     */
    public MultiMap getCaughtImplicitOf(Stmt stmt) {
        return caughtImplicit.getOrDefault(stmt, Maps.newMultiMap(Map.of()));
    }

    /**
     * @return the set of exception types that may be implicitly thrown
     * by given Stmt but not caught by its containing method.
     */
    public Set getUncaughtImplicitOf(Stmt stmt) {
        return uncaughtImplicit.get(stmt);
    }

    void addCaughtExplicit(Stmt stmt, Catch catcher, ClassType exceptionType) {
        caughtExplicit.computeIfAbsent(stmt, s -> Maps.newMultiMap())
                .put(catcher, exceptionType);
    }

    void addUncaughtExplicit(Stmt stmt, ClassType exceptionType) {
        uncaughtExplicit.put(stmt, exceptionType);
    }

    /**
     * @return all exception types that may be explicitly thrown by given Stmt
     * and caught by its containing method. The result of the call is a map
     * from Catch statements to set of exception types that are caught
     * by the Catches.
     */
    public MultiMap getCaughtExplicitOf(Stmt stmt) {
        return caughtExplicit.getOrDefault(stmt, Maps.newMultiMap());
    }

    /**
     * @return the set of exception types that may be explicitly thrown
     * by given Stmt but not caught by its containing method.
     */
    public Set getUncaughtExplicitOf(Stmt stmt) {
        return uncaughtExplicit.get(stmt);
    }

    /**
     * @return all exception types that may be implicitly or explicitly
     * thrown by given Stmt and caught by its containing method.
     * The result of the call is a map from Catch statements to set of
     * exception types that are caught by the Catches.
     */
    public MultiMap getCaughtOf(Stmt stmt) {
        MultiMap caught = Maps.newMultiMap();
        caught.putAll(getCaughtImplicitOf(stmt));
        caught.putAll(getCaughtExplicitOf(stmt));
        return caught;
    }

    /**
     * @return all exception types that may be implicitly or explicitly
     * thrown by given Stmt and cannot be caught by its containing method.
     */
    public Set getUncaughtOf(Stmt stmt) {
        Set uncaught = Sets.newSet();
        uncaught.addAll(getUncaughtImplicitOf(stmt));
        uncaught.addAll(getUncaughtExplicitOf(stmt));
        return uncaught;
    }
}