inifile.h

/*
** Copyright 2007-2025, RTE (https://www.rte-france.com)
** See AUTHORS.txt
** SPDX-License-Identifier: MPL-2.0
** This file is part of Antares-Simulator,
** Adequacy and Performance assessment for interconnected energy networks.
**
** Antares_Simulator is free software: you can redistribute it and/or modify
** it under the terms of the Mozilla Public Licence 2.0 as published by
** the Mozilla Foundation, either version 2 of the License, or
** (at your option) any later version.
**
** Antares_Simulator 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
** Mozilla Public Licence 2.0 for more details.
**
** You should have received a copy of the Mozilla Public Licence 2.0
** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
*/
#pragma once
 
#include <optional>
 
#include <yuni/yuni.h>
#include <yuni/core/string.h>
 
namespace Antares
{
class IniFile final
{
public:
    class Property final
    {
    public:
        Property() = default;
        explicit Property(const AnyString& key);
        template<class U>
        Property(const AnyString& key, const U& value);
        ~Property() = default;
 
        void saveToStream(std::ostream& file, uint64_t& written) const;
 
    public:
        YString key;
        YString value;
        Property* next = nullptr;
    };
 
    class Section final
    {
    public:
        Section() = default;
        explicit Section(const AnyString& name);
        ~Section();
 
        template<class U>
        Property* add(const AnyString& key, const U& value);
 
        template<class U>
        Property* add(const AnyString& key, const std::optional<U>& value);
 
        void add(const Property& property);
 
        void saveToStream(std::ostream& file, uint64_t& written) const;
 
        Property* find(const AnyString& key);
        const Property* find(const AnyString& key) const;
 
        template<class U, class StringT>
        U read(const StringT& key, const U& defValue) const;
 
        template<class CallbackT>
        void each(const CallbackT& callback);
 
        template<class CallbackT>
        void each(const CallbackT& callback) const;
 
        bool empty() const;
 
        uint size() const;
 
    public:
        Yuni::ShortString256 name;
        IniFile::Property* firstProperty = nullptr;
        IniFile::Property* lastProperty = nullptr;
        Section* next = nullptr;
 
    }; // class Section
 
public:
 
 
    IniFile() = default;
    explicit IniFile(const std::filesystem::path& filename);
    ~IniFile();
 
 
 
    void clear();
 
    bool loaded() const;
 
    bool open(const std::string& filename, bool warnings = true);
 
    bool open(const std::filesystem::path& filename, bool warnings = true);
 
    bool readStream(std::istream& in_stream);
 
    bool save(const AnyString& filename) const;
    void saveToStream(std::ostream&, uint64_t&) const;
 
    std::string toString() const;
 
    const std::string& filename() const;
 
 
 
    Section* add(Section* s);
 
    Section* addSection(const AnyString& name);
 
    bool empty() const;
 
    Section* find(const AnyString& name);
 
    const Section* find(const AnyString& name) const;
 
    template<class CallbackT>
    void each(const CallbackT& callback);
 
    template<class CallbackT>
    void each(const CallbackT& callback) const;
 
    template<class CallbackT>
    void properties(const CallbackT& callback);
 
    template<class CallbackT>
    void properties(const CallbackT& callback) const;
 
public:
    Section* firstSection = nullptr;
    Section* lastSection = nullptr;
 
private:
    std::string filename_;
 
}; // class IniFile
 
} // namespace Antares
 
#include "inifile.hxx"