SoundCatalog.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 <map>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
#include "Core/Data/JsonDocument.h"

 
namespace hmi {

enum class SoundCatalogError {
    None,                
    FileNotFound,        
    ParseError,          
    UnsupportedVersion,  
    MalformedStructure,  
};
 
// Le resultat contient un SoundCatalog par valeur : il ne peut etre defini qu'apres la classe.
struct SoundCatalogResult;

class SoundCatalog {
public:
    static constexpr int FORMAT_VERSION = 1;

    [[nodiscard]] static SoundCatalogResult loadFromString(std::string_view json);

    [[nodiscard]] static SoundCatalogResult loadFromFile(const std::filesystem::path& path);
 
private:
    [[nodiscard]] static SoundCatalogResult fromDocument(const core::JsonDocument& document);
 
public:
    [[nodiscard]] std::optional<std::string> resolve(std::string_view eventId) const;

    [[nodiscard]] std::vector<std::string> eventIds() const;

    void assign(const std::string& eventId, std::string file);
 
private:
    // std::map (et non unordered_map) : ordre de parcours deterministe, comme hmi::SkinCatalog.
    std::map<std::string, std::string, std::less<>> _sounds;
};

struct SoundCatalogResult {
    std::optional<SoundCatalog> catalog;
    std::string error;
    SoundCatalogError errorCode = SoundCatalogError::None;

    [[nodiscard]] bool ok() const noexcept {
        return catalog.has_value();
    }
};
 
}  // namespace hmi