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, FilesetEntryCommand, 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
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
-
#cmd ⇒ Integer
The load command's type ID.
-
#cmdsize ⇒ Integer
The size of the load command, in bytes.
-
#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.
-
#view ⇒ MachO::MachOView?
The raw view associated with the load command, or nil if the load command was created via LoadCommand.create.
Methods inherited from MachOStructure
Constructor Details
This class inherits a constructor from MachO::MachOStructure
Class Method Details
.create(cmd_sym, *args) ⇒ Object
Creates a new (viewless) command corresponding to the symbol provided
225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'lib/macho/load_commands.rb', line 225 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.min_args - 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
215 216 217 218 219 220 |
# File 'lib/macho/load_commands.rb', line 215 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
#cmd ⇒ Integer
Returns the load command's type ID.
206 |
# File 'lib/macho/load_commands.rb', line 206 field :cmd, :uint32 |
#cmdsize ⇒ Integer
Returns the size of the load command, in bytes.
209 |
# File 'lib/macho/load_commands.rb', line 209 field :cmdsize, :uint32 |
#offset ⇒ Integer
use #view instead
Returns the load command's offset in the source file.
258 259 260 |
# File 'lib/macho/load_commands.rb', line 258 def offset view.offset end |
#serializable? ⇒ Boolean
Returns whether the load command can be serialized.
240 241 242 |
# File 'lib/macho/load_commands.rb', line 240 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.
249 250 251 252 253 254 |
# File 'lib/macho/load_commands.rb', line 249 def serialize(context) raise LoadCommandNotSerializableError, LOAD_COMMANDS[cmd] unless serializable? format = Utils.specialize_format(self.class.format, context.endianness) [cmd, self.class.bytesize].pack(format) end |
#to_h ⇒ Hash
Children should override this to include additional information.
Returns a hash representation of this load command.
278 279 280 281 282 283 284 285 |
# File 'lib/macho/load_commands.rb', line 278 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.
272 273 274 |
# File 'lib/macho/load_commands.rb', line 272 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.
264 265 266 |
# File 'lib/macho/load_commands.rb', line 264 def type LOAD_COMMANDS[cmd] end |
#view ⇒ MachO::MachOView?
Returns the raw view associated with the load command, or nil if the load command was created via create.
203 |
# File 'lib/macho/load_commands.rb', line 203 field :view, :view |