Skip to content

Commit

Permalink
build.zig: Add ability to install a shared library
Browse files Browse the repository at this point in the history 
Initial build.zig only installed a static library. This is fine for
Zig itself but not sufficient for other ecosystems.

Current patch doesn't break backwards compatibility but does a little
refactoring where the old function addRaylib uses the newly added
function addRaylibTo, which is more flexible. In fact, addRaylib is an
alias for addStaticRaylib. addRaylib still generates a static library,
whereas the newly added addSharedRaylib generates a shared library.

Additionally, since a shared library is also a common artifact,
build.zig also installs it to a default location of
zig-out/lib/libraylib.dll.

Example code how to generate a shared library artifact in Zig:

    const libraylib = raylib.addSharedRaylib(b, target, optimize, .{});

    // Define a USE_LIBTYPE_SHARED macro for your project that is used
    // in raylib.h when using a shared library. Your project must use
    // raylib.h in order for this macro to work. It is not necessary
    // but saves performance when using on Windows. For more see:
    // #3680 (comment)
    my_project.defineCMacro("USE_LIBTYPE_SHARED", null);
  • Loading branch information
@greenfork
greenfork committed Jan 3, 2024
1 parent e46b614 commit 334f34e
Showing 1 changed file with 164 additions and 100 deletions.
264 changes: 164 additions & 100 deletions src/build.zig
View file
Original file line number Diff line number Diff line change
@@ -1,152 +1,215 @@
const std = @import("std");
const builtin = @import("builtin");

// This has been tested to work with zig 0.11.0 and zig 0.12.0-dev.1390+94cee4fb2
pub fn addRaylib(b: *std.Build, target: std.zig.CrossTarget, optimize: std.builtin.OptimizeMode, options: Options) *std.Build.CompileStep {
const raylib_flags = &[_][]const u8{
"-std=gnu99",
"-D_GNU_SOURCE",
"-DGL_SILENCE_DEPRECATION=199309L",
};
// This has been tested to work with zig 0.11.0 and zig 0.12.0-dev.1834+f36ac227b
pub fn addRaylib(
b: *std.Build,
target: std.zig.CrossTarget,
optimize: std.builtin.OptimizeMode,
options: Options,
) *std.Build.CompileStep {
return addStaticRaylib(b, target, optimize, options);
}

pub fn addStaticRaylib(
b: *std.Build,
target: std.zig.CrossTarget,
optimize: std.builtin.OptimizeMode,
options: Options,
) *std.Build.CompileStep {
const lib = b.addStaticLibrary(.{
.name = "raylib",
.target = target,
.optimize = optimize,
});
if (addRaylibTo(b, lib, target, options)) {} else |err| switch (err) {
error.OutOfMemory => {
std.debug.print("Not enough memory!", .{});
std.os.exit(1);
},
}
return lib;
}

const raylib = b.addStaticLibrary(.{
pub fn addSharedRaylib(
b: *std.Build,
target: std.zig.CrossTarget,
optimize: std.builtin.OptimizeMode,
options: Options,
) *std.Build.CompileStep {
const lib = b.addSharedLibrary(.{
.name = "raylib",
.target = target,
.optimize = optimize,
});
raylib.linkLibC();
lib.defineCMacro("BUILD_LIBTYPE_SHARED", null);
if (addRaylibTo(b, lib, target, options)) {} else |err| switch (err) {
error.OutOfMemory => {
std.debug.print("Not enough memory!", .{});
std.os.exit(1);
},
}
return lib;
}

/// Generic function for an either static, shared or object file that is passed to the `lib`
/// variable, see `addStaticRaylib` for an example.
fn addRaylibTo(
b: *std.Build,
lib: *std.Build.CompileStep,
target: std.zig.CrossTarget,
options: Options,
) !void {
var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
defer arena.deinit();
const allocator = arena.allocator();
const common_flags = &[_][]const u8{
"-std=gnu99",
"-D_GNU_SOURCE",
"-DGL_SILENCE_DEPRECATION=199309L",
};
var raylib_flags = std.ArrayList([]const u8).init(allocator);
try raylib_flags.appendSlice(common_flags);
if (lib.linkage == .dynamic) {
switch (target.getOsTag()) {
.linux, .freebsd, .openbsd, .netbsd, .dragonfly, .macos => {
try raylib_flags.append("-fvisibility=hidden");
},
else => {},
}
}
var raylib_flags_no_sanitize = try raylib_flags.clone();
try raylib_flags_no_sanitize.append("-fno-sanitize=undefined");

lib.linkLibC();

// No GLFW required on PLATFORM_DRM
if (!options.platform_drm) {
raylib.addIncludePath(.{ .path = srcdir ++ "/external/glfw/include" });
lib.addIncludePath(.{ .path = srcdir ++ "/external/glfw/include" });
}

addCSourceFilesVersioned(raylib, &.{
addCSourceFilesVersioned(lib, &.{
srcdir ++ "/rcore.c",
srcdir ++ "/utils.c",
}, raylib_flags);
}, raylib_flags.items);

if (options.raudio) {
addCSourceFilesVersioned(raylib, &.{
addCSourceFilesVersioned(lib, &.{
srcdir ++ "/raudio.c",
}, &[_][]const u8{
"-fno-sanitize=undefined", // https://github.com/raysan5/raylib/issues/3674
} ++ raylib_flags);
}, raylib_flags_no_sanitize.items); // https://github.com/raysan5/raylib/issues/3674
}
if (options.rmodels) {
addCSourceFilesVersioned(raylib, &.{
addCSourceFilesVersioned(lib, &.{
srcdir ++ "/rmodels.c",
}, &[_][]const u8{
"-fno-sanitize=undefined", // https://github.com/raysan5/raylib/issues/1891
} ++ raylib_flags);
}, raylib_flags_no_sanitize.items); // https://github.com/raysan5/raylib/issues/1891
}
if (options.rshapes) {
addCSourceFilesVersioned(raylib, &.{
addCSourceFilesVersioned(lib, &.{
srcdir ++ "/rshapes.c",
}, raylib_flags);
}, raylib_flags.items);
}
if (options.rtext) {
addCSourceFilesVersioned(raylib, &.{
addCSourceFilesVersioned(lib, &.{
srcdir ++ "/rtext.c",
}, raylib_flags);
}, raylib_flags.items);
}
if (options.rtextures) {
addCSourceFilesVersioned(raylib, &.{
addCSourceFilesVersioned(lib, &.{
srcdir ++ "/rtextures.c",
}, &[_][]const u8{
"-fno-sanitize=undefined", // https://github.com/raysan5/raylib/issues/3674
} ++ raylib_flags);
}, raylib_flags_no_sanitize.items); // https://github.com/raysan5/raylib/issues/3674
}

var gen_step = b.addWriteFiles();
raylib.step.dependOn(&gen_step.step);
lib.step.dependOn(&gen_step.step);

if (options.raygui) {
const raygui_c_path = gen_step.add("raygui.c", "#define RAYGUI_IMPLEMENTATION\n#include \"raygui.h\"\n");
raylib.addCSourceFile(.{ .file = raygui_c_path, .flags = raylib_flags });
raylib.addIncludePath(.{ .path = srcdir });
raylib.addIncludePath(.{ .path = srcdir ++ "/../../raygui/src" });
lib.addCSourceFile(.{ .file = raygui_c_path, .flags = raylib_flags.items });
lib.addIncludePath(.{ .path = srcdir });
lib.addIncludePath(.{ .path = srcdir ++ "/../../raygui/src" });
}

switch (target.getOsTag()) {
.windows => {
addCSourceFilesVersioned(raylib, &.{
addCSourceFilesVersioned(lib, &.{
srcdir ++ "/rglfw.c",
}, raylib_flags);
raylib.linkSystemLibrary("winmm");
raylib.linkSystemLibrary("gdi32");
raylib.linkSystemLibrary("opengl32");
raylib.addIncludePath(.{ .path = "external/glfw/deps/mingw" });
}, raylib_flags.items);
lib.linkSystemLibrary("winmm");
lib.linkSystemLibrary("gdi32");
lib.linkSystemLibrary("opengl32");
lib.addIncludePath(.{ .path = "external/glfw/deps/mingw" });

raylib.defineCMacro("PLATFORM_DESKTOP", null);
lib.defineCMacro("PLATFORM_DESKTOP", null);
},
.linux => {
if (!options.platform_drm) {
addCSourceFilesVersioned(raylib, &.{
addCSourceFilesVersioned(lib, &.{
srcdir ++ "/rglfw.c",
}, raylib_flags);
raylib.linkSystemLibrary("GL");
raylib.linkSystemLibrary("rt");
raylib.linkSystemLibrary("dl");
raylib.linkSystemLibrary("m");
raylib.linkSystemLibrary("X11");
raylib.addLibraryPath(.{ .path = "/usr/lib" });
raylib.addIncludePath(.{ .path = "/usr/include" });

raylib.defineCMacro("PLATFORM_DESKTOP", null);
}, raylib_flags.items);
lib.linkSystemLibrary("GL");
lib.linkSystemLibrary("rt");
lib.linkSystemLibrary("dl");
lib.linkSystemLibrary("m");
lib.linkSystemLibrary("X11");
lib.addLibraryPath(.{ .path = "/usr/lib" });
lib.addIncludePath(.{ .path = "/usr/include" });

lib.defineCMacro("PLATFORM_DESKTOP", null);
} else {
raylib.linkSystemLibrary("GLESv2");
raylib.linkSystemLibrary("EGL");
raylib.linkSystemLibrary("drm");
raylib.linkSystemLibrary("gbm");
raylib.linkSystemLibrary("pthread");
raylib.linkSystemLibrary("rt");
raylib.linkSystemLibrary("m");
raylib.linkSystemLibrary("dl");
raylib.addIncludePath(.{ .path = "/usr/include/libdrm" });

raylib.defineCMacro("PLATFORM_DRM", null);
raylib.defineCMacro("GRAPHICS_API_OPENGL_ES2", null);
raylib.defineCMacro("EGL_NO_X11", null);
raylib.defineCMacro("DEFAULT_BATCH_BUFFER_ELEMENT", "2048");
lib.linkSystemLibrary("GLESv2");
lib.linkSystemLibrary("EGL");
lib.linkSystemLibrary("drm");
lib.linkSystemLibrary("gbm");
lib.linkSystemLibrary("pthread");
lib.linkSystemLibrary("rt");
lib.linkSystemLibrary("m");
lib.linkSystemLibrary("dl");
lib.addIncludePath(.{ .path = "/usr/include/libdrm" });

lib.defineCMacro("PLATFORM_DRM", null);
lib.defineCMacro("GRAPHICS_API_OPENGL_ES2", null);
lib.defineCMacro("EGL_NO_X11", null);
lib.defineCMacro("DEFAULT_BATCH_BUFFER_ELEMENT", "2048");
}
},
.freebsd, .openbsd, .netbsd, .dragonfly => {
addCSourceFilesVersioned(raylib, &.{
addCSourceFilesVersioned(lib, &.{
srcdir ++ "/rglfw.c",
}, raylib_flags);
raylib.linkSystemLibrary("GL");
raylib.linkSystemLibrary("rt");
raylib.linkSystemLibrary("dl");
raylib.linkSystemLibrary("m");
raylib.linkSystemLibrary("X11");
raylib.linkSystemLibrary("Xrandr");
raylib.linkSystemLibrary("Xinerama");
raylib.linkSystemLibrary("Xi");
raylib.linkSystemLibrary("Xxf86vm");
raylib.linkSystemLibrary("Xcursor");

raylib.defineCMacro("PLATFORM_DESKTOP", null);
}, raylib_flags.items);
lib.linkSystemLibrary("GL");
lib.linkSystemLibrary("rt");
lib.linkSystemLibrary("dl");
lib.linkSystemLibrary("m");
lib.linkSystemLibrary("X11");
lib.linkSystemLibrary("Xrandr");
lib.linkSystemLibrary("Xinerama");
lib.linkSystemLibrary("Xi");
lib.linkSystemLibrary("Xxf86vm");
lib.linkSystemLibrary("Xcursor");

lib.defineCMacro("PLATFORM_DESKTOP", null);
},
.macos => {
var new_flags = try raylib_flags.clone();
// On macos rglfw.c include Objective-C files.
const raylib_flags_extra_macos = &[_][]const u8{
"-ObjC",
};
addCSourceFilesVersioned(raylib, &.{
try new_flags.appendSlice(raylib_flags_extra_macos);
addCSourceFilesVersioned(lib, &.{
srcdir ++ "/rglfw.c",
}, raylib_flags ++ raylib_flags_extra_macos);
raylib.linkFramework("Foundation");
raylib.linkFramework("CoreServices");
raylib.linkFramework("CoreGraphics");
raylib.linkFramework("AppKit");
raylib.linkFramework("IOKit");

raylib.defineCMacro("PLATFORM_DESKTOP", null);
}, new_flags.items);
lib.linkFramework("Foundation");
lib.linkFramework("CoreServices");
lib.linkFramework("CoreGraphics");
lib.linkFramework("AppKit");
lib.linkFramework("IOKit");

lib.defineCMacro("PLATFORM_DESKTOP", null);
},
.emscripten => {
raylib.defineCMacro("PLATFORM_WEB", null);
raylib.defineCMacro("GRAPHICS_API_OPENGL_ES2", null);
lib.defineCMacro("PLATFORM_WEB", null);
lib.defineCMacro("GRAPHICS_API_OPENGL_ES2", null);

if (b.sysroot == null) {
@panic("Pass '--sysroot \"$EMSDK/upstream/emscripten\"'");
Expand All @@ -158,14 +221,12 @@ pub fn addRaylib(b: *std.Build, target: std.zig.CrossTarget, optimize: std.built
var dir = std.fs.openDirAbsolute(cache_include, std.fs.Dir.OpenDirOptions{ .access_sub_paths = true, .no_follow = true }) catch @panic("No emscripten cache. Generate it!");
dir.close();

raylib.addIncludePath(.{ .path = cache_include });
lib.addIncludePath(.{ .path = cache_include });
},
else => {
@panic("Unsupported OS");
},
}

return raylib;
}

pub const Options = struct {
Expand Down Expand Up @@ -200,17 +261,20 @@ pub fn build(b: *std.Build) void {
.raygui = b.option(bool, "raygui", "Compile with raygui support") orelse defaults.raygui,
};

const lib = addRaylib(b, target, optimize, options);
const static_lib = addStaticRaylib(b, target, optimize, options);
const shared_lib = addSharedRaylib(b, target, optimize, options);

lib.installHeader("src/raylib.h", "raylib.h");
lib.installHeader("src/raymath.h", "raymath.h");
lib.installHeader("src/rlgl.h", "rlgl.h");
inline for (&[_]*std.Build.CompileStep{ static_lib, shared_lib }) |lib| {
lib.installHeader("src/raylib.h", "raylib.h");
lib.installHeader("src/raymath.h", "raymath.h");
lib.installHeader("src/rlgl.h", "rlgl.h");

if (options.raygui) {
lib.installHeader("../raygui/src/raygui.h", "raygui.h");
}
if (options.raygui) {
lib.installHeader("../raygui/src/raygui.h", "raygui.h");
}

b.installArtifact(lib);
b.installArtifact(lib);
}
}

const srcdir = struct {
Expand Down

0 comments on commit 334f34e

Please sign in to comment.