Module: OS::Mac
- Defined in:
- os/mac.rb,
os/linux.rb,
cask/macos.rb,
os/mac/sdk.rb,
os/mac/xcode.rb,
os/mac/version.rb
Defined Under Namespace
Modules: CLT, Xcode Classes: CLTSDKLocator, SDK, Version, XcodeSDKLocator
Class Method Summary collapse
-
.active_developer_dir ⇒ String
private
-
.app_with_bundle_id(*ids) ⇒ Pathname?
private
-
.full_version ⇒ Version
private
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(v = nil) ⇒ Object
private
-
.sdk_for_formula(f, v = nil, check_only_runtime_requirements: false) ⇒ Object
private
-
.sdk_locator ⇒ Object
private
If a specific SDK is requested:.
-
.sdk_path ⇒ Object
private
Returns the path to an SDK or nil, following the rules set by Mac.sdk.
-
.sdk_path_if_needed(_v = nil) ⇒ Object
private
-
.sdk_root_needed? ⇒ Boolean
private
-
.system_dir?(dir) ⇒ Boolean
-
.undeletable?(path) ⇒ Boolean
-
.version ⇒ Version
private
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.
82 83 84 |
# File 'os/mac.rb', line 82 def 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.
189 190 191 192 193 194 |
# File 'os/mac.rb', line 189 def app_with_bundle_id(*ids) path = mdfind(*ids) .reject { |p| p.include?("/Backups.backupdb/") } .first Pathname.new(path) if path.present? end |
.full_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.
This can be compared to numerics, strings, or symbols using the standard Ruby Comparable methods.
33 34 35 36 37 38 39 |
# File 'os/mac.rb', line 33 def full_version @full_version ||= if ENV["HOMEBREW_FAKE_EL_CAPITAN"] # for Portable Ruby building Version.new("10.11.6") else Version.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.
42 43 44 45 |
# File 'os/mac.rb', line 42 def full_version=(version) @full_version = Version.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.
77 78 79 |
# File 'os/mac.rb', line 77 def language 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.
64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'os/mac.rb', line 64 def languages 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.
48 49 50 51 52 |
# File 'os/mac.rb', line 48 def 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:
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'os/mac.rb', line 159 def 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.
197 198 199 200 201 |
# File 'os/mac.rb', line 197 def 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.
210 211 212 |
# File 'os/mac.rb', line 210 def 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.
203 204 205 206 207 |
# File 'os/mac.rb', line 203 def 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.
56 57 58 59 60 61 62 |
# File 'os/mac.rb', line 56 def preferred_perl_version if version >= :big_sur "5.30" else "5.18" end end |
.sdk(v = 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.
116 117 118 |
# File 'os/mac.rb', line 116 def sdk(v = nil) sdk_locator.sdk_if_applicable(v) end |
.sdk_for_formula(f, v = 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.
120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'os/mac.rb', line 120 def sdk_for_formula(f, v = 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 f.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(v) 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.
108 109 110 111 112 113 114 |
# File 'os/mac.rb', line 108 def sdk_locator if CLT.installed? && CLT.provides_sdk? CLT.sdk_locator else Xcode.sdk_locator end end |
.sdk_path ⇒ 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.
135 136 137 138 |
# File 'os/mac.rb', line 135 def sdk_path(v = nil) s = sdk(v) s&.path end |
.sdk_path_if_needed(_v = 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.
140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'os/mac.rb', line 140 def sdk_path_if_needed(v = nil) # 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(v) 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.
87 88 89 90 91 92 93 94 95 96 |
# File 'os/mac.rb', line 87 def sdk_root_needed? 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
386 387 388 |
# File 'cask/macos.rb', line 386 def system_dir?(dir) SYSTEM_DIRS.include?(Pathname.new(dir).) end |
.undeletable?(path) ⇒ Boolean
390 391 392 |
# File 'cask/macos.rb', line 390 def undeletable?(path) UNDELETABLE_PATHS.include?(Pathname.new(path).) end |
.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.
This can be compared to numerics, strings, or symbols using the standard Ruby Comparable methods.
26 27 28 |
# File 'os/mac.rb', line 26 def version @version ||= full_version.strip_patch end |