Add basic block API and add more entity API functions

Also update readme

Author: simon816

README.md

@@ -16,6 +16,31 @@ keeps the usage of command blocks to a minimum.
 There is a C compiler that compiles to this assembly language,
 read more [here](https://github.com/simon816/Command-Block-Assembly/blob/master/README_C.md).
 
+As shown in the [fibonacci sequence example](https://github.com/simon816/Command-Block-Assembly/blob/master/examples/fib.c),
+it's just like writing normal C code.
+
+```c
+#include <stdio.h>
+
+int x;
+int y;
+int old_x;
+int counter;
+
+void main() {
+    x = 0;
+    y = 1;
+    counter = 1;
+    do {
+        printf("fib(%d) = %d", counter++, x);
+        sync;
+        old_x = x;
+        x = y;
+        y += old_x;
+    } while(x >= 0);
+}
+```
+
 # The Assembly Language
 
 It is a simple language with instructions similar to that of x86.
@@ -105,6 +130,17 @@ main:
 |PRINT|arg1, [...args]|Outputs arguments to chat for all players (`@a` selector)|
 |CMD|bare words|Runs the given command|
 |TEST|bare words|Runs the given command, skipping the next line if the command failed|
+|EXECAS|label, sel_type, sel_pairs|Runs the function defined in `label` using `/execute as` if the selector matches|
+|EXECASN|label, sel_type, sel_pairs|Same as EXECAS except runs if it does _not_ match the selector|
+|EXECAT|label, sel_type, sel_pairs|Runs the function defined in `label` using `/execute at` if the selector matches|
+|EXECATP|label, sel_type, sel_pairs|Runs the function defined in `label` using `/execute positioned as` if the selector matches|
+|EXECPOS|label, x, y, z|Runs the function defined in `label` using `/execute positioned`|
+|EXECALI|label, axes|Runs the function defined in `label` using `/execute align`|
+|EXECFACP|label, x, y, z|Runs the function defined in `label` using `/execute facing`|
+|EXECFAC|label, feature, sel_type, sel_pairs|Runs the function defined in `label` using `/execute facing entity`|
+|EXECROT|label, y, x|Runs the function defined in `label` using `/execute rotated`|
+|EXECROTE|label, sel_type, sel_pairs|Runs the function defined in `label` using `/execute rotated as`|
+|EXECANC|label, anchor|Runs the function defined in `label` using `/execute anchored`|
 |PUSH||Pushes stack register onto the stack, increments stack pointer|
 |POP||Pops stack into stack register, decrements stack pointer|
 |SYNC||Synchronises with the game tick. i.e. wait one tick before continuing|
@@ -161,6 +197,17 @@ into wherever the directive is.
 "Include headers". Does not load any code from the file, but pulls in the symbol table (subroutines, constants).  
 Useful for using library code already running in the game. (i.e. library was loaded sometime beforehand).
 
+#### `#event_handler label event_name condition1=value1;condition2=value2;...`
+
+Runs the subroutine with the given `label` whenever the named event is triggered and the conditions match.
+The following is an example where the function `on_placed_stone` will get invoked every time a player places
+a stone block.
+
+```
+#event_handler on_placed_stone minecraft:placed_block item.item=minecraft:stone
+on_placed_stone:
+    ...
+```
 
 ## Memory locations
 
@@ -183,9 +230,11 @@ The assembler is invoked by calling `main.py`.
 
 Command line parameters:
 ```
-usage: main.py [-h] [--world-dir WORLD_DIR] [--namespace NAMESPACE]
+usage: main.py [-h] [--world-dir WORLD_DIR] [--as_zip] [--namespace NAMESPACE]
                [--rem-existing] [--debug] [--stack STACK] [--arg ARG]
                [--jump JUMP] [--place-location PLACE_LOCATION] [--enable-sync]
+               [--setup-on-load] [--spawn-location SPAWN_LOCATION]
+               [--pack-description PACK_DESCRIPTION]
                file
 
 positional arguments:
@@ -195,6 +244,7 @@ optional arguments:
   -h, --help            show this help message and exit
   --world-dir WORLD_DIR
                         World Directory
+  --as_zip              Write datapack as zip file
   --namespace NAMESPACE
                         Function namespace
   --rem-existing        Remove existing functions in namespace
@@ -205,6 +255,11 @@ optional arguments:
   --place-location PLACE_LOCATION
                         Location to place command blocks
   --enable-sync         Enable SYNC opcode
+  --setup-on-load       Run setup on minecraft:load
+  --spawn-location SPAWN_LOCATION
+                        Location to spawn hidden armor stand
+  --pack-description PACK_DESCRIPTION
+                        Datapack description
 ```
 
 Notes:

README_C.md

@@ -12,24 +12,27 @@ which is a 32 bit signed integer.
 
 The compiler is invoked by calling `compiler_main.py`.
 
-The parameters are similar to the assembler, with the addition of `--page-size` and `--dump-asm`.
-
-
 Command line parameters:
 ```
-usage: compiler_main.py [-h] [--world-dir WORLD_DIR] [--namespace NAMESPACE]
-                        [--rem-existing] [--debug] [--stack STACK] [--arg ARG]
+usage: compiler_main.py [-h] [-E] [-S] [--world-dir WORLD_DIR] [--as_zip]
+                        [--namespace NAMESPACE] [--rem-existing] [--debug]
+                        [--stack STACK] [--arg ARG]
                         [--place-location PLACE_LOCATION] [--enable-sync]
-                        [--page-size PAGE_SIZE] [--dump-asm]
+                        [--page-size PAGE_SIZE] [--setup-on-load]
+                        [--spawn-location SPAWN_LOCATION]
+                        [--pack-description PACK_DESCRIPTION]
                         file
 
 positional arguments:
   file                  C File
 
 optional arguments:
   -h, --help            show this help message and exit
+  -E                    Only run preprocessor. Outputs to stdout
+  -S                    Don't run assembler. Outputs ASM to stdout
   --world-dir WORLD_DIR
                         World Directory
+  --as_zip              Write datapack as zip file
   --namespace NAMESPACE
                         Function namespace
   --rem-existing        Remove existing functions in namespace
@@ -41,10 +44,14 @@ optional arguments:
   --enable-sync         Enable SYNC opcode
   --page-size PAGE_SIZE
                         Memory page size
-  --dump-asm            Dump generated ASM
+  --setup-on-load       Run setup on minecraft:load
+  --spawn-location SPAWN_LOCATION
+                        Location to spawn hidden armor stand
+  --pack-description PACK_DESCRIPTION
+                        Datapack description
 ```
 
 There are some examples in the [examples](https://github.com/simon816/Command-Block-Assembly/tree/master/examples) directory.
 
-The [mclib.h](https://github.com/simon816/Command-Block-Assembly/blob/master/examples/mclib.h) file
+The [mclib.h](https://github.com/simon816/Command-Block-Assembly/blob/master/compiler/include/mclib.h) file
 contains several useful macros and definitions.

assembler.py

@@ -787,9 +787,11 @@ def handle_execute_face_pos(self, lbl, x, y, z):
         self._execute_chain_helper(lbl, ExecuteChain().facing(
             self._read_pos(x, y, z)))
 
-    def handle_execute_face_entity(self, lbl, sel_type, *pairs):
+    def handle_execute_face_entity(self, lbl, feature, sel_type, *pairs):
+        arg_type, feature = feature
+        assert arg_type == 'string'
         self._execute_chain_helper(lbl, ExecuteChain().facing_entity(
-            self._read_selector(sel_type, pairs)))
+            self._read_selector(sel_type, pairs), feature))
 
     def handle_execute_rotate(self, lbl, y, x):
         y, x = self.resolve_ref(*y), self.resolve_ref(*x)

compiler/include/block.h

@@ -0,0 +1,15 @@
+/**
+ *  block.h
+ *
+ *  Block utilities.
+ */
+
+
+#ifndef __BLOCK_H
+#define __BLOCK_H
+
+int is_block(const char *location, const char *block_id, ...);
+
+void set_block(const char *location, const char *block_id, ...);
+
+#endif /* __BLOCK_H */

compiler/include/entity.h

@@ -39,4 +39,10 @@ void remove_tag_this_entity(const char *tag);
 
 void set_scoreboard_tracking(entity_local variable, const char *criterion);
 
+void set_this_entity_rotation(int yaw, int pitch);
+
+void summon_entity(const char *entity_name, const char *location, const char *nbt);
+
+void kill_this_entity();
+
 #endif /* __ENTITY_H */

examples/mclib.h compiler/include/mclib.hexamples/mclib.h renamed to compiler/include/mclib.h

@@ -6,7 +6,7 @@
 
 
 #ifndef __MCLIB_H
-#define __MCLIB_H 1
+#define __MCLIB_H
 
 /**
  *  Stringify (add quotes to) the bare word argument

compiler/lib/__init__.py

@@ -3,7 +3,8 @@ def load():
     from . import \
          builtin, \
          stdio, \
-         entity
+         entity, \
+         block
 
     return locals()
 

compiler/lib/block.py

@@ -0,0 +1,42 @@
+from ..ir import IR
+
+def make_block_name(block_id, props):
+    prop_dict = {}
+    for prop in props:
+        key, value = prop.split('=')
+        prop_dict[key.strip()] = value.strip()
+    return block_id + ('' if not props else '[%s]' % ','.join(
+        '%s=%s' % item for item in prop_dict.items()))
+
+def is_block(visitor, expr):
+    assert len(expr.args) >= 2, "is_block takes at least 2 arguments"
+    args = []
+    for arg in expr.args:
+        arg_val = visitor.visit_expression(arg)
+        assert isinstance(arg_val, IR.LiteralString), \
+               "All arguments to is_block must be constant strings"
+        args.append(arg_val)
+    loc, block, *props = map(lambda a:a.val, args)
+    # TODO possible use of ExecSel
+    cmd = 'execute if block %s %s' % (loc, make_block_name(block, props))
+    res = IR.Slot(visitor.type('int'))
+    visitor.emit(IR.Test(cmd, res))
+    return res
+
+def set_block(visitor, expr):
+    assert len(expr.args) >= 2, "set_block takes at least 2 arguments"
+    args = []
+    for arg in expr.args:
+        arg_val = visitor.visit_expression(arg)
+        assert isinstance(arg_val, IR.LiteralString), \
+               "All arguments to set_block must be constant strings"
+        args.append(arg_val)
+    loc, block, *props = map(lambda a:a.val, args)
+    cmd = 'setblock %s %s' % (loc, make_block_name(block, props))
+    visitor.emit(IR.Asm((('CMD ' + cmd, None, None),)))
+
+def exports():
+    return {
+        'is_block': is_block,
+        'set_block': set_block,
+    }

compiler/lib/entity.py

@@ -30,9 +30,33 @@ def set_tracking(visitor, expr):
     visitor.emit(IR.Asm((('CMD ' + rem_old, None, None),)))
     visitor.emit(IR.Asm((('CMD ' + add_new, None, None),)))
 
+def set_rotation(visitor, expr):
+    assert len(expr.args) == 2
+    yaw, pitch = map(visitor.visit_expression, expr.args)
+    assert isinstance(yaw, IR.LiteralInt)
+    assert isinstance(pitch, IR.LiteralInt)
+    visitor.emit(IR.Asm((('CMD tp @s ~ ~ ~ %d %d'
+                          % (yaw.val, pitch.val), None, None),)))
+
+def summon_entity(visitor, expr):
+    assert len(expr.args) == 3
+    name, loc, nbt = map(visitor.visit_expression, expr.args)
+    assert isinstance(name, IR.LiteralString)
+    assert isinstance(loc, IR.LiteralString)
+    assert isinstance(nbt, IR.LiteralString)
+    visitor.emit(IR.Asm((('CMD summon %s %s %s'
+                          % (name.val, loc.val, nbt.val), None, None),)))
+
+def kill_this_entity(visitor, expr):
+    assert len(expr.args) == 0
+    visitor.emit(IR.Asm((('CMD kill @s', None, None),)))
+
 def exports():
     return {
         'add_tag_this_entity': add_tag,
         'remove_tag_this_entity': remove_tag,
         'set_scoreboard_tracking': set_tracking,
+        'set_this_entity_rotation': set_rotation,
+        'summon_entity': summon_entity,
+        'kill_this_entity': kill_this_entity,
     }