authorgravatar for alex@alexrp.comAlex Rønne Petersen <alex@alexrp.com> 2024-06-16 04:42:58+02:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2024-06-16 23:13:12-04:00
log6220c754cf3387aebbcba270789ec67e652398cb
treede071d2dc7ecde7a1615d52a839fa01b198b6a8c
parentc533233f4211f353ca532da48132ee4069ba2841

std.Build: Add Step.Fail and addFail() function.

Closes #15373.

3 files changed, 43 insertions(+), 0 deletions(-)

lib/std/Build.zig+4
...@@ -1058,6 +1058,10 @@ pub fn addRemoveDirTree(b: *Build, dir_path: []const u8) *Step.RemoveDir {...@@ -1058,6 +1058,10 @@ pub fn addRemoveDirTree(b: *Build, dir_path: []const u8) *Step.RemoveDir {
1058 return Step.RemoveDir.create(b, dir_path);1058 return Step.RemoveDir.create(b, dir_path);
1059}1059}
10601060
1061pub fn addFail(b: *Build, error_msg: []const u8) *Step.Fail {
1062 return Step.Fail.create(b, error_msg);
1063}
1064
1061pub fn addFmt(b: *Build, options: Step.Fmt.Options) *Step.Fmt {1065pub fn addFmt(b: *Build, options: Step.Fmt.Options) *Step.Fmt {
1062 return Step.Fmt.create(b, options);1066 return Step.Fmt.create(b, options);
1063}1067}
lib/std/Build/Step.zig+4
...@@ -83,6 +83,7 @@ pub const Id = enum {...@@ -83,6 +83,7 @@ pub const Id = enum {
83 install_file,83 install_file,
84 install_dir,84 install_dir,
85 remove_dir,85 remove_dir,
86 fail,
86 fmt,87 fmt,
87 translate_c,88 translate_c,
88 write_file,89 write_file,
...@@ -102,6 +103,7 @@ pub const Id = enum {...@@ -102,6 +103,7 @@ pub const Id = enum {
102 .install_file => InstallFile,103 .install_file => InstallFile,
103 .install_dir => InstallDir,104 .install_dir => InstallDir,
104 .remove_dir => RemoveDir,105 .remove_dir => RemoveDir,
106 .fail => Fail,
105 .fmt => Fmt,107 .fmt => Fmt,
106 .translate_c => TranslateC,108 .translate_c => TranslateC,
107 .write_file => WriteFile,109 .write_file => WriteFile,
...@@ -119,6 +121,7 @@ pub const Id = enum {...@@ -119,6 +121,7 @@ pub const Id = enum {
119pub const CheckFile = @import("Step/CheckFile.zig");121pub const CheckFile = @import("Step/CheckFile.zig");
120pub const CheckObject = @import("Step/CheckObject.zig");122pub const CheckObject = @import("Step/CheckObject.zig");
121pub const ConfigHeader = @import("Step/ConfigHeader.zig");123pub const ConfigHeader = @import("Step/ConfigHeader.zig");
124pub const Fail = @import("Step/Fail.zig");
122pub const Fmt = @import("Step/Fmt.zig");125pub const Fmt = @import("Step/Fmt.zig");
123pub const InstallArtifact = @import("Step/InstallArtifact.zig");126pub const InstallArtifact = @import("Step/InstallArtifact.zig");
124pub const InstallDir = @import("Step/InstallDir.zig");127pub const InstallDir = @import("Step/InstallDir.zig");
...@@ -551,6 +554,7 @@ pub fn writeManifest(s: *Step, man: *std.Build.Cache.Manifest) !void {...@@ -551,6 +554,7 @@ pub fn writeManifest(s: *Step, man: *std.Build.Cache.Manifest) !void {
551test {554test {
552 _ = CheckFile;555 _ = CheckFile;
553 _ = CheckObject;556 _ = CheckObject;
557 _ = Fail;
554 _ = Fmt;558 _ = Fmt;
555 _ = InstallArtifact;559 _ = InstallArtifact;
556 _ = InstallDir;560 _ = InstallDir;
lib/std/Build/Step/Fail.zig created+35
...@@ -0,0 +1,35 @@
1//! Fail the build with a given message.
2const std = @import("std");
3const Step = std.Build.Step;
4const Fail = @This();
5
6step: Step,
7error_msg: []const u8,
8
9pub const base_id: Step.Id = .fail;
10
11pub fn create(owner: *std.Build, error_msg: []const u8) *Fail {
12 const fail = owner.allocator.create(Fail) catch @panic("OOM");
13
14 fail.* = .{
15 .step = Step.init(.{
16 .id = base_id,
17 .name = "fail",
18 .owner = owner,
19 .makeFn = make,
20 }),
21 .error_msg = owner.dupe(error_msg),
22 };
23
24 return fail;
25}
26
27fn make(step: *Step, prog_node: std.Progress.Node) !void {
28 _ = prog_node; // No progress to report.
29
30 const fail: *Fail = @fieldParentPtr("step", step);
31
32 try step.result_error_msgs.append(step.owner.allocator, fail.error_msg);
33
34 return error.MakeFailed;
35}