473 lines
16 KiB
Nix
473 lines
16 KiB
Nix
rec {
|
|
description = "C++ MassSprings";
|
|
|
|
inputs = {
|
|
nixpkgs.url = "nixpkgs"; # Use nixpkgs from system registry
|
|
flake-utils.url = "github:numtide/flake-utils";
|
|
};
|
|
|
|
outputs = {
|
|
self,
|
|
nixpkgs,
|
|
flake-utils,
|
|
}:
|
|
# Create a shell (and possibly package) for each possible system, not only x86_64-linux
|
|
flake-utils.lib.eachDefaultSystem (
|
|
system: let
|
|
# =========================================================================================
|
|
# Define pkgs/stdenvs
|
|
# =========================================================================================
|
|
pkgs = import nixpkgs {
|
|
inherit system;
|
|
config.allowUnfree = true;
|
|
overlays = [];
|
|
};
|
|
|
|
clangPkgs = import nixpkgs {
|
|
inherit system;
|
|
config.allowUnfree = true;
|
|
overlays = [];
|
|
|
|
# Use this to change the compiler:
|
|
# - GCC: pkgs.stdenv
|
|
# - Clang: pkgs.clangStdenv
|
|
# NixOS packages are built using GCC by default. Using clang requires a full rebuild/redownload.
|
|
config.replaceStdenv = {pkgs}: pkgs.clangStdenv;
|
|
};
|
|
|
|
windowsPkgs = import nixpkgs {
|
|
inherit system;
|
|
config.allowUnfree = true;
|
|
overlays = [];
|
|
|
|
# Use this to cross compile to a different system
|
|
crossSystem = {
|
|
config = "x86_64-w64-mingw32";
|
|
};
|
|
};
|
|
|
|
inherit (pkgs) lib stdenv;
|
|
|
|
# =========================================================================================
|
|
# Define shell environment
|
|
# =========================================================================================
|
|
|
|
# Setup the shell when entering the "nix develop" environment (bash script).
|
|
shellHook = let
|
|
mkCmakeScript = type: let
|
|
typeLower = lib.toLower type;
|
|
in
|
|
pkgs.writers.writeFish "cmake-${typeLower}.fish" ''
|
|
cd $FLAKE_PROJECT_ROOT
|
|
|
|
echo "Removing build directory ./cmake-build-${typeLower}/"
|
|
rm -rf ./cmake-build-${typeLower}
|
|
|
|
echo "Creating build directory"
|
|
mkdir cmake-build-${typeLower}
|
|
cd cmake-build-${typeLower}
|
|
|
|
echo "Running cmake"
|
|
cmake -G "Ninja" \
|
|
-DCMAKE_BUILD_TYPE="${type}" \
|
|
..
|
|
|
|
echo "Linking compile_commands.json"
|
|
cd ..
|
|
ln -sf ./cmake-build-${typeLower}/compile_commands.json ./compile_commands.json
|
|
'';
|
|
|
|
cmakeDebug = mkCmakeScript "Debug";
|
|
cmakeRelease = mkCmakeScript "Release";
|
|
|
|
mkBuildScript = type: let
|
|
typeLower = lib.toLower type;
|
|
in
|
|
pkgs.writers.writeFish "cmake-build.fish" ''
|
|
cd $FLAKE_PROJECT_ROOT/cmake-build-${typeLower}
|
|
|
|
echo "Running cmake"
|
|
NIX_ENFORCE_NO_NATIVE=0 cmake --build . -j$(nproc)
|
|
'';
|
|
|
|
buildDebug = mkBuildScript "Debug";
|
|
buildRelease = mkBuildScript "Release";
|
|
|
|
# Use this to specify commands that should be ran after entering fish shell
|
|
initProjectShell = pkgs.writers.writeFish "init-shell.fish" ''
|
|
echo "Entering \"${description}\" environment..."
|
|
|
|
# Determine the project root, used e.g. in cmake scripts
|
|
set -g -x FLAKE_PROJECT_ROOT (git rev-parse --show-toplevel)
|
|
|
|
# C/C++:
|
|
abbr -a cmake-debug "${cmakeDebug}"
|
|
abbr -a cmake-release "${cmakeRelease}"
|
|
abbr -a build-debug "${buildDebug}"
|
|
abbr -a build-release "${buildRelease}"
|
|
abbr -a debug-clean "${cmakeDebug} && ${buildDebug} && ./cmake-build-debug/masssprings"
|
|
abbr -a release-clean "${cmakeRelease} && ${buildRelease} && ./cmake-build-release/masssprings"
|
|
abbr -a debug "${buildDebug} && ./cmake-build-debug/masssprings"
|
|
abbr -a release "${buildRelease} && ./cmake-build-release/masssprings"
|
|
|
|
abbr -a run "${buildRelease} && ./cmake-build-release/masssprings"
|
|
abbr -a runclusters "${buildRelease} && ./cmake-build-release/masssprings --output=clusters.puzzle --space=rh --moves=10 --blocks=4"
|
|
abbr -a runtests "${buildDebug} && ./cmake-build-debug/tests"
|
|
abbr -a runbenchs "mv -f benchs.json benchs.old.json; ${buildRelease} && sudo cpupower frequency-set --governor performance && ./cmake-build-release/benchmarks --benchmark_out=benchs.json --benchmark_out_format=console; sudo cpupower frequency-set --governor powersave"
|
|
abbr -a rungdb "${buildDebug} && gdb --tui ./cmake-build-debug/masssprings"
|
|
abbr -a runvalgrind "${buildDebug} && valgrind --leak-check=full --show-reachable=no --show-leak-kinds=definite,indirect,possible --track-origins=no --suppressions=valgrind.supp --log-file=valgrind.log ./cmake-build-debug/masssprings && cat valgrind.log"
|
|
abbr -a runperf "${buildRelease} && perf record -g ./cmake-build-release/masssprings && hotspot ./perf.data"
|
|
abbr -a runperf-graph "${buildRelease} && perf record -g ./cmake-build-release/benchmarks --benchmark_filter='explore_state_space' && hotspot ./perf.data"
|
|
abbr -a runperf-space "${buildRelease} && perf record -g ./cmake-build-release/benchmarks --benchmark_filter='explore_rush_hour_puzzle_space' && hotspot ./perf.data"
|
|
abbr -a runtracy "tracy -a 127.0.0.1 &; ${buildRelease} && sudo -E ./cmake-build-release/masssprings"
|
|
|
|
abbr -a runclion "clion ./CMakeLists.txt 2>/dev/null 1>&2 & disown;"
|
|
'';
|
|
in
|
|
builtins.concatStringsSep "\n" [
|
|
# Launch into pure fish shell
|
|
''
|
|
exec "$(type -p fish)" -C "source ${initProjectShell}"
|
|
''
|
|
];
|
|
|
|
# ===========================================================================================
|
|
# Define custom dependencies
|
|
# ===========================================================================================
|
|
|
|
raygui = stdenv.mkDerivation rec {
|
|
pname = "raygui";
|
|
version = "4.0-unstable-2026-02-24";
|
|
|
|
src = pkgs.fetchFromGitHub {
|
|
owner = "raysan5";
|
|
repo = "raygui";
|
|
rev = "5788707b6b7000343c14653b1ad3b971ca0597e4";
|
|
hash = "sha256-wKylPeNw7wO5xuTfnp1OYETQ78EPlr4NU9erbmIFgjE=";
|
|
};
|
|
|
|
patches = [./raygui.patch];
|
|
|
|
dontBuild = true;
|
|
installPhase = ''
|
|
runHook preInstall
|
|
|
|
mkdir -p $out/{include,lib/pkgconfig}
|
|
|
|
install -Dm644 src/raygui.h $out/include/raygui.h
|
|
|
|
cat <<EOF > $out/lib/pkgconfig/raygui.pc
|
|
prefix=$out
|
|
includedir=$out/include
|
|
|
|
Name: raygui
|
|
Description: Simple and easy-to-use immediate-mode gui library
|
|
URL: https://github.com/raysan5/raygui
|
|
Version: ${version}
|
|
Cflags: -I"{includedir}"
|
|
EOF
|
|
|
|
runHook postInstall
|
|
'';
|
|
};
|
|
|
|
thread-pool = stdenv.mkDerivation {
|
|
pname = "thread-pool";
|
|
version = "5.1.0";
|
|
|
|
src = pkgs.fetchFromGitHub {
|
|
owner = "bshoshany";
|
|
repo = "thread-pool";
|
|
rev = "bd4533f1f70c2b975cbd5769a60d8eaaea1d2233";
|
|
hash = "sha256-/RMo5pe9klgSWmoqBpHMq2lbJsnCxMzhsb3ZPsw3aZw=";
|
|
};
|
|
|
|
# Header-only library
|
|
dontBuild = true;
|
|
installPhase = ''
|
|
runHook preInstall
|
|
|
|
mkdir -p $out
|
|
cp -rv ./include $out/include
|
|
|
|
runHook postInstall
|
|
'';
|
|
};
|
|
|
|
# We can use the pkgs.stdenv for Linux+Windows because it's a header only library.
|
|
# The build is required to create the pkg-config/cmake configuration files.
|
|
libmorton = stdenv.mkDerivation {
|
|
pname = "libmorton";
|
|
version = "0.2.12-unstable-2023-05-24";
|
|
|
|
src = pkgs.fetchFromGitHub {
|
|
owner = "Forceflow";
|
|
repo = "libmorton";
|
|
rev = "7923faa88d7e564020b2d5d408bf8c186ecbe363";
|
|
hash = "sha256-5LHiWu2GIuDmfM2gXGbRsFasE7AmVCSRphNdFElbbjk=";
|
|
};
|
|
|
|
nativeBuildInputs = with pkgs; [cmake];
|
|
|
|
cmakeFlags = [
|
|
"-DBUILD_TESTING=OFF"
|
|
"-DCMAKE_INSTALL_INCLUDEDIR=include"
|
|
"-DCMAKE_INSTALL_DATADIR=share"
|
|
];
|
|
};
|
|
|
|
glew-windows = windowsPkgs.stdenv.mkDerivation rec {
|
|
pname = "glew-windows";
|
|
version = "2.2.0";
|
|
|
|
src = pkgs.fetchurl {
|
|
url = "https://github.com/nigels-com/glew/releases/download/glew-${version}/glew-${version}.tgz";
|
|
hash = "sha256-1PyCiTz7ABCVeNChojN/uMozWzzsz5e5flzH8I5DU+E=";
|
|
};
|
|
|
|
nativeBuildInputs = with pkgs; [
|
|
cmake
|
|
ninja
|
|
pkg-config
|
|
];
|
|
|
|
preConfigure = ''
|
|
cd build/cmake
|
|
'';
|
|
|
|
cmakeFlags = [
|
|
"-DBUILD_UTILS=OFF"
|
|
"-DGLEW_OSMESA=OFF"
|
|
"-DBUILD_SHARED_LIBS=ON"
|
|
"-DCMAKE_POLICY_VERSION_MINIMUM=3.5"
|
|
];
|
|
|
|
installPhase = ''
|
|
runHook preInstall
|
|
|
|
cmake --install . --prefix "$out"
|
|
|
|
runHook postInstall
|
|
'';
|
|
};
|
|
|
|
# ===========================================================================================
|
|
# Specify dependencies
|
|
# https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-dependencies-overview
|
|
# Just for a "nix develop" shell, buildInputs can be used for everything.
|
|
# ===========================================================================================
|
|
|
|
# Add dependencies to nativeBuildInputs if they are executed during the build:
|
|
# - Those which are needed on $PATH during the build, for example cmake and pkg-config
|
|
# - Setup hooks, for example makeWrapper
|
|
# - Interpreters needed by patchShebangs for build scripts (with the --build flag), which can be the case for e.g. perl
|
|
# NOTE: Do not add compiler here, they are provided by the stdenv
|
|
nativeBuildInputs = with pkgs; [
|
|
# Languages:
|
|
# binutils
|
|
|
|
# C/C++:
|
|
cmake
|
|
ninja
|
|
gdb
|
|
valgrind
|
|
kdePackages.kcachegrind
|
|
perf
|
|
hotspot
|
|
# heaptrack
|
|
# renderdoc
|
|
];
|
|
|
|
# Add dependencies to buildInputs if they will end up copied or linked into the final output or otherwise used at runtime:
|
|
# - Libraries used by compilers, for example zlib
|
|
# - Interpreters needed by patchShebangs for scripts which are installed, which can be the case for e.g. perl
|
|
buildInputs = with pkgs; [
|
|
# C/C++:
|
|
raylib
|
|
raygui
|
|
glew
|
|
thread-pool
|
|
libmorton
|
|
boost
|
|
|
|
# Debugging/Testing/Profiling
|
|
tracy_0_13
|
|
backward-cpp
|
|
libbfd
|
|
catch2_3
|
|
gbenchmark
|
|
];
|
|
|
|
# ===========================================================================================
|
|
# Define buildable + installable packages
|
|
# ===========================================================================================
|
|
|
|
package = stdenv.mkDerivation rec {
|
|
inherit buildInputs;
|
|
pname = "masssprings";
|
|
version = "1.0.0";
|
|
src = ./.;
|
|
|
|
nativeBuildInputs = with pkgs; [
|
|
gcc
|
|
cmake
|
|
|
|
# Fix the working directory so the auxiliary files are always available
|
|
makeWrapper
|
|
];
|
|
|
|
cmakeFlags = [
|
|
"-DDISABLE_THREADPOOL=Off"
|
|
"-DDISABLE_TRACY=On"
|
|
"-DDISABLE_BACKWARD=On"
|
|
"-DDISABLE_TESTS=On"
|
|
"-DDISABLE_BENCH=On"
|
|
];
|
|
|
|
hardeningDisable = ["all"];
|
|
|
|
preConfigure = ''
|
|
unset NIX_ENFORCE_NO_NATIVE
|
|
'';
|
|
|
|
installPhase = ''
|
|
runHook preInstall
|
|
|
|
mkdir -p $out/lib
|
|
cp ./${pname} $out/lib/
|
|
cp -rv $src/default.puzzle $out/lib/
|
|
cp -rv $src/fonts $out/lib/fonts
|
|
cp -rv $src/shader $out/lib/shader
|
|
|
|
# The wrapper enters the correct working dir, so fonts/shaders/presets are available
|
|
mkdir -p $out/bin
|
|
makeWrapper $out/lib/${pname} $out/bin/${pname} --chdir "$out/lib"
|
|
|
|
# Generate a .desktop file
|
|
mkdir -p $out/share/applications
|
|
cat <<INI > $out/share/applications/${pname}.desktop
|
|
[Desktop Entry]
|
|
Terminal=true
|
|
Name=PuzzleSpaces
|
|
Exec=$out/bin/${pname} %f
|
|
Type=Application
|
|
INI
|
|
|
|
runHook postInstall
|
|
'';
|
|
};
|
|
|
|
windowsPackage = windowsPkgs.stdenv.mkDerivation rec {
|
|
pname = "masssprings";
|
|
version = "1.0.0";
|
|
src = ./.;
|
|
|
|
# nativeBuildInputs must be from the build-platform (not cross)
|
|
# so we use "pkgs" here, not "windowsPkgs"
|
|
nativeBuildInputs = with pkgs; [
|
|
cmake
|
|
];
|
|
|
|
buildInputs = with windowsPkgs; [
|
|
raylib
|
|
raygui
|
|
glew-windows
|
|
thread-pool
|
|
libmorton
|
|
|
|
# Disable stacktrace since that's platform dependant and won't cross compile to windows
|
|
# https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/boost/generic.nix#L43
|
|
(boost.override {
|
|
enableShared = false;
|
|
extraB2Args = [
|
|
"--without-stacktrace"
|
|
];
|
|
})
|
|
];
|
|
|
|
cmakeFlags = [
|
|
"-DCMAKE_SYSTEM_NAME=Windows"
|
|
"-DDISABLE_THREADPOOL=Off"
|
|
"-DDISABLE_TRACY=On"
|
|
"-DDISABLE_BACKWARD=On"
|
|
"-DDISABLE_TESTS=On"
|
|
"-DDISABLE_BENCH=On"
|
|
];
|
|
|
|
installPhase = ''
|
|
runHook preInstall
|
|
|
|
mkdir -p $out/bin
|
|
cp -rv ./${pname}.exe $out/bin/
|
|
cp -rv $src/default.puzzle $out/bin/
|
|
cp -rv $src/fonts $out/bin/fonts
|
|
cp -rv $src/shader $out/bin/shader
|
|
|
|
runHook postInstall
|
|
'';
|
|
};
|
|
in rec {
|
|
# Provide packages for "nix build" and "nix run"
|
|
packages = {
|
|
default = package;
|
|
windows = windowsPackage;
|
|
};
|
|
apps.default = flake-utils.lib.mkApp {drv = package;};
|
|
|
|
# Provide environment for "nix develop"
|
|
devShells = {
|
|
default = pkgs.mkShell {
|
|
inherit nativeBuildInputs buildInputs shellHook;
|
|
name = description;
|
|
|
|
# =========================================================================================
|
|
# Define environment variables
|
|
# =========================================================================================
|
|
|
|
# Dynamic libraries from buildinputs:
|
|
LD_LIBRARY_PATH = nixpkgs.lib.makeLibraryPath buildInputs;
|
|
};
|
|
|
|
# Provide environment with clang stdenv for "nix develop .#clang"
|
|
# TODO: Broken. Clang can't find stdlib headers or library headers (raylib, backward, ...).
|
|
# Does the clangStdenv not automatically collect the include paths?
|
|
clang =
|
|
pkgs.mkShell.override {
|
|
stdenv = pkgs.clangStdenv;
|
|
} {
|
|
inherit shellHook;
|
|
name = description;
|
|
|
|
nativeBuildInputs = with pkgs; [
|
|
cmake
|
|
ninja
|
|
];
|
|
|
|
buildInputs = with pkgs; [
|
|
# C/C++:
|
|
raylib
|
|
raygui
|
|
glew
|
|
thread-pool
|
|
libmorton
|
|
boost
|
|
|
|
# Debugging/Testing/Profiling
|
|
backward-cpp
|
|
libbfd
|
|
catch2_3
|
|
gbenchmark
|
|
];
|
|
|
|
# =========================================================================================
|
|
# Define environment variables
|
|
# =========================================================================================
|
|
|
|
# Dynamic libraries from buildinputs:
|
|
LD_LIBRARY_PATH = nixpkgs.lib.makeLibraryPath buildInputs;
|
|
};
|
|
};
|
|
}
|
|
);
|
|
}
|