SAXReader.h

Go to the documentation of this file.

/*
 * Copyright(c) Sophist Solutions, Inc. 1990-2026.  All rights reserved
 */
#ifndef _Stroika_Foundation_DataExchange_XML_SAXReader_h_
#define _Stroika_Foundation_DataExchange_XML_SAXReader_h_ 1
 
#include "Stroika/Foundation/StroikaPreComp.h"
 
#include "Stroika/Foundation/Characters/String.h"
#include "Stroika/Foundation/DataExchange/StructuredStreamEvents/IConsumer.h"
#include "Stroika/Foundation/DataExchange/XML/Common.h"
#include "Stroika/Foundation/DataExchange/XML/Options.h"
#include "Stroika/Foundation/DataExchange/XML/Schema.h"
#include "Stroika/Foundation/Execution/ProgressMonitor.h"
#include "Stroika/Foundation/Streams/InputStream.h"
 
/**
 *  \file
 */
 
namespace Stroika::Foundation::DataExchange::XML::Providers {
    struct ISAXProvider;
};
namespace Stroika::Foundation::DataExchange::XML {
 
    /**
     * Parse will throw an exception if it encounters any errors parsing.
     *
     *  @see ObjectReaderRegistry for examples of one way to use this
     * 
     *  \note though we support using incompatible schema/saxProvider pairs, doing so incurs a significant performance penalty.
     */
    void SAXParse (const Providers::ISAXProvider& saxProvider, const Streams::InputStream::Ptr<byte>& in,
                   StructuredStreamEvents::IConsumer* callback = nullptr, const Schema::Ptr& schema = nullptr,
                   Execution::ProgressMonitor::Updater progress = nullptr);
#if qStroika_Foundation_DataExchange_XML_SupportParsing
    void SAXParse (const Streams::InputStream::Ptr<byte>& in, StructuredStreamEvents::IConsumer* callback = nullptr, const Schema::Ptr& schema = nullptr,
                   Execution::ProgressMonitor::Updater progress = nullptr, const Options& o = {}); ///< \brief Parse with the provider o names
#endif
 
#if qStroika_Foundation_DataExchange_XML_SupportParsing
    [[deprecated ("Since Stroika v3.0d5 use address of callback")]] inline void
    SAXParse (const Streams::InputStream::Ptr<byte>& in, StructuredStreamEvents::IConsumer& callback, const Schema::Ptr& schema = nullptr)
    {
        SAXParse (in, &callback, schema);
    }
#endif
 
}
 
/*
 ********************************************************************************
 ***************************** Implementation Details ***************************
 ********************************************************************************
 */
#include "SAXReader.inl"
 
#endif /*_Stroika_Foundation_DataExchange_XML_SAXReader_h_*/