#include <version.h>

Public Types
typedef T	ComponentType

typedef Version< T, N, Mandatory >	ThisType

Public Member Functions
constexpr	Version ()=default

template<typename ... Other>
constexpr	Version (Other ... components)

	Version (const QString &version)
	Creates version from string in format "x.y.z". More...

	Version (const QByteArray &version)
	Creates version from byte array in format "x.y.z". More...

constexpr ComponentType	majorNumber () const

constexpr ComponentType	minorNumber () const

constexpr ComponentType	revisionNumber () const

constexpr ComponentType	patchNumber () const

constexpr ComponentType	operator[] (const std::size_t i) const

	operator QString () const

constexpr bool	isValid () const

Static Public Member Functions
template<typename StringClassWithSplitMethod >
static Version	tryParse (const StringClassWithSplitMethod &s, const Version &defaultVersion)

Private Types
using	ComponentsArray = std::array< T, N >

Private Member Functions
template<typename StringsList >
	Version (const StringsList &versionParts)

Static Private Member Functions
template<typename StringsList >
static ComponentsArray	parseList (const StringsList &versionParts)

Private Attributes
ComponentsArray	m_components {{}}

Friends
bool	operator== (const ThisType &left, const ThisType &right)

bool	operator< (const ThisType &left, const ThisType &right)

Detailed Description

template<typename T, std::size_t N, std::size_t Mandatory = N>
class Utils::Version< T, N, Mandatory >

Definition at line 41 of file version.h.

Member Typedef Documentation

◆ ComponentsArray

template<typename T , std::size_t N, std::size_t Mandatory = N>

using Utils::Version< T, N, Mandatory >::ComponentsArray = std::array<T, N>

private

Definition at line 157 of file version.h.

◆ ComponentType

template<typename T , std::size_t N, std::size_t Mandatory = N>

typedef T Utils::Version< T, N, Mandatory >::ComponentType

Definition at line 48 of file version.h.

◆ ThisType

template<typename T , std::size_t N, std::size_t Mandatory = N>

typedef Version<T, N, Mandatory> Utils::Version< T, N, Mandatory >::ThisType

Definition at line 49 of file version.h.

Constructor & Destructor Documentation

◆ Version() [1/5]

template<typename T , std::size_t N, std::size_t Mandatory = N>

constexpr Utils::Version< T, N, Mandatory >::Version ( )

constexprdefault

◆ Version() [2/5]

template<typename T , std::size_t N, std::size_t Mandatory = N>

template<typename ... Other>

constexpr Utils::Version< T, N, Mandatory >::Version ( Other ... components )

inlineconstexpr

Definition at line 54 of file version.h.

             : m_components {{static_cast<T>(components) ...}}
         {
         }

◆ Version() [3/5]

template<typename T , std::size_t N, std::size_t Mandatory = N>

Utils::Version< T, N, Mandatory >::Version ( const QString & version )

inline

Creates version from string in format "x.y.z".

Parameters

version Version string in format "x.y.z"

Exceptions

RuntimeError if parsing fails

Definition at line 65 of file version.h.

             : Version {version.split(QLatin1Char('.'))}
         {
         }

◆ Version() [4/5]

template<typename T , std::size_t N, std::size_t Mandatory = N>

Utils::Version< T, N, Mandatory >::Version ( const QByteArray & version )

inline

Creates version from byte array in format "x.y.z".

Parameters

version Version string in format "x.y.z"

Exceptions

RuntimeError if parsing fails

Definition at line 76 of file version.h.

             : Version {version.split('.')}
         {
         }

◆ Version() [5/5]

template<typename T , std::size_t N, std::size_t Mandatory = N>

template<typename StringsList >

Utils::Version< T, N, Mandatory >::Version ( const StringsList & versionParts )

inlineprivate

Definition at line 180 of file version.h.

             : m_components (parseList(versionParts)) // GCC 4.8.4 has problems with the uniform initializer here
         {
         }

Member Function Documentation

◆ isValid()

template<typename T , std::size_t N, std::size_t Mandatory = N>

constexpr bool Utils::Version< T, N, Mandatory >::isValid ( ) const

inlineconstexpr

Definition at line 126 of file version.h.

         {
             return (*this != ThisType {});
         }

Referenced by SearchPluginManager::getPluginVersion(), and SearchPluginManager::parseVersionInfo().

Here is the caller graph for this function:

◆ majorNumber()

template<typename T , std::size_t N, std::size_t Mandatory = N>

constexpr ComponentType Utils::Version< T, N, Mandatory >::majorNumber ( ) const

inlineconstexpr

Definition at line 81 of file version.h.

         {
             static_assert(N >= 1, "The number of version components is too small");
             return m_components[0];
         }

◆ minorNumber()

template<typename T , std::size_t N, std::size_t Mandatory = N>

constexpr ComponentType Utils::Version< T, N, Mandatory >::minorNumber ( ) const

inlineconstexpr

Definition at line 87 of file version.h.

         {
             static_assert(N >= 2, "The number of version components is too small");
             return m_components[1];
         }

◆ operator QString()

template<typename T , std::size_t N, std::size_t Mandatory = N>

Utils::Version< T, N, Mandatory >::operator QString ( ) const

inline

Definition at line 110 of file version.h.

         {
             // find the last one non-zero component
             std::size_t lastSignificantIndex = N - 1;
             while ((lastSignificantIndex > 0) && ((*this)[lastSignificantIndex] == 0))
                 --lastSignificantIndex;
  
             if (lastSignificantIndex + 1 < Mandatory)     // lastSignificantIndex >= 0
                 lastSignificantIndex = Mandatory - 1;     // and Mandatory >= 1
  
             QString res = QString::number((*this)[0]);
             for (std::size_t i = 1; i <= lastSignificantIndex; ++i)
                 res += QLatin1Char('.') + QString::number((*this)[i]);
             return res;
         }

◆ operator[]()

template<typename T , std::size_t N, std::size_t Mandatory = N>

constexpr ComponentType Utils::Version< T, N, Mandatory >::operator[] ( const std::size_t i ) const

inlineconstexpr

Definition at line 105 of file version.h.

         {
             return m_components.at(i);
         }

◆ parseList()

template<typename T , std::size_t N, std::size_t Mandatory = N>

template<typename StringsList >

static ComponentsArray Utils::Version< T, N, Mandatory >::parseList ( const StringsList & versionParts )

inlinestaticprivate

Definition at line 160 of file version.h.

         {
             if ((static_cast<std::size_t>(versionParts.size()) > N)
                 || (static_cast<std::size_t>(versionParts.size()) < Mandatory))
             {
                 throw RuntimeError(QLatin1String("Incorrect number of version components"));
             }
  
             bool ok = false;
             ComponentsArray res {{}};
             for (std::size_t i = 0; i < static_cast<std::size_t>(versionParts.size()); ++i)
             {
                 res[i] = static_cast<T>(versionParts[static_cast<typename StringsList::size_type>(i)].toInt(&ok));
                 if (!ok)
                     throw RuntimeError(QLatin1String("Can not parse version component"));
             }
             return res;
         }

◆ patchNumber()

template<typename T , std::size_t N, std::size_t Mandatory = N>

constexpr ComponentType Utils::Version< T, N, Mandatory >::patchNumber ( ) const

inlineconstexpr

Definition at line 99 of file version.h.

         {
             static_assert(N >= 4, "The number of version components is too small");
             return m_components[3];
         }

◆ revisionNumber()

template<typename T , std::size_t N, std::size_t Mandatory = N>

constexpr ComponentType Utils::Version< T, N, Mandatory >::revisionNumber ( ) const

inlineconstexpr

Definition at line 93 of file version.h.

         {
             static_assert(N >= 3, "The number of version components is too small");
             return m_components[2];
         }

◆ tryParse()

template<typename T , std::size_t N, std::size_t Mandatory = N>

template<typename StringClassWithSplitMethod >

static Version Utils::Version< T, N, Mandatory >::tryParse	(	const StringClassWithSplitMethod &	s,
		const Version< T, N, Mandatory > &	defaultVersion
	)

inlinestatic

Definition at line 143 of file version.h.

         {
             try
             {
                 return Version(s);
             }
             catch (const RuntimeError &error)
             {
                 qDebug() << "Error parsing version:" << error.message();
                 return defaultVersion;
             }
         }

References Exception::message().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<

template<typename T , std::size_t N, std::size_t Mandatory = N>

bool operator<	(	const ThisType &	left,
		const ThisType &	right
	)

friend

Definition at line 137 of file version.h.

         {
             return (left.m_components < right.m_components);
         }

◆ operator==

template<typename T , std::size_t N, std::size_t Mandatory = N>

bool operator==	(	const ThisType &	left,
		const ThisType &	right
	)

friend

Definition at line 132 of file version.h.

         {
             return (left.m_components == right.m_components);
         }

Member Data Documentation

◆ m_components

template<typename T , std::size_t N, std::size_t Mandatory = N>

ComponentsArray Utils::Version< T, N, Mandatory >::m_components {{}}

private

Definition at line 185 of file version.h.

The documentation for this class was generated from the following file:

src/base/utils/version.h

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

template<typename T, std::size_t N, std::size_t Mandatory = N> class Utils::Version< T, N, Mandatory >

Member Typedef Documentation

◆ ComponentsArray

◆ ComponentType

◆ ThisType

Constructor & Destructor Documentation

◆ Version() [1/5]

◆ Version() [2/5]

◆ Version() [3/5]

◆ Version() [4/5]

◆ Version() [5/5]

Member Function Documentation

◆ isValid()

◆ majorNumber()

◆ minorNumber()

◆ operator QString()

◆ operator[]()

◆ parseList()

◆ patchNumber()

◆ revisionNumber()

◆ tryParse()

Friends And Related Function Documentation

◆ operator<

◆ operator==

Member Data Documentation

◆ m_components

template<typename T, std::size_t N, std::size_t Mandatory = N>
class Utils::Version< T, N, Mandatory >