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 = std::map<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;
      file_settings& operator =(const file_settings&) noexcept = default;
      ~file_settings();
      
      
      bool auto_save() const noexcept;
     void auto_save(bool value) noexcept;
 
      xtd::string bottom_file_comment() const noexcept;
      file_settings& bottom_file_comment(const xtd::string& value) noexcept;
 
      const xtd::string& file_path() const noexcept;
 
      string_dictionary key_values() const noexcept;
      string_dictionary key_values(const xtd::string& section) const noexcept;
      
      string_collection keys() const noexcept;
      string_collection keys(const xtd::string& section) const noexcept;
 
      string_collection sections() const noexcept;
      
      std::optional<std::reference_wrapper<std::iostream>> stream() const noexcept;
 
      xtd::string top_file_comment() const noexcept;
      file_settings& top_file_comment(const xtd::string& value) noexcept;
      
      
      bool equals(const xtd::object& obj) const noexcept override;
      bool equals(const file_settings& other) const noexcept override;
      
      virtual void from_string(const xtd::string& text);
 
      void load(const xtd::string& file_path);
      void load(std::istream& stream);
 
      xtd::string read(const xtd::string& key, const xtd::string& default_value) noexcept;
      template<class type_t>
      type_t read(const xtd::string& key, const type_t& default_value) {
        return xtd::parse<type_t>(read_string(xtd::string::empty_string, key, xtd::string::format("{}", default_value)));
      }
      xtd::string read(const xtd::string& section, const xtd::string& key, const xtd::string& default_value) noexcept;
      template<class type_t>
      type_t read(const xtd::string& section, const xtd::string& key, const type_t& default_value) {
        return xtd::parse<type_t>(read_string(section, key, xtd::string::format("{}", default_value)));
      }
 
      void remove(const xtd::string& key) noexcept;
      void remove(const xtd::string& section, const xtd::string& key) noexcept;
      
      void remove_all_keys() noexcept;
      void remove_all_keys(const xtd::string& section) noexcept;
      
      void reset();
      
      void save();
      
      void save_as(const xtd::string& file_path);
      void save_as(std::ostream& stream);
 
      xtd::string to_string() const noexcept override;
      
      void write(const xtd::string& key, const xtd::string& value) noexcept;
      template<class type_t>
      void write(const xtd::string& key, type_t&& value) {
        write_string(xtd::string::empty_string, key, xtd::string::format("{}", value));
      }
      void write(const xtd::string& section, const xtd::string& key, const xtd::string& value) noexcept;
      template<class type_t>
      void write(const xtd::string& section, const xtd::string& key, type_t&& value) {
        write_string(section, key, xtd::string::format("{}", value));
      }
      
      
      const string_dictionary& operator [](const xtd::string& section) const noexcept;
      string_dictionary& operator [](const xtd::string& section) noexcept;
      
    protected:
      virtual xtd::string convert_comment_to_text(const xtd::string& text) const noexcept;
      virtual xtd::string convert_text_to_comment(const xtd::string& text) const noexcept;
 
    private:
      xtd::string read_string(const xtd::string& section, const xtd::string& key, const xtd::string& default_value) noexcept;
      void write_string(const xtd::string& section, const xtd::string& key, const xtd::string& value) noexcept;
 
      bool auto_save_ = false;
      std::map<xtd::string, string_dictionary> after_key_value_comment_;
      std::map<xtd::string, xtd::string> after_section_comment_;
      std::map<xtd::string, string_dictionary> before_key_value_comment_;
      std::map<xtd::string, xtd::string> before_section_comment_;
      xtd::string bottom_file_comment_;
      xtd::string file_path_;
      std::map<xtd::string, string_dictionary> key_value_comment_;
      std::map<xtd::string, xtd::string> section_comment_;
      std::map<xtd::string, string_dictionary> section_key_values_;
      std::iostream* stream_ = nullptr;
      xtd::string top_file_comment_;
    };
  }
}