NdsOverlayDefinition.cs

namespace NdsForge;

public sealed class NdsOverlayDefinition
{
    public NdsOverlayDefinition(
        NdsProcessor processor,
        uint id,
        ReadOnlySpan<byte> contents,
        uint loadAddress,
        uint ramSize,
        uint bssSize = 0,
        uint staticInitializerStart = 0,
        uint staticInitializerEnd = 0,
        uint compressedSize = 0,
        byte flags = 0)
        : this(
            processor,
            id,
            contents.ToArray(),
            linkedFilePath: null,
            linkedFile: null,
            loadAddress,
            ramSize,
            bssSize,
            staticInitializerStart,
            staticInitializerEnd,
            compressedSize,
            flags)
    {
    }

    public static NdsOverlayDefinition LinkToFile(
        NdsProcessor processor,
        uint id,
        string filePath,
        uint loadAddress,
        uint ramSize,
        uint bssSize = 0,
        uint staticInitializerStart = 0,
        uint staticInitializerEnd = 0,
        uint compressedSize = 0,
        byte flags = 0) => new(
            processor,
            id,
            contents: null,
            NdsFileSystemBuilder.NormalizePath(filePath, allowRoot: false),
            linkedFile: null,
            loadAddress,
            ramSize,
            bssSize,
            staticInitializerStart,
            staticInitializerEnd,
            compressedSize,
            flags);

    public static NdsOverlayDefinition LinkToFile(
        NdsProcessor processor,
        uint id,
        NdsBuildFile file,
        uint loadAddress,
        uint ramSize,
        uint bssSize = 0,
        uint staticInitializerStart = 0,
        uint staticInitializerEnd = 0,
        uint compressedSize = 0,
        byte flags = 0) => new(
            processor,
            id,
            contents: null,
            linkedFilePath: null,
            file ?? throw new ArgumentNullException(nameof(file)),
            loadAddress,
            ramSize,
            bssSize,
            staticInitializerStart,
            staticInitializerEnd,
            compressedSize,
            flags);

    private NdsOverlayDefinition(
        NdsProcessor processor,
        uint id,
        byte[]? contents,
        string? linkedFilePath,
        NdsBuildFile? linkedFile,
        uint loadAddress,
        uint ramSize,
        uint bssSize,
        uint staticInitializerStart,
        uint staticInitializerEnd,
        uint compressedSize,
        byte flags)
    {
        if (processor is not NdsProcessor.Arm9 and not NdsProcessor.Arm7)
        {
            throw new ArgumentOutOfRangeException(nameof(processor), "DS overlay tables belong to ARM9 or ARM7.");
        }
 
        if (staticInitializerEnd < staticInitializerStart || compressedSize > 0x00FF_FFFF)
        {
            throw new ArgumentException("Overlay initializer bounds or compressed size are invalid.");
        }
 
        Processor = processor;
        Id = id;
        Contents = contents ?? [];
        LinkedFilePath = linkedFilePath;
        LinkedFile = linkedFile;
        LoadAddress = loadAddress;
        RamSize = ramSize;
        BssSize = bssSize;
        StaticInitializerStart = staticInitializerStart;
        StaticInitializerEnd = staticInitializerEnd;
        CompressedSize = compressedSize;
        Flags = flags;
    }

    public NdsProcessor Processor { get; }

    public uint Id { get; }

    public ReadOnlyMemory<byte> Contents { get; }

    public string? LinkedFilePath { get; }

    internal NdsBuildFile? LinkedFile { get; }

    internal string? EffectiveLinkedFilePath => LinkedFile?.Path ?? LinkedFilePath;

    internal bool HasPrivateAllocation => EffectiveLinkedFilePath is null;

    public uint LoadAddress { get; }

    public uint RamSize { get; }

    public uint BssSize { get; }

    public uint StaticInitializerStart { get; }

    public uint StaticInitializerEnd { get; }

    public uint CompressedSize { get; }

    public byte Flags { get; }
}