configure.py

#!/usr/bin/env python3

###
# Generates build files for the project.
# This file also includes the project configuration,
# such as compiler flags and the object matching status.
#
# Usage:
#   python3 configure.py
#   ninja
#
# Append --help to see available options.
###

import argparse
import sys
from pathlib import Path
from typing import Any, Dict, List

from tools.project import (
    Object,
    ProgressCategory,
    ProjectConfig,
    calculate_progress,
    generate_build,
    is_windows,
)

# Game versions
DEFAULT_VERSION = 0
VERSIONS = [
    "EU0",  # 0
    "EU1",  # 1
    "JP0",  # 2
]

parser = argparse.ArgumentParser()
parser.add_argument(
    "mode",
    choices=["configure", "progress"],
    default="configure",
    help="script mode (default: configure)",
    nargs="?",
)
parser.add_argument(
    "-v",
    "--version",
    choices=VERSIONS,
    type=str.upper,
    default=VERSIONS[DEFAULT_VERSION],
    help="version to build",
)
parser.add_argument(
    "--build-dir",
    metavar="DIR",
    type=Path,
    default=Path("build"),
    help="base build directory (default: build)",
)
parser.add_argument(
    "--binutils",
    metavar="BINARY",
    type=Path,
    help="path to binutils (optional)",
)
parser.add_argument(
    "--compilers",
    metavar="DIR",
    type=Path,
    help="path to compilers (optional)",
)
parser.add_argument(
    "--map",
    action="store_true",
    help="generate map file(s)",
)
parser.add_argument(
    "--debug",
    action="store_true",
    help="build with debug info (non-matching)",
)
if not is_windows():
    parser.add_argument(
        "--wrapper",
        metavar="BINARY",
        type=Path,
        help="path to wibo or wine (optional)",
    )
parser.add_argument(
    "--dtk",
    metavar="BINARY | DIR",
    type=Path,
    help="path to decomp-toolkit binary or source (optional)",
)
parser.add_argument(
    "--objdiff",
    metavar="BINARY | DIR",
    type=Path,
    help="path to objdiff-cli binary or source (optional)",
)
parser.add_argument(
    "--sjiswrap",
    metavar="EXE",
    type=Path,
    help="path to sjiswrap.exe (optional)",
)
parser.add_argument(
    "--verbose",
    action="store_true",
    help="print verbose output",
)
parser.add_argument(
    "--non-matching",
    dest="non_matching",
    action="store_true",
    help="builds equivalent (but non-matching) or modded objects",
)
parser.add_argument(
    "--no-progress",
    dest="progress",
    action="store_false",
    help="disable progress calculation",
)
args = parser.parse_args()

config = ProjectConfig()
config.version = str(args.version)
version_num = VERSIONS.index(config.version)

# Apply arguments
config.build_dir = args.build_dir
config.dtk_path = args.dtk
config.objdiff_path = args.objdiff
config.binutils_path = args.binutils
config.compilers_path = args.compilers
config.generate_map = args.map
config.non_matching = args.non_matching
config.sjiswrap_path = args.sjiswrap
config.progress = args.progress
if not is_windows():
    config.wrapper = args.wrapper
# Don't build asm unless we're --non-matching
if not config.non_matching:
    config.asm_dir = None

# Tool versions
config.binutils_tag = "2.42-1"
config.compilers_tag = "20240706"
config.dtk_tag = "v1.3.0"
config.objdiff_tag = "v2.6.0"
config.sjiswrap_tag = "v1.2.0"
config.wibo_tag = "0.6.11"

# Project
config.config_path = Path("config") / config.version / "config.yml"
config.check_sha_path = Path("config") / config.version / "build.sha1"
config.asflags = [
    "-mgekko",
    "--strip-local-absolute",
    "-I include",
    f"-I build/{config.version}/include",
    f"--defsym BUILD_VERSION={version_num}",
    f"--defsym VERSION_{config.version}",
]
config.ldflags = [
    "-fp hardware",
    "-nodefaults",
]
if args.debug:
    config.ldflags.append("-g")
if args.map:
    config.ldflags.append("-mapunused")

# Use for any additional files that should cause a re-configure when modified
config.reconfig_deps = []

# Optional numeric ID for decomp.me preset
# Can be overridden in libraries or objects
DECOMPME_PRESET_DOL = 74
DECOMPME_PRESET_REL = 75
config.scratch_preset_id = DECOMPME_PRESET_DOL

SPM_HEADERS = "spm-headers"

# Base flags, common to most GC/Wii games.
# Generally leave untouched, with overrides added below.
cflags_base = [
    "-nodefaults",
    "-proc gekko",
    "-align powerpc",
    "-enum int",
    "-fp hardware",
    "-Cpp_exceptions on",
    "-W all,error",
    "-O4,p",
    "-inline auto",
    '-pragma "cats off"',
    '-pragma "warn_notinlined off"',
    "-maxerrors 1",
    "-nosyspath",
    "-RTTI off",
    "-fp_contract on",
    "-str reuse",
    "-enc SJIS",
    "-i include",
    f"-i build/{config.version}/include",
    f"-DBUILD_VERSION={version_num}",
    f"-DVERSION_{config.version}",

    # spm-headers
    "-DDECOMP",
    f"-DSPM_{config.version.upper()}",
    f"-i {SPM_HEADERS}/include",
    f"-i {SPM_HEADERS}/include_cpp",
    f"-i {SPM_HEADERS}/decomp",
]

# Debug flags
if args.debug:
    cflags_base.extend(["-sym on", "-DDEBUG=1"])
else:
    cflags_base.append("-DNDEBUG=1")

# Metrowerks library flags
cflags_runtime = [
    *cflags_base,
    "-use_lmw_stmw on",
    "-str reuse,pool,readonly",
    "-gccinc",
    "-common off",
    "-inline auto",
]

# SPM dol flags
cflags_dol = [
    *cflags_base,
    "-use_lmw_stmw on",
    "-lang c++",
    "-fp fmadd", # TODO: needed?
    "-str pool,reuse,readonly",
    "-ipa file",
    "-inline all",
    "-sdata 4",
    "-sdata2 4",
    "-sym on", # Enable line numbers in objdiff
]

# REL flags
cflags_rel = [
    *cflags_dol,
    "-sdata 0",
    "-sdata2 0",
]

config.linker_version = "GC/3.0a5.2"


# Helper functions for libraries

def Runtime(*objects: Object) -> Dict[str, Any]:
    return {
        "lib": "Runtime.PPCEABI.H",
        "mw_version": config.linker_version,
        "cflags": cflags_runtime,
        "objects": objects,
    }

def Dol(*objects: Object) -> Dict[str, Any]:
    return {
        "lib": "dol",
        "src_dir": "src",
        "mw_version": config.linker_version,
        "cflags": cflags_dol,
        "objects": objects,
    }


def Rel(*objects: Object) -> Dict[str, Any]:
    return {
        "lib": "rel",
        "src_dir": "rel",
        "mw_version": config.linker_version,
        "cflags": cflags_rel,
        "objects": objects,
        "scratch_preset_id": DECOMPME_PRESET_REL,
    }


Matching = True                   # Object matches and should be linked
NonStarted = False                # Object has no source file created
NonMatching = False               # Object does not match and should not be linked
Equivalent = config.non_matching  # Object should be linked when configured with --non-matching

# Object is only matching for specific versions
def MatchingFor(*versions):
    return config.version in versions

config.warn_missing_config = True
config.warn_missing_source = False
config.libs = [
    Dol(
        Object(Matching, "main.c"),
        Object(Matching, "swdrv.c"),
        Object(NonMatching, "windowdrv.c"),
        Object(Matching, "evtmgr.c"),
        Object(Matching, "evtmgr_cmd.c"),
        Object(NonMatching, "mario_pouch.c"),
        Object(NonStarted, "mario.c"),
        Object(NonMatching, "seq_title.c"),
        Object(Matching, "seqdef.c"),
        Object(Matching, "seqdrv.c"),
        Object(NonMatching, "system.c"),
        Object(Matching, "dvdmgr.c"),
        Object(Matching, "debug.c"),
        Object(Matching, "filemgr.c"),
        Object(Matching, "memory.c"),
        Object(NonMatching, "spmario.c"),
        Object(NonStarted, "npcdrv.c"),
        Object(NonMatching, "wpadmgr.c"),
        Object(Matching, "relmgr.c"),
        Object(Matching, "nandmgr.c"),
    ),
    Rel(
        Object(NonMatching, "dan.c"),
    ),
    Runtime(
        Object(NonMatching, "Runtime.PPCEABI.H/global_destructor_chain.c"),
        Object(NonMatching, "Runtime.PPCEABI.H/__init_cpp_exceptions.cpp"),
    ),
]

# Optional callback to adjust link order. This can be used to add, remove, or reorder objects.
# This is called once per module, with the module ID and the current link order.
#
# For example, this adds "dummy.c" to the end of the DOL link order if configured with --non-matching.
# "dummy.c" *must* be configured as a Matching (or Equivalent) object in order to be linked.
def link_order_callback(module_id: int, objects: List[str]) -> List[str]:
    # Don't modify the link order for matching builds
    if not config.non_matching:
        return objects
    if module_id == 0:  # DOL
        return objects + ["dummy.c"]
    return objects

# Uncomment to enable the link order callback.
# config.link_order_callback = link_order_callback


# Optional extra categories for progress tracking
# Adjust as desired for your project
config.progress_categories = [
    # Unused since full splits not known
]

if args.mode == "configure":
    # Write build.ninja and objdiff.json
    print("Configure for", args.version)
    generate_build(config)
elif args.mode == "progress":
    # Print progress and write progress.json
    config.progress_each_module = args.verbose
    calculate_progress(config)
else:
    sys.exit("Unknown mode: " + args.mode)