ffi-compiler 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,74 @@
+
+[ffi-compiler](https://github.com/ffi/ffi-compiler) is a ruby library for automating compilation of native libraries for use with [ffi](https://github.com/ffi/ffi)
+
+To use, define your own ruby->native API using ffi, implement it in C, then use ffi-compiler to compile it.
+
+Example
+------
+	
+###### Directory layout
+	lib
+	  |- example
+	      |- example.rb
+	      
+	ext
+      |- example.c
+      |- Rakefile
+      
+    example.gemspec
+
+###### lib/example/example.rb
+	require 'ffi'
+	require 'ffi-compiler/loader'
+	
+	module Example
+	  extend FFI::Library
+	  ffi_lib FFI::Compiler::Loader.find('example')
+	  
+	  # example function which takes no parameters and returns long
+	  attach_function :example, [], :long
+	end
+
+###### ext/example.c
+	long
+	example(void)
+	{
+	  return 0xdeadbeef;
+	}
+
+###### ext/Rakefile
+	require 'ffi-compiler/task'
+	
+	FFI::Compiler::Task.new('example') do |c|
+	  c.have_header?('stdio.h', '/usr/local/include')
+	  c.have_func?('puts')
+	  c.have_library?('z')
+	end
+
+###### example.gemspec
+	Gem::Specification.new do |s|
+      s.extensions << 'ext/Rakefile'
+	  s.name = 'example'
+	  s.version = '0.0.1'
+	  s.email = 'ffi-example'
+	  s.files = %w(example.gemspec) + Dir.glob("{lib,spec,ext}/**/*")
+	  s.add_dependency 'rake'
+	  s.add_dependency 'ffi-compiler'
+	end
+    
+###### Build gem and install it
+	gem build example.gemspec && gem install example-0.0.1.gem
+	Successfully built RubyGem
+	  Name: example
+	  Version: 0.0.1
+	  File: example-0.0.1.gem
+	Building native extensions.  This could take a while...
+	Successfully installed example-0.0.1
+
+###### Test it
+	$ irb
+	2.0.0dev :001 > require 'example/example'
+	 => true 
+	2.0.0dev :002 > puts "Example.example=#{Example.example.to_s(16)}"
+	Example.example=deadbeef
+	 => nil 

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rubygems/package_task'
+
+def gem_spec
+  @gem_spec ||= Gem::Specification.load('ffi-compiler.gemspec')
+end
+
+Gem::PackageTask.new(gem_spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+  pkg.package_dir = 'pkg'
+end

data/ffi-compiler.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name = 'ffi-compiler'
-  s.version = '0.0.1'
+  s.version = '0.0.2'
   s.author = 'Wayne Meissner'
   s.email = 'wmeissner@gmail.com'
   s.homepage = 'http://wiki.github.com/ffi/ffi'
   s.summary = 'Ruby FFI Rakefile generator'
   s.description = 'Ruby FFI library'
-  s.files = %w(ffi-compiler.gemspec) + Dir.glob("{lib,spec}/**/*")
+  s.files = %w(ffi-compiler.gemspec README.md Rakefile LICENSE) + Dir.glob("{lib,spec}/**/*")
   s.has_rdoc = false
   s.license = 'Apache 2.0'
   s.required_ruby_version = '>= 1.9.3'

data/lib/ffi-compiler/loader.rb

@@ -0,0 +1,24 @@
+require 'pathname'
+require 'ffi'
+
+module FFI
+  module Compiler
+    module Loader
+      def self.find(name, start_path = nil)
+        library = FFI.map_library_name(name)
+        root = false
+        Pathname.new(start_path || File.dirname(caller[0].split(/:/)[0])).ascend do |path|
+          Dir.glob("#{path}/**/#{library}") do |f|
+            return f
+          end
+
+          break if root
+
+          # Next iteration will be the root of the gem if this is the lib/ dir - stop after that
+          root = File.basename(path) == 'lib'
+        end
+        raise LoadError.new("cannot find '#{name}' library")
+      end
+    end
+  end
+end

data/lib/ffi-compiler/task.rb

@@ -0,0 +1,153 @@
+require 'rake/tasklib'
+require 'rake/clean'
+require 'ffi'
+require 'tmpdir'
+
+module FFI
+  class Compiler
+    class Task < Rake::TaskLib
+      def initialize(name)
+        @name = name
+        @defines = []
+        @include_paths = []
+        @library_paths = []
+        @libraries = []
+        @headers = []
+        @functions = []
+
+        yield self if block_given?
+        define_task!
+      end
+
+      def have_func?(func)
+        main = <<-C_FILE
+        extern void #{func}();
+        int main(int argc, char **argv) { #{func}(); return 0; }
+        C_FILE
+
+        if try_compile(main)
+          @functions << func
+          return true
+        end
+        false
+      end
+
+      def have_header?(header, *paths)
+        try_header(header, @include_paths) || try_header(header, paths)
+      end
+
+      def have_library?(libname, *paths)
+        try_library(libname, @library_paths) || try_library(libname, paths)
+      end
+
+      def create_rakefile!
+        create_rakefile(@name)
+      end
+
+      private
+      def define_task!
+        lib_name = FFI.map_library_name(@name)
+        pic_flags = '-fPIC'
+        so_flags = ''
+        ld_flags = ''
+        cc = 'cc'
+        cxx = 'c++'
+        iflags = @include_paths.uniq.map { |p| "-I#{p}" }.join(' ')
+        defines = @functions.uniq.map { |f| "-DHAVE_#{f.upcase}=1" }.join(' ')
+        defines << " " + @headers.uniq.map { |h| "-DHAVE_#{h.upcase.sub(/\./, '_')}=1" }.join(' ')
+
+        if FFI::Platform.mac?
+          pic_flags = ''
+          ld_flags += ' -dynamiclib '
+
+        elsif FFI::Platform.name =~ /linux/
+          so_flags += " -shared -Wl,-soname,#{lib_name} "
+        end
+
+        cflags = "#{pic_flags} #{iflags} #{defines}".strip
+        ld_flags += so_flags
+        ld_flags += @library_paths.map { |path| "-L#{path}" }.join(' ')
+        ld_flags.strip!
+        ld = FileList['*.cpp'].empty? ? cc : cxx
+        cxxflags = cflags
+        libs = @libraries.map { |l| "-l#{l}" }.join(" ")
+
+        obj_files = FileList['*.c', '*.cpp'].map { |f| f.gsub(/\.(c|cpp)$/, '.o') }
+
+        CLEAN.include(obj_files)
+
+        desc "Compile C file to object file"
+        rule '.o' => ['.c'] do |t|
+          sh "#{cc} #{cflags} -o #{t.name} -c #{t.source}"
+        end
+
+        desc "Compile C++ file to object file"
+        rule '.o' => ['.cpp'] do |t|
+          sh "#{cxx} #{cxxflags} -o #{t.name} -c #{t.source}"
+        end
+
+        desc "Compile to dynamic library"
+        file lib_name => obj_files do |t|
+          sh "#{ld} #{ld_flags} -o #{t.name} #{t.prerequisites.join(' ')} #{libs}"
+        end
+        CLEAN.include(lib_name)
+
+        task :default => [ lib_name ]
+      end
+
+      def try_header(header, paths)
+        main = <<-C_FILE
+          #include <#{header}>
+          int main(int argc, char **argv) { return 0; }
+        C_FILE
+
+        if paths.empty? && try_compile(main)
+          @headers << header
+          return true
+        end
+
+        paths.each do |path|
+          if try_compile(main, "-I#{path}")
+            @include_paths << path
+            @headers << header
+            return true
+          end
+        end
+        false
+      end
+
+
+      def try_library(libname, paths)
+        main = <<-C_FILE
+        int main(int argc, char **argv) { return 0; }
+        C_FILE
+
+        if paths.empty? && try_compile(main)
+          @libraries << libname
+          return true
+        end
+
+        paths.each do |path|
+          if try_compile(main, "-L#{path}", "-l#{libname}")
+            @library_paths << path
+            @libraries << libname
+          end
+        end
+      end
+
+      def try_compile(src, *opts)
+        Dir.mktmpdir do |dir|
+          path = File.join(dir, 'ffi-test.c')
+          File.open(path, "w") do |f|
+            f << src
+          end
+          begin
+            return system "cc #{opts.join(' ')} -o #{File.join(dir, 'ffi-test')} #{path} >& /dev/null"
+          rescue
+            return false
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-compiler
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2013-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,7 +66,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ffi-compiler.gemspec
+- README.md
+- Rakefile
+- LICENSE
+- lib/ffi-compiler/loader.rb
 - lib/ffi-compiler/mkrf.rb
+- lib/ffi-compiler/task.rb
 homepage: http://wiki.github.com/ffi/ffi
 licenses:
 - Apache 2.0