rbind 0.0.16 → 0.0.17

data/lib/rbind/rbind.rb

@@ -2,9 +2,9 @@ require 'open3'
 
 module Rbind
     class Rbind
-        attr_accessor :parser
-        attr_accessor :generator_c
-        attr_accessor :generator_ruby
+        attr_reader :parser
+        attr_reader :generator_c
+        attr_reader :generator_ruby
         attr_accessor :includes
         attr_accessor :name
         attr_accessor :pkg_config
@@ -46,12 +46,12 @@ module Rbind
             end
         end
 
-        def initialize(name)
+        def initialize(name,parser = DefaultParser.new)
             @name = name
             @includes = []
             @pkg_config = []
             @gems = []
-            @parser = DefaultParser.new
+            @parser = parser
             lib_name = "rbind_#{name.downcase}"
             @generator_c = GeneratorC.new(@parser,lib_name)
             @generator_ruby = GeneratorRuby.new(@parser,name,lib_name)
@@ -87,20 +87,23 @@ module Rbind
 
         # parses other rbind packages
         def parse_extern
+            # extern package are always paresed with the default parser 
+            local_parser = DefaultParser.new(parser)
             paths = Rbind.rbind_pkg_paths(@pkg_config)
             paths.each do |pkg|
                 config = YAML.load(File.open(File.join(pkg,"config.rbind")).read)
                 path = File.join(pkg,"extern.rbind")
                 ::Rbind.log.info "parsing extern rbind pkg file #{path}"
-                parser.parse(File.open(path).read,config.ruby_module_name)
+                local_parser.parse(File.open(path).read,config.ruby_module_name)
             end
             @gems.each do |gem|
                 path = Rbind.gem_path(gem)
                 config = YAML.load(File.open(File.join(path,"config.rbind")).read)
                 path = File.join(path,"extern.rbind")
                 ::Rbind.log.info "parsing extern gem file #{path}"
-                parser.parse(File.open(path).read,config.ruby_module_name)
+                local_parser.parse(File.open(path).read,config.ruby_module_name)
             end
+            self
         end
 
         def parse_headers_dry(*headers)
@@ -191,9 +194,22 @@ module Rbind
             @generator_c.libs
         end
 
-        def import_std_string
+        def add_std_string
             @generator_c.includes << "<string>"
-            @parser.add_type(RString.new("std::string",@parser))
+            @parser.add_type(StdString.new("std::string",@parser))
+            @parser.type_alias["basic_string"] = @parser.std.string
+            self
+        end
+
+        def add_std_vector
+            @generator_c.includes << "<vector>"
+            @parser.add_type(StdVector.new("std::vector"))
+            self
+        end
+
+        def add_std_types
+            add_std_vector
+            add_std_string
         end
 
         def method_missing(m,*args)

data/lib/rbind/templates/c/CMakeLists.txt

@@ -18,13 +18,13 @@ TARGET_LINK_LIBRARIES(<%= library_name %> <%= libs %> ${GEM_LIBRARIES})
 
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/rbind.pc.in ${CMAKE_CURRENT_BINARY_DIR}/<%= library_name %>.pc @ONLY)
 
-set(ROOT_FOLDER ${CMAKE_CURRENT_SOURCE_DIR}/..)
+set(ROOT_FOLDER ${CMAKE_CURRENT_SOURCE_DIR}/../..)
 if(GEM_INSTALL)
     # local install
-    install(TARGETS <%= library_name %> LIBRARY DESTINATION ${ROOT_FOLDER}/lib/lib)
-    install(FILES types.h operations.h conversions.hpp DESTINATION ${ROOT_FOLDER}/lib/include)
-    install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/extern.rbind DESTINATION ${ROOT_FOLDER}/lib/include)
-    install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/config.rbind DESTINATION ${ROOT_FOLDER}/lib/include)
+    install(TARGETS <%= library_name %> LIBRARY DESTINATION ${ROOT_FOLDER}/lib)
+    install(FILES types.h operations.h conversions.hpp DESTINATION ${ROOT_FOLDER}/include)
+    install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/extern.rbind DESTINATION ${ROOT_FOLDER}/include)
+    install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/config.rbind DESTINATION ${ROOT_FOLDER}/include)
 else()
     # global install
     install(FILES ${CMAKE_CURRENT_BINARY_DIR}/<%= library_name %>.pc DESTINATION lib/pkgconfig)
@@ -36,7 +36,7 @@ else()
     FIND_PACKAGE(Ruby)
     IF(NOT RUBY_INCLUDE_PATH)
         MESSAGE(STATUS "Ruby library not found. Cannot install ruby extensions")
-    ELSEIF(NOT RUBY_EXTENSIONS_AVAILABLE)
+    ELSEIF(RUBY_EXTENSIONS_AVAILABLE)
         STRING(REGEX REPLACE ".*lib(32|64)?/?" "lib/" RUBY_LIBRARY_INSTALL_DIR ${RUBY_RUBY_LIB_PATH})
         INSTALL(DIRECTORY ${ROOT_FOLDER}/lib/ruby/ DESTINATION ${RUBY_LIBRARY_INSTALL_DIR}
             FILES_MATCHING PATTERN "*.rb")

data/lib/rbind/templates/ruby/rbind.rb

@@ -8,7 +8,7 @@ module <%= name %>
         extend FFI::Library
 
         #load library <%= library_name %>
-        path = File.join(File.dirname(__FILE__),"..","..","lib")
+        path = File.join(File.dirname(__FILE__),"..")
         path = if Dir.exist?(path)
                    Dir.chdir(path) do
                        path = Dir.glob("lib<%= library_name %>.*").first

data/lib/rbind/templates/ruby/rmethod.rb

@@ -1,5 +1,7 @@
-    # wrapper for <%= signature %>
+<%= add_doc -%>
+    # @note wrapper for <%= signature %>
     def <%=name%>(<%= wrap_parameters_signature %>)
+<%= add_specialize_ruby -%>
     <%- if return_type.basic_type? || operator? -%>
         Rbind::<%= cname %>( <%= wrap_parameters_call %>)
     <%- else -%>
@@ -11,4 +13,5 @@
         result
     <%- end -%>
     end
+<%= add_alias -%>
 

data/lib/rbind/templates/ruby/rnamespace.rb

@@ -1,4 +1,5 @@
-# wrapper for <%= full_name %>
+<%= add_doc -%>
+# @note wrapper for <%= full_name %>
 module <%= name %>
     # @!group Constants
 <%= add_consts%>

data/lib/rbind/templates/ruby/roverloaded_method.rb

@@ -1,6 +1,8 @@
-    # wrapper for overloaded method <%= name %>
+<%= add_doc -%>
+    # @note wrapper for overloaded method <%= name %>
     def <%=name%>(*args)
 <%= add_methods %>
         raise ArgumentError, "No overloaded signature fits to: #{args.map(&:class)}"
     end
+<%= add_alias -%>
 

data/lib/rbind/templates/ruby/roverloaded_method_call.rb

@@ -6,6 +6,7 @@
                 targs[i] = @@<%=cname%>_defaults<%=index%>[i]
             end
             begin
+    <%= add_specialize_ruby -%>
                 <%- if !return_type || return_type.basic_type? || operator? -%>
                     <%- if constructor? || !instance_method? -%>
                 return Rbind::<%= cname %>(*targs)

data/lib/rbind/templates/ruby/roverloaded_static_method.rb

@@ -1,6 +1,7 @@
-    # wrapper for overloaded method <%= name %>
+<%= add_doc -%>
+    # @note wrapper for overloaded method <%= name %>
     def self.<%=name%>(*args)
 <%= add_methods %>
         raise ArgumentError, "No overloaded signature fits to: #{args.map(&:class)}"
     end
-
+<%= add_alias -%>

data/lib/rbind/templates/ruby/rstatic_method.rb

@@ -1,5 +1,8 @@
-    # wrapper for <%= signature %>
+<%= add_doc -%>
+    # @note wrapper for <%= signature %>
     def self.<%= name %>(<%= wrap_parameters_signature %>)
+<%= add_specialize_ruby -%>
         Rbind::<%= cname %>(<%= wrap_parameters_call %>)
     end
+<%= add_alias -%>
 

data/lib/rbind/templates/ruby/rtype.rb

@@ -1,5 +1,5 @@
-# @api private
-# object wrapping <%= full_name %>
+# @private
+# @note object wrapping <%= full_name %>
 class <%= name %>Struct < FFI::Struct
     layout :version,:uchar,
            :size,:size_t,
@@ -14,11 +14,12 @@ class <%= name %>Struct < FFI::Struct
     end
 end
 
+<%= add_doc -%>
 class <%= name %>
     extend FFI::DataConverter
     native_type FFI::Type::POINTER
 
-    # @api private
+    # @private
     #
     # Returns the *Struct type that Rbind uses to store additional information
     # about the memory used by this object
@@ -28,6 +29,7 @@ class <%= name %>
         <%= name %>Struct
     end
 
+<%= add_constructor_doc -%>
     def self.new(*args)
         if args.first.is_a?(FFI::Pointer) || args.first.is_a?(<%= name %>Struct)
             raise ArgumentError, "too many arguments for creating #{self.name} from Pointer" unless args.size == 1
@@ -37,7 +39,7 @@ class <%= name %>
         raise ArgumentError, "no constructor for #{self}(#{args.inspect})"
     end
 
-    # @api private
+    # @private
     def self.rbind_to_native(obj,context)
         if obj.is_a? <%= name %>
             obj.__obj_ptr__
@@ -46,14 +48,14 @@ class <%= name %>
         end
     end
 
-    # @api private
+    # @private
     def self.rbind_from_native(ptr,context)
         <%= name %>.new(ptr)
     end
 
-    # @api private
+    # @private
     #
-    # Performs the convertion a Ruby representation into the FFI representation
+    # Performs the conversion a Ruby representation into the FFI representation
     #
     # @param [Object] obj the Ruby representation
     # @param context necessary but undocumented argument from FFI
@@ -62,9 +64,9 @@ class <%= name %>
         rbind_to_native(obj,context)
     end
 
-    # @api private
+    # @private
     # 
-    # Performs the convertion from FFI into the Ruby representation that
+    # Performs the conversion from FFI into the Ruby representation that
     # corresponds to this type
     #
     # @param [FFI::Pointer,FFI::AutoPointer] ptr
@@ -74,10 +76,10 @@ class <%= name %>
         rbind_from_native(ptr,context)
     end
 
-    # @api private
+    # @private
     attr_reader :__obj_ptr__
 
-    # @api private
+    # @private
     def initialize(ptr)
         @__obj_ptr__ = if ptr.is_a? <%= name %>Struct
                            ptr
@@ -86,7 +88,7 @@ class <%= name %>
                        end
     end
 
-    # @api private
+    # @private
     # returns true if the underlying pointer is owner of
     # the real object
     def __owner__?
@@ -98,10 +100,6 @@ class <%= name %>
         <%= add_to_s %>
     end
 
-    # @!group Sepcializing
-<%= add_specializing %>
-    # @!endgroup
-
     # @!group Constants
 <%= add_consts %>
     # @!endgroup
@@ -109,7 +107,12 @@ class <%= name %>
     # methods
 <%= add_methods %>
 
+    # @!group Specializing
+<%= add_specializing %>
+    # @!endgroup
+
     # types
 <%= add_types %>
+
 end
 

data/lib/rbind/templates/ruby/rtype_template.rb

@@ -0,0 +1,7 @@
+# template <%= full_name %>
+class <%= name %>
+    # @!group Sepcializing
+<%= add_specializing %>
+    # @!endgroup
+end
+

data/lib/rbind/{core/rstring.rb → types/std_string.rb}

@@ -1,30 +1,29 @@
 module Rbind
-    class RString < RClass
+    class StdString < RClass
         def initialize(name,root)
             super(name)
 
             size_t = root.type("size_t")
             char = root.type("char")
             string = root.type("c_string")
-            const_string = root.type("const_c_string")
+            const_string = string.to_const
             bool = root.type("bool")
             void = root.type("void")
             int = root.type("int")
             
             add_operation ROperation.new(self.name,nil)
-            add_operation ROperation.new(self.name,nil,RParameter.new("other",self))
-            add_operation ROperation.new(self.name,nil,RParameter.new("str",string),RParameter.new("size",size_t))
+            add_operation ROperation.new(self.name,nil,RParameter.new("other",self).to_const)
+            add_operation ROperation.new(self.name,nil,RParameter.new("str",string).to_const,RParameter.new("size",size_t))
             add_operation ROperation.new("size",size_t)
             add_operation ROperation.new("length",size_t)
             add_operation ROperation.new("operator[]",char,RParameter.new("idx",size_t))
             add_operation ROperation.new("c_str",const_string)
             add_operation ROperation.new("empty",bool)
             add_operation ROperation.new("clear",void)
-            add_operation ROperation.new("compare",int,RParameter.new("other",self))
-            add_operation ROperation.new("swap",void,RParameter.new("other",self).add_flag(:IO))
-        end
+            add_operation ROperation.new("compare",int,RParameter.new("other",self).to_const)
+            add_operation ROperation.new("swap",void,RParameter.new("other",self))
 
-        def specialize_ruby
+            specialize_ruby do
 %Q$         def self.to_native(obj,context)
                 if obj.is_a? ::String
                     str = obj.to_str
@@ -36,6 +35,7 @@ module Rbind
             def to_s
                 c_str
             end$
+            end
         end
     end
 end

data/lib/rbind/types/std_vector.rb

@@ -0,0 +1,100 @@
+module Rbind
+    class StdVector < RTemplateClass
+        def specialize(klass,*parameters)
+            if parameters.size != 1
+                raise ArgumentError,"StdVector does only support one template parameter. Got: #{parameters}}"
+            end
+            vector_type = parameters.flatten.first
+
+            klass.add_operation ROperation.new(klass.name,nil)
+            klass.add_operation ROperation.new(klass.name,nil,RParameter.new("other",klass).to_const)
+
+            para = Array.new
+            para <<  RParameter.new("size",type("size_t"))
+            para <<  RParameter.new("val",vector_type).default_value(vector_type.full_name+"()").to_const
+            klass.add_operation ROperation.new("resize",type("void"),para)
+            klass.add_operation ROperation.new("size",type("size_t"))
+            klass.add_operation ROperation.new("clear",type("void"))
+            klass.add_operation ROperation.new("capacity",type("size_t"))
+            klass.add_operation ROperation.new("empty",type("bool"))
+            klass.add_operation ROperation.new("reserve",type("void"),RParameter.new("size",type("size_t")))
+            klass.add_operation ROperation.new("operator[]",vector_type,RParameter.new("size",type("size_t")))
+            klass.add_operation ROperation.new("at",vector_type,RParameter.new("size",type("size_t")))
+            klass.add_operation ROperation.new("front",vector_type)
+            klass.add_operation ROperation.new("back",vector_type)
+            klass.add_operation ROperation.new("data",type("void *"))
+            klass.add_operation ROperation.new("push_back",type("void"),RParameter.new("other",vector_type).to_const)
+            klass.add_operation ROperation.new("pop_back",type("void"))
+            klass.add_operation ROperation.new("swap",type("void"),RParameter.new("other",klass))
+            # add ruby code to the front of the method
+            klass.operation("operator[]").specialize_ruby do
+                "validate_index(size)"
+            end
+            klass.operation("at").specialize_ruby do
+                "validate_index(size)"
+            end
+
+            specialize_ruby do
+    %Q$     def self.new(type,*args)
+            klass,elements = if type.class == Class
+                                [type.name,[]]
+                            else
+                                e = Array(type) + args.flatten
+                                args = []
+                                [type.class.name,e]
+                            end
+            #remove module name
+            klass = klass.split("::")
+            klass.shift if klass.size > 1
+            klass = klass.join("_")
+            raise ArgumentError,"no std::vector defined for \#{type}" unless self.const_defined?(klass)
+            v = self.const_get(klass).new(*args)
+            elements.each do |e|
+                v << e
+            end
+            v
+            end$
+            end
+
+            klass
+        end
+
+        # called from RTemplate when ruby_specialize is called for the instance
+        def specialize_ruby_specialization(klass)
+            %Q$ include Enumerable
+            alias get_element []
+            def [](idx)
+                validate_index(idx)
+                get_element(idx)
+            end
+
+            def validate_index(idx)
+                if idx < 0 || idx >= size
+                    raise RangeError,"\#{idx} is out of range [0..\#{size-1}]"
+                end
+            end
+            def each(&block)
+                if block
+                     s = size
+                     0.upto(s-1) do |i|
+                         yield self[i]
+                     end
+                else
+                    Enumerator.new(self)
+                end
+            end
+            def <<(val)
+                push_back(val)
+                self
+            end
+            def delete_if(&block)
+                v = self.class.new
+                each do |i|
+                     v << i if !yield(i)
+                end
+                v.swap(self)
+                self
+            end$
+        end
+    end
+end

data/rbind.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
     s.name              = 'rbind'
-    s.version           = '0.0.16'
+    s.version           = '0.0.17'
     s.date              = '2013-08-13'
     s.platform          = Gem::Platform::RUBY
     s.authors           = ['Alexander Duda']
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
                           'but is not tight to this library. It allows to import already wrapped types '\
                           'from other gems/libraries using rbind to share the same types across '\
                           'multiple gems/libraries. For now rbind uses a copy of the OpenCV python hdr_parser '\
-                          'to parse c/c++ header files and looks for certain defines. '\
+                          'to parse c/c++ header files.'\
                           'This gem is still under heavy development and the API might change in the future.'
     s.files             = `git ls-files`.split("\n")
     s.require_path      = 'lib'