ARCodeFile.cpp

/*
    Copyright 2016-2025 melonDS team

    This file is part of melonDS.

    melonDS is free software: you can redistribute it and/or modify it under
    the terms of the GNU General Public License as published by the Free
    Software Foundation, either version 3 of the License, or (at your option)
    any later version.

    melonDS is distributed in the hope that it will be useful, but WITHOUT ANY
    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with melonDS. If not, see http://www.gnu.org/licenses/.
*/

#include <cstdio>
#include <cstring>
#include "ARCodeFile.h"
#include "ARDatabaseDAT.h"
#include "Platform.h"

namespace melonDS
{
using namespace Platform;

// TODO: import codes from other sources (usrcheat.dat, ...)
// TODO: more user-friendly error reporting


ARCodeFile::ARCodeFile(const std::string& filename)
{
    Filename = filename;

    if (!Load())
        Error = true;
}

std::vector<ARCode> ARCodeFile::GetCodes() const noexcept
{
    if (Error)
        return {};

    std::vector<ARCode> codes;

    for (auto& item : RootCat.Children)
    {
        if (std::holds_alternative<ARCodeCat>(item))
        {
            auto& cat = std::get<ARCodeCat>(item);

            for (auto& childitem : cat.Children)
            {
                auto& code = std::get<ARCode>(childitem);
                codes.push_back(code);
            }
        }
        else
        {
            auto& code = std::get<ARCode>(item);
            codes.push_back(code);
        }
    }

    return codes;
}

bool ARCodeFile::Load()
{
    FileHandle* f = OpenFile(Filename, FileMode::ReadText);
    if (!f) return true;

    RootCat.Parent = nullptr;
    RootCat.OnlyOneCodeEnabled = false;
    RootCat.Children.clear();

    bool isincat = false;
    ARCodeCat* curcat = &RootCat;

    bool isincode = false;
    ARCode* curcode = nullptr;

    int lastentry = 0;

    char linebuf[1024];
    while (!IsEndOfFile(f))
    {
        if (!FileReadLine(linebuf, 1024, f))
            break;

        linebuf[1023] = '\0';

        char* start = linebuf;
        while (start[0]==' ' || start[0]=='\t')
            start++;

        if (start[0]=='#' || start[0]=='\r' || start[0]=='\n' || start[0]=='\0')
            continue;

        if (!strncasecmp(start, "ROOT", 4))
        {
            isincode = false;
            isincat = true;

            curcat = &RootCat;
            lastentry = 0;
        }
        else if (!strncasecmp(start, "CAT", 3))
        {
            char catname[128];
            int ret, retchk;
            int onlyone;
            if (start[3] == ' ' && (start[4] == '0' || start[4] == '1') && start[5] == ' ')
            {
                retchk = 2;
                ret = sscanf(start, "CAT %d %127[^\r\n]", &onlyone, catname);
            }
            else
            {
                // backwards compatibility
                onlyone = 0;
                retchk = 1;
                ret = sscanf(start, "CAT %127[^\r\n]", catname);
            }
            catname[127] = '\0';

            if (ret < retchk)
            {
                Log(LogLevel::Error, "AR: malformed CAT line: %s\n", start);
                CloseFile(f);
                return false;
            }

            isincode = false;
            isincat = true;

            ARCodeCat cat = {
                .Parent = &RootCat,
                .Name = catname,
                .Description = "",
                .OnlyOneCodeEnabled = onlyone!=0,
                .Children = {}
            };
            RootCat.Children.emplace_back(cat);
            curcat = &std::get<ARCodeCat>(RootCat.Children.back());

            lastentry = 1;
        }
        else if (!strncasecmp(start, "CODE", 4))
        {
            int enable;
            char codename[128];
            int ret = sscanf(start, "CODE %d %127[^\r\n]", &enable, codename);
            codename[127] = '\0';

            if (ret < 2)
            {
                Log(LogLevel::Error, "AR: malformed CODE line: %s\n", start);
                CloseFile(f);
                return false;
            }

            if (!isincat)
            {
                Log(LogLevel::Error, "AR: encountered CODE line with no category started\n");
                CloseFile(f);
                return false;
            }

            isincode = true;

            ARCode code = {
                .Parent = curcat,
                .Name = codename,
                .Description = "",
                .Enabled = enable!=0,
                .Code = {}
            };
            curcat->Children.emplace_back(code);
            curcode = &std::get<ARCode>(curcat->Children.back());

            lastentry = 2;
        }
        else if (!strncasecmp(start, "DESC", 4))
        {
            char desc[256];
            int ret = sscanf(start, "DESC %255[^\r\n]", desc);
            desc[255] = '\0';

            if (ret < 1)
                continue;

            if (lastentry == 2)
                curcode->Description = desc;
            else if (lastentry == 1)
                curcat->Description = desc;
            else
            {
                Log(LogLevel::Error, "AR: encountered DESC line not part of anything\n");
                CloseFile(f);
                return false;
            }
        }
        else
        {
            u32 c0, c1;
            int ret = sscanf(start, "%08X %08X", &c0, &c1);

            if (ret < 2)
            {
                Log(LogLevel::Error, "AR: malformed data line: %s\n", start);
                CloseFile(f);
                return false;
            }

            if (!isincode)
            {
                Log(LogLevel::Error, "AR: encountered data line with no code started\n");
                CloseFile(f);
                return false;
            }

            curcode->Code.push_back(c0);
            curcode->Code.push_back(c1);
        }
    }

    FinalizeList();

    CloseFile(f);
    return true;
}

bool ARCodeFile::Save()
{
    FileHandle* f = Platform::OpenFile(Filename, FileMode::WriteText);
    if (!f) return false;

    bool isincat = true;

    for (auto& item : RootCat.Children)
    {
        if (std::holds_alternative<ARCodeCat>(item))
        {
            auto& cat = std::get<ARCodeCat>(item);

            FileWriteFormatted(f, "CAT %d %s\n", cat.OnlyOneCodeEnabled, cat.Name.c_str());
            if (!cat.Description.empty())
                FileWriteFormatted(f, "DESC %s\n", cat.Description.c_str());
            FileWriteFormatted(f, "\n");

            isincat = true;

            for (auto& childitem : cat.Children)
            {
                auto& code = std::get<ARCode>(childitem);

                FileWriteFormatted(f, "CODE %d %s\n", code.Enabled, code.Name.c_str());
                if (!code.Description.empty())
                    FileWriteFormatted(f, "DESC %s\n", code.Description.c_str());

                for (size_t i = 0; i < code.Code.size(); i+=2)
                    FileWriteFormatted(f, "%08X %08X\n", code.Code[i], code.Code[i + 1]);

                FileWriteFormatted(f, "\n");
            }
        }
        else
        {
            auto& code = std::get<ARCode>(item);

            if (isincat)
            {
                isincat = false;
                FileWriteFormatted(f, "ROOT\n\n");
            }

            FileWriteFormatted(f, "CODE %d %s\n", code.Enabled, code.Name.c_str());
            if (!code.Description.empty())
                FileWriteFormatted(f, "DESC %s\n", code.Description.c_str());

            for (size_t i = 0; i < code.Code.size(); i+=2)
                FileWriteFormatted(f, "%08X %08X\n", code.Code[i], code.Code[i + 1]);

            FileWriteFormatted(f, "\n");
        }
    }

    CloseFile(f);
    return true;
}

void ARCodeFile::Import(ARDatabaseEntry& dbentry, ARCodeEnableMap& enablemap, bool clear)
{
    bool hasenablemap = !enablemap.empty();

    if (clear)
        RootCat.Children.clear();

    for (auto& item : dbentry.RootCat.Children)
    {
        if (std::holds_alternative<ARCodeCat>(item))
        {
            auto& cat = std::get<ARCodeCat>(item);

            bool shouldimport = false;
            if (hasenablemap)
            {
                for (auto& childitem: cat.Children)
                {
                    auto& code = std::get<ARCode>(childitem);
                    if (enablemap[&code])
                    {
                        shouldimport = true;
                        break;
                    }
                }
            }
            else
                shouldimport = true;

            if (!shouldimport)
                continue;

            ARCodeCat newcat = {
                .Parent = &RootCat,
                .Name = cat.Name,
                .Description = cat.Description,
                .OnlyOneCodeEnabled = cat.OnlyOneCodeEnabled,
                .Children = {}
            };
            RootCat.Children.emplace_back(newcat);
            ARCodeCat* parentptr = &std::get<ARCodeCat>(RootCat.Children.back());

            for (auto& childitem : cat.Children)
            {
                auto& code = std::get<ARCode>(childitem);
                if (hasenablemap && (!enablemap[&code]))
                    continue;

                ARCode newcode = {
                    .Parent = parentptr,
                    .Name = code.Name,
                    .Description = code.Description,
                    .Enabled = code.Enabled,
                    .Code = code.Code
                };
                parentptr->Children.emplace_back(newcode);
            }
        }
        else
        {
            auto& code = std::get<ARCode>(item);
            if (hasenablemap && (!enablemap[&code]))
                continue;

            ARCode newcode = {
                .Parent = &RootCat,
                .Name = code.Name,
                .Description = code.Description,
                .Enabled = code.Enabled,
                .Code = code.Code
            };
            RootCat.Children.emplace_back(newcode);
        }
    }

    FinalizeList();
}

void ARCodeFile::FinalizeList()
{
    for (auto& item : RootCat.Children)
    {
        if (!std::holds_alternative<ARCodeCat>(item))
            continue;

        auto& cat = std::get<ARCodeCat>(item);
        if (!cat.OnlyOneCodeEnabled)
            continue;

        // for categories that only allow one code to be enabled:
        // make sure we don't have multiple ones enabled

        bool foundone = false;
        for (auto& childitem : cat.Children)
        {
            auto& code = std::get<ARCode>(childitem);
            if (!code.Enabled) continue;
            if (foundone)
                code.Enabled = false;
            else
                foundone = true;
        }
    }
}

}