Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(emscripten): ensure EMSDK setup completes before WASM compilation #54

Merged
merged 8 commits into from
Feb 12, 2025
Merged

fix(emscripten): ensure EMSDK setup completes before WASM compilation #54

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0849049
try reorder imgui-build
kassane Feb 11, 2025
14324b0
imgui lib to obj
kassane Feb 11, 2025
afb2261
split libs
kassane Feb 11, 2025
20c628a
dub: link imgui in libsokol (shared)
kassane Feb 11, 2025
fff619c
Revert "dub: link imgui in libsokol (shared)"
kassane Feb 11, 2025
96a06db
dub: imgui samples - link static-libs
kassane Feb 11, 2025
379a543
dub: try run in windows
kassane Feb 11, 2025
98af083
Revert "dub: try run in windows"
kassane Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,21 @@ zig build --help
# -Dwayland=[bool] Force Wayland (default: false, Linux only, not supported in main-line headers)
# -Degl=[bool] Force EGL (default: false, Linux only)
# -Dimgui=[bool] Add support for sokol_imgui.h bindings
# -Dsokol_imgui_cprefix=[string] Override Dear ImGui C bindings prefix for sokol_imgui.h (see SOKOL_IMGUI_CPREFIX)
# -Dcimgui_header_path=[string] Override the Dear ImGui C bindings header name (default: cimgui.h)
# -Dimgui-version=[enum] Select ImGui version to use
# Supported Values:
# default
# docking
# -Dubsan=[bool] Enable undefined behavior sanitizer
# -Dtsan=[bool] Enable thread sanitizer
# -Dartifact=[bool] Build artifacts (default: false)
# -DbetterC=[bool] Omit generating some runtime information and helper functions (default: false)
# -DzigCC=[bool] Use zig cc as compiler and linker (default: false)
# -Dshaders=[bool] Build shaders (default: false)
# -Dtarget=[string] The CPU architecture, OS, and ABI to build for
# -Dcpu=[string] Target CPU features to add or subtract
# -Dofmt=[string] Target object format
kassane marked this conversation as resolved.
Show resolved Hide resolved
# -Ddynamic-linker=[string] Path to interpreter on the target system
# -Doptimize=[enum] Prioritize performance, safety, or binary size
# Supported Values:
Expand All @@ -79,13 +89,6 @@ zig build --help
# ReleaseFast
# ReleaseSmall
# -Dshared=[bool] Build sokol dynamic library (default: static)
# -Dubsan=[bool] Enable undefined behavior sanitizer
# -Dtsan=[bool] Enable thread sanitizer
# -Dimgui-version=[enum] Select ImGui version to use
# Supported Values:
# default
# docking

```
(also run `zig build -l` to get a list of build targets)

Expand All @@ -109,4 +112,4 @@ The sokol headers are created by Andre Weissflog (floooh) and sokol is released

[^1]: https://github.com/floooh/sokol-zig/
[^2]: https://github.com/floooh/sokol-rust/
[^3]: https://github.com/floooh/sokol/blob/master/LICENSE
[^3]: https://github.com/floooh/sokol/blob/master/LICENSE
109 changes: 80 additions & 29 deletions build.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,12 @@ pub const LibSokolOptions = struct {
use_x11: bool = true,
use_wayland: bool = false,
emsdk: ?*Build.Dependency = null,
use_ubsan: bool = false,
use_tsan: bool = false,
with_sokol_imgui: bool = false,
imgui_version: ?[]const u8 = null,
sokol_imgui_cprefix: ?[]const u8 = null,
cimgui_header_path: ?[]const u8 = null,
};

// helper function to resolve .auto backend based on target platform
Expand Down Expand Up @@ -62,8 +67,8 @@ pub fn buildLibSokol(b: *Build, options: LibSokolOptions) !*CompileStep {
.link_libc = true,
});

lib.root_module.sanitize_c = b.option(bool, "ubsan", "Enable undefined behavior sanitizer") orelse false;
lib.root_module.sanitize_thread = b.option(bool, "tsan", "Enable thread sanitizer") orelse false;
lib.root_module.sanitize_c = options.use_ubsan;
lib.root_module.sanitize_thread = options.use_tsan;

switch (options.optimize) {
.Debug, .ReleaseSafe => lib.bundle_compiler_rt = true,
Expand Down Expand Up @@ -192,23 +197,22 @@ pub fn buildLibSokol(b: *Build, options: LibSokolOptions) !*CompileStep {
}

if (options.with_sokol_imgui) {
if (b.lazyDependency("imgui", .{})) |dep| {
if (options.imgui_version) |imgui_version| {
const imgui = dep.path(imgui_version);
lib.addIncludePath(imgui);
}
}
if (options.sokol_imgui_cprefix) |cprefix| {
try cflags.append(b.fmt("-DSOKOL_IMGUI_CPREFIX={s}", .{cprefix}));
}
if (options.cimgui_header_path) |cimgui_header_path| {
try cflags.append(b.fmt("-DCIMGUI_HEADER_PATH=\"{s}\"", .{cimgui_header_path}));
}
lib.addCSourceFile(.{
.file = b.path(csrc_root ++ "sokol_imgui.c"),
.flags = cflags.slice(),
});
const imgui = try buildImgui(b, .{
.target = options.target,
.optimize = options.optimize,
.use_tsan = lib.root_module.sanitize_thread orelse false,
.use_ubsan = lib.root_module.sanitize_c orelse false,
});
if (options.emsdk) |emsdk| {
imgui.addSystemIncludePath(emSdkLazyPath(b, emsdk, &.{ "upstream", "emscripten", "cache", "sysroot", "include" }));
}
for (imgui.root_module.include_dirs.items) |dir| {
try lib.root_module.include_dirs.append(b.allocator, dir);
}
lib.linkLibrary(imgui);
}
return lib;
}
Expand All @@ -221,8 +225,21 @@ pub fn build(b: *Build) !void {
const opt_use_wayland = b.option(bool, "wayland", "Force Wayland (default: false, Linux only, not supported in main-line headers)") orelse false;
const opt_use_egl = b.option(bool, "egl", "Force EGL (default: false, Linux only)") orelse false;
const opt_with_sokol_imgui = b.option(bool, "imgui", "Add support for sokol_imgui.h bindings") orelse false;
const opt_sokol_imgui_cprefix = b.option([]const u8, "sokol_imgui_cprefix", "Override Dear ImGui C bindings prefix for sokol_imgui.h (see SOKOL_IMGUI_CPREFIX)");
const opt_cimgui_header_path = b.option([]const u8, "cimgui_header_path", "Override the Dear ImGui C bindings header name (default: cimgui.h)");
const sokol_backend: SokolBackend = if (opt_use_gl) .gl else if (opt_use_gles3) .gles3 else if (opt_use_wgpu) .wgpu else .auto;
const imguiver_path = switch (b.option(
imguiVersion,
"imgui-version",
"Select ImGui version to use",
) orelse imguiVersion.default) {
.default => "src",
.docking => "src-docking",
};

// For debug
const sanitize_c = b.option(bool, "ubsan", "Enable undefined behavior sanitizer") orelse false;
const sanitize_thread = b.option(bool, "tsan", "Enable thread sanitizer") orelse false;
// LDC-options options
const dub_artifact = b.option(bool, "artifact", "Build artifacts (default: false)") orelse false;
const opt_betterC = b.option(bool, "betterC", "Omit generating some runtime information and helper functions (default: false)") orelse false;
Expand All @@ -243,12 +260,35 @@ pub fn build(b: *Build) !void {
.use_x11 = opt_use_x11,
.use_egl = opt_use_egl,
.with_sokol_imgui = opt_with_sokol_imgui,
.sokol_imgui_cprefix = opt_sokol_imgui_cprefix,
.cimgui_header_path = opt_cimgui_header_path,
.imgui_version = imguiver_path,
.emsdk = emsdk,
.use_ubsan = sanitize_c,
.use_tsan = sanitize_thread,
});

var artifact: ?*std.Build.Step.Compile = null;
kassane marked this conversation as resolved.
Show resolved Hide resolved

if (opt_with_sokol_imgui) {
const lib_imgui = try buildImgui(b, .{
.target = target,
.optimize = optimize,
.version = imguiver_path,
.lib_sokol = lib_sokol,
.emsdk = emsdk,
.use_ubsan = sanitize_c,
.use_tsan = sanitize_thread,
});
artifact = lib_imgui;
} else {
artifact = lib_sokol;
}

if (opt_shaders)
buildShaders(b, target);
if (dub_artifact) {
b.installArtifact(lib_sokol);
b.installArtifact(artifact.?);
} else {
// build examples
const examples = .{
Expand Down Expand Up @@ -280,7 +320,7 @@ pub fn build(b: *Build) !void {
break;
const ldc = try ldcBuildStep(b, .{
.name = example,
.artifact = lib_sokol,
.artifact = artifact,
.sources = &[_][]const u8{
b.fmt("{s}/src/examples/{s}.d", .{ rootPath(), example }),
},
Expand Down Expand Up @@ -1155,31 +1195,42 @@ const libImGuiOptions = struct {
optimize: std.builtin.OptimizeMode,
use_ubsan: bool = false,
use_tsan: bool = false,
lib_sokol: *CompileStep,
emsdk: ?*Build.Dependency = null,
version: []const u8,
};
const imguiVersion = enum {
default,
docking,
};
fn buildImgui(b: *Build, options: libImGuiOptions) !*CompileStep {

// get the imgui source code
const imguiver_path = switch (b.option(
imguiVersion,
"imgui-version",
"Select ImGui version to use",
) orelse imguiVersion.default) {
.default => "src",
.docking => "src-docking",
};

const libimgui = b.addStaticLibrary(.{
.name = "imgui",
.target = options.target,
.optimize = options.optimize,
});

libimgui.root_module.sanitize_c = options.use_ubsan;
libimgui.root_module.sanitize_thread = options.use_tsan;

if (options.target.result.isWasm()) {
kassane marked this conversation as resolved.
Show resolved Hide resolved
// make sure we're building for the wasm32-emscripten target, not wasm32-freestanding
if (libimgui.rootModuleTarget().os.tag != .emscripten) {
std.log.err("Please build with 'zig build -Dtarget=wasm32-emscripten", .{});
return error.Wasm32EmscriptenExpected;
}
// one-time setup of Emscripten SDK
if (options.emsdk) |emsdk| {
if (try emSdkSetupStep(b, emsdk)) |emsdk_setup| {
libimgui.step.dependOn(&emsdk_setup.step);
}
// add the Emscripten system include seach path
libimgui.addSystemIncludePath(emSdkLazyPath(b, emsdk, &.{ "upstream", "emscripten", "cache", "sysroot", "include" }));
}
}
libimgui.step.dependOn(&options.lib_sokol.step);
libimgui.linkLibrary(options.lib_sokol);

var cflags = try std.BoundedArray([]const u8, 64).init(0);
if (options.optimize != .Debug) {
try cflags.append("-DNDEBUG");
Expand All @@ -1194,7 +1245,7 @@ fn buildImgui(b: *Build, options: libImGuiOptions) !*CompileStep {
});

if (b.lazyDependency("imgui", .{})) |dep| {
const imgui = dep.path(imguiver_path);
const imgui = dep.path(options.version);
libimgui.addIncludePath(imgui);

libimgui.addCSourceFiles(.{
Expand Down
Loading