rufus-lua 0.1.0 → 1.0.0

data/CHANGELOG.txt

@@ -2,6 +2,14 @@
 = rufus-lua CHANGELOG.txt
 
 
+== rufus-lua - 1.0.0    not yet released
+
+- automatically creates lib table when defined Ruby function (callback)
+- implemented #[]=, #objlen and #size for table
+- fixed bug when pushing floats on the stack (float --> double)
+- added State#function for defining Ruby functions (callbacks) available via Lua
+
+
 == rufus-lua - 0.1.0    released 2009/03/16
 
 - initial release

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2009, John Mettraux, Alain Hoang.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.txt

@@ -3,15 +3,14 @@
 
 Lua embedded in Ruby, via Ruby FFI
 
-Tested with Ruby 1.8.6, Ruby 1.9.1p0 and JRuby 1.1.6
+Tested with
+  ruby 1.8.6, ruby 1.9.1p0, jruby 1.2.0
+  jruby 1.1.6 has an issue with errors raised inside of Ruby functions (callbacks)
 
 
 == Lua
 
-from 
-
-  http://www.lua.org/
-  http://www.lua.org/about.html
+http://www.lua.org/about.html says :
 
 """
 Lua is a powerful, fast, lightweight, embeddable scripting language.
@@ -19,6 +18,8 @@ Lua is a powerful, fast, lightweight, embeddable scripting language.
 Lua combines simple procedural syntax with powerful data description constructs based on associative arrays and extensible semantics. Lua is dynamically typed, runs by interpreting bytecode for a register-based virtual machine, and has automatic memory management with incremental garbage collection, making it ideal for configuration, scripting, and rapid prototyping. 
 """
 
+http://www.lua.org/
+
 
 == other Ruby and Lua bridges / connectors
 
@@ -46,18 +47,83 @@ then
 
   s.close
 
-rufus-lua's rdoc is at http://rufus.rubyforge.org/rufus-lua/
+
+=== binding Ruby code as Lua functions
+
+  require 'rubygems'
+  require 'rufus/lua'
+  
+  s = Rufus::Lua::State.new
+  
+  s.function 'key_up' do |table|
+    table.inject({}) do |h, (k, v)|
+      h[k.to_s.upcase] = v
+    end
+  end
+  
+  p s.eval(%{
+    local table = { CoW = 2, pigs = 3, DUCKS = 'none' }
+    return key_up(table) -- calling Ruby from Lua...
+  }).to_h
+    # => { 'COW' => 2.0, 'DUCKS => 'none', 'PIGS' => 3.0 }
+  
+  s.close
+
+
+It's OK to bind a function inside of a table (library) :
+
+  require 'rubygems'
+  require 'rufus/lua'
+  
+  s = Rufus::Lua::State.new
+
+  s.eval("rubies = {}")
+  s.function 'add' do |x, y|
+    x + y
+  end
+
+  s.eval("rubies.add(1, 2)")
+    # => 3.0
+
+  s.close
+
+
+You can omit the table definition (only 1 level allowed here though) :
+
+  require 'rubygems'
+  require 'rufus/lua'
+  
+  s = Rufus::Lua::State.new
+
+  s.function 'rubies.add' do |x, y|
+    x + y
+  end
+
+  s.eval("rubies.add(1, 2)")
+    # => 3.0
+
+  s.close
+  
+
+
+The specs contain more examples :
+
+http://github.com/jmettraux/rufus-lua/tree/master/spec/
+
+rufus-lua's rdoc is at :
+
+http://rufus.rubyforge.org/rufus-lua/
 
 
 == compiling liblua.dylib
 
 original instructions by Adrian Perez at :
 
-  http://lua-users.org/lists/lua-l/2006-09/msg00894.html
+http://lua-users.org/lists/lua-l/2006-09/msg00894.html
 
 get the source at 
 
-  http://www.lua.org/ftp/lua-5.1.4.tar.gz
+http://www.lua.org/ftp/lua-5.1.4.tar.gz
 
 then
 
@@ -83,6 +149,12 @@ The following gems are needed to run the specs
   install bacon
 
 
+== tested with
+
+ruby 1.8.6, ruby 1.9.1p0, jruby 1.2.0
+jruby 1.1.6 has an issue with errors raised inside of Ruby functions (callbacks)
+
+
 == dependencies
 
 the ruby gem 'ffi'
@@ -116,8 +188,9 @@ http://github.com/jmettraux/rufus-lua
 
 many thanks to the authors of Ruby FFI, and of Lua
 
-  http://kenai.com/projects/ruby-ffi/
-  http://lua.org/
+http://kenai.com/projects/ruby-ffi/
+
+http://lua.org/
 
 
 == authors
@@ -137,5 +210,5 @@ MIT
 
 Lua itself is licensed under the MIT license as well :
 
-  http://www.lua.org/license.html
+http://www.lua.org/license.html
 

data/TODO.txt

@@ -12,8 +12,12 @@
 [o] fib.lua, use local, bench ! (2 times faster almost)
 
 [ ] add GC control methods (Alain)
-[ ] Add method to disable GC
-[ ] Add method to enable GC
+[X] Add method to disable GC
+[X] Add method to enable GC
 [ ] Look at parameters in Lua GC that can be tweaked
 [ ] Add method to tune GC parameters
+[ ] Test whether GC is truly independent for each state
+
+[x] ruby callbacks (functions)
+[ ] ability to bind ruby functions (callbacks) inside of tables (modules)
 

data/lib/rufus/lua.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2009, John Mettraux, Alain Hoang.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

data/lib/rufus/lua/lib.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2009, John Mettraux, Alain Hoang.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -39,17 +39,20 @@ module Lua
     paths = Array(ENV['LUA_LIB'] || %w{
       /opt/local/lib/liblua.dylib
       /usr/local/lib/liblua.dylib
+      /opt/local/lib/liblua.so
       /usr/local/lib/liblua.so
     })
 
-    path = paths.find { |path| File.exist?(path) }
+    begin
 
-    raise(
-      "didn't find the lua dylib on your system, " +
-      "see http://rufus.rubyforge.org/rufus-lua/ to learn how to get it"
-    ) unless path
+      ffi_lib(*paths)
 
-    ffi_lib(path)
+    rescue LoadError => le
+      raise(
+        "didn't find the lua dylib on your system, " +
+        "see http://rufus.rubyforge.org/rufus-lua/ to learn how to get it"
+      )
+    end
 
     #
     # attach functions
@@ -64,7 +67,7 @@ module Lua
     #attach_function :lua_resume, [ :pointer, :int ], :int
 
     attach_function :lua_toboolean, [ :pointer, :int ], :int
-    attach_function :lua_tonumber, [ :pointer, :int ], :float
+    attach_function :lua_tonumber, [ :pointer, :int ], :double
     attach_function :lua_tolstring, [ :pointer, :int, :pointer ], :string
 
     attach_function :lua_type, [ :pointer, :int ], :int
@@ -77,12 +80,16 @@ module Lua
     attach_function :lua_getfield, [ :pointer, :int, :string ], :pointer
     attach_function :lua_gettable, [ :pointer, :int ], :void
 
+    attach_function :lua_createtable, [ :pointer, :int, :int ], :void
+    #attach_function :lua_newtable, [ :pointer ], :void
+    attach_function :lua_settable, [ :pointer, :int ], :void
+
     attach_function :lua_next, [ :pointer, :int ], :int
 
     attach_function :lua_pushnil, [ :pointer ], :pointer
     attach_function :lua_pushboolean, [ :pointer, :int ], :pointer
     attach_function :lua_pushinteger, [ :pointer, :int ], :pointer
-    attach_function :lua_pushnumber, [ :pointer, :float ], :pointer
+    attach_function :lua_pushnumber, [ :pointer, :double ], :pointer
     attach_function :lua_pushstring, [ :pointer, :string ], :pointer
 
     attach_function :lua_rawgeti, [ :pointer, :int, :int ], :void
@@ -91,6 +98,12 @@ module Lua
     attach_function :luaL_loadbuffer, [ :pointer, :string, :int, :string ], :int
     attach_function :luaL_ref, [ :pointer, :int ], :int
     attach_function :luaL_unref, [ :pointer, :int, :int ], :void
+
+    attach_function :lua_gc, [ :pointer, :int, :int ], :int
+
+    callback :cfunction, [ :pointer ], :int
+    attach_function :lua_pushcclosure, [ :pointer, :cfunction, :int ], :void
+    attach_function :lua_setfield, [ :pointer, :int, :string ], :void
   end
 end
 end

data/lib/rufus/lua/objects.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2009, John Mettraux, Alain Hoang.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -39,8 +39,10 @@ module Rufus::Lua
     attr_reader :ref
 
     def initialize (pointer)
+
       @pointer = pointer
       @ref = Lib.luaL_ref(@pointer, LUA_REGISTRYINDEX)
+        # this pops the object out of the stack !
     end
 
     #
@@ -190,13 +192,43 @@ module Rufus::Lua
       stack_pop
     end
 
-    #--
-    # TODO : implement (maybe)
     #
-    #def []= (k, v)
-    #  raise 'not yet !'
-    #end
-    #++
+    # Sets a value in the table
+    #
+    # TODO : have something for adding in the array part...
+    #
+    def []= (k, v)
+
+      load_onto_stack
+
+      stack_push(k)
+      stack_push(v)
+      Lib.lua_settable(@pointer, -3)
+
+      v
+    end
+
+    #
+    # Returns the size of the table, corresponds to the Lua '#' operator.
+    #
+    # Will thus return 0 if the table doesn't hold any value in its
+    # 'array' part.
+    #
+    def objlen
+
+      load_onto_stack
+      Lib.lua_objlen(@pointer, -1)
+    end
+
+    #
+    # Returns the real size of the table (number of entries + number of elements
+    # in array side)
+    #
+    def size
+
+      self.to_h.size
+    end
+    alias :length :size
 
     #
     # Returns a Ruby Hash instance representing this Lua table.
@@ -214,7 +246,10 @@ module Rufus::Lua
       while Lib.lua_next(@pointer, table_pos) != 0 do
 
         value = stack_fetch(-1)
+        value.load_onto_stack if value.is_a?(Ref)
+
         key = stack_fetch(-2)
+        key.load_onto_stack if key.is_a?(Ref)
 
         stack_unstack # leave key on top
 

data/lib/rufus/lua/state.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2009, John Mettraux, Alain Hoang.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -25,6 +25,8 @@
 
 module Rufus::Lua
 
+  VERSION = '1.0.0'
+
   #
   # An error class for this gem/library.
   #
@@ -46,6 +48,16 @@ module Rufus::Lua
     LUA_NOREF = -2
     LUA_REFNIL = -1
 
+    # Lua GC constants
+    LUA_GCSTOP = 0
+    LUA_GCRESTART = 1
+    LUA_GCCOLLECT = 2
+    LUA_GCCOUNT = 3
+    LUA_GCCOUNTB = 4
+    LUA_GCSTEP = 5
+    LUA_GCSETPAUSE = 6
+    LUA_GCSETSTEPMUL = 7
+
     TNONE = -1
     TNIL = 0
     TBOOLEAN = 1
@@ -57,6 +69,8 @@ module Rufus::Lua
     TUSERDATA = 7
     TTHREAD = 8
 
+    SIMPLE_TYPES = [ TNIL, TBOOLEAN, TNUMBER, TSTRING ]
+
     LUA_MULTRET = -1
 
     protected
@@ -99,11 +113,25 @@ module Rufus::Lua
       # warning : don't touch at stack[0]
 
       s = (1..stack_top).inject([]) { |a, i|
+
         type, tname = stack_type_at(i)
-        a << "#{i} : #{tname} (#{type})"
+
+        val = if type == TSTRING
+          "\"#{stack_fetch(i)}\""
+        elsif SIMPLE_TYPES.include?(type)
+          stack_fetch(i).to_s
+        elsif type == TTABLE
+          "(# is #{Lib.lua_objlen(@pointer, i)})"
+        else
+          ''
+        end
+
+        a << "#{i} : #{tname} (#{type}) #{val}"
         a
       }.reverse.join("\n")
+
       s += "\n" if s.length > 0
+
       s
     end
 
@@ -180,6 +208,11 @@ module Rufus::Lua
 
       new_top = stack_top - 1
       new_top = 0 if new_top < 0
+        #
+        # there are no safeguard in Lua, setting top to -2 work well
+        # when the stack is crowed, but it has bad side effects when the
+        # stack is empty... Now safeguarding by ourselves.
+
       Lib.lua_settop(@pointer, new_top)
     end
 
@@ -200,8 +233,8 @@ module Rufus::Lua
 
         when String then Lib.lua_pushstring(@pointer, o)
 
-        #when Hash then ...
-        #when Array then ...
+        when Hash then stack_push_hash(o)
+        when Array then stack_push_array(o)
 
         else raise(
           ArgumentError.new(
@@ -209,6 +242,36 @@ module Rufus::Lua
       end
     end
 
+    #
+    # Pushes a hash on top of the Lua stack.
+    #
+    def stack_push_hash (h)
+
+      Lib.lua_createtable(@pointer, 0, h.size)
+        # since we already know the size of the table...
+
+      h.each do |k, v|
+        stack_push(k)
+        stack_push(v)
+        Lib.lua_settable(@pointer, -3)
+      end
+    end
+
+    #
+    # Pushes an array on top of the Lua stack.
+    #
+    def stack_push_array (a)
+
+      Lib.lua_createtable(@pointer, a.size, 0)
+        # since we already know the size of the table...
+
+      a.each_with_index do |e, i|
+        stack_push(i)
+        stack_push(e)
+        Lib.lua_settable(@pointer, -3)
+      end
+    end
+
     #
     # Loads a Lua global value on top of the stack
     #
@@ -352,6 +415,85 @@ module Rufus::Lua
       k.index('.') ? self.eval("return #{k}") : get_global(k)
     end
 
+    #
+    # Binds a Ruby function (callback) in the top environment of Lua
+    #
+    #   require 'rubygems'
+    #   require 'rufus/lua'
+    #
+    #   s = Rufus::Lua::State.new
+    #
+    #   s.function 'key_up' do |table|
+    #     table.inject({}) do |h, (k, v)|
+    #       h[k.to_s.upcase] = v
+    #     end
+    #   end
+    #
+    #   p s.eval(%{
+    #     local table = {}
+    #     table['CoW'] = 2
+    #     table['pigs'] = 3
+    #     table['DUCKS'] = 'none'
+    #     return key_up(table)
+    #   }).to_h
+    #     # => { 'COW' => 2.0, 'DUCKS => 'none', 'PIGS' => 3.0 }
+    #
+    #   s.close
+    #
+    def function (name, &block)
+
+      raise 'please pass a block for the body of the function' unless block
+
+      callback = Proc.new do |state|
+
+        args = block.arity > 0 ?
+          (1..block.arity).collect { |i| stack_pop } :
+          []
+
+        result = block.call(*args)
+
+        if result.is_a?(Hash)
+          stack_push(result)
+          1
+        else
+          result = Array(result)
+          result.each { |e| stack_push(e) }
+          result.size
+        end
+      end
+
+      name = name.to_s
+
+      name, index = if ri = name.rindex('.')
+        #
+        # bind in the given table
+
+        table_name = name[0..ri-1]
+
+        t = self.eval("return #{table_name}") rescue nil
+
+        raise ArgumentError.new(
+          "won't create automatically nested tables"
+        ) if (not t) and table_name.index('.')
+
+        t = self.eval("#{table_name} = {}; return #{table_name}") \
+          unless t
+
+        t.send(:load_onto_stack)
+
+        [ name[ri+1..-1], -2 ]
+
+      else
+        #
+        # bind function at the global level
+
+        [ name, LUA_GLOBALSINDEX ]
+      end
+
+      Lib.lua_pushcclosure(@pointer, callback, 0)
+      Lib.lua_setfield(@pointer, index, name)
+    end
+
     #
     # Closes the state.
     #
@@ -360,7 +502,45 @@ module Rufus::Lua
     #
     def close
 
+      raise "State already closed" unless @pointer
       Lib.lua_close(@pointer)
+      @pointer = nil
+    end
+
+    #
+    # Returns current amount of memory in KB in use by Lua
+    #
+    def gc_count
+
+      raise "State got closed, cannot proceed" unless @pointer
+      Lib.lua_gc(@pointer, LUA_GCCOUNT, 0)
+    end
+
+    #
+    # Runs garbage collection
+    #
+    def gc_collect!
+
+      raise "State got closed, cannot proceed" unless @pointer
+      Lib.lua_gc(@pointer, LUA_GCCOLLECT, 0)
+    end
+
+    #
+    # Stop garbage collection for this state
+    #
+    def gc_stop
+
+      raise "State got closed, cannot proceed" unless @pointer
+      Lib.lua_gc(@pointer, LUA_GCSTOP, 0)
+    end
+
+    #
+    # Restart garbage collection for this state
+    #
+    def gc_resume
+
+      raise "State got closed, cannot proceed" unless @pointer
+      Lib.lua_gc(@pointer, LUA_GCRESTART, 0)
     end
   end
 end

data/lib/rufus/lua/utils.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2009, John Mettraux, Alain Hoang.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

data/t.txt

@@ -0,0 +1,24 @@
+$ ruby19 test/bm_fiber.rb
+                  user     system      total        real
+ruby          0.050000   0.010000   0.060000 (  0.054605)
+lua via ruby  0.180000   0.000000   0.180000 (  0.189010)
+lua           0.010000   0.000000   0.010000 (  0.005543)
+
+$ ruby19 test/bm_fiber.rb
+                  user     system      total        real
+ruby          0.050000   0.000000   0.050000 (  0.051531)
+lua via ruby  0.180000   0.010000   0.190000 (  0.194944)
+lua           0.010000   0.000000   0.010000 (  0.006325)
+
+$ ruby19 test/bm_fiber.rb
+                  user     system      total        real
+ruby          0.050000   0.010000   0.060000 (  0.052032)
+lua via ruby  0.180000   0.000000   0.180000 (  0.195411)
+lua           0.010000   0.000000   0.010000 (  0.006394)
+
+$ ruby19 test/bm_fiber.rb
+                  user     system      total        real
+ruby          0.050000   0.010000   0.060000 (  0.054892)
+lua via ruby  0.180000   0.000000   0.180000 (  0.267880)
+lua           0.000000   0.000000   0.000000 (  0.005865)
+

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-lua
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - John Mettraux
+- Alain Hoang
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-03-16 00:00:00 +09:00
+date: 2009-03-27 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,6 +45,7 @@ files:
 - CREDITS.txt
 - LICENSE.txt
 - README.txt
+- t.txt
 - TODO.txt
 has_rdoc: true
 homepage: http://rufus.rubyforge.org/