# frozen_string_literal: true module OS module Mac module Xcode module_function DEFAULT_BUNDLE_PATH = Pathname.new("/Applications/Xcode.app").freeze BUNDLE_ID = "com.apple.dt.Xcode" OLD_BUNDLE_ID = "com.apple.Xcode" def latest_version case MacOS.version when "10.9" then "6.2" when "10.10" then "7.2.1" when "10.11" then "8.2.1" when "10.12" then "9.2" when "10.13" then "10.1" when "10.14" then "10.2.1" when "10.15" then "11.2.1" else raise "macOS '#{MacOS.version}' is invalid" unless OS::Mac.prerelease? # Default to newest known version of Xcode for unreleased macOS versions. "11.2.1" end end def minimum_version case MacOS.version when "10.15" then "11.0" when "10.14" then "10.2" when "10.13" then "9.0" when "10.12" then "8.0" else "2.0" end end def below_minimum_version? return false unless installed? version < minimum_version end def latest_sdk_version? OS::Mac.version >= OS::Mac.latest_sdk_version end def needs_clt_installed? return false if latest_sdk_version? without_clt? end def outdated? return false unless installed? version < latest_version end def without_clt? !MacOS::CLT.installed? end # Returns a Pathname object corresponding to Xcode.app's Developer # directory or nil if Xcode.app is not installed def prefix @prefix ||= begin dir = MacOS.active_developer_dir if dir.empty? || dir == CLT::PKG_PATH || !File.directory?(dir) path = bundle_path path/"Contents/Developer" if path else # Use cleanpath to avoid pathological trailing slash Pathname.new(dir).cleanpath end end end def toolchain_path Pathname.new("#{prefix}/Toolchains/XcodeDefault.xctoolchain") end def bundle_path # Use the default location if it exists. return DEFAULT_BUNDLE_PATH if DEFAULT_BUNDLE_PATH.exist? # Ask Spotlight where Xcode is. If the user didn't install the # helper tools and installed Xcode in a non-conventional place, this # is our only option. See: https://superuser.com/questions/390757 MacOS.app_with_bundle_id(BUNDLE_ID, OLD_BUNDLE_ID) end def installed? !prefix.nil? end def sdk(v = nil) @locator ||= XcodeSDKLocator.new @locator.sdk_if_applicable(v) end def sdk_path(v = nil) sdk(v)&.path end def update_instructions if OS::Mac.prerelease? <<~EOS Xcode can be updated from: #{Formatter.url("https://developer.apple.com/download/more/")} EOS else <<~EOS Xcode can be updated from the App Store. EOS end end def version # may return a version string # that is guessed based on the compiler, so do not # use it in order to check if Xcode is installed. if @version ||= detect_version ::Version.new @version else ::Version::NULL end end def detect_version # This is a separate function as you can't cache the value out of a block # if return is used in the middle, which we do many times in here. return if !MacOS::Xcode.installed? && !MacOS::CLT.installed? %W[ #{prefix}/usr/bin/xcodebuild #{which("xcodebuild")} ].uniq.each do |xcodebuild_path| next unless File.executable? xcodebuild_path xcodebuild_output = Utils.popen_read(xcodebuild_path, "-version") next unless $CHILD_STATUS.success? xcode_version = xcodebuild_output[/Xcode (\d+(\.\d+)*)/, 1] return xcode_version if xcode_version # Xcode 2.x's xcodebuild has a different version string case xcodebuild_output[/DevToolsCore-(\d+\.\d)/, 1] when "515.0" then return "2.0" when "798.0" then return "2.5" end end detect_version_from_clang_version end def detect_version_from_clang_version return "dunno" if DevelopmentTools.clang_version.null? # This logic provides a fake Xcode version based on the # installed CLT version. This is useful as they are packaged # simultaneously so workarounds need to apply to both based on their # comparable version. case (DevelopmentTools.clang_version.to_f * 10).to_i when 0 then "dunno" when 60 then "6.0" when 61 then "6.1" when 70 then "7.0" when 73 then "7.3" when 80 then "8.0" when 81 then "8.3" when 90 then "9.2" when 91 then "9.4" when 100 then "10.2.1" when 110 then "11.2.1" else "11.2.1" end end def default_prefix? prefix.to_s == "/Applications/Xcode.app/Contents/Developer" end end module CLT module_function # The original Mavericks CLT package ID EXECUTABLE_PKG_ID = "com.apple.pkg.CLTools_Executables" MAVERICKS_NEW_PKG_ID = "com.apple.pkg.CLTools_Base" # obsolete PKG_PATH = "/Library/Developer/CommandLineTools" HEADER_PKG_PATH = "/Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_:macos_version.pkg" HEADER_PKG_ID = "com.apple.pkg.macOS_SDK_headers_for_macOS_10.14" # Returns true even if outdated tools are installed def installed? !version.null? end def separate_header_package? version >= "10" end def provides_sdk? version >= "8" end def headers_installed? if !separate_header_package? installed? else headers_version == version end end def sdk(v = nil) @locator ||= CLTSDKLocator.new @locator.sdk_if_applicable(v) end def sdk_path(v = nil) sdk(v)&.path end def update_instructions if MacOS.version >= "10.14" <<~EOS Update them from Software Update in System Preferences or #{Formatter.url("https://developer.apple.com/download/more/")}. EOS else <<~EOS Update them from Software Update in the App Store #{Formatter.url("https://developer.apple.com/download/more/")}. EOS end end def latest_version # As of Xcode 8 CLT releases are no longer in sync with Xcode releases # on the older supported platform for that Xcode release, i.e there's no # CLT package for 10.11 that contains the Clang version from Xcode 8. case MacOS.version when "10.15" then "1100.0.33.12" when "10.14" then "1001.0.46.4" when "10.13" then "1000.10.44.2" when "10.12" then "900.0.39.2" when "10.11" then "800.0.42.1" when "10.10" then "700.1.81" else "600.0.57" end end def minimum_version case MacOS.version when "10.15" then "11.0.0" when "10.14" then "10.0.0" when "10.13" then "9.0.0" when "10.12" then "8.0.0" else "1.0.0" end end def below_minimum_version? return false unless installed? version < minimum_version end def outdated? clang_version = detect_clang_version return false unless clang_version ::Version.new(clang_version) < latest_version end def detect_clang_version path = if MacOS.version >= :mavericks "#{PKG_PATH}/usr/bin/clang" else "/usr/bin/clang" end version_output = Utils.popen_read("#{path} --version") version_output[/clang-(\d+\.\d+\.\d+(\.\d+)?)/, 1] end # Version string (a pretty long one) of the CLT package. # Note, that different ways to install the CLTs lead to different # version numbers. def version if @version ||= detect_version ::Version.new @version else ::Version::NULL end end # Version string of the header package, which is a # separate package as of macOS 10.14. def headers_version if !separate_header_package? version else @header_version ||= MacOS.pkgutil_info(HEADER_PKG_ID)[/version: (.+)$/, 1] return ::Version::NULL unless @header_version ::Version.new(@header_version) end end def detect_version version = nil [EXECUTABLE_PKG_ID, MAVERICKS_NEW_PKG_ID].each do |id| next unless File.exist?("#{PKG_PATH}/usr/bin/clang") version = MacOS.pkgutil_info(id)[/version: (.+)$/, 1] return version if version end detect_clang_version end end end end