JsonDocument.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <cstddef>
#include <filesystem>
#include <string>
#include <string_view>
 
#include <nlohmann/json.hpp>

 
namespace core {

enum class JsonReadError {
    None,                
    FileNotFound,        
    ParseError,          
    UnsupportedVersion,  
    MalformedStructure,  
};

struct TextPosition {
    int line = 0;    
    int column = 0;  
};

struct JsonDocument {
    nlohmann::json root;                        
    JsonReadError error = JsonReadError::None;  
    std::string message;                        
    TextPosition position;                      
    int version = 0;                            

    [[nodiscard]] bool ok() const {
        return error == JsonReadError::None;
    }
};

[[nodiscard]] TextPosition positionOf(std::string_view text, std::size_t byteOffset);

[[nodiscard]] JsonDocument readJsonObject(std::string_view json, int supportedVersion,
                                          std::string_view origin = {},
                                          std::string_view versionField = "version");

[[nodiscard]] JsonDocument readJsonObjectFromFile(const std::filesystem::path& path,
                                                  int supportedVersion,
                                                  std::string_view versionField = "version");
 
}  // namespace core