bitescript 0.0.7 → 0.0.8

data/History.txt

@@ -1,3 +1,14 @@
+=== 0.0.8 / 2011-03-05
+
+* Support parsing of generic signatures
+* Update ASM reference to work with JRuby >=1.6.0.RC3 name mangling
+
+=== 0.0.7 / 2010-11-10
+
+* Fix some likely label collisions
+* Class mirror and annotation fixes
+* Post-generate verification
+
 === 0.0.6 / 2010-06-09
 
 * Move to a class mirror API rather than loading and walking real classes

data/README.txt

@@ -1,6 +1,6 @@
 = bitescript
 
-http://kenai.com/projects/jvmscript
+http://github.com/headius/bitescript
 
 == DESCRIPTION:
 
@@ -16,7 +16,7 @@ include BiteScript
 
 fb = FileBuilder.build(__FILE__) do
   public_class "SimpleLoop" do
-    public_static_method "main", void, string[] do
+    public_static_method "main", [], void, string[] do
       aload 0
       push_int 0
       aaload
@@ -45,7 +45,7 @@ gem install bitescript
 
 == LICENSE:
 
-Copyright (c) 2009, Charles Oliver Nutter
+Copyright (c) 2009-2011, Charles Oliver Nutter
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

data/bitescript.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bitescript}
-  s.version = "0.0.7"
+  s.version = "0.0.8"
   s.authors = ["Charles Oliver Nutter", "Ryan Brown"]
   s.date = Time.now.strftime('YYYY-MM-DD')
   s.description = %q{BiteScript is a Ruby DSL for generating Java bytecode and classes.}

data/examples/instanceof.bs

@@ -0,0 +1,13 @@
+main do
+  ldc 'hello'
+  instanceof java.lang.CharSequence
+  ifeq :not
+  ldc 'is instance of!'
+  aprintln
+  goto :end
+  label :not
+  ldc 'not instance of!'
+  aprintln
+  label :end
+  returnvoid
+end

data/lib/bitescript/asm.rb

@@ -3,16 +3,25 @@ require 'java'
 module BiteScript
   module ASM
     begin
-      # try mangled names for the version included with JRuby
+      # try mangled names for the version included with JRuby <=1.6.0.RC2
       java.lang.Class.for_name 'jruby.objectweb.asm.Opcodes'
       
       # no error, proceed with mangled name
       asm_package = Java::jruby.objectweb.asm
       java_import asm_package.Opcodes
     rescue Exception
-      # fall back on standard names
-      asm_package = org.objectweb.asm
-      java_import asm_package.Opcodes
+      begin
+        # try mangled names for the version included with JRuby >=1.6.0.RC3
+        java.lang.Class.for_name 'org.jruby.org.objectweb.asm.Opcodes'
+        
+        # no error, proceed with mangled name
+        asm_package = Java::org.jruby.org.objectweb.asm
+        java_import asm_package.Opcodes
+      rescue
+        # fall back on standard names
+        asm_package = org.objectweb.asm
+        java_import asm_package.Opcodes
+      end
     end
     java_import asm_package.Label
     java_import asm_package.Type
@@ -23,5 +32,8 @@ module BiteScript
     java_import asm_package.ClassReader
     java_import asm_package.ClassWriter
     java_import asm_package.util.CheckClassAdapter
+    java_import asm_package.signature.SignatureReader
+    java_import asm_package.signature.SignatureVisitor
+    java_import asm_package.signature.SignatureWriter
   end
 end

data/lib/bitescript/mirror.rb

@@ -168,7 +168,7 @@ module BiteScript::ASM
     include Modifiers
 
     attr_reader :type, :interfaces
-    attr_accessor :superclass
+    attr_accessor :superclass, :signature
 
     def initialize(type, flags)
       super()
@@ -248,6 +248,18 @@ module BiteScript::ASM
       @fields[field.name] = field
     end
 
+    def type_parameters
+      signature.type_parameters is signature
+    end
+
+    def generic_superclass
+      signature.superclass if signature
+    end
+
+    def generic_interfaces
+      signature.interfaces if signature
+    end
+
     def inspect
       if annotation?
         kind = "@interface"
@@ -285,6 +297,7 @@ module BiteScript::ASM
       def visit(version, access, name, signature, super_name, interfaces)
         @current = @class = ClassMirror.new(Type.getObjectType(name), access)
         @class.superclass = Type.getObjectType(super_name) if super_name
+        @class.signature = SignatureMirror.new(signature) if signature
         if interfaces
           interfaces.each do |i|
             @class.interfaces << Type.getObjectType(i)
@@ -309,7 +322,8 @@ module BiteScript::ASM
       end
 
       def visitField(flags, name, desc, signature, value)
-        @current = FieldMirror.new(@class.type, flags, name, Type.getType(desc), value)
+        signature = GenericTypeBuilder.read(signature)
+        @current = FieldMirror.new(@class.type, flags, name, Type.getType(desc), signature, value)
         @class.addField(@current)
         self
       end
@@ -318,8 +332,9 @@ module BiteScript::ASM
         return_type = Type.getReturnType(desc)
         parameters = Type.getArgumentTypes(desc).to_a
         exceptions = (exceptions || []).map {|e| Type.getObjectType(e)}
+        signature = SignatureMirror.new(signature) if signature
         @current = MethodMirror.new(
-            @class.type, flags, return_type, name, parameters, exceptions)
+            @class.type, flags, return_type, name, parameters, exceptions, signature)
         @class.addMethod(@current)
         # TODO parameter annotations, default value, etc.
         self  # This isn't legal is it?
@@ -337,13 +352,18 @@ module BiteScript::ASM
     include Modifiers
     include Annotated
 
-    attr_reader :declaring_class, :name, :type, :value
-    def initialize(klass, flags, name, type, value)
+    attr_reader :declaring_class, :name, :type, :value, :signature
+    def initialize(klass, flags, name, type, signature, value)
       @declaring_class = klass
       @flags = flags
       @name = name
       @type = type
       @value = value
+      @signature = signature
+    end
+
+    def generic_type
+      signature
     end
 
     def inspect
@@ -356,8 +376,9 @@ module BiteScript::ASM
     include Annotated
 
     attr_reader :declaring_class, :name, :return_type
-    attr_reader :argument_types, :exception_types
-    def initialize(klass, flags, return_type, name, parameters, exceptions)
+    attr_reader :argument_types, :exception_types, :signature
+
+    def initialize(klass, flags, return_type, name, parameters, exceptions, signature)
       @flags = flags
       @declaring_class = klass
       @name = name
@@ -366,6 +387,22 @@ module BiteScript::ASM
       @exception_types = exceptions
     end
 
+    def generic_parameter_types
+      signature.parameter_types if signature
+    end
+
+    def generic_return_type
+      signature.return_type if signature
+    end
+
+    def generic_exception_types
+      signature.exception_types if signature
+    end
+
+    def type_parameters
+      signature.type_parameters is signature
+    end
+
     def inspect
       "%s%s%s %s(%s);" % [
         inspect_annotations,
@@ -376,4 +413,237 @@ module BiteScript::ASM
       ]
     end
   end
+
+  class SignatureMirror
+    include BiteScript::ASM::SignatureVisitor
+
+    attr_reader :type_parameters
+    attr_reader :parameter_types, :return_type, :exception_types
+    attr_reader :superclass, :interfaces
+
+    def method?
+      return_type != nil
+    end
+
+    def class?
+      superclass != nil
+    end
+
+    def initialize(signature=nil)
+      @type_parameters = []
+      @parameter_types = []
+      @exception_types = []
+      @interfaces = []
+      if (signature)
+        reader = BiteScript::ASM::SignatureReader.new(signature)
+        reader.accept(self)
+      end
+    end
+
+    def visitFormalTypeParameter(name)
+      type_parameters << TypeVariable.new(name)
+    end
+
+    def visitClassBound
+      GenericTypeBuilder.new {|bound| type_parameters[-1].bounds << bound}
+    end
+
+    def visitInterfaceBound
+      GenericTypeBuilder.new {|bound| type_parameters[-1].bounds << bound}
+    end
+
+    def visitParameterType
+      GenericTypeBuilder.new {|type| parameter_types << type}
+    end
+
+    def visitReturnType
+      GenericTypeBuilder.new {|type| @return_type = type}
+    end
+
+    def visitExceptionType
+      GenericTypeBuilder.new {|type| exception_types << type}
+    end
+
+    def visitSuperclass
+      GenericTypeBuilder.new {|type| @superclass = type}
+    end
+
+    def visitInterface
+      GenericTypeBuilder.new {|type| interfaces << type}
+    end
+  end
+
+  class GenericTypeMirror
+    def array?
+      false
+    end
+    def wildcard?
+      false
+    end
+    def generic_class?
+      false
+    end
+    def type_variable?
+      false
+    end
+    def inspect
+      "<#{self.class.name} #{to_s}>"
+    end
+  end
+
+  class TypeVariable < GenericTypeMirror
+    attr_reader :name, :bounds
+    def initialize(name)
+      @name = name
+      @bounds = []
+    end
+    def type_variable?
+      true
+    end
+
+    def to_s
+      result = "#{name}"
+      unless bounds.empty?
+        result << ' extends ' << bounds.map {|b| b.to_s}.join(' & ')
+      end
+      result
+    end
+  end
+
+  class GenericArray < GenericTypeMirror
+    attr_accessor :component_type
+    def array?
+      true
+    end
+    def to_s
+      "#{component_type}[]"
+    end
+  end
+
+  class Wildcard < GenericTypeMirror
+    attr_reader :lower_bound, :upper_bound
+    def initialize(upper_bound, lower_bound=nil)
+      @upper_bound = upper_bound
+      @lower_bound = lower_bound
+    end
+    def wildcard?
+      true
+    end
+    def to_s?
+      if lower_bound
+        "? super #{lower_bound}"
+      elsif upper_bound
+        "? extends #{upper_bound}"
+      else
+        "?"
+      end
+    end
+  end
+
+  class ParameterizedType < GenericTypeMirror
+    attr_reader :raw_type, :type_arguments, :outer_type
+
+    def initialize(raw_type, outer_type=nil)
+      @raw_type = raw_type
+      @type_arguments = []
+      @outer_type = outer_type
+    end
+
+    def descriptor
+      raw_type.descriptor
+    end
+
+    def generic_class?
+      true
+    end
+
+    def to_s
+      name = raw_type.internal_name.tr('/', '.')
+      unless type_arguments.empty?
+        name << "<#{type_arguments.map {|a| a.to_s}.join(', ')}>"
+      end
+      if outer_type
+        "#{outer_type}.#{name}"
+      else
+        name
+      end
+    end
+  end
+
+  class GenericTypeBuilder
+    include BiteScript::ASM::SignatureVisitor
+    attr_reader :result
+
+    def self.read(signature)
+      if signature
+        builder = GenericTypeBuilder.new
+        reader = BiteScript::ASM::SignatureReader.new(signature)
+        reader.accept(builder)
+        builder.result
+      end
+    end
+
+    def initialize(&block)
+      @block = block
+    end
+
+    def return_type(type)
+      @result = type
+      @block.call(type) if @block
+    end
+
+    def visitBaseType(desc)
+      return_type(Type.getType(desc.chr))
+    end
+
+    def visitArrayType
+      type = GenericArray.new
+      return_type(type)
+      GenericTypeBuilder.new {|component_type| type.component_type = component_type}
+    end
+
+    def visitTypeVariable(name)
+      return_type(TypeVariable.new(name))
+    end
+
+    def visitClassType(desc)
+      return_type(ParameterizedType.new(Type.getObjectType(desc)))
+    end
+
+    def visitTypeArgument(wildcard=nil)
+      if wildcard.nil?
+        @result.type_arguments <<
+            Wildcard.new(Type.getObjectType('java/lang/Object'))
+        return
+      end
+      GenericTypeBuilder.new do |type|
+        argument = case wildcard
+        when INSTANCEOF
+          type
+        when EXTENDS
+          Wildcard.new(type)
+        when SUPER
+          Wildcard.new(nil, type)
+        else
+          raise "Unknown wildcard #{wildcard.chr}"
+        end
+        @result.type_arguments << argument
+      end
+    end
+
+    def visitSuperclass
+      self
+    end
+
+    def visitInnerClassType(name)
+      desc = @result.descriptor.sub(/;$/, "$#{name};")
+      return_type(ParameterizedType.new(Type.getType(desc), @result))
+    end
+
+    def visitEnd
+      if @result.type_arguments.empty? && @result.outer_type.nil?
+        @result = @result.raw_type
+      end
+    end
+  end
 end

data/test/test_generics.rb

@@ -0,0 +1,127 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'bitescript'
+
+class TestGenerics < Test::Unit::TestCase
+  def test_type_signature
+    sig = BiteScript::GenericTypeBuilder.read('Ljava/util/List<TE;>;')
+    assert sig.generic_class?
+    assert_equal 'Ljava/util/List;', sig.raw_type.descriptor
+    assert_kind_of BiteScript::ASM::Type, sig.raw_type
+    assert_equal 1, sig.type_arguments.size
+    assert sig.type_arguments[0].type_variable?
+    assert_equal 'E', sig.type_arguments[0].name
+  end
+
+  def test_wildcard
+    sig = BiteScript::GenericTypeBuilder.read('Ljava/util/List<*>;')
+    assert sig.generic_class?
+    assert_equal 'Ljava/util/List;', sig.raw_type.descriptor
+    assert_kind_of BiteScript::ASM::Type, sig.raw_type
+    assert_equal 1, sig.type_arguments.size
+    assert sig.type_arguments[0].wildcard?
+
+    wildcard = sig.type_arguments[0]
+    assert_nil wildcard.lower_bound
+    assert_not_nil wildcard.upper_bound
+    assert_equal 'Ljava/lang/Object;', wildcard.upper_bound.descriptor
+
+    sig = BiteScript::GenericTypeBuilder.read('Ljava/util/List<+Ljava/lang/Number;>;')
+    wildcard = sig.type_arguments[0]
+    assert wildcard.wildcard?
+    assert_nil wildcard.lower_bound
+    assert_not_nil wildcard.upper_bound
+    assert_equal 'Ljava/lang/Number;', wildcard.upper_bound.descriptor
+
+    sig = BiteScript::GenericTypeBuilder.read('Ljava/util/List<-Ljava/lang/Integer;>;')
+    wildcard = sig.type_arguments[0]
+    assert wildcard.wildcard?
+    assert_not_nil wildcard.lower_bound
+    assert_nil wildcard.upper_bound
+    assert_equal 'Ljava/lang/Integer;', wildcard.lower_bound.descriptor
+  end
+
+  def test_array
+    sig = BiteScript::GenericTypeBuilder.read('[Ljava/util/List<Ljava/lang/String;>;')
+    assert sig.array?
+    list = sig.component_type
+    assert list.generic_class?
+    assert_equal 'Ljava/util/List;', list.raw_type.descriptor
+    assert_kind_of BiteScript::ASM::Type, list.raw_type
+    assert_equal 1, list.type_arguments.size
+    string = list.type_arguments[0]
+    assert_equal 'Ljava/lang/String;', string.descriptor
+  end
+
+  def test_inner_class
+    sig = BiteScript::GenericTypeBuilder.read('Ljava/util/HashMap<TK;TV;>.HashIterator<TK;>;')
+    assert sig.generic_class?
+    assert_kind_of BiteScript::ASM::Type, sig.raw_type
+    assert_equal 'Ljava/util/HashMap$HashIterator;', sig.raw_type.descriptor
+    assert sig.outer_type.generic_class?
+    assert_kind_of BiteScript::ASM::Type, sig.outer_type.raw_type
+    assert_equal 'Ljava/util/HashMap;', sig.outer_type.raw_type.descriptor
+    assert_equal ['K', 'V'], sig.outer_type.type_arguments.map {|x| x.name}
+  end
+
+  def test_method_signature
+    sig = BiteScript::SignatureMirror.new(
+        '<T:Ljava/lang/Object;>(I)Ljava/lang/Class<+TT;>;')
+    assert sig.method?
+    assert !sig.class?
+
+    type = sig.return_type
+    assert type.generic_class?
+    assert_equal 'Ljava/lang/Class;', type.raw_type.descriptor
+    assert_equal 1, type.type_arguments.size
+
+    arg = type.type_arguments[0]
+    assert arg.wildcard?
+    assert_nil arg.lower_bound
+    assert_not_nil arg.upper_bound
+    assert arg.upper_bound.type_variable?
+    assert_equal 'T', arg.upper_bound.name
+
+    assert_equal 1, sig.parameter_types.size
+    assert_kind_of BiteScript::ASM::Type, sig.parameter_types[0]
+    assert_equal 'I', sig.parameter_types[0].descriptor
+
+    assert_equal 1, sig.type_parameters.size
+    var = sig.type_parameters[0]
+    assert var.type_variable?
+    assert_equal 'T', var.name
+    assert_equal 1, var.bounds.size
+    assert_equal 'Ljava/lang/Object;', var.bounds[0].descriptor
+  end
+
+  def test_class_signature
+    sig = BiteScript::SignatureMirror.new(
+        '<E:Ljava/lang/Object;>Ljava/util/List<TE;>;')
+    assert sig.class?
+    assert !sig.method?
+
+    assert_equal 0, sig.interfaces.size
+
+    superclass = sig.superclass
+    assert superclass.generic_class?
+    assert_equal 'Ljava/util/List;', superclass.raw_type.descriptor
+    assert_equal 'E', superclass.type_arguments[0].name
+
+    assert_equal 1, sig.type_parameters.size
+    var = sig.type_parameters[0]
+    assert var.type_variable?
+    assert_equal 'E', var.name
+    assert_equal 1, var.bounds.size
+    assert_equal 'Ljava/lang/Object;', var.bounds[0].descriptor
+  end
+
+  def test_multiple_bounds
+    sig = BiteScript::SignatureMirror.new(
+        '<T::Ljava/lang/Comparable<TT;>;:Ljava/lang/Iterable<TT;>;>Ljava/lang/Object;')
+    t = sig.type_parameters[0]
+    assert_equal 2, t.bounds.size
+    assert_equal "java.lang.Comparable<T>", t.bounds[0].to_s
+    assert_equal "java.lang.Iterable<T>", t.bounds[1].to_s
+  end
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: bitescript
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-    - 0
-    - 0
-    - 7
-  version: 0.0.7
+  prerelease: 
+  version: 0.0.8
 platform: ruby
 authors: 
   - Charles Oliver Nutter
@@ -15,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-10 08:48:06.220000 +01:00
+date: 2011-03-07 10:38:26.957000 -06:00
 default_executable: 
 dependencies: []
 
@@ -41,6 +37,7 @@ files:
   - examples/hello_world.class
   - examples/hello_world_macro.bs
   - examples/indy.bs
+  - examples/instanceof.bs
   - examples/mixed_bag.rb
   - examples/simple_loop.rb
   - examples/using_ruby.bs
@@ -57,6 +54,7 @@ files:
   - test/test_bitescript.rb
   - test/test_builder.rb
   - test/test_bytecode.rb
+  - test/test_generics.rb
   - test/test_java_class.rb
   - test/test_signature.rb
   - History.txt
@@ -79,21 +77,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-          - 0
         version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-          - 0
         version: "0"
 requirements: []
 
 rubyforge_project: jruby-extras
-rubygems_version: 1.3.7
+rubygems_version: 1.5.1
 signing_key: 
 specification_version: 3
 summary: BiteScript is a Ruby DSL for generating Java bytecode.
@@ -101,5 +95,6 @@ test_files:
   - test/test_bitescript.rb
   - test/test_builder.rb
   - test/test_bytecode.rb
+  - test/test_generics.rb
   - test/test_java_class.rb
   - test/test_signature.rb