file_settings.hpp

Go to the documentation of this file.

#pragma once
#include "../core_export.hpp"
#include "../collections/generic/sorted_dictionary.hpp"
#include "../collections/specialized/string_collection.hpp"
#include "../io/directory.hpp"
#include "../io/file.hpp"
#include "../io/path.hpp"
#include "../iequatable.hpp"
#include <map>

namespace xtd {
  namespace configuration {
    class core_export_ file_settings : public object, public iequatable<file_settings> {
    public:
      
      using string_dictionary = xtd::collections::generic::sorted_dictionary<xtd::string, xtd::string>;
      
      using string_collection = xtd::collections::specialized::string_collection;
      
      
      file_settings() noexcept = default;
      explicit file_settings(const xtd::string& file_path);
      explicit file_settings(std::iostream& stream);
      
      file_settings(file_settings&&) noexcept = default;
      file_settings(const file_settings&) noexcept = default;
      auto operator =(const file_settings&) noexcept -> file_settings& = default;
      ~file_settings();
      
      
      [[nodiscard]] auto auto_save() const noexcept -> bool;
      auto auto_save(bool value) noexcept -> void;
      
      [[nodiscard]] auto bottom_file_comment() const noexcept -> xtd::string;
      auto bottom_file_comment(const xtd::string& value) noexcept -> file_settings&;
      
      [[nodiscard]] auto file_path() const noexcept -> const xtd::string&;
      
      [[nodiscard]] auto key_values() const noexcept -> string_dictionary;
      [[nodiscard]] auto key_values(const xtd::string& section) const noexcept -> string_dictionary;
      
      [[nodiscard]] auto keys() const noexcept -> string_collection;
      [[nodiscard]] auto keys(const xtd::string& section) const noexcept -> string_collection;
      
      [[nodiscard]] auto sections() const noexcept -> string_collection;
      
      [[nodiscard]] auto stream() const noexcept -> std::optional<xtd::ref<std::iostream>>;
      
      [[nodiscard]] auto top_file_comment() const noexcept -> xtd::string;
      auto top_file_comment(const xtd::string& value) noexcept -> file_settings&;
      
      
      [[nodiscard]] auto equals(const xtd::object& obj) const noexcept -> bool override;
      [[nodiscard]] auto equals(const file_settings& other) const noexcept -> bool override;
      
      virtual auto from_string(const xtd::string& text) -> void;
      
      auto load(const xtd::string& file_path) -> void;
      auto load(std::istream& stream) -> void;
      
      [[nodiscard]] auto read(const xtd::string& key, const xtd::string& default_value) noexcept -> xtd::string;
      template<class type_t>
      [[nodiscard]] auto read(const xtd::string& key, const type_t& default_value) -> type_t {
        return xtd::parse<type_t>(read_string(xtd::string::empty_string, key, xtd::string::format("{}", default_value)));
      }

      [[nodiscard]] auto read(const xtd::string& section, const xtd::string& key, const xtd::string& default_value) noexcept -> xtd::string;
      template<class type_t>
      [[nodiscard]] auto read(const xtd::string& section, const xtd::string& key, const type_t& default_value) -> type_t {
        return xtd::parse<type_t>(read_string(section, key, xtd::string::format("{}", default_value)));
      }
      
      auto remove(const xtd::string& key) noexcept -> void;
      auto remove(const xtd::string& section, const xtd::string& key) noexcept -> void;
      
      auto remove_all_keys() noexcept -> void;
      auto remove_all_keys(const xtd::string& section) noexcept -> void;
      
      auto reset() -> void;
      
      auto save() -> void;
      
      auto save_as(const xtd::string& file_path) -> void;
      auto save_as(std::ostream& stream) -> void;
      
      [[nodiscard]] auto to_string() const noexcept -> xtd::string override;
      
      auto write(const xtd::string& key, const xtd::string& value) noexcept -> void;
      template<class type_t>
      auto write(const xtd::string& key, type_t&& value) -> void {
        write_string(xtd::string::empty_string, key, xtd::string::format("{}", value));
      }

      auto write(const xtd::string& section, const xtd::string& key, const xtd::string& value) noexcept -> void;
      template<class type_t>
      auto write(const xtd::string& section, const xtd::string& key, type_t&& value) -> void {
        write_string(section, key, xtd::string::format("{}", value));
      }

      
      
      auto operator [](const xtd::string& section) const noexcept -> const string_dictionary&;
      auto operator [](const xtd::string& section) noexcept -> string_dictionary&;
      
    protected:
      virtual auto convert_comment_to_text(const xtd::string& text) const noexcept -> xtd::string;
      virtual auto convert_text_to_comment(const xtd::string& text) const noexcept -> xtd::string;
      
    private:
      auto read_string(const xtd::string& section, const xtd::string& key, const xtd::string& default_value) noexcept -> xtd::string;
      auto write_string(const xtd::string& section, const xtd::string& key, const xtd::string& value) noexcept -> void;
      
      bool auto_save_ = false;
      xtd::collections::generic::sorted_dictionary<xtd::string, string_dictionary> after_key_value_comment_;
      xtd::collections::generic::sorted_dictionary<xtd::string, xtd::string> after_section_comment_;
      xtd::collections::generic::sorted_dictionary<xtd::string, string_dictionary> before_key_value_comment_;
      xtd::collections::generic::sorted_dictionary<xtd::string, xtd::string> before_section_comment_;
      xtd::string bottom_file_comment_;
      xtd::string file_path_;
      xtd::collections::generic::sorted_dictionary<xtd::string, string_dictionary> key_value_comment_;
      xtd::collections::generic::sorted_dictionary<xtd::string, xtd::string> section_comment_;
      xtd::collections::generic::sorted_dictionary<xtd::string, string_dictionary> section_key_values_;
      std::iostream* stream_ = nullptr;
      xtd::string top_file_comment_;
    };
  }
}