Module: OS::Mac Private
- Defined in:
- os/mac.rb,
os/linux.rb,
cask/macos.rb,
os/mac/sdk.rb,
os/mac/xcode.rb
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.
Defined Under Namespace
Modules: CLT, Xcode Classes: CLTSDKLocator, SDK, XcodeSDKLocator
Class Method Summary collapse
- .active_developer_dir ⇒ String private
- .app_with_bundle_id(*ids) ⇒ Pathname? private
-
.full_version ⇒ MacOSVersion
internal
This can be compared to numerics, strings, or symbols using the standard Ruby Comparable methods.
- .full_version=(version) ⇒ void private
- .language ⇒ Object private
- .languages ⇒ Object private
- .latest_sdk_version ⇒ ::Version private
-
.macports_or_fink ⇒ Object
private
See these issues for some history:.
- .mdfind(*ids) ⇒ Array<String> private
- .mdfind_query(*ids) ⇒ String private
- .pkgutil_info(id) ⇒ Object private
- .preferred_perl_version ⇒ String private
- .sdk(version = nil) ⇒ Object private
- .sdk_for_formula(formula, version = nil, check_only_runtime_requirements: false) ⇒ Object private
-
.sdk_locator ⇒ Object
private
If a specific SDK is requested:.
-
.sdk_path(_version = nil) ⇒ Object
private
Returns the path to an SDK or nil, following the rules set by Mac.sdk.
- .sdk_path_if_needed(_version = nil) ⇒ Object private
- .sdk_root_needed? ⇒ Boolean private
- .system_dir?(dir) ⇒ Boolean private
- .undeletable?(path) ⇒ Boolean private
-
.version ⇒ MacOSVersion
internal
This can be compared to numerics, strings, or symbols using the standard Ruby Comparable methods.
Class Method Details
.active_developer_dir ⇒ 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.
90 91 92 |
# File 'os/mac.rb', line 90 def self.active_developer_dir @active_developer_dir ||= Utils.popen_read("/usr/bin/xcode-select", "-print-path").strip end |
.app_with_bundle_id(*ids) ⇒ 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.
200 201 202 203 204 205 |
# File 'os/mac.rb', line 200 def self.app_with_bundle_id(*ids) path = mdfind(*ids) .reject { |p| p.include?("/Backups.backupdb/") } .first Pathname.new(path) if path.present? end |
.full_version ⇒ MacOSVersion
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.
This can be compared to numerics, strings, or symbols using the standard Ruby Comparable methods.
37 38 39 40 41 42 43 44 |
# File 'os/mac.rb', line 37 def self.full_version odisabled "`MacOS.full_version` on Linux" if Homebrew::SimulateSystem.simulating_or_running_on_linux? @full_version ||= if (fake_macos = ENV.fetch("HOMEBREW_FAKE_MACOS", nil)) # for Portable Ruby building MacOSVersion.new(fake_macos) else MacOSVersion.new(VERSION) end end |
.full_version=(version) ⇒ void
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.
This method returns an undefined value.
47 48 49 50 |
# File 'os/mac.rb', line 47 def self.full_version=(version) @full_version = MacOSVersion.new(version.chomp) @version = nil end |
.language ⇒ Object
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.
84 85 86 87 |
# File 'os/mac.rb', line 84 def self.language odisabled "`MacOS.language` on Linux" if Homebrew::SimulateSystem.simulating_or_running_on_linux? languages.first end |
.languages ⇒ Object
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.
70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'os/mac.rb', line 70 def self.languages odisabled "`MacOS.languages` on Linux" if Homebrew::SimulateSystem.simulating_or_running_on_linux? return @languages if @languages os_langs = Utils.popen_read("defaults", "read", "-g", "AppleLanguages") if os_langs.blank? # User settings don't exist so check the system-wide one. os_langs = Utils.popen_read("defaults", "read", "/Library/Preferences/.GlobalPreferences", "AppleLanguages") end os_langs = os_langs.scan(/[^ \n"(),]+/) @languages = os_langs end |
.latest_sdk_version ⇒ ::Version
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.
53 54 55 56 57 |
# File 'os/mac.rb', line 53 def self.latest_sdk_version # TODO: bump version when new Xcode macOS SDK is released # NOTE: We only track the major version of the SDK. ::Version.new("13") end |
.macports_or_fink ⇒ Object
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.
See these issues for some history:
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'os/mac.rb', line 170 def self.macports_or_fink paths = [] # First look in the path because MacPorts is relocatable and Fink # may become relocatable in the future. %w[port fink].each do |ponk| path = which(ponk) paths << path unless path.nil? end # Look in the standard locations, because even if port or fink are # not in the path they can still break builds if the build scripts # have these paths baked in. %w[/sw/bin/fink /opt/local/bin/port].each do |ponk| path = Pathname.new(ponk) paths << path if path.exist? end # Finally, some users make their MacPorts or Fink directories # read-only in order to try out Homebrew, but this doesn't work as # some build scripts error out when trying to read from these now # unreadable paths. %w[/sw /opt/local].map { |p| Pathname.new(p) }.each do |path| paths << path if path.exist? && !path.readable? end paths.uniq end |
.mdfind(*ids) ⇒ Array<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.
208 209 210 211 212 |
# File 'os/mac.rb', line 208 def self.mdfind(*ids) (@mdfind ||= {}).fetch(ids) do @mdfind[ids] = Utils.popen_read("/usr/bin/mdfind", mdfind_query(*ids)).split("\n") end end |
.mdfind_query(*ids) ⇒ 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.
221 222 223 |
# File 'os/mac.rb', line 221 def self.mdfind_query(*ids) ids.map! { |id| "kMDItemCFBundleIdentifier == #{id}" }.join(" || ") end |
.pkgutil_info(id) ⇒ Object
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.
214 215 216 217 218 |
# File 'os/mac.rb', line 214 def self.pkgutil_info(id) (@pkginfo ||= {}).fetch(id) do |key| @pkginfo[key] = Utils.popen_read("/usr/sbin/pkgutil", "--pkg-info", key).strip end end |
.preferred_perl_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.
60 61 62 63 64 65 66 67 68 |
# File 'os/mac.rb', line 60 def self.preferred_perl_version if version >= :sonoma "5.34" elsif version >= :big_sur "5.30" else "5.18" end end |
.sdk(version = nil) ⇒ Object
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.
125 126 127 |
# File 'os/mac.rb', line 125 def self.sdk(version = nil) sdk_locator.sdk_if_applicable(version) end |
.sdk_for_formula(formula, version = nil, check_only_runtime_requirements: false) ⇒ Object
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.
129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'os/mac.rb', line 129 def self.sdk_for_formula(formula, version = nil, check_only_runtime_requirements: false) # If the formula requires Xcode, don't return the CLT SDK # If check_only_runtime_requirements is true, don't necessarily return the # Xcode SDK if the XcodeRequirement is only a build or test requirement. return Xcode.sdk if formula.requirements.any? do |req| next false unless req.is_a? XcodeRequirement next false if check_only_runtime_requirements && req.build? && !req.test? true end sdk(version) end |
.sdk_locator ⇒ Object
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.
If a specific SDK is requested:
- The requested SDK is returned, if it's installed.
- If the requested SDK is not installed, the newest SDK (if any SDKs are available) is returned.
- If no SDKs are available, nil is returned.
If no specific SDK is requested, the SDK matching the OS version is returned, if available. Otherwise, the latest SDK is returned.
117 118 119 120 121 122 123 |
# File 'os/mac.rb', line 117 def self.sdk_locator if CLT.installed? && CLT.provides_sdk? CLT.sdk_locator else Xcode.sdk_locator end end |
.sdk_path(_version = nil) ⇒ Object
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 the path to an SDK or nil, following the rules set by sdk.
144 145 146 147 148 |
# File 'os/mac.rb', line 144 def self.sdk_path(version = nil) odisabled "`MacOS.sdk_path` on Linux" if Homebrew::SimulateSystem.simulating_or_running_on_linux? s = sdk(version) s&.path end |
.sdk_path_if_needed(_version = nil) ⇒ Object
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.
150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'os/mac.rb', line 150 def self.sdk_path_if_needed(version = nil) odisabled "`MacOS.sdk_path_if_needed` on Linux" if Homebrew::SimulateSystem.simulating_or_running_on_linux? # Prefer CLT SDK when both Xcode and the CLT are installed. # Expected results: # 1. On Xcode-only systems, return the Xcode SDK. # 2. On Xcode-and-CLT systems where headers are provided by the system, return nil. # 3. On CLT-only systems with no CLT SDK, return nil. # 4. On CLT-only systems with a CLT SDK, where headers are provided by the system, return nil. # 5. On CLT-only systems with a CLT SDK, where headers are not provided by the system, return the CLT SDK. return unless sdk_root_needed? sdk_path(version) end |
.sdk_root_needed? ⇒ 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.
95 96 97 98 99 100 101 102 103 104 105 |
# File 'os/mac.rb', line 95 def self.sdk_root_needed? odisabled "`MacOS.sdk_root_needed?` on Linux" if Homebrew::SimulateSystem.simulating_or_running_on_linux? if MacOS::CLT.installed? # If there's no CLT SDK, return false return false unless MacOS::CLT.provides_sdk? # If the CLT is installed and headers are provided by the system, return false return false unless MacOS::CLT.separate_header_package? end true end |
.system_dir?(dir) ⇒ 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.
384 385 386 |
# File 'cask/macos.rb', line 384 def system_dir?(dir) SYSTEM_DIRS.include?(Pathname.new(dir).) end |
.undeletable?(path) ⇒ 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.
388 389 390 |
# File 'cask/macos.rb', line 388 def undeletable?(path) UNDELETABLE_PATHS.include?(Pathname.new(path).) end |
.version ⇒ MacOSVersion
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.
This can be compared to numerics, strings, or symbols using the standard Ruby Comparable methods.
28 29 30 |
# File 'os/mac.rb', line 28 def self.version @version ||= full_version.strip_patch end |