anim_json_parser.cpp

Go to the documentation of this file.

#include "porytiles/infra/services/anim_json_parser.hpp"
 
#include <fstream>
#include <optional>
#include <set>
#include <sstream>
#include <string>
#include <vector>
 
#include "fmt/format.h"
#include "fmt/ranges.h"
#include "nlohmann/json.hpp"
 
#include "porytiles/domain/models/anim_override_entry.hpp"
#include "porytiles/domain/models/metatile.hpp"
#include "porytiles/utilities/dynamic_cased_name.hpp"
#include "porytiles/utilities/panic/panic.hpp"
#include "porytiles/utilities/result/chainable_result.hpp"
#include "porytiles/utilities/text/file_highlight_printer.hpp"
 
namespace {
 
using namespace porytiles;
 
[[nodiscard]] std::optional<metatile::Layer> layer_from_string(const std::string &str)
{
    if (str == "bottom") {
        return metatile::Layer::bottom;
    }
    if (str == "middle") {
        return metatile::Layer::middle;
    }
    if (str == "top") {
        return metatile::Layer::top;
    }
    return std::nullopt;
}
 
[[nodiscard]] std::optional<metatile::Subtile> subtile_from_string(const std::string &str)
{
    if (str == "northwest") {
        return metatile::Subtile::northwest;
    }
    if (str == "northeast") {
        return metatile::Subtile::northeast;
    }
    if (str == "southwest") {
        return metatile::Subtile::southwest;
    }
    if (str == "southeast") {
        return metatile::Subtile::southeast;
    }
    return std::nullopt;
}
 
[[nodiscard]] std::string subtile_to_json_string(metatile::Subtile subtile)
{
    switch (subtile) {
    case metatile::Subtile::northwest:
        return "northwest";
    case metatile::Subtile::northeast:
        return "northeast";
    case metatile::Subtile::southwest:
        return "southwest";
    case metatile::Subtile::southeast:
        return "southeast";
    }
    panic("unhandled Subtile value");
}
 
[[nodiscard]] std::size_t byte_offset_to_line_index(const std::filesystem::path &json_path, std::size_t byte_offset)
{
    std::ifstream in{json_path};
    if (!in) {
        return 0;
    }
 
    std::size_t line_index = 0;
    std::size_t current_byte = 0;
    char ch{};
    while (in.get(ch) && current_byte < byte_offset) {
        if (ch == '\n') {
            ++line_index;
        }
        ++current_byte;
    }
    return line_index;
}
 
[[nodiscard]] std::size_t find_key_line_index(const std::filesystem::path &json_path, const std::string &key_name)
{
    std::ifstream in{json_path};
    if (!in) {
        return 0;
    }
 
    const std::string pattern = "\"" + key_name + "\"";
    std::string line;
    std::size_t line_index = 0;
    while (std::getline(in, line)) {
        if (line.find(pattern) != std::string::npos) {
            return line_index;
        }
        ++line_index;
    }
    return 0;
}
 
[[nodiscard]] std::vector<AnimOverrideEntry>
parse_override_entries(const std::string &context_name, const nlohmann::json &overrides_node)
{
    std::vector<AnimOverrideEntry> overrides;
    for (const auto &entry_node : overrides_node) {
        AnimOverrideEntry entry{};
 
        entry.metatile_id = entry_node.at("id").get<std::size_t>();
 
        const auto layer_str = entry_node.at("layer").get<std::string>();
        const auto layer_opt = layer_from_string(layer_str);
        if (!layer_opt.has_value()) {
            panic("anim.json: '" + context_name + "' override has invalid layer '" + layer_str + "'");
        }
        entry.layer = *layer_opt;
 
        const auto subtile_str = entry_node.at("subtile").get<std::string>();
        const auto subtile_opt = subtile_from_string(subtile_str);
        if (!subtile_opt.has_value()) {
            panic("anim.json: '" + context_name + "' override has invalid subtile '" + subtile_str + "'");
        }
        entry.subtile = *subtile_opt;
 
        entry.frame_subtile = entry_node.at("frame_subtile").get<std::size_t>();
        entry.pal_index = entry_node.at("pal_index").get<std::size_t>();
        entry.h_flip = entry_node.at("hflip").get<bool>();
        entry.v_flip = entry_node.at("vflip").get<bool>();
 
        overrides.push_back(entry);
    }
    return overrides;
}
 
[[nodiscard]] nlohmann::ordered_json serialize_override_entries(const std::vector<AnimOverrideEntry> &entries)
{
    nlohmann::ordered_json overrides_array = nlohmann::ordered_json::array();
    for (const auto &entry : entries) {
        nlohmann::ordered_json obj;
        obj["id"] = entry.metatile_id;
        obj["layer"] = metatile::to_string(entry.layer);
        obj["subtile"] = subtile_to_json_string(entry.subtile);
        obj["frame_subtile"] = entry.frame_subtile;
        obj["pal_index"] = entry.pal_index;
        obj["hflip"] = entry.h_flip;
        obj["vflip"] = entry.v_flip;
        overrides_array.push_back(std::move(obj));
    }
    return overrides_array;
}
 
AnimParams parse_animation_params(const std::string &anim_name, const nlohmann::json &node)
{
    AnimParams params;
 
    if (node.contains("frame_factor")) {
        params.frame_factor(node["frame_factor"].get<std::size_t>());
    }
 
    if (node.contains("frame_offset")) {
        params.frame_offset(node["frame_offset"].get<std::size_t>());
    }
 
    // Parse unique frame definitions
    if (node.contains("frames")) {
        std::vector<DynamicCasedName> frame_names;
        for (const auto &frame : node["frames"]) {
            // Read as string - JSON arrays may contain strings or numbers, convert to string
            frame_names.push_back(DynamicCasedName::from_snake_case(frame.get<std::string>()));
        }
        params.frame_names(std::move(frame_names));
    }
 
    // Parse playback sequence
    if (node.contains("frame_order")) {
        std::vector<DynamicCasedName> frame_order;
        for (const auto &frame : node["frame_order"]) {
            frame_order.push_back(DynamicCasedName::from_snake_case(frame.get<std::string>()));
        }
        params.frame_order(std::move(frame_order));
    }
    else {
        // Default: frame_order = frame_names (for simple animations where playback order matches definition order)
        params.frame_order(params.frame_names());
    }
 
    if (node.contains("counter_max")) {
        params.counter_max(node["counter_max"].get<std::size_t>());
    }
 
    if (node.contains("overrides")) {
        if (!node["overrides"].is_array()) {
            panic("anim.json: animation '" + anim_name + "' overrides must be an array");
        }
        params.overrides(parse_override_entries(anim_name, node["overrides"]));
    }
 
    if (node.contains("tile_offset")) {
        params.tile_offset(node["tile_offset"].get<std::size_t>());
    }
 
    params.cased_name(DynamicCasedName{anim_name});
    return params;
}
 
nlohmann::ordered_json serialize_animation_params(const AnimParams &params)
{
    nlohmann::ordered_json node;
 
    // Only write non-default values to keep the file clean
    if (params.frame_factor() != anim::default_frame_factor) {
        node["frame_factor"] = params.frame_factor();
    }
 
    if (params.frame_offset() != anim::default_frame_offset) {
        node["frame_offset"] = params.frame_offset();
    }
 
    // Always write frames array since it's the core animation definition
    nlohmann::ordered_json frames_array = nlohmann::ordered_json::array();
    for (const auto &frame : params.frame_names()) {
        frames_array.push_back(frame.to_snake_case());
    }
    node["frames"] = frames_array;
 
    // Always write frame_order array since it defines the playback sequence
    nlohmann::ordered_json frame_order_array = nlohmann::ordered_json::array();
    for (const auto &frame : params.frame_order()) {
        frame_order_array.push_back(frame.to_snake_case());
    }
    node["frame_order"] = frame_order_array;
 
    if (params.counter_max() != anim::default_counter_max) {
        node["counter_max"] = params.counter_max();
    }
 
    if (params.tile_offset() != 0) {
        node["tile_offset"] = params.tile_offset();
    }
 
    if (!params.overrides().empty()) {
        node["overrides"] = serialize_override_entries(params.overrides());
    }
 
    return node;
}
 
} // namespace
 
namespace porytiles {
 
AnimJsonParser::AnimJsonParser(gsl::not_null<const TextFormatter *> format) : format_{format} {}
 
ChainableResult<std::map<DynamicCasedName, AnimParams>>
AnimJsonParser::parse(const std::filesystem::path &json_path) const
{
    if (!std::filesystem::exists(json_path)) {
        return FormattableError{
            std::vector<std::string>{"Parameters file not found.", "Expected file: {}"},
            std::vector<std::vector<FormatParam>>{{}, {FormatParam{json_path.string(), Style::bold}}}};
    }
 
    try {
        std::ifstream in{json_path};
        if (!in) {
            return FormattableError{
                std::vector<std::string>{"Failed to open anim.json for reading.", "path: {}"},
                std::vector<std::vector<FormatParam>>{{}, {FormatParam{json_path.string(), Style::bold}}}};
        }
 
        nlohmann::json root = nlohmann::json::parse(in);
 
        std::map<DynamicCasedName, AnimParams> result;
 
        if (!root.is_object()) {
            FileHighlightPrinter printer{format_};
            std::vector<std::string> err_lines;
            err_lines.push_back(format_->format(
                "{}:1: Invalid anim.json format, expected a JSON object at the root level.",
                FormatParam{json_path.string(), Style::bold}));
            err_lines.emplace_back();
            auto context = printer.print(json_path, std::vector<std::size_t>{0});
            err_lines.insert(err_lines.end(), context.begin(), context.end());
            return FormattableError{std::move(err_lines)};
        }
 
        for (const auto &[anim_name, anim_node] : root.items()) {
            if (anim_name == "primary_references") {
                continue;
            }
 
            const std::size_t line_idx = find_key_line_index(json_path, anim_name);
 
            // Validate snake_case naming convention
            const auto expected_snake = DynamicCasedName{anim_name}.to_snake_case();
            if (expected_snake != anim_name) {
                FileHighlightPrinter printer{format_};
                std::vector<std::string> err_lines;
                err_lines.push_back(format_->format(
                    "{}:{}: Animation name '{}' must be snake_case (expected '{}').",
                    FormatParam{json_path.string(), Style::bold},
                    FormatParam{line_idx + 1},
                    FormatParam{anim_name, Style::bold},
                    FormatParam{expected_snake, Style::bold}));
                err_lines.emplace_back();
                auto context = printer.print(json_path, std::vector{line_idx});
                err_lines.insert(err_lines.end(), context.begin(), context.end());
                return FormattableError{std::move(err_lines)};
            }
 
            if (!anim_node.is_object()) {
                FileHighlightPrinter printer{format_};
                std::vector<std::string> err_lines;
                err_lines.push_back(format_->format(
                    "{}:{}: Invalid animation entry, '{}' should be a JSON object with frame_factor, frame_offset, "
                    "frames fields.",
                    FormatParam{json_path.string(), Style::bold},
                    FormatParam{line_idx + 1},
                    FormatParam{anim_name, Style::bold}));
                err_lines.emplace_back();
                auto context = printer.print(json_path, std::vector{line_idx});
                err_lines.insert(err_lines.end(), context.begin(), context.end());
                return FormattableError{std::move(err_lines)};
            }
 
            auto parsed = parse_animation_params(anim_name, anim_node);
            result.insert({DynamicCasedName{anim_name}, std::move(parsed)});
 
            // Validate that frame_order entries reference valid frame_names
            const auto &parsed_params = result.at(DynamicCasedName{anim_name});
            std::set<DynamicCasedName> valid_frames(
                parsed_params.frame_names().begin(), parsed_params.frame_names().end());
 
            for (const auto &frame : parsed_params.frame_order()) {
                if (!valid_frames.contains(frame)) {
                    FileHighlightPrinter printer{format_};
                    std::vector<std::string> err_lines;
                    err_lines.push_back(format_->format(
                        "{}:{}: frame_order entry '{}' does not exist in frames list.",
                        FormatParam{json_path.string(), Style::bold},
                        FormatParam{line_idx + 1},
                        FormatParam{frame.to_snake_case(), Style::bold}));
                    err_lines.emplace_back();
 
                    // Transform frame names to snake_case strings for display
                    std::vector<std::string> frame_strs;
                    frame_strs.reserve(parsed_params.frame_names().size());
                    for (const auto &f : parsed_params.frame_names()) {
                        frame_strs.push_back(f.to_snake_case());
                    }
                    err_lines.push_back(format_->format(
                        "Valid frames are: {}.",
                        FormatParam{fmt::format("[{}]", fmt::join(frame_strs, ", ")), Style::bold}));
                    err_lines.emplace_back();
                    auto context = printer.print(json_path, std::vector<std::size_t>{line_idx});
                    err_lines.insert(err_lines.end(), context.begin(), context.end());
                    return FormattableError{std::move(err_lines)};
                }
            }
        }
 
        return result;
    }
    catch (const nlohmann::json::parse_error &e) {
        FileHighlightPrinter printer{format_};
        std::vector<std::string> err_lines;
 
        const auto byte_offset = static_cast<std::size_t>(e.byte);
        const auto line_idx = byte_offset_to_line_index(json_path, byte_offset);
        err_lines.push_back(format_->format(
            "{}:{}: Failed to parse anim.json: {}.",
            FormatParam{json_path.string(), Style::bold},
            FormatParam{line_idx + 1},
            FormatParam{e.what()}));
        err_lines.emplace_back();
        auto context = printer.print(json_path, std::vector<std::size_t>{line_idx});
        err_lines.insert(err_lines.end(), context.begin(), context.end());
 
        return FormattableError{std::move(err_lines)};
    }
    catch (const nlohmann::json::exception &e) {
        return FormattableError{
            std::vector<std::string>{"{}: Failed to parse anim.json: {}."},
            std::vector<std::vector<FormatParam>>{
                {FormatParam{json_path.string(), Style::bold}, FormatParam{e.what()}}}};
    }
}
 
ChainableResult<std::map<DynamicCasedName, std::vector<AnimOverrideEntry>>>
AnimJsonParser::parse_primary_references(const std::filesystem::path &json_path) const
{
    if (!std::filesystem::exists(json_path)) {
        return FormattableError{
            std::vector<std::string>{"Parameters file not found.", "Expected file: {}"},
            std::vector<std::vector<FormatParam>>{{}, {FormatParam{json_path.string(), Style::bold}}}};
    }
 
    try {
        std::ifstream in{json_path};
        if (!in) {
            return FormattableError{
                std::vector<std::string>{"Failed to open anim.json for reading.", "path: {}"},
                std::vector<std::vector<FormatParam>>{{}, {FormatParam{json_path.string(), Style::bold}}}};
        }
 
        nlohmann::json root = nlohmann::json::parse(in);
 
        std::map<DynamicCasedName, std::vector<AnimOverrideEntry>> result;
 
        if (!root.is_object() || !root.contains("primary_references")) {
            return result;
        }
 
        const auto &refs_node = root["primary_references"];
        if (!refs_node.is_object()) {
            FileHighlightPrinter printer{format_};
            const auto line_idx = find_key_line_index(json_path, "primary_references");
            std::vector<std::string> err_lines;
            err_lines.push_back(format_->format(
                "{}:{}: 'primary_references' must be a JSON object.",
                FormatParam{json_path.string(), Style::bold},
                FormatParam{line_idx + 1}));
            err_lines.emplace_back();
            auto context = printer.print(json_path, std::vector{line_idx});
            err_lines.insert(err_lines.end(), context.begin(), context.end());
            return FormattableError{std::move(err_lines)};
        }
 
        for (const auto &[prim_anim_name, prim_anim_node] : refs_node.items()) {
            const auto line_idx = find_key_line_index(json_path, prim_anim_name);
 
            if (!prim_anim_node.is_object()) {
                FileHighlightPrinter printer{format_};
                std::vector<std::string> err_lines;
                err_lines.push_back(format_->format(
                    "{}:{}: Primary reference '{}' must be a JSON object.",
                    FormatParam{json_path.string(), Style::bold},
                    FormatParam{line_idx + 1},
                    FormatParam{prim_anim_name, Style::bold}));
                err_lines.emplace_back();
                auto context = printer.print(json_path, std::vector{line_idx});
                err_lines.insert(err_lines.end(), context.begin(), context.end());
                return FormattableError{std::move(err_lines)};
            }
 
            if (!prim_anim_node.contains("overrides") || !prim_anim_node["overrides"].is_array()) {
                FileHighlightPrinter printer{format_};
                std::vector<std::string> err_lines;
                err_lines.push_back(format_->format(
                    "{}:{}: Primary reference '{}' must contain an 'overrides' array.",
                    FormatParam{json_path.string(), Style::bold},
                    FormatParam{line_idx + 1},
                    FormatParam{prim_anim_name, Style::bold}));
                err_lines.emplace_back();
                auto context = printer.print(json_path, std::vector{line_idx});
                err_lines.insert(err_lines.end(), context.begin(), context.end());
                return FormattableError{std::move(err_lines)};
            }
 
            auto entries = parse_override_entries(prim_anim_name, prim_anim_node["overrides"]);
            result.insert({DynamicCasedName{prim_anim_name}, std::move(entries)});
        }
 
        return result;
    }
    catch (const nlohmann::json::parse_error &e) {
        FileHighlightPrinter printer{format_};
        std::vector<std::string> err_lines;
 
        const auto byte_offset = static_cast<std::size_t>(e.byte);
        const auto line_idx = byte_offset_to_line_index(json_path, byte_offset);
        err_lines.push_back(format_->format(
            "{}:{}: Failed to parse anim.json: {}.",
            FormatParam{json_path.string(), Style::bold},
            FormatParam{line_idx + 1},
            FormatParam{e.what()}));
        err_lines.emplace_back();
        auto context = printer.print(json_path, std::vector<std::size_t>{line_idx});
        err_lines.insert(err_lines.end(), context.begin(), context.end());
 
        return FormattableError{std::move(err_lines)};
    }
    catch (const nlohmann::json::exception &e) {
        return FormattableError{
            std::vector<std::string>{"{}: Failed to parse anim.json: {}."},
            std::vector<std::vector<FormatParam>>{
                {FormatParam{json_path.string(), Style::bold}, FormatParam{e.what()}}}};
    }
}
 
ChainableResult<void> AnimJsonParser::write(
    const std::filesystem::path &json_path,
    const std::map<DynamicCasedName, AnimParams> &params,
    const std::map<DynamicCasedName, std::vector<AnimOverrideEntry>> &primary_references) const
{
    try {
        // Create parent directories if they don't exist
        if (json_path.has_parent_path()) {
            std::filesystem::create_directories(json_path.parent_path());
        }
 
        nlohmann::ordered_json root;
        for (const auto &[name, anim_params] : params) {
            root[name.to_snake_case()] = serialize_animation_params(anim_params);
        }
 
        if (!primary_references.empty()) {
            nlohmann::ordered_json refs_node;
            for (const auto &[prim_anim_name, entries] : primary_references) {
                nlohmann::ordered_json anim_ref_node;
                anim_ref_node["overrides"] = serialize_override_entries(entries);
                refs_node[prim_anim_name.to_snake_case()] = std::move(anim_ref_node);
            }
            root["primary_references"] = std::move(refs_node);
        }
 
        std::ofstream out(json_path);
        if (!out) {
            return FormattableError{
                std::vector<std::string>{"Failed to open anim.json for writing.", "path: {}"},
                std::vector<std::vector<FormatParam>>{{}, {FormatParam{json_path.string(), Style::bold}}}};
        }
 
        out << root.dump(2);
        out << std::endl;
        out.close();
 
        if (!out) {
            return FormattableError{
                std::vector<std::string>{"Failed to write anim.json.", "Error occurred while writing to: {}"},
                std::vector<std::vector<FormatParam>>{{}, {FormatParam{json_path.string(), Style::bold}}}};
        }
 
        return {};
    }
    catch (const nlohmann::json::exception &e) {
        return FormattableError{
            std::vector<std::string>{"Failed to serialize anim.json.", "JSON error: {}"},
            std::vector<std::vector<FormatParam>>{{}, {FormatParam{e.what()}}}};
    }
}
 
} // namespace porytiles