org.jamplate.model.function

Interface Compiler

All Known Implementing Classes:

CombineCompiler, ExclusiveCompiler, FallbackCompiler, FilterByKindCompiler, FirstCompileCompiler, FlattenCompiler, MandatoryCompiler, ToIdleCompiler, ToIdleWhitespaceCompiler, ToPushConstCompiler, ToPushConstUnescapeCompiler, ToPushEvalAddrCompiler, ToReprntConstCompiler

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Compiler

A compiler is a function that compiles Trees into Instructions depending on the state of the trees and compilations provided to it.

Since:

0.2.0 ~2021.05.21

Version:

0.2.0

Author:

LSafer

Method Summary

Modifier and Type	Method and Description
@Nullable Instruction	compile(@NotNull Compiler compiler, @NotNull Compilation compilation, @NotNull Tree tree) Compile the given tree and the trees in it.

Method Detail

compile

@Nullable
 @Contract(pure=true)
@Nullable Instruction compile(@NotNull
                                                                @NotNull Compiler compiler,
                                                                @NotNull
                                                                @NotNull Compilation compilation,
                                                                @NotNull
                                                                @NotNull Tree tree)

Compile the given tree and the trees in it. If this compiler cannot If this compiler encountered a tree that it cannot compile, this compiler will pass it to the given fallback compiler with the given compiler as the fallback compiler.
Unless this compiler want to change the default compiler, this compiler will invoke the given compiler with itself as the default compiler.

Parameters:

compiler - a compiler this compiler must use when dealing with other entities this compiler cannot compile.

compilation - the compilation the given tree was taken from.

tree - the tree to parse any instruction in it.

Returns:

the compiled instruction. Or null if this compiler failed to compile the given tree into an instruction.

Throws:

java.lang.NullPointerException - if the given compiler or tree or executable or compiler is null.

CompileException - if this compiler detected a wrong unforgivable pattern in the given tree;

java.io.IOError - if any I/O error occurs.

Since:

0.2.0 ~2021.05.21