build: Introduce wrapper scripts

thrimbor · Ryzee119 · commit 60a5b1b205a4 · 2021-10-27T16:02:57.000+10:30
diff --git a/.ci_build_samples.sh b/.ci_build_samples.sh
@@ -1,6 +1,8 @@
 #!/bin/sh
 set -e
 
+eval $(./bin/activate -s)
+
 if [ $(uname) = 'Darwin' ]; then
     NUMCORES=$(sysctl -n hw.logicalcpu)
 else
diff --git a/.github/workflows/build_samples.yml b/.github/workflows/build_samples.yml
@@ -73,7 +73,7 @@ jobs:
           HOMEBREW_NO_INSTALL_CLEANUP: 1
         run: |
           brew doctor || true
-          brew update-reset && brew install llvm
+          brew update-reset && brew install llvm coreutils
       - name: Build
         run: ./.ci_build_samples.sh
   ubuntu:
diff --git a/Dockerfile b/Dockerfile
@@ -4,7 +4,7 @@ COPY ./ /usr/src/nxdk/
 ENV NXDK_DIR=/usr/src/nxdk
 RUN cd /usr/src/nxdk && make tools -j`nproc`
 ARG buildparams
-RUN cd /usr/src/nxdk && make NXDK_ONLY=y $buildparams -j`nproc`
+RUN eval $(./usr/src/nxdk/bin/activate -s); cd /usr/src/nxdk && make NXDK_ONLY=y $buildparams -j`nproc`
 
 
 FROM ghcr.io/xboxdev/nxdk-runbase:git-2c3115b1
@@ -14,6 +14,8 @@ ENV NXDK_DIR=/usr/src/nxdk
 
 WORKDIR /usr/src/app
 
+ENTRYPOINT /usr/src/nxdk/docker_entry.sh
+
 LABEL org.opencontainers.image.documentation='https://github.com/XboxDev/nxdk/wiki'
 LABEL org.opencontainers.image.licenses='(Apache-2.0 AND BSD-3-Clause AND CC0-1.0 AND GPL-2.0-or-later AND LGPL-2.1-or-later AND MIT)'
 LABEL org.opencontainers.image.source='https://github.com/XboxDev/nxdk.git'
diff --git a/Makefile b/Makefile
@@ -13,35 +13,26 @@ endif
 UNAME_S := $(shell uname -s)
 UNAME_M := $(shell uname -m)
 
+LD  = nxdk-link
+LIB = nxdk-lib
+AS  = nxdk-as
+CC  = nxdk-cc
+CXX = nxdk-cxx
+
 ifeq ($(UNAME_S),Linux)
-LD           = lld -flavor link
-LIB          = llvm-lib
-AS           = clang
-CC           = clang
-CXX          = clang++
 ifneq ($(UNAME_M),x86_64)
 CGC          = $(NXDK_DIR)/tools/cg/linux/cgc.i386
 else
 CGC          = $(NXDK_DIR)/tools/cg/linux/cgc
 endif #UNAME_M != x86_64
 endif
 ifeq ($(UNAME_S),Darwin)
-LD           = /usr/local/opt/llvm/bin/lld -flavor link
-LIB          = /usr/local/opt/llvm/bin/llvm-lib
-AS           = /usr/local/opt/llvm/bin/clang
-CC           = /usr/local/opt/llvm/bin/clang
-CXX          = /usr/local/opt/llvm/bin/clang++
 CGC          = $(NXDK_DIR)/tools/cg/mac/cgc
 endif
 ifneq (,$(findstring MSYS_NT,$(UNAME_S)))
 $(error Please use a MinGW64 shell)
 endif
 ifneq (,$(findstring MINGW,$(UNAME_S)))
-LD           = lld-link
-LIB          = llvm-lib
-AS           = clang
-CC           = clang
-CXX          = clang++
 CGC          = $(NXDK_DIR)/tools/cg/win/cgc
 endif
 
@@ -51,19 +42,6 @@ VP20COMPILER = $(NXDK_DIR)/tools/vp20compiler/vp20compiler
 FP20COMPILER = $(NXDK_DIR)/tools/fp20compiler/fp20compiler
 EXTRACT_XISO = $(NXDK_DIR)/tools/extract-xiso/build/extract-xiso
 TOOLS        = cxbe vp20compiler fp20compiler extract-xiso
-NXDK_CFLAGS  = -target i386-pc-win32 -march=pentium3 \
-               -ffreestanding -nostdlib -fno-builtin \
-               -I$(NXDK_DIR)/lib -I$(NXDK_DIR)/lib/xboxrt/libc_extensions \
-               -isystem $(NXDK_DIR)/lib/pdclib/include \
-               -I$(NXDK_DIR)/lib/pdclib/platform/xbox/include \
-               -I$(NXDK_DIR)/lib/winapi \
-               -I$(NXDK_DIR)/lib/xboxrt/vcruntime \
-               -DNXDK -D__STDC__=1
-NXDK_ASFLAGS = -target i386-pc-win32 -march=pentium3 \
-               -nostdlib -I$(NXDK_DIR)/lib -I$(NXDK_DIR)/lib/xboxrt
-NXDK_CXXFLAGS = -I$(NXDK_DIR)/lib/libcxx/include $(NXDK_CFLAGS) -fno-exceptions
-NXDK_LDFLAGS = -subsystem:windows -fixed -base:0x00010000 \
-               -stack:65536 -merge:.edata=.edataxb
 
 ifeq ($(DEBUG),y)
 NXDK_ASFLAGS += -g -gdwarf-4
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 nxdk - *the new open source xdk*
 ================================
-nxdk is a software development kit for the original Xbox. nxdk is a revitalization of [OpenXDK](https://web.archive.org/web/20170624051336/http://openxdk.sourceforge.net:80/). 
+nxdk is a software development kit for the original Xbox. nxdk is a revitalization of [OpenXDK](https://web.archive.org/web/20170624051336/http://openxdk.sourceforge.net:80/).
 It is maintained by the [XboxDev](https://github.com/XboxDev/XboxDev) community.
 
 Notable features:
@@ -40,13 +40,11 @@ OS-specific instructions for installing these prerequisites can be found in the
     git clone --recursive https://github.com/XboxDev/nxdk.git
 
 ### Build Samples
-Samples are easily built by running the Makefile in one of the sample directories. Details can be found in the [Wiki](https://github.com/XboxDev/nxdk/wiki/Build-a-Sample). nxdk also supports automatic [creation of ISO files](https://github.com/XboxDev/nxdk/wiki/Create-an-XISO).
+Samples are easily built by running the activation script `bin/activate`, which will spawn a shell that is fully set up to start using nxdk, and then running the Makefile in one of the sample directories. Details can be found in the [Wiki](https://github.com/XboxDev/nxdk/wiki/Build-a-Sample). nxdk also supports automatic [creation of ISO files](https://github.com/XboxDev/nxdk/wiki/Create-an-XISO).
 
 Next Steps
 ----------
-Copy one of the sample directories to get started. You can copy it anywhere you
-like, but make sure that the `NXDK_DIR` variable in the Makefile points to
-correct place. Then, in the directory, you can simply run `make`.
+Copy one of the sample directories to get started. You can copy it anywhere you like. Run nxdk's activation script `bin/activate`, then, in the directory of your program, you can simply run `make`.
 
 Credits
 -------
diff --git a/bin/activate b/bin/activate
@@ -0,0 +1,19 @@
+#!/usr/bin/env sh
+
+readlink_cmd="readlink"
+
+if [ $(uname -s) = 'Darwin' ]; then
+    export PATH=/usr/local/opt/llvm/bin/:$PATH
+    readlink_cmd="greadlink"
+fi
+
+export NXDK_DIR="${NXDK_DIR:-$(dirname $(dirname "$(${readlink_cmd} -f "$0")")../)}"
+export PATH=${NXDK_DIR}/bin:$PATH
+
+if [ "$1" = "-s" ]; then cat <<- DONE
+    export NXDK_DIR="$NXDK_DIR";
+    export PATH="$PATH";
+DONE
+else
+    exec "${@:-$SHELL}"
+fi
diff --git a/bin/nxdk-as b/bin/nxdk-as
@@ -0,0 +1,9 @@
+#!/usr/bin/env sh
+
+clang \
+    -target i386-pc-win32 \
+    -march=pentium3 \
+    -nostdlib \
+    -I${NXDK_DIR}/lib \
+    -I${NXDK_DIR}/lib/xboxrt \
+    "$@"
diff --git a/bin/nxdk-cc b/bin/nxdk-cc
@@ -0,0 +1,18 @@
+#!/usr/bin/env sh
+
+clang \
+    -target i386-pc-win32 \
+    -march=pentium3 \
+    -fuse-ld=nxdk-link \
+    -ffreestanding \
+    -nostdlib \
+    -fno-builtin \
+    -I${NXDK_DIR}/lib \
+    -I${NXDK_DIR}/lib/xboxrt/libc_extensions \
+    -isystem ${NXDK_DIR}/lib/pdclib/include \
+    -I${NXDK_DIR}/lib/pdclib/platform/xbox/include \
+    -I${NXDK_DIR}/lib/winapi \
+    -I${NXDK_DIR}/lib/xboxrt/vcruntime \
+    -DNXDK \
+    -D__STDC__=1 \
+    "$@"
diff --git a/bin/nxdk-cxx b/bin/nxdk-cxx
@@ -0,0 +1,20 @@
+#!/usr/bin/env sh
+
+clang \
+    -target i386-pc-win32 \
+    -march=pentium3 \
+    -fuse-ld=nxdk-link \
+    -ffreestanding \
+    -nostdlib \
+    -fno-builtin \
+    -I${NXDK_DIR}/lib/libcxx/include \
+    -I${NXDK_DIR}/lib \
+    -I${NXDK_DIR}/lib/xboxrt/libc_extensions \
+    -isystem ${NXDK_DIR}/lib/pdclib/include \
+    -I${NXDK_DIR}/lib/pdclib/platform/xbox/include \
+    -I${NXDK_DIR}/lib/winapi \
+    -I${NXDK_DIR}/lib/xboxrt/vcruntime \
+    -DNXDK \
+    -D__STDC__=1 \
+    -fno-exceptions \
+    "$@"
diff --git a/bin/nxdk-lib b/bin/nxdk-lib
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+
+llvm-lib \
+    "$@"
diff --git a/bin/nxdk-link b/bin/nxdk-link
@@ -0,0 +1,9 @@
+#!/usr/bin/env sh
+
+lld -flavor link \
+    -subsystem:windows \
+    -fixed \
+    -base:0x00010000 \
+    -stack:65536 \
+    -merge:.edata=.edataxb \
+    "$@"
diff --git a/docker_entry.sh b/docker_entry.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+set -e
+
+eval $(/usr/src/nxdk/bin/activate -s)
+
+exec "$@"

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +#!/usr/bin/env sh
++
 +llvm-lib \
 +    "$@"