loxxy 0.1.15 → 0.2.02

data/lib/loxxy/back_end/symbol_table.rb

@@ -85,7 +85,7 @@ module Loxxy
           name2envs[name] = [current_env]
         end
 
-        anEntry.name # anEntry.i_name
+        anEntry.name
       end
 
       # Search for the object with the given name
@@ -99,23 +99,6 @@ module Loxxy
         sc.defns[aName]
       end
 
-      # Search for the object with the given i_name
-      # @param anIName [String]
-      # @return [BackEnd::Variable]
-      # def lookup_i_name(anIName)
-        # found = nil
-        # environment = current_env
-
-        # begin
-          # found = environment.defns.values.find { |e| e.i_name == anIName }
-          # break if found
-
-          # environment = environment.parent
-        # end while environment
-
-        # found
-      # end
-
       # Return all variables defined in the current .. root chain.
       # Variables are sorted top-down and left-to-right.
       def all_variables

data/lib/loxxy/cli_parser.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'optparse' # Use standard OptionParser class for command-line parsing
+
+module Loxxy
+  # A command-line option parser for the Loxxy interpreter.
+  # It is a specialisation of the OptionParser class.
+  class CLIParser < OptionParser
+    # @return [Hash{Symbol=>String, Array}]
+    attr_reader(:parsed_options)
+
+    # Constructor.
+    def initialize(prog_name, ver)
+      super()
+      reset(prog_name, ver)
+
+      heading
+      separator 'Options:'
+      separator ''
+      add_tail_options
+    end
+
+    def parse!(args)
+      super
+      parsed_options
+    end
+
+    private
+
+    def reset(prog_name, ver)
+      @program_name = prog_name
+      @version = ver
+      @banner = "Usage: #{prog_name} LOX_FILE [options]"
+      @parsed_options = {}
+    end
+
+    def description
+      <<-DESCR
+  Description:
+    loxxy is a Lox interpreter, it executes the Lox file(s) given in command-line.
+    More on Lox Language: https://craftinginterpreters.com/the-lox-language.html
+
+  Example:
+    #{program_name} hello.lox
+      DESCR
+    end
+
+    def heading
+      banner
+      separator ''
+      separator description
+      separator ''
+    end
+
+    def add_tail_options
+      on_tail('--version', 'Display the program version then quit.') do
+        puts version
+        exit(0)
+      end
+
+      on_tail('-?', '-h', '--help', 'Display this help then quit.') do
+        puts help
+        exit(0)
+      end
+    end
+  end # class
+end # module
+# End of file

data/lib/loxxy/error.rb

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

data/lib/loxxy/front_end/grammar.rb

@@ -38,7 +38,7 @@ module Loxxy
       rule('declaration' => 'stmt')
 
       rule('classDecl' => 'CLASS classNaming class_body').as 'class_decl'
-      rule('classNaming' => 'IDENTIFIER LESS IDENTIFIER')
+      rule('classNaming' => 'IDENTIFIER LESS IDENTIFIER').as 'class_subclassing'
       rule('classNaming' => 'IDENTIFIER').as 'class_name'
       rule('class_body' => 'LEFT_BRACE methods_opt RIGHT_BRACE').as 'class_body'
       rule('methods_opt' => 'method_plus')
@@ -143,7 +143,7 @@ module Loxxy
       rule('primary' => 'STRING').as 'literal_expr'
       rule('primary' => 'IDENTIFIER').as 'variable_expr'
       rule('primary' => 'LEFT_PAREN expression RIGHT_PAREN').as 'grouping_expr'
-      rule('primary' => 'SUPER DOT IDENTIFIER')
+      rule('primary' => 'SUPER DOT IDENTIFIER').as 'super_expr'
 
       # Utility rules
       rule('function' => 'IDENTIFIER LEFT_PAREN params_opt RIGHT_PAREN block').as 'function'

data/lib/loxxy/front_end/scanner.rb

@@ -2,6 +2,7 @@
 
 require 'strscan'
 require 'rley'
+require_relative '../error'
 require_relative '../datatype/all_datatypes'
 require_relative 'literal'
 
@@ -60,8 +61,6 @@ module Loxxy
         PRINT RETURN SUPER THIS TRUE VAR WHILE
       ].map { |x| [x, x] }.to_h
 
-      class ScanError < StandardError; end
-
       # Constructor. Initialize a tokenizer for Lox input.
       # @param source [String] Lox text to tokenize.
       def initialize(source = nil)
@@ -117,11 +116,14 @@ module Loxxy
           keyw = @@keywords[lexeme.upcase]
           tok_type = keyw || 'IDENTIFIER'
           token = build_token(tok_type, lexeme)
+        elsif scanner.scan(/"(?:\\"|[^"])*\z/)
+          # Error: unterminated string...
+          col = scanner.pos - @line_start + 1
+          raise ScanError, "Error: [line #{lineno}:#{col}]: Unterminated string."
         else # Unknown token
-          erroneous = curr_ch.nil? ? '' : scanner.scan(/./)
-          sequel = scanner.scan(/.{1,20}/)
-          erroneous += sequel unless sequel.nil?
-          raise ScanError, "Unknown token #{erroneous} on line #{lineno}"
+          col = scanner.pos - @line_start + 1
+          _erroneous = curr_ch.nil? ? '' : scanner.scan(/./)
+          raise ScanError, "Error: [line #{lineno}:#{col}]: Unexpected character."
         end
 
         return token
@@ -156,7 +158,7 @@ module Loxxy
           when 'NUMBER'
             value = Datatype::Number.new(aLexeme)
           when 'STRING'
-            value = Datatype::LXString.new(aLexeme)
+            value = Datatype::LXString.new(unescape_string(aLexeme))
           when 'TRUE'
             value = Datatype::True.instance
           else
@@ -166,6 +168,29 @@ module Loxxy
         return [value, symb]
       end
 
+      # Replace any sequence sequence by their "real" value.
+      def unescape_string(aText)
+        result = +''
+        previous = nil
+
+        aText.each_char do |ch|
+          if previous
+            if ch == ?n
+              result << "\n"
+            else
+              result << ch
+            end
+            previous = nil
+          elsif ch == '\\'
+            previous = ?\
+          else
+            result << ch
+          end
+        end
+
+        result
+      end
+
       # Skip non-significant whitespaces and comments.
       # Advance the scanner until something significant is found.
       def skip_intertoken_spaces

data/lib/loxxy/interpreter.rb

@@ -24,6 +24,15 @@ module Loxxy
     # @param lox_input [String] Lox program to evaluate
     # @return [Loxxy::Datatype::BuiltinDatatype]
     def evaluate(lox_input)
+      raw_evaluate(lox_input).first
+    end
+
+    # Evaluate the given Lox program.
+    # Return the pair [result, a BackEnd::Engine instance]
+    #   where result is the value of the last executed expression (if any)
+    # @param lox_input [String] Lox program to evaluate
+    # @return Loxxy::Datatype::BuiltinDatatype, Loxxy::BackEnd::Engine]
+    def raw_evaluate(lox_input)
       # Front-end scans, parses the input and blurps an AST...
       parser = FrontEnd::Parser.new
 
@@ -34,7 +43,9 @@ module Loxxy
       # Back-end launches the tree walking & responds to visit events
       # by executing the code determined by the visited AST node.
       engine = BackEnd::Engine.new(config)
-      engine.execute(visitor)
+      result = engine.execute(visitor)
+
+      [result, engine]
     end
   end # class
 end # module

data/lib/loxxy/version.rb

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

data/loxxy.gemspec

@@ -40,8 +40,12 @@ Gem::Specification.new do |spec|
   spec.version       = Loxxy::VERSION
   spec.authors       = ['Dimitri Geshef']
   spec.email         = ['famished.tiger@yahoo.com']
-  spec.summary       = 'An implementation of the Lox programming language. WIP'
-  spec.description   = 'An implementation of the Lox programming language. WIP'
+  spec.summary       = 'An implementation of the Lox programming language.'
+  spec.description   = <<-DESCR_END
+  A Ruby implementation of the Lox programming language. Lox is a dynamically typed,
+  object-oriented programming language that features first-class functions, closures,
+  classes, and inheritance.
+  DESCR_END
   spec.homepage      = 'https://github.com/famished-tiger/loxxy'
   spec.license       = 'MIT'
   spec.required_ruby_version = '~> 2.4'

data/spec/back_end/engine_spec.rb

@@ -34,15 +34,7 @@ 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)
 

data/spec/front_end/scanner_spec.rb

@@ -189,6 +189,26 @@ LOX_END
           end
         end
 
+        it 'should recognize escaped quotes' do
+          embedded_quotes = %q{she said: \"Hello\"}
+          result = subject.send(:unescape_string, embedded_quotes)
+          expect(result).to eq('she said: "Hello"')
+        end
+
+        it 'should recognize escaped backslash' do
+          embedded_backslash = 'backslash>\\\\'
+          result = subject.send(:unescape_string, embedded_backslash)
+          expect(result).to eq('backslash>\\')
+        end
+
+        # rubocop: disable Style/StringConcatenation
+        it 'should recognize newline escape sequence' do
+          embedded_newline = 'line1\\nline2'
+          result = subject.send(:unescape_string, embedded_newline)
+          expect(result).to eq('line1' + "\n" + 'line2')
+        end
+        # rubocop: enable Style/StringConcatenation
+
         it 'should recognize a nil token' do
           subject.start_with('nil')
           token_nil = subject.tokens[0]
@@ -237,6 +257,20 @@ LOX_END
           ]
           match_expectations(subject, expectations)
         end
+
+        it 'should complain if it finds an unterminated string' do
+          subject.start_with('var a = "Unfinished;')
+          err = Loxxy::ScanError
+          err_msg = 'Error: [line 1:21]: Unterminated string.'
+          expect { subject.tokens }.to raise_error(err, err_msg)
+        end
+
+        it 'should complain if it finds an unexpected character' do
+          subject.start_with('var a = ?1?;')
+          err = Loxxy::ScanError
+          err_msg = 'Error: [line 1:9]: Unexpected character.'
+          expect { subject.tokens }.to raise_error(err, err_msg)
+        end
       end # context
     end # describe
   end # module

data/spec/interpreter_spec.rb

@@ -6,6 +6,7 @@ require 'stringio'
 # Load the class under test
 require_relative '../lib/loxxy/interpreter'
 
+# rubocop: disable Metrics/ModuleLength
 module Loxxy
   # This spec contains the bare bones test for the Interpreter class.
   # The execution of Lox code is tested elsewhere.
@@ -525,7 +526,100 @@ LOX_END
         expect { subject.evaluate(program) }.not_to raise_error
         expect(sample_cfg[:ostream].string).to eq('Egotist instance')
       end
+
+      it 'should support a closure nested in a method' do
+        lox_snippet = <<-LOX_END
+        class Foo {
+          getClosure() {
+            fun closure() {
+              return this.toString();
+            }
+            return closure;
+          }
+
+          toString() { return "foo"; }
+        }
+
+        var closure = Foo().getClosure();
+        closure;
+        LOX_END
+        # Expected result: Backend::LoxFunction('closure')
+        # Expected function's closure (environment layout):
+        # Environment('global')
+        #   defns
+        #   +- ['clock'] => BackEnd::Engine::NativeFunction
+        #   *- ['Foo'] => BackEnd::LoxClass
+        # Environment
+        #   defns
+        #   ['this'] => BackEnd::LoxInstance
+        # Environment
+        #   defns
+        #   +- ['closure'] => Backend::LoxFunction
+        result = subject.evaluate(lox_snippet)
+        expect(result).to be_kind_of(BackEnd::LoxFunction)
+        expect(result.name).to eq('closure')
+        closure = result.closure
+        expect(closure).to be_kind_of(Loxxy::BackEnd::Environment)
+        expect(closure.defns['closure'].value).to eq(result)
+        expect(closure.enclosing).to be_kind_of(Loxxy::BackEnd::Environment)
+        expect(closure.enclosing.defns['this'].value).to be_kind_of(Loxxy::BackEnd::LoxInstance)
+        global_env = closure.enclosing.enclosing
+        expect(global_env).to be_kind_of(Loxxy::BackEnd::Environment)
+        expect(global_env.defns['clock'].value).to be_kind_of(BackEnd::Engine::NativeFunction)
+        expect(global_env.defns['Foo'].value).to be_kind_of(BackEnd::LoxClass)
+      end
+
+      it 'should support custom initializer' do
+        lox_snippet = <<-LOX_END
+          // From section 3.9.5
+          class Breakfast {
+            init(meat, bread) {
+              this.meat = meat;
+              this.bread = bread;
+            }
+
+            serve(who) {
+              print "Enjoy your " + this.meat + " and " +
+                  this.bread + ", " + who + ".";
+            }
+          }
+
+          var baconAndToast = Breakfast("bacon", "toast");
+          baconAndToast.serve("Dear Reader");
+          // Output: "Enjoy your bacon and toast, Dear Reader."
+        LOX_END
+        expect { subject.evaluate(lox_snippet) }.not_to raise_error
+        predicted = 'Enjoy your bacon and toast, Dear Reader.'
+        expect(sample_cfg[:ostream].string).to eq(predicted)
+      end
+
+      it 'should support class inheritance and super keyword' do
+        lox_snippet = <<-LOX_END
+          class A {
+            method() {
+              print "A method";
+            }
+          }
+
+          class B < A {
+            method() {
+              print "B method";
+            }
+
+            test() {
+              super.method();
+            }
+          }
+
+          class C < B {}
+
+          C().test();
+        LOX_END
+        expect { subject.evaluate(lox_snippet) }.not_to raise_error
+        expect(sample_cfg[:ostream].string).to eq('A method')
+      end
     end # context
   end # describe
   # rubocop: enable Metrics/BlockLength
 end # module
+# rubocop: enable Metrics/ModuleLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loxxy
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.2.02
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rley
@@ -66,7 +66,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: An implementation of the Lox programming language. WIP
+description: |2
+    A Ruby implementation of the Lox programming language. Lox is a dynamically typed,
+    object-oriented programming language that features first-class functions, closures,
+    classes, and inheritance.
 email:
 - famished.tiger@yahoo.com
 executables:
@@ -108,6 +111,7 @@ files:
 - lib/loxxy/ast/lox_return_stmt.rb
 - lib/loxxy/ast/lox_seq_decl.rb
 - lib/loxxy/ast/lox_set_expr.rb
+- lib/loxxy/ast/lox_super_expr.rb
 - lib/loxxy/ast/lox_this_expr.rb
 - lib/loxxy/ast/lox_unary_expr.rb
 - lib/loxxy/ast/lox_var_stmt.rb
@@ -124,6 +128,7 @@ files:
 - lib/loxxy/back_end/symbol_table.rb
 - lib/loxxy/back_end/unary_operator.rb
 - lib/loxxy/back_end/variable.rb
+- lib/loxxy/cli_parser.rb
 - lib/loxxy/datatype/all_datatypes.rb
 - lib/loxxy/datatype/boolean.rb
 - lib/loxxy/datatype/builtin_datatype.rb
@@ -178,7 +183,7 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: An implementation of the Lox programming language. WIP
+summary: An implementation of the Lox programming language.
 test_files:
 - spec/back_end/engine_spec.rb
 - spec/back_end/environment_spec.rb