zig/std/build.zig

1556 lines
53 KiB
Zig

const io = @import("io.zig");
const mem = @import("mem.zig");
const debug = @import("debug.zig");
const assert = debug.assert;
const List = @import("list.zig").List;
const HashMap = @import("hash_map.zig").HashMap;
const Allocator = @import("mem.zig").Allocator;
const os = @import("os/index.zig");
const StdIo = os.ChildProcess.StdIo;
const Term = os.ChildProcess.Term;
const BufSet = @import("buf_set.zig").BufSet;
const BufMap = @import("buf_map.zig").BufMap;
const fmt_lib = @import("fmt.zig");
error ExtraArg;
error UncleanExit;
error InvalidStepName;
error DependencyLoopDetected;
error NoCompilerFound;
error NeedAnObject;
pub const Builder = struct {
uninstall_tls: TopLevelStep,
have_uninstall_step: bool,
allocator: &Allocator,
lib_paths: List([]const u8),
include_paths: List([]const u8),
rpaths: List([]const u8),
user_input_options: UserInputOptionsMap,
available_options_map: AvailableOptionsMap,
available_options_list: List(AvailableOption),
verbose: bool,
invalid_user_input: bool,
zig_exe: []const u8,
default_step: &Step,
env_map: BufMap,
top_level_steps: List(&TopLevelStep),
prefix: []const u8,
lib_dir: []const u8,
installed_files: List([]const u8),
build_root: []const u8,
cache_root: []const u8,
const UserInputOptionsMap = HashMap([]const u8, UserInputOption, mem.hash_slice_u8, mem.eql_slice_u8);
const AvailableOptionsMap = HashMap([]const u8, AvailableOption, mem.hash_slice_u8, mem.eql_slice_u8);
const AvailableOption = struct {
name: []const u8,
type_id: TypeId,
description: []const u8,
};
const UserInputOption = struct {
name: []const u8,
value: UserValue,
used: bool,
};
const UserValue = enum {
Flag,
Scalar: []const u8,
List: List([]const u8),
};
const TypeId = enum {
Bool,
Int,
Float,
String,
List,
};
const TopLevelStep = struct {
step: Step,
description: []const u8,
};
pub fn init(allocator: &Allocator, zig_exe: []const u8, build_root: []const u8,
cache_root: []const u8) -> Builder
{
var self = Builder {
.zig_exe = zig_exe,
.build_root = build_root,
.cache_root = cache_root,
.verbose = false,
.invalid_user_input = false,
.allocator = allocator,
.lib_paths = List([]const u8).init(allocator),
.include_paths = List([]const u8).init(allocator),
.rpaths = List([]const u8).init(allocator),
.user_input_options = UserInputOptionsMap.init(allocator),
.available_options_map = AvailableOptionsMap.init(allocator),
.available_options_list = List(AvailableOption).init(allocator),
.top_level_steps = List(&TopLevelStep).init(allocator),
.default_step = undefined,
.env_map = %%os.getEnvMap(allocator),
.prefix = undefined,
.lib_dir = undefined,
.installed_files = List([]const u8).init(allocator),
.uninstall_tls = TopLevelStep {
.step = Step.init("uninstall", allocator, makeUninstall),
.description = "Remove build artifacts from prefix path",
},
.have_uninstall_step = false,
};
self.processNixOSEnvVars();
self.default_step = self.step("default", "Build the project");
return self;
}
pub fn deinit(self: &Builder) {
self.lib_paths.deinit();
self.include_paths.deinit();
self.rpaths.deinit();
self.env_map.deinit();
self.top_level_steps.deinit();
}
pub fn setInstallPrefix(self: &Builder, maybe_prefix: ?[]const u8) {
self.prefix = maybe_prefix ?? "/usr/local"; // TODO better default
self.lib_dir = %%os.path.join(self.allocator, self.prefix, "lib");
}
pub fn addExecutable(self: &Builder, name: []const u8, root_src: ?[]const u8) -> &LibExeObjStep {
return LibExeObjStep.createExecutable(self, name, root_src);
}
pub fn addObject(self: &Builder, name: []const u8, root_src: []const u8) -> &LibExeObjStep {
return LibExeObjStep.createObject(self, name, root_src);
}
pub fn addSharedLibrary(self: &Builder, name: []const u8, root_src: ?[]const u8,
ver: &const Version) -> &LibExeObjStep
{
return LibExeObjStep.createSharedLibrary(self, name, root_src, ver);
}
pub fn addStaticLibrary(self: &Builder, name: []const u8, root_src: ?[]const u8) -> &LibExeObjStep {
return LibExeObjStep.createStaticLibrary(self, name, root_src);
}
pub fn addTest(self: &Builder, root_src: []const u8) -> &TestStep {
const test_step = %%self.allocator.create(TestStep);
*test_step = TestStep.init(self, root_src);
return test_step;
}
pub fn addAssemble(self: &Builder, name: []const u8, src: []const u8) -> &LibExeObjStep {
const obj_step = LibExeObjStep.createObject(self, name, null);
obj_step.addAssemblyFile(src);
return obj_step;
}
pub fn addCStaticLibrary(self: &Builder, name: []const u8) -> &CLibExeObjStep {
return CLibExeObjStep.createStaticLibrary(self, name);
}
pub fn addCSharedLibrary(self: &Builder, name: []const u8, ver: &const Version) -> &CLibExeObjStep {
return CLibExeObjStep.createSharedLibrary(self, name, ver);
}
pub fn addCExecutable(self: &Builder, name: []const u8) -> &CLibExeObjStep {
return CLibExeObjStep.createExecutable(self, name);
}
pub fn addCObject(self: &Builder, name: []const u8, src: []const u8) -> &CLibExeObjStep {
return CLibExeObjStep.createObject(self, name, src);
}
pub fn addCommand(self: &Builder, cwd: ?[]const u8, env_map: &const BufMap,
path: []const u8, args: []const []const u8) -> &CommandStep
{
return CommandStep.create(self, cwd, env_map, path, args);
}
pub fn addWriteFile(self: &Builder, file_path: []const u8, data: []const u8) -> &WriteFileStep {
const write_file_step = %%self.allocator.create(WriteFileStep);
*write_file_step = WriteFileStep.init(self, file_path, data);
return write_file_step;
}
pub fn addLog(self: &Builder, comptime format: []const u8, args: ...) -> &LogStep {
const data = self.fmt(format, args);
const log_step = %%self.allocator.create(LogStep);
*log_step = LogStep.init(self, data);
return log_step;
}
pub fn addRemoveDirTree(self: &Builder, dir_path: []const u8) -> &RemoveDirStep {
const remove_dir_step = %%self.allocator.create(RemoveDirStep);
*remove_dir_step = RemoveDirStep.init(self, dir_path);
return remove_dir_step;
}
pub fn version(self: &const Builder, major: u32, minor: u32, patch: u32) -> Version {
Version {
.major = major,
.minor = minor,
.patch = patch,
}
}
pub fn addCIncludePath(self: &Builder, path: []const u8) {
%%self.include_paths.append(path);
}
pub fn addRPath(self: &Builder, path: []const u8) {
%%self.rpaths.append(path);
}
pub fn addLibPath(self: &Builder, path: []const u8) {
%%self.lib_paths.append(path);
}
pub fn make(self: &Builder, step_names: []const []const u8) -> %void {
var wanted_steps = List(&Step).init(self.allocator);
defer wanted_steps.deinit();
if (step_names.len == 0) {
%%wanted_steps.append(&self.default_step);
} else {
for (step_names) |step_name| {
const s = %return self.getTopLevelStepByName(step_name);
%%wanted_steps.append(s);
}
}
for (wanted_steps.toSliceConst()) |s| {
%return self.makeOneStep(s);
}
}
pub fn getUninstallStep(self: &Builder) -> &Step {
if (self.have_uninstall_step)
return &self.uninstall_tls.step;
%%self.top_level_steps.append(&self.uninstall_tls);
self.have_uninstall_step = true;
return &self.uninstall_tls.step;
}
fn makeUninstall(uninstall_step: &Step) -> %void {
const uninstall_tls = @fieldParentPtr(TopLevelStep, "step", uninstall_step);
const self = @fieldParentPtr(Builder, "uninstall_tls", uninstall_tls);
for (self.installed_files.toSliceConst()) |installed_file| {
_ = os.deleteFile(self.allocator, installed_file);
}
// TODO remove empty directories
}
fn makeOneStep(self: &Builder, s: &Step) -> %void {
if (s.loop_flag) {
%%io.stderr.printf("Dependency loop detected:\n {}\n", s.name);
return error.DependencyLoopDetected;
}
s.loop_flag = true;
for (s.dependencies.toSlice()) |dep| {
self.makeOneStep(dep) %% |err| {
if (err == error.DependencyLoopDetected) {
%%io.stderr.printf(" {}\n", s.name);
}
return err;
};
}
s.loop_flag = false;
%return s.make();
}
fn getTopLevelStepByName(self: &Builder, name: []const u8) -> %&Step {
for (self.top_level_steps.toSliceConst()) |top_level_step| {
if (mem.eql(u8, top_level_step.step.name, name)) {
return &top_level_step.step;
}
}
%%io.stderr.printf("Cannot run step '{}' because it does not exist\n", name);
return error.InvalidStepName;
}
fn processNixOSEnvVars(self: &Builder) {
test (os.getEnv("NIX_CFLAGS_COMPILE")) |nix_cflags_compile| {
var it = mem.split(nix_cflags_compile, ' ');
while (true) {
const word = it.next() ?? break;
if (mem.eql(u8, word, "-isystem")) {
const include_path = it.next() ?? {
%%io.stderr.printf("Expected argument after -isystem in NIX_CFLAGS_COMPILE\n");
break;
};
self.addCIncludePath(include_path);
} else {
%%io.stderr.printf("Unrecognized C flag from NIX_CFLAGS_COMPILE: {}\n", word);
break;
}
}
}
test (os.getEnv("NIX_LDFLAGS")) |nix_ldflags| {
var it = mem.split(nix_ldflags, ' ');
while (true) {
const word = it.next() ?? break;
if (mem.eql(u8, word, "-rpath")) {
const rpath = it.next() ?? {
%%io.stderr.printf("Expected argument after -rpath in NIX_LDFLAGS\n");
break;
};
self.addRPath(rpath);
} else if (word.len > 2 and word[0] == '-' and word[1] == 'L') {
const lib_path = word[2...];
self.addLibPath(lib_path);
} else {
%%io.stderr.printf("Unrecognized C flag from NIX_LDFLAGS: {}\n", word);
break;
}
}
}
}
pub fn option(self: &Builder, comptime T: type, name: []const u8, description: []const u8) -> ?T {
const type_id = comptime typeToEnum(T);
const available_option = AvailableOption {
.name = name,
.type_id = type_id,
.description = description,
};
test (%%self.available_options_map.put(name, available_option)) {
debug.panic("Option '{}' declared twice", name);
}
%%self.available_options_list.append(available_option);
const entry = self.user_input_options.get(name) ?? return null;
entry.value.used = true;
switch (type_id) {
TypeId.Bool => switch (entry.value.value) {
UserValue.Flag => return true,
UserValue.Scalar => |s| {
if (mem.eql(u8, s, "true")) {
return true;
} else if (mem.eql(u8, s, "false")) {
return false;
} else {
%%io.stderr.printf("Expected -D{} to be a boolean, but received '{}'\n", name, s);
self.markInvalidUserInput();
return null;
}
},
UserValue.List => {
%%io.stderr.printf("Expected -D{} to be a boolean, but received a list.\n", name);
self.markInvalidUserInput();
return null;
},
},
TypeId.Int => debug.panic("TODO integer options to build script"),
TypeId.Float => debug.panic("TODO float options to build script"),
TypeId.String => switch (entry.value.value) {
UserValue.Flag => {
%%io.stderr.printf("Expected -D{} to be a string, but received a boolean.\n", name);
self.markInvalidUserInput();
return null;
},
UserValue.List => {
%%io.stderr.printf("Expected -D{} to be a string, but received a list.\n", name);
self.markInvalidUserInput();
return null;
},
UserValue.Scalar => |s| return s,
},
TypeId.List => debug.panic("TODO list options to build script"),
}
}
pub fn step(self: &Builder, name: []const u8, description: []const u8) -> &Step {
const step_info = %%self.allocator.create(TopLevelStep);
*step_info = TopLevelStep {
.step = Step.initNoOp(name, self.allocator),
.description = description,
};
%%self.top_level_steps.append(step_info);
return &step_info.step;
}
pub fn addUserInputOption(self: &Builder, name: []const u8, value: []const u8) -> bool {
test (%%self.user_input_options.put(name, UserInputOption {
.name = name,
.value = UserValue.Scalar { value },
.used = false,
})) |*prev_value| {
// option already exists
switch (prev_value.value) {
UserValue.Scalar => |s| {
// turn it into a list
var list = List([]const u8).init(self.allocator);
%%list.append(s);
%%list.append(value);
_ = %%self.user_input_options.put(name, UserInputOption {
.name = name,
.value = UserValue.List { list },
.used = false,
});
},
UserValue.List => |*list| {
// append to the list
%%list.append(value);
_ = %%self.user_input_options.put(name, UserInputOption {
.name = name,
.value = UserValue.List { *list },
.used = false,
});
},
UserValue.Flag => {
%%io.stderr.printf("Option '-D{}={}' conflicts with flag '-D{}'.\n", name, value, name);
return true;
},
}
}
return false;
}
pub fn addUserInputFlag(self: &Builder, name: []const u8) -> bool {
test (%%self.user_input_options.put(name, UserInputOption {
.name = name,
.value = UserValue.Flag,
.used = false,
})) |*prev_value| {
switch (prev_value.value) {
UserValue.Scalar => |s| {
%%io.stderr.printf("Flag '-D{}' conflicts with option '-D{}={}'.\n", name, name, s);
return true;
},
UserValue.List => {
%%io.stderr.printf("Flag '-D{}' conflicts with multiple options of the same name.\n", name);
return true;
},
UserValue.Flag => {},
}
}
return false;
}
fn typeToEnum(comptime T: type) -> TypeId {
if (@isInteger(T)) {
TypeId.Int
} else if (@isFloat(T)) {
TypeId.Float
} else switch (T) {
bool => TypeId.Bool,
[]const u8 => TypeId.String,
[]const []const u8 => TypeId.List,
else => @compileError("Unsupported type: " ++ @typeName(T)),
}
}
fn markInvalidUserInput(self: &Builder) {
self.invalid_user_input = true;
}
pub fn typeIdName(id: TypeId) -> []const u8 {
return switch (id) {
TypeId.Bool => "bool",
TypeId.Int => "int",
TypeId.Float => "float",
TypeId.String => "string",
TypeId.List => "list",
};
}
pub fn validateUserInputDidItFail(self: &Builder) -> bool {
// make sure all args are used
var it = self.user_input_options.iterator();
while (true) {
const entry = it.next() ?? break;
if (!entry.value.used) {
%%io.stderr.printf("Invalid option: -D{}\n\n", entry.key);
self.markInvalidUserInput();
}
}
return self.invalid_user_input;
}
fn spawnChild(self: &Builder, exe_path: []const u8, args: []const []const u8) -> %void {
return self.spawnChildEnvMap(null, &self.env_map, exe_path, args);
}
fn spawnChildEnvMap(self: &Builder, cwd: ?[]const u8, env_map: &const BufMap,
exe_path: []const u8, args: []const []const u8) -> %void
{
if (self.verbose) {
test (cwd) |yes_cwd| %%io.stderr.print("cd {}; ", yes_cwd);
%%io.stderr.print("{}", exe_path);
for (args) |arg| {
%%io.stderr.print(" {}", arg);
}
%%io.stderr.printf("\n");
}
var child = os.ChildProcess.spawn(exe_path, args, cwd, env_map,
StdIo.Ignore, StdIo.Inherit, StdIo.Inherit, self.allocator) %% |err|
{
%%io.stderr.printf("Unable to spawn {}: {}\n", exe_path, @errorName(err));
return err;
};
const term = child.wait() %% |err| {
%%io.stderr.printf("Unable to spawn {}: {}\n", exe_path, @errorName(err));
return err;
};
switch (term) {
Term.Clean => |code| {
if (code != 0) {
%%io.stderr.printf("Process {} exited with error code {}\n", exe_path, code);
return error.UncleanExit;
}
},
else => {
%%io.stderr.printf("Process {} terminated unexpectedly\n", exe_path);
return error.UncleanExit;
},
};
}
pub fn makePath(self: &Builder, path: []const u8) -> %void {
os.makePath(self.allocator, path) %% |err| {
%%io.stderr.printf("Unable to create path {}: {}\n", path, @errorName(err));
return err;
};
}
pub fn installCLibrary(self: &Builder, lib: &CLibExeObjStep) -> &InstallCLibraryStep {
const install_step = %%self.allocator.create(InstallCLibraryStep);
*install_step = InstallCLibraryStep.init(self, lib);
install_step.step.dependOn(&lib.step);
return install_step;
}
///::dest_rel_path is relative to prefix path
pub fn installFile(self: &Builder, src_path: []const u8, dest_rel_path: []const u8) -> &InstallFileStep {
const full_dest_path = %%os.path.join(self.allocator, self.prefix, dest_rel_path);
self.addInstalledFile(full_dest_path);
const install_step = %%self.allocator.create(InstallFileStep);
*install_step = InstallFileStep.init(self, src_path, full_dest_path);
return install_step;
}
pub fn addInstalledFile(self: &Builder, full_path: []const u8) {
_ = self.getUninstallStep();
%%self.installed_files.append(full_path);
}
fn copyFile(self: &Builder, source_path: []const u8, dest_path: []const u8) {
const dirname = os.path.dirname(dest_path);
const abs_source_path = self.pathFromRoot(source_path);
os.makePath(self.allocator, dirname) %% |err| {
debug.panic("Unable to create path {}: {}", dirname, @errorName(err));
};
os.copyFile(self.allocator, abs_source_path, dest_path) %% |err| {
debug.panic("Unable to copy {} to {}: {}", abs_source_path, dest_path, @errorName(err));
};
}
fn pathFromRoot(self: &Builder, rel_path: []const u8) -> []u8 {
return %%os.path.resolve(self.allocator, self.build_root, rel_path);
}
pub fn fmt(self: &Builder, comptime format: []const u8, args: ...) -> []u8 {
return %%fmt_lib.allocPrint(self.allocator, format, args);
}
};
const Version = struct {
major: u32,
minor: u32,
patch: u32,
};
const CrossTarget = struct {
arch: Arch,
os: Os,
environ: Environ,
};
const Target = enum {
Native,
Cross: CrossTarget,
pub fn oFileExt(self: &const Target) -> []const u8 {
const environ = switch (*self) {
Target.Native => @compileVar("environ"),
Target.Cross => |t| t.environ,
};
return switch (environ) {
Environ.msvc => ".obj",
else => ".o",
};
}
pub fn exeFileExt(self: &const Target) -> []const u8 {
const target_os = switch (*self) {
Target.Native => @compileVar("os"),
Target.Cross => |t| t.os,
};
return switch (target_os) {
Os.windows => ".exe",
else => "",
};
}
};
pub const LibExeObjStep = struct {
step: Step,
builder: &Builder,
root_src: ?[]const u8,
name: []const u8,
target: Target,
linker_script: ?[]const u8,
link_libs: BufSet,
verbose: bool,
release: bool,
static: bool,
output_path: ?[]const u8,
output_h_path: ?[]const u8,
kind: Kind,
version: Version,
out_h_filename: []const u8,
out_filename: []const u8,
out_filename_major_only: []const u8,
out_filename_name_only: []const u8,
object_files: List([]const u8),
assembly_files: List([]const u8),
const Kind = enum {
Exe,
Lib,
Obj,
};
pub fn createSharedLibrary(builder: &Builder, name: []const u8, root_src: ?[]const u8,
ver: &const Version) -> &LibExeObjStep
{
const self = %%builder.allocator.create(LibExeObjStep);
*self = initExtraArgs(builder, name, root_src, Kind.Lib, false, ver);
return self;
}
pub fn createStaticLibrary(builder: &Builder, name: []const u8, root_src: ?[]const u8) -> &LibExeObjStep {
const self = %%builder.allocator.create(LibExeObjStep);
*self = initExtraArgs(builder, name, root_src, Kind.Lib, true, builder.version(0, 0, 0));
return self;
}
pub fn createObject(builder: &Builder, name: []const u8, root_src: []const u8) -> &LibExeObjStep {
const self = %%builder.allocator.create(LibExeObjStep);
*self = initExtraArgs(builder, name, root_src, Kind.Obj, false, builder.version(0, 0, 0));
return self;
}
pub fn createExecutable(builder: &Builder, name: []const u8, root_src: ?[]const u8) -> &LibExeObjStep {
const self = %%builder.allocator.create(LibExeObjStep);
*self = initExtraArgs(builder, name, root_src, Kind.Exe, false, builder.version(0, 0, 0));
return self;
}
fn initExtraArgs(builder: &Builder, name: []const u8, root_src: ?[]const u8, kind: Kind,
static: bool, ver: &const Version) -> LibExeObjStep
{
var self = LibExeObjStep {
.builder = builder,
.verbose = false,
.release = false,
.static = static,
.kind = kind,
.root_src = root_src,
.name = name,
.target = Target.Native,
.linker_script = null,
.link_libs = BufSet.init(builder.allocator),
.step = Step.init(name, builder.allocator, make),
.output_path = null,
.output_h_path = null,
.version = *ver,
.out_filename = undefined,
.out_h_filename = builder.fmt("{}.h", name),
.out_filename_major_only = undefined,
.out_filename_name_only = undefined,
.object_files = List([]const u8).init(builder.allocator),
.assembly_files = List([]const u8).init(builder.allocator),
};
self.computeOutFileNames();
return self;
}
fn computeOutFileNames(self: &LibExeObjStep) {
switch (self.kind) {
Kind.Obj => {
self.out_filename = self.builder.fmt("{}{}", self.name, self.target.oFileExt());
},
Kind.Exe => {
self.out_filename = self.builder.fmt("{}{}", self.name, self.target.exeFileExt());
},
Kind.Lib => {
if (self.static) {
self.out_filename = self.builder.fmt("lib{}.a", self.name);
} else {
self.out_filename = self.builder.fmt("lib{}.so.{d}.{d}.{d}",
self.name, self.version.major, self.version.minor, self.version.patch);
self.out_filename_major_only = self.builder.fmt("lib{}.so.{d}", self.name, self.version.major);
self.out_filename_name_only = self.builder.fmt("lib{}.so", self.name);
}
},
}
}
pub fn setTarget(self: &LibExeObjStep, target_arch: Arch, target_os: Os, target_environ: Environ) {
self.target = Target.Cross {
CrossTarget {
.arch = target_arch,
.os = target_os,
.environ = target_environ,
}
};
self.computeOutFileNames();
}
pub fn setLinkerScriptPath(self: &LibExeObjStep, path: []const u8) {
self.linker_script = path;
}
pub fn linkSystemLibrary(self: &LibExeObjStep, name: []const u8) {
%%self.link_libs.put(name);
}
pub fn setVerbose(self: &LibExeObjStep, value: bool) {
self.verbose = value;
}
pub fn setRelease(self: &LibExeObjStep, value: bool) {
self.release = value;
}
pub fn setOutputPath(self: &LibExeObjStep, value: []const u8) {
self.output_path = value;
}
pub fn getOutputPath(self: &LibExeObjStep) -> []const u8 {
test (self.output_path) |output_path| {
output_path
} else {
const wanted_path = %%os.path.join(self.builder.allocator, self.builder.cache_root, self.out_filename);
%%os.path.relative(self.builder.allocator, self.builder.build_root, wanted_path)
}
}
pub fn setOutputHPath(self: &LibExeObjStep, value: []const u8) {
self.output_h_path = value;
}
pub fn getOutputHPath(self: &LibExeObjStep) -> []const u8 {
test (self.output_h_path) |output_h_path| {
output_h_path
} else {
%%os.path.join(self.builder.allocator, self.builder.cache_root, self.out_h_filename)
}
}
pub fn addAssemblyFile(self: &LibExeObjStep, path: []const u8) {
%%self.assembly_files.append(path);
}
pub fn addObjectFile(self: &LibExeObjStep, path: []const u8) {
assert(self.kind != Kind.Obj);
%%self.object_files.append(path);
}
pub fn addObject(self: &LibExeObjStep, obj: &LibExeObjStep) {
assert(obj.kind == Kind.Obj);
assert(self.kind != Kind.Obj);
self.step.dependOn(&obj.step);
%%self.object_files.append(obj.getOutputPath());
}
fn make(step: &Step) -> %void {
const self = @fieldParentPtr(LibExeObjStep, "step", step);
const builder = self.builder;
if (self.root_src == null and self.object_files.len == 0 and self.assembly_files.len == 0) {
%%io.stderr.printf("{}: linker needs 1 or more objects to link\n", step.name);
return error.NeedAnObject;
}
var zig_args = List([]const u8).init(builder.allocator);
defer zig_args.deinit();
const cmd = switch (self.kind) {
Kind.Lib => "build_lib",
Kind.Exe => "build_exe",
Kind.Obj => "build_obj",
};
%%zig_args.append(cmd);
test (self.root_src) |root_src| {
%%zig_args.append(builder.pathFromRoot(root_src));
}
for (self.object_files.toSliceConst()) |object_file| {
%%zig_args.append("--object");
%%zig_args.append(builder.pathFromRoot(object_file));
}
for (self.assembly_files.toSliceConst()) |asm_file| {
%%zig_args.append("--assembly");
%%zig_args.append(builder.pathFromRoot(asm_file));
}
if (self.verbose) {
%%zig_args.append("--verbose");
}
if (self.release) {
%%zig_args.append("--release");
}
%%zig_args.append("--cache-dir");
%%zig_args.append(builder.cache_root);
const output_path = builder.pathFromRoot(self.getOutputPath());
%%zig_args.append("--output");
%%zig_args.append(output_path);
const output_h_path = self.getOutputHPath();
%%zig_args.append("--output-h");
%%zig_args.append(builder.pathFromRoot(output_h_path));
%%zig_args.append("--name");
%%zig_args.append(self.name);
if (self.kind == Kind.Lib and !self.static) {
%%zig_args.append("--ver-major");
%%zig_args.append(builder.fmt("{}", self.version.major));
%%zig_args.append("--ver-minor");
%%zig_args.append(builder.fmt("{}", self.version.minor));
%%zig_args.append("--ver-patch");
%%zig_args.append(builder.fmt("{}", self.version.patch));
}
switch (self.target) {
Target.Native => {},
Target.Cross => |cross_target| {
%%zig_args.append("--target-arch");
%%zig_args.append(@enumTagName(cross_target.arch));
%%zig_args.append("--target-os");
%%zig_args.append(@enumTagName(cross_target.os));
%%zig_args.append("--target-environ");
%%zig_args.append(@enumTagName(cross_target.environ));
},
}
test (self.linker_script) |linker_script| {
%%zig_args.append("--linker-script");
%%zig_args.append(linker_script);
}
{
var it = self.link_libs.iterator();
while (true) {
const entry = it.next() ?? break;
%%zig_args.append("--library");
%%zig_args.append(entry.key);
}
}
for (builder.include_paths.toSliceConst()) |include_path| {
%%zig_args.append("-isystem");
%%zig_args.append(include_path);
}
for (builder.rpaths.toSliceConst()) |rpath| {
%%zig_args.append("-rpath");
%%zig_args.append(rpath);
}
for (builder.lib_paths.toSliceConst()) |lib_path| {
%%zig_args.append("--library-path");
%%zig_args.append(lib_path);
}
%return builder.spawnChild(builder.zig_exe, zig_args.toSliceConst());
if (self.kind == Kind.Lib and !self.static) {
%return doAtomicSymLinks(builder.allocator, output_path, self.out_filename_major_only,
self.out_filename_name_only);
}
}
};
pub const TestStep = struct {
step: Step,
builder: &Builder,
root_src: []const u8,
release: bool,
verbose: bool,
link_libs: BufSet,
name_prefix: []const u8,
filter: ?[]const u8,
pub fn init(builder: &Builder, root_src: []const u8) -> TestStep {
const step_name = builder.fmt("test {}", root_src);
TestStep {
.step = Step.init(step_name, builder.allocator, make),
.builder = builder,
.root_src = root_src,
.release = false,
.verbose = false,
.name_prefix = "",
.filter = null,
.link_libs = BufSet.init(builder.allocator),
}
}
pub fn setVerbose(self: &TestStep, value: bool) {
self.verbose = value;
}
pub fn setRelease(self: &TestStep, value: bool) {
self.release = value;
}
pub fn linkSystemLibrary(self: &TestStep, name: []const u8) {
%%self.link_libs.put(name);
}
pub fn setNamePrefix(self: &TestStep, text: []const u8) {
self.name_prefix = text;
}
pub fn setFilter(self: &TestStep, text: ?[]const u8) {
self.filter = text;
}
fn make(step: &Step) -> %void {
const self = @fieldParentPtr(TestStep, "step", step);
const builder = self.builder;
var zig_args = List([]const u8).init(builder.allocator);
defer zig_args.deinit();
%%zig_args.append("test");
%%zig_args.append(builder.pathFromRoot(self.root_src));
if (self.verbose) {
%%zig_args.append("--verbose");
}
if (self.release) {
%%zig_args.append("--release");
}
test (self.filter) |filter| {
%%zig_args.append("--test-filter");
%%zig_args.append(filter);
}
if (self.name_prefix.len != 0) {
%%zig_args.append("--test-name-prefix");
%%zig_args.append(self.name_prefix);
}
{
var it = self.link_libs.iterator();
while (true) {
const entry = it.next() ?? break;
%%zig_args.append("--library");
%%zig_args.append(entry.key);
}
}
for (builder.include_paths.toSliceConst()) |include_path| {
%%zig_args.append("-isystem");
%%zig_args.append(include_path);
}
for (builder.rpaths.toSliceConst()) |rpath| {
%%zig_args.append("-rpath");
%%zig_args.append(rpath);
}
for (builder.lib_paths.toSliceConst()) |lib_path| {
%%zig_args.append("--library-path");
%%zig_args.append(lib_path);
}
%return builder.spawnChild(builder.zig_exe, zig_args.toSliceConst());
}
};
pub const CLibExeObjStep = struct {
step: Step,
name: []const u8,
out_filename: []const u8,
output_path: ?[]const u8,
static: bool,
version: Version,
cflags: List([]const u8),
source_files: List([]const u8),
object_files: List([]const u8),
link_libs: BufSet,
full_path_libs: List([]const u8),
target: Target,
builder: &Builder,
include_dirs: List([]const u8),
major_only_filename: []const u8,
name_only_filename: []const u8,
object_src: []const u8,
kind: Kind,
const Kind = enum {
Exe,
Lib,
Obj,
};
pub fn createSharedLibrary(builder: &Builder, name: []const u8, version: &const Version) -> &CLibExeObjStep {
const self = %%builder.allocator.create(CLibExeObjStep);
*self = init(builder, name, Kind.Lib, builder.version(0, 0, 0), false);
return self;
}
pub fn createStaticLibrary(builder: &Builder, name: []const u8) -> &CLibExeObjStep {
const self = %%builder.allocator.create(CLibExeObjStep);
*self = init(builder, name, Kind.Lib, builder.version(0, 0, 0), true);
return self;
}
pub fn createObject(builder: &Builder, name: []const u8, src: []const u8) -> &CLibExeObjStep {
const self = %%builder.allocator.create(CLibExeObjStep);
*self = init(builder, name, Kind.Obj, builder.version(0, 0, 0), false);
self.object_src = src;
return self;
}
pub fn createExecutable(builder: &Builder, name: []const u8) -> &CLibExeObjStep {
const self = %%builder.allocator.create(CLibExeObjStep);
*self = init(builder, name, Kind.Exe, builder.version(0, 0, 0), false);
return self;
}
fn init(builder: &Builder, name: []const u8, kind: Kind, version: &const Version, static: bool) -> CLibExeObjStep {
var clib = CLibExeObjStep {
.builder = builder,
.name = name,
.kind = kind,
.version = *version,
.static = static,
.target = Target.Native,
.cflags = List([]const u8).init(builder.allocator),
.source_files = List([]const u8).init(builder.allocator),
.object_files = List([]const u8).init(builder.allocator),
.step = Step.init(name, builder.allocator, make),
.link_libs = BufSet.init(builder.allocator),
.full_path_libs = List([]const u8).init(builder.allocator),
.include_dirs = List([]const u8).init(builder.allocator),
.output_path = null,
.out_filename = undefined,
.major_only_filename = undefined,
.name_only_filename = undefined,
.object_src = undefined,
};
clib.computeOutFileNames();
return clib;
}
fn computeOutFileNames(self: &CLibExeObjStep) {
switch (self.kind) {
Kind.Obj => {
self.out_filename = self.builder.fmt("{}{}", self.name, self.target.oFileExt());
},
Kind.Exe => {
self.out_filename = self.builder.fmt("{}{}", self.name, self.target.exeFileExt());
},
Kind.Lib => {
if (self.static) {
self.out_filename = self.builder.fmt("lib{}.a", self.name);
} else {
self.out_filename = self.builder.fmt("lib{}.so.{d}.{d}.{d}",
self.name, self.version.major, self.version.minor, self.version.patch);
self.major_only_filename = self.builder.fmt("lib{}.so.{d}", self.name, self.version.major);
self.name_only_filename = self.builder.fmt("lib{}.so", self.name);
}
},
}
}
pub fn setOutputPath(self: &CLibExeObjStep, value: []const u8) {
self.output_path = value;
}
pub fn getOutputPath(self: &CLibExeObjStep) -> []const u8 {
test (self.output_path) |output_path| {
output_path
} else {
const wanted_path = %%os.path.join(self.builder.allocator, self.builder.cache_root, self.out_filename);
%%os.path.relative(self.builder.allocator, self.builder.build_root, wanted_path)
}
}
pub fn linkLibrary(self: &CLibExeObjStep, lib: &LibExeObjStep) {
assert(self.kind != Kind.Obj);
assert(lib.kind == LibExeObjStep.Kind.Lib);
self.step.dependOn(&lib.step);
%%self.full_path_libs.append(lib.getOutputPath());
// TODO should be some kind of isolated directory that only has this header in it
%%self.include_dirs.append(self.builder.cache_root);
}
pub fn linkSystemLibrary(self: &CLibExeObjStep, name: []const u8) {
assert(self.kind != Kind.Obj);
%%self.link_libs.put(name);
}
pub fn linkCLibrary(self: &CLibExeObjStep, other: &CLibExeObjStep) {
assert(self.kind != Kind.Obj);
assert(other.kind == Kind.Lib);
self.step.dependOn(&other.step);
%%self.full_path_libs.append(other.getOutputPath());
}
pub fn addSourceFile(self: &CLibExeObjStep, file: []const u8) {
assert(self.kind != Kind.Obj);
%%self.source_files.append(file);
}
pub fn addObjectFile(self: &CLibExeObjStep, file: []const u8) {
assert(self.kind != Kind.Obj);
%%self.object_files.append(file);
}
pub fn addObject(self: &CLibExeObjStep, obj: &LibExeObjStep) {
assert(self.kind != Kind.Obj);
assert(obj.kind == LibExeObjStep.Kind.Obj);
self.step.dependOn(&obj.step);
%%self.object_files.append(obj.getOutputPath());
// TODO should be some kind of isolated directory that only has this header in it
%%self.include_dirs.append(self.builder.cache_root);
}
pub fn addIncludeDir(self: &CLibExeObjStep, path: []const u8) {
%%self.include_dirs.append(path);
}
pub fn addCompileFlagsForRelease(self: &CLibExeObjStep, release: bool) {
if (release) {
%%self.cflags.append("-g");
%%self.cflags.append("-O2");
} else {
%%self.cflags.append("-g");
}
}
pub fn addCompileFlags(self: &CLibExeObjStep, flags: []const []const u8) {
for (flags) |flag| {
%%self.cflags.append(flag);
}
}
fn make(step: &Step) -> %void {
const self = @fieldParentPtr(CLibExeObjStep, "step", step);
const cc = os.getEnv("CC") ?? "cc";
const builder = self.builder;
var cc_args = List([]const u8).init(builder.allocator);
defer cc_args.deinit();
switch (self.kind) {
Kind.Obj => {
%%cc_args.append("-c");
%%cc_args.append(builder.pathFromRoot(self.object_src));
const output_path = builder.pathFromRoot(self.getOutputPath());
%%cc_args.append("-o");
%%cc_args.append(output_path);
for (self.cflags.toSliceConst()) |cflag| {
%%cc_args.append(cflag);
}
for (self.include_dirs.toSliceConst()) |dir| {
%%cc_args.append("-I");
%%cc_args.append(builder.pathFromRoot(dir));
}
%return builder.spawnChild(cc, cc_args.toSliceConst());
},
Kind.Lib => {
for (self.source_files.toSliceConst()) |source_file| {
%%cc_args.resize(0);
if (!self.static) {
%%cc_args.append("-fPIC");
}
const abs_source_file = builder.pathFromRoot(source_file);
%%cc_args.append("-c");
%%cc_args.append(abs_source_file);
const cache_o_src = %%os.path.join(builder.allocator, builder.cache_root, source_file);
const cache_o_dir = os.path.dirname(cache_o_src);
%return builder.makePath(cache_o_dir);
const cache_o_file = builder.fmt("{}{}", cache_o_src, self.target.oFileExt());
%%cc_args.append("-o");
%%cc_args.append(cache_o_file);
for (self.cflags.toSliceConst()) |cflag| {
%%cc_args.append(cflag);
}
for (self.include_dirs.toSliceConst()) |dir| {
%%cc_args.append("-I");
%%cc_args.append(builder.pathFromRoot(dir));
}
%return builder.spawnChild(cc, cc_args.toSliceConst());
%%self.object_files.append(cache_o_file);
}
if (self.static) {
debug.panic("TODO static library");
} else {
%%cc_args.resize(0);
%%cc_args.append("-fPIC");
%%cc_args.append("-shared");
const soname_arg = builder.fmt("-Wl,-soname,lib{}.so.{d}", self.name, self.version.major);
defer builder.allocator.free(soname_arg);
%%cc_args.append(soname_arg);
const output_path = builder.pathFromRoot(self.getOutputPath());
%%cc_args.append("-o");
%%cc_args.append(output_path);
for (self.object_files.toSliceConst()) |object_file| {
%%cc_args.append(builder.pathFromRoot(object_file));
}
const rpath_arg = builder.fmt("-Wl,-rpath,{}",
%%os.path.real(builder.allocator, builder.cache_root));
defer builder.allocator.free(rpath_arg);
%%cc_args.append(rpath_arg);
%%cc_args.append("-rdynamic");
for (self.full_path_libs.toSliceConst()) |full_path_lib| {
%%cc_args.append(builder.pathFromRoot(full_path_lib));
}
%return builder.spawnChild(cc, cc_args.toSliceConst());
%return doAtomicSymLinks(builder.allocator, output_path, self.major_only_filename,
self.name_only_filename);
}
},
Kind.Exe => {
for (self.source_files.toSliceConst()) |source_file| {
%%cc_args.resize(0);
const abs_source_file = builder.pathFromRoot(source_file);
%%cc_args.append("-c");
%%cc_args.append(abs_source_file);
const cache_o_src = %%os.path.join(builder.allocator, builder.cache_root, source_file);
const cache_o_dir = os.path.dirname(cache_o_src);
%return builder.makePath(cache_o_dir);
const cache_o_file = builder.fmt("{}{}", cache_o_src, self.target.oFileExt());
%%cc_args.append("-o");
%%cc_args.append(cache_o_file);
for (self.cflags.toSliceConst()) |cflag| {
%%cc_args.append(cflag);
}
for (self.include_dirs.toSliceConst()) |dir| {
%%cc_args.append("-I");
%%cc_args.append(builder.pathFromRoot(dir));
}
%return builder.spawnChild(cc, cc_args.toSliceConst());
%%self.object_files.append(%%os.path.relative(builder.allocator, builder.build_root, cache_o_file));
}
%%cc_args.resize(0);
for (self.object_files.toSliceConst()) |object_file| {
%%cc_args.append(builder.pathFromRoot(object_file));
}
const output_path = builder.pathFromRoot(self.getOutputPath());
%%cc_args.append("-o");
%%cc_args.append(output_path);
const rpath_arg = builder.fmt("-Wl,-rpath,{}",
%%os.path.real(builder.allocator, builder.cache_root));
defer builder.allocator.free(rpath_arg);
%%cc_args.append(rpath_arg);
%%cc_args.append("-rdynamic");
for (self.full_path_libs.toSliceConst()) |full_path_lib| {
%%cc_args.append(builder.pathFromRoot(full_path_lib));
}
%return builder.spawnChild(cc, cc_args.toSliceConst());
},
}
}
pub fn setTarget(self: &CLibExeObjStep, target_arch: Arch, target_os: Os, target_environ: Environ) {
self.target = Target.Cross {
CrossTarget {
.arch = target_arch,
.os = target_os,
.environ = target_environ,
}
};
}
};
pub const CommandStep = struct {
step: Step,
builder: &Builder,
exe_path: []const u8,
args: []const []const u8,
cwd: ?[]const u8,
env_map: &const BufMap,
pub fn create(builder: &Builder, cwd: ?[]const u8, env_map: &const BufMap,
exe_path: []const u8, args: []const []const u8) -> &CommandStep
{
const self = %%builder.allocator.create(CommandStep);
*self = CommandStep {
.builder = builder,
.step = Step.init(exe_path, builder.allocator, make),
.exe_path = exe_path,
.args = args,
.cwd = cwd,
.env_map = env_map,
};
return self;
}
fn make(step: &Step) -> %void {
const self = @fieldParentPtr(CommandStep, "step", step);
const cwd = test (self.cwd) |cwd| self.builder.pathFromRoot(cwd) else null;
return self.builder.spawnChildEnvMap(cwd, self.env_map, self.exe_path, self.args);
}
};
pub const InstallCLibraryStep = struct {
step: Step,
builder: &Builder,
lib: &CLibExeObjStep,
dest_file: []const u8,
pub fn init(builder: &Builder, lib: &CLibExeObjStep) -> InstallCLibraryStep {
var self = InstallCLibraryStep {
.builder = builder,
.step = Step.init(builder.fmt("install {}", lib.step.name), builder.allocator, make),
.lib = lib,
.dest_file = undefined,
};
self.dest_file = %%os.path.join(builder.allocator, builder.lib_dir, lib.out_filename);
builder.addInstalledFile(self.dest_file);
if (!self.lib.static) {
builder.addInstalledFile(%%os.path.join(builder.allocator, builder.lib_dir, lib.major_only_filename));
builder.addInstalledFile(%%os.path.join(builder.allocator, builder.lib_dir, lib.name_only_filename));
}
return self;
}
fn make(step: &Step) -> %void {
const self = @fieldParentPtr(InstallCLibraryStep, "step", step);
const builder = self.builder;
self.builder.copyFile(self.lib.getOutputPath(), self.dest_file);
if (!self.lib.static) {
%return doAtomicSymLinks(self.builder.allocator, self.dest_file, self.lib.major_only_filename,
self.lib.name_only_filename);
}
}
};
pub const InstallFileStep = struct {
step: Step,
builder: &Builder,
src_path: []const u8,
dest_path: []const u8,
pub fn init(builder: &Builder, src_path: []const u8, dest_path: []const u8) -> InstallFileStep {
return InstallFileStep {
.builder = builder,
.step = Step.init(builder.fmt("install {}", src_path), builder.allocator, make),
.src_path = src_path,
.dest_path = dest_path,
};
}
fn make(step: &Step) -> %void {
const self = @fieldParentPtr(InstallFileStep, "step", step);
self.builder.copyFile(self.src_path, self.dest_path);
}
};
pub const WriteFileStep = struct {
step: Step,
builder: &Builder,
file_path: []const u8,
data: []const u8,
pub fn init(builder: &Builder, file_path: []const u8, data: []const u8) -> WriteFileStep {
return WriteFileStep {
.builder = builder,
.step = Step.init(builder.fmt("writefile {}", file_path), builder.allocator, make),
.file_path = file_path,
.data = data,
};
}
fn make(step: &Step) -> %void {
const self = @fieldParentPtr(WriteFileStep, "step", step);
const full_path = self.builder.pathFromRoot(self.file_path);
const full_path_dir = os.path.dirname(full_path);
os.makePath(self.builder.allocator, full_path_dir) %% |err| {
%%io.stderr.printf("unable to make path {}: {}\n", full_path_dir, @errorName(err));
return err;
};
io.writeFile(full_path, self.data, self.builder.allocator) %% |err| {
%%io.stderr.printf("unable to write {}: {}\n", full_path, @errorName(err));
return err;
};
}
};
pub const LogStep = struct {
step: Step,
builder: &Builder,
data: []const u8,
pub fn init(builder: &Builder, data: []const u8) -> LogStep {
return LogStep {
.builder = builder,
.step = Step.init(builder.fmt("log {}", data), builder.allocator, make),
.data = data,
};
}
fn make(step: &Step) -> %void {
const self = @fieldParentPtr(LogStep, "step", step);
%%io.stderr.write(self.data);
%%io.stderr.flush();
}
};
pub const RemoveDirStep = struct {
step: Step,
builder: &Builder,
dir_path: []const u8,
pub fn init(builder: &Builder, dir_path: []const u8) -> RemoveDirStep {
return RemoveDirStep {
.builder = builder,
.step = Step.init(builder.fmt("RemoveDir {}", dir_path), builder.allocator, make),
.dir_path = dir_path,
};
}
fn make(step: &Step) -> %void {
const self = @fieldParentPtr(RemoveDirStep, "step", step);
const full_path = self.builder.pathFromRoot(self.dir_path);
os.deleteTree(self.builder.allocator, full_path) %% |err| {
%%io.stderr.printf("Unable to remove {}: {}\n", full_path, @errorName(err));
return err;
};
}
};
pub const Step = struct {
name: []const u8,
makeFn: fn(self: &Step) -> %void,
dependencies: List(&Step),
loop_flag: bool,
done_flag: bool,
pub fn init(name: []const u8, allocator: &Allocator, makeFn: fn (&Step)->%void) -> Step {
Step {
.name = name,
.makeFn = makeFn,
.dependencies = List(&Step).init(allocator),
.loop_flag = false,
.done_flag = false,
}
}
pub fn initNoOp(name: []const u8, allocator: &Allocator) -> Step {
init(name, allocator, makeNoOp)
}
pub fn make(self: &Step) -> %void {
if (self.done_flag)
return;
%return self.makeFn(self);
self.done_flag = true;
}
pub fn dependOn(self: &Step, other: &Step) {
%%self.dependencies.append(other);
}
fn makeNoOp(self: &Step) -> %void {}
};
fn doAtomicSymLinks(allocator: &Allocator, output_path: []const u8, filename_major_only: []const u8,
filename_name_only: []const u8) -> %void
{
const out_dir = os.path.dirname(output_path);
const out_basename = os.path.basename(output_path);
// sym link for libfoo.so.1 to libfoo.so.1.2.3
const major_only_path = %%os.path.join(allocator, out_dir, filename_major_only);
os.atomicSymLink(allocator, out_basename, major_only_path) %% |err| {
%%io.stderr.printf("Unable to symlink {} -> {}\n", major_only_path, out_basename);
return err;
};
// sym link for libfoo.so to libfoo.so.1
const name_only_path = %%os.path.join(allocator, out_dir, filename_name_only);
os.atomicSymLink(allocator, filename_major_only, name_only_path) %% |err| {
%%io.stderr.printf("Unable to symlink {} -> {}\n", name_only_path, filename_major_only);
return err;
};
}