loxxy 0.1.03 → 0.1.08

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bf956c6e2d6736535acd1e9b0cb29df6b55a8d9002be073cb70bbf753fb06c9
-  data.tar.gz: 1f635dc69e588f01406cd988bf98d12b9ea398f36e249113a37b089788ef21cb
+  metadata.gz: 1724fce16b30fe2328ba31a725e92cc03f43ac7dee60fd54c68642c5a5639471
+  data.tar.gz: 0f045add2ebf55375ee63e94f3a7316984588d0133200f3f4ce45de3ae118157
 SHA512:
-  metadata.gz: dce93451a9efc548df45683f5772a5d5509c25a57969465f3ff9f48f8b5adcc642b7bb92b25d43658869b5b62d3108796964226c35130cb1492335dc6eaf8fe1
-  data.tar.gz: 881dfd881db0d2ec3e56b91ad14bc6dd0e0b91ba3839fa1efe09c3636aac575856e3e8c4d4a64a55e913a757a4f1d275cc843734ceda3a23ef597591cb282f3f
+  metadata.gz: 5e4a67161f2d6f6a89b237bdda4e1d096df1183eeb3a9b8ff4f1506d8b053bae265de73857faf82a225b77fad5d32faddfe07873d74e0e71a2839f113659c61b
+  data.tar.gz: 29d09adcb56231c4f7b7c911c16b978e4ec3e0608f754e8b80b971293b99ea96fcf2bb6cd55dec62a8acac00bde0fb9b93e86cc37ee11024faea8e8eb0a70d3f

data/CHANGELOG.md

@@ -1,5 +1,60 @@
+## [0.1.08] - 2021-03-27
+- `Loxxy` implements variable resolving and binding as described in Chapter 11 of "Crafting Interpreters" book.
+
+### New
+- Class `BackEnd::Resolver` implements the variable resolution (whenever a variable is in use, locate the declaration of that variable)
+
+### Changed
+- Class `Ast::Visitor` changes in some method signatures
+- Class `BackEnd::Engine` new attribute `resolver` that points to a `BackEnd::Resolver` instance
+- Class `BackEnd::Engine` several methods dealing with variables have been adapted to take the resolver into account.
+
+## [0.1.07] - 2021-03-14
+- `Loxxy` now supports nested functions and closures
+
+### Changed
+- Method `Ast::AstBuilder#reduce_call_expr` now supports nested call expressions (e.g. `getCallback()();` )
+- Class `BackEnd::Environment`: added the attributes `predecessor` and `embedding` to support closures.
+- Class `BackeEnd::LoxFunction`: added the attribute `closure` that is equal to the environment where the function is declared.
+- Constructor `BackEnd::LoxFunction#new` now takes a `BackEnd::Engine`as its fourth parameter
+- Methods `BackEnd::SymbolTable#enter_environment`, `BackEnd::SymbolTable#leave_environment` take into account closures. 
+
+### Fixed
+- Method `Ast::AstBuilder#after_var_stmt` now takes into account the value from the top of stack
+
+
+## [0.1.06] - 2021-03-06
+- Parameters/arguments checks in function declaration and call
+
+### Changed
+- Method `Ast::AstBuilder#reduce_call_arglist` raises a `Loxxy::RuntimeError` when more than 255 arguments are used.
+- Method `BackEnd::Engine#after_call_expr` raises a `Loxxy::RuntimeError` when argument count doesn't match the arity of function.
+
+- Class `BackEnd::Function` renamed to `LoxFunction`
+
+## [0.1.05] - 2021-03-05
+- Test for Fibbonacci recursive function is now passing.
+
+### Fixed
+- Method `BackEnd::Function#call` a call doesn't no more generate of TWO scopes
+
+## [0.1.04] - 2021-02-28
+
+### Added
+- Class `Ast::LoxReturnStmt` a node that represents a return statement
+- Method `Ast::ASTBuilder#reduce_return_stmt`
+- Method `Ast::ASTVisitor#visit_return_stmt` for visiting an `Ast::LoxReturnStmt` node
+- Method `BackEnd::Engine#after_return_stmt` to handle return statement
+- Method `BackEnd::Function#!` implementing the logical negation of a function (as value).
+- Test suite for logical operators (in project repository)
+- Test suite for block code
+- Test suite for call and function declaration (initial)
+
+### Changed
+- Method `BackEnd::Engine#after_call_expr` now generate a `catch` and `throw` events
+
 ## [0.1.03] - 2021-02-26
-- Runtime argument chacking for arithmetic and comparison operators
+- Runtime argument checking for arithmetic and comparison operators
 
 ### Added
 - Test suite for arithmetic and comparison operators (in project repository)
@@ -221,11 +276,11 @@
 - The interpreter can evaluate substraction between two numbers.
 
 ### Added
-- Method `Datatype::Number#-` implmenting the subtraction operation
+- Method `Datatype::Number#-` implementing the subtraction operation
 
 ### Changed
 - File `README.md` minor editorial changes.
-- File `lx_string_spec.rb` Added test for string concatentation
+- File `lx_string_spec.rb` Added test for string concatenation
 - File `number_spec.rb` Added tests for addition and subtraction operations
 - File `interpreter_spec.rb` Added tests for subtraction operation
 

data/README.md

@@ -4,7 +4,7 @@
 
 ### What is loxxy?
 A Ruby implementation of the [Lox programming language](https://craftinginterpreters.com/the-lox-language.html ),
-a simple language used in Bob Nystrom's online book [Crafting Interpreters](https://craftinginterpreters.com/ ).
+a simple language defined in Bob Nystrom's online book [Crafting Interpreters](https://craftinginterpreters.com/ ).
 
 ### Purpose of this project:
 - To deliver an open source example of a programming language fully implemented in Ruby  
@@ -13,12 +13,10 @@ a simple language used in Bob Nystrom's online book [Crafting Interpreters](http
   a Lox interpreter written in Lox.
 
 ### Current status
-The project is still in inception and the interpreter is being implemented...  
-Currently it can execute all allowed __Lox__ expressions and statements except:
-- Closures,  
-- Classes and objects.
+The interpreter currently it can execute all allowed __Lox__ expressions and statements except  
+object-oriented feaures (classes and objects).
 
-These will be implemented soon.
+Our intent is implement to these missing features in Q2 2021.
 
 
 ## What's the fuss about Lox?

data/lib/loxxy/ast/all_lox_nodes.rb

@@ -12,6 +12,7 @@ require_relative 'lox_logical_expr'
 require_relative 'lox_assign_expr'
 require_relative 'lox_block_stmt'
 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'

data/lib/loxxy/ast/ast_builder.rb

@@ -221,6 +221,11 @@ module Loxxy
         Ast::LoxPrintStmt.new(tokens[1].position, theChildren[1])
       end
 
+      # rule('returnStmt' => 'RETURN expression_opt SEMICOLON')
+      def reduce_return_stmt(_production, _range, tokens, theChildren)
+        Ast::LoxReturnStmt.new(tokens[1].position, theChildren[1])
+      end
+
       # rule('whileStmt' => 'WHILE LEFT_PAREN expression RIGHT_PAREN statement').as ''
       def reduce_while_stmt(_production, _range, tokens, theChildren)
         Ast::LoxWhileStmt.new(tokens[1].position, theChildren[2], theChildren[4])
@@ -255,20 +260,33 @@ module Loxxy
 
       # rule('call' => 'primary refinement_plus').as 'call_expr'
       def reduce_call_expr(_production, _range, _tokens, theChildren)
-        theChildren[1].callee = theChildren[0]
-        theChildren[1]
+        members = theChildren.flatten
+        call_expr = nil
+        loop do
+          (callee, call_expr) = members.shift(2)
+          call_expr.callee = callee
+          members.unshift(call_expr)
+          break if members.size == 1
+        end
+
+        call_expr
+      end
+
+      # rule('refinement_plus' => 'refinement_plus refinement')
+      def reduce_refinement_plus_more(_production, _range, _tokens, theChildren)
+        theChildren[0] << theChildren[1]
       end
 
       # rule('refinement_plus' => 'refinement').
       def reduce_refinement_plus_end(_production, _range, _tokens, theChildren)
-        theChildren[0]
+        theChildren
       end
 
       # rule('refinement' => 'LEFT_PAREN arguments_opt RIGHT_PAREN')
       def reduce_call_arglist(_production, _range, tokens, theChildren)
         args = theChildren[1] || []
         if args.size > 255
-          raise StandardError, "Can't have more than 255 arguments."
+          raise Loxxy::RuntimeError, "Can't have more than 255 arguments."
         end
 
         LoxCallExpr.new(tokens[0].position, args)
@@ -298,6 +316,10 @@ module Loxxy
       def reduce_function(_production, _range, _tokens, theChildren)
         first_child = theChildren.first
         pos = first_child.token.position
+        if theChildren[2] && theChildren[2].size > 255
+          msg = "Can't have more than 255 parameters."
+          raise Loxxy::SyntaxError, msg
+        end
         LoxFunStmt.new(pos, first_child.token.lexeme, theChildren[2], theChildren[4])
       end
 

data/lib/loxxy/ast/ast_visitor.rb

@@ -91,6 +91,14 @@ module Loxxy
         broadcast(:after_print_stmt, aPrintStmt)
       end
 
+      # Visit event. The visitor is about to visit a return statement.
+      # @param aReturnStmt [AST::LOXReturnStmt] the return statement node to visit
+      def visit_return_stmt(aReturnStmt)
+        broadcast(:before_return_stmt, aReturnStmt)
+        traverse_subnodes(aReturnStmt)
+        broadcast(:after_return_stmt, aReturnStmt, self)
+      end
+
       # Visit event. The visitor is about to visit a while statement node.
       # @param aWhileStmt [AST::LOXWhileStmt] the while statement node to visit
       def visit_while_stmt(aWhileStmt)
@@ -112,7 +120,7 @@ module Loxxy
       def visit_assign_expr(anAssignExpr)
         broadcast(:before_assign_expr, anAssignExpr)
         traverse_subnodes(anAssignExpr)
-        broadcast(:after_assign_expr, anAssignExpr)
+        broadcast(:after_assign_expr, anAssignExpr, self)
       end
 
       # Visit event. The visitor is about to visit a logical expression.
@@ -186,7 +194,7 @@ module Loxxy
       # Visit event. The visitor is about to visit a function statement node.
       # @param aFunStmt [AST::LoxFunStmt] function declaration to visit
       def visit_fun_stmt(aFunStmt)
-        broadcast(:before_fun_stmt, aFunStmt)
+        broadcast(:before_fun_stmt, aFunStmt, self)
         traverse_subnodes(aFunStmt)
         broadcast(:after_fun_stmt, aFunStmt, self)
       end

data/lib/loxxy/ast/lox_block_stmt.rb

@@ -20,8 +20,6 @@ module Loxxy
       def accept(visitor)
         visitor.visit_block_stmt(self)
       end
-
-      alias operands subnodes
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_fun_stmt.rb

@@ -26,8 +26,6 @@ module Loxxy
       def accept(visitor)
         visitor.visit_fun_stmt(self)
       end
-
-      alias operands subnodes
     end # class
     # rubocop: enable Style/AccessorGrouping
   end # module

data/lib/loxxy/ast/lox_grouping_expr.rb

@@ -16,8 +16,6 @@ module Loxxy
       def accept(visitor)
         visitor.visit_grouping_expr(self)
       end
-
-      alias operands subnodes
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_return_stmt.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'lox_compound_expr'
+
+module Loxxy
+  module Ast
+    class LoxReturnStmt < LoxCompoundExpr
+      # @param aPosition [Rley::Lexical::Position] Position of the entry in the input stream.
+      # @param anExpression [Ast::LoxNode] expression to return
+      def initialize(aPosition, anExpression)
+        super(aPosition, [anExpression])
+      end
+
+      # Part of the 'visitee' role in Visitor design pattern.
+      # @param visitor [Ast::ASTVisitor] the visitor
+      def accept(visitor)
+        visitor.visit_return_stmt(self)
+      end
+    end # class
+  end # module
+end # module

data/lib/loxxy/ast/lox_seq_decl.rb

@@ -10,8 +10,6 @@ module Loxxy
       def accept(visitor)
         visitor.visit_seq_decl(self)
       end
-
-      alias operands subnodes
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_var_stmt.rb

@@ -13,8 +13,8 @@ module Loxxy
       # @param aName [String] name of the variable
       # @param aValue [Loxxy::Ast::LoxNode, NilClass] initial value for the variable
       def initialize(aPosition, aName, aValue)
-        initial_value = aValue ? [aValue] : [Datatype::Nil.instance]
-        super(aPosition, initial_value)
+        initial_value = aValue || Datatype::Nil.instance
+        super(aPosition, [initial_value])
         @name = aName
       end
 

data/lib/loxxy/back_end/engine.rb

@@ -3,7 +3,8 @@
 # Load all the classes implementing AST nodes
 require_relative '../ast/all_lox_nodes'
 require_relative 'binary_operator'
-require_relative 'function'
+require_relative 'lox_function'
+require_relative 'resolver'
 require_relative 'symbol_table'
 require_relative 'unary_operator'
 
@@ -11,7 +12,6 @@ module Loxxy
   module BackEnd
     # An instance of this class executes the statements as when they
     # occur during the abstract syntax tree walking.
-    # @note WIP: very crude implementation.
     class Engine
       # @return [Hash] A set of configuration options
       attr_reader :config
@@ -19,7 +19,7 @@ module Loxxy
       # @return [BackEnd::SymbolTable]
       attr_reader :symbol_table
 
-      # @return [Array<Datatype::BuiltinDatatyp>] Stack for the values of expr
+      # @return [Array<Datatype::BuiltinDatatype>] Data stack for the expression results
       attr_reader :stack
 
      # @return [Hash { Symbol => UnaryOperator}]
@@ -28,6 +28,9 @@ module Loxxy
       # @return [Hash { Symbol => BinaryOperator}]
       attr_reader :binary_operators
 
+      # @return [BackEnd::Resolver]
+      attr_reader :resolver
+
       # @param theOptions [Hash]
       def initialize(theOptions)
         @config = theOptions
@@ -47,6 +50,10 @@ module Loxxy
       # @param aVisitor [AST::ASTVisitor]
       # @return [Loxxy::Datatype::BuiltinDatatype]
       def execute(aVisitor)
+        # Do variable resolution pass first
+        @resolver = BackEnd::Resolver.new
+        resolver.analyze(aVisitor)
+
         aVisitor.subscribe(self)
         aVisitor.start
         aVisitor.unsubscribe(self)
@@ -61,11 +68,20 @@ module Loxxy
         # Do nothing, subnodes were already evaluated
       end
 
-      def after_var_stmt(aVarStmt)
-        new_var = Variable.new(aVarStmt.name, aVarStmt.subnodes[0])
+      def before_var_stmt(aVarStmt)
+        new_var = Variable.new(aVarStmt.name, Datatype::Nil.instance)
         symbol_table.insert(new_var)
       end
 
+      def after_var_stmt(aVarStmt)
+        var_name = aVarStmt.name
+        variable = symbol_table.lookup(var_name)
+        raise StandardError, "Unknown variable #{var_name}" unless variable
+
+        value = stack.pop
+        variable.assign(value)
+      end
+
       def before_for_stmt(aForStmt)
         before_block_stmt(aForStmt)
       end
@@ -98,6 +114,10 @@ module Loxxy
         @ostream.print tos ? tos.to_str : 'nil'
       end
 
+      def after_return_stmt(_returnStmt, _aVisitor)
+        throw(:return)
+      end
+
       def after_while_stmt(aWhileStmt, aVisitor)
         loop do
           condition = stack.pop
@@ -117,14 +137,13 @@ module Loxxy
         symbol_table.leave_environment
       end
 
-      def after_assign_expr(anAssignExpr)
+      def after_assign_expr(anAssignExpr, _visitor)
         var_name = anAssignExpr.name
-        variable = symbol_table.lookup(var_name)
+        variable = variable_lookup(anAssignExpr)
         raise StandardError, "Unknown variable #{var_name}" unless variable
 
-        value = stack.pop
+        value = stack.last # ToS remains since an assignment produces a value
         variable.assign(value)
-        stack.push value # An expression produces a value
       end
 
       def after_logical_expr(aLogicalExpr, visitor)
@@ -192,18 +211,18 @@ module Loxxy
         callee = stack.pop
         aCallExpr.arguments.reverse_each { |arg| arg.accept(aVisitor) }
 
-        if callee.kind_of?(NativeFunction)
+        case callee
+        when NativeFunction
           stack.push callee.call # Pass arguments
-        else
-          new_env = Environment.new(symbol_table.current_env)
-          symbol_table.enter_environment(new_env)
-          callee.parameters&.each do |param_name|
-            local = Variable.new(param_name, stack.pop)
-            symbol_table.insert(local)
+        when LoxFunction
+          arg_count = aCallExpr.arguments.size
+          if arg_count != callee.arity
+            msg = "Expected #{callee.arity} arguments but got #{arg_count}."
+            raise Loxxy::RuntimeError, msg
           end
-          callee.call(aVisitor)
-
-          symbol_table.leave_environment
+          callee.call(self, aVisitor)
+        else
+          raise Loxxy::RuntimeError, 'Can only call functions and classes.'
         end
       end
 
@@ -213,10 +232,10 @@ module Loxxy
 
       def after_variable_expr(aVarExpr, aVisitor)
         var_name = aVarExpr.name
-        var = symbol_table.lookup(var_name)
+        var = variable_lookup(aVarExpr)
         raise StandardError, "Unknown variable #{var_name}" unless var
 
-        var.value.accept(aVisitor) # Evaluate the variable value
+        var.value.accept(aVisitor) # Evaluate variable value then push on stack
       end
 
       # @param literalExpr [Ast::LoxLiteralExpr]
@@ -230,13 +249,26 @@ module Loxxy
       end
 
       def after_fun_stmt(aFunStmt, _visitor)
-        function = Function.new(aFunStmt.name, aFunStmt.params, aFunStmt.body, stack)
+        function = LoxFunction.new(aFunStmt.name, aFunStmt.params, aFunStmt.body, self)
         new_var = Variable.new(aFunStmt.name, function)
         symbol_table.insert(new_var)
       end
 
       private
 
+      def variable_lookup(aVarNode)
+        env = nil
+        offset = resolver.locals[aVarNode]
+        if offset.nil?
+          env = symbol_table.root
+        else
+          env = symbol_table.current_env
+          offset.times { env = env.enclosing }
+        end
+
+        env.defns[aVarNode.name]
+      end
+
       NativeFunction = Struct.new(:callable, :interp) do
         def accept(_visitor)
           interp.stack.push self
@@ -255,7 +287,8 @@ module Loxxy
         negate_op = UnaryOperator.new('-', [Datatype::Number])
         unary_operators[:-@] = negate_op
 
-        negation_op = UnaryOperator.new('!', [Datatype::BuiltinDatatype])
+        negation_op = UnaryOperator.new('!', [Datatype::BuiltinDatatype,
+          BackEnd::LoxFunction])
         unary_operators[:!] = negation_op
       end
 

data/lib/loxxy/back_end/environment.rb

@@ -9,10 +9,17 @@ module Loxxy
     # of a relation or a relation definition.
     # It contains a map of names to the objects they name (e.g. logical var)
     class Environment
-      # The  enclosing (parent) environment.
+      # The enclosing (parent) environment.
       # @return [Environment, NilClass]
       attr_accessor :enclosing
 
+      # The previous environment in the environment chain.
+      # @return [Environment, NilClass]
+      attr_accessor :predecessor
+
+      # @return [Boolean] true if this environment is part of a closure (contains an embedded function)
+      attr_accessor :embedding
+
       # Mapping from user-defined name to related definition
       #  (say, a variable object)
       # @return [Hash{String => Variable}] Pairs of the kind

data/lib/loxxy/back_end/lox_function.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative '../datatype/all_datatypes'
+
+module Loxxy
+  module BackEnd
+    # rubocop: disable Style/AccessorGrouping
+    # Representation of a Lox function.
+    # It is a named slot that can be associated with a value at the time.
+    class LoxFunction
+      # @return [String] The name of the function (if any)
+      attr_reader :name
+
+      # @return [Array<>] the parameters
+      attr_reader :parameters
+      attr_reader :body
+      attr_reader :stack
+      attr_reader :closure
+
+      # Create a function with given name
+      # @param aName [String] The name of the variable
+      def initialize(aName, parameterList, aBody, anEngine)
+        @name = aName.dup
+        @parameters = parameterList
+        @body = aBody.kind_of?(Ast::LoxNoopExpr) ? aBody : aBody.subnodes[0]
+        @stack = anEngine.stack
+        @closure = anEngine.symbol_table.current_env
+        anEngine.symbol_table.current_env.embedding = true
+      end
+
+      def arity
+        parameters ? parameters.size : 0
+      end
+
+      def accept(_visitor)
+        stack.push self
+      end
+
+      def call(engine, aVisitor)
+        # new_env = Environment.new(engine.symbol_table.current_env)
+        new_env = Environment.new(closure)
+        engine.symbol_table.enter_environment(new_env)
+
+        parameters&.each do |param_name|
+          local = Variable.new(param_name, stack.pop)
+          engine.symbol_table.insert(local)
+        end
+
+        catch(:return) do
+          (body.nil? || body.kind_of?(Ast::LoxNoopExpr)) ? Datatype::Nil.instance : body.accept(aVisitor)
+          throw(:return)
+        end
+
+        engine.symbol_table.leave_environment
+      end
+
+      # Logical negation.
+      # As a function is a truthy thing, its negation is thus false.
+      # @return [Datatype::False]
+      def !
+        Datatype::False.instance
+      end
+
+      # Text representation of a Lox function
+      def to_str
+        "<fn #{name}>"
+      end
+    end # class
+    # rubocop: enable Style/AccessorGrouping
+  end # module
+end # module

data/lib/loxxy/back_end/resolver.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+# Load all the classes implementing AST nodes
+require_relative '../ast/all_lox_nodes'
+require_relative 'binary_operator'
+require_relative 'lox_function'
+require_relative 'symbol_table'
+require_relative 'unary_operator'
+
+module Loxxy
+  module BackEnd
+    # A class aimed to perform variable resolution when it visits the parse tree.
+    # Resolving means retrieve the declaration of a variable/function everywhere it
+    # is referenced.
+    class Resolver
+      # A stack of Hashes of the form String => Boolean
+      # @return [Array<Hash{String => Boolean}>]
+      attr_reader :scopes
+
+      # A map from a LoxNode involving a variable and the number of enclosing scopes
+      # where it is declared.
+      # @return [Hash {LoxNode => Integer}]
+      attr_reader :locals
+
+      def initialize
+        @scopes = []
+        @locals = {}
+      end
+
+      # Given an abstract syntax parse tree visitor, launch the visit
+      # and execute the visit events in the output stream.
+      # @param aVisitor [AST::ASTVisitor]
+      # @return [Loxxy::Datatype::BuiltinDatatype]
+      def analyze(aVisitor)
+        begin_scope
+        aVisitor.subscribe(self)
+        aVisitor.start
+        aVisitor.unsubscribe(self)
+        end_scope
+      end
+
+      # block statement introduces a new scope
+      def before_block_stmt(_aBlockStmt)
+        begin_scope
+      end
+
+      def after_block_stmt(_aBlockStmt)
+        end_scope
+      end
+
+      def before_for_stmt(aForStmt)
+        before_block_stmt(aForStmt)
+      end
+
+      def after_for_stmt(aForStmt, aVisitor)
+        aForStmt.test_expr.accept(aVisitor)
+        aForStmt.body_stmt.accept(aVisitor)
+        aForStmt.update_expr&.accept(aVisitor)
+        after_block_stmt(aForStmt)
+      end
+
+      def after_if_stmt(anIfStmt, aVisitor)
+        anIfStmt.then_stmt.accept(aVisitor)
+        anIfStmt.else_stmt&.accept(aVisitor)
+      end
+
+      def after_while_stmt(aWhileStmt, aVisitor)
+        aWhileStmt.body.accept(aVisitor)
+        aWhileStmt.condition.accept(aVisitor)
+      end
+
+      # A variable declaration adds a new variable to current scope
+      def before_var_stmt(aVarStmt)
+        declare(aVarStmt.name)
+      end
+
+      def after_var_stmt(aVarStmt)
+        define(aVarStmt.name)
+      end
+
+      # Assignment expressions require their variables resolved
+      def after_assign_expr(anAssignExpr, aVisitor)
+        resolve_local(anAssignExpr, aVisitor)
+      end
+
+      # Variable expressions require their variables resolved
+      def before_variable_expr(aVarExpr)
+        var_name = aVarExpr.name
+        if !scopes.empty? && (scopes.last[var_name] == false)
+          raise StandardError, "Can't read variable #{var_name} in its own initializer"
+        end
+      end
+
+      def after_variable_expr(aVarExpr, aVisitor)
+        resolve_local(aVarExpr, aVisitor)
+      end
+
+      def after_call_expr(aCallExpr, aVisitor)
+        # Evaluate callee part
+        aCallExpr.callee.accept(aVisitor)
+        aCallExpr.arguments.reverse_each { |arg| arg.accept(aVisitor) }
+      end
+
+      # function declaration creates a new scope for its body & binds its parameters for that scope
+      def before_fun_stmt(aFunStmt, aVisitor)
+        declare(aFunStmt.name)
+        define(aFunStmt.name)
+        resolve_function(aFunStmt, aVisitor)
+      end
+
+      private
+
+      def begin_scope
+        scopes.push({})
+      end
+
+      def end_scope
+        scopes.pop
+      end
+
+      def declare(aVarName)
+        return if scopes.empty?
+
+        curr_scope = scopes.last
+
+        # The initializer is not yet processed.
+        # Mark the variable as 'not yet ready' = exists but may not be referenced yet
+        curr_scope[aVarName] = false
+      end
+
+      def define(aVarName)
+        return if scopes.empty?
+
+        curr_scope = scopes.last
+
+        # The initializer (if any) was processed.
+        # Mark the variable as alive (= can be referenced in an expression)
+        curr_scope[aVarName] = true
+      end
+
+      def resolve_local(aVarExpr, _visitor)
+        max_i = i = scopes.size - 1
+        scopes.reverse_each do |scp|
+          if scp.include?(aVarExpr.name)
+            # Keep track of the difference of nesting levels between current scope
+            # and the scope where the variable is declared
+            @locals[aVarExpr] = max_i - i
+            break
+          end
+          i -= 1
+        end
+      end
+
+      def resolve_function(aFunStmt, aVisitor)
+        begin_scope
+
+        aFunStmt.params&.each do |param_name|
+          declare(param_name)
+          define(param_name)
+        end
+
+        body = aFunStmt.body
+        unless body.nil? || body.kind_of?(Ast::LoxNoopExpr)
+          body.subnodes.first&.accept(aVisitor)
+        end
+
+        end_scope
+      end
+    end # class
+  end # mmodule
+end # module

data/lib/loxxy/back_end/symbol_table.rb

@@ -44,23 +44,33 @@ module Loxxy
       # to be a child of current environment and to be itself the new current environment.
       # @param anEnv [BackEnd::Environment] the Environment that
       def enter_environment(anEnv)
-        anEnv.enclosing = current_env
+        if anEnv.enclosing && (anEnv.enclosing != current_env)
+          anEnv.predecessor = current_env
+        else
+          anEnv.enclosing = current_env
+        end
         @current_env = anEnv
       end
 
       def leave_environment
-        current_env.defns.each_pair do |nm, _item|
-          environments = name2envs[nm]
-          if environments.size == 1
-            name2envs.delete(nm)
-          else
-            environments.pop
-            name2envs[nm] = environments
+        unless current_env.embedding
+          current_env.defns.each_pair do |nm, _item|
+            environments = name2envs[nm]
+            if environments.size == 1
+              name2envs.delete(nm)
+            else
+              environments.pop
+              name2envs[nm] = environments
+            end
           end
         end
         raise StandardError, 'Cannot remove root environment.' if current_env == root
 
-        @current_env = current_env.enclosing
+        if current_env.predecessor
+          @current_env = current_env.predecessor
+        else
+          @current_env = current_env.enclosing
+        end
       end
 
       # Add an entry with given name to current environment.

data/lib/loxxy/error.rb

@@ -6,4 +6,7 @@ module Loxxy
 
   # Error occurring while Loxxy executes some invalid Lox code.
   class RuntimeError < Error; end
+
+  # Error occurring while Loxxy parses some invalid Lox code.
+  class SyntaxError < Error; end
 end

data/lib/loxxy/front_end/grammar.rb

@@ -74,7 +74,7 @@ module Loxxy
       rule('elsePart_opt' => [])
 
       rule('printStmt' => 'PRINT expression SEMICOLON').as 'print_stmt'
-      rule('returnStmt' => 'RETURN expression_opt SEMICOLON')
+      rule('returnStmt' => 'RETURN expression_opt SEMICOLON').as 'return_stmt'
       rule('whileStmt' => 'WHILE LEFT_PAREN expression RIGHT_PAREN statement').as 'while_stmt'
       rule('block' => 'LEFT_BRACE declaration_plus RIGHT_BRACE').as 'block_stmt'
       rule('block' => 'LEFT_BRACE RIGHT_BRACE').as 'block_empty'
@@ -127,7 +127,7 @@ module Loxxy
       rule('unaryOp' => 'MINUS')
       rule('call' => 'primary')
       rule('call' => 'primary refinement_plus').as 'call_expr'
-      rule('refinement_plus' => 'refinement_plus refinement') # .as 'refinement_plus_more'
+      rule('refinement_plus' => 'refinement_plus refinement').as 'refinement_plus_more'
       rule('refinement_plus' => 'refinement').as 'refinement_plus_end'
       rule('refinement' => 'LEFT_PAREN arguments_opt RIGHT_PAREN').as 'call_arglist'
       rule('refinement' => 'DOT IDENTIFIER')

data/lib/loxxy/front_end/scanner.rb

@@ -92,6 +92,7 @@ module Loxxy
 
       private
 
+      # rubocop: disable Lint/DuplicateBranch
       def _next_token
         skip_intertoken_spaces
         curr_ch = scanner.peek(1)
@@ -125,6 +126,7 @@ module Loxxy
 
         return token
       end
+      # rubocop: enable Lint/DuplicateBranch
 
       def build_token(aSymbolName, aLexeme)
         begin

data/lib/loxxy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Loxxy
-  VERSION = '0.1.03'
+  VERSION = '0.1.08'
 end

data/spec/back_end/engine_spec.rb

@@ -34,8 +34,18 @@ module Loxxy
         let(:var_decl) { Ast::LoxVarStmt.new(sample_pos, 'greeting', greeting) }
         let(:lit_expr) { Ast::LoxLiteralExpr.new(sample_pos, greeting) }
 
+        it "should react to 'before_var_stmt' event" do
+          expect { subject.before_var_stmt(var_decl) }.not_to raise_error
+          current_env = subject.symbol_table.current_env
+          expect(current_env.defns['greeting']).to be_kind_of(Variable)
+        end
 
         it "should react to 'after_var_stmt' event" do
+          # Precondition: `before_var_stmt` is called...
+          expect { subject.before_var_stmt(var_decl) }.not_to raise_error
+          # Precondition: value to assign is on top of stack
+          subject.stack.push(greeting)
+
           expect { subject.after_var_stmt(var_decl) }.not_to raise_error
           current_env = subject.symbol_table.current_env
           expect(current_env.defns['greeting']).to be_kind_of(Variable)

data/spec/interpreter_spec.rb

@@ -53,15 +53,6 @@ module Loxxy
     end # context
 
     context 'Evaluating Lox code:' do
-      let(:hello_world) do
-        lox = <<-LOX_END
-        var greeting = "Hello"; // Declaring a variable
-        print greeting + ", " + "world!"; // ... Playing with concatenation
-LOX_END
-
-        lox
-      end
-
       it 'should evaluate core data types' do
         result = subject.evaluate('true; // Not false')
         expect(result).to be_kind_of(Loxxy::Datatype::True)
@@ -269,9 +260,9 @@ LOX_END
 
       it 'should accept variable mention' do
         program = <<-LOX_END
-        var foo = "bar";
-        print foo; // => bar
-LOX_END
+          var foo = "bar";
+          print foo; // => bar
+        LOX_END
         expect { subject.evaluate(program) }.not_to raise_error
         expect(sample_cfg[:ostream].string).to eq('bar')
       end
@@ -424,18 +415,49 @@ LOX_END
         expect(sample_cfg[:ostream].string).to eq('<fn foo><native fn>')
       end
 
-      it 'should print the hello world message' do
-        expect { subject.evaluate(hello_world) }.not_to raise_error
-        expect(sample_cfg[:ostream].string).to eq('Hello, world!')
+      it 'should support return statements' do
+        program = <<-LOX_END
+          fun max(a, b) {
+            if (a > b) return a;
+
+            return b;
+          }
+
+          max(3, 2);
+        LOX_END
+        result = subject.evaluate(program)
+        expect(result).to eq(3)
       end
-    end # context
 
-    context 'Test suite:' do
-      it "should complain if one argument isn't a number" do
-        source = '1 + nil;'
-        err = Loxxy::RuntimeError
-        err_msg = 'Operands must be two numbers or two strings.'
-        expect { subject.evaluate(source) }.to raise_error(err, err_msg)
+      # rubocop: disable Style/StringConcatenation
+      it 'should support local functions and closures' do
+        program = <<-LOX_END
+          fun makeCounter() {
+            var i = 0;
+            fun count() {
+              i = i + 1;
+              print i;
+            }
+
+            return count;
+          }
+
+          var counter = makeCounter();
+          counter(); // "1".
+          counter(); // "2".
+        LOX_END
+        expect { subject.evaluate(program) }.not_to raise_error
+        expect(sample_cfg[:ostream].string).to eq('1' + '2')
+      end
+      # rubocop: enable Style/StringConcatenation
+
+      it 'should print the hello world message' do
+        program = <<-LOX_END
+          var greeting = "Hello"; // Declaring a variable
+          print greeting + ", " + "world!"; // ... Playing with concatenation
+        LOX_END
+        expect { subject.evaluate(program) }.not_to raise_error
+        expect(sample_cfg[:ostream].string).to eq('Hello, world!')
       end
     end # context
   end # describe

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loxxy
 version: !ruby/object:Gem::Version
-  version: 0.1.03
+  version: 0.1.08
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rley
@@ -103,6 +103,7 @@ files:
 - lib/loxxy/ast/lox_node.rb
 - lib/loxxy/ast/lox_noop_expr.rb
 - lib/loxxy/ast/lox_print_stmt.rb
+- lib/loxxy/ast/lox_return_stmt.rb
 - lib/loxxy/ast/lox_seq_decl.rb
 - lib/loxxy/ast/lox_unary_expr.rb
 - lib/loxxy/ast/lox_var_stmt.rb
@@ -112,7 +113,8 @@ files:
 - lib/loxxy/back_end/engine.rb
 - lib/loxxy/back_end/entry.rb
 - lib/loxxy/back_end/environment.rb
-- lib/loxxy/back_end/function.rb
+- lib/loxxy/back_end/lox_function.rb
+- lib/loxxy/back_end/resolver.rb
 - lib/loxxy/back_end/symbol_table.rb
 - lib/loxxy/back_end/unary_operator.rb
 - lib/loxxy/back_end/variable.rb

data/lib/loxxy/back_end/function.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../datatype/all_datatypes'
-
-module Loxxy
-  module BackEnd
-    # rubocop: disable Style/AccessorGrouping
-    # Representation of a Lox function.
-    # It is a named slot that can be associated with a value at the time.
-    class Function
-      # @return [String]
-      attr_reader :name
-
-      # @return [Array<>] the parameters
-      attr_reader :parameters
-      attr_reader :body
-      attr_reader :stack
-
-      # Create a variable with given name and initial value
-      # @param aName [String] The name of the variable
-      # @param aValue [Datatype::BuiltinDatatype] the initial assigned value
-      def initialize(aName, parameterList, aBody, aStack)
-        @name = aName.dup
-        @parameters = parameterList
-        @body = aBody
-        @stack = aStack
-      end
-
-      def accept(_visitor)
-        stack.push self
-      end
-
-      def call(aVisitor)
-        body.empty? ? Datatype::Nil.instance : body.accept(aVisitor)
-      end
-
-      # Text representation of a Lox function
-      def to_str
-        "<fn #{name}>"
-      end
-    end # class
-    # rubocop: enable Style/AccessorGrouping
-  end # module
-end # module