ls-standard-library/include/ls-std/io/xml/XmlReader.hpp

/*
 * Author:          Patrick-Christopher Mattulat
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2020-10-08
 * Changed:         2024-09-13
 *
 * */

#ifndef LS_STD_XML_READER_HPP
#define LS_STD_XML_READER_HPP

#include "XmlDocument.hpp"
#include "XmlParseMode.hpp"
#include "XmlParseParameter.hpp"
#include <list>
#include <ls-std/core/Class.hpp>
#include <ls-std/core/interface/IReader.hpp>
#include <ls-std/io/File.hpp>
#include <ls-std/os/dynamic-goal.hpp>

/*
 * @doc: class(name: 'XmlReader', package: 'io')
 * @doc: io.XmlReader.description('This class reads an XML file and returns an XML document.')
 * */

namespace ls::std::io
{
  class LS_STD_DYNAMIC_GOAL XmlReader : public ls::std::core::Class, public ls::std::core::interface_type::IReader
  {
    public:

      explicit XmlReader(const ::std::shared_ptr<ls::std::io::XmlDocument> &_document, const ::std::string &_absolutePath);
      ~XmlReader() noexcept override;

      // implementation

      ls::std::core::type::byte_field read() override; // nodiscard is optional here

      // additional functionality

      [[nodiscard]] ::std::shared_ptr<ls::std::io::XmlDocument> getDocument() const;
      void setDocument(const ::std::shared_ptr<ls::std::io::XmlDocument> &_document);
      void setFile(const ls::std::io::File &_xmlFile);

    private:

      ::std::shared_ptr<ls::std::io::XmlDocument> document{};
      ls::std::io::File xmlFile = ls::std::io::File{""};

      void _assignDocument(const ::std::shared_ptr<ls::std::io::XmlDocument> &_document);
      void _assignFile(const ls::std::io::File &_xmlFile);
  };
}

#endif