dub 0.7.0 → 1.0.0

data/History.txt

@@ -1,11 +1,24 @@
+== 1.0.0
+
+* Major enhancement
+  * Support for yaml definition of binding body.
+  * Support for superclass (reuse of definitions from the super class)
+  
+== 0.7.1
+
+The tests in this release do not pass, but the generator is really better and works. I just
+don't have the time to fix the tests.
+
+* Major enhancement
+  * When the object inherits from a LuaObject class, it calls luaInit(L, obj, "foo.Bar")
+
 == 0.7.0 2011-08-19
 
 The tests in this release do not pass, but the generator is really better and works. I just
 don't have the time to fix the tests.
 
 * Major enhancements
-  * Support for finding userdata from lua table in checkuserdata.
-  * Support to access userdata with 'super'.
+  * Support for finding userdata from lua table ('super').
 
 == 0.6.7
 

data/README.rdoc

@@ -21,7 +21,13 @@ Currently, the parser supports:
  * class enums
  * namespace enums
  * group constant defines
+ * bindings for superclass
+ * hand made bindings in yaml (this is used to do more 'natural' bindings for
+   the target language)
  * well tested
+   in fact no, it was but the tests are not up to date and need fixing
+   our best testing is that bindings run and compile without a warning or bug.
+
 
 If you are not good at reading lists, here is an example of the kind of tricks Dub plays with types:
 
@@ -62,6 +68,8 @@ Then you can write settings in the class documentation:
    *
    * @dub string_format:'%%f'
    *      string_args:'(*userdata)->interval()'
+   *      super: 'QObject, QWidget'
+   *      bind: 'Foobar.yml'
    */
 
 Note that for some strange reason, you have to use a double '%' to get one.

data/dub.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dub}
-  s.version = "0.7.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Gaspard Bucher}]
-  s.date = %q{2011-08-19}
+  s.date = %q{2011-09-04}
   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}
@@ -39,6 +39,8 @@ Gem::Specification.new do |s|
     "lib/dub/lua/group.cpp.erb",
     "lib/dub/lua/lua_cpp_helper.cpp",
     "lib/dub/lua/lua_cpp_helper.h",
+    "lib/dub/lua/lua_object.cpp",
+    "lib/dub/lua/lua_object.h",
     "lib/dub/lua/namespace.cpp.erb",
     "lib/dub/lua/namespace_gen.rb",
     "lib/dub/member_extraction.rb",

data/lib/dub/argument.rb

@@ -59,7 +59,6 @@ module Dub
         group.each do |function|
           insert_by_arg(hash, function)
         end
-        print(hash.inspect) if group.first.name == 'bind'
         hash
       end
 

data/lib/dub/function.rb

@@ -49,6 +49,10 @@ module Dub
       @throw != :nothing
     end
 
+    def custom_body(lang)
+      klass ? klass.custom_bind(lang)[self.name] : nil
+    end
+
     def static?
       @is_static
     end

data/lib/dub/klass.rb

@@ -1,3 +1,4 @@
+require 'yaml'
 module Dub
   module MemberExtraction
   end
@@ -7,7 +8,7 @@ require 'dub/member_extraction'
 module Dub
   class Klass
     include MemberExtraction
-    attr_reader :name, :xml, :prefix, :constructor, :alias_names, :enums, :parent, :instanciations
+    attr_reader :name, :xml, :prefix, :constructor, :alias_names, :enums, :ancestors, :parent, :instanciations
     attr_accessor :opts
 
     def initialize(parent, name, xml, prefix = '')
@@ -58,9 +59,27 @@ module Dub
     def members
       list = super(@ignores)
       if self.generator
-        @gen_members ||= self.generator.members_list(list.reject {|m| m.constructor?})
-      else
-        list
+        list = @gen_members ||= self.generator.members_list(list.reject {|m| m.constructor?})
+      end
+      # Copy members from super classes
+      superclasses = (@opts[:super] || '').split(',').map(&:strip)
+      @super_members ||= superclasses.map do |id_name|
+        if id_name =~ /([^\.])\.(.*)/
+          namespace = Dub::Namespace.find($1)
+          class_name = $2
+        else
+          namespace = self.parent
+          class_name = id_name
+        end
+        if x = namespace[class_name]
+          x.members
+        else
+          Dub.logger.warn "Could not find superclass '#{id_name}'"
+          nil
+        end
+      end.compact.flatten
+      (list + @super_members).sort do |a,b|
+        a.name <=> b.name
       end
     end
 
@@ -165,9 +184,33 @@ module Dub
       [@name] + @alias_names
     end
 
+    # Uses the bind declaration to read function bodies from a yml file:
+    # @dub bind: Foo.yml
+    def custom_bind(lang)
+      if !@bind_hash then
+        if file = @opts[:bind] then
+          header = (@xml/'location').first[:file]
+          path = header.split('/')
+          path.pop
+          path = (path + [file]).join('/')
+          if File.exist?(path) then
+            data = File.read(path)
+            @bind_hash = YAML::load(data)
+          else
+            @bind_hash = {}
+            Dub.logger.warn "Missing binding file '#{path}'"
+          end
+        else
+          @bind_hash = {}
+        end
+      end
+      @bind_hash[lang] ||= {}
+    end
+
     private
       def parse_xml
         parse_opts_hash
+        parse_ancestors
         parse_enums
         parse_members
         parse_template_params
@@ -192,6 +235,10 @@ module Dub
         @enums = (@xml/"enumvalue/name").map{|e| e.innerHTML}
       end
 
+      def parse_ancestors
+        @ancestors = (@xml/'inheritancegraph'/'label').map{|a| a.innerHTML}
+      end
+
       def parse_template_params
         template_params = (@xml/'/templateparamlist/param')
         if !template_params.empty?
@@ -288,4 +335,4 @@ module Dub
       end
 
   end
-end
+end

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

@@ -2,6 +2,9 @@
 
 #include "lua_cpp_helper.h"
 
+<%# We need this to serialize superclass members properly %>
+<% Lua.function_generator.klass = @class %>
+
 <% if @class.prefix %>
 using namespace <%= @class.prefix %>;
 <% end %>

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

@@ -4,9 +4,9 @@
   try {
 <%= indent(body(@function, 'dub'), 4) %>
   } catch (std::exception &e) {
-    lua_pushfstring(L, "<%= @function.id_name %>: %s", e.what());
+    lua_pushfstring(L, "<%= @function.name %>: %s", e.what());
   } catch (...) {
-    lua_pushfstring(L, "<%= @function.id_name %>: Unknown exception");
+    lua_pushfstring(L, "<%= @function.name %>: Unknown exception");
   }
   return lua_error(L);
 <% else -%>

data/lib/dub/lua/function_gen.rb

@@ -3,8 +3,10 @@ require 'erb'
 
 module Dub
   module Lua
+    SELF = "self"
     class FunctionGen < Dub::Generator
-      attr_accessor :template_path
+      # klass is used when parsing members from the superclasses.
+      attr_accessor :template_path, :klass
 
       NUMBER_TYPES = [
         'float',
@@ -135,44 +137,56 @@ module Dub
         res = []
         delta_top = 0
         if func.member_method? && !func.constructor? && !func.static?
-          klass = func.parent
-          res << "#{klass.name} *self__ = *((#{klass.name}**)#{check_prefix}L_checksdata(L, 1, #{klass.id_name.inspect}));"
+          # Force @klass when serializing members from superclass.
+          klass = @klass || func.parent
+          res << "#{klass.name} *#{SELF} = *((#{klass.name}**)#{check_prefix}L_checksdata(L, 1, #{klass.id_name.inspect}));"
           if func.member_method? && func.klass.custom_destructor?
             # protect calls
             if check_prefix == 'dub'
               # we cannot use luaL_error
-              res << "if (!self__) throw dub::Exception(\"Using deleted #{klass.id_name} in #{func.name}\");"
+              res << "if (!#{SELF}) throw dub::Exception(\"Using deleted #{klass.id_name} in #{func.name}\");"
             else
-              res << "if (!self__) return luaL_error(L, \"Using deleted #{klass.id_name} in #{func.name}\");"
+              res << "if (!#{SELF}) return luaL_error(L, \"Using deleted #{klass.id_name} in #{func.name}\");"
             end
           end
           delta_top = 1
         end
-
-        if func.has_default_arguments?
-          res << "int top__ = lua_gettop(L);"
-          if return_value = func.return_value
-            res << "#{return_value.create_type} retval__;"
-          end
-        end
+        
+        custom_body = func.custom_body('lua')
 
         if_indent = 0
-        func.arguments.each_with_index do |arg, i|
-          if arg.has_default?
-            res << indent("if (top__ < #{i+1+delta_top}) {",     if_indent)
-            res << indent("  #{call_string(func, i)}", if_indent)
-            res << indent("} else {", if_indent)
-            if_indent += 2
+        if custom_body && func.has_default_arguments?
+          # we do not prepare arguments
+        else
+          if func.has_default_arguments?
+            res << "int top__ = lua_gettop(L);"
+            if return_value = func.return_value
+              res << "#{return_value.create_type} retval__;"
+            end
+          end
+          func.arguments.each_with_index do |arg, i|
+            if arg.has_default?
+              res << indent("if (top__ < #{i+1+delta_top}) {",     if_indent)
+              res << indent("  #{call_string(func, i)}", if_indent)
+              res << indent("} else {", if_indent)
+              if_indent += 2
+            end
+            res << indent(get_arg(arg, i + 1 + delta_top, check_prefix), if_indent)
           end
-          res << indent(get_arg(arg, i + 1 + delta_top, check_prefix), if_indent)
         end
-        res << indent(call_string(func, func.arguments.count), if_indent)
+        if custom_body
+          res << indent(custom_body, if_indent)
+        else
+          res << indent(call_string(func, func.arguments.count), if_indent)
+        end
         while if_indent > 0
           if_indent -= 2
           res << indent("}", if_indent)
         end
 
-        res << return_value(func)
+        unless custom_body
+          res << return_value(func)
+        end
         res.join("\n")
       end
 
@@ -197,7 +211,7 @@ module Dub
         if func.constructor?
           call_string = "new #{call_string}"
         elsif func.member_method? && !func.static?
-          call_string = "self__->#{call_string}"
+          call_string = "#{SELF}->#{call_string}"
         end
 
 
@@ -228,7 +242,11 @@ module Dub
           else
             pushclass = 'lua_pushclass'
             if func.constructor?
-              if func.klass.custom_destructor?
+              if ctor_with_lua_init?(func)
+                res << "// The class inherits from 'LuaCallback', use lua_init instead of pushclass."
+                res << "return retval__->luaInit(L, retval__, \"#{return_value.id_name}\");"
+                return res.join("\n")
+              elsif func.klass.custom_destructor?
                 # Use special pushclass to set userdata
                 pushclass = 'lua_pushclass2'
               end
@@ -296,6 +314,16 @@ module Dub
         @function_template = ::ERB.new(File.read(@template_path ||File.join(File.dirname(__FILE__), 'function.cpp.erb')), nil, '%<>-')
         @group_template    = ::ERB.new(File.read(File.join(File.dirname(__FILE__), 'group.cpp.erb')))
       end
+
+      def ctor_with_lua_init?(func)
+        # If the class inherits from LuaObject, we need to use
+        # s->lua_init(L); instead of pushclass.
+        if func.constructor?
+          func.klass.ancestors.detect{|a| a =~ /LuaObject/}
+        else
+          false
+        end
+      end
     end # FunctionGen
   end # Lua
 end # Dub

data/lib/dub/lua/lua_cpp_helper.cpp

@@ -98,6 +98,9 @@ void *dubL_checksdata(lua_State *L, int ud, const char *tname) throw(dub::TypeEx
       }
     }
   } else if (lua_istable(L, ud)) {
+    if (ud < 0) {
+      ud = lua_gettop(L) + 1 + ud;
+    }
     // get p from super
     // ... <ud> ...
     // TODO: optimize by storing key in registry ?
@@ -135,6 +138,9 @@ void *dubL_checksdata_n(lua_State *L, int ud, const char *tname) throw() {
       }
     }
   } else if (lua_istable(L, ud)) {
+    if (ud < 0) {
+      ud = lua_gettop(L) + 1 + ud;
+    }
     // get p from super
     // ... <ud> ...
     // TODO: optimize by storing key in registry ?
@@ -250,3 +256,4 @@ void register_mt(lua_State *L, const char *libname, const char *class_name) {
   // <mt>
 }
 
+

data/lib/dub/lua/lua_object.cpp

@@ -0,0 +1,158 @@
+/*
+  ==============================================================================
+
+   This file is part of the LUBYK project (http://lubyk.org)
+   Copyright (c) 2007-2011 by Gaspard Bucher (http://teti.ch).
+
+  ------------------------------------------------------------------------------
+
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+   of this software and associated documentation files (the "Software"), to deal
+   in the Software without restriction, including without limitation the rights
+   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+   copies of the Software, and to permit persons to whom the Software is
+   furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included in
+   all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+   THE SOFTWARE.
+
+  ==============================================================================
+*/
+#include "lua_object.h"
+#include "lua_cpp_helper.h"
+
+using namespace dub;
+
+LuaObject::LuaObject() throw () :
+  lua_(NULL) {
+}
+
+int LuaObject::lua_init(lua_State *L, const char *type_name) throw() {
+  // ... <self> or new table
+  setupSuper(L); // creates self if there is no table (without a 'super' field)
+  // ... <self>.super = userdata
+  // ... <self> <udata>
+
+  setupMetatable(L, type_name);
+  // ... <self> <udata>
+  
+  setupLuaThread(L);
+  // <self>
+  return 1;
+}
+
+void LuaObject::setupSuper(lua_State *L) throw() {
+  if (!lua_istable(L, -1)) {
+    lua_newtable(L);
+  }
+  // ... <self>
+  LuaObject **userdata = (LuaObject**)lua_newuserdata(L, sizeof(LuaObject*));
+  *userdata = this;
+  // ... <self> <udata>
+  lua_pushlstring(L, "super", 5);
+  // ... <self> <udata> <"super">
+  lua_pushvalue(L, -2);
+  // ... <self> <udata> <"super"> <udata>
+  lua_rawset(L, -4);
+  // self.super = udata
+  // ... <self> <udata>
+}
+
+void LuaObject::setupMetatable(lua_State *L, const char *type_name) throw() {
+  // set metatable
+  luaL_getmetatable(L, type_name);
+  // ... <self> <udata> <mt>
+  lua_pushvalue(L, -1);
+  // ... <self> <udata> <mt> <mt>
+  lua_setmetatable(L, -3);
+  // ... <self> <udata> <mt>
+  lua_setmetatable(L, -3);
+  // ... <self> <udata>
+}
+
+// dependency relationship:
+// self.super ---> udata ---> fenv ---> thread ---> self
+//
+//   Thanks to Robert G. Jakabosky for the idea to use lua_xmove
+//   instead of weak tables to store the function reference.
+void LuaObject::setupLuaThread(lua_State *L) throw() {
+  // ... <self> <udata>
+  lua_getfenv(L, -1);
+  // ... <self> <udata> <env>
+  lua_pushstring(L, ".");
+  // ... <self> <udata> <env> "."
+  lua_rawget(L, -2); // <env>["."]
+  // ... <self> <udata> <env> <??>
+  if (!lua_rawequal(L, -1, -3)) {
+    // ... <self> <udata> <env> <nil>
+    // does not have it's own env table
+    lua_pop(L, 2);
+    // ... <self> <udata>
+    // Create env table
+    lua_newtable(L);
+    // ... <self> <udata> <env>
+    lua_pushstring(L, ".");
+    // ... <self> <udata> <env> "."
+    lua_pushvalue(L, -3);
+    // ... <self> <udata> <env> "." <udata>
+    lua_rawset(L, -3); // env["."] = udata
+    // ... <self> <udata> <env>
+    lua_pushvalue(L, -1);
+    // ... <self> <udata> <env> <env>
+    if (!lua_setfenv(L, -3)) {
+      luaL_error(L, "Could not set userdata env on '%s'.", lua_typename(L, lua_type(L, -3)));
+    }
+    // ... <self> <udata> <env>
+  } else {
+    // ... <self> <udata> <env> <self>
+    // has its own env table
+    lua_pop(L, 1);
+    // ... <self> <udata> <env>
+  }
+
+  // ... <self> <udata> <env>
+  if (lua_) {
+    // remove from env
+    luaL_unref(L, -1, thread_in_env_idx_);
+  }
+
+  lua_ = lua_newthread(L);
+  // ... <self> <udata> <env> <thread>
+
+  // Store the thread in the Thread/Socket's environment table so it is not GC too soon
+  thread_in_env_idx_ = luaL_ref(L, -2);
+  // ... <self> <udata> <env>
+
+  lua_pop(L, 2);
+  // ... <self>
+
+  // Transfer copies of <self> to thread stack
+  lua_pushvalue(L, -1);
+  // ... <self> <self>
+  lua_xmove(L, lua_, 1);
+  // ... <self>
+
+  // lua_ stack is now
+  // <self>
+
+  // L is now
+  // <self>
+}
+
+void LuaObject::pushLuaCallback(const char *method, int len) const {
+  // <self>
+  lua_pushlstring(lua_, method, len);
+  // <self> <"method">
+  lua_gettable(lua_, -2);
+  // <self> <?>
+  lua_pushvalue(lua_, 1);
+  // <self> <?> <self>
+}

data/lib/dub/lua/lua_object.h

@@ -0,0 +1,69 @@
+/*
+  ==============================================================================
+
+   This file is part of the LUBYK project (http://lubyk.org)
+   Copyright (c) 2007-2011 by Gaspard Bucher (http://teti.ch).
+
+  ------------------------------------------------------------------------------
+
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+   of this software and associated documentation files (the "Software"), to deal
+   in the Software without restriction, including without limitation the rights
+   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+   copies of the Software, and to permit persons to whom the Software is
+   furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included in
+   all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+   THE SOFTWARE.
+
+  ==============================================================================
+*/
+#ifndef INCLUDE_DUB_LUA_OBJECT_H_
+#define INCLUDE_DUB_LUA_OBJECT_H_
+
+namespace dub {
+/** Calls a lua function back.
+ */
+class LuaObject
+{
+public:
+  /** Prepare tables to work with the table based self idion.
+   * expects stack to be:
+   * ... self
+   * if self (last argument) is a table, it is used as self. 
+   * Otherwise, a new table is created.
+   * The method leaves "self" on top of the stack, with self.super = this.
+   */
+  LuaObject() throw();
+  
+  int lua_init(lua_State *L, const char *type_name) throw();
+
+  virtual ~LuaObject() {}
+
+  /** The caller should lock before calling this.
+   * TODO: The 'const' stuff is stupid: can't we remove it ?
+   */
+  void pushLuaCallback(const char *method, int len) const;
+
+  lua_State *lua_;
+
+private:
+
+  int thread_in_env_idx_;
+
+  void setupSuper(lua_State *L) throw();
+  void setupMetatable(lua_State *L, const char *type_name) throw() ;
+  void setupLuaThread(lua_State *L) throw();
+};
+
+} // dub
+
+#endif // INCLUDE_DUB_LUA_OBJECT_H_

data/lib/dub/namespace.rb

@@ -3,10 +3,17 @@ require 'dub/member_extraction'
 module Dub
 
   class Namespace
+    @@namespaces = {}
+
+    def self.find(name)
+      @@namespaces[name]
+    end
+
     include MemberExtraction
     attr_accessor :name, :gen, :xml, :enums, :parent, :header, :prefix, :defines
 
     def initialize(name, xml, current_dir)
+      @@namespaces[name] = self
       @name, @xml, @current_dir = name, xml, current_dir
       @class_alias = {}
       @alias_names = []

data/lib/dub/version.rb

@@ -1,3 +1,3 @@
 module Dub
-  VERSION = '0.7.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dub
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 7
   - 0
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Gaspard Bucher
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-19 00:00:00 Z
+date: 2011-09-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
@@ -78,6 +78,8 @@ files:
 - lib/dub/lua/group.cpp.erb
 - lib/dub/lua/lua_cpp_helper.cpp
 - lib/dub/lua/lua_cpp_helper.h
+- lib/dub/lua/lua_object.cpp
+- lib/dub/lua/lua_object.h
 - lib/dub/lua/namespace.cpp.erb
 - lib/dub/lua/namespace_gen.rb
 - lib/dub/member_extraction.rb