", .{sgr_num});
- }
- open_span_count += 1;
- },
- else => return error.UnsupportedEscape,
- },
- }
- }
- return try buf.toOwnedSlice();
-}
-
-const builtin_types = [_][]const u8{
- "f16", "f32", "f64", "f80", "f128",
- "c_longdouble", "c_short", "c_ushort", "c_int", "c_uint",
- "c_long", "c_ulong", "c_longlong", "c_ulonglong", "c_char",
- "anyopaque", "void", "bool", "isize", "usize",
- "noreturn", "type", "anyerror", "comptime_int", "comptime_float",
-};
-
-fn isType(name: []const u8) bool {
- for (builtin_types) |t| {
- if (mem.eql(u8, t, name))
- return true;
- }
- return false;
-}
-
-const start_line = "";
-const end_line = "";
-
-fn writeEscapedLines(out: anytype, text: []const u8) !void {
- for (text) |char| {
- if (char == '\n') {
- try out.writeAll(end_line);
- try out.writeAll("\n");
- try out.writeAll(start_line);
- } else {
- try writeEscaped(out, &[_]u8{char});
- }
- }
-}
-
-fn tokenizeAndPrintRaw(
- allocator: Allocator,
- docgen_tokenizer: *Tokenizer,
- out: anytype,
- source_token: Token,
- raw_src: []const u8,
-) !void {
- const src_non_terminated = mem.trim(u8, raw_src, " \n");
- const src = try allocator.dupeZ(u8, src_non_terminated);
-
- try out.writeAll("" ++ start_line);
- var tokenizer = std.zig.Tokenizer.init(src);
- var index: usize = 0;
- var next_tok_is_fn = false;
- while (true) {
- const prev_tok_was_fn = next_tok_is_fn;
- next_tok_is_fn = false;
-
- const token = tokenizer.next();
- if (mem.indexOf(u8, src[index..token.loc.start], "//")) |comment_start_off| {
- // render one comment
- const comment_start = index + comment_start_off;
- const comment_end_off = mem.indexOf(u8, src[comment_start..token.loc.start], "\n");
- const comment_end = if (comment_end_off) |o| comment_start + o else token.loc.start;
-
- try writeEscapedLines(out, src[index..comment_start]);
- try out.writeAll("");
- index = comment_end;
- tokenizer.index = index;
- continue;
- }
-
- try writeEscapedLines(out, src[index..token.loc.start]);
- switch (token.tag) {
- .eof => break,
-
- .keyword_addrspace,
- .keyword_align,
- .keyword_and,
- .keyword_asm,
- .keyword_async,
- .keyword_await,
- .keyword_break,
- .keyword_catch,
- .keyword_comptime,
- .keyword_const,
- .keyword_continue,
- .keyword_defer,
- .keyword_else,
- .keyword_enum,
- .keyword_errdefer,
- .keyword_error,
- .keyword_export,
- .keyword_extern,
- .keyword_for,
- .keyword_if,
- .keyword_inline,
- .keyword_noalias,
- .keyword_noinline,
- .keyword_nosuspend,
- .keyword_opaque,
- .keyword_or,
- .keyword_orelse,
- .keyword_packed,
- .keyword_anyframe,
- .keyword_pub,
- .keyword_resume,
- .keyword_return,
- .keyword_linksection,
- .keyword_callconv,
- .keyword_struct,
- .keyword_suspend,
- .keyword_switch,
- .keyword_test,
- .keyword_threadlocal,
- .keyword_try,
- .keyword_union,
- .keyword_unreachable,
- .keyword_usingnamespace,
- .keyword_var,
- .keyword_volatile,
- .keyword_allowzero,
- .keyword_while,
- .keyword_anytype,
- => {
- try out.writeAll("");
- try writeEscaped(out, src[token.loc.start..token.loc.end]);
- try out.writeAll("");
- },
-
- .keyword_fn => {
- try out.writeAll("");
- try writeEscaped(out, src[token.loc.start..token.loc.end]);
- try out.writeAll("");
- next_tok_is_fn = true;
- },
-
- .string_literal,
- .char_literal,
- => {
- try out.writeAll("");
- try writeEscaped(out, src[token.loc.start..token.loc.end]);
- try out.writeAll("");
- },
-
- .multiline_string_literal_line => {
- if (src[token.loc.end - 1] == '\n') {
- try out.writeAll("");
- try writeEscaped(out, src[token.loc.start .. token.loc.end - 1]);
- try out.writeAll("" ++ end_line ++ "\n" ++ start_line);
- } else {
- try out.writeAll("");
- try writeEscaped(out, src[token.loc.start..token.loc.end]);
- try out.writeAll("");
- }
- },
-
- .builtin => {
- try out.writeAll("");
- try writeEscaped(out, src[token.loc.start..token.loc.end]);
- try out.writeAll("");
- },
-
- .doc_comment,
- .container_doc_comment,
- => {
- try out.writeAll("");
- },
-
- .identifier => {
- const tok_bytes = src[token.loc.start..token.loc.end];
- if (mem.eql(u8, tok_bytes, "undefined") or
- mem.eql(u8, tok_bytes, "null") or
- mem.eql(u8, tok_bytes, "true") or
- mem.eql(u8, tok_bytes, "false"))
- {
- try out.writeAll("");
- try writeEscaped(out, tok_bytes);
- try out.writeAll("");
- } else if (prev_tok_was_fn) {
- try out.writeAll("");
- try writeEscaped(out, tok_bytes);
- try out.writeAll("");
- } else {
- const is_int = blk: {
- if (src[token.loc.start] != 'i' and src[token.loc.start] != 'u')
- break :blk false;
- var i = token.loc.start + 1;
- if (i == token.loc.end)
- break :blk false;
- while (i != token.loc.end) : (i += 1) {
- if (src[i] < '0' or src[i] > '9')
- break :blk false;
- }
- break :blk true;
- };
- if (is_int or isType(tok_bytes)) {
- try out.writeAll("");
- try writeEscaped(out, tok_bytes);
- try out.writeAll("");
- } else {
- try writeEscaped(out, tok_bytes);
- }
- }
- },
-
- .number_literal => {
- try out.writeAll("");
- try writeEscaped(out, src[token.loc.start..token.loc.end]);
- try out.writeAll("");
- },
-
- .bang,
- .pipe,
- .pipe_pipe,
- .pipe_equal,
- .equal,
- .equal_equal,
- .equal_angle_bracket_right,
- .bang_equal,
- .l_paren,
- .r_paren,
- .semicolon,
- .percent,
- .percent_equal,
- .l_brace,
- .r_brace,
- .l_bracket,
- .r_bracket,
- .period,
- .period_asterisk,
- .ellipsis2,
- .ellipsis3,
- .caret,
- .caret_equal,
- .plus,
- .plus_plus,
- .plus_equal,
- .plus_percent,
- .plus_percent_equal,
- .plus_pipe,
- .plus_pipe_equal,
- .minus,
- .minus_equal,
- .minus_percent,
- .minus_percent_equal,
- .minus_pipe,
- .minus_pipe_equal,
- .asterisk,
- .asterisk_equal,
- .asterisk_asterisk,
- .asterisk_percent,
- .asterisk_percent_equal,
- .asterisk_pipe,
- .asterisk_pipe_equal,
- .arrow,
- .colon,
- .slash,
- .slash_equal,
- .comma,
- .ampersand,
- .ampersand_equal,
- .question_mark,
- .angle_bracket_left,
- .angle_bracket_left_equal,
- .angle_bracket_angle_bracket_left,
- .angle_bracket_angle_bracket_left_equal,
- .angle_bracket_angle_bracket_left_pipe,
- .angle_bracket_angle_bracket_left_pipe_equal,
- .angle_bracket_right,
- .angle_bracket_right_equal,
- .angle_bracket_angle_bracket_right,
- .angle_bracket_angle_bracket_right_equal,
- .tilde,
- => try writeEscaped(out, src[token.loc.start..token.loc.end]),
-
- .invalid, .invalid_periodasterisks => return parseError(
- docgen_tokenizer,
- source_token,
- "syntax error",
- .{},
- ),
- }
- index = token.loc.end;
- }
- try out.writeAll(end_line ++ "");
-}
-
-fn tokenizeAndPrint(
- allocator: Allocator,
- docgen_tokenizer: *Tokenizer,
- out: anytype,
- source_token: Token,
-) !void {
- const raw_src = docgen_tokenizer.buffer[source_token.start..source_token.end];
- return tokenizeAndPrintRaw(allocator, docgen_tokenizer, out, source_token, raw_src);
-}
-
-fn printSourceBlock(allocator: Allocator, docgen_tokenizer: *Tokenizer, out: anytype, syntax_block: SyntaxBlock) !void {
- const source_type = @tagName(syntax_block.source_type);
-
- try out.print("{s}", .{ source_type, syntax_block.name });
- switch (syntax_block.source_type) {
- .zig => try tokenizeAndPrint(allocator, docgen_tokenizer, out, syntax_block.source_token),
- else => {
- const raw_source = docgen_tokenizer.buffer[syntax_block.source_token.start..syntax_block.source_token.end];
- const trimmed_raw_source = mem.trim(u8, raw_source, " \n");
-
- try out.writeAll("" ++ start_line);
- try writeEscapedLines(out, trimmed_raw_source);
- try out.writeAll(end_line ++ "");
- },
- }
- try out.writeAll("");
-}
-
-fn printShell(out: anytype, shell_content: []const u8, escape: bool) !void {
- const trimmed_shell_content = mem.trim(u8, shell_content, " \n");
- try out.writeAll("Shell");
- var cmd_cont: bool = false;
- var iter = std.mem.splitScalar(u8, trimmed_shell_content, '\n');
- while (iter.next()) |orig_line| {
- const line = mem.trimRight(u8, orig_line, " ");
- if (!cmd_cont and line.len > 1 and mem.eql(u8, line[0..2], "$ ") and line[line.len - 1] != '\\') {
- try out.writeAll("$ ");
- const s = std.mem.trimLeft(u8, line[1..], " ");
- if (escape) {
- try writeEscaped(out, s);
- } else {
- try out.writeAll(s);
- }
- try out.writeAll("" ++ "\n");
- } else if (!cmd_cont and line.len > 1 and mem.eql(u8, line[0..2], "$ ") and line[line.len - 1] == '\\') {
- try out.writeAll("$ ");
- const s = std.mem.trimLeft(u8, line[1..], " ");
- if (escape) {
- try writeEscaped(out, s);
- } else {
- try out.writeAll(s);
- }
- try out.writeAll("\n");
- cmd_cont = true;
- } else if (line.len > 0 and line[line.len - 1] != '\\' and cmd_cont) {
- if (escape) {
- try writeEscaped(out, line);
- } else {
- try out.writeAll(line);
- }
- try out.writeAll("" ++ "\n");
- cmd_cont = false;
- } else {
- if (escape) {
- try writeEscaped(out, line);
- } else {
- try out.writeAll(line);
- }
- try out.writeAll("\n");
- }
- }
-
- try out.writeAll("");
-}
-
-// Override this to skip to later tests
-const debug_start_line = 0;
-
-fn genHtml(
- allocator: Allocator,
- tokenizer: *Tokenizer,
- toc: *Toc,
- out: anytype,
- zig_exe: []const u8,
- opt_zig_lib_dir: ?[]const u8,
- do_code_tests: bool,
-) !void {
- var progress = Progress{ .dont_print_on_dumb = true };
- const root_node = progress.start("Generating docgen examples", toc.nodes.len);
- defer root_node.end();
-
- var env_map = try process.getEnvMap(allocator);
- try env_map.put("YES_COLOR", "1");
-
- const host = try std.zig.system.NativeTargetInfo.detect(.{});
- const builtin_code = try getBuiltinCode(allocator, &env_map, zig_exe, opt_zig_lib_dir);
-
- for (toc.nodes) |node| {
- defer root_node.completeOne();
- switch (node) {
- .Content => |data| {
- try out.writeAll(data);
- },
- .Link => |info| {
- if (!toc.urls.contains(info.url)) {
- return parseError(tokenizer, info.token, "url not found: {s}", .{info.url});
- }
- try out.print("{s}", .{ info.url, info.name });
- },
- .Nav => {
- try out.writeAll(toc.toc);
- },
- .Builtin => |tok| {
- try out.writeAll("@import(\"builtin\")");
- try tokenizeAndPrintRaw(allocator, tokenizer, out, tok, builtin_code);
- try out.writeAll("");
- },
- .HeaderOpen => |info| {
- try out.print(
- "{s} §\n",
- .{ info.n, info.url, info.url, info.name, info.url, info.n },
- );
- },
- .SeeAlso => |items| {
- try out.writeAll("See also:
\n");
- for (items) |item| {
- const url = try urlize(allocator, item.name);
- if (!toc.urls.contains(url)) {
- return parseError(tokenizer, item.token, "url not found: {s}", .{url});
- }
- try out.print("- {s}
\n", .{ url, item.name });
- }
- try out.writeAll("
\n");
- },
- .InlineSyntax => |content_tok| {
- try tokenizeAndPrint(allocator, tokenizer, out, content_tok);
- },
- .Shell => |content_tok| {
- const raw_shell_content = tokenizer.buffer[content_tok.start..content_tok.end];
- try printShell(out, raw_shell_content, true);
- },
- .SyntaxBlock => |syntax_block| {
- try printSourceBlock(allocator, tokenizer, out, syntax_block);
- },
- .Code => |code| {
- const name_plus_ext = try std.fmt.allocPrint(allocator, "{s}.zig", .{code.name});
- const syntax_block = SyntaxBlock{
- .source_type = .zig,
- .name = name_plus_ext,
- .source_token = code.source_token,
- };
-
- try printSourceBlock(allocator, tokenizer, out, syntax_block);
-
- if (!do_code_tests) {
- continue;
- }
-
- if (debug_start_line > 0) {
- const loc = tokenizer.getTokenLocation(code.source_token);
- if (debug_start_line > loc.line) {
- continue;
- }
- }
-
- const raw_source = tokenizer.buffer[code.source_token.start..code.source_token.end];
- const trimmed_raw_source = mem.trim(u8, raw_source, " \n");
- const tmp_source_file_name = try fs.path.join(
- allocator,
- &[_][]const u8{ tmp_dir_name, name_plus_ext },
- );
- try fs.cwd().writeFile(tmp_source_file_name, trimmed_raw_source);
-
- var shell_buffer = std.ArrayList(u8).init(allocator);
- defer shell_buffer.deinit();
- var shell_out = shell_buffer.writer();
-
- switch (code.id) {
- .exe => |expected_outcome| code_block: {
- var build_args = std.ArrayList([]const u8).init(allocator);
- defer build_args.deinit();
- try build_args.appendSlice(&[_][]const u8{
- zig_exe, "build-exe",
- "--name", code.name,
- "--color", "on",
- name_plus_ext,
- });
- if (opt_zig_lib_dir) |zig_lib_dir| {
- try build_args.appendSlice(&.{ "--zig-lib-dir", zig_lib_dir });
- }
-
- try shell_out.print("$ zig build-exe {s} ", .{name_plus_ext});
-
- switch (code.mode) {
- .Debug => {},
- else => {
- try build_args.appendSlice(&[_][]const u8{ "-O", @tagName(code.mode) });
- try shell_out.print("-O {s} ", .{@tagName(code.mode)});
- },
- }
- for (code.link_objects) |link_object| {
- const name_with_ext = try std.fmt.allocPrint(allocator, "{s}{s}", .{ link_object, obj_ext });
- try build_args.append(name_with_ext);
- try shell_out.print("{s} ", .{name_with_ext});
- }
- if (code.link_libc) {
- try build_args.append("-lc");
- try shell_out.print("-lc ", .{});
- }
- const target = try std.zig.CrossTarget.parse(.{
- .arch_os_abi = code.target_str orelse "native",
- });
- if (code.target_str) |triple| {
- try build_args.appendSlice(&[_][]const u8{ "-target", triple });
- try shell_out.print("-target {s} ", .{triple});
- }
- if (code.verbose_cimport) {
- try build_args.append("--verbose-cimport");
- try shell_out.print("--verbose-cimport ", .{});
- }
- for (code.additional_options) |option| {
- try build_args.append(option);
- try shell_out.print("{s} ", .{option});
- }
-
- try shell_out.print("\n", .{});
-
- if (expected_outcome == .build_fail) {
- const result = try ChildProcess.exec(.{
- .allocator = allocator,
- .argv = build_args.items,
- .cwd = tmp_dir_name,
- .env_map = &env_map,
- .max_output_bytes = max_doc_file_size,
- });
- switch (result.term) {
- .Exited => |exit_code| {
- if (exit_code == 0) {
- progress.log("", .{});
- print("{s}\nThe following command incorrectly succeeded:\n", .{result.stderr});
- dumpArgs(build_args.items);
- return parseError(tokenizer, code.source_token, "example incorrectly compiled", .{});
- }
- },
- else => {
- progress.log("", .{});
- print("{s}\nThe following command crashed:\n", .{result.stderr});
- dumpArgs(build_args.items);
- return parseError(tokenizer, code.source_token, "example compile crashed", .{});
- },
- }
- const escaped_stderr = try escapeHtml(allocator, result.stderr);
- const colored_stderr = try termColor(allocator, escaped_stderr);
- try shell_out.writeAll(colored_stderr);
- break :code_block;
- }
- const exec_result = exec(allocator, &env_map, tmp_dir_name, build_args.items) catch
- return parseError(tokenizer, code.source_token, "example failed to compile", .{});
-
- if (code.verbose_cimport) {
- const escaped_build_stderr = try escapeHtml(allocator, exec_result.stderr);
- try shell_out.writeAll(escaped_build_stderr);
- }
-
- if (code.target_str) |triple| {
- if (mem.startsWith(u8, triple, "wasm32") or
- mem.startsWith(u8, triple, "riscv64-linux") or
- (mem.startsWith(u8, triple, "x86_64-linux") and
- builtin.os.tag != .linux or builtin.cpu.arch != .x86_64))
- {
- // skip execution
- break :code_block;
- }
- }
-
- const path_to_exe = try std.fmt.allocPrint(allocator, "./{s}{s}", .{
- code.name,
- target.exeFileExt(),
- });
- const run_args = &[_][]const u8{path_to_exe};
-
- var exited_with_signal = false;
-
- const result = if (expected_outcome == .fail) blk: {
- const result = try ChildProcess.exec(.{
- .allocator = allocator,
- .argv = run_args,
- .env_map = &env_map,
- .cwd = tmp_dir_name,
- .max_output_bytes = max_doc_file_size,
- });
- switch (result.term) {
- .Exited => |exit_code| {
- if (exit_code == 0) {
- progress.log("", .{});
- print("{s}\nThe following command incorrectly succeeded:\n", .{result.stderr});
- dumpArgs(run_args);
- return parseError(tokenizer, code.source_token, "example incorrectly compiled", .{});
- }
- },
- .Signal => exited_with_signal = true,
- else => {},
- }
- break :blk result;
- } else blk: {
- break :blk exec(allocator, &env_map, tmp_dir_name, run_args) catch return parseError(tokenizer, code.source_token, "example crashed", .{});
- };
-
- const escaped_stderr = try escapeHtml(allocator, result.stderr);
- const escaped_stdout = try escapeHtml(allocator, result.stdout);
-
- const colored_stderr = try termColor(allocator, escaped_stderr);
- const colored_stdout = try termColor(allocator, escaped_stdout);
-
- try shell_out.print("$ ./{s}\n{s}{s}", .{ code.name, colored_stdout, colored_stderr });
- if (exited_with_signal) {
- try shell_out.print("(process terminated by signal)", .{});
- }
- try shell_out.writeAll("\n");
- },
- .@"test" => {
- var test_args = std.ArrayList([]const u8).init(allocator);
- defer test_args.deinit();
-
- try test_args.appendSlice(&[_][]const u8{
- zig_exe, "test",
- tmp_source_file_name,
- });
- if (opt_zig_lib_dir) |zig_lib_dir| {
- try test_args.appendSlice(&.{ "--zig-lib-dir", zig_lib_dir });
- }
- try shell_out.print("$ zig test {s}.zig ", .{code.name});
-
- switch (code.mode) {
- .Debug => {},
- else => {
- try test_args.appendSlice(&[_][]const u8{
- "-O", @tagName(code.mode),
- });
- try shell_out.print("-O {s} ", .{@tagName(code.mode)});
- },
- }
- if (code.link_libc) {
- try test_args.append("-lc");
- try shell_out.print("-lc ", .{});
- }
- if (code.target_str) |triple| {
- try test_args.appendSlice(&[_][]const u8{ "-target", triple });
- try shell_out.print("-target {s} ", .{triple});
-
- const cross_target = try std.zig.CrossTarget.parse(.{
- .arch_os_abi = triple,
- });
- const target_info = try std.zig.system.NativeTargetInfo.detect(
- cross_target,
- );
- switch (host.getExternalExecutor(target_info, .{
- .link_libc = code.link_libc,
- })) {
- .native => {},
- else => {
- try test_args.appendSlice(&[_][]const u8{"--test-no-exec"});
- try shell_out.writeAll("--test-no-exec");
- },
- }
- }
- const result = exec(allocator, &env_map, null, test_args.items) catch
- return parseError(tokenizer, code.source_token, "test failed", .{});
- const escaped_stderr = try escapeHtml(allocator, result.stderr);
- const escaped_stdout = try escapeHtml(allocator, result.stdout);
- try shell_out.print("\n{s}{s}\n", .{ escaped_stderr, escaped_stdout });
- },
- .test_error => |error_match| {
- var test_args = std.ArrayList([]const u8).init(allocator);
- defer test_args.deinit();
-
- try test_args.appendSlice(&[_][]const u8{
- zig_exe, "test",
- "--color", "on",
- tmp_source_file_name,
- });
- if (opt_zig_lib_dir) |zig_lib_dir| {
- try test_args.appendSlice(&.{ "--zig-lib-dir", zig_lib_dir });
- }
- try shell_out.print("$ zig test {s}.zig ", .{code.name});
-
- switch (code.mode) {
- .Debug => {},
- else => {
- try test_args.appendSlice(&[_][]const u8{ "-O", @tagName(code.mode) });
- try shell_out.print("-O {s} ", .{@tagName(code.mode)});
- },
- }
- if (code.link_libc) {
- try test_args.append("-lc");
- try shell_out.print("-lc ", .{});
- }
- const result = try ChildProcess.exec(.{
- .allocator = allocator,
- .argv = test_args.items,
- .env_map = &env_map,
- .max_output_bytes = max_doc_file_size,
- });
- switch (result.term) {
- .Exited => |exit_code| {
- if (exit_code == 0) {
- progress.log("", .{});
- print("{s}\nThe following command incorrectly succeeded:\n", .{result.stderr});
- dumpArgs(test_args.items);
- return parseError(tokenizer, code.source_token, "example incorrectly compiled", .{});
- }
- },
- else => {
- progress.log("", .{});
- print("{s}\nThe following command crashed:\n", .{result.stderr});
- dumpArgs(test_args.items);
- return parseError(tokenizer, code.source_token, "example compile crashed", .{});
- },
- }
- if (mem.indexOf(u8, result.stderr, error_match) == null) {
- progress.log("", .{});
- print("{s}\nExpected to find '{s}' in stderr\n", .{ result.stderr, error_match });
- return parseError(tokenizer, code.source_token, "example did not have expected compile error", .{});
- }
- const escaped_stderr = try escapeHtml(allocator, result.stderr);
- const colored_stderr = try termColor(allocator, escaped_stderr);
- try shell_out.print("\n{s}\n", .{colored_stderr});
- },
- .test_safety => |error_match| {
- var test_args = std.ArrayList([]const u8).init(allocator);
- defer test_args.deinit();
-
- try test_args.appendSlice(&[_][]const u8{
- zig_exe, "test",
- tmp_source_file_name,
- });
- if (opt_zig_lib_dir) |zig_lib_dir| {
- try test_args.appendSlice(&.{ "--zig-lib-dir", zig_lib_dir });
- }
- var mode_arg: []const u8 = "";
- switch (code.mode) {
- .Debug => {},
- .ReleaseSafe => {
- try test_args.append("-OReleaseSafe");
- mode_arg = "-OReleaseSafe";
- },
- .ReleaseFast => {
- try test_args.append("-OReleaseFast");
- mode_arg = "-OReleaseFast";
- },
- .ReleaseSmall => {
- try test_args.append("-OReleaseSmall");
- mode_arg = "-OReleaseSmall";
- },
- }
-
- const result = try ChildProcess.exec(.{
- .allocator = allocator,
- .argv = test_args.items,
- .env_map = &env_map,
- .max_output_bytes = max_doc_file_size,
- });
- switch (result.term) {
- .Exited => |exit_code| {
- if (exit_code == 0) {
- progress.log("", .{});
- print("{s}\nThe following command incorrectly succeeded:\n", .{result.stderr});
- dumpArgs(test_args.items);
- return parseError(tokenizer, code.source_token, "example test incorrectly succeeded", .{});
- }
- },
- else => {
- progress.log("", .{});
- print("{s}\nThe following command crashed:\n", .{result.stderr});
- dumpArgs(test_args.items);
- return parseError(tokenizer, code.source_token, "example compile crashed", .{});
- },
- }
- if (mem.indexOf(u8, result.stderr, error_match) == null) {
- progress.log("", .{});
- print("{s}\nExpected to find '{s}' in stderr\n", .{ result.stderr, error_match });
- return parseError(tokenizer, code.source_token, "example did not have expected runtime safety error message", .{});
- }
- const escaped_stderr = try escapeHtml(allocator, result.stderr);
- const colored_stderr = try termColor(allocator, escaped_stderr);
- try shell_out.print("$ zig test {s}.zig {s}\n{s}\n", .{
- code.name,
- mode_arg,
- colored_stderr,
- });
- },
- .obj => |maybe_error_match| {
- const name_plus_obj_ext = try std.fmt.allocPrint(allocator, "{s}{s}", .{ code.name, obj_ext });
- var build_args = std.ArrayList([]const u8).init(allocator);
- defer build_args.deinit();
-
- try build_args.appendSlice(&[_][]const u8{
- zig_exe, "build-obj",
- "--color", "on",
- "--name", code.name,
- tmp_source_file_name,
- try std.fmt.allocPrint(allocator, "-femit-bin={s}{c}{s}", .{
- tmp_dir_name, fs.path.sep, name_plus_obj_ext,
- }),
- });
- if (opt_zig_lib_dir) |zig_lib_dir| {
- try build_args.appendSlice(&.{ "--zig-lib-dir", zig_lib_dir });
- }
-
- try shell_out.print("$ zig build-obj {s}.zig ", .{code.name});
-
- switch (code.mode) {
- .Debug => {},
- else => {
- try build_args.appendSlice(&[_][]const u8{ "-O", @tagName(code.mode) });
- try shell_out.print("-O {s} ", .{@tagName(code.mode)});
- },
- }
-
- if (code.target_str) |triple| {
- try build_args.appendSlice(&[_][]const u8{ "-target", triple });
- try shell_out.print("-target {s} ", .{triple});
- }
- for (code.additional_options) |option| {
- try build_args.append(option);
- try shell_out.print("{s} ", .{option});
- }
-
- if (maybe_error_match) |error_match| {
- const result = try ChildProcess.exec(.{
- .allocator = allocator,
- .argv = build_args.items,
- .env_map = &env_map,
- .max_output_bytes = max_doc_file_size,
- });
- switch (result.term) {
- .Exited => |exit_code| {
- if (exit_code == 0) {
- progress.log("", .{});
- print("{s}\nThe following command incorrectly succeeded:\n", .{result.stderr});
- dumpArgs(build_args.items);
- return parseError(tokenizer, code.source_token, "example build incorrectly succeeded", .{});
- }
- },
- else => {
- progress.log("", .{});
- print("{s}\nThe following command crashed:\n", .{result.stderr});
- dumpArgs(build_args.items);
- return parseError(tokenizer, code.source_token, "example compile crashed", .{});
- },
- }
- if (mem.indexOf(u8, result.stderr, error_match) == null) {
- progress.log("", .{});
- print("{s}\nExpected to find '{s}' in stderr\n", .{ result.stderr, error_match });
- return parseError(tokenizer, code.source_token, "example did not have expected compile error message", .{});
- }
- const escaped_stderr = try escapeHtml(allocator, result.stderr);
- const colored_stderr = try termColor(allocator, escaped_stderr);
- try shell_out.print("\n{s} ", .{colored_stderr});
- } else {
- _ = exec(allocator, &env_map, null, build_args.items) catch return parseError(tokenizer, code.source_token, "example failed to compile", .{});
- }
- try shell_out.writeAll("\n");
- },
- .lib => {
- const bin_basename = try std.zig.binNameAlloc(allocator, .{
- .root_name = code.name,
- .target = builtin.target,
- .output_mode = .Lib,
- });
-
- var test_args = std.ArrayList([]const u8).init(allocator);
- defer test_args.deinit();
-
- try test_args.appendSlice(&[_][]const u8{
- zig_exe, "build-lib",
- tmp_source_file_name,
- try std.fmt.allocPrint(allocator, "-femit-bin={s}{s}{s}", .{
- tmp_dir_name, fs.path.sep_str, bin_basename,
- }),
- });
- if (opt_zig_lib_dir) |zig_lib_dir| {
- try test_args.appendSlice(&.{ "--zig-lib-dir", zig_lib_dir });
- }
- try shell_out.print("$ zig build-lib {s}.zig ", .{code.name});
-
- switch (code.mode) {
- .Debug => {},
- else => {
- try test_args.appendSlice(&[_][]const u8{ "-O", @tagName(code.mode) });
- try shell_out.print("-O {s} ", .{@tagName(code.mode)});
- },
- }
- if (code.target_str) |triple| {
- try test_args.appendSlice(&[_][]const u8{ "-target", triple });
- try shell_out.print("-target {s} ", .{triple});
- }
- if (code.link_mode) |link_mode| {
- switch (link_mode) {
- .Static => {
- try test_args.append("-static");
- try shell_out.print("-static ", .{});
- },
- .Dynamic => {
- try test_args.append("-dynamic");
- try shell_out.print("-dynamic ", .{});
- },
- }
- }
- for (code.additional_options) |option| {
- try test_args.append(option);
- try shell_out.print("{s} ", .{option});
- }
- const result = exec(allocator, &env_map, null, test_args.items) catch return parseError(tokenizer, code.source_token, "test failed", .{});
- const escaped_stderr = try escapeHtml(allocator, result.stderr);
- const escaped_stdout = try escapeHtml(allocator, result.stdout);
- try shell_out.print("\n{s}{s}\n", .{ escaped_stderr, escaped_stdout });
- },
- }
-
- if (!code.just_check_syntax) {
- try printShell(out, shell_buffer.items, false);
- }
- },
- }
- }
-}
-
-fn exec(
- allocator: Allocator,
- env_map: *process.EnvMap,
- cwd: ?[]const u8,
- args: []const []const u8,
-) !ChildProcess.ExecResult {
- const result = try ChildProcess.exec(.{
- .allocator = allocator,
- .argv = args,
- .env_map = env_map,
- .cwd = cwd,
- .max_output_bytes = max_doc_file_size,
- });
- switch (result.term) {
- .Exited => |exit_code| {
- if (exit_code != 0) {
- print("{s}\nThe following command exited with code {}:\n", .{ result.stderr, exit_code });
- dumpArgs(args);
- return error.ChildExitError;
- }
- },
- else => {
- print("{s}\nThe following command crashed:\n", .{result.stderr});
- dumpArgs(args);
- return error.ChildCrashed;
- },
- }
- return result;
-}
-
-fn getBuiltinCode(
- allocator: Allocator,
- env_map: *process.EnvMap,
- zig_exe: []const u8,
- opt_zig_lib_dir: ?[]const u8,
-) ![]const u8 {
- if (opt_zig_lib_dir) |zig_lib_dir| {
- const result = try exec(allocator, env_map, null, &.{
- zig_exe, "build-obj", "--show-builtin", "--zig-lib-dir", zig_lib_dir,
- });
- return result.stdout;
- } else {
- const result = try exec(allocator, env_map, null, &.{
- zig_exe, "build-obj", "--show-builtin",
- });
- return result.stdout;
- }
-}
-
-fn dumpArgs(args: []const []const u8) void {
- for (args) |arg|
- print("{s} ", .{arg})
- else
- print("\n", .{});
-}
-
-test "term supported colors" {
- const test_allocator = testing.allocator;
-
- {
- const input = "A\x1b[31;1mred\x1b[0mB";
- const expect = "AredB";
-
- const result = try termColor(test_allocator, input);
- defer test_allocator.free(result);
- try testing.expectEqualSlices(u8, expect, result);
- }
-
- {
- const input = "A\x1b[32;1mgreen\x1b[0mB";
- const expect = "AgreenB";
-
- const result = try termColor(test_allocator, input);
- defer test_allocator.free(result);
- try testing.expectEqualSlices(u8, expect, result);
- }
-
- {
- const input = "A\x1b[36;1mcyan\x1b[0mB";
- const expect = "AcyanB";
-
- const result = try termColor(test_allocator, input);
- defer test_allocator.free(result);
- try testing.expectEqualSlices(u8, expect, result);
- }
-
- {
- const input = "A\x1b[1mbold\x1b[0mB";
- const expect = "AboldB";
-
- const result = try termColor(test_allocator, input);
- defer test_allocator.free(result);
- try testing.expectEqualSlices(u8, expect, result);
- }
-
- {
- const input = "A\x1b[2mdim\x1b[0mB";
- const expect = "AdimB";
-
- const result = try termColor(test_allocator, input);
- defer test_allocator.free(result);
- try testing.expectEqualSlices(u8, expect, result);
- }
-}
-
-test "term output from zig" {
- // Use data generated by https://github.com/perillo/zig-tty-test-data,
- // with zig version 0.11.0-dev.1898+36d47dd19.
- const test_allocator = testing.allocator;
-
- {
- // 1.1-with-build-progress.out
- const input = "Semantic Analysis [1324] \x1b[25D\x1b[0KLLVM Emit Object... \x1b[20D\x1b[0KLLVM Emit Object... \x1b[20D\x1b[0KLLD Link... \x1b[12D\x1b[0K";
- const expect = "";
-
- const result = try termColor(test_allocator, input);
- defer test_allocator.free(result);
- try testing.expectEqualSlices(u8, expect, result);
- }
-
- {
- // 2.1-with-reference-traces.out
- const input = "\x1b[1msrc/2.1-with-reference-traces.zig:3:7: \x1b[31;1merror: \x1b[0m\x1b[1mcannot assign to constant\n\x1b[0m x += 1;\n \x1b[32;1m~~^~~~\n\x1b[0m\x1b[0m\x1b[2mreferenced by:\n main: src/2.1-with-reference-traces.zig:7:5\n callMain: /usr/local/lib/zig/lib/std/start.zig:607:17\n remaining reference traces hidden; use '-freference-trace' to see all reference traces\n\n\x1b[0m";
- const expect =
- \\src/2.1-with-reference-traces.zig:3:7: error: cannot assign to constant
- \\ x += 1;
- \\ ~~^~~~
- \\referenced by:
- \\ main: src/2.1-with-reference-traces.zig:7:5
- \\ callMain: /usr/local/lib/zig/lib/std/start.zig:607:17
- \\ remaining reference traces hidden; use '-freference-trace' to see all reference traces
- \\
- \\
- ;
-
- const result = try termColor(test_allocator, input);
- defer test_allocator.free(result);
- try testing.expectEqualSlices(u8, expect, result);
- }
-
- {
- // 2.2-without-reference-traces.out
- const input = "\x1b[1m/usr/local/lib/zig/lib/std/io/fixed_buffer_stream.zig:128:29: \x1b[31;1merror: \x1b[0m\x1b[1minvalid type given to fixedBufferStream\n\x1b[0m else => @compileError(\"invalid type given to fixedBufferStream\"),\n \x1b[32;1m^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\x1b[0m\x1b[1m/usr/local/lib/zig/lib/std/io/fixed_buffer_stream.zig:116:66: \x1b[36;1mnote: \x1b[0m\x1b[1mcalled from here\n\x1b[0mpub fn fixedBufferStream(buffer: anytype) FixedBufferStream(Slice(@TypeOf(buffer))) {\n; \x1b[32;1m~~~~~^~~~~~~~~~~~~~~~~\n\x1b[0m";
- const expect =
- \\/usr/local/lib/zig/lib/std/io/fixed_buffer_stream.zig:128:29: error: invalid type given to fixedBufferStream
- \\ else => @compileError("invalid type given to fixedBufferStream"),
- \\ ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- \\/usr/local/lib/zig/lib/std/io/fixed_buffer_stream.zig:116:66: note: called from here
- \\pub fn fixedBufferStream(buffer: anytype) FixedBufferStream(Slice(@TypeOf(buffer))) {
- \\; ~~~~~^~~~~~~~~~~~~~~~~
- \\
- ;
-
- const result = try termColor(test_allocator, input);
- defer test_allocator.free(result);
- try testing.expectEqualSlices(u8, expect, result);
- }
-
- {
- // 2.3-with-notes.out
- const input = "\x1b[1msrc/2.3-with-notes.zig:6:9: \x1b[31;1merror: \x1b[0m\x1b[1mexpected type '*2.3-with-notes.Derp', found '*2.3-with-notes.Wat'\n\x1b[0m bar(w);\n \x1b[32;1m^\n\x1b[0m\x1b[1msrc/2.3-with-notes.zig:6:9: \x1b[36;1mnote: \x1b[0m\x1b[1mpointer type child '2.3-with-notes.Wat' cannot cast into pointer type child '2.3-with-notes.Derp'\n\x1b[0m\x1b[1msrc/2.3-with-notes.zig:2:13: \x1b[36;1mnote: \x1b[0m\x1b[1mopaque declared here\n\x1b[0mconst Wat = opaque {};\n \x1b[32;1m^~~~~~~~~\n\x1b[0m\x1b[1msrc/2.3-with-notes.zig:1:14: \x1b[36;1mnote: \x1b[0m\x1b[1mopaque declared here\n\x1b[0mconst Derp = opaque {};\n \x1b[32;1m^~~~~~~~~\n\x1b[0m\x1b[1msrc/2.3-with-notes.zig:4:18: \x1b[36;1mnote: \x1b[0m\x1b[1mparameter type declared here\n\x1b[0mextern fn bar(d: *Derp) void;\n \x1b[32;1m^~~~~\n\x1b[0m\x1b[0m\x1b[2mreferenced by:\n main: src/2.3-with-notes.zig:10:5\n callMain: /usr/local/lib/zig/lib/std/start.zig:607:17\n remaining reference traces hidden; use '-freference-trace' to see all reference traces\n\n\x1b[0m";
- const expect =
- \\src/2.3-with-notes.zig:6:9: error: expected type '*2.3-with-notes.Derp', found '*2.3-with-notes.Wat'
- \\ bar(w);
- \\ ^
- \\src/2.3-with-notes.zig:6:9: note: pointer type child '2.3-with-notes.Wat' cannot cast into pointer type child '2.3-with-notes.Derp'
- \\src/2.3-with-notes.zig:2:13: note: opaque declared here
- \\const Wat = opaque {};
- \\ ^~~~~~~~~
- \\src/2.3-with-notes.zig:1:14: note: opaque declared here
- \\const Derp = opaque {};
- \\ ^~~~~~~~~
- \\src/2.3-with-notes.zig:4:18: note: parameter type declared here
- \\extern fn bar(d: *Derp) void;
- \\ ^~~~~
- \\referenced by:
- \\ main: src/2.3-with-notes.zig:10:5
- \\ callMain: /usr/local/lib/zig/lib/std/start.zig:607:17
- \\ remaining reference traces hidden; use '-freference-trace' to see all reference traces
- \\
- \\
- ;
-
- const result = try termColor(test_allocator, input);
- defer test_allocator.free(result);
- try testing.expectEqualSlices(u8, expect, result);
- }
-
- {
- // 3.1-with-error-return-traces.out
-
- const input = "error: Error\n\x1b[1m/home/zig/src/3.1-with-error-return-traces.zig:5:5\x1b[0m: \x1b[2m0x20b008 in callee (3.1-with-error-return-traces)\x1b[0m\n return error.Error;\n \x1b[32;1m^\x1b[0m\n\x1b[1m/home/zig/src/3.1-with-error-return-traces.zig:9:5\x1b[0m: \x1b[2m0x20b113 in caller (3.1-with-error-return-traces)\x1b[0m\n try callee();\n \x1b[32;1m^\x1b[0m\n\x1b[1m/home/zig/src/3.1-with-error-return-traces.zig:13:5\x1b[0m: \x1b[2m0x20b153 in main (3.1-with-error-return-traces)\x1b[0m\n try caller();\n \x1b[32;1m^\x1b[0m\n";
- const expect =
- \\error: Error
- \\/home/zig/src/3.1-with-error-return-traces.zig:5:5: 0x20b008 in callee (3.1-with-error-return-traces)
- \\ return error.Error;
- \\ ^
- \\/home/zig/src/3.1-with-error-return-traces.zig:9:5: 0x20b113 in caller (3.1-with-error-return-traces)
- \\ try callee();
- \\ ^
- \\/home/zig/src/3.1-with-error-return-traces.zig:13:5: 0x20b153 in main (3.1-with-error-return-traces)
- \\ try caller();
- \\ ^
- \\
- ;
-
- const result = try termColor(test_allocator, input);
- defer test_allocator.free(result);
- try testing.expectEqualSlices(u8, expect, result);
- }
-
- {
- // 3.2-with-stack-trace.out
- const input = "\x1b[1m/usr/local/lib/zig/lib/std/debug.zig:561:19\x1b[0m: \x1b[2m0x22a107 in writeCurrentStackTrace__anon_5898 (3.2-with-stack-trace)\x1b[0m\n while (it.next()) |return_address| {\n \x1b[32;1m^\x1b[0m\n\x1b[1m/usr/local/lib/zig/lib/std/debug.zig:157:80\x1b[0m: \x1b[2m0x20bb23 in dumpCurrentStackTrace (3.2-with-stack-trace)\x1b[0m\n writeCurrentStackTrace(stderr, debug_info, detectTTYConfig(io.getStdErr()), start_addr) catch |err| {\n \x1b[32;1m^\x1b[0m\n\x1b[1m/home/zig/src/3.2-with-stack-trace.zig:5:36\x1b[0m: \x1b[2m0x20d3b2 in foo (3.2-with-stack-trace)\x1b[0m\n std.debug.dumpCurrentStackTrace(null);\n \x1b[32;1m^\x1b[0m\n\x1b[1m/home/zig/src/3.2-with-stack-trace.zig:9:8\x1b[0m: \x1b[2m0x20b458 in main (3.2-with-stack-trace)\x1b[0m\n foo();\n \x1b[32;1m^\x1b[0m\n\x1b[1m/usr/local/lib/zig/lib/std/start.zig:607:22\x1b[0m: \x1b[2m0x20a965 in posixCallMainAndExit (3.2-with-stack-trace)\x1b[0m\n root.main();\n \x1b[32;1m^\x1b[0m\n\x1b[1m/usr/local/lib/zig/lib/std/start.zig:376:5\x1b[0m: \x1b[2m0x20a411 in _start (3.2-with-stack-trace)\x1b[0m\n @call(.never_inline, posixCallMainAndExit, .{});\n \x1b[32;1m^\x1b[0m\n";
- const expect =
- \\/usr/local/lib/zig/lib/std/debug.zig:561:19: 0x22a107 in writeCurrentStackTrace__anon_5898 (3.2-with-stack-trace)
- \\ while (it.next()) |return_address| {
- \\ ^
- \\/usr/local/lib/zig/lib/std/debug.zig:157:80: 0x20bb23 in dumpCurrentStackTrace (3.2-with-stack-trace)
- \\ writeCurrentStackTrace(stderr, debug_info, detectTTYConfig(io.getStdErr()), start_addr) catch |err| {
- \\ ^
- \\/home/zig/src/3.2-with-stack-trace.zig:5:36: 0x20d3b2 in foo (3.2-with-stack-trace)
- \\ std.debug.dumpCurrentStackTrace(null);
- \\ ^
- \\/home/zig/src/3.2-with-stack-trace.zig:9:8: 0x20b458 in main (3.2-with-stack-trace)
- \\ foo();
- \\ ^
- \\/usr/local/lib/zig/lib/std/start.zig:607:22: 0x20a965 in posixCallMainAndExit (3.2-with-stack-trace)
- \\ root.main();
- \\ ^
- \\/usr/local/lib/zig/lib/std/start.zig:376:5: 0x20a411 in _start (3.2-with-stack-trace)
- \\ @call(.never_inline, posixCallMainAndExit, .{});
- \\ ^
- \\
- ;
-
- const result = try termColor(test_allocator, input);
- defer test_allocator.free(result);
- try testing.expectEqualSlices(u8, expect, result);
- }
-}
-
-test "printShell" {
- const test_allocator = std.testing.allocator;
-
- {
- const shell_out =
- \\$ zig build test.zig
- ;
- const expected =
- \\Shell$ zig build test.zig
- \\
- ;
-
- var buffer = std.ArrayList(u8).init(test_allocator);
- defer buffer.deinit();
-
- try printShell(buffer.writer(), shell_out, false);
- try testing.expectEqualSlices(u8, expected, buffer.items);
- }
- {
- const shell_out =
- \\$ zig build test.zig
- \\build output
- ;
- const expected =
- \\Shell$ zig build test.zig
- \\build output
- \\
- ;
-
- var buffer = std.ArrayList(u8).init(test_allocator);
- defer buffer.deinit();
-
- try printShell(buffer.writer(), shell_out, false);
- try testing.expectEqualSlices(u8, expected, buffer.items);
- }
- {
- const shell_out =
- \\$ zig build test.zig
- \\build output
- \\$ ./test
- ;
- const expected =
- \\Shell$ zig build test.zig
- \\build output
- \\$ ./test
- \\
- ;
-
- var buffer = std.ArrayList(u8).init(test_allocator);
- defer buffer.deinit();
-
- try printShell(buffer.writer(), shell_out, false);
- try testing.expectEqualSlices(u8, expected, buffer.items);
- }
- {
- const shell_out =
- \\$ zig build test.zig
- \\
- \\$ ./test
- \\output
- ;
- const expected =
- \\Shell$ zig build test.zig
- \\
- \\$ ./test
- \\output
- \\
- ;
-
- var buffer = std.ArrayList(u8).init(test_allocator);
- defer buffer.deinit();
-
- try printShell(buffer.writer(), shell_out, false);
- try testing.expectEqualSlices(u8, expected, buffer.items);
- }
- {
- const shell_out =
- \\$ zig build test.zig
- \\$ ./test
- \\output
- ;
- const expected =
- \\Shell$ zig build test.zig
- \\$ ./test
- \\output
- \\
- ;
-
- var buffer = std.ArrayList(u8).init(test_allocator);
- defer buffer.deinit();
-
- try printShell(buffer.writer(), shell_out, false);
- try testing.expectEqualSlices(u8, expected, buffer.items);
- }
- {
- const shell_out =
- \\$ zig build test.zig \
- \\ --build-option
- \\build output
- \\$ ./test
- \\output
- ;
- const expected =
- \\Shell$ zig build test.zig \
- \\ --build-option
- \\build output
- \\$ ./test
- \\output
- \\
- ;
-
- var buffer = std.ArrayList(u8).init(test_allocator);
- defer buffer.deinit();
-
- try printShell(buffer.writer(), shell_out, false);
- try testing.expectEqualSlices(u8, expected, buffer.items);
- }
- {
- // intentional space after "--build-option1 \"
- const shell_out =
- \\$ zig build test.zig \
- \\ --build-option1 \
- \\ --build-option2
- \\$ ./test
- ;
- const expected =
- \\Shell$ zig build test.zig \
- \\ --build-option1 \
- \\ --build-option2
- \\$ ./test
- \\
- ;
-
- var buffer = std.ArrayList(u8).init(test_allocator);
- defer buffer.deinit();
-
- try printShell(buffer.writer(), shell_out, false);
- try testing.expectEqualSlices(u8, expected, buffer.items);
- }
- {
- const shell_out =
- \\$ zig build test.zig \
- \\$ ./test
- ;
- const expected =
- \\Shell$ zig build test.zig \
- \\$ ./test
- \\
- ;
-
- var buffer = std.ArrayList(u8).init(test_allocator);
- defer buffer.deinit();
-
- try printShell(buffer.writer(), shell_out, false);
- try testing.expectEqualSlices(u8, expected, buffer.items);
- }
- {
- const shell_out =
- \\$ zig build test.zig
- \\$ ./test
- \\$1
- ;
- const expected =
- \\Shell$ zig build test.zig
- \\$ ./test
- \\$1
- \\
- ;
-
- var buffer = std.ArrayList(u8).init(test_allocator);
- defer buffer.deinit();
-
- try printShell(buffer.writer(), shell_out, false);
- try testing.expectEqualSlices(u8, expected, buffer.items);
- }
- {
- const shell_out =
- \\$zig build test.zig
- ;
- const expected =
- \\Shell$zig build test.zig
- \\
- ;
-
- var buffer = std.ArrayList(u8).init(test_allocator);
- defer buffer.deinit();
-
- try printShell(buffer.writer(), shell_out, false);
- try testing.expectEqualSlices(u8, expected, buffer.items);
- }
-}
diff --git a/lib/build_runner.zig b/lib/build_runner.zig
index cdedba90b2d60a0f5d16fb227e23d9491808d5a2..7d036fa5bf4b67ec6ceccef7af2d8cb75b739b84 100644
--- a/lib/build_runner.zig
+++ b/lib/build_runner.zig
@@ -188,10 +188,10 @@ pub fn main() !void {
usageAndErr(builder, false, stderr_stream);
};
} else if (mem.eql(u8, arg, "--zig-lib-dir")) {
- builder.zig_lib_dir = nextArg(args, &arg_idx) orelse {
+ builder.zig_lib_dir = .{ .cwd_relative = nextArg(args, &arg_idx) orelse {
std.debug.print("Expected argument after {s}\n\n", .{arg});
usageAndErr(builder, false, stderr_stream);
- };
+ } };
} else if (mem.eql(u8, arg, "--debug-log")) {
const next_arg = nextArg(args, &arg_idx) orelse {
std.debug.print("Expected argument after {s}\n\n", .{arg});
diff --git a/lib/std/Build.zig b/lib/std/Build.zig
index aaf152f5ac6575aeaf3ecabe231d4ebb7a8b96d6..9cc501d3240edcb5d96f565d0c82a0c60278ba2c 100644
--- a/lib/std/Build.zig
+++ b/lib/std/Build.zig
@@ -57,6 +57,8 @@ pub const RunStep = @import("Build/Step/Run.zig");
pub const TranslateCStep = @import("Build/Step/TranslateC.zig");
/// deprecated: use `Step.WriteFile`.
pub const WriteFileStep = @import("Build/Step/WriteFile.zig");
+/// deprecated: use `LazyPath`.
+pub const FileSource = LazyPath;
install_tls: TopLevelStep,
uninstall_tls: TopLevelStep,
@@ -93,8 +95,7 @@ build_root: Cache.Directory,
cache_root: Cache.Directory,
global_cache_root: Cache.Directory,
cache: *Cache,
-/// If non-null, overrides the default zig lib dir.
-zig_lib_dir: ?[]const u8,
+zig_lib_dir: ?LazyPath,
vcpkg_root: VcpkgRoot = .unattempted,
pkg_config_pkg_list: ?(PkgConfigError![]const PkgConfigPkg) = null,
args: ?[][]const u8 = null,
@@ -471,7 +472,7 @@ pub fn addOptions(self: *Build) *Step.Options {
pub const ExecutableOptions = struct {
name: []const u8,
- root_source_file: ?FileSource = null,
+ root_source_file: ?LazyPath = null,
version: ?std.SemanticVersion = null,
target: CrossTarget = .{},
optimize: std.builtin.Mode = .Debug,
@@ -481,6 +482,8 @@ pub const ExecutableOptions = struct {
single_threaded: ?bool = null,
use_llvm: ?bool = null,
use_lld: ?bool = null,
+ zig_lib_dir: ?LazyPath = null,
+ main_pkg_path: ?LazyPath = null,
};
pub fn addExecutable(b: *Build, options: ExecutableOptions) *Step.Compile {
@@ -497,12 +500,14 @@ pub fn addExecutable(b: *Build, options: ExecutableOptions) *Step.Compile {
.single_threaded = options.single_threaded,
.use_llvm = options.use_llvm,
.use_lld = options.use_lld,
+ .zig_lib_dir = options.zig_lib_dir orelse b.zig_lib_dir,
+ .main_pkg_path = options.main_pkg_path,
});
}
pub const ObjectOptions = struct {
name: []const u8,
- root_source_file: ?FileSource = null,
+ root_source_file: ?LazyPath = null,
target: CrossTarget,
optimize: std.builtin.Mode,
max_rss: usize = 0,
@@ -510,6 +515,8 @@ pub const ObjectOptions = struct {
single_threaded: ?bool = null,
use_llvm: ?bool = null,
use_lld: ?bool = null,
+ zig_lib_dir: ?LazyPath = null,
+ main_pkg_path: ?LazyPath = null,
};
pub fn addObject(b: *Build, options: ObjectOptions) *Step.Compile {
@@ -524,12 +531,14 @@ pub fn addObject(b: *Build, options: ObjectOptions) *Step.Compile {
.single_threaded = options.single_threaded,
.use_llvm = options.use_llvm,
.use_lld = options.use_lld,
+ .zig_lib_dir = options.zig_lib_dir orelse b.zig_lib_dir,
+ .main_pkg_path = options.main_pkg_path,
});
}
pub const SharedLibraryOptions = struct {
name: []const u8,
- root_source_file: ?FileSource = null,
+ root_source_file: ?LazyPath = null,
version: ?std.SemanticVersion = null,
target: CrossTarget,
optimize: std.builtin.Mode,
@@ -538,6 +547,8 @@ pub const SharedLibraryOptions = struct {
single_threaded: ?bool = null,
use_llvm: ?bool = null,
use_lld: ?bool = null,
+ zig_lib_dir: ?LazyPath = null,
+ main_pkg_path: ?LazyPath = null,
};
pub fn addSharedLibrary(b: *Build, options: SharedLibraryOptions) *Step.Compile {
@@ -554,12 +565,14 @@ pub fn addSharedLibrary(b: *Build, options: SharedLibraryOptions) *Step.Compile
.single_threaded = options.single_threaded,
.use_llvm = options.use_llvm,
.use_lld = options.use_lld,
+ .zig_lib_dir = options.zig_lib_dir orelse b.zig_lib_dir,
+ .main_pkg_path = options.main_pkg_path,
});
}
pub const StaticLibraryOptions = struct {
name: []const u8,
- root_source_file: ?FileSource = null,
+ root_source_file: ?LazyPath = null,
target: CrossTarget,
optimize: std.builtin.Mode,
version: ?std.SemanticVersion = null,
@@ -568,6 +581,8 @@ pub const StaticLibraryOptions = struct {
single_threaded: ?bool = null,
use_llvm: ?bool = null,
use_lld: ?bool = null,
+ zig_lib_dir: ?LazyPath = null,
+ main_pkg_path: ?LazyPath = null,
};
pub fn addStaticLibrary(b: *Build, options: StaticLibraryOptions) *Step.Compile {
@@ -584,12 +599,14 @@ pub fn addStaticLibrary(b: *Build, options: StaticLibraryOptions) *Step.Compile
.single_threaded = options.single_threaded,
.use_llvm = options.use_llvm,
.use_lld = options.use_lld,
+ .zig_lib_dir = options.zig_lib_dir orelse b.zig_lib_dir,
+ .main_pkg_path = options.main_pkg_path,
});
}
pub const TestOptions = struct {
name: []const u8 = "test",
- root_source_file: FileSource,
+ root_source_file: LazyPath,
target: CrossTarget = .{},
optimize: std.builtin.Mode = .Debug,
version: ?std.SemanticVersion = null,
@@ -600,6 +617,8 @@ pub const TestOptions = struct {
single_threaded: ?bool = null,
use_llvm: ?bool = null,
use_lld: ?bool = null,
+ zig_lib_dir: ?LazyPath = null,
+ main_pkg_path: ?LazyPath = null,
};
pub fn addTest(b: *Build, options: TestOptions) *Step.Compile {
@@ -616,15 +635,18 @@ pub fn addTest(b: *Build, options: TestOptions) *Step.Compile {
.single_threaded = options.single_threaded,
.use_llvm = options.use_llvm,
.use_lld = options.use_lld,
+ .zig_lib_dir = options.zig_lib_dir orelse b.zig_lib_dir,
+ .main_pkg_path = options.main_pkg_path,
});
}
pub const AssemblyOptions = struct {
name: []const u8,
- source_file: FileSource,
+ source_file: LazyPath,
target: CrossTarget,
optimize: std.builtin.Mode,
max_rss: usize = 0,
+ zig_lib_dir: ?LazyPath = null,
};
pub fn addAssembly(b: *Build, options: AssemblyOptions) *Step.Compile {
@@ -635,8 +657,9 @@ pub fn addAssembly(b: *Build, options: AssemblyOptions) *Step.Compile {
.target = options.target,
.optimize = options.optimize,
.max_rss = options.max_rss,
+ .zig_lib_dir = options.zig_lib_dir orelse b.zig_lib_dir,
});
- obj_step.addAssemblyFileSource(options.source_file.dupe(b));
+ obj_step.addAssemblyLazyPath(options.source_file.dupe(b));
return obj_step;
}
@@ -655,7 +678,7 @@ pub const ModuleDependency = struct {
};
pub const CreateModuleOptions = struct {
- source_file: FileSource,
+ source_file: LazyPath,
dependencies: []const ModuleDependency = &.{},
};
@@ -1257,12 +1280,21 @@ fn printCmd(ally: Allocator, cwd: ?[]const u8, argv: []const []const u8) void {
std.debug.print("{s}\n", .{text});
}
+/// This creates the install step and adds it to the dependencies of the
+/// top-level install step, using all the default options.
+/// See `addInstallArtifact` for a more flexible function.
pub fn installArtifact(self: *Build, artifact: *Step.Compile) void {
- self.getInstallStep().dependOn(&self.addInstallArtifact(artifact).step);
+ self.getInstallStep().dependOn(&self.addInstallArtifact(artifact, .{}).step);
}
-pub fn addInstallArtifact(self: *Build, artifact: *Step.Compile) *Step.InstallArtifact {
- return Step.InstallArtifact.create(self, artifact);
+/// This merely creates the step; it does not add it to the dependencies of the
+/// top-level install step.
+pub fn addInstallArtifact(
+ self: *Build,
+ artifact: *Step.Compile,
+ options: Step.InstallArtifact.Options,
+) *Step.InstallArtifact {
+ return Step.InstallArtifact.create(self, artifact, options);
}
///`dest_rel_path` is relative to prefix path
@@ -1284,22 +1316,22 @@ pub fn installLibFile(self: *Build, src_path: []const u8, dest_rel_path: []const
self.getInstallStep().dependOn(&self.addInstallFileWithDir(.{ .path = src_path }, .lib, dest_rel_path).step);
}
-pub fn addObjCopy(b: *Build, source: FileSource, options: Step.ObjCopy.Options) *Step.ObjCopy {
+pub fn addObjCopy(b: *Build, source: LazyPath, options: Step.ObjCopy.Options) *Step.ObjCopy {
return Step.ObjCopy.create(b, source, options);
}
///`dest_rel_path` is relative to install prefix path
-pub fn addInstallFile(self: *Build, source: FileSource, dest_rel_path: []const u8) *Step.InstallFile {
+pub fn addInstallFile(self: *Build, source: LazyPath, dest_rel_path: []const u8) *Step.InstallFile {
return self.addInstallFileWithDir(source.dupe(self), .prefix, dest_rel_path);
}
///`dest_rel_path` is relative to bin path
-pub fn addInstallBinFile(self: *Build, source: FileSource, dest_rel_path: []const u8) *Step.InstallFile {
+pub fn addInstallBinFile(self: *Build, source: LazyPath, dest_rel_path: []const u8) *Step.InstallFile {
return self.addInstallFileWithDir(source.dupe(self), .bin, dest_rel_path);
}
///`dest_rel_path` is relative to lib path
-pub fn addInstallLibFile(self: *Build, source: FileSource, dest_rel_path: []const u8) *Step.InstallFile {
+pub fn addInstallLibFile(self: *Build, source: LazyPath, dest_rel_path: []const u8) *Step.InstallFile {
return self.addInstallFileWithDir(source.dupe(self), .lib, dest_rel_path);
}
@@ -1309,7 +1341,7 @@ pub fn addInstallHeaderFile(b: *Build, src_path: []const u8, dest_rel_path: []co
pub fn addInstallFileWithDir(
self: *Build,
- source: FileSource,
+ source: LazyPath,
install_dir: InstallDir,
dest_rel_path: []const u8,
) *Step.InstallFile {
@@ -1322,12 +1354,13 @@ pub fn addInstallDirectory(self: *Build, options: InstallDirectoryOptions) *Step
pub fn addCheckFile(
b: *Build,
- file_source: FileSource,
+ file_source: LazyPath,
options: Step.CheckFile.Options,
) *Step.CheckFile {
return Step.CheckFile.create(b, file_source, options);
}
+/// deprecated: https://github.com/ziglang/zig/issues/14943
pub fn pushInstalledFile(self: *Build, dir: InstallDir, dest_rel_path: []const u8) void {
const file = InstalledFile{
.dir = dir,
@@ -1357,6 +1390,11 @@ pub fn pathFromRoot(b: *Build, p: []const u8) []u8 {
return fs.path.resolve(b.allocator, &.{ b.build_root.path orelse ".", p }) catch @panic("OOM");
}
+fn pathFromCwd(b: *Build, p: []const u8) []u8 {
+ const cwd = process.getCwdAlloc(b.allocator) catch @panic("OOM");
+ return fs.path.resolve(b.allocator, &.{ cwd, p }) catch @panic("OOM");
+}
+
pub fn pathJoin(self: *Build, paths: []const []const u8) []u8 {
return fs.path.join(self.allocator, paths) catch @panic("OOM");
}
@@ -1608,7 +1646,7 @@ pub const Module = struct {
/// This could either be a generated file, in which case the module
/// contains exactly one file, or it could be a path to the root source
/// file of directory of files which constitute the module.
- source_file: FileSource,
+ source_file: LazyPath,
dependencies: std.StringArrayHashMap(*Module),
};
@@ -1630,50 +1668,64 @@ pub const GeneratedFile = struct {
}
};
-/// A file source is a reference to an existing or future file.
-pub const FileSource = union(enum) {
- /// A plain file path, relative to build root or absolute.
+/// A reference to an existing or future path.
+pub const LazyPath = union(enum) {
+ /// A source file path relative to build root.
+ /// This should not be an absolute path, but in an older iteration of the zig build
+ /// system API, it was allowed to be absolute. Absolute paths should use `cwd_relative`.
path: []const u8,
/// A file that is generated by an interface. Those files usually are
/// not available until built by a build step.
generated: *const GeneratedFile,
+ /// An absolute path or a path relative to the current working directory of
+ /// the build runner process.
+ /// This is uncommon but used for system environment paths such as `--zig-lib-dir` which
+ /// ignore the file system path of build.zig and instead are relative to the directory from
+ /// which `zig build` was invoked.
+ /// Use of this tag indicates a dependency on the host system.
+ cwd_relative: []const u8,
+
/// Returns a new file source that will have a relative path to the build root guaranteed.
- /// This should be preferred over setting `.path` directly as it documents that the files are in the project directory.
- pub fn relative(path: []const u8) FileSource {
+ /// Asserts the parameter is not an absolute path.
+ pub fn relative(path: []const u8) LazyPath {
std.debug.assert(!std.fs.path.isAbsolute(path));
- return FileSource{ .path = path };
+ return LazyPath{ .path = path };
}
/// Returns a string that can be shown to represent the file source.
/// Either returns the path or `"generated"`.
- pub fn getDisplayName(self: FileSource) []const u8 {
+ pub fn getDisplayName(self: LazyPath) []const u8 {
return switch (self) {
- .path => self.path,
+ .path, .cwd_relative => self.path,
.generated => "generated",
};
}
/// Adds dependencies this file source implies to the given step.
- pub fn addStepDependencies(self: FileSource, other_step: *Step) void {
+ pub fn addStepDependencies(self: LazyPath, other_step: *Step) void {
switch (self) {
- .path => {},
+ .path, .cwd_relative => {},
.generated => |gen| other_step.dependOn(gen.step),
}
}
- /// Should only be called during make(), returns a path relative to the build root or absolute.
- pub fn getPath(self: FileSource, src_builder: *Build) []const u8 {
+ /// Returns an absolute path.
+ /// Intended to be used during the make phase only.
+ pub fn getPath(self: LazyPath, src_builder: *Build) []const u8 {
return getPath2(self, src_builder, null);
}
- /// Should only be called during make(), returns a path relative to the build root or absolute.
- /// asking_step is only used for debugging purposes; it's the step being run that is asking for
- /// the path.
- pub fn getPath2(self: FileSource, src_builder: *Build, asking_step: ?*Step) []const u8 {
+ /// Returns an absolute path.
+ /// Intended to be used during the make phase only.
+ ///
+ /// `asking_step` is only used for debugging purposes; it's the step being
+ /// run that is asking for the path.
+ pub fn getPath2(self: LazyPath, src_builder: *Build, asking_step: ?*Step) []const u8 {
switch (self) {
.path => |p| return src_builder.pathFromRoot(p),
+ .cwd_relative => |p| return src_builder.pathFromCwd(p),
.generated => |gen| return gen.path orelse {
std.debug.getStderrMutex().lock();
const stderr = std.io.getStdErr();
@@ -1684,16 +1736,17 @@ pub const FileSource = union(enum) {
}
/// Duplicates the file source for a given builder.
- pub fn dupe(self: FileSource, b: *Build) FileSource {
+ pub fn dupe(self: LazyPath, b: *Build) LazyPath {
return switch (self) {
.path => |p| .{ .path = b.dupePath(p) },
+ .cwd_relative => |p| .{ .cwd_relative = b.dupePath(p) },
.generated => |gen| .{ .generated = gen },
};
}
};
/// In this function the stderr mutex has already been locked.
-fn dumpBadGetPathHelp(
+pub fn dumpBadGetPathHelp(
s: *Step,
stderr: fs.File,
src_builder: *Build,
diff --git a/lib/std/Build/Step.zig b/lib/std/Build/Step.zig
index 991283dbc526cdfae354afa53b7b9ae9e2c3647d..8fd60b4ad6187e56362e34fc4715186c2c58fa96 100644
--- a/lib/std/Build/Step.zig
+++ b/lib/std/Build/Step.zig
@@ -423,12 +423,7 @@ pub fn evalZigProcess(
});
}
- if (s.cast(Compile)) |compile| if (compile.emit_bin == .no_emit) return result;
-
- return result orelse return s.fail(
- "the following command failed to communicate the compilation result:\n{s}",
- .{try allocPrintCmd(arena, null, argv)},
- );
+ return result;
}
fn sendMessage(file: std.fs.File, tag: std.zig.Client.Message.Tag) !void {
diff --git a/lib/std/Build/Step/CheckFile.zig b/lib/std/Build/Step/CheckFile.zig
index dc359b5654d2454e72bb97a6a22faa879f871c34..d072865922fb8da947f8b742f57b0726cc3de7c5 100644
--- a/lib/std/Build/Step/CheckFile.zig
+++ b/lib/std/Build/Step/CheckFile.zig
@@ -11,7 +11,7 @@ const mem = std.mem;
step: Step,
expected_matches: []const []const u8,
expected_exact: ?[]const u8,
-source: std.Build.FileSource,
+source: std.Build.LazyPath,
max_bytes: usize = 20 * 1024 * 1024,
pub const base_id = .check_file;
@@ -23,7 +23,7 @@ pub const Options = struct {
pub fn create(
owner: *std.Build,
- source: std.Build.FileSource,
+ source: std.Build.LazyPath,
options: Options,
) *CheckFile {
const self = owner.allocator.create(CheckFile) catch @panic("OOM");
diff --git a/lib/std/Build/Step/CheckObject.zig b/lib/std/Build/Step/CheckObject.zig
index e79468ec9bc7d1d09b37500690e4b1748ea46a5c..f69427ab05ecb11d0c7dcd2c3ed504a8f3702ea3 100644
--- a/lib/std/Build/Step/CheckObject.zig
+++ b/lib/std/Build/Step/CheckObject.zig
@@ -15,14 +15,14 @@ const Step = std.Build.Step;
pub const base_id = .check_object;
step: Step,
-source: std.Build.FileSource,
+source: std.Build.LazyPath,
max_bytes: usize = 20 * 1024 * 1024,
checks: std.ArrayList(Check),
obj_format: std.Target.ObjectFormat,
pub fn create(
owner: *std.Build,
- source: std.Build.FileSource,
+ source: std.Build.LazyPath,
obj_format: std.Target.ObjectFormat,
) *CheckObject {
const gpa = owner.allocator;
@@ -44,7 +44,7 @@ pub fn create(
const SearchPhrase = struct {
string: []const u8,
- file_source: ?std.Build.FileSource = null,
+ file_source: ?std.Build.LazyPath = null,
fn resolve(phrase: SearchPhrase, b: *std.Build, step: *Step) []const u8 {
const file_source = phrase.file_source orelse return phrase.string;
@@ -302,13 +302,13 @@ pub fn checkExact(self: *CheckObject, phrase: []const u8) void {
self.checkExactInner(phrase, null);
}
-/// Like `checkExact()` but takes an additional argument `FileSource` which will be
+/// Like `checkExact()` but takes an additional argument `LazyPath` which will be
/// resolved to a full search query in `make()`.
-pub fn checkExactFileSource(self: *CheckObject, phrase: []const u8, file_source: std.Build.FileSource) void {
+pub fn checkExactPath(self: *CheckObject, phrase: []const u8, file_source: std.Build.LazyPath) void {
self.checkExactInner(phrase, file_source);
}
-fn checkExactInner(self: *CheckObject, phrase: []const u8, file_source: ?std.Build.FileSource) void {
+fn checkExactInner(self: *CheckObject, phrase: []const u8, file_source: ?std.Build.LazyPath) void {
assert(self.checks.items.len > 0);
const last = &self.checks.items[self.checks.items.len - 1];
last.exact(.{ .string = self.step.owner.dupe(phrase), .file_source = file_source });
@@ -321,7 +321,7 @@ pub fn checkContains(self: *CheckObject, phrase: []const u8) void {
/// Like `checkContains()` but takes an additional argument `FileSource` which will be
/// resolved to a full search query in `make()`.
-pub fn checkContainsFileSource(self: *CheckObject, phrase: []const u8, file_source: std.Build.FileSource) void {
+pub fn checkContainsPath(self: *CheckObject, phrase: []const u8, file_source: std.Build.LazyPath) void {
self.checkContainsInner(phrase, file_source);
}
diff --git a/lib/std/Build/Step/Compile.zig b/lib/std/Build/Step/Compile.zig
index d3c8d54442c22702cc13301b7e509e720bbacd6b..d0352b257c78b0035ba2b9fb0020eac2bf985839 100644
--- a/lib/std/Build/Step/Compile.zig
+++ b/lib/std/Build/Step/Compile.zig
@@ -11,7 +11,7 @@ const Allocator = mem.Allocator;
const Step = std.Build.Step;
const CrossTarget = std.zig.CrossTarget;
const NativeTargetInfo = std.zig.system.NativeTargetInfo;
-const FileSource = std.Build.FileSource;
+const LazyPath = std.Build.LazyPath;
const PkgConfigPkg = std.Build.PkgConfigPkg;
const PkgConfigError = std.Build.PkgConfigError;
const ExecError = std.Build.ExecError;
@@ -28,7 +28,7 @@ name: []const u8,
target: CrossTarget,
target_info: NativeTargetInfo,
optimize: std.builtin.Mode,
-linker_script: ?FileSource = null,
+linker_script: ?LazyPath = null,
version_script: ?[]const u8 = null,
out_filename: []const u8,
linkage: ?Linkage = null,
@@ -40,20 +40,12 @@ strip: ?bool,
unwind_tables: ?bool,
// keep in sync with src/link.zig:CompressDebugSections
compress_debug_sections: enum { none, zlib } = .none,
-lib_paths: ArrayList(FileSource),
-rpaths: ArrayList(FileSource),
-framework_dirs: ArrayList(FileSource),
+lib_paths: ArrayList(LazyPath),
+rpaths: ArrayList(LazyPath),
+framework_dirs: ArrayList(LazyPath),
frameworks: StringHashMap(FrameworkLinkInfo),
verbose_link: bool,
verbose_cc: bool,
-emit_asm: EmitOption = .default,
-emit_bin: EmitOption = .default,
-emit_implib: EmitOption = .default,
-emit_llvm_bc: EmitOption = .default,
-emit_llvm_ir: EmitOption = .default,
-// Lots of things depend on emit_h having a consistent path,
-// so it is not an EmitOption for now.
-emit_h: bool = false,
bundle_compiler_rt: ?bool = null,
single_threaded: ?bool,
stack_protector: ?bool = null,
@@ -74,8 +66,10 @@ max_memory: ?u64 = null,
shared_memory: bool = false,
global_base: ?u64 = null,
c_std: std.Build.CStd,
-zig_lib_dir: ?[]const u8,
-main_pkg_path: ?[]const u8,
+/// Set via options; intended to be read-only after that.
+zig_lib_dir: ?LazyPath,
+/// Set via options; intended to be read-only after that.
+main_pkg_path: ?LazyPath,
exec_cmd_args: ?[]const ?[]const u8,
filter: ?[]const u8,
test_evented_io: bool = false,
@@ -85,10 +79,8 @@ wasi_exec_model: ?std.builtin.WasiExecModel = null,
/// Symbols to be exported when compiling to wasm
export_symbol_names: []const []const u8 = &.{},
-root_src: ?FileSource,
-out_h_filename: []const u8,
+root_src: ?LazyPath,
out_lib_filename: []const u8,
-out_pdb_filename: []const u8,
modules: std.StringArrayHashMap(*Module),
link_objects: ArrayList(LinkObject),
@@ -99,14 +91,12 @@ is_linking_libc: bool,
is_linking_libcpp: bool,
vcpkg_bin_path: ?[]const u8 = null,
-/// This may be set in order to override the default install directory
-override_dest_dir: ?InstallDir,
installed_path: ?[]const u8,
/// Base address for an executable image.
image_base: ?u64 = null,
-libc_file: ?FileSource = null,
+libc_file: ?LazyPath = null,
valgrind_support: ?bool = null,
each_lib_rpath: ?bool = null,
@@ -210,35 +200,40 @@ use_lld: ?bool,
/// otherwise.
expect_errors: []const []const u8 = &.{},
-output_path_source: GeneratedFile,
-output_lib_path_source: GeneratedFile,
-output_h_path_source: GeneratedFile,
-output_pdb_path_source: GeneratedFile,
-output_dirname_source: GeneratedFile,
+emit_directory: ?*GeneratedFile,
+
generated_docs: ?*GeneratedFile,
+generated_asm: ?*GeneratedFile,
+generated_bin: ?*GeneratedFile,
+generated_pdb: ?*GeneratedFile,
+generated_implib: ?*GeneratedFile,
+generated_llvm_bc: ?*GeneratedFile,
+generated_llvm_ir: ?*GeneratedFile,
+generated_h: ?*GeneratedFile,
pub const CSourceFiles = struct {
+ /// Relative to the build root.
files: []const []const u8,
flags: []const []const u8,
};
pub const CSourceFile = struct {
- source: FileSource,
- args: []const []const u8,
+ file: LazyPath,
+ flags: []const []const u8,
pub fn dupe(self: CSourceFile, b: *std.Build) CSourceFile {
return .{
- .source = self.source.dupe(b),
- .args = b.dupeStrings(self.args),
+ .file = self.file.dupe(b),
+ .flags = b.dupeStrings(self.flags),
};
}
};
pub const LinkObject = union(enum) {
- static_path: FileSource,
+ static_path: LazyPath,
other_step: *Compile,
system_lib: SystemLib,
- assembly_file: FileSource,
+ assembly_file: LazyPath,
c_source_file: *CSourceFile,
c_source_files: *CSourceFiles,
};
@@ -265,15 +260,15 @@ const FrameworkLinkInfo = struct {
};
pub const IncludeDir = union(enum) {
- raw_path: []const u8,
- raw_path_system: []const u8,
+ path: LazyPath,
+ path_system: LazyPath,
other_step: *Compile,
config_header_step: *Step.ConfigHeader,
};
pub const Options = struct {
name: []const u8,
- root_source_file: ?FileSource = null,
+ root_source_file: ?LazyPath = null,
target: CrossTarget,
optimize: std.builtin.Mode,
kind: Kind,
@@ -286,6 +281,8 @@ pub const Options = struct {
single_threaded: ?bool = null,
use_llvm: ?bool = null,
use_lld: ?bool = null,
+ zig_lib_dir: ?LazyPath = null,
+ main_pkg_path: ?LazyPath = null,
};
pub const BuildId = union(enum) {
@@ -373,25 +370,9 @@ pub const Kind = enum {
pub const Linkage = enum { dynamic, static };
-pub const EmitOption = union(enum) {
- default: void,
- no_emit: void,
- emit: void,
- emit_to: []const u8,
-
- fn getArg(self: @This(), b: *std.Build, arg_name: []const u8) ?[]const u8 {
- return switch (self) {
- .no_emit => b.fmt("-fno-{s}", .{arg_name}),
- .default => null,
- .emit => b.fmt("-f{s}", .{arg_name}),
- .emit_to => |path| b.fmt("-f{s}={s}", .{ arg_name, path }),
- };
- }
-};
-
pub fn create(owner: *std.Build, options: Options) *Compile {
const name = owner.dupe(options.name);
- const root_src: ?FileSource = if (options.root_source_file) |rsrc| rsrc.dupe(owner) else null;
+ const root_src: ?LazyPath = if (options.root_source_file) |rsrc| rsrc.dupe(owner) else null;
if (mem.indexOf(u8, name, "/") != null or mem.indexOf(u8, name, "\\") != null) {
panic("invalid name: '{s}'. It looks like a file path, but it is supposed to be the library or application name.", .{name});
}
@@ -453,18 +434,16 @@ pub fn create(owner: *std.Build, options: Options) *Compile {
}),
.version = options.version,
.out_filename = out_filename,
- .out_h_filename = owner.fmt("{s}.h", .{name}),
.out_lib_filename = undefined,
- .out_pdb_filename = owner.fmt("{s}.pdb", .{name}),
.major_only_filename = null,
.name_only_filename = null,
.modules = std.StringArrayHashMap(*Module).init(owner.allocator),
.include_dirs = ArrayList(IncludeDir).init(owner.allocator),
.link_objects = ArrayList(LinkObject).init(owner.allocator),
.c_macros = ArrayList([]const u8).init(owner.allocator),
- .lib_paths = ArrayList(FileSource).init(owner.allocator),
- .rpaths = ArrayList(FileSource).init(owner.allocator),
- .framework_dirs = ArrayList(FileSource).init(owner.allocator),
+ .lib_paths = ArrayList(LazyPath).init(owner.allocator),
+ .rpaths = ArrayList(LazyPath).init(owner.allocator),
+ .framework_dirs = ArrayList(LazyPath).init(owner.allocator),
.installed_headers = ArrayList(*Step).init(owner.allocator),
.c_std = std.Build.CStd.C99,
.zig_lib_dir = null,
@@ -476,16 +455,18 @@ pub fn create(owner: *std.Build, options: Options) *Compile {
.disable_sanitize_c = false,
.sanitize_thread = false,
.rdynamic = false,
- .override_dest_dir = null,
.installed_path = null,
.force_undefined_symbols = StringHashMap(void).init(owner.allocator),
- .output_path_source = GeneratedFile{ .step = &self.step },
- .output_lib_path_source = GeneratedFile{ .step = &self.step },
- .output_h_path_source = GeneratedFile{ .step = &self.step },
- .output_pdb_path_source = GeneratedFile{ .step = &self.step },
- .output_dirname_source = GeneratedFile{ .step = &self.step },
+ .emit_directory = null,
.generated_docs = null,
+ .generated_asm = null,
+ .generated_bin = null,
+ .generated_pdb = null,
+ .generated_implib = null,
+ .generated_llvm_bc = null,
+ .generated_llvm_ir = null,
+ .generated_h = null,
.target_info = target_info,
@@ -496,6 +477,16 @@ pub fn create(owner: *std.Build, options: Options) *Compile {
.use_lld = options.use_lld,
};
+ if (options.zig_lib_dir) |lp| {
+ self.zig_lib_dir = lp.dupe(self.step.owner);
+ lp.addStepDependencies(&self.step);
+ }
+
+ if (options.main_pkg_path) |lp| {
+ self.main_pkg_path = lp.dupe(self.step.owner);
+ lp.addStepDependencies(&self.step);
+ }
+
if (self.kind == .lib) {
if (self.linkage != null and self.linkage.? == .static) {
self.out_lib_filename = self.out_filename;
@@ -614,7 +605,7 @@ pub fn addObjCopy(cs: *Compile, options: Step.ObjCopy.Options) *Step.ObjCopy {
copy.basename = cs.name;
}
}
- return b.addObjCopy(cs.getOutputSource(), copy);
+ return b.addObjCopy(cs.getEmittedBin(), copy);
}
/// This function would run in the context of the package that created the executable,
@@ -626,10 +617,13 @@ pub const run = @compileError("deprecated; use std.Build.addRunArtifact");
pub const install = @compileError("deprecated; use std.Build.installArtifact");
pub fn checkObject(self: *Compile) *Step.CheckObject {
- return Step.CheckObject.create(self.step.owner, self.getOutputSource(), self.target_info.target.ofmt);
+ return Step.CheckObject.create(self.step.owner, self.getEmittedBin(), self.target_info.target.ofmt);
}
-pub fn setLinkerScriptPath(self: *Compile, source: FileSource) void {
+/// deprecated: use `setLinkerScript`
+pub const setLinkerScriptPath = setLinkerScript;
+
+pub fn setLinkerScript(self: *Compile, source: LazyPath) void {
const b = self.step.owner;
self.linker_script = source.dupe(b);
source.addStepDependencies(&self.step);
@@ -690,12 +684,18 @@ pub fn isStaticLibrary(self: *Compile) bool {
}
pub fn producesPdbFile(self: *Compile) bool {
+ // TODO: Is this right? Isn't PDB for *any* PE/COFF file?
+ // TODO: just share this logic with the compiler, silly!
if (!self.target.isWindows() and !self.target.isUefi()) return false;
if (self.target.getObjectFormat() == .c) return false;
if (self.strip == true or (self.strip == null and self.optimize == .ReleaseSmall)) return false;
return self.isDynamicLibrary() or self.kind == .exe or self.kind == .@"test";
}
+pub fn producesImplib(self: *Compile) bool {
+ return self.isDynamicLibrary() and self.target.isWindows();
+}
+
pub fn linkLibC(self: *Compile) void {
self.is_linking_libc = true;
}
@@ -935,19 +935,12 @@ pub fn addCSourceFiles(self: *Compile, files: []const []const u8, flags: []const
self.link_objects.append(.{ .c_source_files = c_source_files }) catch @panic("OOM");
}
-pub fn addCSourceFile(self: *Compile, file: []const u8, flags: []const []const u8) void {
- self.addCSourceFileSource(.{
- .args = flags,
- .source = .{ .path = file },
- });
-}
-
-pub fn addCSourceFileSource(self: *Compile, source: CSourceFile) void {
+pub fn addCSourceFile(self: *Compile, source: CSourceFile) void {
const b = self.step.owner;
const c_source_file = b.allocator.create(CSourceFile) catch @panic("OOM");
c_source_file.* = source.dupe(b);
self.link_objects.append(.{ .c_source_file = c_source_file }) catch @panic("OOM");
- source.source.addStepDependencies(&self.step);
+ source.file.addStepDependencies(&self.step);
}
pub fn setVerboseLink(self: *Compile, value: bool) void {
@@ -958,80 +951,99 @@ pub fn setVerboseCC(self: *Compile, value: bool) void {
self.verbose_cc = value;
}
-pub fn overrideZigLibDir(self: *Compile, dir_path: []const u8) void {
- const b = self.step.owner;
- self.zig_lib_dir = b.dupePath(dir_path);
-}
-
-pub fn setMainPkgPath(self: *Compile, dir_path: []const u8) void {
- const b = self.step.owner;
- self.main_pkg_path = b.dupePath(dir_path);
-}
-
-pub fn setLibCFile(self: *Compile, libc_file: ?FileSource) void {
+pub fn setLibCFile(self: *Compile, libc_file: ?LazyPath) void {
const b = self.step.owner;
self.libc_file = if (libc_file) |f| f.dupe(b) else null;
}
-/// Returns the generated executable, library or object file.
-/// To run an executable built with zig build, use `run`, or create an install step and invoke it.
-pub fn getOutputSource(self: *Compile) FileSource {
- return .{ .generated = &self.output_path_source };
-}
-
-pub fn getOutputDirectorySource(self: *Compile) FileSource {
- return .{ .generated = &self.output_dirname_source };
-}
-
-/// Returns the generated import library. This function can only be called for libraries.
-pub fn getOutputLibSource(self: *Compile) FileSource {
- assert(self.kind == .lib);
- return .{ .generated = &self.output_lib_path_source };
-}
-
-/// Returns the generated header file.
-/// This function can only be called for libraries or object files which have `emit_h` set.
-pub fn getOutputHSource(self: *Compile) FileSource {
- assert(self.kind != .exe and self.kind != .@"test");
- assert(self.emit_h);
- return .{ .generated = &self.output_h_path_source };
-}
-
-/// Returns the generated PDB file. This function can only be called for Windows and UEFI.
-pub fn getOutputPdbSource(self: *Compile) FileSource {
- // TODO: Is this right? Isn't PDB for *any* PE/COFF file?
- assert(self.target.isWindows() or self.target.isUefi());
- return .{ .generated = &self.output_pdb_path_source };
-}
-
-pub fn getEmittedDocs(self: *Compile) FileSource {
- if (self.generated_docs) |g| return .{ .generated = g };
+fn getEmittedFileGeneric(self: *Compile, output_file: *?*GeneratedFile) LazyPath {
+ if (output_file.*) |g| {
+ return .{ .generated = g };
+ }
const arena = self.step.owner.allocator;
const generated_file = arena.create(GeneratedFile) catch @panic("OOM");
generated_file.* = .{ .step = &self.step };
- self.generated_docs = generated_file;
+ output_file.* = generated_file;
return .{ .generated = generated_file };
}
-pub fn addAssemblyFile(self: *Compile, path: []const u8) void {
- const b = self.step.owner;
- self.link_objects.append(.{
- .assembly_file = .{ .path = b.dupe(path) },
- }) catch @panic("OOM");
+/// deprecated: use `getEmittedBinDirectory`
+pub const getOutputDirectorySource = getEmittedBinDirectory;
+
+/// Returns the path to the directory that contains the emitted binary file.
+pub fn getEmittedBinDirectory(self: *Compile) LazyPath {
+ _ = self.getEmittedBin();
+ return self.getEmittedFileGeneric(&self.emit_directory);
+}
+
+/// deprecated: use `getEmittedBin`
+pub const getOutputSource = getEmittedBin;
+
+/// Returns the path to the generated executable, library or object file.
+/// To run an executable built with zig build, use `run`, or create an install step and invoke it.
+pub fn getEmittedBin(self: *Compile) LazyPath {
+ return self.getEmittedFileGeneric(&self.generated_bin);
+}
+
+/// deprecated: use `getEmittedImplib`
+pub const getOutputLibSource = getEmittedImplib;
+
+/// Returns the path to the generated import library.
+/// This function can only be called for libraries.
+pub fn getEmittedImplib(self: *Compile) LazyPath {
+ assert(self.kind == .lib);
+ return self.getEmittedFileGeneric(&self.generated_implib);
+}
+
+/// deprecated: use `getEmittedH`
+pub const getOutputHSource = getEmittedH;
+
+/// Returns the path to the generated header file.
+/// This function can only be called for libraries or objects.
+pub fn getEmittedH(self: *Compile) LazyPath {
+ assert(self.kind != .exe and self.kind != .@"test");
+ return self.getEmittedFileGeneric(&self.generated_h);
+}
+
+/// deprecated: use `getEmittedPdb`.
+pub const getOutputPdbSource = getEmittedPdb;
+
+/// Returns the generated PDB file.
+/// If the compilation does not produce a PDB file, this causes a FileNotFound error
+/// at build time.
+pub fn getEmittedPdb(self: *Compile) LazyPath {
+ _ = self.getEmittedBin();
+ return self.getEmittedFileGeneric(&self.generated_pdb);
+}
+
+/// Returns the path to the generated documentation directory.
+pub fn getEmittedDocs(self: *Compile) LazyPath {
+ return self.getEmittedFileGeneric(&self.generated_docs);
+}
+
+/// Returns the path to the generated assembly code.
+pub fn getEmittedAsm(self: *Compile) LazyPath {
+ return self.getEmittedFileGeneric(&self.generated_asm);
+}
+
+/// Returns the path to the generated LLVM IR.
+pub fn getEmittedLlvmIr(self: *Compile) LazyPath {
+ return self.getEmittedFileGeneric(&self.generated_llvm_ir);
+}
+
+/// Returns the path to the generated LLVM BC.
+pub fn getEmittedLlvmBc(self: *Compile) LazyPath {
+ return self.getEmittedFileGeneric(&self.generated_llvm_bc);
}
-pub fn addAssemblyFileSource(self: *Compile, source: FileSource) void {
+pub fn addAssemblyFile(self: *Compile, source: LazyPath) void {
const b = self.step.owner;
const source_duped = source.dupe(b);
self.link_objects.append(.{ .assembly_file = source_duped }) catch @panic("OOM");
source_duped.addStepDependencies(&self.step);
}
-pub fn addObjectFile(self: *Compile, source_file: []const u8) void {
- self.addObjectFileSource(.{ .path = source_file });
-}
-
-pub fn addObjectFileSource(self: *Compile, source: FileSource) void {
+pub fn addObjectFile(self: *Compile, source: LazyPath) void {
const b = self.step.owner;
self.link_objects.append(.{ .static_path = source.dupe(b) }) catch @panic("OOM");
source.addStepDependencies(&self.step);
@@ -1042,14 +1054,16 @@ pub fn addObject(self: *Compile, obj: *Compile) void {
self.linkLibraryOrObject(obj);
}
-pub fn addSystemIncludePath(self: *Compile, path: []const u8) void {
+pub fn addSystemIncludePath(self: *Compile, path: LazyPath) void {
const b = self.step.owner;
- self.include_dirs.append(IncludeDir{ .raw_path_system = b.dupe(path) }) catch @panic("OOM");
+ self.include_dirs.append(IncludeDir{ .path_system = path.dupe(b) }) catch @panic("OOM");
+ path.addStepDependencies(&self.step);
}
-pub fn addIncludePath(self: *Compile, path: []const u8) void {
+pub fn addIncludePath(self: *Compile, path: LazyPath) void {
const b = self.step.owner;
- self.include_dirs.append(IncludeDir{ .raw_path = b.dupe(path) }) catch @panic("OOM");
+ self.include_dirs.append(IncludeDir{ .path = path.dupe(b) }) catch @panic("OOM");
+ path.addStepDependencies(&self.step);
}
pub fn addConfigHeader(self: *Compile, config_header: *Step.ConfigHeader) void {
@@ -1057,32 +1071,17 @@ pub fn addConfigHeader(self: *Compile, config_header: *Step.ConfigHeader) void {
self.include_dirs.append(.{ .config_header_step = config_header }) catch @panic("OOM");
}
-pub fn addLibraryPath(self: *Compile, path: []const u8) void {
- const b = self.step.owner;
- self.lib_paths.append(.{ .path = b.dupe(path) }) catch @panic("OOM");
-}
-
-pub fn addLibraryPathDirectorySource(self: *Compile, directory_source: FileSource) void {
+pub fn addLibraryPath(self: *Compile, directory_source: LazyPath) void {
self.lib_paths.append(directory_source) catch @panic("OOM");
directory_source.addStepDependencies(&self.step);
}
-pub fn addRPath(self: *Compile, path: []const u8) void {
- const b = self.step.owner;
- self.rpaths.append(.{ .path = b.dupe(path) }) catch @panic("OOM");
-}
-
-pub fn addRPathDirectorySource(self: *Compile, directory_source: FileSource) void {
+pub fn addRPath(self: *Compile, directory_source: LazyPath) void {
self.rpaths.append(directory_source) catch @panic("OOM");
directory_source.addStepDependencies(&self.step);
}
-pub fn addFrameworkPath(self: *Compile, dir_path: []const u8) void {
- const b = self.step.owner;
- self.framework_dirs.append(.{ .path = b.dupe(dir_path) }) catch @panic("OOM");
-}
-
-pub fn addFrameworkPathDirectorySource(self: *Compile, directory_source: FileSource) void {
+pub fn addFrameworkPath(self: *Compile, directory_source: LazyPath) void {
self.framework_dirs.append(directory_source) catch @panic("OOM");
directory_source.addStepDependencies(&self.step);
}
@@ -1168,7 +1167,11 @@ pub fn setExecCmd(self: *Compile, args: []const ?[]const u8) void {
}
fn linkLibraryOrObject(self: *Compile, other: *Compile) void {
- self.step.dependOn(&other.step);
+ other.getEmittedBin().addStepDependencies(&self.step);
+ if (other.target.isWindows() and other.isDynamicLibrary()) {
+ other.getEmittedImplib().addStepDependencies(&self.step);
+ }
+
self.link_objects.append(.{ .other_step = other }) catch @panic("OOM");
self.include_dirs.append(.{ .other_step = other }) catch @panic("OOM");
@@ -1287,6 +1290,30 @@ fn constructDepString(
}
}
+fn getGeneratedFilePath(self: *Compile, comptime tag_name: []const u8, asking_step: ?*Step) []const u8 {
+ const maybe_path: ?*GeneratedFile = @field(self, tag_name);
+
+ const generated_file = maybe_path orelse {
+ std.debug.getStderrMutex().lock();
+ const stderr = std.io.getStdErr();
+
+ std.Build.dumpBadGetPathHelp(&self.step, stderr, self.step.owner, asking_step) catch {};
+
+ @panic("missing emit option for " ++ tag_name);
+ };
+
+ const path = generated_file.path orelse {
+ std.debug.getStderrMutex().lock();
+ const stderr = std.io.getStdErr();
+
+ std.Build.dumpBadGetPathHelp(&self.step, stderr, self.step.owner, asking_step) catch {};
+
+ @panic(tag_name ++ " is null. Is there a missing step dependency?");
+ };
+
+ return path;
+}
+
fn make(step: *Step, prog_node: *std.Progress.Node) !void {
const b = step.owner;
const self = @fieldParentPtr(Compile, "step", step);
@@ -1364,7 +1391,7 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
.exe => @panic("Cannot link with an executable build artifact"),
.@"test" => @panic("Cannot link with a test"),
.obj => {
- try zig_args.append(other.getOutputSource().getPath(b));
+ try zig_args.append(other.getEmittedBin().getPath(b));
},
.lib => l: {
if (self.isStaticLibrary() and other.isStaticLibrary()) {
@@ -1372,7 +1399,12 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
break :l;
}
- const full_path_lib = other.getOutputLibSource().getPath(b);
+ // For DLLs, we gotta link against the implib. For
+ // everything else, we directly link against the library file.
+ const full_path_lib = if (other.producesImplib())
+ other.getGeneratedFilePath("generated_implib", &self.step)
+ else
+ other.getGeneratedFilePath("generated_bin", &self.step);
try zig_args.append(full_path_lib);
if (other.linkage == Linkage.dynamic and !self.target.isWindows()) {
@@ -1432,7 +1464,7 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
},
.c_source_file => |c_source_file| {
- if (c_source_file.args.len == 0) {
+ if (c_source_file.flags.len == 0) {
if (prev_has_cflags) {
try zig_args.append("-cflags");
try zig_args.append("--");
@@ -1440,13 +1472,13 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
}
} else {
try zig_args.append("-cflags");
- for (c_source_file.args) |arg| {
+ for (c_source_file.flags) |arg| {
try zig_args.append(arg);
}
try zig_args.append("--");
prev_has_cflags = true;
}
- try zig_args.append(c_source_file.source.getPath(b));
+ try zig_args.append(c_source_file.file.getPath(b));
},
.c_source_files => |c_source_files| {
@@ -1515,14 +1547,13 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
if (b.verbose_cc or self.verbose_cc) try zig_args.append("--verbose-cc");
if (b.verbose_llvm_cpu_features) try zig_args.append("--verbose-llvm-cpu-features");
- if (self.emit_asm.getArg(b, "emit-asm")) |arg| try zig_args.append(arg);
- if (self.emit_bin.getArg(b, "emit-bin")) |arg| try zig_args.append(arg);
+ if (self.generated_asm != null) try zig_args.append("-femit-asm");
+ if (self.generated_bin == null) try zig_args.append("-fno-emit-bin");
if (self.generated_docs != null) try zig_args.append("-femit-docs");
- if (self.emit_implib.getArg(b, "emit-implib")) |arg| try zig_args.append(arg);
- if (self.emit_llvm_bc.getArg(b, "emit-llvm-bc")) |arg| try zig_args.append(arg);
- if (self.emit_llvm_ir.getArg(b, "emit-llvm-ir")) |arg| try zig_args.append(arg);
-
- if (self.emit_h) try zig_args.append("-femit-h");
+ if (self.generated_implib != null) try zig_args.append("-femit-implib");
+ if (self.generated_llvm_bc != null) try zig_args.append("-femit-llvm-bc");
+ if (self.generated_llvm_ir != null) try zig_args.append("-femit-llvm-ir");
+ if (self.generated_h != null) try zig_args.append("-femit-h");
try addFlag(&zig_args, "strip", self.strip);
try addFlag(&zig_args, "unwind-tables", self.unwind_tables);
@@ -1746,18 +1777,18 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
for (self.include_dirs.items) |include_dir| {
switch (include_dir) {
- .raw_path => |include_path| {
+ .path => |include_path| {
try zig_args.append("-I");
- try zig_args.append(b.pathFromRoot(include_path));
+ try zig_args.append(include_path.getPath(b));
},
- .raw_path_system => |include_path| {
+ .path_system => |include_path| {
if (b.sysroot != null) {
try zig_args.append("-iwithsysroot");
} else {
try zig_args.append("-isystem");
}
- const resolved_include_path = b.pathFromRoot(include_path);
+ const resolved_include_path = include_path.getPath(b);
const common_include_path = if (builtin.os.tag == .windows and b.sysroot != null and fs.path.isAbsolute(resolved_include_path)) blk: {
// We need to check for disk designator and strip it out from dir path so
@@ -1774,10 +1805,9 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
try zig_args.append(common_include_path);
},
.other_step => |other| {
- if (other.emit_h) {
- const h_path = other.getOutputHSource().getPath(b);
+ if (other.generated_h) |header| {
try zig_args.append("-isystem");
- try zig_args.append(fs.path.dirname(h_path).?);
+ try zig_args.append(fs.path.dirname(header.path.?).?);
}
if (other.installed_headers.items.len > 0) {
try zig_args.append("-I");
@@ -1810,7 +1840,7 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
zig_args.appendAssumeCapacity("-rpath");
if (self.target_info.target.isDarwin()) switch (rpath) {
- .path => |path| {
+ .path, .cwd_relative => |path| {
// On Darwin, we should not try to expand special runtime paths such as
// * @executable_path
// * @loader_path
@@ -1907,15 +1937,12 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
if (self.zig_lib_dir) |dir| {
try zig_args.append("--zig-lib-dir");
- try zig_args.append(b.pathFromRoot(dir));
- } else if (b.zig_lib_dir) |dir| {
- try zig_args.append("--zig-lib-dir");
- try zig_args.append(dir);
+ try zig_args.append(dir.getPath(b));
}
if (self.main_pkg_path) |dir| {
try zig_args.append("--main-pkg-path");
- try zig_args.append(b.pathFromRoot(dir));
+ try zig_args.append(dir.getPath(b));
}
try addFlag(&zig_args, "PIC", self.force_pic);
@@ -2008,33 +2035,51 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
if (maybe_output_bin_path) |output_bin_path| {
const output_dir = fs.path.dirname(output_bin_path).?;
- self.output_dirname_source.path = output_dir;
+ if (self.emit_directory) |lp| {
+ lp.path = output_dir;
+ }
+
+ // -femit-bin[=path] (default) Output machine code
+ if (self.generated_bin) |bin| {
+ bin.path = b.pathJoin(&.{ output_dir, self.out_filename });
+ }
- self.output_path_source.path = b.pathJoin(
- &.{ output_dir, self.out_filename },
- );
+ const sep = std.fs.path.sep;
- if (self.kind == .lib) {
- self.output_lib_path_source.path = b.pathJoin(
- &.{ output_dir, self.out_lib_filename },
- );
+ // output PDB if someone requested it
+ if (self.generated_pdb) |pdb| {
+ pdb.path = b.fmt("{s}{c}{s}.pdb", .{ output_dir, sep, self.name });
}
- if (self.emit_h) {
- self.output_h_path_source.path = b.pathJoin(
- &.{ output_dir, self.out_h_filename },
- );
+ // -femit-implib[=path] (default) Produce an import .lib when building a Windows DLL
+ if (self.generated_implib) |implib| {
+ implib.path = b.fmt("{s}{c}{s}.lib", .{ output_dir, sep, self.name });
}
- if (self.target.isWindows() or self.target.isUefi()) {
- self.output_pdb_path_source.path = b.pathJoin(
- &.{ output_dir, self.out_pdb_filename },
- );
+ // -femit-h[=path] Generate a C header file (.h)
+ if (self.generated_h) |lp| {
+ lp.path = b.fmt("{s}{c}{s}.h", .{ output_dir, sep, self.name });
}
+ // -femit-docs[=path] Create a docs/ dir with html documentation
if (self.generated_docs) |generated_docs| {
generated_docs.path = b.pathJoin(&.{ output_dir, "docs" });
}
+
+ // -femit-asm[=path] Output .s (assembly code)
+ if (self.generated_asm) |lp| {
+ lp.path = b.fmt("{s}{c}{s}.s", .{ output_dir, sep, self.name });
+ }
+
+ // -femit-llvm-ir[=path] Produce a .ll file with optimized LLVM IR (requires LLVM extensions)
+ if (self.generated_llvm_ir) |lp| {
+ lp.path = b.fmt("{s}{c}{s}.ll", .{ output_dir, sep, self.name });
+ }
+
+ // -femit-llvm-bc[=path] Produce an optimized LLVM module as a .bc file (requires LLVM extensions)
+ if (self.generated_llvm_bc) |lp| {
+ lp.path = b.fmt("{s}{c}{s}.bc", .{ output_dir, sep, self.name });
+ }
}
if (self.kind == .lib and self.linkage != null and self.linkage.? == .dynamic and
@@ -2042,7 +2087,7 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
{
try doAtomicSymLinks(
step,
- self.getOutputSource().getPath(b),
+ self.getEmittedBin().getPath(b),
self.major_only_filename.?,
self.name_only_filename.?,
);
diff --git a/lib/std/Build/Step/ConfigHeader.zig b/lib/std/Build/Step/ConfigHeader.zig
index a697d7eda8fe9569c28ae5e54aaa77470f25db31..df090ea9485630561651ec3cef3c80acf3ae6223 100644
--- a/lib/std/Build/Step/ConfigHeader.zig
+++ b/lib/std/Build/Step/ConfigHeader.zig
@@ -6,16 +6,19 @@ const Allocator = std.mem.Allocator;
pub const Style = union(enum) {
/// The configure format supported by autotools. It uses `#undef foo` to
/// mark lines that can be substituted with different values.
- autoconf: std.Build.FileSource,
+ autoconf: std.Build.LazyPath,
/// The configure format supported by CMake. It uses `@@FOO@@` and
/// `#cmakedefine` for template substitution.
- cmake: std.Build.FileSource,
+ cmake: std.Build.LazyPath,
/// Instead of starting with an input file, start with nothing.
blank,
/// Start with nothing, like blank, and output a nasm .asm file.
nasm,
- pub fn getFileSource(style: Style) ?std.Build.FileSource {
+ /// deprecated: use `getPath`
+ pub const getFileSource = getPath;
+
+ pub fn getPath(style: Style) ?std.Build.LazyPath {
switch (style) {
.autoconf, .cmake => |s| return s,
.blank, .nasm => return null,
@@ -54,7 +57,7 @@ pub fn create(owner: *std.Build, options: Options) *ConfigHeader {
var include_path: []const u8 = "config.h";
- if (options.style.getFileSource()) |s| switch (s) {
+ if (options.style.getPath()) |s| switch (s) {
.path => |p| {
const basename = std.fs.path.basename(p);
if (std.mem.endsWith(u8, basename, ".h.in")) {
@@ -68,7 +71,7 @@ pub fn create(owner: *std.Build, options: Options) *ConfigHeader {
include_path = p;
}
- const name = if (options.style.getFileSource()) |s|
+ const name = if (options.style.getPath()) |s|
owner.fmt("configure {s} header {s} to {s}", .{
@tagName(options.style), s.getDisplayName(), include_path,
})
@@ -98,7 +101,10 @@ pub fn addValues(self: *ConfigHeader, values: anytype) void {
return addValuesInner(self, values) catch @panic("OOM");
}
-pub fn getFileSource(self: *ConfigHeader) std.Build.FileSource {
+/// deprecated: use `getOutput`
+pub const getFileSource = getOutput;
+
+pub fn getOutput(self: *ConfigHeader) std.Build.LazyPath {
return .{ .generated = &self.output_file };
}
diff --git a/lib/std/Build/Step/InstallArtifact.zig b/lib/std/Build/Step/InstallArtifact.zig
index 9552a44440446bdcf215aee0327038b1e13b115c..f3c9ca3bef0e271a8eeed015692f3d27c151eb3d 100644
--- a/lib/std/Build/Step/InstallArtifact.zig
+++ b/lib/std/Build/Step/InstallArtifact.zig
@@ -3,100 +3,150 @@ const Step = std.Build.Step;
const InstallDir = std.Build.InstallDir;
const InstallArtifact = @This();
const fs = std.fs;
-
-pub const base_id = .install_artifact;
+const LazyPath = std.Build.LazyPath;
step: Step,
-artifact: *Step.Compile,
-dest_dir: InstallDir,
+
+dest_dir: ?InstallDir,
+dest_sub_path: []const u8,
+emitted_bin: ?LazyPath,
+
+implib_dir: ?InstallDir,
+emitted_implib: ?LazyPath,
+
pdb_dir: ?InstallDir,
+emitted_pdb: ?LazyPath,
+
h_dir: ?InstallDir,
-/// If non-null, adds additional path components relative to dest_dir, and
-/// overrides the basename of the Compile step.
-dest_sub_path: ?[]const u8,
+emitted_h: ?LazyPath,
-pub fn create(owner: *std.Build, artifact: *Step.Compile) *InstallArtifact {
+dylib_symlinks: ?DylibSymlinkInfo,
+
+artifact: *Step.Compile,
+
+const DylibSymlinkInfo = struct {
+ major_only_filename: []const u8,
+ name_only_filename: []const u8,
+};
+
+pub const base_id = .install_artifact;
+
+pub const Options = struct {
+ /// Which installation directory to put the main output file into.
+ dest_dir: Dir = .default,
+ pdb_dir: Dir = .default,
+ h_dir: Dir = .default,
+ implib_dir: Dir = .default,
+
+ /// Whether to install symlinks along with dynamic libraries.
+ dylib_symlinks: ?bool = null,
+ /// If non-null, adds additional path components relative to bin dir, and
+ /// overrides the basename of the Compile step for installation purposes.
+ dest_sub_path: ?[]const u8 = null,
+
+ pub const Dir = union(enum) {
+ disabled,
+ default,
+ override: InstallDir,
+ };
+};
+
+pub fn create(owner: *std.Build, artifact: *Step.Compile, options: Options) *InstallArtifact {
const self = owner.allocator.create(InstallArtifact) catch @panic("OOM");
- self.* = InstallArtifact{
+ const dest_dir: ?InstallDir = switch (options.dest_dir) {
+ .disabled => null,
+ .default => switch (artifact.kind) {
+ .obj => @panic("object files have no standard installation procedure"),
+ .exe, .@"test" => InstallDir{ .bin = {} },
+ .lib => InstallDir{ .lib = {} },
+ },
+ .override => |o| o,
+ };
+ self.* = .{
.step = Step.init(.{
.id = base_id,
.name = owner.fmt("install {s}", .{artifact.name}),
.owner = owner,
.makeFn = make,
}),
- .artifact = artifact,
- .dest_dir = artifact.override_dest_dir orelse switch (artifact.kind) {
- .obj => @panic("Cannot install a .obj build artifact."),
- .exe, .@"test" => InstallDir{ .bin = {} },
- .lib => InstallDir{ .lib = {} },
+ .dest_dir = dest_dir,
+ .pdb_dir = switch (options.pdb_dir) {
+ .disabled => null,
+ .default => if (artifact.producesPdbFile()) dest_dir else null,
+ .override => |o| o,
},
- .pdb_dir = if (artifact.producesPdbFile()) blk: {
- if (artifact.kind == .exe or artifact.kind == .@"test") {
- break :blk InstallDir{ .bin = {} };
- } else {
- break :blk InstallDir{ .lib = {} };
- }
+ .h_dir = switch (options.h_dir) {
+ .disabled => null,
+ // https://github.com/ziglang/zig/issues/9698
+ .default => null,
+ //.default => switch (artifact.kind) {
+ // .lib => .header,
+ // else => null,
+ //},
+ .override => |o| o,
+ },
+ .implib_dir = switch (options.implib_dir) {
+ .disabled => null,
+ .default => if (artifact.producesImplib()) dest_dir else null,
+ .override => |o| o,
+ },
+
+ .dylib_symlinks = if (options.dylib_symlinks orelse (dest_dir != null and
+ artifact.isDynamicLibrary() and
+ artifact.version != null and
+ artifact.target.wantSharedLibSymLinks())) .{
+ .major_only_filename = artifact.major_only_filename.?,
+ .name_only_filename = artifact.name_only_filename.?,
} else null,
- .h_dir = if (artifact.kind == .lib and artifact.emit_h) .header else null,
- .dest_sub_path = null,
+
+ .dest_sub_path = options.dest_sub_path orelse artifact.out_filename,
+
+ .emitted_bin = null,
+ .emitted_pdb = null,
+ .emitted_h = null,
+ .emitted_implib = null,
+
+ .artifact = artifact,
};
+
self.step.dependOn(&artifact.step);
- owner.pushInstalledFile(self.dest_dir, artifact.out_filename);
- if (self.artifact.isDynamicLibrary()) {
- if (artifact.major_only_filename) |name| {
- owner.pushInstalledFile(.lib, name);
- }
- if (artifact.name_only_filename) |name| {
- owner.pushInstalledFile(.lib, name);
- }
- if (self.artifact.target.isWindows()) {
- owner.pushInstalledFile(.lib, artifact.out_lib_filename);
- }
- }
- if (self.pdb_dir) |pdb_dir| {
- owner.pushInstalledFile(pdb_dir, artifact.out_pdb_filename);
- }
- if (self.h_dir) |h_dir| {
- owner.pushInstalledFile(h_dir, artifact.out_h_filename);
- }
+ if (self.dest_dir != null) self.emitted_bin = artifact.getEmittedBin();
+ if (self.pdb_dir != null) self.emitted_pdb = artifact.getEmittedPdb();
+ if (self.h_dir != null) self.emitted_h = artifact.getEmittedH();
+ if (self.implib_dir != null) self.emitted_implib = artifact.getEmittedImplib();
+
return self;
}
fn make(step: *Step, prog_node: *std.Progress.Node) !void {
_ = prog_node;
const self = @fieldParentPtr(InstallArtifact, "step", step);
- const src_builder = self.artifact.step.owner;
const dest_builder = step.owner;
-
- const dest_sub_path = if (self.dest_sub_path) |sub_path| sub_path else self.artifact.out_filename;
- const full_dest_path = dest_builder.getInstallPath(self.dest_dir, dest_sub_path);
const cwd = fs.cwd();
var all_cached = true;
- {
- const full_src_path = self.artifact.getOutputSource().getPath(src_builder);
+ if (self.dest_dir) |dest_dir| {
+ const full_dest_path = dest_builder.getInstallPath(dest_dir, self.dest_sub_path);
+ const full_src_path = self.emitted_bin.?.getPath2(step.owner, step);
const p = fs.Dir.updateFile(cwd, full_src_path, cwd, full_dest_path, .{}) catch |err| {
return step.fail("unable to update file from '{s}' to '{s}': {s}", .{
full_src_path, full_dest_path, @errorName(err),
});
};
all_cached = all_cached and p == .fresh;
- }
- if (self.artifact.isDynamicLibrary() and
- self.artifact.version != null and
- self.artifact.target.wantSharedLibSymLinks())
- {
- try Step.Compile.doAtomicSymLinks(step, full_dest_path, self.artifact.major_only_filename.?, self.artifact.name_only_filename.?);
+ if (self.dylib_symlinks) |dls| {
+ try Step.Compile.doAtomicSymLinks(step, full_dest_path, dls.major_only_filename, dls.name_only_filename);
+ }
+
+ self.artifact.installed_path = full_dest_path;
}
- if (self.artifact.isDynamicLibrary() and
- self.artifact.target.isWindows() and
- self.artifact.emit_implib != .no_emit)
- {
- const full_src_path = self.artifact.getOutputLibSource().getPath(src_builder);
- const full_implib_path = dest_builder.getInstallPath(self.dest_dir, self.artifact.out_lib_filename);
+
+ if (self.implib_dir) |implib_dir| {
+ const full_src_path = self.emitted_implib.?.getPath2(step.owner, step);
+ const full_implib_path = dest_builder.getInstallPath(implib_dir, fs.path.basename(full_src_path));
const p = fs.Dir.updateFile(cwd, full_src_path, cwd, full_implib_path, .{}) catch |err| {
return step.fail("unable to update file from '{s}' to '{s}': {s}", .{
full_src_path, full_implib_path, @errorName(err),
@@ -104,9 +154,10 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
};
all_cached = all_cached and p == .fresh;
}
+
if (self.pdb_dir) |pdb_dir| {
- const full_src_path = self.artifact.getOutputPdbSource().getPath(src_builder);
- const full_pdb_path = dest_builder.getInstallPath(pdb_dir, self.artifact.out_pdb_filename);
+ const full_src_path = self.emitted_pdb.?.getPath2(step.owner, step);
+ const full_pdb_path = dest_builder.getInstallPath(pdb_dir, fs.path.basename(full_src_path));
const p = fs.Dir.updateFile(cwd, full_src_path, cwd, full_pdb_path, .{}) catch |err| {
return step.fail("unable to update file from '{s}' to '{s}': {s}", .{
full_src_path, full_pdb_path, @errorName(err),
@@ -114,9 +165,10 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
};
all_cached = all_cached and p == .fresh;
}
+
if (self.h_dir) |h_dir| {
- const full_src_path = self.artifact.getOutputHSource().getPath(src_builder);
- const full_h_path = dest_builder.getInstallPath(h_dir, self.artifact.out_h_filename);
+ const full_src_path = self.emitted_h.?.getPath2(step.owner, step);
+ const full_h_path = dest_builder.getInstallPath(h_dir, fs.path.basename(full_src_path));
const p = fs.Dir.updateFile(cwd, full_src_path, cwd, full_h_path, .{}) catch |err| {
return step.fail("unable to update file from '{s}' to '{s}': {s}", .{
full_src_path, full_h_path, @errorName(err),
@@ -124,6 +176,6 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
};
all_cached = all_cached and p == .fresh;
}
- self.artifact.installed_path = full_dest_path;
+
step.result_cached = all_cached;
}
diff --git a/lib/std/Build/Step/InstallDir.zig b/lib/std/Build/Step/InstallDir.zig
index 5c9af3157d5ff1f392216d2d42b1eb6927d5c3fc..a38786a42429b209360fd8176340fb3d3e82b74c 100644
--- a/lib/std/Build/Step/InstallDir.zig
+++ b/lib/std/Build/Step/InstallDir.zig
@@ -2,7 +2,7 @@ const std = @import("std");
const mem = std.mem;
const fs = std.fs;
const Step = std.Build.Step;
-const FileSource = std.Build.FileSource;
+const LazyPath = std.Build.LazyPath;
const InstallDir = std.Build.InstallDir;
const InstallDirStep = @This();
@@ -15,7 +15,7 @@ dest_builder: *std.Build,
pub const base_id = .install_dir;
pub const Options = struct {
- source_dir: FileSource,
+ source_dir: LazyPath,
install_dir: InstallDir,
install_subdir: []const u8,
/// File paths which end in any of these suffixes will be excluded
diff --git a/lib/std/Build/Step/InstallFile.zig b/lib/std/Build/Step/InstallFile.zig
index 784685dc3a45e251035d976f2ab9b6972a2464da..f7487de5985fe96a536f0ddd6cd8be0f1aa056d2 100644
--- a/lib/std/Build/Step/InstallFile.zig
+++ b/lib/std/Build/Step/InstallFile.zig
@@ -1,6 +1,6 @@
const std = @import("std");
const Step = std.Build.Step;
-const FileSource = std.Build.FileSource;
+const LazyPath = std.Build.LazyPath;
const InstallDir = std.Build.InstallDir;
const InstallFile = @This();
const assert = std.debug.assert;
@@ -8,7 +8,7 @@ const assert = std.debug.assert;
pub const base_id = .install_file;
step: Step,
-source: FileSource,
+source: LazyPath,
dir: InstallDir,
dest_rel_path: []const u8,
/// This is used by the build system when a file being installed comes from one
@@ -17,7 +17,7 @@ dest_builder: *std.Build,
pub fn create(
owner: *std.Build,
- source: FileSource,
+ source: LazyPath,
dir: InstallDir,
dest_rel_path: []const u8,
) *InstallFile {
diff --git a/lib/std/Build/Step/ObjCopy.zig b/lib/std/Build/Step/ObjCopy.zig
index a8a0dafaef1dbe9cd0beda8c172fcac80c38e1b1..1fc6aa9a417572849e9b35628a6ccdfe21ce0f34 100644
--- a/lib/std/Build/Step/ObjCopy.zig
+++ b/lib/std/Build/Step/ObjCopy.zig
@@ -20,7 +20,7 @@ pub const RawFormat = enum {
};
step: Step,
-file_source: std.Build.FileSource,
+input_file: std.Build.LazyPath,
basename: []const u8,
output_file: std.Build.GeneratedFile,
@@ -37,30 +37,33 @@ pub const Options = struct {
pub fn create(
owner: *std.Build,
- file_source: std.Build.FileSource,
+ input_file: std.Build.LazyPath,
options: Options,
) *ObjCopy {
const self = owner.allocator.create(ObjCopy) catch @panic("OOM");
self.* = ObjCopy{
.step = Step.init(.{
.id = base_id,
- .name = owner.fmt("objcopy {s}", .{file_source.getDisplayName()}),
+ .name = owner.fmt("objcopy {s}", .{input_file.getDisplayName()}),
.owner = owner,
.makeFn = make,
}),
- .file_source = file_source,
- .basename = options.basename orelse file_source.getDisplayName(),
+ .input_file = input_file,
+ .basename = options.basename orelse input_file.getDisplayName(),
.output_file = std.Build.GeneratedFile{ .step = &self.step },
.format = options.format,
.only_section = options.only_section,
.pad_to = options.pad_to,
};
- file_source.addStepDependencies(&self.step);
+ input_file.addStepDependencies(&self.step);
return self;
}
-pub fn getOutputSource(self: *const ObjCopy) std.Build.FileSource {
+/// deprecated: use getOutput
+pub const getOutputSource = getOutput;
+
+pub fn getOutput(self: *const ObjCopy) std.Build.LazyPath {
return .{ .generated = &self.output_file };
}
@@ -75,7 +78,7 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
// bytes when ObjCopy implementation is modified incompatibly.
man.hash.add(@as(u32, 0xe18b7baf));
- const full_src_path = self.file_source.getPath(b);
+ const full_src_path = self.input_file.getPath(b);
_ = try man.addFile(full_src_path, null);
man.hash.addOptionalBytes(self.only_section);
man.hash.addOptional(self.pad_to);
diff --git a/lib/std/Build/Step/Options.zig b/lib/std/Build/Step/Options.zig
index 52821a595108a2aa8b7cd2eb11c4fc77b12ea163..575ee747d15ea99e3d639c0ae90abaf1ec9721f2 100644
--- a/lib/std/Build/Step/Options.zig
+++ b/lib/std/Build/Step/Options.zig
@@ -3,7 +3,7 @@ const builtin = @import("builtin");
const fs = std.fs;
const Step = std.Build.Step;
const GeneratedFile = std.Build.GeneratedFile;
-const FileSource = std.Build.FileSource;
+const LazyPath = std.Build.LazyPath;
const Options = @This();
@@ -13,8 +13,7 @@ step: Step,
generated_file: GeneratedFile,
contents: std.ArrayList(u8),
-artifact_args: std.ArrayList(OptionArtifactArg),
-file_source_args: std.ArrayList(OptionFileSourceArg),
+args: std.ArrayList(Arg),
pub fn create(owner: *std.Build) *Options {
const self = owner.allocator.create(Options) catch @panic("OOM");
@@ -27,8 +26,7 @@ pub fn create(owner: *std.Build) *Options {
}),
.generated_file = undefined,
.contents = std.ArrayList(u8).init(owner.allocator),
- .artifact_args = std.ArrayList(OptionArtifactArg).init(owner.allocator),
- .file_source_args = std.ArrayList(OptionFileSourceArg).init(owner.allocator),
+ .args = std.ArrayList(Arg).init(owner.allocator),
};
self.generated_file = .{ .step = &self.step };
@@ -168,35 +166,39 @@ fn printLiteral(out: anytype, val: anytype, indent: u8) !void {
}
}
+/// deprecated: use `addOptionPath`
+pub const addOptionFileSource = addOptionPath;
+
/// The value is the path in the cache dir.
/// Adds a dependency automatically.
-pub fn addOptionFileSource(
+pub fn addOptionPath(
self: *Options,
name: []const u8,
- source: FileSource,
+ path: LazyPath,
) void {
- self.file_source_args.append(.{
- .name = name,
- .source = source.dupe(self.step.owner),
+ self.args.append(.{
+ .name = self.step.owner.dupe(name),
+ .path = path.dupe(self.step.owner),
}) catch @panic("OOM");
- source.addStepDependencies(&self.step);
+ path.addStepDependencies(&self.step);
}
-/// The value is the path in the cache dir.
-/// Adds a dependency automatically.
+/// Deprecated: use `addOptionPath(options, name, artifact.getEmittedBin())` instead.
pub fn addOptionArtifact(self: *Options, name: []const u8, artifact: *Step.Compile) void {
- self.artifact_args.append(.{ .name = self.step.owner.dupe(name), .artifact = artifact }) catch @panic("OOM");
- self.step.dependOn(&artifact.step);
+ return addOptionPath(self, name, artifact.getEmittedBin());
}
pub fn createModule(self: *Options) *std.Build.Module {
return self.step.owner.createModule(.{
- .source_file = self.getSource(),
+ .source_file = self.getOutput(),
.dependencies = &.{},
});
}
-pub fn getSource(self: *Options) FileSource {
+/// deprecated: use `getOutput`
+pub const getSource = getOutput;
+
+pub fn getOutput(self: *Options) LazyPath {
return .{ .generated = &self.generated_file };
}
@@ -207,19 +209,11 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
const b = step.owner;
const self = @fieldParentPtr(Options, "step", step);
- for (self.artifact_args.items) |item| {
+ for (self.args.items) |item| {
self.addOption(
[]const u8,
item.name,
- b.pathFromRoot(item.artifact.getOutputSource().getPath(b)),
- );
- }
-
- for (self.file_source_args.items) |item| {
- self.addOption(
- []const u8,
- item.name,
- item.source.getPath(b),
+ item.path.getPath(b),
);
}
@@ -229,7 +223,7 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
var hash = b.cache.hash;
// Random bytes to make unique. Refresh this with new random bytes when
// implementation is modified in a non-backwards-compatible way.
- hash.add(@as(u32, 0x38845ef8));
+ hash.add(@as(u32, 0xad95e922));
hash.addBytes(self.contents.items);
const sub_path = "c" ++ fs.path.sep_str ++ hash.final() ++ fs.path.sep_str ++ basename;
@@ -294,14 +288,9 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
}
}
-const OptionArtifactArg = struct {
+const Arg = struct {
name: []const u8,
- artifact: *Step.Compile,
-};
-
-const OptionFileSourceArg = struct {
- name: []const u8,
- source: FileSource,
+ path: LazyPath,
};
test Options {
diff --git a/lib/std/Build/Step/Run.zig b/lib/std/Build/Step/Run.zig
index 076a6e0352a72a74fc4294216a9a2b87434fb628..4bb474f4da543ef87a05ed76937dc81c789d6660 100644
--- a/lib/std/Build/Step/Run.zig
+++ b/lib/std/Build/Step/Run.zig
@@ -82,7 +82,7 @@ has_side_effects: bool = false,
pub const StdIn = union(enum) {
none,
bytes: []const u8,
- file_source: std.Build.FileSource,
+ lazy_path: std.Build.LazyPath,
};
pub const StdIo = union(enum) {
@@ -120,15 +120,15 @@ pub const StdIo = union(enum) {
pub const Arg = union(enum) {
artifact: *Step.Compile,
- file_source: PrefixedFileSource,
- directory_source: PrefixedFileSource,
+ lazy_path: PrefixedLazyPath,
+ directory_source: PrefixedLazyPath,
bytes: []u8,
output: *Output,
};
-pub const PrefixedFileSource = struct {
+pub const PrefixedLazyPath = struct {
prefix: []const u8,
- file_source: std.Build.FileSource,
+ lazy_path: std.Build.LazyPath,
};
pub const Output = struct {
@@ -164,14 +164,15 @@ pub fn enableTestRunnerMode(self: *Run) void {
}
pub fn addArtifactArg(self: *Run, artifact: *Step.Compile) void {
+ const bin_file = artifact.getEmittedBin();
+ bin_file.addStepDependencies(&self.step);
self.argv.append(Arg{ .artifact = artifact }) catch @panic("OOM");
- self.step.dependOn(&artifact.step);
}
/// This provides file path as a command line argument to the command being
-/// run, and returns a FileSource which can be used as inputs to other APIs
+/// run, and returns a LazyPath which can be used as inputs to other APIs
/// throughout the build system.
-pub fn addOutputFileArg(self: *Run, basename: []const u8) std.Build.FileSource {
+pub fn addOutputFileArg(self: *Run, basename: []const u8) std.Build.LazyPath {
return self.addPrefixedOutputFileArg("", basename);
}
@@ -179,7 +180,7 @@ pub fn addPrefixedOutputFileArg(
self: *Run,
prefix: []const u8,
basename: []const u8,
-) std.Build.FileSource {
+) std.Build.LazyPath {
const b = self.step.owner;
const output = b.allocator.create(Output) catch @panic("OOM");
@@ -197,31 +198,43 @@ pub fn addPrefixedOutputFileArg(
return .{ .generated = &output.generated_file };
}
-pub fn addFileSourceArg(self: *Run, file_source: std.Build.FileSource) void {
- self.addPrefixedFileSourceArg("", file_source);
+/// deprecated: use `addFileArg`
+pub const addFileSourceArg = addFileArg;
+
+pub fn addFileArg(self: *Run, lp: std.Build.LazyPath) void {
+ self.addPrefixedFileArg("", lp);
}
-pub fn addPrefixedFileSourceArg(self: *Run, prefix: []const u8, file_source: std.Build.FileSource) void {
+// deprecated: use `addPrefixedFileArg`
+pub const addPrefixedFileSourceArg = addPrefixedFileArg;
+
+pub fn addPrefixedFileArg(self: *Run, prefix: []const u8, lp: std.Build.LazyPath) void {
const b = self.step.owner;
- const prefixed_file_source: PrefixedFileSource = .{
+ const prefixed_file_source: PrefixedLazyPath = .{
.prefix = b.dupe(prefix),
- .file_source = file_source.dupe(b),
+ .lazy_path = lp.dupe(b),
};
- self.argv.append(.{ .file_source = prefixed_file_source }) catch @panic("OOM");
- file_source.addStepDependencies(&self.step);
+ self.argv.append(.{ .lazy_path = prefixed_file_source }) catch @panic("OOM");
+ lp.addStepDependencies(&self.step);
}
-pub fn addDirectorySourceArg(self: *Run, directory_source: std.Build.FileSource) void {
- self.addPrefixedDirectorySourceArg("", directory_source);
+/// deprecated: use `addDirectoryArg`
+pub const addDirectorySourceArg = addDirectoryArg;
+
+pub fn addDirectoryArg(self: *Run, directory_source: std.Build.LazyPath) void {
+ self.addPrefixedDirectoryArg("", directory_source);
}
-pub fn addPrefixedDirectorySourceArg(self: *Run, prefix: []const u8, directory_source: std.Build.FileSource) void {
+// deprecated: use `addPrefixedDirectoryArg`
+pub const addPrefixedDirectorySourceArg = addPrefixedDirectoryArg;
+
+pub fn addPrefixedDirectoryArg(self: *Run, prefix: []const u8, directory_source: std.Build.LazyPath) void {
const b = self.step.owner;
- const prefixed_directory_source: PrefixedFileSource = .{
+ const prefixed_directory_source: PrefixedLazyPath = .{
.prefix = b.dupe(prefix),
- .file_source = directory_source.dupe(b),
+ .lazy_path = directory_source.dupe(b),
};
self.argv.append(.{ .directory_source = prefixed_directory_source }) catch @panic("OOM");
directory_source.addStepDependencies(&self.step);
@@ -239,7 +252,7 @@ pub fn addArgs(self: *Run, args: []const []const u8) void {
pub fn setStdIn(self: *Run, stdin: StdIn) void {
switch (stdin) {
- .file_source => |file_source| file_source.addStepDependencies(&self.step),
+ .lazy_path => |lazy_path| lazy_path.addStepDependencies(&self.step),
.bytes, .none => {},
}
self.stdin = stdin;
@@ -331,7 +344,7 @@ pub fn addCheck(self: *Run, new_check: StdIo.Check) void {
}
}
-pub fn captureStdErr(self: *Run) std.Build.FileSource {
+pub fn captureStdErr(self: *Run) std.Build.LazyPath {
assert(self.stdio != .inherit);
if (self.captured_stderr) |output| return .{ .generated = &output.generated_file };
@@ -346,7 +359,7 @@ pub fn captureStdErr(self: *Run) std.Build.FileSource {
return .{ .generated = &output.generated_file };
}
-pub fn captureStdOut(self: *Run) std.Build.FileSource {
+pub fn captureStdOut(self: *Run) std.Build.LazyPath {
assert(self.stdio != .inherit);
if (self.captured_stdout) |output| return .{ .generated = &output.generated_file };
@@ -431,14 +444,14 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
try argv_list.append(bytes);
man.hash.addBytes(bytes);
},
- .file_source => |file| {
- const file_path = file.file_source.getPath(b);
+ .lazy_path => |file| {
+ const file_path = file.lazy_path.getPath(b);
try argv_list.append(b.fmt("{s}{s}", .{ file.prefix, file_path }));
man.hash.addBytes(file.prefix);
_ = try man.addFile(file_path, null);
},
.directory_source => |file| {
- const file_path = file.file_source.getPath(b);
+ const file_path = file.lazy_path.getPath(b);
try argv_list.append(b.fmt("{s}{s}", .{ file.prefix, file_path }));
man.hash.addBytes(file.prefix);
man.hash.addBytes(file_path);
@@ -448,8 +461,7 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
// On Windows we don't have rpaths so we have to add .dll search paths to PATH
self.addPathForDynLibs(artifact);
}
- const file_path = artifact.installed_path orelse
- artifact.getOutputSource().getPath(b);
+ const file_path = artifact.installed_path orelse artifact.generated_bin.?.path.?; // the path is guaranteed to be set
try argv_list.append(file_path);
@@ -474,8 +486,8 @@ fn make(step: *Step, prog_node: *std.Progress.Node) !void {
.bytes => |bytes| {
man.hash.addBytes(bytes);
},
- .file_source => |file_source| {
- const file_path = file_source.getPath(b);
+ .lazy_path => |lazy_path| {
+ const file_path = lazy_path.getPath(b);
_ = try man.addFile(file_path, null);
},
.none => {},
@@ -1174,8 +1186,8 @@ fn evalGeneric(self: *Run, child: *std.process.Child) !StdIoResult {
child.stdin.?.close();
child.stdin = null;
},
- .file_source => |file_source| {
- const path = file_source.getPath(self.step.owner);
+ .lazy_path => |lazy_path| {
+ const path = lazy_path.getPath(self.step.owner);
const file = self.step.owner.build_root.handle.openFile(path, .{}) catch |err| {
return self.step.fail("unable to open stdin file: {s}", .{@errorName(err)});
};
@@ -1241,7 +1253,7 @@ fn addPathForDynLibs(self: *Run, artifact: *Step.Compile) void {
switch (link_object) {
.other_step => |other| {
if (other.target.isWindows() and other.isDynamicLibrary()) {
- addPathDir(self, fs.path.dirname(other.getOutputSource().getPath(b)).?);
+ addPathDir(self, fs.path.dirname(other.getEmittedBin().getPath(b)).?);
addPathForDynLibs(self, other);
}
},
diff --git a/lib/std/Build/Step/TranslateC.zig b/lib/std/Build/Step/TranslateC.zig
index cfbabc2fa95836764a50923d66f4d0c288306914..c491b3c7ce4f5e167e026ff855ead57f3e673508 100644
--- a/lib/std/Build/Step/TranslateC.zig
+++ b/lib/std/Build/Step/TranslateC.zig
@@ -9,7 +9,7 @@ const TranslateC = @This();
pub const base_id = .translate_c;
step: Step,
-source: std.Build.FileSource,
+source: std.Build.LazyPath,
include_dirs: std.ArrayList([]const u8),
c_macros: std.ArrayList([]const u8),
out_basename: []const u8,
@@ -18,7 +18,7 @@ optimize: std.builtin.OptimizeMode,
output_file: std.Build.GeneratedFile,
pub const Options = struct {
- source_file: std.Build.FileSource,
+ source_file: std.Build.LazyPath,
target: CrossTarget,
optimize: std.builtin.OptimizeMode,
};
@@ -53,10 +53,14 @@ pub const AddExecutableOptions = struct {
linkage: ?Step.Compile.Linkage = null,
};
+pub fn getOutput(self: *TranslateC) std.Build.LazyPath {
+ return .{ .generated = &self.output_file };
+}
+
/// Creates a step to build an executable from the translated source.
pub fn addExecutable(self: *TranslateC, options: AddExecutableOptions) *Step.Compile {
return self.step.owner.addExecutable(.{
- .root_source_file = .{ .generated = &self.output_file },
+ .root_source_file = self.getOutput(),
.name = options.name orelse "translated_c",
.version = options.version,
.target = options.target orelse self.target,
@@ -70,7 +74,7 @@ pub fn addExecutable(self: *TranslateC, options: AddExecutableOptions) *Step.Com
/// `createModule` can be used instead to create a private module.
pub fn addModule(self: *TranslateC, name: []const u8) *std.Build.Module {
return self.step.owner.addModule(name, .{
- .source_file = .{ .generated = &self.output_file },
+ .source_file = self.getOutput(),
});
}
@@ -83,7 +87,7 @@ pub fn createModule(self: *TranslateC) *std.Build.Module {
module.* = .{
.builder = b,
- .source_file = .{ .generated = &self.output_file },
+ .source_file = self.getOutput(),
.dependencies = std.StringArrayHashMap(*std.Build.Module).init(b.allocator),
};
return module;
@@ -96,7 +100,7 @@ pub fn addIncludeDir(self: *TranslateC, include_dir: []const u8) void {
pub fn addCheckFile(self: *TranslateC, expected_matches: []const []const u8) *Step.CheckFile {
return Step.CheckFile.create(
self.step.owner,
- .{ .generated = &self.output_file },
+ self.getOutput(),
.{ .expected_matches = expected_matches },
);
}
diff --git a/lib/std/Build/Step/WriteFile.zig b/lib/std/Build/Step/WriteFile.zig
index 0448aa8d2a118a33028934584143458fe8b407a3..51db4bb3c391f2680e23d71d0374e05f9afb4986 100644
--- a/lib/std/Build/Step/WriteFile.zig
+++ b/lib/std/Build/Step/WriteFile.zig
@@ -28,7 +28,10 @@ pub const File = struct {
sub_path: []const u8,
contents: Contents,
- pub fn getFileSource(self: *File) std.Build.FileSource {
+ /// deprecated: use `getPath`
+ pub const getFileSource = getPath;
+
+ pub fn getPath(self: *File) std.Build.LazyPath {
return .{ .generated = &self.generated_file };
}
};
@@ -40,7 +43,7 @@ pub const OutputSourceFile = struct {
pub const Contents = union(enum) {
bytes: []const u8,
- copy: std.Build.FileSource,
+ copy: std.Build.LazyPath,
};
pub fn create(owner: *std.Build) *WriteFile {
@@ -59,7 +62,7 @@ pub fn create(owner: *std.Build) *WriteFile {
return wf;
}
-pub fn add(wf: *WriteFile, sub_path: []const u8, bytes: []const u8) std.Build.FileSource {
+pub fn add(wf: *WriteFile, sub_path: []const u8, bytes: []const u8) std.Build.LazyPath {
const b = wf.step.owner;
const gpa = b.allocator;
const file = gpa.create(File) catch @panic("OOM");
@@ -70,7 +73,7 @@ pub fn add(wf: *WriteFile, sub_path: []const u8, bytes: []const u8) std.Build.Fi
};
wf.files.append(gpa, file) catch @panic("OOM");
wf.maybeUpdateName();
- return file.getFileSource();
+ return file.getPath();
}
/// Place the file into the generated directory within the local cache,
@@ -80,7 +83,7 @@ pub fn add(wf: *WriteFile, sub_path: []const u8, bytes: []const u8) std.Build.Fi
/// include sub-directories, in which case this step will ensure the
/// required sub-path exists.
/// This is the option expected to be used most commonly with `addCopyFile`.
-pub fn addCopyFile(wf: *WriteFile, source: std.Build.FileSource, sub_path: []const u8) std.Build.FileSource {
+pub fn addCopyFile(wf: *WriteFile, source: std.Build.LazyPath, sub_path: []const u8) std.Build.LazyPath {
const b = wf.step.owner;
const gpa = b.allocator;
const file = gpa.create(File) catch @panic("OOM");
@@ -93,7 +96,7 @@ pub fn addCopyFile(wf: *WriteFile, source: std.Build.FileSource, sub_path: []con
wf.maybeUpdateName();
source.addStepDependencies(&wf.step);
- return file.getFileSource();
+ return file.getLazyPath();
}
/// A path relative to the package root.
@@ -101,7 +104,7 @@ pub fn addCopyFile(wf: *WriteFile, source: std.Build.FileSource, sub_path: []con
/// used as part of the normal build process, but as a utility occasionally
/// run by a developer with intent to modify source files and then commit
/// those changes to version control.
-pub fn addCopyFileToSource(wf: *WriteFile, source: std.Build.FileSource, sub_path: []const u8) void {
+pub fn addCopyFileToSource(wf: *WriteFile, source: std.Build.LazyPath, sub_path: []const u8) void {
const b = wf.step.owner;
wf.output_source_files.append(b.allocator, .{
.contents = .{ .copy = source },
@@ -123,11 +126,13 @@ pub fn addBytesToSource(wf: *WriteFile, bytes: []const u8, sub_path: []const u8)
}) catch @panic("OOM");
}
-pub const getFileSource = @compileError("Deprecated; use the return value from add()/addCopyFile(), or use files[i].getFileSource()");
+pub const getFileSource = @compileError("Deprecated; use the return value from add()/addCopyFile(), or use files[i].getPath()");
-/// Returns a `FileSource` representing the base directory that contains all the
+pub const getDirectorySource = getDirectory;
+
+/// Returns a `LazyPath` representing the base directory that contains all the
/// files from this `WriteFile`.
-pub fn getDirectorySource(wf: *WriteFile) std.Build.FileSource {
+pub fn getDirectory(wf: *WriteFile) std.Build.LazyPath {
return .{ .generated = &wf.generated_directory };
}
diff --git a/src/link.zig b/src/link.zig
index 703dfb87394be3ae5a3af36966dbce8d1e53e46d..42322cbda88221d8af195b6eb310201c5e82825f 100644
--- a/src/link.zig
+++ b/src/link.zig
@@ -966,6 +966,8 @@ pub const File = struct {
}
pub fn linkAsArchive(base: *File, comp: *Compilation, prog_node: *std.Progress.Node) FlushError!void {
+ const emit = base.options.emit orelse return;
+
const tracy = trace(@src());
defer tracy.end();
@@ -973,8 +975,8 @@ pub const File = struct {
defer arena_allocator.deinit();
const arena = arena_allocator.allocator();
- const directory = base.options.emit.?.directory; // Just an alias to make it shorter to type.
- const full_out_path = try directory.join(arena, &[_][]const u8{base.options.emit.?.sub_path});
+ const directory = emit.directory; // Just an alias to make it shorter to type.
+ const full_out_path = try directory.join(arena, &[_][]const u8{emit.sub_path});
const full_out_path_z = try arena.dupeZ(u8, full_out_path);
// If there is no Zig code to compile, then we should skip flushing the output file
diff --git a/src/link/Coff.zig b/src/link/Coff.zig
index 8720fc1037b3cd1ca1595d2dd6179e3cc89135cc..f1b914c3681921c010fa2f00436df230c7b6811b 100644
--- a/src/link/Coff.zig
+++ b/src/link/Coff.zig
@@ -1452,6 +1452,8 @@ pub fn updateDeclExports(
if (self.llvm_object) |llvm_object| return llvm_object.updateDeclExports(mod, decl_index, exports);
}
+ if (self.base.options.emit == null) return;
+
const gpa = self.base.allocator;
const decl = mod.declPtr(decl_index);
diff --git a/src/link/Elf.zig b/src/link/Elf.zig
index 4bb049e0740323dc1c84cd046e2760499e2065d2..ec4da9c728e2c2acbb5bacb09ff36bf63df44688 100644
--- a/src/link/Elf.zig
+++ b/src/link/Elf.zig
@@ -2865,6 +2865,8 @@ pub fn updateDeclExports(
if (self.llvm_object) |llvm_object| return llvm_object.updateDeclExports(mod, decl_index, exports);
}
+ if (self.base.options.emit == null) return;
+
const tracy = trace(@src());
defer tracy.end();
diff --git a/src/link/MachO.zig b/src/link/MachO.zig
index d124a1f51c4bbba99dbb7e671bd36dc1c24b8306..44e6acc3976d5abfa4c8405001db1ea53fe64cf8 100644
--- a/src/link/MachO.zig
+++ b/src/link/MachO.zig
@@ -2386,6 +2386,8 @@ pub fn updateDeclExports(
return llvm_object.updateDeclExports(mod, decl_index, exports);
}
+ if (self.base.options.emit == null) return;
+
const tracy = trace(@src());
defer tracy.end();
diff --git a/src/link/NvPtx.zig b/src/link/NvPtx.zig
index fc3d659770cf9791911221933f2f231091e826b4..fd1504a3d3e6bbfb2218889cc58acff10c0032c4 100644
--- a/src/link/NvPtx.zig
+++ b/src/link/NvPtx.zig
@@ -106,10 +106,11 @@ pub fn flushModule(self: *NvPtx, comp: *Compilation, prog_node: *std.Progress.No
if (build_options.skip_non_native) {
@panic("Attempted to compile for architecture that was disabled by build configuration");
}
+ const outfile = comp.bin_file.options.emit orelse return;
+
const tracy = trace(@src());
defer tracy.end();
- const outfile = comp.bin_file.options.emit.?;
// We modify 'comp' before passing it to LLVM, but restore value afterwards.
// We tell LLVM to not try to build a .o, only an "assembly" file.
// This is required by the LLVM PTX backend.
diff --git a/src/link/Wasm.zig b/src/link/Wasm.zig
index c2a2de398f9bb6ca5d2e0ae30d382d21a8cc7bc7..11294daa8430fe14aebd247adf998b193f38a750 100644
--- a/src/link/Wasm.zig
+++ b/src/link/Wasm.zig
@@ -1712,6 +1712,8 @@ pub fn updateDeclExports(
if (wasm.llvm_object) |llvm_object| return llvm_object.updateDeclExports(mod, decl_index, exports);
}
+ if (wasm.base.options.emit == null) return;
+
const decl = mod.declPtr(decl_index);
const atom_index = try wasm.getOrCreateAtomForDecl(decl_index);
const atom = wasm.getAtom(atom_index);
diff --git a/test/link/glibc_compat/build.zig b/test/link/glibc_compat/build.zig
index 8d850cf350ccf59d4d22482b067b697a752b60ab..a104633fd76478353fc4d4a2fb4bbd33b588076b 100644
--- a/test/link/glibc_compat/build.zig
+++ b/test/link/glibc_compat/build.zig
@@ -4,7 +4,7 @@ pub fn build(b: *std.Build) void {
const test_step = b.step("test", "Test");
b.default_step = test_step;
- inline for (.{ "aarch64-linux-gnu.2.27", "aarch64-linux-gnu.2.34" }) |t| {
+ for ([_][]const u8{ "aarch64-linux-gnu.2.27", "aarch64-linux-gnu.2.34" }) |t| {
const exe = b.addExecutable(.{
.name = t,
.root_source_file = .{ .path = "main.c" },
@@ -13,6 +13,8 @@ pub fn build(b: *std.Build) void {
) catch unreachable,
});
exe.linkLibC();
+ // TODO: actually test the output
+ _ = exe.getEmittedBin();
test_step.dependOn(&exe.step);
}
}
diff --git a/test/link/interdependent_static_c_libs/build.zig b/test/link/interdependent_static_c_libs/build.zig
index 2eb8fa27b4e74e0acea7e97ecf731f4f8ec3c30f..757c0d419b6364ed3cf7f5d3a89a0ac657ca5a9a 100644
--- a/test/link/interdependent_static_c_libs/build.zig
+++ b/test/link/interdependent_static_c_libs/build.zig
@@ -16,16 +16,16 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = .{},
});
- lib_a.addCSourceFile("a.c", &[_][]const u8{});
- lib_a.addIncludePath(".");
+ lib_a.addCSourceFile(.{ .file = .{ .path = "a.c" }, .flags = &[_][]const u8{} });
+ lib_a.addIncludePath(.{ .path = "." });
const lib_b = b.addStaticLibrary(.{
.name = "b",
.optimize = optimize,
.target = .{},
});
- lib_b.addCSourceFile("b.c", &[_][]const u8{});
- lib_b.addIncludePath(".");
+ lib_b.addCSourceFile(.{ .file = .{ .path = "b.c" }, .flags = &[_][]const u8{} });
+ lib_b.addIncludePath(.{ .path = "." });
const test_exe = b.addTest(.{
.root_source_file = .{ .path = "main.zig" },
@@ -33,7 +33,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
});
test_exe.linkLibrary(lib_a);
test_exe.linkLibrary(lib_b);
- test_exe.addIncludePath(".");
+ test_exe.addIncludePath(.{ .path = "." });
test_step.dependOn(&b.addRunArtifact(test_exe).step);
}
diff --git a/test/link/macho/bugs/13056/build.zig b/test/link/macho/bugs/13056/build.zig
index 1ac50a61c62d4fe7dad24fc3e8f6e30c09f8263b..eade752bc46ac8b67c2a2ecec4e15aea9b948978 100644
--- a/test/link/macho/bugs/13056/build.zig
+++ b/test/link/macho/bugs/13056/build.zig
@@ -23,13 +23,13 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.name = "test",
.optimize = optimize,
});
- exe.addSystemIncludePath(std.fs.path.join(b.allocator, &.{ sdk.path, "/usr/include" }) catch unreachable);
- exe.addIncludePath(std.fs.path.join(b.allocator, &.{ sdk.path, "/usr/include/c++/v1" }) catch unreachable);
- exe.addCSourceFile("test.cpp", &.{
+ exe.addSystemIncludePath(.{ .path = b.pathJoin(&.{ sdk.path, "/usr/include" }) });
+ exe.addIncludePath(.{ .path = b.pathJoin(&.{ sdk.path, "/usr/include/c++/v1" }) });
+ exe.addCSourceFile(.{ .file = .{ .path = "test.cpp" }, .flags = &.{
"-nostdlib++",
"-nostdinc++",
- });
- exe.addObjectFile(std.fs.path.join(b.allocator, &.{ sdk.path, "/usr/lib/libc++.tbd" }) catch unreachable);
+ } });
+ exe.addObjectFile(.{ .path = b.pathJoin(&.{ sdk.path, "/usr/lib/libc++.tbd" }) });
const run_cmd = b.addRunArtifact(exe);
run_cmd.expectStdErrEqual("x: 5\n");
diff --git a/test/link/macho/dead_strip/build.zig b/test/link/macho/dead_strip/build.zig
index 8dd75b70194f197a7aec597cbf74d6eb4fa3d04a..8b8449b6b214d58ab3f7b5015e39188324348aeb 100644
--- a/test/link/macho/dead_strip/build.zig
+++ b/test/link/macho/dead_strip/build.zig
@@ -52,7 +52,7 @@ fn createScenario(
.optimize = optimize,
.target = target,
});
- exe.addCSourceFile("main.c", &[0][]const u8{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &[0][]const u8{} });
exe.linkLibC();
return exe;
}
diff --git a/test/link/macho/dead_strip_dylibs/build.zig b/test/link/macho/dead_strip_dylibs/build.zig
index 4767a7cf34a7a580d98486a9ffe433fdfda02fb4..cf243b523156dc05cede7badcbd8de046cf2878e 100644
--- a/test/link/macho/dead_strip_dylibs/build.zig
+++ b/test/link/macho/dead_strip_dylibs/build.zig
@@ -53,7 +53,7 @@ fn createScenario(
.name = name,
.optimize = optimize,
});
- exe.addCSourceFile("main.c", &[0][]const u8{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &[0][]const u8{} });
exe.linkLibC();
exe.linkFramework("Cocoa");
return exe;
diff --git a/test/link/macho/dylib/build.zig b/test/link/macho/dylib/build.zig
index de693625d03d84891827c0b72572c776505577d6..b05e4f5677b33e6a762b964c69a99c38253f9c99 100644
--- a/test/link/macho/dylib/build.zig
+++ b/test/link/macho/dylib/build.zig
@@ -21,7 +21,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = target,
});
- dylib.addCSourceFile("a.c", &.{});
+ dylib.addCSourceFile(.{ .file = .{ .path = "a.c" }, .flags = &.{} });
dylib.linkLibC();
const check_dylib = dylib.checkObject();
@@ -39,10 +39,10 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = target,
});
- exe.addCSourceFile("main.c", &.{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &.{} });
exe.linkSystemLibrary("a");
- exe.addLibraryPathDirectorySource(dylib.getOutputDirectorySource());
- exe.addRPathDirectorySource(dylib.getOutputDirectorySource());
+ exe.addLibraryPath(dylib.getEmittedBinDirectory());
+ exe.addRPath(dylib.getEmittedBinDirectory());
exe.linkLibC();
const check_exe = exe.checkObject();
@@ -55,7 +55,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
check_exe.checkStart();
check_exe.checkExact("cmd RPATH");
- check_exe.checkExactFileSource("path", dylib.getOutputDirectorySource());
+ check_exe.checkExactPath("path", dylib.getOutputDirectorySource());
test_step.dependOn(&check_exe.step);
const run = b.addRunArtifact(exe);
diff --git a/test/link/macho/empty/build.zig b/test/link/macho/empty/build.zig
index 9933746d533ac556f570aecd304fc06559a67a02..6a1350770271cc47a70af3da9636d2f680e857cf 100644
--- a/test/link/macho/empty/build.zig
+++ b/test/link/macho/empty/build.zig
@@ -20,8 +20,8 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = target,
});
- exe.addCSourceFile("main.c", &[0][]const u8{});
- exe.addCSourceFile("empty.c", &[0][]const u8{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &[0][]const u8{} });
+ exe.addCSourceFile(.{ .file = .{ .path = "empty.c" }, .flags = &[0][]const u8{} });
exe.linkLibC();
const run_cmd = b.addRunArtifact(exe);
diff --git a/test/link/macho/entry/build.zig b/test/link/macho/entry/build.zig
index a5269ff6abf5e140a3279c4a4a0f5c870188a0fa..fcba02cd9a8832b03a1c2f5dadfe0261aa46b2b4 100644
--- a/test/link/macho/entry/build.zig
+++ b/test/link/macho/entry/build.zig
@@ -18,7 +18,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = .{ .os_tag = .macos },
});
- exe.addCSourceFile("main.c", &.{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &.{} });
exe.linkLibC();
exe.entry_symbol_name = "_non_main";
diff --git a/test/link/macho/entry_in_archive/build.zig b/test/link/macho/entry_in_archive/build.zig
index f4b04bd162aa07b30dd568bc1dfcb7d1e7a69d77..f48e612d95d4072cb5caa035f909217ca305ec94 100644
--- a/test/link/macho/entry_in_archive/build.zig
+++ b/test/link/macho/entry_in_archive/build.zig
@@ -18,7 +18,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = .{ .os_tag = .macos },
});
- lib.addCSourceFile("main.c", &.{});
+ lib.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &.{} });
lib.linkLibC();
const exe = b.addExecutable(.{
diff --git a/test/link/macho/entry_in_dylib/build.zig b/test/link/macho/entry_in_dylib/build.zig
index a5deaa73fecb12729d4e04454556c5816832aab5..97ffa917b451488b6fe083cca3b6a994b9ce71b7 100644
--- a/test/link/macho/entry_in_dylib/build.zig
+++ b/test/link/macho/entry_in_dylib/build.zig
@@ -18,7 +18,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = .{ .os_tag = .macos },
});
- lib.addCSourceFile("bootstrap.c", &.{});
+ lib.addCSourceFile(.{ .file = .{ .path = "bootstrap.c" }, .flags = &.{} });
lib.linkLibC();
lib.linker_allow_shlib_undefined = true;
@@ -27,7 +27,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = .{ .os_tag = .macos },
});
- exe.addCSourceFile("main.c", &.{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &.{} });
exe.linkLibrary(lib);
exe.linkLibC();
exe.entry_symbol_name = "_bootstrap";
diff --git a/test/link/macho/headerpad/build.zig b/test/link/macho/headerpad/build.zig
index 2c1146f2497a6475384f96efcce9c75926739979..e1aebb0a8f2c540ba0255a17b1943cf50c880487 100644
--- a/test/link/macho/headerpad/build.zig
+++ b/test/link/macho/headerpad/build.zig
@@ -113,7 +113,7 @@ fn simpleExe(
.name = name,
.optimize = optimize,
});
- exe.addCSourceFile("main.c", &.{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &.{} });
exe.linkLibC();
exe.linkFramework("CoreFoundation");
exe.linkFramework("Foundation");
diff --git a/test/link/macho/needed_framework/build.zig b/test/link/macho/needed_framework/build.zig
index 2323f277e6f91205646a5a99a6ab1c2a042286bd..f189ef7578de6b2c7bf9b333b7cde8f6d710cfb2 100644
--- a/test/link/macho/needed_framework/build.zig
+++ b/test/link/macho/needed_framework/build.zig
@@ -20,7 +20,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.name = "test",
.optimize = optimize,
});
- exe.addCSourceFile("main.c", &[0][]const u8{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &[0][]const u8{} });
exe.linkLibC();
exe.linkFrameworkNeeded("Cocoa");
exe.dead_strip_dylibs = true;
diff --git a/test/link/macho/needed_library/build.zig b/test/link/macho/needed_library/build.zig
index 26c69ea81500aaaddece78d0e22a92ba0dc230bd..de5d6b1ae6e3c6f945d0b219997935168398358f 100644
--- a/test/link/macho/needed_library/build.zig
+++ b/test/link/macho/needed_library/build.zig
@@ -21,7 +21,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = target,
});
- dylib.addCSourceFile("a.c", &.{});
+ dylib.addCSourceFile(.{ .file = .{ .path = "a.c" }, .flags = &.{} });
dylib.linkLibC();
// -dead_strip_dylibs
@@ -31,11 +31,11 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = target,
});
- exe.addCSourceFile("main.c", &[0][]const u8{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &[0][]const u8{} });
exe.linkLibC();
exe.linkSystemLibraryNeeded("a");
- exe.addLibraryPathDirectorySource(dylib.getOutputDirectorySource());
- exe.addRPathDirectorySource(dylib.getOutputDirectorySource());
+ exe.addLibraryPath(dylib.getEmittedBinDirectory());
+ exe.addRPath(dylib.getEmittedBinDirectory());
exe.dead_strip_dylibs = true;
const check = exe.checkObject();
diff --git a/test/link/macho/objc/build.zig b/test/link/macho/objc/build.zig
index 4cd12f786fe1ef1c0005270769c23c8dc1c88c5c..979c0aa943276b6c26dd64c018cdeb4b4b2e858e 100644
--- a/test/link/macho/objc/build.zig
+++ b/test/link/macho/objc/build.zig
@@ -18,9 +18,9 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.name = "test",
.optimize = optimize,
});
- exe.addIncludePath(".");
- exe.addCSourceFile("Foo.m", &[0][]const u8{});
- exe.addCSourceFile("test.m", &[0][]const u8{});
+ exe.addIncludePath(.{ .path = "." });
+ exe.addCSourceFile(.{ .file = .{ .path = "Foo.m" }, .flags = &[0][]const u8{} });
+ exe.addCSourceFile(.{ .file = .{ .path = "test.m" }, .flags = &[0][]const u8{} });
exe.linkLibC();
// TODO when we figure out how to ship framework stubs for cross-compilation,
// populate paths to the sysroot here.
diff --git a/test/link/macho/objcpp/build.zig b/test/link/macho/objcpp/build.zig
index aebf0e17fd93d0844583c0366be627ca77d012b4..183d3cb9d3ef8d4138ed5b9f2834303b5064fac0 100644
--- a/test/link/macho/objcpp/build.zig
+++ b/test/link/macho/objcpp/build.zig
@@ -19,9 +19,9 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
});
b.default_step.dependOn(&exe.step);
- exe.addIncludePath(".");
- exe.addCSourceFile("Foo.mm", &[0][]const u8{});
- exe.addCSourceFile("test.mm", &[0][]const u8{});
+ exe.addIncludePath(.{ .path = "." });
+ exe.addCSourceFile(.{ .file = .{ .path = "Foo.mm" }, .flags = &[0][]const u8{} });
+ exe.addCSourceFile(.{ .file = .{ .path = "test.mm" }, .flags = &[0][]const u8{} });
exe.linkLibCpp();
// TODO when we figure out how to ship framework stubs for cross-compilation,
// populate paths to the sysroot here.
diff --git a/test/link/macho/pagezero/build.zig b/test/link/macho/pagezero/build.zig
index f7b13e171ebc6f84b4dcf0100a3522ccd95f495a..5a071384644862e1bc8a064cb4e986affb3ed8e4 100644
--- a/test/link/macho/pagezero/build.zig
+++ b/test/link/macho/pagezero/build.zig
@@ -15,7 +15,7 @@ pub fn build(b: *std.Build) void {
.optimize = optimize,
.target = target,
});
- exe.addCSourceFile("main.c", &.{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &.{} });
exe.linkLibC();
exe.pagezero_size = 0x4000;
@@ -39,7 +39,7 @@ pub fn build(b: *std.Build) void {
.optimize = optimize,
.target = target,
});
- exe.addCSourceFile("main.c", &.{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &.{} });
exe.linkLibC();
exe.pagezero_size = 0;
diff --git a/test/link/macho/search_strategy/build.zig b/test/link/macho/search_strategy/build.zig
index df0cab9d5df7e3581f10ee4bdfa4480e205773cc..574782617b188bd279d290ab80937b23b69862a5 100644
--- a/test/link/macho/search_strategy/build.zig
+++ b/test/link/macho/search_strategy/build.zig
@@ -55,11 +55,8 @@ fn createScenario(
.optimize = optimize,
.target = target,
});
- static.addCSourceFile("a.c", &.{});
+ static.addCSourceFile(.{ .file = .{ .path = "a.c" }, .flags = &.{} });
static.linkLibC();
- static.override_dest_dir = std.Build.InstallDir{
- .custom = "static",
- };
const dylib = b.addSharedLibrary(.{
.name = name,
@@ -67,22 +64,19 @@ fn createScenario(
.optimize = optimize,
.target = target,
});
- dylib.addCSourceFile("a.c", &.{});
+ dylib.addCSourceFile(.{ .file = .{ .path = "a.c" }, .flags = &.{} });
dylib.linkLibC();
- dylib.override_dest_dir = std.Build.InstallDir{
- .custom = "dynamic",
- };
const exe = b.addExecutable(.{
.name = name,
.optimize = optimize,
.target = target,
});
- exe.addCSourceFile("main.c", &.{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &.{} });
exe.linkSystemLibraryName(name);
exe.linkLibC();
- exe.addLibraryPathDirectorySource(static.getOutputDirectorySource());
- exe.addLibraryPathDirectorySource(dylib.getOutputDirectorySource());
- exe.addRPathDirectorySource(dylib.getOutputDirectorySource());
+ exe.addLibraryPath(static.getEmittedBinDirectory());
+ exe.addLibraryPath(dylib.getEmittedBinDirectory());
+ exe.addRPath(dylib.getEmittedBinDirectory());
return exe;
}
diff --git a/test/link/macho/stack_size/build.zig b/test/link/macho/stack_size/build.zig
index d7ea44b626b0659603be4e20103c9f37dfad4841..4210d9802d00e2a61ccd7b8b581eb7eb828662bd 100644
--- a/test/link/macho/stack_size/build.zig
+++ b/test/link/macho/stack_size/build.zig
@@ -20,7 +20,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = target,
});
- exe.addCSourceFile("main.c", &.{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &.{} });
exe.linkLibC();
exe.stack_size = 0x100000000;
diff --git a/test/link/macho/tbdv3/build.zig b/test/link/macho/tbdv3/build.zig
index c2eb6df626cc2de0c0e28b557675925e26f22b60..ba11004f29b9e9af07efd552ea587f2778dde360 100644
--- a/test/link/macho/tbdv3/build.zig
+++ b/test/link/macho/tbdv3/build.zig
@@ -23,7 +23,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = target,
});
- lib.addCSourceFile("a.c", &.{});
+ lib.addCSourceFile(.{ .file = .{ .path = "a.c" }, .flags = &.{} });
lib.linkLibC();
const tbd_file = b.addWriteFile("liba.tbd",
@@ -43,10 +43,10 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = target,
});
- exe.addCSourceFile("main.c", &[0][]const u8{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &[0][]const u8{} });
exe.linkSystemLibrary("a");
- exe.addLibraryPathDirectorySource(tbd_file.getDirectorySource());
- exe.addRPathDirectorySource(lib.getOutputDirectorySource());
+ exe.addLibraryPath(tbd_file.getDirectory());
+ exe.addRPath(lib.getEmittedBinDirectory());
exe.linkLibC();
const run = b.addRunArtifact(exe);
diff --git a/test/link/macho/tls/build.zig b/test/link/macho/tls/build.zig
index 555fe207c55e7ef8fd5eb129566c8c626aa6ee72..443f698ea6beb13800c708e8ff40159457599de5 100644
--- a/test/link/macho/tls/build.zig
+++ b/test/link/macho/tls/build.zig
@@ -21,7 +21,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = target,
});
- lib.addCSourceFile("a.c", &.{});
+ lib.addCSourceFile(.{ .file = .{ .path = "a.c" }, .flags = &.{} });
lib.linkLibC();
const test_exe = b.addTest(.{
diff --git a/test/link/macho/unwind_info/build.zig b/test/link/macho/unwind_info/build.zig
index c3b9d1ea4f176bcc0ddfa5d220802f9b62d5e7ae..ead71b15d23036c791b23349a75505bcb532e47c 100644
--- a/test/link/macho/unwind_info/build.zig
+++ b/test/link/macho/unwind_info/build.zig
@@ -75,7 +75,7 @@ fn createScenario(
.target = target,
});
b.default_step.dependOn(&exe.step);
- exe.addIncludePath(".");
+ exe.addIncludePath(.{ .path = "." });
exe.addCSourceFiles(&[_][]const u8{
"main.cpp",
"simple_string.cpp",
diff --git a/test/link/macho/weak_framework/build.zig b/test/link/macho/weak_framework/build.zig
index 8069d62bd388d144a2efd545663cf16d32b4a0a3..8a71584b254cab18d209bdbc37605288b33bf5ba 100644
--- a/test/link/macho/weak_framework/build.zig
+++ b/test/link/macho/weak_framework/build.zig
@@ -18,7 +18,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.name = "test",
.optimize = optimize,
});
- exe.addCSourceFile("main.c", &[0][]const u8{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &[0][]const u8{} });
exe.linkLibC();
exe.linkFrameworkWeak("Cocoa");
diff --git a/test/link/macho/weak_library/build.zig b/test/link/macho/weak_library/build.zig
index 831a96e88042ea4d0c8dd0647058511acb603fb8..f66316693e99a8aed3b455e78834d5f666884f4c 100644
--- a/test/link/macho/weak_library/build.zig
+++ b/test/link/macho/weak_library/build.zig
@@ -21,7 +21,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.target = target,
.optimize = optimize,
});
- dylib.addCSourceFile("a.c", &.{});
+ dylib.addCSourceFile(.{ .file = .{ .path = "a.c" }, .flags = &.{} });
dylib.linkLibC();
b.installArtifact(dylib);
@@ -30,11 +30,11 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.target = target,
.optimize = optimize,
});
- exe.addCSourceFile("main.c", &[0][]const u8{});
+ exe.addCSourceFile(.{ .file = .{ .path = "main.c" }, .flags = &[0][]const u8{} });
exe.linkLibC();
exe.linkSystemLibraryWeak("a");
- exe.addLibraryPathDirectorySource(dylib.getOutputDirectorySource());
- exe.addRPathDirectorySource(dylib.getOutputDirectorySource());
+ exe.addLibraryPath(dylib.getEmittedBinDirectory());
+ exe.addRPath(dylib.getEmittedBinDirectory());
const check = exe.checkObject();
check.checkStart();
diff --git a/test/link/static_libs_from_object_files/build.zig b/test/link/static_libs_from_object_files/build.zig
index 13365ba15334560c08deb2d18c134c0bcfe73af7..e5a4b79acd8f47bf88556690754902a07ce3ff06 100644
--- a/test/link/static_libs_from_object_files/build.zig
+++ b/test/link/static_libs_from_object_files/build.zig
@@ -2,7 +2,7 @@ const std = @import("std");
const builtin = @import("builtin");
const Build = std.Build;
-const FileSource = Build.FileSource;
+const LazyPath = Build.LazyPath;
const Step = Build.Step;
const Run = Step.Run;
const WriteFile = Step.WriteFile;
@@ -14,7 +14,7 @@ pub fn build(b: *Build) void {
b.default_step = test_step;
// generate c files
- const files = b.allocator.alloc(std.Build.FileSource, nb_files) catch unreachable;
+ const files = b.allocator.alloc(LazyPath, nb_files) catch unreachable;
defer b.allocator.free(files);
{
for (files[0 .. nb_files - 1], 1..nb_files) |*file, i| {
@@ -47,7 +47,7 @@ pub fn build(b: *Build) void {
add(b, test_step, files, .ReleaseFast);
}
-fn add(b: *Build, test_step: *Step, files: []const std.Build.FileSource, optimize: std.builtin.OptimizeMode) void {
+fn add(b: *Build, test_step: *Step, files: []const LazyPath, optimize: std.builtin.OptimizeMode) void {
const flags = [_][]const u8{
"-Wall",
"-std=c11",
@@ -63,7 +63,7 @@ fn add(b: *Build, test_step: *Step, files: []const std.Build.FileSource, optimiz
});
for (files) |file| {
- exe.addCSourceFileSource(.{ .source = file, .args = &flags });
+ exe.addCSourceFile(.{ .file = file, .flags = &flags });
}
const run_cmd = b.addRunArtifact(exe);
@@ -88,7 +88,7 @@ fn add(b: *Build, test_step: *Step, files: []const std.Build.FileSource, optimiz
for (files, 1..) |file, i| {
const lib = if (i & 1 == 0) lib_a else lib_b;
- lib.addCSourceFileSource(.{ .source = file, .args = &flags });
+ lib.addCSourceFile(.{ .file = file, .flags = &flags });
}
const exe = b.addExecutable(.{
@@ -125,7 +125,7 @@ fn add(b: *Build, test_step: *Step, files: []const std.Build.FileSource, optimiz
.target = .{},
.optimize = optimize,
});
- obj.addCSourceFileSource(.{ .source = file, .args = &flags });
+ obj.addCSourceFile(.{ .file = file, .flags = &flags });
const lib = if (i & 1 == 0) lib_a else lib_b;
lib.addObject(obj);
diff --git a/test/link/wasm/extern/build.zig b/test/link/wasm/extern/build.zig
index 55562143c2f0023b8a94af69cc184f00b9d076d7..a505899520421601f1ddaa2c5aba23d3f4b36b89 100644
--- a/test/link/wasm/extern/build.zig
+++ b/test/link/wasm/extern/build.zig
@@ -19,7 +19,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = .{ .cpu_arch = .wasm32, .os_tag = .wasi },
});
- exe.addCSourceFile("foo.c", &.{});
+ exe.addCSourceFile(.{ .file = .{ .path = "foo.c" }, .flags = &.{} });
exe.use_llvm = false;
exe.use_lld = false;
diff --git a/test/link/wasm/infer-features/build.zig b/test/link/wasm/infer-features/build.zig
index 35ab68abf67ef00708d61c647357cf7685e76b4e..6264edfba912c64e2ad5c365ae366e64a63d130a 100644
--- a/test/link/wasm/infer-features/build.zig
+++ b/test/link/wasm/infer-features/build.zig
@@ -13,7 +13,7 @@ pub fn build(b: *std.Build) void {
.os_tag = .freestanding,
},
});
- c_obj.addCSourceFile("foo.c", &.{});
+ c_obj.addCSourceFile(.{ .file = .{ .path = "foo.c" }, .flags = &.{} });
// Wasm library that doesn't have any features specified. This will
// infer its featureset from other linked object files.
diff --git a/test/src/Cases.zig b/test/src/Cases.zig
index ce080b5490f85fce2570f4e7e0a7b5301d315f5a..08aadaf0d42a4fff637057f424a8c737d18bf4a4 100644
--- a/test/src/Cases.zig
+++ b/test/src/Cases.zig
@@ -518,12 +518,12 @@ pub fn lowerToBuildSteps(
}
const writefiles = b.addWriteFiles();
- var file_sources = std.StringHashMap(std.Build.FileSource).init(b.allocator);
+ var file_sources = std.StringHashMap(std.Build.LazyPath).init(b.allocator);
defer file_sources.deinit();
for (update.files.items) |file| {
file_sources.put(file.path, writefiles.add(file.path, file.src)) catch @panic("OOM");
}
- const root_source_file = writefiles.files.items[0].getFileSource();
+ const root_source_file = writefiles.files.items[0].getPath();
const artifact = if (case.is_test) b.addTest(.{
.root_source_file = root_source_file,
@@ -551,8 +551,6 @@ pub fn lowerToBuildSteps(
}),
};
- artifact.emit_bin = if (case.emit_bin) .default else .no_emit;
-
if (case.link_libc) artifact.linkLibC();
switch (case.backend) {
@@ -577,7 +575,7 @@ pub fn lowerToBuildSteps(
parent_step.dependOn(&artifact.step);
},
.CompareObjectFile => |expected_output| {
- const check = b.addCheckFile(artifact.getOutputSource(), .{
+ const check = b.addCheckFile(artifact.getEmittedBin(), .{
.expected_exact = expected_output,
});
diff --git a/test/src/CompareOutput.zig b/test/src/CompareOutput.zig
index d2f7a23089860d8784999c8521bb0945ce2701fc..39226f03692912ec26db8469c3cc6bd2db950afb 100644
--- a/test/src/CompareOutput.zig
+++ b/test/src/CompareOutput.zig
@@ -99,7 +99,7 @@ pub fn addCase(self: *CompareOutput, case: TestCase) void {
.target = .{},
.optimize = .Debug,
});
- exe.addAssemblyFileSource(write_src.files.items[0].getFileSource());
+ exe.addAssemblyFile(write_src.files.items[0].getPath());
const run = b.addRunArtifact(exe);
run.setName(annotated_case_name);
@@ -119,7 +119,7 @@ pub fn addCase(self: *CompareOutput, case: TestCase) void {
const exe = b.addExecutable(.{
.name = "test",
- .root_source_file = write_src.files.items[0].getFileSource(),
+ .root_source_file = write_src.files.items[0].getPath(),
.optimize = optimize,
.target = .{},
});
@@ -145,7 +145,7 @@ pub fn addCase(self: *CompareOutput, case: TestCase) void {
const exe = b.addExecutable(.{
.name = "test",
- .root_source_file = write_src.files.items[0].getFileSource(),
+ .root_source_file = write_src.files.items[0].getPath(),
.target = .{},
.optimize = .Debug,
});
diff --git a/test/src/StackTrace.zig b/test/src/StackTrace.zig
index 71394e00b8ec9a08beb2d32f1e0cd95cd3a16c49..c42e9114be8c383e45c7657694adb90b24a641d3 100644
--- a/test/src/StackTrace.zig
+++ b/test/src/StackTrace.zig
@@ -75,7 +75,7 @@ fn addExpect(
const write_src = b.addWriteFile("source.zig", source);
const exe = b.addExecutable(.{
.name = "test",
- .root_source_file = write_src.files.items[0].getFileSource(),
+ .root_source_file = write_src.files.items[0].getPath(),
.optimize = optimize_mode,
.target = .{},
});
@@ -88,7 +88,7 @@ fn addExpect(
const check_run = b.addRunArtifact(self.check_exe);
check_run.setName(annotated_case_name);
- check_run.addFileSourceArg(run.captureStdErr());
+ check_run.addFileArg(run.captureStdErr());
check_run.addArgs(&.{
@tagName(optimize_mode),
});
diff --git a/test/src/run_translated_c.zig b/test/src/run_translated_c.zig
index 42db8b19c5614ad9725b14002c47972b43032340..cd2d0d9e3b16449d924107442106727a5686a554 100644
--- a/test/src/run_translated_c.zig
+++ b/test/src/run_translated_c.zig
@@ -85,7 +85,7 @@ pub const RunTranslatedCContext = struct {
_ = write_src.add(src_file.filename, src_file.source);
}
const translate_c = b.addTranslateC(.{
- .source_file = write_src.files.items[0].getFileSource(),
+ .source_file = write_src.files.items[0].getPath(),
.target = .{},
.optimize = .Debug,
});
diff --git a/test/src/translate_c.zig b/test/src/translate_c.zig
index a1f312d623a73280c7b66398f8d4ca607e4915d1..a71886099f7a6bac0b98f1199c2a21d71c230964 100644
--- a/test/src/translate_c.zig
+++ b/test/src/translate_c.zig
@@ -108,7 +108,7 @@ pub const TranslateCContext = struct {
}
const translate_c = b.addTranslateC(.{
- .source_file = write_src.files.items[0].getFileSource(),
+ .source_file = write_src.files.items[0].getPath(),
.target = case.target,
.optimize = .Debug,
});
diff --git a/test/standalone/c_compiler/build.zig b/test/standalone/c_compiler/build.zig
index 6c5f2b4db6b94fcdfafbd85d4b897ccf1e29b419..36622dde185ae173dacdf7ddc1bcfc475ff6d9bb 100644
--- a/test/standalone/c_compiler/build.zig
+++ b/test/standalone/c_compiler/build.zig
@@ -19,7 +19,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.optimize = optimize,
.target = target,
});
- exe_c.addCSourceFile("test.c", &[0][]const u8{});
+ exe_c.addCSourceFile(.{ .file = .{ .path = "test.c" }, .flags = &[0][]const u8{} });
exe_c.linkLibC();
const exe_cpp = b.addExecutable(.{
@@ -28,7 +28,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.target = target,
});
b.default_step.dependOn(&exe_cpp.step);
- exe_cpp.addCSourceFile("test.cpp", &[0][]const u8{});
+ exe_cpp.addCSourceFile(.{ .file = .{ .path = "test.cpp" }, .flags = &[0][]const u8{} });
exe_cpp.linkLibCpp();
switch (target.getOsTag()) {
diff --git a/test/standalone/coff_dwarf/build.zig b/test/standalone/coff_dwarf/build.zig
index ffd7800a5b6cddbf3800a01888d2aa8d951887a2..b85b44b686cbedbffff958ca4994d97563360107 100644
--- a/test/standalone/coff_dwarf/build.zig
+++ b/test/standalone/coff_dwarf/build.zig
@@ -23,7 +23,7 @@ pub fn build(b: *std.Build) void {
.optimize = optimize,
.target = target,
});
- lib.addCSourceFile("shared_lib.c", &.{"-gdwarf"});
+ lib.addCSourceFile(.{ .file = .{ .path = "shared_lib.c" }, .flags = &.{"-gdwarf"} });
lib.linkLibC();
exe.linkLibrary(lib);
diff --git a/test/standalone/compiler_rt_panic/build.zig b/test/standalone/compiler_rt_panic/build.zig
index c10771872db15edc2dd2a00c9daf444400208e43..3d22319bacf512edf330486cd2f9ac4fb707f305 100644
--- a/test/standalone/compiler_rt_panic/build.zig
+++ b/test/standalone/compiler_rt_panic/build.zig
@@ -16,7 +16,10 @@ pub fn build(b: *std.Build) void {
.target = target,
});
exe.linkLibC();
- exe.addCSourceFile("main.c", &.{});
+ exe.addCSourceFile(.{
+ .file = .{ .path = "main.c" },
+ .flags = &.{},
+ });
exe.link_gc_sections = false;
exe.bundle_compiler_rt = true;
diff --git a/test/standalone/embed_generated_file/build.zig b/test/standalone/embed_generated_file/build.zig
index af1ae0a00f70ede3d2d4a88a1aa06316afbd86af..ca05c33c39a65bdefd093668e947de5651bd801d 100644
--- a/test/standalone/embed_generated_file/build.zig
+++ b/test/standalone/embed_generated_file/build.zig
@@ -19,8 +19,11 @@ pub fn build(b: *std.Build) void {
.optimize = .Debug,
});
exe.addAnonymousModule("bootloader.elf", .{
- .source_file = bootloader.getOutputSource(),
+ .source_file = bootloader.getEmittedBin(),
});
+ // TODO: actually check the output
+ _ = exe.getEmittedBin();
+
test_step.dependOn(&exe.step);
}
diff --git a/test/standalone/emit_asm_and_bin/build.zig b/test/standalone/emit_asm_and_bin/build.zig
index 1a608b40a925f7ee1d5fc300aabab7202e0088e4..2f671bb6cce51608971cd8fb1230b27186980cc8 100644
--- a/test/standalone/emit_asm_and_bin/build.zig
+++ b/test/standalone/emit_asm_and_bin/build.zig
@@ -8,8 +8,9 @@ pub fn build(b: *std.Build) void {
.root_source_file = .{ .path = "main.zig" },
.optimize = b.standardOptimizeOption(.{}),
});
- main.emit_asm = .{ .emit_to = b.pathFromRoot("main.s") };
- main.emit_bin = .{ .emit_to = b.pathFromRoot("main") };
+ // TODO: actually check these two artifacts for correctness
+ _ = main.getEmittedBin();
+ _ = main.getEmittedAsm();
test_step.dependOn(&b.addRunArtifact(main).step);
}
diff --git a/test/standalone/issue_12588/build.zig b/test/standalone/issue_12588/build.zig
index fa22252fcc83e27bccfeb796ef7e0c4a2ec8f0d1..e6d01192d3cf0f8c6bbb3495b6302dd29b7305f3 100644
--- a/test/standalone/issue_12588/build.zig
+++ b/test/standalone/issue_12588/build.zig
@@ -13,9 +13,8 @@ pub fn build(b: *std.Build) void {
.optimize = optimize,
.target = target,
});
- obj.emit_llvm_ir = .{ .emit_to = b.pathFromRoot("main.ll") };
- obj.emit_llvm_bc = .{ .emit_to = b.pathFromRoot("main.bc") };
- obj.emit_bin = .no_emit;
+ _ = obj.getEmittedLlvmIr();
+ _ = obj.getEmittedLlvmBc();
b.default_step.dependOn(&obj.step);
test_step.dependOn(&obj.step);
diff --git a/test/standalone/issue_339/build.zig b/test/standalone/issue_339/build.zig
index f4215dbb8bc267e2757a090716e3fd5b4bcbf574..d53ba992ea3ed052c563d5f6c1623e3a33798cd0 100644
--- a/test/standalone/issue_339/build.zig
+++ b/test/standalone/issue_339/build.zig
@@ -14,5 +14,8 @@ pub fn build(b: *std.Build) void {
.optimize = optimize,
});
+ // TODO: actually check the output
+ _ = obj.getEmittedBin();
+
test_step.dependOn(&obj.step);
}
diff --git a/test/standalone/issue_5825/build.zig b/test/standalone/issue_5825/build.zig
index e8e8d487723084ea8b3fb7365cd80f00ac9f3c12..9a790f6bb92740e350ebc29fdec8244dbe0eada8 100644
--- a/test/standalone/issue_5825/build.zig
+++ b/test/standalone/issue_5825/build.zig
@@ -27,5 +27,8 @@ pub fn build(b: *std.Build) void {
exe.linkSystemLibrary("ntdll");
exe.addObject(obj);
+ // TODO: actually check the output
+ _ = exe.getEmittedBin();
+
test_step.dependOn(&exe.step);
}
diff --git a/test/standalone/issue_794/build.zig b/test/standalone/issue_794/build.zig
index 8527f4af2c77ab3a45491c214179c510801f5a52..eb05aa9b4fd5829ad6a84aefbb7f7bf85a6b03d5 100644
--- a/test/standalone/issue_794/build.zig
+++ b/test/standalone/issue_794/build.zig
@@ -7,7 +7,10 @@ pub fn build(b: *std.Build) void {
const test_artifact = b.addTest(.{
.root_source_file = .{ .path = "main.zig" },
});
- test_artifact.addIncludePath("a_directory");
+ test_artifact.addIncludePath(.{ .path = "a_directory" });
+
+ // TODO: actually check the output
+ _ = test_artifact.getEmittedBin();
test_step.dependOn(&test_artifact.step);
}
diff --git a/test/standalone/issue_8550/build.zig b/test/standalone/issue_8550/build.zig
index 32bb3e10eb892a0844542c2e388e0b5d267550e8..a7815618744b9ca914e44dbc6588cf422405df9b 100644
--- a/test/standalone/issue_8550/build.zig
+++ b/test/standalone/issue_8550/build.zig
@@ -19,8 +19,8 @@ pub fn build(b: *std.Build) !void {
.optimize = optimize,
.target = target,
});
- kernel.addObjectFile("./boot.S");
- kernel.setLinkerScriptPath(.{ .path = "./linker.ld" });
+ kernel.addObjectFile(.{ .path = "./boot.S" });
+ kernel.setLinkerScript(.{ .path = "./linker.ld" });
b.installArtifact(kernel);
test_step.dependOn(&kernel.step);
diff --git a/test/standalone/main_pkg_path/build.zig b/test/standalone/main_pkg_path/build.zig
index f3eacce767b8418b300b6034f60c5574ff9e0a49..d1b67592b5b05c4ab9d9aa6bf1c0ddbc36015705 100644
--- a/test/standalone/main_pkg_path/build.zig
+++ b/test/standalone/main_pkg_path/build.zig
@@ -6,8 +6,8 @@ pub fn build(b: *std.Build) void {
const test_exe = b.addTest(.{
.root_source_file = .{ .path = "a/test.zig" },
+ .main_pkg_path = .{ .path = "." },
});
- test_exe.setMainPkgPath(".");
test_step.dependOn(&b.addRunArtifact(test_exe).step);
}
diff --git a/test/standalone/mix_c_files/build.zig b/test/standalone/mix_c_files/build.zig
index 39a0da27ad4c4748f2217be41746c245f1c1839a..b675be9eebe4b6b461d0f0ccabeb0cc2991570d0 100644
--- a/test/standalone/mix_c_files/build.zig
+++ b/test/standalone/mix_c_files/build.zig
@@ -21,7 +21,7 @@ fn add(b: *std.Build, test_step: *std.Build.Step, optimize: std.builtin.Optimize
.root_source_file = .{ .path = "main.zig" },
.optimize = optimize,
});
- exe.addCSourceFile("test.c", &[_][]const u8{"-std=c11"});
+ exe.addCSourceFile(.{ .file = .{ .path = "test.c" }, .flags = &[_][]const u8{"-std=c11"} });
exe.linkLibC();
const run_cmd = b.addRunArtifact(exe);
diff --git a/test/standalone/mix_o_files/build.zig b/test/standalone/mix_o_files/build.zig
index 2d9323ff00def954b4a50679e17b74494dac0be1..980e52ad3baa8b86829eefa0ce8c86e9986e6cec 100644
--- a/test/standalone/mix_o_files/build.zig
+++ b/test/standalone/mix_o_files/build.zig
@@ -19,7 +19,10 @@ pub fn build(b: *std.Build) void {
.optimize = optimize,
.target = target,
});
- exe.addCSourceFile("test.c", &[_][]const u8{"-std=c99"});
+ exe.addCSourceFile(.{
+ .file = .{ .path = "test.c" },
+ .flags = &[_][]const u8{"-std=c99"},
+ });
exe.addObject(obj);
exe.linkSystemLibrary("c");
diff --git a/test/standalone/shared_library/build.zig b/test/standalone/shared_library/build.zig
index 3034d8901783871d1a9b398f304f0c86847e5e35..3c1f95cf43ea56e46e1c39ba4541ea65cec9f398 100644
--- a/test/standalone/shared_library/build.zig
+++ b/test/standalone/shared_library/build.zig
@@ -19,7 +19,10 @@ pub fn build(b: *std.Build) void {
.target = target,
.optimize = optimize,
});
- exe.addCSourceFile("test.c", &[_][]const u8{"-std=c99"});
+ exe.addCSourceFile(.{
+ .file = .{ .path = "test.c" },
+ .flags = &[_][]const u8{"-std=c99"},
+ });
exe.linkLibrary(lib);
exe.linkSystemLibrary("c");
diff --git a/test/standalone/stack_iterator/build.zig b/test/standalone/stack_iterator/build.zig
index 1c5a9673cecac54b8453333101044140a74ee7f8..628210452c428a7e750a6a638663d78854facf18 100644
--- a/test/standalone/stack_iterator/build.zig
+++ b/test/standalone/stack_iterator/build.zig
@@ -74,7 +74,10 @@ pub fn build(b: *std.Build) void {
if (target.isWindows()) c_shared_lib.defineCMacro("LIB_API", "__declspec(dllexport)");
c_shared_lib.strip = false;
- c_shared_lib.addCSourceFile("shared_lib.c", &.{"-fomit-frame-pointer"});
+ c_shared_lib.addCSourceFile(.{
+ .file = .{ .path = "shared_lib.c" },
+ .flags = &.{"-fomit-frame-pointer"},
+ });
c_shared_lib.linkLibC();
const exe = b.addExecutable(.{
diff --git a/test/standalone/static_c_lib/build.zig b/test/standalone/static_c_lib/build.zig
index 3feae705fcdba9ec0d870bef9bcc028a86ff3920..1e3e80c36323fdce2b05cacd1fe2fda7108b7d7a 100644
--- a/test/standalone/static_c_lib/build.zig
+++ b/test/standalone/static_c_lib/build.zig
@@ -11,15 +11,15 @@ pub fn build(b: *std.Build) void {
.optimize = optimize,
.target = .{},
});
- foo.addCSourceFile("foo.c", &[_][]const u8{});
- foo.addIncludePath(".");
+ foo.addCSourceFile(.{ .file = .{ .path = "foo.c" }, .flags = &[_][]const u8{} });
+ foo.addIncludePath(.{ .path = "." });
const test_exe = b.addTest(.{
.root_source_file = .{ .path = "foo.zig" },
.optimize = optimize,
});
test_exe.linkLibrary(foo);
- test_exe.addIncludePath(".");
+ test_exe.addIncludePath(.{ .path = "." });
test_step.dependOn(&b.addRunArtifact(test_exe).step);
}
diff --git a/test/standalone/strip_empty_loop/build.zig b/test/standalone/strip_empty_loop/build.zig
index 73c70d6616279d708090452f3d55410c03e5648c..e64781d9914255a937a5c9ad3c51c263376a3f64 100644
--- a/test/standalone/strip_empty_loop/build.zig
+++ b/test/standalone/strip_empty_loop/build.zig
@@ -14,5 +14,9 @@ pub fn build(b: *std.Build) void {
.target = target,
});
main.strip = true;
+
+ // TODO: actually check the output
+ _ = main.getEmittedBin();
+
test_step.dependOn(&main.step);
}
diff --git a/test/standalone/use_alias/build.zig b/test/standalone/use_alias/build.zig
index 6fa0a1f3a5b649857e2a356be1d958c3f738a8bf..0511cd3935fcaaaa4c5fe603b7d7faad4ec7522c 100644
--- a/test/standalone/use_alias/build.zig
+++ b/test/standalone/use_alias/build.zig
@@ -10,7 +10,7 @@ pub fn build(b: *std.Build) void {
.root_source_file = .{ .path = "main.zig" },
.optimize = optimize,
});
- main.addIncludePath(".");
+ main.addIncludePath(.{ .path = "." });
test_step.dependOn(&b.addRunArtifact(main).step);
}
diff --git a/test/tests.zig b/test/tests.zig
index bba1b00142d139eb52958fbfc478d59e255982da..d42344cb883aad8bee36db8999d37b4e8cfa5db7 100644
--- a/test/tests.zig
+++ b/test/tests.zig
@@ -588,6 +588,8 @@ pub fn addStandaloneTests(
});
if (case.link_libc) exe.linkLibC();
+ _ = exe.getEmittedBin();
+
step.dependOn(&exe.step);
}
@@ -759,7 +761,7 @@ pub fn addCliTests(b: *std.Build) *Step {
"-fno-emit-bin", "-fno-emit-h",
"-fstrip", "-OReleaseFast",
});
- run.addFileSourceArg(writefile.files.items[0].getFileSource());
+ run.addFileArg(writefile.files.items[0].getPath());
const example_s = run.addPrefixedOutputFileArg("-femit-asm=", "example.s");
const checkfile = b.addCheckFile(example_s, .{
@@ -1006,6 +1008,7 @@ pub fn addModuleTests(b: *std.Build, options: ModuleTestOptions) *Step {
.single_threaded = test_target.single_threaded,
.use_llvm = test_target.use_llvm,
.use_lld = test_target.use_lld,
+ .zig_lib_dir = .{ .path = "lib" },
});
const single_threaded_suffix = if (test_target.single_threaded == true) "-single" else "";
const backend_suffix = if (test_target.use_llvm == true)
@@ -1017,8 +1020,7 @@ pub fn addModuleTests(b: *std.Build, options: ModuleTestOptions) *Step {
else
"";
- these_tests.overrideZigLibDir("lib");
- these_tests.addIncludePath("test");
+ these_tests.addIncludePath(.{ .path = "test" });
const qualified_name = b.fmt("{s}-{s}-{s}{s}{s}{s}", .{
options.name,
@@ -1037,11 +1039,11 @@ pub fn addModuleTests(b: *std.Build, options: ModuleTestOptions) *Step {
.name = qualified_name,
.link_libc = test_target.link_libc,
.target = altered_target,
+ .zig_lib_dir = .{ .path = "lib" },
});
- compile_c.overrideZigLibDir("lib");
- compile_c.addCSourceFileSource(.{
- .source = these_tests.getOutputSource(),
- .args = &.{
+ compile_c.addCSourceFile(.{
+ .file = these_tests.getEmittedBin(),
+ .flags = &.{
// TODO output -std=c89 compatible C code
"-std=c99",
"-pedantic",
@@ -1058,7 +1060,7 @@ pub fn addModuleTests(b: *std.Build, options: ModuleTestOptions) *Step {
"-Wno-absolute-value",
},
});
- compile_c.addIncludePath("lib"); // for zig.h
+ compile_c.addIncludePath(.{ .path = "lib" }); // for zig.h
if (test_target.target.getOsTag() == .windows) {
if (true) {
// Unfortunately this requires about 8G of RAM for clang to compile
@@ -1131,7 +1133,10 @@ pub fn addCAbiTests(b: *std.Build, skip_non_native: bool, skip_release: bool) *S
test_step.target_info.dynamic_linker.max_byte = null;
}
test_step.linkLibC();
- test_step.addCSourceFile("test/c_abi/cfuncs.c", &.{"-std=c99"});
+ test_step.addCSourceFile(.{
+ .file = .{ .path = "test/c_abi/cfuncs.c" },
+ .flags = &.{"-std=c99"},
+ });
// This test is intentionally trying to check if the external ABI is
// done properly. LTO would be a hindrance to this.
diff --git a/tools/docgen.zig b/tools/docgen.zig
new file mode 100644
index 0000000000000000000000000000000000000000..589a14818231c4810e4942fb56b966d08a8d29cb
--- /dev/null
+++ b/tools/docgen.zig
@@ -0,0 +1,2278 @@
+const std = @import("std");
+const builtin = @import("builtin");
+const io = std.io;
+const fs = std.fs;
+const process = std.process;
+const ChildProcess = std.ChildProcess;
+const Progress = std.Progress;
+const print = std.debug.print;
+const mem = std.mem;
+const testing = std.testing;
+const Allocator = std.mem.Allocator;
+
+const max_doc_file_size = 10 * 1024 * 1024;
+
+const exe_ext = @as(std.zig.CrossTarget, .{}).exeFileExt();
+const obj_ext = builtin.object_format.fileExt(builtin.cpu.arch);
+const tmp_dir_name = "docgen_tmp";
+const test_out_path = tmp_dir_name ++ fs.path.sep_str ++ "test" ++ exe_ext;
+
+const usage =
+ \\Usage: docgen [--zig] [--skip-code-tests] input output"
+ \\
+ \\ Generates an HTML document from a docgen template.
+ \\
+ \\Options:
+ \\ -h, --help Print this help and exit
+ \\ --skip-code-tests Skip the doctests
+ \\
+;
+
+fn fatal(comptime format: []const u8, args: anytype) noreturn {
+ const stderr = io.getStdErr().writer();
+
+ stderr.print("error: " ++ format ++ "\n", args) catch {};
+ process.exit(1);
+}
+
+pub fn main() !void {
+ var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
+ defer arena.deinit();
+
+ const allocator = arena.allocator();
+
+ var args_it = try process.argsWithAllocator(allocator);
+ if (!args_it.skip()) @panic("expected self arg");
+
+ var zig_exe: []const u8 = "zig";
+ var opt_zig_lib_dir: ?[]const u8 = null;
+ var do_code_tests = true;
+ var files = [_][]const u8{ "", "" };
+
+ var i: usize = 0;
+ while (args_it.next()) |arg| {
+ if (mem.startsWith(u8, arg, "-")) {
+ if (mem.eql(u8, arg, "-h") or mem.eql(u8, arg, "--help")) {
+ const stdout = io.getStdOut().writer();
+ try stdout.writeAll(usage);
+ process.exit(0);
+ } else if (mem.eql(u8, arg, "--zig")) {
+ if (args_it.next()) |param| {
+ zig_exe = param;
+ } else {
+ fatal("expected parameter after --zig", .{});
+ }
+ } else if (mem.eql(u8, arg, "--zig-lib-dir")) {
+ if (args_it.next()) |param| {
+ // Convert relative to absolute because this will be passed
+ // to a child process with a different cwd.
+ opt_zig_lib_dir = try fs.realpathAlloc(allocator, param);
+ } else {
+ fatal("expected parameter after --zig-lib-dir", .{});
+ }
+ } else if (mem.eql(u8, arg, "--skip-code-tests")) {
+ do_code_tests = false;
+ } else {
+ fatal("unrecognized option: '{s}'", .{arg});
+ }
+ } else {
+ if (i > 1) {
+ fatal("too many arguments", .{});
+ }
+ files[i] = arg;
+ i += 1;
+ }
+ }
+ if (i < 2) {
+ fatal("not enough arguments", .{});
+ }
+
+ var in_file = try fs.cwd().openFile(files[0], .{ .mode = .read_only });
+ defer in_file.close();
+
+ var out_file = try fs.cwd().createFile(files[1], .{});
+ defer out_file.close();
+
+ const input_file_bytes = try in_file.reader().readAllAlloc(allocator, max_doc_file_size);
+
+ var buffered_writer = io.bufferedWriter(out_file.writer());
+
+ var tokenizer = Tokenizer.init(files[0], input_file_bytes);
+ var toc = try genToc(allocator, &tokenizer);
+
+ try fs.cwd().makePath(tmp_dir_name);
+ defer fs.cwd().deleteTree(tmp_dir_name) catch {};
+
+ try genHtml(allocator, &tokenizer, &toc, buffered_writer.writer(), zig_exe, opt_zig_lib_dir, do_code_tests);
+ try buffered_writer.flush();
+}
+
+const Token = struct {
+ id: Id,
+ start: usize,
+ end: usize,
+
+ const Id = enum {
+ invalid,
+ content,
+ bracket_open,
+ tag_content,
+ separator,
+ bracket_close,
+ eof,
+ };
+};
+
+const Tokenizer = struct {
+ buffer: []const u8,
+ index: usize,
+ state: State,
+ source_file_name: []const u8,
+ code_node_count: usize,
+
+ const State = enum {
+ start,
+ l_bracket,
+ hash,
+ tag_name,
+ eof,
+ };
+
+ fn init(source_file_name: []const u8, buffer: []const u8) Tokenizer {
+ return Tokenizer{
+ .buffer = buffer,
+ .index = 0,
+ .state = .start,
+ .source_file_name = source_file_name,
+ .code_node_count = 0,
+ };
+ }
+
+ fn next(self: *Tokenizer) Token {
+ var result = Token{
+ .id = .eof,
+ .start = self.index,
+ .end = undefined,
+ };
+ while (self.index < self.buffer.len) : (self.index += 1) {
+ const c = self.buffer[self.index];
+ switch (self.state) {
+ .start => switch (c) {
+ '{' => {
+ self.state = .l_bracket;
+ },
+ else => {
+ result.id = .content;
+ },
+ },
+ .l_bracket => switch (c) {
+ '#' => {
+ if (result.id != .eof) {
+ self.index -= 1;
+ self.state = .start;
+ break;
+ } else {
+ result.id = .bracket_open;
+ self.index += 1;
+ self.state = .tag_name;
+ break;
+ }
+ },
+ else => {
+ result.id = .content;
+ self.state = .start;
+ },
+ },
+ .tag_name => switch (c) {
+ '|' => {
+ if (result.id != .eof) {
+ break;
+ } else {
+ result.id = .separator;
+ self.index += 1;
+ break;
+ }
+ },
+ '#' => {
+ self.state = .hash;
+ },
+ else => {
+ result.id = .tag_content;
+ },
+ },
+ .hash => switch (c) {
+ '}' => {
+ if (result.id != .eof) {
+ self.index -= 1;
+ self.state = .tag_name;
+ break;
+ } else {
+ result.id = .bracket_close;
+ self.index += 1;
+ self.state = .start;
+ break;
+ }
+ },
+ else => {
+ result.id = .tag_content;
+ self.state = .tag_name;
+ },
+ },
+ .eof => unreachable,
+ }
+ } else {
+ switch (self.state) {
+ .start, .l_bracket, .eof => {},
+ else => {
+ result.id = .invalid;
+ },
+ }
+ self.state = .eof;
+ }
+ result.end = self.index;
+ return result;
+ }
+
+ const Location = struct {
+ line: usize,
+ column: usize,
+ line_start: usize,
+ line_end: usize,
+ };
+
+ fn getTokenLocation(self: *Tokenizer, token: Token) Location {
+ var loc = Location{
+ .line = 0,
+ .column = 0,
+ .line_start = 0,
+ .line_end = 0,
+ };
+ for (self.buffer, 0..) |c, i| {
+ if (i == token.start) {
+ loc.line_end = i;
+ while (loc.line_end < self.buffer.len and self.buffer[loc.line_end] != '\n') : (loc.line_end += 1) {}
+ return loc;
+ }
+ if (c == '\n') {
+ loc.line += 1;
+ loc.column = 0;
+ loc.line_start = i + 1;
+ } else {
+ loc.column += 1;
+ }
+ }
+ return loc;
+ }
+};
+
+fn parseError(tokenizer: *Tokenizer, token: Token, comptime fmt: []const u8, args: anytype) anyerror {
+ const loc = tokenizer.getTokenLocation(token);
+ const args_prefix = .{ tokenizer.source_file_name, loc.line + 1, loc.column + 1 };
+ print("{s}:{d}:{d}: error: " ++ fmt ++ "\n", args_prefix ++ args);
+ if (loc.line_start <= loc.line_end) {
+ print("{s}\n", .{tokenizer.buffer[loc.line_start..loc.line_end]});
+ {
+ var i: usize = 0;
+ while (i < loc.column) : (i += 1) {
+ print(" ", .{});
+ }
+ }
+ {
+ const caret_count = @min(token.end, loc.line_end) - token.start;
+ var i: usize = 0;
+ while (i < caret_count) : (i += 1) {
+ print("~", .{});
+ }
+ }
+ print("\n", .{});
+ }
+ return error.ParseError;
+}
+
+fn assertToken(tokenizer: *Tokenizer, token: Token, id: Token.Id) !void {
+ if (token.id != id) {
+ return parseError(tokenizer, token, "expected {s}, found {s}", .{ @tagName(id), @tagName(token.id) });
+ }
+}
+
+fn eatToken(tokenizer: *Tokenizer, id: Token.Id) !Token {
+ const token = tokenizer.next();
+ try assertToken(tokenizer, token, id);
+ return token;
+}
+
+const HeaderOpen = struct {
+ name: []const u8,
+ url: []const u8,
+ n: usize,
+};
+
+const SeeAlsoItem = struct {
+ name: []const u8,
+ token: Token,
+};
+
+const ExpectedOutcome = enum {
+ succeed,
+ fail,
+ build_fail,
+};
+
+const Code = struct {
+ id: Id,
+ name: []const u8,
+ source_token: Token,
+ just_check_syntax: bool,
+ mode: std.builtin.Mode,
+ link_objects: []const []const u8,
+ target_str: ?[]const u8,
+ link_libc: bool,
+ link_mode: ?std.builtin.LinkMode,
+ disable_cache: bool,
+ verbose_cimport: bool,
+ additional_options: []const []const u8,
+
+ const Id = union(enum) {
+ @"test",
+ test_error: []const u8,
+ test_safety: []const u8,
+ exe: ExpectedOutcome,
+ obj: ?[]const u8,
+ lib,
+ };
+};
+
+const Link = struct {
+ url: []const u8,
+ name: []const u8,
+ token: Token,
+};
+
+const SyntaxBlock = struct {
+ source_type: SourceType,
+ name: []const u8,
+ source_token: Token,
+
+ const SourceType = enum {
+ zig,
+ c,
+ peg,
+ javascript,
+ };
+};
+
+const Node = union(enum) {
+ Content: []const u8,
+ Nav,
+ Builtin: Token,
+ HeaderOpen: HeaderOpen,
+ SeeAlso: []const SeeAlsoItem,
+ Code: Code,
+ Link: Link,
+ InlineSyntax: Token,
+ Shell: Token,
+ SyntaxBlock: SyntaxBlock,
+};
+
+const Toc = struct {
+ nodes: []Node,
+ toc: []u8,
+ urls: std.StringHashMap(Token),
+};
+
+const Action = enum {
+ open,
+ close,
+};
+
+fn genToc(allocator: Allocator, tokenizer: *Tokenizer) !Toc {
+ var urls = std.StringHashMap(Token).init(allocator);
+ errdefer urls.deinit();
+
+ var header_stack_size: usize = 0;
+ var last_action: Action = .open;
+ var last_columns: ?u8 = null;
+
+ var toc_buf = std.ArrayList(u8).init(allocator);
+ defer toc_buf.deinit();
+
+ var toc = toc_buf.writer();
+
+ var nodes = std.ArrayList(Node).init(allocator);
+ defer nodes.deinit();
+
+ try toc.writeByte('\n');
+
+ while (true) {
+ const token = tokenizer.next();
+ switch (token.id) {
+ .eof => {
+ if (header_stack_size != 0) {
+ return parseError(tokenizer, token, "unbalanced headers", .{});
+ }
+ try toc.writeAll("