Module: SharedEnvExtension

Extended by:
T::Sig
Included in:
Stdenv, Superenv
Defined in:
extend/os/mac/extend/ENV/shared.rb,
extend/os/linux/extend/ENV/shared.rb,
extend/ENV/shared.rb

Overview

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:

Instance Method Summary collapse

Instance Method Details

#append(keys, value, separator = " ") ⇒ void

This method returns an undefined value.

Parameters:



83
84
85
86
87
88
89
90
91
92
93
 
# File 'extend/ENV/shared.rb', line 83

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 returns an undefined value.

Parameters:



109
110
111
 
# File 'extend/ENV/shared.rb', line 109

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

#append_to_cccfg(value) ⇒ void

This method returns an undefined value.

Parameters:



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

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

#append_to_cflags(newflags) ⇒ void

This method returns an undefined value.

Parameters:



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

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

#cc ⇒ String?

Returns:



152
153
154
 
# File 'extend/ENV/shared.rb', line 152

def cc
  self["CC"]
end

#cflags ⇒ String?

Returns:



162
163
164
 
# File 'extend/ENV/shared.rb', line 162

def cflags
  self["CFLAGS"]
end

#compiler ⇒ Symbol, String

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:



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'extend/ENV/shared.rb', line 203

def compiler
  @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)
    end

    compiler
  elsif @formula
    CompilerSelector.select_for(@formula)
  else
    DevelopmentTools.default_compiler
  end
end

#cppflags ⇒ String?

Returns:



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

def cppflags
  self["CPPFLAGS"]
end

#cxx ⇒ String?

Returns:



157
158
159
 
# File 'extend/ENV/shared.rb', line 157

def cxx
  self["CXX"]
end

#cxxflags ⇒ String?

Returns:



167
168
169
 
# File 'extend/ENV/shared.rb', line 167

def cxxflags
  self["CXXFLAGS"]
end

#fc ⇒ String?

Returns:



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

def fc
  self["FC"]
end

#fcflags ⇒ String?

Returns:



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

def fcflags
  self["FCFLAGS"]
end

#fflags ⇒ String?

Returns:



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

def fflags
  self["FFLAGS"]
end

#fortran ⇒ void

This method returns an undefined value.



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'extend/ENV/shared.rb', line 242

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 = true

  flags = []

  if fc
    ohai "Building with an alternative Fortran compiler", "This is unsupported."
    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
      flags = FC_FLAG_VARS
    end
  end

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

#ldflags ⇒ String?

Returns:



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

def ldflags
  self["LDFLAGS"]
end

#no_weak_imports_support? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
21
22
23
24
25
 
# File 'extend/os/mac/extend/ENV/shared.rb', line 18

def no_weak_imports_support?
  return false unless compiler == :clang

  return false if !MacOS::Xcode.version.null? && MacOS::Xcode.version < "8.0"
  return false if !MacOS::CLT.version.null? && MacOS::CLT.version < "8.0"

  true
end

#permit_arch_flags ⇒ void

This method returns an undefined value.



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

def permit_arch_flags; end

#prepend(keys, value, separator = " ") ⇒ void

This method returns an undefined value.

Parameters:



96
97
98
99
100
101
102
103
104
105
106
 
# File 'extend/ENV/shared.rb', line 96

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 returns an undefined value.

Parameters:



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

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

#prepend_path(key, path) ⇒ void

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:



121
122
123
124
125
 
# File 'extend/ENV/shared.rb', line 121

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)
end

#remove(keys, value) ⇒ void

This method returns an undefined value.

Parameters:



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'extend/ENV/shared.rb', line 135

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}

Returns:



62
63
64
65
 
# File 'extend/ENV/shared.rb', line 62

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

#remove_from_cflags(val) ⇒ void

This method returns an undefined value.

Parameters:



73
74
75
 
# File 'extend/ENV/shared.rb', line 73

def remove_from_cflags(val)
  remove CC_FLAG_VARS, val
end