IniFile.h

Go to the documentation of this file.

// This file is part of CoreLibrary containing useful reusable utility
// classes.
//
// Copyright (C) 2014 to present, Duncan Crutchley
// Contact <dac1976github@outlook.com>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License and GNU Lesser General Public License
// for more details.
//
// You should have received a copy of the GNU General Public License
// and GNU Lesser General Public License along with this program. If
// not, see <http://www.gnu.org/licenses/>.

#ifndef INIFILE
#define INIFILE

#include "Platform/PlatformDefines.h"
#include <utility>
#include <map>
#include <cstdint>
#include "IniFileSectionDetails.h"

namespace core_lib
{
namespace ini_file
{

class CORE_LIBRARY_DLL_SHARED_API IniFile final
{
public:
#ifdef USE_DEFAULT_CONSTRUCTOR_

    IniFile();
#else

    IniFile() = default;
#endif

    IniFile(const IniFile&) = default;
    explicit IniFile(const std::string& iniFilePath);
    ~IniFile() = default;
    IniFile& operator=(const IniFile&) = default;
#ifdef USE_EXPLICIT_MOVE_

    IniFile(IniFile&& ini);
    IniFile& operator=(IniFile&& ini);
#else

    IniFile(IniFile&&) = default;
    IniFile& operator=(IniFile&&) = default;
#endif

    void LoadFile(const std::string& iniFilePath);
    void UpdateFile(const std::string& overridePath = "") const;
    std::list<std::string> GetSections() const;
    keys_list GetSection(const std::string& section) const;
    bool SectionExists(const std::string& section) const;
    bool KeyExists(const std::string& section, const std::string& key) const;
    bool ReadBool(const std::string& section, const std::string& key,
                  bool defaultValue = false) const;
    int32_t ReadInt32(const std::string& section, const std::string& key,
                      int32_t defaultValue = 0) const;
    int64_t ReadInt64(const std::string& section, const std::string& key,
                      int64_t defaultValue = 0L) const;
    double ReadDouble(const std::string& section, const std::string& key,
                      double defaultValue = 0.0) const;
    long double ReadLongDouble(const std::string& section, const std::string& key,
                               long double defaultValue = 0.0L) const;
    std::string ReadString(const std::string& section, const std::string& key,
                           const std::string& defaultValue = "") const;

    void WriteBool(const std::string& section, const std::string& key, bool value);
    void WriteInt32(const std::string& section, const std::string& key, int32_t value);
    void WriteInt64(const std::string& section, const std::string& key, int64_t value);
    void WriteDouble(const std::string& section, const std::string& key, double value);
    void WriteLongDouble(const std::string& section, const std::string& key, long double value);
    void WriteString(const std::string& section, const std::string& key, const std::string& value);
    void EraseSection(const std::string& section);
    void EraseSections();
    void EraseKey(const std::string& section, const std::string& key);
    void EraseKeys(const std::string& section);

private:
#ifdef USE_DEFAULT_CONSTRUCTOR_

    mutable bool m_changesMade;
    std::string m_iniFilePath;
#else

    mutable bool m_changesMade{false};
    std::string m_iniFilePath{"config.ini"};
#endif

    using section_map = std::map<std::string, if_private::SectionDetails>;
    section_map m_sectionMap;
    using section_iter = section_map::iterator;
    using section_citer = section_map::const_iterator;
    if_private::line_list m_lines;

    std::string ReadValueString(const std::string& section, const std::string& key,
                                const std::string& defaultValue) const;
    void WriteValueString(const std::string& section, const std::string& key,
                          const std::string& value);
};

} // namespace ini_file
} // namespace core_lib

#endif // INIFILE