ruby-macho 0.2.2 → 0.2.3

data/lib/macho/open.rb

@@ -1,16 +1,25 @@
 module MachO
-	# Opens the given filename as a MachOFile or FatFile, depending on its magic.
-	# @param filename [String] the file being opened
-	# @return [MachO::MachOFile] if the file is a Mach-O
-	# @return [MachO::FatFile] if the file is a Fat file
-	def self.open(filename)
-		# open file and test magic instead of using exceptions for control?
-		begin
-			file = MachOFile.new(filename)
-		rescue FatBinaryError
-			file = FatFile.new(filename)
-		end
+  # Opens the given filename as a MachOFile or FatFile, depending on its magic.
+  # @param filename [String] the file being opened
+  # @return [MachO::MachOFile] if the file is a Mach-O
+  # @return [MachO::FatFile] if the file is a Fat file
+  # @raise [ArgumentError] if the given file does not exist
+  # @raise [MachO::TruncatedFileError] if the file is too small to have a valid header
+  # @raise [MachO::MagicError] if the file's magic is not valid Mach-O magic
+  def self.open(filename)
+    raise ArgumentError.new("#{filename}: no such file") unless File.file?(filename)
+    raise TruncatedFileError.new unless File.stat(filename).size >= 4
 
-		file
-	end
-end
+    magic = File.open(filename, "rb") { |f| f.read(4) }.unpack("N").first
+
+    if MachO.fat_magic?(magic)
+      file = FatFile.new(filename)
+    elsif MachO.magic?(magic)
+      file = MachOFile.new(filename)
+    else
+      raise MagicError.new(magic)
+    end
+
+    file
+  end
+end

data/lib/macho/sections.rb

@@ -1,159 +1,159 @@
 module MachO
-	# type mask
-	SECTION_TYPE = 0x000000ff
-
-	# attributes mask
-	SECTION_ATTRIBUTES = 0xffffff00
-
-	# user settable attributes mask
-	SECTION_ATTRIBUTES_USR = 0xff000000
-
-	# system settable attributes mask
-	SECTION_ATTRIBUTES_SYS = 0x00ffff00
-
-	# association of section flag symbols to values
-	# @api private
-	SECTION_FLAGS = {
-		:S_REGULAR => 0x0,
-		:S_ZEROFILL => 0x1,
-		:S_CSTRING_LITERALS => 0x2,
-		:S_4BYTE_LITERALS => 0x3,
-		:S_8BYTE_LITERALS => 0x4,
-		:S_LITERAL_POINTERS => 0x5,
-		:S_NON_LAZY_SYMBOL_POINTERS => 0x6,
-		:S_LAZY_SYMBOL_POINTERS => 0x7,
-		:S_SYMBOL_STUBS => 0x8,
-		:S_MOD_INIT_FUNC_POINTERS => 0x9,
-		:S_MOD_TERM_FUNC_POINTERS => 0xa,
-		:S_COALESCED => 0xb,
-		:S_GB_ZEROFILE => 0xc,
-		:S_INTERPOSING => 0xd,
-		:S_16BYTE_LITERALS => 0xe,
-		:S_DTRACE_DOF => 0xf,
-		:S_LAZY_DYLIB_SYMBOL_POINTERS => 0x10,
-		:S_THREAD_LOCAL_REGULAR => 0x11,
-		:S_THREAD_LOCAL_ZEROFILL => 0x12,
-		:S_THREAD_LOCAL_VARIABLES => 0x13,
-		:S_THREAD_LOCAL_VARIABLE_POINTERS => 0x14,
-		:S_THREAD_LOCAL_INIT_FUNCTION_POINTERS => 0x15,
-		:S_ATTR_PURE_INSTRUCTIONS => 0x80000000,
-		:S_ATTR_NO_TOC => 0x40000000,
-		:S_ATTR_STRIP_STATIC_SYMS => 0x20000000,
-		:S_ATTR_NO_DEAD_STRIP => 0x10000000,
-		:S_ATTR_LIVE_SUPPORT => 0x08000000,
-		:S_ATTR_SELF_MODIFYING_CODE => 0x04000000,
-		:S_ATTR_DEBUG => 0x02000000,
-		:S_ATTR_SOME_INSTRUCTIONS => 0x00000400,
-		:S_ATTR_EXT_RELOC => 0x00000200,
-		:S_ATTR_LOC_RELOC => 0x00000100
-	}
-
-	# association of section name symbols to names
-	# @api private
-	SECTION_NAMES = {
-		:SECT_TEXT => "__text",
-		:SECT_FVMLIB_INIT0 => "__fvmlib_init0",
-		:SECT_FVMLIB_INIT1 => "__fvmlib_init1",
-		:SECT_DATA => "__data",
-		:SECT_BSS => "__bss",
-		:SECT_COMMON => "__common",
-		:SECT_OBJC_SYMBOLS => "__symbol_table",
-		:SECT_OBJC_MODULES => "__module_info",
-		:SECT_OBJC_STRINGS => "__selector_strs",
-		:SECT_OBJC_REFS => "__selector_refs",
-		:SECT_ICON_HEADER => "__header",
-		:SECT_ICON_TIFF => "__tiff"
-	}
-
-	# Represents a section of a segment for 32-bit architectures.
-	class Section < 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
-
-		FORMAT = "a16a16VVVVVVVVV"
-		SIZEOF = 68
-
-		# @api private
-		def initialize(sectname, segname, addr, size, offset, align, reloff,
-				nreloc, flags, reserved1, reserved2)
-			@sectname = sectname
-			@segname = segname
-			@addr = addr
-			@size = size
-			@offset = offset
-			@align = align
-			@reloff = reloff
-			@nreloc = nreloc
-			@flags = flags
-			@reserved1 = reserved1
-			@reserved2 = reserved2
-		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 [Symbol] a section flag symbol
-		# @return [Boolean] true if `flag` is present in the section's flag field
-		def flag?(flag)
-			flag = SECTION_FLAGS[flag]
-			return false if flag.nil?
-			flags & flag == flag
-		end
-	end
-
-	# Represents a section of a segment for 64-bit architectures.
-	class Section64 < Section
-		# @return [void] reserved
-		attr_reader :reserved3
-
-		FORMAT = "a16a16QQVVVVVVVV"
-		SIZEOF = 80
-
-		# @api private
-		def initialize(sectname, segname, addr, size, offset, align, reloff,
-				nreloc, flags, reserved1, reserved2, reserved3)
-			super(sectname, segname, addr, size, offset, align, reloff,
-				nreloc, flags, reserved1, reserved2)
-			@reserved3 = reserved3
-		end
-	end
+  # type mask
+  SECTION_TYPE = 0x000000ff
+
+  # attributes mask
+  SECTION_ATTRIBUTES = 0xffffff00
+
+  # user settable attributes mask
+  SECTION_ATTRIBUTES_USR = 0xff000000
+
+  # system settable attributes mask
+  SECTION_ATTRIBUTES_SYS = 0x00ffff00
+
+  # association of section flag symbols to values
+  # @api private
+  SECTION_FLAGS = {
+    :S_REGULAR => 0x0,
+    :S_ZEROFILL => 0x1,
+    :S_CSTRING_LITERALS => 0x2,
+    :S_4BYTE_LITERALS => 0x3,
+    :S_8BYTE_LITERALS => 0x4,
+    :S_LITERAL_POINTERS => 0x5,
+    :S_NON_LAZY_SYMBOL_POINTERS => 0x6,
+    :S_LAZY_SYMBOL_POINTERS => 0x7,
+    :S_SYMBOL_STUBS => 0x8,
+    :S_MOD_INIT_FUNC_POINTERS => 0x9,
+    :S_MOD_TERM_FUNC_POINTERS => 0xa,
+    :S_COALESCED => 0xb,
+    :S_GB_ZEROFILE => 0xc,
+    :S_INTERPOSING => 0xd,
+    :S_16BYTE_LITERALS => 0xe,
+    :S_DTRACE_DOF => 0xf,
+    :S_LAZY_DYLIB_SYMBOL_POINTERS => 0x10,
+    :S_THREAD_LOCAL_REGULAR => 0x11,
+    :S_THREAD_LOCAL_ZEROFILL => 0x12,
+    :S_THREAD_LOCAL_VARIABLES => 0x13,
+    :S_THREAD_LOCAL_VARIABLE_POINTERS => 0x14,
+    :S_THREAD_LOCAL_INIT_FUNCTION_POINTERS => 0x15,
+    :S_ATTR_PURE_INSTRUCTIONS => 0x80000000,
+    :S_ATTR_NO_TOC => 0x40000000,
+    :S_ATTR_STRIP_STATIC_SYMS => 0x20000000,
+    :S_ATTR_NO_DEAD_STRIP => 0x10000000,
+    :S_ATTR_LIVE_SUPPORT => 0x08000000,
+    :S_ATTR_SELF_MODIFYING_CODE => 0x04000000,
+    :S_ATTR_DEBUG => 0x02000000,
+    :S_ATTR_SOME_INSTRUCTIONS => 0x00000400,
+    :S_ATTR_EXT_RELOC => 0x00000200,
+    :S_ATTR_LOC_RELOC => 0x00000100
+  }.freeze
+
+  # association of section name symbols to names
+  # @api private
+  SECTION_NAMES = {
+    :SECT_TEXT => "__text",
+    :SECT_FVMLIB_INIT0 => "__fvmlib_init0",
+    :SECT_FVMLIB_INIT1 => "__fvmlib_init1",
+    :SECT_DATA => "__data",
+    :SECT_BSS => "__bss",
+    :SECT_COMMON => "__common",
+    :SECT_OBJC_SYMBOLS => "__symbol_table",
+    :SECT_OBJC_MODULES => "__module_info",
+    :SECT_OBJC_STRINGS => "__selector_strs",
+    :SECT_OBJC_REFS => "__selector_refs",
+    :SECT_ICON_HEADER => "__header",
+    :SECT_ICON_TIFF => "__tiff"
+  }.freeze
+
+  # Represents a section of a segment for 32-bit architectures.
+  class Section < 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
+
+    FORMAT = "a16a16L=9"
+    SIZEOF = 68
+
+    # @api private
+    def initialize(sectname, segname, addr, size, offset, align, reloff,
+        nreloc, flags, reserved1, reserved2)
+      @sectname = sectname
+      @segname = segname
+      @addr = addr
+      @size = size
+      @offset = offset
+      @align = align
+      @reloff = reloff
+      @nreloc = nreloc
+      @flags = flags
+      @reserved1 = reserved1
+      @reserved2 = reserved2
+    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 [Symbol] a section flag symbol
+    # @return [Boolean] true if `flag` is present in the section's flag field
+    def flag?(flag)
+      flag = SECTION_FLAGS[flag]
+      return false if flag.nil?
+      flags & flag == flag
+    end
+  end
+
+  # Represents a section of a segment for 64-bit architectures.
+  class Section64 < Section
+    # @return [void] reserved
+    attr_reader :reserved3
+
+    FORMAT = "a16a16Q=2L=8"
+    SIZEOF = 80
+
+    # @api private
+    def initialize(sectname, segname, addr, size, offset, align, reloff,
+        nreloc, flags, reserved1, reserved2, reserved3)
+      super(sectname, segname, addr, size, offset, align, reloff,
+        nreloc, flags, reserved1, reserved2)
+      @reserved3 = reserved3
+    end
+  end
 end

data/lib/macho/structure.rb

@@ -1,22 +1,38 @@
 module MachO
-	# A general purpose pseudo-structure.
-	# @abstract
-	class MachOStructure
-		# The format of the data structure, in String#unpack format.
-		FORMAT = ""
+  # A general purpose pseudo-structure.
+  # @abstract
+  class MachOStructure
+    # The String#unpack format of the data structure.
+    FORMAT = ""
 
-		# The size of the data structure, in bytes.
-		SIZEOF = 0
+    # The size of the data structure, in bytes.
+    SIZEOF = 0
 
-		# @return [Fixnum] the size, in bytes, of the represented structure.
-		def self.bytesize
-			self::SIZEOF
-		end
+    # @return [Fixnum] the size, in bytes, of the represented structure.
+    def self.bytesize
+      self::SIZEOF
+    end
 
-		# @return [MachO::MachOStructure] a new MachOStructure initialized with `bin`
-		# @api private
-		def self.new_from_bin(bin)
-			self.new(*bin.unpack(self::FORMAT))
-		end
-	end
+    # @param endianness [Symbol] either :big or :little
+    # @param bin [String] the string to be unpacked into the new structure
+    # @return [MachO::MachOStructure] a new MachOStructure initialized with `bin`
+    # @api private
+    def self.new_from_bin(endianness, bin)
+      format = specialize_format(self::FORMAT, endianness)
+
+      self.new(*bin.unpack(format))
+    end
+
+    private
+
+    # Convert an abstract (native-endian) String#unpack format to big or little.
+    # @param format [String] the format string being converted
+    # @param endianness [Symbol] either :big or :little
+    # @return [String] the converted string
+    # @api private
+    def self.specialize_format(format, endianness)
+      modifier = (endianness == :big) ? ">" : "<"
+      format.tr("=", modifier)
+    end
+  end
 end

data/lib/macho/tools.rb

@@ -1,65 +1,65 @@
 module MachO
-	# A collection of convenient methods for common operations on Mach-O and Fat binaries.
-	module Tools
-		# @param filename [String] the Mach-O or Fat binary being read
-		# @return [Array<String>] an array of all dylibs linked to the binary
-		def self.dylibs(filename)
-			file = MachO.open(filename)
+  # A collection of convenient methods for common operations on Mach-O and Fat binaries.
+  module Tools
+    # @param filename [String] the Mach-O or Fat binary being read
+    # @return [Array<String>] an array of all dylibs linked to the binary
+    def self.dylibs(filename)
+      file = MachO.open(filename)
 
-			file.linked_dylibs
-		end
+      file.linked_dylibs
+    end
 
-		# Changes the dylib ID of a Mach-O or Fat binary, overwriting the source file.
-		# @param filename [String] the Mach-O or Fat binary being modified
-		# @param new_id [String] the new dylib ID for the binary
-		# @return [void]
-		# @todo unstub for fat files
-		def self.change_dylib_id(filename, new_id)
-			file = MachO.open(filename)
+    # Changes the dylib ID of a Mach-O or Fat binary, overwriting the source file.
+    # @param filename [String] the Mach-O or Fat binary being modified
+    # @param new_id [String] the new dylib ID for the binary
+    # @return [void]
+    # @todo unstub for fat files
+    def self.change_dylib_id(filename, new_id)
+      file = MachO.open(filename)
 
-			file.dylib_id = new_id
-			file.write!
-		end
+      file.dylib_id = new_id
+      file.write!
+    end
 
-		# Changes a shared library install name in a Mach-O or Fat binary, overwriting the source file.
-		# @param filename [String] the Mach-O or Fat binary being modified
-		# @param old_name [String] the old shared library name
-		# @param new_name [String] the new shared library name
-		# @return [void]
-		# @todo unstub for fat files
-		def self.change_install_name(filename, old_name, new_name)
-			file = MachO.open(filename)
+    # Changes a shared library install name in a Mach-O or Fat binary, overwriting the source file.
+    # @param filename [String] the Mach-O or Fat binary being modified
+    # @param old_name [String] the old shared library name
+    # @param new_name [String] the new shared library name
+    # @return [void]
+    # @todo unstub for fat files
+    def self.change_install_name(filename, old_name, new_name)
+      file = MachO.open(filename)
 
-			file.change_install_name(old_name, new_name)
-			file.write!
-		end
+      file.change_install_name(old_name, new_name)
+      file.write!
+    end
 
-		# Changes a runtime path in a Mach-O or Fat binary, overwriting the source file.
-		# @param filename [String] the Mach-O or Fat binary being modified
-		# @param old_path [String] the old runtime path
-		# @param new_path [String] the new runtime path
-		# @return [void]
-		# @todo unstub
-		def self.change_rpath(filename, old_path, new_path)
-			raise "stub"
-		end
+    # Changes a runtime path in a Mach-O or Fat binary, overwriting the source file.
+    # @param filename [String] the Mach-O or Fat binary being modified
+    # @param old_path [String] the old runtime path
+    # @param new_path [String] the new runtime path
+    # @return [void]
+    # @todo unstub
+    def self.change_rpath(filename, old_path, new_path)
+      raise UnimplementedError.new("changing rpaths in a Mach-O")
+    end
 
-		# Add a runtime path to a Mach-O or Fat binary, overwriting the source file.
-		# @param filename [String] the Mach-O or Fat binary being modified
-		# @param new_path [String] the new runtime path
-		# @return [void]
-		# @todo unstub
-		def self.add_rpath(filename, new_path)
-			raise "stub"
-		end
+    # Add a runtime path to a Mach-O or Fat binary, overwriting the source file.
+    # @param filename [String] the Mach-O or Fat binary being modified
+    # @param new_path [String] the new runtime path
+    # @return [void]
+    # @todo unstub
+    def self.add_rpath(filename, new_path)
+      raise UnimplementedError.new("adding rpaths to a Mach-O")
+    end
 
-		# Delete a runtime path from a Mach-O or Fat binary, overwriting the source file.
-		# @param filename [String] the Mach-O or Fat binary being modified
-		# @param old_path [String] the old runtime path
-		# @return [void]
-		# @todo unstub
-		def self.delete_rpath(filename, old_path)
-			raise "stub"
-		end
-	end
+    # Delete a runtime path from a Mach-O or Fat binary, overwriting the source file.
+    # @param filename [String] the Mach-O or Fat binary being modified
+    # @param old_path [String] the old runtime path
+    # @return [void]
+    # @todo unstub
+    def self.delete_rpath(filename, old_path)
+      raise UnimplementedError.new("removing rpaths from a Mach-O")
+    end
+  end
 end