loxxy 0.2.04 → 0.3.02

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d628b0737a29bab0869827af50a363846200bfab7baddc63279e0e3fb904fa75
-  data.tar.gz: d617939297fe24cf267fb66c198cbc172e05a7df4472eac546bd9b5e27eef0cd
+  metadata.gz: a0e398714d64763c288f06c315611c86bf3dae2e3403055ae3ca240a10bd292f
+  data.tar.gz: 8db95e837824181e1794277dc3e67e4005432006877124bbd62ffd07def57591
 SHA512:
-  metadata.gz: dde10867e0a0243a5c0e2349a37df2ec76178aa2a7da625abd42363175301bf773d8d56aa249dde380361b13af5181c33a8ed65a4cf1bd2bbdaf2c946b534f99
-  data.tar.gz: 204243d4d781f54820a66d483d791676d144b3a4af7febbb2a1a27041c651d2ea4a0015e2bf3408754c9ea31dc0f66b4c6b0d8ad6175edc5912391331f95e9e1
+  metadata.gz: caf2aab9a8c03997fbde67467b7cb66a786c2fb8ef46fc24869c42ac7da76831f5e771a282c938ec83585666de801602ffc9818fc489454ec93dec9bd76bf5a7
+  data.tar.gz: 9d98db7d9bddec915929dc1cbaed057248ccb5e0cc63efc3d0d7e99536ea9b330925d91d6b1ffd6805194dc3805b0025228f66d11f11b5455cb8f52d7753e6eb

data/CHANGELOG.md

@@ -1,3 +1,67 @@
+## [0.3.02] - 2021-05-22
+- New built-in expressions `getc`, `chr`, `exit` and `print_eeror` , fixes with deeply nested returns, set expressions
+
+### New
+- Class `BackEnd::Engine` new built-in functions `getc`, `chr`, `exit`, and `print_error`
+
+### Changed
+- Class `Ast::LoxSetExpr` value to assign is now a distinct atrrbute instead of a subnode
+-  Class `BackEnd::Engine` two distinct stacks: one of expression evaluation, another for argument passing
+
+### Fixed
+- Class `BackEnd::LoxClass`: in some contexts the init method returned twice 'this'.
+- Method `LoxFunction#call` mismatch between deeply nested returns and environments
+
+
+## [0.3.01] - 2021-05-08
+- Fix in `Scanner` class, added more tests in test suite.
+
+### New
+- Added the new subfolder `extra` under `test_suite`. It will contain tests for non-standard features or tests not covered in standard test suite.
+
+### Fixed
+- Class `FrontEnd::Scanner`: Couldn't correctly recognize a plus preceding directly a number literal
+
+## [0.3.00] - 2021-05-07
+- Milestone: `Loxxy` passes all reference test suite.
+
+### Fixed
+- Method `BackEnd::Resolver#before_variable_expr`: Standard `Lox` allows re-declaration of a variable at top-level scope 
+
+ 
+## [0.2.06] - 2021-05-04
+- Nearly passing the 'official' test suite, fixing non-compliant behavior, specialized exceptions for errors
+
+### New
+- Module `LoxFileTester` module that hosts methods that simplify the tests of `Lox` source file. 
+
+### Changed
+- Folder `test_suite` vastly reorganized. Sub-folder `baseline` contains spec files testing the `Lox` files from official implementation
+- Class `BackEnd::Engine` replaced most `StandardError` by `Loxxy::RuntimeError` exception.
+- Class `BackEnd::Resolver` replaced most `StandardError` by `Loxxy::RuntimeError` exception.
+- Method `Datatype::Number#/` now handles correctly expression like `0/0` (integer divide)
+
+### Fixed
+- `0/0` expression results in a ZeroDivisionError exception, in Lox this result to a NaN (Not a Number). Now, `Loxxy` is aligned to standard `Lox`
+- `FrontEnd::Scanner` now always treats expression like `-123` as the unary or binary minus operator applied to a positive number. 
+
+## [0.2.05] - 2021-04-26
+- `Loxxy` now transforms for loops into while loops (desugaring), fix in Scanner class
+
+### Changed
+- Method `Ast::ASTBuilder#reduce_for_stmt` converts 'for' loops into 'while' loops
+- Method `Ast::ASTBuilder#reduce_for_control takes care of case for(expr1;;expr2) now test expression is set to true
+
+### Fixed
+- Method `FrontEnd::Scanner#next_token` keyword recognition was case insensitive
+
+### Removed
+- Method `Ast::Visitor#visitor_for_stmt`
+- Method `BackEnd::Engine#after_for_stmt`
+- Method `BackEnd::Resolver#before_for_stmt`
+- Method `BackEnd::Resolver#after_for_stmt`
+
+
 ## [0.2.04] - 2021-04-25
 - `Loxxy` passes the test suite for `for` statements
 

data/README.md

@@ -19,11 +19,17 @@ Although __Lox__ is fairly simple, it is far from being a toy language:
 ### Loxxy gem features
 - Complete tree-walking interpreter including lexer, parser and resolver
 - 100% pure Ruby with clean design (not a port from some other language)
+- Passes the `jox` (THE reference `Lox` implementation) test suite  
 - Minimal runtime dependency (Rley gem). Won't drag a bunch of gems...  
 - Ruby API for integrating a Lox interpreter with your code.
 - A command-line interpreter `loxxy`
 - Open for your language extensions...
 
+### Why `Loxxy` ?
+- If programming languages are one of your subject interest...
+- ... and you wanted learn how to implement one in Ruby...
+- ... then `Loxxy` can help to understand and experiment in this rewarding craft.
+
 ## How to start in 1, 2, 3...?
 ... in less than 3 minutes...
 

data/lib/loxxy/ast/all_lox_nodes.rb

@@ -19,7 +19,6 @@ require_relative 'lox_while_stmt'
 require_relative 'lox_return_stmt'
 require_relative 'lox_print_stmt'
 require_relative 'lox_if_stmt'
-require_relative 'lox_for_stmt'
 require_relative 'lox_var_stmt'
 require_relative 'lox_class_stmt'
 require_relative 'lox_seq_decl'

data/lib/loxxy/ast/ast_builder.rb

@@ -225,16 +225,39 @@ module Loxxy
       end
 
       # rule('forStmt' => 'FOR LEFT_PAREN forControl RIGHT_PAREN statement')
-      def reduce_for_stmt(_production, _range, _tokens, theChildren)
-        for_stmt = theChildren[2]
-        for_stmt.body_stmt = theChildren[4]
+      def reduce_for_stmt(_production, _range, tokens, theChildren)
+        # Following 'Crafting Interpreters', we replace the for statement by a while loop
+        return theChildren[4] if theChildren[2].compact.empty? # for(;;) => execute body once
+
+        (init, test, update) = theChildren[2]
+        if update
+          new_body = LoxSeqDecl.new(tokens[0].position, [theChildren[4], update])
+          stmt = Ast::LoxBlockStmt.new(tokens[1].position, new_body)
+        else
+          stmt = theChildren[4]
+        end
+        while_stmt = Ast::LoxWhileStmt.new(tokens[0].position, test, stmt)
+
+        if init
+          block_body = LoxSeqDecl.new(tokens[0].position, [init, while_stmt])
+          for_stmt = Ast::LoxBlockStmt.new(tokens[1].position, block_body)
+        else
+          for_stmt = while_stmt
+        end
+
         for_stmt
       end
 
       # rule('forControl' => 'forInitialization forTest forUpdate')
       def reduce_for_control(_production, _range, tokens, theChildren)
         (init, test, update) = theChildren
-        Ast::LoxForStmt.new(tokens[0].position, init, test, update)
+        if test.nil? && update
+          # when test expr is nil but update expr is not, then force test to be true
+          test = LoxLiteralExpr.new(tokens[0].position, Datatype::True.instance)
+          [init, test, update]
+        else
+          theChildren
+        end
       end
 
       # rule('forInitialization' => 'SEMICOLON')
@@ -295,7 +318,7 @@ module Loxxy
         name_assignee = theChildren[1].token.lexeme.dup
         if theChildren[0].kind_of?(Ast::LoxSetExpr)
           theChildren[0].property = name_assignee
-          theChildren[0].subnodes << theChildren[3]
+          theChildren[0].value = theChildren[3]
           theChildren[0]
         else
           Ast::LoxAssignExpr.new(tokens[1].position, name_assignee, theChildren[3])

data/lib/loxxy/ast/ast_visitor.rb

@@ -75,14 +75,6 @@ module Loxxy
         broadcast(:after_class_stmt, aClassStmt, self)
       end
 
-      # Visit event. The visitor is about to visit a for statement.
-      # @param aForStmt [AST::LOXForStmt] the for statement node to visit
-      def visit_for_stmt(aForStmt)
-        broadcast(:before_for_stmt, aForStmt)
-        traverse_subnodes(aForStmt) # The condition is visited/evaluated here...
-        broadcast(:after_for_stmt, aForStmt, self)
-      end
-
       # Visit event. The visitor is about to visit a if statement.
       # @param anIfStmt [AST::LOXIfStmt] the if statement node to visit
       def visit_if_stmt(anIfStmt)
@@ -111,7 +103,7 @@ module Loxxy
       # @param aWhileStmt [AST::LOXWhileStmt] the while statement node to visit
       def visit_while_stmt(aWhileStmt)
         broadcast(:before_while_stmt, aWhileStmt)
-        traverse_subnodes(aWhileStmt) # The condition is visited/evaluated here...
+        traverse_subnodes(aWhileStmt) if aWhileStmt.condition # The condition is visited/evaluated here...
         broadcast(:after_while_stmt, aWhileStmt, self)
       end
 
@@ -134,7 +126,6 @@ module Loxxy
       # @param aSetExpr [AST::LOXGetExpr] the get expression node to visit
       def visit_set_expr(aSetExpr)
         broadcast(:before_set_expr, aSetExpr, self)
-        traverse_subnodes(aSetExpr)
         broadcast(:after_set_expr, aSetExpr, self)
       end
 

data/lib/loxxy/ast/lox_set_expr.rb

@@ -4,17 +4,20 @@ require_relative 'lox_compound_expr'
 
 module Loxxy
   module Ast
-    class LoxSetExpr < LoxCompoundExpr
+    class LoxSetExpr < LoxNode
       # @return [Ast::LoxNode] the object to which the property belongs to
       attr_reader :object
 
       # @return [String] Name of an object property
       attr_accessor :property
 
+      # @return [LoxNode, Datatype] value to assign
+      attr_accessor :value
+
       # @param aPosition [Rley::Lexical::Position] Position of the entry in the input stream.
       # @param anObject [Ast::LoxNode] The object which the given property is being set
       def initialize(aPosition, anObject)
-        super(aPosition, [])
+        super(aPosition)
         @object = anObject
       end
 

data/lib/loxxy/back_end/engine.rb

@@ -20,7 +20,7 @@ module Loxxy
       # @return [BackEnd::SymbolTable]
       attr_reader :symbol_table
 
-      # @return [Array<Datatype::BuiltinDatatype>] Data stack for the expression results
+      # @return [Array<Datatype::BuiltinDatatype>] Data stack for arguments and return results
       attr_reader :stack
 
      # @return [Hash { Symbol => UnaryOperator}]
@@ -35,17 +35,31 @@ module Loxxy
       # @param theOptions [Hash]
       def initialize(theOptions)
         @config = theOptions
+        @istream = config.include?(:istream) ? config[:istream] : $stdin
         @ostream = config.include?(:ostream) ? config[:ostream] : $stdout
         @symbol_table = SymbolTable.new
         @stack = []
-        @unary_operators = {}
-        @binary_operators = {}
 
+        reset_expr_stack
         init_unary_operators
         init_binary_operators
         init_globals
       end
 
+      # Returns the current environment
+      # @return [Loxxy::BackEnd::Environment]
+      def current_env
+        symbol_table.current_env
+      end
+
+      def expr_stack
+        current_env.expr_stack
+      end
+
+      def reset_expr_stack
+        current_env.expr_stack.clear
+      end
+
       # Given an abstract syntax parse tree visitor, launch the visit
       # and execute the visit events in the output stream.
       # @param aVisitor [AST::ASTVisitor]
@@ -58,7 +72,7 @@ module Loxxy
         aVisitor.subscribe(self)
         aVisitor.start
         aVisitor.unsubscribe(self)
-        stack.empty? ? Datatype::Nil.instance : stack.pop
+        expr_stack.empty? ? Datatype::Nil.instance : expr_stack.pop
       end
 
       ##########################################################################
@@ -69,12 +83,16 @@ module Loxxy
         # Do nothing, subnodes were already evaluated
       end
 
+      def before_class_stmt(_class_stmt)
+        reset_expr_stack
+      end
+
       def after_class_stmt(aClassStmt, aVisitor)
         if aClassStmt.superclass
           aClassStmt.superclass.accept(aVisitor)
-          parent = stack.pop
+          parent = expr_stack.pop
           unless parent.kind_of?(LoxClass)
-            raise StandardError, 'Superclass must be a class.'
+            raise Loxxy::RuntimeError, 'Superclass must be a class.'
           end
         else
           parent = nil
@@ -89,7 +107,7 @@ module Loxxy
         meths = aClassStmt.body.map do |func_node|
           func_node.is_method = true
           func_node.accept(aVisitor)
-          mth = stack.pop
+          mth = expr_stack.pop
           mth.is_initializer = true if mth.name == 'init'
           mth
         end
@@ -104,11 +122,15 @@ module Loxxy
         symbol_table.insert(new_var)
       end
 
+      def before_var_stmt(_var_stmt)
+        reset_expr_stack
+      end
+
       def after_var_stmt(aVarStmt)
         new_var = Variable.new(aVarStmt.name, Datatype::Nil.instance)
         symbol_table.insert(new_var)
 
-        value = stack.pop
+        value = expr_stack.pop
         new_var.assign(value)
       end
 
@@ -116,31 +138,14 @@ module Loxxy
         before_block_stmt(aForStmt)
       end
 
-      def after_for_stmt(aForStmt, aVisitor)
-        iterating = false
-
-        loop do
-          if aForStmt.test_expr
-            aForStmt.test_expr.accept(aVisitor)
-            condition = stack.pop
-            break unless condition.truthy?
-          elsif iterating
-            # when both test and update expressions are nil => execute body once
-            break unless aForStmt.update_expr
-          else
-            iterating = true
-          end
-
-          aForStmt.body_stmt.accept(aVisitor)
-          aForStmt.update_expr&.accept(aVisitor)
-          stack.pop
-        end
-        after_block_stmt(aForStmt)
+      def before_if_stmt(_if_stmt)
+        reset_expr_stack
       end
 
       def after_if_stmt(anIfStmt, aVisitor)
         # Retrieve the result of the condition evaluation
-        condition = stack.pop
+        # condition = stack.pop
+        condition = expr_stack.pop
         if condition.truthy?
           anIfStmt.then_stmt.accept(aVisitor)
         elsif anIfStmt.else_stmt
@@ -148,26 +153,40 @@ module Loxxy
         end
       end
 
+      def before_print_stmt(_print_stmt)
+        reset_expr_stack
+      end
+
       def after_print_stmt(_printStmt)
-        tos = stack.pop
+        tos = expr_stack.pop
         @ostream.print tos ? tos.to_str : 'nil'
       end
 
+      def before_return_stmt(_return_stmt)
+        reset_expr_stack
+      end
+
       def after_return_stmt(_returnStmt, _aVisitor)
+        stack.push(expr_stack.pop)
         throw(:return)
       end
 
+      def before_while_stmt(_while_stmt)
+        reset_expr_stack
+      end
+
       def after_while_stmt(aWhileStmt, aVisitor)
         loop do
-          condition = stack.pop
+          condition = expr_stack.pop
           break unless condition.truthy?
 
           aWhileStmt.body.accept(aVisitor)
-          aWhileStmt.condition.accept(aVisitor)
+          aWhileStmt.condition&.accept(aVisitor)
         end
       end
 
       def before_block_stmt(_aBlockStmt)
+        reset_expr_stack
         new_env = Environment.new
         symbol_table.enter_environment(new_env)
       end
@@ -179,42 +198,44 @@ module Loxxy
       def after_assign_expr(anAssignExpr, _visitor)
         var_name = anAssignExpr.name
         variable = variable_lookup(anAssignExpr)
-        raise StandardError, "Unknown variable #{var_name}" unless variable
+        raise Loxxy::RuntimeError, "Undefined variable '#{var_name}'." unless variable
 
-        value = stack.last # ToS remains since an assignment produces a value
+        value = expr_stack.last # ToS remains since an assignment produces a value
         variable.assign(value)
       end
 
-      def before_set_expr(aSetExpr, aVisitor)
-        # Evaluate receiver object part
-        aSetExpr.object.accept(aVisitor)
+      def before_set_expr(_set_expr, _visitor)
+        reset_expr_stack
       end
 
-      def after_set_expr(aSetExpr, _visitor)
-        value = stack.pop
-        assignee = stack.pop
+      def after_set_expr(aSetExpr, aVisitor)
+        # Evaluate receiver object part (i.e. 'this')
+        aSetExpr.object.accept(aVisitor)
+        assignee = expr_stack.pop
         unless assignee.kind_of?(LoxInstance)
           raise Loxxy::RuntimeError, 'Only instances have fields.'
         end
 
+        aSetExpr.value.accept(aVisitor)
+        value = expr_stack.pop
+
         assignee.set(aSetExpr.property, value)
-        stack.push value
+        expr_stack.push value
       end
 
       def after_logical_expr(aLogicalExpr, visitor)
         op = aLogicalExpr.operator
-        operand1 = stack.pop # only first operand was evaluated
+        operand1 = expr_stack.pop # only first operand was evaluated
         result = nil
         if ((op == :and) && operand1.falsey?) || ((op == :or) && operand1.truthy?)
           result = operand1
         else
           raw_operand2 = aLogicalExpr.subnodes[1]
           raw_operand2.accept(visitor) # Visit means operand2 is evaluated
-          operand2 = stack.pop
+          operand2 = expr_stack.pop
           result = logical_2nd_arg(operand2)
         end
-
-        stack.push result
+        expr_stack.push result
       end
 
       def logical_2nd_arg(operand2)
@@ -234,13 +255,14 @@ module Loxxy
       end
 
       def after_binary_expr(aBinaryExpr)
-        operand2 = stack.pop
-        operand1 = stack.pop
+        operand2 = expr_stack.pop
+        operand1 = expr_stack.pop
         op = aBinaryExpr.operator
         operator = binary_operators[op]
         operator.validate_operands(operand1, operand2)
         if operand1.respond_to?(op)
-          stack.push operand1.send(op, operand2)
+          result = operand1.send(op, operand2)
+          expr_stack.push convert2lox_datatype(result)
         else
           msg1 = "`#{op}': Unimplemented operator for a #{operand1.class}."
           raise StandardError, msg1
@@ -248,12 +270,13 @@ module Loxxy
       end
 
       def after_unary_expr(anUnaryExpr)
-        operand = stack.pop
+        operand = expr_stack.pop
         op = anUnaryExpr.operator
         operator = unary_operators[op]
         operator.validate_operand(operand)
         if operand.respond_to?(op)
-          stack.push operand.send(op)
+          result = operand.send(op)
+          expr_stack.push convert2lox_datatype(result)
         else
           msg1 = "`#{op}': Unimplemented operator for a #{operand.class}."
           raise StandardError, msg1
@@ -263,12 +286,17 @@ module Loxxy
       def after_call_expr(aCallExpr, aVisitor)
         # Evaluate callee part
         aCallExpr.callee.accept(aVisitor)
-        callee = stack.pop
+        callee = expr_stack.pop
+        before_size = expr_stack.size
         aCallExpr.arguments.reverse_each { |arg| arg.accept(aVisitor) }
+        after_size = expr_stack.size
+        if after_size > before_size
+          stack.concat(expr_stack.pop(after_size - before_size))
+        end
 
         case callee
         when NativeFunction
-          stack.push callee.call # Pass arguments
+          expr_stack.push callee.call # Pass arguments
         when LoxFunction, LoxClass
           arg_count = aCallExpr.arguments.size
           if arg_count != callee.arity
@@ -283,12 +311,12 @@ module Loxxy
 
       def after_get_expr(aGetExpr, aVisitor)
         aGetExpr.object.accept(aVisitor)
-        instance = stack.pop
+        instance = expr_stack.pop
         unless instance.kind_of?(LoxInstance)
           raise Loxxy::RuntimeError, 'Only instances have properties.'
         end
 
-        stack.push instance.get(aGetExpr.property)
+        expr_stack.push instance.get(aGetExpr.property)
       end
 
       def after_grouping_expr(_groupingExpr)
@@ -305,7 +333,7 @@ module Loxxy
 
       # @param literalExpr [Ast::LoxLiteralExpr]
       def before_literal_expr(literalExpr)
-        stack.push(literalExpr.literal)
+        expr_stack.push(literalExpr.literal)
       end
 
       def after_this_expr(aThisExpr, aVisitor)
@@ -321,21 +349,25 @@ module Loxxy
         superklass = variable_lookup(aSuperExpr).value.superclass
         method = superklass.find_method(aSuperExpr.property)
         unless method
-          raise StandardError, "Undefined property '#{aSuperExpr.property}'."
+          raise Loxxy::RuntimeError, "Undefined property '#{aSuperExpr.property}'."
         end
 
-        stack.push method.bind(instance)
+        expr_stack.push method.bind(instance)
       end
 
       # @param aValue [Ast::BuiltinDattype] the built-in datatype value
       def before_visit_builtin(aValue)
-        stack.push(aValue)
+        expr_stack.push(aValue)
+      end
+
+      def before_fun_stmt(_fun_stmt, _visitor)
+        reset_expr_stack
       end
 
       def after_fun_stmt(aFunStmt, _visitor)
         function = LoxFunction.new(aFunStmt.name, aFunStmt.params, aFunStmt.body, self)
         if aFunStmt.is_method
-          stack.push function
+          expr_stack.push function
         else
           new_var = Variable.new(aFunStmt.name, function)
           symbol_table.insert(new_var)
@@ -357,30 +389,20 @@ module Loxxy
         env.defns[aVarNode.name]
       end
 
-      NativeFunction = Struct.new(:callable, :interp) do
-        def accept(_visitor)
-          interp.stack.push self
-        end
-
-        def call
-          callable.call
-        end
-
-        def to_str
-          '<native fn>'
-        end
-      end
-
       def init_unary_operators
+        @unary_operators = {}
+
         negate_op = UnaryOperator.new('-', [Datatype::Number])
         unary_operators[:-@] = negate_op
 
         negation_op = UnaryOperator.new('!', [Datatype::BuiltinDatatype,
-          BackEnd::LoxFunction])
+          BackEnd::LoxInstance, BackEnd::LoxFunction, BackEnd::LoxClass])
         unary_operators[:!] = negation_op
       end
 
       def init_binary_operators
+        @binary_operators = {}
+
         plus_op = BinaryOperator.new('+', [[Datatype::Number, :idem],
           [Datatype::LXString, :idem]])
         binary_operators[:+] = plus_op
@@ -415,6 +437,24 @@ module Loxxy
 
       def init_globals
         add_native_fun('clock', native_clock)
+        add_native_fun('getc', native_getc)
+        add_native_fun('chr', native_chr)
+        add_native_fun('exit', native_exit)
+        add_native_fun('print_error', native_print_error)
+      end
+
+      NativeFunction = Struct.new(:callable, :interp) do
+        def accept(_visitor)
+          interp.expr_stack.push self
+        end
+
+        def call
+          callable.call
+        end
+
+        def to_str
+          '<native fn>'
+        end
       end
 
       def add_native_fun(aName, aProc)
@@ -430,6 +470,47 @@ module Loxxy
           Datatype::Number.new(now)
         end
       end
+
+      # Read a single character and return the character code as an integer.
+      def native_getc
+        proc do
+          ch = @istream.getc
+          Datatype::Number.new(ch.codepoints[0])
+        end
+      end
+
+      # chr(ch): Convert given character code number to a single-character string.
+      def native_chr
+        proc do
+          codepoint = stack.pop
+          Datatype::LXString.new(codepoint.value.chr)
+        end
+      end
+
+      # exit(status): Exit with given status code.
+      def native_exit
+        proc do
+          status = stack.pop
+          exit(status.value)
+        end
+      end
+
+      # print_error(message): Print message string on stderr.
+      def native_print_error
+        proc do
+          message = stack.pop
+          $stderr.print message.value
+        end
+      end
+
+      def convert2lox_datatype(item)
+        case item
+        when TrueClass then Datatype::True.instance
+        when FalseClass then Datatype::False.instance
+        else
+          item
+        end
+      end
     end # class
   end # module
 end # module