loxxy 0.0.16 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d7d30d3246aa8a8f06f3456d3996c680e9ddb4ed31bcf9fff99685702e50dd1
-  data.tar.gz: dc428ddd0fc03e153e70873bc2827b6e4aac813e5fdfba40ef2f28bfa7283fc2
+  metadata.gz: fd4cbf32f4ee44a60c45630a76318425850dc35b4d9f6129274cefcbf4e91fcc
+  data.tar.gz: 711e0ae07d2a0b3a080c2fe408d9adf4f7b96bb070af686d66dd3f9dbae8391d
 SHA512:
-  metadata.gz: d90f2494a324be036dae2f3d38636c571009b60f19d2b3d917b242ab98d231e03bb121f577e5598ac63514cc5817814972cabe927f05af2842a5a97c89eb69d9
-  data.tar.gz: e09a70a27baa1408904e1bfe512f4f523b8e4efd1aab00412b993c8f4a35b5498f1f6ddb5e67697108c80a91778301e41c15741451e73e1d869496d96441757a
+  metadata.gz: 131f6fe3b23dc0a84b063efe70744b02ecc9edb68742540799964311298f35494a0d48db75bb18a240ddeed039286ab08ba2ef99e2ae4857d2b4d5dc4403d5ba
+  data.tar.gz: b46c18f54147fd01f9819e3ad06564ee78fe72de5c91d6ef8a5bef5945d9f1ad622cad848c4d521ae66f00c91b7825d01e57c831b2a097da830bec0d99f2cf06

data/.rubocop.yml

@@ -250,7 +250,7 @@ Style/IfUnlessModifier:
   Enabled: false
 
 Style/InverseMethods:
-  Enabled: true
+  Enabled: false
 
 Style/MissingRespondToMissing:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,62 @@
+## [0.0.21] - 2021-01-1x
+- The interpreter supports the declaration global variables.
+
+## Added
+- Class `BackEnd::Entry`, mixin module for objects put in the symbol table
+- Class `BackEnd::Environment` that keeps track of variables in a given context.
+- Class `BackEnd::SymbolTable` that keeps track of environments.
+- Class `BackEnd::Variable` internal representation of a `Lox` variable
+- Method `Ast::ASTBuilder#reduce_var_declaration` and `Ast::ASTBuilder#reduce_var_declaration`
+- Method `Ast::ASTVisitor#visit_var_stmt` for visiting `LoxVarStmt` nodes
+- Attribute `Engine::symbol_table`for keeping track of variables
+- Method `Engine::after_var_stmt` for the implementation of variable declarations
+
+## [0.0.20] - 2021-01-15
+- The interpreter supports the `if` ... `else` statement.
+
+## Added
+- Class `Ast::LoxItStmt`, AST node specific for `if` `else` statements
+- Method `Ast::ASTBuilder#reduce_if_stmt` as semantic action for if ... else
+- Method `Ast::ASTVisitor#visit_if_stmt` for visiting `LoxIfStmt` nodes
+- Method `Engine::after_if_stmt` implementation of the control flow
+
+## [0.0.19] - 2021-01-14
+- The interpreter supports expressions between parentheses (grouping).
+
+## Added
+- Class `Ast::LoxLogicalExpr`
+- Method `Ast::ASTBuilder#reduce_grouping_expr` as semantic action for grouping expression
+- Method `Ast::ASTVisitor#visit_grouping_expr` for visiting grouping expressions
+- Method `Engine::after_grouping_expr`for the evaluation of grouping expressions
+
+## Changed
+- File `grammar.rb` rules for if ... else were given names in order to activate semantic actions.
+- File `README.md` updated with little `if ... else` documentation.
+
+## [0.0.18] - 2021-01-13
+- The interpreter can evaluate `and`, `or`expressions.
+
+## Added
+- Class `Ast::LoxLogicalExpr`
+- Method `Ast::ASTBuilder#reduce_logical_expr` for the semantic action require for `and`, `or`
+- Method `Ast::ASTVisitor#visit_logical_expr` for visiting logical expressions
+- Method `Backend::Engine#after_logical_expr` implements the evaluation of the logical expressions
+
+## [0.0.17] - 2021-01-12
+- The interpreter can evaluate all arithmetic and comparison operations.
+- It implements `==`, `!=` and the unary operations `!`, `-`
+
+## Added
+- Class `Ast::LoxUnaryExpr`
+- Method `Ast::ASTBuilder#reduce_unary_expr` to support the evaluation of `!` and ``-@`
+- Method `Ast::ASTVisitor#visit_unnary_expr` for visiting unary expressions
+- Method `Backend::Engine#after_unary_expr` evaluating an unary expression
+- In class `Datatype::BuiltinDatatype` the methods `falsey?`, `truthy?`, `!`, `!=`
+- In class `Datatype::Number`the methods `<`, `<=`, ´>´, `>=` and `-@`
+
+## Changed
+- File `README.md` updated.
+
 ## [0.0.16] - 2021-01-11
 - The interpreter can evaluate product and division of two numbers.
 - It also implements equality `==` and inequality `!=` operators
@@ -36,7 +95,7 @@
 - The interpreter can evaluate addition of numbers and string concatenation
 
 ## Added
-- Method `Ast::ASTVisitor::visit_binary_expr` for visiting binary expressions
+- Method `Ast::ASTVisitor#visit_binary_expr` for visiting binary expressions
 - Method `Ast::LoxBinaryExpr#accept` for visitor pattern
 - Method `BackEnd::Engine#after_binary_expr` to trigger execution of binary operator
 - `Boolean` class hierarchy: added methos `true?` and `false?` to ease spec test writing

data/README.md

@@ -8,7 +8,7 @@ a simple language used in Bob Nystrom's online book [Crafting Interpreters](http
 
 ### Purpose of this project:
 - To deliver an open source example of a programming language fully implemented in Ruby  
-  (from the scanner, parser, an interpreter).
+  (from the scanner and parser to an interpreter).
 - The implementation should be mature enough to run [LoxLox](https://github.com/benhoyt/loxlox),  
   a Lox interpreter written in Lox.
 
@@ -128,16 +128,22 @@ program
 ```
 
 ## Suppported Lox language features
-Although the interpreter should parse almost any valid Lox program,
-it currently can evaluate a tiny set of AST node (AST = Abstract Syntax Tree).
+On one hand, the parser covers the complete Lox grammar and should therefore, in principle,
+parse any valid Lox program.
+
+On the other hand, the interpreter is under development and currently it can evaluate only a tiny subset of __Lox__.
+But the situation is changing almost daily, stay tuned...
 
 Here are the language features currently supported by the interpreter:
 
 - [Comments](#comments)
 - [Keywords](#keywords)
-- [Operators and Special Chars](#operators-and-special-chars)
 - [Datatypes](#datatypes)
-- [Statements](#statements)
+- [Statements](#statements)  
+  -[Expressions](#expressions)  
+- [Variable declarations](#var-statement)  
+- [If Statement](#if-statement)   
+- [Print Statement](#print-statement)
 
 ### Comments
 
@@ -148,41 +154,10 @@ Loxxy supports single line C-style comments.
 ```
 
 ### Keywords
-
-The parser knows all the __Lox__ reserved keywords:
+Loxxy implements the following __Lox__ reserved keywords:
 ```lang-none
-and, class, else, false, fun, for, if, nil, or,
-print, return, super, this, true, var, while
+and, false, nil, or, print, true
 ```
-Of these, the interpreter implements: `false`, `nil`, `true`
-
-### Operators and Special Chars
-#### Operators
-The parser recognizes all the __Lox__ operators, delimiters and separators:
-- Arithmetic operators: `+`, `-`, `*`, `/`
-- Comparison operators: `>`, `>=`, `<`, `<=`
-- Equality operators: `==`, `!=`
-
-Of these, the interpreter implements: 
-`+` (addition of two numbers or string concatenation)
-`-` (difference between two numbers)
-`*` (product of two numbers)
-`/` (division of two number)
-`==` and `!=` (in)equality testing of two Lox values
-
-#### Delimiters
-The parser knows all the __Lox__ grouping delimiters:  
-(`, ), `{`, `}`
-
-These aren't yet implemented in the interpreter.
-
-The other characters that have a special meaning in __Lox__ are:
-- `,` Used in parameter list
-- `.` For the dot notation (i.e. calling a method)
-- `;` The semicolon is used to terminates expressions
-- `=` Assignment
-
-The parser recognizes them all but the interpreter accepts the semicolons only.
 
 ### Datatypes
 
@@ -192,22 +167,150 @@ loxxy supports  all the standard __Lox__ datatypes:
 - `String`: Sequence of characters surrounded by `"`. For example: `"Hello!"`
 - `Nil`: Used to define a null value, denoted by the `nil` keyword
 
-## Statements
-### Implemented expressions
-Loxxy implements expressions:
-- Plain literals only; or,
-- Addition, subtraction, product and division of two numbers; or,
-- Concatenation of two strings,
-- (In)equality test of two Lox values
+### Statements
+
+Loxxy supports the following statements:  
+- [Expressions](#expressions)  
+  -[Arithmetic expressions](#arithmetic-expressions)  
+  -[String concatenation](#string-concatenation)  
+  -[Comparison expressions](#comparison-expressions)  
+  -[Logical expressions](#logical-expressions)  
+  -[Grouping expressions](#grouping-expressions)  
+  
+-[Variable declarations](#var-statement)  
+-[If Statement](#if-statement)  
+-[Print Statement](#print-statement)
+
+#### Expressions
+
+##### Arithmetic expressions
+Loxxy supports the following operators for arithmetic expressions:
+
+- `+`: Adds of two numbers. Both operands must be of the type Number  
+  E.g. `37 + 5; // => 42`  
+  `7 + -3; // => 4`
+- `-`: (Binary) Subtracts right operand from left operand. Both operands must be numbers.  
+  E.g. `47 - 5; // => 42`
+- `-`: (Unary) Negates (= changes the sign) of the given number operand.  
+  E.g. `- -3; // => 3`
+- `*`: Multiplies two numbers  
+  E.g. `2 * 3; // => 6`
+- `/`: Divides two numbers  
+  E.g. `8 / 2; // => 4`
+  `5 / 2; // => 2.5`
+
+##### String concatenation
+- `+`: Concatenates two strings. Both operands must be of the String type.  
+  E.g. `"Hello" + ", " + "world! // => "Hello, world!"`
+
+##### Comparison expressions
+
+- `==`: Returns `true` if left operand is equal to right operand, otherwise `false`  
+  E.g. `false == false; // => true`  
+  `5 + 2 == 3 + 4; // => true`  
+  `"" == ""; // => true`
+- `!=`: Returns `true` if left operand is not equal to right operand, otherwise `false`  
+  E.g. `false != "false"; // => true`  
+  `5 + 2 != 4 + 3; // => false`
+- `<`: Returns `true` if left operand is less than right operand, otherwise `false`. Both operands must be numbers  
+  E.g. `1 < 3; // => true`  
+  `1 < 0; // => false`  
+  `2 < 2; // => false`
+- `<=`: Returns `true` if left operand is equal to right operand, otherwise `false`. Both operands must be numbers  
+  E.g. `1 <= 3; // => true`  
+  `1 <= 0; // => false`  
+  `2 <= 2; // => true`
+- `>`: Returns `true` if left operand is equal to right operand, otherwise `false`. Both operands must be numbers  
+  E.g. `1 > 3; // => false`  
+  `1 > 0; // => true`  
+  `2 > 2; // => false`
+- `>=`: Returns `true` if left operand is equal to right operand, otherwise `false`. Both operands must be numbers  
+  E.g. `1 > 3; // => false`  
+  `1 > 0; // => true`  
+  `2 > 2; // => false`
+
+##### Logical expressions
+
+REMINDER: In __Lox__, `false` and `nil` are considered falsey, everything else is truthy.
+
+- `and`: When both operands are booleans, then returns `true` if both left and right operands are truthy, otherwise `false`.   
+  If at least one operand isn't a boolean then returns first falsey operand else (both operands are truthy) returns the second operand.
+  truthy returns the second operand.  
+  E.g. `false and true; // => false`  
+  `true and nil; // => nil`  
+  `0 and true and ""; // => ""`
+- `or`: When both operands are booleans, then returns `true` if left or right operands are truthy, otherwise `false`.  
+  If at least one operand isn't a boolean then returns first truthy operand else (both operands are truthy) returns the second operand.
+  E.g. `false or true; // => true`  
+  `true or nil; // => nil`  
+  `false or nil; // => nil`  
+  `0 or true or ""; // => 0`
+- `!`: Performs a logical negation on its operand  
+  E.g. `!false; // => true`  
+  `!!true; // => true`  
+  `!0; // => false`
+
+####  Grouping expressions
+Use parentheses `(` `)` for a better control in expression/operator precedence.
+
+``` javascript
+print 3 + 4 * 5;  // => 23
+print (3 + 4) * 5; // => 35
+```
+
+#### Variable declarations
+``` javascript
+var iAmAVariable = "my-initial-value";
+var iAmNil; // __Lox__ initializes variables to nil by default;
+```
 
-### Implemented statements
-Loxxy implements the following statements:
-- Expressions (see above sub-section)
-- Print statement
+Warning: current version cannot retrieve the value of a variable.
+Expect this capability to be implemented in the coming days.
+
+
+#### If statement
+
+Based on a given condition, an if statement executes one of two statements:
+``` javascript
+if (condition) {
+print "then-branch";
+} else {
+print "else-branch";
+}
+```
+
+As for other languages, the `else` part is optional.
+##### Warning: nested `if`...`else`
+Call it a bug ... Nested `if` `else` control flow structure aren't yet supported by __Loxxy__.  
+The culprit has a name: [the dangling else](https://en.wikipedia.org/wiki/Dangling_else). 
+
+The problem in a nutshell: in a nested if ... else ... statement like this:
+``` javascript
+'if (true) if (false) print "bad"; else print "good";
+```
+... there is an ambiguity. Indeed, according to the __Lox__ grammar, the `else` could be bound 
+either to the first `if` or to the second one.
+This ambiguity is usually lifted by applying an ad-hoc rule: an `else` is aways bound to the most 
+recent (rightmost) `if`.  
+Being a generic parsing library, `Rley` doesn't apply any of these supplemental rules.
+As a consequence,it complains about the found ambiguity and stops the parsing...
+Although `Rley` can cope with ambiguities, this requires the use of an advanced data structure
+called `Shared Packed Parse Forest (SPPF)`.
+SPPF are much more complex to handle than the `common` parse trees present in most compiler or interpreter books.
+Therefore, a future version of `Rley` will incorporate the capability to define disambuiguation rules.  
+
+In the meantime, the `Loxxy` will progress on other __Lox__ features like:
+- Variables,
+- Block structures...
+
+
+####  Print Statement
+
+The statement print + expression + ; prints the result of the expression to stdout.
+
+``` javascript
+print "Hello, world!";  // Output: Hello, world!
 
-```javascript
-// Print statement with nested concatenation
-print "Hello" + ", " + "world!";
 ```
 
 ## Installation

data/lib/loxxy/ast/all_lox_nodes.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'lox_print_stmt'
 require_relative 'lox_literal_expr'
 require_relative 'lox_noop_expr'
+require_relative 'lox_grouping_expr'
+require_relative 'lox_unary_expr'
+require_relative 'lox_binary_expr'
+require_relative 'lox_logical_expr'
+require_relative 'lox_print_stmt'
+require_relative 'lox_if_stmt'
+require_relative 'lox_var_stmt'

data/lib/loxxy/ast/ast_builder.rb

@@ -15,7 +15,6 @@ module Loxxy
         # @return [Hash{String => String}]
         Name2special = {
           'AND' => 'and',
-          'BANG' => '!',
           'BANG_EQUAL' => '!=',
           'COMMA' =>  ',',
           'DOT' => '.',
@@ -36,6 +35,11 @@ module Loxxy
           'SLASH' =>  '/',
           'STAR' => '*'
         }.freeze
+
+        Name2unary = {
+          'BANG' => '!',
+          'MINUS' => '-@'
+        }.freeze
       end # defined
 
       attr_reader :strict
@@ -92,6 +96,17 @@ module Loxxy
         node
       end
 
+      def reduce_logical_expr(_production, _range, tokens, theChildren)
+        operand1 = theChildren[0]
+
+        # Second child is array with couples [operator, operand2]
+        theChildren[1].each do |(operator, operand2)|
+          operand1 = LoxLogicalExpr.new(tokens[0].position, operator, operand1, operand2)
+        end
+
+        operand1
+      end
+
       # rule('lhs' => 'nonterm_i nonterm_k_plus')
       def reduce_binary_operator(_production, _range, tokens, theChildren)
         operand1 = theChildren[0]
@@ -119,6 +134,11 @@ module Loxxy
         [[operator, operand2]]
       end
 
+      # Return the AST node corresponding to the second symbol in the rhs
+      def reduce_keep_symbol2(_production, _range, _tokens, theChildren)
+        theChildren[1]
+      end
+
       #####################################
       #  SEMANTIC ACTIONS
       #####################################
@@ -138,6 +158,27 @@ module Loxxy
       return_first_child(range, tokens, theChildren) # Discard the semicolon
       end
 
+      # rule('varDecl' => 'VAR IDENTIFIER SEMICOLON')
+      def reduce_var_declaration(_production, _range, tokens, theChildren)
+        var_name = theChildren[1].token.lexeme.dup
+        Ast::LoxVarStmt.new(tokens[1].position, var_name, nil)
+      end
+
+      # rule('varDecl' => 'VAR IDENTIFIER EQUAL expression SEMICOLON')
+      def reduce_var_initialization(_production, _range, tokens, theChildren)
+        var_name = theChildren[1].token.lexeme.dup
+        Ast::LoxVarStmt.new(tokens[1].position, var_name, theChildren[3])
+      end
+
+
+      # rule('ifStmt' => 'IF ifCondition statement elsePart_opt')
+      def reduce_if_stmt(_production, _range, tokens, theChildren)
+        condition = theChildren[1]
+        then_stmt = theChildren[2]
+        else_stmt = theChildren[3]
+        LoxIfStmt.new(tokens[0].position, condition, then_stmt, else_stmt)
+      end
+
       # rule('printStmt' => 'PRINT expression SEMICOLON')
       def reduce_print_stmt(_production, _range, tokens, theChildren)
         Ast::LoxPrintStmt.new(tokens[1].position, theChildren[1])
@@ -145,7 +186,7 @@ module Loxxy
 
       # rule('logic_or' => 'logic_and disjunct_plus')
       def reduce_logic_or_plus(production, range, tokens, theChildren)
-        reduce_binary_operator(production, range, tokens, theChildren)
+        reduce_logical_expr(production, range, tokens, theChildren)
       end
 
       # rule('disjunct_plus' => 'disjunct_plus OR logic_and')
@@ -160,7 +201,7 @@ module Loxxy
 
       # rule('logic_and' => 'equality conjunct_plus')
       def reduce_logic_and_plus(production, range, tokens, theChildren)
-        reduce_binary_operator(production, range, tokens, theChildren)
+        reduce_logical_expr(production, range, tokens, theChildren)
       end
 
       # rule('conjunct_plus' => 'conjunct_plus AND equality')
@@ -231,6 +272,19 @@ module Loxxy
         reduce_binary_plus_end(production, range, tokens, theChildren)
       end
 
+      # rule('unary' => 'unaryOp unary')
+      def reduce_unary_expr(_production, _range, tokens, theChildren)
+        operator = Name2unary[theChildren[0].symbol.name].to_sym
+        operand = theChildren[1]
+        LoxUnaryExpr.new(tokens[0].position, operator, operand)
+      end
+
+      # rule('primary' => 'LEFT_PAREN expression RIGHT_PAREN')
+      def reduce_grouping_expr(_production, _range, tokens, theChildren)
+        subexpr = theChildren[1]
+        LoxGroupingExpr.new(tokens[0].position, subexpr)
+      end
+
       # rule('primary' => 'FALSE' | TRUE').as 'literal_expr'
       def reduce_literal_expr(_production, _range, _tokens, theChildren)
         first_child = theChildren.first