Concepts.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2025 nfx
 *
 * 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 <nfx/json/Document.h>
#include <type_traits>
 
namespace nfx::serialization::json
{
    //=====================================================================
    // Import types from nfx::json
    //=====================================================================
 
    using nfx::json::Document;
    using nfx::json::Array;
    using nfx::json::Object;
    using nfx::json::Type;
 
    // Import type trait from nfx::json
    using nfx::json::is_json_container_v;
 
    //=====================================================================
    // Forward declarations
    //=====================================================================

    template <typename T>
    struct SerializationTraits;
 
    //=====================================================================
    // Type trait to detect SerializationTraits specializations
    //=====================================================================
 
    namespace detail
    {
        using nfx::json::Document;

        template <typename T, typename = void>
        struct has_serialization_traits : std::false_type
        {
        };
 
        template <typename T>
        struct has_serialization_traits<
            T,
            std::void_t<decltype( SerializationTraits<std::decay_t<T>>::toDocument(
                std::declval<const std::decay_t<T>&>(), std::declval<Document&>() ) )>> : std::true_type
        {
        };

        template <typename T>
        inline constexpr bool has_serialization_traits_v = has_serialization_traits<T>::value;
 
        //=====================================================================
        // Type trait to identify nfx extension types
        //=====================================================================

        template <typename T>
        struct is_nfx_extension_type : std::false_type
        {
        };

        template <typename T>
        inline constexpr bool is_nfx_extension_type_v = is_nfx_extension_type<std::decay_t<T>>::value;
    } // namespace detail
 
    //=====================================================================
    // Concepts for template overload resolution
    //=====================================================================

    template <typename T>
    concept StlSerializable =
        !detail::is_nfx_extension_type_v<T> && !nfx::json::Primitive<T> && !is_json_container_v<T> &&
        !std::is_base_of_v<nfx::json::Document, std::remove_cvref_t<T>>;

    template <typename T>
    concept NfxSerializable =
        detail::is_nfx_extension_type_v<T> && !nfx::json::Primitive<T> && !is_json_container_v<T> &&
        !std::is_base_of_v<nfx::json::Document, std::remove_cvref_t<T>>;
} // namespace nfx::serialization::json