WIP: Editor and runner

Author: OndraVoves

.github/workflows/test.yaml

@@ -98,13 +98,13 @@ jobs:
       #   uses: pyvista/setup-headless-display-action@v2
 
       - name: Test headless standalone
-        run: zig-out/bin/cetech1 --headless --max-kernel-tick 5
+        run: zig-out/bin/cetech1_editor --headless --max-kernel-tick 5
 
       - name: Test headless standalone with asset root
-        run: zig-out/bin/cetech1 --headless --max-kernel-tick 5 --asset-root fixtures/test_asset/
+        run: zig-out/bin/cetech1_editor --headless --max-kernel-tick 5 --asset-root fixtures/test_asset/
 
       - name: Test UI headless 
-        run: zig-out/bin/cetech1 --headless --test-ui --test-ui-junit ./result.xml
+        run: zig-out/bin/cetech1_editor --headless --test-ui --test-ui-junit ./result.xml
 
       - name: Publish Test Report
         uses: mikepenz/action-junit-report@v4
@@ -150,13 +150,13 @@ jobs:
         #run: kcov --include-pattern=/cetech1/src/,/cetech/public/ kcov-output zig-out/bin/cetech1_test
 
       - name: Test headless standalone
-        run: zig-out/bin/cetech1 --headless --max-kernel-tick 5 
+        run: zig-out/bin/cetech1_editor --headless --max-kernel-tick 5 
 
       - name: Test headless standalone with asset root
-        run: zig-out/bin/cetech1 --headless --max-kernel-tick 5 --asset-root fixtures/test_asset/
+        run: zig-out/bin/cetech1_editor --headless --max-kernel-tick 5 --asset-root fixtures/test_asset/
 
       - name: Test UI headless 
-        run: zig-out/bin/cetech1 --headless --test-ui --test-ui-junit ./result.xml
+        run: zig-out/bin/cetech1_editor --headless --test-ui --test-ui-junit ./result.xml
 
       - name: Publish Test Report
         uses: mikepenz/action-junit-report@v4
@@ -206,15 +206,15 @@ jobs:
       # FIXME: Windows
       - name: Test headless standalone
         shell: bash
-        run: zig-out/bin/cetech1 --headless --max-kernel-tick 5
+        run: zig-out/bin/cetech1_editor --headless --max-kernel-tick 5
 
       - name: Test headless standalone with asset root
         shell: bash
-        run: zig-out/bin/cetech1 --headless --max-kernel-tick 5 --asset-root fixtures/test_asset/
+        run: zig-out/bin/cetech1_editor --headless --max-kernel-tick 5 --asset-root fixtures/test_asset/
 
       - name: Test UI headless 
         shell: bash
-        run: zig-out/bin/cetech1 --headless --test-ui --test-ui-junit ./result.xml
+        run: zig-out/bin/cetech1_editor --headless --test-ui --test-ui-junit ./result.xml
 
       - name: Publish Test Report
         uses: mikepenz/action-junit-report@v4

build.zig

@@ -119,13 +119,16 @@ pub fn updateCectechStep(
 pub fn createKernelExe(
     b: *std.Build,
     comptime bin_name: []const u8,
+    comptime run_name: []const u8,
+    comptime run_description: []const u8,
     runner_main: std.Build.LazyPath,
     cetech1_kernel: *std.Build.Module,
     cetech1_kernel_lib: *std.Build.Step.Compile,
     versionn: std.SemanticVersion,
+    static_modules: []const []const u8,
     target: std.Build.ResolvedTarget,
     optimize: std.builtin.OptimizeMode,
-) *std.Build.Step.Compile {
+) !*std.Build.Step.Compile {
     const exe = b.addExecutable(.{
         .name = bin_name,
         .version = versionn,
@@ -141,11 +144,63 @@ pub fn createKernelExe(
     exe.linkLibrary(cetech1_kernel_lib);
     b.installArtifact(exe);
     useSystemSDK(b, target, exe);
-    createRunStep(b, exe, "run", "Run Forest run");
-
+    createRunStep(b, exe, run_name, run_description);
+    try linkStaticModules(b, exe, target, optimize, static_modules);
     return exe;
 }
 
+pub fn createEditorExe(
+    b: *std.Build,
+    comptime base_bin_name: []const u8,
+    root_source: std.Build.LazyPath,
+    cetech1_kernel: *std.Build.Module,
+    cetech1_kernel_lib: *std.Build.Step.Compile,
+    versionn: std.SemanticVersion,
+    static_modules: []const []const u8,
+    target: std.Build.ResolvedTarget,
+    optimize: std.builtin.OptimizeMode,
+) !*std.Build.Step.Compile {
+    return try createKernelExe(
+        b,
+        base_bin_name ++ "_editor",
+        "editor",
+        "Run editor",
+        root_source,
+        cetech1_kernel,
+        cetech1_kernel_lib,
+        versionn,
+        static_modules,
+        target,
+        optimize,
+    );
+}
+
+pub fn createRunnerExe(
+    b: *std.Build,
+    comptime base_bin_name: []const u8,
+    root_source: std.Build.LazyPath,
+    cetech1_kernel: *std.Build.Module,
+    cetech1_kernel_lib: *std.Build.Step.Compile,
+    versionn: std.SemanticVersion,
+    static_modules: []const []const u8,
+    target: std.Build.ResolvedTarget,
+    optimize: std.builtin.OptimizeMode,
+) !*std.Build.Step.Compile {
+    return try createKernelExe(
+        b,
+        base_bin_name,
+        "run",
+        "Run Forest Run!",
+        root_source,
+        cetech1_kernel,
+        cetech1_kernel_lib,
+        versionn,
+        static_modules,
+        target,
+        optimize,
+    );
+}
+
 pub fn build(b: *std.Build) !void {
     try ensureZigVersion();
 
@@ -317,6 +372,10 @@ pub fn build(b: *std.Build) !void {
 
     // Modules
     const ModulesSet = std.StringArrayHashMapUnmanaged(void);
+
+    var internal_modules = std.ArrayListUnmanaged([]const u8){};
+    defer internal_modules.deinit(b.allocator);
+
     var module_set = ModulesSet{};
     defer module_set.deinit(b.allocator);
     for (all_modules) |module| {
@@ -403,7 +462,7 @@ pub fn build(b: *std.Build) !void {
         gen_ide.addArgs(&.{ "--ide", @tagName(options.ide) });
 
         gen_ide.addArg("--bin-path");
-        gen_ide.addDirectoryArg(b.path("zig-out/bin/cetech1"));
+        gen_ide.addDirectoryArg(b.path("zig-out/bin/cetech1_editor"));
 
         gen_ide.addArg("--project-path");
         gen_ide.addDirectoryArg(b.path(""));
@@ -446,6 +505,9 @@ pub fn build(b: *std.Build) !void {
     var buff: [256:0]u8 = undefined;
     for (dynamic_modules.keys()) |m| {
         const artifact_name = try std.fmt.bufPrintZ(&buff, "ct_{s}", .{m});
+
+        if (!module_set.contains(m)) continue;
+
         const art = b.lazyDependency(m, .{
             .target = target,
             .optimize = optimize,
@@ -526,21 +588,36 @@ pub fn build(b: *std.Build) !void {
     });
 
     //
-    // CETech1 kernel standalone exe
+    // CETech1 editor standalone exe
+    //
+    const editor_exe = try createEditorExe(
+        b,
+        "cetech1",
+        b.path("src/editor/editor.zig"),
+        kernel_module,
+        kernel_lib,
+        cetech1_version,
+        static_modules.keys(),
+        target,
+        optimize,
+    );
+    editor_exe.step.dependOn(&generated_files.step);
+
+    //
+    // CETech1 runner standalone exe
     //
-    const exe = createKernelExe(
+    const runner_exe = try createRunnerExe(
         b,
         "cetech1",
-        b.path("src/main.zig"),
+        b.path("src/runner/runner.zig"),
         kernel_module,
         kernel_lib,
         cetech1_version,
+        static_modules.keys(),
         target,
         optimize,
     );
-    try linkStaticModules(b, exe, target, optimize, static_modules.keys());
-    // Make exe depends on generated files.
-    exe.step.dependOn(&generated_files.step);
+    runner_exe.step.dependOn(&generated_files.step);
 
     //
     // CETech1 kernel standalone tests
@@ -557,17 +634,17 @@ pub fn build(b: *std.Build) !void {
     });
     useSystemSDK(b, target, tests);
     b.installArtifact(tests);
+    try linkStaticModules(b, tests, target, optimize, static_modules.keys());
     tests.linkLibC();
     tests.linkLibrary(kernel_lib);
     tests.step.dependOn(&generated_files.step);
-    try linkStaticModules(b, tests, target, optimize, static_modules.keys());
 
     const run_unit_tests = b.addRunArtifact(tests);
     run_unit_tests.step.dependOn(b.getInstallStep());
     const test_step = b.step("test", "Run unit tests");
     test_step.dependOn(&run_unit_tests.step);
 
-    const run_tests_ui = b.addRunArtifact(exe);
+    const run_tests_ui = b.addRunArtifact(editor_exe);
     run_tests_ui.addArgs(&.{ "--test-ui", "--headless" });
     run_tests_ui.step.dependOn(b.getInstallStep());
     const testui_step = b.step("test-ui", "Run UI headless test");

docs/snippets/getting-started/run.sh

@@ -1 +1 @@
-zig-out/bin/cetech1_test && zig-out/bin/cetech1 --asset-root fixtures/test_asset/
+zig-out/bin/cetech1_test && zig-out/bin/cetech1_editor --asset-root fixtures/test_asset/

docs/snippets/getting-started/run_steamdeck.sh

@@ -1,5 +1,5 @@
 # Desktop mode
-zig-out/bin/cetech1_test && zig-out/bin/cetech1 --asset-root fixtures/test_asset/
+zig-out/bin/cetech1_test && zig-out/bin/cetech1_editor --asset-root fixtures/test_asset/
 
 # Standalone
-zig-out/bin/cetech1 --fullscreen --asset-root fixtures/test_asset/
+zig-out/bin/cetech1_editor --fullscreen --asset-root fixtures/test_asset/

docs/snippets/getting-started/run_windows.sh

@@ -1 +1 @@
-zig-out/bin/cetech1_test.exe && zig-out/bin/cetech1.exe --asset-root fixtures/test_asset/
+zig-out/bin/cetech1_test.exe && zig-out/bin/cetech1_editor.exe --asset-root fixtures/test_asset/

docs/topics/getting-started.md

@@ -152,15 +152,15 @@ CETech1 has builtin support for tracy profiler and provide Tracy as submodule, b
     <tab title="MacOS">
         <code-block lang="bash">
             profiler/build/tracy-profiler -a localhost
-            zig-out/bin/cetech1 # on separate terminal
+            zig-out/bin/cetech1_editor # on separate terminal
             # Have fun
         </code-block>
     </tab>
     <tab title="Linux">
         <code-block lang="bash">
             # install tracy by your way
             profiler/build/tracy-profiler -a localhost
-            zig-out/bin/cetech1 # on separate terminal
+            zig-out/bin/cetech1_editor # on separate terminal
             # Have fun
         </code-block>
     </tab>

src/main.zig src/editor/editor.zigsrc/main.zig renamed to src/editor/editor.zig

@@ -10,6 +10,12 @@ pub const std_options = std.Options{
 
 pub fn main() anyerror!u8 {
     const descs = kernel.static_module.descs;
-    try kernel.kernel.boot(&descs, .{});
+    try kernel.kernel.boot(
+        &descs,
+        .{
+            .ignored_modules = &.{"runner"},
+            .ignored_modules_prefix = &.{"runner_"},
+        },
+    );
     return 0;
 }

src/kernel.zig

@@ -45,6 +45,8 @@ const BootArgs = struct {
     max_kernel_tick: u32 = 0,
     headless: bool = false,
     load_dynamic: bool = true,
+    ignored_modules: ?[]const []const u8 = null,
+    ignored_modules_prefix: ?[]const []const u8 = null,
 };
 
 const Phase = struct {
@@ -185,7 +187,7 @@ fn setCanQuit(can_quit: *const fn () bool) void {
     can_quit_handler = can_quit;
 }
 
-pub fn init(allocator: std.mem.Allocator, headless: bool) !void {
+pub fn init(allocator: std.mem.Allocator, headless: bool, boot_args: BootArgs) !void {
     _root_allocator = allocator;
     _main_profiler_allocator = profiler.AllocatorProfiler.init(&profiler_private.api, allocator, null);
     _kernel_allocator = _main_profiler_allocator.allocator();
@@ -223,7 +225,7 @@ pub fn init(allocator: std.mem.Allocator, headless: bool) !void {
     try tempalloc.init(_tmp_alocator_pool_allocator.allocator(), 256);
 
     try apidb.init(_apidb_allocator.allocator());
-    try modules.init(_modules_allocator.allocator());
+    try modules.init(_modules_allocator.allocator(), boot_args.ignored_modules, boot_args.ignored_modules_prefix);
     try metrics.init(_metrics_allocator.allocator());
     try task.init(_task_allocator.allocator());
     try cdb_private.init(_cdb_allocator.allocator());
@@ -453,7 +455,7 @@ pub fn boot(static_modules: []const cetech1.modules.ModuleDesc, boot_args: BootA
         const renderer_profile = 1 == getIntArgs("--renderer-profile") orelse @intFromBool(is_debug);
 
         // Init Kernel
-        try init(gpa_allocator, _headless);
+        try init(gpa_allocator, _headless, boot_args);
         defer deinit(gpa_allocator) catch undefined;
 
         // Test args