Module: OS::Mac::Xcode Private

Extended by:
T::Sig
Defined in:
os/mac/xcode.rb,
os/linux.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 Xcode information.

Constant Summary collapse

DEFAULT_BUNDLE_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.

Pathname("/Applications/Xcode.app").freeze
BUNDLE_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.

"com.apple.dt.Xcode"
OLD_BUNDLE_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.

"com.apple.Xcode"

Class Method Summary collapse

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.

Returns:

  • (Boolean)


60
61
62
63
64
# File 'os/mac/xcode.rb', line 60

def below_minimum_version?
  return false unless installed?

  version < minimum_version
end

.bundle_pathObject

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.



112
113
114
115
116
117
118
119
120
# File 'os/mac/xcode.rb', line 112

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

.default_prefix?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:

  • (Boolean)


234
235
236
# File 'os/mac/xcode.rb', line 234

def default_prefix?
  prefix.to_s == "/Applications/Xcode.app/Contents/Developer"
end

.detect_versionObject

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.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# File 'os/mac/xcode.rb', line 177

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 "798.0" then return "2.5"
    when "515.0" then return "2.0"
    end
  end

  detect_version_from_clang_version
end

.detect_version_from_clang_versionString

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:



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'os/mac/xcode.rb', line 205

def detect_version_from_clang_version
  version = DevelopmentTools.clang_version

  return "dunno" if 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 version
  when "6.0.0"  then "6.2"
  when "6.1.0"  then "6.4"
  when "7.0.0"  then "7.1"
  when "7.0.2"  then "7.2.1"
  when "7.3.0"  then "7.3.1"
  when "8.0.0"  then "8.2.1"
  when "8.1.0"  then "8.3.3"
  when "9.0.0"  then "9.2"
  when "9.1.0"  then "9.4.1"
  when "10.0.0" then "10.1"
  when "10.0.1" then "10.3"
  when "11.0.0" then "11.3.1"
  when "11.0.3" then "11.7"
  when "12.0.0" then "12.4"
  when "13.0.0" then "13.0"
  else               "12.5"
  end
end

.installation_instructionsObject

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.



139
140
141
142
143
144
145
146
147
148
149
150
# File 'os/mac/xcode.rb', line 139

def installation_instructions
  if OS::Mac.version.prerelease?
    <<~EOS
      Xcode can be installed from:
        #{Formatter.url("https://developer.apple.com/download/more/")}
    EOS
  else
    <<~EOS
      Xcode can be installed from the App Store.
    EOS
  end
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:

  • (Boolean)


123
124
125
# File 'os/mac/xcode.rb', line 123

def installed?
  false
end

.latest_sdk_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.

Returns:

  • (Boolean)


67
68
69
# File 'os/mac/xcode.rb', line 67

def latest_sdk_version?
  OS::Mac.full_version >= OS::Mac.latest_sdk_version
end

.latest_version(macos: MacOS.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 a new version is available from the App Store and our CI systems have been updated. This may be a beta version for a beta macOS.

Parameters:

  • macos (MacOS::Version) (defaults to: MacOS.version)

Returns:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# File 'os/mac/xcode.rb', line 22

def latest_version(macos: MacOS.version)
  latest_stable = "12.5"
  case macos
  when "12" then "13.0"
  when "11" then latest_stable
  when "10.15" then "12.4"
  when "10.14" then "11.3.1"
  when "10.13" then "10.1"
  when "10.12" then "9.2"
  when "10.11" then "8.2.1"
  when "10.10" then "7.2.1"
  when "10.9"  then "6.2"
  else
    raise "macOS '#{MacOS.version}' is invalid" unless OS::Mac.version.prerelease?

    # Default to newest known version of Xcode for unreleased macOS versions.
    latest_stable
  end
end

.minimum_versionString

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 Xcode release on that macOS version (which may initially be a beta if that version of macOS is also in beta).

Returns:



47
48
49
50
51
52
53
54
55
56
57
# File 'os/mac/xcode.rb', line 47

def minimum_version
  case MacOS.version
  when "12" then "13.0"
  when "11" then "12.2"
  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

.needs_clt_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:

  • (Boolean)


72
73
74
75
76
# File 'os/mac/xcode.rb', line 72

def needs_clt_installed?
  return false if latest_sdk_version?

  without_clt?
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.

Returns:

  • (Boolean)


79
80
81
82
83
# File 'os/mac/xcode.rb', line 79

def outdated?
  return false unless installed?

  version < latest_version
end

.prefixObject

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 a Pathname object corresponding to Xcode.app’s Developer directory or nil if Xcode.app is not installed.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'os/mac/xcode.rb', line 92

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

.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.



131
132
133
# File 'os/mac/xcode.rb', line 131

def sdk(v = nil)
  sdk_locator.sdk_if_applicable(v)
end

.sdk_locatorObject

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.



127
128
129
# File 'os/mac/xcode.rb', line 127

def sdk_locator
  @sdk_locator ||= XcodeSDKLocator.new
end

.sdk_path(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.



135
136
137
# File 'os/mac/xcode.rb', line 135

def sdk_path(v = nil)
  sdk(v)&.path
end

.toolchain_pathPathname

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:



108
109
110
# File 'os/mac/xcode.rb', line 108

def toolchain_path
  Pathname("#{prefix}/Toolchains/XcodeDefault.xctoolchain")
end

.update_instructionsString

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:



153
154
155
156
157
158
159
160
161
162
163
164
# File 'os/mac/xcode.rb', line 153

def update_instructions
  if OS::Mac.version.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

.versionObject

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.



73
74
75
# File 'os/linux.rb', line 73

def version
  Version::NULL
end

.without_clt?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:

  • (Boolean)


86
87
88
# File 'os/mac/xcode.rb', line 86

def without_clt?
  !MacOS::CLT.installed?
end