mkmf-lite 0.2.1 → 0.2.2

data/CHANGES

@@ -1,3 +1,8 @@
+= 0.2.2 - 6-Dec-2011
+* Added the check_sizeof method.
+* If CONFIG['COMMON_HEADERS'] is blank then stdio.h and stdlib.h are
+  used instead. On MS Windows the windows.h header is also used.
+
 = 0.2.1 - 21-Jan-2011
 * Minor platform detection adjustments for MS Windows.
 

data/lib/mkmf/lite.rb

@@ -3,10 +3,16 @@ require 'rbconfig'
 require 'tmpdir'
 require 'ptools'
 
+if File::ALT_SEPARATOR && RUBY_VERSION.to_f < 1.9
+  require 'win32/open3'
+else
+  require 'open3'
+end
+
 module Mkmf
   module Lite
     # The version of the mkmf-lite library
-    MKMF_LITE_VERSION = '0.2.1'
+    MKMF_LITE_VERSION = '0.2.2'
 
     @@cpp_command = Config::CONFIG['CC'] || Config::CONFIG['CPP']
     @@cpp_outfile = Config::CONFIG['CPPOUTFILE'] || "-o conftest.i"
@@ -62,7 +68,7 @@ module Mkmf
     end
 
     # Checks whether or not the struct of type +struct_type+ contains the
-    # +struct_member+.  If it does not, or the struct type cannot be found,
+    # +struct_member+. If it does not, or the struct type cannot be found,
     # then false is returned.
     #
     # An optional list of +headers+ may be specified, in addition to the
@@ -76,6 +82,27 @@ module Mkmf
       try_to_compile(code)
     end
 
+    # Returns the sizeof +type+ using +headers+, or common headers if no
+    # headers are specified.
+    #
+    # If this method fails an error is raised. This could happen if the type
+    # can't be found and/or the header files do not include the indicated type.
+    #
+    # Example:
+    #
+    #   class Foo
+    #     include Mkmf::Lite
+    #     utsname = check_sizeof('struct utsname', 'sys/utsname.h')
+    #   end
+    #
+    def check_sizeof(type, headers = [])
+      headers = get_header_string(headers)
+      erb = ERB.new(read_template('check_sizeof.erb'))
+      code = erb.result(binding)
+
+      try_to_execute(code)
+    end
+
     private
 
     # Take an array of header file names (or convert it to an array if it's a
@@ -92,8 +119,13 @@ module Mkmf
 
       common_headers = Config::CONFIG['COMMON_HEADERS']
 
-      unless common_headers.nil? || common_headers.empty?
-        headers += Config::CONFIG['COMMON_HEADERS'].split
+      if common_headers.nil? || common_headers.empty?
+        if headers.empty?
+          headers = ['stdio.h', 'stdlib.h']
+          headers += 'windows.h' if File::ALT_SEPARATOR
+        end
+      else
+        headers += common_headers.split
       end
 
       headers = headers.flatten.uniq
@@ -102,6 +134,49 @@ module Mkmf
       headers
     end
 
+    # Create a temporary bit of C source code in the temp directory, and
+    # try to compile it. If it succeeds attempt to run the generated code.
+    # The code generated is expected to print a number to STDOUT, which
+    # is then grabbed and returned as an integer.
+    #
+    # Note that $stderr is temporarily redirected to the null device because
+    # we don't actually care about the reason for failure, though a Ruby
+    # error is raised if the compilation step fails.
+    #
+    def try_to_execute(code)
+      begin
+        result = 0
+
+        stderr_orig = $stderr.dup
+
+        Dir.chdir(Dir.tmpdir){
+          File.open(@@cpp_srcfile, 'w'){ |fh| fh.write(code) }
+
+          command  = @@cpp_command + ' '
+          command += @@cpp_outfile + ' '
+          command += @@cpp_srcfile
+
+          $stderr.reopen(File.null)
+
+          if system(command)
+            Open3.popen3("./conftest.i") do |stdin, stdout, stderr|
+              stdin.close
+              stderr.close
+              result = stdout.gets.chomp.to_i
+            end
+          else
+            raise "Failed to compile source code:\n===\n" + code + "==="
+          end
+        }
+      ensure
+        File.delete(@@cpp_srcfile) if File.exists?(@@cpp_srcfile)
+        File.delete(@@cpp_outfile) if File.exists?(@@cpp_outfile)
+        $stderr.reopen(stderr_orig)
+      end
+
+      result
+    end
+
     # Create a temporary bit of C source code in the temp directory, and
     # try to compile it. If it succeeds, return true. Otherwise, return
     # false.

data/lib/mkmf/templates/check_sizeof.erb

@@ -0,0 +1,10 @@
+#include <stdio.h>
+
+<%= headers %>
+
+int conftest_const = (int)(sizeof(<%= type %>));
+
+int main(){
+  printf("%d\n", conftest_const);
+  return 0;
+}

data/mkmf-lite.gemspec

@@ -3,7 +3,7 @@ require 'rubygems'
 Gem::Specification.new do |spec|
   spec.name      = 'mkmf-lite'
   spec.summary   = 'A lighter version of mkmf designed for use as a library'
-  spec.version   = '0.2.1'
+  spec.version   = '0.2.2'
   spec.author    = 'Daniel J. Berger'
   spec.license   = 'Artistic 2.0'
   spec.email     = 'djberg96@gmail.com'

data/test/test_mkmf_lite.rb

@@ -22,7 +22,7 @@ class TC_Mkmf_Lite < Test::Unit::TestCase
   end
 
   test "version information" do
-    assert_equal('0.2.1', MKMF_LITE_VERSION)
+    assert_equal('0.2.2', MKMF_LITE_VERSION)
   end
 
   test "have_header basic functionality" do
@@ -82,6 +82,31 @@ class TC_Mkmf_Lite < Test::Unit::TestCase
     }
   end
 
+  test "check_sizeof basic functionality" do
+    assert_respond_to(self, :check_sizeof)
+    assert_nothing_raised{ check_sizeof('struct passwd', 'pwd.h') }
+  end
+
+  test "check_sizeof requires at least one argument" do
+    assert_raise(ArgumentError){ check_sizeof }
+    assert_raise(ArgumentError){ check_sizeof('struct passwd', 'pw_name', 1) }
+  end
+
+  test "check_sizeof accepts a maximum of two arguments" do
+    assert_raise(ArgumentError){ check_sizeof('div_t', 'stdlib.h', 1) }
+  end
+
+  test "check_sizeof works with one or two arguments" do
+    assert_nothing_raised{ check_sizeof('div_t') }
+    assert_nothing_raised{ check_sizeof('div_t', 'stdlib.h') }
+  end
+
+  test "check_sizeof returns an integer value" do
+    size = check_sizeof('struct passwd', 'pwd.h')
+    assert_kind_of(Integer, size)
+    assert_true(size > 0)
+  end
+
   def teardown
     @st_type   = nil
     @st_member = nil

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mkmf-lite
 version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-21 00:00:00 -07:00
-default_executable: 
+date: 2011-12-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ptools
@@ -61,6 +60,7 @@ extra_rdoc_files:
 files: 
 - CHANGES
 - lib/mkmf/lite.rb
+- lib/mkmf/templates/check_sizeof.erb
 - lib/mkmf/templates/have_func.erb
 - lib/mkmf/templates/have_func_pointer.erb
 - lib/mkmf/templates/have_header.erb
@@ -70,7 +70,6 @@ files:
 - Rakefile
 - README
 - test/test_mkmf_lite.rb
-has_rdoc: true
 homepage: http://www.rubyforge.org/projects/shards
 licenses: 
 - Artistic 2.0
@@ -100,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: shards
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A lighter version of mkmf designed for use as a library