VersionId Class Reference

A class, that supports base manipulation with version number. More...

#include <VersionId.h>

Public Member Functions
	VersionId ()=default
	Creates an zero version object. More...
	VersionId (int version, int release, int revision, int patch=0)
wxString	GetString () const
	Make string with version by MakeString() from instance values. More...
bool	operator== (const VersionId &other)
bool	operator!= (const VersionId &other)
bool	operator< (const VersionId &other)
bool	operator> (const VersionId &other)

Static Public Member Functions
static wxString	MakeString (int version, int release, int revision, int patch)
	Creates version string like "1.2.3" by parameters. More...
static VersionId	ParseFromString (wxString &versionString)
	Parse and return version object from version string like "1.2.3". More...

Private Attributes
int	mVersion { 0 }
int	mRelease { 0 }
int	mRevision { 0 }
int	mPatch { 0 }

Detailed Description

A class, that supports base manipulation with version number.

By default initialized by zero version number (Version = 0, Release = 0, Revision = 0, Patch = 0), that not allow us to update.

Definition at line 18 of file VersionId.h.

Constructor & Destructor Documentation

VersionId() [1/2]

VersionId::VersionId ( )

default

Creates an zero version object.

VersionId() [2/2]

VersionId::VersionId	(	int	version,
		int	release,
		int	revision,
		int	patch = 0
	)

Definition at line 11 of file VersionId.cpp.

    : mVersion(version),
      mRelease(release),
      mRevision(revision),
      mPatch(patch)
{}

Member Function Documentation

GetString()

wxString VersionId::GetString

(

)

const

Make string with version by MakeString() from instance values.

Definition at line 60 of file VersionId.cpp.

{
    return MakeString(mVersion, mRelease, mRevision, mPatch);
}

References MakeString(), mPatch, mRelease, mRevision, and mVersion.

Referenced by UpdatePopupDialog::AddHtmlContent().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeString()

wxString VersionId::MakeString ( int  version, int  release, int  revision, int  patch  )

static

Creates version string like "1.2.3" by parameters.

Definition at line 18 of file VersionId.cpp.

{
   if (patch == 0)
      return std::to_string(version)
        + "." + std::to_string(release)
        + "." + std::to_string(revision);
   else
      return std::to_string(version)
        + "." + std::to_string(release)
        + "." + std::to_string(revision)
        + "." + std::to_string(patch);
}

Referenced by GetString().

Here is the caller graph for this function:

operator!=()

bool VersionId::operator!=

(

const VersionId &

other

)

Definition at line 71 of file VersionId.cpp.

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

operator<()

bool VersionId::operator<

(

const VersionId &

other

)

Definition at line 76 of file VersionId.cpp.

{
    return std::tie(mVersion, mRelease, mRevision, mPatch) <
           std::tie(other.mVersion, other.mRelease, other.mRevision, other.mPatch);
}

References mPatch, mRelease, mRevision, and mVersion.

operator==()

bool VersionId::operator==

(

const VersionId &

other

)

Definition at line 65 of file VersionId.cpp.

{
    return std::tie(mVersion, mRelease, mRevision, mPatch) ==
           std::tie(other.mVersion, other.mRelease, other.mRevision, other.mPatch);
}

References mPatch, mRelease, mRevision, and mVersion.

operator>()

bool VersionId::operator>

(

const VersionId &

other

)

Definition at line 82 of file VersionId.cpp.

{
    return !(*this < other) && (*this != other);
}

ParseFromString()

VersionId VersionId::ParseFromString ( wxString &  versionString )

static

Parse and return version object from version string like "1.2.3".

Definition at line 31 of file VersionId.cpp.

{
    auto versionStringParts = wxSplit(versionString, '.');
 
    // If we have corrupted version string,
    // then return the zero version number, that not allow us to update.
    const auto size = versionStringParts.size();
    if (size < 2 || size > 4)
        return VersionId{};
 
    VersionId versionId;
 
    const auto fields = { &versionId.mVersion, &versionId.mRelease,
                            &versionId.mRevision, &versionId.mPatch };
 
    auto currentField = fields.begin();
 
    for (auto& v : versionStringParts)
    {
        if (v.empty() || !v.IsNumber())
            return VersionId{};
 
        **currentField = std::stoi(v.ToStdString());
        ++currentField;
    }
 
    return versionId;
}

References mPatch, mRelease, mRevision, mVersion, and size.

Referenced by UpdateDataParser::HandleXMLContent().

Here is the caller graph for this function:

Member Data Documentation

mPatch

int VersionId::mPatch { 0 }

private

Definition at line 43 of file VersionId.h.

Referenced by GetString(), operator<(), operator==(), and ParseFromString().

mRelease

int VersionId::mRelease { 0 }

private

Definition at line 41 of file VersionId.h.

Referenced by GetString(), operator<(), operator==(), and ParseFromString().

mRevision

int VersionId::mRevision { 0 }

private

Definition at line 42 of file VersionId.h.

Referenced by GetString(), operator<(), operator==(), and ParseFromString().

mVersion

int VersionId::mVersion { 0 }

private

Definition at line 40 of file VersionId.h.

Referenced by GetString(), operator<(), operator==(), and ParseFromString().

---

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

• VersionId.h
• VersionId.cpp