wip for precompile phase for D

Fix up some macOS test cases

.github/workflows/run-tests.yml

@@ -0,0 +1,38 @@
+name: Run RScons Tests
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby-version: ['2.7', '3.0', '3.4']
+    
+    steps:
+    - name: Install dependencies (Linux)
+      if: runner.os == 'Linux'
+      run: sudo apt-get update && sudo apt-get install -y gcc gdc ldc clang flex bison
+
+    - name: Install dependencies (macOS)
+      if: runner.os == 'macOS'
+      run: brew install gcc ldc flex bison
+
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Run tests
+      run: rake all

CHANGELOG.md

@@ -1,3 +1,39 @@
+## v3.3.0
+
+### New Features
+
+- Add support for Ruby 3.4.
+- Fix up some macOS test cases.
+- #177 - Remove dependency on base64
+- #175 - Add support for building object files from LLVM assembly sources
+
+## v3.2.0
+
+### New Features
+
+- #171 - Place object files next to source files for source files in build directory
+- #170 - Use top-level build directory as environment build directory for unnamed environments
+- #167 - Add upgrading instructions
+- #166 - Replace CFile builder with Yacc and Lex builders
+
+### Fixes
+
+- #172 - Fix configuration checks performed with ldc2 compiler
+- #169 - Output a better error when pkg-config is not found
+- #168 - Cannot output binary to an environment's build root with the same name as the top-level source directory
+- #164 - Improve DSL method documentation
+
+## v3.1.0
+
+### New Features
+
+- #162 - Improve configuration error messages
+- #163 - Ruby 3.2 compatibility
+
+### Fixes
+
+- #161 - builder registered during build hooks should increase build step count
+
 ## v3.0.2
 
 ### Fixes

DEVELOPING.md

@@ -9,6 +9,6 @@ To run the rscons specs, the following commands must be available:
 * g++
 * clang++
 * gdc
-* ldc
+* ldc2
 * flex
 * bison

Gemfile

@@ -1,8 +1,10 @@
 source 'https://rubygems.org'
 
+gem "base64"
 gem "rspec"
 gem "rake"
 gem "simplecov", "~> 0.15.0"
+gem "openssl"
 if RbConfig::CONFIG["host"]["msys"]
   gem "json", "2.1.0"
 else

Gemfile.lock

@@ -1,45 +1,53 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.5.0)
+    base64 (0.3.0)
+    date (3.5.1)
+    diff-lcs (1.6.2)
     docile (1.1.5)
-    json (2.6.1)
-    psych (4.0.3)
+    erb (6.0.1)
+    json (2.18.0)
+    openssl (4.0.0)
+    psych (5.3.1)
+      date
       stringio
-    rake (13.0.6)
-    rdoc (6.4.0)
+    rake (13.3.1)
+    rdoc (7.1.0)
+      erb
       psych (>= 4.0.0)
-    redcarpet (3.5.1)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+      tsort
+    redcarpet (3.6.1)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
     simplecov (0.15.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    stringio (3.0.1)
+    stringio (3.2.0)
     syntax (1.2.2)
-    webrick (1.7.0)
-    yard (0.9.27)
-      webrick (~> 1.7.0)
+    tsort (0.2.0)
+    yard (0.9.38)
 
 PLATFORMS
   ruby
   x86-mingw32
 
 DEPENDENCIES
+  base64
   json
+  openssl
   rake
   rdoc
   redcarpet
@@ -49,4 +57,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.2.31
+   2.6.2

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2022 Josh Holtrop
+Copyright (c) 2013-2025 Josh Holtrop
 
 MIT License
 

README.md

@@ -9,7 +9,7 @@ It supports the following features:
   * multi-threaded job execution
   * auto-configuration
   * built-in builders for several common operations
-  * out-of-the-box support for C, C++, and D languages
+  * out-of-the-box support for Assembly, C, C++, D, and LLVM
   * extensibility for other languages or custom builders
   * compatible with Windows, Linux, OS X, and FreeBSD
   * colorized output with build progress

Rakefile.rb

@@ -32,11 +32,12 @@ end
 # useful for coverage information.
 desc "Dist Specs"
 task :dspec, [:example_string] => :build_dist do |task, args|
+  FileUtils.rm_rf("test")
   FileUtils.mkdir_p("test")
   FileUtils.cp("dist/rscons", "test/rscons.rb")
-  ENV["dist_specs"] = "1"
+  ENV["rscons_dist_specs"] = "1"
   Rake::Task["spec"].execute(args)
-  ENV.delete("dist_specs")
+  ENV.delete("rscons_dist_specs")
   FileUtils.rm_f(Dir.glob(".rscons-*"))
 end
 

UPGRADING.md

@@ -0,0 +1,10 @@
+# Upgrading
+
+## v3.2.0
+
+- Replace any calls to `env.CFile()` builder with `env.Lex()` or `env.Yacc()` as required.
+
+## v3.0.0
+
+- Move `build` block contents outside of `build` block and remove `build` call.
+- Replace `Environment.new()` calls with `env()`.

build_tests/cfile/Rsconscript

@@ -1,4 +0,0 @@
-env do |env|
-  env.CFile("lexer.c", "lexer.l")
-  env.CFile("parser.c", "parser.y")
-end

build_tests/cfile/error_unknown_extension.rb

@@ -1,3 +0,0 @@
-env do |env|
-  env.CFile("file.c", "foo.bar")
-end

build_tests/clone_env/Rsconscript

@@ -1,10 +1,10 @@
-debug = env(echo: :command) do |env|
+debug = env("dbg", echo: :command) do |env|
   env['CFLAGS'] = '-O2'
   env['CPPFLAGS'] = '-DSTRING="Debug Version"'
   env.Program('program-debug.exe', Dir['src/*.c'])
 end
 
-release = debug.clone do |env|
+release = debug.clone("rls") do |env|
   env["CPPFLAGS"] = '-DSTRING="Release Version"'
   env.Program('program-release.exe', Dir['src/*.c'])
 end

build_tests/clone_env/clone_all.rb

@@ -1,4 +1,4 @@
-env1 = env(echo: :command) do |env|
+env1 = env("e1", echo: :command) do |env|
   env['CFLAGS'] = '-O2'
   env.add_build_hook do |builder|
     builder.vars['CPPFLAGS'] = '-DSTRING="Hello"'
@@ -9,6 +9,6 @@ env1 = env(echo: :command) do |env|
   env.Program('program.exe', Dir['src/*.c'])
 end
 
-env2 = env1.clone do |env|
+env2 = env1.clone("e2") do |env|
   env.Program('program2.exe', Dir['src/*.c'])
 end

build_tests/configure/check_cfg_no_pkg_config.rb

@@ -0,0 +1,5 @@
+ENV["PATH"] = ""
+
+configure do
+  check_cfg package: "mypackage"
+end

build_tests/configure/check_d_compiler_find_first.rb

@@ -1,3 +1,3 @@
 configure do
-  check_d_compiler "gdc", "ldc2"
+  check_d_compiler "gdc", "ldc2", "ldc"
 end

build_tests/configure/check_lib_with_ldc.rb

@@ -0,0 +1,8 @@
+configure do
+  check_d_compiler "ldc2"
+  check_lib "z"
+end
+
+env(echo: :command) do |env|
+  env.Program("simple.exe", "simple.d")
+end

build_tests/d/Rsconscript

@@ -3,5 +3,6 @@ configure do
 end
 
 env(echo: :command) do |env|
-  env.Program("hello-d.exe", glob("*.d"))
+  env["D_IMPORT_PATH"] << "src"
+  env.Program("hello-d.exe", glob("src/*.d"))
 end

build_tests/d/build-ldc2.rb

@@ -3,5 +3,6 @@ configure do
 end
 
 env(echo: :command) do |env|
-  env.Program("hello-d.exe", glob("*.d"))
+  env["D_IMPORT_PATH"] << "src"
+  env.Program("hello-d.exe", glob("src/*.d"))
 end

build_tests/d/link_objects.rb

@@ -1,5 +1,6 @@
 env(echo: :command) do |env|
-  env.Object("main.o", "main.d")
-  env.Object("mod.o", "mod.d")
+  env["LD_LIBRARY_PATH"] << "src"
+  env.Object("main.o", "src/main.d")
+  env.Object("mod.o", "src/mod.d")
   env.Program("hello-d.exe", ["main.o", "mod.o"])
 end

build_tests/lex_yacc/Rsconscript

@@ -0,0 +1,4 @@
+env do |env|
+  env.Lex("lexer.c", "lexer.l")
+  env.Yacc("parser.c", "parser.y")
+end

build_tests/llvm/Rsconscript

@@ -0,0 +1,4 @@
+env do |env|
+  env["LLVMAS_FLAGS"] += %w[-Wno-override-module]
+  env.Program("llvmtest.exe", %w[main.c one.ll])
+end

build_tests/llvm/direct.rb

@@ -0,0 +1,8 @@
+configure do
+  check_c_compiler "clang"
+end
+
+env do |env|
+  env["LLVMAS_FLAGS"] += %w[-Wno-override-module]
+  env.Program("llvmtest.exe", %w[one.ll two.ll main2.c], direct: true)
+end

build_tests/llvm/main.c

@@ -0,0 +1,6 @@
+extern int one(void);
+
+int main(int argc, char * argv[])
+{
+    return one();
+}

build_tests/llvm/main2.c

@@ -0,0 +1,9 @@
+extern int one(void);
+extern int two(void);
+
+int main(int argc, char * argv[])
+{
+    one();
+    two();
+    return 0;
+}

build_tests/llvm/one.ll

@@ -0,0 +1,9 @@
+@str = private unnamed_addr constant [12 x i8] c"hello world\00"
+
+declare i32 @puts(ptr nocapture) nounwind
+
+define i32 @one()
+{
+    call i32 @puts(ptr @str)
+    ret i32 0
+}

build_tests/llvm/two.ll

@@ -0,0 +1,9 @@
+@str = private unnamed_addr constant [12 x i8] c"hello again\00"
+
+declare i32 @puts(ptr nocapture) nounwind
+
+define i32 @two()
+{
+    call i32 @puts(ptr @str)
+    ret i32 0
+}

build_tests/simple/build_root_source_path.rb

@@ -0,0 +1,13 @@
+env("e", echo: :command) do |env|
+  source_file = "#{env.build_root}/src/foo.c"
+  FileUtils.mkdir_p(File.dirname(source_file))
+  File.open(source_file, "w") do |fh|
+    fh.puts(<<-EOF)
+    int main()
+    {
+      return 29;
+    }
+    EOF
+  end
+  env.Program("foo.exe", source_file)
+end

build_tests/simple/builder_wait_for_builder.rb

@@ -1,7 +1,7 @@
 class MyObject < Rscons::Builder
   def run(options)
     if @builder
-      if File.exists?(@target)
+      if File.exist?(@target)
         true
       else
         false

build_tests/simple/user_dep_build_order.rb

@@ -4,7 +4,7 @@ class TestBuilder < Rscons::Builder
       true
     else
       if @target == "two"
-        return false unless File.exists?("one")
+        return false unless File.exist?("one")
       end
       wait_time = @env.expand_varref("${wait_time}", @vars)
       @command = ["ruby", "-e", "require 'fileutils'; sleep #{wait_time}; FileUtils.touch('#{@target}');"]

build_tests/two_sources/assuffix.rb

@@ -3,5 +3,5 @@ env do |env|
   env["CFLAGS"] += %w[-S]
   env.Object("one.ssss", "one.c", "CPPFLAGS" => ["-DONE"])
   env.Object("two.sss", "two.c")
-  env.Program("two_sources.exe", %w[one.ssss two.sss], "ASFLAGS" => env["ASFLAGS"] + %w[-x assembler])
+  env.Program("two_sources.exe", %w[one.ssss two.sss], "ASFLAGS" => env["ASFLAGS"] + %w[-x assembler-with-cpp])
 end

build_tests/typical/binary_matching_folder.rb

@@ -0,0 +1,4 @@
+env "src" do |env|
+  env["CPPPATH"] += glob("src/**")
+  env.Program("^/src", glob("src/**/*.c"))
+end

build_tests/typical/phonies.rb

@@ -0,0 +1,15 @@
+class Custom < Rscons::Builder
+  def run(options)
+    print_run_message("#{name} #{target}", nil)
+    true
+  end
+end
+
+env do |env|
+  env.add_builder(Custom)
+  env.Custom("t3", :phony1)
+  env.Custom(:phony1, "t2")
+  env.Custom("t2", :phony2)
+  env.Custom(:phony2, "t1")
+  env.Custom("t1", [])
+end

build_tests/variants/error_unnamed_environment.rb

@@ -0,0 +1,13 @@
+variant "debug"
+variant "release"
+
+with_variants do
+  env do |env|
+    if variant("debug")
+      env["CPPDEFINES"] << "DEBUG"
+    else
+      env["CPPDEFINES"] << "NDEBUG"
+    end
+    env.Program("^/prog.exe", "prog.c")
+  end
+end

doc/user_guide.md

@@ -6,7 +6,7 @@ It supports the following features:
   * multi-threaded job execution
   * auto-configuration
   * built-in builders for several common operations
-  * out-of-the-box support for C, C++, and D languages
+  * out-of-the-box support for Assembly, C, C++, D, and LLVM
   * extensibility for other languages or custom builders
   * compatible with Windows, Linux, OS X, and FreeBSD
   * colorized output with build progress
@@ -265,21 +265,17 @@ which they were added.
 Example:
 
 ```ruby
-task "build" do
-  env do |env|
-    env.Program("^^/proj.elf", glob("src/**/*.c"))
-  end
+proj_env = env do |env|
+  env.Program("^/proj.elf", glob("src/**/*.c"))
 end
 
-task "flash", deps: "build" do
-  sh "nrfjprog", "-f", "NRF52", "--program", env.expand("^^/proj.elf")
+task "flash" do
+  sh "nrfjprog", "-f", "NRF52", "--program", proj_env.expand("^/proj.elf")
 end
 ```
 
-In this example, the `flash` task depends on the `build` task.
-So if the project had not yet been built, and the user executes
-`./rscons flash`, the project would first be built and then flashed to the
-target.
+In this example, the `flash` task would first build the proj.elf target and
+then flash it to target with the nrfjprog program.
 
 If the `task` method is called again with the name of an already existing task,
 the task is not overwritten, but rather modified.
@@ -287,6 +283,34 @@ Any newly specified dependencies are added to the current dependencies.
 Any action block is appended to the task's list of action blocks to execute
 when the task is executed.
 
+For example, with the `Rsconscript`:
+
+```ruby
+task "a" do
+  puts "A"
+end
+
+task "b" do
+  puts "B"
+end
+
+task "c", depends: "a" do
+  puts "C1"
+end
+
+task "c", depends: "b" do
+  puts "C2"
+end
+```
+
+The following behavior is observed:
+
+    $ ./rscons c
+    A
+    B
+    C1
+    C2
+
 Note that for a simple project, the build script may not need to define any
 tasks at all and could just make use of the Rscons built-in default task (see
 ${#Default Task}).
@@ -378,7 +402,7 @@ argument (task name) automatically filled in by the shortcut method.
 For example:
 
 ```ruby
-default deps: "unpack_compiler" do
+default depends: "unpack_compiler" do
   puts "default task"
 end
 ```
@@ -386,7 +410,7 @@ end
 is equivalent to:
 
 ```ruby
-task "default", deps: "unpack_compiler" do
+task "default", depends: "unpack_compiler" do
   puts "default task"
 end
 ```
@@ -463,11 +487,11 @@ task "build" do
   ...
 end
 
-task "flash" do
+task "flash", depends: "build" do
   ...
 end
 
-default deps: "build"
+default depends: "build"
 ```
 
 Then when the user runs `./rscons` the "build" task will be executed.
@@ -901,11 +925,11 @@ There are several default builders that are built-in to Rscons:
 
   * `Command`, which executes a user-defined command to produce the target.
   * `Copy`, which copies files or directories to a specified destination.
-  * `CFile`, which builds a C or C++ source file from a lex or yacc input file.
   * `Directory`, which creates a directory.
   * `Disassemble`, which disassembles an object file to a disassembly listing.
   * `Install`, which installs files or directories to a specified destination.
   * `InstallDirectory`, which creates a directory in an install destination.
+  * `Lex`, which builds a source file from a lex input file.
   * `Library`, which collects object files into a static library archive file.
   * `Object`, which compiles source files to produce an object file.
   * `Preprocess`, which invokes the C/C++ preprocessor on a source file.
@@ -915,6 +939,7 @@ There are several default builders that are built-in to Rscons:
   * `SharedObject`, which compiles source files to produce an object file, in a
     way that is able to be used to create a shared library.
   * `Size`, which runs the 'size' utility on an executable file.
+  * `Yacc`, which builds a source file from a yacc input file.
 
 ####> The Command Builder
 
@@ -941,17 +966,6 @@ The `Command` builder supports the following construction variables:
     `CMD_STDOUT` is expanded for variable references, so the token `${_TARGET}`
     can be used, for example.
 
-####> The CFile Builder
-
-```ruby
-env.CFile(target, source)
-# Example
-env.CFile("^/parser/parser.c", "parser.y")
-```
-
-The `CFile` builder will generate a C or C++ source file from a lex (.l, .ll)
-or yacc (.y, .yy) input file.
-
 ####> The Copy Builder
 
 ```ruby
@@ -1024,6 +1038,17 @@ the `InstallDirectory` builder.
 The `uninstall` task removes targets created by the `InstallDirectory` builder
 but not by the `Directory` builder.
 
+####> The Lex Builder
+
+```ruby
+env.Lex(target, source)
+# Example
+env.Lex("^/lexer.c", "lexer.l")
+```
+
+The `Lex` builder will generate a source file from a lex (.l, .ll)
+input file.
+
 ####> The Library Builder
 
 ```ruby
@@ -1154,6 +1179,17 @@ stores its output in the target file.
 The size executable can be specified with the `SIZE` construction variable,
 and flags can be specified with `SIZEFLAGS`.
 
+####> The Yacc Builder
+
+```ruby
+env.Yacc(target, source)
+# Example
+env.Yacc("^/parser.c", "parser.y")
+```
+
+The `Yacc` builder will generate a source file from a yacc (.y, .yy)
+input file.
+
 ###> Phony Targets
 
 Rscons supports phony build targets.
@@ -1272,10 +1308,10 @@ It iterates through each enabled variant and calls the given block.
 In this example, the block would be called twice, once with the "kde" variant
 active, and the second time with the "gnome" variant active.
 
-Each `env()` call creates an Environment, so two environments are created.
+Each `env` method call creates an Environment, so two environments are created.
 When an Environment is created within a `with_variants` block, the
-Environment's name has the active variant(s) appended to the given Environment
-name (if any), and separated by a "-".
+Environment's build directory name has the active variant(s) keys appended to
+the given Environment name, and separated by a "-".
 
 In this example, a "prog-kde" Environment would be created with build root
 build/prog-kde and -DKDE would be passed to the compiler when compiling each
@@ -1284,6 +1320,29 @@ Next a "prog-gnome" Environment would be created with build root
 build/prog-gnome and -DGNOME would be passed to the compiler when compiling
 the sources.
 
+The key for a variant is the variant's name by default but can be overridden by
+passing a `:key` value to the `variant` method.
+A `nil` value for the `:key` parameter will omit that variant from appearing
+in the environment's build directory name.
+For example:
+
+```ruby
+variant "debug"
+variant "release", key: nil
+
+with_variants do
+  env "prog" do |env|
+  end
+end
+```
+
+In this example, one "prog" environment will be created for the "debug" variant
+with the build directory "prog-debug", and another "prog" environment will be
+created for the "release" variant with the build directory "prog".
+The build directory for the release variant of the "prog" environment is just
+"prog" instead of "prog-release" because the key for the "release" variant is
+set to `nil`.
+
 Variants are enabled by default, but can be disabled by passing a `false` value
 to the `:default` option of the `variant` method.
 For example:
@@ -1558,8 +1617,8 @@ end
 The `Object` and `SharedObject` builders that ship with Rscons have an API that
 allows the user to register extra languages that can be suppored by the
 builders.
-In fact, the built-in support for assembly, C, C++, and D compilation all make
-use of this built-in API.
+In fact, the built-in support for assembly, C, C++, D, and LLVM compilation
+all make use of this built-in API.
 To see an example of how this API is used, see the
 `lib/rscons/builders/lang/*.rb` files in the Rscons source repository.
 For example, here is how the C++ language is registered:
@@ -1868,6 +1927,15 @@ env do |env|
 end
 ```
 
+### Example: Building a Program from C and LLVM Sources
+
+```ruby
+env do |env|
+  env["CFLAGS"] << "-Wall"
+  env.Program("program", glob("src/**/*.{c,ll}"))
+end
+```
+
 ### Example: Cloning an Environment
 
 ```ruby
@@ -1935,7 +2003,7 @@ end
 
 ```ruby
 env do |env|
-  env.CFile("^/parser.tab.cc", "parser.yy")
+  env.Yacc("^/parser.tab.cc", "parser.yy")
 end
 ```
 

lib/rscons.rb

@@ -23,20 +23,23 @@ module Rscons
   # Names of the default builders which will be added to all newly created
   # {Environment} objects.
   DEFAULT_BUILDERS = [
-    :CFile,
+    :Barrier,
     :Command,
     :Copy,
     :Directory,
     :Disassemble,
     :Install,
     :InstallDirectory,
+    :Lex,
     :Library,
     :Object,
+    :Precompile,
     :Preprocess,
     :Program,
     :SharedLibrary,
     :SharedObject,
     :Size,
+    :Yacc,
   ]
 
   # Class to represent a fatal error during an Rscons operation.
@@ -65,6 +68,13 @@ module Rscons
       target.is_a?(Symbol)
     end
 
+    # Generate a random phony target name.
+    #
+    # @return [Symbol] Phony target name.
+    def gen_phony_target
+      ("t" + sprintf("%08x", rand(1_000_000..4_000_000_000))).to_sym
+    end
+
     # Return the system shell and arguments for executing a shell command.
     #
     # @return [Array<String>] The shell and flag.
@@ -135,25 +145,29 @@ require_relative "rscons/builders/mixins/object_deps"
 require_relative "rscons/builders/mixins/program"
 
 # default builders
-require_relative "rscons/builders/cfile"
+require_relative "rscons/builders/barrier"
 require_relative "rscons/builders/command"
 require_relative "rscons/builders/copy"
 require_relative "rscons/builders/directory"
 require_relative "rscons/builders/disassemble"
+require_relative "rscons/builders/lex"
 require_relative "rscons/builders/library"
 require_relative "rscons/builders/object"
+require_relative "rscons/builders/precompile"
 require_relative "rscons/builders/preprocess"
 require_relative "rscons/builders/program"
 require_relative "rscons/builders/shared_library"
 require_relative "rscons/builders/shared_object"
 require_relative "rscons/builders/simple_builder"
 require_relative "rscons/builders/size"
+require_relative "rscons/builders/yacc"
 
 # language support
 require_relative "rscons/builders/lang/asm"
 require_relative "rscons/builders/lang/c"
 require_relative "rscons/builders/lang/cxx"
 require_relative "rscons/builders/lang/d"
+require_relative "rscons/builders/lang/llvm_asm"
 
 # Unbuffer $stdout
 $stdout.sync = true

lib/rscons/application.rb

@@ -237,7 +237,7 @@ module Rscons
       cache = Cache.instance
       cache.targets(true).each do |target|
         cache.remove_target(target)
-        next unless File.exists?(target)
+        next unless File.exist?(target)
         puts "Removing #{target}" if verbose
         FileUtils.rm_f(target)
       end
@@ -258,6 +258,14 @@ module Rscons
     #
     # @param name [String]
     #   Variant name.
+    # @param options [Hash]
+    #   Optional parameters.
+    # @option options [String] :default
+    #   Whether the variant is enabled by default (default: true).
+    # @option options [String] :key
+    #   Variant key, used to name an Environment's build directory. If nil,
+    #   this variant will not contribute to the Environment's build directory
+    #   name.
     def variant(name, options = {})
       if @active_variants
         !!@active_variants.find {|variant| variant[:name] == name}
@@ -294,6 +302,15 @@ module Rscons
     end
 
     # Create a variant group.
+    #
+    # @overload variant_group(name, options = {})
+    #   @param name [String]
+    #     Variant group name (optional).
+    #   @param options [Hash]
+    #     Optional variant group parameters.
+    # @overload variant_group(options = {})
+    #   @param options [Hash]
+    #     Optional variant group parameters.
     def variant_group(*args, &block)
       if args.first.is_a?(String)
         name = args.slice!(0)

lib/rscons/builder_set.rb

@@ -27,8 +27,9 @@ module Rscons
       #   env.Directory("dest")
       #   env.Install("dest", "bin")
       #   env.Install("dest", "share")
-      self[builder.target] ||= []
-      self[builder.target] << builder
+      target = Util.absolute_path(builder.target)
+      self[target] ||= []
+      self[target] << builder
     end
 
     # Return the number of remaining build steps.
@@ -37,7 +38,7 @@ module Rscons
     #   The number of remaining build steps.
     def build_steps_remaining
       self.reduce(0) do |result, (target, builders)|
-        result + builders.size
+        result + builders.count {|b| !b.is_a?(Rscons::Builders::Barrier)}
       end
     end
 
@@ -55,9 +56,14 @@ module Rscons
     def get_next_builder_to_run(targets_still_building)
       to_build = self.find do |target, builders|
         deps = builders.first.sources + (@build_dependencies[target] || []).to_a
+        deps.map! {|dep| Util.absolute_path(dep)}
         # All dependencies must have been built for this target to be ready to
         # build.
         deps.all? do |dep|
+          puts "BuilderSet: #{target}: dep #{dep}"
+          puts "  still building? #{targets_still_building.include?(dep)}"
+          puts "  self.include? #{self.include?(dep)}"
+          puts "  @side_effects.include? #{@side_effects.include?(dep)}"
           !(targets_still_building.include?(dep) ||
             self.include?(dep) ||
             @side_effects.include?(dep))
@@ -66,6 +72,7 @@ module Rscons
 
       if to_build
         target, builders = *to_build
+        puts "Selecting #{target.inspect} to build"
         builder = builders.first
         if builders.size > 1
           builders.slice!(0)

lib/rscons/builders/barrier.rb

@@ -0,0 +1,15 @@
+module Rscons
+  module Builders
+    # The Barrier builder does not perform any action. It exists as a builder
+    # on which to place dependencies to ensure that each of its sources are
+    # built before any build targets which depend on the barrier build target.
+    class Barrier < Builder
+
+      # Run the builder.
+      def run(options)
+        true
+      end
+
+    end
+  end
+end

lib/rscons/builders/cfile.rb

@@ -1,35 +0,0 @@
-module Rscons
-  module Builders
-    # Build a C or C++ source file given a lex (.l, .ll) or yacc (.y, .yy)
-    # input file.
-    #
-    # Examples::
-    #   env.CFile("parser.tab.cc", "parser.yy")
-    #   env.CFile("lex.yy.cc", "parser.ll")
-    class CFile < Builder
-
-      # Run the builder to produce a build target.
-      def run(options)
-        if @command
-          finalize_command
-        else
-          @vars["_TARGET"] = @target
-          @vars["_SOURCES"] = @sources
-          case
-          when @sources.first.end_with?(*@env.expand_varref("${LEXSUFFIX}"))
-            cmd = "LEX"
-            message = "Generating lexer"
-          when @sources.first.end_with?(*@env.expand_varref("${YACCSUFFIX}"))
-            cmd = "YACC"
-            message = "Generating parser"
-          else
-            raise "Unknown source file #{@sources.first.inspect} for CFile builder"
-          end
-          command = @env.build_command("${#{cmd}_CMD}", @vars)
-          standard_command("#{message} from <source>#{Util.short_format_paths(@sources)}<reset> => <target>#{@target}<reset>", command)
-        end
-      end
-
-    end
-  end
-end

lib/rscons/builders/copy.rb

@@ -14,14 +14,14 @@ module Rscons
       # Run the builder to produce a build target.
       def run(options)
         target_is_dir = (@sources.length > 1) ||
-                        Dir.exists?(@sources.first) ||
-                        Dir.exists?(@target)
+                        Dir.exist?(@sources.first) ||
+                        Dir.exist?(@target)
         outdir = target_is_dir ? @target : File.dirname(@target)
         # Collect the list of files to copy over.
         file_map = {}
         if target_is_dir
           @sources.each do |src|
-            if Dir.exists? src
+            if Dir.exist? src
               Dir.glob("#{src}/**/*", File::FNM_DOTMATCH).select do |f|
                 File.file?(f)
               end.each do |subfile|
@@ -50,7 +50,7 @@ module Rscons
           end
           @cache.register_build(dest, :Copy, [src], @env, install: @install_builder)
         end
-        (target_is_dir ? Dir.exists?(@target) : File.exists?(@target)) ? true : false
+        (target_is_dir ? Dir.exist?(@target) : File.exist?(@target)) ? true : false
       end
 
     end

lib/rscons/builders/directory.rb

@@ -14,7 +14,7 @@ module Rscons
       def run(options)
         if File.directory?(@target)
           true
-        elsif File.exists?(@target)
+        elsif File.exist?(@target)
           Ansi.write($stderr, :red, "Error: `#{@target}' already exists and is not a directory", :reset, "\n")
           false
         else

lib/rscons/builders/lang/llvm_asm.rb

@@ -0,0 +1,10 @@
+Rscons::Builders::Object.register(
+  command: "${LLVMAS_CMD}",
+  direct_command: "${LLVMAS_CMD:direct}",
+  suffix: "${LLVMAS_SUFFIX}",
+  short_description: "Assembling")
+Rscons::Builders::SharedObject.register(
+  command: "${LLVMAS_CMD}",
+  direct_command: "${LLVMAS_CMD:direct}",
+  suffix: "${LLVMAS_SUFFIX}",
+  short_description: "Assembling")

lib/rscons/builders/lex.rb

@@ -0,0 +1,24 @@
+module Rscons
+  module Builders
+    # Build a source file given a lex input file.
+    #
+    # Examples::
+    #   env.Lex("lex.c", "parser.l")
+    #   env.Lex("lex.cc", "parser.ll")
+    class Lex < Builder
+
+      # Run the builder to produce a build target.
+      def run(options)
+        if @command
+          finalize_command
+        else
+          @vars["_TARGET"] = @target
+          @vars["_SOURCES"] = @sources
+          command = @env.build_command("${LEX_CMD}", @vars)
+          standard_command("Generating lexer source from <source>#{Util.short_format_paths(@sources)}<reset> => <target>#{@target}<reset>", command)
+        end
+      end
+
+    end
+  end
+end

lib/rscons/builders/mixins/depfile.rb

@@ -8,7 +8,7 @@ module Rscons
         # dependency file.
         def finalize_command_with_depfile
           deps = @sources
-          if File.exists?(@vars["_DEPFILE"])
+          if File.exist?(@vars["_DEPFILE"])
             deps += Util.parse_dependency_file(@vars["_DEPFILE"])
           end
           @cache.register_build(@target, @command, deps.uniq, @env)

lib/rscons/builders/mixins/object_deps.rb

@@ -15,11 +15,16 @@ module Rscons
         #   List of paths to the object or static library dependencies.
         def register_object_deps(builder_class)
           suffixes = @env.expand_varref(["${OBJSUFFIX}", "${LIBSUFFIX}"], @vars)
+          barrier_target = @env.setup_precompile(@sources)
           @sources.map do |source|
             if source.end_with?(*suffixes)
               source
             else
-              @env.register_dependency_build(@target, source, suffixes.first, @vars, builder_class)
+              object_file_path = @env.register_dependency_build(@target, source, suffixes.first, @vars, builder_class)
+              if barrier_target
+                @env.depends(object_file_path, barrier_target)
+              end
+              object_file_path
             end
           end
         end

lib/rscons/builders/precompile.rb

@@ -0,0 +1,29 @@
+module Rscons
+  module Builders
+    # The Precompile builder generates .di interface files from .d source files
+    # for D.
+    class Precompile < Builder
+
+      # Run the builder to produce a build target.
+      def run(options)
+        if @command
+          finalize_command
+        else
+          if @sources.find {|s| s.end_with?(*@env.expand_varref("${DSUFFIX}", @vars))}
+            pcc = @env.expand_varref("${DC}")
+            if pcc =~ /ldc/
+              dpc_cmd = "${DPC_CMD:ldc}"
+            else
+              dpc_cmd = "${DPC_CMD:gdc}"
+            end
+            @vars["_TARGET"] = @target
+            @vars["_SOURCES"] = @sources
+            command = @env.build_command(dpc_cmd, @vars)
+            standard_command("Precompile <source>#{Util.short_format_paths(@sources)}<reset>", command)
+          end
+        end
+      end
+
+    end
+  end
+end

lib/rscons/builders/yacc.rb

@@ -0,0 +1,24 @@
+module Rscons
+  module Builders
+    # Build a source file given a yacc input file.
+    #
+    # Examples::
+    #   env.Yacc("parser.c", "parser.y")
+    #   env.Yacc("parser.cc", "parser.yy")
+    class Yacc < Builder
+
+      # Run the builder to produce a build target.
+      def run(options)
+        if @command
+          finalize_command
+        else
+          @vars["_TARGET"] = @target
+          @vars["_SOURCES"] = @sources
+          command = @env.build_command("${YACC_CMD}", @vars)
+          standard_command("Generating parser source from <source>#{Util.short_format_paths(@sources)}<reset> => <target>#{@target}<reset>", command)
+        end
+      end
+
+    end
+  end
+end

lib/rscons/cache.rb

@@ -142,14 +142,16 @@ module Rscons
     #   - each cached dependency file's current checksum matches the checksum
     #     stored in the cache file
     def up_to_date?(targets, command, deps, env, options = {})
+      deps.map! {|dep| Util.absolute_path(dep)}
       Array(targets).each do |target|
+        target = Util.absolute_path(target)
         cache_key = get_cache_key(target)
 
         unless Rscons.phony_target?(target)
           # target file must exist on disk
-          unless File.exists?(target)
-            if options[:debug]
-              puts "Target #{target} needs rebuilding because it does not exist on disk"
+          unless File.exist?(target)
+            if options[:debug] || ENV["RSCONS_CACHE_DEBUG"]
+              puts "Cache: up_to_date?: Target #{target} needs rebuilding because it does not exist on disk"
             end
             return false
           end
@@ -157,8 +159,8 @@ module Rscons
 
         # target must be registered in the cache
         unless @cache["targets"].has_key?(cache_key)
-          if options[:debug]
-            puts "Target #{target} needs rebuilding because there is no cached build information for it"
+          if options[:debug] || ENV["RSCONS_CACHE_DEBUG"]
+            puts "Cache: up_to_date?: Target #{target} needs rebuilding because there is no cached build information for it"
           end
           return false
         end
@@ -166,8 +168,8 @@ module Rscons
         unless Rscons.phony_target?(target)
           # target must have the same checksum as when it was built last
           unless @cache["targets"][cache_key]["checksum"] == lookup_checksum(target)
-            if options[:debug]
-              puts "Target #{target} needs rebuilding because it has been changed on disk since being built last"
+            if options[:debug] || ENV["RSCONS_CACHE_DEBUG"]
+              puts "Cache: up_to_date?: Target #{target} needs rebuilding because it has been changed on disk since being built last"
             end
             return false
           end
@@ -175,8 +177,8 @@ module Rscons
 
         # command used to build target must be identical
         unless @cache["targets"][cache_key]["command"] == Digest::MD5.hexdigest(command.inspect)
-          if options[:debug]
-            puts "Target #{target} needs rebuilding because the command used to build it has changed"
+          if options[:debug] || ENV["RSCONS_CACHE_DEBUG"]
+            puts "Cache: up_to_date?: Target #{target} needs rebuilding because the command used to build it has changed"
           end
           return false
         end
@@ -186,16 +188,16 @@ module Rscons
         if options[:strict_deps]
           # depedencies passed in must exactly equal those in the cache
           unless deps == cached_deps_fnames
-            if options[:debug]
-              puts "Target #{target} needs rebuilding because the :strict_deps option is given and the set of dependencies does not match the previous set of dependencies"
+            if options[:debug] || ENV["RSCONS_CACHE_DEBUG"]
+              puts "Cache: up_to_date?: Target #{target} needs rebuilding because the :strict_deps option is given and the set of dependencies does not match the previous set of dependencies"
             end
             return false
           end
         else
           # all dependencies passed in must exist in cache (but cache may have more)
           unless (Set.new(deps) - Set.new(cached_deps_fnames)).empty?
-            if options[:debug]
-              puts "Target #{target} needs rebuilding because there are new dependencies"
+            if options[:debug] || ENV["RSCONS_CACHE_DEBUG"]
+              puts "Cache: up_to_date?: Target #{target} needs rebuilding because there are new dependencies"
             end
             return false
           end
@@ -203,11 +205,12 @@ module Rscons
 
         # set of user dependencies must match
         user_deps = env.get_user_deps(target) || []
+        user_deps.map! {|dep| Util.absolute_path(dep)}
         cached_user_deps = @cache["targets"][cache_key]["user_deps"] || []
         cached_user_deps_fnames = cached_user_deps.map { |dc| dc["fname"] }
         unless user_deps == cached_user_deps_fnames
-          if options[:debug]
-            puts "Target #{target} needs rebuilding because the set of user-specified dependency files has changed"
+          if options[:debug] || ENV["RSCONS_CACHE_DEBUG"]
+            puts "Cache: up_to_date?: Target #{target} needs rebuilding because the set of user-specified dependency files has changed"
           end
           return false
         end
@@ -215,12 +218,14 @@ module Rscons
         # all cached dependencies must have their checksums match
         (cached_deps + cached_user_deps).each do |dep_cache|
           unless dep_cache["checksum"] == lookup_checksum(dep_cache["fname"])
-            if options[:debug]
-              puts "Target #{target} needs rebuilding because dependency file #{dep_cache["fname"]} has changed"
+            if options[:debug] || ENV["RSCONS_CACHE_DEBUG"]
+              puts "Cache: up_to_date?: Target #{target} needs rebuilding because dependency file #{dep_cache["fname"]} has changed"
             end
             return false
           end
         end
+
+        puts "Cache: up_to_date?: Target #{target} is up to date" if ENV["RSCONS_CACHE_DEBUG"]
       end
 
       true
@@ -247,22 +252,26 @@ module Rscons
     # @return [void]
     def register_build(targets, command, deps, env, options = {})
       Array(targets).each do |target|
+        target = Util.absolute_path(target)
         target_checksum =
           if options[:side_effect] or Rscons.phony_target?(target)
             ""
           else
             calculate_checksum(target)
           end
+        puts "Cache: register_build(#{target}, #{target_checksum})"
         @cache["targets"][get_cache_key(target)] = {
           "command" => Digest::MD5.hexdigest(command.inspect),
           "checksum" => target_checksum,
           "deps" => deps.map do |dep|
+            dep = Util.absolute_path(dep)
             {
               "fname" => dep,
               "checksum" => lookup_checksum(dep),
             }
           end,
           "user_deps" => (env.get_user_deps(target) || []).map do |dep|
+            dep = Util.absolute_path(dep)
             {
               "fname" => dep,
               "checksum" => lookup_checksum(dep),
@@ -307,7 +316,7 @@ module Rscons
       parts.each_index do |i|
         next if parts[i] == ""
         subpath = File.join(*parts[0, i + 1])
-        unless File.exists?(subpath)
+        unless File.exist?(subpath)
           FileUtils.mkdir_p(subpath)
           @cache["directories"][subpath] = !!options[:install]
         end
@@ -381,6 +390,8 @@ module Rscons
     #
     # @return [String] The file's checksum.
     def lookup_checksum(file)
+      file = Util.absolute_path(file)
+      puts "Cache: lookup_checksum(#{file})" if ENV["RSCONS_CACHE_DEBUG"]
       @lookup_checksums[file] || calculate_checksum(file)
     end
 
@@ -390,7 +401,10 @@ module Rscons
     #
     # @return [String] The file's checksum.
     def calculate_checksum(file)
-      @lookup_checksums[file] = Digest::MD5.hexdigest(File.read(file, mode: "rb")) rescue ""
+      file = Util.absolute_path(file)
+      cs = Digest::MD5.hexdigest(File.read(file, mode: "rb")) rescue ""
+      puts "Cache: calculate_checksum(#{file}) = #{cs}" if ENV["RSCONS_CACHE_DEBUG"]
+      @lookup_checksums[file] = cs
     end
 
   end

lib/rscons/cli.rb

@@ -118,13 +118,13 @@ module Rscons
 
       # Find the build script.
       if rsconscript
-        unless File.exists?(rsconscript)
+        unless File.exist?(rsconscript)
           $stderr.puts "Cannot read #{rsconscript}"
           return 1
         end
       else
         rsconscript = DEFAULT_RSCONSCRIPTS.find do |f|
-          File.exists?(f)
+          File.exist?(f)
         end
       end
 

lib/rscons/configure_op.rb

@@ -1,5 +1,6 @@
 require "fileutils"
 require "open3"
+require "set"
 
 module Rscons
   # Class to manage a configure operation.
@@ -10,9 +11,11 @@ module Rscons
     # @param script [Script]
     #   Build script.
     def initialize(script)
+      @tested_compilers = {}
       @work_dir = "#{Rscons.application.build_dir}/_configure"
       FileUtils.mkdir_p(@work_dir)
-      @log_fh = File.open("#{@work_dir}/config.log", "wb")
+      @log_file_name = "#{@work_dir}/config.log"
+      @log_fh = File.open(@log_file_name, "wb")
       cache = Cache.instance
       cache["failed_commands"] = []
       cache["configuration_data"] = {}
@@ -64,7 +67,13 @@ module Rscons
       cc = ccc.find do |cc|
         test_c_compiler(cc, options)
       end
-      complete(cc ? 0 : 1, options.merge(success_message: cc))
+      if cc
+        @tested_compilers["c"] ||= Set.new
+        @tested_compilers["c"] << cc
+      end
+      complete(cc ? 0 : 1, options.merge(
+        success_message: cc,
+        fail_message: "not found (checked #{ccc.join(", ")})"))
     end
 
     # Check for a working C++ compiler.
@@ -86,7 +95,13 @@ module Rscons
       cc = ccc.find do |cc|
         test_cxx_compiler(cc, options)
       end
-      complete(cc ? 0 : 1, options.merge(success_message: cc))
+      if cc
+        @tested_compilers["cxx"] ||= Set.new
+        @tested_compilers["cxx"] << cc
+      end
+      complete(cc ? 0 : 1, options.merge(
+        success_message: cc,
+        fail_message: "not found (checked #{ccc.join(", ")})"))
     end
 
     # Check for a working D compiler.
@@ -103,12 +118,18 @@ module Rscons
       end
       if cdc.empty?
         # Default D compiler search array.
-        cdc = %w[gdc ldc2]
+        cdc = %w[gdc ldc2 ldc]
       end
       dc = cdc.find do |dc|
         test_d_compiler(dc, options)
       end
-      complete(dc ? 0 : 1, options.merge(success_message: dc))
+      if dc
+        @tested_compilers["d"] ||= Set.new
+        @tested_compilers["d"] << dc
+      end
+      complete(dc ? 0 : 1, options.merge(
+        success_message: dc,
+        fail_message: "not found (checked #{cdc.join(", ")})"))
     end
 
     # Check for a package or configure program output.
@@ -118,7 +139,12 @@ module Rscons
       elsif program = options[:program]
         Ansi.write($stdout, "Checking '", :cyan, program, :reset, "'... ")
       end
-      program ||= "pkg-config"
+      unless program
+        program = "pkg-config"
+        unless Util.find_executable(program)
+          raise RsconsError.new("Error: executable '#{program}' not found")
+        end
+      end
       args = options[:args] || %w[--cflags --libs]
       command = [program, *args, package].compact
       stdout, _, status = log_and_test_command(command)
@@ -240,17 +266,36 @@ module Rscons
     def check_lib(lib, options = {})
       check_libpath = [nil] + (options[:check_libpath] || [])
       Ansi.write($stdout, "Checking for library '", :cyan, lib, :reset, "'... ")
-      File.open("#{@work_dir}/cfgtest.c", "wb") do |fh|
-        fh.puts <<-EOF
-          int main(int argc, char * argv[]) {
-            return 0;
-          }
-        EOF
+      if @tested_compilers["d"]
+        source_file = "#{@work_dir}/cfgtest.d"
+        File.open(source_file, "wb") do |fh|
+          fh.puts <<-EOF
+            int main() {
+              return 0;
+            }
+          EOF
+        end
+      else
+        source_file = "#{@work_dir}/cfgtest.c"
+        File.open(source_file, "wb") do |fh|
+          fh.puts <<-EOF
+            int main(int argc, char * argv[]) {
+              return 0;
+            }
+          EOF
+        end
+      end
+      ld = "${CC}"
+      %w[d cxx c].each do |language|
+        if @tested_compilers[language]
+          ld = @tested_compilers[language].first
+          break
+        end
       end
       vars = {
-        "LD" => "${CC}",
+        "LD" => ld,
         "LIBS" => [lib],
-        "_SOURCES" => "#{@work_dir}/cfgtest.c",
+        "_SOURCES" => source_file,
         "_TARGET" => "#{@work_dir}/cfgtest.exe",
       }
       status = 1
@@ -375,6 +420,8 @@ module Rscons
     #   A define to set (in CPPDEFINES) if the requested item is found.
     # @option options [String] :success_message
     #   Message to print on success (default "found").
+    # @option options [String] :fail_message
+    #   Message to print on failure (default "not found").
     def complete(status, options)
       success_message = options[:success_message] || "found"
       fail_message = options[:fail_message] || "not found"
@@ -398,7 +445,7 @@ module Rscons
           options[:on_fail].call
         end
         if should_fail
-          raise RsconsError.new("Configuration failed")
+          raise RsconsError.new("Configuration failed; log file written to #{@log_file_name}")
         end
       end
     end
@@ -482,8 +529,10 @@ module Rscons
           env = BasicEnvironment.new
           merge = {
             "DC" => dc,
-            "DCCMD" => env["DCCMD"].map {|e| e.sub(/^-o$/, "-of")},
-            "LDCMD" => env["LDCMD"].map {|e| e.sub(/^-o$/, "-of")},
+            "DC:-o" => "-of",
+            "LD:-o" => "-of",
+            "LIBDIRPREFIX" => "-L-L",
+            "LIBLINKPREFIX" => "-L-l",
             "DDEPGEN" => ["-deps=${_DEPFILE}"],
           }
           merge["OBJSUFFIX"] = [ldc_objsuffix]

lib/rscons/default_construction_variables.rb

@@ -35,21 +35,24 @@ module Rscons
     "CXXFLAGS" => [],
     "CXXSUFFIX" => %w[.cc .cpp .cxx .C],
     "DC" => "gdc",
-    "DCCMD" => %w[${DC} -c -o ${_TARGET} ${DDEPGEN} ${INCPREFIX}${D_IMPORT_PATH} ${DFLAGS} ${_SOURCES}],
-    "DCCMD:direct" => %w[${DC} -o ${_TARGET} ${DDEPGEN} ${INCPREFIX}${D_IMPORT_PATH} ${DFLAGS} ${LDFLAGS} ${_SOURCES} ${LIBDIRPREFIX}${LIBPATH} ${LIBLINKPREFIX}${LIBS}],
+    "DC:-o" => "-o",
+    "DCCMD" => %w[${DC} -c ${DC:-o} ${_TARGET} ${DDEPGEN} ${INCPREFIX}${D_IMPORT_PATH} ${DFLAGS} ${_SOURCES}],
+    "DCCMD:direct" => %w[${DC} ${DC:-o} ${_TARGET} ${DDEPGEN} ${INCPREFIX}${D_IMPORT_PATH} ${DFLAGS} ${LDFLAGS} ${_SOURCES} ${LIBDIRPREFIX}${LIBPATH} ${LIBLINKPREFIX}${LIBS}],
     "DDEPGEN" => %w[-MMD -MF ${_DEPFILE}],
     "DEPFILESUFFIX" => ".mf",
     "DFLAGS" => [],
     "DISASM_CMD" => %w[${OBJDUMP} ${DISASM_FLAGS} ${_SOURCES}],
     "DISASM_FLAGS" => %w[--disassemble --source],
+    "DPC_CMD:ldc" => %w[${DC} -H -Hf ${_TARGET} -o- ${INCPREFIX}${D_IMPORT_PATH} ${DFLAGS} ${_SOURCES}],
+    "DPC_CMD:gdc" => %w[${DC} -H -Hf ${_TARGET} -fsyntax-only ${INCPREFIX}${D_IMPORT_PATH} ${DFLAGS} ${_SOURCES}],
     "DSUFFIX" => %w[.d],
     "D_IMPORT_PATH" => [],
     "INCPREFIX" => "-I",
     "LD" => nil,
-    "LDCMD" => %w[${LD} -o ${_TARGET} ${LDFLAGS} ${_SOURCES} ${LIBDIRPREFIX}${LIBPATH} ${LIBLINKPREFIX}${LIBS}],
+    "LD:-o" => "-o",
+    "LDCMD" => %w[${LD} ${LD:-o} ${_TARGET} ${LDFLAGS} ${_SOURCES} ${LIBDIRPREFIX}${LIBPATH} ${LIBLINKPREFIX}${LIBS}],
     "LDFLAGS" => [],
     "LEX" => "flex",
-    "LEXSUFFIX" => %w[.l .ll],
     "LEX_CMD" => %w[${LEX} ${LEX_FLAGS} -o ${_TARGET} ${_SOURCES}],
     "LEX_FLAGS" => [],
     "LIBDIRPREFIX" => "-L",
@@ -57,6 +60,11 @@ module Rscons
     "LIBPATH" => [],
     "LIBS" => [],
     "LIBSUFFIX" => ".a",
+    "LLVMAS" => "clang",
+    "LLVMAS_CMD" => %w[${LLVMAS} -c -o ${_TARGET} ${LLVMAS_FLAGS} ${_SOURCES}],
+    "LLVMAS_CMD:direct" => %w[${LLVMAS} -o ${_TARGET} ${LLVMAS_FLAGS} ${LDFLAGS} ${_SOURCES} ${LIBDIRPREFIX}${LIBPATH} ${LIBLINKPREFIX}${LIBS}],
+    "LLVMAS_FLAGS" => [],
+    "LLVMAS_SUFFIX" => ".ll",
     "OBJDUMP" => "objdump",
     "OBJSUFFIX" => %w[.o],
     "PROGSUFFIX" => on_windows ? ".exe" : "",
@@ -84,7 +92,6 @@ module Rscons
     "SIZECMD" => %w[${SIZE} ${SIZEFLAGS} ${_SOURCES}],
     "SIZEFLAGS" => [],
     "YACC" => "bison",
-    "YACCSUFFIX" => %w[.y .yy],
     "YACC_CMD" => %w[${YACC} ${YACC_FLAGS} -o ${_TARGET} ${_SOURCES}],
     "YACC_FLAGS" => %w[-d],
   }

lib/rscons/environment.rb

@@ -74,15 +74,19 @@ module Rscons
     # Create an Environment object.
     def initialize(*args, &block)
       @id = self.class.get_id
-      if args.first.is_a?(String)
-        base_name = args.slice!(0)
-      else
-        base_name = "e.#{@id}"
-      end
       variant_keys = (Rscons.application.active_variants || []).map do |variant|
         variant[:key]
       end.compact
-      @name = [base_name, *variant_keys].join("-")
+      if args.first.is_a?(String)
+        base_name = args.slice!(0)
+        @name = [base_name, *variant_keys].join("-")
+        @build_root = "#{Rscons.application.build_dir}/#{@name}"
+      else
+        if variant_keys.size > 0
+          raise RsconsError.new("Error: an Environment with active variants must be given a name")
+        end
+        @build_root = Rscons.application.build_dir
+      end
       options = args.first || {}
       unless Cache.instance["configuration_data"]["configured"]
         raise "Project must be configured before creating an Environment"
@@ -114,8 +118,8 @@ module Rscons
         else
           :short
         end
-      @build_root = "#{Rscons.application.build_dir}/#{@name}"
       @n_threads = Rscons.application.n_threads
+      @build_steps = 0
       self.class.register(self)
       if block
         Environment.running_environment = self
@@ -276,7 +280,26 @@ module Rscons
       if extra_path = builder_class.extra_path
         extra_path = "/#{extra_path}"
       end
-      "#{@build_root}#{extra_path}/#{Util.make_relative_path("#{source_fname}#{suffix}")}".gsub("\\", "/")
+      source_fname = source_fname.gsub("\\", "/")
+      if extra_path.nil? && source_fname.start_with?("#{@build_root}/")
+        # If the source file is in the environment's build directory and no
+        # builder "extra path" is present, then just place the output file
+        # next to the source file.
+        "#{source_fname}#{suffix}"
+      else
+        "#{@build_root}/o#{extra_path}/#{Util.make_relative_path("#{source_fname}#{suffix}")}"
+      end
+    end
+
+    # Get a path under the build root for precompile outputs.
+    #
+    # @param end_path [String]
+    #   Path to append to precompile build root.
+    #
+    # @return [String]
+    #   Precompile directory name.
+    def get_pc_build_dir(end_path)
+      "#{@build_root}/pc/#{Util.make_relative_path(end_path)}"
     end
 
     # Build all build targets specified in the Environment.
@@ -359,6 +382,7 @@ module Rscons
           @builder_sets << build_builder_set
         end
         @builder_sets.last << builder
+        @build_steps += 1
         @build_targets[target] = builder
         builder
       else
@@ -376,7 +400,9 @@ module Rscons
       if target.is_a?(Builder)
         target = target.target
       end
-      target = expand(target.to_s)
+      unless Rscons.phony_target?(target)
+        target = Util.absolute_path(expand(target))
+      end
       user_deps = user_deps.map do |ud|
         if ud.is_a?(Builder)
           ud = ud.target
@@ -384,7 +410,11 @@ module Rscons
         expand(ud)
       end
       @user_deps[target] ||= []
-      @user_deps[target] = (@user_deps[target] + user_deps).uniq
+      user_deps.each do |ud|
+        unless @user_deps[target].include?(ud)
+          @user_deps[target] << Util.absolute_path(ud)
+        end
+      end
       build_after(target, user_deps)
     end
 
@@ -415,14 +445,16 @@ module Rscons
       targets = Array(targets)
       prerequisites = Array(prerequisites)
       targets.each do |target|
-        target = expand(target)
+        unless Rscons.phony_target?(target)
+          target = Util.absolute_path(expand(target))
+        end
         @registered_build_dependencies[target] ||= Set.new
         prerequisites.each do |prerequisite|
           if prerequisite.is_a?(Builder)
             prerequisite = prerequisite.target
           end
           prerequisite = expand(prerequisite)
-          @registered_build_dependencies[target] << prerequisite
+          @registered_build_dependencies[target] << Util.absolute_path(prerequisite)
         end
       end
     end
@@ -437,7 +469,7 @@ module Rscons
     #
     # @return [void]
     def produces(target, *side_effects)
-      target = expand(target)
+      target = Util.absolute_path(expand(target))
       @builder_sets.reverse.each do |builder_set|
         if builders = builder_set[target]
           builders.last.produces(*side_effects)
@@ -583,6 +615,42 @@ module Rscons
       @builder_sets << build_builder_set
     end
 
+    # Set up builders and barrier for a precompile phase if needed.
+    #
+    # @param sources [Array<String>]
+    #   Sources for the build operation.
+    #
+    # @return [Symbol, nil]
+    #   Barrier target name if a precompile phase is needed, otherwise nil.
+    def setup_precompile(sources)
+      barrier_target = nil
+      precompile_paths = Set.new
+      sources.each do |source|
+        next unless source.end_with?(".d")
+        unless barrier_target
+          barrier_target = Rscons.gen_phony_target
+          self.Barrier(barrier_target)
+        end
+        next unless module_name = Util.get_module_name(source)
+        next unless import_path = Util.find_import_path_for_d_source(self["D_IMPORT_PATH"], source, module_name)
+        precompile_path = get_pc_build_dir(import_path)
+        unless precompile_paths.include?(precompile_path)
+          Util.clean_d_precompile_path(precompile_path, import_path)
+          precompile_paths << precompile_path
+        end
+        unless self["D_IMPORT_PATH"].include?(precompile_path)
+          # Put the precompile path containing the .di files for the given
+          # import path immediately before the import path.
+          index = self["D_IMPORT_PATH"].find_index {|ip| ip == import_path}
+          self["D_IMPORT_PATH"].insert(index, precompile_path)
+        end
+        pctarget = "#{precompile_path}/#{module_name.gsub(".", "/")}.di"
+        self.Precompile(pctarget, source)
+        self.depends(barrier_target, pctarget)
+      end
+      barrier_target
+    end
+
     private
 
     # Build a BuilderSet.
@@ -610,7 +678,9 @@ module Rscons
     #
     # @return [void]
     def run_builder(builder)
-      builder.build_step ||= get_next_build_step
+      unless builder.is_a?(Rscons::Builders::Barrier)
+        builder.build_step ||= get_next_build_step
+      end
       case result = builder.run({})
       when Array
         result.each do |waititem|
@@ -636,8 +706,10 @@ module Rscons
           Cache.instance.register_build(side_effect, nil, [], self, side_effect: true)
           @side_effects.delete(side_effect)
         end
-        @build_hooks[:post].each do |build_hook_block|
-          build_hook_block.call(builder)
+        unless builder.is_a?(Rscons::Builders::Barrier)
+          @build_hooks[:post].each do |build_hook_block|
+            build_hook_block.call(builder)
+          end
         end
         process_remove_wait(builder)
       else
@@ -709,13 +781,15 @@ module Rscons
       # If no builder was found to run yet and there are threads available, try
       # to get a runnable builder from the builder set.
       targets_still_building = @threads.reduce([]) do |result, (thread, obj)|
-        result << builder_for_thread(thread).target
+        result << Util.absolute_path(builder_for_thread(thread).target)
       end
       if @builder_sets.size > 0
         if builder = @builder_sets[0].get_next_builder_to_run(targets_still_building)
           builder.vars = @varset.merge(builder.vars)
-          @build_hooks[:pre].each do |build_hook_block|
-            build_hook_block.call(builder)
+          unless builder.is_a?(Rscons::Builders::Barrier)
+            @build_hooks[:pre].each do |build_hook_block|
+              build_hook_block.call(builder)
+            end
           end
           return run_builder(builder)
         end

lib/rscons/script.rb

@@ -34,15 +34,7 @@ module Rscons
       #
       # @return [Array<String>] Paths matching the specified pattern(s).
       def glob(*patterns)
-        require "pathname"
-        patterns.reduce([]) do |result, pattern|
-          if pattern.end_with?("/**")
-            pattern += "/"
-          end
-          result += Dir.glob(pattern).map do |path|
-            Pathname.new(path.gsub("\\", "/")).cleanpath.to_s
-          end
-        end.sort
+        Util.glob(*patterns)
       end
 
       # Download a file.
@@ -289,27 +281,80 @@ module Rscons
       end
 
       # Create or modify a task.
+      #
+      # @overload task(name, options = {}, &block)
+      #   @param name [String]
+      #     Task name.
+      #   @param options [Hash]
+      #     Optional task attributes.
+      #   @option options [Boolean] :autoconf
+      #     Whether to automatically configure before running this task
+      #     (default: true).
+      #   @option options [String] :desc
+      #     Description for the task.
+      #   @option options [Array<String>] :depends
+      #     Dependencies of the task.
+      #   @option options [Array<Task::Param>] :params
+      #     Task parameter definitions.
+      #
+      # The action block given will be invoked by Rscons when the task
+      # executes. It will be passed two arguments:
+      #   1) The Task object.
+      #   2) A Hash of task parameter names and values.
       def task(*args, &block)
         Util.task(*args, &block)
       end
 
       # Define a variant, or within a with_variants block, query if it is
       # active.
-      def variant(*args)
-        Rscons.application.variant(*args)
+      #
+      # @param name [String]
+      #   Variant name.
+      # @param options [Hash]
+      #   Optional parameters.
+      # @option options [String] :default
+      #   Whether the variant is enabled by default (default: true).
+      # @option options [String] :key
+      #   Variant key, used to name an Environment's build directory. If nil,
+      #   this variant will not contribute to the Environment's build directory
+      #   name.
+      def variant(name, options = {})
+        Rscons.application.variant(name, options)
       end
 
       # Check if a variant is enabled.
-      def variant_enabled?(*args)
-        Rscons.application.variant_enabled?(*args)
+      #
+      # This can be used, for example, in a configuration block to omit or
+      # include configuration checks based on which variants have been
+      # configured.
+      #
+      # @param variant_name [String]
+      #   Variant name.
+      #
+      # @return [Boolean]
+      #   Whether the requested variant is enabled.
+      def variant_enabled?(variant_name)
+        Rscons.application.variant_enabled?(variant_name)
       end
 
       # Create a variant group.
+      #
+      # @overload variant_group(name, options = {})
+      #   @param name [String]
+      #     Variant group name (optional).
+      #   @param options [Hash]
+      #     Optional variant group parameters.
+      # @overload variant_group(options = {})
+      #   @param options [Hash]
+      #     Optional variant group parameters.
       def variant_group(*args, &block)
         Rscons.application.variant_group(*args, &block)
       end
 
-      # Iterate through variants.
+      # Iterate through enabled variants.
+      #
+      # The given block is called for each combination of enabled variants
+      # across the defined variant groups.
       def with_variants(&block)
         Rscons.application.enable_variants
         Rscons.application.with_variants(&block)
@@ -349,11 +394,17 @@ module Rscons
     # Top-level DSL available to the Rsconscript.
     class TopLevelDsl < GlobalDsl
       # Set the project name.
+      #
+      # @param project_name [String]
+      #   Project name.
       def project_name(project_name)
         @script.project_name = project_name
       end
 
-      # Whether to automatically configure (default true).
+      # Set whether to automatically configure (default true).
+      #
+      # @param autoconf [Boolean]
+      #   Whether to automatically configure.
       def autoconf(autoconf)
         @script.autoconf = autoconf
       end

lib/rscons/util.rb

@@ -16,6 +16,42 @@ module Rscons
         end
       end
 
+      # Get the absolute path for a given path.
+      #
+      # If the path is a phony target, leave it as is.
+      #
+      # @param path [String, Symbol]
+      #   Input path.
+      #
+      # @return [String, Symbol]
+      #   Output path.
+      def absolute_path(path)
+        if Rscons.phony_target?(path)
+          path
+        else
+          File.expand_path(path)
+        end
+      end
+
+      # Remove any stale .di files from the precompile path.
+      #
+      # @param pc_path [String]
+      #   Path to precompile build directory containing .di generated
+      #   interface files.
+      # @param import_path [String]
+      #   D import path containing .d source files.
+      #
+      # @return [void]
+      def clean_d_precompile_path(pc_path, import_path)
+        glob("#{pc_path}/**/*.di").each do |di_path|
+          end_path = di_path[(pc_path.size+1)..]
+          path = "#{import_path}/#{end_path}".sub(/\.di$/, ".d")
+          unless File.exist?(path)
+            FileUtils.rm_f(path)
+          end
+        end
+      end
+
       # Colorize a builder run message.
       #
       # @param message [String]
@@ -120,6 +156,29 @@ module Rscons
         end
       end
 
+      # Find the D import path that will be used to import the given module.
+      #
+      # @param import_paths [Array<String>]
+      #   Import paths.
+      # @param source [String]
+      #   Source file name.
+      # @param module_name [String]
+      #   Module name.
+      #
+      # @return [String, nil]
+      #   Import path used to import the given module.
+      def find_import_path_for_d_source(import_paths, source, module_name)
+        source = source.gsub("\\", "/")
+        module_path = module_name.gsub(".", "/") + ".d"
+        import_paths.each do |import_path|
+          path = "#{import_path}/#{module_path}".gsub("\\", "/")
+          if path == source
+            return import_path
+          end
+        end
+        nil
+      end
+
       # Format an elapsed time in human-readable format.
       #
       # @return [String]
@@ -141,6 +200,52 @@ module Rscons
         result
       end
 
+      # Get the module name for a D source file.
+      #
+      # @param source_path [String]
+      #   D source file.
+      #
+      # @return [String, nil]
+      #   Module name.
+      def get_module_name(source_path)
+        if File.exist?(source_path)
+          if File.binread(source_path) =~ /^\s*module\s(\S*);/
+            return $1
+          end
+          name = File.basename(source_path).sub(/\.d$/, "")
+          if name =~ /^\w+$/
+            return name
+          end
+        end
+      end
+
+      # Return a list of paths matching the specified pattern(s).
+      #
+      # A pattern can contain a "/**" component to recurse through directories.
+      # If the pattern ends with "/**" then only the recursive list of
+      # directories will be returned.
+      #
+      # Examples:
+      # - "src/**": return all directories under "src", recursively (including
+      #   "src" itself).
+      # - "src/**/*": return all files and directories recursively under the src
+      #   directory.
+      # - "src/**/*.c": return all .c files recursively under the src directory.
+      # - "dir/*/": return all directories in dir, but no files.
+      #
+      # @return [Array<String>] Paths matching the specified pattern(s).
+      def glob(*patterns)
+        require "pathname"
+        patterns.reduce([]) do |result, pattern|
+          if pattern.end_with?("/**")
+            pattern += "/"
+          end
+          result += Dir.glob(pattern).map do |path|
+            Pathname.new(path.gsub("\\", "/")).cleanpath.to_s
+          end
+        end.sort
+      end
+
       # Make a relative path corresponding to a possibly absolute one.
       #
       # @param path [String]

lib/rscons/version.rb

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

rb/build_dist.rb

@@ -1,7 +1,10 @@
 #!/usr/bin/env ruby
 
-require "fileutils"
+require "base64"
 require "digest/md5"
+require "fileutils"
+require "stringio"
+require "zlib"
 
 if File.read("lib/rscons/version.rb") =~ /VERSION = "(.+)"/
   VERSION = $1
@@ -22,7 +25,7 @@ combine_files = lambda do |file|
       require_name = $1
       if require_name =~ %r{^#{PROG_NAME}(?:/.*)?$}
         path = "#{LIB_DIR}/#{require_name}.rb"
-        if File.exists?(path)
+        if File.exist?(path)
           unless files_processed[path]
             files_processed[path] = true
             combine_files[path]
@@ -68,11 +71,15 @@ license = File.read("LICENSE.txt").gsub(/^(.*?)$/) do |line|
   end
 end
 
-require "zlib"
-require "base64"
 compressed_script = Zlib::Deflate.deflate(stripped.join)
+hash = Digest::MD5.hexdigest(compressed_script)
 encoded_compressed_script = Base64.encode64(compressed_script).gsub("\n", "")
-hash = Digest::MD5.hexdigest(encoded_compressed_script)
+encoded_compressed_script_io = StringIO.new(encoded_compressed_script)
+commented_encoded_compressed_script = ""
+until encoded_compressed_script_io.eof?
+  line = encoded_compressed_script_io.read(64)
+  commented_encoded_compressed_script += "##{line}\n"
+end
 
 FileUtils.rm_rf(DIST)
 FileUtils.mkdir_p(DIST)
@@ -82,25 +89,53 @@ File.open("#{DIST}/#{PROG_NAME}", "wb", 0755) do |fh|
 
 #{license}
 
+BASE64CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
+
+def base64_decode(s)
+  out = ""
+  v = 0
+  bits = 0
+  s.each_char do |c|
+    if cv = BASE64CHARS.index(c)
+      v = (v << 6) | cv
+      bits += 6
+    elsif c == "="
+      break
+    end
+    if bits >= 8
+      out += (v >> (bits - 8)).chr
+      v &= 0xFFFFFFFF >> (32 - (bits - 8))
+      bits -= 8
+    end
+  end
+  out
+end
+
 script = File.join(File.dirname(__FILE__), ".rscons-#{VERSION}-#{hash}.rb")
-unless File.exists?(script)
-  if File.read(__FILE__, mode: "rb") =~ /^#==>(.*)/
+unless File.exist?(script)
+  if File.read(__FILE__, mode: "rb") =~ /^#==>(.*)/m
     require "zlib"
-    require "base64"
     encoded_compressed = $1
-    unescaped_compressed = Base64.decode64(encoded_compressed)
-    inflated = Zlib::Inflate.inflate(unescaped_compressed)
+    compressed = base64_decode(encoded_compressed)
+    if ENV["rscons_dist_specs"]
+      require "digest/md5"
+      if Digest::MD5.hexdigest(compressed) != "#{hash}"
+        raise "Hash mismatch when decompressing rscons executable"
+      end
+    end
+    inflated = Zlib::Inflate.inflate(compressed)
     File.open(script, "wb") do |fh|
       fh.write(inflated)
     end
   else
-    raise "Could not decompress."
+    raise "Error expanding rscons executable"
   end
 end
 load script
 if __FILE__ == $0
   Rscons::Cli.new.run(ARGV)
 end
-#==>#{encoded_compressed_script}
+#==>
+#{commented_encoded_compressed_script}
 EOF
 end

rb/gen_user_guide.rb

@@ -99,7 +99,7 @@ class Generator
     end
 
     template = File.read("rb/assets/user_guide.html.erb")
-    erb = ERB.new(template, nil, "<>")
+    erb = ERB.new(template, trim_mode: "<>")
 
     if multi_page
       @pages.each_with_index do |page, page_index|

spec/rscons/cache_spec.rb

@@ -17,14 +17,14 @@ module Rscons
       it "makes directories and records any created in the cache" do
         _cache = {}
         cache = build_from(_cache)
-        expect(File).to receive(:exists?).with("one").and_return(true)
-        expect(File).to receive(:exists?).with("one/two").and_return(false)
+        expect(File).to receive(:exist?).with("one").and_return(true)
+        expect(File).to receive(:exist?).with("one/two").and_return(false)
         expect(FileUtils).to receive(:mkdir_p).with("one/two")
-        expect(File).to receive(:exists?).with("one/two/three").and_return(false)
+        expect(File).to receive(:exist?).with("one/two/three").and_return(false)
         expect(FileUtils).to receive(:mkdir_p).with("one/two/three")
-        expect(File).to receive(:exists?).with("one").and_return(true)
-        expect(File).to receive(:exists?).with("one/two").and_return(true)
-        expect(File).to receive(:exists?).with("one/two/four").and_return(false)
+        expect(File).to receive(:exist?).with("one").and_return(true)
+        expect(File).to receive(:exist?).with("one/two").and_return(true)
+        expect(File).to receive(:exist?).with("one/two/four").and_return(false)
         expect(FileUtils).to receive(:mkdir_p).with("one/two/four")
         cache.mkdir_p("one/two/three")
         cache.mkdir_p("one\\two\\four")
@@ -34,8 +34,8 @@ module Rscons
       it "handles absolute paths" do
         _cache = {}
         cache = build_from(_cache)
-        expect(File).to receive(:exists?).with("/one").and_return(true)
-        expect(File).to receive(:exists?).with("/one/two").and_return(false)
+        expect(File).to receive(:exist?).with("/one").and_return(true)
+        expect(File).to receive(:exist?).with("/one/two").and_return(false)
         expect(FileUtils).to receive(:mkdir_p).with("/one/two")
         cache.mkdir_p("/one/two")
         expect(cache.directories(false)).to eq ["/one/two"]

spec/spec_helper.rb

@@ -1,4 +1,4 @@
-if ENV["dist_specs"]
+if ENV["rscons_dist_specs"]
   require_relative "../test/rscons"
 else
   require "simplecov"
@@ -11,12 +11,7 @@ else
     else
       command_name "RSpec"
     end
-    if ENV["dist_specs"]
-      add_filter "/bin/"
-      add_filter "/lib/"
-    else
-      add_filter "test/rscons.rb"
-    end
+    add_filter "test/rscons.rb"
     project_name "Rscons"
     merge_timeout 3600
   end