ruby-macho 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83843cf163d14c552c318a7d2d4787cee484ad88
-  data.tar.gz: 73313735ad3e7647fdc5aab78e17e1065e8b1d44
+  metadata.gz: 804e6a31dedb8f86966c6e53366730c1ac87c2c2
+  data.tar.gz: 3a4f11ddc1807e34f158f22f446b561cbc5e9e07
 SHA512:
-  metadata.gz: a2f3c64080a15318bcc1c78a341899b8d141c7368b017094bb20fe58ba824130a6ecc5a366a78759a6c251d61a5da62ccf6c35452f77317c58351d3497f316b2
-  data.tar.gz: a86b0a030d58848ce69c5eb4eac8eb5268f6cefd03904ca69a3c18ad83e60b40db446360719c45879777c62142877036af891699cc0685976d7043b7f7598f3b
+  metadata.gz: 99c430de85ed1154fe02a70a0443535fdc5fd3e4a5b3a4d16e857dad770784977d0dfe73f6a75879408877b44ba86c73b4d1755ae782420f2364a1dd4acc3eb0
+  data.tar.gz: d4877cb5eea705217b930175167a7f2330ef255e51cf403d12f13f174b61ad6e91f57bfdf554f379a0a8cb7651093128456a639f77fad874b66fdcb6f788cde1

data/lib/macho/headers.rb

@@ -234,30 +234,47 @@ module MachO
 	}
 
 	# Fat binary header structure
+	# @see MachO::FatArch
 	class FatHeader < MachOStructure
+		# @return [Fixnum] the magic number of the header (and file)
 		attr_reader :magic
-		attr_reader :nfat_arch # number of FatArchs that follow
 
-		@format = "VV"
-		@sizeof = 8
+		# @return [Fixnum] the number of fat architecture structures following the header
+		attr_reader :nfat_arch
 
+		FORMAT = "VV"
+		SIZEOF = 8
+
+		# @api private
 		def initialize(magic, nfat_arch)
 			@magic = magic
 			@nfat_arch = nfat_arch
 		end
 	end
 
-	# Fat binary header architecture structure
+	# Fat binary header architecture structure. A Fat binary has one or more of
+	# these, representing one or more internal Mach-O blobs.
+	# @see MachO::FatHeader
 	class FatArch < MachOStructure
+		# @return [Fixnum] the CPU type of the Mach-O
 		attr_reader :cputype
+
+		# @return [Fixnum] the CPU subtype of the Mach-O
 		attr_reader :cpusubtype
+
+		# @return [Fixnum] the file offset to the beginning of the Mach-O data
 		attr_reader :offset
+
+		# @return [Fixnum] the size, in bytes, of the Mach-O data
 		attr_reader :size
+
+		# @return [Fixnum] the alignment, as a power of 2
 		attr_reader :align
 
-		@format = "VVVVV"
-		@sizeof = 20
+		FORMAT = "VVVVV"
+		SIZEOF = 20
 
+		# @api private
 		def initialize(cputype, cpusubtype, offset, size, align)
 			@cputype = cputype
 			@cpusubtype = cpusubtype
@@ -269,17 +286,31 @@ module MachO
 
 	# 32-bit Mach-O file header structure
 	class MachHeader < MachOStructure
+		# @return [Fixnum] the magic number
 		attr_reader :magic
+
+		# @return [Fixnum] the CPU type of the Mach-O
 		attr_reader :cputype
+
+		# @return [Fixnum] the CPU subtype of the Mach-O
 		attr_reader :cpusubtype
+
+		# @return [Fixnum] the file type of the Mach-O
 		attr_reader :filetype
+
+		# @return [Fixnum] the number of load commands in the Mach-O
 		attr_reader :ncmds
+
+		# @return [Fixnum] the size of all load commands, in bytes, in the Mach-O
 		attr_reader :sizeofcmds
+
+		# @return [Fixnum] the header flags associated with the Mach-O
 		attr_reader :flags
 
-		@format = "VVVVVVV"
-		@sizeof = 28
+		FORMAT = "VVVVVVV"
+		SIZEOF = 28
 
+		# @api private
 		def initialize(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds,
 				flags)
 			@magic = magic
@@ -301,37 +332,18 @@ module MachO
 	end
 
 	# 64-bit Mach-O file header structure
-	class MachHeader64 < MachOStructure
-		attr_reader :magic
-		attr_reader :cputype
-		attr_reader :cpusubtype
-		attr_reader :filetype
-		attr_reader :ncmds
-		attr_reader :sizeofcmds
-		attr_reader :flags
+	class MachHeader64 < MachHeader
+		# @return [void]
 		attr_reader :reserved
 
-		@format = "VVVVVVVV"
-		@sizeof = 32
+		FORMAT = "VVVVVVVV"
+		SIZEOF = 32
 
+		# @api private
 		def initialize(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds,
 				flags, reserved)
-			@magic = magic
-			@cputype = cputype
-			@cpusubtype = cpusubtype
-			@filetype = filetype
-			@ncmds = ncmds
-			@sizeofcmds = sizeofcmds
-			@flags = flags
+			super(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds, flags)
 			@reserved = reserved
 		end
-
-		# @example
-		#  puts "this mach-o has position-independent execution" if header.flag?(MH_PIE)
-		# @param flag [Fixnum] a mach header flag constant
-		# @return [Boolean] true if `flag` is present in the header's flag section
-		def flag?(flag)
-			flags & flag == flag
-		end
 	end
 end

data/lib/macho/load_commands.rb

@@ -296,8 +296,8 @@ module MachO
 		# @return [Fixnum] the size of the load command, in bytes
 		attr_reader :cmdsize
 
-		@format = "VV"
-		@sizeof = 8
+		FORMAT = "VV"
+		SIZEOF = 8
 
 		# Creates a new LoadCommand given an offset and binary string
 		# @param offset [Fixnum] the offset to initialize with
@@ -305,7 +305,7 @@ module MachO
 		# @return [MachO::LoadCommand] the new load command
 		# @api private
 		def self.new_from_bin(raw_data, offset, bin)
-			self.new(raw_data, offset, *bin.unpack(@format))
+			self.new(raw_data, offset, *bin.unpack(self::FORMAT))
 		end
 
 		# @param offset [Fixnum] the offset to initialize with
@@ -358,8 +358,8 @@ module MachO
 		# @return [Array<Fixnum>] the UUID
 		attr_reader :uuid
 
-		@format = "VVa16"
-		@sizeof = 24
+		FORMAT = "VVa16"
+		SIZEOF = 24
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, uuid)
@@ -409,8 +409,8 @@ module MachO
 		# @return [Fixnum] any flags associated with the segment
 		attr_reader :flags
 
-		@format = "VVa16VVVVVVVV"
-		@sizeof = 56
+		FORMAT = "VVa16VVVVVVVV"
+		SIZEOF = 56
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, segname, vmaddr, vmsize, fileoff,
@@ -463,8 +463,8 @@ module MachO
 		# @return [Fixnum] any flags associated with the segment
 		attr_reader :flags
 
-		@format = "VVa16QQQQVVVV"
-		@sizeof = 72
+		FORMAT = "VVa16QQQQVVVV"
+		SIZEOF = 72
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, segname, vmaddr, vmsize, fileoff,
@@ -503,8 +503,8 @@ module MachO
 		# @return [Fixnum] the library's compatibility version number
 		attr_reader :compatibility_version
 
-		@format = "VVVVVV"
-		@sizeof = 24
+		FORMAT = "VVVVVV"
+		SIZEOF = 24
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, name, timestamp, current_version,
@@ -524,8 +524,8 @@ module MachO
 		# @return [MachO::LoadCommand::LCStr] the dynamic linker's path name as an LCStr
 		attr_reader :name
 
-		@format = "VVV"
-		@sizeof = 12
+		FORMAT = "VVV"
+		SIZEOF = 12
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, name)
@@ -546,8 +546,8 @@ module MachO
 		# @return [Fixnum] a bit vector of linked modules
 		attr_reader :linked_modules
 
-		@format = "VVVVV"
-		@sizeof = 20
+		FORMAT = "VVVVV"
+		SIZEOF = 20
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, name, nmodules, linked_modules)
@@ -592,8 +592,8 @@ module MachO
 		# @return [void]
 		attr_reader :reserved6
 
-		@format = "VVVVVVVVVV"
-		@sizeof = 40
+		FORMAT = "VVVVVVVVVV"
+		SIZEOF = 40
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, init_address, init_module,
@@ -639,8 +639,8 @@ module MachO
 		# @return [void]
 		attr_reader :reserved6
 
-		@format = "VVQQQQQQQQ"
-		@sizeof = 72
+		FORMAT = "VVQQQQQQQQ"
+		SIZEOF = 72
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, init_address, init_module,
@@ -664,8 +664,8 @@ module MachO
 		# @return [MachO::LoadCommand::LCStr] the umbrella framework name as an LCStr
 		attr_reader :umbrella
 
-		@format = "VVV"
-		@sizeof = 12
+		FORMAT = "VVV"
+		SIZEOF = 12
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, umbrella)
@@ -680,8 +680,8 @@ module MachO
 		# @return [MachO::LoadCommand::LCStr] the subumbrella framework name as an LCStr
 		attr_reader :sub_umbrella
 
-		@format = "VVV"
-		@sizeof = 12
+		FORMAT = "VVV"
+		SIZEOF = 12
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, sub_umbrella)
@@ -696,8 +696,8 @@ module MachO
 		# @return [MachO::LoadCommand::LCStr] the sublibrary name as an LCStr
 		attr_reader :sub_library
 
-		@format = "VVV"
-		@sizeof = 12
+		FORMAT = "VVV"
+		SIZEOF = 12
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, sub_library)
@@ -712,8 +712,8 @@ module MachO
 		# @return [MachO::LoadCommand::LCStr] the subclient name as an LCStr
 		attr_reader :sub_client
 
-		@format = "VVV"
-		@sizeof = 12
+		FORMAT = "VVV"
+		SIZEOF = 12
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, sub_client)
@@ -737,8 +737,8 @@ module MachO
 		# @return the string table size in bytes
 		attr_reader :strsize
 
-		@format = "VVVVVV"
-		@sizeof = 24
+		FORMAT = "VVVVVV"
+		SIZEOF = 24
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, symoff, nsyms, stroff, strsize)
@@ -808,8 +808,8 @@ module MachO
 		attr_reader :nlocrel
 
 
-		@format = "VVVVVVVVVVVVVVVVVVVV"
-		@sizeof = 80
+		FORMAT = "VVVVVVVVVVVVVVVVVVVV"
+		SIZEOF = 80
 
 		# ugh
 		# @api private
@@ -848,8 +848,8 @@ module MachO
 		# @return [Fixnum] the number of hints in the hint table
 		attr_reader :nhints
 
-		@format = "VVVV"
-		@sizeof = 16
+		FORMAT = "VVVV"
+		SIZEOF = 16
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, htoffset, nhints)
@@ -865,8 +865,8 @@ module MachO
 		# @return [Fixnum] the checksum or 0
 		attr_reader :cksum
 
-		@format = "VVV"
-		@sizeof = 12
+		FORMAT = "VVV"
+		SIZEOF = 12
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, cksum)
@@ -882,8 +882,8 @@ module MachO
 		# @return [MachO::LoadCommand::LCStr] the path to add to the run path as an LCStr
 		attr_reader :path
 
-		@format = "VVV"
-		@sizeof = 12
+		FORMAT = "VVV"
+		SIZEOF = 12
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, path)
@@ -902,8 +902,8 @@ module MachO
 		# @return [Fixnum] size of the data in the __LINKEDIT segment
 		attr_reader :datasize
 
-		@format = "VVVV"
-		@sizeof = 16
+		FORMAT = "VVVV"
+		SIZEOF = 16
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, dataoff, datasize)
@@ -925,8 +925,8 @@ module MachO
 		# @return [Fixnum] the encryption system, or 0 if not encrypted yet
 		attr_reader :cryptid
 
-		@format = "VVVVV"
-		@sizeof = 20
+		FORMAT = "VVVVV"
+		SIZEOF = 20
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, cryptoff, cryptsize, cryptid)
@@ -952,8 +952,8 @@ module MachO
 		# @return [Fixnum] 64-bit padding value
 		attr_reader :pad
 
-		@format = "VVVVVV"
-		@sizeof = 24
+		FORMAT = "VVVVVV"
+		SIZEOF = 24
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, cryptoff, cryptsize, cryptid)
@@ -974,8 +974,8 @@ module MachO
 		# @return [Fixnum] the SDK version X.Y.Z packed as x16.y8.z8
 		attr_reader :sdk
 
-		@format = "VVVV"
-		@sizeof = 16
+		FORMAT = "VVVV"
+		SIZEOF = 16
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, version, sdk)
@@ -1041,8 +1041,8 @@ module MachO
 		# @return [Fixnum] the size of the export information
 		attr_reader :export_size
 
-		@format = "VVVVVVVVVVVV"
-		@sizeof = 48
+		FORMAT = "VVVVVVVVVVVV"
+		SIZEOF = 48
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, rebase_off, rebase_size, bind_off,
@@ -1068,8 +1068,8 @@ module MachO
 		# @return [Fixnum] the number of strings
 		attr_reader :count
 
-		@format = "VVV"
-		@sizeof = 12
+		FORMAT = "VVV"
+		SIZEOF = 12
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, count)
@@ -1086,8 +1086,8 @@ module MachO
 		# @return [Fixnum] if not 0, the initial stack size.
 		attr_reader :stacksize
 
-		@format = "VVQQ"
-		@sizeof = 24
+		FORMAT = "VVQQ"
+		SIZEOF = 24
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, entryoff, stacksize)
@@ -1103,8 +1103,8 @@ module MachO
 		# @return [Fixnum] the version packed as a24.b10.c10.d10.e10
 		attr_reader :version
 
-		@format = "VVQ"
-		@sizeof = 16
+		FORMAT = "VVQ"
+		SIZEOF = 16
 
 		# @api private
 		def initialize(raw_data, offset, cmd, cmdsize, version)

data/lib/macho/sections.rb

@@ -91,8 +91,8 @@ module MachO
 		# @return [void] reserved (for count or sizeof)
 		attr_reader :reserved2
 
-		@format = "a16a16VVVVVVVVV"
-		@sizeof = 68
+		FORMAT = "a16a16VVVVVVVVV"
+		SIZEOF = 68
 
 		# @api private
 		def initialize(sectname, segname, addr, size, offset, align, reloff,
@@ -130,79 +130,19 @@ module MachO
 	end
 
 	# Represents a section of a segment for 64-bit architectures.
-	class Section64 < MachOStructure
-		# @return [String] the name of the section, including null pad bytes
-		attr_reader :sectname
-
-		# @return [String] the name of the segment's section, including null pad bytes
-		attr_reader :segname
-
-		# @return [Fixnum] the memory address of the section
-		attr_reader :addr
-
-		# @return [Fixnum] the size, in bytes, of the section
-		attr_reader :size
-
-		# @return [Fixnum] the file offset of the section
-		attr_reader :offset
-
-		# @return [Fixnum] the section alignment (power of 2) of the section
-		attr_reader :align
-
-		# @return [Fixnum] the file offset of the section's relocation entries
-		attr_reader :reloff
-
-		# @return [Fixnum] the number of relocation entries
-		attr_reader :nreloc
-
-		# @return [Fixnum] flags for type and addrributes of the section
-		attr_reader :flags
-
-		# @return [void] reserved (for offset or index)
-		attr_reader :reserved1
-
-		# @return [void] reserved (for count or sizeof)
-		attr_reader :reserved2
-
+	class Section64 < Section
 		# @return [void] reserved
 		attr_reader :reserved3
 
-		@format = "a16a16QQVVVVVVVV"
-		@sizeof = 80
+		FORMAT = "a16a16QQVVVVVVVV"
+		SIZEOF = 80
 
 		# @api private
 		def initialize(sectname, segname, addr, size, offset, align, reloff,
 				nreloc, flags, reserved1, reserved2, reserved3)
-			@sectname = sectname
-			@segname = segname
-			@addr = addr
-			@size = size
-			@offset = offset
-			@align = align
-			@reloff = reloff
-			@nreloc = nreloc
-			@flags = flags
-			@reserved1 = reserved1
-			@reserved2 = reserved2
+			super(sectname, segname, addr, size, offset, align, reloff,
+				nreloc, flags, reserved1, reserved2)
 			@reserved3 = reserved3
 		end
-
-		# @return [String] the section's name, with any trailing NULL characters removed
-		def section_name
-			@sectname.delete("\x00")
-		end
-
-		# @return [String] the parent segment's name, with any trailing NULL characters removed
-		def segment_name
-			@segname.delete("\x00")
-		end
-
-		# @example
-		#  puts "this section is regular" if sect.flag?(S_REGULAR)
-		# @param flag [Fixnum] a section flag constant
-		# @return [Boolean] true if `flag` is present in the sections's flag field
-		def flag?(flag)
-			flags & flag == flag
-		end
 	end
 end

data/lib/macho/structure.rb

@@ -2,19 +2,21 @@ module MachO
 	# A general purpose pseudo-structure.
 	# @abstract
 	class MachOStructure
-		# Subclasses should fill these in manually.
-		@format = ""
-		@sizeof = 0
+		# The format of the data structure, in String#unpack format.
+		FORMAT = ""
+
+		# The size of the data structure, in bytes.
+		SIZEOF = 0
 
 		# @return [Fixnum] the size, in bytes, of the represented structure.
 		def self.bytesize
-			@sizeof
+			self::SIZEOF
 		end
 
 		# @return [MachO::MachOStructure] a new MachOStructure initialized with `bin`
 		# @api private
 		def self.new_from_bin(bin)
-			self.new(*bin.unpack(@format))
+			self.new(*bin.unpack(self::FORMAT))
 		end
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-macho
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - William Woodruff