header.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/>.
 */
#ifndef __ANTARES_LIBS_STUDY_HEADER_H__
#define __ANTARES_LIBS_STUDY_HEADER_H__
 
#include <ctime>
#include <filesystem>
 
#include <yuni/yuni.h>
#include <yuni/core/string.h>
 
#include <antares/inifile/inifile.h>
 
#include "version.h"
 
#define STUDYHEADER_DEFAULT_AUTHOR "Unknown"
#define STUDYHEADER_DEFAULT_CAPTION "No title"
 
namespace Antares::Data
{
class StudyHeader final
{
public:
    static bool readVersionFromFile(const std::filesystem::path& filename, std::string& version);
 
 
 
    StudyHeader()
    {
        reset();
    }
 
    ~StudyHeader() = default;
 
    void reset();
 
    bool loadFromFile(const std::filesystem::path& filename, bool warnings = true);
 
    bool saveToFile(const AnyString& filename, bool upgradeVersion = true);
 
    void CopySettingsToIni(IniFile& ini, bool upgradeVersion);
 
    static StudyVersion tryToFindTheVersion(const std::string& folder);
 
    bool validateVersion();
 
    Yuni::String caption;
 
    StudyVersion version;
 
    time_t dateCreated;
    time_t dateLastSave;
 
    Yuni::String author;
    Yuni::String editor;
 
private:
    bool internalLoadFromINIFile(const IniFile& ini, bool warnings);
 
    static bool internalFindVersionFromFile(const IniFile& ini, std::string& version);
 
}; // class StudyHeader;
 
} // namespace Antares::Data
 
#endif /* __ANTARES_LIBS_STUDY_HEADER_H__ */