Module: SharedEnvExtension

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

Instance Method Summary collapse

Instance Method Details

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

This method returns an undefined value.

Parameters:



86
87
88
89
90
91
92
93
94
95
96
# File 'extend/ENV/shared.rb', line 86

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:



112
113
114
# File 'extend/ENV/shared.rb', line 112

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:



81
82
83
# File 'extend/ENV/shared.rb', line 81

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

#append_to_cflags(newflags) ⇒ void

This method returns an undefined value.

Parameters:



71
72
73
# File 'extend/ENV/shared.rb', line 71

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

#ccString?

Returns:



155
156
157
# File 'extend/ENV/shared.rb', line 155

def cc
  self["CC"]
end

#cflagsString?

Returns:



165
166
167
# File 'extend/ENV/shared.rb', line 165

def cflags
  self["CFLAGS"]
end

#compilerSymbol, 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:



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

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

#cppflagsString?

Returns:



175
176
177
# File 'extend/ENV/shared.rb', line 175

def cppflags
  self["CPPFLAGS"]
end

#cxxString?

Returns:



160
161
162
# File 'extend/ENV/shared.rb', line 160

def cxx
  self["CXX"]
end

#cxxflagsString?

Returns:



170
171
172
# File 'extend/ENV/shared.rb', line 170

def cxxflags
  self["CXXFLAGS"]
end

#fcString?

Returns:



185
186
187
# File 'extend/ENV/shared.rb', line 185

def fc
  self["FC"]
end

#fcflagsString?

Returns:



195
196
197
# File 'extend/ENV/shared.rb', line 195

def fcflags
  self["FCFLAGS"]
end

#fflagsString?

Returns:



190
191
192
# File 'extend/ENV/shared.rb', line 190

def fflags
  self["FFLAGS"]
end

#fortranvoid

This method returns an undefined value.



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
271
272
273
# File 'extend/ENV/shared.rb', line 245

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

#ldflagsString?

Returns:



180
181
182
# File 'extend/ENV/shared.rb', line 180

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_flagsvoid

This method returns an undefined value.



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

def permit_arch_flags; end

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

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



131
132
133
134
135
# File 'extend/ENV/shared.rb', line 131

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:



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

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:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'extend/ENV/shared.rb', line 138

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_etcHash{String => String}

Returns:



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

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

Parameters:



76
77
78
# File 'extend/ENV/shared.rb', line 76

def remove_from_cflags(val)
  remove CC_FLAG_VARS, val
end