Mode dependency from nlomann to CPP

Signed-off-by: David Laseca Perez <davidlaseca@eprosima.com>

Author: David-LP99

ddspipe_yaml/include/ddspipe_yaml/YamlValidator.hpp

@@ -14,98 +14,120 @@
 
 #pragma once
 
+#include <memory>
+
 #include <ddspipe_yaml/library/library_dll.h>
 #include <ddspipe_yaml/Yaml.hpp>
 
-#include <nlohmann/json.hpp>
-#include <nlohmann/json-schema.hpp>
+namespace nlohmann {
+namespace json_schema {
+class json_validator;
+} // namespace json_schema
+} // namespace nlohmann
 
 namespace eprosima {
 namespace ddspipe {
 namespace yaml {
 
 /**
- * @brief Yaml Validator
+ * @brief Validates YAML objects against a JSON Schema (draft-07).
  *
- * This class is used to validate Yaml objects.
+ * Loads a schema from a file path or a raw string via \c InputType, then
+ * validates \c Yaml nodes against it. Custom format checkers (e.g. IPv4/IPv6)
+ * are applied automatically during validation.
  */
 class DDSPIPE_YAML_DllAPI YamlValidator
 {
 private:
 
-    nlohmann::json_schema::json_validator validator;
-
-    /**
-     * @brief Convert \c yml to a nlohmann::json type
-     *
-     * @param yml Yaml object to convert.
-     */
-    nlohmann::json yaml_to_json(
-            const Yaml& yml);
+    std::unique_ptr<nlohmann::json_schema::json_validator> validator;
 
 protected:
 
     /**
-     * @brief Used to allow checking formats, for example, a string with an IP address
+     * @brief Custom format checker registered with the JSON Schema validator.
      *
-     * @param format Name of the format option (i.e. IPv4 or IPv6).
-     * @param value Value being checked against the \c format type.
+     * Called automatically during validation when the schema uses the \c format keyword.
+     * Supported format values are \c "v4" (IPv4) and \c "v6" (IPv6).
+     *
+     * @param format Name of the format to check (e.g. \c "v4" or \c "v6").
+     * @param value  Value to validate against the given format.
+     *
+     * @throws std::invalid_argument if \c value does not conform to \c format.
      */
     static void format_checker(
             const std::string& format,
             const std::string& value);
 
 public:
+    
+    enum class InputType
+    {
+        FROM_STRING,
+        FROM_FILE
+    };
 
     /**
-     * @brief Default constructor. Creates a \c YamlValidator with an empty schema validator.
+     * @brief Default constructor. Creates a \c YamlValidator with no schema loaded.
+     *
+     * \c validate_YAML will return \c false until a schema is set via \c set_schema.
      */
     YamlValidator();
 
     /**
-     * @brief Construct a \c YamlValidator and load the given JSON schema.
+     * @brief Construct a \c YamlValidator and load a JSON Schema (draft-07).
+     *
+     * @param input_type    Whether \c schema_string is a file path (\c InputType::FROM_FILE)
+     *                      or raw JSON content (\c InputType::FROM_STRING).
+     * @param schema_string File path or raw JSON string of the schema to load.
      *
-     * @param schema JSON schema to set as the root schema of the validator.
+     * @throws utils::ConfigurationException if the schema cannot be read, parsed, or is not
+     *         a valid JSON Schema draft-07.
      */
     explicit YamlValidator(
-            const nlohmann::json& schema);
+            InputType input_type,
+            const std::string& schema_string);
 
     /**
-     * @brief Set or replace the root schema of the validator.
-     *
-     * @param schema JSON schema to set as the root schema of the validator.
+     * @brief Default destructor. Needed because \c std::unique_ptr needs the full definition
+     * of \c nlohmann::json_schema::json_validator when destroying it.
      */
-    void set_schema(
-            const nlohmann::json& schema);
+    ~YamlValidator();
 
     /**
-     * @brief Load a JSON schema from a file path.
-     *
-     * @param schema_path Path to the JSON schema file.
-     * @return Parsed \c nlohmann::json object representing the schema.
+     * @brief Move assignment operator. Needed because \c std::unique_ptr needs the full definition
+     * of \c nlohmann::json_schema::json_validator when move-assigning (the old value is destroyed).
      */
-    static nlohmann::json from_file(
-            const std::string& schema_path);
+    YamlValidator& operator=(YamlValidator&&);
 
     /**
-     * @brief Load a JSON schema from a string containing the schema content directly.
+     * @brief Set or replace the root schema of the validator.
      *
-     * @param schema_file_content String with the JSON schema content.
-     * @return Parsed \c nlohmann::json object representing the schema.
+     * @param input_type    Whether \c schema_string is a file path (\c InputType::FROM_FILE)
+     *                      or raw JSON content (\c InputType::FROM_STRING).
+     * @param schema_string File path or raw JSON string of the schema to load.
+     *
+     * @throws utils::ConfigurationException if the schema cannot be read, parsed, or is not
+     *         a valid JSON Schema draft-07.
      */
-    static nlohmann::json from_string(
-            const std::string& schema_file_content);
+    void set_schema(
+            InputType input_type,
+            const std::string& schema_string);
 
     /**
      * @brief Validate a YAML object against the loaded schema.
      *
+     * Returns \c false immediately if no schema has been loaded.
+     *
      * @param yml Yaml object to validate.
-     * @param print_errors Flag to print the errors in the error output when \c yml doesn't fit the schema.
+     * @param display_errors If \c true, prints validation errors to \c stderr.
      * @return \c true if \c yml conforms to the schema, \c false otherwise.
+     *
+     * @throws utils::ConfigurationException if \c yml cannot be converted to JSON.
      */
     bool validate_YAML(
             const Yaml& yml,
-            bool print_errors = true);
+            bool display_errors = true);
 };
 
 } /* namespace yaml */