Module: OS::Mac::CLT Private
- Defined in:
- os/mac/xcode.rb
Overview
This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.
Helper module for querying macOS Command Line Tools information.
Constant Summary collapse
- EXECUTABLE_PKG_ID =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
The original Mavericks CLT package ID
"com.apple.pkg.CLTools_Executables"
- MAVERICKS_NEW_PKG_ID =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
obsolete
"com.apple.pkg.CLTools_Base"
- PKG_PATH =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
"/Library/Developer/CommandLineTools"
Class Method Summary collapse
- .below_minimum_version? ⇒ Boolean private
- .detect_clang_version ⇒ String? private
- .detect_version ⇒ String? private
- .detect_version_from_clang_version ⇒ String? private
- .installation_instructions ⇒ String private
- .installation_then_reinstall_instructions ⇒ String private
-
.installed? ⇒ Boolean
private
Returns true even if outdated tools are installed.
-
.latest_clang_version ⇒ String
private
Bump these when the new version is distributed through Software Update and our CI systems have been updated.
-
.minimum_version ⇒ String
private
Bump these if things are badly broken (e.g. no SDK for this macOS) without this.
- .outdated? ⇒ Boolean private
- .provides_sdk? ⇒ Boolean private
- .reinstall_instructions(reason: "resolve your issues") ⇒ String private
- .sdk(version = nil) ⇒ SDK? private
- .sdk_locator ⇒ CLTSDKLocator private
- .sdk_path(version = nil) ⇒ Pathname? private
- .separate_header_package? ⇒ Boolean private
- .update_instructions ⇒ String private
-
.version ⇒ ::Version
internal
Version string (a pretty long one) of the CLT package.
Class Method Details
.below_minimum_version? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
412 413 414 415 416 |
# File 'os/mac/xcode.rb', line 412 def self.below_minimum_version? return false unless installed? version < minimum_version end |
.detect_clang_version ⇒ String?
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
427 428 429 430 |
# File 'os/mac/xcode.rb', line 427 def self.detect_clang_version version_output = Utils.popen_read("#{PKG_PATH}/usr/bin/clang", "--version") version_output[/clang-(\d+(\.\d+)+)/, 1] end |
.detect_version ⇒ String?
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
455 456 457 458 459 460 461 462 463 464 465 |
# File 'os/mac/xcode.rb', line 455 def self.detect_version version = T.let(nil, T.nilable(String)) [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_version_from_clang_version end |
.detect_version_from_clang_version ⇒ String?
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
433 434 435 436 437 438 |
# File 'os/mac/xcode.rb', line 433 def self.detect_version_from_clang_version clang_version = detect_clang_version return if clang_version.nil? MacOS::Xcode.detect_version_from_clang_version(Version.new(clang_version)) end |
.installation_instructions ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'os/mac/xcode.rb', line 310 def self.installation_instructions if MacOS.version == "10.14" # This is not available from `xcode-select` <<~EOS Install the Command Line Tools for Xcode 11.3.1 from: #{Formatter.url(MacOS::Xcode::APPLE_DEVELOPER_DOWNLOAD_URL)} EOS elsif OS::Mac.version.prerelease? <<~EOS Install the Command Line Tools for Xcode #{minimum_version.split(".").first} from: #{Formatter.url(MacOS::Xcode::APPLE_DEVELOPER_DOWNLOAD_URL)} EOS else <<~EOS Install the Command Line Tools: xcode-select --install EOS end end |
.installation_then_reinstall_instructions ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
363 364 365 366 367 368 |
# File 'os/mac/xcode.rb', line 363 def self.installation_then_reinstall_instructions <<~EOS #{installation_instructions} #{reinstall_instructions} EOS end |
.installed? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Returns true even if outdated tools are installed.
280 281 282 |
# File 'os/mac/xcode.rb', line 280 def self.installed? !version.null? end |
.latest_clang_version ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Bump these when the new version is distributed through Software Update and our CI systems have been updated.
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'os/mac/xcode.rb', line 373 def self.latest_clang_version case MacOS.version when "26" then "1700.3.9.908" when "15" then "1700.0.13.5" when "14" then "1600.0.26.6" when "13" then "1500.1.0.2.5" when "12" then "1400.0.29.202" when "11" then "1300.0.29.30" when "10.15" then "1200.0.32.29" when "10.14" then "1100.0.33.17" when "10.13" then "1000.10.44.2" when "10.12" then "900.0.39.2" else "800.0.42.1" end end |
.minimum_version ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Bump these if things are badly broken (e.g. no SDK for this macOS) without this. Generally this will be the first stable CLT release on that macOS version.
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 |
# File 'os/mac/xcode.rb', line 393 def self.minimum_version macos = MacOS.version case macos when "15" then "16.0.0" when "14" then "15.0.0" when "13" then "14.0.0" when "12" then "13.0.0" when "11" then "12.5.0" 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" when "10.11" then "7.3.0" else "#{macos}.0.0" end end |
.outdated? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
419 420 421 422 423 424 |
# File 'os/mac/xcode.rb', line 419 def self.outdated? clang_version = detect_clang_version return false unless clang_version ::Version.new(clang_version) < latest_clang_version end |
.provides_sdk? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
290 291 292 |
# File 'os/mac/xcode.rb', line 290 def self.provides_sdk? version >= "8" end |
.reinstall_instructions(reason: "resolve your issues") ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
331 332 333 334 335 336 337 338 339 340 341 |
# File 'os/mac/xcode.rb', line 331 def self.reinstall_instructions(reason: "resolve your issues") <<~EOS If that doesn't #{reason}, run: sudo rm -rf /Library/Developer/CommandLineTools sudo xcode-select --install Alternatively, manually download them from: #{Formatter.url(MacOS::Xcode::APPLE_DEVELOPER_DOWNLOAD_URL)}. You should download the Command Line Tools for Xcode #{MacOS::Xcode.latest_version}. EOS end |
.sdk(version = nil) ⇒ SDK?
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
300 301 302 |
# File 'os/mac/xcode.rb', line 300 def self.sdk(version = nil) sdk_locator.sdk_if_applicable(version) end |
.sdk_locator ⇒ CLTSDKLocator
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
295 296 297 |
# File 'os/mac/xcode.rb', line 295 def self.sdk_locator @sdk_locator ||= CLTSDKLocator.new end |
.sdk_path(version = nil) ⇒ Pathname?
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
305 306 307 |
# File 'os/mac/xcode.rb', line 305 def self.sdk_path(version = nil) sdk(version)&.path end |
.separate_header_package? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
285 286 287 |
# File 'os/mac/xcode.rb', line 285 def self.separate_header_package? version >= "10" && MacOS.version >= "10.14" end |
.update_instructions ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 |
# File 'os/mac/xcode.rb', line 344 def self.update_instructions return installation_instructions if OS::Mac.version.prerelease? software_update_location = if MacOS.version >= "13" "System Settings" elsif MacOS.version >= "10.14" "System Preferences" else "the App Store" end <<~EOS Update them from Software Update in #{software_update_location}. #{reinstall_instructions(reason: "show you any updates")} EOS end |
.version ⇒ ::Version
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Version string (a pretty long one) of the CLT package. Note that the different ways of installing the CLTs lead to different version numbers.
446 447 448 449 450 451 452 |
# File 'os/mac/xcode.rb', line 446 def self.version if @version ||= detect_version ::Version.new @version else ::Version::NULL end end |