loxxy 0.0.28 → 0.1.04

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b9202e7a755cffecb3226da5764a3cb6f75fd3179803eb25779ae42822bbf15
-  data.tar.gz: 49767873134c5c124aab3e6b20a49c60f968df180dfd6e945f3da2808eee59c7
+  metadata.gz: 16614a276ddf1553d4373e5da9ab78d7f03f2fc8cadec6190c28bb27bdd95b99
+  data.tar.gz: 98903f6ec0c9e010fd429f6b1753b34f52b4cfc67c7eafd21b1103c6ac429bba
 SHA512:
-  metadata.gz: 29c481015e414ea71eb55c0b4dcc4d793b011a8f16fa7f9218ec704b2baea820e47ba758ba9a2e30e5bdfe08bfd2ad8fa892e6d67e247938b8bcda7b005ff2a9
-  data.tar.gz: cbf671e54aa98e799b6d565cac52fb19fb3f5d7b3ae84841f27067ae427e5a7c25a7d40a07d39645150f73176709fbcc6e3bbf36e9cada14d8b329f335c621d5
+  metadata.gz: 8278546ef246d8f4d5db72b18d5c91dfa3dc1d7f18f81b7491ca01df38a64495a3b5eb26df0fa18b652f59d56784efb8fe9348b5b65d091aa27a09e6b8f144a4
+  data.tar.gz: deaa7b43f225788b9366610572f5994eec8950a8e66c8159b83a18b874139d322270f274c4753dc28b6926b7c295d42a2f77600211dfbd0df0e24b82e1a155b5

data/CHANGELOG.md

@@ -1,3 +1,82 @@
+## [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 checking for arithmetic and comparison operators
+
+### Added
+- Test suite for arithmetic and comparison operators (in project repository)
+- Class `BackEnd::UnaryOperator`:  runtime argument validation
+- Class `BackEnd::BinaryOperator`: runtime argument validation
+
+### Changed
+- File `console` renamed to `loxxy`. Very basic command-line interface.
+- Custom exception classes 
+- File `README.md` updated list of supported `Lox` keywords.
+
+
+## [0.1.02] - 2021-02-21
+- Function definition and call documented in `README.md`
+
+### Changed
+- File `README.md` updated description of function definition and function call.
+
+### Fixed
+- Method `BackEnd::Engine#after_print_stmt` now handles of empty stack or nil data.
+- Method `BackEnd::Engine#after_call_expr` was pushing one spurious item onto data stack.
+
+## [0.1.01] - 2021-02-20
+### Fixed
+- Fixed most offences for Rubocop.
+
+
+## [0.1.00] - 2021-02-20
+- Version number bumped, `Loxxy` supports function definitions
+
+### Added
+- Class `Ast::LoxFunStmt` a node that represents a function declaration
+- Method `Ast::ASTBuilder#reduce_fun_decl`
+- Method `Ast::ASTBuilder#reduce_function` creates a `LoxFunStmt` instance
+- Method `Ast::ASTBuilder#reduce_parameters_plus_more` for dealing with function parameters
+- Method `Ast::ASTBuilder#reduce_parameters_plus_end`
+- Method `Ast::ASTVisitor#visit_fun_stmt` for visiting an `Ast::LoxFunStmt` node
+- Method `Ast::LoxBlockStmt#empty?` returns true if the code block is empty
+- Method `BackEnd::Engine#after_fun_stmt`
+- Method `Backend::NativeFunction#call` 
+- Method `Backend::NativeFunction#to_str` 
+- Method `Backend::Function` implementation of a function object.
+
+### Changed
+- Method `BackEnd::Engine#after_call_expr`
+
+### Fixed
+- Fixed inconsistencies in documentation comments.
+
+## [0.0.28] - 2021-02-15
+- The interpreter implements function calls (to a native function).
+
+### Added
+- Class `Ast::LoxCallExpr` a node that represents a function call expression
+- Method `Ast::ASTBuilder#reduce_call_expr`
+- Method `Ast::ASTBuilder#reduce_refinement_plus_end`
+- Method `Ast::ASTBuilder#reduce_call_arglist` creates a `LoxCallExpr` node
+- Method `Ast::ASTBuilder#reduce_arguments_plus_more` builds the function argument array
+- Method `Ast::ASTVisitor#visit_call_expr` for visiting an `Ast::LoxCallExpr` node
+- Method `BackEnd::Engine#after_call_expr`implements the evaluation of a function call.
+- Method `BackEnd::Engine#after_for_stmt` implements most of the `for` control flow
+
 ## [0.0.27] - 2021-01-24
 - The interpreter implements `while` loops.
 
@@ -157,11 +236,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

@@ -14,14 +14,13 @@ a simple language used in Bob Nystrom's online book [Crafting Interpreters](http
 
 ### Current status
 The project is still in inception and the interpreter is being implemented...  
-Currently it can execute all allowed __Lox__ expressions and statement except:
-- Functions and closures,  
+Currently it can execute all allowed __Lox__ expressions and statements except:
+- Closures,  
 - Classes and objects.
 
 These will be implemented soon.
 
 
-
 ## What's the fuss about Lox?
 ... Nothing...  
 Bob Nystrom designed a language __simple__ enough so that he could present 
@@ -36,11 +35,11 @@ Although __Lox__ is fairly simple, it is far from a toy language:
 - Functions and closures
 - Object-orientation (classes, methods, inheritance).
 
-In other words, __Lox__ contains interesting features expected from most general-purpose 
+In other words, __Lox__ contains interesting features found in most general-purpose 
 languages.
 
 ### What's missing in Lox?
-__Lox__ was constrained by design and therefore was not aimed to be a language used in real-world applications.
+__Lox__ was constrained by design and was therefore not aimed to be a language used in real-world applications.
 Here are some missing parts to make it a _practical_ language:
 - Collections (arrays, maps, ...)
 - Modules (importing stuff from other packages/files)
@@ -70,6 +69,23 @@ lox = Loxxy::Interpreter.new
 lox.evaluate(lox_program) # Output: Hello, world!
 ```
 
+## A function definition example
+```ruby
+require 'loxxy'
+
+lox_program = <<LOX_END
+  fun add4(n) {
+    n + 4;
+  }
+
+  print add4(6); // Output: 10
+LOX_END
+
+lox = Loxxy::Interpreter.new
+lox.evaluate(lox_program) # Output 10
+```
+
+
 ## Retrieving the result from a Lox program
 The __Loxxy__ interpreter returns the value of the last evaluated expression. 
 
@@ -151,6 +167,7 @@ Here are the language features currently supported by the interpreter:
 - [Print Statement](#print-statement)
 - [While Statement](#while-statement)  
 - [Block Statement](#block-statement)
+- [Function declaration](#func-statement)
 
 ### Comments
 
@@ -163,7 +180,8 @@ Loxxy supports single line C-style comments.
 ### Keywords
 Loxxy implements the following __Lox__ reserved keywords:
 ```lang-none
-and, false, nil, or, print, true
+and, else, false, for, fun, if,
+nil, or, print, true, var, while
 ```
 
 ### Datatypes
@@ -177,19 +195,21 @@ loxxy supports  all the standard __Lox__ datatypes:
 ### Statements
 
 Loxxy supports the following statements:  
-- [Expressions](#expressions)  
+- [Expressions](#expressions)
   -[Arithmetic expressions](#arithmetic-expressions)  
   -[String concatenation](#string-concatenation)  
   -[Comparison expressions](#comparison-expressions)  
   -[Logical expressions](#logical-expressions)  
   -[Grouping expressions](#grouping-expressions)  
-  -[Variable expressions and assignments](#variable-expressions)
-  
+  -[Variable expressions and assignments](#variable-expressions)  
+  -[Function call](#function-call)
+
 -[Variable declarations](#var-statement)  
 -[If Statement](#if-statement)  
 -[Print Statement](#print-statement)  
--[While Statement](#while-statement)
--[Block Statement](#block-statement)
+-[While Statement](#while-statement)  
+-[Block Statement](#block-statement)  
+-[Function Declaration](#function-declaration)
 
 #### Expressions
 
@@ -284,6 +304,15 @@ var iAmNil; // __Lox__ initializes variables to nil by default;
 print iAmNil; // output: nil
 ```
 
+#### Function call
+``` javascript
+// Calling a function without argument
+print clock();
+
+// Assumption: there exists a function `add` that takes two arguments
+print add(2, 3);
+```
+
 #### For statement
 
 Similar to the `for` statement in `C` language
@@ -362,6 +391,19 @@ var a = "outer";
 print a; // output: outer
 ```
 
+#### Function Declaration
+The keyword `fun` is used to begin a function declaration.
+In __Lox__ a function has a name and a body (which may be empty).
+
+``` javascript
+fun add4(n) // `add4` will be the name of the function
+{
+  n + 4;
+}
+
+print add4(6); // output: 10
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/bin/loxxy

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'loxxy'
+
+if ARGV[0]
+lox = Loxxy::Interpreter.new
+File.open(ARGV[0], 'r') do |f|
+lox.evaluate(f.read)
+end
+end

data/lib/loxxy.rb

@@ -6,8 +6,6 @@ require_relative 'loxxy/front_end/raw_parser'
 
 # Namespace for all classes and constants of __loxxy__ gem.
 module Loxxy
-  class Error < StandardError; end
-
   # Shorthand method. Returns the sole object that represents
   # a Lox false literal.
   # @return [Loxxy::Datatype::False]

data/lib/loxxy/ast/all_lox_nodes.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'lox_fun_stmt'
 require_relative 'lox_variable_expr'
 require_relative 'lox_literal_expr'
 require_relative 'lox_noop_expr'
@@ -11,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

@@ -163,6 +163,11 @@ module Loxxy
         [theChildren[0]]
       end
 
+      # rule('funDecl' => 'FUN function')
+      def reduce_fun_decl(_production, _range, _tokens, theChildren)
+        theChildren[1]
+      end
+
       # rule('exprStmt' => 'expression SEMICOLON')
       def reduce_exprStmt(_production, range, tokens, theChildren)
       return_first_child(range, tokens, theChildren) # Discard the semicolon
@@ -216,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])
@@ -227,6 +237,11 @@ module Loxxy
         Ast::LoxBlockStmt.new(tokens[1].position, decls)
       end
 
+      # rule('block' => 'LEFT_BRACE RIGHT_BRACE').as 'block_empty'
+      def reduce_block_empty(_production, _range, tokens, _children)
+        Ast::LoxBlockStmt.new(tokens[0].position, nil)
+      end
+
       # rule('assignment' => 'owner_opt IDENTIFIER EQUAL assignment')
       def reduce_assign_expr(_production, _range, tokens, theChildren)
         var_name = theChildren[1].token.lexeme.dup
@@ -284,6 +299,23 @@ module Loxxy
         LoxVariableExpr.new(tokens[0].position, var_name)
       end
 
+      # rule('function' => 'IDENTIFIER LEFT_PAREN params_opt RIGHT_PAREN block').as 'function'
+      def reduce_function(_production, _range, _tokens, theChildren)
+        first_child = theChildren.first
+        pos = first_child.token.position
+        LoxFunStmt.new(pos, first_child.token.lexeme, theChildren[2], theChildren[4])
+      end
+
+      # rule('parameters' => 'parameters COMMA IDENTIFIER')
+      def reduce_parameters_plus_more(_production, _range, _tokens, theChildren)
+        theChildren[0] << theChildren[2].token.lexeme
+      end
+
+      # rule('parameters' => 'IDENTIFIER')
+      def reduce_parameters_plus_end(_production, _range, _tokens, theChildren)
+        [theChildren[0].token.lexeme]
+      end
+
       # rule('arguments' => 'arguments COMMA expression')
       def reduce_arguments_plus_more(_production, _range, _tokens, theChildren)
         theChildren[0] << theChildren[2]

data/lib/loxxy/ast/ast_visitor.rb

@@ -12,7 +12,7 @@ module Loxxy
       # attr_reader(:runtime)
 
       # Build a visitor for the given top.
-      # @param aRoot [AST::LoxNode] the parse tree to visit.
+      # @param aTop [AST::LoxNode] the parse tree to visit.
       def initialize(aTop)
         raise StandardError if aTop.nil?
 
@@ -52,7 +52,7 @@ module Loxxy
       end
 
       # Visit event. The visitor is about to visit a variable declaration statement.
-      # @param aPrintStmt [AST::LOXVarStmt] the variable declaration node to visit
+      # @param aSeqDecls [AST::LOXSeqDecl] the variable declaration node to visit
       def visit_seq_decl(aSeqDecls)
         broadcast(:before_seq_decl, aSeqDecls)
         traverse_subnodes(aSeqDecls)
@@ -60,7 +60,7 @@ module Loxxy
       end
 
       # Visit event. The visitor is about to visit a variable declaration statement.
-      # @param aPrintStmt [AST::LOXVarStmt] the variable declaration node to visit
+      # @param aVarStmt [AST::LOXVarStmt] the variable declaration node to visit
       def visit_var_stmt(aVarStmt)
         broadcast(:before_var_stmt, aVarStmt)
         traverse_subnodes(aVarStmt)
@@ -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)
@@ -103,12 +111,12 @@ module Loxxy
       # @param aBlockStmt [AST::LOXBlockStmt] the print statement node to visit
       def visit_block_stmt(aBlockStmt)
         broadcast(:before_block_stmt, aBlockStmt)
-        traverse_subnodes(aBlockStmt)
+        traverse_subnodes(aBlockStmt) unless aBlockStmt.empty?
         broadcast(:after_block_stmt, aBlockStmt)
       end
 
       # Visit event. The visitor is visiting an assignment node
-      # @param aLiteralExpr [AST::LoxAssignExpr] the variable assignment node to visit.
+      # @param anAssignExpr [AST::LoxAssignExpr] the variable assignment node to visit.
       def visit_assign_expr(anAssignExpr)
         broadcast(:before_assign_expr, anAssignExpr)
         traverse_subnodes(anAssignExpr)
@@ -118,7 +126,7 @@ module Loxxy
       # Visit event. The visitor is about to visit a logical expression.
       # Since logical expressions may take shorcuts by not evaluating all their
       # sub-expressiosns, they are responsible for visiting or not their children.
-      # @param aBinaryExpr [AST::LOXBinaryExpr] the logical expression node to visit
+      # @param aLogicalExpr [AST::LOXLogicalExpr] the logical expression node to visit
       def visit_logical_expr(aLogicalExpr)
         broadcast(:before_logical_expr, aLogicalExpr)
 
@@ -170,25 +178,33 @@ module Loxxy
       end
 
       # Visit event. The visitor is visiting a variable usage node
-      # @param aLiteralExpr [AST::LoxVariableExpr] the variable reference node to visit.
+      # @param aVariableExpr [AST::LoxVariableExpr] the variable reference node to visit.
       def visit_variable_expr(aVariableExpr)
         broadcast(:before_variable_expr, aVariableExpr)
         broadcast(:after_variable_expr, aVariableExpr, self)
       end
 
       # Visit event. The visitor is about to visit the given terminal datatype value.
-      # @param aNonTerminalNode [Ast::BuiltinDattype] the built-in datatype value
+      # @param aValue [Ast::BuiltinDattype] the built-in datatype value
       def visit_builtin(aValue)
         broadcast(:before_visit_builtin, aValue)
         broadcast(:after_visit_builtin, aValue)
       end
 
+      # 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)
+        traverse_subnodes(aFunStmt)
+        broadcast(:after_fun_stmt, aFunStmt, self)
+      end
+
       # Visit event. The visitor is about to visit the given non terminal node.
       # @param aNonTerminalNode [Rley::PTree::NonTerminalNode] the node to visit.
-      def visit_nonterminal(non_terminal_node)
+      def visit_nonterminal(aNonTerminalNode)
         # Loxxy interpreter encountered a CST node (Concrete Syntax Tree)
         # that it cannot handle.
-        symb = non_terminal_node.symbol.name
+        symb = aNonTerminalNode.symbol.name
         msg = "Loxxy cannot execute this code yet for non-terminal symbol '#{symb}'."
         raise NotImplementedError, msg
       end

data/lib/loxxy/ast/lox_block_stmt.rb

@@ -6,11 +6,15 @@ module Loxxy
   module Ast
     class LoxBlockStmt < LoxCompoundExpr
       # @param aPosition [Rley::Lexical::Position] Position of the entry in the input stream.
-      # @param operand [Loxxy::Ast::LoxSeqDecl]
+      # @param decls [Loxxy::Ast::LoxSeqDecl]
       def initialize(aPosition, decls)
         super(aPosition, [decls])
       end
 
+      def empty?
+        subnodes.size == 1 && subnodes[0].nil?
+      end
+
       # Part of the 'visitee' role in Visitor design pattern.
       # @param visitor [Ast::ASTVisitor] the visitor
       def accept(visitor)

data/lib/loxxy/ast/lox_for_stmt.rb

@@ -18,7 +18,6 @@ module Loxxy
       # @param initialization [Loxxy::Ast::LoxNode]
       # @param testExpr [Loxxy::Ast::LoxNode]
       # @param updateExpr [Loxxy::Ast::LoxNode]
-      # @param body [Loxxy::Ast::LoxNode]
       def initialize(aPosition, initialization, testExpr, updateExpr)
         child = initialization ? [initialization] : []
         super(aPosition, child)

data/lib/loxxy/ast/lox_fun_stmt.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lox_compound_expr'
+
+module Loxxy
+  module Ast
+    # rubocop: disable Style/AccessorGrouping
+    class LoxFunStmt < LoxCompoundExpr
+      attr_reader :name
+      attr_reader :params
+      attr_reader :body
+
+      # @param aPosition [Rley::Lexical::Position] Position of the entry in the input stream.
+      # @param aName [String]
+      # @param arguments [Array<String>]
+      # @param body [Ast::LoxBlockStmt]
+      def initialize(aPosition, aName, paramList, aBody)
+        super(aPosition, [])
+        @name = aName
+        @params = paramList
+        @body = aBody
+      end
+
+      # Part of the 'visitee' role in Visitor design pattern.
+      # @param visitor [Ast::ASTVisitor] the visitor
+      def accept(visitor)
+        visitor.visit_fun_stmt(self)
+      end
+
+      alias operands subnodes
+    end # class
+    # rubocop: enable Style/AccessorGrouping
+  end # module
+end # module

data/lib/loxxy/ast/lox_if_stmt.rb

@@ -12,7 +12,9 @@ module Loxxy
       attr_reader :else_stmt
 
       # @param aPosition [Rley::Lexical::Position] Position of the entry in the input stream.
-      # @param subExpr [Loxxy::Ast::LoxNode]
+      # @param condExpr [Loxxy::Ast::LoxNode]
+      # @param thenStmt [Loxxy::Ast::LoxNode]
+      # @param elseStmt [Loxxy::Ast::LoxNode]
       def initialize(aPosition, condExpr, thenStmt, elseStmt)
         super(aPosition, [condExpr])
         @then_stmt = thenStmt

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/back_end/binary_operator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative '../error'
+
+module Loxxy
+  module BackEnd
+    Signature = Struct.new(:parameter_types)
+
+    # A Lox binary operator
+    class BinaryOperator
+      # @return [String] text representation of the operator
+      attr_reader :name
+
+      # @return [Array<Class>]
+      attr_reader :signatures
+
+      # @param aName [String] "name" of operator
+      # @param theSignatures [Array<Signature>] allowed signatures
+      def initialize(aName, theSignatures)
+        @name = aName
+        @signatures = theSignatures
+      end
+
+      # rubocop: disable Style/ClassEqualityComparison
+      def validate_operands(operand1, operand2)
+        compliant = signatures.find do |(type1, type2)|
+          next unless operand1.kind_of?(type1)
+
+          if type2 == :idem
+            (operand2.class == operand1.class)
+          else
+            operand2.kind_of?(type2)
+          end
+        end
+        # rubocop: enable Style/ClassEqualityComparison
+
+        unless compliant
+          err = Loxxy::RuntimeError
+          if signatures.size == 1 && signatures[0].last == :idem
+            raise err, "Operands must be #{datatype_name(signatures[0].first)}s."
+          elsif signatures.size == 2 && signatures.all? { |(_, second)| second == :idem }
+            type1 = datatype_name(signatures[0].first)
+            type2 = datatype_name(signatures[1].first)
+            raise err, "Operands must be two #{type1}s or two #{type2}s."
+          end
+        end
+      end
+
+      private
+
+      def datatype_name(aClass)
+        # (?:(?:[^:](?!:|(?<=LX))))+$
+        aClass.name.sub(/^.+(?=::)::(?:LX)?/, '').downcase
+      end
+    end # class
+  end # module
+end # module

data/lib/loxxy/back_end/engine.rb

@@ -2,7 +2,10 @@
 
 # Load all the classes implementing AST nodes
 require_relative '../ast/all_lox_nodes'
+require_relative 'binary_operator'
+require_relative 'function'
 require_relative 'symbol_table'
+require_relative 'unary_operator'
 
 module Loxxy
   module BackEnd
@@ -16,16 +19,26 @@ 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}]
+      attr_reader :unary_operators
+
+      # @return [Hash { Symbol => BinaryOperator}]
+      attr_reader :binary_operators
+
       # @param theOptions [Hash]
       def initialize(theOptions)
         @config = theOptions
         @ostream = config.include?(:ostream) ? config[:ostream] : $stdout
         @symbol_table = SymbolTable.new
         @stack = []
+        @unary_operators = {}
+        @binary_operators = {}
 
+        init_unary_operators
+        init_binary_operators
         init_globals
       end
 
@@ -82,7 +95,11 @@ module Loxxy
 
       def after_print_stmt(_printStmt)
         tos = stack.pop
-        @ostream.print tos.to_str
+        @ostream.print tos ? tos.to_str : 'nil'
+      end
+
+      def after_return_stmt(_returnStmt, _aVisitor)
+        throw(:return)
       end
 
       def after_while_stmt(aWhileStmt, aVisitor)
@@ -147,9 +164,11 @@ module Loxxy
       end
 
       def after_binary_expr(aBinaryExpr)
-        op = aBinaryExpr.operator
         operand2 = stack.pop
         operand1 = 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)
         else
@@ -159,12 +178,14 @@ module Loxxy
       end
 
       def after_unary_expr(anUnaryExpr)
-        op = anUnaryExpr.operator
         operand = stack.pop
+        op = anUnaryExpr.operator
+        operator = unary_operators[op]
+        operator.validate_operand(operand)
         if operand.respond_to?(op)
           stack.push operand.send(op)
         else
-          msg1 = "`#{op}': Unimplemented operator for a #{operand1.class}."
+          msg1 = "`#{op}': Unimplemented operator for a #{operand.class}."
           raise StandardError, msg1
         end
       end
@@ -173,11 +194,32 @@ module Loxxy
         # Evaluate callee part
         aCallExpr.callee.accept(aVisitor)
         callee = stack.pop
-        # TODO: reverse order?
-        aCallExpr.arguments.each do |arg|
-          arg.evaluate(aVisitor)
+        aCallExpr.arguments.reverse_each { |arg| arg.accept(aVisitor) }
+
+        case callee
+        when NativeFunction
+          stack.push callee.call # Pass arguments
+        when Function
+          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)
+          end
+          catch(:return) do
+            callee.call(aVisitor)
+            throw(:return)
+          end
+
+          symbol_table.leave_environment
+        else
+          raise Loxxy::RuntimeError, 'Can only call functions and classes.'
         end
-        stack.push callee.call # Pass arguments
+      end
+
+      def complete_call
+        callee = ret_stack.pop
+        symbol_table.leave_environment if callee.kind_of?(Function)
       end
 
       def after_grouping_expr(_groupingExpr)
@@ -197,17 +239,73 @@ module Loxxy
         stack.push(literalExpr.literal)
       end
 
-      # @param aNonTerminalNode [Ast::BuiltinDattype] the built-in datatype value
+      # @param aValue [Ast::BuiltinDattype] the built-in datatype value
       def before_visit_builtin(aValue)
         stack.push(aValue)
       end
 
+      def after_fun_stmt(aFunStmt, _visitor)
+        function = Function.new(aFunStmt.name, aFunStmt.params, aFunStmt.body, stack)
+        new_var = Variable.new(aFunStmt.name, function)
+        symbol_table.insert(new_var)
+      end
+
       private
 
       NativeFunction = Struct.new(:callable, :interp) do
         def accept(_visitor)
-          interp.stack.push callable
+          interp.stack.push self
+        end
+
+        def call
+          callable.call
         end
+
+        def to_str
+          '<native fn>'
+        end
+      end
+
+      def init_unary_operators
+        negate_op = UnaryOperator.new('-', [Datatype::Number])
+        unary_operators[:-@] = negate_op
+
+        negation_op = UnaryOperator.new('!', [Datatype::BuiltinDatatype,
+          BackEnd::Function])
+        unary_operators[:!] = negation_op
+      end
+
+      def init_binary_operators
+        plus_op = BinaryOperator.new('+', [[Datatype::Number, :idem],
+          [Datatype::LXString, :idem]])
+        binary_operators[:+] = plus_op
+
+        minus_op = BinaryOperator.new('-', [[Datatype::Number, :idem]])
+        binary_operators[:-] = minus_op
+
+        star_op = BinaryOperator.new('*', [[Datatype::Number, :idem]])
+        binary_operators[:*] = star_op
+
+        slash_op = BinaryOperator.new('/', [[Datatype::Number, :idem]])
+        binary_operators[:/] = slash_op
+
+        equal_equal_op = BinaryOperator.new('==', [[Datatype::BuiltinDatatype, Datatype::BuiltinDatatype]])
+        binary_operators[:==] = equal_equal_op
+
+        not_equal_op = BinaryOperator.new('!=', [[Datatype::BuiltinDatatype, Datatype::BuiltinDatatype]])
+        binary_operators[:!=] = not_equal_op
+
+        less_op = BinaryOperator.new('<', [[Datatype::Number, :idem]])
+        binary_operators[:<] = less_op
+
+        less_equal_op = BinaryOperator.new('<=', [[Datatype::Number, :idem]])
+        binary_operators[:<=] = less_equal_op
+
+        greater_op = BinaryOperator.new('>', [[Datatype::Number, :idem]])
+        binary_operators[:>] = greater_op
+
+        greater_equal_op = BinaryOperator.new('>=', [[Datatype::Number, :idem]])
+        binary_operators[:>=] = greater_equal_op
       end
 
       def init_globals

data/lib/loxxy/back_end/function.rb

@@ -0,0 +1,51 @@
+# 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
+
+      # 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/unary_operator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../error'
+
+module Loxxy
+  module BackEnd
+    # A Lox unary operator
+    class UnaryOperator
+      # @return [String] text representation of the operator
+      attr_reader :name
+
+      # @return [Array<Class>]
+      attr_reader :signatures
+
+      # @param aName [String] "name" of operator
+      # @param theSignatures [Array<Class>] allowed signatures
+      def initialize(aName, theSignatures)
+        @name = aName
+        @signatures = theSignatures
+      end
+
+      def validate_operand(operand1)
+        compliant = signatures.find { |some_type| operand1.kind_of?(some_type) }
+
+        unless compliant
+          err = Loxxy::RuntimeError
+          # if signatures.size == 1
+          raise err, "Operand must be a #{datatype_name(signatures[0])}."
+          # end
+        end
+      end
+
+      private
+
+      def datatype_name(aClass)
+        # (?:(?:[^:](?!:|(?<=LX))))+$
+        aClass.name.sub(/^.+(?=::)::(?:LX)?/, '').downcase
+      end
+    end # class
+  end # module
+end # module

data/lib/loxxy/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Loxxy
+  # Abstract class. Generalization of Loxxy error classes.
+  class Error < StandardError; end
+
+  # Error occurring while Loxxy executes some invalid Lox code.
+  class RuntimeError < Error; end
+end

data/lib/loxxy/front_end/grammar.rb

@@ -44,7 +44,7 @@ module Loxxy
       rule('function_star' => 'function_star function')
       rule('function_star' => [])
 
-      rule('funDecl' => 'FUN function')
+      rule('funDecl' => 'FUN function').as 'fun_decl'
 
       rule('varDecl' => 'VAR IDENTIFIER SEMICOLON').as 'var_declaration'
       rule('varDecl' => 'VAR IDENTIFIER EQUAL expression SEMICOLON').as 'var_initialization'
@@ -74,10 +74,10 @@ 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')
+      rule('block' => 'LEFT_BRACE RIGHT_BRACE').as 'block_empty'
 
       # Expressions: produce values
       rule('expression_opt' => 'expression')
@@ -142,11 +142,11 @@ module Loxxy
       rule('primary' => 'SUPER DOT IDENTIFIER')
 
       # Utility rules
-      rule('function' => 'IDENTIFIER LEFT_PAREN params_opt RIGHT_PAREN block')
+      rule('function' => 'IDENTIFIER LEFT_PAREN params_opt RIGHT_PAREN block').as 'function'
       rule('params_opt' => 'parameters')
       rule('params_opt' => [])
-      rule('parameters' => 'parameters COMMA IDENTIFIER')
-      rule('parameters' => 'IDENTIFIER')
+      rule('parameters' => 'parameters COMMA IDENTIFIER').as 'parameters_plus_more'
+      rule('parameters' => 'IDENTIFIER').as 'parameters_plus_end'
       rule('arguments_opt' => 'arguments')
       rule('arguments_opt' => [])
       rule('arguments' => 'arguments COMMA expression').as 'arguments_plus_more'

data/lib/loxxy/front_end/literal.rb

@@ -11,7 +11,7 @@ module Loxxy
 
       # Constructor.
       # @param aValue [Datatype::BuiltinDatatype] the Lox data value
-      # @param theLexeme [String] the lexeme (= piece of text from input)
+      # @param aLexeme [String] the lexeme (= piece of text from input)
       # @param aTerminal [Rley::Syntax::Terminal, String]
       #   The terminal symbol corresponding to the lexeme.
       # @param aPosition [Rley::Lexical::Position] The position of lexeme

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.0.28'
+  VERSION = '0.1.04'
 end

data/loxxy.gemspec

@@ -46,8 +46,8 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
   spec.required_ruby_version = '~> 2.4'
 
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['loxxy']
   spec.require_paths = ['lib']
 
   PkgExtending.pkg_files(spec)

data/spec/interpreter_spec.rb

@@ -9,6 +9,7 @@ require_relative '../lib/loxxy/interpreter'
 module Loxxy
   # This spec contains the bare bones test for the Interpreter class.
   # The execution of Lox code is tested elsewhere.
+  # rubocop: disable Metrics/BlockLength
   describe Interpreter do
     let(:sample_cfg) do
       { ostream: StringIO.new }
@@ -386,18 +387,71 @@ LOX_END
 
       it 'should implement nullary function calls' do
         program = <<-LOX_END
-          print clock(); // Lox expect the 'clock' predefined native function
+          print clock(); // Lox expects the 'clock' predefined native function
         LOX_END
         expect { subject.evaluate(program) }.not_to raise_error
         tick = sample_cfg[:ostream].string
         expect(Time.now.to_f - tick.to_f).to be < 0.1
       end
 
+      it 'should implement function definition' do
+        program = <<-LOX_END
+          fun printSum(a, b) {
+             print a + b;
+          }
+          printSum(1, 2);
+        LOX_END
+        expect { subject.evaluate(program) }.not_to raise_error
+        expect(sample_cfg[:ostream].string).to eq('3')
+      end
+
+      it 'should support functions with empty body' do
+        program = <<-LOX_END
+          fun f() {}
+          print f();
+        LOX_END
+        expect { subject.evaluate(program) }.not_to raise_error
+        expect(sample_cfg[:ostream].string).to eq('nil')
+      end
+
+      it 'should provide print representation of functions' do
+        program = <<-LOX_END
+          fun foo() {}
+          print foo; // output: <fn foo>
+          print clock; // output: <native fn>
+        LOX_END
+        expect { subject.evaluate(program) }.not_to raise_error
+        expect(sample_cfg[:ostream].string).to eq('<fn foo><native fn>')
+      end
+
+      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
 
       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!')
       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)
+      end
+    end # context
   end # describe
+  # rubocop: enable Metrics/BlockLength
 end # module

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loxxy
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.1.04
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2021-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rley
@@ -69,7 +69,8 @@ dependencies:
 description: An implementation of the Lox programming language. WIP
 email:
 - famished.tiger@yahoo.com
-executables: []
+executables:
+- loxxy
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -83,6 +84,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/loxxy
 - lib/loxxy.rb
 - lib/loxxy/ast/all_lox_nodes.rb
 - lib/loxxy/ast/ast_builder.rb
@@ -93,6 +95,7 @@ files:
 - lib/loxxy/ast/lox_call_expr.rb
 - lib/loxxy/ast/lox_compound_expr.rb
 - lib/loxxy/ast/lox_for_stmt.rb
+- lib/loxxy/ast/lox_fun_stmt.rb
 - lib/loxxy/ast/lox_grouping_expr.rb
 - lib/loxxy/ast/lox_if_stmt.rb
 - lib/loxxy/ast/lox_literal_expr.rb
@@ -100,15 +103,19 @@ 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
 - lib/loxxy/ast/lox_variable_expr.rb
 - lib/loxxy/ast/lox_while_stmt.rb
+- lib/loxxy/back_end/binary_operator.rb
 - 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/symbol_table.rb
+- lib/loxxy/back_end/unary_operator.rb
 - lib/loxxy/back_end/variable.rb
 - lib/loxxy/datatype/all_datatypes.rb
 - lib/loxxy/datatype/boolean.rb
@@ -118,6 +125,7 @@ files:
 - lib/loxxy/datatype/nil.rb
 - lib/loxxy/datatype/number.rb
 - lib/loxxy/datatype/true.rb
+- lib/loxxy/error.rb
 - lib/loxxy/front_end/grammar.rb
 - lib/loxxy/front_end/literal.rb
 - lib/loxxy/front_end/parser.rb