diff --git a/.gitignore b/.gitignore index fc3791f..7158171 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ Gemfile.lock pkg ports tmp +mkmf.log diff --git a/examples/Rakefile b/examples/Rakefile index 85f8b90..cc1bd28 100644 --- a/examples/Rakefile +++ b/examples/Rakefile @@ -3,8 +3,6 @@ require 'rbconfig' $: << File.expand_path(File.join(File.dirname(__FILE__), "../lib")) require "mini_portile2" -require "mkmf" - recipes = [] recipe_hooks = {} @@ -132,10 +130,9 @@ yaml.files = [{ }] recipes.push(yaml) recipe_hooks["yaml"] = lambda do |recipe| - conf = pkg_config(File.join(recipe.path, "lib", "pkgconfig", "yaml-0.1.pc")) - puts "pkg_config: #{conf.inspect}" + recipe.activate_mkmf(pkgconf: File.join(recipe.path, "lib", "pkgconfig", "yaml-0.1.pc")) - expected = "-L" + MiniPortile.native_path(File.join(recipe.path, "lib")) + expected = "-L" + File.join(recipe.path, "lib") $LDFLAGS.split.include?(expected) or raise(<<~MSG) assertion failed: LDFLAGS not updated correctly: #{$LDFLAGS} @@ -158,9 +155,10 @@ namespace :ports do desc "Install port #{recipe.name} #{recipe.version}" task recipe.name => ["ports"] do |t| recipe.cook - recipe.activate if hook = recipe_hooks[recipe.name] hook.call(recipe) + else + recipe.activate end end diff --git a/lib/mini_portile2/mini_portile.rb b/lib/mini_portile2/mini_portile.rb index 2538a47..f2ebd7d 100644 --- a/lib/mini_portile2/mini_portile.rb +++ b/lib/mini_portile2/mini_portile.rb @@ -94,6 +94,68 @@ def self.posix_path(path) end end + # + # this minimal version of pkg_config is based on ruby 29dc9378 (2023-01-09) + # + # specifically with the fix from b90e56e6 to support multiple pkg-config options, and removing + # code paths that aren't helpful for mini-portile's use case of parsing pc files. + # + def self.pkg_config(pcfiles, *pcoptions) + if pcoptions.empty? + raise ArgumentError, "no pkg-config options are given" + end + + pcfiles = Array(pcfiles) + + if ($PKGCONFIG ||= + (pkgconfig = MakeMakefile.with_config("pkg-config") {MakeMakefile.config_string("PKG_CONFIG") || "pkg-config"}) && + MakeMakefile.find_executable0(pkgconfig) && pkgconfig) + pkgconfig = $PKGCONFIG + else + raise RuntimeError, "pkg-config is not found" + end + + MakeMakefile.message "Finding pkg-config for #{pcoptions}... " + + pcoptions = Array(pcoptions).map { |o| "--#{o}" } + response = MakeMakefile.xpopen([pkgconfig, *pcoptions, *pcfiles], err:[:child, :out], &:read) + raise RuntimeError, response unless $?.success? + response.strip! + + MakeMakefile.message response.inspect + "\n" + response + end + + def self.activate_mkmf(pkgconf: nil) + if !pkgconf + raise NotImplementedError, "MiniPortile.activate_mkmf does not (yet) work without pkgconf files. If you want this functionality, please open an issue! ♥ ♥ ♥" + end + + pkgconf = Array(pkgconf) + + pkgconf.each do |p| + unless File.exist?(p) + raise RuntimeError, "pkg-config file '#{p}' does not exist" + end + end + + require "mkmf" + + MakeMakefile.message "Activating for mkmf using pkg-config files:\n" + pkgconf.each do |p| + MakeMakefile.message "- #{p}\n" + end + + # on macos, pkg-config will not return --cflags without this + ENV["PKG_CONFIG_ALLOW_SYSTEM_CFLAGS"] = "t" + + cflags = MiniPortile.pkg_config(pkgconf, "cflags") + ldflags = MiniPortile.pkg_config(pkgconf, "libs", "static") + + $CFLAGS << " " << cflags + $LDFLAGS << " " << ldflags + end + def initialize(name, version, **kwargs) @name = name @version = version @@ -236,7 +298,13 @@ def cook return true end - def activate + def activate(pkgconf: nil) + if pkgconf + # because I don't know if anybody has this use case, + # I just haven't bothered to implement this yet. + raise NotImplementedError, "MiniPortile#activate does not (yet) support pkgconf files. If you want this functionality, please open an issue! ♥ ♥ ♥" + end + lib_path = File.join(port_path, "lib") vars = { 'PATH' => File.join(port_path, 'bin'), @@ -656,4 +724,8 @@ def with_tempfile(filename, full_path) FileUtils.mkdir_p File.dirname(full_path) FileUtils.mv temp_file.path, full_path, :force => true end + + def abort_pkg_config(id) + abort("\nCould not configure the build properly (#{id}). Please install either the `pkg-config` utility or the `pkg-config` rubygem.\n\n") + end end diff --git a/test/assets/pkgconf/libxml2/libxml-2.0.pc b/test/assets/pkgconf/libxml2/libxml-2.0.pc new file mode 100644 index 0000000..d6601b3 --- /dev/null +++ b/test/assets/pkgconf/libxml2/libxml-2.0.pc @@ -0,0 +1,13 @@ +prefix=/foo/libxml2/2.11.5 +exec_prefix=${prefix} +libdir=/foo/libxml2/2.11.5/lib +includedir=${prefix}/include +modules=1 + +Name: libXML +Version: 2.11.5 +Description: libXML library version2. +Requires: +Libs: -L${libdir} -lxml2 +Libs.private: -L/foo/zlib/1.3/lib -lz -lm +Cflags: -I${includedir}/libxml2 diff --git a/test/assets/pkgconf/libxslt/libxslt.pc b/test/assets/pkgconf/libxslt/libxslt.pc new file mode 100644 index 0000000..0000042 --- /dev/null +++ b/test/assets/pkgconf/libxslt/libxslt.pc @@ -0,0 +1,13 @@ +prefix=/foo/libxslt/1.1.38 +exec_prefix=${prefix} +libdir=/foo/libxslt/1.1.38/lib +includedir=${prefix}/include + + +Name: libxslt +Version: 1.1.38 +Description: XSLT library version 2. +Requires: libxml-2.0 +Cflags: -I${includedir} +Libs: -L${libdir} -lxslt +Libs.private: -lm diff --git a/test/test_activate.rb b/test/test_activate.rb index f175af0..dc59d24 100644 --- a/test/test_activate.rb +++ b/test/test_activate.rb @@ -3,14 +3,17 @@ class TestActivate < TestCase attr_reader :recipe + LIBXML_PC = File.join(__dir__, "assets", "pkgconf", "libxml2", "libxml-2.0.pc") + LIBXSLT_PC = File.join(__dir__, "assets", "pkgconf", "libxslt", "libxslt.pc") + def setup super - @save_env = %w[PATH CPATH LIBRARY_PATH LDFLAGS].inject({}) do |env, var| + @save_env = %w[PATH CPATH LIBRARY_PATH LDFLAGS PKG_CONFIG_PATH].inject({}) do |env, var| env.update(var => ENV[var]) end - $LDFLAGS = nil - $CPPFLAGS = nil + $LDFLAGS = "" + $CFLAGS = "" FileUtils.rm_rf(["tmp", "ports"]) # remove any previous test files @@ -22,8 +25,8 @@ def setup def teardown FileUtils.rm_rf(["tmp", "ports"]) # remove any previous test files - $LDFLAGS = nil - $CPPFLAGS = nil + $LDFLAGS = "" + $CFLAGS = "" @save_env.each do |var, val| ENV[var] = val end @@ -119,6 +122,60 @@ def test_LDFLAGS_env_var_when_cross_compiling assert_equal(flag_elements('LDFLAGS').first, "-L#{lib_path}") end + def test_activate_with_pkgconf_raises_an_exception + assert_raises(NotImplementedError) do + recipe.activate(pkgconf: "fake/path/to/foo.pc") + end + end + + def test_activate_mkmf_without_pkgconf_raises_an_exception + assert_raises(NotImplementedError) do + MiniPortile.activate_mkmf + end + end + + def test_activate_mkmf_pkgconf_does_not_exist + assert_raises(RuntimeError) do + MiniPortile.activate_mkmf(pkgconf: "nonexistent/foo.pc") + end + + assert_raises(RuntimeError) do + MiniPortile.activate_mkmf(pkgconf: [LIBXML_PC, "nonexistent/foo.pc"]) + end + end + + def test_activate_mkmf_LDFLAGS_global + # can't get pkgconf to install on windows with ruby 2.3 + skip if MiniPortile.windows? && RUBY_VERSION < "2.4" + + MiniPortile.activate_mkmf(pkgconf: LIBXML_PC) + + assert_includes($LDFLAGS.split, "-lxml2") + assert_includes($LDFLAGS.split, "-L/foo/libxml2/2.11.5/lib") + end + + def test_activate_mkmf_CFLAGS_global + # can't get pkgconf to install on windows with ruby 2.3 + skip if MiniPortile.windows? && RUBY_VERSION < "2.4" + + MiniPortile.activate_mkmf(pkgconf: LIBXML_PC) + + assert_includes($CFLAGS.split, "-I/foo/libxml2/2.11.5/include/libxml2") + end + + def test_activate_mkmf_chains_pkgconf_path + # can't get pkgconf to install on windows with ruby 2.3 + skip if MiniPortile.windows? && RUBY_VERSION < "2.4" + + MiniPortile.activate_mkmf(pkgconf: [LIBXML_PC, LIBXSLT_PC]) + + assert_includes($CFLAGS.split, "-I/foo/libxml2/2.11.5/include/libxml2") + assert_includes($CFLAGS.split, "-I/foo/libxslt/1.1.38/include") + assert_includes($LDFLAGS.split, "-L/foo/libxml2/2.11.5/lib") + assert_includes($LDFLAGS.split, "-L/foo/libxslt/1.1.38/lib") + assert_includes($LDFLAGS.split, "-L/foo/zlib/1.3/lib") # from `--static` + end + private def path_elements(varname)