AssetKey.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once

 
#include <filesystem>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
namespace core {

struct AssetFamilyDefinition {
    std::string name;
    int width = 0;
    int height = 0;
    std::vector<std::string> catalogues;
};

struct AssetFamilyTable {
    std::vector<AssetFamilyDefinition> families;
    std::vector<std::string> errors;
 
    [[nodiscard]] const AssetFamilyDefinition* find(std::string_view name) const;
    [[nodiscard]] bool ok() const {
        return errors.empty() && !families.empty();
    }
};

[[nodiscard]] AssetFamilyTable loadAssetFamilies(const std::filesystem::path& familiesFile);

struct AssetKey {
    std::string family;
    std::string id;
 
    [[nodiscard]] friend bool operator==(const AssetKey&, const AssetKey&) noexcept = default;
};

[[nodiscard]] bool isValidAssetKey(std::string_view key);

[[nodiscard]] std::optional<AssetKey> parseAssetKey(std::string_view key);

[[nodiscard]] std::string defaultAssetKeyFor(std::string_view family, std::string_view id);

struct ExpectedAssetKey {
    std::string key;
    std::string family;
    std::string sourceFile;
    bool explicitKey = false;
};

[[nodiscard]] std::vector<ExpectedAssetKey> expectedAssetKeys(const std::filesystem::path& rpgDir,
                                                              const AssetFamilyTable& families,
                                                              std::vector<std::string>& errors);
 
}  // namespace core