IProvider.h

Go to the documentation of this file.

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2025.  All rights reserved
 */
#ifndef _Stroika_Foundation_DataExchange_XML_Providers_IProvider_h_
#define _Stroika_Foundation_DataExchange_XML_Providers_IProvider_h_ 1
 
#include "Stroika/Foundation/StroikaPreComp.h"
 
#include "Stroika/Foundation/DataExchange/XML/Common.h"
#include "Stroika/Foundation/DataExchange/XML/DOM.h"
#include "Stroika/Foundation/DataExchange/XML/SAXReader.h"
#include "Stroika/Foundation/DataExchange/XML/Schema.h"
#include "Stroika/Foundation/Execution/LazyInitialized.h"
#include "Stroika/Foundation/Streams/InputStream.h"
 
/**
 *  \file
 * 
 *  Generally ignore this file/module unless you need to control which XML provider you are using
 *  and/or to access internal representations from one of these providers.
 *
 *  \note Code-Status:  <a href="Code-Status.md#Alpha">Alpha</a>
 */
 
namespace Stroika::Foundation::DataExchange::XML::Providers {
 
    /**
     *  Abstract interface generally unused EXCEPT to compare that the ISchemaProvider POINTER EQUALS the IDOMProvider pointer.
     */
    struct IProvider {
        virtual ~IProvider () = default;
    };
 
    struct ISchemaProvider : public virtual IProvider {
        virtual ~ISchemaProvider ()                                                                  = default;
        virtual shared_ptr<Schema::IRep> SchemaFactory (const Streams::InputStream::Ptr<byte>& schemaData,
                                                        const Resource::ResolverPtr&           resolver) const = 0;
    };
    struct IDOMProvider : public virtual IProvider {
        virtual ~IDOMProvider () = default;
        // Note input stream 'in' maybe nullptr to avoid reading and create new blank with no root
        virtual shared_ptr<DOM::Document::IRep> DocumentFactory (const Streams::InputStream::Ptr<byte>& in,
                                                                 const Schema::Ptr& schemaToValidateAgainstWhileReading) const = 0;
    };
    struct ISAXProvider : public virtual IProvider {
        virtual ~ISAXProvider ()                                = default;
        virtual void SAXParse (const Streams::InputStream::Ptr<byte>& in, StructuredStreamEvents::IConsumer* callback,
                               const Schema::Ptr& schema) const = 0;
    };
    struct IXMLProvider : ISchemaProvider, IDOMProvider, ISAXProvider {};
 
#if qStroika_Foundation_DataExchange_XML_SupportParsing and qStroika_Foundation_DataExchange_XML_SupportSchema and qStroika_Foundation_DataExchange_XML_SupportDOM
    namespace Private_ {
        const IXMLProvider* GetDefaultProvider_ ();
    }
#endif
 
    /**
     *  Provided as using LazyInitialized so can be ...??? so used before main - and still destroyed properly... without forcing include of libxml2/xerces stuff
     */
#if qStroika_Foundation_DataExchange_XML_SupportParsing and qStroika_Foundation_DataExchange_XML_SupportSchema and qStroika_Foundation_DataExchange_XML_SupportDOM
    inline const Foundation::Execution::LazyInitialized<const IXMLProvider*> kDefaultProvider{Private_::GetDefaultProvider_};
#endif
 
}
 
#endif /*_Stroika_Foundation_DataExchange_XML_Providers_IProvider_h_*/