ruby-llvm 2.9.0 → 2.9.1

data/lib/llvm/execution_engine.rb

@@ -4,6 +4,7 @@ require 'llvm/target'
 require 'llvm/analysis'
 
 module LLVM
+  # @private
   module C
     # Generic values
     attach_function :LLVMCreateGenericValueOfInt, [:pointer, :long_long, :int], :pointer
@@ -54,14 +55,17 @@ module LLVM
   class ExecutionEngine
     private_class_method :new
 
-    def initialize(ptr) # :nodoc:
+    # @private
+    def initialize(ptr)
       @ptr = ptr
     end
 
-    def to_ptr # :nodoc:
+    # @private
+    def to_ptr
       @ptr
     end
 
+    # Create a JIT compiler with an LLVM::Module.
     def self.create_jit_compiler(mod, opt_level = 3)
       FFI::MemoryPointer.new(FFI.type_size(:pointer)) do |ptr|
         error   = FFI::MemoryPointer.new(FFI.type_size(:pointer))
@@ -79,6 +83,8 @@ module LLVM
       end
     end
 
+    # Execute the given LLVM::Function with the supplied args (as
+    # GenericValues).
     def run_function(fun, *args)
       FFI::MemoryPointer.new(FFI.type_size(:pointer) * args.size) do |args_ptr|
         args_ptr.write_array_of_pointer(args.map { |arg| LLVM.GenericValue(arg).to_ptr })
@@ -87,6 +93,7 @@ module LLVM
       end
     end
 
+    # Obtain an FFI::Pointer to a global within the current module.
     def pointer_to_global(global)
       C.LLVMGetPointerToGlobal(self, global)
     end
@@ -95,46 +102,57 @@ module LLVM
   class GenericValue
     private_class_method :new
 
-    def initialize(ptr) # :nodoc:
+    # @private
+    def initialize(ptr)
       @ptr = ptr
     end
 
-    def to_ptr # :nodoc:
+    # @private
+    def to_ptr
       @ptr
     end
 
+    # Creates a Generic Value from an integer. Type is the size of integer to
+    # create (ex. Int32, Int8, etc.)
     def self.from_i(i, type = LLVM::Int, signed = true)
       new(C.LLVMCreateGenericValueOfInt(type, i, signed ? 1 : 0))
     end
 
+    # Creates a Generic Value from a Float.
     def self.from_f(f)
       type = LLVM::Float.type
       new(C.LLVMCreateGenericValueOfFloat(type, f))
     end
     
+    # Creates a GenericValue from a Ruby boolean.
     def self.from_b(b)
       from_i(b ? 1 : 0, LLVM::Int1, false)
     end
 
+    # Creates a GenericValue from an FFI::Pointer.
     def self.from_ptr(ptr)
       new(ptr)
     end
 
+    # Converts a GenericValue to a Ruby Integer.
     def to_i(signed = true)
       C.LLVMGenericValueToInt(self, signed ? 1 : 0)
     end
 
+    # Converts a GenericValue to a Ruby Float.
     def to_f(type = LLVM::Float.type)
       C.LLVMGenericValueToFloat(type, self)
     end
     
+    # Converts a GenericValue to a Ruby boolean.
     def to_b
       to_i(false) != 0
     end
-    
   end
 
-  def GenericValue(val)
+  # Creates a GenericValue from an object (GenericValue, Integer, Float, true,
+  # false).
+  def LLVM.GenericValue(val)
     case val
     when GenericValue then val
     when ::Integer then GenericValue.from_i(val)
@@ -143,5 +161,4 @@ module LLVM
     when ::FalseClass then GenericValue.from_b(false)
     end
   end
-  module_function :GenericValue
 end

data/lib/llvm/target.rb

@@ -2,6 +2,7 @@ require 'llvm'
 require 'llvm/core'
 
 module LLVM
+  # @private
   module C
     attach_function :LLVMAddTargetData, [:pointer, :pointer], :void
   end

data/lib/llvm/transforms/ipo.rb

@@ -3,11 +3,13 @@ require 'llvm'
 require 'llvm/core'
 
 module LLVM
+  # @private
   module C
     attach_function :LLVMAddGlobalDCEPass, [:pointer], :void
   end
 
   class PassManager
+    # @LLVMpass gdce
     def gdce!
       C.LLVMAddGlobalDCEPass(self)
     end

data/lib/llvm/transforms/scalar.rb

@@ -2,6 +2,7 @@ require 'llvm'
 require 'llvm/core'
 
 module LLVM
+  # @private
   module C
     attach_function :LLVMAddAggressiveDCEPass, [:pointer], :void
     attach_function :LLVMAddCFGSimplificationPass, [:pointer], :void
@@ -27,86 +28,107 @@ module LLVM
   end
   
   class PassManager
+    # @LLVMpass adce
     def adce!
       C.LLVMAddAggressiveDCEPass(self)
     end
     
+    # @LLVMpass simplifycfg
     def simplifycfg!
       C.LLVMAddCFGSimplificationPass(self)
     end
     
+    # @LLVMpass dse
     def dse!
       C.LLVMAddDeadStoreEliminationPass(self)
     end
     
+    # @LLVMpass gvn
     def gvn!
       C.LLVMAddGVNPass(self)
     end
     
+    # @LLVMpass indvars
     def indvars!
       C.LLVMAddIndVarSimplifyPass(self)
     end
     
+    # @LLVMpass instcombine
     def instcombine!
       C.LLVMAddInstructionCombiningPass(self)
     end
     
+    # @LLVMpass jump-threading
     def jump_threading!
       C.LLVMAddJumpThreadingPass(self)
     end
     
+    # @LLVMpass licm
     def licm!
       C.LLVMAddLICMPass(self)
     end
     
+    # @LLVMpass loop-deletion
     def loop_deletion!
       C.LLVMAddLoopDeletionPass(self)
     end
     
+    # @LLVMpass loop-rotate
     def loop_rotate!
       C.LLVMAddLoopRotatePass(self)
     end
     
+    # @LLVMpass loop-unroll
     def loop_unroll!
       C.LLVMAddLoopUnrollPass(self)
     end
     
+    # @LLVMpass loop-unswitch
     def loop_unswitch!
       C.LLVMAddLoopUnswitchPass(self)
     end
     
+    # @LLVMpass memcpyopt
     def memcpyopt!
       C.LLVMAddMemCpyOptPass(self)
     end
     
+    # @LLVMpass mem2reg
     def mem2reg!
       C.LLVMAddPromoteMemoryToRegisterPass(self)
     end
     
+    # @LLVMpass reassociate
     def reassociate!
       C.LLVMAddReassociatePass(self)
     end
     
+    # @LLVMpass sccp
     def sccp!
       C.LLVMAddSCCPPass(self)
     end
     
+    # @LLVMpass scalarrepl
     def scalarrepl!
       C.LLVMAddScalarReplAggregatesPass(self)
     end
     
+    # @LLVMpass simplify-libcalls
     def simplify_libcalls!
       C.LLVMAddSimplifyLibCallsPass(self)
     end
     
+    # @LLVMpass tailcallelim
     def tailcallelim!
       C.LLVMAddTailCallEliminationPass(self)
     end
     
+    # @LLVMpass constprop
     def constprop!
       C.LLVMAddConstantPropagationPass(self)
     end
     
+    # @LLVMpass reg2mem
     def reg2mem!
       C.LLVMAddDemoteMemoryToRegisterPass(self)
     end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-llvm
 version: !ruby/object:Gem::Version 
-  hash: 43
-  prerelease: false
-  segments: 
-  - 2
-  - 9
-  - 0
-  version: 2.9.0
+  prerelease: 
+  version: 2.9.1
 platform: ruby
 authors: 
 - Jeremy Voorhis
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-19 00:00:00 -07:00
+date: 2011-04-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,12 +21,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 5
-        - 4
-        version: 0.5.4
+        version: 1.0.0
   type: :runtime
   version_requirements: *id001
 description: 
@@ -71,23 +61,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.0
 signing_key: 
 specification_version: 3
 summary: LLVM bindings for Ruby