paper_house 0.4.0

data/lib/paper_house/auto_depends.rb

@@ -0,0 +1,95 @@
+#
+# Copyright (C) 2013 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require "paper_house/safe_popen"
+
+
+module PaperHouse
+  #
+  # Automatically detects compilation dependencies.
+  #
+  class AutoDepends
+    attr_reader :data
+
+
+    def initialize c_file, o_file, cc, cc_options
+      @cc = cc
+      @command = "#{ @cc } -H #{ cc_options } -c #{ c_file } -o #{ o_file }"
+      @data = []
+    end
+
+
+    #
+    # Runs dependency detection.
+    #
+    def run
+      puts @command
+      exit_status = popen_command
+      raise "#{ @cc } failed" if exit_status != 0
+    end
+
+
+    ############################################################################
+    private
+    ############################################################################
+
+
+    def popen_command
+      SafePopen.popen( @command ) do | stdout, stderr, stdin, |
+        stdin.close
+        parse_cc_h_stderr stderr
+      end.exitstatus
+    end
+
+
+    def parse_cc_h_stderr stderr
+      stderr.each do | each |
+        parse_cc_h_stderr_line( each, stderr )
+      end
+    end
+
+
+    def parse_cc_h_stderr_line line, stderr
+      case line
+      when /^\./
+        @data << line.sub( /^\.+\s+/, "" ).strip
+      when /Multiple include guards/
+        filter_out_include_guards_warnings stderr
+      else
+        puts line
+      end
+    end
+
+
+    def filter_out_include_guards_warnings stderr
+      stderr.each do | each |
+        if /:$/=~ each
+          puts each
+          return
+        end
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/paper_house/build_task.rb

@@ -0,0 +1,188 @@
+#
+# Copyright (C) 2013 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require "paper_house/auto_depends"
+require "paper_house/dependency"
+require "paper_house/cc_options"
+require "rake/clean"
+require "rake/tasklib"
+
+
+module PaperHouse
+  # Common base class for *.c compilation tasks.
+  class BuildTask < Rake::TaskLib
+    include CcOptions
+
+
+    # Name of task.
+    attr_accessor :name
+
+
+    # @!attribute target_directory
+    #   Directory where *.o files are created.
+    attr_writer :target_directory
+
+    def target_directory
+      @target_directory ||= "."
+    end
+
+
+    # @!attribute cc
+    #   C compiler name or path.
+    attr_writer :cc
+
+    def cc
+      ENV[ "CC" ] || @cc || "gcc"
+    end
+
+
+    def initialize name, &block
+      @name = name.to_s
+      block.call self if block
+      define
+    end
+
+
+    # Relative path to target file.
+    def target_path
+      File.join target_directory, target_file_name
+    end
+
+
+    ############################################################################
+    private
+    ############################################################################
+
+
+    def define
+      define_main_task
+      define_directory_task
+      define_all_c_compile_tasks
+      define_maybe_generate_target_task
+      define_clean_tasks
+    end
+
+
+    def define_main_task
+      path = target_path
+      task name => [ target_directory, path ]
+    end
+
+
+    def define_directory_task
+      directory target_directory
+    end
+
+
+    def define_all_c_compile_tasks
+      sources_list.zip( objects ) do | source, object |
+        define_c_compile_task source, object
+      end
+    end
+
+
+    def define_c_compile_task source, object
+      task object => source do | task |
+        compile task.name, task.prerequisites[ 0 ]
+      end
+    end
+
+
+    def define_maybe_generate_target_task
+      file target_path => objects do | task |
+        next if uptodate?( task.name, task.prerequisites )
+        build
+      end
+    end
+
+
+    def build
+      check_sources_list
+      generate_target
+    end
+
+
+    def check_sources_list
+      if sources_list.empty?
+        fail "Cannot find sources (#{ @sources })."
+      end
+    end
+
+
+    def define_clean_tasks
+      define_clean_task
+      define_clobber_task
+    end
+
+
+    def define_clean_task
+      objects.each do | each |
+        next if not FileTest.exist?( each )
+        CLEAN.include each
+      end
+    end
+
+
+    def define_clobber_task
+      clobber_targets.each do | each |
+        next if not FileTest.exist?( each )
+        CLOBBER.include each
+      end
+    end
+
+
+    def clobber_targets
+      [ target_path, dependency.path ]
+    end
+
+
+    def objects
+      sources_list.pathmap File.join( target_directory, "%n.o" )
+    end
+
+
+    def compile o_file, c_file
+      return if no_need_to_compile?( o_file, c_file )
+      auto_depends = AutoDepends.new( c_file, o_file, cc, auto_depends_cc_options )
+      auto_depends.run
+      dependency.write o_file, auto_depends.data
+    end
+
+
+    def no_need_to_compile?( o_file, c_file )
+      uptodate?( o_file, dependency.read( o_file ) << c_file )
+    end
+
+
+    def auto_depends_cc_options
+      ( cflags + [ "-fPIC" ] + i_options ).join " "
+    end
+
+
+    def dependency
+      @dependency ||= Dependency.new( @name )
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/paper_house/c_extension_task.rb

@@ -0,0 +1,95 @@
+#
+# Copyright (C) 2013 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require "paper_house/library_task"
+require "paper_house/linker_options"
+require "paper_house/platform"
+
+
+module PaperHouse
+  #
+  # Compiles *.c files into a Ruby extension library.
+  #
+  class CExtensionTask < LibraryTask
+    include LinkerOptions
+    include Platform
+
+
+    # Name of target library.
+    attr_writer :library_name
+
+
+    # Name of target library file.
+    def target_file_name
+      library_name + SHARED_EXT
+    end
+
+
+    # List of libraries to link.
+    def library_dependencies
+      if Platform::MAC
+        ( [ @library_dependencies ] << "ruby" ).flatten.compact
+      else
+        super
+      end
+    end
+
+
+    ############################################################################
+    private
+    ############################################################################
+
+
+    def generate_target
+      sh ( [ cc ] + cc_options ).join( " " )
+    end
+
+
+    def cc_options
+      [ LDSHARED, o_option, objects, ldflags, libdir_option, l_options ].flatten
+    end
+
+
+    def o_option
+      "-o #{ target_path }"
+    end
+
+
+    def libdir_option
+      "-L#{ RUBY_LIBDIR }"
+    end
+
+
+    def include_directories
+      ( includes + auto_includes + RUBY_INCLUDES ).uniq
+    end
+  end
+
+
+  #
+  # Alias for CExtensionTask
+  #
+  RubyLibraryTask = CExtensionTask
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/paper_house/cc_options.rb

@@ -0,0 +1,81 @@
+#
+# Copyright (C) 2013 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+module PaperHouse
+  # CC option utilities.
+  module CcOptions
+    # @!attribute sources
+    #   Glob pattern to match source files.
+    attr_writer :sources
+
+    def sources
+      @sources ||= "*.c"
+    end
+
+
+    # @!attribute cflags
+    #   Compile options pass to C compiler.
+    attr_writer :cflags
+
+    def cflags
+      @cflags ||= []
+    end
+
+
+    # @!attribute includes
+    #   Glob pattern to match include directories.
+    attr_writer :includes
+
+    def includes
+      @includes ||= []
+      FileList[ [ @includes ] ]
+    end
+
+
+    ############################################################################
+    private
+    ############################################################################
+
+
+    def i_options
+      include_directories.pathmap "-I%p"
+    end
+
+
+    def include_directories
+      ( includes + auto_includes ).uniq
+    end
+
+
+    def auto_includes
+      FileList[ sources_list.pathmap( "%d" ).uniq ]
+    end
+
+
+    def sources_list
+      FileList[ sources ]
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/paper_house/dependency.rb

@@ -0,0 +1,74 @@
+#
+# Copyright (C) 2013 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require "pstore"
+require "rake"
+
+
+module PaperHouse
+  #
+  # Keeps compilation dependencies
+  #
+  class Dependency
+    attr_reader :path
+
+
+    def initialize name
+      @name = name
+      @path = File.join( Rake.original_dir, ".#{ name }.depends" )
+      @cache = {}
+    end
+
+
+    #
+    # Reads the dependency information of +object_file+.
+    #
+    def read object_file
+      db.transaction( true ) do | store |
+        store[ object_file ]
+      end || []
+    end
+
+
+    #
+    # Saves the dependency information (+object_file+ => +dependent_files+).
+    #
+    def write object_file, dependent_files
+      db.transaction( false ) do | store |
+        store[ object_file ] = dependent_files
+      end
+    end
+
+
+    ############################################################################
+    private
+    ############################################################################
+
+
+    def db
+      @cache[ @name ] ||= PStore.new( @path )
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/paper_house/executable_task.rb

@@ -0,0 +1,77 @@
+#
+# Copyright (C) 2013 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require "paper_house/build_task"
+require "paper_house/linker_options"
+require "paper_house/shared_library_task"
+require "paper_house/static_library_task"
+
+
+module PaperHouse
+  #
+  # Compiles *.c files into an executable file.
+  #
+  class ExecutableTask < BuildTask
+    include LinkerOptions
+
+
+    def initialize name, &block
+      super name, &block
+      Rake::Task[ name ].prerequisites.each do | each |
+        find_prerequisites each, [ StaticLibraryTask, SharedLibraryTask ]
+      end
+    end
+
+
+    # @!attribute executable_name
+    #   Name of target executable file.
+    attr_writer :executable_name
+
+    def executable_name
+      @executable_name ||= @name
+    end
+    alias :target_file_name :executable_name
+
+
+    ############################################################################
+    private
+    ############################################################################
+
+
+    def generate_target
+      sh ( [ cc ] + cc_options ).join( " " )
+    end
+
+
+    def cc_options
+      [ o_option, objects, ldflags, l_options ].flatten
+    end
+
+
+    def o_option
+      "-o #{ target_path }"
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/lib/paper_house/library_task.rb

@@ -0,0 +1,64 @@
+#
+# Copyright (C) 2013 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require "paper_house/build_task"
+
+
+module PaperHouse
+  # Common base class for static, shared, and ruby library tasks.
+  class LibraryTask < BuildTask
+    # Find a LibraryTask by name
+    def self.find_by name
+      ObjectSpace.each_object( self ) do | each |
+        return each if each.name == name.to_s
+      end
+      nil
+    end
+
+
+    def initialize name, &block
+      @library_dependencies = []
+      super name, &block
+    end
+
+
+    # Name of library.
+    def library_name
+      @library_name ||= @name
+    end
+
+
+    # Name of library.
+    def library_name= new_name
+       @library_name = /\Alib/=~ new_name ? new_name : "lib" + new_name
+    end
+
+
+    # Name of library pass to -l option.
+    def lname
+      library_name.sub( /^lib/, "" )
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End: