dub 0.5.1 → 0.6.0

data/History.txt

@@ -1,3 +1,12 @@
+== 0.6.0 2010-03-11
+
+* 4 enhancements
+  * added support for custom tostring methods for classes
+  * fixed parsing of templated return types
+  * static class methods are now registered in the namespace as Klass_method
+  * removing functions and methods with class pointer arguments (could use lists later on)
+  * better parsing of complex types (including nested template arguments)
+
 == 0.5.1 2010-03-05
 
 * 2 minor enhancements

data/dub.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dub}
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gaspard Bucher"]
-  s.date = %q{2010-03-05}
+  s.date = %q{2010-03-11}
   s.description = %q{This is a tool to ease the creation of scripting language bindings for a C++ library.
     It is currently developed to crete the OpenCV bindings for Lua in Rubyk (http://rubyk.org). The generator uses the xml output from Doxygen to avoid parsing C++ code by itself.}
   s.email = %q{gaspard@teti.ch}
@@ -148,6 +148,7 @@ Gem::Specification.new do |s|
      "test/fixtures/app/xml/namespacedub.xml",
      "test/fixtures/classcv_1_1_mat.xml",
      "test/fixtures/classcv_1_1_point__.xml",
+     "test/fixtures/classcv_1_1_scalar__.xml",
      "test/fixtures/classcv_1_1_size__.xml",
      "test/fixtures/group___magic_type.xml",
      "test/fixtures/namespacecv.xml",

data/lib/dub/argument.rb

@@ -4,8 +4,8 @@ module Dub
   class Argument
     include Dub::EntitiesUnescape
     attr_reader :name, :default, :function, :xml
-    attr_accessor :type
-
+    attr_accessor :type, :is_list, :is_list_count
+    TYPE_REGEXP = %r{^\s*(\w+\s+|)(const\s+|)([\w\:]+|\.\.\.)(\s*<(.+)>|)(\s*\*+|\s*&|)$}
     NUMBER_TYPES = [
       'float',
       'double',
@@ -14,6 +14,7 @@ module Dub
       'uint',
       'int',
       'size_t',
+      'time_t',
       'unsigned int',
       'uint',
       'bool',
@@ -141,6 +142,18 @@ module Dub
       @type == '...'
     end
 
+    def complex?
+      @is_complex
+    end
+
+    def is_list?
+      @is_list
+    end
+
+    def is_list_count?
+      @is_list_count
+    end
+
     def create_type
       resolve_type if @template_params
       (is_const? ? 'const ' : '') +
@@ -199,39 +212,32 @@ module Dub
         end
 
         type = type.innerHTML
+        type = unescape(type).strip
 
-        # Strip CV_EXPORT .....
-        if type =~ /^([^ ]+)\s+([a-zA-Z_]+.*)$/
-          if $1 == 'const'
-            @const = true
-          end
-          type = $2
-        end
+        if type =~ TYPE_REGEXP
+          res = $~.to_a
 
-        # Strip const .....
-        if type =~ /^const\s+(.+)$/
-          type  = $1.strip
-          @const = true
-        end
+          if res[1].strip == 'const'
+            res[2] = res[1]
+            res[1] = ""
+          end
 
-        # Strip ..... &
-        if type =~ /^(.+)&amp;$/
-          type = $1.strip
-          @ref = true
-        end
+          @const = res[2].strip == 'const'
+          @type = res[3]
 
-        # Strip ..... *
-        if type =~ /^(.+)(\*+)\s*$/
-          type = $1.strip
-          @pointer = $2
-        end
+          if res[6] == ''
+            @pointer = nil
+            @res = nil
+          elsif res[6] =~ /^\s*(\*+)\s*$/
+            @pointer = $1
+          else
+            @ref = res[6].strip
+          end
 
-        # Strip .....< ... >
-        if type =~ /^(.+)\s*&lt;\s*(.+)\s*&gt;/
-          type = $1.strip
-          @template_params = $2.split(',').map(&:strip)
+          @template_params = res[5] ? res[5].split(',').map(&:strip) : nil
+        else
+          # ERROR
         end
-        @type = type
       end
 
       # Replace something like AUTO_STEP by cv::Mat::AUTO_STEP
@@ -245,21 +251,23 @@ module Dub
       end
 
       def resolve_type
+        params = @template_params
+        @template_params = nil
         if container = @function.parent
           if container.kind_of?(Klass)
             container = container.parent
           end
           if container && tclass = container.template_class(@type)
-            if instanciation = tclass.instanciations[@template_params]
+            if instanciation = tclass.instanciations[params]
               @type = instanciation.name
-            else
-              Dub.logger.warn "Could not resolve templated type #{@type}<#{@template_params.join(', ')}>"
+              return
             end
-          else
-            Dub.logger.warn "Could not find class for type #{@type}<#{@template_params.join(', ')}>"
           end
         end
-        @template_params = nil
+
+        @type = "#{@type}< #{params.join(', ')} >"
+        Dub.logger.warn "Could not resolve templated type #{@type}"
+        @is_complex = true
       end
   end
 end # Namespace

data/lib/dub/function.rb

@@ -11,13 +11,14 @@ module Dub
       @parent, @name = parent, name
       @xml, @prefix, @overloaded_index = xml, prefix, overloaded_index
       parse_xml
+      parse_template_params
     end
-    
+
     def set_as_constructor
       @return_value = Argument.new(self, (Hpricot::XML("<type>#{name} *</type>")/''))
       @is_constructor = true
     end
-    
+
     def bind(generator)
       @gen = generator.function_generator
     end
@@ -42,6 +43,10 @@ module Dub
       @is_constructor
     end
 
+    def static?
+      @is_static
+    end
+
     alias gen generator
 
     def name=(n)
@@ -51,6 +56,14 @@ module Dub
       end
     end
 
+    def call_name
+      if klass
+        static? ? "#{klass.name}::#{name}" : name
+      else
+        name
+      end
+    end
+
     def source
       loc = (@xml/'location').first.attributes
       "#{loc['file'].split('/')[-3..-1].join('/')}:#{loc['line']}"
@@ -70,10 +83,33 @@ module Dub
       @has_array_arguments = !@arguments.detect {|a| a.array_suffix }.nil?
     end
 
+    def has_class_pointer_arguments?
+      return @has_class_pointer_arguments if defined?(@has_class_pointer_arguments)
+      @has_class_pointer_arguments = !@arguments.detect {|a| !a.is_native? && a.is_pointer? }.nil?
+    end
+
+    def has_complex_arguments?
+      return @has_complex_arguments if defined?(@has_complex_arguments)
+      @has_complex_arguments = !(@arguments + [@return_value]).compact.detect {|a| a.complex? }.nil?
+    end
+
     def vararg?
       @arguments.last && @arguments.last.vararg?
     end
 
+    def arg_is_list(list_position, count_position)
+      @arguments[list_position ].is_list       = true
+      @arguments[count_position].is_list_count = true
+    end
+
+    def template?
+      !@template_params.nil?
+    end
+
+    def template_params
+      @template_params
+    end
+
     def inspect
       "#<Function #{@prefix}_#{@name}(#{@arguments.inspect[1..-2]})>"
     end
@@ -100,12 +136,24 @@ module Dub
         end
 
         raw_type = (@xml/'/type').innerHTML
+
         if raw_type.strip == ''
           # no return type
         else
           arg = Argument.new(self, (@xml/'/type'))
           @return_value = arg unless arg.create_type =~ /void\s*$/
         end
+
+        @is_static = @xml[:static] == 'yes'
+      end
+
+      def parse_template_params
+        template_params = (@xml/'/templateparamlist/param')
+        if !template_params.empty?
+          @template_params = template_params.map do |param|
+            (param/'/type').innerHTML.gsub(/^\s*(typename|class)\s+/,'')
+          end
+        end
       end
   end
 end # Namespace

data/lib/dub/function_group.rb

@@ -35,10 +35,6 @@ module Dub
       generator.group(self)
     end
 
-    def name
-      first.name
-    end
-
     def method_name(overloaded_index = nil)
       first.method_name(overloaded_index)
     end
@@ -63,12 +59,14 @@ module Dub
       nil
     end
 
-    def prefix
-      first.prefix
-    end
-
     def <=>(other)
       name <=> other.name
     end
+
+    private
+      def method_missing(method, *args)
+        first.send(method, *args)
+      end
+
   end
 end

data/lib/dub/group.rb

@@ -6,5 +6,19 @@ module Dub
       super
       parse_defines
     end
+
+    def arg_is_list(argument_pos, count_pos)
+      each do |f|
+        f.arg_is_list(argument_pos, count_pos)
+      end
+    end
+
+    def members
+      if self.generator
+        @gen_members ||= self.generator.members_list(super, @ignores)
+      else
+        super
+      end
+    end
   end
 end

data/lib/dub/klass.rb

@@ -8,7 +8,7 @@ module Dub
   class Klass
     include MemberExtraction
     attr_reader :name, :xml, :prefix, :constructor, :alias_names, :enums, :parent, :instanciations
-    attr_accessor :header
+    attr_accessor :header, :string_format, :string_args
 
     def initialize(parent, name, xml, prefix = '')
       @parent, @name, @xml, @prefix = parent, name, xml, prefix
@@ -63,7 +63,7 @@ module Dub
     end
 
     def <=>(other)
-      name <=> other.name
+      (name || "") <=> (other.name || "")
     end
 
     def [](name)

data/lib/dub/lua/class.cpp.erb

@@ -23,7 +23,11 @@ static int <%= @class.destructor_name %>(lua_State *L) {
 
 static int <%= @class.tostring_name %>(lua_State *L) {
   <%= @class.name %> **userdata = (<%= @class.name %>**)luaL_checkudata(L, 1, <%= @class.id_name.inspect %>);
-  lua_pushfstring(L, "<%= @class.id_name %>: %p", *userdata);
+  <% if @class.string_format %>
+  lua_pushfstring(L, "<<%= @class.id_name %>: %p <%= @class.string_format %>>", *userdata, <%= @class.string_args %>);
+  <% else %>
+  lua_pushfstring(L, "<<%= @class.id_name %>: %p>", *userdata);
+  <% end %>
   return 1;
 }
 
@@ -56,7 +60,7 @@ static const struct lua_constants_Reg <%= @class.name %>_namespace_constants[] =
 
 void luaopen_<%= @class.lib_name %>(lua_State *L) {
   // Create the metatable which will contain all the member methods
-  luaL_newmetatable(L, <%= @class.id_name.inspect %>); // "dub.Matrix"
+  luaL_newmetatable(L, <%= @class.id_name.inspect %>);
 
   // metatable.__index = metatable (find methods in the table itself)
   lua_pushvalue(L, -1);
@@ -65,7 +69,7 @@ void luaopen_<%= @class.lib_name %>(lua_State *L) {
   // register member methods
   luaL_register(L, NULL, <%= @class.name %>_member_methods);
 
-  // register class methods in a global table like "dub"
+  // register class methods in a global namespace table
   luaL_register(L, <%= @class.prefix.inspect %>, <%= @class.name %>_namespace_methods);
 
 <% if @class.has_constants? %>

data/lib/dub/lua/class_gen.rb

@@ -20,8 +20,9 @@ module Dub
 
       def method_registration(klass = @class)
         member_methods = (klass.members || []).map do |method|
+          next if method.static?
           "{%-20s, #{method.method_name(0)}}" % method.name.inspect
-        end
+        end.compact
 
         member_methods << "{%-20s, #{klass.tostring_name}}" % "__tostring".inspect
         member_methods << "{%-20s, #{klass.destructor_name}}" % "__gc".inspect
@@ -29,10 +30,17 @@ module Dub
         member_methods.join(",\n")
       end
 
-      def namespace_methods_registration
-        @class.names.map do |name|
-          "{%-20s, #{@class.constructor.method_name(0)}}" % name.inspect
-        end.join(",\n")
+      def namespace_methods_registration(klass = @class)
+        global_methods = klass.names.map do |name|
+          "{%-20s, #{klass.constructor.method_name(0)}}" % name.inspect
+        end
+
+        (klass.members || []).map do |method|
+          next unless method.static?
+          global_methods << "{%-20s, #{method.method_name(0)}}" % "#{klass.name}_#{method.name}".inspect
+        end
+
+        global_methods.join(",\n")
       end
 
       def constants_registration(klass = @class)
@@ -61,10 +69,10 @@ module Dub
       def ignore_member?(member)
         if member.name =~ /^~/           || # do not build constructor
            member.name =~ /^operator/    || # no conversion operators
-           member.original_signature =~ />/ || # no complex types in signature
+           member.has_complex_arguments? || # no complex arguments or return values
            member.has_array_arguments? ||
            member.vararg? ||
-           member.original_signature =~ /void\s+\*/
+           member.original_signature =~ /void\s+\*/ # used to detect return value and parameters
           true # ignore
         elsif return_value = member.return_value
           return_value.type =~ />$/    || # no complex return types

data/lib/dub/lua/function_gen.rb

@@ -4,9 +4,10 @@ require 'erb'
 module Dub
   module Lua
     class FunctionGen < Dub::Generator
-      FLOAT_TYPES = [
+      NUMBER_TYPES = [
         'float',
         'double',
+        'time_t',
       ]
 
       INT_TYPES = [
@@ -29,7 +30,11 @@ module Dub
       # Produce bindings for a group of overloaded functions
       def group(group)
         @group = group
-        @group_template.result(binding)
+        if @group.members
+          @group_template.result(binding)
+        else
+          ''
+        end
       end
 
       def function(function)
@@ -45,6 +50,17 @@ module Dub
         Dub::Lua.namespace_generator
       end
 
+      def chooser_body(group = @group)
+        decision_tree = Argument.decision_tree(group.members)
+        res = []
+        res << "int type__ = lua_type(L, 1);"
+        if flatten_hash(decision_tree).include?(nil)
+          res << "int top__  = lua_gettop(L);"
+        end
+        res << switch(decision_tree)
+        res.join("\n")
+      end
+
       # Create a switch to choose the correct method from argument types (overloaded functions)
       def switch(hash_or_function, depth = 1)
         if hash_or_function.kind_of?(Function)
@@ -62,7 +78,7 @@ module Dub
             when :string
               res << "#{else_prefix}if (type__ == LUA_TSTRING) {"
             when nil
-              res << "#{else_prefix}if (type__ == LUA_TNONE) {"
+              res << "#{else_prefix}if (top__ < #{depth}) {"
             else
               res << "#{else_prefix}if (type__ == LUA_TUSERDATA && is_userdata(L, #{depth}, \"#{type}\")) {"
             end
@@ -89,7 +105,7 @@ module Dub
       def body(func)
         res = []
 
-        if func.member_method? && !func.constructor?
+        if func.member_method? && !func.constructor? && !func.static?
           klass = func.parent
           res << "#{klass.name} *self__ = *((#{klass.name}**)luaL_checkudata(L, 1, #{klass.id_name.inspect}));"
           res << "lua_remove(L, 1);"
@@ -132,16 +148,17 @@ module Dub
         "return #{method_name(func)}(L);"
       end
 
-      def call_string(func, upto_arg)
+      def call_string(func, upto_arg = nil)
+        upto_arg ||= func.arguments.count
         if upto_arg == 0
-          call_string = "#{func.name}();"
+          call_string = "#{func.call_name}();"
         else
-          call_string = "#{func.name}(#{func.arguments[0..(upto_arg-1)].map{|arg| arg.in_call_type}.join(', ')});"
+          call_string = "#{func.call_name}(#{func.arguments[0..(upto_arg-1)].map{|arg| arg.in_call_type}.join(', ')});"
         end
 
         if func.constructor?
           call_string = "new #{call_string}"
-        elsif func.member_method?
+        elsif func.member_method? && !func.static?
           call_string = "self__->#{call_string}"
         end
 
@@ -198,7 +215,7 @@ module Dub
               "#{type_def} = ptr_#{arg.name}(L, #{stack_pos});"
             end
           else
-            if FLOAT_TYPES.include?(arg.type)
+            if NUMBER_TYPES.include?(arg.type)
               "#{type_def} = luaL_checknumber(L, #{stack_pos});"
             elsif BOOL_TYPES.include?(arg.type)
               "#{type_def} = lua_toboolean(L, #{stack_pos});"
@@ -214,12 +231,15 @@ module Dub
       end
 
       def flatten_hash(hash)
+        list = []
         hash.each do |k, v|
           if v.kind_of?(Hash)
-            hash[k] = flatten_hash(v)
+            list << [k, flatten_hash(v)]
+          else
+            list << [k, v]
           end
         end
-        hash.to_a.flatten
+        list.flatten
       end
 
     end # FunctionGen

data/lib/dub/lua/group.cpp.erb

@@ -5,6 +5,5 @@
 
 /** Overloaded function chooser for <%= @group.name %>(...) */
 <%= signature(@group.first, 0) %> {
-  int type__ = lua_type(L, 1);
-<%= indent(switch(Argument.decision_tree(@group.members)), 2) %>
+<%= indent(chooser_body, 2) %>
 }

data/lib/dub/lua/namespace_gen.rb

@@ -50,7 +50,7 @@ module Dub
       end
 
       def members_list(all_members, ignore_list = [])
-        list = all_members.map do |member_or_group|
+        list = (all_members || []).map do |member_or_group|
           if ignore_list.include?(member_or_group.name)
             nil
           elsif member_or_group.kind_of?(Array)
@@ -72,7 +72,9 @@ module Dub
            member.original_signature =~ />/ || # no complex types in signature
            member.has_array_arguments? ||
            member.vararg? ||
-            member.original_signature =~ /void\s+\*/
+           member.original_signature =~ /void\s+\*/ ||
+           member.has_class_pointer_arguments?
+
           true # ignore
         elsif return_value = member.return_value
           return_value.type =~ />$/    || # no complex return types

data/lib/dub/member_extraction.rb

@@ -17,7 +17,7 @@ module Dub
       @t_members_hash = {}
       # TODO: template functions
       (@xml/'memberdef').each do |member|
-        Dub.logger.info "Parsing #{member.name}"
+        Dub.logger.info "Parsing #{(member/'name').innerHTML}"
         name = (member/"name").innerHTML
         if (member/'templateparamlist').first
           insert_member(member, name, @t_members_hash)
@@ -38,7 +38,7 @@ module Dub
     end
 
     def member(name)
-      get_member(name.to_s)
+      get_member(name.to_s, @members_hash)
     end
 
     def members
@@ -52,9 +52,13 @@ module Dub
       end
     end
 
+    def template_method(name)
+      get_member(name.to_s, @t_members_hash)
+    end
+
     # Lazy construction of members
-    def get_member(name)
-      if member_or_group = @members_hash[name]
+    def get_member(name, source = @members_hash)
+      if member_or_group = source[name]
         if member_or_group.kind_of?(Array)
           if member_or_group.first.kind_of?(Hpricot::Elem)
             list = Dub::FunctionGroup.new(self)
@@ -65,7 +69,7 @@ module Dub
             member_or_group = nil if member_or_group == []
           end
         elsif member_or_group.kind_of?(Hpricot::Elem)
-          @members_hash[name] = member_or_group = make_member(name, member_or_group)
+          source[name] = member_or_group = make_member(name, member_or_group)
         end
       end
       member_or_group

data/lib/dub/namespace.rb

@@ -197,7 +197,8 @@ module Dub
               old_name = (ref_class/'/compoundname').first.innerHTML.gsub(/^.*::/,'')
 
               # replace class name
-              class_def = ref_class.to_s.gsub(/#{old_name}<.*?>::/,"#{new_name}::")
+              # <type><ref refid="classcv_1_1_scalar__" kindref="compound">Scalar_</ref>&lt; _Tp &gt;</type>
+              class_def = ref_class.to_s.gsub(/<ref .*>#{old_name}<\/ref>&lt;.*?&gt;/, new_name)
               class_def = class_def.gsub(/#{old_name}/, new_name)
 
               # replace template types
@@ -220,7 +221,7 @@ module Dub
               class_xml = (Hpricot::XML(class_def)/'compounddef').first
 
               (class_xml/'*[@prot=private]').remove
-              (class_xml/'templateparamlist').remove
+              (class_xml/'/templateparamlist').remove
               (class_xml/'').append("<originaltemplate>#{old_name}</originaltemplate>")
               (ref_class/'').append("<instanciation><name>#{new_name}</name><param>#{instanciations_params.join('</param><param>')}</param></instanciation>")
 

data/lib/dub/version.rb

@@ -1,3 +1,3 @@
 module Dub
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end