Module: OS::Mac::Xcode

Defined in:
brew/Library/Homebrew/os/linux.rb,
brew/Library/Homebrew/os/mac/xcode.rb

Constant Summary collapse

DEFAULT_BUNDLE_PATH =
Pathname.new("/Applications/Xcode.app").freeze
BUNDLE_ID =
"com.apple.dt.Xcode"
OLD_BUNDLE_ID =
"com.apple.Xcode"

Class Method Summary collapse

Class Method Details

.below_minimum_version?Boolean

Returns:

  • (Boolean)


39
40
41
42
43
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 39

def below_minimum_version?
  return false unless installed?

  version < minimum_version
end

.bundle_pathObject



86
87
88
89
90
91
92
93
94
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 86

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

Returns:

  • (Boolean)


184
185
186
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 184

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

.detect_versionObject



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 134

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

  detect_version_from_clang_version
end

.detect_version_from_clang_versionObject



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 161

def detect_version_from_clang_version
  return "dunno" if DevelopmentTools.clang_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 (DevelopmentTools.clang_version.to_f * 10).to_i
  when 0       then "dunno"
  when 60      then "6.0"
  when 61      then "6.1"
  when 70      then "7.0"
  when 73      then "7.3"
  when 80      then "8.0"
  when 81      then "8.3"
  when 90      then "9.2"
  when 91      then "9.4"
  when 100     then "10.2.1"
  when 110     then "11.0"
  else              "11.0"
  end
end

.installed?Boolean

Returns:

  • (Boolean)


96
97
98
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 96

def installed?
  !prefix.nil?
end

.latest_sdk_version?Boolean

Returns:

  • (Boolean)


45
46
47
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 45

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

.latest_versionObject



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 12

def latest_version
  case MacOS.version
  when "10.9"  then "6.2"
  when "10.10" then "7.2.1"
  when "10.11" then "8.2.1"
  when "10.12" then "9.2"
  when "10.13" then "10.1"
  when "10.14" then "10.2.1"
  when "10.15" then "11.0"
  else
    raise "macOS '#{MacOS.version}' is invalid" unless OS::Mac.prerelease?

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

.minimum_versionObject



29
30
31
32
33
34
35
36
37
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 29

def minimum_version
  case MacOS.version
  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

Returns:

  • (Boolean)


49
50
51
52
53
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 49

def needs_clt_installed?
  return false if latest_sdk_version?

  without_clt?
end

.outdated?Boolean

Returns:

  • (Boolean)


55
56
57
58
59
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 55

def outdated?
  return false unless installed?

  version < latest_version
end

.prefixObject

Returns a Pathname object corresponding to Xcode.app’s Developer directory or nil if Xcode.app is not installed



67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 67

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



100
101
102
103
104
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 100

def sdk(v = nil)
  @locator ||= XcodeSDKLocator.new

  @locator.sdk_if_applicable(v)
end

.sdk_path(v = nil) ⇒ Object



106
107
108
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 106

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

.toolchain_pathObject



82
83
84
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 82

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

.update_instructionsObject



110
111
112
113
114
115
116
117
118
119
120
121
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 110

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



59
60
61
# File 'brew/Library/Homebrew/os/linux.rb', line 59

def version
  Version::NULL
end

.without_clt?Boolean

Returns:

  • (Boolean)


61
62
63
# File 'brew/Library/Homebrew/os/mac/xcode.rb', line 61

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