authorgravatar for xq@random-projects.netFelix "xq" Queißner <xq@random-projects.net> 2021-02-22 21:23:44+01:00
committergravatar for git@vexu.euVeikka Tuominen <git@vexu.eu> 2021-06-11 10:33:26+03:00
log4ed567d12e2670596ebc4bf42c710b4e3210e77e
treeed4986cddfe64caa612748b1deb3fa591053ce89
parent437f81aa9a963af2dce654cd0ac7ac0e19a4922a

Adds more FileSources everywhere.

4 files changed, 111 insertions(+), 160 deletions(-)

lib/std/build.zig+46-118
......@@ -204,55 +204,24 @@ pub const Builder = struct {
204204 self.h_dir = fs.path.join(self.allocator, &[_][]const u8{ self.install_path, "include" }) catch unreachable;
205205 }
206206
207 pub fn addExecutable(self: *Builder, name: []const u8, root_src: ?[]const u8) *LibExeObjStep {
208 return LibExeObjStep.createExecutable(
209 self,
210 name,
211 if (root_src) |p| FileSource{ .path = p } else null,
212 false,
213 );
207 fn convertOptionalPathToFileSource(path: ?[]const u8) ?FileSource {
208 return if (path) |p|
209 FileSource.relative(p)
210 else
211 null;
214212 }
215213
216 pub fn addExecutableFromWriteFileStep(
217 self: *Builder,
218 name: []const u8,
219 wfs: *WriteFileStep,
220 basename: []const u8,
221 ) *LibExeObjStep {
222 return LibExeObjStep.createExecutable(self, name, @as(FileSource, .{
223 .write_file = .{
224 .step = wfs,
225 .basename = basename,
226 },
227 }), false);
214 pub fn addExecutable(self: *Builder, name: []const u8, root_src: ?[]const u8) *LibExeObjStep {
215 return addExecutableSource(self, name, convertOptionalPathToFileSource(root_src), false);
228216 }
229217
230 pub fn addExecutableSource(
231 self: *Builder,
232 name: []const u8,
233 root_src: ?FileSource,
234 ) *LibExeObjStep {
235 return LibExeObjStep.createExecutable(self, name, root_src, false);
236 }
218 pub const addExecutableSource = LibExeObjStep.createExecutable;
237219
238220 pub fn addObject(self: *Builder, name: []const u8, root_src: ?[]const u8) *LibExeObjStep {
239 const root_src_param = if (root_src) |p| @as(FileSource, .{ .path = p }) else null;
240 return LibExeObjStep.createObject(self, name, root_src_param);
221 return addObjectSource(self, name, convertOptionalPathToFileSource(root_src));
241222 }
242223
243 pub fn addObjectFromWriteFileStep(
244 self: *Builder,
245 name: []const u8,
246 wfs: *WriteFileStep,
247 basename: []const u8,
248 ) *LibExeObjStep {
249 return LibExeObjStep.createObject(self, name, @as(FileSource, .{
250 .write_file = .{
251 .step = wfs,
252 .basename = basename,
253 },
254 }));
255 }
224 pub const addObjectSource = LibExeObjStep.createObject;
256225
257226 pub fn addSharedLibrary(
258227 self: *Builder,
......@@ -260,64 +229,33 @@ pub const Builder = struct {
260229 root_src: ?[]const u8,
261230 kind: LibExeObjStep.SharedLibKind,
262231 ) *LibExeObjStep {
263 const root_src_param = if (root_src) |p| @as(FileSource, .{ .path = p }) else null;
264 return LibExeObjStep.createSharedLibrary(self, name, root_src_param, kind);
232 return addSharedLibrarySource(self, name, convertOptionalPathToFileSource(root_src), kind);
265233 }
266234
267 pub fn addSharedLibraryFromWriteFileStep(
268 self: *Builder,
269 name: []const u8,
270 wfs: *WriteFileStep,
271 basename: []const u8,
272 kind: LibExeObjStep.SharedLibKind,
273 ) *LibExeObjStep {
274 return LibExeObjStep.createSharedLibrary(self, name, @as(FileSource, .{
275 .write_file = .{
276 .step = wfs,
277 .basename = basename,
278 },
279 }), kind);
280 }
235 pub const addSharedLibrarySource = LibExeObjStep.createSharedLibrary;
281236
282237 pub fn addStaticLibrary(self: *Builder, name: []const u8, root_src: ?[]const u8) *LibExeObjStep {
283238 const root_src_param = if (root_src) |p| @as(FileSource, .{ .path = p }) else null;
284239 return LibExeObjStep.createStaticLibrary(self, name, root_src_param);
285240 }
286241
287 pub fn addStaticLibraryFromWriteFileStep(
288 self: *Builder,
289 name: []const u8,
290 wfs: *WriteFileStep,
291 basename: []const u8,
292 ) *LibExeObjStep {
293 return LibExeObjStep.createStaticLibrary(self, name, @as(FileSource, .{
294 .write_file = .{
295 .step = wfs,
296 .basename = basename,
297 },
298 }));
299 }
242 pub const addStaticLibrarySource = LibExeObjStep.createStaticLibrary;
300243
301244 pub fn addTest(self: *Builder, root_src: []const u8) *LibExeObjStep {
302245 return LibExeObjStep.createTest(self, "test", .{ .path = root_src });
303246 }
304247
305 pub fn addTestFromWriteFileStep(
306 self: *Builder,
307 wfs: *WriteFileStep,
308 basename: []const u8,
309 ) *LibExeObjStep {
310 return LibExeObjStep.createTest(self, "test", @as(FileSource, .{
311 .write_file = .{
312 .step = wfs,
313 .basename = basename,
314 },
315 }));
248 pub fn addTestSource(self: *Builder, root_src: FileSource) *LibExeObjStep {
249 return LibExeObjStep.createTest(self, "test", root_src);
316250 }
317251
318252 pub fn addAssemble(self: *Builder, name: []const u8, src: []const u8) *LibExeObjStep {
253 return addAssembleSource(self, name, FileSource.relative(src));
254 }
255
256 pub fn addAssembleSource(self: *Builder, name: []const u8, src: FileSource) *LibExeObjStep {
319257 const obj_step = LibExeObjStep.createObject(self, name, null);
320 obj_step.addAssemblyFile(src);
258 obj_step.addAssemblyFileSource(src);
321259 return obj_step;
322260 }
323261
......@@ -938,7 +876,7 @@ pub const Builder = struct {
938876
939877 ///`dest_rel_path` is relative to prefix path
940878 pub fn installFile(self: *Builder, src_path: []const u8, dest_rel_path: []const u8) void {
941 self.getInstallStep().dependOn(&self.addInstallFileWithDir(src_path, .Prefix, dest_rel_path).step);
879 self.getInstallStep().dependOn(&self.addInstallFileWithDir(FileSource.relative(src_path), .Prefix, dest_rel_path).step);
942880 }
943881
944882 pub fn installDirectory(self: *Builder, options: InstallDirectoryOptions) void {
......@@ -947,12 +885,12 @@ pub const Builder = struct {
947885
948886 ///`dest_rel_path` is relative to bin path
949887 pub fn installBinFile(self: *Builder, src_path: []const u8, dest_rel_path: []const u8) void {
950 self.getInstallStep().dependOn(&self.addInstallFileWithDir(src_path, .Bin, dest_rel_path).step);
888 self.getInstallStep().dependOn(&self.addInstallFileWithDir(FileSource.relative(src_path), .Bin, dest_rel_path).step);
951889 }
952890
953891 ///`dest_rel_path` is relative to lib path
954892 pub fn installLibFile(self: *Builder, src_path: []const u8, dest_rel_path: []const u8) void {
955 self.getInstallStep().dependOn(&self.addInstallFileWithDir(src_path, .Lib, dest_rel_path).step);
893 self.getInstallStep().dependOn(&self.addInstallFileWithDir(FileSource.relative(src_path), .Lib, dest_rel_path).step);
956894 }
957895
958896 pub fn installRaw(self: *Builder, artifact: *LibExeObjStep, dest_filename: []const u8) void {
......@@ -961,17 +899,17 @@ pub const Builder = struct {
961899
962900 ///`dest_rel_path` is relative to install prefix path
963901 pub fn addInstallFile(self: *Builder, src_path: []const u8, dest_rel_path: []const u8) *InstallFileStep {
964 return self.addInstallFileWithDir(src_path, .Prefix, dest_rel_path);
902 return self.addInstallFileWithDir(FileSource.relative(src_path), .Prefix, dest_rel_path);
965903 }
966904
967905 ///`dest_rel_path` is relative to bin path
968906 pub fn addInstallBinFile(self: *Builder, src_path: []const u8, dest_rel_path: []const u8) *InstallFileStep {
969 return self.addInstallFileWithDir(src_path, .Bin, dest_rel_path);
907 return self.addInstallFileWithDir(FileSource.relative(src_path), .Bin, dest_rel_path);
970908 }
971909
972910 ///`dest_rel_path` is relative to lib path
973911 pub fn addInstallLibFile(self: *Builder, src_path: []const u8, dest_rel_path: []const u8) *InstallFileStep {
974 return self.addInstallFileWithDir(src_path, .Lib, dest_rel_path);
912 return self.addInstallFileWithDir(FileSource.relative(src_path), .Lib, dest_rel_path);
975913 }
976914
977915 pub fn addInstallRaw(self: *Builder, artifact: *LibExeObjStep, dest_filename: []const u8) *InstallRawStep {
......@@ -980,7 +918,7 @@ pub const Builder = struct {
980918
981919 pub fn addInstallFileWithDir(
982920 self: *Builder,
983 src_path: []const u8,
921 source: FileSource,
984922 install_dir: InstallDir,
985923 dest_rel_path: []const u8,
986924 ) *InstallFileStep {
......@@ -988,7 +926,7 @@ pub const Builder = struct {
988926 panic("dest_rel_path must be non-empty", .{});
989927 }
990928 const install_step = self.allocator.create(InstallFileStep) catch unreachable;
991 install_step.* = InstallFileStep.init(self, src_path, install_dir, dest_rel_path);
929 install_step.* = InstallFileStep.init(self, source, install_dir, dest_rel_path);
992930 return install_step;
993931 }
994932
......@@ -1301,42 +1239,41 @@ pub const GeneratedFile = struct {
13011239pub const FileSource = union(enum) {
13021240 /// Relative to build root
13031241 path: []const u8,
1304 write_file: struct {
1305 step: *WriteFileStep,
1306 basename: []const u8,
1307 },
13081242 generated: *const GeneratedFile,
13091243
13101244 pub fn relative(path: []const u8) FileSource {
13111245 return FileSource{ .path = path };
13121246 }
13131247
1248 /// Returns a string that can be shown to represent the file source.
1249 /// Either returns the path or `"generated"`.
1250 pub fn getDisplayName(self: FileSource) []const u8 {
1251 return switch (self) {
1252 .path => self.path,
1253 .generated => "generated",
1254 };
1255 }
1256
13141257 pub fn addStepDependencies(self: FileSource, step: *Step) void {
13151258 switch (self) {
13161259 .path => {},
1317 .write_file => |wf| step.dependOn(&wf.step.step),
13181260 .generated => |gen| step.dependOn(gen.step),
13191261 }
13201262 }
13211263
1322 /// Should only be called during make()
1264 /// Should only be called during make(), returns an absolute path to the file.
13231265 pub fn getPath(self: FileSource, builder: *Builder) []const u8 {
1324 return switch (self) {
1266 const path = switch (self) {
13251267 .path => |p| builder.pathFromRoot(p),
1326 .write_file => |wf| wf.step.getOutputPath(wf.basename),
13271268 .generated => |gen| gen.getPath(),
13281269 };
1270 std.debug.assert(std.fs.path.isAbsolute(path));
1271 return path;
13291272 }
13301273
13311274 pub fn dupe(self: FileSource, b: *Builder) FileSource {
13321275 return switch (self) {
13331276 .path => |p| .{ .path = b.dupePath(p) },
1334 .write_file => |wf| .{
1335 .write_file = .{
1336 .step = wf.step,
1337 .basename = b.dupe(wf.basename),
1338 },
1339 },
13401277 .generated => |gen| .{ .generated = gen },
13411278 };
13421279 }
......@@ -1967,15 +1904,6 @@ pub const LibExeObjStep = struct {
19671904 }) catch unreachable;
19681905 }
19691906
1970 pub fn addAssemblyFileFromWriteFileStep(self: *LibExeObjStep, wfs: *WriteFileStep, basename: []const u8) void {
1971 self.addAssemblyFileSource(.{
1972 .write_file = .{
1973 .step = wfs,
1974 .basename = self.builder.dupe(basename),
1975 },
1976 });
1977 }
1978
19791907 pub fn addAssemblyFileSource(self: *LibExeObjStep, source: FileSource) void {
19801908 const source_duped = source.dupe(self.builder);
19811909 self.link_objects.append(LinkObject{ .AssemblyFile = source_duped }) catch unreachable;
......@@ -2834,21 +2762,21 @@ pub const InstallArtifactStep = struct {
28342762pub const InstallFileStep = struct {
28352763 step: Step,
28362764 builder: *Builder,
2837 src_path: []const u8,
2765 source: FileSource,
28382766 dir: InstallDir,
28392767 dest_rel_path: []const u8,
28402768
28412769 pub fn init(
28422770 builder: *Builder,
2843 src_path: []const u8,
2771 source: FileSource,
28442772 dir: InstallDir,
28452773 dest_rel_path: []const u8,
28462774 ) InstallFileStep {
28472775 builder.pushInstalledFile(dir, dest_rel_path);
28482776 return InstallFileStep{
28492777 .builder = builder,
2850 .step = Step.init(.InstallFile, builder.fmt("install {s}", .{src_path}), builder.allocator, make),
2851 .src_path = builder.dupePath(src_path),
2778 .step = Step.init(.InstallFile, builder.fmt("install {s} to {s}", .{ source.getDisplayName(), dest_rel_path }), builder.allocator, make),
2779 .source = source.dupe(builder),
28522780 .dir = dir.dupe(builder),
28532781 .dest_rel_path = builder.dupePath(dest_rel_path),
28542782 };
......@@ -2857,7 +2785,7 @@ pub const InstallFileStep = struct {
28572785 fn make(step: *Step) !void {
28582786 const self = @fieldParentPtr(InstallFileStep, "step", step);
28592787 const full_dest_path = self.builder.getInstallPath(self.dir, self.dest_rel_path);
2860 const full_src_path = self.builder.pathFromRoot(self.src_path);
2788 const full_src_path = self.source.getPath(self.builder);
28612789 try self.builder.updateFile(full_src_path, full_dest_path);
28622790 }
28632791};
lib/std/build/run.zig+11-19
......@@ -47,12 +47,9 @@ pub const RunStep = struct {
4747 };
4848
4949 pub const Arg = union(enum) {
50 Artifact: *LibExeObjStep,
51 WriteFile: struct {
52 step: *WriteFileStep,
53 file_name: []const u8,
54 },
55 Bytes: []u8,
50 artifact: *LibExeObjStep,
51 file_source: build.FileSource,
52 bytes: []u8,
5653 };
5754
5855 pub fn create(builder: *Builder, name: []const u8) *RunStep {
......@@ -68,22 +65,19 @@ pub const RunStep = struct {
6865 }
6966
7067 pub fn addArtifactArg(self: *RunStep, artifact: *LibExeObjStep) void {
71 self.argv.append(Arg{ .Artifact = artifact }) catch unreachable;
68 self.argv.append(Arg{ .artifact = artifact }) catch unreachable;
7269 self.step.dependOn(&artifact.step);
7370 }
7471
75 pub fn addWriteFileArg(self: *RunStep, write_file: *WriteFileStep, file_name: []const u8) void {
72 pub fn addFileSourceArg(self: *RunStep, file_source: build.FileSource) void {
7673 self.argv.append(Arg{
77 .WriteFile = .{
78 .step = write_file,
79 .file_name = self.builder.dupePath(file_name),
80 },
74 .file_source = file_source,
8175 }) catch unreachable;
82 self.step.dependOn(&write_file.step);
76 file_source.addStepDependencies(&self.step);
8377 }
8478
8579 pub fn addArg(self: *RunStep, arg: []const u8) void {
86 self.argv.append(Arg{ .Bytes = self.builder.dupe(arg) }) catch unreachable;
80 self.argv.append(Arg{ .bytes = self.builder.dupe(arg) }) catch unreachable;
8781 }
8882
8983 pub fn addArgs(self: *RunStep, args: []const []const u8) void {
......@@ -162,11 +156,9 @@ pub const RunStep = struct {
162156 var argv_list = ArrayList([]const u8).init(self.builder.allocator);
163157 for (self.argv.items) |arg| {
164158 switch (arg) {
165 Arg.Bytes => |bytes| try argv_list.append(bytes),
166 Arg.WriteFile => |file| {
167 try argv_list.append(file.step.getOutputPath(file.file_name));
168 },
169 Arg.Artifact => |artifact| {
159 .bytes => |bytes| try argv_list.append(bytes),
160 .file_source => |file| try argv_list.append(file.getPath(self.builder)),
161 .artifact => |artifact| {
170162 if (artifact.target.isWindows()) {
171163 // On Windows we don't have rpaths so we have to add .dll search paths to PATH
172164 self.addPathForDynLibs(artifact);
lib/std/build/translate_c.zig+1-1
......@@ -62,7 +62,7 @@ pub const TranslateCStep = struct {
6262
6363 /// Creates a step to build an executable from the translated source.
6464 pub fn addExecutable(self: *TranslateCStep) *LibExeObjStep {
65 return self.builder.addExecutableSource("translated_c", @as(build.FileSource, .{ .generated = &self.output_file }));
65 return self.builder.addExecutableSource("translated_c", build.FileSource{ .generated = &self.output_file }, false);
6666 }
6767
6868 pub fn addIncludeDir(self: *TranslateCStep, include_dir: []const u8) void {
lib/std/build/write_file.zig+53-22
......@@ -15,9 +15,10 @@ pub const WriteFileStep = struct {
1515 step: Step,
1616 builder: *Builder,
1717 output_dir: []const u8,
18 files: ArrayList(File),
18 files: std.TailQueue(File),
1919
2020 pub const File = struct {
21 source: build.GeneratedFile,
2122 basename: []const u8,
2223 bytes: []const u8,
2324 };
......@@ -26,25 +27,49 @@ pub const WriteFileStep = struct {
2627 return WriteFileStep{
2728 .builder = builder,
2829 .step = Step.init(.WriteFile, "writefile", builder.allocator, make),
29 .files = ArrayList(File).init(builder.allocator),
30 .files = .{},
3031 .output_dir = undefined,
3132 };
3233 }
3334
3435 pub fn add(self: *WriteFileStep, basename: []const u8, bytes: []const u8) void {
35 self.files.append(.{
36 .basename = self.builder.dupePath(basename),
37 .bytes = self.builder.dupe(bytes),
38 }) catch unreachable;
36 const node = self.builder.allocator.create(std.TailQueue(File).Node) catch unreachable;
37 node.* = .{
38 .data = .{
39 .source = build.GeneratedFile{
40 .step = &self.step,
41 .getPathFn = getFilePath,
42 },
43 .basename = self.builder.dupePath(basename),
44 .bytes = self.builder.dupe(bytes),
45 },
46 };
47
48 self.files.append(node);
3949 }
4050
4151 /// Unless setOutputDir was called, this function must be called only in
4252 /// the make step, from a step that has declared a dependency on this one.
4353 /// To run an executable built with zig build, use `run`, or create an install step and invoke it.
44 pub fn getOutputPath(self: *WriteFileStep, basename: []const u8) []const u8 {
54 //pub const getOutputPath = @compileError("WriteFileStep.getOutputPath is deprecated! Use getFileSource to retrieve a ");
55 /// Gets a file source for the given basename. If the file does not exist, returns `null`.
56 pub fn getFileSource(step: *WriteFileStep, basename: []const u8) ?build.FileSource {
57 var it = step.files.first;
58 while (it) |node| : (it = node.next) {
59 if (std.mem.eql(u8, node.data.basename, basename))
60 return build.FileSource{ .generated = &node.data.source };
61 }
62 return null;
63 }
64
65 /// Returns the
66 fn getFilePath(source: *const build.GeneratedFile) []const u8 {
67 const file = @fieldParentPtr(File, "source", source);
68 const step = @fieldParentPtr(WriteFileStep, "step", source.step);
69
4570 return fs.path.join(
46 self.builder.allocator,
47 &[_][]const u8{ self.output_dir, basename },
71 step.builder.allocator,
72 &[_][]const u8{ step.output_dir, file.basename },
4873 ) catch unreachable;
4974 }
5075
......@@ -67,10 +92,13 @@ pub const WriteFileStep = struct {
6792 // new random bytes when WriteFileStep implementation is modified
6893 // in a non-backwards-compatible way.
6994 hash.update("eagVR1dYXoE7ARDP");
70 for (self.files.items) |file| {
71 hash.update(file.basename);
72 hash.update(file.bytes);
73 hash.update("|");
95 {
96 var it = self.files.first;
97 while (it) |node| : (it = node.next) {
98 hash.update(node.data.basename);
99 hash.update(node.data.bytes);
100 hash.update("|");
101 }
74102 }
75103 var digest: [48]u8 = undefined;
76104 hash.final(&digest);
......@@ -88,15 +116,18 @@ pub const WriteFileStep = struct {
88116 };
89117 var dir = try fs.cwd().openDir(self.output_dir, .{});
90118 defer dir.close();
91 for (self.files.items) |file| {
92 dir.writeFile(file.basename, file.bytes) catch |err| {
93 warn("unable to write {s} into {s}: {s}\n", .{
94 file.basename,
95 self.output_dir,
96 @errorName(err),
97 });
98 return err;
99 };
119 {
120 var it = self.files.first;
121 while (it) |node| : (it = node.next) {
122 dir.writeFile(node.data.basename, node.data.bytes) catch |err| {
123 warn("unable to write {s} into {s}: {s}\n", .{
124 node.data.basename,
125 self.output_dir,
126 @errorName(err),
127 });
128 return err;
129 };
130 }
100131 }
101132 }
102133};