ruby-macho 0.2.4 → 0.2.5

data/lib/macho/headers.rb

@@ -1,64 +1,82 @@
 module MachO
   # big-endian fat magic
+  # @api private
   FAT_MAGIC = 0xcafebabe
 
   # little-endian fat magic
   # this is defined, but should never appear in ruby-macho code because
   # fat headers are always big-endian and therefore always unpacked as such.
+  # @api private
   FAT_CIGAM = 0xbebafeca
 
   # 32-bit big-endian magic
+  # @api private
   MH_MAGIC = 0xfeedface
 
   # 32-bit little-endian magic
+  # @api private
   MH_CIGAM = 0xcefaedfe
 
   # 64-bit big-endian magic
+  # @api private
   MH_MAGIC_64 = 0xfeedfacf
 
   # 64-bit little-endian magic
+  # @api private
   MH_CIGAM_64 = 0xcffaedfe
 
   # association of magic numbers to string representations
+  # @api private
   MH_MAGICS = {
     FAT_MAGIC => "FAT_MAGIC",
     MH_MAGIC => "MH_MAGIC",
     MH_CIGAM => "MH_CIGAM",
     MH_MAGIC_64 => "MH_MAGIC_64",
-    MH_CIGAM_64 => "MH_CIGAM_64"
-  }
+    MH_CIGAM_64 => "MH_CIGAM_64",
+  }.freeze
 
   # mask for CPUs with 64-bit architectures (when running a 64-bit ABI?)
+  # @api private
   CPU_ARCH_ABI64 = 0x01000000
 
   # any CPU (unused?)
+  # @api private
   CPU_TYPE_ANY = -1
 
   # m68k compatible CPUs
+  # @api private
   CPU_TYPE_MC680X0 = 0x06
 
   # i386 and later compatible CPUs
+  # @api private
   CPU_TYPE_I386 = 0x07
 
   # x86_64 (AMD64) compatible CPUs
+  # @api private
   CPU_TYPE_X86_64 = (CPU_TYPE_I386 | CPU_ARCH_ABI64)
 
   # 32-bit ARM compatible CPUs
+  # @api private
   CPU_TYPE_ARM = 0x0c
 
   # m88k compatible CPUs
+  # @api private
   CPU_TYPE_MC88000 = 0xd
 
   # 64-bit ARM compatible CPUs
+  # @api private
   CPU_TYPE_ARM64 = (CPU_TYPE_ARM | CPU_ARCH_ABI64)
 
   # PowerPC compatible CPUs
+  # @api private
   CPU_TYPE_POWERPC = 0x12
 
   # PowerPC64 compatible CPUs
+  # @api private
   CPU_TYPE_POWERPC64 = (CPU_TYPE_POWERPC | CPU_ARCH_ABI64)
 
   # association of cpu types to symbol representations
+  # @api private
   CPU_TYPES = {
     CPU_TYPE_ANY => :any,
     CPU_TYPE_I386 => :i386,
@@ -67,156 +85,213 @@ module MachO
     CPU_TYPE_ARM64 => :arm64,
     CPU_TYPE_POWERPC => :ppc,
     CPU_TYPE_POWERPC64 => :ppc64,
-  }
+  }.freeze
 
   # mask for CPU subtype capabilities
+  # @api private
   CPU_SUBTYPE_MASK = 0xff000000
 
   # 64-bit libraries (undocumented!)
   # @see http://llvm.org/docs/doxygen/html/Support_2MachO_8h_source.html
+  # @api private
   CPU_SUBTYPE_LIB64 = 0x80000000
 
   # the lowest common sub-type for `CPU_TYPE_I386`
+  # @api private
   CPU_SUBTYPE_I386 = 3
 
   # the i486 sub-type for `CPU_TYPE_I386`
+  # @api private
   CPU_SUBTYPE_486 = 4
 
   # the i486SX sub-type for `CPU_TYPE_I386`
+  # @api private
   CPU_SUBTYPE_486SX = 132
 
   # the i586 (P5, Pentium) sub-type for `CPU_TYPE_I386`
+  # @api private
   CPU_SUBTYPE_586 = 5
-  CPU_SUBTYPE_PENT  = CPU_SUBTYPE_586
+
+  # @see CPU_SUBTYPE_586
+  # @api private
+  CPU_SUBTYPE_PENT = CPU_SUBTYPE_586
 
   # the Pentium Pro (P6) sub-type for `CPU_TYPE_I386`
+  # @api private
   CPU_SUBTYPE_PENTPRO = 22
 
   # the Pentium II (P6, M3?) sub-type for `CPU_TYPE_I386`
+  # @api private
   CPU_SUBTYPE_PENTII_M3 = 54
 
   # the Pentium II (P6, M5?) sub-type for `CPU_TYPE_I386`
+  # @api private
   CPU_SUBTYPE_PENTII_M5 = 86
 
   # the Pentium 4 (Netburst) sub-type for `CPU_TYPE_I386`
+  # @api private
   CPU_SUBTYPE_PENTIUM_4 = 10
 
   # the lowest common sub-type for `CPU_TYPE_MC680X0`
+  # @api private
   CPU_SUBTYPE_MC680X0_ALL = 1
+
+  # @see CPU_SUBTYPE_MC680X0_ALL
+  # @api private
   CPU_SUBTYPE_MC68030 = CPU_SUBTYPE_MC680X0_ALL
 
   # the 040 subtype for `CPU_TYPE_MC680X0`
+  # @api private
   CPU_SUBTYPE_MC68040 = 2
 
   # the 030 subtype for `CPU_TYPE_MC680X0`
+  # @api private
   CPU_SUBTYPE_MC68030_ONLY = 3
 
   # the lowest common sub-type for `CPU_TYPE_X86_64`
+  # @api private
   CPU_SUBTYPE_X86_64_ALL = CPU_SUBTYPE_I386
 
   # the Haskell sub-type for `CPU_TYPE_X86_64`
+  # @api private
   CPU_SUBTYPE_X86_64_H = 8
 
   # the lowest common sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_ALL = 0
 
   # the v4t sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_V4T = 5
 
   # the v6 sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_V6 = 6
 
   # the v5 sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_V5TEJ = 7
 
   # the xscale (v5 family) sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_XSCALE = 8
 
   # the v7 sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_V7 = 9
 
   # the v7f (Cortex A9) sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_V7F = 10
 
   # the v7s ("Swift") sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_V7S = 11
 
   # the v7k ("Kirkwood40") sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_V7K = 12
 
   # the v6m sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_V6M = 14
 
   # the v7m sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_V7M = 15
 
   # the v7em sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_V7EM = 16
 
   # the v8 sub-type for `CPU_TYPE_ARM`
+  # @api private
   CPU_SUBTYPE_ARM_V8 = 13
 
   # the lowest common sub-type for `CPU_TYPE_ARM64`
+  # @api private
   CPU_SUBTYPE_ARM64_ALL = 0
 
   # the v8 sub-type for `CPU_TYPE_ARM64`
+  # @api private
   CPU_SUBTYPE_ARM64_V8 = 1
 
   # the lowest common sub-type for `CPU_TYPE_MC88000`
+  # @api private
   CPU_SUBTYPE_MC88000_ALL = 0
+
+  # @see CPU_SUBTYPE_MC88000_ALL
+  # @api private
   CPU_SUBTYPE_MMAX_JPC = CPU_SUBTYPE_MC88000_ALL
 
   # the 100 sub-type for `CPU_TYPE_MC88000`
+  # @api private
   CPU_SUBTYPE_MC88100 = 1
 
   # the 110 sub-type for `CPU_TYPE_MC88000`
+  # @api private
   CPU_SUBTYPE_MC88110 = 2
 
   # the lowest common sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_ALL = 0
 
   # the 601 sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_601 = 1
 
   # the 602 sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_602 = 2
 
   # the 603 sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_603 = 3
 
   # the 603e (G2) sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_603E = 4
 
   # the 603ev sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_603EV = 5
 
   # the 604 sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_604 = 6
 
   # the 604e sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_604E = 7
 
   # the 620 sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_620 = 8
 
   # the 750 (G3) sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_750 = 9
 
   # the 7400 (G4) sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_7400 = 10
 
   # the 7450 (G4 "Voyager") sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_7450 = 11
 
   # the 970 (G5) sub-type for `CPU_TYPE_POWERPC`
+  # @api private
   CPU_SUBTYPE_POWERPC_970 = 100
 
   # any CPU sub-type for CPU type `CPU_TYPE_POWERPC64`
+  # @api private
   CPU_SUBTYPE_POWERPC64_ALL = CPU_SUBTYPE_POWERPC_ALL
 
   # association of CPU types/subtype pairs to symbol representations in
   # (very) roughly descending order of commonness
   # @see https://opensource.apple.com/source/cctools/cctools-877.8/libstuff/arch.c
+  # @api private
   CPU_SUBTYPES = {
     CPU_TYPE_I386 => {
       CPU_SUBTYPE_I386 => :i386,
@@ -280,53 +355,64 @@ module MachO
   }.freeze
 
   # relocatable object file
+  # @api private
   MH_OBJECT = 0x1
 
   # demand paged executable file
+  # @api private
   MH_EXECUTE = 0x2
 
   # fixed VM shared library file
+  # @api private
   MH_FVMLIB = 0x3
 
   # core dump file
+  # @api private
   MH_CORE = 0x4
 
   # preloaded executable file
+  # @api private
   MH_PRELOAD = 0x5
 
   # dynamically bound shared library
+  # @api private
   MH_DYLIB = 0x6
 
   # dynamic link editor
+  # @api private
   MH_DYLINKER = 0x7
 
   # dynamically bound bundle file
+  # @api private
   MH_BUNDLE = 0x8
 
   # shared library stub for static linking only, no section contents
+  # @api private
   MH_DYLIB_STUB = 0x9
 
   # companion file with only debug sections
+  # @api private
   MH_DSYM = 0xa
 
   # x86_64 kexts
+  # @api private
   MH_KEXT_BUNDLE = 0xb
 
-  # association of filetypes to string representations
+  # association of filetypes to Symbol representations
   # @api private
   MH_FILETYPES = {
-    MH_OBJECT => "MH_OBJECT",
-    MH_EXECUTE => "MH_EXECUTE",
-    MH_FVMLIB => "MH_FVMLIB",
-    MH_CORE => "MH_CORE",
-    MH_PRELOAD => "MH_PRELOAD",
-    MH_DYLIB => "MH_DYLIB",
-    MH_DYLINKER => "MH_DYLINKER",
-    MH_BUNDLE => "MH_BUNDLE",
-    MH_DYLIB_STUB => "MH_DYLIB_STUB",
-    MH_DSYM => "MH_DSYM",
-    MH_KEXT_BUNDLE => "MH_KEXT_BUNDLE"
-  }
+    MH_OBJECT => :object,
+    MH_EXECUTE => :execute,
+    MH_FVMLIB => :fvmlib,
+    MH_CORE => :core,
+    MH_PRELOAD => :preload,
+    MH_DYLIB => :dylib,
+    MH_DYLINKER => :dylinker,
+    MH_BUNDLE => :bundle,
+    MH_DYLIB_STUB => :dylib_stub,
+    MH_DSYM => :dsym,
+    MH_KEXT_BUNDLE => :kext_bundle,
+  }.freeze
 
   # association of mach header flag symbols to values
   # @api private
@@ -356,8 +442,8 @@ module MachO
     :MH_DEAD_STRIPPABLE_DYLIB => 0x400000,
     :MH_HAS_TLV_DESCRIPTORS => 0x800000,
     :MH_NO_HEAP_EXECUTION => 0x1000000,
-    :MH_APP_EXTENSION_SAFE => 0x02000000
-  }
+    :MH_APP_EXTENSION_SAFE => 0x02000000,
+  }.freeze
 
   # Fat binary header structure
   # @see MachO::FatArch
@@ -369,7 +455,12 @@ module MachO
     attr_reader :nfat_arch
 
     # always big-endian
-    FORMAT = "N2"
+    # @see MachOStructure::FORMAT
+    # @api private
+    FORMAT = "N2".freeze
+
+    # @see MachOStructure::SIZEOF
+    # @api private
     SIZEOF = 8
 
     # @api private
@@ -399,7 +490,12 @@ module MachO
     attr_reader :align
 
     # always big-endian
-    FORMAT = "N5"
+    # @see MachOStructure::FORMAT
+    # @api private
+    FORMAT = "N5".freeze
+
+    # @see MachOStructure::SIZEOF
+    # @api private
     SIZEOF = 20
 
     # @api private
@@ -435,12 +531,17 @@ module MachO
     # @return [Fixnum] the header flags associated with the Mach-O
     attr_reader :flags
 
-    FORMAT = "L=7"
+    # @see MachOStructure::FORMAT
+    # @api private
+    FORMAT = "L=7".freeze
+
+    # @see MachOStructure::SIZEOF
+    # @api private
     SIZEOF = 28
 
     # @api private
     def initialize(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds,
-        flags)
+                   flags)
       @magic = magic
       @cputype = cputype
       # For now we're not interested in additional capability bits also to be
@@ -468,12 +569,17 @@ module MachO
     # @return [void]
     attr_reader :reserved
 
-    FORMAT = "L=8"
+    # @see MachOStructure::FORMAT
+    # @api private
+    FORMAT = "L=8".freeze
+
+    # @see MachOStructure::SIZEOF
+    # @api private
     SIZEOF = 32
 
     # @api private
     def initialize(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds,
-        flags, reserved)
+                   flags, reserved)
       super(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds, flags)
       @reserved = reserved
     end