Regz Wizard: UI to explore generated code (#596)

Author: mattnite

.github/workflows/tools-regz-wizard.yml

@@ -0,0 +1,30 @@
+name: tools/regz-wizard
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Zig
+        uses: mlugg/setup-zig@v2
+        with:
+          version: 0.14.1
+
+      - name: Build
+        working-directory: tools/regz-wizard
+        run: zig build
+
+      - name: Run Test Suite
+        working-directory: tools/regz-wizard
+        run: zig build test

tools/regz-wizard/build.zig

@@ -0,0 +1,59 @@
+const std = @import("std");
+
+pub fn build(b: *std.Build) void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+
+    const dvui_dep = b.dependency("dvui", .{
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const regz_dep = b.dependency("regz", .{
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const regz_mod = regz_dep.module("regz");
+    const dvui_mod = dvui_dep.module("dvui_sdl3");
+
+    const exe_mod = b.createModule(.{
+        .root_source_file = b.path("src/main.zig"),
+        .target = target,
+        .optimize = optimize,
+        .imports = &.{
+            .{
+                .name = "regz",
+                .module = regz_mod,
+            },
+            .{
+                .name = "dvui",
+                .module = dvui_mod,
+            },
+        },
+    });
+
+    const exe = b.addExecutable(.{
+        .name = "regz_wizard",
+        .root_module = exe_mod,
+    });
+    b.installArtifact(exe);
+
+    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("run", "Run the app");
+    run_step.dependOn(&run_cmd.step);
+
+    const exe_unit_tests = b.addTest(.{
+        .root_module = exe_mod,
+    });
+
+    const run_exe_unit_tests = b.addRunArtifact(exe_unit_tests);
+    const test_step = b.step("test", "Run unit tests");
+    test_step.dependOn(&run_exe_unit_tests.step);
+}

tools/regz-wizard/build.zig.zon

@@ -0,0 +1,19 @@
+.{
+    .name = .tools_regzwizard,
+    .version = "0.0.0",
+    .fingerprint = 0xe9f2d03f97400569,
+    .minimum_zig_version = "0.14.1",
+    .dependencies = .{
+        .regz = .{ .path = "../regz" },
+        .dvui = .{
+            .url = "git+https://github.com/david-vanderson/dvui.git#2fd3c7fcd700ea9c0fd96d217d6ff878ba0d02d7",
+            .hash = "dvui-0.2.0-AQFJmTOVzgAbOn4QEgiYY-6CISQ25dLcsTsmYBWpSteB",
+        },
+    },
+    .paths = .{
+        "README.md",
+        "build.zig",
+        "build.zig.zon",
+        "src",
+    },
+}

tools/regz-wizard/src/VirtualFilesystem.zig

@@ -0,0 +1,43 @@
+//! Filesystem to store generated files
+gpa: Allocator,
+map: std.StringArrayHashMapUnmanaged([]const u8) = .{},
+
+const std = @import("std");
+const Allocator = std.mem.Allocator;
+
+const regz = @import("regz");
+const Directory = regz.Database.Directory;
+
+const VirtualFilesystem = @This();
+
+pub fn init(gpa: Allocator) VirtualFilesystem {
+    return VirtualFilesystem{
+        .gpa = gpa,
+    };
+}
+
+pub fn deinit(fs: *VirtualFilesystem) void {
+    for (fs.map.keys(), fs.map.values()) |path, content| {
+        fs.gpa.free(path);
+        fs.gpa.free(content);
+    }
+
+    fs.map.deinit(fs.gpa);
+}
+
+pub fn dir(fs: *VirtualFilesystem) Directory {
+    return Directory{
+        .ptr = @ptrCast(fs),
+        .vtable = &.{
+            .create_file = create_file,
+        },
+    };
+}
+
+fn create_file(ctx: *anyopaque, path: []const u8, content: []const u8) Directory.CreateFileError!void {
+    const fs: *VirtualFilesystem = @alignCast(@ptrCast(ctx));
+    const path_copy = try fs.gpa.dupe(u8, path);
+    const content_copy = try fs.gpa.dupe(u8, content);
+    // TODO: clean up collisions
+    try fs.map.put(fs.gpa, path_copy, content_copy);
+}

tools/regz-wizard/src/Virtual_FS.zig

@@ -0,0 +1,141 @@
+const std = @import("std");
+const regz = @import("regz");
+const dvui = @import("dvui");
+const VirtualFilesystem = @import("VirtualFilesystem.zig");
+
+const window_icon_png = @embedFile("zig-favicon.png");
+
+pub const dvui_app: dvui.App = .{
+    .config = .{
+        .options = .{
+            .size = .{ .w = 800.0, .h = 600.0 },
+            .min_size = .{ .w = 250.0, .h = 350.0 },
+            .title = "Regz Wizard",
+            .icon = window_icon_png,
+        },
+    },
+    .frameFn = frame,
+    .initFn = init,
+    .deinitFn = deinit,
+};
+
+pub const main = dvui.App.main;
+pub const panic = dvui.App.panic;
+pub const std_options: std.Options = .{
+    .logFn = dvui.App.logFn,
+};
+
+var db: ?*regz.Database = null;
+var debug_allocator: std.heap.DebugAllocator(.{}) = .init;
+const gpa = debug_allocator.allocator();
+var vfs: VirtualFilesystem = undefined;
+var current_gen_file: usize = 0;
+
+pub fn init(win: *dvui.Window) void {
+    _ = win;
+    vfs = .init(gpa);
+}
+
+// Run as app is shutting down before dvui.Window.deinit()
+pub fn deinit() void {
+    if (db) |d| d.destroy();
+    vfs.deinit();
+    _ = debug_allocator.deinit();
+}
+
+// TODO: add mechanism to open a file, this creates a brand new db instance.
+// - Some sort of menu bar
+// - File -> Drop down
+
+// Run each frame to do normal UI
+pub fn frame() !dvui.App.Result {
+    var scaler = try dvui.scale(@src(), .{ .scale = &dvui.currentWindow().content_scale, .pinch_zoom = .global }, .{ .rect = .cast(dvui.windowRect()) });
+    scaler.deinit();
+
+    var scroll = try dvui.scrollArea(@src(), .{}, .{ .expand = .both, .color_fill = .fill_window });
+    defer scroll.deinit();
+
+    var vbox = try dvui.box(@src(), .vertical, .{ .expand = .both, .margin = .{ .x = 4 } });
+    defer vbox.deinit();
+
+    {
+        var m = try dvui.menu(@src(), .horizontal, .{});
+        defer m.deinit();
+
+        if (try dvui.menuItemLabel(@src(), "File", .{ .submenu = true }, .{ .expand = .horizontal })) |r| {
+            var fw = try dvui.floatingMenu(@src(), .{ .from = r }, .{});
+            defer fw.deinit();
+
+            if (try dvui.menuItemLabel(@src(), "Open", .{}, .{}) != null) blk: {
+                defer fw.close();
+                const filename = try dvui.dialogNativeFileOpen(dvui.currentWindow().arena(), .{ .title = "dvui native file open", .filters = &.{ "*.svd", "*.atdf" }, .filter_description = "images" });
+                if (filename) |f| {
+                    const ext = std.fs.path.extension(f);
+                    const format: regz.Database.Format = if (std.mem.eql(u8, ext, ".svd"))
+                        .svd
+                    else if (std.mem.eql(u8, ext, ".atdf"))
+                        .atdf
+                    else
+                        break :blk;
+
+                    if (db) |d| d.destroy();
+
+                    vfs.deinit();
+                    vfs = .init(gpa);
+
+                    db = try regz.Database.create_from_path(gpa, format, f);
+                    try db.?.to_zig(vfs.dir(), .{ .for_microzig = true });
+                }
+            }
+
+            if (try dvui.menuItemLabel(@src(), "Exit", .{}, .{})) |_| {
+                return .close;
+            }
+        }
+
+        if (db != null) if (try dvui.menuItemLabel(@src(), "Edit", .{ .submenu = true }, .{ .expand = .horizontal })) |r| {
+            var fw = try dvui.floatingMenu(@src(), .{ .from = r }, .{});
+            defer fw.deinit();
+
+            if (try dvui.menuItemLabel(@src(), "Apply Patches", .{}, .{})) |_| {
+                defer fw.close();
+
+                const filename = try dvui.dialogNativeFileOpen(dvui.currentWindow().arena(), .{ .title = "dvui native file open", .filters = &.{"*.json"}, .filter_description = "images" });
+                _ = filename;
+            }
+        };
+
+        if (try dvui.menuItemLabel(@src(), "View", .{ .submenu = true }, .{ .expand = .horizontal })) |r| {
+            var fw = try dvui.floatingMenu(@src(), .{ .from = r }, .{});
+            defer fw.deinit();
+
+            if (try dvui.menuItemLabel(@src(), "Demo Window", .{}, .{})) |_| {
+                dvui.Examples.show_demo_window = true;
+                fw.close();
+            }
+        }
+    }
+
+    // look at demo() for examples of dvui widgets, shows in a floating window
+    try dvui.Examples.demo();
+
+    if (db != null) {
+        const entries = vfs.map.keys();
+        _ = try dvui.dropdown(@src(), entries, &current_gen_file, .{});
+
+        const current = entries[current_gen_file];
+
+        var font = dvui.themeGet().font_body;
+        font.name = "VeraMono";
+
+        var tl = dvui.TextLayoutWidget.init(@src(), .{}, .{ .expand = .horizontal, .font = font });
+        try tl.install(.{});
+        defer tl.deinit();
+
+        try tl.addText(vfs.map.get(current).?, .{
+            .font = font,
+        });
+    }
+
+    return .ok;
+}

tools/regz-wizard/src/main.zig

@@ -16,7 +16,7 @@ const gen = @import("gen.zig");
 const Patch = @import("patch.zig").Patch;
 const SQL_Options = @import("SQL_Options.zig");
 const Arch = @import("arch.zig").Arch;
-const Directory = @import("Directory.zig");
+pub const Directory = @import("Directory.zig");
 
 const log = std.log.scoped(.db);
 const file_size_max = 100 * 1024 * 1024;

tools/regz-wizard/src/zig-favicon.png

@@ -8,11 +8,7 @@ pub const VTable = struct {
 pub const CreateFileError = error{
     TODO,
     System,
-};
-
-pub const CreateDirectoryError = error{
-    TODO,
-    System,
+    OutOfMemory,
 };
 
 pub inline fn create_file(d: Directory, filename: []const u8, content: []const u8) CreateFileError!void {

tools/regz/src/Database.zig

@@ -11,6 +11,10 @@ a:hover {
   text-decoration: underline;
 }
 
+image {
+    max-width: 100%;
+}
+
 .upper-header {
     display: flex;
     flex-direction: row;