UTVersionInfo.h

Go to the documentation of this file.

//==================================================================================================
// Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
//
// This program is free software; you can redistribute it and/or modify it under the terms of the
// GNU General Public License as published by the Free Software Foundation, version 2.0 of the
// License.
//
// 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 for more details.
//
// You should have received a copy of the GNU General Public License along with this program; if
// not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
// For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
// reserves the right and is willing to waive the proprietary source code disclosure aspects of that
// license as applied to the UT library in exchange for either substantial contributions to the
// development of the UT library or other forms of compensation.  Any such waiver must be
// established in writing between the copyright holder and the commercial entity obtaining such a
// waiver.
//==================================================================================================


#ifndef _UT_VERSION_INFO_H_
#define _UT_VERSION_INFO_H_


//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UT.h"


// \cond DOXYGEN_DOCUMENT_NEVER

#pragma pack(1)

//==================================================================================================
struct InternalVersionInfo_t
//==================================================================================================
{
    uint8   major;              
    uint8   minor;              
    uint8   subminor;           
    uint8   subsubminor;        
    uint8   alpha;              
    uint8   beta;               
    uint8   rc;                 
    uint8   has_build_number;   
    uint16  build_number;       
};

#pragma pack()


extern void get_version_string( const InternalVersionInfo_t* version, out String_t* version_string );

// \endcond


//==================================================================================================
class UT_EXPORT VersionInfo_t
//==================================================================================================
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
    inline                          VersionInfo_t();

    void                            Init(stringliteral* library_name = NULL);

    inline uint8                    MajorVersion() const;

    inline uint8                    MinorVersion() const;

    inline uint8                    SubminorVersion() const;

    inline uint8                    SubSubminorVersion() const;

    inline bool                     IsAlphaVersion() const;

    inline bool                     IsBetaVersion() const;

    inline bool                     IsReleaseCandidate() const;

    inline bool                     HasBuildNumber() const;

    inline uint16                   BuildNumber() const;

    void                            GetVersionString(out String_t* version_string) const;

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    bool                            m_initialized;
    InternalVersionInfo_t           m_info;
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations
//===
//==================================================================================================
//==================================================================================================
inline
VersionInfo_t::VersionInfo_t()
{
    m_initialized = false;
}


inline uint8
VersionInfo_t::MajorVersion() const
{
    assert(m_initialized);
    return m_info.major;
}


inline uint8
VersionInfo_t::MinorVersion() const
{
    assert(m_initialized);
    return m_info.minor;
}


inline uint8
VersionInfo_t::SubminorVersion() const
{
    assert(m_initialized);
    return m_info.subminor;
}


inline uint8
VersionInfo_t::SubSubminorVersion() const
{
    assert(m_initialized);
    return m_info.subsubminor;
}


inline bool
VersionInfo_t::IsAlphaVersion() const
{
    assert(m_initialized);
    return m_info.alpha ? true : false;
}


inline bool
VersionInfo_t::IsBetaVersion() const
{
    assert(m_initialized);
    return m_info.beta ? true : false;
}


inline bool
VersionInfo_t::IsReleaseCandidate() const
{
    assert(m_initialized);
    return m_info.rc ? true : false;
}


inline bool
VersionInfo_t::HasBuildNumber() const
{
    assert(m_initialized);
    return m_info.has_build_number ? true : false;
}


inline uint16
VersionInfo_t::BuildNumber() const
{
    assert(m_initialized && m_info.has_build_number);
    return m_info.build_number;
}


#endif // _UT_VERSION_INFO_H_