org.jamplate.model

Class Memory

java.lang.Object

org.jamplate.model.Memory

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class Memory
extends java.lang.Object
implements java.io.Closeable

The memory is a structure that saves the variables at the runtime.

Since:

0.2.0 ~2021.05.21

Version:

0.2.0

Author:

LSafer

Constructor Summary

Constructors

Constructor and Description
Memory() Construct a new empty memory.
Memory(@NotNull Memory memory) Construct a new copy of the given memory.

Method Summary

Modifier and Type	Method and Description
void	close()
Value	compute(@NotNull java.lang.String address, @NotNull java.util.function.UnaryOperator<Value> operator) Replace the value at the given address with the result of invoking the given operator with the current value.
@NotNull Frame	dumpFrame() Dump the stack and the heap of the current frame to frame before it.
@NotNull Value	get(@NotNull java.lang.String address) Return the value allocated at the given address in this memory.
@NotNull java.lang.Appendable	getConsole() Return current set console appendable.
@NotNull Frame	getFrame() Return the current last frame.
@NotNull Frame[]	getFrames() Return an array containing the current frames in this memory.
@NotNull Tree[]	getStackTrace() Build the current stack trace of trees.
@NotNull Value	pop() Return and remove the last pushed value to the stack.
Frame	popFrame() Pop the current stack frame.
void	print(@NotNull java.lang.CharSequence text) Print the given text to the console.
void	push(@NotNull Value value) Push the given value to the stack part of this memory.
void	pushFrame() Push a new frame.
void	pushFrame(@NotNull Frame frame) Push the given frame in this memory.
void	set(@NotNull java.lang.String address, @NotNull Value value) Set the value at the given address to be the given value.
void	setConsole(@NotNull java.lang.Appendable console) Set the console to be the given console.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Memory

public Memory()

Construct a new empty memory.

Since:

0.2.0 ~2021.05.21

Memory

public Memory(@NotNull
              @NotNull Memory memory)

Construct a new copy of the given memory.

Parameters:

memory - the memory to be copied.

Throws:

java.lang.NullPointerException - if the given memory is null.

Since:

0.2.0 ~2021.05.23

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

compute

@Contract(mutates="this")
public Value compute(@NotNull
                                                @NotNull java.lang.String address,
                                                @NotNull
                                                @NotNull java.util.function.UnaryOperator<Value> operator)

Replace the value at the given address with the result of invoking the given operator with the current value.
If the given operator thrown any exception when invoked by this method. The thrown exception will fall throw this method with nothing changed.
The computing will be performed on the last frame that contain an allocation to the given address. If no frame has an allocation to the given address then the result of the computation will be store in the base frame.

Parameters:

address - the address to replace the value at.

operator - the function to be invoked to acquire the replacement value.

Returns:

the computed value.

Throws:

java.lang.NullPointerException - if the given address or operator is null.

Since:

0.2.0 ~2021.05.21

dumpFrame

@NotNull
 @Contract(mutates="this")
public @NotNull Frame dumpFrame()

Dump the stack and the heap of the current frame to frame before it. If the current frame is the base frame, then a copy of the base from will be returned.

Returns:

the dumped frame.

Since:

0.2.0 ~2021.05.23

get

@NotNull
 @Contract(pure=true)
public @NotNull Value get(@NotNull
                                                           @NotNull java.lang.String address)

Return the value allocated at the given address in this memory.
The value is returned from the last frame that has an allocation in the given address.

Parameters:

address - the address to be read.

Returns:

the value at the given address. Or Value.NULL if no value was allocated there.

Throws:

java.lang.NullPointerException - if the given address is null.

Since:

0.2.0 ~2021.05.21

getConsole

@NotNull
 @Contract(pure=true)
public @NotNull java.lang.Appendable getConsole()

Return current set console appendable.

Returns:

the current console.

Since:

0.2.0 ~2021.05.23

getFrame

@NotNull
 @Contract(pure=true)
public @NotNull Frame getFrame()

Return the current last frame.

Returns:

the current frame.

Since:

0.2.0 ~2021.05.23

getFrames

@NotNull
 @Contract(value="->new",
          pure=true)
public @NotNull Frame[] getFrames()

Return an array containing the current frames in this memory.

Returns:

an array of the current frames.

Since:

0.2.0 ~2021.05.23

getStackTrace

@NotNull
 @Contract(pure=true)
public @NotNull Tree[] getStackTrace()

Build the current stack trace of trees.

Returns:

the current stack trace.

Since:

0.2.0 ~2021.05.31

pop

@NotNull
 @Contract(mutates="this")
public @NotNull Value pop()

Return and remove the last pushed value to the stack.
The stack of the last frame will be modified.

Returns:

the last value pushed to the stack. Or Value.NULL if the stack was empty.

Since:

0.2.0 ~2021.05.21

popFrame

@Contract(mutates="this")
public Frame popFrame()

Pop the current stack frame. Popping the stack frame will result to this memory representing the frame previous to the last pushed frame. If the base frame to be popped, then the base frame will be replaced with a new one instead of popped.

Returns:

the popped frame.

Since:

0.2.0 ~2021.05.21

print

@Contract(mutates="this")
public void print(@NotNull
                                             @NotNull java.lang.CharSequence text)

Print the given text to the console.
Note: the console is the buffer containing the output of the execution of the instruction.

Parameters:

text - the text to be printed.

Throws:

java.lang.NullPointerException - if the given text is null.

java.io.IOError - if an error occurred while writing to the console.

Since:

0.2.0 ~2021.05.21

push

@Contract(mutates="this")
public void push(@NotNull
                                            @NotNull Value value)

Push the given value to the stack part of this memory.
The value will be pushed to the stack of the last frame.

Parameters:

value - the value to be pushed.

Throws:

java.lang.NullPointerException - if the given value is null.

Since:

0.2.0 ~2021.05.21

pushFrame

@Contract(mutates="this")
public void pushFrame()

Push a new frame.

Since:

0.2.0 ~2021.05.23

pushFrame

@Contract(mutates="this")
public void pushFrame(@NotNull
                                                 @NotNull Frame frame)

Push the given frame in this memory.

Parameters:

frame - the frame to be pushed.

Throws:

java.lang.NullPointerException - if the given frame is null.

Since:

0.2.0 ~2021.05.21

set

@Contract(mutates="this")
public void set(@NotNull
                                           @NotNull java.lang.String address,
                                           @NotNull
                                           @NotNull Value value)

Set the value at the given address to be the given value.
The value will be allocated at the heap of the first frame.

Parameters:

address - the address to set the value to.

value - the value to be set at the given address.

Throws:

java.lang.NullPointerException - if the given address or value is null.

Since:

0.2.0 ~2021.05.21

setConsole

@Contract(mutates="this")
public void setConsole(@NotNull
                                                  @NotNull java.lang.Appendable console)

Set the console to be the given console.

Parameters:

console - the new console to be set.

Throws:

java.lang.NullPointerException - if the given console is null.

Since:

0.2.0 ~2021.05.23