rufus-lua 1.1.0 → 1.1.1

data/lib/rufus/lua/lib.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009, John Mettraux, Alain Hoang.
+# Copyright (c) 2009-2014, 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
@@ -23,7 +23,6 @@
 #++
 
 
-#require 'rubygems' # done by the 'client' code
 require 'ffi'
 
 
@@ -36,26 +35,45 @@ module Lua
     #
     # locate the dynamic library
 
-    paths = Array(
+    paths =
       ENV['LUA_LIB'] ||
-      Dir.glob('/usr/lib/liblua*.so') +
-      Dir.glob('/usr/local/lib/liblua*.so') +
-      Dir.glob('/opt/local/lib/liblua*.so') +
-      Dir.glob('/usr/lib/liblua*.dylib') +
-      Dir.glob('/usr/local/lib/liblua*.dylib') +
-      Dir.glob('/opt/local/lib/liblua*.dylib'))
+        # developer points to the right lib
+      (
+        Dir.glob('/usr/lib/liblua*.so') +
+        Dir.glob('/usr/lib/*/liblua*.so') +
+        Dir.glob('/usr/local/lib/liblua*.so') +
+        Dir.glob('/opt/local/lib/liblua*.so') +
+        Dir.glob('/usr/lib/liblua*.dylib') +
+        Dir.glob('/usr/local/lib/liblua*.dylib') +
+        Dir.glob('/opt/local/lib/liblua*.dylib')
+      )
+        # or else we attempt to find it from potential locations
 
     begin
 
-      ffi_lib(*paths)
+      ffi_lib_flags(:lazy, :global)
+
+      ffi_lib(paths)
 
     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"
+
+      fail RuntimeError.new(
+        "Didn't find the Lua dynamic library on your system. " +
+        "Set LUA_LIB in your environment if have that library or " +
+        "go to https://github.com/jmettraux/rufus-lua to learn how to " +
+        "get it. (paths: #{paths.inspect})"
       )
     end
 
+    # Rufus::Lua::Lib.path returns the path to the library used.
+    #
+    def self.path
+
+      f = ffi_libraries.first
+
+      f ? f.name : nil
+    end
+
     #
     # attach functions
 
@@ -65,6 +83,7 @@ module Lua
 
     attach_function :luaL_openlibs, [ :pointer ], :void
 
+    attach_function :lua_call, [ :pointer, :int, :int ], :void
     %w[ base package string table math io os debug ].each do |libname|
       attach_function "luaopen_#{libname}", [ :pointer ], :void
     end
@@ -74,7 +93,7 @@ module Lua
 
     attach_function :lua_toboolean, [ :pointer, :int ], :int
     attach_function :lua_tonumber, [ :pointer, :int ], :double
-    attach_function :lua_tolstring, [ :pointer, :int, :pointer ], :string
+    attach_function :lua_tolstring, [ :pointer, :int, :pointer ], :pointer
 
     attach_function :lua_type, [ :pointer, :int ], :int
     attach_function :lua_typename, [ :pointer, :int ], :string
@@ -97,6 +116,7 @@ module Lua
     attach_function :lua_pushinteger, [ :pointer, :int ], :pointer
     attach_function :lua_pushnumber, [ :pointer, :double ], :pointer
     attach_function :lua_pushstring, [ :pointer, :string ], :pointer
+    attach_function :lua_pushlstring, [ :pointer, :pointer, :int ], :pointer
 
     attach_function :lua_rawgeti, [ :pointer, :int, :int ], :void
 

data/lib/rufus/lua/objects.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009, John Mettraux, Alain Hoang.
+# Copyright (c) 2009-2014, 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
@@ -37,7 +37,7 @@ module Rufus::Lua
     #
     attr_reader :ref
 
-    def initialize (pointer)
+    def initialize(pointer)
 
       @pointer = pointer
       @ref = Lib.luaL_ref(@pointer, LUA_REGISTRYINDEX)
@@ -60,7 +60,7 @@ module Rufus::Lua
     #
     def load_onto_stack
 
-      raise LuaError.new(
+      fail RuntimeError.new(
         "#{self.class} got freed, cannot re-access it directly"
       ) unless @ref
 
@@ -71,7 +71,6 @@ module Rufus::Lua
   #
   # A Lua function.
   #
-  #   require 'rubygems'
   #   require 'rufus/lua'
   #
   #   s = Rufus::Lua::State.new
@@ -88,7 +87,7 @@ module Rufus::Lua
 
     # Calls the Lua function.
     #
-    def call (*args)
+    def call(*args)
 
       bottom = stack_top
 
@@ -98,7 +97,7 @@ module Rufus::Lua
       args.each { |arg| stack_push(arg) }
         # push arguments on stack
 
-      pcall(bottom, args.length)
+      pcall(bottom, args.length, nil, nil, nil)
     end
   end
 
@@ -109,7 +108,7 @@ module Rufus::Lua
 
     # Resumes the coroutine
     #
-    def resume (*args)
+    def resume(*args)
 
       bottom = stack_top
 
@@ -118,7 +117,7 @@ module Rufus::Lua
       load_onto_stack
       args.each { |arg| stack_push(arg) }
 
-      pcall(bottom, args.length + 1)
+      pcall(bottom, args.length + 1, nil, nil, nil)
     end
 
     # Returns the string status of the coroutine :
@@ -131,7 +130,7 @@ module Rufus::Lua
       fetch_library_method('coroutine.status').load_onto_stack
       load_onto_stack
 
-      pcall(bottom, 1)
+      pcall(bottom, 1, nil, nil, nil)
     end
   end
 
@@ -175,7 +174,7 @@ module Rufus::Lua
 
     # Returns the value behind the key, or else nil.
     #
-    def [] (k)
+    def [](k)
 
       load_onto_stack # table
       stack_push(k) # key
@@ -187,7 +186,7 @@ module Rufus::Lua
     #
     # TODO : have something for adding in the array part...
     #
-    def []= (k, v)
+    def []=(k, v)
 
       load_onto_stack
 
@@ -282,7 +281,7 @@ module Rufus::Lua
     #   @s.eval("return { 1, 2, car = 'benz' }").to_a(false)
     #     # => [1.0, 2.0, ["car", "benz"]]
     #
-    def to_a (pure=true)
+    def to_a(pure=true)
 
       h = self.to_h
 

data/lib/rufus/lua/state.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009, John Mettraux, Alain Hoang.
+# Copyright (c) 2009-2014, 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,13 +25,6 @@
 
 module Rufus::Lua
 
-  VERSION = '1.1.0'
-
-  #
-  # An error class for this gem/library.
-  #
-  class LuaError < RuntimeError; end
-
   #
   # Rufus::Lua::Lib contains all the raw C API Lua methods. The methods
   # here are shared by all the rufus-lua classes that have to deal with
@@ -82,25 +75,25 @@ module Rufus::Lua
     #
     # (Not sure yet about this yet)
     #
-    def fetch_library_method (s)
+    def fetch_library_method(s)
 
-      if m = @pointer.__lib_method_cache[s]
-        m
-      else
-        @pointer.__lib_method_cache[s] = loadstring_and_call("return #{s}")
-      end
+      m = @pointer.__lib_method_cache[s]
+      return m if m
+
+      @pointer.__lib_method_cache[s] =
+        loadstring_and_call("return #{s}", nil, nil, nil)
     end
 
     # This method holds the 'eval' mechanism.
     #
-    def loadstring_and_call (s)
+    def loadstring_and_call(s, binding, filename, lineno)
 
       bottom = stack_top
 
       err = Lib.luaL_loadbuffer(@pointer, s, Lib.strlen(s), 'line')
-      raise_if_error('eval:compile', err)
+      fail_if_error('eval:compile', err, binding, filename, lineno)
 
-      pcall(bottom, 0) # arg_count is set to 0
+      pcall(bottom, 0, binding, filename, lineno) # arg_count is set to 0
     end
 
     # Returns a string representation of the state's stack.
@@ -134,7 +127,7 @@ module Rufus::Lua
 
     # Outputs the stack to the stdout
     #
-    def print_stack (msg=nil)
+    def print_stack(msg=nil)
 
       puts "\n=stack= #{msg ? "(#{msg})" : ""}"
       puts "top : #{stack_top}"
@@ -153,7 +146,7 @@ module Rufus::Lua
     # of the Lua state's stack. There is an optional pos paramter to peek
     # at other elements of the stack.
     #
-    def stack_type_at (pos=-1)
+    def stack_type_at(pos=-1)
 
       type = Lib.lua_type(@pointer, pos)
       tname = Lib.lua_typename(@pointer, type)
@@ -164,7 +157,7 @@ module Rufus::Lua
     # Fetches the top value on the stack (or the one specified by the optional
     # pos parameter), but does not 'pop' it.
     #
-    def stack_fetch (pos=-1)
+    def stack_fetch(pos=-1)
 
       type, tname = stack_type_at(pos)
 
@@ -172,7 +165,11 @@ module Rufus::Lua
 
         when TNIL then nil
 
-        when TSTRING then Lib.lua_tolstring(@pointer, pos, nil)
+        when TSTRING then
+          len = FFI::MemoryPointer.new(:size_t)
+          ptr = Lib.lua_tolstring(@pointer, pos, len)
+          ptr.read_string(len.read_long)
+
         when TBOOLEAN then (Lib.lua_toboolean(@pointer, pos) == 1)
         when TNUMBER then Lib.lua_tonumber(@pointer, pos)
 
@@ -211,7 +208,7 @@ module Rufus::Lua
 
     # Given a Ruby instance, will attempt to push it on the Lua stack.
     #
-    def stack_push (o)
+    def stack_push(o)
 
       return stack_push(o.to_lua) if o.respond_to?(:to_lua)
 
@@ -225,7 +222,7 @@ module Rufus::Lua
         when Fixnum then Lib.lua_pushinteger(@pointer, o)
         when Float then Lib.lua_pushnumber(@pointer, o)
 
-        when String then Lib.lua_pushstring(@pointer, o)
+        when String then Lib.lua_pushlstring(@pointer, o, o.unpack('C*').size)
         when Symbol then Lib.lua_pushstring(@pointer, o.to_s)
 
         when Hash then stack_push_hash(o)
@@ -239,7 +236,7 @@ module Rufus::Lua
 
     # Pushes a hash on top of the Lua stack.
     #
-    def stack_push_hash (h)
+    def stack_push_hash(h)
 
       Lib.lua_createtable(@pointer, 0, h.size)
         # since we already know the size of the table...
@@ -253,7 +250,7 @@ module Rufus::Lua
 
     # Pushes an array on top of the Lua stack.
     #
-    def stack_push_array (a)
+    def stack_push_array(a)
 
       Lib.lua_createtable(@pointer, a.size, 0)
         # since we already know the size of the table...
@@ -267,21 +264,21 @@ module Rufus::Lua
 
     # Loads a Lua global value on top of the stack
     #
-    def stack_load_global (name)
+    def stack_load_global(name)
 
       Lib.lua_getfield(@pointer, LUA_GLOBALSINDEX, name)
     end
 
     # Loads the Lua object registered with the given ref on top of the stack
     #
-    def stack_load_ref (ref)
+    def stack_load_ref(ref)
 
       Lib.lua_rawgeti(@pointer, LUA_REGISTRYINDEX, @ref)
     end
 
     # Returns the result of a function call or a coroutine.resume().
     #
-    def return_result (stack_bottom)
+    def return_result(stack_bottom)
 
       count = stack_top - stack_bottom
 
@@ -297,14 +294,14 @@ module Rufus::Lua
     #
     # Will raise an error in case of failure.
     #
-    def pcall (stack_bottom, arg_count)
+    def pcall(stack_bottom, arg_count, binding, filename, lineno)
 
       #err = Lib.lua_pcall(@pointer, 0, 1, 0)
         # when there's only 1 return value, use LUA_MULTRET (-1) the
         # rest of the time
 
       err = Lib.lua_pcall(@pointer, arg_count, LUA_MULTRET, 0)
-      raise_if_error('eval:pcall', err)
+      fail_if_error('eval:pcall', err, binding, filename, lineno)
 
       return_result(stack_bottom)
     end
@@ -313,9 +310,9 @@ module Rufus::Lua
     # Resumes a coroutine (that has been placed, under its arguments,
     # on top of the stack).
     #
-    #def do_resume (stack_bottom, arg_count)
+    #def do_resume(stack_bottom, arg_count)
     #  err = Lib.lua_resume(@pointer, arg_count)
-    #  raise_if_error('eval:resume', err)
+    #  fail_if_error('eval:resume', err, nil, nil, nil)
     #  return_result(stack_bottom)
     #end
     #++
@@ -323,7 +320,7 @@ module Rufus::Lua
     # This method will raise an error with err > 0, else it will immediately
     # return.
     #
-    def raise_if_error (where, err)
+    def fail_if_error(kind, err, binding, filename, lineno)
 
       return if err < 1
 
@@ -334,16 +331,16 @@ module Rufus::Lua
       #   the error handler function.
       # LUA_ERRERR: error while running the error handler function.
 
-      s = Lib.lua_tolstring(@pointer, -1, nil)
+      s = Lib.lua_tolstring(@pointer, -1, nil).read_string
       Lib.lua_settop(@pointer, -2)
 
-      raise LuaError.new("#{where} : '#{s}' (#{err})")
+      fail LuaError.new(kind, err, s, binding, filename, lineno)
     end
 
     # Given the name of a Lua global variable, will return its value (or nil
     # if there is nothing bound under that name).
     #
-    def get_global (name)
+    def get_global(name)
 
       stack_load_global(name)
       stack_pop
@@ -373,21 +370,11 @@ module Rufus::Lua
     # The list may include 'base', 'package', 'table', 'string', 'math', 'io',
     # 'os' and 'debug'.
     #
-    def initialize (include_libs=true)
+    def initialize(include_libs=true)
 
       @pointer = Lib.luaL_newstate
 
-      Array(include_libs).each do |libname|
-
-        if libname == false
-          break
-        elsif libname == true
-          Lib.luaL_openlibs(@pointer)
-          break
-        else
-          Lib.send("luaopen_#{libname}", @pointer)
-        end
-      end
+      open_libraries(include_libs)
 
       #
       # preparing library methods cache
@@ -406,9 +393,9 @@ module Rufus::Lua
 
     # Evaluates a piece (string) of Lua code within the state.
     #
-    def eval (s)
+    def eval(s, binding=nil, filename=nil, lineno=nil)
 
-      loadstring_and_call(s)
+      loadstring_and_call(s, binding, filename, lineno)
     end
 
     # Returns a value set at the 'global' level in the state.
@@ -416,9 +403,9 @@ module Rufus::Lua
     #   state.eval('a = 1 + 2')
     #   puts state['a'] # => "3.0"
     #
-    def [] (k)
+    def [](k)
 
-      k.index('.') ? self.eval("return #{k}") : get_global(k)
+      k.index('.') ?  self.eval("return #{k}") : get_global(k)
     end
 
     # Allows for setting a Lua varible immediately.
@@ -426,7 +413,7 @@ module Rufus::Lua
     #   state['var'] = [ 1, 2, 3 ]
     #   puts state['var'].to_a[0] # => 1
     #
-    def []= (k, v)
+    def []=(k, v)
 
       #puts; puts("#{k} = #{Rufus::Lua.to_lua_s(v)}")
       self.eval("#{k} = #{Rufus::Lua.to_lua_s(v)}")
@@ -434,7 +421,6 @@ module Rufus::Lua
 
     # Binds a Ruby function (callback) in the top environment of Lua
     #
-    #   require 'rubygems'
     #   require 'rufus/lua'
     #
     #   s = Rufus::Lua::State.new
@@ -474,7 +460,7 @@ module Rufus::Lua
     #   s.eval(return is_array({ 'a' = 'b' }))
     #     # => false
     #
-    def function (name, opts={}, &block)
+    def function(name, opts={}, &block)
 
       raise 'please pass a block for the body of the function' unless block
 
@@ -588,6 +574,39 @@ module Rufus::Lua
       raise "State got closed, cannot proceed" unless @pointer
       Lib.lua_gc(@pointer, LUA_GCRESTART, 0)
     end
+
+    # #open_library(libname) - load a lua library via lua_call().
+    #
+    # This is needed because is the Lua 5.1 Reference Manual Section 5
+    # (http://www.lua.org/manual/5.1/manual.html#5) it says:
+    #
+    # "The luaopen_* functions (to open libraries) cannot be called
+    # directly, like a regular C function. They must be called through
+    # Lua, like a Lua function."
+    #
+    # "..you must call them like any other Lua C function, e.g., by using
+    # lua_call."
+    #
+    # (by Matthew Nielsen - https://github.com/xunker)
+    #
+    def open_library(libname)
+
+      Lib.lua_pushcclosure(
+        @pointer, lambda { |ptr| Lib.send("luaopen_#{libname}", @pointer) }, 0)
+      Lib.lua_pushstring(
+        @pointer, (libname.to_s == "base" ? "" : libname.to_s))
+      Lib.lua_call(
+        @pointer, 1, 0)
+    end
+
+    def open_libraries(libs)
+
+      if libs == true
+        Lib.luaL_openlibs(@pointer)
+      elsif libs.is_a?(Array)
+        libs.each { |l| open_library(l) }
+      end
+    end
   end
 end