made const handling more better to accept crazy magic fairy dust use of 'const' sprinkled about in argument lists

git-svn-id: http://cmock.svn.sourceforge.net/svnroot/cmock/trunk@115 bf332499-1b4d-0410-844d-d2d48d5cc64c

lib/cmock_function_prototype_parser.rb

@@ -1194,40 +1194,26 @@ module CMockFunctionPrototype
   end
 
   module TypeConstAndPtrSuffix0
+    def const
+      elements[0]
+    end
+
+    def lookahead_const
+      elements[2]
+    end
   end
 
   module TypeConstAndPtrSuffix1
-    def space
-      elements[0]
-    end
-
-  end
-
-  module TypeConstAndPtrSuffix2
-    def space
-      elements[0]
-    end
-
-  end
-
-  module TypeConstAndPtrSuffix3
-    def space
-      elements[0]
-    end
-
-  end
-
-  module TypeConstAndPtrSuffix4
-  end
-
-  module TypeConstAndPtrSuffix5
     def const
       elements[0]
     end
 
   end
 
-  module TypeConstAndPtrSuffix6
+  module TypeConstAndPtrSuffix2
+    def lookahead_const
+      elements[1]
+    end
   end
 
   def _nt_type_const_and_ptr_suffix
@@ -1240,143 +1226,33 @@ module CMockFunctionPrototype
 
     i0 = index
     i1, s1 = index, []
-    if input.index('const', index) == index
+    r2 = _nt_const
-      r2 = instantiate_node(SyntaxNode,input, index...(index + 5))
-      @index += 5
-    else
-      terminal_parse_failure('const')
-      r2 = nil
-    end
     s1 << r2
     if r2
-      i3 = index
+      s3, i3 = [], index
-      i4, s4 = index, []
-      s5, i5 = [], index
       loop do
-        if input.index(' ', index) == index
+        r4 = _nt_asterisk
-          r6 = instantiate_node(SyntaxNode,input, index...(index + 1))
+        if r4
-          @index += 1
+          s3 << r4
-        else
-          terminal_parse_failure(' ')
-          r6 = nil
-        end
-        if r6
-          s5 << r6
         else
           break
         end
       end
-      if s5.empty?
+      if s3.empty?
-        self.index = i5
+        self.index = i3
-        r5 = nil
+        r3 = nil
       else
-        r5 = instantiate_node(SyntaxNode,input, i5...index, s5)
+        r3 = instantiate_node(SyntaxNode,input, i3...index, s3)
-      end
-      s4 << r5
-      if r5
-        i7 = index
-        r8 = _nt_name
-        if r8
-          self.index = i7
-          r7 = instantiate_node(SyntaxNode,input, index...index)
-        else
-          r7 = nil
-        end
-        s4 << r7
-      end
-      if s4.last
-        r4 = instantiate_node(SyntaxNode,input, i4...index, s4)
-        r4.extend(TypeConstAndPtrSuffix0)
-      else
-        self.index = i4
-        r4 = nil
-      end
-      if r4
-        r3 = r4
-      else
-        i9, s9 = index, []
-        r10 = _nt_space
-        s9 << r10
-        if r10
-          i11 = index
-          r12 = _nt_comma
-          if r12
-            self.index = i11
-            r11 = instantiate_node(SyntaxNode,input, index...index)
-          else
-            r11 = nil
-          end
-          s9 << r11
-        end
-        if s9.last
-          r9 = instantiate_node(SyntaxNode,input, i9...index, s9)
-          r9.extend(TypeConstAndPtrSuffix1)
-        else
-          self.index = i9
-          r9 = nil
-        end
-        if r9
-          r3 = r9
-        else
-          i13, s13 = index, []
-          r14 = _nt_space
-          s13 << r14
-          if r14
-            i15 = index
-            r16 = _nt_right_paren
-            if r16
-              self.index = i15
-              r15 = instantiate_node(SyntaxNode,input, index...index)
-            else
-              r15 = nil
-            end
-            s13 << r15
-          end
-          if s13.last
-            r13 = instantiate_node(SyntaxNode,input, i13...index, s13)
-            r13.extend(TypeConstAndPtrSuffix2)
-          else
-            self.index = i13
-            r13 = nil
-          end
-          if r13
-            r3 = r13
-          else
-            i17, s17 = index, []
-            r18 = _nt_space
-            s17 << r18
-            if r18
-              i19 = index
-              r20 = _nt_left_paren
-              if r20
-                self.index = i19
-                r19 = instantiate_node(SyntaxNode,input, index...index)
-              else
-                r19 = nil
-              end
-              s17 << r19
-            end
-            if s17.last
-              r17 = instantiate_node(SyntaxNode,input, i17...index, s17)
-              r17.extend(TypeConstAndPtrSuffix3)
-            else
-              self.index = i17
-              r17 = nil
-            end
-            if r17
-              r3 = r17
-            else
-              self.index = i3
-              r3 = nil
-            end
-          end
-        end
       end
       s1 << r3
+      if r3
+        r5 = _nt_lookahead_const
+        s1 << r5
+      end
     end
     if s1.last
       r1 = instantiate_node(SyntaxNode,input, i1...index, s1)
-      r1.extend(TypeConstAndPtrSuffix4)
+      r1.extend(TypeConstAndPtrSuffix0)
     else
       self.index = i1
       r1 = nil
@@ -1384,75 +1260,94 @@ module CMockFunctionPrototype
     if r1
       r0 = r1
     else
-      i21, s21 = index, []
+      i6, s6 = index, []
-      r22 = _nt_const
+      r7 = _nt_const
-      s21 << r22
+      s6 << r7
-      if r22
+      if r7
-        s23, i23 = [], index
+        s8, i8 = [], index
         loop do
-          r24 = _nt_asterisk
+          r9 = _nt_asterisk
-          if r24
+          if r9
-            s23 << r24
+            s8 << r9
           else
             break
           end
         end
-        if s23.empty?
+        if s8.empty?
-          self.index = i23
+          self.index = i8
-          r23 = nil
+          r8 = nil
         else
-          r23 = instantiate_node(SyntaxNode,input, i23...index, s23)
+          r8 = instantiate_node(SyntaxNode,input, i8...index, s8)
         end
-        s21 << r23
+        s6 << r8
       end
-      if s21.last
+      if s6.last
-        r21 = instantiate_node(SyntaxNode,input, i21...index, s21)
+        r6 = instantiate_node(SyntaxNode,input, i6...index, s6)
-        r21.extend(TypeConstAndPtrSuffix5)
+        r6.extend(TypeConstAndPtrSuffix1)
       else
-        self.index = i21
+        self.index = i6
-        r21 = nil
+        r6 = nil
       end
-      if r21
+      if r6
-        r0 = r21
+        r0 = r6
       else
-        i25, s25 = index, []
+        i10, s10 = index, []
-        s26, i26 = [], index
+        s11, i11 = [], index
         loop do
-          r27 = _nt_asterisk
+          r12 = _nt_asterisk
-          if r27
+          if r12
-            s26 << r27
+            s11 << r12
           else
             break
           end
         end
-        if s26.empty?
+        if s11.empty?
-          self.index = i26
+          self.index = i11
-          r26 = nil
+          r11 = nil
         else
-          r26 = instantiate_node(SyntaxNode,input, i26...index, s26)
+          r11 = instantiate_node(SyntaxNode,input, i11...index, s11)
         end
-        s25 << r26
+        s10 << r11
-        if r26
+        if r11
-          r29 = _nt_const
+          r13 = _nt_lookahead_const
-          if r29
+          s10 << r13
-            r28 = r29
+        end
+        if s10.last
+          r10 = instantiate_node(SyntaxNode,input, i10...index, s10)
+          r10.extend(TypeConstAndPtrSuffix2)
+        else
+          self.index = i10
+          r10 = nil
+        end
+        if r10
+          r0 = r10
+        else
+          s14, i14 = [], index
+          loop do
+            r15 = _nt_asterisk
+            if r15
+              s14 << r15
+            else
+              break
+            end
+          end
+          if s14.empty?
+            self.index = i14
+            r14 = nil
           else
-            r28 = instantiate_node(SyntaxNode,input, index...index)
+            r14 = instantiate_node(SyntaxNode,input, i14...index, s14)
+          end
+          if r14
+            r0 = r14
+          else
+            r16 = _nt_lookahead_const
+            if r16
+              r0 = r16
+            else
+              self.index = i0
+              r0 = nil
+            end
           end
-          s25 << r28
-        end
-        if s25.last
-          r25 = instantiate_node(SyntaxNode,input, i25...index, s25)
-          r25.extend(TypeConstAndPtrSuffix6)
-        else
-          self.index = i25
-          r25 = nil
-        end
-        if r25
-          r0 = r25
-        else
-          self.index = i0
-          r0 = nil
         end
       end
     end
@@ -1462,6 +1357,189 @@ module CMockFunctionPrototype
     return r0
   end
 
+  module LookaheadConst0
+  end
+
+  module LookaheadConst1
+    def space
+      elements[0]
+    end
+
+  end
+
+  module LookaheadConst2
+    def space
+      elements[0]
+    end
+
+  end
+
+  module LookaheadConst3
+    def space
+      elements[0]
+    end
+
+  end
+
+  module LookaheadConst4
+  end
+
+  def _nt_lookahead_const
+    start_index = index
+    if node_cache[:lookahead_const].has_key?(index)
+      cached = node_cache[:lookahead_const][index]
+      @index = cached.interval.end if cached
+      return cached
+    end
+
+    i0, s0 = index, []
+    if input.index('const', index) == index
+      r1 = instantiate_node(SyntaxNode,input, index...(index + 5))
+      @index += 5
+    else
+      terminal_parse_failure('const')
+      r1 = nil
+    end
+    s0 << r1
+    if r1
+      i2 = index
+      i3, s3 = index, []
+      s4, i4 = [], index
+      loop do
+        if input.index(' ', index) == index
+          r5 = instantiate_node(SyntaxNode,input, index...(index + 1))
+          @index += 1
+        else
+          terminal_parse_failure(' ')
+          r5 = nil
+        end
+        if r5
+          s4 << r5
+        else
+          break
+        end
+      end
+      if s4.empty?
+        self.index = i4
+        r4 = nil
+      else
+        r4 = instantiate_node(SyntaxNode,input, i4...index, s4)
+      end
+      s3 << r4
+      if r4
+        i6 = index
+        r7 = _nt_name
+        if r7
+          self.index = i6
+          r6 = instantiate_node(SyntaxNode,input, index...index)
+        else
+          r6 = nil
+        end
+        s3 << r6
+      end
+      if s3.last
+        r3 = instantiate_node(SyntaxNode,input, i3...index, s3)
+        r3.extend(LookaheadConst0)
+      else
+        self.index = i3
+        r3 = nil
+      end
+      if r3
+        r2 = r3
+      else
+        i8, s8 = index, []
+        r9 = _nt_space
+        s8 << r9
+        if r9
+          i10 = index
+          r11 = _nt_comma
+          if r11
+            self.index = i10
+            r10 = instantiate_node(SyntaxNode,input, index...index)
+          else
+            r10 = nil
+          end
+          s8 << r10
+        end
+        if s8.last
+          r8 = instantiate_node(SyntaxNode,input, i8...index, s8)
+          r8.extend(LookaheadConst1)
+        else
+          self.index = i8
+          r8 = nil
+        end
+        if r8
+          r2 = r8
+        else
+          i12, s12 = index, []
+          r13 = _nt_space
+          s12 << r13
+          if r13
+            i14 = index
+            r15 = _nt_right_paren
+            if r15
+              self.index = i14
+              r14 = instantiate_node(SyntaxNode,input, index...index)
+            else
+              r14 = nil
+            end
+            s12 << r14
+          end
+          if s12.last
+            r12 = instantiate_node(SyntaxNode,input, i12...index, s12)
+            r12.extend(LookaheadConst2)
+          else
+            self.index = i12
+            r12 = nil
+          end
+          if r12
+            r2 = r12
+          else
+            i16, s16 = index, []
+            r17 = _nt_space
+            s16 << r17
+            if r17
+              i18 = index
+              r19 = _nt_left_paren
+              if r19
+                self.index = i18
+                r18 = instantiate_node(SyntaxNode,input, index...index)
+              else
+                r18 = nil
+              end
+              s16 << r18
+            end
+            if s16.last
+              r16 = instantiate_node(SyntaxNode,input, i16...index, s16)
+              r16.extend(LookaheadConst3)
+            else
+              self.index = i16
+              r16 = nil
+            end
+            if r16
+              r2 = r16
+            else
+              self.index = i2
+              r2 = nil
+            end
+          end
+        end
+      end
+      s0 << r2
+    end
+    if s0.last
+      r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
+      r0.extend(LookaheadConst4)
+    else
+      self.index = i0
+      r0 = nil
+    end
+
+    node_cache[:lookahead_const][start_index] = r0
+
+    return r0
+  end
+
   module Name0
     def space
       elements[1]

lib/cmock_function_prototype_parser.treetop

@@ -97,12 +97,20 @@ grammar CMockFunctionPrototype
   end
 
   rule type_const_and_ptr_suffix
-    # "const" or "const *" or "* const" or "*" (of course, more than one asterisk possible in pointer cases);
+    # variants of "const", "const *", "* const", "const * const", & "*"
-    # first line below is a fancy lookahead statement that allows const type suffix to be distinguished 
+    # (of course, more than one asterisk possible in pointer cases)
-    #  from a parameter name that might begin with word 'const' (e.g. "int const_param" or "char* const constant")
+    (const asterisk+ lookahead_const) /
-    ('const' ( (' '+ &name) / (space &comma) / (space &right_paren) / (space &left_paren) )) /
+    (const asterisk+) /
-    (const asterisk+) / 
+    (asterisk+ lookahead_const) /
-    (asterisk+ (const)?)
+    (asterisk+) / 
+    (lookahead_const)
+  end
+
+  rule lookahead_const
+    # fancy lookahead statement that allows const type suffix to be distinguished 
+    # from a parameter name that might begin with word 'const' 
+    # (e.g. "int const_param" or "char* const constant")
+    'const' ( (' '+ &name) / (space &comma) / (space &right_paren) / (space &left_paren) )
   end
 
 	rule name

lib/cmock_generator_plugin_expect.rb

@@ -30,7 +30,7 @@ class CMockGeneratorPluginExpect
     end
     
     function[:args].each do |arg|
-      type = arg[:type].sub(/const/, '').strip
+      type = arg[:type].gsub(/\s*const\s*/, ' ').strip
       lines << [ "#{@tab}#{type} *#{function[:name]}_Expected_#{arg[:name]};\n",
                  "#{@tab}#{type} *#{function[:name]}_Expected_#{arg[:name]}_Head;\n",
                  "#{@tab}#{type} *#{function[:name]}_Expected_#{arg[:name]}_Tail;\n" ]
@@ -72,7 +72,7 @@ class CMockGeneratorPluginExpect
     end
     
     function[:args].each do |arg|
-      arg_return_type = arg[:type].sub(/const/, '').strip
+      arg_return_type = arg[:type].gsub(/\s*const\s*/, ' ').strip
       lines << @utils.code_verify_an_arg_expectation(function, arg_return_type, arg[:name])
     end
     lines.flatten
@@ -86,7 +86,7 @@ class CMockGeneratorPluginExpect
       lines << "void ExpectParameters_#{function[:name]}(#{function[:args_string]})\n"
       lines << "{\n"
       function[:args].each do |arg|
-        type = arg[:type].sub(/const/, '').strip
+        type = arg[:type].gsub(/\s*const\s*/, ' ').strip
         lines << @utils.code_add_an_arg_expectation(function, type, arg[:name])
       end
       lines << "}\n\n"

lib/cmock_header_parser.rb

@@ -90,7 +90,7 @@ class CMockHeaderParser
     
     parsed = @parser.parse(prototype)
 
-    raise "Failed parsing function prototype: '#{prototype}'" if parsed.nil? 
+    raise "Failed parsing function prototype: '#{prototype}' in file '#{@name}'" if parsed.nil? 
     
     hash[:name]          = parsed.get_function_name
     hash[:args_string]   = parsed.get_argument_list

test/unit/cmock_function_prototype_parser_test.rb

@@ -141,12 +141,13 @@ class CMockFunctionPrototypeParserTest < Test::Unit::TestCase
       parsed.get_arguments)
     assert_nil(parsed.get_var_arg)
   
-    parsed = @parser.parse("void foo_bar(CUSTOM_TYPE abc, CUSTOM_TYPE* xyz_123, CUSTOM_TYPE const abcxyz)")
+    parsed = @parser.parse("void foo_bar(CUSTOM_TYPE abc, CUSTOM_TYPE* xyz_123, CUSTOM_TYPE const abcxyz, struct CUSTOM_TYPE const * const abc123)")
-    assert_equal('CUSTOM_TYPE abc, CUSTOM_TYPE* xyz_123, CUSTOM_TYPE const abcxyz', parsed.get_argument_list)
+    assert_equal('CUSTOM_TYPE abc, CUSTOM_TYPE* xyz_123, CUSTOM_TYPE const abcxyz, struct CUSTOM_TYPE const* const abc123', parsed.get_argument_list)
     assert_equal([
       {:type => 'CUSTOM_TYPE', :name => 'abc'},
       {:type => 'CUSTOM_TYPE*', :name => 'xyz_123'},
-      {:type => 'CUSTOM_TYPE const', :name => 'abcxyz'}],
+      {:type => 'CUSTOM_TYPE const', :name => 'abcxyz'},
+      {:type => 'struct CUSTOM_TYPE const* const', :name => 'abc123'}],
       parsed.get_arguments)
     assert_nil(parsed.get_var_arg)
 

test/unit/cmock_header_parser_test.rb

@@ -259,7 +259,7 @@ class CMockHeaderParserTest < Test::Unit::TestCase
     begin
       @parser.parse      
     rescue RuntimeError => e
-      assert_equal("Failed parsing function prototype: 'int Foo(int a, unsigned int b)'", e.message)
+      assert_equal("Failed parsing function prototype: 'int Foo(int a, unsigned int b)' in file '#{@test_name}'", e.message)
     end    
   end