loxxy 0.2.00 → 0.2.05

data/lib/loxxy/ast/lox_set_expr.rb

@@ -18,11 +18,7 @@ module Loxxy
         @object = anObject
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_set_expr(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_super_expr.rb

@@ -18,17 +18,13 @@ module Loxxy
         @property = aMethodName
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_super_expr(self)
-      end
-
       # Quack like a LoxVariableExpr
       # @return [String] the `super` keyword
       def name
         'super'
       end
+
+      define_accept # Add `accept` method as found in Visitor design pattern
       alias callee= object=
     end # class
   end # module

data/lib/loxxy/ast/lox_this_expr.rb

@@ -12,11 +12,7 @@ module Loxxy
         'this'
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param _visitor [LoxxyTreeVisitor] the visitor
-      def accept(aVisitor)
-        aVisitor.visit_this_expr(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_unary_expr.rb

@@ -15,12 +15,7 @@ module Loxxy
         @operator = anOperator
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_unary_expr(self)
-      end
-
+      define_accept # Add `accept` method as found in Visitor design pattern
       alias operands subnodes
     end # class
   end # module

data/lib/loxxy/ast/lox_var_stmt.rb

@@ -18,11 +18,7 @@ module Loxxy
         @name = aName
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_var_stmt(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_variable_expr.rb

@@ -16,11 +16,7 @@ module Loxxy
         @name = aName
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_variable_expr(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_while_stmt.rb

@@ -16,17 +16,13 @@ module Loxxy
         @body = theBody
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_while_stmt(self)
-      end
-
       # Accessor to the condition expression
       # @return [LoxNode]
       def condition
         subnodes[0]
       end
+
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/back_end/engine.rb

@@ -74,7 +74,7 @@ module Loxxy
           aClassStmt.superclass.accept(aVisitor)
           parent = 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
@@ -116,19 +116,6 @@ module Loxxy
         before_block_stmt(aForStmt)
       end
 
-      def after_for_stmt(aForStmt, aVisitor)
-        loop do
-          aForStmt.test_expr.accept(aVisitor)
-          condition = stack.pop
-          break unless condition.truthy?
-
-          aForStmt.body_stmt.accept(aVisitor)
-          aForStmt.update_expr&.accept(aVisitor)
-          stack.pop
-        end
-        after_block_stmt(aForStmt)
-      end
-
       def after_if_stmt(anIfStmt, aVisitor)
         # Retrieve the result of the condition evaluation
         condition = stack.pop
@@ -154,7 +141,7 @@ module Loxxy
           break unless condition.truthy?
 
           aWhileStmt.body.accept(aVisitor)
-          aWhileStmt.condition.accept(aVisitor)
+          aWhileStmt.condition&.accept(aVisitor)
         end
       end
 
@@ -170,22 +157,26 @@ 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
         variable.assign(value)
       end
 
-      def after_set_expr(aSetExpr, aVisitor)
-        value = stack.pop
-        # Evaluate object part
+      def before_set_expr(aSetExpr, aVisitor)
+        # Evaluate receiver object part
         aSetExpr.object.accept(aVisitor)
+      end
+
+      def after_set_expr(aSetExpr, _visitor)
+        value = stack.pop
         assignee = stack.pop
         unless assignee.kind_of?(LoxInstance)
-          raise StandardError, 'Only instances have fields.'
+          raise Loxxy::RuntimeError, 'Only instances have fields.'
         end
 
         assignee.set(aSetExpr.property, value)
+        stack.push value
       end
 
       def after_logical_expr(aLogicalExpr, visitor)
@@ -272,7 +263,7 @@ module Loxxy
         aGetExpr.object.accept(aVisitor)
         instance = stack.pop
         unless instance.kind_of?(LoxInstance)
-          raise StandardError, 'Only instances have properties.'
+          raise Loxxy::RuntimeError, 'Only instances have properties.'
         end
 
         stack.push instance.get(aGetExpr.property)
@@ -285,7 +276,7 @@ module Loxxy
       def after_variable_expr(aVarExpr, aVisitor)
         var_name = aVarExpr.name
         var = variable_lookup(aVarExpr)
-        raise StandardError, "Undefined variable '#{var_name}'." unless var
+        raise Loxxy::RuntimeError, "Undefined variable '#{var_name}'." unless var
 
         var.value.accept(aVisitor) # Evaluate variable value then push on stack
       end

data/lib/loxxy/back_end/lox_instance.rb

@@ -38,7 +38,7 @@ module Loxxy
 
         method = klass.find_method(aName)
         unless method
-          raise StandardError, "Undefined property '#{aName}'."
+          raise Loxxy::RuntimeError, "Undefined property '#{aName}'."
         end
 
         method.bind(self)

data/lib/loxxy/back_end/resolver.rb

@@ -88,17 +88,6 @@ module Loxxy
         @current_class = previous_class
       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)
@@ -123,7 +112,7 @@ module Loxxy
 
       def after_while_stmt(aWhileStmt, aVisitor)
         aWhileStmt.body.accept(aVisitor)
-        aWhileStmt.condition.accept(aVisitor)
+        aWhileStmt.condition&.accept(aVisitor)
       end
 
       # A variable declaration adds a new variable to current scope

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/parser.rb

@@ -46,7 +46,7 @@ module Loxxy
           # Stop if the parse failed...
           line1 = "Parsing failed\n"
           line2 = "Reason: #{result.failure_reason.message}"
-          raise StandardError, line1 + line2
+          raise SyntaxError, line1 + line2
         end
 
         return engine.convert(result) # engine.to_ptree(result)

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'
 
@@ -53,15 +54,13 @@ module Loxxy
         '<=' => 'LESS_EQUAL'
       }.freeze
 
-      # Here are all the implemented Lox keywords (in uppercase)
+      # Here are all the implemented Lox keywords
       # These are enumerated in section 4.2.1 Token type
       @@keywords = %w[
-        AND CLASS ELSE FALSE FUN FOR IF NIL OR
-        PRINT RETURN SUPER THIS TRUE VAR WHILE
+        and class else false fun for if nil or
+        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)
@@ -114,14 +113,17 @@ module Loxxy
         elsif (lexeme = scanner.scan(/"(?:\\"|[^"])*"/))
           token = build_token('STRING', lexeme)
         elsif (lexeme = scanner.scan(/[a-zA-Z_][a-zA-Z_0-9]*/))
-          keyw = @@keywords[lexeme.upcase]
-          tok_type = keyw || 'IDENTIFIER'
+          keyw = @@keywords[lexeme]
+          tok_type = keyw ? keyw.upcase : '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/version.rb

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

data/loxxy.gemspec

@@ -41,7 +41,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Dimitri Geshef']
   spec.email         = ['famished.tiger@yahoo.com']
   spec.summary       = 'An implementation of the Lox programming language.'
-  spec.description   = '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/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]
@@ -197,6 +217,13 @@ LOX_END
           expect(token_nil.lexeme).to eq('nil')
           expect(token_nil.value).to be_kind_of(Datatype::Nil)
         end
+
+        it 'should differentiate nil from variable spelled same' do
+          subject.start_with('Nil')
+          similar = subject.tokens[0]
+          expect(similar.terminal).to eq('IDENTIFIER')
+          expect(similar.lexeme).to eq('Nil')
+        end
       end # context
 
       context 'Handling comments:' do
@@ -237,6 +264,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