Merge Development: Options Menu v2.0.0

.gitattributes

@@ -0,0 +1,12 @@
+# The mod's scripts and command config files are parsed/executed by the
+# console's BusyBox shell and this project's own line-based parsers, neither
+# of which tolerate CRLF (a stray \r ends up embedded in paths/values,
+# e.g. COMMAND_STR=sh %script_dir%/om_network\r causes "No such file").
+# Force LF regardless of platform checkout settings (core.autocrlf, etc.).
+* text=auto eol=lf
+
+*.png binary
+*.xz binary
+*.hmod binary
+*.ttf binary
+mod/etc/options_menu/retroarch/scripts/RASettingsBackup binary

.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: Build
+
+on:
+  push:
+    branches: ['**']
+    tags: ['v*']
+  pull_request:
+
+jobs:
+  hmod:
+    # Keep in sync with the vendor/hmod-build submodule tag.
+    uses: DefKorns/hmod-build/.github/workflows/hmod.yml@v1.5.0
+    with:
+      release-name: Options Menu
+      docker: true
+      # the compat build relinks with its own rpath and adds a private libstdc++
+      make: |
+        hmod
+        hmod FIX_LIBSTDCXX=1
+    secrets: inherit
+    permissions:
+      contents: write

.gitignore

@@ -0,0 +1,16 @@
+*.o
+.build-flags
+src/cacert.pem
+out/
+local/
+mod/bin/
+!mod/bin/standby
+mod/etc/options_menu/lib/
+mod/etc/options_menu/optiond
+mod/etc/options_menu/options
+mod/etc/options_menu/mod_uninstall/mod_uninstall
+mod/etc/options_menu/save_manager/save_manager
+mod/etc/options_menu/scripts/ChangeCombo
+mod/etc/options_menu/scripts/gen_splash
+mod/etc/options_menu/scripts/downloader
+mod/etc/options_menu/fonts/NotoSansJP-Latin-subset.ttf

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "hmod-build"]
+	path = vendor/hmod-build
+	url = https://github.com/DefKorns/hmod-build.git

Makefile

@@ -1,43 +1,149 @@
-TARGET_NAME = options_deluxe
+# FIX_LIBSTDCXX=1 builds the _compat variant: it ships a private libstdc++.so.6
+# via rpath, immune to other hmods replacing the system copy (~225KB more).
+ifdef FIX_LIBSTDCXX
+MOD_ID   := options_menu_compat
+MOD_NAME := Options Menu (compat)
+VARIANT  := compat
+else
+MOD_ID   := options_menu
+MOD_NAME := Options Menu
+VARIANT  := plain
+endif
+MOD_CREATOR  := CompCom, DefKorns
+MOD_CATEGORY := Options Menu
+BINARIES     := mod/etc/options_menu/options mod/etc/options_menu/optiond mod/etc/options_menu/mod_uninstall/mod_uninstall mod/etc/options_menu/save_manager/save_manager mod/bin/standby_watchdog mod/etc/options_menu/scripts/gen_splash mod/etc/options_menu/scripts/ChangeCombo mod/etc/options_menu/scripts/downloader
+
 CXX = g++
 STRIP = strip
-CXXFLAGS = -std=c++11 -Os `sdl2-config --cflags`
-LDLIBS =  `sdl2-config --libs` -lpng
-LDFLAGS = 
-SOURCES = src/main.cpp src/command.cpp src/framework/sdl_context.cpp src/framework/texture.cpp src/framework/controller.cpp src/framework/powerwatch.cpp
+ifdef CROSS_PREFIX
+PKG_CONFIG_LIBDIR = /usr/lib/arm-linux-gnueabihf/pkgconfig
+SDL_CFLAGS = -I/usr/include/arm-linux-gnueabihf $(shell PKG_CONFIG_LIBDIR=$(PKG_CONFIG_LIBDIR) pkg-config --cflags sdl2 SDL2_ttf libpng)
+SDL_LIBS = $(shell PKG_CONFIG_LIBDIR=$(PKG_CONFIG_LIBDIR) pkg-config --libs sdl2 SDL2_ttf libpng)
+PNG_LIBS = $(shell PKG_CONFIG_LIBDIR=$(PKG_CONFIG_LIBDIR) pkg-config --libs libpng)
+LDFLAGS = -Wl,--allow-shlib-undefined
+VENDORED_LIBS = mod/etc/options_menu/lib/libSDL2_ttf-2.0.so.0 mod/etc/options_menu/lib/libfreetype.so.6
+ifdef FIX_LIBSTDCXX
+VENDORED_LIBS += mod/etc/options_menu/lib/libstdc++.so.6
+STDCXX_RPATH = -Wl,-rpath,/etc/options_menu/lib
+STDCXX_RPATH_ORIGIN = -Wl,-rpath,'$$ORIGIN/lib'
+endif
+else
+SDL_CFLAGS = $(shell sdl2-config --cflags) $(shell pkg-config --cflags SDL2_ttf)
+SDL_LIBS = $(shell sdl2-config --libs) $(shell pkg-config --libs SDL2_ttf) -lpng
+PNG_LIBS = -lpng
+LDFLAGS =
+VENDORED_LIBS =
+endif
+CXXFLAGS = -std=c++11 -Os $(SDL_CFLAGS) -DMOD_VERSION=\"v$(MOD_VER)\"
+LDLIBS = $(SDL_LIBS)
+SOURCES = src/main.cpp src/command.cpp src/localization.cpp src/framework/badge.cpp src/framework/dialog.cpp src/framework/sdl_context.cpp src/framework/texture.cpp src/framework/controller.cpp src/framework/powerwatch.cpp src/framework/draw_helpers.cpp src/framework/utf8.cpp src/framework/font8x8_lookup.cpp src/framework/uitheme.cpp src/framework/list_jump.cpp
 OBJECTS = $(SOURCES:.cpp=.o)
+ALL_OBJECTS = $(OBJECTS) src/daemon.o src/mod_uninstall.o src/save_manager.o src/standby_watchdog.o src/gen_splash.o src/change_combo.o
+
+MOD_DEPS := $(BINARIES) $(VENDORED_LIBS)
+ifndef FIX_LIBSTDCXX
+# a prior compat build leaves this behind in mod/
+MOD_DEPS += no-private-libstdcxx
+endif
+
+# built into the toolchain image from Noto Sans JP (see its README), not tracked
+FONT_LATIN := mod/etc/options_menu/fonts/NotoSansJP-Latin-subset.ttf
+MOD_DEPS += $(FONT_LATIN)
+
+all: hmod
+
+compile: $(BINARIES) $(VENDORED_LIBS)
 
-all: $(TARGET_NAME).hmod $(TARGET_NAME)_b_down.hmod
+# relink everything when switching variant (different rpaths) or version (MOD_VERSION)
+.build-flags: FORCE
+	@[ "$$(cat $@ 2>/dev/null)" = "$(VARIANT) $(MOD_VER)" ] || echo "$(VARIANT) $(MOD_VER)" > $@
 
-$(TARGET_NAME)_b_down.hmod: $(TARGET_NAME).hmod
-	cp button.cfg mod/etc/options_menu/
-	cd mod/; tar -czvf "../$(TARGET_NAME)_b_down.hmod" *
+$(ALL_OBJECTS): .build-flags
 
-$(TARGET_NAME).hmod: mod/etc/options_menu/options mod/etc/options_menu/optiond mod/etc/options_menu/mod_uninstall/mod_uninstall mod/bin/standby_watchdog
-	$(CROSS_PREFIX)$(STRIP) mod/etc/options_menu/options
-	$(CROSS_PREFIX)$(STRIP) mod/etc/options_menu/optiond
-	$(CROSS_PREFIX)$(STRIP) mod/etc/options_menu/mod_uninstall/mod_uninstall
-	$(CROSS_PREFIX)$(STRIP) mod/bin/standby_watchdog
-	rm -f mod/etc/options_menu/button.cfg
-	cd mod/; tar -czvf "../$(TARGET_NAME).hmod" *
+no-private-libstdcxx:
+	rm -f mod/etc/options_menu/lib/libstdc++.so.6
 
+# SDL2_ttf/freetype aren't on the console's own rootfs; shipped as
+# mod/etc/options_menu/lib/*.so and found via rpath instead.
 mod/etc/options_menu/options: $(OBJECTS)
-	$(CROSS_PREFIX)$(CXX) $(OBJECTS) $(LDLIBS) $(LDFLAGS) -o mod/etc/options_menu/options
+	$(CROSS_PREFIX)$(CXX) $(OBJECTS) $(LDLIBS) $(LDFLAGS) -Wl,-rpath,'$$ORIGIN/lib' -o $@
+	$(CROSS_PREFIX)$(STRIP) $@
+
+mod/etc/options_menu/lib:
+	mkdir -p $@
+
+# always copied, so a new image can't leave a stale font behind
+$(FONT_LATIN): FORCE
+	cp /opt/options-menu/fonts/NotoSansJP-Latin-subset.ttf $@
+
+# built from source in the toolchain image, copied in each build
+mod/etc/options_menu/lib/libSDL2_ttf-2.0.so.0: | mod/etc/options_menu/lib
+	cp /usr/lib/arm-linux-gnueabihf/libSDL2_ttf-2.0.so.0 $@
+
+mod/etc/options_menu/lib/libfreetype.so.6: | mod/etc/options_menu/lib
+	cp /usr/lib/arm-linux-gnueabihf/libfreetype.so.6 $@
+
+mod/etc/options_menu/lib/libstdc++.so.6: | mod/etc/options_menu/lib
+	cp $$($(CROSS_PREFIX)$(CXX) -print-file-name=libstdc++.so.6) $@
+	$(CROSS_PREFIX)$(STRIP) --strip-unneeded $@
 
 mod/etc/options_menu/optiond: src/daemon.o src/framework/controller.o
-	$(CROSS_PREFIX)$(CXX) $(LDFLAGS) src/daemon.o src/framework/controller.o -o mod/etc/options_menu/optiond
+	$(CROSS_PREFIX)$(CXX) $(LDFLAGS) $^ $(STDCXX_RPATH_ORIGIN) -o $@
+	$(CROSS_PREFIX)$(STRIP) $@
 
-mod/etc/options_menu/mod_uninstall/mod_uninstall: src/mod_uninstall.o
-	$(CROSS_PREFIX)$(CXX) src/mod_uninstall.o src/framework/*.o $(LDLIBS) $(LDFLAGS) -o mod/etc/options_menu/mod_uninstall/mod_uninstall
+mod/etc/options_menu/mod_uninstall/mod_uninstall: src/mod_uninstall.o src/localization.o $(filter src/framework/%,$(OBJECTS))
+	$(CROSS_PREFIX)$(CXX) $^ $(LDLIBS) $(LDFLAGS) -Wl,-rpath,/etc/options_menu/lib -o $@
+	$(CROSS_PREFIX)$(STRIP) $@
+	upx --lzma $@
+
+mod/etc/options_menu/save_manager/save_manager: src/save_manager.o src/localization.o $(filter src/framework/%,$(OBJECTS))
+	$(CROSS_PREFIX)$(CXX) $^ $(LDLIBS) $(LDFLAGS) -Wl,-rpath,/etc/options_menu/lib -o $@
+	$(CROSS_PREFIX)$(STRIP) $@
+	upx --lzma $@
 
 mod/bin/standby_watchdog: src/standby_watchdog.o src/framework/controller.o src/framework/powerwatch.o
-	$(CROSS_PREFIX)$(CXX) src/standby_watchdog.o src/framework/controller.o src/framework/powerwatch.o -o mod/bin/standby_watchdog
+	$(CROSS_PREFIX)$(CXX) $(LDFLAGS) $^ $(STDCXX_RPATH) -o $@
+	$(CROSS_PREFIX)$(STRIP) $@
+	upx --lzma $@
+
+mod/etc/options_menu/scripts/gen_splash: src/gen_splash.o src/localization.o src/framework/utf8.o src/framework/font8x8_lookup.o src/framework/uitheme.o
+	$(CROSS_PREFIX)$(CXX) $^ $(PNG_LIBS) $(LDFLAGS) $(STDCXX_RPATH) -o $@
+	$(CROSS_PREFIX)$(STRIP) $@
+
+mod/etc/options_menu/scripts/ChangeCombo: src/change_combo.o src/framework/controller.o src/localization.o
+	$(CROSS_PREFIX)$(CXX) $^ $(LDFLAGS) $(STDCXX_RPATH) -o $@
+	$(CROSS_PREFIX)$(STRIP) $@
+	upx --lzma $@
+
+# plain C against the toolchain's static curl: no libstdc++, same in both variants
+CC = gcc
+CURL_PREFIX = /opt/curl-static
+CFLAGS = -std=gnu99 -O2 -Wall -I$(CURL_PREFIX)/include
+CURL_LDLIBS = $(shell $(CURL_PREFIX)/bin/curl-config --static-libs)
+
+src/cacert.pem:
+	curl -fL -o $@ https://curl.se/ca/cacert.pem
+
+# built from inside src/ so the symbols are _binary_cacert_pem_*
+src/ca_bundle.o: src/cacert.pem
+	cd src && $(CROSS_PREFIX)ld -r -b binary -o ca_bundle.o cacert.pem
+
+mod/etc/options_menu/scripts/downloader: src/downloader.o src/ca_bundle.o
+	$(CROSS_PREFIX)$(CC) $^ $(CURL_LDLIBS) -o $@
+	$(CROSS_PREFIX)$(STRIP) $@
+	upx --lzma $@
+
+%.o: %.c
+	$(CROSS_PREFIX)$(CC) $(CFLAGS) -c $< -o $@
 
 %.o: %.cpp
 	$(CROSS_PREFIX)$(CXX) $(CXXFLAGS) -c $< -o $@
 
 clean:
-	find -name "*.o" -type f -delete
-	rm -f mod/etc/options_menu/options mod/etc/options_menu/optiond mod/etc/options_menu/mod_uninstall/mod_uninstall mod/bin/standby_watchdog mod/etc/options_menu/button.cfg $(TARGET_NAME).hmod $(TARGET_NAME)_b_down.hmod
+	find . -name "*.o" -type f -not -path "./vendor/*" -delete
+	rm -f $(BINARIES) .build-flags
+	rm -rf mod/etc/options_menu/lib out/
+
+include vendor/hmod-build/hmod.mk
 
-.PHONY: clean
+.PHONY: all compile clean no-private-libstdcxx