Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor(build.zig): examples can be run independently & sysaudio exmples renamed as tests #1296

Merged
merged 1 commit into from
Oct 30, 2024
Merged

refactor(build.zig): examples can be run independently & sysaudio exmples renamed as tests #1296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 85 additions & 65 deletions build.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,54 @@ pub fn build(b: *std.Build) !void {
build_options.addOption(SysgpuBackend, "sysgpu_backend", sysgpu_backend);
build_options.addOption(Platform, "core_platform", core_platform);

var examples = [_]Example{
.{ .name = "core-custom-entrypoint", .deps = &.{} },
.{ .name = "core-triangle", .deps = &.{} },
.{ .name = "custom-renderer", .deps = &.{} },
.{ .name = "glyphs", .deps = &.{ .assets, .freetype } },
// .{ .name = "hardware-check", .deps = &.{ .assets, .zigimg } },
.{ .name = "piano", .deps = &.{} },
.{ .name = "play-opus", .deps = &.{.assets} },
// .{ .name = "sprite", .deps = &.{ .zigimg, .assets } },
.{ .name = "text", .deps = &.{.assets} },
};

var sysaudio_tests = [_]SysAudioTest{
.{ .name = "record" },
.{ .name = "sine" },
};

// Setup Steps
const docs_step = b.step("docs", "Generate docs");
for (&examples) |*example| {
example.run_step = b.step(
b.fmt("run-{s}", .{example.name}),
b.fmt("Run example: {s}", .{example.name}),
);
}
const test_step = b.step("test", "Test Run: Unit Tests");
for (&sysaudio_tests) |*sysaudio_test| {
sysaudio_test.run_step = b.step(
b.fmt("test-sysaudio-{s}", .{sysaudio_test.name}),
b.fmt("Test Run: sysaudio {s}", .{sysaudio_test.name}),
);
}

const module = b.addModule("mach", .{
.root_source_file = b.path("src/main.zig"),
.optimize = optimize,
.target = target,
});
module.addImport("build-options", build_options.createModule());

buildExamples(
b,
optimize,
target,
module,
&examples,
);

if (want_mach) {
// Linux gamemode requires libc.
if (target.result.os.tag == .linux) module.link_libc = true;
Expand All @@ -98,7 +139,9 @@ pub fn build(b: *std.Build) !void {
}
if (b.lazyDependency("font_assets", .{})) |dep| module.addImport("font-assets", dep.module("font-assets"));

if (want_examples) try buildExamples(b, optimize, target, module);
if (want_examples) {
for (examples) |example| b.getInstallStep().dependOn(example.install_step);
}
}
if (want_core) {
if (target.result.os.tag == .linux) {
Expand All @@ -117,30 +160,19 @@ pub fn build(b: *std.Build) !void {
});
}
if (target.result.cpu.arch != .wasm32) {
if (want_examples) {
// TODO(build): make these 'tests' not 'examples'
inline for ([_][]const u8{
"sine",
"record",
}) |example| {
const example_exe = b.addExecutable(.{
.name = "sysaudio-" ++ example,
.root_source_file = b.path("src/sysaudio/examples/" ++ example ++ ".zig"),
.target = target,
.optimize = optimize,
});
example_exe.root_module.addImport("mach", module);

const example_compile_step = b.step("sysaudio-" ++ example, "Compile 'sysaudio-" ++ example ++ "' example");
example_compile_step.dependOn(b.getInstallStep());

const example_run_cmd = b.addRunArtifact(example_exe);
example_run_cmd.step.dependOn(b.getInstallStep());
if (b.args) |args| example_run_cmd.addArgs(args);

const example_run_step = b.step("run-sysaudio-" ++ example, "Run '" ++ example ++ "' example");
example_run_step.dependOn(&example_run_cmd.step);
}
for (&sysaudio_tests) |*sysaudio_test| {
const test_exe = b.addExecutable(.{
.name = b.fmt("sysaudio-{s}", .{sysaudio_test.name}),
.root_source_file = b.path(b.fmt("src/sysaudio/tests/{s}.zig", .{sysaudio_test.name})),
.target = target,
.optimize = optimize,
});
test_exe.root_module.addImport("mach", module);

const run_cmd = b.addRunArtifact(test_exe);
if (b.args) |args| run_cmd.addArgs(args);

sysaudio_test.run_step.dependOn(&run_cmd.step);
}
}
}
Expand Down Expand Up @@ -189,7 +221,6 @@ pub fn build(b: *std.Build) !void {
// Exposes a `test` step to the `zig build --help` menu, providing a way for the user to
// request running the unit tests.
const run_unit_tests = b.addRunArtifact(unit_tests);
const test_step = b.step("test", "Run unit tests");
test_step.dependOn(&run_unit_tests.step);

if (want_sysgpu) linkSysgpu(b, &unit_tests.root_module);
Expand All @@ -210,7 +241,6 @@ pub fn build(b: *std.Build) !void {
.install_dir = .prefix,
.install_subdir = "docs",
});
const docs_step = b.step("docs", "Generate docs");
docs_step.dependOn(&install_docs.step);
}
}
Expand Down Expand Up @@ -346,48 +376,35 @@ fn linkSysaudio(b: *std.Build, module: *std.Build.Module) void {
}
}

const Dependency = enum {
assets,
freetype,
zigimg,
};

const Example = struct {
name: []const u8,
deps: []const Dependency = &.{},

install_step: *std.Build.Step = undefined,
run_step: *std.Build.Step = undefined,
};

fn buildExamples(
b: *std.Build,
optimize: std.builtin.OptimizeMode,
target: std.Build.ResolvedTarget,
mach_mod: *std.Build.Module,
) !void {
const Dependency = enum {
assets,
freetype,
zigimg,
};

for ([_]struct {
core: bool = false,
name: []const u8,
deps: []const Dependency = &.{},
has_assets: bool = false,
}{
// Mach core examples
.{ .core = true, .name = "custom-entrypoint", .deps = &.{} },
.{ .core = true, .name = "triangle", .deps = &.{} },

// Mach engine examples
// .{ .name = "hardware-check", .deps = &.{ .assets, .zigimg } },
.{ .name = "custom-renderer", .deps = &.{} },
.{ .name = "glyphs", .deps = &.{ .freetype, .assets } },
.{ .name = "piano", .deps = &.{} },
.{ .name = "play-opus", .deps = &.{.assets} },
// .{ .name = "sprite", .deps = &.{ .zigimg, .assets } },
.{ .name = "text", .deps = &.{.assets} },
}) |example| {
examples: []Example,
) void {
for (examples) |*example| {
const exe = b.addExecutable(.{
.name = if (example.core) b.fmt("core-{s}", .{example.name}) else example.name,
.root_source_file = if (example.core)
b.path(b.fmt("examples/core/{s}/main.zig", .{example.name}))
else
b.path(b.fmt("examples/{s}/main.zig", .{example.name})),
.name = example.name,
.root_source_file = b.path(b.fmt("examples/{s}/main.zig", .{example.name})),
.target = target,
.optimize = optimize,
});
exe.root_module.addImport("mach", mach_mod);
b.installArtifact(exe);

for (example.deps) |d| {
switch (d) {
Expand All @@ -412,18 +429,21 @@ fn buildExamples(
}
}

const compile_step = b.step(example.name, b.fmt("Compile {s}", .{example.name}));
compile_step.dependOn(b.getInstallStep());

const run_cmd = b.addRunArtifact(exe);
run_cmd.step.dependOn(b.getInstallStep());
if (b.args) |args| run_cmd.addArgs(args);

const run_step = b.step(b.fmt("run-{s}", .{example.name}), b.fmt("Run {s}", .{example.name}));
run_step.dependOn(&run_cmd.step);
const installArtifact = b.addInstallArtifact(exe, .{});
example.install_step = &installArtifact.step;
run_cmd.step.dependOn(&installArtifact.step);
example.run_step.dependOn(&run_cmd.step);
}
}

const SysAudioTest = struct {
name: []const u8,
run_step: *std.Build.Step = undefined,
};

comptime {
const supported_zig = std.SemanticVersion.parse("0.14.0-dev.1911+3bf89f55c") catch unreachable;
if (builtin.zig_version.order(supported_zig) != .eq) {
Expand Down
0 examples/core/custom-entrypoint/App.zig → examples/core-custom-entrypoint/App.zig
View file
Open in desktop
File renamed without changes.
0 examples/core/custom-entrypoint/main.zig → examples/core-custom-entrypoint/main.zig
View file
Open in desktop
File renamed without changes.
0 examples/core/custom-entrypoint/shader.wgsl → examples/core-custom-entrypoint/shader.wgsl
View file
Open in desktop
File renamed without changes.
0 examples/core/triangle/App.zig → examples/core-triangle/App.zig
View file
Open in desktop
File renamed without changes.
0 examples/core/triangle/main.zig → examples/core-triangle/main.zig
View file
Open in desktop
File renamed without changes.
0 examples/core/triangle/shader.wgsl → examples/core-triangle/shader.wgsl
View file
Open in desktop
File renamed without changes.
0 src/sysaudio/examples/record.zig → src/sysaudio/tests/record.zig
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion src/sysaudio/examples/sine.zig → src/sysaudio/tests/sine.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ pub fn main() !void {
while (true) {
std.debug.print("( paused = {}, volume = {d} )\n> ", .{ player.paused(), try player.volume() });
const line = (try std.io.getStdIn().reader().readUntilDelimiterOrEof(&buf, '\n')) orelse break;
var iter = std.mem.split(u8, line, ":");
var iter = std.mem.splitScalar(u8, line, ':');
const cmd = std.mem.trimRight(u8, iter.first(), &std.ascii.whitespace);
if (std.mem.eql(u8, cmd, "vol")) {
const vol = try std.fmt.parseFloat(f32, std.mem.trim(u8, iter.next().?, &std.ascii.whitespace));
Expand Down
Loading