Compare commits
71
Commits
dev
...
f5ab51c477
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f5ab51c477 | ||
|
|
b0f2bbb7d5 | ||
|
|
c1dcfa297f | ||
|
|
034dbcd9a6 | ||
|
|
b5d5fe7a7b | ||
|
|
610b8f1266 | ||
|
|
a316c4f922 | ||
|
|
97dbaeb82d | ||
|
|
a2f72c6b87 | ||
|
|
7055cad73c | ||
|
|
4548f4e3c9 | ||
|
|
19dbab3426 | ||
|
|
69f5bea2b2 | ||
|
|
2ee9dda49d | ||
|
|
f011b23499 | ||
|
|
80d52f25b8 | ||
|
|
0face546e3 | ||
|
|
ca747232cd | ||
|
|
a7b46093e9 | ||
|
|
09892eed63 | ||
|
|
117df43f64 | ||
|
|
acc12822b6 | ||
|
|
8c7b43f60c | ||
|
|
7c8becc3f9 | ||
|
|
d1a35501ef | ||
|
|
28a245f0ab | ||
|
|
87a6d9f04f | ||
|
|
556c821cc6 | ||
|
|
441fc9bc65 | ||
|
|
1861874f5c | ||
|
|
6d51c5cbde | ||
|
|
73af83803a | ||
|
|
353f4f45bc | ||
|
|
5bac91f92f | ||
|
|
bbe9563ceb | ||
|
|
5ec74604c6 | ||
|
|
8e06efe61e | ||
|
|
0756874ddb | ||
|
|
dded5e2648 | ||
|
|
fbe60f6ba2 | ||
|
|
8dd9799666 | ||
|
|
f2c755c8bb | ||
|
|
01ca86de8b | ||
|
|
943fabd0d1 | ||
|
|
d08e2f6b5c | ||
|
|
90365dd197 | ||
|
|
8d05516c40 | ||
|
|
db49d86866 | ||
|
|
e667455c32 | ||
|
|
e62332aba6 | ||
|
|
397639849d | ||
|
|
96d5caf2e5 | ||
|
|
f4b10a30af | ||
|
|
cf52c3fc6f | ||
|
|
5378afb6f8 | ||
|
|
48d9273cc6 | ||
|
|
efea4f1181 | ||
|
|
b4fa6d965c | ||
|
|
ac56ad34f6 | ||
|
|
2fd533a32a | ||
|
|
c938ed71d1 | ||
|
|
ec60201a62 | ||
|
|
0cafb8c5b3 | ||
|
|
004810386b | ||
|
|
a15ee9daaf | ||
|
|
cd33405697 | ||
|
|
efa77066bf | ||
|
|
a1bb9d81fd | ||
|
|
0344f02cb1 | ||
|
|
d52bdaf046 | ||
|
|
ad7ccb771d |
No files matched your search
@@ -1,3 +1,45 @@
|
||||
## v2.3.0
|
||||
|
||||
### New Features
|
||||
|
||||
- #125 - Support subsidiary Rsconscript files
|
||||
- #126 - Add PATH manipulation methods
|
||||
|
||||
### Fixes
|
||||
|
||||
- #121 - env.depends() does not work with built-root-relative "^/" paths
|
||||
- #130 - Document -f command line option
|
||||
- #133 - Clarify failed command error message indicating to run -F
|
||||
- #134 - Document CMD_STDOUT variable for Command builder
|
||||
- #135 - Write dependency file to build directory when user invokes Object builder directly
|
||||
- #141 - Document phony targets
|
||||
|
||||
## v2.2.0
|
||||
|
||||
### New Features
|
||||
|
||||
- #120 - improve support for MSYS2
|
||||
- #119 - add failure messages for failed configuration checks
|
||||
- #118 - compiler checks should support cross-compilers and freestanding compilers
|
||||
|
||||
## v2.1.0
|
||||
|
||||
### New Features
|
||||
|
||||
- #117 - ruby 2.7 compatibility
|
||||
|
||||
## v2.0.2
|
||||
|
||||
### Fixes
|
||||
|
||||
- #113 - distinguish object files built from multiple sources with the same base name but different extensions
|
||||
|
||||
## v2.0.1
|
||||
|
||||
### Fixes
|
||||
|
||||
- #112 - Install builder cannot replace a currently executing binary on Linux
|
||||
|
||||
## v2.0.0
|
||||
|
||||
- convert rscons from a Ruby gem to a standalone script
|
||||
@@ -32,6 +74,7 @@
|
||||
- various performance improvements
|
||||
- wrote a new user guide
|
||||
- added new website ([https://holtrop.github.io/rscons/](https://holtrop.github.io/rscons/))
|
||||
- added new logo
|
||||
|
||||
## v1.17.0
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# Developing
|
||||
|
||||
# Specs
|
||||
|
||||
To run the rscons specs, the following commands must be available:
|
||||
|
||||
* gcc
|
||||
* clang
|
||||
* g++
|
||||
* clang++
|
||||
* gdc
|
||||
* ldc
|
||||
* flex
|
||||
* bison
|
||||
@@ -1,10 +1,14 @@
|
||||
source 'https://rubygems.org'
|
||||
|
||||
gem "json"
|
||||
gem "rspec"
|
||||
gem "rake"
|
||||
gem "simplecov"
|
||||
gem "yard"
|
||||
gem "rdoc"
|
||||
gem "redcarpet"
|
||||
gem "syntax"
|
||||
gem "simplecov", "~> 0.15.0"
|
||||
if RbConfig::CONFIG["host"]["msys"]
|
||||
gem "json", "2.1.0"
|
||||
else
|
||||
gem "json"
|
||||
gem "yard"
|
||||
gem "rdoc"
|
||||
gem "redcarpet"
|
||||
gem "syntax"
|
||||
end
|
||||
+21
-21
@@ -1,32 +1,32 @@
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
diff-lcs (1.3)
|
||||
docile (1.3.2)
|
||||
json (2.2.0)
|
||||
rake (12.3.2)
|
||||
rdoc (6.1.1)
|
||||
redcarpet (3.4.0)
|
||||
rspec (3.8.0)
|
||||
rspec-core (~> 3.8.0)
|
||||
rspec-expectations (~> 3.8.0)
|
||||
rspec-mocks (~> 3.8.0)
|
||||
rspec-core (3.8.2)
|
||||
rspec-support (~> 3.8.0)
|
||||
rspec-expectations (3.8.4)
|
||||
diff-lcs (1.4.4)
|
||||
docile (1.1.5)
|
||||
json (2.5.1)
|
||||
rake (13.0.6)
|
||||
rdoc (6.3.2)
|
||||
redcarpet (3.5.1)
|
||||
rspec (3.10.0)
|
||||
rspec-core (~> 3.10.0)
|
||||
rspec-expectations (~> 3.10.0)
|
||||
rspec-mocks (~> 3.10.0)
|
||||
rspec-core (3.10.1)
|
||||
rspec-support (~> 3.10.0)
|
||||
rspec-expectations (3.10.1)
|
||||
diff-lcs (>= 1.2.0, < 2.0)
|
||||
rspec-support (~> 3.8.0)
|
||||
rspec-mocks (3.8.1)
|
||||
rspec-support (~> 3.10.0)
|
||||
rspec-mocks (3.10.2)
|
||||
diff-lcs (>= 1.2.0, < 2.0)
|
||||
rspec-support (~> 3.8.0)
|
||||
rspec-support (3.8.2)
|
||||
simplecov (0.15.0)
|
||||
rspec-support (~> 3.10.0)
|
||||
rspec-support (3.10.2)
|
||||
simplecov (0.15.1)
|
||||
docile (~> 1.1.0)
|
||||
json (>= 1.8, < 3)
|
||||
simplecov-html (~> 0.10.0)
|
||||
simplecov-html (0.10.2)
|
||||
syntax (1.2.2)
|
||||
yard (0.9.20)
|
||||
yard (0.9.26)
|
||||
|
||||
PLATFORMS
|
||||
ruby
|
||||
@@ -38,9 +38,9 @@ DEPENDENCIES
|
||||
rdoc
|
||||
redcarpet
|
||||
rspec
|
||||
simplecov
|
||||
simplecov (~> 0.15.0)
|
||||
syntax
|
||||
yard
|
||||
|
||||
BUNDLED WITH
|
||||
1.17.3
|
||||
2.1.4
|
||||
@@ -1,5 +1,7 @@
|
||||
# Rscons
|
||||
|
||||

|
||||
|
||||
Rscons (https://github.com/holtrop/rscons) is an open-source build system
|
||||
for developers.
|
||||
|
||||
|
||||
+25
-10
@@ -6,24 +6,27 @@ rescue Bundler::BundlerError => e
|
||||
end
|
||||
|
||||
require "rspec/core/rake_task"
|
||||
require "yard"
|
||||
require "rake/clean"
|
||||
require "fileutils"
|
||||
|
||||
CLEAN.include %w[build_test_run .yardoc yard coverage test]
|
||||
CLOBBER.include %w[dist pkg]
|
||||
CLOBBER.include %w[dist gen large_project pkg]
|
||||
|
||||
task :build_dist do
|
||||
sh "ruby rb/build_dist.rb"
|
||||
end
|
||||
|
||||
RSpec::Core::RakeTask.new(:spec, :example_string) do |task, args|
|
||||
ENV["specs"] = "1"
|
||||
if args.example_string
|
||||
ENV["partial_specs"] = "1"
|
||||
task.rspec_opts = %W[-e "#{args.example_string}" -f documentation]
|
||||
end
|
||||
end
|
||||
task :spec => :build_dist
|
||||
task :spec do
|
||||
ENV.delete("specs")
|
||||
end
|
||||
|
||||
# dspec task is useful to test the distributable release script, but is not
|
||||
# useful for coverage information.
|
||||
@@ -32,16 +35,11 @@ task :dspec, [:example_string] => :build_dist do |task, args|
|
||||
FileUtils.mkdir_p("test")
|
||||
FileUtils.cp("dist/rscons", "test/rscons.rb")
|
||||
ENV["dist_specs"] = "1"
|
||||
Rake::Task["spec"].invoke(args.example_string)
|
||||
Rake::Task["spec"].execute(args.example_string)
|
||||
ENV.delete("dist_specs")
|
||||
FileUtils.rm_f(Dir.glob(".rscons-*"))
|
||||
end
|
||||
|
||||
YARD::Rake::YardocTask.new do |yard|
|
||||
yard.files = ['lib/**/*.rb']
|
||||
yard.options = ["-ogen/yard"]
|
||||
end
|
||||
|
||||
task :gen_large_project, [:size] => :build_dist do |task, args|
|
||||
size = (args.size || 10000).to_i
|
||||
FileUtils.rm_rf("large_project")
|
||||
@@ -88,8 +86,25 @@ EOF
|
||||
FileUtils.cp("dist/rscons", "large_project")
|
||||
end
|
||||
|
||||
task :user_guide do
|
||||
system("ruby", "-Ilib", "rb/gen_user_guide.rb")
|
||||
unless RbConfig::CONFIG["host"]["msys"]
|
||||
require "yard"
|
||||
YARD::Rake::YardocTask.new do |yard|
|
||||
yard.files = ['lib/**/*.rb']
|
||||
yard.options = ["-ogen/yard"]
|
||||
end
|
||||
|
||||
desc "Build user guide"
|
||||
task :user_guide do
|
||||
system("ruby", "-Ilib", "rb/gen_user_guide.rb")
|
||||
end
|
||||
end
|
||||
|
||||
task :default => :spec
|
||||
|
||||
task :all => [
|
||||
:build_dist,
|
||||
:spec,
|
||||
:dspec,
|
||||
:yard,
|
||||
:user_guide,
|
||||
]
|
||||
@@ -1,4 +1,5 @@
|
||||
configure do
|
||||
check_d_compiler
|
||||
check_d_import "std.stdio", check_d_import_path: ["./usr1"]
|
||||
check_d_import "frobulous", check_d_import_path: ["./usr2"]
|
||||
end
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
configure do
|
||||
check_d_compiler
|
||||
check_d_import "std.stdio"
|
||||
end
|
||||
@@ -17,6 +17,10 @@ configure do
|
||||
end
|
||||
op.complete(status, success_message: "good!", fail_message: fail_message, fail: should_fail)
|
||||
end
|
||||
custom_check("Checking sed -E flag") do |op|
|
||||
stdout, stderr, status = op.log_and_test_command(%w[sed -E -e s/ab+/rep/], stdin: "abbbc")
|
||||
op.complete(stdout =~ /repc/ ? 0 : 1, success_message: "good", fail_message: "fail")
|
||||
end
|
||||
end
|
||||
|
||||
build do
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
configure do
|
||||
check_c_compiler "foo123c", fail: false, on_fail: "Install the foo123 package"
|
||||
check_d_compiler "foo123d", fail: false
|
||||
check_cxx_compiler "foo123cxx", on_fail: lambda {puts "Install the foo123cxx package"}
|
||||
end
|
||||
@@ -6,7 +6,8 @@ build do
|
||||
"CMD_DESC" => "Generating")
|
||||
env["build_root"] = env.build_root
|
||||
env["inc_c"] = "inc.c"
|
||||
env.build_after("${build_root}/program.o", "${inc_c}")
|
||||
env.Program("program.exe", ["program.c", "inc.c"])
|
||||
env.Object("program.o", "program.c")
|
||||
env.build_after("program.o", "${inc_c}")
|
||||
env.Program("program.exe", ["program.o", "inc.c"])
|
||||
end
|
||||
end
|
||||
@@ -4,8 +4,9 @@ build do
|
||||
env["inc_h"] = "inc.h"
|
||||
|
||||
env.Copy("copy_inc.h", "${inc_h}")
|
||||
env.depends("${build_root}/program.o", "${inc_h}")
|
||||
env.Program("program.exe", ["program.c", "inc.c"])
|
||||
env.depends("program.o", "${inc_h}")
|
||||
env.Object("program.o", "program.c")
|
||||
env.Program("program.exe", ["program.o", "inc.c"])
|
||||
|
||||
inc_c = env.Command("inc.c",
|
||||
[],
|
||||
|
||||
@@ -4,8 +4,9 @@ build do
|
||||
env["inc_h"] = "inc.h"
|
||||
|
||||
env.Copy("copy_inc.h", "${inc_h}")
|
||||
env.depends("${build_root}/program.o", "${inc_h}")
|
||||
env.Program("program.exe", ["program.c", "inc.c"])
|
||||
env.depends("program.o", "${inc_h}")
|
||||
env.Object("program.o", "program.c")
|
||||
env.Program("program.exe", ["program.o", "inc.c"])
|
||||
|
||||
env.Command("inc.c",
|
||||
[],
|
||||
|
||||
@@ -4,6 +4,7 @@ build do
|
||||
require 'yaml'
|
||||
env.add_builder(:JsonToYaml) do |params|
|
||||
unless @cache.up_to_date?(@target, :JsonToYaml, @sources, @env)
|
||||
print_run_message("JsonToYaml #{@target}", nil)
|
||||
@cache.mkdir_p(File.dirname(@target))
|
||||
File.open(@target, 'w') do |f|
|
||||
f.write(YAML.dump(JSON.load(IO.read(@sources.first))))
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
build do
|
||||
Environment.new do |env|
|
||||
env.Program("foo.exe", glob("*.cc", "*.c"))
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,6 @@
|
||||
#include <stdio.h>
|
||||
|
||||
void foo(void)
|
||||
{
|
||||
printf("foo\n");
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
#include <iostream>
|
||||
|
||||
extern "C" {
|
||||
void foo(void);
|
||||
}
|
||||
|
||||
int main(int argc, char * argv[])
|
||||
{
|
||||
foo();
|
||||
std::cout << "main" << std::endl;
|
||||
return 0;
|
||||
}
|
||||
@@ -0,0 +1,4 @@
|
||||
build do
|
||||
sh "echo", "hi there"
|
||||
sh(["echo 1 2"])
|
||||
end
|
||||
@@ -0,0 +1,4 @@
|
||||
build do
|
||||
sh "foobar42"
|
||||
sh "echo", "continued"
|
||||
end
|
||||
@@ -0,0 +1,4 @@
|
||||
build do
|
||||
sh "foobar42", continue: true
|
||||
sh "echo", "continued"
|
||||
end
|
||||
@@ -1,6 +1,6 @@
|
||||
build do
|
||||
Environment.new do |env|
|
||||
env["LIBS"] += ["c"]
|
||||
env["LIBS"] += ["m"]
|
||||
env.Program('simple.exe', Dir['*.c'])
|
||||
end
|
||||
end
|
||||
Executable
+3
@@ -0,0 +1,3 @@
|
||||
#!/bin/sh
|
||||
|
||||
echo "foobar!"
|
||||
Executable
+3
@@ -0,0 +1,3 @@
|
||||
#!/bin/sh
|
||||
|
||||
exit 42
|
||||
Executable
+3
@@ -0,0 +1,3 @@
|
||||
#!/bin/sh
|
||||
|
||||
echo "flex!"
|
||||
@@ -0,0 +1,10 @@
|
||||
path_prepend "path_prepend"
|
||||
path_append "path_append"
|
||||
|
||||
build do
|
||||
Environment.new do |env|
|
||||
system("flex")
|
||||
system("foobar")
|
||||
env.Object("simple.o", "simple.c")
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,6 @@
|
||||
build do
|
||||
Environment.new do |env|
|
||||
env.Program("simple.exe", glob("*.c"))
|
||||
env.Size("simple.size", "simple.exe")
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,18 @@
|
||||
class FileBuilder < Builder
|
||||
def self.name
|
||||
"File"
|
||||
end
|
||||
def run(options)
|
||||
FileUtils.mkdir_p(File.dirname(@target))
|
||||
File.binwrite(@target, ENV["file_contents"])
|
||||
true
|
||||
end
|
||||
end
|
||||
build do
|
||||
Environment.new do |env|
|
||||
env.add_builder(FileBuilder)
|
||||
env.File("^/file.txt")
|
||||
program = env.Program("^/simple.exe", Dir["*.c"])
|
||||
env.depends("^/simple.exe", "^/file.txt")
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,10 @@
|
||||
configure do
|
||||
rscons "sub/Rsconscript"
|
||||
rscons "sub/Rsconscript2", "configure"
|
||||
puts "top configure"
|
||||
end
|
||||
|
||||
build do
|
||||
rscons "sub/Rsconscript2", "build"
|
||||
puts "top build"
|
||||
end
|
||||
@@ -0,0 +1,10 @@
|
||||
configure do
|
||||
rscons "sub"
|
||||
rscons "sub", "-f", "Rsconscript2", "configure"
|
||||
puts "top configure"
|
||||
end
|
||||
|
||||
build do
|
||||
rscons "sub", "-f", "Rsconscript2", "build"
|
||||
puts "top build"
|
||||
end
|
||||
@@ -0,0 +1,9 @@
|
||||
configure do
|
||||
rscons "sub/Rsconscript_fail"
|
||||
puts "top configure"
|
||||
end
|
||||
|
||||
build do
|
||||
rscons "sub/Rsconscript2", "build"
|
||||
puts "top build"
|
||||
end
|
||||
@@ -0,0 +1,4 @@
|
||||
build do
|
||||
rscons "second", "build"
|
||||
puts "top build"
|
||||
end
|
||||
@@ -0,0 +1,3 @@
|
||||
build do
|
||||
puts "second build"
|
||||
end
|
||||
@@ -0,0 +1,7 @@
|
||||
configure do
|
||||
puts "sub Rsconscript configure"
|
||||
end
|
||||
|
||||
build do
|
||||
puts "sub Rsconscript build"
|
||||
end
|
||||
@@ -0,0 +1,7 @@
|
||||
configure do
|
||||
puts "sub Rsconscript2 configure"
|
||||
end
|
||||
|
||||
build do
|
||||
puts "sub Rsconscript2 build"
|
||||
end
|
||||
@@ -0,0 +1,8 @@
|
||||
configure do
|
||||
puts "sub Rsconscript configure"
|
||||
check_program "foobarfailure"
|
||||
end
|
||||
|
||||
build do
|
||||
puts "sub Rsconscript build"
|
||||
end
|
||||
@@ -0,0 +1,6 @@
|
||||
build do
|
||||
Environment.new(name: "typical") do |env|
|
||||
env["CPPPATH"] += glob("src/**")
|
||||
env.Program("^/typical.exe", glob("src/**/*.c"))
|
||||
end
|
||||
end
|
||||
@@ -2,9 +2,9 @@ build do
|
||||
Environment.new(echo: :command) do |env|
|
||||
env.append('CPPPATH' => glob('src/**/*/'))
|
||||
env.add_build_hook do |builder|
|
||||
if File.basename(builder.target) == "one.o"
|
||||
if File.basename(builder.sources.first) == "one.c"
|
||||
builder.vars["CFLAGS"] << "-O1"
|
||||
elsif File.basename(builder.target) == "two.o"
|
||||
elsif File.basename(builder.sources.first) == "two.c"
|
||||
builder.vars["CFLAGS"] << "-O2"
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
build do
|
||||
Environment.new(echo: :command) do |env|
|
||||
env.append('CPPPATH' => glob('src/**').sort)
|
||||
env.append("CPPPATH" => glob("src/**"))
|
||||
FileUtils.mkdir_p(env.build_root)
|
||||
FileUtils.mv("src/one/one.c", env.build_root)
|
||||
FileUtils.mv("src/two/two.c", Rscons.application.build_dir)
|
||||
env.Object("^/one.o", "^/one.c")
|
||||
env.Program("program.exe", glob('src/**/*.c') + ["^/one.o"])
|
||||
env.Program("^^/program.exe", ["^/one.o", "^^/two.c"])
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,9 @@
|
||||
build do
|
||||
base_env = Environment.new do |env|
|
||||
env["CPPPATH"] += glob("src/**")
|
||||
end
|
||||
|
||||
base_env.clone(name: "typical") do |env|
|
||||
env.Program("^/typical.exe", glob("src/**/*.c"))
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,11 @@
|
||||
build do
|
||||
mkdir "foo"
|
||||
cd "foo" do
|
||||
mkdir_p ["bar/baz", "bar/booz"]
|
||||
end
|
||||
mv "foo/bar", "foobar"
|
||||
rmdir "foo"
|
||||
touch "foobar/booz/a.txt"
|
||||
cp "foobar/booz/a.txt", "foobar/baz/b.txt"
|
||||
rm_rf "foobar/booz"
|
||||
end
|
||||
+287
-65
@@ -8,7 +8,7 @@ It supports the following features:
|
||||
* built-in builders for several common operations
|
||||
* out-of-the-box support for C, C++, and D languages
|
||||
* extensibility for other languages or custom builders
|
||||
* compatible with Windows, Linux, and OS X
|
||||
* compatible with Windows, Linux, OS X, and FreeBSD
|
||||
* colorized output with build progress
|
||||
* build hooks
|
||||
|
||||
@@ -78,10 +78,22 @@ cache file in order to avoid rebuilding a target when it is already up to date.
|
||||
### Build Directory
|
||||
|
||||
Rscons was designed to store temporary build artifacts (for example, object
|
||||
files, dependency files, etc...) in a `build` directory.
|
||||
files, dependency files, etc...) and build system metadata in a
|
||||
"build directory".
|
||||
This keeps files generated by the build cleanly separated from user-controlled
|
||||
source files.
|
||||
|
||||
In contrast to other build systems or build system generators, rscons executes
|
||||
from the project base directory (up to the user) rather than executing from
|
||||
*within* the build directory.
|
||||
This keeps any file paths printed by compilers (such as in warning or error
|
||||
messages) accurate relative to the project directory, so that the user does not
|
||||
need to translate any paths to the correct path within a terminal or editor
|
||||
application, for example.
|
||||
|
||||
By default a build directory named "build" is used, but this can be overridden
|
||||
by the user by using the `-b`/`--build` command-line option.
|
||||
|
||||
## Getting Started
|
||||
|
||||
To use Rscons on your project, you must:
|
||||
@@ -94,11 +106,12 @@ To use Rscons on your project, you must:
|
||||
|
||||
Rscons is designed to be distributed as a stand-alone single file script that
|
||||
can be copied into and versioned in a project's source tree.
|
||||
The only dependency required to run Rscons is to have a Ruby interpreter
|
||||
The only requirement to run Rscons is that the system has a Ruby interpreter
|
||||
installed.
|
||||
The latest release can be downloaded from [https://github.com/holtrop/rscons/releases](https://github.com/holtrop/rscons/releases).
|
||||
Simply copy the `rscons` executable script into the desired location within
|
||||
the project to be built (typically the root of the repository).
|
||||
the project to be built (typically the root of the repository) and mark it
|
||||
executable.
|
||||
|
||||
## Version Control Setup
|
||||
|
||||
@@ -208,6 +221,171 @@ called `myprog.exe` which is to be built from all C source files found
|
||||
|
||||
The `Rsconscript` file is a Ruby script.
|
||||
|
||||
##> Build Script Methods
|
||||
|
||||
`rscons` provides several methods that a build script can use.
|
||||
|
||||
* `glob` (see ${#Finding Files: The glob Method})
|
||||
* `path_append` (see ${#PATH Management})
|
||||
* `path_components` (see ${#PATH Management})
|
||||
* `path_prepend` (see ${#PATH Management})
|
||||
* `path_set` (see ${#PATH Management})
|
||||
* `rscons` (see ${#Using Subsidiary Build Scripts: The rscons Method})
|
||||
* `sh` (see (${#Executing Commands: The sh Method})
|
||||
|
||||
Additionally, the following methods from the Ruby
|
||||
[FileUtils](https://ruby-doc.org/stdlib-3.1.0/libdoc/fileutils/rdoc/FileUtils.html)
|
||||
module are made available for the build script to call directly:
|
||||
|
||||
* `cd`
|
||||
* `chmod`
|
||||
* `chmod_R`
|
||||
* `chown`
|
||||
* `chown_R`
|
||||
* `cp`
|
||||
* `cp_lr`
|
||||
* `cp_r`
|
||||
* `install`
|
||||
* `ln`
|
||||
* `ln_s`
|
||||
* `ln_sf`
|
||||
* `mkdir`
|
||||
* `mkdir_p`
|
||||
* `mv`
|
||||
* `pwd`
|
||||
* `rm`
|
||||
* `rm_f`
|
||||
* `rm_r`
|
||||
* `rm_rf`
|
||||
* `rmdir`
|
||||
* `touch`
|
||||
|
||||
###> Finding Files: The glob Method
|
||||
|
||||
The [`glob`](../yard/Rscons/Script/GlobalDsl.html#glob-instance_method) method can be
|
||||
used to find files matching the patterns specified.
|
||||
It supports a syntax similar to the Ruby [Dir.glob method](https://ruby-doc.org/core-3.1.0/Dir.html#method-c-glob) but operates more deterministically.
|
||||
|
||||
Example use:
|
||||
|
||||
```ruby
|
||||
build do
|
||||
Environment.new 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.
|
||||
|
||||
###> PATH Management
|
||||
|
||||
`rscons` provides methods for management of the `PATH` environment variable.
|
||||
|
||||
The
|
||||
[`path_append`](../yard/Rscons/Script/GlobalDsl.html#path_append-instance_method)
|
||||
and
|
||||
[`path_prepend`](../yard/Rscons/Script/GlobalDsl.html#path_prepend-instance_method)
|
||||
methods can be used to append or prepend a path to the `PATH` environment
|
||||
variable.
|
||||
|
||||
```ruby
|
||||
path_prepend "i686-elf-gcc/bin"
|
||||
```
|
||||
|
||||
The
|
||||
[`path_set`](../yard/Rscons/Script/GlobalDsl.html#path_set-instance_method)
|
||||
method sets the `PATH` environment variable to the given Array or String.
|
||||
|
||||
The
|
||||
[`path_components`](../yard/Rscons/Script/GlobalDsl.html#path_components-instance_method)
|
||||
method returns an Array of the components in the `PATH`
|
||||
environment variable.
|
||||
|
||||
###> Using Subsidiary Build Scripts: The rscons Method
|
||||
|
||||
The
|
||||
[`rscons`](../yard/Rscons/Script/GlobalDsl.html#rscons-instance_method)
|
||||
build script method can be used to invoke an rscons subprocess to
|
||||
perform an operation using a subsidiary rscons build script.
|
||||
This can be used, for example, when a subproject is imported and a top-level
|
||||
`configure` or `build` operation should also perform the same operation in the
|
||||
subproject directory.
|
||||
|
||||
The first argument to the `rscons` method specifies either a directory name, or
|
||||
the path to the subsidiary Rsconscript file to execute.
|
||||
Any additional arguments are passed to `rscons` when it executes the subsidiary
|
||||
script.
|
||||
`rscons` will change working directories to the directory containing the
|
||||
subsidiary script when executing it.
|
||||
|
||||
For example:
|
||||
|
||||
```ruby
|
||||
configure do
|
||||
rscons "subproject", "configure"
|
||||
end
|
||||
|
||||
build do
|
||||
rscons "subproject/Rsconscript", "build"
|
||||
end
|
||||
```
|
||||
|
||||
It is also perfectly valid to perform a different operation in the subsidiary
|
||||
script from the one being performed in the top-level script.
|
||||
For example, in a project that requires a particular cross compiler, the
|
||||
top-level `configure` script could build the necessary cross compiler using a
|
||||
subsidiary build script.
|
||||
This could look something like:
|
||||
|
||||
```ruby
|
||||
configure do
|
||||
rscons "cross/Rsconscript"
|
||||
check_c_compiler "i686-elf-gcc"
|
||||
end
|
||||
```
|
||||
|
||||
This would build, and if necessary first configure, using the cross/Rsconscript
|
||||
subsidiary build script.
|
||||
Subsidiary build scripts are executed from within the directory containing the
|
||||
build script.
|
||||
|
||||
###> Executing Commands: The sh Method
|
||||
|
||||
The
|
||||
[`sh`](../yard/Rscons/Script/GlobalDsl.html#sh-instance_method)
|
||||
build script method can be used to directly execute commands.
|
||||
The `sh` method accepts either a single String argument or an Array of Strings.
|
||||
When an Array is given, if the array length is greater than 1, then the command
|
||||
will not be executed and interpreted by the system shell.
|
||||
Otherwise, it will be executed and interpreted by the system shell.
|
||||
|
||||
For example:
|
||||
|
||||
```ruby
|
||||
build do
|
||||
# Run "make" in imported "subcomponent" directory.
|
||||
sh "cd subcomponent; make"
|
||||
# Move a file around.
|
||||
sh "mv", "subcomponent/file with spaces.txt", "new_name.txt"
|
||||
end
|
||||
```
|
||||
|
||||
If the command fails, rscons will normally print the error and terminate
|
||||
execution.
|
||||
If the `:continue` option is set, then rscons will not terminate execution.
|
||||
For example:
|
||||
|
||||
```ruby
|
||||
build do
|
||||
# This command will fail and a message will be printed.
|
||||
sh "false", continue: true
|
||||
# However, due to the :continue option being set, execution will continue.
|
||||
sh "echo hi"
|
||||
end
|
||||
```
|
||||
|
||||
##> Configuration Operations
|
||||
|
||||
A `configure` block is optional.
|
||||
@@ -245,6 +423,15 @@ configure do
|
||||
end
|
||||
```
|
||||
|
||||
Global configuration options may be supplied to the compiler checks as well.
|
||||
Example:
|
||||
|
||||
```ruby
|
||||
configure do
|
||||
check_c_compiler "x86_64-elf-gcc", on_fail: "Install x86_64-elf cross toolchain first!"
|
||||
end
|
||||
```
|
||||
|
||||
###> Checking for a Header File
|
||||
|
||||
The following methods can be used to check for the presence of a header file:
|
||||
@@ -271,18 +458,6 @@ end
|
||||
|
||||
Optionally specifies an array of paths to look for the header file in.
|
||||
|
||||
##### `:fail`
|
||||
|
||||
If the `:fail` option is set to `false`, then the absence of the header file
|
||||
will not result in the configure option failing.
|
||||
The `:fail` option defaults to `true` if the `:set_define` option is not
|
||||
defined, and defaults to `false` if the `:set_define` option is defined.
|
||||
|
||||
##### `:set_define`
|
||||
|
||||
If set, a build define of the specified String will be added to the
|
||||
`CPPDEFINES` construction variable array if the requested header is found.
|
||||
|
||||
###> Checking for a D Import
|
||||
|
||||
The `check_d_import` method can be used to check for the presence of D import.
|
||||
@@ -326,18 +501,6 @@ end
|
||||
|
||||
Optionally specifies an array of paths to look for the library in.
|
||||
|
||||
##### `:fail`
|
||||
|
||||
If the `:fail` option is set to `false`, then the absence of the library
|
||||
will not result in the configure option failing.
|
||||
The `:fail` option defaults to `true` if the `:set_define` option is not
|
||||
defined, and defaults to `false` if the `:set_define` option is defined.
|
||||
|
||||
##### `:set_define`
|
||||
|
||||
If set, a build define of the specified String will be added to the
|
||||
`CPPDEFINES` construction variable array if the requested library is found.
|
||||
|
||||
##### `:use`
|
||||
|
||||
If not set, the library will be used by default in all `Environment` objects.
|
||||
@@ -386,18 +549,6 @@ used to look for package configuration flags for the specified package.
|
||||
If the `:program` option is given, the program specified will be used to look
|
||||
for configuration flags.
|
||||
|
||||
##### `:fail`
|
||||
|
||||
If the `:fail` option is set to `false`, then the absence of the package or
|
||||
program requested will not result in the configure option failing.
|
||||
The `:fail` option defaults to `true` if the `:set_define` option is not
|
||||
defined, and defaults to `false` if the `:set_define` option is defined.
|
||||
|
||||
##### `:set_define`
|
||||
|
||||
If set, a build define of the specified String will be added to the
|
||||
`CPPDEFINES` construction variable array if the requested package is found.
|
||||
|
||||
##### `:use`
|
||||
|
||||
If not set, the library will be used by default in all `Environment` objects.
|
||||
@@ -456,6 +607,46 @@ configure do
|
||||
end
|
||||
```
|
||||
|
||||
###> Global Configuration Check Options
|
||||
|
||||
#### `:fail`
|
||||
|
||||
If the `:fail` option is set to `false`, then the absence of the package or
|
||||
program requested will not result in the configure option failing.
|
||||
The `:fail` option defaults to `true` if the `:set_define` option is not
|
||||
defined, and defaults to `false` if the `:set_define` option is defined.
|
||||
|
||||
#### `:on_fail`
|
||||
|
||||
The `:on_fail` option can be set to a String or a Proc object. If the
|
||||
configuration operation fails (or would fail), the given message is printed
|
||||
or the Proc is called.
|
||||
|
||||
Examples:
|
||||
|
||||
```ruby
|
||||
configure do
|
||||
check_c_compiler "special-gcc", on_fail: "First install special gcc!"
|
||||
end
|
||||
|
||||
configure do
|
||||
package_hint = lambda do
|
||||
puts "The following packages must be installed to build this project:"
|
||||
puts "- libsdl2-dev"
|
||||
puts "- libsdl2-image-dev"
|
||||
puts "- libsdl2-net-dev"
|
||||
end
|
||||
check_lib "SDL2", on_fail: package_hint
|
||||
check_lib "SDL2_image", on_fail: package_hint
|
||||
check_lib "SDL2_net", on_fail: package_hint
|
||||
end
|
||||
```
|
||||
|
||||
#### `:set_define`
|
||||
|
||||
If set, a build define of the specified String will be added to the
|
||||
`CPPDEFINES` construction variable array if the requested package is found.
|
||||
|
||||
##> Build Operations
|
||||
|
||||
The `build` block is used to create Environments and register build targets.
|
||||
@@ -478,21 +669,26 @@ source files found recursively under the `src` directory.
|
||||
|
||||
An Environment includes:
|
||||
|
||||
- a name
|
||||
- a collection of construction variables
|
||||
- a collection of build hooks
|
||||
- a collection of user-registered build targets
|
||||
- a build root
|
||||
|
||||
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.
|
||||
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
|
||||
build do
|
||||
Environment.new do |env|
|
||||
Environment.new(name: "myproj") do |env|
|
||||
env.Program("myprog.exe", glob("src/**/*.c"))
|
||||
end
|
||||
end
|
||||
@@ -500,28 +696,11 @@ end
|
||||
|
||||
Rscons will place an object file and dependency file corresponding to each C
|
||||
source file under the Environment's build root.
|
||||
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.
|
||||
|
||||
###> Specifying Source Files: The glob Method
|
||||
|
||||
The [`glob`](../yard/Rscons/Script/Dsl.html#glob-instance_method) method can be
|
||||
used to find files matching the patterns specified.
|
||||
It supports a syntax similar to the Ruby [Dir.glob method](https://ruby-doc.org/core-2.5.1/Dir.html#method-c-glob) but operates more deterministically.
|
||||
|
||||
Example use:
|
||||
|
||||
```ruby
|
||||
build do
|
||||
Environment.new 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.
|
||||
|
||||
###> Construction Variables
|
||||
|
||||
Construction variables are values assigned to keys within an Environment.
|
||||
@@ -592,20 +771,33 @@ There are several default builders that are built-in to Rscons:
|
||||
library.
|
||||
* `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.
|
||||
|
||||
####> The Command Builder
|
||||
|
||||
```ruby
|
||||
env.Command(target, sources, "CMD" => command)
|
||||
# Example
|
||||
env.Command("docs.html", "docs.md",
|
||||
env.Command("user_guide.html", "user_guide.md",
|
||||
"CMD" => ["pandoc", "-fmarkdown", "-thtml", "-o${_TARGET}", "${_SOURCES}"],
|
||||
"CMD_DESC" => "PANDOC")
|
||||
"CMD_DESC" => "Generating user guide:")
|
||||
```
|
||||
|
||||
The `Command` builder executes a user-defined command in order to produce the
|
||||
desired target file based on the provided source files.
|
||||
|
||||
The `Command` builder supports the following construction variables:
|
||||
|
||||
* `CMD` (required) specifies the command to execute (an array of strings).
|
||||
`CMD` is expanded for variable references, so the tokens `${_TARGET}` and
|
||||
`${_SOURCES}` can be used, for example.
|
||||
* `CMD_DESC` (optional) specifies the short text description to print when
|
||||
the builder executes. The given description is followed by the target file
|
||||
name.
|
||||
* `CMD_STDOUT` (optional) specifies a file to redirect standard output to.
|
||||
`CMD_STDOUT` is expanded for variable references, so the token `${_TARGET}`
|
||||
can be used, for example.
|
||||
|
||||
####> The CFile Builder
|
||||
|
||||
```ruby
|
||||
@@ -795,6 +987,36 @@ allows it to be used to create a shared library are added.
|
||||
Although it can be called explicitly, it is more commonly implicitly called by
|
||||
the `SharedLibrary` builder.
|
||||
|
||||
####> The Size Builder
|
||||
|
||||
```ruby
|
||||
env.Size(target, sources)
|
||||
# Example
|
||||
env.Program("program.exe", glob("*.c"))
|
||||
env.Size("program.size", "program.exe")
|
||||
```
|
||||
|
||||
The `Size` builder runs the "size" executable on the given source file and
|
||||
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`.
|
||||
|
||||
###> Phony Targets
|
||||
|
||||
rscons supports phony build targets.
|
||||
Normally, a builder produces an output file, and executes whenever the input
|
||||
files or command have changed.
|
||||
A phony build target can be used to register a builder that does not produce
|
||||
an output file.
|
||||
A custom builder can take some action when the input files change even if it
|
||||
does not produce an output file.
|
||||
Such a builder could perform verification or run a test on its source files,
|
||||
possibly failing if some conditions are not met.
|
||||
It could also simply output something to the console, such as an analysis of
|
||||
the source file, whenever it changes.
|
||||
A phony target is signified by passing a Symbol instead of a String as the
|
||||
first parameter (target) to a builder method.
|
||||
|
||||
###> Explicit Dependencies
|
||||
|
||||
A target can be marked as depending on another file that Rscons would not
|
||||
@@ -1024,7 +1246,7 @@ Here is our Custom builder example extended to print its status:
|
||||
```ruby
|
||||
class Rscons::Builders::Custom < Rscons::Builder
|
||||
def run(options)
|
||||
print_run_message("Creating <target>#{@target}<reset> from Custom builder")
|
||||
print_run_message("Creating <target>#{@target}<reset> from Custom builder", nil)
|
||||
File.open(@target, "w") do |fh|
|
||||
fh.write("Target file created.")
|
||||
end
|
||||
@@ -1049,7 +1271,7 @@ Here is a Custom builder which combines its source files similar to what the
|
||||
class Rscons::Builders::Custom < Rscons::Builder
|
||||
def run(options)
|
||||
unless @cache.up_to_date?(@target, nil, @sources, @env)
|
||||
print_run_message("Combining <source>#{Util.short_format_paths(@sources)}<reset> => <target>#{@target}<reset>")
|
||||
print_run_message("Combining <source>#{Util.short_format_paths(@sources)}<reset> => <target>#{@target}<reset>", nil)
|
||||
File.open(@target, "wb") do |fh|
|
||||
@sources.each do |source|
|
||||
fh.write(File.read(source, mode: "rb"))
|
||||
@@ -1276,7 +1498,7 @@ To do this, create a `configure` script with contents similar to the following:
|
||||
|
||||
```
|
||||
#!/bin/sh
|
||||
exec "$(dirname "$0")"/rscons "$@"
|
||||
exec "$(dirname "$0")"/rscons configure "$@"
|
||||
```
|
||||
|
||||
and make it executable with `chmod +x configure`.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 242 KiB |
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 67 KiB |
+6
-14
@@ -33,10 +33,11 @@ module Rscons
|
||||
:Program,
|
||||
:SharedLibrary,
|
||||
:SharedObject,
|
||||
:Size,
|
||||
]
|
||||
|
||||
# Class to represent a fatal error while building a target.
|
||||
class BuildError < RuntimeError; end
|
||||
# Class to represent a fatal error during an Rscons operation.
|
||||
class RsconsError < RuntimeError; end
|
||||
|
||||
class << self
|
||||
|
||||
@@ -64,16 +65,6 @@ module Rscons
|
||||
target.is_a?(Symbol)
|
||||
end
|
||||
|
||||
# Return a new path by changing the suffix in path to suffix.
|
||||
#
|
||||
# @param path [String] The path to alter.
|
||||
# @param suffix [String] The new filename suffix, e.g. ".exe".
|
||||
#
|
||||
# @return [String] New path.
|
||||
def set_suffix(path, suffix)
|
||||
path.sub(/\.[^.]*$/, "") + suffix
|
||||
end
|
||||
|
||||
# Return the system shell and arguments for executing a shell command.
|
||||
#
|
||||
# @return [Array<String>] The shell and flag.
|
||||
@@ -91,7 +82,7 @@ module Rscons
|
||||
end
|
||||
if ENV["SHELL"] and ENV["SHELL"] != "" and test_shell[ENV["SHELL"], "-c"]
|
||||
[ENV["SHELL"], "-c"]
|
||||
elsif Object.const_get("RUBY_PLATFORM") =~ /mingw/
|
||||
elsif Object.const_get("RUBY_PLATFORM") =~ /mingw|msys/
|
||||
if test_shell["sh", "-c"]
|
||||
# Using Rscons from MSYS should use MSYS's shell.
|
||||
["sh", "-c"]
|
||||
@@ -112,7 +103,7 @@ module Rscons
|
||||
# @return [Array<String>] Command used to execute commands.
|
||||
def command_executer
|
||||
@command_executer ||=
|
||||
if Object.const_get("RUBY_PLATFORM") =~ /mingw/
|
||||
if Object.const_get("RUBY_PLATFORM") =~ /mingw|msys/
|
||||
if ENV.keys.find {|key| key =~ /MSYS/}
|
||||
begin
|
||||
if IO.popen(["env", "echo", "success"]) {|io| io.read.strip} == "success"
|
||||
@@ -156,6 +147,7 @@ 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"
|
||||
|
||||
# language support
|
||||
require_relative "rscons/builders/lang/asm"
|
||||
|
||||
+1
-1
@@ -84,7 +84,7 @@ module Rscons
|
||||
# @return [Boolean]
|
||||
# Whether to output ANSI color escape codes.
|
||||
def do_ansi?(io)
|
||||
if RUBY_PLATFORM =~ /mingw/
|
||||
if RUBY_PLATFORM =~ /mingw|msys/
|
||||
(ENV["TERM"] == "xterm") && %w[fifo characterSpecial].include?(io.stat.ftype)
|
||||
else
|
||||
io.tty?
|
||||
|
||||
@@ -5,6 +5,10 @@ module Rscons
|
||||
# Functionality for an instance of the rscons application invocation.
|
||||
class Application
|
||||
|
||||
# @return [String]
|
||||
# Top-level build directory.
|
||||
attr_accessor :build_dir
|
||||
|
||||
# @return [Boolean]
|
||||
# Whether to output ANSI color escape sequences.
|
||||
attr_accessor :do_ansi_color
|
||||
@@ -23,6 +27,8 @@ module Rscons
|
||||
|
||||
# Create Application instance.
|
||||
def initialize
|
||||
@build_dir = ENV["RSCONS_BUILD_DIR"] || "build"
|
||||
ENV.delete("RSCONS_BUILD_DIR")
|
||||
@n_threads = Util.determine_n_threads
|
||||
@vars = VarSet.new
|
||||
@operations = Set.new
|
||||
@@ -75,6 +81,8 @@ module Rscons
|
||||
end
|
||||
if rv == 0
|
||||
build(operation_options)
|
||||
else
|
||||
rv
|
||||
end
|
||||
when "clean"
|
||||
clean
|
||||
@@ -134,8 +142,8 @@ module Rscons
|
||||
env.process
|
||||
end
|
||||
0
|
||||
rescue BuildError => be
|
||||
Ansi.write($stderr, :red, be.message, :reset, "\n")
|
||||
rescue RsconsError => e
|
||||
Ansi.write($stderr, :red, e.message, :reset, "\n")
|
||||
1
|
||||
end
|
||||
end
|
||||
@@ -169,11 +177,8 @@ module Rscons
|
||||
# Exit code.
|
||||
def distclean
|
||||
cache = Cache.instance
|
||||
build_dir = cache["configuration_data"]["build_dir"]
|
||||
clean
|
||||
if build_dir
|
||||
FileUtils.rm_rf(build_dir)
|
||||
end
|
||||
FileUtils.rm_rf(@build_dir)
|
||||
cache.clear
|
||||
0
|
||||
end
|
||||
@@ -191,7 +196,11 @@ module Rscons
|
||||
co = ConfigureOp.new(options)
|
||||
begin
|
||||
@script.configure(co)
|
||||
rescue ConfigureOp::ConfigureFailure
|
||||
rescue RsconsError => e
|
||||
if e.message and e.message != ""
|
||||
$stderr.puts e.message
|
||||
end
|
||||
Ansi.write($stderr, :red, "Configuration failed", :reset, "\n")
|
||||
rv = 1
|
||||
end
|
||||
co.close(rv == 0)
|
||||
|
||||
@@ -57,6 +57,7 @@ module Rscons
|
||||
printed_message = true
|
||||
end
|
||||
@cache.mkdir_p(File.dirname(dest), install: @install_builder)
|
||||
FileUtils.rm_f(dest)
|
||||
FileUtils.cp(src, dest, :preserve => true)
|
||||
end
|
||||
@cache.register_build(dest, :Copy, [src], @env, install: @install_builder)
|
||||
|
||||
@@ -75,10 +75,10 @@ module Rscons
|
||||
@vars["_SOURCES"] = @sources
|
||||
depfilesuffix = @env.expand_varref("${DEPFILESUFFIX}", vars)
|
||||
@vars["_DEPFILE"] =
|
||||
if @vars[:direct]
|
||||
@env.get_build_fname(target, depfilesuffix, self.class)
|
||||
if @vars[:direct] || !@target.start_with?("#{@env.build_root}/")
|
||||
@env.get_build_fname(@target, depfilesuffix, self.class)
|
||||
else
|
||||
Rscons.set_suffix(target, depfilesuffix)
|
||||
"#{@target}#{depfilesuffix}"
|
||||
end
|
||||
@cache.mkdir_p(File.dirname(@vars["_DEPFILE"]))
|
||||
command = @env.build_command(@command_template, @vars)
|
||||
|
||||
@@ -23,7 +23,7 @@ module Rscons
|
||||
@vars["_PREPROCESS_DEPGEN"] = depgen
|
||||
@vars["_TARGET"] = @target
|
||||
@vars["_SOURCES"] = @sources
|
||||
@vars["_DEPFILE"] = Rscons.set_suffix(target, env.expand_varref("${DEPFILESUFFIX}", vars))
|
||||
@vars["_DEPFILE"] = "#{target}#{env.expand_varref("${DEPFILESUFFIX}", vars)}"
|
||||
command = @env.build_command("${CPP_CMD}", @vars)
|
||||
self.produces(@vars["_DEPFILE"])
|
||||
standard_command("Preprocessing <source>#{Util.short_format_paths(@sources)}<reset> => <target>#{@target}<reset>", command)
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
module Rscons
|
||||
module Builders
|
||||
# Run the "size" utility on an executable and store its results in the
|
||||
# target file.
|
||||
# input file.
|
||||
#
|
||||
# Examples::
|
||||
# env.Size("^/project.size", "^/project.elf")
|
||||
class Size < Builder
|
||||
|
||||
# Run the builder to produce a build target.
|
||||
def run(options)
|
||||
if @command
|
||||
finalize_command
|
||||
else
|
||||
@vars["_SOURCES"] = @sources
|
||||
command = @env.build_command("${SIZECMD}", @vars)
|
||||
standard_command("Size <source>#{Util.short_format_paths(@sources)}<reset> => <target>#{@target}<reset>", command, stdout: @target)
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
+9
-7
@@ -51,9 +51,6 @@ module Rscons
|
||||
# }
|
||||
class Cache
|
||||
|
||||
# Name of the file to store cache information in
|
||||
CACHE_FILE = ".rsconscache"
|
||||
|
||||
# Prefix for phony cache entries.
|
||||
PHONY_PREFIX = ":PHONY:"
|
||||
|
||||
@@ -70,6 +67,11 @@ module Rscons
|
||||
initialize!
|
||||
end
|
||||
|
||||
# Get the path to the cache file.
|
||||
def cache_file
|
||||
File.join(Rscons.application.build_dir, ".rsconscache")
|
||||
end
|
||||
|
||||
# Access cache value.
|
||||
def [](key)
|
||||
@cache[key]
|
||||
@@ -84,7 +86,7 @@ module Rscons
|
||||
#
|
||||
# @return [void]
|
||||
def clear
|
||||
FileUtils.rm_f(CACHE_FILE)
|
||||
FileUtils.rm_f(cache_file)
|
||||
initialize!
|
||||
end
|
||||
|
||||
@@ -100,7 +102,7 @@ module Rscons
|
||||
# @return [void]
|
||||
def write
|
||||
@cache["version"] = VERSION
|
||||
File.open(CACHE_FILE, "w") do |fh|
|
||||
File.open(cache_file, "w") do |fh|
|
||||
fh.puts(JSON.dump(@cache))
|
||||
end
|
||||
end
|
||||
@@ -360,9 +362,9 @@ module Rscons
|
||||
# Create a Cache object and load in the previous contents from the cache
|
||||
# file.
|
||||
def initialize!
|
||||
@cache = JSON.load(File.read(CACHE_FILE)) rescue {}
|
||||
@cache = JSON.load(File.read(cache_file)) rescue {}
|
||||
unless @cache.is_a?(Hash)
|
||||
$stderr.puts "Warning: #{CACHE_FILE} was corrupt. Contents:\n#{@cache.inspect}"
|
||||
$stderr.puts "Warning: #{cache_file} was corrupt. Contents:\n#{@cache.inspect}"
|
||||
@cache = {}
|
||||
end
|
||||
@cache["targets"] ||= {}
|
||||
|
||||
+8
-10
@@ -6,11 +6,14 @@ USAGE = <<EOF
|
||||
Usage: #{$0} [global options] [operation] [operation 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
|
||||
--version Show rscons version and exit
|
||||
-h, --help Show rscons help and exit
|
||||
-j N, --nthreads=N Set number of threads (local default: #{Rscons.application.n_threads})
|
||||
-r COLOR, --color=COLOR Set color mode (off, auto, force)
|
||||
-v, --verbose Run verbosely
|
||||
--version Show rscons version and exit
|
||||
|
||||
Operations:
|
||||
configure Configure the project
|
||||
@@ -21,12 +24,7 @@ Operations:
|
||||
uninstall Uninstall project from installation destination
|
||||
|
||||
Configure options:
|
||||
-b BUILD, --build=BUILD Set build directory (default: build)
|
||||
--prefix=PREFIX Set installation prefix (default: /usr/local)
|
||||
|
||||
Build options:
|
||||
-j N, --nthreads=N Set number of threads (local default: #{Rscons.application.n_threads})
|
||||
|
||||
EOF
|
||||
|
||||
module Rscons
|
||||
@@ -58,6 +56,10 @@ module Rscons
|
||||
private
|
||||
|
||||
def add_global_options(opts)
|
||||
opts.on("-b", "--build DIR") do |build_dir|
|
||||
Rscons.application.build_dir = build_dir
|
||||
end
|
||||
|
||||
opts.on("-j NTHREADS") do |n_threads|
|
||||
Rscons.application.n_threads = n_threads.to_i
|
||||
end
|
||||
@@ -158,10 +160,6 @@ module Rscons
|
||||
end
|
||||
|
||||
def parse_configure_args(opts, argv, options)
|
||||
opts.on("-b", "--build DIR") do |build_dir|
|
||||
options[:build_dir] = build_dir
|
||||
end
|
||||
|
||||
opts.on("--prefix PREFIX") do |prefix|
|
||||
options[:prefix] = prefix
|
||||
end
|
||||
|
||||
+55
-55
@@ -5,37 +5,29 @@ module Rscons
|
||||
# Class to manage a configure operation.
|
||||
class ConfigureOp
|
||||
|
||||
# Exception raised when a configuration error occurs.
|
||||
class ConfigureFailure < Exception; end
|
||||
|
||||
# Create a ConfigureOp.
|
||||
#
|
||||
# @param options [Hash]
|
||||
# Optional parameters.
|
||||
# @option options [String] :build_dir
|
||||
# Build directory.
|
||||
# @option options [String] :prefix
|
||||
# Install prefix.
|
||||
# @option options [String] :project_name
|
||||
# Project name.
|
||||
def initialize(options)
|
||||
# Default options.
|
||||
options[:build_dir] ||= "build"
|
||||
options[:prefix] ||= "/usr/local"
|
||||
@work_dir = "#{options[:build_dir]}/configure"
|
||||
@work_dir = "#{Rscons.application.build_dir}/_configure"
|
||||
FileUtils.mkdir_p(@work_dir)
|
||||
@log_fh = File.open("#{@work_dir}/config.log", "wb")
|
||||
cache = Cache.instance
|
||||
cache["failed_commands"] = []
|
||||
cache["configuration_data"] = {}
|
||||
cache["configuration_data"]["build_dir"] = options[:build_dir]
|
||||
cache["configuration_data"]["prefix"] = options[:prefix]
|
||||
if project_name = options[:project_name]
|
||||
Ansi.write($stdout, "Configuring ", :cyan, project_name, :reset, "...\n")
|
||||
else
|
||||
$stdout.puts "Configuring project..."
|
||||
end
|
||||
Ansi.write($stdout, "Setting build directory... ", :green, options[:build_dir], :reset, "\n")
|
||||
Ansi.write($stdout, "Setting prefix... ", :green, options[:prefix], :reset, "\n")
|
||||
store_merge("prefix" => options[:prefix])
|
||||
end
|
||||
@@ -62,6 +54,10 @@ module Rscons
|
||||
# @return [void]
|
||||
def check_c_compiler(*ccc)
|
||||
$stdout.write("Checking for C compiler... ")
|
||||
options = {}
|
||||
if ccc.last.is_a?(Hash)
|
||||
options = ccc.slice!(-1)
|
||||
end
|
||||
if ccc.empty?
|
||||
# Default C compiler search array.
|
||||
ccc = %w[gcc clang]
|
||||
@@ -69,7 +65,7 @@ module Rscons
|
||||
cc = ccc.find do |cc|
|
||||
test_c_compiler(cc)
|
||||
end
|
||||
complete(cc ? 0 : 1, success_message: cc)
|
||||
complete(cc ? 0 : 1, options.merge(success_message: cc))
|
||||
end
|
||||
|
||||
# Check for a working C++ compiler.
|
||||
@@ -80,6 +76,10 @@ module Rscons
|
||||
# @return [void]
|
||||
def check_cxx_compiler(*ccc)
|
||||
$stdout.write("Checking for C++ compiler... ")
|
||||
options = {}
|
||||
if ccc.last.is_a?(Hash)
|
||||
options = ccc.slice!(-1)
|
||||
end
|
||||
if ccc.empty?
|
||||
# Default C++ compiler search array.
|
||||
ccc = %w[g++ clang++]
|
||||
@@ -87,7 +87,7 @@ module Rscons
|
||||
cc = ccc.find do |cc|
|
||||
test_cxx_compiler(cc)
|
||||
end
|
||||
complete(cc ? 0 : 1, success_message: cc)
|
||||
complete(cc ? 0 : 1, options.merge(success_message: cc))
|
||||
end
|
||||
|
||||
# Check for a working D compiler.
|
||||
@@ -98,6 +98,10 @@ module Rscons
|
||||
# @return [void]
|
||||
def check_d_compiler(*cdc)
|
||||
$stdout.write("Checking for D compiler... ")
|
||||
options = {}
|
||||
if cdc.last.is_a?(Hash)
|
||||
options = cdc.slice!(-1)
|
||||
end
|
||||
if cdc.empty?
|
||||
# Default D compiler search array.
|
||||
cdc = %w[gdc ldc2]
|
||||
@@ -105,7 +109,7 @@ module Rscons
|
||||
dc = cdc.find do |dc|
|
||||
test_d_compiler(dc)
|
||||
end
|
||||
complete(dc ? 0 : 1, success_message: dc)
|
||||
complete(dc ? 0 : 1, options.merge(success_message: dc))
|
||||
end
|
||||
|
||||
# Check for a package or configure program output.
|
||||
@@ -280,12 +284,19 @@ module Rscons
|
||||
|
||||
# Execute a test command and log the result.
|
||||
#
|
||||
# @param command [Array<String>]
|
||||
# Command to execute.
|
||||
# @param options [Hash]
|
||||
# Optional arguments.
|
||||
# @option options [String] :stdin
|
||||
# Data to send to standard input stream of the executed command.
|
||||
#
|
||||
# @return [String, String, Process::Status]
|
||||
# stdout, stderr, status
|
||||
def log_and_test_command(command)
|
||||
def log_and_test_command(command, options = {})
|
||||
begin
|
||||
@log_fh.puts("Command: #{command.join(" ")}")
|
||||
stdout, stderr, status = Open3.capture3(*command)
|
||||
stdout, stderr, status = Open3.capture3(*command, stdin_data: options[:stdin])
|
||||
@log_fh.puts("Exit status: #{status.to_i}")
|
||||
@log_fh.write(stdout)
|
||||
@log_fh.write(stderr)
|
||||
@@ -380,11 +391,15 @@ module Rscons
|
||||
else
|
||||
!options[:set_define]
|
||||
end
|
||||
color = should_fail ? :red : :yellow
|
||||
Ansi.write($stdout, color, "#{fail_message}\n")
|
||||
if options[:on_fail].is_a?(String)
|
||||
$stdout.puts(options[:on_fail])
|
||||
elsif options[:on_fail].is_a?(Proc)
|
||||
options[:on_fail].call
|
||||
end
|
||||
if should_fail
|
||||
Ansi.write($stdout, :red, "#{fail_message}\n")
|
||||
raise ConfigureFailure.new
|
||||
else
|
||||
Ansi.write($stdout, :yellow, "#{fail_message}\n")
|
||||
raise RsconsError.new
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -401,22 +416,17 @@ module Rscons
|
||||
def test_c_compiler(cc)
|
||||
File.open("#{@work_dir}/cfgtest.c", "wb") do |fh|
|
||||
fh.puts <<-EOF
|
||||
#include <stdio.h>
|
||||
int main(int argc, char * argv[]) {
|
||||
printf("Success.\\n");
|
||||
return 0;
|
||||
int fun(int val) {
|
||||
return val * 2;
|
||||
}
|
||||
EOF
|
||||
end
|
||||
command = %W[#{cc} -o #{@work_dir}/cfgtest.exe #{@work_dir}/cfgtest.c]
|
||||
command = %W[#{cc} -c -o #{@work_dir}/cfgtest.o #{@work_dir}/cfgtest.c]
|
||||
merge = {"CC" => cc}
|
||||
_, _, status = log_and_test_command(command)
|
||||
if status == 0
|
||||
stdout, _, status = log_and_test_command(["#{@work_dir}/cfgtest.exe"])
|
||||
if status == 0 and stdout =~ /Success/
|
||||
store_merge(merge)
|
||||
true
|
||||
end
|
||||
store_merge(merge)
|
||||
true
|
||||
end
|
||||
end
|
||||
|
||||
@@ -430,23 +440,18 @@ module Rscons
|
||||
def test_cxx_compiler(cc)
|
||||
File.open("#{@work_dir}/cfgtest.cxx", "wb") do |fh|
|
||||
fh.puts <<-EOF
|
||||
#include <iostream>
|
||||
using namespace std;
|
||||
int main(int argc, char * argv[]) {
|
||||
cout << "Success." << endl;
|
||||
return 0;
|
||||
template<typename T>
|
||||
T fun(T val) {
|
||||
return val * 2;
|
||||
}
|
||||
EOF
|
||||
end
|
||||
command = %W[#{cc} -o #{@work_dir}/cfgtest.exe #{@work_dir}/cfgtest.cxx]
|
||||
command = %W[#{cc} -c -o #{@work_dir}/cfgtest.o #{@work_dir}/cfgtest.cxx]
|
||||
merge = {"CXX" => cc}
|
||||
_, _, status = log_and_test_command(command)
|
||||
if status == 0
|
||||
stdout, _, status = log_and_test_command(["#{@work_dir}/cfgtest.exe"])
|
||||
if status == 0 and stdout =~ /Success/
|
||||
store_merge(merge)
|
||||
true
|
||||
end
|
||||
store_merge(merge)
|
||||
true
|
||||
end
|
||||
end
|
||||
|
||||
@@ -460,9 +465,8 @@ module Rscons
|
||||
def test_d_compiler(dc)
|
||||
File.open("#{@work_dir}/cfgtest.d", "wb") do |fh|
|
||||
fh.puts <<-EOF
|
||||
import std.stdio;
|
||||
int main() {
|
||||
writeln("Success.");
|
||||
import core.math;
|
||||
int fun() {
|
||||
return 0;
|
||||
}
|
||||
EOF
|
||||
@@ -470,29 +474,25 @@ module Rscons
|
||||
[:gdc, :ldc2].find do |dc_test|
|
||||
case dc_test
|
||||
when :gdc
|
||||
command = %W[#{dc} -o #{@work_dir}/cfgtest.exe #{@work_dir}/cfgtest.d]
|
||||
command = %W[#{dc} -c -o #{@work_dir}/cfgtest.o #{@work_dir}/cfgtest.d]
|
||||
merge = {"DC" => dc}
|
||||
when :ldc2
|
||||
command = %W[#{dc} -of #{@work_dir}/cfgtest.exe #{@work_dir}/cfgtest.d]
|
||||
# ldc2 on Windows expect an object file suffix of .obj.
|
||||
ldc_objsuffix = RUBY_PLATFORM =~ /mingw|msys/ ? ".obj" : ".o"
|
||||
command = %W[#{dc} -c -of #{@work_dir}/cfgtest#{ldc_objsuffix} #{@work_dir}/cfgtest.d]
|
||||
env = BasicEnvironment.new
|
||||
merge = {
|
||||
"DC" => dc,
|
||||
"DCCMD" => env["DCCMD"].map {|e| if e == "-o"; "-of"; else; e; end},
|
||||
"LDCMD" => env["LDCMD"].map {|e| if e == "-o"; "-of"; else; e; end},
|
||||
"DCCMD" => env["DCCMD"].map {|e| e.sub(/^-o$/, "-of")},
|
||||
"LDCMD" => env["LDCMD"].map {|e| e.sub(/^-o$/, "-of")},
|
||||
"DDEPGEN" => ["-deps=${_DEPFILE}"],
|
||||
}
|
||||
if RUBY_PLATFORM =~ /mingw/
|
||||
# ldc2 on Windows expect an object file suffix of .obj.
|
||||
merge["OBJSUFFIX"] = %w[.obj]
|
||||
end
|
||||
merge["OBJSUFFIX"] = [ldc_objsuffix]
|
||||
end
|
||||
_, _, status = log_and_test_command(command)
|
||||
if status == 0
|
||||
stdout, _, status = log_and_test_command(["#{@work_dir}/cfgtest.exe"])
|
||||
if status == 0 and stdout =~ /Success/
|
||||
store_merge(merge)
|
||||
true
|
||||
end
|
||||
store_merge(merge)
|
||||
true
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
module Rscons
|
||||
|
||||
on_windows = RUBY_PLATFORM =~ /mingw|cygwin/
|
||||
on_windows = RUBY_PLATFORM =~ /mingw|msys|cygwin/
|
||||
pic_flags = on_windows ? [] : %w[-fPIC]
|
||||
|
||||
# Default Rscons construction variables.
|
||||
@@ -80,6 +80,9 @@ module Rscons
|
||||
"SHLIBLINKPREFIX" => "-l",
|
||||
"SHLIBPREFIX" => on_windows ? "" : "lib",
|
||||
"SHLIBSUFFIX" => on_windows ? ".dll" : ".so",
|
||||
"SIZE" => "size",
|
||||
"SIZECMD" => %w[${SIZE} ${SIZEFLAGS} ${_SOURCES}],
|
||||
"SIZEFLAGS" => [],
|
||||
"YACC" => "bison",
|
||||
"YACCSUFFIX" => %w[.y .yy],
|
||||
"YACC_CMD" => %w[${YACC} ${YACC_FLAGS} -o ${_TARGET} ${_SOURCES}],
|
||||
|
||||
+23
-17
@@ -1,7 +1,6 @@
|
||||
require "fileutils"
|
||||
require "set"
|
||||
require "shellwords"
|
||||
require "thwait"
|
||||
|
||||
module Rscons
|
||||
# The Environment class is the main programmatic interface to Rscons. It
|
||||
@@ -52,6 +51,10 @@ module Rscons
|
||||
# global Rscons.application.n_threads value.
|
||||
attr_accessor :n_threads
|
||||
|
||||
# @return [String]
|
||||
# Environment name.
|
||||
attr_reader :name
|
||||
|
||||
# Create an Environment object.
|
||||
#
|
||||
# @param options [Hash]
|
||||
@@ -59,6 +62,9 @@ module Rscons
|
||||
# :command, :short, or :off (default :short)
|
||||
# @option options [Boolean] :exclude_builders
|
||||
# Whether to omit adding default builders (default false)
|
||||
# @option options [String, nil] :name
|
||||
# Environment name. This determines the folder name used to store all
|
||||
# environment build files under the top-level build directory.
|
||||
# @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.
|
||||
@@ -98,7 +104,8 @@ module Rscons
|
||||
else
|
||||
:short
|
||||
end
|
||||
@build_root = "#{Cache.instance["configuration_data"]["build_dir"]}/e.#{@id}"
|
||||
@name = options[:name] || "e.#{@id}"
|
||||
@build_root = "#{Rscons.application.build_dir}/#{@name}"
|
||||
@n_threads = Rscons.application.n_threads
|
||||
|
||||
if block_given?
|
||||
@@ -126,14 +133,14 @@ module Rscons
|
||||
#
|
||||
# @return [Environment] The newly created {Environment} object.
|
||||
def clone(options = {})
|
||||
options = options.dup
|
||||
clone = options[:clone] || :all
|
||||
clone = Set[:variables, :builders, :build_hooks] if clone == :all
|
||||
clone = Set[] if clone == :none
|
||||
clone = Set.new(clone) if clone.is_a?(Array)
|
||||
clone.delete(:builders) if options[:exclude_builders]
|
||||
env = self.class.new(
|
||||
echo: options[:echo] || @echo,
|
||||
exclude_builders: true)
|
||||
options[:echo] ||= @echo
|
||||
env = self.class.new(options.merge(exclude_builders: true))
|
||||
if clone.include?(:builders)
|
||||
@builders.each do |builder_name, builder|
|
||||
env.add_builder(builder)
|
||||
@@ -251,7 +258,7 @@ module Rscons
|
||||
if extra_path = builder_class.extra_path
|
||||
extra_path = "/#{extra_path}"
|
||||
end
|
||||
"#{@build_root}#{extra_path}/#{Util.make_relative_path(Rscons.set_suffix(source_fname, suffix))}".gsub("\\", "/")
|
||||
"#{@build_root}#{extra_path}/#{Util.make_relative_path("#{source_fname}#{suffix}")}".gsub("\\", "/")
|
||||
end
|
||||
|
||||
# Build all build targets specified in the Environment.
|
||||
@@ -287,9 +294,9 @@ module Rscons
|
||||
unless @process_failures.empty?
|
||||
msg = @process_failures.join("\n")
|
||||
if Cache.instance["failed_commands"].size > 0
|
||||
msg += "\nUse -F to view the failed command log from the previous build operation"
|
||||
msg += "\nUse `#{Util.command_to_execute_me} -F` to view the failed command log from the previous build operation"
|
||||
end
|
||||
raise BuildError.new(msg)
|
||||
raise RsconsError.new(msg)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -347,12 +354,12 @@ module Rscons
|
||||
if target.is_a?(Builder)
|
||||
target = target.target
|
||||
end
|
||||
target = expand_varref(target.to_s)
|
||||
target = expand_path(expand_varref(target.to_s))
|
||||
user_deps = user_deps.map do |ud|
|
||||
if ud.is_a?(Builder)
|
||||
ud = ud.target
|
||||
end
|
||||
expand_varref(ud)
|
||||
expand_path(expand_varref(ud))
|
||||
end
|
||||
@user_deps[target] ||= []
|
||||
@user_deps[target] = (@user_deps[target] + user_deps).uniq
|
||||
@@ -468,10 +475,12 @@ module Rscons
|
||||
output_fname
|
||||
end
|
||||
|
||||
# Expand a path to be relative to the Environment's build root.
|
||||
# Expand paths.
|
||||
#
|
||||
# Paths beginning with "^/" are expanded by replacing "^" with the
|
||||
# Environment's build root.
|
||||
# Environment's build root (e.g. "build/envname").
|
||||
# Paths beginning with "^^/" are expanded by replacing "^^" with the
|
||||
# top-level build directory (e.g. "build").
|
||||
#
|
||||
# @param path [String, Array<String>]
|
||||
# The path(s) to expand.
|
||||
@@ -486,7 +495,7 @@ module Rscons
|
||||
expand_path(path)
|
||||
end
|
||||
else
|
||||
path.sub(%r{^\^(?=[\\/])}, @build_root).gsub("\\", "/")
|
||||
path.sub(%r{^\^\^(?=[\\/])}, Rscons.application.build_dir).sub(%r{^\^(?=[\\/])}, @build_root).gsub("\\", "/")
|
||||
end
|
||||
end
|
||||
|
||||
@@ -702,10 +711,7 @@ module Rscons
|
||||
!thread.alive?
|
||||
end
|
||||
else
|
||||
if @threads.empty?
|
||||
raise "No threads to wait for"
|
||||
end
|
||||
ThreadsWait.new(*@threads.keys).next_wait
|
||||
Util.wait_for_thread(*@threads.keys)
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
+187
-27
@@ -3,32 +3,8 @@ module Rscons
|
||||
# The Script class encapsulates the state of a build script.
|
||||
class Script
|
||||
|
||||
# DSL available to the Rsconscript.
|
||||
class Dsl
|
||||
# Create a Dsl.
|
||||
def initialize(script)
|
||||
@script = script
|
||||
end
|
||||
|
||||
# Set the project name.
|
||||
def project_name(project_name)
|
||||
@script.project_name = project_name
|
||||
end
|
||||
|
||||
# Whether to automatically configure (default true).
|
||||
def autoconf(autoconf)
|
||||
@script.autoconf = autoconf
|
||||
end
|
||||
|
||||
# Enter build block.
|
||||
def build(&block)
|
||||
@script.operations["build"] = block
|
||||
end
|
||||
|
||||
# Enter configuration block.
|
||||
def configure(&block)
|
||||
@script.operations["configure"] = block
|
||||
end
|
||||
# Global DSL methods.
|
||||
class GlobalDsl
|
||||
|
||||
# Return a list of paths matching the specified pattern(s).
|
||||
#
|
||||
@@ -56,10 +32,194 @@ module Rscons
|
||||
end
|
||||
end.sort
|
||||
end
|
||||
|
||||
# Return path components from the PATH variable.
|
||||
#
|
||||
# @return [Array<String>]
|
||||
# Path components from the PATH variable.
|
||||
def path_components
|
||||
ENV["PATH"].split(File::PATH_SEPARATOR)
|
||||
end
|
||||
|
||||
# Prepend a path component to the PATH variable.
|
||||
#
|
||||
# @param path [String]
|
||||
# Path to prepend.
|
||||
#
|
||||
# @return [void]
|
||||
def path_prepend(path)
|
||||
path_set([File.expand_path(path)] + path_components)
|
||||
end
|
||||
|
||||
# Append a path component to the PATH variable.
|
||||
#
|
||||
# @param path [String]
|
||||
# Path to append.
|
||||
#
|
||||
# @return [void]
|
||||
def path_append(path)
|
||||
path_set(path_components + [File.expand_path(path)])
|
||||
end
|
||||
|
||||
# Set the PATH variable.
|
||||
#
|
||||
# @param new_path [String, Array<String>]
|
||||
# New PATH variable value as an array or string.
|
||||
#
|
||||
# @return [void]
|
||||
def path_set(new_path)
|
||||
if new_path.is_a?(Array)
|
||||
new_path = new_path.join(File::PATH_SEPARATOR)
|
||||
end
|
||||
ENV["PATH"] = new_path
|
||||
end
|
||||
|
||||
# Invoke rscons in a subprocess for a subsidiary Rsconscript file.
|
||||
#
|
||||
# @param path [String]
|
||||
# Path to subsidiary Rsconscript to execute, or path to subsidiary
|
||||
# directory to run rscons in.
|
||||
# @param args[Array<String>]
|
||||
# Arguments to pass to rscons subprocess.
|
||||
def rscons(path, *args)
|
||||
rscons_path = File.expand_path($0)
|
||||
path = File.expand_path(path)
|
||||
if File.directory?(path)
|
||||
command = [*args]
|
||||
dir = path
|
||||
else
|
||||
command = ["-f", path, *args]
|
||||
dir = File.dirname(path)
|
||||
end
|
||||
if File.exist?("#{dir}/rscons")
|
||||
rscons_path = "#{dir}/rscons"
|
||||
end
|
||||
command = [rscons_path] + command
|
||||
print_dir = dir != "." && dir != File.expand_path(Dir.pwd)
|
||||
if ENV["specs"] and not ENV["dist_specs"] # specs
|
||||
command = ["ruby", $LOAD_PATH.map {|p| ["-I", p]}, command].flatten # specs
|
||||
end # specs
|
||||
puts "rscons: Entering directory '#{dir}'" if print_dir
|
||||
result = system(*command, chdir: dir)
|
||||
puts "rscons: Leaving directory '#{dir}'" if print_dir
|
||||
unless result
|
||||
raise RsconsError.new("Failed command: " + command.join(" "))
|
||||
end
|
||||
end
|
||||
|
||||
# Execute a shell command, exiting on failure.
|
||||
# The behavior to exit on failure is suppressed if the +:continue+
|
||||
# option is given.
|
||||
#
|
||||
# @overload sh(command, options = {})
|
||||
# @param command [String, Array<String>]
|
||||
# Command to execute. The command is executed and interpreted by the
|
||||
# system shell when given as a single string. It is not passed to the
|
||||
# system shell if the array size is greater than 1.
|
||||
# @param options [Hash]
|
||||
# Options.
|
||||
# @option options [Boolean] :continue
|
||||
# If set to +true+, rscons will continue executing afterward, even if
|
||||
# the command fails.
|
||||
#
|
||||
# @overload sh(*command, options = {})
|
||||
# @param command [String, Array<String>]
|
||||
# Command to execute. The command is executed and interpreted by the
|
||||
# system shell when given as a single string. It is not passed to the
|
||||
# system shell if the array size is greater than 1.
|
||||
# @param options [Hash]
|
||||
# Options.
|
||||
# @option options [Boolean] :continue
|
||||
# If set to +true+, rscons will continue executing afterward, even if
|
||||
# the command fails.
|
||||
def sh(*command)
|
||||
options = {}
|
||||
if command.last.is_a?(Hash)
|
||||
options = command.slice!(-1)
|
||||
end
|
||||
if command.size == 1 && command[0].is_a?(Array)
|
||||
command = command[0]
|
||||
end
|
||||
if Rscons.application.verbose
|
||||
if command.size > 1
|
||||
puts Util.command_to_s(command)
|
||||
else
|
||||
puts command[0]
|
||||
end
|
||||
end
|
||||
begin
|
||||
system(*command, exception: true)
|
||||
rescue StandardError => e
|
||||
message = "#{e.backtrace[2]}: #{e.message}"
|
||||
if options[:continue]
|
||||
Ansi.write($stderr, :red, message, :reset, "\n")
|
||||
else
|
||||
raise RsconsError.new(message)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
[
|
||||
:cd,
|
||||
:chmod,
|
||||
:chmod_R,
|
||||
:chown,
|
||||
:chown_R,
|
||||
:cp,
|
||||
:cp_lr,
|
||||
:cp_r,
|
||||
:install,
|
||||
:ln,
|
||||
:ln_s,
|
||||
:ln_sf,
|
||||
:mkdir,
|
||||
:mkdir_p,
|
||||
:mv,
|
||||
:pwd,
|
||||
:rm,
|
||||
:rm_f,
|
||||
:rm_r,
|
||||
:rm_rf,
|
||||
:rmdir,
|
||||
:touch,
|
||||
].each do |method|
|
||||
define_method(method) do |*args, **kwargs, &block|
|
||||
FileUtils.__send__(method, *args, **kwargs, &block)
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# Top-level DSL available to the Rsconscript.
|
||||
class Dsl < GlobalDsl
|
||||
# Create a Dsl.
|
||||
def initialize(script)
|
||||
@script = script
|
||||
end
|
||||
|
||||
# Set the project name.
|
||||
def project_name(project_name)
|
||||
@script.project_name = project_name
|
||||
end
|
||||
|
||||
# Whether to automatically configure (default true).
|
||||
def autoconf(autoconf)
|
||||
@script.autoconf = autoconf
|
||||
end
|
||||
|
||||
# Enter build block.
|
||||
def build(&block)
|
||||
@script.operations["build"] = block
|
||||
end
|
||||
|
||||
# Enter configuration block.
|
||||
def configure(&block)
|
||||
@script.operations["configure"] = block
|
||||
end
|
||||
end
|
||||
|
||||
# DSL available to the 'configure' block.
|
||||
class ConfigureDsl
|
||||
class ConfigureDsl < GlobalDsl
|
||||
# Create a ConfigureDsl.
|
||||
#
|
||||
# @param configure_op [ConfigureOp]
|
||||
|
||||
+54
-15
@@ -9,7 +9,7 @@ module Rscons
|
||||
#
|
||||
# @return [Boolean] Whether the given path is an absolute filesystem path.
|
||||
def absolute_path?(path)
|
||||
if RUBY_PLATFORM =~ /mingw/
|
||||
if RUBY_PLATFORM =~ /mingw|msys/
|
||||
path =~ %r{^(?:\w:)?[\\/]}
|
||||
else
|
||||
path.start_with?("/")
|
||||
@@ -48,7 +48,7 @@ module Rscons
|
||||
# @return [String]
|
||||
# The string representation of the command.
|
||||
def command_to_s(command)
|
||||
command.map { |c| c =~ /\s/ ? "'#{c}'" : c }.join(' ')
|
||||
command.map { |c| c[" "] ? "'#{c.gsub("'", "'\\\\''")}'" : c }.join(" ")
|
||||
end
|
||||
|
||||
# Determine the number of threads to use by default.
|
||||
@@ -68,8 +68,8 @@ module Rscons
|
||||
case RbConfig::CONFIG["host_os"]
|
||||
when /linux/
|
||||
return File.read("/proc/cpuinfo").scan(/^processor\s*:/).size
|
||||
when /mswin|mingw/
|
||||
if `wmic cpu get NumberOfLogicalProcessors /value` =~ /NumberOfLogicalProcessors=(\d+)/
|
||||
when /mswin|mingw|msys/
|
||||
if `wmic cpu get NumberOfLogicalProcessors -value` =~ /NumberOfLogicalProcessors=(\d+)/
|
||||
return $1.to_i
|
||||
end
|
||||
when /darwin/
|
||||
@@ -191,6 +191,40 @@ module Rscons
|
||||
deps
|
||||
end
|
||||
|
||||
# Wait for any of a number of threads to complete.
|
||||
#
|
||||
# @param threads [Array<Thread>]
|
||||
# Threads to wait for.
|
||||
#
|
||||
# @return [Thread]
|
||||
# The Thread that completed.
|
||||
def wait_for_thread(*threads)
|
||||
if threads.empty?
|
||||
raise "No threads to wait for"
|
||||
end
|
||||
queue = Queue.new
|
||||
threads.each do |thread|
|
||||
# Create a wait thread for each thread we're waiting for.
|
||||
Thread.new do
|
||||
begin
|
||||
thread.join
|
||||
ensure
|
||||
queue.push(thread)
|
||||
end
|
||||
end
|
||||
end
|
||||
# Wait for any thread to complete.
|
||||
queue.pop
|
||||
end
|
||||
|
||||
# Command that can be run to execute this instance of rscons from the
|
||||
# current working directory.
|
||||
def command_to_execute_me
|
||||
command = Pathname.new(File.expand_path($0)).relative_path_from(Dir.pwd).to_s
|
||||
command = "./#{command}" unless command["/"]
|
||||
command
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Check if a directory contains a certain executable.
|
||||
@@ -199,21 +233,26 @@ module Rscons
|
||||
# Directory to look in.
|
||||
# @param executable [String]
|
||||
# Executable to look for.
|
||||
#
|
||||
# @return [String, nil]
|
||||
# Executable found.
|
||||
def test_path_for_executable(path_entry, executable)
|
||||
is_executable = lambda do |path|
|
||||
File.file?(path) and File.executable?(path)
|
||||
end
|
||||
if RbConfig::CONFIG["host_os"] =~ /mswin|windows|mingw/i
|
||||
executable = executable.downcase
|
||||
dir_entries = Dir.entries(path_entry)
|
||||
dir_entries.find do |entry|
|
||||
path = "#{path_entry}/#{entry}"
|
||||
entry = entry.downcase
|
||||
if ((entry == executable) or
|
||||
(entry == "#{executable}.exe") or
|
||||
(entry == "#{executable}.com") or
|
||||
(entry == "#{executable}.bat")) and is_executable[path]
|
||||
return path
|
||||
if RbConfig::CONFIG["host_os"] =~ /mswin|windows|mingw|msys/i
|
||||
if File.directory?(path_entry)
|
||||
executable = executable.downcase
|
||||
dir_entries = Dir.entries(path_entry)
|
||||
dir_entries.find do |entry|
|
||||
path = "#{path_entry}/#{entry}"
|
||||
entry = entry.downcase
|
||||
if ((entry == executable) or
|
||||
(entry == "#{executable}.exe") or
|
||||
(entry == "#{executable}.com") or
|
||||
(entry == "#{executable}.bat")) and is_executable[path]
|
||||
return path
|
||||
end
|
||||
end
|
||||
end
|
||||
else
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
module Rscons
|
||||
# Project version.
|
||||
VERSION = "2.0.0beta2"
|
||||
VERSION = "2.3.0"
|
||||
end
|
||||
@@ -1,6 +1,6 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>RScons User Guide<%= subpage_title %> - Version <%= Rscons::VERSION %></title>
|
||||
<title>Rscons User Guide<%= subpage_title %> - Version <%= Rscons::VERSION %></title>
|
||||
<style>
|
||||
body {
|
||||
background-color: #CCC;
|
||||
@@ -31,6 +31,11 @@
|
||||
.separator {
|
||||
height: 2em;
|
||||
}
|
||||
.img_block_center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
.page_nav {
|
||||
width: 100%;
|
||||
table-layout: fixed;
|
||||
|
||||
+7
-4
@@ -44,7 +44,7 @@ combine_files[START_FILE]
|
||||
# Strip Ruby comment lines and empty lines to save some space, but do not
|
||||
# remove lines that are in heredoc sections. This isn't terribly robust to be
|
||||
# used in the wild, but works for the heredoc instances for this project.
|
||||
stripped_comments = []
|
||||
stripped = []
|
||||
heredoc_end = nil
|
||||
combined_file.each do |line|
|
||||
if line =~ /<<-?([A-Z]+)/
|
||||
@@ -53,17 +53,20 @@ combined_file.each do |line|
|
||||
if heredoc_end and line =~ /^\s*#{heredoc_end}/
|
||||
heredoc_end = nil
|
||||
end
|
||||
if heredoc_end or not (line =~ /^\s*(#[^!].*)?$/)
|
||||
stripped_comments << line
|
||||
if line !~ /#\sspecs/
|
||||
if heredoc_end or line !~ /^\s*(#[^!].*)?$/
|
||||
stripped << line
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
require "zlib"
|
||||
require "base64"
|
||||
compressed_script = Zlib::Deflate.deflate(stripped_comments.join)
|
||||
compressed_script = Zlib::Deflate.deflate(stripped.join)
|
||||
encoded_compressed_script = Base64.encode64(compressed_script).gsub("\n", "")
|
||||
hash = Digest::MD5.hexdigest(encoded_compressed_script)
|
||||
|
||||
FileUtils.rm_rf(DIST)
|
||||
FileUtils.mkdir_p(DIST)
|
||||
File.open("#{DIST}/#{PROG_NAME}", "wb", 0755) do |fh|
|
||||
fh.write(<<EOF)
|
||||
|
||||
@@ -154,7 +154,8 @@ class Generator
|
||||
end
|
||||
|
||||
def render_toc
|
||||
toc_content = %[<h1>Table of Contents</h1>\n]
|
||||
toc_content = %[<img class="img_block_center" src="rscons_logo_1000.png" />]
|
||||
toc_content += %[<h1>Table of Contents</h1>\n]
|
||||
@sections.each do |section|
|
||||
indent = section.number.split(".").size - 1
|
||||
toc_content += %[<span style="padding-left: #{4 * indent}ex;">]
|
||||
@@ -223,5 +224,6 @@ end
|
||||
input = load_file("doc/user_guide.md")
|
||||
FileUtils.rm_rf("gen/user_guide")
|
||||
FileUtils.mkdir_p("gen/user_guide")
|
||||
FileUtils.cp("img/rscons_logo_1000.png", "gen/user_guide")
|
||||
Generator.new(input, "gen/user_guide/user_guide.html", false)
|
||||
Generator.new(input, "gen/user_guide", true)
|
||||
+530
-183
File diff suppressed because it is too large.
Load diff
@@ -68,7 +68,7 @@ EOF
|
||||
expect(RbConfig::CONFIG).to receive(:[]).with("host_os").and_return("mingw")
|
||||
end
|
||||
it "returns the number of logical processors that wmic reports" do
|
||||
expect(Util).to receive(:`).with("wmic cpu get NumberOfLogicalProcessors /value").and_return("NumberOfLogicalProcessors=7")
|
||||
expect(Util).to receive(:`).with("wmic cpu get NumberOfLogicalProcessors -value").and_return("NumberOfLogicalProcessors=7")
|
||||
expect(Util.determine_n_threads).to eq(7)
|
||||
end
|
||||
end
|
||||
@@ -121,7 +121,10 @@ EOF
|
||||
before(:each) do
|
||||
stub_const("File::PATH_SEPARATOR", ";")
|
||||
stub_const("RbConfig::CONFIG", "host_os" => "mingw")
|
||||
expect(ENV).to receive(:[]).with("PATH").and_return("C:\\bin;C:\\Windows")
|
||||
expect(ENV).to receive(:[]).with("PATH").and_return("C:\\none;C:\\bin;C:\\Windows")
|
||||
allow(File).to receive(:directory?).with("C:\\none").and_return(false)
|
||||
allow(File).to receive(:directory?).with("C:\\bin").and_return(true)
|
||||
allow(File).to receive(:directory?).with("C:\\Windows").and_return(true)
|
||||
allow(Dir).to receive(:entries).with("C:\\bin").and_return(%w[one.com])
|
||||
allow(Dir).to receive(:entries).with("C:\\Windows").and_return(%w[two.exe Three.bat])
|
||||
end
|
||||
|
||||
@@ -1,15 +1,5 @@
|
||||
describe Rscons do
|
||||
|
||||
describe ".set_suffix" do
|
||||
it "changes the suffix to the new one" do
|
||||
expect(Rscons.set_suffix("foo.c", ".h")).to eq("foo.h")
|
||||
end
|
||||
|
||||
it "appends a suffix if the given file name does not have one" do
|
||||
expect(Rscons.set_suffix("bazz", ".d")).to eq("bazz.d")
|
||||
end
|
||||
end
|
||||
|
||||
describe ".get_system_shell" do
|
||||
before(:each) do
|
||||
Rscons.instance_variable_set(:@shell, nil)
|
||||
|
||||
+20
-20
@@ -1,25 +1,25 @@
|
||||
require "simplecov"
|
||||
|
||||
SimpleCov.start do
|
||||
add_filter "/spec/"
|
||||
add_filter "/.bundle/"
|
||||
if ENV["partial_specs"]
|
||||
command_name "RSpec-partial"
|
||||
else
|
||||
command_name "RSpec"
|
||||
end
|
||||
if ENV["dist_specs"]
|
||||
add_filter "/bin/"
|
||||
add_filter "/lib/"
|
||||
else
|
||||
add_filter "test/rscons.rb"
|
||||
end
|
||||
project_name "Rscons"
|
||||
merge_timeout 3600
|
||||
end
|
||||
|
||||
if ENV["dist_specs"]
|
||||
require_relative "../test/rscons"
|
||||
else
|
||||
require "simplecov"
|
||||
|
||||
SimpleCov.start do
|
||||
add_filter "/spec/"
|
||||
add_filter "/.bundle/"
|
||||
if ENV["partial_specs"]
|
||||
command_name "RSpec-partial"
|
||||
else
|
||||
command_name "RSpec"
|
||||
end
|
||||
if ENV["dist_specs"]
|
||||
add_filter "/bin/"
|
||||
add_filter "/lib/"
|
||||
else
|
||||
add_filter "test/rscons.rb"
|
||||
end
|
||||
project_name "Rscons"
|
||||
merge_timeout 3600
|
||||
end
|
||||
|
||||
require "rscons"
|
||||
end
|
||||
Reference in new issue
Block a user