Improve root build system; added string typedefs

Author: ACSimon33

2024/00/zig_template/build.zig.zon

@@ -1,7 +1,7 @@
 .{
     .name = "zig_template",
     .version = "0.1.0",
-    .minimum_zig_version = "0.11.0",
+    .minimum_zig_version = "0.13.0",
     .dependencies = .{
         .yazap = .{
             .url = "git+https://github.com/prajwalch/yazap#c2e3122d5dd6192513ba590f229dbc535110efb8",

2024/00/zig_template/src/main.zig

@@ -6,23 +6,27 @@ const allocator = std.heap.page_allocator;
 const log = std.log;
 const App = yazap.App;
 const Arg = yazap.Arg;
+const string = []const u8;
 
 pub fn main() !void {
     var app = App.init(allocator, "Day 00", "Day 00: Zig Template");
     defer app.deinit();
 
     var cmd = app.rootCommand();
     cmd.setProperty(.help_on_empty_args);
-    try cmd.addArg(Arg.singleValueOption("filename", 'f', "Input file (e.g. input/puzzle_input.txt)"));
+    try cmd.addArg(Arg.singleValueOption(
+        "filename",
+        'f',
+        "Input file (e.g. input/puzzle_input.txt)",
+    ));
 
     const matches = try app.parseProcess();
 
     const stdout_file = std.io.getStdOut().writer();
     var bw = std.io.bufferedWriter(stdout_file);
     const stdout = bw.writer();
 
-    var file_content: []u8 = &[_]u8{};
-
+    var file_content: string = undefined;
     if (matches.getSingleValue("filename")) |filename| {
         const file = try std.fs.cwd().openFile(filename, .{});
         defer file.close();

2024/00/zig_template/src/zig_template.zig

@@ -1,15 +1,16 @@
 const std = @import("std");
+const string = []const u8;
 
 /// Task 1
-pub fn solution_1(contents: []const u8) !i32 {
+pub fn solution_1(contents: string) !i32 {
     const lines = std.mem.split(u8, contents, "\n");
     _ = lines;
 
     return 0;
 }
 
 /// Task 2
-pub fn solution_2(contents: []const u8) !i32 {
+pub fn solution_2(contents: string) !i32 {
     const lines = std.mem.split(u8, contents, "\n");
     _ = lines;
 

2024/02/red_nosed_reports/build.zig.zon

@@ -1,7 +1,7 @@
 .{
     .name = "red_nosed_reports",
     .version = "0.1.0",
-    .minimum_zig_version = "0.11.0",
+    .minimum_zig_version = "0.13.0",
     .dependencies = .{
         .yazap = .{
             .url = "git+https://github.com/prajwalch/yazap#c2e3122d5dd6192513ba590f229dbc535110efb8",

2024/02/red_nosed_reports/src/main.zig

@@ -6,23 +6,27 @@ const allocator = std.heap.page_allocator;
 const log = std.log;
 const App = yazap.App;
 const Arg = yazap.Arg;
+const string = []const u8;
 
 pub fn main() !void {
     var app = App.init(allocator, "Day 02", "Day 02: red_nosed Reports");
     defer app.deinit();
 
     var cmd = app.rootCommand();
     cmd.setProperty(.help_on_empty_args);
-    try cmd.addArg(Arg.singleValueOption("filename", 'f', "Input file (e.g. input/puzzle_input.txt)"));
+    try cmd.addArg(Arg.singleValueOption(
+        "filename",
+        'f',
+        "Input file (e.g. input/puzzle_input.txt)",
+    ));
 
     const matches = try app.parseProcess();
 
     const stdout_file = std.io.getStdOut().writer();
     var bw = std.io.bufferedWriter(stdout_file);
     const stdout = bw.writer();
 
-    var file_content: []u8 = &[_]u8{};
-
+    var file_content: string = undefined;
     if (matches.getSingleValue("filename")) |filename| {
         const file = try std.fs.cwd().openFile(filename, .{});
         defer file.close();

2024/02/red_nosed_reports/src/red_nosed_reports.zig

@@ -1,6 +1,7 @@
 const std = @import("std");
 const ArrayList = std.ArrayList;
 const Allocator = std.mem.Allocator;
+const string = []const u8;
 
 const Report = struct {
     levels: ArrayList(i32),
@@ -13,7 +14,7 @@ const Report = struct {
 ///
 /// Returns:
 ///   - Number of fully safe reports.
-pub fn number_of_safe_reports(contents: []const u8) !i32 {
+pub fn number_of_safe_reports(contents: string) !i32 {
     var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
     defer arena.deinit();
 
@@ -38,7 +39,7 @@ pub fn number_of_safe_reports(contents: []const u8) !i32 {
 ///
 /// Returns:
 ///   - Number of fully safe reports.
-pub fn number_of_partially_safe_reports(contents: []const u8) !i32 {
+pub fn number_of_partially_safe_reports(contents: string) !i32 {
     var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
     defer arena.deinit();
 
@@ -67,7 +68,7 @@ pub fn number_of_partially_safe_reports(contents: []const u8) !i32 {
 ///
 /// Returns:
 ///   - Array list of report objects.
-fn parse_reports(contents: []const u8, allocator: Allocator) !ArrayList(Report) {
+fn parse_reports(contents: string, allocator: Allocator) !ArrayList(Report) {
     var reports = ArrayList(Report).init(allocator);
 
     var lines = std.mem.split(u8, contents, "\n");

2024/06/guard_gallivant/build.zig.zon

@@ -1,7 +1,7 @@
 .{
     .name = "guard_gallivant",
     .version = "0.1.0",
-    .minimum_zig_version = "0.11.0",
+    .minimum_zig_version = "0.13.0",
     .dependencies = .{
         .yazap = .{
             .url = "git+https://github.com/prajwalch/yazap#c2e3122d5dd6192513ba590f229dbc535110efb8",

2024/06/guard_gallivant/src/guard_gallivant.zig

@@ -1,17 +1,17 @@
 const std = @import("std");
 const HashMap = std.AutoArrayHashMap;
 const Allocator = std.mem.Allocator;
+const string = []const u8;
 
 /// Task 1
-pub fn solution_1(contents: []const u8) !usize {
+pub fn solution_1(contents: string) !usize {
     var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
     defer arena.deinit();
 
     const allocator = arena.allocator();
-    const setup = try parse_map(contents, allocator);
-    const map = setup[0];
-    var guard = setup[1];
+    const map, var guard = try parse_map(contents, allocator);
 
+    // Move the guard until it is outside the map and record all positions
     var visited = HashMap(Position, void).init(allocator);
     while (is_guard_inside(map, guard)) : (guard = move(map, guard)) {
         try visited.put(guard.pos, {});
@@ -21,36 +21,35 @@ pub fn solution_1(contents: []const u8) !usize {
 }
 
 /// Task 2
-pub fn solution_2(contents: []const u8) !usize {
+pub fn solution_2(contents: string) !usize {
     var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
     defer arena.deinit();
 
     const allocator = arena.allocator();
-    const setup = try parse_map(contents, allocator);
-    var map = setup[0];
-    var guard = setup[1];
+    var map, var guard = try parse_map(contents, allocator);
 
+    // Move the guard until it is outside the map and record all states
     var visited = HashMap(Guard, void).init(allocator);
     while (is_guard_inside(map, guard)) : (guard = move(map, guard)) {
         try visited.put(guard, {});
     }
 
-    var tried_obstacle = HashMap(Position, void).init(allocator);
-    try tried_obstacle.put(visited.keys()[0].pos, {});
+    var new_obstacles = HashMap(Position, void).init(allocator);
+    try new_obstacles.put(visited.keys()[0].pos, {});
     var loop_count: usize = 0;
+
+    // Put an obstacle into each unique position in the guards path and check
+    // wether the guard runs in a loop or exits the map
     for (0..visited.count()) |i| {
-        if (tried_obstacle.contains(visited.keys()[i].pos)) {
+        if (new_obstacles.contains(visited.keys()[i].pos)) {
             continue;
         }
-
         try map.obstacles.put(visited.keys()[i].pos, {});
 
+        // Let the guard start right in front of the new obstacle to save time
         guard = visited.keys()[i - 1];
-        var states = HashMap(Guard, void).init(
-            std.heap.page_allocator,
-        );
-        defer states.deinit();
 
+        var states = HashMap(Guard, void).init(allocator);
         while (is_guard_inside(map, guard)) : (guard = move(map, guard)) {
             if (states.contains(guard)) {
                 loop_count += 1;
@@ -60,7 +59,7 @@ pub fn solution_2(contents: []const u8) !usize {
         }
 
         _ = map.obstacles.pop();
-        try tried_obstacle.put(visited.keys()[i].pos, {});
+        try new_obstacles.put(visited.keys()[i].pos, {});
     }
 
     return loop_count;
@@ -131,7 +130,7 @@ pub fn is_guard_inside(map: GuardMap, guard: Guard) bool {
 ///
 /// Returns:
 ///   - Array list of report objects.
-fn parse_map(contents: []const u8, allocator: Allocator) !struct { GuardMap, Guard } {
+fn parse_map(contents: string, allocator: Allocator) !struct { GuardMap, Guard } {
     var obstacles = HashMap(Position, void).init(allocator);
     var dir: ?Direction = null;
     var pos: ?Position = null;

2024/06/guard_gallivant/src/main.zig

@@ -6,23 +6,27 @@ const allocator = std.heap.page_allocator;
 const log = std.log;
 const App = yazap.App;
 const Arg = yazap.Arg;
+const string = []const u8;
 
 pub fn main() !void {
     var app = App.init(allocator, "Day 06", "Day 06: Guard Gallivant");
     defer app.deinit();
 
     var cmd = app.rootCommand();
     cmd.setProperty(.help_on_empty_args);
-    try cmd.addArg(Arg.singleValueOption("filename", 'f', "Input file (e.g. input/puzzle_input.txt)"));
+    try cmd.addArg(Arg.singleValueOption(
+        "filename",
+        'f',
+        "Input file (e.g. input/puzzle_input.txt)",
+    ));
 
     const matches = try app.parseProcess();
 
     const stdout_file = std.io.getStdOut().writer();
     var bw = std.io.bufferedWriter(stdout_file);
     const stdout = bw.writer();
 
-    var file_content: []u8 = &[_]u8{};
-
+    var file_content: string = undefined;
     if (matches.getSingleValue("filename")) |filename| {
         const file = try std.fs.cwd().openFile(filename, .{});
         defer file.close();

2024/build.zig

@@ -1,27 +1,37 @@
 const std = @import("std");
+const string = []const u8;
+const ResolvedTarget = std.Build.ResolvedTarget;
+const OptimizeMode = std.builtin.OptimizeMode;
+const Step = std.Build.Step;
 
-pub fn build(b: *std.Build) void {
-    const target = b.standardTargetOptions(.{});
-    const optimize = b.standardOptimizeOption(.{});
-
-    // ---------------------------- Subprojects ----------------------------- \\
-    const day_00 = b.dependency("day_00_zig_template", .{
+/// Add a dependency for each day
+fn add_subproject(
+    b: *std.Build,
+    target: ResolvedTarget,
+    optimize: OptimizeMode,
+    test_step: *Step,
+    benchmark_step: *Step,
+    comptime day: string,
+    comptime name: string,
+) void {
+    const subproject = b.dependency("day_" ++ day ++ "_" ++ name, .{
         .target = target,
         .optimize = optimize,
     });
 
-    const day_02 = b.dependency("day_02_red_nosed_reports", .{
-        .target = target,
-        .optimize = optimize,
-    });
+    test_step.dependOn(&b.addRunArtifact(subproject.artifact(name ++ "_tests")).step);
+    benchmark_step.dependOn(&b.addRunArtifact(subproject.artifact(name ++ "_benchmarks")).step);
+}
 
-    // --------------------------- Example tests ---------------------------- \\
-    const test_step = b.step("test", "Run example tests");
-    test_step.dependOn(&b.addRunArtifact(day_00.artifact("zig_template_tests")).step);
-    test_step.dependOn(&b.addRunArtifact(day_02.artifact("red_nosed_reports_tests")).step);
+pub fn build(b: *std.Build) void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
 
-    // ------------------------- Puzzle benchmarks -------------------------- \\
+    const test_step = b.step("test", "Run example tests");
     const benchmark_step = b.step("benchmark", "Run puzzle benchmarks");
-    benchmark_step.dependOn(&b.addRunArtifact(day_00.artifact("zig_template_benchmarks")).step);
-    benchmark_step.dependOn(&b.addRunArtifact(day_02.artifact("red_nosed_reports_benchmarks")).step);
+
+    // ---------------------------- Subprojects ----------------------------- \\
+    add_subproject(b, target, optimize, test_step, benchmark_step, "00", "zig_template");
+    add_subproject(b, target, optimize, test_step, benchmark_step, "02", "red_nosed_reports");
+    add_subproject(b, target, optimize, test_step, benchmark_step, "06", "guard_gallivant");
 }