Module: SharedEnvExtension Private

Extended by:
T::Helpers
Includes:
CompilerConstants, OS::Linux::SharedEnvExtension, OS::Mac::SharedEnvExtension, Utils::Output::Mixin
Included in:
EnvActivation, Stdenv, Superenv
Defined in:
extend/ENV/shared.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.

Homebrew extends Ruby's ENV to make our code more readable. Implemented in SharedEnvExtension and either Superenv or Stdenv (depending on the build mode).

See Also:

Constant Summary

Constants included from CompilerConstants

CompilerConstants::COMPILERS, CompilerConstants::COMPILER_SYMBOL_MAP, CompilerConstants::GNU_GCC_REGEXP, CompilerConstants::GNU_GCC_VERSIONS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils::Output::Mixin

#issue_reporting_message, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #opoo_without_github_actions_annotation, #pretty_cannot_install, #pretty_deprecated, #pretty_disabled, #pretty_duration, #pretty_install_status, #pretty_installed, #pretty_uninstalled, #pretty_unmarked, #pretty_upgradable, #pretty_warning

Instance Attribute Details

#bottle_arch ⇒ String? (readonly)

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:



42
43
44
 
# File 'extend/ENV/shared.rb', line 42

def bottle_arch
  @bottle_arch
end

Instance Method Details

#append(keys, value, separator = " ") ⇒ 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.

Parameters:



99
100
101
102
103
104
105
106
107
108
109
 
# File 'extend/ENV/shared.rb', line 99

def append(keys, value, separator = " ")
  value = value.to_s
  Array(keys).each do |key|
    old_value = self[key]
    self[key] = if old_value.blank?
      value
    else
      old_value + separator + value
    end
  end
end

#append_path(key, path) ⇒ 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.

Parameters:



125
126
127
 
# File 'extend/ENV/shared.rb', line 125

def append_path(key, path)
  self[key] = PATH.new(self[key]).append(path).to_s
end

#append_to_cccfg(value) ⇒ 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.

Parameters:



94
95
96
 
# File 'extend/ENV/shared.rb', line 94

def append_to_cccfg(value)
  append("HOMEBREW_CCCFG", value, "")
end

#append_to_cflags(newflags) ⇒ 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.

Parameters:



84
85
86
 
# File 'extend/ENV/shared.rb', line 84

def append_to_cflags(newflags)
  append(CC_FLAG_VARS, newflags)
end

#append_to_rustflags(rustflags) ⇒ 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.

Parameters:



130
131
132
 
# File 'extend/ENV/shared.rb', line 130

def append_to_rustflags(rustflags)
  append("HOMEBREW_RUSTFLAGS", rustflags)
end

#build_bottle? ⇒ 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) 


66
 
# File 'extend/ENV/shared.rb', line 66

def build_bottle? = @build_bottle == true

#cc ⇒ 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.

Returns:



173
174
175
 
# File 'extend/ENV/shared.rb', line 173

def cc
  self["CC"]
end

#cflags ⇒ 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.

Returns:



183
184
185
 
# File 'extend/ENV/shared.rb', line 183

def cflags
  self["CFLAGS"]
end

#compiler ⇒ Symbol, 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.

Outputs the current compiler.

# Do something only for the system clang
if ENV.compiler == :clang
  # modify CFLAGS CXXFLAGS OBJCFLAGS OBJCXXFLAGS in one go:
  ENV.append_to_cflags "-I ./missing/includes"
end

Returns:



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'extend/ENV/shared.rb', line 224

def compiler
  @compiler ||= T.let(nil, T.nilable(T.any(Symbol, String)))
  @compiler ||= if (cc = @cc)
    warn_about_non_apple_gcc(cc) if cc.match?(GNU_GCC_REGEXP)

    fetch_compiler(cc, "--cc")
  elsif (cc = homebrew_cc)
    warn_about_non_apple_gcc(cc) if cc.match?(GNU_GCC_REGEXP)

    compiler = fetch_compiler(cc, "HOMEBREW_CC")

    if @formula
      compilers = [compiler] + CompilerSelector.compilers
      compiler = CompilerSelector.select_for(@formula, compilers, testing_formula: @testing_formula == true)
    end

    compiler
  elsif @formula
    CompilerSelector.select_for(@formula, testing_formula: @testing_formula == true)
  else
    DevelopmentTools.default_compiler
  end
end

#cppflags ⇒ 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.

Returns:



193
194
195
 
# File 'extend/ENV/shared.rb', line 193

def cppflags
  self["CPPFLAGS"]
end

#cxx ⇒ 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.

Returns:



178
179
180
 
# File 'extend/ENV/shared.rb', line 178

def cxx
  self["CXX"]
end

#cxxflags ⇒ 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.

Returns:



188
189
190
 
# File 'extend/ENV/shared.rb', line 188

def cxxflags
  self["CXXFLAGS"]
end

#debug_symbols? ⇒ 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) 


69
 
# File 'extend/ENV/shared.rb', line 69

def debug_symbols? = @debug_symbols == true

#effective_arch ⇒ Symbol

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:



300
301
302
303
304
305
306
 
# File 'extend/ENV/shared.rb', line 300

def effective_arch
  if @build_bottle && @bottle_arch
    @bottle_arch.to_sym
  else
    Hardware.oldest_cpu
  end
end

#fc ⇒ 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.

Returns:



203
204
205
 
# File 'extend/ENV/shared.rb', line 203

def fc
  self["FC"]
end

#fcflags ⇒ 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.

Returns:



213
214
215
 
# File 'extend/ENV/shared.rb', line 213

def fcflags
  self["FCFLAGS"]
end

#fflags ⇒ 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.

Returns:



208
209
210
 
# File 'extend/ENV/shared.rb', line 208

def fflags
  self["FFLAGS"]
end

#fortran ⇒ 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.



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'extend/ENV/shared.rb', line 269

def fortran
  # Ignore repeated calls to this function as it will misleadingly warn about
  # building with an alternative Fortran compiler without optimization flags,
  # despite it often being the Homebrew-provided one set up in the first call.
  return if @fortran_setup_done

  @fortran_setup_done = T.let(true, T.nilable(TrueClass))

  flags = []

  if fc
    opoo "Building with an unsupported Fortran compiler"
    self["F77"] ||= fc
  else
    if (gfortran = which("gfortran", (HOMEBREW_PREFIX/"bin").to_s))
      ohai "Using Homebrew-provided Fortran compiler"
    elsif (gfortran = which("gfortran", PATH.new(ORIGINAL_PATHS)))
      ohai "Using a Fortran compiler found at #{gfortran}"
    end
    if gfortran
      puts "This may be changed by setting the `$FC` environment variable."
      self["FC"] = self["F77"] = gfortran.to_s
      flags = FC_FLAG_VARS
    end
  end

  flags.each { |key| self[key] = cflags }
  set_cpu_flags(flags)
end

#ldflags ⇒ 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.

Returns:



198
199
200
 
# File 'extend/ENV/shared.rb', line 198

def ldflags
  self["LDFLAGS"]
end

#make_jobs ⇒ Integer

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:



346
347
348
 
# File 'extend/ENV/shared.rb', line 346

def make_jobs
  Homebrew::EnvConfig.make_jobs.to_i
end

#permit_arch_flags ⇒ 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.



343
 
# File 'extend/ENV/shared.rb', line 343

def permit_arch_flags; end

#prepend(keys, value, separator = " ") ⇒ 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.

Parameters:



112
113
114
115
116
117
118
119
120
121
122
 
# File 'extend/ENV/shared.rb', line 112

def prepend(keys, value, separator = " ")
  value = value.to_s
  Array(keys).each do |key|
    old_value = self[key]
    self[key] = if old_value.blank?
      value
    else
      value + separator + old_value
    end
  end
end

#prepend_create_path(key, path) ⇒ 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.

Parameters:



149
150
151
152
153
 
# File 'extend/ENV/shared.rb', line 149

def prepend_create_path(key, path)
  path = Pathname(path)
  path.mkpath
  prepend_path key, path
end

#prepend_path(key, path) ⇒ 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.

Prepends a directory to PATH. Is the formula struggling to find the pkgconfig file? Point it to it. This is done automatically for keg-only formulae.

ENV.prepend_path "PKG_CONFIG_PATH", "#{Formula["glib"].opt_lib}/pkgconfig"

Prepending a system path such as /usr/bin is a no-op so that requirements don't accidentally override superenv shims or formulae's bin directories.

ENV.prepend_path "PATH", which("emacs").dirname

Parameters:



142
143
144
145
146
 
# File 'extend/ENV/shared.rb', line 142

def prepend_path(key, path)
  return if %w[/usr/bin /bin /usr/sbin /sbin].include? path.to_s

  self[key] = PATH.new(self[key]).prepend(path).to_s
end

#refurbish_args ⇒ 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.



351
 
# File 'extend/ENV/shared.rb', line 351

def refurbish_args; end

#remove(keys, value) ⇒ 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.

Parameters:



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'extend/ENV/shared.rb', line 156

def remove(keys, value)
  return if value.nil?

  Array(keys).each do |key|
    old_value = self[key]
    next if old_value.nil?

    new_value = old_value.sub(value, "")
    if new_value.empty?
      delete(key)
    else
      self[key] = new_value
    end
  end
end

#remove_cc_etc ⇒ Hash{String => String, nil}

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:



78
79
80
81
 
# File 'extend/ENV/shared.rb', line 78

def remove_cc_etc
  keys = %w[CC CXX OBJC OBJCXX LD CPP CFLAGS CXXFLAGS OBJCFLAGS OBJCXXFLAGS LDFLAGS CPPFLAGS]
  keys.to_h { |key| [key, delete(key)] }
end

#remove_from_cflags(val) ⇒ 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.

Parameters:



89
90
91
 
# File 'extend/ENV/shared.rb', line 89

def remove_from_cflags(val)
  remove CC_FLAG_VARS, val
end

#setup_build_environment(formula: nil, cc: nil, build_bottle: false, bottle_arch: nil, testing_formula: false, debug_symbols: false) ⇒ 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.

Parameters:

  • formula (Formula, nil) (defaults to: nil)
  • cc (String, nil) (defaults to: nil)
  • build_bottle (Boolean, nil) (defaults to: false)
  • bottle_arch (String, nil) (defaults to: nil)
  • testing_formula (Boolean) (defaults to: false)
  • debug_symbols (Boolean, nil) (defaults to: false) 


54
55
56
57
58
59
60
61
62
63
 
# File 'extend/ENV/shared.rb', line 54

def setup_build_environment(formula: nil, cc: nil, build_bottle: false, bottle_arch: nil, testing_formula: false,
                            debug_symbols: false)
  @formula = T.let(formula, T.nilable(Formula))
  @cc = T.let(cc, T.nilable(String))
  @build_bottle = T.let(build_bottle, T.nilable(T::Boolean))
  @bottle_arch = T.let(bottle_arch, T.nilable(String))
  @debug_symbols = T.let(debug_symbols, T.nilable(T::Boolean))
  @testing_formula = T.let(testing_formula, T.nilable(T::Boolean))
  reset
end