rubex 0.1.1 → 0.1.2

data/lib/rubex/rake_task.rb

@@ -5,30 +5,66 @@ require_relative '../rubex.rb'
 
 module Rubex
   class RakeTask < ::Rake::TaskLib
+    attr_reader :ext_dir, :rubex_files
+    attr_accessor :debug
 
-    def initialize name, gem_spec=nil
+    def initialize name, gem_spec=nil, &block
       @name = name
       @gem_spec = gem_spec
-      @ext_dir = "ext/#{@name}"
+      @ext_dir = "#{Dir.pwd}/ext/#{@name}"
       @lib_dir = 'lib'
       @source_pattern = "*.rubex"
       @compiled_pattern = "*.c"
       @config_script = "extconf.rb"
+      @debug = true
+      instance_eval(&block) if block_given?
       define_compile_tasks
     end
 
+    # Change the directory that contains rubex files. Overrides default
+    # assumption of gem file structure.
+    #
+    # @param [String] ext_dir Path to new ext dir.
+    def ext ext_dir
+      @ext_dir = ext_dir
+    end
+
+    # Specify the names of Rubex files with respect to ext directory if compiling
+    # multiple files.
+    #
+    # @param [Array[String]] files Array containing names of all files relative to
+    #   ext directory as Strings.
+    def files files
+      @rubex_files = files
+    end
+
     def define_compile_tasks
       namespace :rubex do
         desc "Compile a Rubex file into a shared object."
         task :compile do
-          file_name = "#{Dir.pwd}/#{@ext_dir}/#{@name}#{@source_pattern[1..-1]}"
-          Rubex::Compiler.compile file_name, directory: "#{@ext_dir}"
+          file_name = "#{@ext_dir}/#{@name}#{@source_pattern[1..-1]}"
+          Rubex::Compiler.compile file_name, target_dir: "#{@ext_dir}", debug: @debug
+        end
+
+        desc "Delete all generated files."
+        task :clobber do
+          path = @ext_dir
+          unless path.end_with?(@name)
+            path += "/#{@name}"
+          end
+
+          Dir.chdir(path) do
+            FileUtils.rm(
+              Dir.glob(
+              "#{path}/*.{c,h,so,o,bundle,dll}") + ["Makefile", "extconf.rb"], force: true
+            )
+          end
         end
       end
       Rake::ExtensionTask.new(@name)
 
       desc "Compile Rubex code into a .so file for use in Ruby scripts."
-      task :compile => "rubex:compile"
+      task "compile" => "rubex:compile"
     end
   end # class RakeTask
-end # module Rubex
+end # module Rubex

data/lib/rubex/symbol_table/entry.rb

@@ -13,9 +13,15 @@ module Rubex
       attr_accessor :extern
       # Is a Ruby singleton method
       attr_accessor :singleton
+      # Number of times this entry is called in a function. Useful for Ruby methods.
+      attr_accessor :times_called
+      # Whether this entry has a no_gil tag or not. Applicable for C functions.
+      attr_accessor :no_gil
 
       def initialize name, c_name, type, value
         @name, @c_name, @type, @value = name, c_name, type, value
+        @times_called = 0
+        @no_gil = false
       end
 
       def c_code local_scope

data/lib/rubex/symbol_table/scope.rb

@@ -191,7 +191,11 @@ module Rubex
       class Klass
         include Rubex::SymbolTable::Scope
         attr_accessor :include_files #TODO: this should probably not be here.
+        # Stores callbacks for begin blocks since they cannot be a part of the
+        #   statements of a class.
         attr_accessor :begin_block_callbacks
+        # Similar to begin_block_callbacks
+        attr_accessor :no_gil_block_callbacks
 
         def initialize name, outer_scope
           super(outer_scope)
@@ -199,6 +203,7 @@ module Rubex
           @klass_name = @name
           @include_files = []
           @begin_block_callbacks = []
+          @no_gil_block_callbacks = []
         end
 
         def object_scope
@@ -214,17 +219,24 @@ module Rubex
         def add_begin_block_callback func
           @begin_block_callbacks << func
         end
+
+        # Stores CFunctionDef nodes that represent no_gil block callbacks.
+        def add_no_gil_block_callback func
+          @no_gil_block_callbacks << func
+        end
       end # class Klass
 
       class Local
         include Rubex::SymbolTable::Scope
-        attr_reader :begin_block_counter
+        attr_reader :begin_block_counter,
+                    :no_gil_block_counter
 
         def initialize name, outer_scope
           super(outer_scope)
           @name = name
           @klass_name = outer_scope.klass_name
           @begin_block_counter = 0
+          @no_gil_block_counter = 0
         end
 
         # args - Rubex::AST::ArgumentList. Creates sym. table entries for args.
@@ -240,6 +252,10 @@ module Rubex
         def found_begin_block
           @begin_block_counter += 1
         end
+
+        def found_no_gil_block
+          @no_gil_block_counter += 1
+        end
       end # class Local
 
       class BeginBlock
@@ -254,11 +270,14 @@ module Rubex
         def upgrade_symbols_to_global
           @block_entries.uniq!
           @block_entries.each do |entry|
-            entry.c_name = Rubex::GLOBAL_PREFIX + @name + entry.c_name
             @outer_scope.global_entries << entry
           end
 
           remove_global_from_local_entries
+          
+          @outer_scope.global_entries.each do |entry| 
+            entry.c_name = Rubex::GLOBAL_PREFIX + @name + entry.c_name
+          end
         end
 
         # IMPORTANT NOTE TO PROGRAMMER:
@@ -268,6 +287,10 @@ module Rubex
         # C, the begin block must be put inside its own C function, which is then
         # sent as a callback to rb_protect().
         #
+        # The same as above applies to a no_gil block, which is why the NoGilBlock
+        # (defined below) inherits from this class and completely imitates its
+        # behaviour.
+        #
         # As a result, it is necesary to 'upgrade' the local variables present
         # inside the begin block to C global variables so that they can be shared
         # between the callback C function encapsulating the begin block and the 
@@ -286,7 +309,7 @@ module Rubex
         # of @outer_scope get carried forward into this begin block callback.
         # Therefore these variables get declared inside the begin block callback
         # as well. So whenever one of these Arrays is called for this particular
-        # scope, we return an empty array so that nothing gets declared.
+        # scope, we preturn an empty array so that nothing gets declared.
         def method_missing meth, *args, &block
           return [] if meth == :var_entries
           ret = @outer_scope.send(meth, *args, &block)
@@ -315,6 +338,8 @@ module Rubex
         end
       end # class BeginBlock
 
+      class NoGilBlock < BeginBlock; end
+
       class StructOrUnion
         include Rubex::SymbolTable::Scope
         # FIXME: Change scope structure to identify struct scopes by name too.

data/lib/rubex/version.rb

@@ -1,3 +1,3 @@
 module Rubex
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.2".freeze
 end

data/rubex.gemspec

@@ -37,4 +37,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'ruby-prof'
   spec.add_development_dependency 'benchmark-ips'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'numo-narray'
 end

data/spec/basic_ruby_method_spec.rb

@@ -15,9 +15,9 @@ describe Rubex do
       end
     end
 
-    context ".compile" do
+    context ".compile", tit: true do
       it "generates valid C code" do
-        t, c, e = Rubex::Compiler.compile @path + ".rubex", test: true
+        t, c, e, h = Rubex::Compiler.compile @path + ".rubex", test: true
       end
     end
 

data/spec/blocks_spec.rb

@@ -14,13 +14,13 @@ describe Rubex do
       end
     end
 
-    context ".compile", focus: true do
+    context ".compile" do
       it "compiles to valid C file" do
         t,c,e = Rubex::Compiler.compile(@path + '.rubex', test: true)
       end
     end
 
-    context "Black Box testing", focus: true do
+    context "Black Box testing" do
       it "compiles and checks for valid output" do
         setup_and_teardown_compiled_files(test_case) do |dir|
           require_relative "#{dir}/#{test_case}.#{os_extension}"

data/spec/box_op_multi_args_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Rubex do
+  test_case = "box_op_multi_args"
+
+  context "Case: #{test_case}" do
+    before do
+      @path = path_str test_case
+    end
+
+    context ".ast" do
+      it "generates the AST" do
+        t = Rubex::Compiler.ast(@path + '.rubex')
+      end
+    end
+
+    context ".compile" do
+      it "compiles to valid C file" do
+        t,c,e = Rubex::Compiler.compile(@path + '.rubex', test: true)
+      end
+    end
+
+    context "Black Box testing" do
+      it "compiles and checks for valid output" do
+        setup_and_teardown_compiled_files(test_case) do |dir|
+          require_relative "#{dir}/#{test_case}.#{os_extension}"
+          require 'numo/narray'
+          n = Numo::DFloat.new(3,3).seq
+          expect(multi_arg_box(n)).to eq(4.0)
+        end
+      end
+    end
+  end
+end

data/spec/c_function_ptrs_spec.rb

@@ -15,13 +15,13 @@ describe Rubex do
       end
     end
 
-    context ".compile", focus: true do
+    context ".compile" do
       it "generates valid C code" do
         t, c, e = Rubex::Compiler.compile @path + ".rubex", test: true
       end
     end
 
-    context "Black Box testing", focus: true do
+    context "Black Box testing" do
       it "compiles and checks for valid output" do
         setup_and_teardown_compiled_files(test_case) do |dir|
           require_relative "#{dir}/#{test_case}.#{os_extension}"

data/spec/c_functions_spec.rb

@@ -28,6 +28,8 @@ describe Rubex do
           c = CFunctions.new
           expect(c.pure_ruby_method).to eq(50)
           expect { c.first_c_function(1,2) }.to raise_error(NoMethodError)
+
+          expect(TypeCast.new.foo(5,5)).to eq(10)
         end
       end
     end

data/spec/c_struct_interface_spec.rb

@@ -15,13 +15,13 @@ describe Rubex do
       end
     end
 
-    context ".compile", focus: true do
+    context ".compile" do
       it "generates valid C code" do
-        t, c, e = Rubex::Compiler.compile @path + ".rubex", test: true
+        t, c, e, h = Rubex::Compiler.compile @path + ".rubex", test: true
       end
     end
 
-    context "Black Box testing", focus: true do
+    context "Black Box testing" do
       it "compiles and checks for valid output" do
         setup_and_teardown_compiled_files(test_case) do |dir|
           require_relative "#{dir}/#{test_case}.#{os_extension}"
@@ -31,6 +31,11 @@ describe Rubex do
           expect(m.artist).to eq("Animals as Leaders")
           expect(m.title) .to eq("CAFO")
           expect(m.id)    .to eq(id)
+          expect(m.id_i)  .to eq(id + 1)
+
+          t = A.new
+
+          expect(t.foo).to eq(55)
         end
       end
     end

data/spec/default_args_spec.rb

@@ -14,13 +14,13 @@ describe Rubex do
       end
     end
 
-    context '.compile', focus: true do
+    context '.compile' do
       skip 'compiles to valid C code' do
         t, c, e = Rubex::Compiler.compile(@path + '.rubex', test: true)
       end
     end
 
-    context 'Black Box testing', focus: true do
+    context 'Black Box testing' do
       skip 'compiles and checks for valid output' do
         setup_and_teardown_compiled_files(test_case) do |dir|
           require_relative "#{dir}/#{test_case}.#{os_extension}"

data/spec/external_c_struct_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Rubex do
+  test_case = 'external_c_struct'
+
+  context "Case: #{test_case}" do
+    before do
+      @path = path_str test_case
+    end
+
+    context ".ast" do
+      it "generates the AST" do
+        t = Rubex::Compiler.ast(@path + '.rubex')
+      end
+    end
+
+    context ".compile" do
+      it "compiles to valid C file" do
+        t,c,e = Rubex::Compiler.compile(@path + '.rubex', test: true)
+      end
+    end
+
+    context "Black Box testing" do
+      it "compiles and checks for valid output" do
+        setup_and_teardown_compiled_files(test_case) do |dir|
+          require_relative "#{dir}/#{test_case}.#{os_extension}"
+
+          expect(HelloFile.new.foo).to eq(false)
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/box_op_multi_args/box_op_multi_args.rubex

@@ -0,0 +1,3 @@
+def multi_arg_box(n)
+  return n[1,1]
+end

data/spec/fixtures/c_functions/c_functions.rubex

@@ -23,3 +23,16 @@ class CFunctions
     
   end
 end
+
+# Try to typecast ruby object to target type when sending to function with a
+#   given type.
+class TypeCast
+  cfunc int bar(char * s, int a, int b)
+    return a + b
+  end
+
+  def foo(i, j)
+    s = "hello world!"
+    return bar(s,i,j)
+  end
+end

data/spec/fixtures/c_struct_interface/c_struct_interface.rubex

@@ -31,4 +31,32 @@ class Music attach mp3info
   def id
     return data$.mp3info.id
   end
+
+  cfunc int inc_id
+    return (data$.mp3info.id + 1)
+  end
+  
+  def id_i
+    inc_id()  
+    return inc_id()
+  end
+end
+
+struct test
+  int *a
+end
+
+class A attach test
+  cfunc object allocate
+    data$.test.a = <int*>xmalloc(sizeof(int)*100)
+  end
+
+  def foo
+    data$.test.a[3] = 55
+    return data$.test.a[3]
+  end
+
+  cfunc void deallocate
+    xfree(data$.test.a)
+  end
 end

data/spec/fixtures/class_methods/class_methods.rubex

@@ -3,7 +3,7 @@ class Bhau
     int i = 0
 
     while i < 10 do
-      print string
+      print(string)
       i += 1
     end
 

data/spec/fixtures/error_handling/error_handling.rubex

@@ -24,7 +24,7 @@ class Handler
 
   def test_uncaught_error
     begin
-      raise ArgumentError
+      raise(ArgumentError)
     rescue SyntaxError
     end
   end
@@ -32,7 +32,7 @@ class Handler
   def test_without_rescue
     int i = 1
     begin
-      raise ArgumentError
+      raise(ArgumentError)
     ensure
       return i
     end