examples: annotate examples

[nit.git] / contrib / nitcc / examples / minilang.nit

diff --git a/contrib/nitcc/examples/minilang.nit b/contrib/nitcc/examples/minilang.nit
index c639f14..3d587b3 100644 (file)
--- a/contrib/nitcc/examples/minilang.nit
+++ b/contrib/nitcc/examples/minilang.nit
@@ -1,49 +1,59 @@
+module minilang is example
+
 import minilang_test_parser
 
+# An naive recursive stack-based interpreter of the minilang language.
 class Interpretor
        super Visitor
+
+       # A stack of numeric values
        var stack = new Array[Int]
+
+       # A stack of boolean values
        var bstack = new Array[Bool]
+
+       # The current values assigned to each variable
        var vars = new HashMap[String, Int]
 
-       redef fun visit(n) do n.accept_calculator(self)
+       redef fun visit(n) do n.accept_minilang(self)
 end
 
 redef class Node
-       fun accept_calculator(v: Interpretor) do visit_children(v)
+       # Execution of the node by the interpreter `v`
+       fun accept_minilang(v: Interpretor) do visit_children(v)
 end
 
 redef class Nint
-       redef fun accept_calculator(v) do v.stack.push(text.to_i)
+       redef fun accept_minilang(v) do v.stack.push(text.to_i)
 end
 
 redef class Ns_assign
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                v.vars[n_id.text] = v.stack.pop
        end
 end
 
 redef class Ns_print
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                printn v.stack.pop
        end
 end
 redef class Ns_print_str
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                var text = n_str.text
                text = text.substring(1, text.length-2)
                printn text
        end
 end
 redef class Ns_println
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                print ""
        end
 end
 redef class Ns_if
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                v.enter_visit(n_c)
                if v.bstack.pop then
                        v.enter_visit(n_then)
@@ -54,7 +64,7 @@ redef class Ns_if
        end
 end
 redef class Ns_while
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                loop
                        v.enter_visit(n_c)
                        if not v.bstack.pop then break
@@ -65,7 +75,7 @@ end
 
 
 redef class Nc_and
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                var b1 = v.bstack.pop
                var b2 = v.bstack.pop
@@ -74,7 +84,7 @@ redef class Nc_and
 end
 
 redef class Nc_or
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                var b1 = v.bstack.pop
                var b2 = v.bstack.pop
@@ -83,99 +93,99 @@ redef class Nc_or
 end
 
 redef class Nc_not
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                v.bstack.push(not v.bstack.pop)
        end
 end
 
 redef class Nc_eq
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                v.bstack.push(v.stack.pop == v.stack.pop)
        end
 end
 
 redef class Nc_ne
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                v.bstack.push(v.stack.pop != v.stack.pop)
        end
 end
 
 redef class Nc_lt
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                v.bstack.push(v.stack.pop > v.stack.pop)
        end
 end
 
 redef class Nc_le
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                v.bstack.push(v.stack.pop >= v.stack.pop)
        end
 end
 
 redef class Nc_gt
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                v.bstack.push(v.stack.pop < v.stack.pop)
        end
 end
 
 redef class Nc_ge
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                v.bstack.push(v.stack.pop <= v.stack.pop)
        end
 end
 
 redef class Ne_add
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                v.stack.push(v.stack.pop+v.stack.pop)
        end
 end
 redef class Ne_sub
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                var n1 = v.stack.pop
                v.stack.push(v.stack.pop-n1)
        end
 end
 redef class Ne_neg
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                v.stack.push(-v.stack.pop)
        end
 end
 redef class Ne_mul
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                v.stack.push(v.stack.pop*v.stack.pop)
        end
 end
 redef class Ne_div
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                super
                var n1 = v.stack.pop
                v.stack.push(v.stack.pop/n1)
        end
 end
 redef class Ne_var
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                v.stack.push v.vars[n_id.text]
        end
 end
 redef class Ne_read
-       redef fun accept_calculator(v) do
+       redef fun accept_minilang(v) do
                var t = gets
                v.stack.push(t.to_i)
        end
 end
 
-var t = new MyTest
+var t = new TestParser_minilang
 var n = t.main
 
 var v = new Interpretor