VersionUtil.h

Go to the documentation of this file.

/*
* True Reality Open Source Game and Simulation Engine
* Copyright © 2021 Acid Rain Studios LLC
*
* This library 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.0 of the License, or (at your option)
* any later version.
*
* This library 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 Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author Maxim Serebrennik
*/

#pragma once

#include <trUtil/Export.h>

#include <trUtil/StringUtils.h>
#include <trUtil/JSON/File.h>

#include <string>

namespace trUtil
{
    class TR_UTIL_EXPORT VersionUtil
    {
    public:

        const static std::string VERSION_FILE_NAME;
        const static std::string MAJ_VERSION;
        const static std::string MIN_VERSION;
        const static std::string YYMM_VERSION;
        const static std::string BUILD_VERSION;

        VersionUtil();

        VersionUtil(std::string fileName);

        VersionUtil(std::string fileName, std::string filePath);

        VersionUtil(std::string fileName, std::string filePath, std::string repoPath);

        ~VersionUtil();

        void SaveVersionFile();

        void SetVersion(int maj, int min, std::string yymm, int build);

        void SetVersion(int maj, int min, int yymm, int build);

        void GenerateVersionStructure();

        void IncrementVersion();

        void SetMajorVersion(int maj);

        int GetMajorVersion();

        void SetMinorVersion(int min);

        int GetMinorVersion();

        std::string GetYYMMVersion();

        void SetYYMMVersion(std::string yymm);

        void SetYYMMVersion(int yymm);

        void SetBuildVersion(int build);

        int GetBuildVersion();

        std::string GetVersionString();

        void UpdateVersion();

    private:
        JSON::File mVersion;

        std::string mRepoPath = trUtil::StringUtils::STR_BLANK;

        std::string GetTodaysVersionDate();

        int GetCurrentCommitNum();
    };
}