Namespace.h

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2025.  All rights reserved
 */
#ifndef _Stroika_Foundation_DataExchange_XML_Namespace_h_
#define _Stroika_Foundation_DataExchange_XML_Namespace_h_ 1
 
#include "Stroika/Foundation/StroikaPreComp.h"
 
#include "Stroika/Foundation/Characters/String.h"
#include "Stroika/Foundation/Containers/Mapping.h"
#include "Stroika/Foundation/Containers/Sequence.h"
#include "Stroika/Foundation/DataExchange/XML/Common.h"
#include "Stroika/Foundation/IO/Network/URI.h"
 
namespace Stroika::Foundation::DataExchange::XML {
 
    using Characters::String;
    using Containers::Mapping;
    using Containers::Sequence;
    using IO::Network::URI;
 
    /**
     *  \brief used to specify default namespace, and any n: prefixes applicable to elements.
     * 
     *  \note default namespace does NOT apply to attributes, only element names...
     */
    struct NamespaceDefinitions {
    public:
        NamespaceDefinitions () = default;
        NamespaceDefinitions (const optional<URI>& defaultNamespace, const Mapping<String, URI>& prefixedNamespaces = {});
        NamespaceDefinitions (const Mapping<String, URI>& prefixedNamespaces);
 
    public:
        nonvirtual bool operator== (const NamespaceDefinitions&) const = default;
 
    public:
        nonvirtual optional<URI> GetDefaultNamespace () const;
 
    public:
        nonvirtual Mapping<String, URI> GetPrefixedNamespaces () const;
 
    public:
        /**
         */
        nonvirtual String ToString () const;
 
    private:
        optional<URI>        fDefaultNamespace_;
        Mapping<String, URI> fPrefixedNS_;
    };
 
    /**
     *  Note name argument slightly more flexible than just String so double conversion works ("" can be assigned to NameWithNamespace)
     * 
     *  \note similar to NamespaceDefinition, but this refers to elements which may or may not have an associated namespace.
     */
    struct NameWithNamespace {
        String        fName;
        optional<URI> fNamespace;
 
        template <Characters::IConvertibleToString NAME_TYPE>
        NameWithNamespace (NAME_TYPE&& name);
        NameWithNamespace (const optional<URI>& ns, const String& name);
 
        bool operator== (const NameWithNamespace& rhs) const = default;
#if qCompilerAndStdLib_explicitly_defaulted_threeway_warning_Buggy
        DISABLE_COMPILER_CLANG_WARNING_START ("clang diagnostic ignored \"-Wdefaulted-function-deleted\"")
#endif
        auto operator<=> (const NameWithNamespace& rhs) const = default;
#if qCompilerAndStdLib_explicitly_defaulted_threeway_warning_Buggy
        DISABLE_COMPILER_CLANG_WARNING_END ("clang diagnostic ignored \"-Wdefaulted-function-deleted\"")
#endif
        /**
         */
        nonvirtual String ToString () const;
    };
 
    /**
     *  Common 'name/namespace' combo used internally in XML.
     */
    inline const NameWithNamespace kXMLNS{"http://www.w3.org/2000/xmlns/"sv, "xmlns"sv};
 
}
 
/*
 ********************************************************************************
 ***************************** Implementation Details ***************************
 ********************************************************************************
 */
#include "Namespace.inl"
 
#endif /*_Stroika_Foundation_DataExchange_XML_Namespace_h_*/