Commit 11cc1c16fa36a7eb13cba1c43fb153ee6aca7b58 | zig

author	Andrew Kelley <andrew@ziglang.org> 2023-02-04 16:14:43-07:00
committer	Andrew Kelley <andrew@ziglang.org> 2023-02-05 03:25:43-05:00
log	11cc1c16fa36a7eb13cba1c43fb153ee6aca7b58
tree	5c1ee30f000c278394a00f674aab25c0fff1c0c0
parent	d4ce0fe7fea14bae889e03464980e5eca7a2ed1f

make `@embedFile` support module-mapped names the same way as `@import`

closes #14553

5 files changed, 78 insertions(+), 14 deletions(-)

src
- Module.zig
test
- standalone.zig
- standalone
  - embed_generated_file
    bootloader.zig
    build.zig
    main.zig

src/Module.zig+40-14

 @@ -4865,14 +4865,31 @@ pub fn importFile(
     };
 }
-pub fn embedFile(mod: *Module, cur_file: *File, rel_file_path: []const u8) !*EmbedFile {
+pub fn embedFile(mod: *Module, cur_file: *File, import_string: []const u8) !*EmbedFile {
     const gpa = mod.gpa;
-    // The resolved path is used as the key in the table, to detect if
+    if (cur_file.pkg.table.get(import_string)) |pkg| {
-    // a file refers to the same as another, despite different relative paths.
+        const resolved_path = try std.fs.path.resolve(gpa, &[_][]const u8{
+            pkg.root_src_directory.path orelse ".", pkg.root_src_path,
+        });
+        var keep_resolved_path = false;
+        defer if (!keep_resolved_path) gpa.free(resolved_path);
+        const gop = try mod.embed_table.getOrPut(gpa, resolved_path);
+        errdefer assert(mod.embed_table.remove(resolved_path));
+        if (gop.found_existing) return gop.value_ptr.*;
+        const sub_file_path = try gpa.dupe(u8, pkg.root_src_path);
+        errdefer gpa.free(sub_file_path);
+        return newEmbedFile(mod, pkg, sub_file_path, resolved_path, &keep_resolved_path, gop);
+    }
+    // The resolved path is used as the key in the table, to detect if a file
+    // refers to the same as another, despite different relative paths.
     const cur_pkg_dir_path = cur_file.pkg.root_src_directory.path orelse ".";
     const resolved_path = try std.fs.path.resolve(gpa, &[_][]const u8{
-        cur_pkg_dir_path, cur_file.sub_file_path, "..", rel_file_path,
+        cur_pkg_dir_path, cur_file.sub_file_path, "..", import_string,
     });
     var keep_resolved_path = false;
     defer if (!keep_resolved_path) gpa.free(resolved_path);
 @@ -4881,9 +4898,6 @@ pub fn embedFile(mod: *Module, cur_file: *File, rel_file_path: []const u8) !*Emb
     errdefer assert(mod.embed_table.remove(resolved_path));
     if (gop.found_existing) return gop.value_ptr.*;
-    const new_file = try gpa.create(EmbedFile);
-    errdefer gpa.destroy(new_file);
     const resolved_root_path = try std.fs.path.resolve(gpa, &[_][]const u8{cur_pkg_dir_path});
     defer gpa.free(resolved_root_path);
 @@ -4902,7 +4916,23 @@ pub fn embedFile(mod: *Module, cur_file: *File, rel_file_path: []const u8) !*Emb
     };
     errdefer gpa.free(sub_file_path);
-    var file = try cur_file.pkg.root_src_directory.handle.openFile(sub_file_path, .{});
+    return newEmbedFile(mod, cur_file.pkg, sub_file_path, resolved_path, &keep_resolved_path, gop);
+}
+fn newEmbedFile(
+    mod: *Module,
+    pkg: *Package,
+    sub_file_path: []const u8,
+    resolved_path: []const u8,
+    keep_resolved_path: *bool,
+    gop: std.StringHashMapUnmanaged(*EmbedFile).GetOrPutResult,
+) !*EmbedFile {
+    const gpa = mod.gpa;
+    const new_file = try gpa.create(EmbedFile);
+    errdefer gpa.destroy(new_file);
+    var file = try pkg.root_src_directory.handle.openFile(sub_file_path, .{});
     defer file.close();
     const actual_stat = try file.stat();
 @@ -4915,10 +4945,6 @@ pub fn embedFile(mod: *Module, cur_file: *File, rel_file_path: []const u8) !*Emb
     const bytes = try file.readToEndAllocOptions(gpa, std.math.maxInt(u32), size_usize, 1, 0);
     errdefer gpa.free(bytes);
-    log.debug("new embedFile. resolved_root_path={s}, resolved_path={s}, sub_file_path={s}, rel_file_path={s}", .{
-        resolved_root_path, resolved_path, sub_file_path, rel_file_path,
-    });
     if (mod.comp.whole_cache_manifest) |whole_cache_manifest| {
         const copied_resolved_path = try gpa.dupe(u8, resolved_path);
         errdefer gpa.free(copied_resolved_path);
 @@ -4927,13 +4953,13 @@ pub fn embedFile(mod: *Module, cur_file: *File, rel_file_path: []const u8) !*Emb
         try whole_cache_manifest.addFilePostContents(copied_resolved_path, bytes, stat);
     }
-    keep_resolved_path = true; // It's now owned by embed_table.
+    keep_resolved_path.* = true; // It's now owned by embed_table.
     gop.value_ptr.* = new_file;
     new_file.* = .{
         .sub_file_path = sub_file_path,
         .bytes = bytes,
         .stat = stat,
-        .pkg = cur_file.pkg,
+        .pkg = pkg,
         .owner_decl = undefined, // Set by Sema immediately after this function returns.
     };
     return new_file;

test/standalone.zig+1

...	@@ -102,4 +102,5 @@ pub fn addCases(cases: *tests.StandaloneContext) void {	...	@@ -102,4 +102,5 @@ pub fn addCases(cases: *tests.StandaloneContext) void {
102	cases.addBuildFile("test/standalone/issue_13030/build.zig", .{ .build_modes = true });	102	cases.addBuildFile("test/standalone/issue_13030/build.zig", .{ .build_modes = true });
103	cases.addBuildFile("test/standalone/emit_asm_and_bin/build.zig", .{});	103	cases.addBuildFile("test/standalone/emit_asm_and_bin/build.zig", .{});
104	cases.addBuildFile("test/standalone/issue_12588/build.zig", .{});	104	cases.addBuildFile("test/standalone/issue_12588/build.zig", .{});
		105	cases.addBuildFile("test/standalone/embed_generated_file/build.zig", .{});
105	}	106	}

test/standalone/embed_generated_file/bootloader.zig created+1

...	@@ -0,0 +1 @@
1	pub export fn _start() void {}

test/standalone/embed_generated_file/build.zig created+28

...	@@ -0,0 +1,28 @@
1	const std = @import("std");
2
3	pub fn build(b: *std.Build) void {
4	const target = b.standardTargetOptions(.{});
5	const optimize = b.standardOptimizeOption(.{});
6
7	const bootloader = b.addExecutable(.{
8	.name = "bootloader",
9	.root_source_file = .{ .path = "bootloader.zig" },
10	.target = .{
11	.cpu_arch = .x86,
12	.os_tag = .freestanding,
13	},
14	.optimize = .ReleaseSmall,
15	});
16
17	const exe = b.addTest(.{
18	.root_source_file = .{ .path = "main.zig" },
19	.target = target,
20	.optimize = optimize,
21	});
22	exe.addAnonymousModule("bootloader.elf", .{
23	.source_file = bootloader.getOutputSource(),
24	});
25
26	const test_step = b.step("test", "Test the program");
27	test_step.dependOn(&exe.step);
28	}

test/standalone/embed_generated_file/main.zig created+8

...	@@ -0,0 +1,8 @@
1	const std = @import("std");
2	const blah = @embedFile("bootloader.elf");
3
4	test {
5	comptime {
6	std.debug.assert(std.mem.eql(u8, blah[1..][0..3], "ELF"));
7	}
8	}