ixmlfile.h

Go to the documentation of this file.

/*
 * Copyright 2025 Ingemar Hedvall
 * SPDX-License-Identifier: MIT
 */
#pragma once
#include <memory>
#include <string>
 
#include "util/ixmlnode.h"
 
namespace util::xml {

class IXmlFile {
 public:
  virtual ~IXmlFile() = default;  

  void FileName(const std::string &filename);

  [[nodiscard]] std::string FileName() const { return filename_; }
 
  [[nodiscard]] std::string FileNameWithoutPath()
      const;  

  [[nodiscard]] std::string Version() const { return version_; }

  void Version(const std::string &version) { version_ = version; }

  [[nodiscard]] std::string Encoding() const { return encoding_; }
  void Encoding(const std::string &encoding) { encoding_ = encoding; }

  [[nodiscard]] bool Standalone() const { return standalone_; }

  [[nodiscard]] std::string RootName()
      const {  
    return root_node_ ? root_node_->TagName() : "";
  }

  IXmlNode &RootName(const std::string &name);

  [[nodiscard]] IXmlNode *RootNode() const { return root_node_.get(); }

  [[nodiscard]] std::string StyleSheet() const { return style_sheet_; }

  void StyleSheet(const std::string &style_sheet) {
    style_sheet_ = style_sheet;
  }

  template <typename T>
  [[nodiscard]] T Property(const std::string &key, const T &def = {}) const {
    return root_node_ ? root_node_->Property<T>(key, def) : def;
  }

  template <typename T>
  void SetProperty(const std::string &key, const T &value) {
    if (root_node_) {
      root_node_->SetProperty(key, value);
    }
  }

  void GetChildList(IXmlNode::ChildList &child_list)
      const;  

  [[nodiscard]] const IXmlNode *GetNode(
      const std::string &tag) const;  
 
  virtual bool ParseFile();  
  virtual bool ParseString(
      const std::string &input);  
  virtual void Reset();  
  virtual bool WriteFile();                           
  std::string WriteString(bool skip_header = false);  
 protected:
  IXmlFile() = default;  
  std::string filename_;            
  std::string version_ = "1.0";     
  std::string encoding_ = "UTF-8";  
  std::string style_sheet_;         
 
  bool standalone_ = true;               
  std::unique_ptr<IXmlNode> root_node_;  
 
  virtual std::unique_ptr<IXmlNode> CreateNode(
      const std::string &name);  
 private:
  void WriteRoot(std::ostream &dest, bool skip_header) const;
};

[[nodiscard]] std::unique_ptr<IXmlFile> CreateXmlFile(
    const std::string &type = "Expat");  
}  // namespace util::xml