KisVersionedStorageIterator Class Reference

#include <KisResourceStorage.h>

Inheritance diagram for KisVersionedStorageIterator:

Public Member Functions
int	guessedVersion () const override
bool	hasNext () const override
	KisVersionedStorageIterator (const QVector< VersionedResourceEntry > &entries, KisStoragePlugin *_q)
QDateTime	lastModified () const override
void	next () override
	The iterator is only valid if next() has been called at least once.
KoResourceSP	resourceImpl () const override
	This only loads the resource when called.
QString	type () const override
QString	url () const override
QSharedPointer< KisResourceStorage::ResourceIterator >	versions () const override
Public Member Functions inherited from KisResourceStorage::ResourceIterator
KoResourceSP	resource () const
virtual	~ResourceIterator ()

Protected Member Functions
	KisVersionedStorageIterator (const QVector< VersionedResourceEntry > &entries, QVector< VersionedResourceEntry >::const_iterator begin, QVector< VersionedResourceEntry >::const_iterator end, KisStoragePlugin *_q)

Protected Attributes
QVector< VersionedResourceEntry >::const_iterator	m_begin
QVector< VersionedResourceEntry >::const_iterator	m_chunkStart
QVector< VersionedResourceEntry >::const_iterator	m_end
const QVector< VersionedResourceEntry >	m_entries
bool	m_isStarted = false
QVector< VersionedResourceEntry >::const_iterator	m_it
KisStoragePlugin *	q = 0

Detailed Description

Definition at line 354 of file KisResourceStorage.h.

Constructor & Destructor Documentation

KisVersionedStorageIterator() [1/2]

KisVersionedStorageIterator::KisVersionedStorageIterator	(	const QVector< VersionedResourceEntry > &	entries,
		KisStoragePlugin *	_q )

Definition at line 536 of file KisResourceStorage.cpp.

    : q(_q)
    , m_entries(entries)
    , m_begin(m_entries.constBegin())
    , m_end(m_entries.constEnd())
 
{
    //    ENTER_FUNCTION() << ppVar(std::distance(m_begin, m_end));
    //    for (auto it = m_begin; it != m_end; ++it) {
    //        qDebug() << ppVar(it->filename) << ppVar(it->guessedVersion);
    //    }
}

KisVersionedStorageIterator() [2/2]

KisVersionedStorageIterator::KisVersionedStorageIterator ( const QVector< VersionedResourceEntry > & entries, QVector< VersionedResourceEntry >::const_iterator begin, QVector< VersionedResourceEntry >::const_iterator end, KisStoragePlugin * _q )

protected

Definition at line 549 of file KisResourceStorage.cpp.

    : q(_q)
    , m_entries(entries)
    , m_begin(begin)
    , m_end(end)
{
//    ENTER_FUNCTION() << ppVar(std::distance(m_begin, m_end));
//    for (auto it = m_begin; it != m_end; ++it) {
//        qDebug() << ppVar(it->filename) << ppVar(it->guessedVersion);
//    }
}

Member Function Documentation

guessedVersion()

int KisVersionedStorageIterator::guessedVersion ( ) const

overridevirtual

Reimplemented from KisResourceStorage::ResourceIterator.

Definition at line 607 of file KisResourceStorage.cpp.

{
    return m_it->guessedVersion;
}

References m_it.

hasNext()

bool KisVersionedStorageIterator::hasNext ( ) const

overridevirtual

Implements KisResourceStorage::ResourceIterator.

Definition at line 564 of file KisResourceStorage.cpp.

{
    return (!m_isStarted && m_begin != m_end) ||
            (m_isStarted && std::next(m_it) != m_end);
}

References m_begin, m_end, m_isStarted, and m_it.

lastModified()

QDateTime KisVersionedStorageIterator::lastModified ( ) const

overridevirtual

Implements KisResourceStorage::ResourceIterator.

Definition at line 597 of file KisResourceStorage.cpp.

{
    return m_it->lastModified;
}

References m_it.

next()

void KisVersionedStorageIterator::next ( )

overridevirtual

The iterator is only valid if next() has been called at least once.

Implements KisResourceStorage::ResourceIterator.

Definition at line 570 of file KisResourceStorage.cpp.

{
 
    if (!m_isStarted) {
        m_isStarted = true;
        m_it = m_begin;
    } else {
        ++m_it;
    }
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(m_it != m_end);
 
    auto nextChunk = std::upper_bound(m_it, m_end, *m_it, VersionedResourceEntry::KeyLess());
    m_chunkStart = m_it;
    m_it = std::prev(nextChunk);
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, m_begin, m_chunkStart, m_end, m_isStarted, and m_it.

resourceImpl()

KoResourceSP KisVersionedStorageIterator::resourceImpl ( ) const

overridevirtual

This only loads the resource when called.

Implements KisResourceStorage::ResourceIterator.

Definition at line 602 of file KisResourceStorage.cpp.

{
    return q->resource(url());
}

References q, KisStoragePlugin::resource(), and url().

type()

QString KisVersionedStorageIterator::type ( ) const

overridevirtual

Implements KisResourceStorage::ResourceIterator.

Definition at line 592 of file KisResourceStorage.cpp.

{
    return m_it->resourceType;
}

References m_it.

url()

QString KisVersionedStorageIterator::url ( ) const

overridevirtual

Implements KisResourceStorage::ResourceIterator.

Definition at line 587 of file KisResourceStorage.cpp.

{
    return m_it->resourceType + "/" + m_it->filename;
}

References m_it.

versions()

QSharedPointer< KisResourceStorage::ResourceIterator > KisVersionedStorageIterator::versions ( ) const

overridevirtual

Reimplemented from KisResourceStorage::ResourceIterator.

Definition at line 612 of file KisResourceStorage.cpp.

{
    struct VersionsIterator : public KisVersionedStorageIterator
    {
        VersionsIterator(const QVector<VersionedResourceEntry> &entries,
                         QVector<VersionedResourceEntry>::const_iterator begin,
                         QVector<VersionedResourceEntry>::const_iterator end,
                         KisStoragePlugin *_q)
            : KisVersionedStorageIterator(entries, begin, end, _q)
        {
        }
 
        void next() override {
            if (!m_isStarted) {
                m_isStarted = true;
                m_it = m_begin;
            } else {
                ++m_it;
            }
        }
 
        QSharedPointer<KisResourceStorage::ResourceIterator> versions() const override{
            return toQShared(new VersionsIterator(m_entries, m_it, std::next(m_it), q));
        }
    };
 
    return toQShared(new VersionsIterator(m_entries, m_chunkStart, std::next(m_it), q));
}

References m_chunkStart, m_entries, m_it, q, and toQShared().

Member Data Documentation

m_begin

QVector<VersionedResourceEntry>::const_iterator KisVersionedStorageIterator::m_begin

protected

Definition at line 381 of file KisResourceStorage.h.

m_chunkStart

QVector<VersionedResourceEntry>::const_iterator KisVersionedStorageIterator::m_chunkStart

protected

Definition at line 380 of file KisResourceStorage.h.

m_end

QVector<VersionedResourceEntry>::const_iterator KisVersionedStorageIterator::m_end

protected

Definition at line 382 of file KisResourceStorage.h.

m_entries

const QVector<VersionedResourceEntry> KisVersionedStorageIterator::m_entries

protected

Definition at line 378 of file KisResourceStorage.h.

m_isStarted

bool KisVersionedStorageIterator::m_isStarted = false

protected

Definition at line 383 of file KisResourceStorage.h.

m_it

QVector<VersionedResourceEntry>::const_iterator KisVersionedStorageIterator::m_it

protected

Definition at line 379 of file KisResourceStorage.h.

q

KisStoragePlugin* KisVersionedStorageIterator::q = 0

protected

Definition at line 377 of file KisResourceStorage.h.

---

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

• libs/resources/KisResourceStorage.h
• libs/resources/KisResourceStorage.cpp