minjs 0.3.0 → 0.4.0

data/lib/minjs/ctype.rb

@@ -1,34 +1,49 @@
 # coding: utf-8
 module Minjs
+  # Ctype
   module Ctype
-    # Annex B
+    # Tests character _code_ is OctalDigit or not.
+    #
+    # @param [Fixnum] code
+    # @return _true_ if code is OctalDigit, otherwise _false_
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 Annex B.
     def octal_digit?(code)
       code >= 0x30 and code <= 0x37
     end
 
-    # 7.8.3
+    # Tests character _code_ is DecimalDigit or not.
+    #
+    # @param [Fixnum] code
+    # @return _true_ if code is DecimalDigit, otherwise _false_
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 7.8.3
     def decimal_digit?(code)
       code >= 0x30 and code <= 0x39
     end
 
-    # 7.8.3
+    # Tests character _code_ is HexDigit or not.
+    #
+    # @param [Fixnum] code
+    # @return _true_ if code is HexlDigit, otherwise _false_.
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 7.8.3
     def hex_digit?(code)
       code >= 0x30 && code <= 0x39 or
       code >= 0x41 && code <= 0x46 or
       code >= 0x61 && code <= 0x66
     end
 
-    # 7.2
+    # Tests character _code_ is WhiteSpace or not.
     #
-    # WhiteSpace ::
-    # <TAB>
-    # <VT>
-    # <FF>
-    # <SP>
-    # <NBSP>
-    # <BOM>
+    # WhiteSpace is    <TAB>,
+    # <VT>,
+    # <FF>,
+    # <SP>,
+    # <NBSP>,
+    # <BOM> and
     # <USP> any character in the Unicode category Zs
     #
+    # @param [Fixnum] code
+    # @return _true_ if code is WhiteSpace, otherwise _false_.
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 7.2
     def white_space?(code)
       code == 0x20 || code == 0x9 || code == 0xb || code == 0xc || code == 0xa0 || code == 0xfeff ||
         code == 0x1680 || # OGHAM SPACE MARK
@@ -38,32 +53,35 @@ module Minjs
         code == 0x3000  # IDEOGRAPHIC SPACE
     end
 
-    # 7.3
-    #
-    # LineTerminator ::
-    # <LF>
-    # <CR>
-    # <LS>
+    # Tests character _code_ is LineTerminator or not.
+    # LineTerminator is
+    # <LF>,
+    # <CR>,
+    # <LS> and
     # <PS>
     #
+    # @param [Fixnum] code
+    # @return _true_ if code is LineTerminator, otherwise _false_.
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 7.3
     def line_terminator?(code)
       code == 0x0a || code == 0x0d || code == 0x2028 || code == 0x2029
     end
 
-    # 7.6
+    # Test character _code_ is IdentifierStart or not.
     #
-    # IdentifierStart ::
-    # UnicodeLetter
-    # $
-    # _
-    # \ UnicodeEscapeSequence
+    # IdentifierStart is any character in the Unicode categories
     #
-    # UnicodeLetter ::
-    # any character in the Unicode categories “Uppercase letter
-    # (Lu)”, “Lowercase letter (Ll)”, “Titlecase letter (Lt)”,
-    # “Modifier letter (Lm)”, “Other letter (Lo)”, or “Letter
-    # number (Nl)”.
+    # * “Uppercase letter (Lu)
+    # * “Lowercase letter (Ll)”
+    # * “Titlecase letter (Lt)”
+    # * “Modifier letter (Lm)”
+    # * “Other letter (Lo)”
+    # * “Letter number (Nl)
     #
+    # @param [Fixnum] c
+    # @return _true_ if code is IdentifierStart, otherwise _false_.
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 7.6
+
     def identifier_start?(c)
       return false if c.nil?
       # almost all characters are ascii
@@ -622,6 +640,28 @@ module Minjs
         return false
       end
     end
+    # Test character _code_ is IdentifierPart or not.
+    #
+    # IdentifierPart is any character in the Unicode categories
+    #
+    # * “Uppercase letter (Lu)”
+    # * “Lowercase letter (Ll)”
+    # * “Titlecase letter (Lt)”
+    # * “Modifier letter (Lm)”
+    # * “Other letter (Lo)”
+    # * “Letter number (Nl)
+    # * “Non-spacing mark (Mn)”
+    # * “Combining spacing mark (Mc)”
+    # * “Decimal number (Nd)”
+    # * “Connector punctuation (Pc)
+    # * <ZWNJ>
+    # * <ZWJ>
+    # * IdentifierStart
+    #
+    # @param [Fixnum] c
+    # @return _true_ if code is IdentifierStart, otherwise _false_.
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 7.6
+    #
     def identifier_part?(c)
       return false if c.nil?
       if c == 0x24 ||
@@ -1267,6 +1307,9 @@ module Minjs
       end
     end
 
+    # Tests _name_ is IdentifierName or not.
+    #
+    # See ECMA262 7.5 for more detail
     def idname?(name)
       return false if name.length == 0
       s = name.codepoints

data/lib/minjs/ecma262.rb

@@ -1,6 +1,11 @@
+module Minjs
+  #ECMA262
+  module ECMA262
+  end
+end
 require "minjs/ecma262/base"
 require "minjs/ecma262/env"
-require "minjs/ecma262/exp"
-require "minjs/ecma262/lit"
-require "minjs/ecma262/punc"
-require "minjs/ecma262/st"
+require "minjs/ecma262/expression"
+require "minjs/ecma262/literal"
+require "minjs/ecma262/punctuator"
+require "minjs/ecma262/statement"

data/lib/minjs/ecma262/base.rb

@@ -1,14 +1,24 @@
 module Minjs
   module ECMA262
+    #ECMA262 Elements
     class Base
+      # Returns a ECMAScript string containg the representation of element.
+      # @param options [Hash] options for Base#concat
+      # @return [String] ECMAScript string.
       def to_js(options = {})
         self.class.to_s + "??"
       end
 
+      # to string
       def to_s
         to_js({})
       end
 
+      # concatenate some of ECMA262 elements and convert it to ECMAScript
+      #
+      # @param args ECMA262 element
+      # @option options :debug [Boolean] if set, output is easy to read.
+      #
       def concat(options, *args)
         prev = nil
         j = []
@@ -24,12 +34,13 @@ module Minjs
             if prev.match(/[\w\$]\z/) and js.match(/\A[\w\$]/)
               sep = ' '
             end
-            #';;' means 'empty statement' that must not be deleted
+            # ';;' means 'empty statement' or separator of 'for statement'
+            # that must not be deleted
             if prev.match(/;;\Z/)
               prev.sub!(/;;\Z/, ";")
             elsif prev.match(/;\Z/) and js == "}"
               prev.sub!(/;\Z/, "")
-            elsif prev.match(/;\Z/) and js == ";" and !options[:for_args]
+            elsif prev.match(/;\Z/) and js == ";"
               prev.sub!(/;\Z/, "")
             elsif prev.match(/[\-]\Z/) and js.match(/^\-/)
               sep = ' '
@@ -40,10 +51,10 @@ module Minjs
           #for debug
           unless options[:no_debug]
             if (@logger and @logger.debug?) || options[:debug]
-              if js.match(/;\z/) and !options[:for_args]
+              if js.match(/;\z/)
                 nl = "\n"
               end
-              if js.match(/}\z/) and !options[:for_args]
+              if js.match(/}\z/)
                 nl = "\n"
               end
             end
@@ -55,19 +66,28 @@ module Minjs
         j.join("")
       end
 
+      # Replaces child (if own it) object
+      #
+      # @param from [Base] from
+      # @param to [Base] to
       def replace(from, to)
         puts "warning: #{self.class}: replace not implement"
       end
 
+      # duplicate object
+      #
+      # duplicate this object's children (if own) and itself.
       def deep_dup
         puts "warning: #{self.class}: deep_dup not implement"
       end
 
+      # compare object
       def ==(obj)
         puts "warning: #{self.class}: == not implement"
         raise "warning: #{self.class}: == not implement"
       end
 
+      # add / remove parenthesis if need
       def add_remove_paren(node = self)
         node.traverse(nil) {|st, parent|
           if st.respond_to? :remove_paren
@@ -77,8 +97,24 @@ module Minjs
         }
         node
       end
+
+      # Traverses this children and itself with given block.
+      #
+      # If this element has children, traverse children first,
+      # then yield block with parent and self.
+      #
+      # @param parent [Base] parent element.
+      # @yield [parent, self] parent and this element.
+      # @yieldparam [Base] self this element.
+      # @yieldparam [Base] parent parent element.
+      def traverse(parent, &block)
+
+      end
     end
 
+    # Class of ECMA262 Statement List
+    #
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 12.1
     class StatementList < Base
       attr_reader :statement_list
 
@@ -86,6 +122,7 @@ module Minjs
         @statement_list = statement_list #array
       end
 
+      # Groups statements and reduce number of them as few as posibble.
       def grouping
         remove_empty_statement
         new_sl = []
@@ -149,10 +186,14 @@ module Minjs
         @statement_list = new_sl
       end
 
+      # duplicate object
+      # @see Base#deep_dup
       def deep_dup
         self.class.new(@statement_list.collect{|s| s.deep_dup})
       end
 
+      # Replaces children object
+      # @see Base#replace
       def replace(from, to)
         idx = @statement_list.index(from)
         if idx
@@ -160,36 +201,46 @@ module Minjs
         end
       end
 
+      # Removes statement from statement list
+      # @param st statement
       def remove(st)
         @statement_list.delete(st)
       end
 
+      # Removes empty statement in this statement list
       def remove_empty_statement
         @statement_list.reject!{|x|
           x.class == StEmpty
         }
       end
 
+      # Traverses this children and itself with given block.
+      # @see Base#traverse
       def traverse(parent, &block)
         _self = self
         @statement_list.each do|st|
           st.traverse(self, &block)
         end
-        yield self, parent
+        yield parent, self
       end
 
+      # compare object
       def ==(obj)
         @statement_list == obj.statement_list
       end
 
+      # Returns a ECMAScript string containg the representation of element.
+      # @see Base#to_js
       def to_js(options = {})
         concat options, @statement_list
       end
 
+      # Returns number of the statements
       def length
         @statement_list.length
       end
 
+      # return true if this can convert to expression.
       def to_exp?
         @statement_list.each do |s|
           return false if s.to_exp? == false
@@ -197,6 +248,7 @@ module Minjs
         return true
       end
 
+      # Converts statement list to expression and returns it.
       def to_exp(options = {})
         return nil if to_exp? == false
         t = @statement_list[0].to_exp(options)
@@ -213,19 +265,31 @@ module Minjs
         @statement_list.each(&block)
       end
 
+      # Returns the statement at index
+      # @param i index
+      # @return [Statement] statement
       def [](i)
         @statement_list[i]
       end
 
-      def []=(i, s)
-        @statement_list[i] = s
+      # Sets the statement at index.
+      # @param i index
+      # @param st statement
+      def []=(i, st)
+        @statement_list[i] = st
       end
 
+      # Returns index of statement.
+      # @param st statement.
+      # @return [Fixnum] index of statement.
       def index(st)
         @statement_list.index(st)
       end
     end
 
+    # Class of ECMA262 Source Elements
+    #
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 14
     class SourceElements < StatementList
       #
       # source_elements: [statement, statement, ...]
@@ -234,19 +298,27 @@ module Minjs
         @statement_list = source_elements
       end
 
+      # alias of statement_list
       def source_elements
         @statement_list
       end
 
+      # alias of statement_list=
       def source_elements=(source_elements)
         @statement_list = source_elements
       end
 
+      alias :source_elements :statement_list
+
+      # compare object
       def ==(obj)
         statement_list == obj.statement_list
       end
     end
 
+    # Class of ECMA262 Program
+    #
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 14
     class Prog < Base
       attr_reader :source_elements
       attr_reader :context
@@ -256,25 +328,34 @@ module Minjs
         @context = context
       end
 
+      # duplicate object
+      # @see Base#deep_dup
       def deep_dup
         self.class.new(context, source_elements.deep_dup)
       end
 
+      # Replaces children object
+      # @see Base#replace
       def replace(from, to)
         if from == @source_elements
           @source_elements = to
         end
       end
 
+      # Traverses this children and itself with given block.
+      # @see Base#traverse
       def traverse(parent, &block)
         @source_elements.traverse(self, &block)
-        yield self, parent
+        yield parent, self
       end
 
+      # compare object
       def ==(obj)
         self.class == obj.class and self.source_elements == obj.source_elements
       end
 
+      # Returns a ECMAScript string containg the representation of element.
+      # @see Base#to_js
       def to_js(options = {})
         concat options, @source_elements
       end

data/lib/minjs/ecma262/env.rb

@@ -1,5 +1,8 @@
 module Minjs
   module ECMA262
+    # class of Environment Record
+    #
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 10.2.1
     class EnvRecord
       attr_reader :binding
       attr_reader :options
@@ -9,6 +12,9 @@ module Minjs
         @options = {}
       end
 
+      # CreateMutableBinding(N, D)
+      #
+      # @see http://www.ecma-international.org/ecma-262 ECMA262 10.2.1
       def create_mutable_binding(n, d, options = {})
         if n.kind_of? IdentifierName
           n = n.val
@@ -16,6 +22,9 @@ module Minjs
         @binding[n] = {:value => nil}
       end
 
+      # SetMutableBinding(N, V, S)
+      #
+      # @see http://www.ecma-international.org/ecma-262 ECMA262 10.2.1
       def set_mutable_binding(n, v, s, options = {})
         if n.kind_of? IdentifierName
           n = n.val
@@ -25,19 +34,21 @@ module Minjs
       end
     end
 
+    # class of Declarative Environment Record
+    #
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 10.2.1.1
     class DeclarativeEnvRecord < EnvRecord
     end
 
+    # class of Object Environment Record
+    #
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 10.2.1.2
     class ObjectEnvRecord < EnvRecord
     end
 
-    class ExObject
-      def initialize(options = {})
-        @attr = options[:attr] || {}
-        @prop = options[:prop] || {}
-      end
-    end
-
+    # class of Lexical Environment
+    #
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 10.2
     class LexEnv
       attr_reader :record
       attr_reader :outer
@@ -52,10 +63,16 @@ module Minjs
         end
       end
 
+      # NewDeclarativeEnvironment(E)
+      #
+      # @see http://www.ecma-international.org/ecma-262 ECMA262 10.2.2.2
       def new_declarative_env(outer = nil)
         e = LexEnv.new(outer: (outer || self), type: :declarative)
       end
 
+      # NewObjectEnvironment(O, E)
+      #
+      # @see http://www.ecma-international.org/ecma-262 ECMA262 10.2.2.3
       def new_object_env(object, outer = nil)#TODO
         raise 'TODO'
         e = LexEnv.new(outer: (outer || self), type: :object)
@@ -67,11 +84,15 @@ module Minjs
         end
       end
 
+      # debug
       def debug
         STDERR.puts @record.binding.keys.join(", ")
       end
     end
 
+    # Class of Execution Contexts
+    #
+    # @see http://www.ecma-international.org/ecma-262 ECMA262 10.3
     class Context
       attr_accessor :lex_env
       attr_accessor :var_env
@@ -81,17 +102,19 @@ module Minjs
         @var_env = LexEnv.new(options)
         @lex_env = LexEnv.new(options)
         #TODO
-        @this_binding = ExObject.new(
-          {
-            attr: {
-              writable: true,
-              enumerable: false,
-              configurable: true
-            }
-          }
-        )
+        @this_binding = nil
+#        ExObject.new(
+#          {
+#            attr: {
+#              writable: true,
+#              enumerable: false,
+#              configurable: true
+#            }
+#          }
+#        )
       end
 
+      # debug
       def debug
         @var_env.debug
       end