# The MIT License (MIT)
#
# Copyright (C) 2026 Scott Duensing
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

# T10 -- libtasks on x86_64 and the DVX shell app loader driven by dvxtest.
#
#   make -C src/test/shell          # build + run both binaries (SAN=1)
#   make -C src/test/shell SAN=0

include ../dvxtest/dvxtest.mk

.DEFAULT_GOAL := all

SHELLDIR    = $(DVXTEST_ROOT)/src/libs/kpunch/dvxshell
APPS_SO_DIR = $(DVXTEST_OBJDIR)/apps
BINDIR      = $(DVXTEST_BINDIR)/shell
TASKS_TEST  = $(BINDIR)/tasksTest
SHELL_TEST  = $(BINDIR)/shellTest
APPS_TEST   = $(BINDIR)/appsTest
SHMAIN_TEST = $(BINDIR)/shellMainTest
PM_TEST     = $(BINDIR)/progmanTest
PM_DIR      = $(DVXTEST_ROOT)/src/apps/kpunch/progman
LOADER_TEST = $(BINDIR)/loaderTest
HLPC_SRC    = $(DVXTEST_ROOT)/src/tools/dvxhlpc.c
HLPC_OBJ    = $(BINDIR)/dvxhlpcLib.o
FIXDIR      = $(BINDIR)/fixtures
FIX_SRCS    = $(wildcard fixtures/fix*.c)
FIX_SOS     = $(patsubst fixtures/%.c,$(FIXDIR)/%.so,$(FIX_SRCS))
FIX_HLP     = $(FIXDIR)/fixture.hlp
HLPC        = $(DVXTEST_ROOT)/bin/host/dvxhlpc
HELP_FIX    = $(DVXTEST_ROOT)/src/test/tools/fixtures/help
SHELL_SRCS  = $(SHELLDIR)/shellApp.c $(SHELLDIR)/shellBas.c $(SHELLDIR)/shellSysBas.c $(SHELLDIR)/shellMain.c $(SHELLDIR)/shellInfo.c $(SHELLDIR)/shellAssoc.c $(SHELLDIR)/shellProg.c $(SHELLDIR)/shellRun.c $(SHELLDIR)/shellSaver.c $(SHELLDIR)/pmModel.c $(SHELLDIR)/pmModelBas.c
SHELL_OBJS  = $(patsubst $(SHELLDIR)/%.c,$(BINDIR)/%.o,$(SHELL_SRCS))
SHELL_BINS  = $(SHELL_TEST) $(APPS_TEST) $(SHMAIN_TEST) $(PM_TEST)
SHFIX_OBJ   = $(BINDIR)/shellFixture.o
SHFIX_BINS  = $(SHELL_TEST) $(APPS_TEST) $(PM_TEST)
TEST_BINS   = $(TASKS_TEST) $(SHELL_BINS) $(LOADER_TEST)
LIBS_A      = $(DVXTEST_ARCHIVES) $(DVXTEST_TASKS_A)

# The frame-pointer check in tasksTest reads __builtin_frame_address.
# A BASIC program on the host (dvxtest.mk): the stub as a .so, the
# runtime linked into appsTest.

# File Manager (run by appsTest to open a document) calls the fileops
# library, which a DOS system loads as a .lib.
FILEOPS_DIR  = $(DVXTEST_ROOT)/src/libs/kpunch/fileops
FILEOPS_OBJS = $(patsubst $(FILEOPS_DIR)/%.c,$(BINDIR)/fileops/%.o,$(wildcard $(FILEOPS_DIR)/*.c))

# The Control Panel's Game Controllers page looks the joystick library up
# by name; appsTest links it in, and the case installs the keyboard
# joystick driver module (no game port on the host) where the library
# looks for drivers.
JOY_DIR      = $(DVXTEST_ROOT)/src/libs/kpunch/joystick
JOY_OBJS     = $(patsubst $(JOY_DIR)/%.c,$(BINDIR)/joystick/%.o,$(wildcard $(JOY_DIR)/*.c))
JOYKEYS_DRV  = $(BINDIR)/joykeys.drv

# The screen savers (BASIC programs) pace their frames with FRAMEWAIT,
# which looks the game library's frame pacer up by name.
GAME_DIR     = $(DVXTEST_ROOT)/src/libs/kpunch/game
GAME_OBJ     = $(BINDIR)/game/game.o

# ... and its Sounds page the sound library (no drivers: no sound device).
AUDIO_DIR    = $(DVXTEST_ROOT)/src/libs/kpunch/audio
AUDIO_OBJS   = $(patsubst $(AUDIO_DIR)/%.c,$(BINDIR)/audio/%.o,$(filter-out $(AUDIO_DIR)/audioShell.c,$(wildcard $(AUDIO_DIR)/*.c)))

CFLAGS      = $(DVXTEST_CFLAGS) -fno-omit-frame-pointer -I$(SHELLDIR) -I$(PM_DIR) -DDVXTEST_APPS_DIR='"$(APPS_SO_DIR)"' -DDVXTEST_FIXTURES_DIR='"$(FIXDIR)"' -DSHELLTEST_BASSTUB_SO='"$(DVXTEST_BASSTUB_SO)"' -DSHELLTEST_BASCOMP='"$(DVXTEST_BASCOMP)"' -DSHELLTEST_JOYKEYS_DRV='"$(JOYKEYS_DRV)"'

.PHONY: all run clean host-tools

all: run

$(BINDIR)/%.o: $(SHELLDIR)/%.c $(DVX_MAKEFILES)
	@mkdir -p $(BINDIR)
	$(HOSTCC) $(CFLAGS) -c -o $@ $<

# The shared shell harness, linked into the suites that drive the shell.
$(SHFIX_OBJ): shellFixture.c $(DVX_MAKEFILES)
	@mkdir -p $(BINDIR)
	$(HOSTCC) $(CFLAGS) -c -o $@ $<

# The help compiler's library entry point, for loaderTest and appsTest
# (BASIC HelpCompile in the parhlp fixture).
$(HLPC_OBJ): $(HLPC_SRC) $(DVX_MAKEFILES)
	@mkdir -p $(BINDIR)
	$(HOSTCC) $(CFLAGS) -DHLPC_NO_MAIN -c -o $@ $<

# Every test binary is one source file (-MMD writes <binary>.d) plus
# objects and archives; the archives are prerequisites so a library
# change relinks the binaries that use it.
$(TASKS_TEST): tasksTest.c $(DVX_MAKEFILES) $(LIBS_A) | dvxtest-libs
	@mkdir -p $(BINDIR)
	$(HOSTCC) $(CFLAGS) -o $@ tasksTest.c $(DVXTEST_LDFLAGS) -Wl,--whole-archive $(DVXTEST_TASKS_A) $(DVXTEST_LIB) -Wl,--no-whole-archive $(DVXTEST_LIBDVX_A) -ldl -lm

$(SHFIX_BINS): EXTRA_OBJS = $(SHFIX_OBJ)
$(SHFIX_BINS): $(SHFIX_OBJ)


$(APPS_TEST): EXTRA_OBJS = $(SHFIX_OBJ) $(FILEOPS_OBJS) $(JOY_OBJS) $(AUDIO_OBJS) $(GAME_OBJ) $(HLPC_OBJ) -Wl,--whole-archive $(DVXTEST_BASRT_A) -Wl,--no-whole-archive
$(APPS_TEST): $(FILEOPS_OBJS) $(JOY_OBJS) $(AUDIO_OBJS) $(GAME_OBJ) $(HLPC_OBJ) $(DVXTEST_BASRT_A) $(DVXTEST_BASSTUB_SO) $(JOYKEYS_DRV) | dvxtest-bascomp

$(JOYKEYS_DRV): $(JOY_DIR)/drivers/joykeys/joyKeys.c $(DVX_MAKEFILES)
	@mkdir -p $(BINDIR)
	$(HOSTCC) $(CFLAGS) -I$(DVXTEST_ROOT)/src/libs/kpunch -shared -o $@ $<

$(BINDIR)/audio/%.o: $(AUDIO_DIR)/%.c $(DVX_MAKEFILES)
	@mkdir -p $(dir $@)
	$(HOSTCC) $(CFLAGS) -I$(DVXTEST_ROOT)/src/libs/kpunch -I$(AUDIO_DIR) -c -o $@ $<

$(GAME_OBJ): $(GAME_DIR)/game.c $(DVX_MAKEFILES)
	@mkdir -p $(dir $@)
	$(HOSTCC) $(CFLAGS) -I$(DVXTEST_ROOT)/src/libs/kpunch -I$(GAME_DIR) -c -o $@ $<

$(BINDIR)/joystick/%.o: $(JOY_DIR)/%.c $(DVX_MAKEFILES)
	@mkdir -p $(dir $@)
	$(HOSTCC) $(CFLAGS) -I$(DVXTEST_ROOT)/src/libs/kpunch -I$(JOY_DIR) -c -o $@ $<

$(BINDIR)/fileops/%.o: $(FILEOPS_DIR)/%.c $(DVX_MAKEFILES)
	@mkdir -p $(dir $@)
	$(HOSTCC) $(CFLAGS) -I$(DVXTEST_ROOT)/src/libs/kpunch -c -o $@ $<

$(SHELL_BINS): $(BINDIR)/%: %.c $(SHELL_OBJS) $(DVX_MAKEFILES) $(LIBS_A) | dvxtest-libs dvxtest-apps
	@mkdir -p $(BINDIR)
	$(HOSTCC) $(CFLAGS) -o $@ $< $(SHELL_OBJS) $(EXTRA_OBJS) $(DVXTEST_LDFLAGS) -Wl,--whole-archive $(DVXTEST_LIBDVX_A) $(DVXTEST_TASKS_A) $(DVXTEST_LIB) -Wl,--no-whole-archive -ldl -lm

# loaderMain.c is #included (main renamed) and brings its own stb_ds
# implementation, so libdvx.a is linked normally, not whole-archive.
$(LOADER_TEST): loaderTest.c $(HLPC_OBJ) $(DVX_MAKEFILES) $(DVXTEST_ARCHIVES) | dvxtest-libs
	@mkdir -p $(BINDIR)
	$(HOSTCC) $(CFLAGS) -o $@ loaderTest.c $(HLPC_OBJ) $(DVXTEST_LDFLAGS) $(DVXTEST_LIB) $(DVXTEST_LIBDVX_A) -ldl -lm

$(FIXDIR)/%.so: fixtures/%.c $(DVX_MAKEFILES)
	@mkdir -p $(FIXDIR)
	$(HOSTCC) $(CFLAGS) -fPIC -shared $(HOST_APP_LDFLAGS) -o $@ $<

# The host tools (dvxhlpc, dvxres) are brought up to date once, before
# anything runs them: the apps host build executes dvxres, and a relink
# racing that exec would fail.  Built COV=0 so a coverage run of this suite
# never redirects the tools into obj/hostcov.
host-tools:
	$(MAKE) -C $(DVXTEST_ROOT)/src/tools host COV=0

dvxtest-apps: | host-tools

$(HLPC): host-tools
	@:

# The dvxhelp fixture: the tools suite's every-directive help source,
# compiled with the host dvxhlpc (rebuilt when the compiler changes).
$(FIX_HLP): $(HELP_FIX)/main.dhs $(HELP_FIX)/inc.dhs $(HELP_FIX)/extra.dhs $(HLPC)
	@mkdir -p $(FIXDIR)
	cd $(HELP_FIX) && $(HLPC) -o $(FIX_HLP) --quiet -i . main.dhs @inputs.txt

-include $(SHELL_OBJS:.o=.d) $(FILEOPS_OBJS:.o=.d) $(JOY_OBJS:.o=.d) $(AUDIO_OBJS:.o=.d) $(SHFIX_OBJ:.o=.d) $(HLPC_OBJ:.o=.d) $(addsuffix .d,$(TEST_BINS)) $(FIX_SOS:.so=.d) $(JOYKEYS_DRV:.drv=.d)

run: $(TASKS_TEST) $(SHELL_TEST) $(APPS_TEST) $(SHMAIN_TEST) $(PM_TEST) $(LOADER_TEST) $(FIX_SOS) $(FIX_HLP)
	cd $(BINDIR) && ASAN_OPTIONS=detect_leaks=1 ./tasksTest
	cd $(BINDIR) && ASAN_OPTIONS=detect_leaks=1 ./loaderTest
	# Every app plugin exports the same appDescriptor symbol by design (one
	# per loaded module), which ASan's ODR checker flags under RTLD_GLOBAL.
	cd $(BINDIR) && ASAN_OPTIONS=detect_leaks=1:detect_odr_violation=0 ./shellTest
	cd $(BINDIR) && ASAN_OPTIONS=detect_leaks=1:detect_odr_violation=0 ./progmanTest
	# allocator_may_return_null: the huge-stack fixture provokes a real
	# malloc failure that tsCreate must survive.
	cd $(BINDIR) && ASAN_OPTIONS=detect_leaks=1:detect_odr_violation=0:allocator_may_return_null=1:max_allocation_size_mb=1536 ./appsTest
	# handle_segv=0: the crash fixture's SIGSEGV must reach the shell's own
	# crash handler, not ASan's.
	cd $(BINDIR) && ASAN_OPTIONS=detect_leaks=1:detect_odr_violation=0:allocator_may_return_null=1:handle_segv=0 ./shellMainTest

clean:
	rm -rf $(BINDIR)
