Skip to content

Build Script Refinements/Static Linking #16

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

Merged
merged 6 commits into from
Dec 22, 2024
Merged

Build Script Refinements/Static Linking #16

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
78ff40e
fix broken release build on linux
murl-digital Sep 9, 2024
e5a218a
simplify build script and add static linking feature
murl-digital Sep 13, 2024
f482024
add cargo config for linux
murl-digital Sep 13, 2024
164b01a
resolve merge conflicts, merge master
revmischa Nov 3, 2024
fa50fd2
static linking flag logic fix
revmischa Nov 3, 2024
844457a
fix lifetimes
revmischa Nov 3, 2024
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
3 changes: 2 additions & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ rand = "0.8"

[features]
default = ["playlist"]
playlist = ["projectm-sys/playlist"]
playlist = ["projectm-sys/playlist"]
static = ["projectm-sys/static"]
3 changes: 3 additions & 0 deletions projectm-sys/.cargo/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
[target.wasm32-unknown-emscripten]
linker = ".cargo/linker-emscripten"

[target.x86_64-unknown-linux-gnu]
rustflags = "-C link-arg=-lGL -C link-arg=-lstdc++ -C link-arg=-lgomp"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are these needed?
should we really overwrite linker args just for linux/x86?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've found that these are necessary otherwise the linker complains. I think rustc only links libc, not libc++, and gomp which I guess is a projectm dependency of some sort.

2 changes: 2 additions & 0 deletions projectm-sys/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,5 @@ lazy_static = "1.4.0"
[features]
default = ["playlist"]
playlist = []
static = []

118 changes: 82 additions & 36 deletions projectm-sys/build.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,28 @@ use std::path::PathBuf;
mod build_bindgen;
use crate::build_bindgen::bindgen;

// Functions to determine feature flags
fn enable_playlist() -> &'static str {
if cfg!(feature = "playlist") {
"ON"
} else {
"OFF"
}
}
// Are we linking to shared or static libraries?
fn build_shared_libs_flag() -> &'static str {
if cfg!(feature = "static") {
"OFF" // Disable shared libs to enable static linking
} else {
"ON" // Enable shared libs
}
}

fn main() {
// Get the path to the projectM source code
// Path to the projectM source code
let projectm_path = PathBuf::from(env::var("CARGO_MANIFEST_DIR").unwrap()).join("libprojectM");

// Check if the libprojectM source code exists
// Verify the existence of the libprojectM directory
if !projectm_path.exists() {
println!("cargo:warning=The libprojectM source code is missing.");
println!(
Expand All @@ -18,16 +35,13 @@ fn main() {
std::process::exit(1);
}

// Determine if the 'playlist' feature is enabled
let enable_playlist = if cfg!(feature = "playlist") {
"ON"
} else {
"OFF"
};
// Determine feature flags
let enable_playlist_flag = enable_playlist();
let build_shared_libs = build_shared_libs_flag();

let dst;

// Platform-specific configurations
// Platform-specific CMake configurations
if cfg!(target_os = "windows") {
// Ensure VCPKG installation root is set
let vcpkg_root = match env::var("VCPKG_INSTALLATION_ROOT") {
Expand Down Expand Up @@ -55,19 +69,19 @@ fn main() {
// Set VCPKG_ROOT for CMake
env::set_var("VCPKG_ROOT", &vcpkg_root);

// Optionally set CMAKE_PREFIX_PATH
// Define the installation path for vcpkg
let vcpkg_installed = vcpkg_root.join("installed").join("x64-windows-static-md");

// Configure and build libprojectM using CMake for Windows
dst = cmake::Config::new(&projectm_path)
let mut cmake_config = cmake::Config::new(&projectm_path)
.generator("Visual Studio 17 2022")
.define("CMAKE_TOOLCHAIN_FILE", &vcpkg_toolchain)
.define("VCPKG_TARGET_TRIPLET", "x64-windows-static-md")
.define(
"CMAKE_MSVC_RUNTIME_LIBRARY",
"MultiThreaded$<$<CONFIG:Debug>:Debug>DLL",
)
.define("ENABLE_PLAYLIST", enable_playlist)
.define("ENABLE_PLAYLIST", enable_playlist_flag)
.define(
"projectM_Eval_DIR",
&projectm_path.join("vendor").join("projectm-eval"),
Expand All @@ -76,59 +90,91 @@ fn main() {
.define("CMAKE_VERBOSE_MAKEFILE", "ON")
.define("BUILD_TESTING", "OFF")
.define("BUILD_EXAMPLES", "OFF")
.build();
.define("BUILD_SHARED_LIBS", build_shared_libs); // static/dynamic

dst = cmake_config.build();
} else if cfg!(target_os = "emscripten") {
// Configure and build libprojectM using CMake for Emscripten
dst = cmake::Config::new(&projectm_path)
.define("ENABLE_PLAYLIST", enable_playlist)
.define("ENABLE_PLAYLIST", enable_playlist_flag)
.define("BUILD_TESTING", "OFF")
.define("BUILD_EXAMPLES", "OFF")
.define("ENABLE_EMSCRIPTEN", "ON")
.define("BUILD_SHARED_LIBS", build_shared_libs) // static/dynamic
.build();
} else {
// Configure and build libprojectM using CMake for other platforms
// Configure and build libprojectM using CMake for other platforms (Linux, macOS)
dst = cmake::Config::new(&projectm_path)
.define("ENABLE_PLAYLIST", enable_playlist)
.define("ENABLE_PLAYLIST", enable_playlist_flag)
.define("BUILD_TESTING", "OFF")
.define("BUILD_EXAMPLES", "OFF")
.define("BUILD_SHARED_LIBS", build_shared_libs) // static/dynamic
.build();
}

// Specify the library search path
println!("cargo:rustc-link-search=native={}/lib", dst.display());

// Determine the library name based on the build profile
// Determine the build profile (release or debug)
let profile = env::var("PROFILE").unwrap_or_else(|_| "release".to_string());

// Platform-specific library linking
// Platform and feature-specific library linking
if cfg!(target_os = "windows") || cfg!(target_os = "emscripten") {
// Use static linking for Windows and Emscripten
if profile == "release" {
println!("cargo:rustc-link-lib=static=projectM-4");
if cfg!(feature = "playlist") {
println!("cargo:rustc-link-lib=static=projectM-4-playlist");
// Static or Dynamic linking based on 'static' feature
if cfg!(feature = "static") {
if profile == "release" {
println!("cargo:rustc-link-lib=static=projectM-4");
if cfg!(feature = "playlist") {
println!("cargo:rustc-link-lib=static=projectM-4-playlist");
}
} else {
println!("cargo:rustc-link-lib=static=projectM-4d");
if cfg!(feature = "playlist") {
println!("cargo:rustc-link-lib=static=projectM-4-playlistd");
}
}
} else {
println!("cargo:rustc-link-lib=static=projectM-4d");
if cfg!(feature = "playlist") {
println!("cargo:rustc-link-lib=static=projectM-4-playlistd");
if profile == "release" {
println!("cargo:rustc-link-lib=dylib=projectM-4");
if cfg!(feature = "playlist") {
println!("cargo:rustc-link-lib=dylib=projectM-4-playlist");
}
} else {
println!("cargo:rustc-link-lib=dylib=projectM-4d");
if cfg!(feature = "playlist") {
println!("cargo:rustc-link-lib=dylib=projectM-4-playlistd");
}
}
}
} else {
// Use dynamic linking for other platforms (Linux, macOS)
if profile == "release" {
println!("cargo:rustc-link-lib=dylib=projectM-4");
if cfg!(feature = "playlist") {
println!("cargo:rustc-link-lib=dylib=projectM-4-playlist");
// For other platforms (Linux, macOS)
if cfg!(feature = "static") {
if profile == "release" {
println!("cargo:rustc-link-lib=static=projectM-4");
if cfg!(feature = "playlist") {
println!("cargo:rustc-link-lib=static=projectM-4-playlist");
}
} else {
println!("cargo:rustc-link-lib=static=projectM-4d");
if cfg!(feature = "playlist") {
println!("cargo:rustc-link-lib=static=projectM-4-playlistd");
}
}
} else {
println!("cargo:rustc-link-lib=dylib=projectM-4d");
if cfg!(feature = "playlist") {
println!("cargo:rustc-link-lib=dylib=projectM-4-playlistd");
if profile == "release" {
println!("cargo:rustc-link-lib=dylib=projectM-4");
if cfg!(feature = "playlist") {
println!("cargo:rustc-link-lib=dylib=projectM-4-playlist");
}
} else {
println!("cargo:rustc-link-lib=dylib=projectM-4d");
if cfg!(feature = "playlist") {
println!("cargo:rustc-link-lib=dylib=projectM-4-playlistd");
}
}
}
}

// Run bindgen to generate Rust bindings
// Generate Rust bindings using bindgen
bindgen();
}
}
Loading