Class: MachO::LoadCommands::LoadCommand
- Inherits:
-
MachOStructure
- Object
- MachOStructure
- MachO::LoadCommands::LoadCommand
- Defined in:
- lib/macho/load_commands.rb
Overview
The top-level Mach-O load command structure.
This is the most generic load command -- only the type ID and size are represented. Used when a more specific class isn't available or isn't implemented.
Direct Known Subclasses
BuildVersionCommand, DyldInfoCommand, DylibCommand, DylinkerCommand, DysymtabCommand, EncryptionInfoCommand, EntryPointCommand, FvmfileCommand, FvmlibCommand, IdentCommand, LinkeditDataCommand, LinkerOptionCommand, NoteCommand, PrebindCksumCommand, PreboundDylibCommand, RoutinesCommand, RpathCommand, SegmentCommand, SourceVersionCommand, SubClientCommand, SubFrameworkCommand, SubLibraryCommand, SubUmbrellaCommand, SymsegCommand, SymtabCommand, ThreadCommand, TwolevelHintsCommand, UUIDCommand, VersionMinCommand
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.
"L=2"
- 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.
8
Instance Attribute Summary collapse
-
#cmd ⇒ Integer
readonly
The load command's type ID.
-
#cmdsize ⇒ Integer
readonly
The size of the load command, in bytes.
-
#view ⇒ MachO::MachOView?
readonly
The raw view associated with the load command, or nil if the load command was created via LoadCommand.create.
Class Method Summary collapse
-
.create(cmd_sym, *args) ⇒ Object
Creates a new (viewless) command corresponding to the symbol provided.
-
.new_from_bin(view) ⇒ LoadCommand
private
Instantiates a new LoadCommand given a view into its origin Mach-O.
Instance Method Summary collapse
-
#initialize(view, cmd, cmdsize) ⇒ LoadCommand
constructor
private
A new instance of LoadCommand.
-
#offset ⇒ Integer
deprecated
Deprecated.
use #view instead
-
#serializable? ⇒ Boolean
Whether the load command can be serialized.
-
#serialize(context) ⇒ String?
private
The serialized fields of the load command, or nil if the load command can't be serialized.
-
#to_h ⇒ Hash
A hash representation of this load command.
-
#to_s ⇒ String
A string representation of the load command's identifying number.
-
#type ⇒ Symbol?
(also: #to_sym)
A symbol representation of the load command's type ID, or nil if the ID doesn't correspond to a known load command class.
Methods inherited from MachOStructure
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.
233 234 235 236 237 238 |
# File 'lib/macho/load_commands.rb', line 233 def initialize(view, cmd, cmdsize) super() @view = view @cmd = cmd @cmdsize = cmdsize end |
Instance Attribute Details
#cmd ⇒ Integer (readonly)
Returns the load command's type ID.
188 189 190 |
# File 'lib/macho/load_commands.rb', line 188 def cmd @cmd end |
#cmdsize ⇒ Integer (readonly)
Returns the size of the load command, in bytes.
191 192 193 |
# File 'lib/macho/load_commands.rb', line 191 def cmdsize @cmdsize end |
#view ⇒ MachO::MachOView? (readonly)
Returns the raw view associated with the load command, or nil if the load command was created via create.
185 186 187 |
# File 'lib/macho/load_commands.rb', line 185 def view @view end |
Class Method Details
.create(cmd_sym, *args) ⇒ Object
Creates a new (viewless) command corresponding to the symbol provided
215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/macho/load_commands.rb', line 215 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
205 206 207 208 209 210 |
# File 'lib/macho/load_commands.rb', line 205 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 ⇒ Integer
use #view instead
Returns the load command's offset in the source file.
259 260 261 |
# File 'lib/macho/load_commands.rb', line 259 def offset view.offset end |
#serializable? ⇒ Boolean
Returns whether the load command can be serialized.
241 242 243 |
# File 'lib/macho/load_commands.rb', line 241 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.
250 251 252 253 254 255 |
# File 'lib/macho/load_commands.rb', line 250 def serialize(context) raise LoadCommandNotSerializableError, LOAD_COMMANDS[cmd] unless serializable? format = Utils.specialize_format(FORMAT, context.endianness) [cmd, SIZEOF].pack(format) end |
#to_h ⇒ Hash
Children should override this to include additional information.
Returns a hash representation of this load command.
279 280 281 282 283 284 285 286 |
# File 'lib/macho/load_commands.rb', line 279 def to_h { "view" => view.to_h, "cmd" => cmd, "cmdsize" => cmdsize, "type" => type, }.merge super end |
#to_s ⇒ String
Returns a string representation of the load command's identifying number.
273 274 275 |
# File 'lib/macho/load_commands.rb', line 273 def to_s type.to_s end |
#type ⇒ Symbol? Also known as: to_sym
Returns a symbol representation of the load command's type ID, or nil if the ID doesn't correspond to a known load command class.
265 266 267 |
# File 'lib/macho/load_commands.rb', line 265 def type LOAD_COMMANDS[cmd] end |