javaclass 0.0.3 → 0.0.4

data/lib/javaclass/classfile/access_flag_constants.rb

@@ -0,0 +1,24 @@
+module JavaClass
+  module ClassFile
+
+    # Access flags as defined by JVM spec.
+    # Author::   Peter Kofler
+    module AccessFlagsConstants
+
+      ACC_PUBLIC = 0x0001
+      ACC_FINAL = 0x0010
+      ACC_SUPER = 0x0020 # old invokespecial instruction semantics
+      ACC_INTERFACE = 0x0200
+      ACC_ABSTRACT = 0x0400
+      ACC_SYNTHETIC = 0x1000 # TODO Check what the synthetic flag means
+      ACC_ANNOTATION = 0x2000
+      ACC_ENUM = 0x4000
+      # TODO How were Java 1.0's "private protected" fields? set up? (see old JVM spec)
+
+      # Bitmask for unknown/not supported flags.
+      ACC_OTHER = 0xffff ^ ACC_PUBLIC ^ ACC_FINAL ^ ACC_SUPER ^ ACC_INTERFACE ^ ACC_ABSTRACT ^ ACC_SYNTHETIC ^ ACC_ENUM ^ ACC_ANNOTATION
+
+    end
+
+  end
+end

data/lib/javaclass/classfile/access_flags.rb

@@ -1,52 +1,75 @@
 require 'javaclass/string_ux'
+require 'javaclass/classfile/access_flag_constants'
+require 'javaclass/classfile/class_format_error'
 
 module JavaClass
-  module ClassFile 
-    
+  module ClassFile
+
     # The access flags of a class or interface.
     # Author::   Peter Kofler
     class AccessFlags
-      
-      # Access flags as defined by JVM spec.
-      ACC_PUBLIC = 0x0001    
-      ACC_FINAL = 0x0010    
-      ACC_SUPER = 0x0020 # old invokespecial instruction semantics    
-      ACC_INTERFACE = 0x0200    
-      ACC_ABSTRACT = 0x0400
-      ACC_INNER = 0x1000 # TODO unknown access flag, find in spec
-      ACC_OTHER = 0xffff ^ ACC_PUBLIC ^ ACC_FINAL ^ ACC_SUPER ^ ACC_INTERFACE ^ ACC_ABSTRACT ^ ACC_INNER
+      include AccessFlagsConstants
+
+      attr_reader :flags
       
       def initialize(data, pos)
         @flags = data.u2(pos)
-        raise "inconsistent flags #{@flags} (abstract and final)" if abstract? && final?
+        correct_flags
+        assert_flags
+      end
+      
+      def correct_flags
         if interface? && !abstract?
           # JDK 1.0 and 1.1 do have non abstract interfaces, fix it
           @flags = @flags | ACC_ABSTRACT
         end
-        raise "inconsistent flags #{@flags} (interface not abstract)" if interface? && !abstract?
-        raise "inconsistent flags #{@flags} (interface is final)" if interface? && final?
-        raise "inconsistent flags #{@flags} (other value #{@flags & ACC_OTHER})" if (@flags & ACC_OTHER) != 0
       end
+      private :correct_flags
       
+      def assert_flags
+        raise ClassFormatError, "inconsistent flags #{@flags} (abstract and final)" if abstract? && final?
+        raise ClassFormatError, "inconsistent flags #{@flags} (interface not abstract)" if interface? && !abstract?
+        raise ClassFormatError, "inconsistent flags #{@flags} (interface is final)" if interface? && final?
+        raise ClassFormatError, "inconsistent flags #{@flags} (annotation not interface)" if annotation? && !interface?
+        raise ClassFormatError, "inconsistent flags #{@flags} (other value #{@flags & ACC_OTHER})" if (@flags & ACC_OTHER) != 0
+      end
+      private :assert_flags
+
       # Return +true+ if the class is public.
       def public?
-       (@flags & ACC_PUBLIC) != 0
+        (@flags & ACC_PUBLIC) != 0
       end
-      alias accessible? public?   
-      
+      alias accessible? public?
+
       def final?
-       (@flags & ACC_FINAL) != 0
+        (@flags & ACC_FINAL) != 0
       end
-      
+
       def abstract?
-       (@flags & ACC_ABSTRACT) != 0
+        (@flags & ACC_ABSTRACT) != 0
       end
-      
+
       def interface?
-       (@flags & ACC_INTERFACE) != 0
+        (@flags & ACC_INTERFACE) != 0
+      end
+
+      def enum?
+        (@flags & ACC_ENUM) != 0
+      end
+
+      def annotation?
+        (@flags & ACC_ANNOTATION) != 0
+      end
+
+#      def inner?
+#        (@flags & ACC_INNER) != 0
+#      end
+
+      # Return the hex word of the flag.
+      def flags_hex
+        format '%4.4X', @flags
       end
-      
     end
-    
+
   end
-end
+end

data/lib/javaclass/classfile/class_format_error.rb

@@ -0,0 +1,37 @@
+module JavaClass
+  module ClassFile
+
+    # An error in the class file format. This indicates a broken class file or not supported feature.
+    # Author::   Peter Kofler
+    class ClassFormatError < StandardError
+
+      attr_reader :classname
+      attr_reader :classpath
+
+      def initialize(*args)
+        super
+        @classname = nil
+        @classpath = nil
+      end
+
+      # Record the offending _classname_ and optional _classpath_ name.
+      def add_classname(classname, classpath=nil)
+        raise ArgumentError, "classname already set to #{@classname}" if @classname 
+        @classname = classname
+        @classpath = classpath
+      end
+
+      def message
+        if @classname && @classpath
+          super + "\nin class #{@classname} on classpath #{@classpath}"
+        elsif @classname
+          super + "\nin class #{@classname}"
+        else
+          super
+        end
+      end
+      
+    end
+
+  end
+end

data/lib/javaclass/classfile/class_magic.rb

@@ -1,29 +1,37 @@
+require 'javaclass/classfile/class_format_error'
+
 module JavaClass
-  module ClassFile 
-    
+  module ClassFile
+
     # The +CAFEBABE+ magic of a class file. This just checks if CAFEBABE is here.
     # Author::   Peter Kofler
     class ClassMagic # ZenTest SKIP
-      
+
       CAFE_BABE = "\xCA\xFE\xBA\xBE"
-      
+
       # Check the class magic in the _data_ beginning at position _start_ (which is usually 0).
       def initialize(data, start=0)
-        # "parsing"
         @bytes = data[start..start+3]
       end
-      
+
       # Return +true+ if the data was valid, i.e. if the class started with +CAFEBABE+.
       def valid?
         @bytes == CAFE_BABE
       end
-      
+
       # Return the value of the magic in this class.
       def bytes
         @bytes.dup
       end
       
+      # Check if this magic is valid and raise an ClassFormatError if not with an optional _msg_ .
+      def check(msg='invalid java class magic')
+        unless valid?
+          raise(ClassFormatError, msg)
+        end
+      end
+
     end
-    
+
   end
 end

data/lib/javaclass/classfile/class_version.rb

@@ -1,44 +1,46 @@
 require 'javaclass/string_ux'
 
 module JavaClass
-  module ClassFile 
-    
+  module ClassFile
+
     # Version of a class file.
     # Author::   Peter Kofler
     # See::      http://java.sun.com/docs/books/jvms/second_edition/html/ClassFile.doc.html#75883
     class ClassVersion # ZenTest FULL to find method to_s
-      
+
       attr_reader :minor
       attr_reader :major
-      
+
       # Extract the class version from the bytes _data_ starting at position _start_ (which is usually 4).
       def initialize(data, start=4)
-        # parsing
         @minor = data.u2(start)
         @major = data.u2(start+2)
       end
-      
+
       # Return the class file version as +major+.+minor+ string like 48.0 (Java 1.4) or 50.0 (Java 6).
       def to_s
         "#{@major}.#{@minor}"
       end
-      
+
       # Return the version as +major+.+minor+ float.
       def to_f
+        @major + @minor/denom
+      end
+
+      def denom
         if @minor <= 0
-          denom = 1.0
+          1.0
         else
-          denom = 1.0 * 10**(Math.log10(@minor).floor + 1)
+          1.0 * 10**(Math.log10(@minor).floor + 1)
         end
-        
-        @major + @minor/denom
       end
+      private :denom 
       
       # Return a debug output of this version.
       def dump
-        ["  minor version: #{@minor}", "  major version: #{@major}"] 
+        ["  minor version: #{@minor}", "  major version: #{@major}"]
       end
-      
+
       # Return the JDK version corresponding to this version like "1.6" or "unknown" if none matched.
       def jdk_version
         v = to_f
@@ -46,22 +48,14 @@ module JavaClass
           '1.0'
         elsif v > 45.3 && v <= 45.65535 # 1.1.X can support class file formats of versions in the range 45.0 through 45.65535 inclusive
           '1.1'
-        elsif v == 46.0 # JDK 1.2=46
-          '1.2'
-        elsif v == 47.0 # JDK 1.3=47
-          '1.3'
-        elsif v == 48.0 # JDK 1.4=48
-          '1.4'
-        elsif v == 49.0 # J2SE 5.0=49
-          '1.5'
-        elsif v == 50.0 # J2SE 6.0=50
-          '1.6'
+        elsif @major >= 46 && @minor == 0
+          "1.#{@major-44}"
         else
           'unknown'
         end
       end
-      
+
     end
-    
+
   end
 end

data/lib/javaclass/classfile/constant_pool.rb

@@ -2,90 +2,155 @@ require 'javaclass/string_ux'
 require 'javaclass/classfile/constants/value'
 require 'javaclass/classfile/constants/single_reference'
 require 'javaclass/classfile/constants/double_reference'
+require 'javaclass/classfile/class_format_error'
 
 module JavaClass
-  module ClassFile 
-    
+  module ClassFile
+
     # Container of the constant pool's constants.
     # Author::   Peter Kofler
     class ConstantPool
-      
+
       # Types of constants by their +tag+.
       CONSTANT_TYPE_TAGS = {
-        CLASS_TAG     = 7 => Constants::ConstantClass, 
-        FIELD_TAG     = 9 => Constants::ConstantField, 
-        METHOD_TAG    = 10 => Constants::ConstantMethod, 
-        INTERFACE_METHOD_TAG = 11 => Constants::ConstantInterfaceMethod, 
-        STRING_TAG    = 8 => Constants::ConstantString, 
-        INT_TAG       = 3 => Constants::ConstantInt, 
-        FLOAT_TAG     = 4 => Constants::ConstantFloat, 
-        LONG_TAG      = 5 => Constants::ConstantLong, 
-        DOUBLE_TAG    = 6 => Constants::ConstantDouble, 
-        NAME_AND_TYPE_TAG = 12 => Constants::ConstantNameAndType, 
+        CLASS_TAG     = 7 => Constants::ConstantClass,
+        FIELD_TAG     = 9 => Constants::ConstantField,
+        METHOD_TAG    = 10 => Constants::ConstantMethod,
+        INTERFACE_METHOD_TAG = 11 => Constants::ConstantInterfaceMethod,
+        STRING_TAG    = 8 => Constants::ConstantString,
+        INT_TAG       = 3 => Constants::ConstantInt,
+        FLOAT_TAG     = 4 => Constants::ConstantFloat,
+        LONG_TAG      = 5 => Constants::ConstantLong,
+        DOUBLE_TAG    = 6 => Constants::ConstantDouble,
+        NAME_AND_TYPE_TAG = 12 => Constants::ConstantNameAndType,
         ASCIZ_TAG     = 1 => Constants::ConstantAsciz,
       }
-      
+
       # Size of the whole constant pool in bytes.
       attr_reader :size
-      
+
       # Parse the constant pool from the bytes _data_ beginning at position _start_ (which is usually 8).
       def initialize(data, start=8)
-        @pool = {} # cnt (fixnum) => constant
+        creator = PoolCreator.new(data, start)
+        creator.create!
         
-        # parsing
-        @item_count = data.u2(start)
-        pos = start + 2
-        cnt = 1
-        while cnt <= @item_count-1
-          
-          type = CONSTANT_TYPE_TAGS[data.u1(pos)]
-          unless type
-            #puts dump.join("\n") 
-            raise "const ##{cnt} = unknown constant pool tag #{data[pos]} at pos #{pos} in class"
-          end
-          
-          constant = type.new(@pool, data, pos)
-          @pool[cnt] = constant
-          pos += constant.size
-          cnt += constant.slots
-          
-        end
+        @pool = creator.pool # cnt (Fixnum) => constant class
+        @item_count = creator.item_count
         
-        @size = pos - start
+        @size = @pool.values.inject(0) { |sum, constant| sum + constant.size } + 2
       end
-      
-      # Return the number of pool items. This number might be larger than +items+ available, 
+
+      # Return the number of pool items. This number might be larger than +items+ available,
       # because +long+ and +double+ constants take two slots.
       def item_count
-        @item_count-1
+        @item_count - 1
       end
-      
-      # Return the _index_'th pool item. _index_ is the real index in the pool which may skip numbers. 
+
+      # Return the _index_'th pool item. _index_ is the real index in the pool which may skip numbers.
       def[](index)
+        check_index(index)
         @pool[index]
       end
-      
+
+      def check_index(index)
+        if index < 0 || index > item_count
+          raise IndexError, "index #{index} is out of bounds of constant pool"
+        end
+      end
+      private :check_index
+
       # Return an array of the ordered list of constants.
       def items
         @pool.keys.sort.collect { |k| self[k] }
       end
-      
+
       # Return an array of all constants of the given _tags_ types.
       def find(*tags)
         items.find_all { |item| tags.include? item.tag }
       end
-      
+
       # Return all string constants.
       def strings
         find(STRING_TAG)
       end
-      
+
       # Return a debug output of the whole pool.
       def dump
         ["  Constant pool:"] + @pool.keys.sort.collect { |k| "const ##{k} = #{self[k].dump}"}
       end
-      
+
+      # Return the constant class from _index_'th pool item.
+      def class_item(index)
+        if self[index] && !self[index].const_class?
+          raise ClassFormatError, "inconsistent constant pool entry #{index} for class, should be Constant Class"
+        end
+        self[index]
+      end
+
+      # Return the constant field from _index_'th pool item.
+      def field_item(index)
+        if self[index] && !self[index].const_field?
+          raise ClassFormatError, "inconsistent constant pool entry #{index} for field, should be Constant Field"
+        end
+        self[index]
+      end
+
+      # Return the constant method from _index_'th pool item.
+      def method_item(index)
+        if self[index] && !self[index].const_method?
+          raise ClassFormatError, "inconsistent constant pool entry #{index} for method, should be Constant Method"
+        end
+        self[index]
+      end
+
     end
     
+    class PoolCreator # :nodoc:
+
+      attr_reader :pool, :item_count
+      
+      def initialize(data, start)
+        @data = data
+        @start = start
+      end
+      
+      def create!
+        create_pool
+        fill_pool
+      end
+
+      def create_pool
+        @pool = {}
+        @item_count = @data.u2(@start)
+        @pos = @start + 2
+      end
+      
+      def fill_pool
+        @cnt = 1
+        while @cnt <= @item_count-1
+          create_next_constant
+        end
+      end
+            
+      def create_next_constant
+        type = determine_constant_type
+        constant = type.new(@pool, @data, @pos)
+        @pool[@cnt] = constant
+        @pos += constant.size
+        @cnt += constant.slots
+      end
+      
+      def determine_constant_type
+        tag_index = @data.u1(@pos)
+        type = ConstantPool::CONSTANT_TYPE_TAGS[tag_index]
+        unless type
+          raise ClassFormatError, "const ##{@cnt} contains unknown constant pool tag/index #{tag_index} (at pos #{@pos} in class).\n" +
+                "allowed are #{ConstantPool::CONSTANT_TYPE_TAGS.keys.sort.join(',')}"
+        end
+        type
+      end
+      
+    end
+
   end
 end

data/lib/javaclass/classfile/constants/base.rb

@@ -1,33 +1,54 @@
 require 'javaclass/string_ux'
 
-module JavaClass 
-  module ClassFile 
-    module Constants # :nodoc:
-      
+module JavaClass
+  module ClassFile
+
+    # The module Constants is for separating namespaces. It contains the logic to parse constant pool constants.
+    # Author::          Peter Kofler
+    module Constants 
+
       # Superclass of all constant values in the constant pool. Every constant has a +name+, a +tag+ and a +size+ in bytes.
       # Author::   Peter Kofler
       class Base # ZenTest FULL to find method name
-        
+
         attr_reader :name
         attr_reader :tag
         attr_reader :size
         attr_reader :slots
-        
+
         # Set default constants.
         def initialize(name=nil)
-          @name = self.class.to_s[/::[^:]+$/][10..-1] # skip modules (::) and "Constant"
-          @name = name if name
+          if name
+            @name = name
+          else 
+            @name = self.class.to_s[/::[^:]+$/][10..-1] # skip modules (::) and "Constant"
+          end
           @size = 3
           @slots = 1
         end
-        
+
         # Return part of debug output.
         def dump
-          "#{@name}\t" # #{@tag} 
+          "#{@name}\t" # #{@tag}
+        end
+
+        # Return false for sanity check if it's a class. Subclasses should overwrite.
+        def const_class?
+          false
         end
-        
+
+        # Return false for sanity check if it's a field. Subclasses should overwrite.
+        def const_field?
+          false
+        end
+
+        # Return false for sanity check if it's a method. Subclasses should overwrite.
+        def const_method?
+          false
+        end
+
       end
-      
+
     end
   end
 end