Compare commits

..
Author SHA1 Message Date
josh e6317ae236 Fix SimpleCov coverage results for multiple invocations from same build test 2026-01-27 23:50:04 -05:00
josh baf4e036fb Fix up dspec task for parallelization 2026-01-27 23:50:04 -05:00
josh 9d6321685e Clean up simplecov reporting 2026-01-27 23:50:04 -05:00
josh 3a5db626ac Parallelize build tests 2026-01-27 23:50:04 -05:00
josh 94a86e3433 Add Barrier builder 2026-01-16 22:54:22 -05:00
josh fc18c9f123 Test phony dependencies 2026-01-16 20:21:13 -05:00
josh 1d020d1aef Update gems 2026-01-15 21:07:18 -05:00
josh 19c5c8cfba Update gems 2025-11-22 00:14:26 -05:00
josh 4fc7ab6b25 v3.3.0 2025-06-10 20:14:15 -04:00
josh 161da80ffe Update CHANGELOG for v3.3.0 2025-06-10 20:13:37 -04:00
josh 8d9f19cb34 Add github workflow to run RScons tests
Fix up some macOS test cases
2025-06-08 20:46:09 -04:00
josh 18a2a075c1 Remove dependency on base64 - close #177 2025-06-08 02:48:03 -04:00
josh 1a280a8994 Update gems 2025-06-07 20:30:48 -04:00
josh a19c2e908e Update gems 2025-03-24 09:48:10 -04:00
josh 5223dfe211 Add base64 to Gemfile 2025-01-15 20:18:41 -05:00
josh d0c1b01598 Update gems 2024-03-28 09:11:07 -04:00
josh 57db93c59b Add LLVM support to documentation 2024-03-24 11:00:15 -04:00
josh ba71e8d5e3 Add support for building object files from LLVM assembly sources - close #175 2024-03-23 22:24:45 -04:00
josh 6e7139abb1 v3.2.0 2024-03-18 22:05:52 -04:00
josh 896a3e270f Indent docstrings under @overload 2024-03-18 22:05:10 -04:00
josh 3ee0015cef Update UPGRADING notes for v3.2.0 2024-03-18 21:53:04 -04:00
josh 0315729f69 Update CHANGELOG for v3.2.0 2024-03-18 21:45:43 -04:00
josh 8c865e668b Add upgrading instructions - close #167 2024-03-17 20:36:59 -04:00
josh 150960246b Improve DSL method documentation - close #164 2024-03-17 20:08:06 -04:00
josh c2277bc0a1 Update gems 2024-03-01 15:11:39 -05:00
josh 4baf26e492 Update ERB call to avoid deprecation warnings 2024-02-28 16:14:21 -05:00
josh 6044b64695 Update gems 2024-02-28 16:11:09 -05:00
josh 415fa424d1 Fix configuration checks performed with ldc2 compiler - close #172 2024-02-04 20:25:01 -05:00
josh f8c21a9bcc Use top-level build directory as environment build directory for unnamed environments - close #170 2023-09-10 21:41:42 -04:00
josh 6a8647a933 Place object files next to source files for source files in build directory - close #171 2023-09-10 10:00:41 -04:00
josh 3867133e89 Cannot output binary to an environment's build root with the same name as the top-level source directory - close #168 2023-09-10 08:51:03 -04:00
josh a7b962c11a Output a better error when pkg-config is not found - close #169 2023-09-08 21:05:01 -04:00
josh b490daa480 Update gems 2023-07-28 14:03:39 -04:00
josh ed7408367f Replace CFile builder with Yacc and Lex builders - close #166 2023-02-22 20:57:00 -05:00
josh d4ec07dd7a Fix user guide examples for task dependencies 2022-10-14 16:18:14 -04:00
josh 33b606ccb1 v3.1.0 2022-08-11 14:57:26 -04:00
josh c48526fd97 Improve configuration error messages - close #162 2022-08-11 14:41:29 -04:00
josh 419e6ed313 builder registered during build hooks should increase build step count - close #161 2022-08-05 17:05:13 -04:00
josh 132d22e886 Ruby 3.2 compatibility - close #163 2022-08-05 16:40:48 -04:00
josh 8f0f320a07 v3.0.2 2022-03-14 00:36:17 -04:00
josh 12f6936084 Update CHANGELOG for v3.0.2 2022-03-14 00:36:05 -04:00
josh 866b40d872 Configure parameters should not be stored as unscoped construction variables - close #160 2022-03-14 00:34:52 -04:00
josh f06d37c8b9 Compiler check configure methods should respect :use flag - close #159 2022-03-14 00:27:02 -04:00
josh 21f8e2435e v3.0.1 2022-03-13 22:27:16 -04:00
josh 97c4f7c757 Update CHANGELOG for v3.0.1 2022-03-13 22:27:16 -04:00
josh b3df37e9ea Do not configure for clean tasks when not yet configured - close #158 2022-03-13 22:27:16 -04:00
josh 1bf1c30242 Load configure task arguments before early configure operations - close #157 2022-03-13 20:16:01 -04:00
josh b932380b3b Avoid running configure operation twice - close #156 2022-03-11 21:17:07 -05:00
josh e3ea429253 Fix running dspec task with argument 2022-03-11 21:13:52 -05:00
josh dca4c49770 Avoid trailing spaces in distributable script 2022-03-07 21:08:17 -05:00
josh b068fe7574 Test that custom clean task action blocks are execution 2022-02-28 11:59:52 -05:00
josh ecd91e1171 v3.0.0 2022-02-27 20:55:16 -05:00
josh f36b71af3f Fix ARCMD spec for Linux and MacOS 2022-02-27 19:16:59 -05:00
josh 90c3867cae Tweak specs to all pass cleanly on MacOS 2022-02-27 19:10:18 -05:00
josh 20b5020284 bundle update 2022-02-27 18:06:39 -05:00
josh cb540741a4 Clarify task parameter construction variable names 2022-02-27 17:44:01 -05:00
josh bc17a9b38f Test that clean task does not process environments 2022-02-27 17:34:48 -05:00
josh cec1331054 Rename build specs from operation to task 2022-02-27 17:34:38 -05:00
josh bb4657e465 Process environments created during task execution phase 2022-02-27 16:55:59 -05:00
josh 29ca9b3f13 Fix YARD warnings 2022-02-27 16:40:09 -05:00
josh 5ab982b84c Add GCC Cross Compiler example build script 2022-02-27 16:28:09 -05:00
josh e6e860e3c1 Document download build script method 2022-02-27 16:27:24 -05:00
josh 3cfffed7ec Document spawn options to sh method 2022-02-27 16:07:35 -05:00
josh b2d47cd439 Document ^^/ prefix 2022-02-27 16:05:28 -05:00
josh 6a10d68fac Expand CLI usage printout 2022-02-27 16:02:00 -05:00
josh 88a8f2395d Update user guide for v3.0.0
Document variants
2022-02-27 15:51:20 -05:00
josh b82d6f2e62 Include user guide Overview section in README.md 2022-02-27 12:56:23 -05:00
josh 150943f23f Update CHANGELOG.md for v3.0.0 2022-02-27 12:52:59 -05:00
josh 59f1a89f4f Add -A CLI flag to show all tasks 2022-02-27 12:41:47 -05:00
josh ea66501311 Show variants in -T output 2022-02-22 15:46:19 -05:00
josh e9e3c6711f Add build_dir script method - close #155 2022-02-20 18:13:59 -05:00
josh 8269a98d01 Add variants - close #137 2022-02-20 08:54:33 -05:00
76 changed files with 4949 additions and 3478 deletions

No files matched your search

+38
View File
@@ -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
+1 -1
View File
@@ -7,5 +7,5 @@
/gen/
/large_project/
/pkg/
/test/
/test_run/
/yard/
+73
View File
@@ -1,3 +1,76 @@
## 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
- #159 - Compiler check configure methods should respect :use flag
- #160 - Configure parameters should not be stored as unscoped construction variables
## v3.0.1
### Fixes
- #156 - Avoid running configure operation twice
- #157 - Load configure task arguments before early configure operations
- #158 - Do not configure for clean tasks when not yet configured
## v3.0.0
- #136 - Move rsconscache into build directory
- #140 - Support naming environments
- #143 - Add Size builder
- #142 - Add 'sh' script DSL method
- #144 - Add FileUtils class methods to script DSL
- #145 - Support environment variable to set rscons build directory
- #146 - Add ^^/ shortcut to top-level build directory
- #139 - Add tasks
- #147 - Add task options
- #148 - Add license/copyright to distributable script
- #150 - Add env.expand() shortcut method to expand paths and construction variables
- #152 - Add download script method
- #153 - Allow passing spawn options to sh
- #154 - Record build directory absolute path
- #149 - Add shortcut method for creating environments
- #131 - Only configure if necessary
- #151 - Store configure task parameters in configuration cache data
- #137 - Add variants
- #155 - Add build_dir script method
## v2.3.0
### New Features
+1 -1
View File
@@ -9,6 +9,6 @@ To run the rscons specs, the following commands must be available:
* g++
* clang++
* gdc
* ldc
* ldc2
* flex
* bison
+3 -1
View File
@@ -1,8 +1,10 @@
source 'https://rubygems.org'
gem "base64"
gem "rspec"
gem "rake"
gem "simplecov", "~> 0.15.0"
gem "simplecov"
gem "openssl"
if RbConfig::CONFIG["host"]["msys"]
gem "json", "2.1.0"
else
+40 -25
View File
@@ -1,46 +1,61 @@
GEM
remote: https://rubygems.org/
specs:
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)
base64 (0.3.0)
date (3.5.1)
diff-lcs (1.6.2)
docile (1.4.1)
erb (6.0.1)
json (2.18.0)
openssl (4.0.0)
psych (5.3.1)
date
stringio
rake (13.3.1)
rdoc (7.1.0)
erb
psych (>= 4.0.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.10.0)
rspec-mocks (3.10.2)
rspec-support (~> 3.13.0)
rspec-mocks (3.13.7)
diff-lcs (>= 1.2.0, < 2.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)
rspec-support (~> 3.13.0)
rspec-support (3.13.6)
simplecov (0.22.0)
docile (~> 1.1)
simplecov-html (~> 0.11)
simplecov_json_formatter (~> 0.1)
simplecov-html (0.13.2)
simplecov_json_formatter (0.1.4)
stringio (3.2.0)
syntax (1.2.2)
yard (0.9.26)
tsort (0.2.0)
yard (0.9.38)
PLATFORMS
ruby
x86-mingw32
DEPENDENCIES
base64
json
openssl
rake
rdoc
redcarpet
rspec
simplecov (~> 0.15.0)
simplecov
syntax
yard
BUNDLED WITH
2.1.4
2.6.2
+1 -1
View File
@@ -1,4 +1,4 @@
Copyright (c) 2013-2022 Josh Holtrop
Copyright (c) 2013-2025 Josh Holtrop
MIT License
+33 -1
View File
@@ -4,7 +4,39 @@
Rscons (https://github.com/holtrop/rscons) is an open-source build system
for developers.
It supports the following features:
Rscons is written in Ruby, and is inspired by [SCons](https://scons.org/) and [waf](https://waf.io/).
* multi-threaded job execution
* auto-configuration
* built-in builders for several common operations
* 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
* build hooks
* user-defined tasks with dependencies and custom parameters
* build variants
At its core, Rscons is mainly an engine to:
* determine the proper order to perform build steps,
* determine whether each build target is up to date or in need of rebuild, and
* schedule those build steps across multiple threads as efficiently as possible.
Along the way, Rscons provides a concise syntax for specifying common types of
build steps, but also provides an extensible framework for performing
custom build operations as well.
Rscons takes inspiration from:
* [SCons](https://scons.org/)
* [waf](https://waf.io/)
* [rake](https://github.com/ruby/rake)
* [CMake](https://cmake.org/)
* [Autoconf](https://www.gnu.org/software/autoconf/)
Rscons is written in Ruby.
The only requirement to run Rscons is that the system has a Ruby interpreter
installed.
See [https://holtrop.github.io/rscons/index.html](https://holtrop.github.io/rscons/index.html) for User Guide and Installation instructions.
+29 -8
View File
@@ -8,8 +8,10 @@ end
require "rspec/core/rake_task"
require "rake/clean"
require "fileutils"
require "simplecov"
require "stringio"
CLEAN.include %w[build_test_run .yardoc yard coverage test]
CLEAN.include %w[build_test_run .yardoc yard coverage test_run]
CLOBBER.include %w[dist gen large_project pkg]
task :build_dist do
@@ -19,24 +21,43 @@ 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
task :spec => :build_tests
task :spec do
unless ENV["rscons_dist_specs"]
original_stdout = $stdout
sio = StringIO.new
$stdout = sio
SimpleCov.collate Dir["coverage/.resultset.json", "coverage/bt*/.resultset.json"]
$stdout = original_stdout
sio.string.lines.each do |line|
$stdout.write(line) unless line =~ /Coverage report generated for/
end
end
end
task :build_tests do |task, args|
ENV["specs"] = "1"
sh "ruby -Ilib build_tests/build_tests.rb"
ENV.delete("specs")
end
# dspec task is useful to test the distributable release script, but is not
# useful for coverage information.
desc "Dist Specs"
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"].execute(args.example_string)
ENV.delete("dist_specs")
FileUtils.rm_rf("test_run")
FileUtils.mkdir_p("test_run")
FileUtils.cp("dist/rscons", "test_run/rscons.rb")
ENV["rscons_dist_specs"] = "1"
Rake::Task["spec"].execute(args)
Rake::Task["build_tests"].execute(args)
ENV.delete("rscons_dist_specs")
FileUtils.rm_f(Dir.glob(".rscons-*"))
end
+10
View File
@@ -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()`.
File diff suppressed because it is too large. Load diff
-4
View File
@@ -1,4 +0,0 @@
env do |env|
env.CFile("lexer.c", "lexer.l")
env.CFile("parser.c", "parser.y")
end
@@ -1,3 +0,0 @@
env do |env|
env.CFile("file.c", "foo.bar")
end
+2 -2
View File
@@ -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
+2 -2
View File
@@ -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
@@ -0,0 +1,12 @@
configure do
check_c_compiler "clang", use: "clang"
check_c_compiler
end
env "t1" do |env|
env.Program("test_gcc.exe", "simple.c")
end
env "t2", use: "clang" do |env|
env.Program("test_clang.exe", "simple.c")
end
@@ -0,0 +1,5 @@
ENV["PATH"] = ""
configure do
check_cfg package: "mypackage"
end
@@ -0,0 +1,12 @@
configure do
check_cxx_compiler "clang++", use: "clang"
check_cxx_compiler
end
env "t1" do |env|
env.Program("test_gcc.exe", "simple.cc")
end
env "t2", use: "clang" do |env|
env.Program("test_clang.exe", "simple.cc")
end
@@ -1,3 +1,3 @@
configure do
check_d_compiler "gdc", "ldc2"
check_d_compiler "gdc", "ldc2", "ldc"
end
@@ -0,0 +1,12 @@
configure do
check_d_compiler "ldc2", use: "ldc2"
check_d_compiler
end
env "t1" do |env|
env.Program("test_gcc.exe", "simple.d")
end
env "t2", use: "ldc2" do |env|
env.Program("test_ldc2.exe", "simple.d")
end
@@ -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
@@ -0,0 +1,6 @@
configure do
check_c_compiler
end
env do |env|
puts "Prefix is #{Task["configure"]["prefix"]}"
end
+6
View File
@@ -0,0 +1,6 @@
#include <iostream>
int main(int argc, char *argv[])
{
std::cout << "Hi" << std::endl;
}
+7
View File
@@ -0,0 +1,7 @@
import std.stdio;
int main()
{
writeln("Hello");
return 0;
}
+4
View File
@@ -0,0 +1,4 @@
env do |env|
env.Lex("lexer.c", "lexer.l")
env.Yacc("parser.c", "parser.y")
end
File renamed without changes.
File renamed without changes.
+5 -2
View File
@@ -1,4 +1,7 @@
env(echo: :command) do |env|
env.Program('library.exe', ['lib.a', 'three.c'])
env.Library("lib.a", ['one.c', 'two.c'], 'CPPFLAGS' => ['-Dmake_lib'])
env["LIBS"] << "mylib"
env["LIBPATH"] << "."
env.Program("library.exe", "one.c")
env.depends("library.exe", "libmylib.a")
env.Library("libmylib.a", ["two.c", "three.c"], "CPPFLAGS" => ["-Dmake_lib"])
end
+5 -2
View File
@@ -1,8 +1,11 @@
#include <stdio.h>
#ifdef make_lib
void two();
void three();
int main(int argc, char *argv[])
{
two();
printf("Library\n");
three();
}
#endif
+1 -1
View File
@@ -1,4 +1,4 @@
env(echo: :command) do |env|
env["ARCMD"] = %w[ar rcf ${_TARGET} ${_SOURCES}]
env["ARCMD"] = %w[ar rc ${_TARGET} ${_SOURCES}]
env.Library("lib.a", glob("*.c"))
end
+3
View File
@@ -0,0 +1,3 @@
void three(void)
{
}
+3
View File
@@ -0,0 +1,3 @@
void two(void)
{
}
+4
View File
@@ -0,0 +1,4 @@
env do |env|
env["LLVMAS_FLAGS"] += %w[-Wno-override-module]
env.Program("llvmtest.exe", %w[main.c one.ll])
end
+8
View File
@@ -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
+6
View File
@@ -0,0 +1,6 @@
extern int one(void);
int main(int argc, char * argv[])
{
return one();
}
+9
View File
@@ -0,0 +1,9 @@
extern int one(void);
extern int two(void);
int main(int argc, char * argv[])
{
one();
two();
return 0;
}
+9
View File
@@ -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
}
+9
View File
@@ -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
}
@@ -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
@@ -1,7 +1,7 @@
class MyObject < Rscons::Builder
def run(options)
if @builder
if File.exists?(@target)
if File.exist?(@target)
true
else
false
+7
View File
@@ -0,0 +1,7 @@
env do |env|
env.Program('simple.exe', Dir['*.c'])
end
clean do
puts "custom clean action"
end
+5
View File
@@ -0,0 +1,5 @@
default do
env do |env|
env.Program('simple.exe', Dir['*.c'])
end
end
+1
View File
@@ -1,5 +1,6 @@
env(echo: :command) do |env|
env["LD"] = "gcc"
mkdir_p("libdir")
env["LIBPATH"] += ["libdir"]
env.Program('simple.exe', Dir['*.c'])
end
+1 -1
View File
@@ -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}');"]
+1 -1
View File
@@ -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
+3
View File
@@ -1,3 +1,6 @@
#ifdef ONE
#error ONE should not be defined
#endif
void two(void)
{
}
@@ -0,0 +1,4 @@
env "src" do |env|
env["CPPPATH"] += glob("src/**")
env.Program("^/src", glob("src/**/*.c"))
end
+3
View File
@@ -0,0 +1,3 @@
default do
touch "#{build_dir}/a.file"
end
+15
View File
@@ -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
+8
View File
@@ -0,0 +1,8 @@
variant "debug", default: false
variant "release"
with_variants do
env "prog" do |env|
env.Program("^/prog.exe", "prog.c")
end
end
@@ -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
+14
View File
@@ -0,0 +1,14 @@
variant "one"
variant "two", default: false
configure do
if variant_enabled?("one")
puts "one enabled"
end
if variant_enabled?("two")
puts "two enabled"
end
if variant_enabled?("three")
puts "three enabled"
end
end
+436 -101
View File
@@ -6,12 +6,13 @@ 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
* build hooks
* user-defined tasks with dependencies and custom parameters
* build variants
At its core, Rscons is mainly an engine to:
@@ -67,8 +68,8 @@ incorrect decision being made to not rebuild when a rebuild is necessary.
### Build Flexibility
Rscons supports multiple configurations of compilation flags or build options
across multiple environments to build output files in different ways according
to the user's desire.
across multiple environments or build variants to build output files in
different ways according to the user's desire.
For example, the same source files can be built into a release executable, but
also compiled with different compilation flags or build options into a test
executable.
@@ -143,17 +144,52 @@ different version control systems):
Rscons is typically invoked from the command-line as `./rscons`.
./rscons [global options] [[task] [task options] ...]
Usage: ./rscons [global options] [[task] [task options] ...]
Global options:
-b BUILD, --build=BUILD Set build directory (default: build)
-f FILE Use FILE as Rsconscript
-F, --show-failure Show failed command log from previous build and exit
-h, --help Show rscons help and exit
-j N, --nthreads=N Set number of threads
-r COLOR, --color=COLOR Set color mode (off, auto, force)
-v, --verbose Run verbosely
--version Show rscons version and exit
-A, --all
Show all tasks (even those without descriptions) in task list. Use in
conjunction with the -T argument.
-b BUILD, --build=BUILD
Set build directory (default: build).
-e VS, --variants=VS
Enable or disable variants. VS is a comma-separated list of variant
entries. If the entry begins with "-" the variant is disabled instead of
enabled. If the full list begins with "+" or "-" then it modifies the
variants that are enabled by default by only enabling or disabling the
listed variants. Otherwise, the enabled set of variants is as given and
any variants not listed are disabled. The set of enabled variants is
remembered from when the project is configured.
-f FILE
Use FILE as Rsconscript.
-F, --show-failure
Show failed command log from previous build and exit (does not load build
script).
-h, --help
Show rscons help and exit (does not load build script).
-j N, --nthreads=N
Set number of threads (local default: 16).
-r COLOR, --color=COLOR
Set color mode (off, auto, force).
-T, --tasks
Show task list and parameters and exit (loads build script). By default
only tasks with a description are listed. Use -AT to show all tasks whether
they have a description or not.
-v, --verbose
Run verbosely. This causes Rscons to print the full build command used by
each builder.
--version
Show rscons version and exit (does not load build script).
The user can list any number of tasks on the command line.
Any parameters beginning with a "-" that follow a task are interpreted as task
@@ -181,6 +217,19 @@ Rscons execution.
The user can also invoke Rscons with the `-v` global command-line option which
will cause Rscons to print each command it is executing.
## Rscons Operation Phases
When Rscons executes, it performs the following phases:
- Parse the command line.
- This is the last step if --help, --version, or --show-failure is specified.
- Load the build script.
- This is the last step if --tasks is specified.
- Configure the project by running the `configure` task if necessary (the
project has not yet been configured, autoconf is set to true, and the user
is requesting to execute a task that is marked with autoconf set to true)
- Execute user-requested tasks.
#> The Build Script
Rscons looks for instructions for what to build by reading a build script file
@@ -188,10 +237,8 @@ called `Rsconscript` (or `Rsconscript.rb`).
Here is a simple example `Rsconscript` file:
```ruby
default do
Environment.new do |env|
env do |env|
env.Program("myprog.exe", glob("src/**/*.c"))
end
end
```
@@ -203,7 +250,7 @@ The `Rsconscript` file is a Ruby script.
##> Tasks
Tasks are the high-level user interface for performing functionality in a build
Tasks are a high-level user interface for performing functionality in a build
script.
Tasks can create Environments that perform compilation/linking steps.
Tasks can also execute arbitrary commands or perform any miscellaneous logic.
@@ -218,21 +265,17 @@ which they were added.
Example:
```ruby
task "build" do
Environment.new 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.
@@ -240,9 +283,41 @@ 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}).
###> Task Parameters
Tasks can also take parameters.
Tasks can accept parameters.
Parameters are defined by the build script author, and have default values.
The user can override parameter values on the command line.
@@ -261,7 +336,7 @@ task "build", params: [
param("myparam", "defaultvalue", true, "My special parameter"),
param("xyz", nil, false, "Enable the xyz feature"),
] do |task, params|
Environment.new do |env|
env do |env|
env["CPPDEFINES"] << "SOMEMACRO=#{params["myparam"]}"
if params["flag"]
env["CPPDEFINES"] << "ENABLE_FEATURE_XYZ"
@@ -327,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
```
@@ -335,7 +410,7 @@ end
is equivalent to:
```ruby
task "default", deps: "unpack_compiler" do
task "default", depends: "unpack_compiler" do
puts "default task"
end
```
@@ -395,12 +470,13 @@ end
See ${#Configuring the Project} for more details on how to make use of the
configuration functionality that Rscons provides.
Configure blocks must be defined in the Rsconscript file before any
environments are created.
####> Default Task
The `default` task is special in that Rscons will execute it if no other task
has been requested by the user on the command line.
It is entirely feasible for the default task to be the only task defined for a
project, and simple projects may wish to do just that.
The default task can also be used to declare a dependency on another task that
would effectively become the default.
@@ -411,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.
@@ -432,7 +508,8 @@ It will not remove the cached configuration options.
The `distclean` task is built-in to Rscons.
It removes all built target files and all cached configuration options.
Generally it will get the project directory back to the state it was in when
unpacked before any configuration or build operations took place.
unpacked or checked out, before any configuration or build operations took
place.
It will not remove items installed by an Install builder.
####> Install Task
@@ -734,17 +811,18 @@ If set, a build define of the specified String will be added to the
##> Building Targets
Building target files is accomplished by using Environments.
Environments are typically created within the default task or any user-defined
tasks.
Environments can be created at the top level of the build script, or from
within a task action block.
Here is an example `default` task block demonstrating how to create an
Environment and register a build target:
Environments are created with the
[`env`](../yard/Rscons/Script/GlobalDsl.html#env-instance_method) build script
method.
Here is an example build script that creates an Environment and registers a
Program build target:
```ruby
default do
Environment.new do |env|
env do |env|
env.Program("myprog.exe", glob("src/**/*.c"))
end
end
```
@@ -759,24 +837,21 @@ An Environment includes:
- a collection of construction variables
- a collection of build hooks
- a collection of user-registered build targets
- a build root
- a build root directory
All build targets must be registered within an `Environment`.
If the user does not specify a name for the environment, a name will be
automatically generated based on the Environment's internal ID, for example
"e.1".
The Environment's build root is a directory created within the top-level
Rscons build directory.
It is based on the Environment name.
The Environment's build root is a directory with the same name as the
Environment, created within the top-level Rscons build directory.
By default it holds all intermediate files generated by Rscons that are needed
to produce a user-specified build target.
For example, for the `Rsconscript`:
```ruby
default do
Environment.new(name: "myproj") do |env|
env "myproj" do |env|
env.Program("myprog.exe", glob("src/**/*.c"))
end
end
```
@@ -786,6 +861,12 @@ Assuming a top-level build directory of "build", the Environment's build root
would be "build/myproj".
This keeps the intermediate generated build artifacts separate from the source
files.
Source and target paths passed to a Builder (e.g. Program) can begin with "^/"
to indicate that Rscons should expand those paths to be relative to the
Environment's build root.
If a source or target path passed to a Builder begins with "^^/", it is
expanded to be relative to the Rscons top-level build directory (but outside
the Environment's build root).
###> Construction Variables
@@ -797,11 +878,9 @@ construction variables.
Example:
```ruby
default do
Environment.new do |env|
env do |env|
env["CCFLAGS"] += %w[-O2 -Wall]
env["LIBS"] += %w[m]
end
end
```
@@ -813,6 +892,7 @@ It also instructs the linker to link against the `m` library.
* uppercase strings - the default construction variables that Rscons uses
* strings beginning with "_" - set and used internally by builders
* lowercase strings with a ":" as "#{task_name}:#{parameter_name}" - set to task parameter values
* symbols, lowercase strings - reserved as user-defined construction variables
###> Builders
@@ -834,7 +914,8 @@ The `target` parameter is the path to the output file or directory.
The `sources` parameter is the path or paths to the input file(s) to be used
by the builder.
In the `target` and `sources` parameters, the user can explicitly refer to a
path within the Environment's build root by beginning the path with "^/".
path within the Environment's build root by beginning the path with "^/", or to
a path within the Rscons top-level built directory by beginning with "^^/".
The `vars` parameter is an optional Hash which can include construction
variables to be used for this build target.
Any construction variable values specified in this parameter will override
@@ -844,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.
@@ -858,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
@@ -884,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
@@ -967,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
@@ -1097,9 +1179,20 @@ 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.
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
@@ -1142,8 +1235,7 @@ build target or source file names.
Example:
```ruby
default do
Environment.new do |env|
env do |env|
env["CFLAGS"] << "-Wall"
env.add_build_hook do |builder|
# Compile sources from under src/tests without the -Wall flag.
@@ -1152,7 +1244,6 @@ default do
end
end
env.Program("program.exe", glob("src/**/*.c"))
end
end
```
@@ -1166,7 +1257,7 @@ Build hooks and post-build hooks can register new build targets.
###> Barriers
Normally Rscons will parallelize all builders.
Normally Rscons will parallelize all builders executed within an Environment.
A barrier can be used to separate sets of build targets.
All build targets registered before the barrier is created will be built before
Rscons will schedule any build targets after the barrier.
@@ -1176,14 +1267,140 @@ In other words, build targets are not parallelized across a barrier.
env.barrier
```
##> Variants
Rscons supports build variants.
Variants can be used to built multiple variations of the same item with a
specific change.
For example, a desktop application with the same sources could be built to
target KDE or GNOME using build variants.
It is up to the build script author to define the variants and what effect they
have on the build.
This build script defines "kde" and "gnome" variants:
```ruby
variant "kde"
variant "gnome"
with_variants do
env "prog" do |env|
if variant "kde"
env["CPPDEFINES"] << "KDE"
end
if variant "gnome"
env["CPPDEFINES"] << "GNOME"
end
env.Program("^/prog.exe", "src/**/*.cpp")
end
end
```
The `variant` build script method has two uses:
* At the top of the build script, it defines a variant.
* Within a `with_variants` block, it queries for whether the given variant is
active.
The `with_variants` build script method allows the power of variants to be
harnessed.
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` method call creates an Environment, so two environments are created.
When an Environment is created within a `with_variants` block, the
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
source.
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:
```ruby
${include build_tests/variants/default.rb}
```
The `rscons` command line interface provides a `-e`/`--variants` argument which
allows the user to enable a different set of variants from those enabled by
default according to the build script author.
This argument accepts a comma-separated list of variants to enable.
Each entry in the list can begin with "-" to disable the variant instead of
enable it.
If the list begins with "+" or "-", then the entire given list modifies the
defaults given in the build script.
Otherwise, it exactly specifies which variants should be enabled, and any
variant not listed is disabled.
When the project is configured, the set of enabled variants is recorded and
remembered for later Rscons invocations.
This way, a user working on a single variant of a project does not need to
specify the `-e`/`--variants` option on each build operation.
The `variant_enabled?` build script method can be called to query whether the
given variant is enabled.
###> Variant Groups
Variants may be grouped, which allows the build script author to define
multiple combinations of desired variations to build with.
For example:
```ruby
${include build_tests/variants/multiple_groups.rb}
```
This build script executes the block given to `with_variants` four times and
results in four Environments being created:
* prog-kde-debug
* prog-kde-release
* prog-gnome-debug
* prog-gnome-release
The command `./rscons -e-debug` would build just "prog-kde-release" and "prog-gnome-release".
The command `./rscons --variants kde,release` would build just "prog-kde-release".
##> Build Script Methods
`rscons` provides several methods that a build script can use.
* `autoconf` (see ${#Configure Task})
* `build_dir` which returns the path to the top-level Rscons build directory
* `clean` (see ${#Clean Task})
* `configure` (see ${#Configure Task})
* `default` (see ${#Default Task})
* `download` (see ${#Downloading Files: The download Method})
* `distclean` (see ${#Distclean Task})
* `glob` (see ${#Finding Files: The glob Method})
* `install` (see ${#Install Task})
@@ -1197,6 +1414,10 @@ env.barrier
* `sh` (see (${#Executing Commands: The sh Method})
* `task` (see ${#Tasks})
* `uninstall` (see ${#Uninstall Task})
* `variant` (see ${#Variants})
* `variant_enabled?` (see ${#Variant Groups})
* `variant_group` (see ${#Variant Groups})
* `with_variants` (see ${#Variant Groups})
Additionally, the following methods from the Ruby
[FileUtils](https://ruby-doc.org/stdlib-3.1.0/libdoc/fileutils/rdoc/FileUtils.html)
@@ -1237,16 +1458,39 @@ rather than file system directory ordering).
Example use:
```ruby
default do
Environment.new do |env|
env do |env|
env.Program("mytests", glob("src/**/*.cc", "test/**/*.cc"))
end
end
```
This example would build the `mytests` executable from all `.cc` source files
found recursively under the `src` or `test` directory.
###> Downloading Files: The download Method
The [`download`](../yard/Rscons/Script/GlobalDsl.html#download-instance_method)
method can be used to download a file from a given URL.
Example use:
```ruby
default do
download "https://ftp.gnu.org/gnu/gcc/gcc-#{gcc_version}/gcc-#{gcc_version}.tar.xz",
"#{build_dir}/gcc-#{gcc_version}.tar.xz",
sha256_sum: gcc_checksum
end
```
The `download` method downloads the file specified by the URL in the first
parameter, and writes it to the local file specified by the second parameter.
If the `:sha256sum` option is given, this causes two changes to the default
behavior:
* If Rscons finds the local file and it already has this checksum, then the
file will not be downloaded again.
* After downloading, Rscons verifies that the checksum matches what is given
and exits with an error if it does not.
###> PATH Management
`rscons` provides methods for management of the `PATH` environment variable.
@@ -1354,6 +1598,18 @@ default do
end
```
Options that Ruby's `spawn` method accepts can also be passed in to the `sh`
method.
For example, to execute the given command with a different working directory,
the `:chdir` option can be specified:
```ruby
default do
# Execute 'ls' from within the 'src' directory:
sh "ls", chdir: "src"
end
```
##> Extending Rscons
### Adding New Languages
@@ -1361,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:
@@ -1406,7 +1662,7 @@ class Rscons::Builders::Mine < Rscons::Builder
end
default do
Environment.new do |env|
env do |env|
env.add_builder(Rscons::Builders::Mine)
end
end
@@ -1429,7 +1685,7 @@ Rscons::DEFAULT_BUILDERS << :Special
load "SpecialBuilder.rb"
default do
Environment.new do |env|
env do |env|
# A build target using the "Special" builder can be registered.
env.Special("target", "source")
end
@@ -1656,40 +1912,45 @@ ${include lib/rscons/default_construction_variables.rb}
### Example: Building a C Program
```ruby
default do
Environment.new do |env|
env do |env|
env["CFLAGS"] << "-Wall"
env.Program("program", glob("src/**/*.c"))
end
end
```
### Example: Building a D Program
```ruby
default do
Environment.new do |env|
env do |env|
env["DFLAGS"] << "-Wall"
env.Program("program", glob("src/**/*.d"))
end
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
default do
main_env = Environment.new do |env|
env["CFLAGS"] = ["-DSOME_DEFINE", "-O3"]
main_env = env do |env|
env["CFLAGS"] = ["-fshort-enums", "-O3"]
env["CPPDEFINES"] << "SOME_DEFINE"
env["LIBS"] = ["SDL"]
env.Program("program", glob("src/**/*.cc"))
end
end
debug_env = main_env.clone do |env|
test_env = main_env.clone do |env|
env["CFLAGS"] -= ["-O3"]
env["CFLAGS"] += ["-g", "-O0"]
env.Program("program-debug", glob("src/**/*.cc"))
end
env["CPPDEFINES"] = "ENABLE_TESTS"
env.Program("program-test", glob("src/**/*.cc"))
end
```
@@ -1709,20 +1970,17 @@ EOF
end
end
default do
Environment.new do |env|
env do |env|
env.add_builder(GenerateFoo)
env.GenerateFoo("foo.h", [])
env.Program("a.out", glob("*.c"))
end
end
```
### Example: Using different compilation flags for some sources
```ruby
default do
Environment.new do |env|
env do |env|
env["CFLAGS"] = ["-O3", "-Wall"]
env.add_build_hook do |builder|
if builder.sources.first =~ %r{src/third-party/}
@@ -1730,27 +1988,104 @@ default do
end
end
env.Program("program", glob("**/*.cc"))
end
end
```
### Example: Creating a static library
```ruby
default do
Environment.new do |env|
env do |env|
env.Library("mylib.a", glob("src/**/*.c"))
end
end
```
### Example: Creating a C++ parser source from a Yacc/Bison input file
```ruby
env do |env|
env.Yacc("^/parser.tab.cc", "parser.yy")
end
```
### Example: GCC Cross Compiler
```ruby
binutils_version = "2.35"
binutils_checksum = "1b11659fb49e20e18db460d44485f09442c8c56d5df165de9461eb09c8302f85"
gcc_version = "10.2.0"
gcc_checksum = "b8dd4368bb9c7f0b98188317ee0254dd8cc99d1e3a18d0ff146c855fe16c1d8c"
install_path = File.expand_path("i686-elf-gcc")
target = "i686-elf"
path_prepend "#{install_path}/bin"
configure do
check_c_compiler "gcc"
check_program "make"
check_program "bison"
check_program "flex"
check_program "texi2any", on_fail: "Install the texinfo package"
check_program "wget"
check_lib "gmp", on_fail: "Install the libgmp-dev package"
check_lib "mpc", on_fail: "Install the libmpc-dev package"
check_lib "mpfr", on_fail: "Install the libmpfr-dev package"
end
default do
Environment.new do |env|
env.CFile("^/parser.tab.cc", "parser.yy")
unless Dir.exist?(install_path)
# Download archives.
download "https://ftp.gnu.org/gnu/binutils/binutils-#{binutils_version}.tar.xz",
"#{build_dir}/binutils-#{binutils_version}.tar.xz",
sha256sum: binutils_checksum
download "https://ftp.gnu.org/gnu/gcc/gcc-#{gcc_version}/gcc-#{gcc_version}.tar.xz",
"#{build_dir}/gcc-#{gcc_version}.tar.xz",
sha256sum: gcc_checksum
# Extract archives.
sh "tar", "xJf", "binutils-#{binutils_version}.tar.xz",
chdir: build_dir
sh "tar", "xJf", "gcc-#{gcc_version}.tar.xz",
chdir: build_dir
# Build binutils.
rm_rf "#{build_dir}/build-binutils"
mkdir_p "#{build_dir}/build-binutils"
cd "#{build_dir}/build-binutils" do
sh %W[../binutils-#{binutils_version}/configure
--target=#{target} --prefix=#{install_path} --with-sysroot --disable-nls
--disable-werror]
sh "make"
sh "make install"
end
# Build gcc.
rm_rf "#{build_dir}/build-gcc"
mkdir_p "#{build_dir}/build-gcc"
cd "#{build_dir}/build-gcc" do
sh %W[../gcc-#{gcc_version}/configure
--target=#{target} --prefix=#{install_path} --disable-nls
--enable-languages=c,c++ --without-headers]
sh "make all-gcc"
sh "make all-target-libgcc"
sh "make install-gcc"
sh "make install-target-libgcc"
end
end
end
clean do
rm_f "#{build_dir}/binutils-#{binutils_version}.tar.xz"
rm_rf "#{build_dir}/binutils-#{binutils_version}"
rm_rf "#{build_dir}/build-binutils"
rm_f "#{build_dir}/gcc-#{gcc_version}.tar.xz"
rm_rf "#{build_dir}/gcc-#{gcc_version}"
rm_rf "#{build_dir}/build-gcc"
end
distclean do
rm_rf install_path
end
```
+14 -2
View File
@@ -23,13 +23,14 @@ 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,
:Preprocess,
@@ -37,6 +38,7 @@ module Rscons
:SharedLibrary,
:SharedObject,
:Size,
:Yacc,
]
# Class to represent a fatal error during an Rscons operation.
@@ -65,6 +67,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,11 +144,12 @@ 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/preprocess"
@@ -148,12 +158,14 @@ 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
+69 -29
View File
@@ -42,6 +42,16 @@ module Rscons
@variant_groups = []
end
# Return if Rscons is in the task execution phase.
#
# @api private
#
# @return [Boolean]
# If Rscons is in the task execution phase.
def task_execution_phase?
@task_execution_phase
end
# Run the application.
#
# Execute user-specified tasks.
@@ -54,13 +64,16 @@ module Rscons
# List of task(s) to execute.
# @param show_tasks [Boolean]
# Flag to show tasks and exit.
# @param all_tasks [Boolean]
# Flag to show all tasks (not just those with a description).
# @param enabled_variants [String]
# User-specified variants list.
#
# @return [Integer]
# Process exit code (0 on success).
def run(rsconscript, tasks_and_params, show_tasks, enabled_variants)
def run(rsconscript, tasks_and_params, show_tasks, all_tasks, enabled_variants)
Cache.instance["failed_commands"] = []
@tasks_and_params = tasks_and_params
@enabled_variants = enabled_variants
if enabled_variants == "" && !tasks_and_params.include?("configure")
if cache_enabled_variants = Cache.instance["configuration_data"]["enabled_variants"]
@@ -68,13 +81,16 @@ module Rscons
end
end
@script = Script.new
if should_load_script
@script.load(rsconscript)
enable_variants
end
if show_tasks
show_script_tasks
show_script_tasks(all_tasks)
return 0
end
apply_task_params(tasks_and_params)
enable_variants
apply_task_params(false)
@task_execution_phase = true
if tasks_and_params.empty?
check_process_environments
if Task.tasks["default"]
@@ -156,8 +172,8 @@ module Rscons
def distclean
cache = Cache.instance
clean
FileUtils.rm_rf(@build_dir)
cache.clear
FileUtils.rm_rf(@build_dir)
end
# Check if the project needs to be configured.
@@ -166,6 +182,7 @@ module Rscons
#
# @return [void]
def check_configure
apply_task_params(true)
enable_variants
unless Cache.instance["configuration_data"]["configured"]
if @script.autoconf
@@ -192,11 +209,10 @@ module Rscons
#
# @api private
#
# @param options [Hash]
# Options.
#
# @return [void]
def configure
unless @_configured
@_configured = true
co = ConfigureOp.new(@script)
begin
@script.configure(co)
@@ -207,6 +223,7 @@ module Rscons
Cache.instance["configuration_data"]["enabled_variants"] = @enabled_variants
co.close(true)
end
end
# Remove installed files.
#
@@ -220,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
@@ -241,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}
@@ -277,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)
@@ -305,13 +339,8 @@ module Rscons
block[]
@active_variants = nil
else
enabled_variants = @variant_groups[iter_variants.size][:variants].select do |variant|
variant[:enabled]
end
if enabled_variants.empty?
iter_vgs[iter_variants + [nil]]
else
enabled_variants.each do |variant|
@variant_groups[iter_variants.size][:variants].each do |variant|
if variant[:enabled]
iter_vgs[iter_variants + [variant]]
end
end
@@ -327,15 +356,8 @@ module Rscons
enabled_count = variant_group[:variants].count do |variant|
variant[:enabled]
end
if enabled_count == 0 && !variant_group[:optional]
message = "No variants enabled for non-optional variant group"
if variant_group[:name]
message += " #{variant_group[:name].inspect}"
end
raise RsconsError.new(message)
end
if enabled_count > 1 && variant_group[:exclusive]
message = "Multiple variants enabled for exclusive variant group"
if enabled_count == 0
message = "No variants enabled for variant group"
if variant_group[:name]
message += " #{variant_group[:name].inspect}"
end
@@ -352,10 +374,10 @@ module Rscons
end
end
def show_script_tasks
def show_script_tasks(all_tasks)
puts "Tasks:"
Task[].sort.each do |task_name, task|
if task.description
if task.description || all_tasks
puts %[ #{sprintf("%-27s", task_name)} #{task.description}]
task.params.each do |param_name, param|
arg_text = "--#{param_name}"
@@ -366,10 +388,20 @@ module Rscons
end
end
end
unless @variant_groups.empty?
@variant_groups.each do |variant_group|
puts "\nVariant group#{variant_group[:name] ? " '#{variant_group[:name]}'" : ""}:"
variant_group[:variants].each do |variant|
puts " #{variant[:name]}#{variant[:enabled] ? " (enabled)" : ""}"
end
end
end
end
def apply_task_params(tasks_and_params)
tasks_and_params.each do |task_name, task_params|
def apply_task_params(only_configure)
@tasks_and_params.each do |task_name, task_params|
unless only_configure && task_name != "configure"
task_params.each do |param_name, param_value|
if param = Task[task_name].params[param_name]
Task[task_name].set_param_value(param_name, param_value)
@@ -379,6 +411,14 @@ module Rscons
end
end
end
end
def should_load_script
return true if @tasks_and_params.empty?
return true if Cache.instance["configuration_data"]["configured"]
return false if (@tasks_and_params.keys - %w[distclean clean uninstall]).empty?
true
end
end
+1 -1
View File
@@ -37,7 +37,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
+15
View File
@@ -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
-35
View File
@@ -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
+4 -4
View File
@@ -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
+1 -1
View File
@@ -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
+10
View File
@@ -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")
+24
View File
@@ -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
+1 -1
View File
@@ -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)
+24
View File
@@ -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
+3 -2
View File
@@ -101,6 +101,7 @@ module Rscons
#
# @return [void]
def write
return unless Dir.exist?(File.dirname(cache_file))
@cache["version"] = VERSION
File.open(cache_file, "w") do |fh|
fh.puts(JSON.dump(@cache))
@@ -146,7 +147,7 @@ module Rscons
unless Rscons.phony_target?(target)
# target file must exist on disk
unless File.exists?(target)
unless File.exist?(target)
if options[:debug]
puts "Target #{target} needs rebuilding because it does not exist on disk"
end
@@ -306,7 +307,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
+51 -13
View File
@@ -54,10 +54,15 @@ module Rscons
def run_toplevel(argv)
rsconscript = nil
show_tasks = false
all_tasks = false
enabled_variants = ""
OptionParser.new do |opts|
opts.on("-A", "--all") do
all_tasks = true
end
opts.on("-b", "--build DIR") do |build_dir|
Rscons.application.build_dir = build_dir
end
@@ -113,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
@@ -132,7 +137,7 @@ module Rscons
end
begin
Rscons.application.run(rsconscript, tasks_and_params, show_tasks, enabled_variants)
Rscons.application.run(rsconscript, tasks_and_params, show_tasks, all_tasks, enabled_variants)
rescue RsconsError => e
Ansi.write($stderr, :red, e.message, :reset, "\n")
1
@@ -144,16 +149,49 @@ module Rscons
Usage: #{$0} [global options] [[task] [task options] ...]
Global options:
-b BUILD, --build=BUILD Set build directory (default: build)
-e VS, --variants=VS Enable or disable variants
-f FILE Use FILE as Rsconscript
-F, --show-failure Show failed command log from previous build 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)
-T, --tasks Show task list and parameters and exit
-v, --verbose Run verbosely
--version Show rscons version and exit
-A, --all
Show all tasks (even those without descriptions) in task list. Use in
conjunction with the -T argument.
-b BUILD, --build=BUILD
Set build directory (default: build).
-e VS, --variants=VS
Enable or disable variants. VS is a comma-separated list of variant
entries. If the entry begins with "-" the variant is disabled instead of
enabled. If the full list begins with "+" or "-" then it modifies the
variants that are enabled by default by only enabling or disabling the
listed variants. Otherwise, the enabled set of variants is as given and
any variants not listed are disabled. The set of enabled variants is
remembered from when the project is configured.
-f FILE
Use FILE as Rsconscript.
-F, --show-failure
Show failed command log from previous build and exit (does not load build
script).
-h, --help
Show rscons help and exit (does not load build script).
-j N, --nthreads=N
Set number of threads (local default: #{Rscons.application.n_threads}).
-r COLOR, --color=COLOR
Set color mode (off, auto, force).
-T, --tasks
Show task list and parameters and exit (loads build script). By default
only tasks with a description are listed. Use -AT to show all tasks whether
they have a description or not.
-v, --verbose
Run verbosely. This causes Rscons to print the full build command used by
each builder.
--version
Show rscons version and exit (does not load build script).
EOF
end
+70 -24
View File
@@ -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"] = {}
@@ -23,14 +26,11 @@ module Rscons
$stdout.puts "Configuring project..."
end
end
vars = {}
Task["configure"].params.each do |name, param|
unless Rscons.application.silent_configure
Ansi.write($stdout, "Setting #{name}... ", :green, param.value, :reset, "\n")
end
vars[name] = param.value
end
store_merge(vars)
end
# Close the log file handle.
@@ -65,9 +65,15 @@ module Rscons
ccc = %w[gcc clang]
end
cc = ccc.find do |cc|
test_c_compiler(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.
@@ -87,9 +93,15 @@ module Rscons
ccc = %w[g++ clang++]
end
cc = ccc.find do |cc|
test_cxx_compiler(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.
@@ -106,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)
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.
@@ -121,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)
@@ -243,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|
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
@@ -378,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"
@@ -401,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
@@ -415,7 +459,7 @@ module Rscons
#
# @return [Boolean]
# Whether the C compiler tested successfully.
def test_c_compiler(cc)
def test_c_compiler(cc, options)
File.open("#{@work_dir}/cfgtest.c", "wb") do |fh|
fh.puts <<-EOF
int fun(int val) {
@@ -427,7 +471,7 @@ module Rscons
merge = {"CC" => cc}
_, _, status = log_and_test_command(command)
if status == 0
store_merge(merge)
store_merge(merge, options)
true
end
end
@@ -439,7 +483,7 @@ module Rscons
#
# @return [Boolean]
# Whether the C++ compiler tested successfully.
def test_cxx_compiler(cc)
def test_cxx_compiler(cc, options)
File.open("#{@work_dir}/cfgtest.cxx", "wb") do |fh|
fh.puts <<-EOF
template<typename T>
@@ -452,7 +496,7 @@ module Rscons
merge = {"CXX" => cc}
_, _, status = log_and_test_command(command)
if status == 0
store_merge(merge)
store_merge(merge, options)
true
end
end
@@ -464,7 +508,7 @@ module Rscons
#
# @return [Boolean]
# Whether the D compiler tested successfully.
def test_d_compiler(dc)
def test_d_compiler(dc, options)
File.open("#{@work_dir}/cfgtest.d", "wb") do |fh|
fh.puts <<-EOF
import core.math;
@@ -485,15 +529,17 @@ 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]
end
_, _, status = log_and_test_command(command)
if status == 0
store_merge(merge)
store_merge(merge, options)
true
end
end
+10 -5
View File
@@ -35,8 +35,9 @@ 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" => [],
@@ -46,10 +47,10 @@ module Rscons
"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 +58,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 +90,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],
}
+31 -27
View File
@@ -72,37 +72,22 @@ module Rscons
attr_reader :name
# Create an Environment object.
#
# @overload initialize(name, options)
# @overload initialize(options)
#
# @param name [String]
# Environment name. This determines the folder name used to store all
# environment build files under the top-level build directory.
# @param options [Hash]
# @option options [Symbol] :echo
# :command, :short, or :off (default :short)
# @option options [Boolean] :exclude_builders
# Whether to omit adding default builders (default false)
# @option options [String, Array<String>] :use
# Use flag(s). If specified, any configuration flags which were saved
# with a corresponding `:use` value will be applied to this Environment.
#
# If a block is given, the Environment object is yielded to the block and
# when the block returns, the {#process} method is automatically called.
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
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 || {}
Rscons.application.check_configure
unless Cache.instance["configuration_data"]["configured"]
raise "Project must be configured before creating an Environment"
end
@@ -133,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
@@ -295,7 +280,15 @@ 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
# Build all build targets specified in the Environment.
@@ -378,6 +371,7 @@ module Rscons
@builder_sets << build_builder_set
end
@builder_sets.last << builder
@build_steps += 1
@build_targets[target] = builder
builder
else
@@ -403,7 +397,11 @@ module Rscons
expand(ud)
end
@user_deps[target] ||= []
@user_deps[target] = (@user_deps[target] + user_deps).uniq
(@user_deps[target] + user_deps).each do |ud|
unless Rscons.phony_target?(ud) || @user_deps[target].include?(ud)
@user_deps[target] << ud
end
end
build_after(target, user_deps)
end
@@ -629,7 +627,9 @@ module Rscons
#
# @return [void]
def run_builder(builder)
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|
@@ -655,9 +655,11 @@ module Rscons
Cache.instance.register_build(side_effect, nil, [], self, side_effect: true)
@side_effects.delete(side_effect)
end
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
raise "Unrecognized #{builder.name} builder return value: #{result.inspect}"
@@ -733,9 +735,11 @@ module Rscons
if @builder_sets.size > 0
if builder = @builder_sets[0].get_next_builder_to_run(targets_still_building)
builder.vars = @varset.merge(builder.vars)
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
end
+115 -7
View File
@@ -10,6 +10,14 @@ module Rscons
@script = script
end
# Get the Rscons build directory path.
#
# @return [String]
# Rscons build directory path.
def build_dir
Rscons.application.build_dir
end
# Return a list of paths matching the specified pattern(s).
#
# A pattern can contain a "/**" component to recurse through directories.
@@ -94,8 +102,49 @@ module Rscons
end
# Create an environment.
#
# @overload env(name, options)
# @param name [String]
# Environment name. This determines the folder name used to store all
# environment build files under the top-level build directory.
# @param options [Hash]
# @option options [Symbol] :echo
# :command, :short, or :off (default :short)
# @option options [Boolean] :exclude_builders
# Whether to omit adding default builders (default false)
# @option options [String, Array<String>] :use
# Use flag(s). If specified, any configuration flags which were saved
# with a corresponding `:use` value will be applied to this
# Environment.
#
# @overload env(options)
# @param options [Hash]
# @option options [Symbol] :echo
# :command, :short, or :off (default :short)
# @option options [Boolean] :exclude_builders
# Whether to omit adding default builders (default false)
# @option options [String, Array<String>] :use
# Use flag(s). If specified, any configuration flags which were saved
# with a corresponding `:use` value will be applied to this
# Environment.
#
# If a block is given it is immediately executed and passed the newly
# created Environment object as an argument.
# If the Environment is created in task context, the +process+ method is
# immediately called.
# Otherwise, the Environment is not processed until the task execution
# phase.
#
# @yield [env]
# @yieldparam env [Environment]
# The created environment.
def env(*args, &block)
Environment.new(*args, &block)
Rscons.application.check_configure
e = Environment.new(*args, &block)
if Rscons.application.task_execution_phase?
e.process
end
e
end
# Construct a task parameter.
@@ -240,27 +289,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)
@@ -300,11 +402,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
+1 -1
View File
@@ -1,4 +1,4 @@
module Rscons
# Project version.
VERSION = "2.3.0"
VERSION = "3.3.0"
end
+54 -13
View File
@@ -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]
@@ -60,13 +63,23 @@ combined_file.each do |line|
end
end
license = File.read("LICENSE.txt").gsub(/^/, "# ")
license = File.read("LICENSE.txt").gsub(/^(.*?)$/) do |line|
if line.size > 0
"# #{line}"
else
"#"
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)
@@ -76,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
+1 -1
View File
@@ -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|
File diff suppressed because it is too large. Load diff
+8 -8
View File
@@ -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"]
+8 -8
View File
@@ -1,8 +1,12 @@
if ENV["dist_specs"]
require_relative "../test/rscons"
if ENV["rscons_dist_specs"]
require_relative "../test_run/rscons"
else
require "simplecov"
class MyFormatter
def format(*args)
end
end
SimpleCov.start do
add_filter "/spec/"
add_filter "/.bundle/"
@@ -11,14 +15,10 @@ 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_run/rscons.rb"
project_name "Rscons"
merge_timeout 3600
formatter(MyFormatter)
end
require "rscons"