loxxy 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 172ec5df8e553332b497968f7b910383cb38314aabbdb84fdb42fba6986841ea
-  data.tar.gz: 3d72fd4f13f507f88e9e735e1ebdd0d63fd603b771f9cfb552b9aa38b5b3ca6a
+  metadata.gz: 51728e22602ac35f1c31a9540daf75d4dcf0e84d1f323dd3ec287440b6fe21ef
+  data.tar.gz: beda9e48d5024a567bf2e1dd84f107991443e8bf2592b2a01f39e2ca39adc751
 SHA512:
-  metadata.gz: 61073737ef6c069e6e1177fa79cdac543253e06ea63d2ca1b00517c08a06f46948fe7d51257308935d92579152793b4fe60bc0f5b901a1c931e5eafab9f35ecd
-  data.tar.gz: 57c87936451c3015511740d7d44f01d8f032a06e597bdfd1d133119413c227a61df11847f86a4be3a2b3440cc1f614a43b1144cceef05a58ade56ca1fa3c598b
+  metadata.gz: 72688ddf02138d6bab0cdbf8bcb3c0087a17e461dbd269fa56f4ddfe4f674172fd957ae071f0e61b6c7296ff3653a2734cc4fb9573340914337621b1d198ed0d
+  data.tar.gz: 45374a6d536f32c81f8bfdea4eeb670bb8c9d0ea0bdbc1d1c151379601d75f11e0353f20feb705a68cb647352f49c4c1231e7ba087081b9720297f79d1427db7

data/CHANGELOG.md

@@ -1,7 +1,21 @@
+## [0.1.14] - 2021-04-05
+- `Loxxy` now implements the 'this' keyword
+
+### New
+- Class `Ast::LoxThisExpr` a syntax node that represents an occurrence of the `this` keyword
+- Method `Ast::ASTBuilder#reduce_this_expr` parse action for this keyword
+- Method `Ast::Visitor#visit_this_expr` visit of an `Ast::LoxThisExpr` node
+- Method `BackEnd::Engine#after_this_expr` runtime action for this keyword (i.e. refers to current instance)
+- Method `BackEnd::LoxFunction#bind` implementation of bound method
+
+### Changed
+- Class `BackEnd::Resolver` implementing semantic actions for `this` keyword
+- File `grammar.rb` added name to a syntax rule
+
 ## [0.1.13] - 2021-04-05
 - `Loxxy` now implements method calls
 
-## New
+### New
 - Class `Ast::LoxGetExpr` a syntax node that represents a read access to an object property
 - Class `Ast::LoxSetExpr` a syntax node that represents a write access to an object property
 - Method `Ast::ASTBuilder#reduce_set_expr` parse action for write access to an object property
@@ -11,11 +25,11 @@
 - Method `BackEnd::Engine#after_set_expr` runtime action for property setting
 - Method `BackEnd::Engine#after_get_expr` runtime action for property getting
 - Method `BackEnd::LoxInstance#set` implementation of write accessor
-- Method `BackEnd::LoxInstance#getr` implementation of read accessor
+- Method `BackEnd::LoxInstance#get` implementation of read accessor
 - Method `BackEnd::Resolver#after_set_expr` resolve action for property setting
 - Method `BackEnd::Resolver#after_get_expr` resolve action for property getting
 
-## Changed
+### Changed
 - Method `Ast::ASTBuilder#reduce_assign_expr` expanded to support write access to an object property
 - Class `LoxClassStmt`: methods are now aggregate under the `body` attribute
 - Class `LoxFunStmt`: has a new attribute `is_method` and inherits from `Ast::LoxNode`

data/README.md

@@ -177,8 +177,8 @@ Loxxy supports single line C-style comments.
 ### Keywords
 Loxxy implements the following __Lox__ reserved keywords:
 ```lang-none
-and, else, false, for, fun, if,
-nil, or, print, true, var, while
+and, class, else, false, for, fun, if,
+nil, or, print, return, this, true, var, while
 ```
 
 ### Datatypes

data/lib/loxxy/ast/all_lox_nodes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'lox_fun_stmt'
+require_relative 'lox_this_expr'
 require_relative 'lox_variable_expr'
 require_relative 'lox_literal_expr'
 require_relative 'lox_noop_expr'

data/lib/loxxy/ast/ast_builder.rb

@@ -354,6 +354,11 @@ module Loxxy
         LoxVariableExpr.new(tokens[0].position, var_name)
       end
 
+      # rule('primary' => 'THIS')
+      def reduce_this_expr(_production, _range, tokens, _children)
+        LoxThisExpr.new(tokens[0].position)
+      end
+
       # rule('function' => 'IDENTIFIER LEFT_PAREN params_opt RIGHT_PAREN block').as 'function'
       def reduce_function(_production, _range, _tokens, theChildren)
         first_child = theChildren.first

data/lib/loxxy/ast/ast_visitor.rb

@@ -205,6 +205,13 @@ module Loxxy
         broadcast(:after_variable_expr, aVariableExpr, self)
       end
 
+      # Visit event. The visitor is about to visit the this keyword.
+      # @param aThisExpr [Ast::LoxThisExpr] this expression
+      def visit_this_expr(aThisExpr)
+        broadcast(:before_this_expr, aThisExpr)
+        broadcast(:after_this_expr, aThisExpr, self)
+      end
+
       # Visit event. The visitor is about to visit the given terminal datatype value.
       # @param aValue [Ast::BuiltinDattype] the built-in datatype value
       def visit_builtin(aValue)

data/lib/loxxy/ast/lox_this_expr.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'lox_node'
+
+module Loxxy
+  module Ast
+    # A node in a parse tree that represents the occurrence of 'this' keyword.
+    class LoxThisExpr < LoxNode
+      # Duck-typing: behaves like a LoxVarExpr
+      # @return [String] return the this keyword
+      def name
+        '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
+    end # class
+  end # module
+end # module

data/lib/loxxy/back_end/engine.rb

@@ -281,6 +281,11 @@ module Loxxy
         stack.push(literalExpr.literal)
       end
 
+      def after_this_expr(aThisExpr, aVisitor)
+        var = variable_lookup(aThisExpr)
+        var.value.accept(aVisitor) # Evaluate this value then push on stack
+      end
+
       # @param aValue [Ast::BuiltinDattype] the built-in datatype value
       def before_visit_builtin(aValue)
         stack.push(aValue)

data/lib/loxxy/back_end/environment.rb

@@ -37,7 +37,6 @@ module Loxxy
       # @return [BackEnd::Variable] the variable
       def insert(anEntry)
         e = validated_entry(anEntry)
-        # e.suffix = default_suffix if e.kind_of?(BackEnd::Variable)
         defns[e.name] = e
 
         e

data/lib/loxxy/back_end/lox_function.rb

@@ -52,6 +52,16 @@ module Loxxy
         engine.symbol_table.leave_environment
       end
 
+      def bind(anInstance)
+        new_env = Environment.new(closure)
+        this = Variable.new('this', anInstance)
+        new_env.insert(this)
+        bound_method = dup
+        bound_method.instance_variable_set(:@closure, new_env)
+
+        bound_method
+      end
+
       # Logical negation.
       # As a function is a truthy thing, its negation is thus false.
       # @return [Datatype::False]

data/lib/loxxy/back_end/lox_instance.rb

@@ -9,7 +9,7 @@ module Loxxy
       # @return BackEnd::LoxClass] the class that this object is an instance of
       attr_reader :klass
 
-      attr_reader :stack
+      attr_reader :engine
 
       # @return [Hash{String => BuiltinDatatype | LoxFunction | LoxInstance }]
       attr_reader :fields
@@ -18,12 +18,12 @@ module Loxxy
       # @param aClass [BackEnd::LoxClass] the class this this object belong
       def initialize(aClass, anEngine)
         @klass = aClass
-        @stack = anEngine.stack
+        @engine = anEngine
         @fields = {}
       end
 
       def accept(_visitor)
-        stack.push self
+        engine.stack.push self
       end
 
       # Text representation of a Lox instance
@@ -41,7 +41,7 @@ module Loxxy
           raise StandardError, "Undefined property '#{aName}'."
         end
 
-        method
+        method.bind(self)
       end
 
       # Set the value of property with given name

data/lib/loxxy/back_end/resolver.rb

@@ -26,10 +26,15 @@ module Loxxy
       # @return [Symbol] must be one of: :none, :function
       attr_reader :current_function
 
+      # An indicator that tells we're in the middle of a class declaration
+      # @return [Symbol] must be one of: :none, :class
+      attr_reader :current_class
+
       def initialize
         @scopes = []
         @locals = {}
         @current_function = :none
+        @current_class = :none
       end
 
       # Given an abstract syntax parse tree visitor, launch the visit
@@ -59,10 +64,16 @@ module Loxxy
       end
 
       def after_class_stmt(aClassStmt, aVisitor)
+        previous_class = current_class
+        @current_class = :class
         define(aClassStmt.name)
+        begin_scope
+        define('this')
         aClassStmt.body.each do |fun_stmt|
           resolve_function(fun_stmt, :method, aVisitor)
         end
+        end_scope
+        @current_class = previous_class
       end
 
       def before_for_stmt(aForStmt)
@@ -140,6 +151,18 @@ module Loxxy
         aGetExpr.object.accept(aVisitor)
       end
 
+      def before_this_expr(_thisExpr)
+        if current_class == :none
+          msg = "Error at 'this': Can't use 'this' outside of a class."
+          raise StandardError, msg
+        end
+      end
+
+      def after_this_expr(aThisExpr, aVisitor)
+        # 'this' behaves closely to a local variable
+        resolve_local(aThisExpr, 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)

data/lib/loxxy/front_end/grammar.rb

@@ -136,7 +136,7 @@ module Loxxy
       rule('primary' => 'TRUE').as 'literal_expr'
       rule('primary' => 'FALSE').as 'literal_expr'
       rule('primary' => 'NIL').as 'literal_expr'
-      rule('primary' => 'THIS')
+      rule('primary' => 'THIS').as 'this_expr'
       rule('primary' => 'NUMBER').as 'literal_expr'
       rule('primary' => 'STRING').as 'literal_expr'
       rule('primary' => 'IDENTIFIER').as 'variable_expr'

data/lib/loxxy/version.rb

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

data/spec/interpreter_spec.rb

@@ -466,7 +466,7 @@ LOX_END
         snippet = <<-LOX_END
           class Duck {
             noise() {
-              quack();
+              this.quack();
             }
 
             quack() {
@@ -509,6 +509,21 @@ LOX_END
         expect { subject.evaluate(program) }.not_to raise_error
         expect(sample_cfg[:ostream].string).to eq('quack')
       end
+
+      it "should support the 'this' keyword" do
+        program = <<-LOX_END
+          class Egotist {
+            speak() {
+              print this;
+            }
+          }
+
+          var method = Egotist().speak;
+          method(); // Output: Egotist instance
+        LOX_END
+        expect { subject.evaluate(program) }.not_to raise_error
+        expect(sample_cfg[:ostream].string).to eq('Egotist instance')
+      end
     end # context
   end # describe
   # rubocop: enable Metrics/BlockLength

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loxxy
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Dimitri Geshef
@@ -108,6 +108,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_this_expr.rb
 - lib/loxxy/ast/lox_unary_expr.rb
 - lib/loxxy/ast/lox_var_stmt.rb
 - lib/loxxy/ast/lox_variable_expr.rb