brew/Library/Homebrew/development_tools.rb

# typed: strict
# frozen_string_literal: true

require "version"

# Helper class for gathering information about development tools.
#
# @api public
class DevelopmentTools
  class << self
    # Locate a development tool.
    #
    # @api public
    sig { params(tool: T.any(String, Symbol)).returns(T.nilable(Pathname)) }
    def locate(tool)
      # Don't call tools (cc, make, strip, etc.) directly!
      # Give the name of the binary you look for as a string to this method
      # in order to get the full path back as a Pathname.
      (@locate ||= T.let({}, T.nilable(T::Hash[T.any(String, Symbol), T.untyped]))).fetch(tool) do |key|
        @locate[key] = if File.executable?((path = "/usr/bin/#{tool}"))
          Pathname.new path
        # Homebrew GCCs most frequently; much faster to check this before xcrun
        elsif (path = HOMEBREW_PREFIX/"bin/#{tool}").executable?
          path
        end
      end
    end

    sig { returns(T::Boolean) }
    def installed?
      locate("clang").present? || locate("gcc").present?
    end

    sig { returns(String) }
    def installation_instructions
      "Install Clang or run `brew install gcc`."
    end

    sig { returns(String) }
    def custom_installation_instructions
      installation_instructions
    end

    sig { params(resource: String).returns(String) }
    def insecure_download_warning(resource)
      package = curl_handles_most_https_certificates? ? "ca-certificates" : "curl"
      "Using `--insecure` with curl to download #{resource} because we need it to run " \
        "`brew install #{package}` in order to download securely from now on. " \
        "Checksums will still be verified."
    end

    # Get the default C compiler.
    #
    # @api public
    sig { returns(Symbol) }
    def default_compiler
      :clang
    end

    # Get the Clang version.
    #
    # @api public
    sig { returns(Version) }
    def clang_version
      @clang_version ||= T.let(
        if (path = locate("clang")) &&
           (build_version = `#{path} --version`[/(?:clang|LLVM) version (\d+\.\d(?:\.\d)?)/, 1])
          Version.new(build_version)
        else
          Version::NULL
        end, T.nilable(Version)
      )
    end

    # Get the Clang build version.
    #
    # @api public
    sig { returns(Version) }
    def clang_build_version
      @clang_build_version ||= T.let(
        if (path = locate("clang")) &&
          (build_version = `#{path} --version`[%r{clang(-| version [^ ]+ \(tags/RELEASE_)(\d{2,})}, 2])
          Version.new(build_version)
        else
          Version::NULL
        end, T.nilable(Version)
      )
    end

    # Get the LLVM Clang build version.
    #
    # @api public
    sig { returns(Version) }
    def llvm_clang_build_version
      @llvm_clang_build_version ||= T.let(begin
        path = Formulary.factory("llvm").opt_prefix/"bin/clang"
        if path.executable? && (build_version = `#{path} --version`[/clang version (\d+\.\d\.\d)/, 1])
          Version.new(build_version)
        else
          Version::NULL
        end
      end, T.nilable(Version))
    end

    # Get the GCC version.
    #
    # @api internal
    sig { params(cc: String).returns(Version) }
    def gcc_version(cc)
      (@gcc_version ||= T.let({}, T.nilable(T::Hash[String, Version]))).fetch(cc) do
        path = HOMEBREW_PREFIX/"opt/#{CompilerSelector.preferred_gcc}/bin"/cc
        path = locate(cc) unless path.exist?
        version = if path &&
                     (build_version = `#{path} --version`[/gcc(?:(?:-\d+(?:\.\d)?)? \(.+\))? (\d+\.\d\.\d)/, 1])
          Version.new(build_version)
        else
          Version::NULL
        end
        @gcc_version[cc] = version
      end
    end

    sig { void }
    def clear_version_cache
      @clang_version = @clang_build_version = T.let(nil, T.nilable(Version))
      @gcc_version = T.let({}, T.nilable(T::Hash[String, Version]))
    end

    sig { returns(T::Boolean) }
    def needs_build_formulae?
      needs_libc_formula? || needs_compiler_formula?
    end

    sig { returns(T::Boolean) }
    def needs_libc_formula?
      false
    end

    sig { returns(T::Boolean) }
    def needs_compiler_formula?
      false
    end

    sig { returns(T::Boolean) }
    def ca_file_handles_most_https_certificates?
      # The system CA file is too old for some modern HTTPS certificates on
      # older OS versions.
      ENV["HOMEBREW_SYSTEM_CA_CERTIFICATES_TOO_OLD"].nil?
    end

    sig { returns(T::Boolean) }
    def curl_handles_most_https_certificates?
      true
    end

    sig { returns(T::Boolean) }
    def ca_file_substitution_required?
      (!ca_file_handles_most_https_certificates? || ENV["HOMEBREW_FORCE_BREWED_CA_CERTIFICATES"].present?) &&
        !(HOMEBREW_PREFIX/"etc/ca-certificates/cert.pem").exist?
    end

    sig { returns(T::Boolean) }
    def curl_substitution_required?
      !curl_handles_most_https_certificates? && !HOMEBREW_BREWED_CURL_PATH.exist?
    end

    sig { returns(T::Boolean) }
    def subversion_handles_most_https_certificates?
      true
    end

    sig { returns(T::Hash[String, T.nilable(String)]) }
    def build_system_info
      {
        "os"         => HOMEBREW_SYSTEM,
        "os_version" => OS_VERSION,
        "cpu_family" => Hardware::CPU.family.to_s,
      }
    end
    alias generic_build_system_info build_system_info
  end
end

require "extend/os/development_tools"