riml 0.1.6 → 0.1.7

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/luke-gru/riml.png)](https://travis-ci.org/luke-gru/riml)
+[![Build Status](https://secure.travis-ci.org/luke-gru/riml.png?branch=master)](https://travis-ci.org/luke-gru/riml)
 
 Riml, a relaxed version of Vimscript
 ====================================
@@ -10,7 +10,6 @@ programmers take for granted. Also, Riml takes some liberties and provides
 some syntactic sugar for lots of VimL constructs. To see how Riml constructs
 are compiled into VimL, just take a look in this README. The left side is Riml,
 and the right side is the equivalent VimL after compilation.
-
 Variables
 ---------
 
@@ -38,11 +37,11 @@ old local variables.
 
 ###Checking for existence
 
-    unless s:callcount?                    if !exists("s:callcount")
-      callcount = 0                         let s:callcount = 0
-    end                                    endif
-    callcount += 1                         let s:callcount += 1
-    puts "called #{callcount} times"       echo "called " . s:callcount . " times"
+    unless s:callcount?                   if !exists("s:callcount")
+      callcount = 0                        let s:callcount = 0
+    end                                   endif
+    callcount += 1                        let s:callcount += 1
+    echo "called #{callcount} times"      echo "called " . s:callcount . " times"
 
 Comparisons
 -----------
@@ -56,93 +55,59 @@ Comparisons
 Heredocs
 --------
 
-    msg = <<EOS                           let s:msg = "a vim heredoc!\n"
-    a vim heredoc!
+    msg = <<EOS                           let s:msg = "a vim heredoc! " . s:cryForJoy() . "!\n"
+    A vim heredoc! #{cryForJoy()}!
     EOS
 
 Classes
 -------
 
-###Riml example 1
-
-    class MyClass
-      def initialize(arg1, arg2, *args)
+###Basic Class
+
+    class MyClass                                      function! g:MyClassConstructor(data, otherData, ...)
+      def initialize(data, otherData, *options)          let myClassObj = {}
+        self.data = data                                 let myClassObj.data = a:data
+        self.otherData = otherData                       let myClassObj.otherData = a:otherData
+        self.options = options                           let myClassObj.options = a:000
+      end                                                let myClassObj.getData = function('g:MyClass_getData')
+                                                         let myClassObj.getOtherData = function('g:MyClass_getOtherData')
+      defm getData                                       return myClassObj
+        return self.data                               endfunction
       end
-
-      defm getData
-        return self.data
+                                                       function! g:MyClass_getdata() dict
+      defm getOtherData                                  return self.data
+        return self.otherData                          endfunction
       end
-
-      defm getOtherData
-        return self.otherData
+    end                                                function! g:MyClass_getOtherData() dict
+                                                         return self.otherData
+                                                       endfunction
+
+###Class with Inheritance
+
+    class Translation                                  function! g:TranslationConstructor(input)
+      def initialize(input)                              let translationObj = {}
+        self.input = input                               let translationObj.input = a:input
+      end                                                return translationObj
+    end                                                endfunction
+
+    class FrenchToEnglishTranslation < Translation     function! g:FrenchToEnglishTranslationConstructor(input)
+      defm translate                                     let frenchToEnglishTranslationObj = {}
+        if (self.input == "Bonjour!")                    let translationObj = g:TranslationConstructor(a:input)
+          echo "Hello!"                                  call extend(frenchToEnglishTranslationObj, translationObj)
+        else                                             let translationObj.translate = function('g:FrenchToEnglishTranslation_translate')
+          echo "Sorry, I don't know that word."          return frenchToEnglishTranslationObj
+        end                                            endfunction
       end
-    end
-
-###Viml example 1
-
+    end                                                function! g:FrenchToEnglishTranslation_translate() dict
+                                                         if (self.input ==# "Bonjour!")
+    translation = new                                      echo "Hello!"
+    \ FrenchToEnglishTranslation("Bonjour!")             else
+    translation.translate()                                echo "Sorry, I don't know that word."
+                                                         endif
+                                                       endfunction
 
-    function! g:MyClassConstructor(arg1, arg2, ...)
-      let myClassObj = {}
-      function! myClassObj.getData() dict
-        return self.data
-      endfunction
-      function! myClassObj.getOtherData() dict
-        return self.otherData
-      endfunction
-      return myClassObj
-    endfunction
-
-###Riml example 2
-
-    class Translation
-      def initialize(input)
-        self.input = input
-      end
-    end
-
-    class FrenchToEnglishTranslation < Translation
-      defm translate
-        if (self.input == "Bonjour!")
-          echo "Hello!"
-        else
-          echo "Sorry, I don't know that word."
-        end
-      end
-    end
-
-    translation = new FrenchToEnglishTranslation("Bonjour!")
-    translation.translate()
-
-###VimL example 2
-
-    function! g:TranslationConstructor(input)
-      let translationObj = {}
-      let translationObj.input = a:input
-      return translationObj
-    endfunction
-
-    function! g:FrenchToEnglishTranslationConstructor(input)
-      let frenchToEnglishTranslationObj = {}
-      let translationObj = g:TranslationConstructor(a:input)
-      call extend(frenchToEnglishTranslationObj, translationObj)
-      function! frenchToEnglishTranslationObj.translate() dict
-        if (self.input ==# "Bonjour!")
-          echo "Hello!"
-        else
-          echo "Sorry, I don't know that word."
-        endif
-      endfunction
-      return frenchToEnglishTranslationObj
-    endfunction
-
-    let s:translation = g:FrenchToEnglishTranslationConstructor("Bonjour!")
-    call s:translation.translate()
-
-Hacking
--------
+                                                       let s:translation = g:TranslationConstructor("Bonjour!")
+                                                       call s:translation.translate()
 
-Make sure to generate the parser before running tests or developing on Riml.
-Also, make sure to regenerate the parser after modifiying the grammar file.
 
-1. `bundle install`
-2. Go to the lib directory and enter `racc -o parser.rb grammar.y`
+Coming soon: for a full list of the language's rules complete with examples, check out the Wiki

data/lib/ast_rewriter.rb

@@ -79,8 +79,8 @@ module Riml
       def replace(node)
         binary_op = node.nodes[0].rhs
         old_set_var = node.nodes[0]
-        assign_true  = old_set_var.clone.tap {|assign_t| assign_t.rhs = TrueNode.new }
-        assign_false = old_set_var.clone.tap {|assign_f| assign_f.rhs = FalseNode.new }
+        assign_true  = old_set_var.dup.tap {|assign_t| assign_t.rhs = TrueNode.new}
+        assign_false = old_set_var.dup.tap {|assign_f| assign_f.rhs = FalseNode.new}
         node.nodes = [
           IfNode.new(binary_op, Nodes.new([
             assign_true, ElseNode.new(Nodes.new([
@@ -112,7 +112,7 @@ module Riml
         )
 
         SuperToObjectExtension.new(constructor, classes, node).rewrite_on_match
-        MethodToNestedFunction.new(node, classes, constructor, dict_name).rewrite_on_match
+        ExtendObjectWithMethods.new(node, classes).rewrite_on_match
         SelfToDictName.new(dict_name).rewrite_on_match(constructor)
 
         constructor.expressions.push(
@@ -121,26 +121,39 @@ module Riml
         reestablish_parents(constructor)
       end
 
-      class MethodToNestedFunction < AST_Rewriter
-        attr_reader :constructor, :dict_name
-        def initialize(class_node, classes, constructor, dict_name)
-          super(class_node, classes)
-          @dict_name, @constructor = dict_name, constructor
-        end
-
+      class ExtendObjectWithMethods < AST_Rewriter
         def match?(node)
           DefMethodNode === node
         end
 
         def replace(node)
           def_node = node.to_def_node
-          node.parent_node = ast.expressions
-          def_node.parent_node = ast.expressions
+          class_expressions = ast.expressions
+          class_expressions.insert_after(class_expressions.last, def_node)
+          def_node.parent = class_expressions
+          # to remove it
+          node.parent = class_expressions
           node.remove
-          def_node.name.insert(0, "#{dict_name}.")
-          def_node.parent_node = constructor.expressions
-          constructor.expressions << def_node
+          def_node.original_name = def_node.name.dup
+          def_node.name.insert(0, "#{ast.name}_")
           reestablish_parents(def_node)
+          extend_obj_with_methods(def_node)
+        end
+
+        def extend_obj_with_methods(def_node)
+          constructor = ast.constructor
+          extension =
+            AssignNode.new('=',
+              DictGetDotNode.new(
+                GetVariableNode.new(nil, ast.constructor_obj_name),
+                [def_node.original_name]
+              ),
+              CallNode.new(
+                nil, 'function', [StringNode.new("#{def_node.scope_modifier}#{def_node.name}", :s)]
+              )
+          )
+          constructor.expressions << extension
+          extension.parent = constructor.expressions
         end
       end
 

data/lib/compiler.rb

@@ -159,7 +159,7 @@ module Riml
 
       private
       def string_surround(string_node)
-        case string_node.type
+        case string_node.type.to_sym
         when :d
           '"' << string_node.value << '"'
         when :s
@@ -283,16 +283,45 @@ module Riml
       def compile(node)
         set_modifier(node)
         node.compiled_output = node.scope_modifier
-        node.variable.parts.each do |part|
-          node.compiled_output <<
-          if part.interpolated?
+        node.compiled_output << compile_parts(node.variable.parts)
+      end
+
+      def compile_parts(parts)
+        compiled = ""
+        parts.each do |part|
+          output = if CurlyBraceVariable === part
+            compile_parts(part)
+          elsif part.nested?
+            compile_nested_parts(part.value, part)
+            part.compiled_output
+          elsif part.interpolated?
             part.value.accept(visitor_for_node(part.value))
             "{#{part.value.compiled_output}}"
           else
             "#{part.value}"
           end
+          compiled << output
         end
-        node.compiled_output
+        compiled
+      end
+
+      def compile_nested_parts(parts, root_part)
+        nested = 0
+        parts.each do |part|
+          if !part.respond_to?(:value)
+            part.accept(visitor_for_node(part, :propagate_up_tree => false))
+            root_part.compiled_output << "{#{part.compiled_output}"
+            nested += 1
+            next
+          end
+          if part.value.is_a?(Array)
+            compile_nested_parts(part.value, root_part)
+            next
+          end
+          part.value.accept(visitor_for_node(part.value, :propagate_up_tree => false))
+          root_part.compiled_output << "{#{part.value.compiled_output}}"
+        end
+        root_part.compiled_output << ('}' * nested)
       end
     end
 

data/lib/grammar.y

@@ -76,7 +76,7 @@ rule
   | Assign                                { result = val[0] }
   | DictGet                               { result = val[0] }
   | ListOrDictGet                         { result = val[0] }
-  | VariableRetrieval                     { result = val[0] }
+  | AllVariableRetrieval                  { result = val[0] }
   | Literal                               { result = val[0] }
   | Call                                  { result = val[0] }
   | Ternary                               { result = val[0] }
@@ -164,7 +164,7 @@ rule
 
   DictGet:
     Dictionary DictGetWithDotLiteral             { result = DictGetDotNode.new(val[0], val[1]) }
-  | VariableRetrieval DictGetWithDot             { result = DictGetDotNode.new(val[0], val[1]) }
+  | AllVariableRetrieval DictGetWithDot          { result = DictGetDotNode.new(val[0], val[1]) }
   | ListOrDictGet DictGetWithDot                 { result = DictGetDotNode.new(val[0], val[1]) }
   ;
 
@@ -295,7 +295,7 @@ rule
   ;
 
   AssignLHS:
-    VariableRetrieval                          { result = val[0] }
+    AllVariableRetrieval                       { result = val[0] }
   | DictGet                                    { result = val[0] }
   | List                                       { result = val[0] }
   | ListUnpack                                 { result = val[0] }
@@ -306,6 +306,10 @@ rule
   VariableRetrieval:
     Scope IDENTIFIER                           { result = GetVariableNode.new(val[0], val[1]) }
   | SPECIAL_VAR_PREFIX IDENTIFIER              { result = GetSpecialVariableNode.new(val[0], val[1]) }
+  ;
+
+  AllVariableRetrieval:
+    VariableRetrieval                          { result = val[0] }
   | Scope CurlyBraceName                       { result = GetCurlyBraceNameNode.new(val[0], val[1]) }
   ;
 
@@ -316,18 +320,25 @@ rule
   ;
 
   CurlyBraceName:
-    IDENTIFIER '{' VariableRetrieval '}'       { result = CurlyBraceVariable.new([ CurlyBracePart.new(val[0]), CurlyBracePart.new(val[2]) ]) }
-  | '{' VariableRetrieval '}' IDENTIFIER       { result = CurlyBraceVariable.new([ CurlyBracePart.new(val[1]), CurlyBracePart.new(val[3]) ]) }
+    CurlyBraceVarPart                          { result = CurlyBraceVariable.new([ val[0] ]) }
+  | IDENTIFIER CurlyBraceName                  { result = CurlyBraceVariable.new([ CurlyBracePart.new(val[0]), val[1] ]) }
   | CurlyBraceName IDENTIFIER                  { result = val[0] << CurlyBracePart.new(val[1]) }
+  | CurlyBraceName CurlyBraceVarPart           { result = val[0] << val[1] }
+  ;
+
+  CurlyBraceVarPart:
+    '{' VariableRetrieval '}'                     { result = CurlyBracePart.new(val[1]) }
+  | '{' VariableRetrieval CurlyBraceVarPart '}'   { result = CurlyBracePart.new([val[1], val[2]]) }
+  | '{' CurlyBraceVarPart VariableRetrieval '}'   { result = CurlyBracePart.new([val[1], val[2]]) }
   ;
 
   # Method definition
   # [scope_modifier, name, parameters, keyword, expressions]
   Def:
-    FunctionType Scope DefCallIdentifier Keyword Block END                               { result = Object.const_get(val[0]).new('!', val[1], val[2], [], val[3], val[4]) }
-  | FunctionType Scope DefCallIdentifier '(' ParamList ')' Keyword Block END             { result = Object.const_get(val[0]).new('!', val[1], val[2], val[4], val[6], val[7]) }
-  | FunctionType Scope DefCallIdentifier '(' SPLAT     ')' Keyword Block END             { result = Object.const_get(val[0]).new('!', val[1], val[2], [val[4]], val[6], val[7]) }
-  | FunctionType Scope DefCallIdentifier '(' ParamList ',' SPLAT ')' Keyword Block END   { result = Object.const_get(val[0]).new('!', val[1], val[2], val[4] << val[6], val[8], val[9]) }
+    FunctionType Scope DefCallIdentifier DefKeyword Block END                               { result = Object.const_get(val[0]).new('!', val[1], val[2], [], val[3], val[4]) }
+  | FunctionType Scope DefCallIdentifier '(' ParamList ')' DefKeyword Block END             { result = Object.const_get(val[0]).new('!', val[1], val[2], val[4], val[6], val[7]) }
+  | FunctionType Scope DefCallIdentifier '(' SPLAT     ')' DefKeyword Block END             { result = Object.const_get(val[0]).new('!', val[1], val[2], [val[4]], val[6], val[7]) }
+  | FunctionType Scope DefCallIdentifier '(' ParamList ',' SPLAT ')' DefKeyword Block END   { result = Object.const_get(val[0]).new('!', val[1], val[2], val[4] << val[6], val[8], val[9]) }
   ;
 
   FunctionType:
@@ -343,7 +354,7 @@ rule
   ;
 
   # Example: 'range', 'dict' or 'abort' after function definition
-  Keyword:
+  DefKeyword:
     IDENTIFIER            { result = val[0] }
   | /* nothing */         { result = nil }
   ;

data/lib/lexer.rb

@@ -71,19 +71,19 @@ module Riml
         @i += splat_var.size
         @token_buf << [:SCOPE_MODIFIER, 'a:'] << [:IDENTIFIER, splat_var[2..-1]]
       # the 'n' scope modifier is added by riml
-      elsif scope_modifier = chunk[/\A([bwtglsavn]:)[\w]/]
+      elsif scope_modifier = chunk[/\A([bwtglsavn]:)\w/, 1]
         @i += 2
-        @token_buf << [:SCOPE_MODIFIER, $1]
+        @token_buf << [:SCOPE_MODIFIER, scope_modifier]
       elsif scope_modifier_literal = chunk[/\A([bwtglsavn]:)/]
-        @i += 2
-        @token_buf << [:SCOPE_MODIFIER_LITERAL, $1]
+        @i += scope_modifier_literal.size
+        @token_buf << [:SCOPE_MODIFIER_LITERAL, scope_modifier_literal]
       elsif special_var_prefix = chunk[/\A(&(\w:)?(?!&)|\$|@)/]
         @token_buf << [:SPECIAL_VAR_PREFIX, special_var_prefix.strip]
         @expecting_identifier = true
         @i += special_var_prefix.size
-      elsif function_method = chunk[/\A(function)\(/]
-        @token_buf << [:IDENTIFIER, $1]
-        @i += $1.size
+      elsif function_method = chunk[/\A(function)\(/, 1]
+        @token_buf << [:IDENTIFIER, function_method]
+        @i += function_method.size
       elsif identifier = chunk[/\A[a-zA-Z_][\w#]*(\?|!)?/]
         # keyword identifiers
         if KEYWORDS.include?(identifier)
@@ -130,15 +130,15 @@ module Riml
         @i += splat.size
       # integer (octal)
       elsif octal = chunk[/\A0[0-7]+/]
-        @token_buf << [:NUMBER, octal.to_s]
+        @token_buf << [:NUMBER, octal]
         @i += octal.size
       # integer (hex)
       elsif hex = chunk[/\A0[xX]\h+/]
-        @token_buf << [:NUMBER, hex.to_s]
+        @token_buf << [:NUMBER, hex]
         @i += hex.size
       # integer or float (decimal)
       elsif decimal = chunk[/\A[0-9]+(\.[0-9]+)?/]
-        @token_buf << [:NUMBER, decimal.to_s]
+        @token_buf << [:NUMBER, decimal]
         @i += decimal.size
       elsif interpolation = chunk[INTERPOLATION_REGEX]
         # "hey there, #{name}" = "hey there, " . name
@@ -221,7 +221,7 @@ module Riml
       when :if, :unless
         if one_line_conditional?(chunk)
           @one_line_conditional_end_pending = true
-        elsif !statement_modifier?(chunk)
+        elsif !statement_modifier?
           @current_indent += 2
           @indent_pending = true
         end
@@ -274,7 +274,7 @@ module Riml
       Lexer.new(code).tokenize
     end
 
-    def statement_modifier?(chunk)
+    def statement_modifier?
       old_i = @i
       # backtrack until the beginning of the line
       @i -= 1 while @code[@i-1] =~ /[^\n\r]/ && !@code[@i-1].empty?

data/lib/nodes.rb

@@ -391,27 +391,49 @@ class GetSpecialVariableNode < Struct.new(:prefix, :name)
   include FullyNameable
 end
 
-class CurlyBracePart < Struct.new(:value)
-  def interpolated?
-    GetVariableNode === value || GetSpecialVariableNode === value
-  end
+class GetCurlyBraceNameNode < Struct.new(:scope_modifier, :variable)
+  include Visitable
+  include Walkable
 
-  def regular?
-    not interpolated?
+  def children
+    [variable]
   end
 end
+
 class CurlyBraceVariable < Struct.new(:parts)
+  include Visitable
+  include Walkable
+
   def <<(part)
     parts << part
     self
   end
+
+  def children
+    parts
+  end
 end
-class GetCurlyBraceNameNode < Struct.new(:scope_modifier, :variable)
+
+class CurlyBracePart < Struct.new(:value)
   include Visitable
   include Walkable
 
+  def interpolated?
+    GetVariableNode === value || GetSpecialVariableNode === value || nested?
+  end
+
+  def nested?
+    value.is_a?(Array) && value.detect {|part| part.is_a?(CurlyBracePart)}
+  end
+
+  def regular?
+    not interpolated?
+  end
+
   def children
-    [variable]
+    return [] if regular?
+    return value if nested?
+    [value]
   end
 end
 
@@ -436,6 +458,8 @@ class DefNode < Struct.new(:bang, :scope_modifier, :name, :parameters, :keyword,
   include FullyNameable
   include Walkable
 
+  attr_accessor :original_name
+
   def initialize(*args)
     super
     # max number of arguments in viml
@@ -529,7 +553,7 @@ end
 
 class DefMethodNode < DefNode
   def to_def_node
-    def_node = DefNode.new(bang, scope_modifier, name, parameters, keyword, expressions)
+    def_node = DefNode.new(bang, 'g:', name, parameters, 'dict', expressions)
     def_node.parent = parent
     def_node
   end
@@ -652,22 +676,6 @@ class ForNode < Struct.new(:variable, :in_expression, :expressions)
   end
 end
 
-# lines: [5, 6, 8, 9]
-# This means the continuation has 4 lines (line.size is 4) and each line
-# preserves the amt of whitespace specified as the value in the array.
-# Ex: 1st line preserves 5 spaces, 2nd line preserves 6 spaces, etc...
-class LineContinuation < Struct.new(:lines)
-  include Visitable
-
-  def size
-    lines.size
-  end
-
-  def [](idx)
-    lines[idx]
-  end
-end
-
 class DictGetNode < Struct.new(:dict, :keys)
   include Visitable
   include Walkable