Module: MachOShim Private

Extended by:
Forwardable
Includes:
Kernel
Included in:
Pathname
Defined in:
os/mac/mach.rb,
os/mac/mach.rbi,
sorbet/rbi/parlour.rbi

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.

Constant Summary

Constants included from Kernel

Kernel::IGNORE_INTERRUPTS_MUTEX

Instance Method Summary collapse

Methods included from Kernel

#disk_usage_readable, #ensure_executable!, #ensure_formula_installed!, #exec_browser, #exec_editor, #ignore_interrupts, #interactive_shell, #number_readable, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #paths, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled, #quiet_system, #redact_secrets, #redirect_stdout, #require?, #safe_system, #tap_and_name_comparison, #truncate_text_to_approximate_size, #which, #which_all, #which_editor, #with_custom_locale, #with_env, #with_homebrew_path

Instance Method Details

#arch ⇒ Object

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. 



130
131
132
133
134
135
136
 
# File 'os/mac/mach.rb', line 130

def arch
  case archs.length
  when 0 then :dunno
  when 1 then archs.first
  else :universal
  end
end

#archs ⇒ Object

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. 



126
127
128
 
# File 'os/mac/mach.rb', line 126

def archs
  mach_data.map { |m| m.fetch :arch }
end

#change_dylib_id(id, **options) ⇒ Object

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. 



78
79
80
81
 
# File 'os/mac/mach.rb', line 78

def change_dylib_id(id, **options)
  macho.change_dylib_id(id, options)
  macho.write!
end

#change_install_name(old, new, **options) ⇒ Object

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. 



83
84
85
86
 
# File 'os/mac/mach.rb', line 83

def change_install_name(old, new, **options)
  macho.change_install_name(old, new, options)
  macho.write!
end

#change_rpath(old, new, **options) ⇒ Object

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. 



73
74
75
76
 
# File 'os/mac/mach.rb', line 73

def change_rpath(old, new, **options)
  macho.change_rpath(old, new, options)
  macho.write!
end

#delete_rpath(rpath, **options) ⇒ Object

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.

TODO:

See if the #write! call can be delayed until

we know we're not making any changes to the rpaths.



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'os/mac/mach.rb', line 60

def delete_rpath(rpath, **options)
  candidates = rpaths(resolve_variable_references: false).select do |r|
    resolve_variable_name(r) == resolve_variable_name(rpath)
  end

  # Delete the last instance to avoid changing the order in which rpaths are searched.
  rpath_to_delete = candidates.last
  options[:last] = true

  macho.delete_rpath(rpath_to_delete, options)
  macho.write!
end

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


158
159
160
 
# File 'os/mac/mach.rb', line 158

def dylib?
  mach_data.any? { |m| m.fetch(:type) == :dylib }
end

#dylib_id(*args, **options, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • options (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


237
 
# File 'sorbet/rbi/parlour.rbi', line 237

def dylib_id(*args, **options, &block); end

#dynamically_linked_libraries(except: :none, resolve_variable_references: true) ⇒ Object

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. 



88
89
90
91
92
93
94
95
 
# File 'os/mac/mach.rb', line 88

def dynamically_linked_libraries(except: :none, resolve_variable_references: true)
  lcs = macho.dylib_load_commands
  lcs.reject! { |lc| lc.flag?(except) } if except != :none
  names = lcs.map { |lc| lc.name.to_s }.uniq
  names.map! { resolve_variable_name(_1) } if resolve_variable_references

  names
end

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


142
143
144
 
# File 'os/mac/mach.rb', line 142

def i386?
  arch == :i386
end

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


168
169
170
 
# File 'os/mac/mach.rb', line 168

def mach_o_bundle?
  mach_data.any? { |m| m.fetch(:type) == :bundle }
end

#mach_o_executable? ⇒ Boolean Also known as: binary_executable?

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) 


162
163
164
 
# File 'os/mac/mach.rb', line 162

def mach_o_executable?
  mach_data.any? { |m| m.fetch(:type) == :executable }
end

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


154
155
156
 
# File 'os/mac/mach.rb', line 154

def ppc64?
  arch == :ppc64
end

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


150
151
152
 
# File 'os/mac/mach.rb', line 150

def ppc7400?
  arch == :ppc7400
end

#resolve_rpath(name) ⇒ Object

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. 



117
118
119
120
121
122
123
124
 
# File 'os/mac/mach.rb', line 117

def resolve_rpath(name)
  target = T.let(nil, T.nilable(String))
  return unless rpaths(resolve_variable_references: true).find do |rpath|
    File.exist?(target = File.join(rpath, name.delete_prefix("@rpath")))
  end

  target
end

#resolve_variable_name(name, resolve_rpaths: true) ⇒ Object

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. 



105
106
107
108
109
110
111
112
113
114
115
 
# File 'os/mac/mach.rb', line 105

def resolve_variable_name(name, resolve_rpaths: true)
  if name.start_with? "@loader_path"
    Pathname(name.sub("@loader_path", dirname)).cleanpath.to_s
  elsif name.start_with?("@executable_path") && binary_executable?
    Pathname(name.sub("@executable_path", dirname)).cleanpath.to_s
  elsif resolve_rpaths && name.start_with?("@rpath") && (target = resolve_rpath(name)).present?
    target
  else
    name
  end
end

#rpaths(resolve_variable_references: true) ⇒ Object

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. 



97
98
99
100
101
102
103
 
# File 'os/mac/mach.rb', line 97

def rpaths(resolve_variable_references: true)
  names = macho.rpaths
  # Don't recursively resolve rpaths to avoid infinite loops.
  names.map! { |name| resolve_variable_name(name, resolve_rpaths: false) } if resolve_variable_references

  names
end

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


138
139
140
 
# File 'os/mac/mach.rb', line 138

def universal?
  arch == :universal
end

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


146
147
148
 
# File 'os/mac/mach.rb', line 146

def x86_64?
  arch == :x86_64
end