Class: Build Private

Inherits:
Object show all
Includes:
Utils::Output::Mixin
Defined in:
build.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

A formula build.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils::Output::Mixin

#odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled

Constructor Details

#initialize(formula, options, 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.

Parameters:



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'build.rb', line 39

def initialize(formula, options, args:)
  @formula = formula
  @formula.build = BuildOptions.new(options, formula.options)
  @args = T.let(args, Homebrew::Cmd::InstallCmd::Args)
  @deps = T.let([], T::Array[Dependency])
  @reqs = T.let(Requirements.new, Requirements)

  return if args.ignore_dependencies?

  @deps = expand_deps
  @reqs = expand_reqs
end

Instance Attribute Details

#args ⇒ Homebrew::Cmd::InstallCmd::Args (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:



36
37
38
 
# File 'build.rb', line 36

def args
  @args
end

#deps ⇒ Array<Dependency> (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:



30
31
32
 
# File 'build.rb', line 30

def deps
  @deps
end

#formula ⇒ Formula (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:



27
28
29
 
# File 'build.rb', line 27

def formula
  @formula
end

#reqs ⇒ Requirements (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:



33
34
35
 
# File 'build.rb', line 33

def reqs
  @reqs
end

Instance Method Details

#detect_stdlibs ⇒ Array<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:



220
221
222
223
224
225
226
227
 
# File 'build.rb', line 220

def detect_stdlibs
  keg = Keg.new(formula.prefix)

  # The stdlib recorded in the install receipt is used during dependency
  # compatibility checks, so we only care about the stdlib that libraries
  # link against.
  keg.detect_cxx_stdlibs(skip_executables: true)
end

#effective_build_options_for(dependent) ⇒ BuildOptions

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.

Parameters:

Returns:



53
54
55
56
57
 
# File 'build.rb', line 53

def effective_build_options_for(dependent)
  args  = dependent.build.used_options
  args |= Tab.for_formula(dependent).used_options
  BuildOptions.new(args, dependent.options)
end

#expand_deps ⇒ Array<Dependency>

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:



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'build.rb', line 70

def expand_deps
  formula.recursive_dependencies do |dependent, dep|
    build = effective_build_options_for(dependent)
    if dep.prune_from_option?(build) ||
       dep.prune_if_build_and_not_dependent?(dependent, formula) ||
       (dep.test? && !dep.build?) || dep.implicit?
      Dependency.prune
    elsif dep.build?
      Dependency.keep_but_prune_recursive_deps
    end
  end
end

#expand_reqs ⇒ Requirements

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:



60
61
62
63
64
65
66
67
 
# File 'build.rb', line 60

def expand_reqs
  formula.recursive_requirements do |dependent, req|
    build = effective_build_options_for(dependent)
    if req.prune_from_option?(build) || req.prune_if_build_and_not_dependent?(dependent, formula) || req.test?
      Requirement.prune
    end
  end
end

#fixopt(formula) ⇒ 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:



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'build.rb', line 230

def fixopt(formula)
  path = if formula.linked_keg.directory? && formula.linked_keg.symlink?
    formula.linked_keg.resolved_path
  elsif formula.prefix.directory?
    formula.prefix
  elsif (children = formula.rack.children.presence) && children.size == 1 &&
        (first_child = children.first.presence) && first_child.directory?
    first_child
  else
    raise
  end
  Keg.new(path).optlink(verbose: args.verbose?)
rescue
  raise "#{formula.opt_prefix} not present or broken\nPlease reinstall #{formula.full_name}. Sorry :("
end

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'build.rb', line 84

def install
  formula_deps = deps.map(&:to_formula)
  keg_only_deps = formula_deps.select(&:keg_only?)
  run_time_deps = deps.reject(&:build?).map(&:to_formula)

  formula_deps.each do |dep|
    fixopt(dep) unless dep.opt_prefix.directory?
  end

  ENV.activate_extensions!(env: args.env)

  if superenv?(args.env)
    superenv = ENV
    superenv.keg_only_deps = keg_only_deps
    superenv.deps = formula_deps
    superenv.run_time_deps = run_time_deps
    ENV.setup_build_environment(
      formula:,
      cc:            args.cc,
      build_bottle:  args.build_bottle?,
      bottle_arch:   args.bottle_arch,
      debug_symbols: args.debug_symbols?,
    )
    reqs.each do |req|
      req.modify_build_environment(
        env: args.env, cc: args.cc, build_bottle: args.build_bottle?, bottle_arch: args.bottle_arch,
      )
    end
  else
    ENV.setup_build_environment(
      formula:,
      cc:            args.cc,
      build_bottle:  args.build_bottle?,
      bottle_arch:   args.bottle_arch,
      debug_symbols: args.debug_symbols?,
    )
    reqs.each do |req|
      req.modify_build_environment(
        env: args.env, cc: args.cc, build_bottle: args.build_bottle?, bottle_arch: args.bottle_arch,
      )
    end

    keg_only_deps.each do |dep|
      ENV.prepend_path "PATH", dep.opt_bin.to_s
      ENV.prepend_path "PKG_CONFIG_PATH", "#{dep.opt_lib}/pkgconfig"
      ENV.prepend_path "PKG_CONFIG_PATH", "#{dep.opt_share}/pkgconfig"
      ENV.prepend_path "ACLOCAL_PATH", "#{dep.opt_share}/aclocal"
      ENV.prepend_path "CMAKE_PREFIX_PATH", dep.opt_prefix.to_s
      ENV.prepend "LDFLAGS", "-L#{dep.opt_lib}" if dep.opt_lib.directory?
      ENV.prepend "CPPFLAGS", "-I#{dep.opt_include}" if dep.opt_include.directory?
    end
  end

  new_env = {
    "TMPDIR" => HOMEBREW_TEMP.to_s,
    "TEMP"   => HOMEBREW_TEMP.to_s,
    "TMP"    => HOMEBREW_TEMP.to_s,
  }

  with_env(new_env) do
    if args.debug? && !Homebrew::EnvConfig.disable_debrew?
      require "debrew"
      formula.extend(Debrew::Formula)
    end

    formula.update_head_version

    formula.brew(
      fetch:         false,
      keep_tmp:      args.keep_tmp?,
      debug_symbols: args.debug_symbols?,
      interactive:   args.interactive?,
    ) do
      with_env(
        # For head builds, HOMEBREW_FORMULA_PREFIX should include the commit,
        # which is not known until after the formula has been staged.
        HOMEBREW_FORMULA_PREFIX:    formula.prefix,
        # https://reproducible-builds.org/docs/build-path/
        HOMEBREW_FORMULA_BUILDPATH: formula.buildpath,
        # https://reproducible-builds.org/docs/source-date-epoch/
        SOURCE_DATE_EPOCH:          formula.source_modified_time.to_i.to_s,
        # Avoid make getting confused about timestamps.
        # https://github.com/Homebrew/homebrew-core/pull/87470
        TZ:                         "UTC0",
      ) do
        if args.git?
          formula.selective_patch(is_data: false)
          system "git", "init"
          system "git", "add", "-A"
          formula.selective_patch(is_data: true)
        else
          formula.patch
        end

        if args.interactive?
          ohai "Entering interactive mode..."
          puts <<~EOS
            Type `exit` to return and finalize the installation.
            Install to this prefix: #{formula.prefix}
          EOS

          if args.git?
            puts <<~EOS
              This directory is now a Git repository. Make your changes and then use:
                git diff | pbcopy
              to copy the diff to the clipboard.
            EOS
          end

          interactive_shell(formula)
        else
          formula.prefix.mkpath
          formula.logs.mkpath

          (formula.logs/"00.options.out").write \
            "#{formula.full_name} #{formula.build.used_options.sort.join(" ")}".strip

          Pathname.prepend WriteMkpathExtension
          formula.install

          stdlibs = detect_stdlibs
          tab = Tab.create(formula, ENV.compiler, stdlibs.first)
          tab.write

          # Find and link metafiles
          formula.prefix.install_metafiles T.must(formula.buildpath)
          formula.prefix.install_metafiles formula.libexec if formula.libexec.exist?

          normalize_pod2man_outputs!(formula)
        end
      end
    end
  end
end

#normalize_pod2man_outputs!(formula) ⇒ 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:



247
248
249
250
 
# File 'build.rb', line 247

def normalize_pod2man_outputs!(formula)
  keg = Keg.new(formula.prefix)
  keg.normalize_pod2man_outputs!
end