jitsu 0.2.1 → 0.3.0

data/README.rdoc

@@ -4,9 +4,9 @@ Ninja (https://github.com/martine/ninja) is an excellent build system, but
 Ninja files are hard to write, by design. Jitsu is a simple meta build system
 that writes Ninja files for you from YAML project descriptions.
 
-For now, only C++ and simple executables and static and dynamic libraries are
-supported. See the features dir for examples and http://ilkka.github.com/jitsu
-for docs.
+For now, C++ is the only supported langugage. Jitsu can build executables and
+static, dynamic and libtool libraries. See the features dir for examples and
+http://ilkka.github.com/jitsu for docs.
 
 == Using Jitsu
 

data/Rakefile

@@ -37,12 +37,13 @@ end
 RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
+  spec.rcov_opts = "-x '^[\/]'"
 end
 
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:features)
 
-task :default => :spec
+task :default => [:spec, :features]
 
 require 'yard'
 yardtask = YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/features/jitsu.feature

@@ -113,3 +113,51 @@ Feature: Build C++ programs
     And I run "ninja all"
     And I run "env LD_PRELOAD=./lib.so ./blah"
     Then the output should be "Hello World" with a newline
+
+  Scenario: Build an executable using libtool
+    Given a directory
+    And a file "lib.h" with contents
+      """
+      #include <string>
+
+      std::string greeting();
+      """
+    And a file "lib.cpp" with contents
+      """
+      #include "lib.h"
+
+      std::string greeting() {
+        return std::string("Hello World");
+      }
+      """
+    And a file "main.cpp" with contents
+      """
+      #include <iostream>
+      
+      extern std::string greeting();
+
+      int main(int argc, char* argv[]) {
+        std::cout << greeting() << std::endl;
+        return 0;
+      }
+      """
+    And a file "build.jitsu" with contents
+      """
+      ---
+      targets:
+        lib.la:
+          type: libtool_library
+          sources:
+            - lib.cpp
+        blah:
+          type: executable
+          sources:
+            - main.cpp
+          dependencies:
+            - lib.la
+      """
+    When I run jitsu
+    And I run "ninja all"
+    And I run "libtool --mode=execute ./blah"
+    Then the output should be "Hello World" with a newline
+

data/jitsu.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jitsu}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ilkka Laukkanen"]

data/lib/jitsu.rb

@@ -35,18 +35,32 @@ module Jitsu
     YAML.load(File.open(jitsufile, 'r').read)
   end
 
+  # Check if any of the targets needs libtool.
+  #
+  # @param targets [Enum] the targets from a build specification hash.
+  # @return [Boolean] true if libtool required, nil otherwise.
+  def self.libtool_needed_for(targets)
+    not targets.select { |key,val| val['type'] == 'libtool_library' }.empty?
+  end
+
   # Output jitsu build specification as build.ninja file(s).
   #
   # @param data [Hash] a build specification from e.g. Jitsu::read.
   # @return nil
   def self.output(data)
     File.open NINJA_FILE_NAME, 'w' do |f|
+      libtool = libtool_needed_for data['targets']
       f.write <<-EOS
 cxxflags =
 ldflags =
 cxx = g++
 ld = g++
 ar = ar
+EOS
+      if libtool
+        f.write "libtool = libtool\n"
+      end
+      f.write <<-EOS
 
 rule cxx
   description = CC ${in}
@@ -61,11 +75,23 @@ rule archive
   description = AR ${out}
   command = ${ar} rT ${out} ${in}
 EOS
+      if libtool_needed_for data['targets']
+        f.write <<-EOS
+
+rule ltcxx
+  description = CC ${in}
+  depfile = ${out}.d
+  command = ${libtool} --quiet --mode=compile ${cxx} -MMD -MF ${out}.d ${cxxflags} -c ${in}
+
+rule ltlink
+  description = LD ${out}
+  command = ${libtool} --quiet --mode=link ${ld} ${ldflags} -o ${out} ${in}
+EOS
+      end
       data['targets'].each do |target,conf|
         f.write "\n"
         sources = conf['sources']
-        objects = sources_to_objects(sources).join(' ')
-        Jitsu.send "handle_#{conf['type']}".to_sym, f, target, sources, objects, conf
+        Jitsu.send "handle_#{conf['type']}".to_sym, f, target, sources, conf, data['targets']
       end
       f.write("\nbuild all: phony || #{data['targets'].keys.join(' ')}\n")
     end
@@ -79,8 +105,11 @@ EOS
   # @param conf [Hash] the entire build spec hash for this target.
   def self.output_sources(out, sources, conf)
     cxxflags = conf['cxxflags']
+    libtool = conf['type'] == 'libtool_library'
+    rule = (libtool ? "ltcxx" : "cxx")
     sources.each do |src|
-      out.write "build #{source_to_object src}: cxx #{src}\n"
+      object = (libtool ? source_to_ltobject(src) : source_to_object(src))
+      out.write "build #{object}: #{rule} #{src}\n"
       out.write "  cxxflags = #{cxxflags}\n" if cxxflags
     end
   end
@@ -91,11 +120,15 @@ EOS
   # @param target [String] the filename of the target.
   # @param sources [Enumerable] a list of sourcefile names to output rules
   # for.
-  # @param objects [Enumerable] a list of all object files for the target.
   # @param conf [Hash] the entire build spec hash for this target.
-  def self.handle_executable(out, target, sources, objects, conf)
+  # @param targets [Hash] all targets for the build
+  def self.handle_executable(out, target, sources, conf, targets)
     output_sources(out, sources, conf)
-    out.write "build #{target}: link #{objects}"
+    libtool = libtool_needed_for targets.select { |key,val|
+      conf['dependencies'] and conf['dependencies'].include? key
+    }
+    rule = libtool ? "ltlink" : "link"
+    out.write "build #{target}: #{rule} #{sources_to_objects(sources).join ' '}"
     out.write " #{conf['dependencies'].join(' ')}" if conf['dependencies']
     out.write "\n"
     out.write "  ldflags = #{conf['ldflags']}\n" if conf['ldflags']
@@ -107,11 +140,11 @@ EOS
   # @param target [String] the filename of the target.
   # @param sources [Enumerable] a list of sourcefile names to output rules
   # for.
-  # @param objects [Enumerable] a list of all object files for the target.
   # @param conf [Hash] the entire build spec hash for this target.
-  def self.handle_static_library(out, target, sources, objects, conf)
+  # @param targets [Hash] all targets for the build
+  def self.handle_static_library(out, target, sources, conf, targets)
     output_sources(out, sources, conf)
-    out.write "build #{target}: archive #{objects}"
+    out.write "build #{target}: archive #{sources_to_objects(sources).join ' '}"
     out.write " #{conf['dependencies'].join(' ')}" if conf['dependencies']
     out.write "\n"
   end
@@ -122,13 +155,13 @@ EOS
   # @param target [String] the filename of the target.
   # @param sources [Enumerable] a list of sourcefile names to output rules
   # for.
-  # @param objects [Enumerable] a list of all object files for the target.
   # @param conf [Hash] the entire build spec hash for this target.
-  def self.handle_dynamic_library(out, target, sources, objects, conf)
+  # @param targets [Hash] all targets for the build
+  def self.handle_dynamic_library(out, target, sources, conf, targets)
     conf['cxxflags'] ||= '${cxxflags}'
     conf['cxxflags'] += ' -fPIC'
     output_sources(out, sources, conf)
-    out.write "build #{target}: link #{objects}"
+    out.write "build #{target}: link #{sources_to_objects(sources).join ' '}"
     out.write " #{conf['dependencies'].join(' ')}" if conf['dependencies']
     out.write "\n"
     conf['ldflags'] ||= '${ldflags}'
@@ -136,6 +169,24 @@ EOS
     out.write "  ldflags = #{conf['ldflags']}\n"
   end
 
+  # Output build rules for one libtool library target.
+  #
+  # @param out [IO] the output stream where output is written.
+  # @param target [String] the filename of the target.
+  # @param sources [Enumerable] a list of sourcefile names to output rules
+  # for.
+  # @param conf [Hash] the entire build spec hash for this target.
+  # @param targets [Hash] all targets for the build
+  def self.handle_libtool_library(out, target, sources, conf, targets)
+    output_sources(out, sources, conf)
+    out.write "build #{target}: ltlink #{sources_to_ltobjects(sources).join ' '}"
+    out.write " #{conf['dependencies'].join(' ')}" if conf['dependencies']
+    out.write "\n"
+    conf['ldflags'] ||= '${ldflags}'
+    conf['ldflags'] += " -rpath /usr/local/lib"
+    out.write "  ldflags = #{conf['ldflags']}\n"
+  end
+
   # Convert sourcefile name to corresponding object file name.
   #
   # @param src [String] source file path.
@@ -151,4 +202,21 @@ EOS
   def self.sources_to_objects(srcs)
     srcs.map { |src| source_to_object src }
   end
+
+  # Convert sourcefile name to corresponding libtool object file name.
+  #
+  # @param src [String] source file path.
+  # @return [String] libtool object file path.
+  def self.source_to_ltobject(src)
+    src.gsub /\.[Cc]\w+$/, '.lo'
+  end
+
+  # Convert a list of sourcefile names to corresponding libtool object file
+  # names.
+  #
+  # @param srcs [Enumerable] source file paths.
+  # @return [Enumerable] libtool object file paths.
+  def self.sources_to_ltobjects(srcs)
+    srcs.map { |src| source_to_ltobject src }
+  end
 end

data/spec/jitsu_spec.rb

@@ -180,6 +180,105 @@ build aaa3.so: link aaa3.o
   ldflags = ${ldflags} -shared -Wl,-soname,aaa3.so
 
 build all: phony || aaa1 aaa2.a aaa3.so
+EOS
+        end
+        File.open('build.ninja', 'r').read.should == ninjafile
+      end
+    end
+  end
+
+  it "outputs a build.jitsu file with libtool" do
+    Dir.mktmpdir do |dir|
+      Dir.chdir dir do |dir|
+        File.open 'build.jitsu', 'w' do |f|
+          f.write <<-EOS
+---
+targets:
+  aaa1:
+    type: executable
+    sources:
+      - aaa1a.cpp
+      - aaa1b.cpp
+    dependencies:
+      - aaa2.a
+      - aaa3.la
+  aaa2.a:
+    type: static_library
+    sources: 
+      - aaa2.cpp
+    cxxflags: -ansi -pedantic
+  aaa3.la:
+    type: libtool_library
+    sources:
+      - aaa3.cpp
+EOS
+        end
+        data = Jitsu.read Jitsu.jitsufile
+        Jitsu.output data
+        Dir['build.ninja'].length.should == 1
+        ninjafile = <<-EOS
+cxxflags =
+ldflags =
+cxx = g++
+ld = g++
+ar = ar
+libtool = libtool
+
+rule cxx
+  description = CC ${in}
+  depfile = ${out}.d
+  command = ${cxx} -MMD -MF ${out}.d ${cxxflags} -c ${in} -o ${out}
+
+rule link
+  description = LD ${out}
+  command = ${ld} ${ldflags} -o ${out} ${in}
+
+rule archive
+  description = AR ${out}
+  command = ${ar} rT ${out} ${in}
+
+rule ltcxx
+  description = CC ${in}
+  depfile = ${out}.d
+  command = ${libtool} --quiet --mode=compile ${cxx} -MMD -MF ${out}.d ${cxxflags} -c ${in}
+
+rule ltlink
+  description = LD ${out}
+  command = ${libtool} --quiet --mode=link ${ld} ${ldflags} -o ${out} ${in}
+
+EOS
+        # the targets are reversed on 1.8.7 :p
+        if RUBY_VERSION.start_with? '1.8'
+          ninjafile += <<-EOS
+build aaa3.lo: ltcxx aaa3.cpp
+build aaa3.la: ltlink aaa3.lo
+  ldflags = ${ldflags} -rpath /usr/local/lib
+
+build aaa2.o: cxx aaa2.cpp
+  cxxflags = -ansi -pedantic
+build aaa2.a: archive aaa2.o
+
+build aaa1a.o: cxx aaa1a.cpp
+build aaa1b.o: cxx aaa1b.cpp
+build aaa1: ltlink aaa1a.o aaa1b.o aaa2.a aaa3.la
+
+build all: phony || aaa3.la aaa2.a aaa1
+EOS
+        else
+          ninjafile += <<-EOS
+build aaa1a.o: cxx aaa1a.cpp
+build aaa1b.o: cxx aaa1b.cpp
+build aaa1: ltlink aaa1a.o aaa1b.o aaa2.a aaa3.la
+
+build aaa2.o: cxx aaa2.cpp
+  cxxflags = -ansi -pedantic
+build aaa2.a: archive aaa2.o
+
+build aaa3.lo: ltcxx aaa3.cpp
+build aaa3.la: ltlink aaa3.lo
+  ldflags = ${ldflags} -rpath /usr/local/lib
+
+build all: phony || aaa1 aaa2.a aaa3.la
 EOS
         end
         File.open('build.ninja', 'r').read.should == ninjafile

metadata

@@ -2,7 +2,7 @@
 name: jitsu
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Ilkka Laukkanen
@@ -140,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 446406449
+      hash: 994791855
       segments: 
       - 0
       version: "0"