1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
|
/************************************************************************
*
* Copyright (C) 2025 IRCAD France
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Sight is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
#pragma once
#include <sight/core/config.hpp>
#include "core/runtime/types.hpp"
#include <filesystem>
#include <string>
namespace sight::core::runtime
{
/**
* @brief Implements a simple XML validator.
* If you parse mutiple files with the same XSD, it is more efficient to instance this class only wants and iterate
* over files with the validate() function.
*/
class SIGHT_CORE_CLASS_API validator
{
public:
using sptr = std::shared_ptr<validator>;
/**
* @brief Instantiates the validator.
* @param _xsd_path a path to the XSD scheam
*/
SIGHT_CORE_API static validator::sptr make(const std::filesystem::path& _xsd_path);
SIGHT_CORE_API virtual ~validator() = default;
/**
* @brief Validates the given file.
* @param _xml_file a path to an xml file to validate
* @return true when the validation succeeds, false otherwise
*/
SIGHT_CORE_API virtual bool validate(const std::filesystem::path& _xml_file) = 0;
/**
* @brief Validates the given xml configuration.
* @param _config xml configuration
* @return true when the validation succeeds, false otherwise
*/
SIGHT_CORE_API virtual bool validate(const config_t& _config) = 0;
protected:
validator() = default;
};
} // namespace sight::core::runtime
|