mkmf-lite 0.7.2 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e85aa72d40bbefbc3868cfce08cdadcd27f2715f96aead7b7055808ea724f5f
-  data.tar.gz: 415625060ad8e4d9d6998f581af4eeb0adb5c69f0a012a827956cfc19f173ff7
+  metadata.gz: 83a4d986b70bc7bcd5c5787245bd5b76f335dc6079124d6bdd18847b128dcb3c
+  data.tar.gz: c688342d4e86a77221dbbd2dd12fc3c3a77ac92892bb4aab230af11bc50ff5ec
 SHA512:
-  metadata.gz: af36e6b2ffc4d90cb1faf28ebe141547b2459819f95caf6b5dded3e51dce35667eb8ea9b0bf81443146495f42c341f56f81d27d3b7b3a7862e9c2a492b4c848d
-  data.tar.gz: f78fc8d5f051406690b1d7b1b362868be38fd25a45ad140cec40bc9aaf58d0ebdf2a2b53b5c0ca4660954266938be91405660bee3fe85ad0f3a340002d92e25b
+  metadata.gz: c36047013680595f8776cd8e87813ccf4fdf2aac43056d6ffc676c61c262f502e8c3114b3a09ca6b1610eede8ea6c3b59bce4e8631e0e785afd385c789d61aad
+  data.tar.gz: 0ef5c1481603d4ffdc840d6f468f4ddcaa0e03b81f2648e6395f48df72b21d772c24ff17638db365d2c1316f57e24cff8ac6880b7895b5710178625df43bf4be

data/CHANGES.md

@@ -1,3 +1,9 @@
+## 0.7.4 - 23-Dec-2025
+* Added have_library method.
+
+## 0.7.3 - 21-Mar-2025
+* Added check_offsetof method.
+
 ## 0.7.2 - 13-Mar-2025
 * Allow option of adding directories to check_sizeof and check_valueof methods.
 

data/README.md

@@ -54,7 +54,7 @@ JRuby may emit warnings on some platforms.
 Apache-2.0
 
 ## Copyright
-(C) 2010-2024 Daniel J. Berger
+(C) 2010-2025 Daniel J. Berger
 All Rights Reserved
 
 ## Warranty

data/Rakefile

@@ -24,7 +24,10 @@ end
 RuboCop::RakeTask.new
 
 desc "Run the test suite"
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+  t.rspec_opts = '-f documentation -w'
+end
 
 # Clean up afterwards
 Rake::Task[:spec].enhance do

data/conftest.c

@@ -0,0 +1,5 @@
+#include <foobar.h>
+
+int main(){
+  return 0;
+}

data/lib/mkmf/lite.rb

@@ -16,7 +16,7 @@ module Mkmf
     extend Memoist
 
     # The version of the mkmf-lite library
-    MKMF_LITE_VERSION = '0.7.2'
+    MKMF_LITE_VERSION = '0.7.4'
 
     private
 
@@ -25,15 +25,22 @@ module Mkmf
     end
 
     def jruby?
-      defined?(JRUBY_VERSION) ? true : false
+      defined?(JRUBY_VERSION)
     end
 
     memoize :jruby?
 
+    def windows_with_cl_compiler?
+      File::ALT_SEPARATOR && RbConfig::CONFIG['CPP']&.match?(/^cl/)
+    end
+
+    memoize :windows_with_cl_compiler?
+
     # rubocop:disable Layout/LineLength
     def cpp_command
       command = RbConfig::CONFIG['CC'] || RbConfig::CONFIG['CPP'] || File.which('cc') || File.which('gcc') || File.which('cl')
-      raise 'Compiler not found' unless command
+      raise StandardError, 'Compiler not found' unless command
+
       command
     end
     # rubocop:enable Layout/LineLength
@@ -45,7 +52,7 @@ module Mkmf
     end
 
     def cpp_out_file
-      if File::ALT_SEPARATOR && RbConfig::CONFIG['CPP'] =~ /^cl/
+      if windows_with_cl_compiler?
         '/Feconftest.exe'
       else
         '-o conftest.exe'
@@ -55,10 +62,9 @@ module Mkmf
     memoize :cpp_out_file
 
     def cpp_libraries
-      return if File::ALT_SEPARATOR && RbConfig::CONFIG['CPP'] =~ /^cl/
-      return if jruby?
+      return nil if windows_with_cl_compiler? || jruby?
 
-      if cpp_command =~ /clang/i
+      if cpp_command.match?(/clang/i)
         '-Lrt -Ldl -Lcrypt -Lm'
       else
         '-lrt -ldl -lcrypt -lm'
@@ -77,14 +83,7 @@ module Mkmf
     def have_header(header, *directories)
       erb = ERB.new(read_template('have_header.erb'))
       code = erb.result(binding)
-
-      if directories.empty?
-        options = nil
-      else
-        options = ''
-        directories.each{ |dir| options += "-I#{dir} " }
-        options.rstrip!
-      end
+      options = build_directory_options(directories)
 
       try_to_compile(code, options)
     end
@@ -112,6 +111,25 @@ module Mkmf
 
     memoize :have_func
 
+    # Check for the presence of the given +library+. You may optionally
+    # provide a +function+ name to check for within that library, as well
+    # as any additional +headers+.
+    #
+    # Returns true if the library can be linked, or false otherwise.
+    #
+    def have_library(library, function = nil, headers = [])
+      headers = get_header_string(headers)
+      erb = ERB.new(read_template('have_library.erb'))
+      code = erb.result(binding)
+
+      # Build link options with the library
+      link_options = windows_with_cl_compiler? ? "#{library}.lib" : "-l#{library}"
+
+      try_to_compile(code, nil, link_options)
+    end
+
+    memoize :have_library
+
     # 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,
     # then false is returned.
@@ -139,14 +157,7 @@ module Mkmf
       headers = get_header_string(headers)
       erb = ERB.new(read_template('check_valueof.erb'))
       code = erb.result(binding)
-
-      if directories.empty?
-        options = nil
-      else
-        options = ''
-        directories.each{ |dir| options += "-I#{dir} " }
-        options.rstrip!
-      end
+      options = build_directory_options(directories)
 
       try_to_execute(code, options)
     end
@@ -170,22 +181,73 @@ module Mkmf
       headers = get_header_string(headers)
       erb = ERB.new(read_template('check_sizeof.erb'))
       code = erb.result(binding)
-
-      if directories.empty?
-        options = nil
-      else
-        options = ''
-        directories.each{ |dir| options += "-I#{dir} " }
-        options.rstrip!
-      end
+      options = build_directory_options(directories)
 
       try_to_execute(code, options)
     end
 
     memoize :check_sizeof
 
+    # Returns the offset of +field+ within +struct_type+ using +headers+,
+    # or common headers, plus stddef.h, if no headers are specified.
+    #
+    # If this method fails an error is raised. This could happen if the field
+    # can't be found and/or the header files do not include the indicated type.
+    # It will also fail if the field is a bit field.
+    #
+    # Example:
+    #
+    #   class Foo
+    #     include Mkmf::Lite
+    #     utsname = check_offsetof('struct utsname', 'release', 'sys/utsname.h')
+    #   end
+    #
+    def check_offsetof(struct_type, field, headers = [], *directories)
+      headers = get_header_string(headers)
+      erb = ERB.new(read_template('check_offsetof.erb'))
+      code = erb.result(binding)
+      options = build_directory_options(directories)
+
+      try_to_execute(code, options)
+    end
+
+    memoize :check_offsetof
+
     private
 
+    def build_directory_options(directories)
+      return nil if directories.empty?
+
+      directories.map { |dir| "-I#{dir}" }.join(' ')
+    end
+
+    def build_compile_command(command_options = nil, library_options = nil)
+      command_parts = [cpp_command]
+      command_parts << command_options if command_options
+      command_parts << cpp_libraries if cpp_libraries
+      command_parts << cpp_defs
+      command_parts << cpp_out_file
+      command_parts << cpp_source_file
+      command_parts << library_options if library_options
+
+      command_parts.compact.join(' ')
+    end
+
+    def with_suppressed_output
+      stderr_orig = $stderr.dup
+      stdout_orig = $stdout.dup
+
+      $stderr.reopen(IO::NULL)
+      $stdout.reopen(IO::NULL)
+
+      yield
+    ensure
+      $stderr.reopen(stderr_orig)
+      $stdout.reopen(stdout_orig)
+      stderr_orig.close
+      stdout_orig.close
+    end
+
     # Take an array of header file names (or convert it to an array if it's a
     # single argument), add the COMMON_HEADERS, flatten it out and remove any
     # duplicates.
@@ -196,21 +258,20 @@ module Mkmf
     # This string is then to be used at the top of the ERB templates.
     #
     def get_header_string(headers)
-      headers = [headers] unless headers.is_a?(Array)
+      headers = Array(headers)
 
       common_headers = RbConfig::CONFIG['COMMON_HEADERS']
 
       if common_headers.nil? || common_headers.empty?
         if headers.empty?
           headers = ['stdio.h', 'stdlib.h']
-          headers += 'windows.h' if File::ALT_SEPARATOR
+          headers << 'windows.h' if File::ALT_SEPARATOR
         end
       else
         headers += common_headers.split
       end
 
-      headers = headers.flatten.uniq
-      headers.map{ |h| "#include <#{h}>" }.join("\n")
+      headers.flatten.uniq.map { |h| "#include <#{h}>" }.join("\n")
     end
 
     # Create a temporary bit of C source code in the temp directory, and
@@ -223,50 +284,32 @@ module Mkmf
     # error is raised if the compilation step fails.
     #
     def try_to_execute(code, command_options = nil)
-      begin
-        result = 0
-
-        stderr_orig = $stderr.dup
-        stdout_orig = $stdout.dup
-
-        Dir.chdir(Dir.tmpdir) do
-          File.write(cpp_source_file, code)
+      result = 0
 
-          if command_options
-            command  = "#{cpp_command} #{command_options} #{cpp_libraries} #{cpp_defs} "
-          else
-            command  = "#{cpp_command} #{cpp_libraries} #{cpp_defs} "
-          end
-
-          command += "#{cpp_out_file} "
-          command += cpp_source_file
+      Dir.chdir(Dir.tmpdir) do
+        File.write(cpp_source_file, code)
+        command = build_compile_command(command_options)
 
-          # Temporarily close these
-          $stderr.reopen(IO::NULL)
-          $stdout.reopen(IO::NULL)
+        compilation_successful = with_suppressed_output { system(command) }
 
-          if system(command)
-            $stdout.reopen(stdout_orig) # We need this back for open3 to work.
+        if compilation_successful
+          conftest = File::ALT_SEPARATOR ? 'conftest.exe' : './conftest.exe'
 
-            conftest = File::ALT_SEPARATOR ? 'conftest.exe' : './conftest.exe'
-
-            Open3.popen3(conftest) do |stdin, stdout, stderr|
-              stdin.close
-              stderr.close
-              result = stdout.gets.chomp.to_i
-            end
-          else
-            raise "Failed to compile source code with command '#{command}':\n===\n#{code}==="
+          Open3.popen3(conftest) do |stdin, stdout, stderr|
+            stdin.close
+            stderr.close
+            output = stdout.gets
+            result = output&.chomp&.to_i || 0
           end
+        else
+          raise StandardError, "Failed to compile source code with command '#{command}':\n===\n#{code}==="
         end
-      ensure
-        FileUtils.rm_f(cpp_source_file)
-        FileUtils.rm_f(cpp_out_file)
-        $stderr.reopen(stderr_orig)
-        $stdout.reopen(stdout_orig)
       end
 
       result
+    ensure
+      FileUtils.rm_f(File.join(Dir.tmpdir, cpp_source_file))
+      FileUtils.rm_f(File.join(Dir.tmpdir, 'conftest.exe'))
     end
 
     # Create a temporary bit of C source code in the temp directory, and
@@ -276,36 +319,16 @@ module Mkmf
     # Note that $stderr is temporarily redirected to the null device because
     # we don't actually care about the reason for failure.
     #
-    def try_to_compile(code, command_options = nil)
-      begin
-        boolean = false
-        stderr_orig = $stderr.dup
-        stdout_orig = $stdout.dup
-
-        Dir.chdir(Dir.tmpdir) do
-          File.write(cpp_source_file, code)
-
-          if command_options
-            command  = "#{cpp_command} #{command_options} #{cpp_libraries} #{cpp_defs} "
-          else
-            command  = "#{cpp_command} #{cpp_libraries} #{cpp_defs} "
-          end
+    def try_to_compile(code, command_options = nil, library_options = nil)
+      Dir.chdir(Dir.tmpdir) do
+        File.write(cpp_source_file, code)
+        command = build_compile_command(command_options, library_options)
 
-          command += "#{cpp_out_file} "
-          command += cpp_source_file
-
-          $stderr.reopen(IO::NULL)
-          $stdout.reopen(IO::NULL)
-          boolean = system(command)
-        end
-      ensure
-        FileUtils.rm_f(cpp_source_file)
-        FileUtils.rm_f(cpp_out_file)
-        $stdout.reopen(stdout_orig)
-        $stderr.reopen(stderr_orig)
+        with_suppressed_output { system(command) }
       end
-
-      boolean
+    ensure
+      FileUtils.rm_f(File.join(Dir.tmpdir, cpp_source_file))
+      FileUtils.rm_f(File.join(Dir.tmpdir, 'conftest.exe'))
     end
 
     # Slurp the contents of the template file for evaluation later.

data/lib/mkmf/templates/check_offsetof.erb

@@ -0,0 +1,11 @@
+#include <stdio.h>
+#include <stddef.h>
+
+<%= headers %>
+
+int conftest_const = (int)(offsetof(<%= struct_type %>, <%= field %>));
+
+int main(){
+  printf("%d\n", conftest_const);
+  return 0;
+}

data/lib/mkmf/templates/have_library.erb

@@ -0,0 +1,10 @@
+<%= headers %>
+
+int main(){
+<% if function %>
+  void *p = (void *)&<%= function %>;
+  return !p;
+<% else %>
+  return 0;
+<% end %>
+}

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.7.2'
+  spec.version    = '0.7.4'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'

data/spec/mkmf_lite_spec.rb

@@ -20,7 +20,7 @@ RSpec.describe Mkmf::Lite do
 
   describe 'constants' do
     example 'version information' do
-      expect(described_class::MKMF_LITE_VERSION).to eq('0.7.2')
+      expect(described_class::MKMF_LITE_VERSION).to eq('0.7.4')
       expect(described_class::MKMF_LITE_VERSION).to be_frozen
     end
   end
@@ -112,6 +112,33 @@ RSpec.describe Mkmf::Lite do
     end
   end
 
+  context 'check_offsetof' do
+    let(:st_field){ 'st_dev' }
+
+    example 'check_offsetof basic functionality' do
+      expect(subject).to respond_to(:check_offsetof)
+      expect{ subject.check_offsetof(st_type, st_field, st_header) }.not_to raise_error
+    end
+
+    example 'check_offsetof requires at least two arguments' do
+      expect{ subject.check_offsetof }.to raise_error(ArgumentError)
+      expect{ subject.check_offsetof(st_type) }.to raise_error(ArgumentError)
+    end
+
+    example 'check_offsetof accepts directory arguments' do
+      expect{ subject.check_offsetof(st_type, st_field, [st_header, 'stdlib.h'], ['/usr/include']) }.not_to raise_error
+    end
+
+    example 'check_offsetof returns an integer value' do
+      size1 = subject.check_offsetof(st_type, st_field, st_header)
+      size2 = subject.check_offsetof(st_type, 'st_ino', st_header)
+      expect(size1).to be_a(Integer)
+      expect(size2).to be_a(Integer)
+      expect(size1).to eq(0)
+      expect(size2).to be > size1
+    end
+  end
+
   context 'check_sizeof' do
     example 'check_sizeof basic functionality' do
       expect(subject).to respond_to(:check_sizeof)
@@ -137,4 +164,34 @@ RSpec.describe Mkmf::Lite do
       expect(size).to be > 0
     end
   end
+
+  context 'have_library' do
+    example 'have_library basic functionality' do
+      expect(subject).to respond_to(:have_library)
+    end
+
+    example 'have_library returns expected boolean value' do
+      expect(subject.have_library('c')).to be(true)
+      expect(subject.have_library('m')).to be(true)
+      expect(subject.have_library('nonexistent_library_xyz')).to be(false)
+    end
+
+    example 'have_library with function argument returns expected boolean value' do
+      expect(subject.have_library('m', 'sqrt', 'math.h')).to be(true)
+      expect(subject.have_library('m', 'nonexistent_function_xyz', 'math.h')).to be(false)
+    end
+
+    example 'have_library with headers argument works correctly' do
+      expect{ subject.have_library('m', 'sqrt', 'math.h') }.not_to raise_error
+      expect(subject.have_library('m', 'sqrt', 'math.h')).to be(true)
+    end
+
+    example 'have_library requires at least one argument' do
+      expect{ subject.have_library }.to raise_error(ArgumentError)
+    end
+
+    example 'have_library accepts a maximum of three arguments' do
+      expect{ subject.have_library('m', 'sqrt', 'math.h', 'bogus') }.to raise_error(ArgumentError)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mkmf-lite
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.4
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -34,7 +34,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2025-03-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ptools
@@ -138,13 +138,17 @@ files:
 - README.md
 - Rakefile
 - certs/djberg96_pub.pem
+- conftest.c
+- conftest.exe
 - lib/mkmf-lite.rb
 - lib/mkmf/lite.rb
+- lib/mkmf/templates/check_offsetof.erb
 - lib/mkmf/templates/check_sizeof.erb
 - lib/mkmf/templates/check_valueof.erb
 - lib/mkmf/templates/have_func.erb
 - lib/mkmf/templates/have_func_pointer.erb
 - lib/mkmf/templates/have_header.erb
+- lib/mkmf/templates/have_library.erb
 - lib/mkmf/templates/have_struct_member.erb
 - mkmf-lite.gemspec
 - spec/mkmf_lite_spec.rb
@@ -175,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A lighter version of mkmf designed for use as a library
 test_files: