pascal.taie.analysis.pta.plugin.taint.SinkPoint 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.pta.plugin.taint;

import pascal.taie.ir.stmt.Invoke;

import javax.annotation.Nonnull;
import java.util.Comparator;

/**
 * Represents a program location where taint objects flow to a sink.
 *
 * @param sinkCall call site of the sink method.
 * @param indexRef    index of the sensitive argument at {@code sinkCall}.
 */
record SinkPoint(Invoke sinkCall, IndexRef indexRef, Sink sink)
        implements Comparable {

    private static final Comparator COMPARATOR =
            Comparator.comparing(SinkPoint::sinkCall)
                    .thenComparing(SinkPoint::indexRef);

    @Override
    public int compareTo(@Nonnull SinkPoint other) {
        return COMPARATOR.compare(this, other);
    }

    @Override
    public String toString() {
        return sinkCall + "/" + indexRef;
    }
}