org.protelis.vm.CodePathFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of protelis-interpreter Show documentation

The Protelis language interpreter

There is a newer version: 17.6.0

/*
 * Copyright (C) 2021, Danilo Pianini and contributors listed in the project's build.gradle.kts or pom.xml file.
 *
 * This file is part of Protelis, and is distributed under the terms of the GNU General Public License,
 * with a linking exception, as described in the file LICENSE.txt in this project's top directory.
 */

package org.protelis.vm;

import java.io.Serializable;

import gnu.trove.list.TIntList;
import gnu.trove.stack.TIntStack;

/**
 * A function which is able to build a {@link CodePath} given the current
 * Protelis stack status.
 */
@FunctionalInterface
public interface CodePathFactory extends Serializable {

    /**
     * Creates a {@link CodePath} for the current stack status.
     * 
     * @param callStackIdentifiers the stack frames identifiers
     * @param callStackSizes       the stack frame sizes, by frame
     * @return a new {@link CodePath}
     */
    CodePath createCodePath(TIntList callStackIdentifiers, TIntStack callStackSizes);
}