dicer

dicer: Dice roll app
Log | Files | Refs | README

commit bce43c205fe30dff37dc83045cd8ef05dd71b27f
Author: Martin Ashby <martin@ashbysoft.com>
Date:   Fri,  9 Aug 2024 22:08:46 +0100

Initial

Diffstat:
A.gitignore | 2++
Abuild.zig | 91+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Abuild.zig.zon | 11+++++++++++
Asrc/main.zig | 40++++++++++++++++++++++++++++++++++++++++
Asrc/root.zig | 10++++++++++
5 files changed, 154 insertions(+), 0 deletions(-)

diff --git a/.gitignore b/.gitignore @@ -0,0 +1,2 @@ +.zig-cache +zig-out diff --git a/build.zig b/build.zig @@ -0,0 +1,91 @@ +const std = @import("std"); + +// Although this function looks imperative, note that its job is to +// declaratively construct a build graph that will be executed by an external +// runner. +pub fn build(b: *std.Build) void { + // Standard target options allows the person running `zig build` to choose + // what target to build for. Here we do not override the defaults, which + // means any target is allowed, and the default is native. Other options + // for restricting supported target set are available. + const target = b.standardTargetOptions(.{}); + + // Standard optimization options allow the person running `zig build` to select + // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not + // set a preferred release mode, allowing the user to decide how to optimize. + const optimize = b.standardOptimizeOption(.{}); + + const lib = b.addStaticLibrary(.{ + .name = "dicer", + // In this case the main source file is merely a path, however, in more + // complicated build scripts, this could be a generated file. + .root_source_file = b.path("src/root.zig"), + .target = target, + .optimize = optimize, + }); + + // This declares intent for the library to be installed into the standard + // location when the user invokes the "install" step (the default step when + // running `zig build`). + b.installArtifact(lib); + + const exe = b.addExecutable(.{ + .name = "dicer", + .root_source_file = b.path("src/main.zig"), + .target = target, + .optimize = optimize, + }); + + // This declares intent for the executable to be installed into the + // standard location when the user invokes the "install" step (the default + // step when running `zig build`). + b.installArtifact(exe); + + // This *creates* a Run step in the build graph, to be executed when another + // step is evaluated that depends on it. The next line below will establish + // such a dependency. + const run_cmd = b.addRunArtifact(exe); + + // By making the run step depend on the install step, it will be run from the + // installation directory rather than directly from within the cache directory. + // This is not necessary, however, if the application depends on other installed + // files, this ensures they will be present and in the expected location. + run_cmd.step.dependOn(b.getInstallStep()); + + // This allows the user to pass arguments to the application in the build + // command itself, like this: `zig build run -- arg1 arg2 etc` + if (b.args) |args| { + run_cmd.addArgs(args); + } + + // This creates a build step. It will be visible in the `zig build --help` menu, + // and can be selected like this: `zig build run` + // This will evaluate the `run` step rather than the default, which is "install". + const run_step = b.step("run", "Run the app"); + run_step.dependOn(&run_cmd.step); + + // Creates a step for unit testing. This only builds the test executable + // but does not run it. + const lib_unit_tests = b.addTest(.{ + .root_source_file = b.path("src/root.zig"), + .target = target, + .optimize = optimize, + }); + + const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests); + + const exe_unit_tests = b.addTest(.{ + .root_source_file = b.path("src/main.zig"), + .target = target, + .optimize = optimize, + }); + + const run_exe_unit_tests = b.addRunArtifact(exe_unit_tests); + + // Similar to creating the run step earlier, this exposes a `test` step to + // the `zig build --help` menu, providing a way for the user to request + // running the unit tests. + const test_step = b.step("test", "Run unit tests"); + test_step.dependOn(&run_lib_unit_tests.step); + test_step.dependOn(&run_exe_unit_tests.step); +} diff --git a/build.zig.zon b/build.zig.zon @@ -0,0 +1,11 @@ +.{ + .name = "dicer", + .version = "0.0.1", + .minimum_zig_version = "0.13.0", + .dependencies = .{}, + .paths = .{ + "build.zig", + "build.zig.zon", + "src", + }, +} diff --git a/src/main.zig b/src/main.zig @@ -0,0 +1,40 @@ +const std = @import("std"); + +const usage = + \\Usage: + \\ dicer XdY + \\ + \\Rolls X dice with Y + \\ +; + +pub fn main() !void { + var args = std.process.args(); + _ = args.skip(); // program name + const dice_str = args.next() orelse { + try printUsage(); + return; + }; + + var spl = std.mem.splitScalar(u8, dice_str, 'd'); + const count = try std.fmt.parseInt(u64, spl.first(), 10); + const sides = try std.fmt.parseInt(u64, spl.next() orelse "6", 10); + var wtr = std.io.getStdOut().writer(); + try wtr.writeAll("Dice roll: "); + var total: u64 = 0; + for (0..count) |_| { + const res = roll(sides); + try std.fmt.format(wtr, "{} ", .{res}); + total += res; + } + try std.fmt.format(wtr, " total: {}", .{total}); + try wtr.writeByte('\n'); +} + +fn roll(dsize: u64) u64 { + return (std.crypto.random.int(u64) % dsize) + 1; +} + +fn printUsage() !void { + try std.fmt.format(std.io.getStdOut(), usage, .{}); +} diff --git a/src/root.zig b/src/root.zig @@ -0,0 +1,10 @@ +const std = @import("std"); +const testing = std.testing; + +export fn add(a: i32, b: i32) i32 { + return a + b; +} + +test "basic add functionality" { + try testing.expect(add(3, 7) == 10); +}