/*
 * Tai-e: A Static Analysis Framework for Java
 *
 * Copyright (C) 2022 Tian Tan <tiantan@nju.edu.cn>
 * Copyright (C) 2022 Yue Li <yueli@nju.edu.cn>
 *
 * 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 <https://www.gnu.org/licenses/>.
 */

package pascal.taie.analysis.pta.core.cs.context;

/**
 * Factory of contexts, which provides convenient APIs to create contexts.
 *
 * @param <T> type of elements of created contexts.
 */
public interface ContextFactory<T> {

    /**
     * @return the empty context.
     */
    Context getEmptyContext();

    /**
     * @return the context with one element.
     */
    Context make(T elem);

    /**
     * @return the context that consists of given elements.
     */
    Context make(T... elems);

    /**
     * @return a context with last k elements of given context.
     */
    Context makeLastK(Context context, int k);

    /**
     * Constructs a context by appending a context element to a parent context.
     * The length of the resulting context will be restricted by given limit.
     *
     * @return the resulting context.
     */
    Context append(Context parent, T elem, int limit);
}
