rmagick 4.0.0 → 5.3.0

data/ext/RMagick/extconf.rb

@@ -2,7 +2,7 @@ lib_dir = File.expand_path('../../lib', File.dirname(__FILE__))
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'rubygems'
 require 'mkmf'
-require 'date'
+require 'pkg-config'
 
 module RMagick
   class Extconf
@@ -10,18 +10,47 @@ module RMagick
     RMAGICK_VERS = ::Magick::VERSION
     MIN_RUBY_VERS = ::Magick::MIN_RUBY_VERSION
 
+    # ImageMagick 6.7 package
+    IM6_7_PACKAGES = ['ImageMagick'].freeze
+
+    # ImageMagick 6.8+ packages
+    IM6_PACKAGES = %w[
+      ImageMagick-6.Q64HDRI
+      ImageMagick-6.Q32HDRI
+      ImageMagick-6.Q16HDRI
+      ImageMagick-6.Q8HDRI
+      ImageMagick-6.Q64
+      ImageMagick-6.Q32
+      ImageMagick-6.Q16
+      ImageMagick-6.Q8
+    ].freeze
+
+    # ImageMagick 7 packages
+    IM7_PACKAGES = %w[
+      ImageMagick-7.Q64HDRI
+      ImageMagick-7.Q32HDRI
+      ImageMagick-7.Q16HDRI
+      ImageMagick-7.Q8HDRI
+      ImageMagick-7.Q64
+      ImageMagick-7.Q32
+      ImageMagick-7.Q16
+      ImageMagick-7.Q8
+    ].freeze
+
     attr_reader :headers
 
     def initialize
       @stdout = $stdout.dup
 
       setup_pkg_config_path
-      configure_compile_options
       assert_can_compile!
+      configure_compile_options
       configure_headers
     end
 
     def setup_pkg_config_path
+      return if RUBY_PLATFORM =~ /mswin|mingw/
+
       if find_executable('brew')
         pkg_config_path = "#{`brew --prefix imagemagick@6`.strip}/lib/pkgconfig"
       elsif find_executable('pacman')
@@ -40,7 +69,6 @@ module RMagick
       {
         magick_version: $magick_version,
         local_libs: $LOCAL_LIBS,
-        cflags: $CFLAGS,
         cppflags: $CPPFLAGS,
         ldflags: $LDFLAGS,
         defs: $defs,
@@ -51,7 +79,9 @@ module RMagick
     def configure_headers
       @headers = %w[assert.h ctype.h stdio.h stdlib.h math.h time.h sys/types.h]
 
-      if have_header('magick/MagickCore.h')
+      if have_header('MagickCore/MagickCore.h')
+        headers << 'MagickCore/MagickCore.h'
+      elsif have_header('magick/MagickCore.h')
         headers << 'magick/MagickCore.h'
       else
         exit_failure "Can't install RMagick #{RMAGICK_VERS}. Can't find magick/MagickCore.h."
@@ -62,85 +92,52 @@ module RMagick
       # Magick-config is not available on Windows
       if RUBY_PLATFORM !~ /mswin|mingw/
 
-        # Check for compiler. Extract first word so ENV['CC'] can be a program name with arguments.
-        config = defined?(RbConfig) ? ::RbConfig : ::Config
-        cc = (ENV['CC'] || config::CONFIG['CC'] || 'gcc').split(' ').first
-        exit_failure "No C compiler found in ${ENV['PATH']}. See mkmf.log for details." unless find_executable(cc)
-
-        magick_package = determine_imagemagick_package
-
-        $magick_version = `pkg-config #{magick_package} --modversion`[/^(\d+\.\d+\.\d+)/]
-
         check_multiple_imagemagick_versions
         check_partial_imagemagick_versions
 
-        # Ensure minimum ImageMagick version
-        # Check minimum ImageMagick version if possible
-        checking_for("outdated ImageMagick version (<= #{Magick::MIN_IM_VERSION})") do
-          Logging.message("Detected ImageMagick version: #{$magick_version}\n")
+        original_ldflags = $LDFLAGS.dup
 
-          exit_failure "Can't install RMagick #{RMAGICK_VERS}. You must have ImageMagick #{Magick::MIN_IM_VERSION} or later.\n" if Gem::Version.new($magick_version) < Gem::Version.new(Magick::MIN_IM_VERSION)
-        end
+        libdir  = PKGConfig.libs_only_L($magick_package).chomp.sub('-L', '')
+        ldflags = "#{ENV['LDFLAGS']} " + PKGConfig.libs($magick_package).chomp
+        rpath   = libdir.empty? ? '' : "-Wl,-rpath,#{libdir}"
 
         # Save flags
-        $CFLAGS = ENV['CFLAGS'].to_s + ' ' + `pkg-config --cflags #{magick_package}`.chomp
-        $CPPFLAGS = ENV['CPPFLAGS'].to_s + ' ' + `pkg-config --cflags #{magick_package}`.chomp
-        $LDFLAGS = ENV['LDFLAGS'].to_s + ' ' + `pkg-config --libs #{magick_package}`.chomp
-        $LOCAL_LIBS = ENV['LIBS'].to_s + ' ' + `pkg-config --libs #{magick_package}`.chomp
+        $CPPFLAGS   += " #{ENV['CPPFLAGS']} " + PKGConfig.cflags($magick_package).chomp
+        $LOCAL_LIBS += " #{ENV['LIBS']} "     + PKGConfig.libs($magick_package).chomp
+        $LDFLAGS    += " #{ldflags} #{rpath}"
 
-        set_archflags_for_osx if RUBY_PLATFORM =~ /darwin/ # osx
+        unless try_link("int main() { }")
+          # if linker does not recognizes '-Wl,-rpath,somewhere' option, it revert to original option
+          $LDFLAGS = "#{original_ldflags} #{ldflags}"
+        end
 
-      elsif RUBY_PLATFORM =~ /mingw/ # mingw
+        configure_archflags_for_osx($magick_package) if RUBY_PLATFORM =~ /darwin/ # osx
 
-        `identify -version` =~ /Version: ImageMagick (\d+\.\d+\.\d+)-+\d+ /
-        abort 'Unable to get ImageMagick version' unless Regexp.last_match(1)
-        $magick_version = Regexp.last_match(1)
+      elsif RUBY_PLATFORM =~ /mingw/ # mingw
 
         dir_paths = search_paths_for_library_for_windows
-        $CPPFLAGS = %(-I"#{dir_paths[:include]}")
-        $LDFLAGS = %(-L"#{dir_paths[:lib]}")
+        $CPPFLAGS += %( -I"#{dir_paths[:include]}")
+        $LDFLAGS += %( -L"#{dir_paths[:lib]}")
+        $LDFLAGS << ' -lucrt' if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4.0')
 
-        have_library('CORE_RL_magick_')
+        have_library(im_version_at_least?('7.0.0') ? 'CORE_RL_MagickCore_' : 'CORE_RL_magick_')
 
       else # mswin
 
-        `identify -version` =~ /Version: ImageMagick (\d+\.\d+\.\d+)-+\d+ /
-        abort 'Unable to get ImageMagick version' unless Regexp.last_match(1)
-        $magick_version = Regexp.last_match(1)
-
         dir_paths = search_paths_for_library_for_windows
         $CPPFLAGS << %( -I"#{dir_paths[:include]}")
         $LDFLAGS << %( -libpath:"#{dir_paths[:lib]}")
+        $LDFLAGS << ' -libpath:ucrt' if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.4.0')
 
-        $LOCAL_LIBS = 'CORE_RL_magick_.lib'
+        $LOCAL_LIBS += ' ' + (im_version_at_least?('7.0.0') ? 'CORE_RL_MagickCore_.lib' : 'CORE_RL_magick_.lib')
 
       end
 
-      $CFLAGS << (have_macro('__GNUC__') ? ' -std=gnu99' : ' -std=c99')
-    end
-
-    # Test for a specific value in an enum type
-    def have_enum_value(enum, value, headers = nil, &b)
-      checking_for "#{enum}.#{value}" do
-        if try_compile(<<"SRC", &b)
-#{COMMON_HEADERS}
-        #{cpp_include(headers)}
-/*top*/
-int main() { #{enum} t = #{value}; t = t; return 0; }
-SRC
-          $defs.push(format('-DHAVE_ENUM_%s', value.upcase))
-          true
-        else
-          false
-        end
-      end
-    end
-
-    # Test for multiple values of the same enum type
-    def have_enum_values(enum, values, headers = nil, &b)
-      values.each do |value|
-        have_enum_value(enum, value, headers, &b)
-      end
+      $CPPFLAGS << if have_macro('__GNUC__')
+                     ' -std=gnu99 -Wno-void-pointer-to-int-cast -Wno-void-pointer-to-enum-cast -Wno-pointer-to-int-cast'
+                   else
+                     ' -std=c99'
+                   end
     end
 
     def exit_failure(msg)
@@ -160,22 +157,44 @@ SRC
       exit(1)
     end
 
-    def determine_imagemagick_package
-      unless find_executable('pkg-config')
-        exit_failure "Can't install RMagick #{RMAGICK_VERS}. Can't find pkg-config in #{ENV['PATH']}\n"
+    def detect_imagemagick_packages(packages)
+      packages.select do |package|
+        PKGConfig.exist?(package)
       end
+    end
+
+    def installed_im6_packages
+      @installed_im6_packages ||= detect_imagemagick_packages(IM6_PACKAGES)
+    end
 
-      packages = `pkg-config --list-all`.scan(/(ImageMagick\-6[\.A-Z0-9]+) .*/).flatten
+    def installed_im7_packages
+      @installed_im7_packages ||= detect_imagemagick_packages(IM7_PACKAGES)
+    end
+
+    def determine_imagemagick_package
+      packages = [installed_im7_packages, installed_im6_packages].flatten
 
-      # For ancient version of ImageMagick 6 we need a different regex
       if packages.empty?
-        packages = `pkg-config --list-all`.scan(/(ImageMagick) .*/).flatten
+        # ImageMagick 6.7 does not have package file like ImageMagick-6.Q16.pc
+        packages = detect_imagemagick_packages(IM6_7_PACKAGES)
       end
 
       if packages.empty?
         exit_failure "Can't install RMagick #{RMAGICK_VERS}. Can't find ImageMagick with pkg-config\n"
       end
 
+      if installed_im6_packages.any? && installed_im7_packages.any?
+        checking_for('forced use of ImageMagick 6') do
+          if ENV['USE_IMAGEMAGICK_6']
+            packages = installed_im6_packages
+            true
+          else
+            packages = installed_im7_packages
+            false
+          end
+        end
+      end
+
       if packages.length > 1
         package_lines = packages.map { |package| " - #{package}" }.join("\n")
         msg = "\nWarning: Found more than one ImageMagick installation. This could cause problems at runtime.\n#{package_lines}\n\n"
@@ -226,21 +245,33 @@ SRC
       matches.delete_if(&:empty?)
       return unless !matches.empty? && matches.length < 3
 
-      msg = "\nWarning: Found a partial ImageMagick installation. Your operating system likely has some built-in ImageMagick libraries but not all of ImageMagick. This will most likely cause problems at both compile and runtime.\nFound partial installation at: " + prefix + "\n"
+      msg = <<~MESSAGE
+
+        Warning: Found a partial ImageMagick installation. Your operating
+        system likely has some built-in ImageMagick libraries but not all of
+        ImageMagick. This will most likely cause problems at both compile and
+        runtime.
+        Found partial installation at: #{prefix}
+
+      MESSAGE
+
       Logging.message msg
       message msg
     end
 
     # issue #169
     # set ARCHFLAGS appropriately for OSX
-    def set_archflags_for_osx
-      archflags = []
-      fullpath = `which convert`
-      fileinfo = `file #{fullpath}`
+    def configure_archflags_for_osx(magick_package)
+      return unless PKGConfig.libs_only_L(magick_package).match(%r{-L(.+)/lib})
+
+      imagemagick_dir = Regexp.last_match(1)
+      command = Dir.glob(File.join(imagemagick_dir, "bin/*")).select { |file| File.executable? file }.first
+      fileinfo = `file #{command}`
 
       # default ARCHFLAGS
       archs = $ARCH_FLAG.scan(/-arch\s+(\S+)/).flatten
 
+      archflags = []
       archs.each do |arch|
         archflags << "-arch #{arch}" if fileinfo.include?(arch)
       end
@@ -259,7 +290,7 @@ SRC
       paths = ENV['PATH'].split(File::PATH_SEPARATOR)
       paths.each do |dir|
         lib = File.join(dir, 'lib')
-        lib_file = File.join(lib, 'CORE_RL_magick_.lib')
+        lib_file = File.join(lib, im_version_at_least?('7.0.0') ? 'CORE_RL_MagickCore_.lib' : 'CORE_RL_magick_.lib')
         next unless File.exist?(lib_file)
 
         dir_paths[:include] = File.join(dir, 'include')
@@ -271,86 +302,136 @@ SRC
 
       return dir_paths if found_lib
 
-      exit_failure <<END_MINGW
-Can't install RMagick #{RMAGICK_VERS}.
-Can't find the ImageMagick library.
-Retry with '--with-opt-dir' option.
-Usage: gem install rmagick -- '--with-opt-dir=\"[path to ImageMagick]\"'
-e.g.
-  gem install rmagick -- '--with-opt-dir=\"C:\Program Files\ImageMagick-6.9.1-Q16\"'
-END_MINGW
+      exit_failure <<~END_MINGW
+        Can't install RMagick #{RMAGICK_VERS}.
+        Can't find the ImageMagick library.
+        Retry with '--with-opt-dir' option.
+        Usage: gem install rmagick -- '--with-opt-dir=\"[path to ImageMagick]\"'
+        e.g.
+          gem install rmagick -- '--with-opt-dir=\"C:\\Program Files\\ImageMagick-6.9.1-Q16\"'
+      END_MINGW
     end
 
     def assert_can_compile!
       assert_minimum_ruby_version!
       assert_has_dev_libs!
+
+      # Check for compiler. Extract first word so ENV['CC'] can be a program name with arguments.
+      cc = (ENV['CC'] || RbConfig::CONFIG['CC'] || 'gcc').split(' ').first
+      exit_failure "No C compiler found in ${ENV['PATH']}. See mkmf.log for details." unless find_executable(cc)
     end
 
     def assert_minimum_ruby_version!
-      unless checking_for("Ruby version >= #{MIN_RUBY_VERS}") do
+      supported = checking_for("Ruby version >= #{MIN_RUBY_VERS}") do
         Gem::Version.new(RUBY_VERSION) >= Gem::Version.new(MIN_RUBY_VERS)
       end
-        exit_failure "Can't install RMagick #{RMAGICK_VERS}. Ruby #{MIN_RUBY_VERS} or later required.\n"
-      end
+
+      exit_failure "Can't install RMagick #{RMAGICK_VERS}. Ruby #{MIN_RUBY_VERS} or later required.\n" unless supported
     end
 
     def assert_has_dev_libs!
-      return unless RUBY_PLATFORM !~ /mswin|mingw/
+      failure_message = <<~END_FAILURE
+        Can't install RMagick #{RMAGICK_VERS}.
+        Can't find the ImageMagick library or one of the dependent libraries.
+        Check the mkmf.log file for more detailed information.
+      END_FAILURE
+
+      if RUBY_PLATFORM !~ /mswin|mingw/
+        unless PKGConfig.libs('MagickCore')[/\bl\s*(MagickCore|Magick)6?\b/]
+          exit_failure failure_message
+        end
 
-      unless `pkg-config --libs MagickCore`[/\bl\s*(MagickCore|Magick)6?\b/]
-        exit_failure "Can't install RMagick #{RMAGICK_VERS}. " \
-                   "Can't find the ImageMagick library or one of the dependent libraries. " \
-                   "Check the mkmf.log file for more detailed information.\n"
+        $magick_package = determine_imagemagick_package
+        $magick_version = PKGConfig.modversion($magick_package)[/^(\d+\.\d+\.\d+)/]
+      else
+        `#{magick_command} -version` =~ /Version: ImageMagick (\d+\.\d+\.\d+)-+\d+ /
+        $magick_version = Regexp.last_match(1)
+        exit_failure failure_message unless $magick_version
+      end
+
+      # Ensure minimum ImageMagick version
+      # Check minimum ImageMagick version if possible
+      checking_for("outdated ImageMagick version (<= #{Magick::MIN_IM_VERSION})") do
+        Logging.message("Detected ImageMagick version: #{$magick_version}\n")
+
+        exit_failure "Can't install RMagick #{RMAGICK_VERS}. You must have ImageMagick #{Magick::MIN_IM_VERSION} or later.\n" if Gem::Version.new($magick_version) < Gem::Version.new(Magick::MIN_IM_VERSION)
       end
     end
 
     def create_header_file
-      [
+      ruby_api = [
+        'rb_gc_adjust_memory_usage', # Ruby 2.4.0
+        'rb_gc_mark_movable' # Ruby 2.7.0
+      ]
+      memory_api = %w[
+        posix_memalign
+        malloc_usable_size
+        malloc_size
+        _aligned_msize
+      ]
+      imagemagick_api = [
         'GetImageChannelEntropy', # 6.9.0-0
-        'SetImageGray' # 6.9.1-10
-      ].each do |func|
+        'SetImageGray', # 6.9.1-10
+        'SetMagickAlignedMemoryMethods' # 7.0.9-0
+      ]
+
+      check_api = ruby_api + memory_api + imagemagick_api
+      check_api.each do |func|
         have_func(func, headers)
       end
 
+      unless have_header('malloc.h')
+        have_header('malloc/malloc.h')
+      end
+
       # Miscellaneous constants
       $defs.push("-DRUBY_VERSION_STRING=\"ruby #{RUBY_VERSION}\"")
       $defs.push("-DRMAGICK_VERSION_STRING=\"RMagick #{RMAGICK_VERS}\"")
 
-      if Gem::Version.new($magick_version) >= Gem::Version.new('6.8.9')
-        $defs.push('-DIMAGEMAGICK_GREATER_THAN_EQUAL_6_8_9=1')
-      end
-      if Gem::Version.new($magick_version) >= Gem::Version.new('6.9.0')
-        $defs.push('-DIMAGEMAGICK_GREATER_THAN_EQUAL_6_9_0=1')
-      end
+      $defs.push('-DIMAGEMAGICK_GREATER_THAN_EQUAL_6_8_9=1') if im_version_at_least?('6.8.9')
+      $defs.push('-DIMAGEMAGICK_GREATER_THAN_EQUAL_6_9_0=1') if im_version_at_least?('6.9.0')
+      $defs.push('-DIMAGEMAGICK_GREATER_THAN_EQUAL_6_9_10=1') if im_version_at_least?('6.9.10')
+      $defs.push('-DIMAGEMAGICK_7=1') if im_version_at_least?('7.0.0')
+      $defs.push('-DIMAGEMAGICK_GREATER_THAN_EQUAL_7_0_8=1') if im_version_at_least?('7.0.8')
+      $defs.push('-DIMAGEMAGICK_GREATER_THAN_EQUAL_7_0_10=1') if im_version_at_least?('7.0.10')
 
       create_header
     end
 
     def create_makefile_file
       create_header_file
-      # Prior to 1.8.5 mkmf duplicated the symbols on the command line and in the
-      # extconf.h header. Suppress that behavior by removing the symbol array.
-      $defs = []
 
       # Force re-compilation if the generated Makefile changed.
-      $config_h = 'Makefile rmagick.h'
+      $config_h = 'Makefile'
 
       create_makefile('RMagick2')
       print_summary
     end
 
-    def print_summary
-      summary = <<"END_SUMMARY"
+    def magick_command
+      @magick_command ||= if find_executable('magick')
+                            'magick'
+                          elsif find_executable('identify')
+                            'identify'
+                          else
+                            raise NotImplementedError, "no executable found for ImageMagick"
+                          end
+    end
 
+    def im_version_at_least?(version)
+      Gem::Version.new($magick_version) >= Gem::Version.new(version)
+    end
 
-#{'=' * 70}
-#{DateTime.now.strftime('%a %d %b %y %T')}
-This installation of RMagick #{RMAGICK_VERS} is configured for
-Ruby #{RUBY_VERSION} (#{RUBY_PLATFORM}) and ImageMagick #{$magick_version}
-#{'=' * 70}
+    def print_summary
+      summary = <<~"END_SUMMARY"
+        #{'=' * 70}
+        #{Time.now.strftime('%a %d %b %y %T')}
+        This installation of RMagick #{RMAGICK_VERS} is configured for
+        Ruby #{RUBY_VERSION} (#{RUBY_PLATFORM}) and ImageMagick #{$magick_version}
+        #{'=' * 70}
 
 
-END_SUMMARY
+      END_SUMMARY
 
       Logging.message summary
       message summary