Validation.h

/*
 * Copyright (C) 2025, Robert Patterson
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#pragma once
 
#include <string>
#include <vector>
#include <unordered_set>
 
#include "util/IdMapping.h"
 
namespace mnx {
 
class Document;
 
namespace validation {
 
struct ValidationResult
{
    struct Error
    {
        Error(const json_pointer& ptr, const json& inst, const std::string& msg)
            : instance(inst), pointer(ptr), message(msg) {}
            
        json instance;          
        json_pointer pointer;   
        std::string message;    
 
        std::string to_string(int indent = -1) const
        {
            return "At " + pointer.to_string() + " of " + instance.dump(indent) + " - " + message;
        }
    };
    std::vector<Error> errors;  
 
    explicit operator bool() const { return errors.empty(); }
};
 
struct SemanticValidationResult : public ValidationResult
{
    using ValidationResult::ValidationResult;
 
    std::unordered_map<std::string, json_pointer> lyricLines; 
};
 
ValidationResult schemaValidate(const Document& document, const std::optional<std::string>& jsonSchema = std::nullopt);
 
SemanticValidationResult semanticValidate(const Document& document);
 
} // namespace validation
} // namespace mnx