rscons 1.3.0 → 1.4.0

data/lib/rscons/environment.rb

@@ -86,7 +86,7 @@ module Rscons
           env.add_builder(builder)
         end
       end
-      env.append(@varset.clone) if clone.include?(:variables)
+      env.append(@varset) if clone.include?(:variables)
       env.build_root = @build_root if clone.include?(:build_root)
       if clone.include?(:build_dirs)
         @build_dirs.each do |src_dir, obj_dir|
@@ -164,38 +164,44 @@ module Rscons
     # Add a set of construction variables or environment options.
     # @see VarSet#append
     def append(*args)
-      @varset.send(:append, *args)
+      @varset.append(*args)
     end
 
     # Build all target specified in the Environment.
     # When a block is passed to Environment.new, this method is automatically
     # called after the block returns.
     def process
-      cache = Cache.new
-      targets_processed = {}
-      process_target = proc do |target|
-        targets_processed[target] ||= begin
-          @targets[target][:source].each do |src|
-            if @targets.include?(src) and not targets_processed.include?(src)
-              process_target.call(src)
+      unless @targets.empty?
+        clean_target_paths!
+        cache = Cache.instance
+        cache.clear_checksum_cache!
+        targets_processed = {}
+        process_target = proc do |target|
+          targets_processed[target] ||= begin
+            @targets[target][:sources].each do |src|
+              if @targets.include?(src) and not targets_processed.include?(src)
+                process_target.call(src)
+              end
             end
+            result = run_builder(@targets[target][:builder],
+                                 target,
+                                 @targets[target][:sources],
+                                 cache,
+                                 @targets[target][:vars] || {})
+            unless result
+              raise BuildError.new("Failed to build #{target}")
+            end
+            result
           end
-          result = run_builder(@targets[target][:builder],
-                               target,
-                               @targets[target][:source],
-                               cache,
-                               @targets[target][:vars] || {})
-          unless result
-            cache.write
-            raise BuildError.new("Failed to build #{target}")
+        end
+        begin
+          @targets.each do |target, target_params|
+            process_target.call(target)
           end
-          result
+        ensure
+          cache.write
         end
       end
-      @targets.each do |target, info|
-        process_target.call(target)
-      end
-      cache.write
     end
 
     # Clear all targets registered for the Environment.
@@ -246,25 +252,28 @@ module Rscons
       end
     end
 
-    alias_method :orig_method_missing, :method_missing
     def method_missing(method, *args)
       if @builders.has_key?(method.to_s)
-        target, source, vars, *rest = args
+        target, sources, vars, *rest = args
         unless vars.nil? or vars.is_a?(Hash) or vars.is_a?(VarSet)
           raise "Unexpected construction variable set: #{vars.inspect}"
         end
-        source = [source] unless source.is_a?(Array)
-        @targets[target] = {
-          builder: @builders[method.to_s],
-          source: source,
-          vars: vars,
-          args: rest,
-        }
+        sources = [sources] unless sources.is_a?(Array)
+        add_target(target, @builders[method.to_s], sources, vars, rest)
       else
-        orig_method_missing(method, *args)
+        super
       end
     end
 
+    def add_target(target, builder, sources, vars, args)
+      @targets[target] = {
+        builder: builder,
+        sources: sources,
+        vars: vars,
+        args: args,
+      }
+    end
+
     # Manually record a given target as depending on the specified
     # dependency files.
     def depends(target, *user_deps)
@@ -321,12 +330,34 @@ module Rscons
           target: target,
           sources: sources,
           vars: vars,
+          env: self,
         }
         build_hook_block.call(build_operation)
       end
       builder.run(target, sources, cache, self, vars)
     end
 
+    private
+
+    # Expand all target paths that begin with ^/ to be relative to the
+    # Environment's build root, if present
+    def clean_target_paths!
+      if @build_root
+        expand = lambda do |path|
+          path.sub(%r{^\^(?=[\\/])}, @build_root)
+        end
+
+        new_targets = {}
+        @targets.each_pair do |target, target_params|
+          target_params[:sources].map! do |source|
+            expand[source]
+          end
+          new_targets[expand[target]] = target_params
+        end
+        @targets = new_targets
+      end
+    end
+
     # Parse dependencies for a given target from a Makefile.
     # This method is used internally by Rscons builders.
     # @param mf_fname [String] File name of the Makefile to read.

data/lib/rscons/varset.rb

@@ -1,45 +1,73 @@
 module Rscons
   # This class represents a collection of variables which can be accessed
-  # as certain types
+  # as certain types.
+  # Only nil, strings, arrays, and hashes should be stored in a VarSet.
   class VarSet
-    # The underlying hash
-    attr_reader :vars
-
-    # Create a VarSet
+    # Create a VarSet.
     # @param vars [Hash] Optional initial variables.
     def initialize(vars = {})
-      if vars.is_a?(VarSet)
-        @vars = vars.clone.vars
-      else
-        @vars = vars
-      end
+      @my_vars = {}
+      @coa_vars = []
+      append(vars)
     end
 
     # Access the value of variable as a particular type
     # @param key [String, Symbol] The variable name.
+    # @return [Object] The variable's value.
     def [](key)
-      @vars[key]
+      if @my_vars.include?(key)
+        @my_vars[key]
+      else
+        @coa_vars.each do |coa_vars|
+          if coa_vars.include?(key)
+            @my_vars[key] = deep_dup(coa_vars[key])
+            return @my_vars[key]
+          end
+        end
+        nil
+      end
     end
 
     # Assign a value to a variable.
     # @param key [String, Symbol] The variable name.
-    # @param val [Object] The value.
+    # @param val [Object] The value to set.
     def []=(key, val)
-      @vars[key] = val
+      @my_vars[key] = val
+    end
+
+    # Check if the VarSet contains a variable.
+    # @param key [String, Symbol] The variable name.
+    # @return [true, false] Whether the VarSet contains a variable.
+    def include?(key)
+      if @my_vars.include?(key)
+        true
+      else
+        @coa_vars.find do |coa_vars|
+          coa_vars.include?(key)
+        end
+      end
     end
 
     # Add or overwrite a set of variables
     # @param values [VarSet, Hash] New set of variables.
     def append(values)
-      values = values.vars if values.is_a?(VarSet)
-      @vars.merge!(Marshal.load(Marshal.dump(values)))
+      coa!
+      if values.is_a?(VarSet)
+        values.send(:coa!)
+        @coa_vars = values.instance_variable_get(:@coa_vars) + @coa_vars
+      else
+        @my_vars = deep_dup(values)
+      end
       self
     end
 
     # Create a new VarSet object based on the first merged with other.
     # @param other [VarSet, Hash] Other variables to add or overwrite.
     def merge(other = {})
-      VarSet.new(Marshal.load(Marshal.dump(@vars))).append(other)
+      coa!
+      varset = self.class.new
+      varset.instance_variable_set(:@coa_vars, @coa_vars.dup)
+      varset.append(other)
     end
     alias_method :clone, :merge
 
@@ -54,18 +82,47 @@ module Rscons
       else
         if varref =~ /^(.*)\$\{([^}]+)\}(.*)$/
           prefix, varname, suffix = $1, $2, $3
-          varval = expand_varref(@vars[varname])
+          varval = expand_varref(self[varname])
           if varval.is_a?(String)
             expand_varref("#{prefix}#{varval}#{suffix}")
           elsif varval.is_a?(Array)
             varval.map {|vv| expand_varref("#{prefix}#{vv}#{suffix}")}.flatten
           else
-            raise "I do not know how to expand a variable reference to a #{varval.class.name} (from #{varname.inspect} => #{@vars[varname].inspect})"
+            raise "I do not know how to expand a variable reference to a #{varval.class.name} (from #{varname.inspect} => #{self[varname].inspect})"
           end
         else
           varref
         end
       end
     end
+
+    private
+
+    # Move all VarSet variables into the copy-on-access list.
+    def coa!
+      unless @my_vars.empty?
+        @coa_vars.unshift(@my_vars)
+        @my_vars = {}
+      end
+    end
+
+    # Create a deep copy of an object.
+    # @param obj [nil, String, Array, Hash] Object to deep copy.
+    # @return [nil, String, Array, Hash] Deep copied value.
+    def deep_dup(obj)
+      obj_class = obj.class
+      if obj_class == Hash
+        obj.reduce({}) do |result, (k, v)|
+          result[k] = deep_dup(v)
+          result
+        end
+      elsif obj_class == Array
+        obj.map { |v| deep_dup(v) }
+      elsif obj_class == String
+        obj.dup
+      else
+        obj
+      end
+    end
   end
 end

data/lib/rscons/version.rb

@@ -1,4 +1,4 @@
 module Rscons
   # gem version
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/spec/build_tests_spec.rb

@@ -1,5 +1,14 @@
 require 'fileutils'
 
+class Dir
+  class << self
+    alias_method :orig_bracket, :[]
+  end
+  def self.[](*args)
+    orig_bracket(*args).sort
+  end
+end
+
 describe Rscons do
   BUILD_TEST_RUN_DIR = "build_test_run"
 
@@ -180,6 +189,23 @@ describe Rscons do
     lines.should == ["CC build_root/src/one/one.o", "CC build_root/src/two/two.o", "LD build_dir"]
   end
 
+  it "expands target and source paths starting with ^/ to be relative to the build root" do
+    test_dir('build_dir')
+    Rscons::Environment.new(echo: :command) do |env|
+      env.append('CPPPATH' => Dir['src/**/*/'])
+      env.build_root = "build_root"
+      FileUtils.mkdir_p(env.build_root)
+      FileUtils.mv("src/one/one.c", "build_root")
+      env.Object("^/one.o", "^/one.c")
+      env.Program('build_dir', Dir['src/**/*.c'] + ["^/one.o"])
+    end
+    lines.should == [
+      %q{gcc -c -o build_root/one.o -MMD -MF build_root/one.mf -Isrc/one/ -Isrc/two/ build_root/one.c},
+      %q{gcc -c -o build_root/src/two/two.o -MMD -MF build_root/src/two/two.mf -Isrc/one/ -Isrc/two/ src/two/two.c},
+      %q{gcc -o build_dir build_root/src/two/two.o build_root/one.o},
+    ]
+  end
+
   it 'cleans built files' do
     test_dir('build_dir')
     Rscons::Environment.new do |env|
@@ -428,4 +454,34 @@ EOF
       `./hello-d`.rstrip.should == "Hello from D!"
     end
   end
+
+  it "supports disassembling object files" do
+    test_dir("simple")
+    Rscons::Environment.new do |env|
+      env.Object("simple.o", "simple.c")
+      env.Disassemble("simple.txt", "simple.o")
+    end
+    File.exists?("simple.txt").should be_true
+    File.read("simple.txt").should =~ /Disassembly of section .text:/
+  end
+
+  it "supports preprocessing C sources" do
+    test_dir("simple")
+    Rscons::Environment.new do |env|
+      env.Preprocess("simplepp.c", "simple.c")
+      env.Program("simple", "simplepp.c")
+    end
+    File.read("simplepp.c").should =~ /# \d+ "simple.c"/
+    `./simple`.should == "This is a simple C program\n"
+  end
+
+  it "supports preprocessing C++ sources" do
+    test_dir("simple_cc")
+    Rscons::Environment.new do |env|
+      env.Preprocess("simplepp.cc", "simple.cc")
+      env.Program("simple", "simplepp.cc")
+    end
+    File.read("simplepp.cc").should =~ /# \d+ "simple.cc"/
+    `./simple`.should == "This is a simple C++ program\n"
+  end
 end

data/spec/rscons/builders/cfile_spec.rb

@@ -0,0 +1,23 @@
+module Rscons
+  module Builders
+    describe CFile do
+      let(:env) {Environment.new}
+      subject {CFile.new}
+
+      it "invokes bison to create a .c file from a .y file" do
+        subject.should_receive(:standard_build).with("YACC parser.c", "parser.c", ["bison", "-d", "-o", "parser.c", "parser.y"], ["parser.y"], env, :cache)
+        subject.run("parser.c", ["parser.y"], :cache, env, {})
+      end
+
+      it "invokes a custom lexer to create a .cc file from a .ll file" do
+        env["LEX"] = "custom_lex"
+        subject.should_receive(:standard_build).with("LEX lexer.cc", "lexer.cc", ["custom_lex", "-o", "lexer.cc", "parser.ll"], ["parser.ll"], env, :cache)
+        subject.run("lexer.cc", ["parser.ll"], :cache, env, {})
+      end
+
+      it "raises an error when an unknown source file is specified" do
+        expect {subject.run("file.c", ["foo.bar"], :cache, env, {})}.to raise_error /Unknown source file .foo.bar. for CFile builder/
+      end
+    end
+  end
+end

data/spec/rscons/cache_spec.rb

@@ -5,35 +5,42 @@ module Rscons
     end
 
     def build_from(cache)
-      YAML.should_receive(:load).and_return(cache)
-      Cache.new
-    end
-
-    describe ".clear" do
-      it "removes the cache file" do
-        FileUtils.should_receive(:rm_f).with(Cache::CACHE_FILE)
-        Cache.clear
+      JSON.stub(:load) do
+        cache
+      end
+      Cache.instance.tap do |cache|
+        cache.send(:initialize!)
       end
     end
 
     describe "#initialize" do
       context "when corrupt" do
         it "prints a warning and defaults to an empty hash" do
-          YAML.should_receive(:load).and_return("string")
+          JSON.should_receive(:load).and_return("string")
           $stderr.should_receive(:puts).with(/Warning:.*was.corrupt/)
-          Cache.new.instance_variable_get(:@cache).is_a?(Hash).should be_true
+          c = Cache.instance
+          c.send(:initialize!)
+          c.instance_variable_get(:@cache).is_a?(Hash).should be_true
         end
       end
     end
 
+    describe "#clear" do
+      it "removes the cache file" do
+        FileUtils.should_receive(:rm_f).with(Cache::CACHE_FILE)
+        JSON.stub(:load) {{}}
+        Cache.instance.clear
+      end
+    end
+
     describe "#write" do
-      it "should fill in :version and write to file" do
+      it "should fill in 'version' and write to file" do
         cache = {}
         fh = $stdout
         fh.should_receive(:puts)
         File.should_receive(:open).and_yield(fh)
         build_from(cache).write
-        cache[:version].should == Rscons::VERSION
+        cache["version"].should == Rscons::VERSION
       end
     end
 
@@ -54,7 +61,7 @@ module Rscons
       end
 
       it "returns false when the target's checksum does not match" do
-        _cache = {targets: {"target" => {checksum: "abc"}}}
+        _cache = {"targets" => {"target" => {"checksum" => "abc"}}}
         cache = build_from(_cache)
         File.should_receive(:exists?).with("target").and_return(true)
         cache.should_receive(:calculate_checksum).with("target").and_return("def")
@@ -62,7 +69,7 @@ module Rscons
       end
 
       it "returns false when the build command has changed" do
-        _cache = {targets: {"target" => {checksum: "abc", command: "old command"}}}
+        _cache = {"targets" => {"target" => {"checksum" => "abc", "command" => Digest::MD5.hexdigest("old command".inspect)}}}
         cache = build_from(_cache)
         File.should_receive(:exists?).with("target").and_return(true)
         cache.should_receive(:calculate_checksum).with("target").and_return("abc")
@@ -70,9 +77,9 @@ module Rscons
       end
 
       it "returns false when there is a new dependency" do
-        _cache = {targets: {"target" => {checksum: "abc",
-                                         command: "command",
-                                         deps: [{fname: "dep.1"}]}}}
+        _cache = {"targets" => {"target" => {"checksum" => "abc",
+                                         "command" => Digest::MD5.hexdigest("command".inspect),
+                                         "deps" => [{"fname" => "dep.1"}]}}}
         cache = build_from(_cache)
         File.should_receive(:exists?).with("target").and_return(true)
         cache.should_receive(:calculate_checksum).with("target").and_return("abc")
@@ -80,15 +87,15 @@ module Rscons
       end
 
       it "returns false when a dependency's checksum has changed" do
-        _cache = {targets: {"target" => {checksum: "abc",
-                                         command: "command",
-                                         deps: [{fname: "dep.1",
-                                                 checksum: "dep.1.chk"},
-                                                {fname: "dep.2",
-                                                 checksum: "dep.2.chk"},
-                                                {fname: "extra.dep",
-                                                 checksum: "extra.dep.chk"}],
-                                         user_deps: []}}}
+        _cache = {"targets" => {"target" => {"checksum" => "abc",
+                                         "command" => Digest::MD5.hexdigest("command".inspect),
+                                         "deps" => [{"fname" => "dep.1",
+                                                 "checksum" => "dep.1.chk"},
+                                                {"fname" => "dep.2",
+                                                 "checksum" => "dep.2.chk"},
+                                                {"fname" => "extra.dep",
+                                                 "checksum" => "extra.dep.chk"}],
+                                         "user_deps" => []}}}
         cache = build_from(_cache)
         File.should_receive(:exists?).with("target").and_return(true)
         cache.should_receive(:calculate_checksum).with("target").and_return("abc")
@@ -98,15 +105,15 @@ module Rscons
       end
 
       it "returns false with strict_deps=true when cache has an extra dependency" do
-        _cache = {targets: {"target" => {checksum: "abc",
-                                         command: "command",
-                                         deps: [{fname: "dep.1",
-                                                 checksum: "dep.1.chk"},
-                                                {fname: "dep.2",
-                                                 checksum: "dep.2.chk"},
-                                                {fname: "extra.dep",
-                                                 checksum: "extra.dep.chk"}],
-                                         user_deps: []}}}
+        _cache = {"targets" => {"target" => {"checksum" => "abc",
+                                         "command" => Digest::MD5.hexdigest("command".inspect),
+                                         "deps" => [{"fname" => "dep.1",
+                                                 "checksum" => "dep.1.chk"},
+                                                {"fname" => "dep.2",
+                                                 "checksum" => "dep.2.chk"},
+                                                {"fname" => "extra.dep",
+                                                 "checksum" => "extra.dep.chk"}],
+                                         "user_deps" => []}}}
         cache = build_from(_cache)
         File.should_receive(:exists?).with("target").and_return(true)
         cache.should_receive(:calculate_checksum).with("target").and_return("abc")
@@ -114,10 +121,10 @@ module Rscons
       end
 
       it "returns false when there is a new user dependency" do
-        _cache = {targets: {"target" => {checksum: "abc",
-                                         command: "command",
-                                         deps: [{fname: "dep.1"}],
-                                         user_deps: []}}}
+        _cache = {"targets" => {"target" => {"checksum" => "abc",
+                                         "command" => Digest::MD5.hexdigest("command".inspect),
+                                         "deps" => [{"fname" => "dep.1"}],
+                                         "user_deps" => []}}}
         cache = build_from(_cache)
         env = "env"
         env.should_receive(:get_user_deps).with("target").and_return(["file.ld"])
@@ -127,16 +134,16 @@ module Rscons
       end
 
       it "returns false when a user dependency checksum has changed" do
-        _cache = {targets: {"target" => {checksum: "abc",
-                                         command: "command",
-                                         deps: [{fname: "dep.1",
-                                                 checksum: "dep.1.chk"},
-                                                {fname: "dep.2",
-                                                 checksum: "dep.2.chk"},
-                                                {fname: "extra.dep",
-                                                 checksum: "extra.dep.chk"}],
-                                         user_deps: [{fname: "user.dep",
-                                                      checksum: "user.dep.chk"}]}}}
+        _cache = {"targets" => {"target" => {"checksum" => "abc",
+                                         "command" => Digest::MD5.hexdigest("command".inspect),
+                                         "deps" => [{"fname" => "dep.1",
+                                                 "checksum" => "dep.1.chk"},
+                                                {"fname" => "dep.2",
+                                                 "checksum" => "dep.2.chk"},
+                                                {"fname" => "extra.dep",
+                                                 "checksum" => "extra.dep.chk"}],
+                                         "user_deps" => [{"fname" => "user.dep",
+                                                      "checksum" => "user.dep.chk"}]}}}
         cache = build_from(_cache)
         env = "env"
         env.should_receive(:get_user_deps).with("target").and_return(["user.dep"])
@@ -150,15 +157,15 @@ module Rscons
       end
 
       it "returns true when no condition for false is met" do
-        _cache = {targets: {"target" => {checksum: "abc",
-                                         command: "command",
-                                         deps: [{fname: "dep.1",
-                                                 checksum: "dep.1.chk"},
-                                                {fname: "dep.2",
-                                                 checksum: "dep.2.chk"},
-                                                {fname: "extra.dep",
-                                                 checksum: "extra.dep.chk"}],
-                                         user_deps: []}}}
+        _cache = {"targets" => {"target" => {"checksum" => "abc",
+                                         "command" => Digest::MD5.hexdigest("command".inspect),
+                                         "deps" => [{"fname" => "dep.1",
+                                                 "checksum" => "dep.1.chk"},
+                                                {"fname" => "dep.2",
+                                                 "checksum" => "dep.2.chk"},
+                                                {"fname" => "extra.dep",
+                                                 "checksum" => "extra.dep.chk"}],
+                                         "user_deps" => []}}}
         cache = build_from(_cache)
         File.should_receive(:exists?).with("target").and_return(true)
         cache.should_receive(:calculate_checksum).with("target").and_return("abc")
@@ -180,23 +187,23 @@ module Rscons
         cache.should_receive(:calculate_checksum).with("dep 2").and_return("dep 2 checksum")
         cache.should_receive(:calculate_checksum).with("user.dep").and_return("user.dep checksum")
         cache.register_build("the target", "the command", ["dep 1", "dep 2"], env)
-        cached_target = cache.instance_variable_get(:@cache)[:targets]["the target"]
+        cached_target = cache.instance_variable_get(:@cache)["targets"]["the target"]
         cached_target.should_not be_nil
-        cached_target[:command].should == "the command"
-        cached_target[:checksum].should == "the checksum"
-        cached_target[:deps].should == [
-          {fname: "dep 1", checksum: "dep 1 checksum"},
-          {fname: "dep 2", checksum: "dep 2 checksum"},
+        cached_target["command"].should == Digest::MD5.hexdigest("the command".inspect)
+        cached_target["checksum"].should == "the checksum"
+        cached_target["deps"].should == [
+          {"fname" => "dep 1", "checksum" => "dep 1 checksum"},
+          {"fname" => "dep 2", "checksum" => "dep 2 checksum"},
         ]
-        cached_target[:user_deps].should == [
-          {fname: "user.dep", checksum: "user.dep checksum"},
+        cached_target["user_deps"].should == [
+          {"fname" => "user.dep", "checksum" => "user.dep checksum"},
         ]
       end
     end
 
     describe "#targets" do
       it "returns a list of targets that are cached" do
-        cache = {targets: {"t1" => {}, "t2" => {}, "t3" => {}}}
+        cache = {"targets" => {"t1" => {}, "t2" => {}, "t3" => {}}}
         build_from(cache).targets.should == ["t1", "t2", "t3"]
       end
     end
@@ -218,11 +225,21 @@ module Rscons
         cache.mkdir_p("one\\two\\four")
         cache.directories.should == ["one/two", "one/two/three", "one/two/four"]
       end
+
+      it "handles absolute paths" do
+        _cache = {}
+        cache = build_from(_cache)
+        File.should_receive(:exists?).with("/one").and_return(true)
+        File.should_receive(:exists?).with("/one/two").and_return(false)
+        FileUtils.should_receive(:mkdir).with("/one/two")
+        cache.mkdir_p("/one/two")
+        cache.directories.should == ["/one/two"]
+      end
     end
 
     describe "#directories" do
       it "returns a list of directories that are cached" do
-        _cache = {directories: {"dir1" => true, "dir2" => true}}
+        _cache = {"directories" => {"dir1" => true, "dir2" => true}}
         build_from(_cache).directories.should == ["dir1", "dir2"]
       end
     end