zig-list: new list (fifo) implementation in Zig

zig-list/.gitignore

@@ -0,0 +1,2 @@
+zig-cache
+zig-out

zig-list/build.zig

@@ -0,0 +1,70 @@
+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 exe = b.addExecutable(.{
+        .name = "zig-list",
+        // 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 = .{ .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 unit_tests = b.addTest(.{
+        .root_source_file = .{ .path = "src/main.zig" },
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const run_unit_tests = b.addRunArtifact(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_unit_tests.step);
+}

zig-list/src/main.zig

@@ -0,0 +1,106 @@
+const std = @import("std");
+
+fn Queue(comptime T: type) type {
+    const QueueNode = struct {
+        const Self = @This();
+        value: T,
+        next: ?*Self,
+    };
+
+    return struct {
+        const Self = @This();
+        head: ?*QueueNode,
+        tail: ?*QueueNode,
+        alloc: std.mem.Allocator,
+
+        fn new(alloc: std.mem.Allocator) Self {
+            return .{
+                .alloc = alloc,
+                .head = null,
+                .tail = null,
+            };
+        }
+
+        fn enqueue(self: *Self, value: T) !void {
+            var node = try self.alloc.create(QueueNode);
+            node.value = value;
+            node.next = null;
+
+            if (self.head == null) {
+                self.head = node;
+                self.tail = node;
+            }
+
+            if (self.tail) |t_node| {
+                var next = t_node;
+                next.next = node;
+            }
+            self.tail = node;
+        }
+
+        fn dequeue(self: *Self) ?T {
+            if (self.head) |t_head| {
+                self.head = t_head.next;
+                var value = t_head.value;
+                self.alloc.destroy(t_head);
+                return value;
+            }
+            return null;
+        }
+
+        fn print(self: *Self) void {
+            var curr = self.head;
+            std.log.info("queue", .{});
+
+            while (curr) |node| {
+                std.log.info("-> {d}", .{node.value});
+                curr = node.next;
+            }
+        }
+    };
+}
+
+const IntQueue = Queue(i32);
+
+pub fn main() !void {
+    var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
+    defer arena.deinit();
+
+    const allocator = arena.allocator();
+
+    var q = IntQueue.new(allocator);
+    try q.enqueue(32);
+    try q.enqueue(45);
+    try q.enqueue(33);
+    q.print();
+    std.log.info("-----", .{});
+
+    var x = q.dequeue();
+    _ = x;
+    q.print();
+}
+
+test "filled queue" {
+    var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
+    defer arena.deinit();
+
+    const allocator = arena.allocator();
+
+    var q = IntQueue.new(allocator);
+    try q.enqueue(20);
+    try q.enqueue(30);
+    if (q.dequeue()) |value| {
+        try std.testing.expect(value == 20);
+    }
+}
+
+test "empty queue" {
+    var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
+    defer arena.deinit();
+
+    const allocator = arena.allocator();
+
+    var q = IntQueue.new(allocator);
+    var x = q.dequeue();
+    try std.testing.expect(x == null);
+}