break core and clap into different packages

bandithedoge · bandithedoge · commit 23cc76179a48 · 2025-11-17T13:04:22.000+01:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -17,7 +17,9 @@ jobs:
         uses: mlugg/setup-zig@v2
 
       - name: Build docs
-        run: zig build docs -Dclap
+        run: |
+          cd docs
+          zig build
 
       - name: Setup Pages
         uses: actions/configure-pages@v5
diff --git a/build.zig b/build.zig
@@ -4,127 +4,44 @@ pub fn build(b: *std.Build) !void {
     const target = b.standardTargetOptions(.{});
     const optimize = b.standardOptimizeOption(.{});
 
-    const options = .{
-        .clap = b.option(bool, "clap", "Build CLAP target") orelse false,
-    };
-
-    const options_step = b.addOptions();
-    inline for (std.meta.fields(@TypeOf(options))) |field| {
-        options_step.addOption(field.type, field.name, @field(options, field.name));
-    }
-    const options_module = options_step.createModule();
-
-    const zigplug = b.addModule("zigplug", .{
-        .root_source_file = b.path("src/zigplug/zigplug.zig"),
+    const core_dep = b.dependency("core", .{
         .target = target,
         .optimize = optimize,
-        .imports = &.{
-            .{ .name = "zigplug_options", .module = options_module },
-        },
     });
 
+    try b.modules.put("zigplug", core_dep.module("zigplug"));
+
     const test_step = b.step("test", "Run unit tests");
-    const tests = b.addTest(.{
-        .root_module = zigplug,
-    });
-    const run_tests = b.addRunArtifact(tests);
-    test_step.dependOn(&run_tests.step);
 
-    const docs_step = b.step("docs", "Build documentation");
-    const check = b.step("check", "Check compile errors");
+    const core_tests = b.addSystemCommand(&.{ "zig", "build", "test" });
+    core_tests.setCwd(b.path("src/core"));
+    test_step.dependOn(&core_tests.step);
 
-    const lib = b.addLibrary(.{
-        .name = "zigplug",
-        .root_module = zigplug,
-    });
+    const clap_tests = b.addSystemCommand(&.{ "zig", "build", "test" });
+    clap_tests.setCwd(b.path("src/clap"));
+    test_step.dependOn(&clap_tests.step);
+}
 
-    var docs_src = std.ArrayList(u8).empty;
-    try docs_src.appendSlice(b.allocator,
-        \\comptime {@import("std").testing.refAllDeclsRecursive(@This());}
-        \\
-        \\pub const zigplug = @import("zigplug");
-        \\
-    );
-    const docs_module = b.createModule(.{
+pub fn clapModule(b: *std.Build, target: std.Build.ResolvedTarget, optimize: std.builtin.OptimizeMode) *std.Build.Module {
+    const dep = b.dependencyFromBuildZig(@This(), .{
         .target = target,
         .optimize = optimize,
-        .imports = &.{.{ .name = "zigplug", .module = zigplug }},
     });
 
-    check.dependOn(&lib.step);
-
-    if (options.clap) {
-        const clap_module = b.addModule("clap", .{
-            .target = target,
-            .optimize = optimize,
-            .root_source_file = b.path("src/clap/root.zig"),
-            .imports = &.{
-                .{ .name = "zigplug", .module = zigplug },
-                .{ .name = "zigplug_options", .module = options_module },
-            },
-        });
-        clap_module.addImport("clap", clap_module);
-
-        if (b.lazyDependency("clap", .{})) |clap_dep| {
-            const clap_c = b.addTranslateC(.{
-                .root_source_file = clap_dep.path("include/clap/clap.h"),
-                .target = target,
-                .optimize = optimize,
-            });
-            clap_module.addAnonymousImport("clap_c", .{
-                .root_source_file = clap_c.getOutput(),
-            });
-        }
-
-        if (b.lazyDependency("msgpack", .{
-            .target = target,
-            .optimize = optimize,
-        })) |msgpack|
-            clap_module.addImport("msgpack", msgpack.module("msgpack"));
-
-        const clap_tests = b.addTest(.{ .root_module = clap_module });
-        const run_clap_tests = b.addRunArtifact(clap_tests);
-        test_step.dependOn(&run_clap_tests.step);
-
-        const clap_lib = b.addLibrary(.{
-            .name = "zigplug_clap",
-            .root_module = clap_module,
-        });
-
-        check.dependOn(&clap_lib.step);
-
-        docs_module.addImport("clap", clap_module);
-        try docs_src.appendSlice(b.allocator,
-            \\ pub const clap = @import("clap");
-            \\
-        );
-    }
-
-    docs_module.root_source_file =
-        b.addWriteFile("docs.zig", try docs_src.toOwnedSlice(b.allocator))
-            .getDirectory()
-            .path(b, "docs.zig");
-
-    const docs = b.addLibrary(.{
-        .name = "zigplug-docs",
-        .root_module = docs_module,
-    });
+    if (dep.builder.lazyDependency("clap", .{
+        .target = target,
+        .optimize = optimize,
+    })) |clap_dep|
+        return clap_dep.module("clap");
 
-    const install_docs = b.addInstallDirectory(.{
-        .source_dir = docs.getEmittedDocs(),
-        .install_dir = .prefix,
-        .install_subdir = "docs",
-    });
-    docs_step.dependOn(&install_docs.step);
+    unreachable;
 }
 
 pub const Options = struct {
     /// Doesn't have to match the display name in your plugin's descriptor
     name: []const u8,
     /// Module that contains `plugin()`
     root_module: *std.Build.Module,
-    /// Must be the same dependency your plugin imports the "zigplug" module from
-    zigplug_dep: *std.Build.Dependency,
     /// Whether to add the resulting compile step to your project's top level install step
     install: bool = true,
 };
@@ -135,18 +52,21 @@ pub fn addClap(b: *std.Build, options: Options) !*std.Build.Step.Compile {
         \\ export const clap_entry = @import("clap").clapEntry(@import("plugin_root"));
     );
 
+    const target = options.root_module.resolved_target.?;
+    const optimize = options.root_module.optimize.?;
+
     const lib = b.addLibrary(.{
         .name = try std.fmt.allocPrint(b.allocator, "{s}_clap", .{options.name}),
         .linkage = .dynamic,
         // printing to stdout/stderr segfaults without this, possibly a bug in zig's new x86 backend
         .use_llvm = true,
         .root_module = b.createModule(.{
-            .target = options.root_module.resolved_target,
-            .optimize = options.root_module.optimize,
+            .target = target,
+            .optimize = optimize,
             .root_source_file = entry.getDirectory().path(b, "entry.zig"),
             .imports = &.{
                 .{ .name = "plugin_root", .module = options.root_module },
-                .{ .name = "clap", .module = options.zigplug_dep.module("clap") },
+                .{ .name = "clap", .module = clapModule(b, target, optimize) },
             },
         }),
     });
diff --git a/build.zig.zon b/build.zig.zon
@@ -5,19 +5,13 @@
     .minimum_zig_version = "0.15.1",
 
     .dependencies = .{
+        .core = .{ .path = "src/core" },
         .clap = .{
-            .url = "https://github.com/free-audio/clap/archive/refs/tags/1.2.6.tar.gz",
-            .hash = "N-V-__8AABAqOwDxKlwerqbiBlg183KUY751DdoGwZ9N-ZuE",
-            .lazy = true,
-        },
-        .msgpack = .{
-            .url = "https://github.com/zigcc/zig-msgpack/archive/refs/tags/0.0.16.tar.gz",
-            .hash = "zig_msgpack-0.0.14-evvueHImBQA5zzdD7c4Sl9yJ4JECWb4JaWgvbInsk7Zt",
+            .path = "src/clap",
             .lazy = true,
         },
     },
     .paths = .{
-        "src",
         "build.zig",
         "build.zig.zon",
         "LICENSE",
diff --git a/docs/build.zig b/docs/build.zig
@@ -0,0 +1,37 @@
+const std = @import("std");
+
+pub fn build(b: *std.Build) !void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+
+    const core = b.dependency("core", .{
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const clap = b.dependency("clap", .{
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const module = b.createModule(.{
+        .target = target,
+        .optimize = optimize,
+        .root_source_file = b.path("root.zig"),
+        .imports = &.{
+            .{ .name = "zigplug", .module = core.module("zigplug") },
+            .{ .name = "clap", .module = clap.module("clap") },
+        },
+    });
+
+    const lib = b.addLibrary(.{
+        .name = "zigplug_docs",
+        .root_module = module,
+    });
+
+    b.installDirectory(.{
+        .source_dir = lib.getEmittedDocs(),
+        .install_dir = .prefix,
+        .install_subdir = "docs",
+    });
+}
diff --git a/docs/build.zig.zon b/docs/build.zig.zon
@@ -0,0 +1,13 @@
+.{
+    .name = .zigplug_docs,
+    .fingerprint = 0xbb1c02b09e857611,
+    .version = "0.0.0",
+    .minimum_zig_version = "0.15.1",
+
+    .dependencies = .{
+        .core = .{ .path = "../src/core" },
+        .clap = .{ .path = "../src/clap" },
+    },
+
+    .paths = .{""},
+}
diff --git a/docs/root.zig b/docs/root.zig
@@ -0,0 +1,2 @@
+pub const zigplug = @import("zigplug");
+pub const clap = @import("clap");
diff --git a/examples/clap-ext/build.zig b/examples/clap-ext/build.zig
@@ -6,7 +6,8 @@ pub fn build(b: *std.Build) !void {
     const optimize = b.standardOptimizeOption(.{});
 
     const zigplug_dep = b.dependency("zigplug", .{
-        .clap = true,
+        .target = target,
+        .optimize = optimize,
     });
 
     const plugin = b.createModule(.{
@@ -15,13 +16,12 @@ pub fn build(b: *std.Build) !void {
         .root_source_file = b.path("src/Plugin.zig"),
         .imports = &.{
             .{ .name = "zigplug", .module = zigplug_dep.module("zigplug") },
-            .{ .name = "zigplug_clap", .module = zigplug_dep.module("clap") },
+            .{ .name = "zigplug_clap", .module = zigplug.clapModule(b, target, optimize) },
         },
     });
 
     _ = try zigplug.addClap(b, .{
         .name = "clap-ext",
         .root_module = plugin,
-        .zigplug_dep = zigplug_dep,
     });
 }
diff --git a/examples/gain/build.zig b/examples/gain/build.zig
@@ -6,7 +6,8 @@ pub fn build(b: *std.Build) !void {
     const optimize = b.standardOptimizeOption(.{});
 
     const zigplug_dep = b.dependency("zigplug", .{
-        .clap = true,
+        .target = target,
+        .optimize = optimize,
     });
 
     const plugin = b.createModule(.{
@@ -15,13 +16,12 @@ pub fn build(b: *std.Build) !void {
         .root_source_file = b.path("src/Plugin.zig"),
         .imports = &.{
             .{ .name = "zigplug", .module = zigplug_dep.module("zigplug") },
-            .{ .name = "zigplug_clap", .module = zigplug_dep.module("clap") },
+            .{ .name = "zigplug_clap", .module = zigplug.clapModule(b, target, optimize) },
         },
     });
 
     _ = try zigplug.addClap(b, .{
         .name = "gain",
         .root_module = plugin,
-        .zigplug_dep = zigplug_dep,
     });
 }
diff --git a/examples/sine/build.zig b/examples/sine/build.zig
@@ -6,7 +6,8 @@ pub fn build(b: *std.Build) !void {
     const optimize = b.standardOptimizeOption(.{});
 
     const zigplug_dep = b.dependency("zigplug", .{
-        .clap = true,
+        .target = target,
+        .optimize = optimize,
     });
 
     const plugin = b.createModule(.{
@@ -15,13 +16,12 @@ pub fn build(b: *std.Build) !void {
         .root_source_file = b.path("src/Plugin.zig"),
         .imports = &.{
             .{ .name = "zigplug", .module = zigplug_dep.module("zigplug") },
-            .{ .name = "zigplug_clap", .module = zigplug_dep.module("clap") },
+            .{ .name = "zigplug_clap", .module = zigplug.clapModule(b, target, optimize) },
         },
     });
 
     _ = try zigplug.addClap(b, .{
         .name = "sine",
         .root_module = plugin,
-        .zigplug_dep = zigplug_dep,
     });
 }
diff --git a/src/clap/build.zig b/src/clap/build.zig
@@ -0,0 +1,52 @@
+const std = @import("std");
+
+pub fn build(b: *std.Build) !void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+
+    const root = b.dependency("zigplug", .{
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const clap_dep = b.dependency("clap_c", .{});
+
+    const clap_c = b.addTranslateC(.{
+        .root_source_file = clap_dep.path("include/clap/clap.h"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const msgpack = b.dependency("msgpack", .{
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const module = b.addModule("clap", .{
+        .target = target,
+        .optimize = optimize,
+        .root_source_file = b.path("root.zig"),
+        .imports = &.{
+            .{ .name = "zigplug", .module = root.module("zigplug") },
+            .{ .name = "clap_c", .module = clap_c.createModule() },
+            .{ .name = "msgpack", .module = msgpack.module("msgpack") },
+        },
+    });
+
+    module.addImport("clap", module);
+
+    const test_step = b.step("test", "Run unit tests");
+    const tests = b.addTest(.{ .root_module = module });
+    const run_tests = b.addRunArtifact(tests);
+    test_step.dependOn(&run_tests.step);
+
+    const lib = b.addLibrary(.{
+        .name = "zigplug_clap",
+        .root_module = module,
+    });
+
+    b.addNamedLazyPath("docs", lib.getEmittedDocs());
+
+    const check = b.step("check", "Check compile errors");
+    check.dependOn(&lib.step);
+}
diff --git a/src/clap/build.zig.zon b/src/clap/build.zig.zon
diff --git a/src/clap/extensions/state.zig b/src/clap/extensions/state.zig
diff --git a/src/core/build.zig b/src/core/build.zig
diff --git a/src/core/parameters.zig b/src/core/parameters.zig
diff --git a/src/core/root.zig b/src/core/root.zig

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+pub const zigplug = @import("zigplug");`
	`2`	`+pub const clap = @import("clap");`