Name
Zero::Emulator - Assemble and emulate a program written in the Zero assembler programming language.
Synopsis
Say "hello world":
Start 1;
Out "hello World";
my $e = Execute;
is_deeply $e->out, ["hello World"];Description
Version 20230519.
The following sections describe the methods in each functional area of this module. For an alphabetic listing of all methods by name see Index.
Instruction Set
The instruction set used by the Zero assembler programming language.
Add($target, $s1, $s2)
Add the source locations together and store the result in the target area.
Parameter Description
1 $target Target address
2 $s1 Source one
3 $s2 Source twoExample:
if (1)
{Start 1;
my $a = Add 3, 2; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out $a;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
5
END
}
Array($source)
Create a new memory area and write its number into the address named by the target operand.
Parameter Description
1 $source Name of allocationExample:
if (1)
{Start 1;
my $a = Array "aaa"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Mov [$a, 0, "aaa"], 1;
Mov [$a, 1, "aaa"], 22;
Mov [$a, 2, "aaa"], 333;
my $n = ArraySize $a, "aaa";
Out "Array size:", $n; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
ArrayDump $a;
ForArray
{my ($i, $e, $check, $next, $end) = @_;
Out $i; Out $e;
} $a, "aaa";
Nop;
my $e = Execute(suppressOutput=>1);
is_deeply $e->heap(1), [1, 22, 333];
is_deeply $e->out, <<END if $testSet <= 2;
Array size: 3 # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
bless([1, 22, 333], "aaa")
0
1
1
22
2
333
END
is_deeply $e->out, <<END if $testSet > 2;
Array size: 3 # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
[1, 22, 333]
0
1
1
22
2
333
END
}
ArrayCountLess()
Count the number of elements in the array specified by the first source operand that are less than the element supplied by the second source operand and place the result in the target location.
Example:
if (1)
{Start 1;
my $a = Array "aaa";
Mov [$a, 0, "aaa"], 10;
Mov [$a, 1, "aaa"], 20;
Mov [$a, 2, "aaa"], 30;
Out ArrayIndex ($a, 30), ArrayIndex ($a, 20), ArrayIndex ($a, 10), ArrayIndex ($a, 15);
Out ArrayCountLess ($a, 35), ArrayCountLess ($a, 25), ArrayCountLess ($a, 15), ArrayCountLess ($a, 5); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out ArrayCountGreater($a, 35), ArrayCountGreater($a, 25), ArrayCountGreater($a, 15), ArrayCountGreater($a, 5);
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
3 2 1 0
3 2 1 0
0 1 2 3
END
}
ArrayCountGreater()
Count the number of elements in the array specified by the first source operand that are greater than the element supplied by the second source operand and place the result in the target location.
Example:
if (1)
{Start 1;
my $a = Array "aaa";
Mov [$a, 0, "aaa"], 10;
Mov [$a, 1, "aaa"], 20;
Mov [$a, 2, "aaa"], 30;
Out ArrayIndex ($a, 30), ArrayIndex ($a, 20), ArrayIndex ($a, 10), ArrayIndex ($a, 15);
Out ArrayCountLess ($a, 35), ArrayCountLess ($a, 25), ArrayCountLess ($a, 15), ArrayCountLess ($a, 5);
Out ArrayCountGreater($a, 35), ArrayCountGreater($a, 25), ArrayCountGreater($a, 15), ArrayCountGreater($a, 5); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
3 2 1 0
3 2 1 0
0 1 2 3
END
}
ArrayDump($target)
Dump an array.
Parameter Description
1 $target Array to dumpExample:
if (1)
{Start 1;
my $a = Array "aaa";
Mov [$a, 0, "aaa"], 1;
Mov [$a, 1, "aaa"], 22;
Mov [$a, 2, "aaa"], 333;
ArrayDump $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply eval($e->out), [1, 22, 333];
#say STDERR $e->block->codeToString;
is_deeply $e->block->codeToString, <<'END' if $testSet == 1;
0000 array \0 3
0001 mov [\0, 0, 3, 0] 1
0002 mov [\0, 1, 3, 0] 22
0003 mov [\0, 2, 3, 0] 333
0004 arrayDump \0
END
is_deeply $e->block->codeToString, <<'END' if $testSet == 2;
0000 array [undef, \0, 3, 0] [undef, 3, 3, 0] [undef, 0, 3, 0]
0001 mov [\0, 0, 3, 0] [undef, 1, 3, 0] [undef, 0, 3, 0]
0002 mov [\0, 1, 3, 0] [undef, 22, 3, 0] [undef, 0, 3, 0]
0003 mov [\0, 2, 3, 0] [undef, 333, 3, 0] [undef, 0, 3, 0]
0004 arrayDump [undef, \0, 3, 0] [undef, 0, 3, 0] [undef, 0, 3, 0]
END
}
ArrayIndex()
Find the 1 based index of the second source operand in the array referenced by the first source operand if it is present in the array else 0 into the target location. The business of returning -1 would have led to the confusion of "try catch" and we certainly do not want that.
Example:
if (1)
{Start 1;
my $a = Array "aaa";
Mov [$a, 0, "aaa"], 10;
Mov [$a, 1, "aaa"], 20;
Mov [$a, 2, "aaa"], 30;
Out ArrayIndex ($a, 30), ArrayIndex ($a, 20), ArrayIndex ($a, 10), ArrayIndex ($a, 15); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out ArrayCountLess ($a, 35), ArrayCountLess ($a, 25), ArrayCountLess ($a, 15), ArrayCountLess ($a, 5);
Out ArrayCountGreater($a, 35), ArrayCountGreater($a, 25), ArrayCountGreater($a, 15), ArrayCountGreater($a, 5);
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
3 2 1 0
3 2 1 0
0 1 2 3
END
}
ArraySize($area, $name)
The current size of an array.
Parameter Description
1 $area Location of area
2 $name Name of areaExample:
if (1)
{Start 1;
my $a = Array "aaa";
Mov [$a, 0, "aaa"], 1;
Mov [$a, 1, "aaa"], 22;
Mov [$a, 2, "aaa"], 333;
my $n = ArraySize $a, "aaa"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out "Array size:", $n;
ArrayDump $a;
ForArray
{my ($i, $e, $check, $next, $end) = @_;
Out $i; Out $e;
} $a, "aaa";
Nop;
my $e = Execute(suppressOutput=>1);
is_deeply $e->heap(1), [1, 22, 333];
is_deeply $e->out, <<END if $testSet <= 2;
Array size: 3
bless([1, 22, 333], "aaa")
0
1
1
22
2
333
END
is_deeply $e->out, <<END if $testSet > 2;
Array size: 3
[1, 22, 333]
0
1
1
22
2
333
END
}
Assert(%options)
Assert regardless.
Parameter Description
1 %options OptionsExample:
if (1)
{Start 1;
Assert; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
Assert failed # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
1 1 assert
END
}
AssertEq($a, $b, %options)
Assert two memory locations are equal.
Parameter Description
1 $a First memory address
2 $b Second memory address
3 %optionsExample:
if (1)
{Start 1;
Mov 0, 1;
AssertEq \0, 2; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
Assert 1 == 2 failed
1 2 assertEq
END
}
AssertFalse($a, %options)
Assert false.
Parameter Description
1 $a Source operand
2 %optionsExample:
if (1)
{Start 1;
AssertTrue 1;
AssertFalse 1; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1, trace=>1);
is_deeply $e->out, <<END;
1 0 1 assertTrue
AssertFalse 1 failed # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
1 2 assertFalse
2 1 1 assertFalse
END
}
AssertGe($a, $b, %options)
Assert are greater than or equal.
Parameter Description
1 $a First memory address
2 $b Second memory address
3 %optionsExample:
if (1)
{Start 1;
Mov 0, 1;
AssertGe \0, 2; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
Assert 1 >= 2 failed
1 2 assertGe
END
}
AssertGt($a, $b, %options)
Assert two memory locations are greater than.
Parameter Description
1 $a First memory address
2 $b Second memory address
3 %optionsExample:
if (1)
{Start 1;
Mov 0, 1;
AssertGt \0, 2; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
Assert 1 > 2 failed
1 2 assertGt
END
}
AssertLe($a, $b, %options)
Assert two memory locations are less than or equal.
Parameter Description
1 $a First memory address
2 $b Second memory address
3 %optionsExample:
if (1)
{Start 1;
Mov 0, 1;
AssertLe \0, 0; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
Assert 1 <= 0 failed
1 2 assertLe
END
}
AssertLt($a, $b, %options)
Assert two memory locations are less than.
Parameter Description
1 $a First memory address
2 $b Second memory address
3 %optionsExample:
if (1)
{Start 1;
Mov 0, 1;
AssertLt \0, 0; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
Assert 1 < 0 failed
1 2 assertLt
END
}
AssertNe($a, $b, %options)
Assert two memory locations are not equal.
Parameter Description
1 $a First memory address
2 $b Second memory address
3 %optionsExample:
if (1)
{Start 1;
Mov 0, 1;
AssertNe \0, 1; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
Assert 1 != 1 failed
1 2 assertNe
END
}
AssertTrue($a, %options)
Assert true.
Parameter Description
1 $a Source operand
2 %optionsExample:
if (1)
{Start 1;
AssertFalse 0;
AssertTrue 0; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1, trace=>1);
is_deeply $e->out, <<END;
1 0 1 assertFalse
AssertTrue 0 failed # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
1 2 assertTrue
2 1 1 assertTrue
END
}
Bad($bad)
A bad ending.
Parameter Description
1 $bad What to do on a bad endingExample:
if (1)
{Start 1;
Block
{my ($start, $good, $bad, $end) = @_;
Out 1;
Jmp $good;
}
Good
{Out 2;
},
Bad # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{Out 3;
};
Out 4;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
1
2
4
END
}
Block($block, %options)
Block of code that can either be restarted or come to a good or a bad ending.
Parameter Description
1 $block Block
2 %options OptionsExample:
if (1)
{Start 1;
Block # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{my ($start, $good, $bad, $end) = @_;
Out 1;
Jmp $good;
}
Good
{Out 2;
},
Bad
{Out 3;
};
Out 4;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
1
2
4
END
}
if (1)
{Start 1;
Block # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{my ($start, $good, $bad, $end) = @_;
Out 1;
Jmp $bad;
}
Good
{Out 2;
},
Bad
{Out 3;
};
Out 4;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
1
3
4
END
}
Call($p)
Call the subroutine at the target address.
Parameter Description
1 $p Procedure descriptionExample:
if (1)
{Start 1;
my $w = Procedure 'write', sub
{Out 1;
Return;
};
Call $w; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
1
END
}
if (1)
{Start 1;
my $w = Procedure 'write', sub
{my $a = ParamsGet 0;
Out $a;
Return;
};
ParamsPut 0, 999;
Call $w; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
999
END
}
if (1)
{Start 1;
my $w = Procedure 'write', sub
{ReturnPut 0, 999;
Return;
};
Call $w; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
ReturnGet \0, 0;
Out \0;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
999
END
}
if (1)
{Start 1;
my $a = Array "aaa";
Dump;
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Stack trace:
1 2 dump
END
}
if (1)
{Start 1;
my $a = Array "aaa";
my $i = Mov 1;
my $v = Mov 11;
ParamsPut 0, $a;
ParamsPut 1, $i;
ParamsPut 2, $v;
my $set = Procedure 'set', sub
{my $a = ParamsGet 0;
my $i = ParamsGet 1;
my $v = ParamsGet 2;
Mov [$a, \$i, 'aaa'], $v;
Return;
};
Call $set; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $V = Mov [$a, \$i, 'aaa'];
AssertEq $v, $V;
Out [$a, \$i, 'aaa'];
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
11
END
}
if (1)
{Start 1;
my $set = Procedure 'set', sub
{my $a = ParamsGet 0;
Out $a;
};
ParamsPut 0, 1; Call $set; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
ParamsPut 0, 2; Call $set; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
ParamsPut 0, 3; Call $set; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
1
2
3
END
}
Clear($target, $source, $source2)
Clear the first bytes of an area. The area is specified by the first element of the address, the number of locations to clear is specified by the second element of the target address.
Parameter Description
1 $target Target address to clear
2 $source Number of bytes to clear
3 $source2 Name of targetExample:
if (1)
{Start 1;
my $a = Array "aaa";
Clear $a, 10, 'aaa'; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1, maximumAreaSize=>10);
is_deeply $e->heap(1), [0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
}
Confess()
Confess with a stack trace showing the location both in the emulated code and in the code that produced the emulated code.
Example:
if (1)
{Start 1;
my $c = Procedure 'confess', sub
{Confess; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
};
Call $c;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
Confess at: # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
2 3 confess
1 6 call
END
}
Dec($target)
Decrement the target.
Parameter Description
1 $target Target addressExample:
if (1)
{Start 1;
my $a = Mov 3;
Dec $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out $a;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
2
END
}
Dump()
Dump all the arrays currently in memory.
Example:
if (1)
{Start 1;
my $a = Array "node";
Out $a;
Mov [$a, 1, 'node'], 1;
Mov [$a, 2, 'node'], 2;
Mov 1, [$a, \1, 'node'];
Dump; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Free $a, "node";
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END if $testSet <= 2;
1
1=bless([undef, 1, 2], "node")
Stack trace:
1 6 dump
END
is_deeply $e->out, <<END if $testSet > 2;
1
1=[0, 1, 2]
Stack trace:
1 6 dump
END
}
Else($e)
Else block.
Parameter Description
1 $e Else block subroutineExample:
if (1)
{Start 1;
IfFalse 1,
Then
{Out 1
},
Else # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{Out 0
};
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
0
END
}
if (1)
{Start 1;
Trace 1;
IfEq 1, 2,
Then
{Mov 1, 1;
Mov 2, 1;
},
Else # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{Mov 3, 3;
Mov 4, 4;
};
IfEq 2, 2,
Then
{Mov 1, 1;
Mov 2, 1;
},
Else # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{Mov 3, 3;
Mov 4, 4;
};
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
Trace: 1
1 0 1 trace
2 1 1 jNe
3 5 1 label
4 6 1 mov [1, 3, stackArea] = 3
5 7 1 mov [1, 4, stackArea] = 4
6 8 1 label
7 9 1 jNe
8 10 1 mov [1, 1, stackArea] = 1
9 11 1 mov [1, 2, stackArea] = 1
10 12 1 jmp
11 16 1 label
END
my $E = &$ee(suppressOutput=>1);
is_deeply $E->out, <<END;
Trace: 1
1 0 1 trace
2 1 1 jNe
3 5 1 label
4 6 1 mov [1, 3, stackArea] = 3
5 7 1 mov [1, 4, stackArea] = 4
6 8 1 label
7 9 1 jNe
8 10 1 mov [1, 1, stackArea] = 1
9 11 1 mov [1, 2, stackArea] = 1
10 12 1 jmp
11 16 1 label
END
is_deeply scalar($e->notExecuted->@*), 6;
is_deeply scalar($E->notExecuted->@*), 6;
}
Execute(%options)
Execute the current assembly.
Parameter Description
1 %options OptionsExample:
if (1)
{Start 1;
Out "Hello", "World";
my $e = Execute(suppressOutput=>1); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
is_deeply $e->out, <<END;
Hello World
END
}
For($block, $range, %options)
For loop 0..range-1 or in reverse.
Parameter Description
1 $block Block
2 $range Limit
3 %options OptionsExample:
if (1)
{Start 1;
For # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{my ($i) = @_;
Out $i;
} 10;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
0
1
2
3
4
5
6
7
8
9
END
}
if (1)
{Start 1;
For # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{my ($i) = @_;
Out $i;
} 10, reverse=>1;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
9
8
7
6
5
4
3
2
1
0
END
}
if (1)
{Start 1;
For # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{my ($i) = @_;
Out $i;
} [2, 10];
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
2
3
4
5
6
7
8
9
END
}
if (1)
{my $N = 5;
Start 1;
For # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{Tally 1;
my $a = Mov 1;
Tally 2;
Inc $a;
Tally 0;
} $N;
my $e = Execute;
is_deeply $e->tallyCount, 2 * $N;
is_deeply $e->tallyCounts, { 1 => {mov => $N}, 2 => {inc => $N}};
}
ForArray($block, $area, $name, %options)
For loop to process each element of the named area.
Parameter Description
1 $block Block of code
2 $area Area
3 $name Area name
4 %options OptionsExample:
if (1)
{Start 1;
my $a = Array "aaa";
Mov [$a, 0, "aaa"], 1;
Mov [$a, 1, "aaa"], 22;
Mov [$a, 2, "aaa"], 333;
my $n = ArraySize $a, "aaa";
Out "Array size:", $n;
ArrayDump $a;
ForArray # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{my ($i, $e, $check, $next, $end) = @_;
Out $i; Out $e;
} $a, "aaa";
Nop;
my $e = Execute(suppressOutput=>1);
is_deeply $e->heap(1), [1, 22, 333];
is_deeply $e->out, <<END if $testSet <= 2;
Array size: 3
bless([1, 22, 333], "aaa")
0
1
1
22
2
333
END
is_deeply $e->out, <<END if $testSet > 2;
Array size: 3
[1, 22, 333]
0
1
1
22
2
333
END
}
Free($target, $source)
Free the memory area named by the target operand after confirming that it has the name specified on the source operand.
Parameter Description
1 $target Target area yielding the id of the area to be freed
2 $source Source area yielding the name of the area to be freedExample:
if (1)
{Start 1;
my $a = Array "node";
Free $a, "aaa"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Wrong name: aaa for array with name: node
1 2 free
END
}
if (1)
{Start 1;
my $a = Array "node";
Out $a;
Mov [$a, 1, 'node'], 1;
Mov [$a, 2, 'node'], 2;
Mov 1, [$a, \1, 'node'];
Dump;
Free $a, "node"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END if $testSet <= 2;
1
1=bless([undef, 1, 2], "node")
Stack trace:
1 6 dump
END
is_deeply $e->out, <<END if $testSet > 2;
1
1=[0, 1, 2]
Stack trace:
1 6 dump
END
}
Good($good)
A good ending.
Parameter Description
1 $good What to do on a good endingExample:
if (1)
{Start 1;
Block
{my ($start, $good, $bad, $end) = @_;
Out 1;
Jmp $good;
}
Good # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{Out 2;
},
Bad
{Out 3;
};
Out 4;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
1
2
4
END
}
IfEq($a, $b, %options)
Execute then or else clause depending on whether two memory locations are equal.
Parameter Description
1 $a First memory address
2 $b Second memory address
3 %options Then blockExample:
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $a, $a, Then {Out "Eq"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfNe $a, $a, Then {Out "Ne"};
IfLe $a, $a, Then {Out "Le"};
IfLt $a, $a, Then {Out "Lt"};
IfGe $a, $a, Then {Out "Ge"};
IfGt $a, $a, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Eq
Le
Ge
END
}
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $a, $b, Then {Out "Eq"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfNe $a, $b, Then {Out "Ne"};
IfLe $a, $b, Then {Out "Le"};
IfLt $a, $b, Then {Out "Lt"};
IfGe $a, $b, Then {Out "Ge"};
IfGt $a, $b, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Ne
Le
Lt
END
}
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $b, $a, Then {Out "Eq"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfNe $b, $a, Then {Out "Ne"};
IfLe $b, $a, Then {Out "Le"};
IfLt $b, $a, Then {Out "Lt"};
IfGe $b, $a, Then {Out "Ge"};
IfGt $b, $a, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Ne
Ge
Gt
END
}
IfFalse($a, %options)
Execute then clause if the specified memory address is zero thus representing false.
Parameter Description
1 $a Memory address
2 %options Then blockExample:
if (1)
{Start 1;
IfFalse 1, # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Then
{Out 1
},
Else
{Out 0
};
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
0
END
}
IfGe($a, $b, %options)
Execute then or else clause depending on whether two memory locations are greater than or equal.
Parameter Description
1 $a First memory address
2 $b Second memory address
3 %options Then blockExample:
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $a, $a, Then {Out "Eq"};
IfNe $a, $a, Then {Out "Ne"};
IfLe $a, $a, Then {Out "Le"};
IfLt $a, $a, Then {Out "Lt"};
IfGe $a, $a, Then {Out "Ge"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfGt $a, $a, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Eq
Le
Ge
END
}
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $a, $b, Then {Out "Eq"};
IfNe $a, $b, Then {Out "Ne"};
IfLe $a, $b, Then {Out "Le"};
IfLt $a, $b, Then {Out "Lt"};
IfGe $a, $b, Then {Out "Ge"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfGt $a, $b, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Ne
Le
Lt
END
}
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $b, $a, Then {Out "Eq"};
IfNe $b, $a, Then {Out "Ne"};
IfLe $b, $a, Then {Out "Le"};
IfLt $b, $a, Then {Out "Lt"};
IfGe $b, $a, Then {Out "Ge"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfGt $b, $a, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Ne
Ge
Gt
END
}
IfGt($a, $b, %options)
Execute then or else clause depending on whether two memory locations are greater than.
Parameter Description
1 $a First memory address
2 $b Second memory address
3 %options Then blockExample:
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $a, $a, Then {Out "Eq"};
IfNe $a, $a, Then {Out "Ne"};
IfLe $a, $a, Then {Out "Le"};
IfLt $a, $a, Then {Out "Lt"};
IfGe $a, $a, Then {Out "Ge"};
IfGt $a, $a, Then {Out "Gt"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Eq
Le
Ge
END
}
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $a, $b, Then {Out "Eq"};
IfNe $a, $b, Then {Out "Ne"};
IfLe $a, $b, Then {Out "Le"};
IfLt $a, $b, Then {Out "Lt"};
IfGe $a, $b, Then {Out "Ge"};
IfGt $a, $b, Then {Out "Gt"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Ne
Le
Lt
END
}
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $b, $a, Then {Out "Eq"};
IfNe $b, $a, Then {Out "Ne"};
IfLe $b, $a, Then {Out "Le"};
IfLt $b, $a, Then {Out "Lt"};
IfGe $b, $a, Then {Out "Ge"};
IfGt $b, $a, Then {Out "Gt"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Ne
Ge
Gt
END
}
IfNe($a, $b, %options)
Execute then or else clause depending on whether two memory locations are not equal.
Parameter Description
1 $a First memory address
2 $b Second memory address
3 %options Then blockExample:
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $a, $a, Then {Out "Eq"};
IfNe $a, $a, Then {Out "Ne"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfLe $a, $a, Then {Out "Le"};
IfLt $a, $a, Then {Out "Lt"};
IfGe $a, $a, Then {Out "Ge"};
IfGt $a, $a, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Eq
Le
Ge
END
}
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $a, $b, Then {Out "Eq"};
IfNe $a, $b, Then {Out "Ne"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfLe $a, $b, Then {Out "Le"};
IfLt $a, $b, Then {Out "Lt"};
IfGe $a, $b, Then {Out "Ge"};
IfGt $a, $b, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Ne
Le
Lt
END
}
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $b, $a, Then {Out "Eq"};
IfNe $b, $a, Then {Out "Ne"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfLe $b, $a, Then {Out "Le"};
IfLt $b, $a, Then {Out "Lt"};
IfGe $b, $a, Then {Out "Ge"};
IfGt $b, $a, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Ne
Ge
Gt
END
}
IfLe($a, $b, %options)
Execute then or else clause depending on whether two memory locations are less than or equal.
Parameter Description
1 $a First memory address
2 $b Second memory address
3 %options Then blockExample:
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $a, $a, Then {Out "Eq"};
IfNe $a, $a, Then {Out "Ne"};
IfLe $a, $a, Then {Out "Le"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfLt $a, $a, Then {Out "Lt"};
IfGe $a, $a, Then {Out "Ge"};
IfGt $a, $a, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Eq
Le
Ge
END
}
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $a, $b, Then {Out "Eq"};
IfNe $a, $b, Then {Out "Ne"};
IfLe $a, $b, Then {Out "Le"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfLt $a, $b, Then {Out "Lt"};
IfGe $a, $b, Then {Out "Ge"};
IfGt $a, $b, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Ne
Le
Lt
END
}
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $b, $a, Then {Out "Eq"};
IfNe $b, $a, Then {Out "Ne"};
IfLe $b, $a, Then {Out "Le"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfLt $b, $a, Then {Out "Lt"};
IfGe $b, $a, Then {Out "Ge"};
IfGt $b, $a, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Ne
Ge
Gt
END
}
IfLt($a, $b, %options)
Execute then or else clause depending on whether two memory locations are less than.
Parameter Description
1 $a First memory address
2 $b Second memory address
3 %options Then blockExample:
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $a, $a, Then {Out "Eq"};
IfNe $a, $a, Then {Out "Ne"};
IfLe $a, $a, Then {Out "Le"};
IfLt $a, $a, Then {Out "Lt"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfGe $a, $a, Then {Out "Ge"};
IfGt $a, $a, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Eq
Le
Ge
END
}
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $a, $b, Then {Out "Eq"};
IfNe $a, $b, Then {Out "Ne"};
IfLe $a, $b, Then {Out "Le"};
IfLt $a, $b, Then {Out "Lt"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfGe $a, $b, Then {Out "Ge"};
IfGt $a, $b, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Ne
Le
Lt
END
}
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
IfEq $b, $a, Then {Out "Eq"};
IfNe $b, $a, Then {Out "Ne"};
IfLe $b, $a, Then {Out "Le"};
IfLt $b, $a, Then {Out "Lt"}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfGe $b, $a, Then {Out "Ge"};
IfGt $b, $a, Then {Out "Gt"};
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Ne
Ge
Gt
END
}
IfTrue($a, %options)
Execute then clause if the specified memory address is not zero thus representing true.
Parameter Description
1 $a Memory address
2 %options Then blockExample:
if (1)
{Start 1;
IfTrue 1, # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Then
{Out 1
},
Else
{Out 0
};
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
1
END
}
Inc($target)
Increment the target.
Parameter Description
1 $target Target addressExample:
if (1)
{Start 1;
my $a = Mov 3;
Inc $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out $a;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
4
END
}
Jeq($target, $source, $source2)
Jump to a target label if the first source field is equal to the second source field.
Parameter Description
1 $target Target label
2 $source Source to test
3 $source2Example:
if (1)
{Start 1;
my $a = Array "aaa";
my $b = Array "bbb";
Mov [$a, 0, 'aaa'], $b;
Mov [$b, 0, 'bbb'], 99;
For
{my ($i, $check, $next, $end) = @_;
my $c = Mov [$a, \0, 'aaa'];
my $d = Mov [$c, \0, 'bbb'];
Jeq $next, $d, $d; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Jne $next, $d, $d;
Jle $next, $d, $d;
Jlt $next, $d, $d;
Jge $next, $d, $d;
Jgt $next, $d, $d;
} 3;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->analyzeExecutionResults(doubleWrite=>3), "# 24 instructions executed";
is_deeply $e->heap(1), [2];
is_deeply $e->heap(2), [99];
}
JFalse($target, $source)
Jump to a target label if the first source field is equal to zero.
Parameter Description
1 $target Target label
2 $source Source to testExample:
if (1)
{Start 1;
my $a = Mov 1;
Block
{my ($start, $good, $bad, $end) = @_;
JTrue $end, $a;
Out 1;
};
Block
{my ($start, $good, $bad, $end) = @_;
JFalse $end, $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out 2;
};
Mov $a, 0;
Block
{my ($start, $good, $bad, $end) = @_;
JTrue $end, $a;
Out 3;
};
Block
{my ($start, $good, $bad, $end) = @_;
JFalse $end, $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out 4;
};
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
2
3
END
}
Jge($target, $source, $source2)
Jump to a target label if the first source field is greater than or equal to the second source field.
Parameter Description
1 $target Target label
2 $source Source to test
3 $source2Example:
if (1)
{Start 1;
my $a = Array "aaa";
my $b = Array "bbb";
Mov [$a, 0, 'aaa'], $b;
Mov [$b, 0, 'bbb'], 99;
For
{my ($i, $check, $next, $end) = @_;
my $c = Mov [$a, \0, 'aaa'];
my $d = Mov [$c, \0, 'bbb'];
Jeq $next, $d, $d;
Jne $next, $d, $d;
Jle $next, $d, $d;
Jlt $next, $d, $d;
Jge $next, $d, $d; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Jgt $next, $d, $d;
} 3;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->analyzeExecutionResults(doubleWrite=>3), "# 24 instructions executed";
is_deeply $e->heap(1), [2];
is_deeply $e->heap(2), [99];
}
Jgt($target, $source, $source2)
Jump to a target label if the first source field is greater than the second source field.
Parameter Description
1 $target Target label
2 $source Source to test
3 $source2Example:
if (1)
{Start 1;
my $a = Array "aaa";
my $b = Array "bbb";
Mov [$a, 0, 'aaa'], $b;
Mov [$b, 0, 'bbb'], 99;
For
{my ($i, $check, $next, $end) = @_;
my $c = Mov [$a, \0, 'aaa'];
my $d = Mov [$c, \0, 'bbb'];
Jeq $next, $d, $d;
Jne $next, $d, $d;
Jle $next, $d, $d;
Jlt $next, $d, $d;
Jge $next, $d, $d;
Jgt $next, $d, $d; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
} 3;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->analyzeExecutionResults(doubleWrite=>3), "# 24 instructions executed";
is_deeply $e->heap(1), [2];
is_deeply $e->heap(2), [99];
}
Jle($target, $source, $source2)
Jump to a target label if the first source field is less than or equal to the second source field.
Parameter Description
1 $target Target label
2 $source Source to test
3 $source2Example:
if (1)
{Start 1;
my $a = Array "aaa";
my $b = Array "bbb";
Mov [$a, 0, 'aaa'], $b;
Mov [$b, 0, 'bbb'], 99;
For
{my ($i, $check, $next, $end) = @_;
my $c = Mov [$a, \0, 'aaa'];
my $d = Mov [$c, \0, 'bbb'];
Jeq $next, $d, $d;
Jne $next, $d, $d;
Jle $next, $d, $d; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Jlt $next, $d, $d;
Jge $next, $d, $d;
Jgt $next, $d, $d;
} 3;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->analyzeExecutionResults(doubleWrite=>3), "# 24 instructions executed";
is_deeply $e->heap(1), [2];
is_deeply $e->heap(2), [99];
}
Jlt($target, $source, $source2)
Jump to a target label if the first source field is less than the second source field.
Parameter Description
1 $target Target label
2 $source Source to test
3 $source2Example:
if (1)
{Start 1;
my $a = Array "aaa";
my $b = Array "bbb";
Mov [$a, 0, 'aaa'], $b;
Mov [$b, 0, 'bbb'], 99;
For
{my ($i, $check, $next, $end) = @_;
my $c = Mov [$a, \0, 'aaa'];
my $d = Mov [$c, \0, 'bbb'];
Jeq $next, $d, $d;
Jne $next, $d, $d;
Jle $next, $d, $d;
Jlt $next, $d, $d; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Jge $next, $d, $d;
Jgt $next, $d, $d;
} 3;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->analyzeExecutionResults(doubleWrite=>3), "# 24 instructions executed";
is_deeply $e->heap(1), [2];
is_deeply $e->heap(2), [99];
}
Jmp($target)
Jump to a label.
Parameter Description
1 $target Target addressExample:
if (1)
{Start 1;
Jmp (my $a = label); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out 1;
Jmp (my $b = label); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
setLabel($a);
Out 2;
setLabel($b);
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
2
END
}
Jne($target, $source, $source2)
Jump to a target label if the first source field is not equal to the second source field.
Parameter Description
1 $target Target label
2 $source Source to test
3 $source2Example:
if (1)
{Start 1;
my $a = Array "aaa";
my $b = Array "bbb";
Mov [$a, 0, 'aaa'], $b;
Mov [$b, 0, 'bbb'], 99;
For
{my ($i, $check, $next, $end) = @_;
my $c = Mov [$a, \0, 'aaa'];
my $d = Mov [$c, \0, 'bbb'];
Jeq $next, $d, $d;
Jne $next, $d, $d; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Jle $next, $d, $d;
Jlt $next, $d, $d;
Jge $next, $d, $d;
Jgt $next, $d, $d;
} 3;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->analyzeExecutionResults(doubleWrite=>3), "# 24 instructions executed";
is_deeply $e->heap(1), [2];
is_deeply $e->heap(2), [99];
}
JTrue($target, $source)
Jump to a target label if the first source field is not equal to zero.
Parameter Description
1 $target Target label
2 $source Source to testExample:
if (1)
{Start 1;
my $a = Mov 1;
Block
{my ($start, $good, $bad, $end) = @_;
JTrue $end, $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out 1;
};
Block
{my ($start, $good, $bad, $end) = @_;
JFalse $end, $a;
Out 2;
};
Mov $a, 0;
Block
{my ($start, $good, $bad, $end) = @_;
JTrue $end, $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out 3;
};
Block
{my ($start, $good, $bad, $end) = @_;
JFalse $end, $a;
Out 4;
};
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
2
3
END
}
LoadAddress()
Load the address component of an address.
Example:
if (1)
{Start 1;
my $a = Array "array";
my $b = Mov 2;
my $c = Mov 5;
my $d = LoadAddress $c; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $f = LoadArea [$a, \0, 'array'];
Out $d;
Out $f;
Mov [$a, \$b, 'array'], 22;
Mov [$a, \$c, 'array'], 33;
Mov [$f, \$d, 'array'], 44;
my $e = &$ee(suppressOutput=>1, maximumAreaSize=>6);
is_deeply $e->out, <<END;
2
1
END
is_deeply $e->heap(1), [undef, undef, 44, undef, undef, 33] if $testSet <= 2;
is_deeply $e->heap(1), [0, 0, 44, 0, 0, 33] if $testSet > 2;
is_deeply $e->widestAreaInArena, [4,5];
}
LoadArea()
Load the area component of an address.
Example:
if (1)
{Start 1;
my $a = Array "array";
my $b = Mov 2;
my $c = Mov 5;
my $d = LoadAddress $c;
my $f = LoadArea [$a, \0, 'array']; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out $d;
Out $f;
Mov [$a, \$b, 'array'], 22;
Mov [$a, \$c, 'array'], 33;
Mov [$f, \$d, 'array'], 44;
my $e = &$ee(suppressOutput=>1, maximumAreaSize=>6);
is_deeply $e->out, <<END;
2
1
END
is_deeply $e->heap(1), [undef, undef, 44, undef, undef, 33] if $testSet <= 2;
is_deeply $e->heap(1), [0, 0, 44, 0, 0, 33] if $testSet > 2;
is_deeply $e->widestAreaInArena, [4,5];
}
Mov()
Copy a constant or memory address to the target address.
Example:
if (1)
{Start 1;
my $a = Mov 2; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out $a;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
2
END
}
{Start 1;
if (1)
{Start 1;
my $a = Array "aaa";
Mov [$a, 1, "aaa"], 11; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Mov 1, [$a, \1, "aaa"]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out \1;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
11
END
}
if (1)
{Start 1;
my $a = Array "alloc";
my $b = Mov 99; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $c = Mov $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Mov [$a, 0, 'alloc'], $b; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Mov [$c, 1, 'alloc'], 2; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply $e->heap(1), [99, 2];
}
if (1)
{Start 1;
my $a = Array "aaa";
Dump;
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Stack trace:
1 2 dump
END
}
if (1)
{Start 1;
my $a = Array "aaa";
my $i = Mov 1; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $v = Mov 11; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
ParamsPut 0, $a;
ParamsPut 1, $i;
ParamsPut 2, $v;
my $set = Procedure 'set', sub
{my $a = ParamsGet 0;
my $i = ParamsGet 1;
my $v = ParamsGet 2;
Mov [$a, \$i, 'aaa'], $v; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Return;
};
Call $set;
my $V = Mov [$a, \$i, 'aaa']; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
AssertEq $v, $V;
Out [$a, \$i, 'aaa'];
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
11
END
}
if (1)
{Start 1;
my $set = Procedure 'set', sub
{my $a = ParamsGet 0;
Out $a;
};
ParamsPut 0, 1; Call $set;
ParamsPut 0, 2; Call $set;
ParamsPut 0, 3; Call $set;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
1
2
3
END
}
if (1)
{Start 1;
my $a = Array "aaa";
my $b = Array "bbb";
Mov [$a, 0, 'aaa'], $b; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Mov [$b, 0, 'bbb'], 99; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
For
{my ($i, $check, $next, $end) = @_;
my $c = Mov [$a, \0, 'aaa']; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $d = Mov [$c, \0, 'bbb']; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Jeq $next, $d, $d;
Jne $next, $d, $d;
Jle $next, $d, $d;
Jlt $next, $d, $d;
Jge $next, $d, $d;
Jgt $next, $d, $d;
} 3;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->analyzeExecutionResults(doubleWrite=>3), "# 24 instructions executed";
is_deeply $e->heap(1), [2];
is_deeply $e->heap(2), [99];
}
if (1)
{Start 1;
my $a = Array 'aaa';
my $b = Mov 2; # Location to move to in a # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
For
{my ($i, $check, $next, $end) = @_;
Mov [$a, \$b, 'aaa'], 1; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Jeq $next, [$a, \$b, 'aaa'], 1;
} 3;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->analyzeExecutionResults(doubleWrite=>3), "# 19 instructions executed";
is_deeply $e->heap(1), [undef, undef, 1] if $testSet <= 2;
is_deeply $e->heap(1), [0, 0, 1] if $testSet > 2;
}
if (1)
{Start 1;
my $a = Array "aaa";
Mov [$a, 0, "aaa"], 1; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Mov [$a, 1, "aaa"], 22; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Mov [$a, 2, "aaa"], 333; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
ArrayDump $a;
my $e = &$ee(suppressOutput=>1);
is_deeply eval($e->out), [1, 22, 333];
#say STDERR $e->block->codeToString;
is_deeply $e->block->codeToString, <<'END' if $testSet == 1;
0000 array \0 3
0001 mov [\0, 0, 3, 0] 1
0002 mov [\0, 1, 3, 0] 22
0003 mov [\0, 2, 3, 0] 333
0004 arrayDump \0
END
is_deeply $e->block->codeToString, <<'END' if $testSet == 2;
0000 array [undef, \0, 3, 0] [undef, 3, 3, 0] [undef, 0, 3, 0]
0001 mov [\0, 0, 3, 0] [undef, 1, 3, 0] [undef, 0, 3, 0]
0002 mov [\0, 1, 3, 0] [undef, 22, 3, 0] [undef, 0, 3, 0]
0003 mov [\0, 2, 3, 0] [undef, 333, 3, 0] [undef, 0, 3, 0]
0004 arrayDump [undef, \0, 3, 0] [undef, 0, 3, 0] [undef, 0, 3, 0]
END
}
MoveLong($target, $source, $source2)
Copy the number of elements specified by the second source operand from the location specified by the first source operand to the target operand.
Parameter Description
1 $target Target of move
2 $source Source of move
3 $source2 Length of moveExample:
if (1)
{my $N = 10;
Start 1;
my $a = Array "aaa";
my $b = Array "bbb";
For
{my ($i, $Check, $Next, $End) = @_;
Mov [$a, \$i, "aaa"], $i;
my $j = Add $i, 100;
Mov [$b, \$i, "bbb"], $j;
} $N;
MoveLong [$b, \2, 'bbb'], [$a, \4, 'aaa'], 3; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1, maximumAreaSize=>11);
is_deeply $e->heap(1), [0 .. 9];
is_deeply $e->heap(2), [100, 101, 4, 5, 6, 105 .. 109];
}
Not()
Move and not.
Example:
if (1)
{Start 1;
my $a = Mov 3;
my $b = Not $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $c = Not $b; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out $a;
Out $b;
Out $c;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
3
1
END
}
Nop()
Do nothing (but do it well!).
Example:
if (1)
{Start 1;
Nop; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee;
is_deeply $e->out, "";
}
if (1)
{Start 1;
my $a = Array "aaa";
Mov [$a, 0, "aaa"], 1;
Mov [$a, 1, "aaa"], 22;
Mov [$a, 2, "aaa"], 333;
my $n = ArraySize $a, "aaa";
Out "Array size:", $n;
ArrayDump $a;
ForArray
{my ($i, $e, $check, $next, $end) = @_;
Out $i; Out $e;
} $a, "aaa";
Nop; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = Execute(suppressOutput=>1);
is_deeply $e->heap(1), [1, 22, 333];
is_deeply $e->out, <<END if $testSet <= 2;
Array size: 3
bless([1, 22, 333], "aaa")
0
1
1
22
2
333
END
is_deeply $e->out, <<END if $testSet > 2;
Array size: 3
[1, 22, 333]
0
1
1
22
2
333
END
}
Out(@source)
Write memory location contents to out.
Parameter Description
1 @source Either a scalar constant or memory address to outputExample:
if (1)
{Start 1;
Out "Hello", "World"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Hello World
END
}
ParamsGet()
Get a word from the parameters in the previous frame and store it in the current frame.
Example:
if (1)
{Start 1;
my $a = Array "aaa";
my $i = Mov 1;
my $v = Mov 11;
ParamsPut 0, $a;
ParamsPut 1, $i;
ParamsPut 2, $v;
my $set = Procedure 'set', sub
{my $a = ParamsGet 0; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $i = ParamsGet 1; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $v = ParamsGet 2; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Mov [$a, \$i, 'aaa'], $v;
Return;
};
Call $set;
my $V = Mov [$a, \$i, 'aaa'];
AssertEq $v, $V;
Out [$a, \$i, 'aaa'];
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
11
END
}
ParamsPut($target, $source)
Put a word into the parameters list to make it visible in a called procedure.
Parameter Description
1 $target Parameter number
2 $source Address to fetch parameter fromExample:
if (1)
{Start 1;
my $a = Array "aaa";
my $i = Mov 1;
my $v = Mov 11;
ParamsPut 0, $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
ParamsPut 1, $i; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
ParamsPut 2, $v; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $set = Procedure 'set', sub
{my $a = ParamsGet 0;
my $i = ParamsGet 1;
my $v = ParamsGet 2;
Mov [$a, \$i, 'aaa'], $v;
Return;
};
Call $set;
my $V = Mov [$a, \$i, 'aaa'];
AssertEq $v, $V;
Out [$a, \$i, 'aaa'];
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
11
END
}
Pop(if (@_ == 2))
Pop the memory area specified by the source operand into the memory address specified by the target operand.
Parameter Description
1 if (@_ == 2) Pop indicated area into a local variableExample:
if (1)
{Start 1;
my $a = Array "aaa";
Push $a, 1, "aaa";
Push $a, 2, "aaa";
my $c = Pop $a, "aaa"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $d = Pop $a, "aaa"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out $c;
Out $d;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
2
1
END
is_deeply $e->heap(1), [];
}
Procedure($name, $source)
Define a procedure.
Parameter Description
1 $name Name of procedure
2 $source Source code as a subroutineExample:
if (1)
{Start 1;
my $add = Procedure 'add2', sub # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{my $a = ParamsGet 0;
my $b = Add $a, 2;
ReturnPut 0, $b;
Return;
};
ParamsPut 0, 2;
Call $add;
my $c = ReturnGet 0;
Out $c;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
4
END
}
if (1)
{Start 1;
for my $i(1..10)
{Out $i;
};
IfTrue 0,
Then
{Out 99;
};
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
1
2
3
4
5
6
7
8
9
10
END
is_deeply $e->outLines, [1..10];
}
Push($target, $source, $source2)
Push the value in the current stack frame specified by the source operand onto the memory area identified by the target operand.
Parameter Description
1 $target Memory area to push to
2 $source Memory containing value to push
3 $source2Example:
if (1)
{Start 1;
my $a = Array "aaa";
Push $a, 1, "aaa"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Push $a, 2, "aaa"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $c = Pop $a, "aaa";
my $d = Pop $a, "aaa";
Out $c;
Out $d;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
2
1
END
is_deeply $e->heap(1), [];
}
if (1)
{Start 1;
my $a = Array "aaa";
Push $a, 1, "aaa"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Push $a, 2, "aaa"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Push $a, 3, "aaa"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $b = Array "bbb";
Push $b, 11, "bbb"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Push $b, 22, "bbb"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Push $b, 33, "bbb"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1);
is_deeply $e->GetMemoryHeaps->($e), 3;
is_deeply $e->heap(1), [1, 2, 3];
is_deeply $e->heap(2), [11, 22, 33];
}
Resize($target, $source, $source2)
Resize the target area to the source size.
Parameter Description
1 $target Target array
2 $source New size
3 $source2 Array nameExample:
if (1)
{Start 1;
my $a = Array 'aaa';
Mov [$a, 0, 'aaa'], 1;
Mov [$a, 1, 'aaa'], 2;
Mov [$a, 2, 'aaa'], 3;
Resize $a, 2, "aaa"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
ArrayDump $a;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->heap(1), [1, 2];
is_deeply eval($e->out), [1,2];
}
Random(if (@_ == 1))
Create a random number in a specified range
Parameter Description
1 if (@_ == 1) Create a variableExample:
if (1)
{Start 1;
RandomSeed 1;
my $a = Random 10; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out $a;
my $e = &$ee(suppressOutput=>1);
ok $e->out =~ m(\A\d\Z);
}
RandomSeed($seed)
Seed the random number generator
Parameter Description
1 $seed ParametersExample:
if (1)
{Start 1;
RandomSeed 1; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $a = Random 10;
Out $a;
my $e = &$ee(suppressOutput=>1);
ok $e->out =~ m(\A\d\Z);
}
Return()
Return from a procedure via the call stack.
Example:
if (1)
{Start 1;
my $w = Procedure 'write', sub
{Out 1;
Return; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
};
Call $w;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
1
END
}
ReturnGet(if (@_ == 1))
Get a word from the return area and save it.
Parameter Description
1 if (@_ == 1) Create a variableExample:
if (1)
{Start 1;
my $w = Procedure 'write', sub
{ReturnPut 0, 999;
Return;
};
Call $w;
ReturnGet \0, 0; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out \0;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
999
END
}
ReturnPut($target, $source)
Put a word into the return area.
Parameter Description
1 $target Offset in return area to write to
2 $source Memory address whose contents are to be placed in the return areaExample:
if (1)
{Start 1;
my $w = Procedure 'write', sub
{ReturnPut 0, 999; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Return;
};
Call $w;
ReturnGet \0, 0;
Out \0;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
999
END
}
ShiftDown(if (@_ == 1))
Shift an element down one in an area.
Parameter Description
1 if (@_ == 1) Create a variableExample:
if (1)
{Start 1;
my $a = Array "array";
Mov [$a, 0, 'array'], 0;
Mov [$a, 1, 'array'], 99;
Mov [$a, 2, 'array'], 2;
my $b = ShiftDown [$a, \1, 'array']; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out $b;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->heap(1), [0, 2];
is_deeply $e->out, <<END;
99
END
}
ShiftLeft(my ($target, $source)
Shift left within an element.
Parameter Description
1 my ($target Target to shift
2 $source Amount to shiftExample:
if (1)
{Start 1;
my $a = Mov 1;
ShiftLeft $a, $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out $a;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
2
END
}
ShiftRight(my ($target, $source)
Shift right with an element.
Parameter Description
1 my ($target Target to shift
2 $source Amount to shiftExample:
if (1)
{Start 1;
my $a = Mov 4;
ShiftRight $a, 1; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out $a;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
2
END
}
ShiftUp($target, $source)
Shift an element up one in an area.
Parameter Description
1 $target Target to shift
2 $source Amount to shiftExample:
if (1)
{Start 1;
my $a = Array "array";
Mov [$a, 0, 'array'], 0;
Mov [$a, 1, 'array'], 1;
Mov [$a, 2, 'array'], 2;
ShiftUp [$a, 0, 'array'], 99; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>0);
is_deeply $e->heap(1), [99, 0, 1, 2];
}
if (1)
{Start 1;
my $a = Array "array";
Mov [$a, 0, 'array'], 0;
Mov [$a, 1, 'array'], 1;
Mov [$a, 2, 'array'], 2;
ShiftUp [$a, 1, 'array'], 99; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>0);
is_deeply $e->heap(1), [0, 99, 1, 2];
}
if (1)
{Start 1;
my $a = Array "array";
Mov [$a, 0, 'array'], 0;
Mov [$a, 1, 'array'], 1;
Mov [$a, 2, 'array'], 2;
ShiftUp [$a, 2, 'array'], 99; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>0);
is_deeply $e->heap(1), [0, 1, 99, 2];
}
if (1)
{Start 1;
my $a = Array "array";
Mov [$a, 0, 'array'], 0;
Mov [$a, 1, 'array'], 1;
Mov [$a, 2, 'array'], 2;
ShiftUp [$a, 3, 'array'], 99; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>0);
is_deeply $e->heap(1), [0, 1, 2, 99];
}
if (1)
{Start 1;
my $a = Array "array";
Mov [$a, $_-1, 'array'], 10*$_ for 1..7;
ShiftUp [$a, 2, 'array'], 26; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $e = &$ee(suppressOutput=>1, maximumAreaSize=>8);
is_deeply $e->heap(1), bless([10, 20, 26, 30, 40, 50, 60, 70], "array");
}
Start($version)
Start the current assembly using the specified version of the Zero language. At the moment only version 1 works.
Parameter Description
1 $version Version desired - at the moment only 1Example:
if (1)
{Start 1; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out "Hello", "World";
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Hello World
END
}
Subtract($target, $s1, $s2)
Subtract the second source operand value from the first source operand value and store the result in the target area.
Parameter Description
1 $target Target address
2 $s1 Source one
3 $s2 Source twoExample:
if (1)
{Start 1;
my $a = Subtract 4, 2; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Out $a;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
2
END
}
Tally($source)
Counts instructions when enabled.
Parameter Description
1 $source Tally instructions when trueExample:
if (1)
{my $N = 5;
Start 1;
For
{Tally 1; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
my $a = Mov 1;
Tally 2; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Inc $a;
Tally 0; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
} $N;
my $e = Execute;
is_deeply $e->tallyCount, 2 * $N;
is_deeply $e->tallyCounts, { 1 => {mov => $N}, 2 => {inc => $N}};
}
Then($t)
Then block.
Parameter Description
1 $t Then block subroutineExample:
if (1)
{Start 1;
IfFalse 1,
Then # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{Out 1
},
Else
{Out 0
};
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
0
END
}
if (1)
{Start 1;
Trace 1;
IfEq 1, 2,
Then # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{Mov 1, 1;
Mov 2, 1;
},
Else
{Mov 3, 3;
Mov 4, 4;
};
IfEq 2, 2,
Then # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
{Mov 1, 1;
Mov 2, 1;
},
Else
{Mov 3, 3;
Mov 4, 4;
};
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
Trace: 1
1 0 1 trace
2 1 1 jNe
3 5 1 label
4 6 1 mov [1, 3, stackArea] = 3
5 7 1 mov [1, 4, stackArea] = 4
6 8 1 label
7 9 1 jNe
8 10 1 mov [1, 1, stackArea] = 1
9 11 1 mov [1, 2, stackArea] = 1
10 12 1 jmp
11 16 1 label
END
my $E = &$ee(suppressOutput=>1);
is_deeply $E->out, <<END;
Trace: 1
1 0 1 trace
2 1 1 jNe
3 5 1 label
4 6 1 mov [1, 3, stackArea] = 3
5 7 1 mov [1, 4, stackArea] = 4
6 8 1 label
7 9 1 jNe
8 10 1 mov [1, 1, stackArea] = 1
9 11 1 mov [1, 2, stackArea] = 1
10 12 1 jmp
11 16 1 label
END
is_deeply scalar($e->notExecuted->@*), 6;
is_deeply scalar($E->notExecuted->@*), 6;
}
Trace($source)
Start or stop tracing. Tracing prints each instruction executed and its effect on memory.
Parameter Description
1 $source Trace settingExample:
if (1)
{Start 1;
Trace 1; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
IfEq 1, 2,
Then
{Mov 1, 1;
Mov 2, 1;
},
Else
{Mov 3, 3;
Mov 4, 4;
};
IfEq 2, 2,
Then
{Mov 1, 1;
Mov 2, 1;
},
Else
{Mov 3, 3;
Mov 4, 4;
};
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
Trace: 1 # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
1 0 1 trace
2 1 1 jNe
3 5 1 label
4 6 1 mov [1, 3, stackArea] = 3
5 7 1 mov [1, 4, stackArea] = 4
6 8 1 label
7 9 1 jNe
8 10 1 mov [1, 1, stackArea] = 1
9 11 1 mov [1, 2, stackArea] = 1
10 12 1 jmp
11 16 1 label
END
my $E = &$ee(suppressOutput=>1);
is_deeply $E->out, <<END;
Trace: 1 # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
1 0 1 trace
2 1 1 jNe
3 5 1 label
4 6 1 mov [1, 3, stackArea] = 3
5 7 1 mov [1, 4, stackArea] = 4
6 8 1 label
7 9 1 jNe
8 10 1 mov [1, 1, stackArea] = 1
9 11 1 mov [1, 2, stackArea] = 1
10 12 1 jmp
11 16 1 label
END
is_deeply scalar($e->notExecuted->@*), 6;
is_deeply scalar($E->notExecuted->@*), 6;
}
TraceLabels($source)
Enable or disable label tracing. If tracing is enabled a stack trace is printed for each label instruction executed showing the call stack at the time the instruction was generated as well as the current stack frames.
Parameter Description
1 $source Trace points if trueExample:
if (1)
{my $N = 5;
Start 1;
TraceLabels 1; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
For
{my $a = Mov 1;
Inc $a;
} $N;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
TraceLabels: 1 # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Label
1 2 label
Label
1 4 label
Label
1 8 label
Label
1 4 label
Label
1 8 label
Label
1 4 label
Label
1 8 label
Label
1 4 label
Label
1 8 label
Label
1 4 label
Label
1 8 label
Label
1 4 label
Label
1 11 label
END
}
Var($value)
Create a variable initialized to the specified value.
Parameter Description
1 $value ValueExample:
if (1)
{Start 1;
my $a = Var 22; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
AssertEq $a, 22;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, "";
}
Watch($target)
Watches for changes to the specified memory location.
Parameter Description
1 $target Memory address to watchExample:
if (1)
{Start 1;
my $a = Mov 1;
my $b = Mov 2;
my $c = Mov 3;
Watch $b; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Mov $a, 4;
Mov $b, 5;
Mov $c, 6;
my $e = Execute(suppressOutput=>1);
is_deeply $e->out, <<END;
Change at watched arena: 0, area: 1(stackArea), address: 1
1 6 mov
Current value: 2 New value: 5
END
}
Instruction Set Architecture
Map the instruction set into a machine architecture.
GenerateMachineCode(%options)
Generate a string of machine code from the current block of code.
Parameter Description
1 %options Generation optionsExample:
if (1)
{Start 1;
my $a = Mov 1;
my $g = GenerateMachineCode; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
is_deeply dump($g), 'pack("H*","0000002300000000000000000000017f000000010000007f000000000000007f")';
my $d = disAssemble $g;
$d->assemble;
is_deeply $d->codeToString, <<'END';
0000 mov [undef, \0, 3, 0] [undef, 1, 3, 0] [undef, 0, 3, 0]
END
my $e = GenerateMachineCodeDisAssembleExecute;
is_deeply $e->block->codeToString, <<'END';
0000 mov [undef, \0, 3, 0] [undef, 1, 3, 0] [undef, 0, 3, 0]
END
}
disAssemble($mc)
Disassemble machine code.
Parameter Description
1 $mc Machine code stringExample:
if (1)
{Start 1;
my $a = Mov 1;
my $g = GenerateMachineCode;
is_deeply dump($g), 'pack("H*","0000002300000000000000000000017f000000010000007f000000000000007f")';
my $d = disAssemble $g; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
$d->assemble;
is_deeply $d->codeToString, <<'END';
0000 mov [undef, \0, 3, 0] [undef, 1, 3, 0] [undef, 0, 3, 0]
END
my $e = GenerateMachineCodeDisAssembleExecute;
is_deeply $e->block->codeToString, <<'END';
0000 mov [undef, \0, 3, 0] [undef, 1, 3, 0] [undef, 0, 3, 0]
END
}
GenerateMachineCodeDisAssembleExecute(%options)
Round trip: generate machine code and write it onto a string, disassemble the generated machine code string and recreate a block of code from it, then execute the reconstituted code to prove that it works as well as the original code.
Parameter Description
1 %options OptionsExample:
if (1)
{Start 1;
my $a = Mov 1;
my $g = GenerateMachineCode;
is_deeply dump($g), 'pack("H*","0000002300000000000000000000017f000000010000007f000000000000007f")';
my $d = disAssemble $g;
$d->assemble;
is_deeply $d->codeToString, <<'END';
0000 mov [undef, \0, 3, 0] [undef, 1, 3, 0] [undef, 0, 3, 0]
END
my $e = GenerateMachineCodeDisAssembleExecute; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
is_deeply $e->block->codeToString, <<'END';
0000 mov [undef, \0, 3, 0] [undef, 1, 3, 0] [undef, 0, 3, 0]
END
}
Private Methods
Assembly()
Start some assembly code
Assert1($op, $a)
Assert operation.
Parameter Description
1 $op Operation
2 $a Source operandAssert2($op, $a, $b)
Assert operation.
Parameter Description
1 $op Operation
2 $a First memory address
3 $b Second memory addressIfx($cmp, $a, $b, %options)
Execute then or else clause depending on whether two memory locations are equal.
Parameter Description
1 $cmp Comparison
2 $a First memory address
3 $b Second memory address
4 %options Then blockLabel($source)
Create a label.
Parameter Description
1 $source Name of labelExample:
if (1)
{Start 1;
Mov 0, 1;
Jlt ((my $a = label), \0, 2);
Out 1;
Jmp (my $b = label);
setLabel($a);
Out 2;
setLabel($b);
Jgt ((my $c = label), \0, 3);
Out 3;
Jmp (my $d = label);
setLabel($c);
Out 4;
setLabel($d);
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
2
3
END
}
if (1)
{Start 1;
Mov 0, 0;
my $a = setLabel;
Out \0;
Inc \0;
Jlt $a, \0, 10;
my $e = &$ee(suppressOutput=>1);
is_deeply $e->out, <<END;
0
1
2
3
4
5
6
7
8
9
END
}
instructionList()
Create a list of instructinos
instructionListExport()
Create an export statement
instructionListReadMe()
List instructions for inclusion in read me
instructionListMapping()
Map instructions to small integers
refDepth($ref)
The depth of a reference.
Parameter Description
1 $ref Reference to packrefValue($ref)
The value of a reference after dereferencing.
Parameter Description
1 $ref Reference to packrerefValue($value, $depth)
Rereference a value.
Parameter Description
1 $value Value to reference
2 $depth Depth of referenceZero::Emulator::Code::packRef($code, $instruction, $ref)
Pack a reference into 8 bytes.
Parameter Description
1 $code Code block being packed
2 $instruction Instruction being packed
3 $ref Reference being packedZero::Emulator::Code::unpackRef($code, $a)
Unpack a reference.
Parameter Description
1 $code Code block being packed
2 $a Instruction being packedZero::Emulator::Code::packInstruction($code, $i)
Pack an instruction.
Parameter Description
1 $code Code being packed
2 $i Instruction to packunpackInstruction($I)
Unpack an instruction.
Parameter Description
1 $I Instruction numbersdisAssembleMinusContext($D)
Disassemble and remove context information from disassembly to make testing easier.
Parameter Description
1 $D Machine code stringIndex
1 Add - Add the source locations together and store the result in the target area.
2 Array - Create a new memory area and write its number into the address named by the target operand.
3 ArrayCountGreater - Count the number of elements in the array specified by the first source operand that are greater than the element supplied by the second source operand and place the result in the target location.
4 ArrayCountLess - Count the number of elements in the array specified by the first source operand that are less than the element supplied by the second source operand and place the result in the target location.
5 ArrayDump - Dump an array.
6 ArrayIndex - Find the 1 based index of the second source operand in the array referenced by the first source operand if it is present in the array else 0 into the target location.
7 ArraySize - The current size of an array.
8 Assembly - Start some assembly code
9 Assert - Assert regardless.
10 Assert1 - Assert operation.
11 Assert2 - Assert operation.
12 AssertEq - Assert two memory locations are equal.
13 AssertFalse - Assert false.
14 AssertGe - Assert are greater than or equal.
15 AssertGt - Assert two memory locations are greater than.
16 AssertLe - Assert two memory locations are less than or equal.
17 AssertLt - Assert two memory locations are less than.
18 AssertNe - Assert two memory locations are not equal.
19 AssertTrue - Assert true.
20 Bad - A bad ending.
21 Block - Block of code that can either be restarted or come to a good or a bad ending.
22 Call - Call the subroutine at the target address.
23 Clear - Clear the first bytes of an area.
24 Confess - Confess with a stack trace showing the location both in the emulated code and in the code that produced the emulated code.
25 Dec - Decrement the target.
26 disAssemble - Disassemble machine code.
27 disAssembleMinusContext - Disassemble and remove context information from disassembly to make testing easier.
28 Dump - Dump all the arrays currently in memory.
29 Else - Else block.
30 Execute - Execute the current assembly.
31 For - For loop 0.
32 ForArray - For loop to process each element of the named area.
33 Free - Free the memory area named by the target operand after confirming that it has the name specified on the source operand.
34 GenerateMachineCode - Generate a string of machine code from the current block of code.
35 GenerateMachineCodeDisAssembleExecute - Round trip: generate machine code and write it onto a string, disassemble the generated machine code string and recreate a block of code from it, then execute the reconstituted code to prove that it works as well as the original code.
36 Good - A good ending.
37 IfEq - Execute then or else clause depending on whether two memory locations are equal.
38 IfFalse - Execute then clause if the specified memory address is zero thus representing false.
39 IfGe - Execute then or else clause depending on whether two memory locations are greater than or equal.
40 IfGt - Execute then or else clause depending on whether two memory locations are greater than.
41 IfLe - Execute then or else clause depending on whether two memory locations are less than or equal.
42 IfLt - Execute then or else clause depending on whether two memory locations are less than.
43 IfNe - Execute then or else clause depending on whether two memory locations are not equal.
44 IfTrue - Execute then clause if the specified memory address is not zero thus representing true.
45 Ifx - Execute then or else clause depending on whether two memory locations are equal.
46 Inc - Increment the target.
47 instructionList - Create a list of instructinos
48 instructionListExport - Create an export statement
49 instructionListMapping - Map instructions to small integers
50 instructionListReadMe - List instructions for inclusion in read me
51 Jeq - Jump to a target label if the first source field is equal to the second source field.
52 JFalse - Jump to a target label if the first source field is equal to zero.
53 Jge - Jump to a target label if the first source field is greater than or equal to the second source field.
54 Jgt - Jump to a target label if the first source field is greater than the second source field.
55 Jle - Jump to a target label if the first source field is less than or equal to the second source field.
56 Jlt - Jump to a target label if the first source field is less than the second source field.
57 Jmp - Jump to a label.
58 Jne - Jump to a target label if the first source field is not equal to the second source field.
59 JTrue - Jump to a target label if the first source field is not equal to zero.
60 Label - Create a label.
61 LoadAddress - Load the address component of an address.
62 LoadArea - Load the area component of an address.
63 Mov - Copy a constant or memory address to the target address.
64 MoveLong - Copy the number of elements specified by the second source operand from the location specified by the first source operand to the target operand.
65 Nop - Do nothing (but do it well!).
66 Not - Move and not.
67 Out - Write memory location contents to out.
68 ParamsGet - Get a word from the parameters in the previous frame and store it in the current frame.
69 ParamsPut - Put a word into the parameters list to make it visible in a called procedure.
70 Pop - Pop the memory area specified by the source operand into the memory address specified by the target operand.
71 Procedure - Define a procedure.
72 Push - Push the value in the current stack frame specified by the source operand onto the memory area identified by the target operand.
73 Random - Create a random number in a specified range
74 RandomSeed - Seed the random number generator
75 refDepth - The depth of a reference.
76 refValue - The value of a reference after dereferencing.
77 rerefValue - Rereference a value.
78 Resize - Resize the target area to the source size.
79 Return - Return from a procedure via the call stack.
80 ReturnGet - Get a word from the return area and save it.
81 ReturnPut - Put a word into the return area.
82 ShiftDown - Shift an element down one in an area.
83 ShiftLeft - Shift left within an element.
84 ShiftRight - Shift right with an element.
85 ShiftUp - Shift an element up one in an area.
86 Start - Start the current assembly using the specified version of the Zero language.
87 Subtract - Subtract the second source operand value from the first source operand value and store the result in the target area.
88 Tally - Counts instructions when enabled.
89 Then - Then block.
90 Trace - Start or stop tracing.
91 TraceLabels - Enable or disable label tracing.
92 unpackInstruction - Unpack an instruction.
93 Var - Create a variable initialized to the specified value.
94 Watch - Watches for changes to the specified memory location.
95 Zero::Emulator::Code::packInstruction - Pack an instruction.
96 Zero::Emulator::Code::packRef - Pack a reference into 8 bytes.
97 Zero::Emulator::Code::unpackRef - Unpack a reference.
Installation
This module is written in 100% Pure Perl and, thus, it is easy to read, comprehend, use, modify and install via cpan:
sudo cpan install Zero::EmulatorAuthor
Copyright
Copyright (c) 2016-2023 Philip R Brenan.
This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.