Added way to generate #to_s

Author: apainintheneck

lib/macho/load_commands.rb

@@ -398,7 +398,7 @@ def to_h
     # the task's address space. Corresponds to LC_SEGMENT.
     class SegmentCommand < LoadCommand
       # @return [String] the name of the segment
-      field :segname, :string, :size => 16
+      field :segname, :string, :size => 16, :to_s => true
 
       # @return [Integer] the memory address of the segment
       field :vmaddr, :uint32
@@ -476,11 +476,6 @@ def guess_align
         align
       end
 
-      # @return [String] a string representation of the segment name
-      def to_s
-        segname
-      end
-
       # @return [Hash] a hash representation of this {SegmentCommand}
       def to_h
         {
@@ -520,7 +515,7 @@ class SegmentCommand64 < SegmentCommand
     class DylibCommand < LoadCommand
       # @return [LCStr] the library's path
       #  name as an LCStr
-      field :name, :lcstr
+      field :name, :lcstr, :to_s => true
 
       # @return [Integer] the library's build time stamp
       field :timestamp, :uint32
@@ -545,11 +540,6 @@ def serialize(context)
          compatibility_version].pack(format) + string_payload
       end
 
-      # @return [String] a string representation of the library's pathname
-      def to_s
-        name.to_s
-      end
-
       # @return [Hash] a hash representation of this {DylibCommand}
       def to_h
         {
@@ -567,7 +557,7 @@ def to_h
     class DylinkerCommand < LoadCommand
       # @return [LCStr] the dynamic linker's
       #  path name as an LCStr
-      field :name, :lcstr
+      field :name, :lcstr, :to_s => true
 
       # @param context [SerializationContext]
       #  the context
@@ -582,11 +572,6 @@ def serialize(context)
         [cmd, cmdsize, string_offsets[:name]].pack(format) + string_payload
       end
 
-      # @return [String] a string representation of the dynamic linker's pathname
-      def to_s
-        name.to_s
-      end
-
       # @return [Hash] a hash representation of this {DylinkerCommand}
       def to_h
         {
@@ -600,19 +585,14 @@ def to_h
     class PreboundDylibCommand < LoadCommand
       # @return [LCStr] the library's path
       #  name as an LCStr
-      field :name, :lcstr
+      field :name, :lcstr, :to_s => true
 
       # @return [Integer] the number of modules in the library
       field :nmodules, :uint32
 
       # @return [Integer] a bit vector of linked modules
       field :linked_modules, :uint32
 
-      # @return [String] a string representation of the library's pathname
-      def to_s
-        name.to_s
-      end
-
       # @return [Hash] a hash representation of this {PreboundDylibCommand}
       def to_h
         {
@@ -707,12 +687,7 @@ class RoutinesCommand64 < RoutinesCommand
     # of an umbrella framework. Corresponds to LC_SUB_FRAMEWORK.
     class SubFrameworkCommand < LoadCommand
       # @return [LCStr] the umbrella framework name as an LCStr
-      field :umbrella, :lcstr
-
-      # @return [String] a string represenation of the umbrella framework name
-      def to_s
-        umbrella.to_s
-      end
+      field :umbrella, :lcstr, :to_s => true
 
       # @return [Hash] a hash representation of this {SubFrameworkCommand}
       def to_h
@@ -726,12 +701,7 @@ def to_h
     # of an umbrella framework. Corresponds to LC_SUB_UMBRELLA.
     class SubUmbrellaCommand < LoadCommand
       # @return [LCStr] the subumbrella framework name as an LCStr
-      field :sub_umbrella, :lcstr
-
-      # @return [String] a string represenation of the sub-umbrella framework name
-      def to_s
-        sub_umbrella.to_s
-      end
+      field :sub_umbrella, :lcstr, :to_s => true
 
       # @return [Hash] a hash representation of this {SubUmbrellaCommand}
       def to_h
@@ -745,12 +715,7 @@ def to_h
     # to LC_SUB_LIBRARY.
     class SubLibraryCommand < LoadCommand
       # @return [LCStr] the sublibrary name as an LCStr
-      field :sub_library, :lcstr
-
-      # @return [String] a string represenation of the sub-library name
-      def to_s
-        sublibrary.to_s
-      end
+      field :sub_library, :lcstr, :to_s => true
 
       # @return [Hash] a hash representation of this {SubLibraryCommand}
       def to_h
@@ -764,12 +729,7 @@ def to_h
     # an umbrella framework. Corresponds to LC_SUB_CLIENT.
     class SubClientCommand < LoadCommand
       # @return [LCStr] the subclient name as an LCStr
-      field :sub_client, :lcstr
-
-      # @return [String] a string represenation of the sub-client name
-      def to_s
-        sub_client.to_s
-      end
+      field :sub_client, :lcstr, :to_s => true
 
       # @return [Hash] a hash representation of this {SubClientCommand}
       def to_h
@@ -972,7 +932,7 @@ def to_h
     # Corresponds to LC_RPATH.
     class RpathCommand < LoadCommand
       # @return [LCStr] the path to add to the run path as an LCStr
-      field :path, :lcstr
+      field :path, :lcstr, :to_s => true
 
       # @param context [SerializationContext] the context
       # @return [String] the serialized fields of the load command
@@ -986,11 +946,6 @@ def serialize(context)
         [cmd, cmdsize, string_offsets[:path]].pack(format) + string_payload
       end
 
-      # @return [String] a string representation of the run path
-      def to_s
-        path.to_s
-      end
-
       # @return [Hash] a hash representation of this {RpathCommand}
       def to_h
         {
@@ -1293,11 +1248,6 @@ def version_string
         segs.join(".")
       end
 
-      # @return [String] an alias for version_string
-      def to_s
-        version_string
-      end
-
       # @return [Hash] a hash representation of this {SourceVersionCommand}
       def to_h
         {
@@ -1335,16 +1285,11 @@ class IdentCommand < LoadCommand
     # memory. Corresponds to LC_FVMFILE.
     class FvmfileCommand < LoadCommand
       # @return [LCStr] the pathname of the file being loaded
-      field :name, :lcstr
+      field :name, :lcstr, :to_s => true
 
       # @return [Integer] the virtual address being loaded at
       field :header_addr, :uint32
 
-      # @return [String] a string representation of the pathname
-      def to_s
-        name.to_s
-      end
-
       # @return [Hash] a hash representation of this {FvmfileCommand}
       def to_h
         {
@@ -1358,19 +1303,14 @@ def to_h
     # into memory. Corresponds to LC_LOADFVMLIB and LC_IDFVMLIB.
     class FvmlibCommand < LoadCommand
       # @return [LCStr] the library's target pathname
-      field :name, :lcstr
+      field :name, :lcstr, :to_s => true
 
       # @return [Integer] the library's minor version number
       field :minor_version, :uint32
 
       # @return [Integer] the library's header address
       field :header_addr, :uint32
 
-      # @return [String] a string representation of the target pathname
-      def to_s
-        name.to_s
-      end
-
       # @return [Hash] a hash representation of this {FvmlibCommand}
       def to_h
         {
@@ -1385,19 +1325,14 @@ def to_h
     # Corresponds to LC_NOTE.
     class NoteCommand < LoadCommand
       # @return [String] the name of the owner for this note
-      field :data_owner, :string, :size => 16
+      field :data_owner, :string, :size => 16, :to_s => true
 
       # @return [Integer] the offset, within the file, of the note
       field :offset, :uint64
 
       # @return [Integer] the size, in bytes, of the note
       field :size, :uint64
 
-      # @return [String] a string representation of data owner of this note
-      def to_s
-        data_owner
-      end
-
       # @return [Hash] a hash representation of this {NoteCommand}
       def to_h
         {
@@ -1419,7 +1354,7 @@ class FilesetEntryCommand < LoadCommand
       field :fileoff, :uint64
 
       # @return [LCStr] the entry's ID
-      field :entry_id, :lcstr
+      field :entry_id, :lcstr, :to_s => true
 
       # @return [void]
       field :reserved, :uint32

lib/macho/structure.rb

@@ -70,8 +70,6 @@ module Fields
     # minimum number of required arguments
     @min_args = 0
 
-    # Used to dynamically create an instance of the inherited class
-    # according to the defined fields.
     # @param args [Array[Value]] list of field parameters
     def initialize(*args)
       raise ArgumentError, "Invalid number of arguments" if args.size < self.class.min_args
@@ -138,6 +136,7 @@ def inherited(subclass) # rubocop:disable Lint/MissingSuper
       #   :mask [Integer] bitmask
       #   :unpack [String] string format
       #   :default [Value] default value
+      #   :to_s [Boolean] flag for generating #to_s
       # @api private
       def field(name, type, **options)
         raise ArgumentError, "Invalid field type #{type}" unless Fields::FORMAT_CODE.key?(type)
@@ -168,6 +167,8 @@ def field(name, type, **options)
         else
           def_reader(name, idx)
         end
+
+        def_to_s(name) if options[:to_s]
       end
 
       #
@@ -257,6 +258,15 @@ def def_reader(name, idx)
           @values[idx]
         end
       end
+
+      # Generates the to_s method based on the named field.
+      # @param name [Symbol] name of the field
+      # @api private
+      def def_to_s(name)
+        define_method(:to_s) do
+          send(name).to_s
+        end
+      end
     end
   end
 end