PyKrita::version Class Reference

Class version. More...

#include <version_checker.h>

Public Member Functions
int	_major () const
int	_minor () const
bool	isValid () const
	operator QString () const
int	patch () const
	version (const int _major=zero, const int _minor=zero, const int patch=zero)
	Default constructor.

Static Public Member Functions
static version	fromPythonObject (PyObject *version_obj)
static version	fromString (const QString &version_str)
static version	invalid ()

Private Types
enum	type { undefined = -1 , zero = 0 }

Static Private Member Functions
static version	tryObtainVersionFromString (PyObject *version_obj)
static version	tryObtainVersionFromTuple (PyObject *version_obj)

Private Attributes
int	m_major
int	m_minor
int	m_patch

Detailed Description

Class version.

Definition at line 22 of file version_checker.h.

Member Enumeration Documentation

type

enum PyKrita::version::type

private

Enumerator
undefined
zero

Definition at line 24 of file version_checker.h.

              {
        undefined = -1,
        zero = 0
    };

Constructor & Destructor Documentation

version()

PyKrita::version::version ( const int _major = zero, const int _minor = zero, const int patch = zero )

inlineexplicit

Default constructor.

Definition at line 31 of file version_checker.h.

        : m_major(_major)
        , m_minor(_minor)
        , m_patch(patch) {
    }

Member Function Documentation

_major()

int PyKrita::version::_major ( ) const

inline

Definition at line 37 of file version_checker.h.

                       {
        return m_major;
    }

References m_major.

_minor()

int PyKrita::version::_minor ( ) const

inline

Definition at line 40 of file version_checker.h.

                       {
        return m_minor;
    }

References m_minor.

fromPythonObject()

static version PyKrita::version::fromPythonObject ( PyObject * version_obj )

inlinestatic

Definition at line 75 of file version_checker.h.

    {
        version v = tryObtainVersionFromTuple(version_obj);
        if (!v.isValid()) {
            // PEP396 requires __version__ to be a tuple of integers,
            // but some modules use a string instead.
            v = tryObtainVersionFromString(version_obj);
        }
        return v;
    }

References tryObtainVersionFromString(), tryObtainVersionFromTuple(), and v.

fromString()

static version PyKrita::version::fromString ( const QString & version_str )

inlinestatic

Definition at line 55 of file version_checker.h.

                                                          {
        int tmp[3] = {zero, zero, zero};
        QStringList parts = version_str.split('.');
        for (
            unsigned long i = 0
                              ; i < qMin(static_cast<unsigned long>(sizeof(tmp) / sizeof(int)), static_cast<unsigned long>(parts.size()))
            ; ++i
        ) {
            bool ok;
            const int num = parts[i].toInt(&ok);
            if (ok)
                tmp[i] = num;
            else {
                tmp[i] = undefined;
                break;
            }
        }
        return version(tmp[0], tmp[1], tmp[2]);
    };

References undefined, version(), and zero.

invalid()

static version PyKrita::version::invalid ( )

inlinestatic

Definition at line 86 of file version_checker.h.

                             {
        static version s_bad(undefined, undefined, undefined);
        return s_bad;
    }

References undefined.

isValid()

bool PyKrita::version::isValid ( ) const

inline

Definition at line 47 of file version_checker.h.

                         {
        return _major() != undefined && _minor() != undefined && patch() != undefined;
    }

References _major(), _minor(), patch(), and undefined.

operator QString()

PyKrita::version::operator QString ( ) const

inline

Definition at line 51 of file version_checker.h.

                             {
        return QString("%1.%2.%3").arg(_major()).arg(_minor()).arg(patch());
    }

References _major(), _minor(), and patch().

patch()

int PyKrita::version::patch ( ) const

inline

Definition at line 43 of file version_checker.h.

                      {
        return m_patch;
    }

References m_patch.

tryObtainVersionFromString()

static version PyKrita::version::tryObtainVersionFromString ( PyObject * version_obj )

inlinestaticprivate

Try to parse version string as a simple triplet X.Y.Z.

Todo

Some modules has letters in a version string... For example current pytz version is "2013d".

Definition at line 124 of file version_checker.h.

    {
        Q_ASSERT("Sanity check" && version_obj);
 
        if (!Python::isUnicode(version_obj))
            return version::invalid();
 
        QString version_str = Python::unicode(version_obj);
        if (version_str.isEmpty())
            return version::invalid();
 
        return version::fromString(version_str);
    }

References fromString(), invalid(), PyKrita::Python::isUnicode(), and PyKrita::Python::unicode().

tryObtainVersionFromTuple()

static version PyKrita::version::tryObtainVersionFromTuple ( PyObject * version_obj )

inlinestaticprivate

Definition at line 97 of file version_checker.h.

    {
        Q_ASSERT("Sanity check" && version_obj);
 
        if (PyTuple_Check(version_obj) == 0)
            return version::invalid();
 
        int version_info[3] = {0, 0, 0};
        for (unsigned i = 0; i < PyTuple_Size(version_obj); ++i) {
            PyObject* v = PyTuple_GetItem(version_obj, i);
            if (v && PyLong_Check(v))
                version_info[i] = PyLong_AsLong(v);
            else
                version_info[i] = -1;
        }
        if (version_info[0] != -1 && version_info[1] != -1 && version_info[2] != -1)
            return ::PyKrita::version(version_info[0], version_info[1], version_info[2]);
 
        return version::invalid();
    }

References invalid(), and v.

Member Data Documentation

m_major

int PyKrita::version::m_major

private

Definition at line 92 of file version_checker.h.

m_minor

int PyKrita::version::m_minor

private

Definition at line 93 of file version_checker.h.

m_patch

int PyKrita::version::m_patch

private

Definition at line 94 of file version_checker.h.

---

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

• plugins/extensions/pykrita/plugin/version_checker.h