Class: MachO::LoadCommands::LoadCommand

Inherits:
MachOStructure show all
Defined in:
lib/macho/load_commands.rb

Overview

Mach-O load command structure This is the most generic load command - only cmd ID and size are represented, and no actual data. Used when a more specific class isn't available/implemented.

Defined Under Namespace

Classes: LCStr, SerializationContext

Constant Summary collapse

FORMAT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

"L=2".freeze
SIZEOF =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

8

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from MachOStructure

bytesize

Constructor Details

#initialize(view, cmd, cmdsize) ⇒ LoadCommand

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of LoadCommand.

Parameters:

  • view (MachO::MachOView) —

    the load command's raw view

  • cmd (Fixnum) —

    the load command's identifying number

  • cmdsize (Fixnum) —

    the size of the load command in bytes



222
223
224
225
226
 
# File 'lib/macho/load_commands.rb', line 222

def initialize(view, cmd, cmdsize)
  @view = view
  @cmd = cmd
  @cmdsize = cmdsize
end

Instance Attribute Details

#cmd ⇒ Fixnum (readonly)

Returns the load command's identifying number.

Returns:

  • (Fixnum) —

    the load command's identifying number



177
178
179
 
# File 'lib/macho/load_commands.rb', line 177

def cmd
  @cmd
end

#cmdsize ⇒ Fixnum (readonly)

Returns the size of the load command, in bytes.

Returns:

  • (Fixnum) —

    the size of the load command, in bytes



180
181
182
 
# File 'lib/macho/load_commands.rb', line 180

def cmdsize
  @cmdsize
end

#view ⇒ MachO::MachOView (readonly)

Returns the raw view associated with the load command.

Returns:



174
175
176
 
# File 'lib/macho/load_commands.rb', line 174

def view
  @view
end

Class Method Details

.create(cmd_sym, *args) ⇒ Object

Creates a new (viewless) command corresponding to the symbol provided

Parameters:

  • cmd_sym (Symbol) —

    the symbol of the load command being created

  • args (Array) —

    the arguments for the load command being created

Raises:



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/macho/load_commands.rb', line 204

def self.create(cmd_sym, *args)
  raise LoadCommandNotCreatableError, cmd_sym unless CREATABLE_LOAD_COMMANDS.include?(cmd_sym)

  klass = LoadCommands.const_get LC_STRUCTURES[cmd_sym]
  cmd = LOAD_COMMAND_CONSTANTS[cmd_sym]

  # cmd will be filled in, view and cmdsize will be left unpopulated
  klass_arity = klass.instance_method(:initialize).arity - 3

  raise LoadCommandCreationArityError.new(cmd_sym, klass_arity, args.size) if klass_arity != args.size

  klass.new(nil, cmd, nil, *args)
end

.new_from_bin(view) ⇒ LoadCommand

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Instantiates a new LoadCommand given a view into its origin Mach-O

Parameters:

Returns:



194
195
196
197
198
199
 
# File 'lib/macho/load_commands.rb', line 194

def self.new_from_bin(view)
  bin = view.raw_data.slice(view.offset, bytesize)
  format = Utils.specialize_format(self::FORMAT, view.endianness)

  new(view, *bin.unpack(format))
end

Instance Method Details

#offset ⇒ Fixnum

Deprecated.

use #view instead

Returns the load command's offset in the source file.

Returns:

  • (Fixnum) —

    the load command's offset in the source file



246
247
248
 
# File 'lib/macho/load_commands.rb', line 246

def offset
  view.offset
end

#serializable? ⇒ Boolean

Returns whether the load command can be serialized.

Returns:

  • (Boolean) —

    whether the load command can be serialized



229
230
231
 
# File 'lib/macho/load_commands.rb', line 229

def serializable?
  CREATABLE_LOAD_COMMANDS.include?(LOAD_COMMANDS[cmd])
end

#serialize(context) ⇒ String?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the serialized fields of the load command, or nil if the load command can't be serialized.

Parameters:

Returns:

  • (String, nil) —

    the serialized fields of the load command, or nil if the load command can't be serialized

Raises:



238
239
240
241
242
 
# File 'lib/macho/load_commands.rb', line 238

def serialize(context)
  raise LoadCommandNotSerializableError, LOAD_COMMANDS[cmd] unless serializable?
  format = Utils.specialize_format(FORMAT, context.endianness)
  [cmd, SIZEOF].pack(format)
end

#to_s ⇒ String

Returns a string representation of the load command's identifying number.

Returns:

  • (String) —

    a string representation of the load command's identifying number



260
261
262
 
# File 'lib/macho/load_commands.rb', line 260

def to_s
  type.to_s
end

#type ⇒ Symbol Also known as: to_sym

Returns a symbol representation of the load command's identifying number.

Returns:

  • (Symbol) —

    a symbol representation of the load command's identifying number



252
253
254
 
# File 'lib/macho/load_commands.rb', line 252

def type
  LOAD_COMMANDS[cmd]
end