/************************************************************************
 *
 * Copyright (C) 2009-2020 IRCAD France
 * Copyright (C) 2012-2020 IHU Strasbourg
 *
 * This file is part of Sight.
 *
 * Sight 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.
 *
 * Sight 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 Sight. If not, see <https://www.gnu.org/licenses/>.
 *
 ***********************************************************************/

#pragma once

#include "fwRuntime/config.hpp"

#include <iostream>
#include <string>

namespace fwRuntime
{

/**
 * @brief   Holds version information for libraries and modules.
 */
struct FWRUNTIME_CLASS_API Version
{

    /**
     * @brief   Constructor.
     *
     * Builds an undefined version.
     */
    FWRUNTIME_API Version();

    /**
     * @brief       Constructor.
     *
     * @param[in]   version     a string representing the version number.
     */
    FWRUNTIME_API Version(const std::string& version);

    /**
     * @brief       Constructor.
     *
     * @param[in]   major   the version major number
     * @param[in]   minor   the version minor number (0 by default)
     * @param[in]   patch   the version patch number (-1 by default)
     */
    FWRUNTIME_API Version(const int major, const int minor = 0, const int patch = -1);

    /**
     * @brief   Equality test.
     */
    FWRUNTIME_API bool operator==(const Version& version) const;

    /**
     * @brief   String converter.
     */
    FWRUNTIME_API const std::string string() const;

    /**
     * @brief   Return an ostream representation of a version.
     */
    FWRUNTIME_API friend std::ostream& operator<<(std::ostream& os, const Version& version);

    private:

        int m_major; ///< version major
        int m_minor; ///< version minor
        int m_patch; ///< version patch
        bool m_defined; ///< to know if the version is defined
};

} // namespace fwRuntime
