Add v2.3.0 release notes

Bumps [redcarpet](https://github.com/vmg/redcarpet) from 3.5.0 to 3.5.1.
- [Release notes](https://github.com/vmg/redcarpet/releases)
- [Changelog](https://github.com/vmg/redcarpet/blob/master/CHANGELOG.md)
- [Commits](https://github.com/vmg/redcarpet/compare/v3.5.0...v3.5.1)

Signed-off-by: dependabot[bot] <support@github.com>

CHANGELOG.md

@@ -1,3 +1,45 @@
+## v2.3.0
+
+### New Features
+
+- #125 - Support subsidiary Rsconscript files
+- #126 - Add PATH manipulation methods
+
+### Fixes
+
+- #121 - env.depends() does not work with built-root-relative "^/" paths
+- #130 - Document -f command line option
+- #133 - Clarify failed command error message indicating to run -F
+- #134 - Document CMD_STDOUT variable for Command builder
+- #135 - Write dependency file to build directory when user invokes Object builder directly
+- #141 - Document phony targets
+
+## v2.2.0
+
+### New Features
+
+- #120 - improve support for MSYS2
+- #119 - add failure messages for failed configuration checks
+- #118 - compiler checks should support cross-compilers and freestanding compilers
+
+## v2.1.0
+
+### New Features
+
+- #117 - ruby 2.7 compatibility
+
+## v2.0.2
+
+### Fixes
+
+- #113 - distinguish object files built from multiple sources with the same base name but different extensions
+
+## v2.0.1
+
+### Fixes
+
+- #112 - Install builder cannot replace a currently executing binary on Linux
+
 ## v2.0.0
 
 - convert rscons from a Ruby gem to a standalone script

DEVELOPING.md

@@ -0,0 +1,14 @@
+# Developing
+
+# Specs
+
+To run the rscons specs, the following commands must be available:
+
+* gcc
+* clang
+* g++
+* clang++
+* gdc
+* ldc
+* flex
+* bison

Gemfile

@@ -1,10 +1,14 @@
 source 'https://rubygems.org'
 
-gem "json"
 gem "rspec"
 gem "rake"
-gem "simplecov"
-gem "yard"
-gem "rdoc"
-gem "redcarpet"
-gem "syntax"
+gem "simplecov", "~> 0.15.0"
+if RbConfig::CONFIG["host"]["msys"]
+  gem "json", "2.1.0"
+else
+  gem "json"
+  gem "yard"
+  gem "rdoc"
+  gem "redcarpet"
+  gem "syntax"
+end

Gemfile.lock

@@ -1,32 +1,32 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    docile (1.3.2)
-    json (2.2.0)
-    rake (12.3.2)
-    rdoc (6.1.1)
-    redcarpet (3.4.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    diff-lcs (1.4.4)
+    docile (1.1.5)
+    json (2.5.1)
+    rake (13.0.6)
+    rdoc (6.3.2)
+    redcarpet (3.5.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    simplecov (0.15.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    simplecov (0.15.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     syntax (1.2.2)
-    yard (0.9.20)
+    yard (0.9.26)
 
 PLATFORMS
   ruby
@@ -38,9 +38,9 @@ DEPENDENCIES
   rdoc
   redcarpet
   rspec
-  simplecov
+  simplecov (~> 0.15.0)
   syntax
   yard
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

Rakefile.rb

@@ -6,7 +6,6 @@ rescue Bundler::BundlerError => e
 end
 
 require "rspec/core/rake_task"
-require "yard"
 require "rake/clean"
 require "fileutils"
 
@@ -18,12 +17,16 @@ task :build_dist do
 end
 
 RSpec::Core::RakeTask.new(:spec, :example_string) do |task, args|
+  ENV["specs"] = "1"
   if args.example_string
     ENV["partial_specs"] = "1"
     task.rspec_opts = %W[-e "#{args.example_string}" -f documentation]
   end
 end
 task :spec => :build_dist
+task :spec do
+  ENV.delete("specs")
+end
 
 # dspec task is useful to test the distributable release script, but is not
 # useful for coverage information.
@@ -32,16 +35,11 @@ task :dspec, [:example_string] => :build_dist do |task, args|
   FileUtils.mkdir_p("test")
   FileUtils.cp("dist/rscons", "test/rscons.rb")
   ENV["dist_specs"] = "1"
-  Rake::Task["spec"].invoke(args.example_string)
+  Rake::Task["spec"].execute(args.example_string)
   ENV.delete("dist_specs")
   FileUtils.rm_f(Dir.glob(".rscons-*"))
 end
 
-YARD::Rake::YardocTask.new do |yard|
-  yard.files = ['lib/**/*.rb']
-  yard.options = ["-ogen/yard"]
-end
-
 task :gen_large_project, [:size] => :build_dist do |task, args|
   size = (args.size || 10000).to_i
   FileUtils.rm_rf("large_project")
@@ -88,8 +86,17 @@ EOF
   FileUtils.cp("dist/rscons", "large_project")
 end
 
-task :user_guide do
-  system("ruby", "-Ilib", "rb/gen_user_guide.rb")
+unless RbConfig::CONFIG["host"]["msys"]
+  require "yard"
+  YARD::Rake::YardocTask.new do |yard|
+    yard.files = ['lib/**/*.rb']
+    yard.options = ["-ogen/yard"]
+  end
+
+  desc "Build user guide"
+  task :user_guide do
+    system("ruby", "-Ilib", "rb/gen_user_guide.rb")
+  end
 end
 
 task :default => :spec
@@ -97,6 +104,7 @@ task :default => :spec
 task :all => [
   :build_dist,
   :spec,
+  :dspec,
   :yard,
   :user_guide,
 ]

build_tests/configure/check_d_import_d_import_path.rb

@@ -1,4 +1,5 @@
 configure do
+  check_d_compiler
   check_d_import "std.stdio", check_d_import_path: ["./usr1"]
   check_d_import "frobulous", check_d_import_path: ["./usr2"]
 end

build_tests/configure/check_d_import_success.rb

@@ -1,3 +1,4 @@
 configure do
+  check_d_compiler
   check_d_import "std.stdio"
 end

build_tests/configure/on_fail.rb

@@ -0,0 +1,5 @@
+configure do
+  check_c_compiler "foo123c", fail: false, on_fail: "Install the foo123 package"
+  check_d_compiler "foo123d", fail: false
+  check_cxx_compiler "foo123cxx", on_fail: lambda {puts "Install the foo123cxx package"}
+end

build_tests/custom_builder/build_after.rb

@@ -6,7 +6,8 @@ build do
                 "CMD_DESC" => "Generating")
     env["build_root"] = env.build_root
     env["inc_c"] = "inc.c"
-    env.build_after("${build_root}/program.o", "${inc_c}")
-    env.Program("program.exe", ["program.c", "inc.c"])
+    env.Object("program.o", "program.c")
+    env.build_after("program.o", "${inc_c}")
+    env.Program("program.exe", ["program.o", "inc.c"])
   end
 end

build_tests/custom_builder/produces.rb

@@ -4,8 +4,9 @@ build do
     env["inc_h"] = "inc.h"
 
     env.Copy("copy_inc.h", "${inc_h}")
-    env.depends("${build_root}/program.o", "${inc_h}")
-    env.Program("program.exe", ["program.c", "inc.c"])
+    env.depends("program.o", "${inc_h}")
+    env.Object("program.o", "program.c")
+    env.Program("program.exe", ["program.o", "inc.c"])
 
     inc_c = env.Command("inc.c",
                         [],

build_tests/custom_builder/produces_env.rb

@@ -4,8 +4,9 @@ build do
     env["inc_h"] = "inc.h"
 
     env.Copy("copy_inc.h", "${inc_h}")
-    env.depends("${build_root}/program.o", "${inc_h}")
-    env.Program("program.exe", ["program.c", "inc.c"])
+    env.depends("program.o", "${inc_h}")
+    env.Object("program.o", "program.c")
+    env.Program("program.exe", ["program.o", "inc.c"])
 
     env.Command("inc.c",
                 [],

build_tests/json_to_yaml/Rsconscript

@@ -4,6 +4,7 @@ build do
     require 'yaml'
     env.add_builder(:JsonToYaml) do |params|
       unless @cache.up_to_date?(@target, :JsonToYaml, @sources, @env)
+        print_run_message("JsonToYaml #{@target}", nil)
         @cache.mkdir_p(File.dirname(@target))
         File.open(@target, 'w') do |f|
           f.write(YAML.dump(JSON.load(IO.read(@sources.first))))

build_tests/multiple_basename/Rsconscript

@@ -0,0 +1,5 @@
+build do
+  Environment.new do |env|
+    env.Program("foo.exe", glob("*.cc", "*.c"))
+  end
+end

build_tests/multiple_basename/foo.c

@@ -0,0 +1,6 @@
+#include <stdio.h>
+
+void foo(void)
+{
+    printf("foo\n");
+}

build_tests/multiple_basename/foo.cc

@@ -0,0 +1,12 @@
+#include <iostream>
+
+extern "C" {
+    void foo(void);
+}
+
+int main(int argc, char * argv[])
+{
+    foo();
+    std::cout << "main" << std::endl;
+    return 0;
+}

build_tests/simple/path_append/foobar

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+echo "foobar!"

build_tests/simple/path_append/gcc

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+exit 42

build_tests/simple/path_prepend/flex

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+echo "flex!"

build_tests/simple/pathing.rb

@@ -0,0 +1,10 @@
+path_prepend "path_prepend"
+path_append "path_append"
+
+build do
+  Environment.new do |env|
+    system("flex")
+    system("foobar")
+    env.Object("simple.o", "simple.c")
+  end
+end

build_tests/simple/user_dependencies_carat.rb

@@ -0,0 +1,18 @@
+class FileBuilder < Builder
+  def self.name
+    "File"
+  end
+  def run(options)
+    FileUtils.mkdir_p(File.dirname(@target))
+    File.binwrite(@target, ENV["file_contents"])
+    true
+  end
+end
+build do
+  Environment.new do |env|
+    env.add_builder(FileBuilder)
+    env.File("^/file.txt")
+    program = env.Program("^/simple.exe", Dir["*.c"])
+    env.depends("^/simple.exe", "^/file.txt")
+  end
+end

build_tests/subsidiary/Rsconscript

@@ -0,0 +1,10 @@
+configure do
+  rscons "sub/Rsconscript"
+  rscons "sub/Rsconscript2", "configure"
+  puts "top configure"
+end
+
+build do
+  rscons "sub/Rsconscript2", "build"
+  puts "top build"
+end

build_tests/subsidiary/Rsconscript_dir

@@ -0,0 +1,10 @@
+configure do
+  rscons "sub"
+  rscons "sub", "-f", "Rsconscript2", "configure"
+  puts "top configure"
+end
+
+build do
+  rscons "sub", "-f", "Rsconscript2", "build"
+  puts "top build"
+end

build_tests/subsidiary/Rsconscript_fail

@@ -0,0 +1,9 @@
+configure do
+  rscons "sub/Rsconscript_fail"
+  puts "top configure"
+end
+
+build do
+  rscons "sub/Rsconscript2", "build"
+  puts "top build"
+end

build_tests/subsidiary/Rsconscript_samedir

@@ -0,0 +1,4 @@
+build do
+  rscons "second", "build"
+  puts "top build"
+end

build_tests/subsidiary/second

@@ -0,0 +1,3 @@
+build do
+  puts "second build"
+end

build_tests/subsidiary/sub/Rsconscript

@@ -0,0 +1,7 @@
+configure do
+  puts "sub Rsconscript configure"
+end
+
+build do
+  puts "sub Rsconscript build"
+end

build_tests/subsidiary/sub/Rsconscript2

@@ -0,0 +1,7 @@
+configure do
+  puts "sub Rsconscript2 configure"
+end
+
+build do
+  puts "sub Rsconscript2 build"
+end

build_tests/subsidiary/sub/Rsconscript_fail

@@ -0,0 +1,8 @@
+configure do
+  puts "sub Rsconscript configure"
+  check_program "foobarfailure"
+end
+
+build do
+  puts "sub Rsconscript build"
+end

build_tests/typical/build_hooks.rb

@@ -2,9 +2,9 @@ build do
   Environment.new(echo: :command) do |env|
     env.append('CPPPATH' => glob('src/**/*/'))
     env.add_build_hook do |builder|
-      if File.basename(builder.target) == "one.o"
+      if File.basename(builder.sources.first) == "one.c"
         builder.vars["CFLAGS"] << "-O1"
-      elsif File.basename(builder.target) == "two.o"
+      elsif File.basename(builder.sources.first) == "two.c"
         builder.vars["CFLAGS"] << "-O2"
       end
     end

doc/user_guide.md

@@ -246,6 +246,15 @@ configure do
 end
 ```
 
+Global configuration options may be supplied to the compiler checks as well.
+Example:
+
+```ruby
+configure do
+  check_c_compiler "x86_64-elf-gcc", on_fail: "Install x86_64-elf cross toolchain first!"
+end
+```
+
 ###> Checking for a Header File
 
 The following methods can be used to check for the presence of a header file:
@@ -272,18 +281,6 @@ end
 
 Optionally specifies an array of paths to look for the header file in.
 
-##### `:fail`
-
-If the `:fail` option is set to `false`, then the absence of the header file
-will not result in the configure option failing.
-The `:fail` option defaults to `true` if the `:set_define` option is not
-defined, and defaults to `false` if the `:set_define` option is defined.
-
-##### `:set_define`
-
-If set, a build define of the specified String will be added to the
-`CPPDEFINES` construction variable array if the requested header is found.
-
 ###> Checking for a D Import
 
 The `check_d_import` method can be used to check for the presence of D import.
@@ -327,18 +324,6 @@ end
 
 Optionally specifies an array of paths to look for the library in.
 
-##### `:fail`
-
-If the `:fail` option is set to `false`, then the absence of the library
-will not result in the configure option failing.
-The `:fail` option defaults to `true` if the `:set_define` option is not
-defined, and defaults to `false` if the `:set_define` option is defined.
-
-##### `:set_define`
-
-If set, a build define of the specified String will be added to the
-`CPPDEFINES` construction variable array if the requested library is found.
-
 ##### `:use`
 
 If not set, the library will be used by default in all `Environment` objects.
@@ -387,18 +372,6 @@ used to look for package configuration flags for the specified package.
 If the `:program` option is given, the program specified will be used to look
 for configuration flags.
 
-##### `:fail`
-
-If the `:fail` option is set to `false`, then the absence of the package or
-program requested will not result in the configure option failing.
-The `:fail` option defaults to `true` if the `:set_define` option is not
-defined, and defaults to `false` if the `:set_define` option is defined.
-
-##### `:set_define`
-
-If set, a build define of the specified String will be added to the
-`CPPDEFINES` construction variable array if the requested package is found.
-
 ##### `:use`
 
 If not set, the library will be used by default in all `Environment` objects.
@@ -457,6 +430,46 @@ configure do
 end
 ```
 
+###> Global Configuration Check Options
+
+#### `:fail`
+
+If the `:fail` option is set to `false`, then the absence of the package or
+program requested will not result in the configure option failing.
+The `:fail` option defaults to `true` if the `:set_define` option is not
+defined, and defaults to `false` if the `:set_define` option is defined.
+
+#### `:on_fail`
+
+The `:on_fail` option can be set to a String or a Proc object. If the
+configuration operation fails (or would fail), the given message is printed
+or the Proc is called.
+
+Examples:
+
+```ruby
+configure do
+  check_c_compiler "special-gcc", on_fail: "First install special gcc!"
+end
+
+configure do
+  package_hint = lambda do
+    puts "The following packages must be installed to build this project:"
+    puts "- libsdl2-dev"
+    puts "- libsdl2-image-dev"
+    puts "- libsdl2-net-dev"
+  end
+  check_lib "SDL2", on_fail: package_hint
+  check_lib "SDL2_image", on_fail: package_hint
+  check_lib "SDL2_net", on_fail: package_hint
+end
+```
+
+#### `:set_define`
+
+If set, a build define of the specified String will be added to the
+`CPPDEFINES` construction variable array if the requested package is found.
+
 ##> Build Operations
 
 The `build` block is used to create Environments and register build targets.
@@ -599,14 +612,26 @@ There are several default builders that are built-in to Rscons:
 ```ruby
 env.Command(target, sources, "CMD" => command)
 # Example
-env.Command("docs.html", "docs.md",
+env.Command("user_guide.html", "user_guide.md",
   "CMD" => ["pandoc", "-fmarkdown", "-thtml", "-o${_TARGET}", "${_SOURCES}"],
-  "CMD_DESC" => "PANDOC")
+  "CMD_DESC" => "Generating user guide:")
 ```
 
 The `Command` builder executes a user-defined command in order to produce the
 desired target file based on the provided source files.
 
+The `Command` builder supports the following construction variables:
+
+  * `CMD` (required) specifies the command to execute (an array of strings).
+    `CMD` is expanded for variable references, so the tokens `${_TARGET}` and
+    `${_SOURCES}` can be used, for example.
+  * `CMD_DESC` (optional) specifies the short text description to print when
+    the builder executes. The given description is followed by the target file
+    name.
+  * `CMD_STDOUT` (optional) specifies a file to redirect standard output to.
+    `CMD_STDOUT` is expanded for variable references, so the token `${_TARGET}`
+    can be used, for example.
+
 ####> The CFile Builder
 
 ```ruby
@@ -796,6 +821,22 @@ allows it to be used to create a shared library are added.
 Although it can be called explicitly, it is more commonly implicitly called by
 the `SharedLibrary` builder.
 
+###> Phony Targets
+
+rscons supports phony build targets.
+Normally, a builder produces an output file, and executes whenever the input
+files or command have changed.
+A phony build target can be used to register a builder that does not produce
+an output file.
+A custom builder can take some action when the input files change even if it
+does not produce an output file.
+Such a builder could perform verification or run a test on its source files,
+possibly failing if some conditions are not met.
+It could also simply output something to the console, such as an analysis of
+the source file, whenever it changes.
+A phony target is signified by passing a Symbol instead of a String as the
+first parameter (target) to a builder method.
+
 ###> Explicit Dependencies
 
 A target can be marked as depending on another file that Rscons would not
@@ -859,6 +900,70 @@ In other words, build targets are not parallelized across a barrier.
 env.barrier
 ```
 
+##> Global Build Script Functionality
+
+###> Using Subsidiary Build Scripts
+
+The `rscons` build script method can be used to invoke an rscons subprocess to
+perform an operation using a subsidiary rscons build script.
+This can be used, for example, when a subproject is imported and a top-level
+`configure` or `build` operation should also perform the same operation in the
+subproject directory.
+
+The first argument to the `rscons` method specifies either a directory name, or
+the path to the subsidiary Rsconscript file to execute.
+Any additional arguments are passed to `rscons` when it executes the subsidiary
+script.
+`rscons` will change working directories to the directory containing the
+subsidiary script when executing it.
+
+For example:
+
+```ruby
+configure do
+  rscons "subproject", "configure"
+end
+
+build do
+  rscons "subproject/Rsconscript", "build"
+end
+```
+
+It is also perfectly valid to perform a different operation in the subsidiary
+script from the one being performed in the top-level script.
+For example, in a project that requires a particular cross compiler, the
+top-level `configure` script could build the necessary cross compiler using a
+subsidiary build script.
+This could look something like:
+
+```ruby
+configure do
+  rscons "cross/Rsconscript"
+  check_c_compiler "i686-elf-gcc"
+end
+```
+
+This would build, and if necessary first configure, using the cross/Rsconscript
+subsidiary build script.
+Subsidiary build scripts are executed from within the directory containing the
+build script.
+
+###> PATH Management
+
+`rscons` provides methods for management of the `PATH` environment variable.
+
+The `path_append` and `path_prepend` methods can be used to append or prepend
+a path to the `PATH` environment variable.
+
+```ruby
+path_prepend "i686-elf-gcc/bin"
+```
+
+The `path_set` method sets the `PATH` environment variable to the given
+Array or String.
+The `path_components` method returns an Array of the components in the `PATH`
+environment variable.
+
 ##> Extending Rscons
 
 ### Adding New Languages
@@ -1025,7 +1130,7 @@ Here is our Custom builder example extended to print its status:
 ```ruby
 class Rscons::Builders::Custom < Rscons::Builder
   def run(options)
-    print_run_message("Creating <target>#{@target}<reset> from Custom builder")
+    print_run_message("Creating <target>#{@target}<reset> from Custom builder", nil)
     File.open(@target, "w") do |fh|
       fh.write("Target file created.")
     end
@@ -1050,7 +1155,7 @@ Here is a Custom builder which combines its source files similar to what the
 class Rscons::Builders::Custom < Rscons::Builder
   def run(options)
     unless @cache.up_to_date?(@target, nil, @sources, @env)
-      print_run_message("Combining <source>#{Util.short_format_paths(@sources)}<reset> => <target>#{@target}<reset>")
+      print_run_message("Combining <source>#{Util.short_format_paths(@sources)}<reset> => <target>#{@target}<reset>", nil)
       File.open(@target, "wb") do |fh|
         @sources.each do |source|
           fh.write(File.read(source, mode: "rb"))
@@ -1277,7 +1382,7 @@ To do this, create a `configure` script with contents similar to the following:
 
 ```
 #!/bin/sh
-exec "$(dirname "$0")"/rscons "$@"
+exec "$(dirname "$0")"/rscons configure "$@"
 ```
 
 and make it executable with `chmod +x configure`.

lib/rscons.rb

@@ -35,8 +35,8 @@ module Rscons
     :SharedObject,
   ]
 
-  # Class to represent a fatal error while building a target.
-  class BuildError < RuntimeError; end
+  # Class to represent a fatal error during an Rscons operation.
+  class RsconsError < RuntimeError; end
 
   class << self
 
@@ -64,16 +64,6 @@ module Rscons
       target.is_a?(Symbol)
     end
 
-    # Return a new path by changing the suffix in path to suffix.
-    #
-    # @param path [String] The path to alter.
-    # @param suffix [String] The new filename suffix, e.g. ".exe".
-    #
-    # @return [String] New path.
-    def set_suffix(path, suffix)
-      path.sub(/\.[^.]*$/, "") + suffix
-    end
-
     # Return the system shell and arguments for executing a shell command.
     #
     # @return [Array<String>] The shell and flag.
@@ -91,7 +81,7 @@ module Rscons
           end
           if ENV["SHELL"] and ENV["SHELL"] != "" and test_shell[ENV["SHELL"], "-c"]
             [ENV["SHELL"], "-c"]
-          elsif Object.const_get("RUBY_PLATFORM") =~ /mingw/
+          elsif Object.const_get("RUBY_PLATFORM") =~ /mingw|msys/
             if test_shell["sh", "-c"]
               # Using Rscons from MSYS should use MSYS's shell.
               ["sh", "-c"]
@@ -112,7 +102,7 @@ module Rscons
     # @return [Array<String>] Command used to execute commands.
     def command_executer
       @command_executer ||=
-        if Object.const_get("RUBY_PLATFORM") =~ /mingw/
+        if Object.const_get("RUBY_PLATFORM") =~ /mingw|msys/
           if ENV.keys.find {|key| key =~ /MSYS/}
             begin
               if IO.popen(["env", "echo", "success"]) {|io| io.read.strip} == "success"

lib/rscons/ansi.rb

@@ -84,7 +84,7 @@ module Rscons
       # @return [Boolean]
       #   Whether to output ANSI color escape codes.
       def do_ansi?(io)
-        if RUBY_PLATFORM =~ /mingw/
+        if RUBY_PLATFORM =~ /mingw|msys/
           (ENV["TERM"] == "xterm") && %w[fifo characterSpecial].include?(io.stat.ftype)
         else
           io.tty?

lib/rscons/application.rb

@@ -75,6 +75,8 @@ module Rscons
           end
           if rv == 0
             build(operation_options)
+          else
+            rv
           end
         when "clean"
           clean
@@ -134,8 +136,8 @@ module Rscons
           env.process
         end
         0
-      rescue BuildError => be
-        Ansi.write($stderr, :red, be.message, :reset, "\n")
+      rescue RsconsError => e
+        Ansi.write($stderr, :red, e.message, :reset, "\n")
         1
       end
     end
@@ -191,7 +193,11 @@ module Rscons
       co = ConfigureOp.new(options)
       begin
         @script.configure(co)
-      rescue ConfigureOp::ConfigureFailure
+      rescue RsconsError => e
+        if e.message and e.message != ""
+          $stderr.puts e.message
+        end
+        Ansi.write($stderr, :red, "Configuration failed", :reset, "\n")
         rv = 1
       end
       co.close(rv == 0)

lib/rscons/builders/copy.rb

@@ -57,6 +57,7 @@ module Rscons
                 printed_message = true
               end
               @cache.mkdir_p(File.dirname(dest), install: @install_builder)
+              FileUtils.rm_f(dest)
               FileUtils.cp(src, dest, :preserve => true)
             end
             @cache.register_build(dest, :Copy, [src], @env, install: @install_builder)

lib/rscons/builders/mixins/object.rb

@@ -75,10 +75,10 @@ module Rscons
             @vars["_SOURCES"] = @sources
             depfilesuffix = @env.expand_varref("${DEPFILESUFFIX}", vars)
             @vars["_DEPFILE"] =
-              if @vars[:direct]
-                @env.get_build_fname(target, depfilesuffix, self.class)
+              if @vars[:direct] || !@target.start_with?("#{@env.build_root}/")
+                @env.get_build_fname(@target, depfilesuffix, self.class)
               else
-                Rscons.set_suffix(target, depfilesuffix)
+                "#{@target}#{depfilesuffix}"
               end
             @cache.mkdir_p(File.dirname(@vars["_DEPFILE"]))
             command = @env.build_command(@command_template, @vars)

lib/rscons/builders/preprocess.rb

@@ -23,7 +23,7 @@ module Rscons
           @vars["_PREPROCESS_DEPGEN"] = depgen
           @vars["_TARGET"] = @target
           @vars["_SOURCES"] = @sources
-          @vars["_DEPFILE"] = Rscons.set_suffix(target, env.expand_varref("${DEPFILESUFFIX}", vars))
+          @vars["_DEPFILE"] = "#{target}#{env.expand_varref("${DEPFILESUFFIX}", vars)}"
           command = @env.build_command("${CPP_CMD}", @vars)
           self.produces(@vars["_DEPFILE"])
           standard_command("Preprocessing <source>#{Util.short_format_paths(@sources)}<reset> => <target>#{@target}<reset>", command)

lib/rscons/cli.rb

@@ -6,11 +6,13 @@ USAGE = <<EOF
 Usage: #{$0} [global options] [operation] [operation options]
 
 Global options:
+  -f FILE                     Use FILE as Rsconscript
   -F, --show-failure          Show failed command log from previous build and exit
-  --version                   Show rscons version and exit
   -h, --help                  Show rscons help and exit
+  -j N, --nthreads=N          Set number of threads (local default: #{Rscons.application.n_threads})
   -r COLOR, --color=COLOR     Set color mode (off, auto, force)
   -v, --verbose               Run verbosely
+  --version                   Show rscons version and exit
 
 Operations:
   configure                   Configure the project
@@ -23,10 +25,6 @@ Operations:
 Configure options:
   -b BUILD, --build=BUILD     Set build directory (default: build)
   --prefix=PREFIX             Set installation prefix (default: /usr/local)
-
-Build options:
-  -j N, --nthreads=N          Set number of threads (local default: #{Rscons.application.n_threads})
-
 EOF
 
 module Rscons

lib/rscons/configure_op.rb

@@ -5,9 +5,6 @@ module Rscons
   # Class to manage a configure operation.
   class ConfigureOp
 
-    # Exception raised when a configuration error occurs.
-    class ConfigureFailure < Exception; end
-
     # Create a ConfigureOp.
     #
     # @param options [Hash]
@@ -62,6 +59,10 @@ module Rscons
     # @return [void]
     def check_c_compiler(*ccc)
       $stdout.write("Checking for C compiler... ")
+      options = {}
+      if ccc.last.is_a?(Hash)
+        options = ccc.slice!(-1)
+      end
       if ccc.empty?
         # Default C compiler search array.
         ccc = %w[gcc clang]
@@ -69,7 +70,7 @@ module Rscons
       cc = ccc.find do |cc|
         test_c_compiler(cc)
       end
-      complete(cc ? 0 : 1, success_message: cc)
+      complete(cc ? 0 : 1, options.merge(success_message: cc))
     end
 
     # Check for a working C++ compiler.
@@ -80,6 +81,10 @@ module Rscons
     # @return [void]
     def check_cxx_compiler(*ccc)
       $stdout.write("Checking for C++ compiler... ")
+      options = {}
+      if ccc.last.is_a?(Hash)
+        options = ccc.slice!(-1)
+      end
       if ccc.empty?
         # Default C++ compiler search array.
         ccc = %w[g++ clang++]
@@ -87,7 +92,7 @@ module Rscons
       cc = ccc.find do |cc|
         test_cxx_compiler(cc)
       end
-      complete(cc ? 0 : 1, success_message: cc)
+      complete(cc ? 0 : 1, options.merge(success_message: cc))
     end
 
     # Check for a working D compiler.
@@ -98,6 +103,10 @@ module Rscons
     # @return [void]
     def check_d_compiler(*cdc)
       $stdout.write("Checking for D compiler... ")
+      options = {}
+      if cdc.last.is_a?(Hash)
+        options = cdc.slice!(-1)
+      end
       if cdc.empty?
         # Default D compiler search array.
         cdc = %w[gdc ldc2]
@@ -105,7 +114,7 @@ module Rscons
       dc = cdc.find do |dc|
         test_d_compiler(dc)
       end
-      complete(dc ? 0 : 1, success_message: dc)
+      complete(dc ? 0 : 1, options.merge(success_message: dc))
     end
 
     # Check for a package or configure program output.
@@ -387,11 +396,15 @@ module Rscons
           else
             !options[:set_define]
           end
+        color = should_fail ? :red : :yellow
+        Ansi.write($stdout, color, "#{fail_message}\n")
+        if options[:on_fail].is_a?(String)
+          $stdout.puts(options[:on_fail])
+        elsif options[:on_fail].is_a?(Proc)
+          options[:on_fail].call
+        end
         if should_fail
-          Ansi.write($stdout, :red, "#{fail_message}\n")
-          raise ConfigureFailure.new
-        else
-          Ansi.write($stdout, :yellow, "#{fail_message}\n")
+          raise RsconsError.new
         end
       end
     end
@@ -408,22 +421,17 @@ module Rscons
     def test_c_compiler(cc)
       File.open("#{@work_dir}/cfgtest.c", "wb") do |fh|
         fh.puts <<-EOF
-          #include <stdio.h>
-          int main(int argc, char * argv[]) {
-            printf("Success.\\n");
-            return 0;
+          int fun(int val) {
+            return val * 2;
           }
         EOF
       end
-      command = %W[#{cc} -o #{@work_dir}/cfgtest.exe #{@work_dir}/cfgtest.c]
+      command = %W[#{cc} -c -o #{@work_dir}/cfgtest.o #{@work_dir}/cfgtest.c]
       merge = {"CC" => cc}
       _, _, status = log_and_test_command(command)
       if status == 0
-        stdout, _, status = log_and_test_command(["#{@work_dir}/cfgtest.exe"])
-        if status == 0 and stdout =~ /Success/
-          store_merge(merge)
-          true
-        end
+        store_merge(merge)
+        true
       end
     end
 
@@ -437,23 +445,18 @@ module Rscons
     def test_cxx_compiler(cc)
       File.open("#{@work_dir}/cfgtest.cxx", "wb") do |fh|
         fh.puts <<-EOF
-          #include <iostream>
-          using namespace std;
-          int main(int argc, char * argv[]) {
-            cout << "Success." << endl;
-            return 0;
+          template<typename T>
+          T fun(T val) {
+            return val * 2;
           }
         EOF
       end
-      command = %W[#{cc} -o #{@work_dir}/cfgtest.exe #{@work_dir}/cfgtest.cxx]
+      command = %W[#{cc} -c -o #{@work_dir}/cfgtest.o #{@work_dir}/cfgtest.cxx]
       merge = {"CXX" => cc}
       _, _, status = log_and_test_command(command)
       if status == 0
-        stdout, _, status = log_and_test_command(["#{@work_dir}/cfgtest.exe"])
-        if status == 0 and stdout =~ /Success/
-          store_merge(merge)
-          true
-        end
+        store_merge(merge)
+        true
       end
     end
 
@@ -467,9 +470,8 @@ module Rscons
     def test_d_compiler(dc)
       File.open("#{@work_dir}/cfgtest.d", "wb") do |fh|
         fh.puts <<-EOF
-          import std.stdio;
-          int main() {
-            writeln("Success.");
+          import core.math;
+          int fun() {
             return 0;
           }
         EOF
@@ -477,29 +479,25 @@ module Rscons
       [:gdc, :ldc2].find do |dc_test|
         case dc_test
         when :gdc
-          command = %W[#{dc} -o #{@work_dir}/cfgtest.exe #{@work_dir}/cfgtest.d]
+          command = %W[#{dc} -c -o #{@work_dir}/cfgtest.o #{@work_dir}/cfgtest.d]
           merge = {"DC" => dc}
         when :ldc2
-          command = %W[#{dc} -of #{@work_dir}/cfgtest.exe #{@work_dir}/cfgtest.d]
+          # ldc2 on Windows expect an object file suffix of .obj.
+          ldc_objsuffix = RUBY_PLATFORM =~ /mingw|msys/ ? ".obj" : ".o"
+          command = %W[#{dc} -c -of #{@work_dir}/cfgtest#{ldc_objsuffix} #{@work_dir}/cfgtest.d]
           env = BasicEnvironment.new
           merge = {
             "DC" => dc,
-            "DCCMD" => env["DCCMD"].map {|e| if e == "-o"; "-of"; else; e; end},
-            "LDCMD" => env["LDCMD"].map {|e| if e == "-o"; "-of"; else; e; end},
+            "DCCMD" => env["DCCMD"].map {|e| e.sub(/^-o$/, "-of")},
+            "LDCMD" => env["LDCMD"].map {|e| e.sub(/^-o$/, "-of")},
             "DDEPGEN" => ["-deps=${_DEPFILE}"],
           }
-          if RUBY_PLATFORM =~ /mingw/
-            # ldc2 on Windows expect an object file suffix of .obj.
-            merge["OBJSUFFIX"] = %w[.obj]
-          end
+          merge["OBJSUFFIX"] = [ldc_objsuffix]
         end
         _, _, status = log_and_test_command(command)
         if status == 0
-          stdout, _, status = log_and_test_command(["#{@work_dir}/cfgtest.exe"])
-          if status == 0 and stdout =~ /Success/
-            store_merge(merge)
-            true
-          end
+          store_merge(merge)
+          true
         end
       end
     end

lib/rscons/default_construction_variables.rb

@@ -1,6 +1,6 @@
 module Rscons
 
-  on_windows = RUBY_PLATFORM =~ /mingw|cygwin/
+  on_windows = RUBY_PLATFORM =~ /mingw|msys|cygwin/
   pic_flags = on_windows ? [] : %w[-fPIC]
 
   # Default Rscons construction variables.

lib/rscons/environment.rb

@@ -1,7 +1,6 @@
 require "fileutils"
 require "set"
 require "shellwords"
-require "thwait"
 
 module Rscons
   # The Environment class is the main programmatic interface to Rscons. It
@@ -251,7 +250,7 @@ module Rscons
       if extra_path = builder_class.extra_path
         extra_path = "/#{extra_path}"
       end
-      "#{@build_root}#{extra_path}/#{Util.make_relative_path(Rscons.set_suffix(source_fname, suffix))}".gsub("\\", "/")
+      "#{@build_root}#{extra_path}/#{Util.make_relative_path("#{source_fname}#{suffix}")}".gsub("\\", "/")
     end
 
     # Build all build targets specified in the Environment.
@@ -287,9 +286,9 @@ module Rscons
       unless @process_failures.empty?
         msg = @process_failures.join("\n")
         if Cache.instance["failed_commands"].size > 0
-          msg += "\nUse -F to view the failed command log from the previous build operation"
+          msg += "\nUse `#{Util.command_to_execute_me} -F` to view the failed command log from the previous build operation"
         end
-        raise BuildError.new(msg)
+        raise RsconsError.new(msg)
       end
     end
 
@@ -347,12 +346,12 @@ module Rscons
       if target.is_a?(Builder)
         target = target.target
       end
-      target = expand_varref(target.to_s)
+      target = expand_path(expand_varref(target.to_s))
       user_deps = user_deps.map do |ud|
         if ud.is_a?(Builder)
           ud = ud.target
         end
-        expand_varref(ud)
+        expand_path(expand_varref(ud))
       end
       @user_deps[target] ||= []
       @user_deps[target] = (@user_deps[target] + user_deps).uniq
@@ -702,10 +701,7 @@ module Rscons
           !thread.alive?
         end
       else
-        if @threads.empty?
-          raise "No threads to wait for"
-        end
-        ThreadsWait.new(*@threads.keys).next_wait
+        Util.wait_for_thread(*@threads.keys)
       end
     end
 

lib/rscons/script.rb

@@ -3,8 +3,87 @@ module Rscons
   # The Script class encapsulates the state of a build script.
   class Script
 
-    # DSL available to the Rsconscript.
-    class Dsl
+    # Global DSL methods.
+    class GlobalDsl
+
+      # Return path components from the PATH variable.
+      #
+      # @return [Array<String>]
+      #   Path components from the PATH variable.
+      def path_components
+        ENV["PATH"].split(File::PATH_SEPARATOR)
+      end
+
+      # Prepend a path component to the PATH variable.
+      #
+      # @param path [String]
+      #   Path to prepend.
+      #
+      # @return [void]
+      def path_prepend(path)
+        path_set([File.expand_path(path)] + path_components)
+      end
+
+      # Append a path component to the PATH variable.
+      #
+      # @param path [String]
+      #   Path to append.
+      #
+      # @return [void]
+      def path_append(path)
+        path_set(path_components + [File.expand_path(path)])
+      end
+
+      # Set the PATH variable.
+      #
+      # @param new_path [String, Array<String>]
+      #   New PATH variable value as an array or string.
+      #
+      # @return [void]
+      def path_set(new_path)
+        if new_path.is_a?(Array)
+          new_path = new_path.join(File::PATH_SEPARATOR)
+        end
+        ENV["PATH"] = new_path
+      end
+
+      # Invoke rscons in a subprocess for a subsidiary Rsconscript file.
+      #
+      # @param path [String]
+      #   Path to subsidiary Rsconscript to execute, or path to subsidiary
+      #   directory to run rscons in.
+      # @param args[Array<String>]
+      #   Arguments to pass to rscons subprocess.
+      def rscons(path, *args)
+        rscons_path = File.expand_path($0)
+        path = File.expand_path(path)
+        if File.directory?(path)
+          command = [*args]
+          dir = path
+        else
+          command = ["-f", path, *args]
+          dir = File.dirname(path)
+        end
+        if File.exist?("#{dir}/rscons")
+          rscons_path = "#{dir}/rscons"
+        end
+        command = [rscons_path] + command
+        print_dir = dir != "." && dir != File.expand_path(Dir.pwd)
+        if ENV["specs"] and not ENV["dist_specs"] # specs
+          command = ["ruby", $LOAD_PATH.map {|p| ["-I", p]}, command].flatten # specs
+        end # specs
+        puts "rscons: Entering directory '#{dir}'" if print_dir
+        result = system(*command, chdir: dir)
+        puts "rscons: Leaving directory '#{dir}'" if print_dir
+        unless result
+          raise RsconsError.new("Failed command: " + command.join(" "))
+        end
+      end
+
+    end
+
+    # Top-level DSL available to the Rsconscript.
+    class Dsl < GlobalDsl
       # Create a Dsl.
       def initialize(script)
         @script = script
@@ -59,7 +138,7 @@ module Rscons
     end
 
     # DSL available to the 'configure' block.
-    class ConfigureDsl
+    class ConfigureDsl < GlobalDsl
       # Create a ConfigureDsl.
       #
       # @param configure_op [ConfigureOp]

lib/rscons/util.rb

@@ -9,7 +9,7 @@ module Rscons
       #
       # @return [Boolean] Whether the given path is an absolute filesystem path.
       def absolute_path?(path)
-        if RUBY_PLATFORM =~ /mingw/
+        if RUBY_PLATFORM =~ /mingw|msys/
           path =~ %r{^(?:\w:)?[\\/]}
         else
           path.start_with?("/")
@@ -68,8 +68,8 @@ module Rscons
           case RbConfig::CONFIG["host_os"]
           when /linux/
             return File.read("/proc/cpuinfo").scan(/^processor\s*:/).size
-          when /mswin|mingw/
-            if `wmic cpu get NumberOfLogicalProcessors /value` =~ /NumberOfLogicalProcessors=(\d+)/
+          when /mswin|mingw|msys/
+            if `wmic cpu get NumberOfLogicalProcessors -value` =~ /NumberOfLogicalProcessors=(\d+)/
               return $1.to_i
             end
           when /darwin/
@@ -191,6 +191,40 @@ module Rscons
         deps
       end
 
+      # Wait for any of a number of threads to complete.
+      #
+      # @param threads [Array<Thread>]
+      #   Threads to wait for.
+      #
+      # @return [Thread]
+      #   The Thread that completed.
+      def wait_for_thread(*threads)
+        if threads.empty?
+          raise "No threads to wait for"
+        end
+        queue = Queue.new
+        threads.each do |thread|
+          # Create a wait thread for each thread we're waiting for.
+          Thread.new do
+            begin
+              thread.join
+            ensure
+              queue.push(thread)
+            end
+          end
+        end
+        # Wait for any thread to complete.
+        queue.pop
+      end
+
+      # Command that can be run to execute this instance of rscons from the
+      # current working directory.
+      def command_to_execute_me
+        command = Pathname.new(File.expand_path($0)).relative_path_from(Dir.pwd).to_s
+        command = "./#{command}" unless command["/"]
+        command
+      end
+
       private
 
       # Check if a directory contains a certain executable.
@@ -199,11 +233,14 @@ module Rscons
       #   Directory to look in.
       # @param executable [String]
       #   Executable to look for.
+      #
+      # @return [String, nil]
+      #   Executable found.
       def test_path_for_executable(path_entry, executable)
         is_executable = lambda do |path|
           File.file?(path) and File.executable?(path)
         end
-        if RbConfig::CONFIG["host_os"] =~ /mswin|windows|mingw/i
+        if RbConfig::CONFIG["host_os"] =~ /mswin|windows|mingw|msys/i
           if File.directory?(path_entry)
             executable = executable.downcase
             dir_entries = Dir.entries(path_entry)

lib/rscons/version.rb

@@ -1,4 +1,4 @@
 module Rscons
   # Project version.
-  VERSION = "2.0.0"
+  VERSION = "2.2.0"
 end

rb/build_dist.rb

@@ -44,7 +44,7 @@ combine_files[START_FILE]
 # Strip Ruby comment lines and empty lines to save some space, but do not
 # remove lines that are in heredoc sections. This isn't terribly robust to be
 # used in the wild, but works for the heredoc instances for this project.
-stripped_comments = []
+stripped = []
 heredoc_end = nil
 combined_file.each do |line|
   if line =~ /<<-?([A-Z]+)/
@@ -53,14 +53,16 @@ combined_file.each do |line|
   if heredoc_end and line =~ /^\s*#{heredoc_end}/
     heredoc_end = nil
   end
-  if heredoc_end or not (line =~ /^\s*(#[^!].*)?$/)
-    stripped_comments << line
+  if line !~ /#\sspecs/
+    if heredoc_end or line !~ /^\s*(#[^!].*)?$/
+      stripped << line
+    end
   end
 end
 
 require "zlib"
 require "base64"
-compressed_script = Zlib::Deflate.deflate(stripped_comments.join)
+compressed_script = Zlib::Deflate.deflate(stripped.join)
 encoded_compressed_script = Base64.encode64(compressed_script).gsub("\n", "")
 hash = Digest::MD5.hexdigest(encoded_compressed_script)
 

spec/rscons/util_spec.rb

@@ -68,7 +68,7 @@ EOF
             expect(RbConfig::CONFIG).to receive(:[]).with("host_os").and_return("mingw")
           end
           it "returns the number of logical processors that wmic reports" do
-            expect(Util).to receive(:`).with("wmic cpu get NumberOfLogicalProcessors /value").and_return("NumberOfLogicalProcessors=7")
+            expect(Util).to receive(:`).with("wmic cpu get NumberOfLogicalProcessors -value").and_return("NumberOfLogicalProcessors=7")
             expect(Util.determine_n_threads).to eq(7)
           end
         end

spec/rscons_spec.rb

@@ -1,15 +1,5 @@
 describe Rscons do
 
-  describe ".set_suffix" do
-    it "changes the suffix to the new one" do
-      expect(Rscons.set_suffix("foo.c", ".h")).to eq("foo.h")
-    end
-
-    it "appends a suffix if the given file name does not have one" do
-      expect(Rscons.set_suffix("bazz", ".d")).to eq("bazz.d")
-    end
-  end
-
   describe ".get_system_shell" do
     before(:each) do
       Rscons.instance_variable_set(:@shell, nil)

spec/spec_helper.rb

@@ -1,25 +1,25 @@
-require "simplecov"
-
-SimpleCov.start do
-  add_filter "/spec/"
-  add_filter "/.bundle/"
-  if ENV["partial_specs"]
-    command_name "RSpec-partial"
-  else
-    command_name "RSpec"
-  end
-  if ENV["dist_specs"]
-    add_filter "/bin/"
-    add_filter "/lib/"
-  else
-    add_filter "test/rscons.rb"
-  end
-  project_name "Rscons"
-  merge_timeout 3600
-end
-
 if ENV["dist_specs"]
   require_relative "../test/rscons"
 else
+  require "simplecov"
+
+  SimpleCov.start do
+    add_filter "/spec/"
+    add_filter "/.bundle/"
+    if ENV["partial_specs"]
+      command_name "RSpec-partial"
+    else
+      command_name "RSpec"
+    end
+    if ENV["dist_specs"]
+      add_filter "/bin/"
+      add_filter "/lib/"
+    else
+      add_filter "test/rscons.rb"
+    end
+    project_name "Rscons"
+    merge_timeout 3600
+  end
+
   require "rscons"
 end