Makefile

BASENAME  = sssv
VERSION  := us

# Colors

NO_COL  := \033[0m
RED     := \033[0;31m
RED2    := \033[1;31m
GREEN   := \033[0;32m
YELLOW  := \033[0;33m
BLUE    := \033[0;34m
PINK    := \033[0;35m
CYAN    := \033[0;36m

# Directories

BUILD_DIR = build
ASM_DIRS  = asm \
            asm/libc \
            asm/libultra/audio \
            asm/data asm/data/libultra/audio asm/data/core asm/data/sssv asm/data/sssv/animals
BIN_DIRS  = assets assets/levels
SRC_DIR   = src.$(VERSION)

SRC_DIRS  = $(SRC_DIR) $(SRC_DIR)/core \
            $(SRC_DIR)/libultra/audio $(SRC_DIR)/libultra/libc \
            $(SRC_DIR)/sssv $(SRC_DIR)/sssv/animals \
            $(SRC_DIR)/data \
            $(SRC_DIR)/bss \
            $(SRC_DIR)/buffers

TOOLS_DIR = tools

# Files

TARGET     = $(BUILD_DIR)/$(BASENAME).$(VERSION)
LD_SCRIPT  = $(BASENAME).ld

LIBULTRA = lib/libultra_rom.a

# Source

TARGET_ASM_OBJS = $(shell sed -nE 's#.*(build/.*\.s\.o).*#\1#p' ${LD_SCRIPT} 2>/dev/null)
TARGET_C_OBJS   = $(shell sed -nE 's#.*(build/.*\.c\.o).*#\1#p' ${LD_SCRIPT} 2>/dev/null)

# Images

RGBA16_OBJS      = $(shell sed -nE 's#.*(build/.*\.rgba16.png\.o).*#\1#p' ${LD_SCRIPT} 2>/dev/null)
I4_OBJS          = $(shell sed -nE 's#.*(build/.*\.i4.png\.o).*#\1#p'     ${LD_SCRIPT} 2>/dev/null)
I8_OBJS          = $(shell sed -nE 's#.*(build/.*\.i8.png\.o).*#\1#p'     ${LD_SCRIPT} 2>/dev/null)
IA16_OBJS        = $(shell sed -nE 's#.*(build/.*\.ia16.png\.o).*#\1#p'   ${LD_SCRIPT} 2>/dev/null)
CI4_OBJS         = $(shell sed -nE 's#.*(build/.*\.ci4.png\.o).*#\1#p'    ${LD_SCRIPT} 2>/dev/null)

CI4_PAL_OBJS     = $(shell sed -nE 's#.*(build/.*\.pal\.o).*#\1#p' ${LD_SCRIPT} 2>/dev/null)
CI4_PAL_OBJS    += $(CI4_OBJS:.ci4.png.o=.pal.o)

IMAGE_OBJS       = $(RGBA16_OBJS) $(I4_OBJS) $(I8_OBJS) $(IA16_OBJS) $(CI4_OBJS) $(CI4_PAL_OBJS)

# RNC Files
RNC_OBJS         = $(shell sed -nE 's#.*(build/.*\.rnc\.o).*#\1#p' ${LD_SCRIPT} 2>/dev/null)

# Generic RNC compressed files
ALL_RNC_FILES      = $(wildcard assets/rnc*.bin) $(wildcard assets/levels/*.bin)
ALL_RNC_EXTRACTED  = $(foreach file,$(ALL_RNC_FILES),rnc/$(file))
ALL_RNC_COMPRESSED = $(foreach file,$(ALL_RNC_FILES),build/$(file))

# Other
TARGET_BIN_OBJS = $(shell sed -nE 's#.*(build/.*\.bin\.o).*#\1#p' ${LD_SCRIPT} 2>/dev/null)


# function is not included unless explicitly undefined
UNDEFINED_SYMS  := osViGetCurrentLine

# Tools
find-command = $(shell which $(1) 2>/dev/null)

CROSS    = mips-linux-gnu-

AS       = $(CROSS)as
CPP      = cpp
LD       = $(CROSS)ld
OBJCOPY  = $(CROSS)objcopy
PYTHON   = python3
GCC      = gcc

XGCC     = $(CROSS)gcc

# prefer clang as CC_CHECK
ifneq (,$(call find-command,clang))
  HOSTCC = clang
  HOSTCC_CHECK_FLAGS = --target=i686-linux-gnu
else
  HOSTCC = gcc
  HOSTCC_CHECK_FLAGS = -m32
endif

# prefer modern gcc for data, but fall back to IDO if not available
ifneq (,$(call find-command,$(CROSS)gcc))
  DCC        = $(XGCC)
  DCC_CFLAGS = $(GCC_FLAGS)
else
  DCC        = $(CC)
  DCC_CFLAGS = $(CFLAGS)
endif

GREP     = grep -rl
CC       = $(TOOLS_DIR)/ido5.3_recomp/cc
RNC64    = $(TOOLS_DIR)/rnc_propack_source/rnc64
RNCU     = $(PYTHON) $(TOOLS_DIR)/rncu.py
SPLAT    = $(TOOLS_DIR)/splat/split.py
N64CRC   = $(TOOLS_DIR)/n64crc.py

IMG_CONVERT = $(PYTHON) $(TOOLS_DIR)/image_converter.py

LIBRNCU  = $(TOOLS_DIR)/librncu.so

# Flags

OPT_FLAGS      = -O2
LOOP_UNROLL    =

MIPSISET       = -mips2 -32

INCLUDE_CFLAGS = -I . -I include -I include/2.0 -I include/2.0/PR -I include/libc -I assets \
                 -I src.$(VERSION) -I src.$(VERSION)/libultra/audio

ASFLAGS        = -EB -mtune=vr4300 -march=vr4300 -mabi=32 -I include
OBJCOPYFLAGS   = -O binary

# Files requiring pre/post-processing
GLOBAL_ASM_C_FILES := $(shell $(GREP) GLOBAL_ASM $(SRC_DIR) </dev/null 2>/dev/null)
GLOBAL_ASM_OBJS := $(foreach file,$(GLOBAL_ASM_C_FILES),$(BUILD_DIR)/$(file).o)


DEFINES := -D_LANGUAGE_C -D_FINALROM -DF3DEX_GBI -DWIN32 -DSSSV -DNDEBUG

ifeq ($(VERSION),us)
DEFINES += -DVERSION_US
endif
ifeq ($(VERSION),eu)
DEFINES += -DVERSION_EU
endif

VERIFY = verify

ifeq ($(NON_MATCHING),1)
DEFINES += -DNON_MATCHING
VERIFY = no_verify
PROGRESS_NONMATCHING = --non-matching
endif

CFLAGS := -G0 -Xfullwarn -Xcpluscomm -signed -nostdinc -non_shared -Wab,-r4300_mul
CFLAGS += $(DEFINES)
# ignore compiler warnings about anonymous structs & incomplete types
CFLAGS += -woff 649,838,807
CFLAGS += $(INCLUDE_CFLAGS)

CHECK_WARNINGS := -Wall -Wextra -Wno-format-security -Wno-unknown-pragmas -Wno-unused-parameter -Wno-unused-variable -Wno-missing-braces -Wno-int-conversion
# CHECK_WARNINGS += -Wdouble-promotion
CC_CHECK := $(HOSTCC) $(HOSTCC_CHECK_FLAGS) -fsyntax-only -fno-builtin -fsigned-char -std=gnu90 $(CHECK_WARNINGS) $(INCLUDE_CFLAGS) $(DEFINES)

GCC_FLAGS := $(INCLUDE_CFLAGS) $(DEFINES)
GCC_FLAGS += -G0 -mno-shared -march=vr4300 -mfix4300 -mabi=32 -mhard-float
GCC_FLAGS += -mdivide-breaks -fno-stack-protector -fno-common -fno-zero-initialized-in-bss -fno-PIC -mno-abicalls -fno-strict-aliasing -fno-inline-functions -ffreestanding -fwrapv
GCC_FLAGS += -Wall -Wextra -Wno-missing-braces

LD_FLAGS   = -T $(LD_SCRIPT) -Map $(TARGET).map --no-check-sections

ifeq ($(VERSION),eu)
LD_FLAGS  +=  -T undefined_syms.$(VERSION).txt -T undefined_syms_auto.txt
endif

ifeq ($(VERSION),us)
LD_FLAGS_EXTRA  = -Lbuild/lib -lultra_rom
LD_FLAGS_EXTRA += $(foreach sym,$(UNDEFINED_SYMS),-u $(sym))
else
LD_FLAGS_EXTRA  =
endif

ASM_PROCESSOR_DIR := $(TOOLS_DIR)/asm-processor
ASM_PROCESSOR      = $(PYTHON) $(ASM_PROCESSOR_DIR)/asm_processor.py

### Optimisation Overrides
$(BUILD_DIR)/$(SRC_DIR)/main_1050.c.o: OPT_FLAGS := -O1
# $(BUILD_DIR)/$(SRC_DIR)/core/eeprom.c.o: OPT_FLAGS := -O2

$(BUILD_DIR)/$(SRC_DIR)/overlay2_6AB090.c.o: LOOP_UNROLL := -Wo,-loopunroll,0

# does nothing:
# $(BUILD_DIR)/$(SRC_DIR)/overlay2_72BA20.c.o: LOOP_UNROLL := -Wo,-loopunroll,0

$(BUILD_DIR)/src.eu/overlay1%.c.o: OPT_FLAGS := -g

### Targets

default: all

all: dirs $(VERIFY)

dirs:
	$(foreach dir,$(SRC_DIRS) $(ASM_DIRS) $(BIN_DIRS),$(shell mkdir -p $(BUILD_DIR)/$(dir)))

tools: $(RNC64) $(LIBRNCU)

verify: $(TARGET).z64
	@sha1sum --check $(BASENAME).$(VERSION).sha1

no_verify: $(TARGET).z64
	@echo "Skipping SHA1SUM check, updating CRC"
	@$(PYTHON) $(N64CRC) $(TARGET).z64

progress: dirs $(VERIFY) progress.csv

splat: $(SPLAT)

extract: splat tools
	$(PYTHON) $(SPLAT) $(BASENAME).$(VERSION).yaml
	$(PYTHON) $(TOOLS_DIR)/fixup_tlut.py

decompress: $(ALL_RNC_EXTRACTED)

compress: dirs $(ALL_RNC_COMPRESSED)
	# DO NOT UNCOMMENT NEXT LINE UNTIL COMPRESSION IS MATCHING
	#cp $(BUILD_DIR)/assets/rnc*.bin assets/

clean:
	rm -rf build

distclean: clean
	rm -rf asm
	rm -rf assets
	rm -f *auto.txt
	rm -f src.us/data/inc/*


### Recipes

$(TARGET).elf: $(BASENAME).ld $(BUILD_DIR)/$(LIBULTRA) $(TARGET_ASM_OBJS) $(TARGET_BIN_OBJS) $(TARGET_C_OBJS) $(IMAGE_OBJS) $(RNC_OBJS)
	@$(LD) $(LD_FLAGS) $(LD_FLAGS_EXTRA) -o $@
	@printf "[$(PINK) linker $(NO_COL)]  $<\n"

ifndef PERMUTER
$(GLOBAL_ASM_OBJS): $(BUILD_DIR)/%.c.o: %.c include/functions.$(VERSION).h include/variables.$(VERSION).h include/structs.h
	@$(CC_CHECK) $<
	@printf "[$(YELLOW) syntax $(NO_COL)] $<\n"
	@$(ASM_PROCESSOR) $(OPT_FLAGS) $< > $(BUILD_DIR)/$<
	@$(CC) -c $(CFLAGS) $(OPT_FLAGS) $(LOOP_UNROLL) $(MIPSISET) -o $@ $(BUILD_DIR)/$<
	@$(ASM_PROCESSOR) $(OPT_FLAGS) $< --post-process $@ \
		--assembler "$(AS) $(ASFLAGS)" --asm-prelude $(ASM_PROCESSOR_DIR)/prelude.inc
	@printf "[$(GREEN) ido5.3 $(NO_COL)]  $<\n"
endif

# non asm-processor recipe
$(BUILD_DIR)/%.c.o: %.c
	@$(CC_CHECK) $<
	@printf "[$(YELLOW) syntax $(NO_COL)]  $<\n"
	@$(CC) -c $(CFLAGS) $(OPT_FLAGS) $(LOOP_UNROLL) $(MIPSISET) -o $@ $<
	@printf "[$(GREEN) ido5.3 $(NO_COL)]  $<\n"

# use modern gcc or IDO for data
$(BUILD_DIR)/$(SRC_DIR)/data/%.c.o: $(SRC_DIR)/data/%.c
	@$(DCC) -c $(DCC_CFLAGS) -o $@ $<
	@printf "[$(GREEN)  data  $(NO_COL)]  $<\n"

$(BUILD_DIR)/%.s.o: %.s
	@$(AS) $(ASFLAGS) -o $@ $<
	@printf "[$(GREEN)   as   $(NO_COL)]  $<\n"

$(BUILD_DIR)/%.bin.o: %.bin
	@$(LD) -r -b binary -o $@ $<
	@printf "[$(PINK) linker $(NO_COL)]  $<\n"

$(TARGET).bin: $(TARGET).elf
	@$(OBJCOPY) $(OBJCOPYFLAGS) $< $@
	@printf "[$(CYAN) objcpy $(NO_COL)]  $<\n"

$(TARGET).z64: $(TARGET).bin
	@cp $< $@

$(BUILD_DIR)/$(LIBULTRA): $(LIBULTRA)
	@mkdir -p $$(dirname $@)
	@cp $< $@
	@$(PYTHON) $(TOOLS_DIR)/set_o32abi_bit.py --quiet $@

rnc/%.bin: %.bin
	@mkdir -p rnc/assets/levels
	@$(RNCU) $< $@
	@printf "[$(RED) rnc u. $(NO_COL)]  $<\n"

$(RNC64): $(TOOLS_DIR)/rnc_propack_source/main.c
	make -C $(TOOLS_DIR)/rnc_propack_source rnc64

$(LIBRNCU): $(TOOLS_DIR)/rncu.c
	$(HOSTCC) -o $@ $< --shared -O3 -fPIC

# language files
%.dat.rnc.json: %.dat.rnc
	@mkdir -p $$(dirname $@)
	@$(PYTHON) $(TOOLS_DIR)/lang2json.py $< $@
	@printf "[$(YELLOW)  lang  $(NO_COL)]  $<\n"

$(BUILD_DIR)/%.dat: %.dat.rnc.json
	@mkdir -p $$(dirname $@)
	@$(PYTHON) $(TOOLS_DIR)/lang2json.py $< $@ --encode
	@printf "[$(RED2)  lang  $(NO_COL)]  $<\n"

# compressed images
$(BUILD_DIR)/%.rgba16: %.rgba16.rnc.png
	@mkdir -p $$(dirname $@)
	@$(IMG_CONVERT) rgba16 $< $@
	@printf "[$(GREEN) rgba16 $(NO_COL)]  $<\n"

$(BUILD_DIR)/%.i4: %.i4.rnc.png
	@mkdir -p $$(dirname $@)
	@$(IMG_CONVERT) i4 $< $@
	@printf "[$(GREEN)   i4   $(NO_COL)]  $<\n"

# uncompressed images
$(BUILD_DIR)/%.rgba16.png: %.rgba16.png
	@mkdir -p $$(dirname $@)
	@$(IMG_CONVERT) rgba16 $< $@
	@printf "[$(GREEN) rgba16 $(NO_COL)]  $<\n"

$(BUILD_DIR)/%.i4.png: %.i4.png
	@mkdir -p $$(dirname $@)
	@$(IMG_CONVERT) i4 $< $@
	@printf "[$(GREEN)   i4   $(NO_COL)]  $<\n"

$(BUILD_DIR)/%.i8.png: %.i8.png
	@mkdir -p $$(dirname $@)
	@$(IMG_CONVERT) i8 $< $@
	@printf "[$(GREEN)   i8   $(NO_COL)]  $<\n"

$(BUILD_DIR)/%.ia16.png: %.ia16.png
	@mkdir -p $$(dirname $@)
	@$(IMG_CONVERT) ia16 $< $@
	@printf "[$(GREEN)  ia16  $(NO_COL)]  $<\n"

$(BUILD_DIR)/%.ci4.png: %.ci4.png
	@mkdir -p $$(dirname $@)
	@$(IMG_CONVERT) ci4 $< $@
	@printf "[$(GREEN)  ci4   $(NO_COL)]  $<\n"

$(BUILD_DIR)/%.pal: %.ci4.png
	@mkdir -p $$(dirname $@)
	@$(IMG_CONVERT) palette $< $@
	@printf "[$(GREEN)  pal   $(NO_COL)]  $<\n"

# BUILD_DIR prefix to suppress circular dependency
$(BUILD_DIR)/%.png.o: $(BUILD_DIR)/%.png
	@$(LD) -r -b binary -o $@ $<
	@printf "[$(PINK) linker $(NO_COL)]  $<\n"

$(BUILD_DIR)/%.pal.o: $(BUILD_DIR)/%.pal
	@$(LD) -r -b binary -o $@ $<
	@printf "[$(PINK) linker $(NO_COL)]  $<\n"


# rnc compress
%.rnc: %
	@$(RNC64) p $< $@ /f >/dev/null
	@$(PYTHON) $(TOOLS_DIR)/pad.py $@ $@.pad
	@mv $@.pad $@
	@printf "[$(RED) rnc p. $(NO_COL)]  $<\n"

$(BUILD_DIR)/%.collision.rnc: %.collision.rnc
	@$(RNC64) p $< $@ /f >/dev/null
	@$(PYTHON) $(TOOLS_DIR)/pad.py $@ $@.pad
	@mv $@.pad $@
	@printf "[$(RED) rnc p. $(NO_COL)]  $<\n"

%.rnc.o: %.rnc
	@$(LD) -r -b binary -o $@ $<
	@printf "[$(PINK) linker $(NO_COL)]  $<\n"

# progress
progress.csv: progress.main.csv progress.lib.csv progress.overlay1.csv progress.overlay2.csv
	@awk "(NR == 1) || (FNR > 1)" $^ > $@
	@rm $^

progress.main.csv: $(TARGET).elf
	$(PYTHON) $(TOOLS_DIR)/progress.py . $(TARGET).map _mainSegmentTextStart main_libultra_start_OFFSET main --version $(VERSION) $(PROGRESS_NONMATCHING) > $@
progress.lib.csv: $(TARGET).elf
	$(PYTHON) $(TOOLS_DIR)/progress.py . $(TARGET).map main_libultra_start_OFFSET _mainSegmentTextEnd lib --version $(VERSION) $(PROGRESS_NONMATCHING) > $@
progress.overlay1.csv: $(TARGET).elf
	$(PYTHON) $(TOOLS_DIR)/progress.py . $(TARGET).map _overlay1SegmentTextStart _overlay1SegmentTextEnd overlay1 --version $(VERSION) $(PROGRESS_NONMATCHING) > $@
progress.overlay2.csv: $(TARGET).elf
	$(PYTHON) $(TOOLS_DIR)/progress.py . $(TARGET).map _overlay2SegmentTextStart _overlay2SegmentTextEnd overlay2 --version $(VERSION) $(PROGRESS_NONMATCHING) > $@

# fake targets for better error handling
$(SPLAT):
	$(info Repo cloned without submodules, attempting to fetch them now...)
	@which git >/dev/null || echo "ERROR: git binary not found on PATH"
	@which git >/dev/null
	git submodule update --init --recursive

baserom.$(VERSION).z64:
	$(error Place the SSSV ROM, named '$@', in the root of this repo and try again.)

### Settings
.SECONDARY:
.PHONY: all clean default
SHELL = /bin/bash -e -o pipefail