Closer align Makefiles & Dockerfiles (#748)

.ci/switch/buildswitch.bash

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-cp -av /usr/local/lib/libSDL2* /lib/x86_64-linux-gnu/
-git config --global --add safe.directory /soh
-make setup -C soh -j$(nproc) OPTFLAGS=-O2 DEBUG=0 CC="gcc" CXX="g++"
-
-/opt/devkitpro/portlibs/switch/bin/aarch64-none-elf-cmake -B StormLib/build-switch -S StormLib -DCMAKE_INSTALL_PREFIX=/opt/devkitpro/portlibs/switch/
-make -C StormLib/build-switch -j$(nproc)
-make install -C StormLib/build-switch
-
-make -f Makefile.switch -j$(nproc) OPTFLAGS=-O2 DEBUG=0

BUILDING.md

@@ -32,13 +32,6 @@ sudo docker run --rm -it -v $(pwd):/soh soh /bin/bash
 ```
 Inside the Docker container:
 ```bash
-# Clone and build StormLib
-git clone https://github.com/ladislav-zezula/StormLib external/StormLib
-cmake -B external/StormLib/build -S external/StormLib
-cmake --build external/StormLib/build
-cp external/StormLib/build/libstorm.a external
-cp /usr/local/lib/libGLEW.a external
-
 cd soh
 # Extract the assets/Compile the exporter/Run the exporter
 make setup -j$(nproc) OPTFLAGS=-O2 DEBUG=0

Dockerfile

@@ -3,45 +3,56 @@ FROM ubuntu:20.04 as build
 ENV LANG C.UTF-8
 ARG DEBIAN_FRONTEND=noninteractive
 
+ENV GCCVER=10
 RUN apt-get update && \
-	apt-get upgrade -y && \
+    apt-get upgrade -y && \
-	apt-get install -y \
+    apt-get install -y \
-		binutils \
+        binutils \
-		gcc-10 \
+        gcc-${GCCVER} \
-		g++-10 \
+        g++-${GCCVER} \
-		patchelf \
+        p7zip-full \
-		p7zip-full \
+        python3 \
-		python3.9 \
+        make \
-		make \
+        cmake \
-		cmake \
+        curl \
-		curl \
+        git \
-		git \
+        lld \
-		lld \
+        wget \
-		libsdl2-dev \
+        libglew-dev \
-		zlib1g-dev \
+        libsdl2-dev \
-		libbz2-dev \
+        zlib1g-dev \
-		libpng-dev \
+        libbz2-dev \
-		libgles2-mesa-dev && \    
+        libpng-dev \
-	ln -s /usr/bin/g++-10 /usr/bin/g++ && \
+        libgles2-mesa-dev && \    
-	update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 10 && \
+    update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-${GCCVER} 10 && \
-	gcc --version && \
+    update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-${GCCVER} 10 
-	g++ --version
-	
-RUN apt-get clean autoclean && apt-get autoremove --yes && rm -rf /var/lib/apt /var/lib/cache /var/lib/log
 
 RUN git clone https://github.com/Perlmint/glew-cmake.git && \
-	cmake glew-cmake && \
+    cmake glew-cmake && \
-	make -j$(nproc) && \
+    make -j$(nproc) && \
-	make install
+    make install
 
 ENV SDL2VER=2.0.22
 RUN curl -sLO https://libsdl.org/release/SDL2-${SDL2VER}.tar.gz && \
-	tar -xzf SDL2-${SDL2VER}.tar.gz && \
+    tar -xzf SDL2-${SDL2VER}.tar.gz && \
-	cd SDL2-${SDL2VER} && \
+    cd SDL2-${SDL2VER} && \
-	./configure --prefix=/usr && \
+    ./configure --build=x86_64-linux-gnu && \
-	make && make install && \
+    make -j$(nproc) && make install && \
-	rm ../SDL2-${SDL2VER}.tar.gz && \
+    rm ../SDL2-${SDL2VER}.tar.gz
-	cp -av /lib/libSDL* /lib/x86_64-linux-gnu/
+
+RUN \
+    ln -sf /proc/self/mounts /etc/mtab && \
+    mkdir -p /usr/local/share/keyring/ && \
+    wget -O /usr/local/share/keyring/devkitpro-pub.gpg https://apt.devkitpro.org/devkitpro-pub.gpg && \
+    echo "deb [signed-by=/usr/local/share/keyring/devkitpro-pub.gpg] https://apt.devkitpro.org stable main" > /etc/apt/sources.list.d/devkitpro.list && \
+    apt-get update -y && \
+    apt-get install -y devkitpro-pacman && \
+    yes | dkp-pacman -Syu switch-dev switch-portlibs --noconfirm
+
+ENV DEVKITPRO=/opt/devkitpro
+ENV DEVKITARM=/opt/devkitpro/devkitARM
+ENV DEVKITPPC=/opt/devkitpro/devkitPPC
+ENV PATH=$PATH:/opt/devkitpro/portlibs/switch/bin/
 
 RUN mkdir /soh
 WORKDIR /soh

Dockerfile.switch

@@ -1,58 +0,0 @@
-FROM ubuntu:20.04 as build
-
-ENV LANG C.UTF-8
-ARG DEBIAN_FRONTEND=noninteractive
-
-ENV GCCVER=10
-RUN \
-    apt-get update && \
-    apt-get upgrade -y && \
-    apt-get install -y \
-        binutils \
-        gcc-10 \
-        g++-10 \
-        p7zip-full \
-        python3 \
-        make \
-        cmake \
-        curl \
-        git \
-        lld \
-        wget \
-        libsdl2-dev \
-        zlib1g-dev \
-        libbz2-dev \
-        libpng-dev \
-        libgles2-mesa-dev && \    
-    update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-${GCCVER} 10 && \
-    update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-${GCCVER} 10 
-
-RUN git clone https://github.com/Perlmint/glew-cmake.git && \
-    cmake glew-cmake && \
-    make -j$(nproc) && \
-    make install ARCH64=true
-
-ENV SDL2VER=2.0.22
-RUN curl -sLO https://libsdl.org/release/SDL2-${SDL2VER}.tar.gz && \
-    tar -xzf SDL2-${SDL2VER}.tar.gz && \
-    cd SDL2-${SDL2VER} && \
-    ./configure --build=x86_64-linux-gnu && \
-    make && make install && \
-    rm ../SDL2-${SDL2VER}.tar.gz
-
-RUN \
-    ln -sf /proc/self/mounts /etc/mtab && \
-    mkdir -p /usr/local/share/keyring/ && \
-    wget -O /usr/local/share/keyring/devkitpro-pub.gpg https://apt.devkitpro.org/devkitpro-pub.gpg && \
-    echo "deb [signed-by=/usr/local/share/keyring/devkitpro-pub.gpg] https://apt.devkitpro.org stable main" > /etc/apt/sources.list.d/devkitpro.list && \
-    apt-get update -y && \
-    apt-get install -y devkitpro-pacman && \
-    yes | dkp-pacman -Syu switch-dev switch-portlibs --noconfirm
-
-ENV DEVKITPRO=/opt/devkitpro
-ENV DEVKITARM=/opt/devkitpro/devkitARM
-ENV DEVKITPPC=/opt/devkitpro/devkitPPC
-ENV PATH=$PATH:/opt/devkitpro/portlibs/switch/bin/
-
-RUN mkdir /soh
-WORKDIR /soh

Jenkinsfile

@@ -97,8 +97,7 @@ pipeline {
                             cp ../../ZELOOTD.z64 OTRExporter/baserom_non_mq.z64
                             docker build . -t soh
                             docker run --name sohcont -dit --rm -v $(pwd):/soh soh /bin/bash
-                            cp ../../buildsoh.bash soh
+                            docker exec sohcont scripts/linux/build.sh
-                            docker exec sohcont soh/buildsoh.bash
                             
                             mkdir build
                             mv soh/soh.elf build/
@@ -107,7 +106,7 @@ pipeline {
                             mv ZAPDTR/ZAPD.out build/assets/extractor/
                             mv README.md readme.txt
 			    
-                            docker exec sohcont appimage/appimage.sh
+                            docker exec sohcont scripts/linux/build-appimage.sh
 			    
                             7z a soh-linux.7z SOH-Linux.AppImage readme.txt
                             
@@ -143,9 +142,9 @@ pipeline {
                             sh '''
                             cp ../../ZELOOTD.z64 OTRExporter/baserom_non_mq.z64
                             cd soh
-                            make setup -j4 OPTFLAGS=-O2 DEBUG=0 LD="ld"
+                            make setup -j$(sysctl -n hw.physicalcpu) OPTFLAGS=-O2 DEBUG=0 LD="ld"
-                            make -j4 DEBUG=0 OPTFLAGS=-O2 LD="ld"
+                            make -j$(sysctl -n hw.physicalcpu) DEBUG=0 OPTFLAGS=-O2 LD="ld"
-                            make -j4 appbundle
+                            make appbundle
                             mv ../README.md readme.txt
                             7z a soh-mac.7z soh.app readme.txt
                             '''
@@ -177,9 +176,9 @@ pipeline {
                             sh '''
                             
                             cp ../../ZELOOTD.z64 OTRExporter/baserom_non_mq.z64
-                            docker build . -t sohswitch -f Dockerfile.switch
+                            docker build . -t sohswitch
                             docker run --name sohcont -dit --rm -v $(pwd):/soh sohswitch /bin/bash
-                            docker exec sohcont .ci/switch/buildswitch.bash
+                            docker exec sohcont scripts/switch/build.sh
                             
                             mv soh/soh.nro .
                             mv README.md readme.txt

ZAPDTR/Makefile

@@ -48,11 +48,15 @@ endif
 LDFLAGS := -Llib/libgfxd -L../libultraship -L../StormLib/build \
   -pthread -lgfxd -lultraship ZAPDUtils/ZAPDUtils.a -lstorm -lbz2 -lm -ldl
 
+LDFLAGS += $(shell pkg-config --libs glew libpng zlib) $(shell sdl2-config --libs)
+INC += $(shell pkg-config --cflags libpng)
+
 ifeq ($(UNAME), Darwin)
-  LDFLAGS += $(shell pkg-config --libs glew libpng zlib) $(shell sdl2-config --libs) -framework OpenGL -framework Foundation
+  LDFLAGS += -framework OpenGL -framework Foundation
-  INC += $(shell pkg-config --cflags libpng)
+endif
-else
+
-  LDFLAGS += -lpng -lGL -lGLEW -lX11 -lz -lSDL2 -lpulse
+ifeq ($(UNAME), Linux)
+  LDFLAGS += $(shell pkg-config --libs x11 libpulse)
 endif
 
 # Use LLD if available. Set LLD=0 to not use it
@@ -65,10 +69,12 @@ ifneq ($(LLD),0)
 endif
 
 UNAMEM := $(shell uname -m)
-ifneq ($(UNAME), Darwin)
+ifeq ($(UNAME), Linux)
   LDFLAGS += -Wl,-export-dynamic -lstdc++fs
   EXPORTERS := -Wl,--whole-archive ../OTRExporter/OTRExporter/OTRExporter.a -Wl,--no-whole-archive
-else
+endif
+
+ifeq ($(UNAME), Darwin)
   EXPORTERS := -Wl,-force_load ../OTRExporter/OTRExporter/OTRExporter.a
 endif
 

libultraship/Makefile

@@ -29,7 +29,6 @@ WARN := -Wall -Wextra -Werror \
 	-Wno-narrowing \
 	-Wno-missing-field-initializers \
 	-Wno-error=multichar \
-	-Wno-unused-command-line-argument \
 	-Wno-delete-non-abstract-non-virtual-dtor \
 	-Wno-unused-private-field \
 	-Wno-deprecated-copy-with-user-provided-copy \
@@ -46,7 +45,7 @@ endif
 
 CXXFLAGS := $(WARN) $(CXXWARN) -std=c++20 -D_GNU_SOURCE -DENABLE_OPENGL -DSPDLOG_ACTIVE_LEVEL=0
 CFLAGS := $(WARN) $(CWARN) -std=c99 -D_GNU_SOURCE -DENABLE_OPENGL -DSPDLOG_ACTIVE_LEVEL=0
-CPPFLAGS := -MMD
+CPPFLAGS := -MMD $(shell pkg-config --cflags sdl2 glew)
 
 MMFLAGS := -Wno-deprecated-declarations -ObjC++ -fobjc-weak -fobjc-arc
 
@@ -62,10 +61,6 @@ ifneq ($(CXX_IS_CLANG),1)
 	MMFLAGS += -stdlib++-isystem ${STD_ISYSTEM} -cxx-isystem ${CXX_ISYSTEM}
 endif
 
-ifeq ($(UNAME), Darwin) #APPLE
-	CPPFLAGS += $(shell pkg-config --cflags sdl2 glew) -framework OpenGL -framework Foundation
-endif
-
 ifneq ($(DEBUG),0)
 	CXXFLAGS += -g -D_DEBUG
 	CFLAGS += -g -D_DEBUG

scripts/linux/build-appimage.sh

@@ -6,7 +6,7 @@ curl -sSfL https://github.com$(curl https://github.com/probonopd/go-appimage/rel
 chmod a+x mkappimage.AppImage
  
 mkdir -p AppDir/usr/bin
-cp appimage/{soh.desktop,soh.sh} AppDir/
+cp scripts/linux/{soh.desktop,soh.sh} AppDir/
 cp soh/macosx/sohIcon.png AppDir/soh.png
 curl -sSfL https://raw.githubusercontent.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt -o AppDir/usr/bin/gamecontrollerdb.txt
 

scripts/linux/build.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+cd soh
+make setup -j$(nproc) OPTFLAGS=-O2 DEBUG=0
+make -j$(nproc) OPTFLAGS=-O2 DEBUG=0
+
+cd ../OTRGui
+mkdir build
+cd build
+cmake ..
+cmake --build . --config Release

scripts/switch/build.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+make setup -C soh -j$(nproc) OPTFLAGS=-O2 DEBUG=0
+make -f Makefile.switch -j$(nproc)

soh/Makefile

@@ -16,26 +16,35 @@ DEBUG ?= 1
 OPTFLAGS ?= -O0
 LTO ?= 0
 
+# flag to save whether the compiler being used is clang or gcc by checking CXX --version
+CXX_IS_CLANG ?= $(shell $(CXX) --version | grep -c clang)
+
 WARN := \
 	-Wno-return-type \
-	-Wno-unused-command-line-argument \
-	-Wno-implicit-function-declaration \
-	-Wno-c++11-narrowing \
 	-funsigned-char \
 	-fno-stack-protector -fno-common -fno-zero-initialized-in-bss -fno-strict-aliasing -fno-inline-functions -fno-inline-small-functions -ffreestanding -fwrapv \
 
-CXXFLAGS := $(WARN) -std=c++20 -D_GNU_SOURCE -fpermissive -no-pie -nostdlib
+ifeq ($(CXX_IS_CLANG),1)
-CFLAGS := $(WARN) -std=c99 -D_GNU_SOURCE -no-pie -nostdlib
+	WARN += -Wno-c++11-narrowing
-LDFLAGS :=
-
-ifeq ($(UNAME), Linux) #LINUX
-	CXXFLAGS += -mhard-float -msse2 -mfpmath=sse
-	CFLAGS += -mhard-float -msse2 -mfpmath=sse
 endif
 
-ifeq ($(UNAME), Darwin) #APPLE
+CXXFLAGS := $(WARN) -std=c++20 -D_GNU_SOURCE -fpermissive -nostdlib $(shell pkg-config --cflags glew) $(shell sdl2-config --cflags)
-	CXXFLAGS += $(shell pkg-config --cflags sdl2) $(shell sdl2-config --cflags) $(shell pkg-config --cflags glew) -framework OpenGL
+CFLAGS := $(WARN) -std=c99 -Wno-implicit-function-declaration -D_GNU_SOURCE -nostdlib $(shell pkg-config --cflags glew) $(shell sdl2-config --cflags)
-	CFLAGS += $(shell pkg-config --cflags sdl2) $(shell sdl2-config --cflags) $(shell pkg-config --cflags glew) -framework OpenGL
+LDFLAGS :=
+
+ifneq ($(CXX_IS_CLANG),1)
+	CXXFLAGS += -no-pie
+	CFLAGS += -no-pie
+endif
+
+ifeq ($(UNAME), Linux)
+	ifeq ($(UNAMEM), x86_64)
+		CXXFLAGS += -msse2 -mfpmath=sse -mhard-float
+		CFLAGS += -msse2 -mfpmath=sse -mhard-float
+	endif
+
+	CXXFLAGS += $(shell pkg-config --cflags libpulse)
+	CFLAGS += $(shell pkg-config --cflags libpulse)
 endif
 
 CPPFLAGS := -MMD
@@ -57,11 +66,11 @@ ifneq ($(LTO),0)
 	LDFLAGS += -flto
 endif
 
-ifeq ($(UNAME), Linux) #LINUX
+ifeq ($(UNAME), Linux)
 TARGET := soh.elf
 endif
 
-ifeq ($(UNAME), Darwin) #APPLE
+ifeq ($(UNAME), Darwin)
 TARGET := soh-$(UNAMEM)
 endif
 
@@ -78,25 +87,15 @@ INC_DIRS := $(addprefix -I, \
 	../libultraship/libultraship/Lib/Fast3D/U64/PR \
 )
 
-ifeq ($(UNAME), Linux) #LINUX
-	INC_DIRS += $(addprefix -I, \
-		/opt/X11/include \
-)
-endif
-
 LDDIRS := $(addprefix -L, \
 	../libultraship/ \
 )
 
-ifeq ($(UNAME), Linux) #LINUX
-	LDDIRS += $(addprefix -L, \
-		/opt/X11/lib \
-)
-endif
-
 LDLIBS := \
 	$(ZAPDUTILS) \
 	$(LIBSTORM) \
+	$(shell sdl2-config --libs) \
+	$(shell pkg-config --libs glew) \
 	$(addprefix -l, \
 	dl \
 	bz2 \
@@ -105,24 +104,16 @@ LDLIBS := \
 	ultraship \
 )
 
-ifeq ($(UNAME), Linux) #LINUX
+ifeq ($(UNAME), Linux)
-LDLIBS += \
+LDLIBS += $(shell pkg-config --libs x11 libpulse)
-	$(addprefix -l, \
-	X11 \
-	SDL2 \
-	GL \
-	GLEW \
-	pulse \
-)
 endif
 
-ifeq ($(UNAME), Darwin) #APPLE
+ifeq ($(UNAME), Darwin)
 LDLIBS += \
 	$(addprefix -framework , \
 	OpenGL \
 	Foundation \
-) \
+)
-	$(shell sdl2-config --libs) $(shell pkg-config --libs glew)
 endif
 
 ASSET_BIN_DIRS := $(shell find assets/* -type d -not -path "assets/xml*")

soh/include/z64.h

@@ -30,7 +30,7 @@
 #include "ichain.h"
 #include "regs.h"
 
-#if defined(_WIN64) || defined(__x86_64__) || defined(__arm64__)
+#if defined(__LP64__) 
 #define _SOH64
 #endif
 

soh/soh/Enhancements/debugger/debugSaveEditor.cpp

@@ -1001,7 +1001,7 @@ void DrawFlagsTab() {
 
 // Draws a combo that lets you choose and upgrade value from a drop-down of text values
 void DrawUpgrade(const std::string& categoryName, int32_t categoryId, const std::vector<std::string>& names) {
-    ImGui::Text(categoryName.c_str());
+    ImGui::Text("%s", categoryName.c_str());
     ImGui::SameLine();
     ImGui::PushID(categoryName.c_str());
     if (ImGui::BeginCombo("##upgrade", names[CUR_UPG_VALUE(categoryId)].c_str())) {