Initial commit

.gitignore

@@ -0,0 +1,4 @@
+/.zig-cache/
+/.idea/
+/zig-out/
+/zig-pkg/

build.zig

@@ -0,0 +1,171 @@
+const std = @import("std");
+
+// Although this function looks imperative, it does not perform the build
+// directly and instead it mutates the build graph (`b`) that will be then
+// executed by an external runner. The functions in `std.Build` implement a DSL
+// for defining build steps and express dependencies between them, allowing the
+// build runner to parallelize the build automatically (and the cache system to
+// know when a step doesn't need to be re-run).
+pub fn build(b: *std.Build) void {
+    // Standard target options allow 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(.{});
+    // It's also possible to define more custom flags to toggle optional features
+    // of this build script using `b.option()`. All defined flags (including
+    // target and optimize options) will be listed when running `zig build --help`
+    // in this directory.
+
+    // This creates a module, which represents a collection of source files alongside
+    // some compilation options, such as optimization mode and linked system libraries.
+    // Zig modules are the preferred way of making Zig code available to consumers.
+    // addModule defines a module that we intend to make available for importing
+    // to our consumers. We must give it a name because a Zig package can expose
+    // multiple modules and consumers will need to be able to specify which
+    // module they want to access.
+    // const mod = b.addModule("base_road_network", .{
+    //     // The root source file is the "entry point" of this module. Users of
+    //     // this module will only be able to access public declarations contained
+    //     // in this file, which means that if you have declarations that you
+    //     // intend to expose to consumers that were defined in other files part
+    //     // of this module, you will have to make sure to re-export them from
+    //     // the root file.
+    //     .root_source_file = b.path("src/root.zig"),
+    //     // Later on we'll use this module as the root module of a test executable
+    //     // which requires us to specify a target.
+    //     .target = target,
+    // });
+
+    // Necessary dependancies and imports for Raylib
+
+    const raylib_dep = b.dependency("raylib_zig", .{
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const raylib = raylib_dep.module("raylib");
+    const raylib_artifact = raylib_dep.artifact("raylib");
+
+    // Here we define an executable. An executable needs to have a root module
+    // which needs to expose a `main` function. While we could add a main function
+    // to the module defined above, it's sometimes preferable to split business
+    // logic and the CLI into two separate modules.
+    //
+    // If your goal is to create a Zig library for others to use, consider if
+    // it might benefit from also exposing a CLI tool. A parser library for a
+    // data serialization format could also bundle a CLI syntax checker, for example.
+    //
+    // If instead your goal is to create an executable, consider if users might
+    // be interested in also being able to embed the core functionality of your
+    // program in their own executable in order to avoid the overhead involved in
+    // subprocessing your CLI tool.
+    //
+    // If neither case applies to you, feel free to delete the declaration you
+    // don't need and to put everything under a single module.
+    const exe = b.addExecutable(.{
+        .name = "base_road_network",
+        .root_module = b.createModule(.{
+            // b.createModule defines a new module just like b.addModule but,
+            // unlike b.addModule, it does not expose the module to consumers of
+            // this package, which is why in this case we don't have to give it a name.
+            .root_source_file = b.path("src/main.zig"),
+            // Target and optimization levels must be explicitly wired in when
+            // defining an executable or library (in the root module), and you
+            // can also hardcode a specific target for an executable or library
+            // definition if desireable (e.g. firmware for embedded devices).
+            .target = target,
+            .optimize = optimize,
+            // List of modules available for import in source files part of the
+            // root module.
+            .imports = &.{
+                // Here "base_road_network" is the name you will use in your source code to
+                // import this module (e.g. `@import("base_road_network")`). The name is
+                // repeated because you are allowed to rename your imports, which
+                // can be extremely useful in case of collisions (which can happen
+                // importing modules from different packages).
+                // .{ .name = "base_road_network", .module = mod },
+
+                // Raylib import
+                .{ .name = "raylib", .module = raylib },
+            },
+        }),
+    });
+
+    exe.root_module.linkLibrary(raylib_artifact);
+
+    // This declares intent for the executable to be installed into the
+    // install prefix when running `zig build` (i.e. when executing the default
+    // step). By default the install prefix is `zig-out/` but can be overridden
+    // by passing `--prefix` or `-p`.
+    b.installArtifact(exe);
+
+    // This creates a top level step. Top level steps have a name and can be
+    // invoked by name when running `zig build` (e.g. `zig build run`).
+    // This will evaluate the `run` step rather than the default step.
+    // For a top level step to actually do something, it must depend on other
+    // steps (e.g. a Run step, as we will see in a moment).
+    const run_step = b.step("run", "Run the app");
+
+    // This creates a RunArtifact step in the build graph. A RunArtifact step
+    // invokes an executable compiled by Zig. Steps will only be executed by the
+    // runner if invoked directly by the user (in the case of top level steps)
+    // or if another step depends on it, so it's up to you to define when and
+    // how this Run step will be executed. In our case we want to run it when
+    // the user runs `zig build run`, so we create a dependency link.
+    const run_cmd = b.addRunArtifact(exe);
+    run_step.dependOn(&run_cmd.step);
+
+    // By making the run step depend on the default step, it will be run from the
+    // installation directory rather than directly from within the cache directory.
+    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);
+    }
+
+    // Creates an executable that will run `test` blocks from the provided module.
+    // Here `mod` needs to define a target, which is why earlier we made sure to
+    // set the releative field.
+    // const mod_tests = b.addTest(.{
+    //     .root_module = mod,
+    // });
+
+    // A run step that will run the test executable.
+    // const run_mod_tests = b.addRunArtifact(mod_tests);
+
+    // Creates an executable that will run `test` blocks from the executable's
+    // root module. Note that test executables only test one module at a time,
+    // hence why we have to create two separate ones.
+    const exe_tests = b.addTest(.{
+        .root_module = exe.root_module,
+    });
+
+    // A run step that will run the second test executable.
+    const run_exe_tests = b.addRunArtifact(exe_tests);
+
+    // A top level step for running all tests. dependOn can be called multiple
+    // times and since the two run steps do not depend on one another, this will
+    // make the two of them run in parallel.
+    const test_step = b.step("test", "Run tests");
+    // test_step.dependOn(&run_mod_tests.step);
+    test_step.dependOn(&run_exe_tests.step);
+
+    // Just like flags, top level steps are also listed in the `--help` menu.
+    //
+    // The Zig build system is entirely implemented in userland, which means
+    // that it cannot hook into private compiler APIs. All compilation work
+    // orchestrated by the build system will result in other Zig compiler
+    // subcommands being invoked with the right flags defined. You can observe
+    // these invocations when one fails (or you pass a flag to increase
+    // verbosity) to validate assumptions and diagnose problems.
+    //
+    // Lastly, the Zig build system is relatively simple and self-contained,
+    // and reading its source code will allow you to master it.
+}

build.zig.zon

@@ -0,0 +1,48 @@
+.{
+    // This is the default name used by packages depending on this one. For
+    // example, when a user runs `zig fetch --save <url>`, this field is used
+    // as the key in the `dependencies` table. Although the user can choose a
+    // different name, most users will stick with this provided value.
+    //
+    // It is redundant to include "zig" in this name because it is already
+    // within the Zig package namespace.
+    .name = .base_road_network,
+    // This is a [Semantic Version](https://semver.org/).
+    // In a future version of Zig it will be used for package deduplication.
+    .version = "0.0.0",
+    // Together with name, this represents a globally unique package
+    // identifier. This field is generated by the Zig toolchain when the
+    // package is first created, and then *never changes*. This allows
+    // unambiguous detection of one package being an updated version of
+    // another.
+    //
+    // When forking a Zig project, this id should be regenerated (delete the
+    // field and run `zig build`) if the upstream project is still maintained.
+    // Otherwise, the fork is *hostile*, attempting to take control over the
+    // original project's identity. Thus it is recommended to leave the comment
+    // on the following line intact, so that it shows up in code reviews that
+    // modify the field.
+    .fingerprint = 0x8da3e26c9def0629, // Changing this has security and trust implications.
+    // Tracks the earliest Zig version that the package considers to be a
+    // supported use case.
+    .minimum_zig_version = "0.16.0",
+    // This field is optional.
+    // Each dependency must either provide a `url` and `hash`, or a `path`.
+    // `zig build --fetch` can be used to fetch all dependencies of a package, recursively.
+    // Once all dependencies are fetched, `zig build` no longer requires
+    // internet connectivity.
+    .dependencies = .{
+        .raylib_zig = .{
+            .url = "git+https://github.com/raylib-zig/raylib-zig?ref=devel#58f3c0fa328fc9ff48d17c2c3771ab9c5114aaa6",
+            .hash = "raylib_zig-6.0.0-KE8REMNkBQCpxwqT9ubVNf5aEOcWRUVIaH2sgt_sDDoZ",
+        },
+    },
+    .paths = .{
+        "build.zig",
+        "build.zig.zon",
+        "src",
+        // For example...
+        //"LICENSE",
+        //"README.md",
+    },
+}

src/constants.zig

@@ -0,0 +1,12 @@
+const clr = @import("raylib").Color;
+
+pub const WIDTH = 2560;
+pub const HEIGHT = 1440;
+
+pub const NODE_RADIUS = 20;
+pub const NODE_COLOUR = clr.brown;
+pub const NODE_TEMP_COLOUR = clr.orange;
+pub const NODE_CURSOR_COLOUR = clr.blue;
+
+pub const ROAD_SIZE = 20;
+pub const ROAD_COLOUR = clr.black;

src/infrastructure/node.zig

@@ -0,0 +1,21 @@
+const rl = @import("raylib");
+
+const c = @import("../constants.zig");
+
+pub const Node = struct {
+    id: usize,
+    pos: rl.Vector2,
+
+    pub fn init(new_id: usize, new_pos: rl.Vector2) Node {
+        return .{
+            .id = new_id,
+            .pos = new_pos,
+        };
+    }
+
+    pub fn draw(self: *const Node, direct_colour: ?rl.Color) void {
+        const colour = if (direct_colour) |clr| clr else c.NODE_COLOUR;
+
+        rl.drawCircleV(self.pos, c.NODE_RADIUS, colour);
+    }
+};

src/infrastructure/node_manager.zig

@@ -0,0 +1,39 @@
+const std = @import("std");
+const Vector2 = @import("raylib").Vector2;
+
+const c = @import("../constants.zig");
+const Node = @import("node.zig").Node;
+const Road = @import("road.zig").Road;
+
+pub const NodeManager = struct {
+    nodes: std.ArrayList(Node),
+    temp_node: ?*Node,
+
+    pub fn init() NodeManager {
+        return .{
+            .nodes = .empty,
+            .temp_node = null,
+        };
+    }
+
+    pub fn deinit(self: *NodeManager, allocator: std.mem.Allocator) void {
+        self.nodes.deinit(allocator);
+    }
+
+    pub fn draw(self: *const NodeManager, pos: Vector2) void {
+        for (self.nodes.items) |node| {
+            node.draw();
+        }
+
+        if (self.temp_node) |node| {
+            // Temporary node that points at the cursor
+            const cur_node = Node.init(0, pos);
+            // Temporary road that is to be drawn as one in the making
+            const road: Road = .init(0, node, &cur_node);
+            road.draw();
+
+            node.*.draw(c.NODE_TEMP_COLOUR);
+            cur_node.draw(c.NODE_CURSOR_COLOUR);
+        }
+    }
+};

src/infrastructure/road.zig

@@ -0,0 +1,40 @@
+const rl = @import("raylib");
+
+const c = @import("../constants.zig");
+const Node = @import("node.zig").Node;
+
+pub const Road = struct {
+    /// Road ID, used for identification, particularly as we'll access all entities via pointers
+    id: usize,
+    /// Pointers to the nodes that encapsulated our road
+    nodes: [2]*Node,
+    /// Calculated road length
+    length: f32,
+
+    pub fn init(new_id: usize, start: *Node, end: *Node) Road {
+        var road: Road = .{
+            .id = new_id,
+            .nodes = .{start, end},
+            .length = 0,
+        };
+
+        road.length = road.calculate_length();
+        return road;
+    }
+
+    /// Calculates length of the road by taking its two nodes
+    fn calculate_length(self: *const Road) f32 {
+        const start = self.nodes[0];
+        const end = self.nodes[1];
+
+        const x_diff = end.*.pos.x - start.*.pos.x;
+        const y_diff = end.*.pos.y - start.*.pos.y;
+        const square_diff = x_diff * x_diff + y_diff * y_diff;
+
+        return @sqrt(square_diff);
+    }
+
+    pub fn draw(self: *const Road) void {
+        rl.drawLineEx(self.nodes[0].*.pos, self.nodes[1].*.pos, c.ROAD_SIZE, c.ROAD_COLOUR);
+    }
+};

src/infrastructure/road_manager.zig

@@ -0,0 +1,22 @@
+const std = @import("std");
+const Road = @import("road.zig").Road;
+
+pub const RoadManager = struct {
+    roads: std.ArrayList(Road),
+
+    pub fn init() RoadManager {
+        return .{
+            .roads = .empty,
+        };
+    }
+
+    pub fn deinit(self: *RoadManager, allocator: std.mem.Allocator) void {
+        self.roads.deinit(allocator);
+    }
+
+    pub fn draw(self: *const RoadManager) void {
+        for (self.roads.items) |road| {
+            road.draw();
+        }
+    }
+};

src/main.zig

@@ -0,0 +1,23 @@
+const std = @import("std");
+const rl = @import("raylib");
+
+const c = @import("constants.zig");
+const Simulator = @import("simulator.zig").Simulator;
+
+pub fn main(init: std.process.Init) !void {
+    const allocator = init.gpa;
+    rl.initWindow(c.WIDTH, c.HEIGHT, "Base Road Network");
+    defer rl.closeWindow();
+
+    var sim: Simulator = .init(allocator);
+
+    while (!rl.windowShouldClose()) {
+        rl.beginDrawing();
+        defer rl.endDrawing();
+
+        const pos = rl.getMousePosition();
+        sim.handleInput(pos);
+
+        sim.draw(pos);
+    }
+}

src/simulator.zig

@@ -0,0 +1,43 @@
+const std = @import("std");
+const rl = @import("raylib");
+
+const NodeManager = @import("infrastructure/node_manager.zig").NodeManager;
+const RoadManager = @import("infrastructure/road_manager.zig").RoadManager;
+
+pub const Simulator = struct {
+    allocator: std.mem.Allocator,
+    node_man: NodeManager,
+    road_man: RoadManager,
+
+    pub fn init(new_allocator: std.mem.Allocator) Simulator {
+        return .{
+            .allocator = new_allocator,
+            .node_man = .init(),
+            .road_man = .init(),
+        };
+    }
+
+    pub fn deinit(self: *Simulator) void {
+        self.road_man.deinit(self.allocator);
+        self.node_man.deinit(self.allocator);
+    }
+
+    pub fn draw(self: *const Simulator, pos: rl.Vector2) void {
+        rl.clearBackground(.light_gray);
+
+        self.road_man.draw();
+        self.node_man.draw(pos);
+    }
+
+    pub fn handleInput(self: *Simulator, pos: rl.Vector2) void {
+        self.handleMouseInput(pos);
+    }
+
+    fn handleMouseInput(self: *Simulator, pos: rl.Vector2) void {
+        if (rl.isMouseButtonReleased(.left)) self.leftClickEvent(pos);
+    }
+
+    fn leftClickEvent(self: *Simulator, pos: rl.Vector2) void {
+        // TODO
+    }
+};