Atlas.h

Go to the documentation of this file.

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

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

enum class RegionGrade : std::uint8_t {
    VeryLow = 0,
    Low,
    Normal,
    High,
    VeryHigh,
};

inline constexpr std::size_t kRegionGradeCount = 5;

struct RegionAppraisal {
    RegionGrade grade = RegionGrade::Normal;
    std::string scope;
};

struct RegionStatistic {
    std::vector<RegionAppraisal> appraisals;

    [[nodiscard]] RegionGrade grade() const {
        return appraisals.empty() ? RegionGrade::Normal : appraisals.front().grade;
    }

    [[nodiscard]] bool varies() const {
        return appraisals.size() > 1;
    }
};

enum class RegionAxis : std::uint8_t {
    CitizenFreedom = 0,
    CrimeAndViolence,
    EconomicProsperity,
    GovernmentCorruption,
    MagicAccess,
    MonsterPresence,
    PoliticalStability,
};

inline constexpr std::size_t kRegionAxisCount = 7;

struct RegionSpeciesShare {
    std::string species;
    std::string label;
    int percent = 0;
};

struct RegionPopulation {
    std::optional<int> total;
    std::vector<RegionSpeciesShare> species;
    std::optional<int> otherPercent;
};

struct Location {
    std::string id;
    std::string name;
    std::string source;
    std::string region;
    std::string description;
};

struct Region {
    std::string id;
    std::string name;
    std::string source;
    std::string government;
    std::string faction;
    RegionPopulation population;
    std::array<RegionStatistic, kRegionAxisCount> statistics;
    std::vector<std::string> neighbors;
    std::vector<std::string> locations;

    [[nodiscard]] const RegionStatistic& statistic(RegionAxis axis) const {
        return statistics[static_cast<std::size_t>(axis)];
    }
};

struct Atlas {
    std::vector<Region> regions;
    std::vector<Location> locations;
    std::vector<std::string> errors;

    [[nodiscard]] const Region* findRegion(std::string_view id) const;
    [[nodiscard]] const Location* findLocation(std::string_view id) const;

    [[nodiscard]] std::vector<std::string> unreachableFrom(std::string_view from) const;
};

[[nodiscard]] Atlas loadAtlas(const std::filesystem::path& directory);

[[nodiscard]] std::string_view regionGradeName(RegionGrade grade);

[[nodiscard]] std::optional<RegionGrade> regionGradeFromName(std::string_view name);

[[nodiscard]] std::string_view regionAxisName(RegionAxis axis);
 
}  // namespace core