92 lines
3.2 KiB
C++
Executable File
92 lines
3.2 KiB
C++
Executable File
/*******************************************************************************
|
|
This file is Part of the ZEngine Library for 2D game development.
|
|
Copyright (C) 2002, 2003 James Turk
|
|
|
|
Licensed under a BSD-style license.
|
|
|
|
The maintainer of this library is James Turk (james@conceptofzero.net)
|
|
and the home of this Library is http://www.zengine.sourceforge.net
|
|
*******************************************************************************/
|
|
|
|
/*!
|
|
\file VersionInfo.h
|
|
\brief Definition file for VersionInfo class.
|
|
|
|
Definition file for VersinInfo class, simple class for containing and comparing
|
|
version numbers.
|
|
<br>$Id: VersionInfo.h,v 1.4 2003/07/12 01:25:42 cozman Exp $<br>
|
|
\author James Turk
|
|
**/
|
|
|
|
#ifndef __versioninfo_h__
|
|
#define __versioninfo_h__
|
|
|
|
#include "ZE_Utility.h"
|
|
|
|
/*!
|
|
\brief Class for holding version information.
|
|
|
|
Class for holding version information on a library. (Members capitalized because
|
|
g++ has issues with members named major and minor.)
|
|
**/
|
|
class VersionInfo
|
|
{
|
|
public:
|
|
//! Major version number.
|
|
unsigned int Major;
|
|
//! Minor version number, changes upon signifigant releases. (Often upon compatibility breaks.)
|
|
unsigned int Minor;
|
|
//! Version release number, changes on every release.
|
|
unsigned int Release;
|
|
//! String Description of release. (Often blank.)
|
|
std::string Extra;
|
|
|
|
/*!
|
|
\brief Constructor for VersionInfo.
|
|
|
|
Simple constructor for version info, with a parameter for each member.
|
|
\param maj Major version number.
|
|
\param min Minor version number.
|
|
\param rel Version release number.
|
|
\param ext Extra info std::string, optional (defaults to empty std::string).
|
|
**/
|
|
VersionInfo(unsigned int maj, unsigned int min, unsigned int rel, std::string ext="");
|
|
|
|
/*!
|
|
\brief Get std::string representing version number.
|
|
|
|
Get dotted version number major.minor.release [extra].
|
|
\return Formatted version std::string.
|
|
**/
|
|
std::string GetString() const;
|
|
|
|
/*!
|
|
\brief Less than operator overload for comparing VersionInfo.
|
|
|
|
Overload of the less than (<) operator for two VersionInfos.
|
|
\param rhs Right hand side of comparison.
|
|
\return true if less than, false if greater than or equal to.
|
|
**/
|
|
bool operator<(const VersionInfo &rhs) const;
|
|
|
|
/*!
|
|
\brief Equals to operator overload for comparing VersionInfo.
|
|
|
|
Overload of the equals to (==) operator for two VersionInfos.
|
|
\param rhs Right hand side of comparison.
|
|
\return true if equal to, false if not equals to.
|
|
**/
|
|
bool operator==(const VersionInfo &rhs) const;
|
|
|
|
/*!
|
|
\brief Greater than operator overload for comparing VersionInfo.
|
|
|
|
Overload of the greater than (>) operator for two VersionInfos.
|
|
\param rhs Right hand side of comparison.
|
|
\return true if greater than, false if less than or equal to.
|
|
**/
|
|
bool operator>(const VersionInfo &rhs) const;
|
|
};
|
|
|
|
#endif //__versioninfo_h__
|