#include <kis_memento_item.h>

Inheritance diagram for KisMementoItem:

Public Types
enum	enumType { CHANGED = 0x0 , DELETED = 0x1 }

Public Member Functions
void	changeTile (KisTile *tile)

qint32	col () const

void	commit ()

void	debugPrintInfo ()

void	deleteTile (KisTile tile, KisTileData defaultTileData)

	KisMementoItem ()

	KisMementoItem (const KisMementoItem &rhs)

	KisMementoItem (const KisMementoItem &rhs, KisMementoManager *mm)

	KisMementoItem (qint32 col, qint32 row, KisTileData defaultTileData, KisMementoManager mm)

KisMementoItemSP	next () const

void	notifyAttachedToDataManager (KisMementoManager *mm)

void	notifyDeadWithoutDetaching ()

void	notifyDetachedFromDataManager ()

KisMementoItemSP	parent ()

void	reset ()

qint32	row () const

void	setNext (KisMementoItemSP next)

void	setParent (KisMementoItemSP parent)

KisTileSP	tile (KisMementoManager *mm)

KisTileData *	tileData () const

enumType	type ()

	~KisMementoItem ()

Public Member Functions inherited from KisShared
bool	deref ()

bool	ref ()

int	refCount ()

QAtomicInt *	sharedWeakReference ()

Protected Member Functions
void	releaseTileData ()

Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Protected Attributes
qint32	m_col {0}

bool	m_committedFlag {false}

KisMementoItemSP	m_next

KisMementoItemSP	m_parent

qint32	m_row {0}

KisTileData *	m_tileData {0}

enumType	m_type {CHANGED}

Detailed Description

Definition at line 18 of file kis_memento_item.h.

Member Enumeration Documentation

◆ enumType

enum KisMementoItem::enumType

Enumerator
CHANGED
DELETED

Definition at line 21 of file kis_memento_item.h.

                  {
        CHANGED  = 0x0,
        DELETED  = 0x1
    };

Constructor & Destructor Documentation

◆ KisMementoItem() [1/4]

KisMementoItem::KisMementoItem ( )

inline

Definition at line 27 of file kis_memento_item.h.

28 : m_tileData(0), m_committedFlag(false) {

29 }

KisMementoItem::m_tileData

KisTileData * m_tileData

Definition kis_memento_item.h:210

KisMementoItem::m_committedFlag

bool m_committedFlag

Definition kis_memento_item.h:211

◆ KisMementoItem() [2/4]

KisMementoItem::KisMementoItem ( const KisMementoItem & rhs )

inline

Definition at line 31 of file kis_memento_item.h.

            : KisShared(),
            m_tileData(rhs.m_tileData),
            m_committedFlag(rhs.m_committedFlag),
            m_type(rhs.m_type),
            m_col(rhs.m_col),
            m_row(rhs.m_row),
            m_next(0),
            m_parent(0) {
        if (m_tileData) {
            if (m_committedFlag)
                m_tileData->acquire();
            else
                m_tileData->ref();
        }
    }

References KisTileData::acquire(), m_committedFlag, m_tileData, and KisTileData::ref().

◆ KisMementoItem() [3/4]

KisMementoItem::KisMementoItem	(	qint32	col,
		qint32	row,
		KisTileData *	defaultTileData,
		KisMementoManager *	mm )

inline

Automatically called by Kis..HashTable. It means that this mementoItem is a root item of parental hierarchy. So m_parent should be NULL. Taking into account the tile was not present before, the status of the item should be 'DELETED'. This memento item is considered as committed, so we acquire the tile data right at the beginning.

Definition at line 57 of file kis_memento_item.h.

                                                                                                {
        Q_UNUSED(mm);
        m_tileData = defaultTileData;
        /* acquire the tileData deliberately and completely */
        m_tileData->acquire();
        m_col = col;
        m_row = row;
        m_type = DELETED;
        m_parent = 0;
        m_committedFlag = true; /* yes, we've committed it */
    }

References KisTileData::acquire(), col(), DELETED, m_col, m_committedFlag, m_parent, m_row, m_tileData, m_type, and row().

◆ KisMementoItem() [4/4]

KisMementoItem::KisMementoItem	(	const KisMementoItem &	rhs,
		KisMementoManager *	mm )

inline

FIXME: Not sure this function has any particular usecase. Just leave it for compatibility with a hash table

Definition at line 73 of file kis_memento_item.h.

                                                                     {
        Q_UNUSED(mm);
        m_tileData = rhs.m_tileData;
        /* Setting counter: m_refCount++ */
        m_tileData->ref();
        m_col = rhs.m_col;
        m_row = rhs.m_row;
        m_type = CHANGED;
        m_parent = 0;
        m_committedFlag = false;
    }

References CHANGED, m_col, m_committedFlag, m_parent, m_row, m_tileData, m_type, and KisTileData::ref().

◆ ~KisMementoItem()

KisMementoItem::~KisMementoItem ( )

inline

Definition at line 85 of file kis_memento_item.h.

                      {
        releaseTileData();
    }

References releaseTileData().

Member Function Documentation

◆ changeTile()

void KisMementoItem::changeTile ( KisTile * tile )

inline

Definition at line 119 of file kis_memento_item.h.

                                   {
        m_tileData = tile->tileData();
        /* Setting counter: m_refCount++ */
        m_tileData->ref();
        m_col = tile->col();
        m_row = tile->row();
        m_type = CHANGED;
    }

References CHANGED, KisTile::col(), m_col, m_row, m_tileData, m_type, KisTileData::ref(), KisTile::row(), tile(), and KisTile::tileData().

◆ col()

qint32 KisMementoItem::col ( ) const

inline

Definition at line 167 of file kis_memento_item.h.

                              {
        return m_col;
    }

References m_col.

◆ commit()

void KisMementoItem::commit ( )

inline

Setting counters to proper values: m_refCount++, m_usersCount++; m_refCount–

Definition at line 128 of file kis_memento_item.h.

                  {
        if (m_committedFlag) return;
        if (m_tileData) {
            m_tileData->acquire();
            m_tileData->deref();
 
            m_tileData->setMementoed(true);
        }
        m_committedFlag = true;
    }

References KisTileData::acquire(), KisTileData::deref(), m_committedFlag, m_tileData, and KisTileData::setMementoed().

◆ debugPrintInfo()

void KisMementoItem::debugPrintInfo ( )

inline

Definition at line 177 of file kis_memento_item.h.

                          {
        QString s = QString("------\n"
                   "Memento item:\t\t0x%1 (0x%2)\n"
                   "   status:\t(%3,%4) %5%6\n"
                   "   parent:\t0x%7 (0x%8)\n"
                   "   next:\t0x%9 (0x%10)\n")
                .arg((quintptr)this)
                .arg((quintptr)m_tileData)
                .arg(m_col)
                .arg(m_row)
                .arg((m_type == CHANGED) ? 'W' : 'D')
                .arg(m_committedFlag ? 'C' : '-')
                .arg((quintptr)m_parent.data())
                .arg(m_parent ? (quintptr)m_parent->m_tileData : 0)
                .arg((quintptr)m_next.data())
                .arg(m_next ? (quintptr)m_next->m_tileData : 0);
        dbgKrita << s;
    }

References CHANGED, KisSharedPtr< T >::data(), dbgKrita, m_col, m_committedFlag, m_next, m_parent, m_row, m_tileData, and m_type.

◆ deleteTile()

void KisMementoItem::deleteTile	(	KisTile *	tile,
		KisTileData *	defaultTileData )

inline

Definition at line 109 of file kis_memento_item.h.

                                                                 {
        m_tileData = defaultTileData;
        /* Setting counter: m_refCount++ */
        m_tileData->ref();
 
        m_col = tile->col();
        m_row = tile->row();
        m_type = DELETED;
    }

References KisTile::col(), DELETED, m_col, m_row, m_tileData, m_type, KisTileData::ref(), KisTile::row(), and tile().

◆ next()

KisMementoItemSP KisMementoItem::next ( ) const

inline

Definition at line 164 of file kis_memento_item.h.

                                         {
        return m_next;
    }

References m_next.

◆ notifyAttachedToDataManager()

void KisMementoItem::notifyAttachedToDataManager ( KisMementoManager * mm )

inline

Definition at line 97 of file kis_memento_item.h.

                                                            {
        Q_UNUSED(mm);
        // just to resemble KisTile...
    }

◆ notifyDeadWithoutDetaching()

void KisMementoItem::notifyDeadWithoutDetaching ( )

inline

Definition at line 93 of file kis_memento_item.h.

                                      {
        // just to resemble KisTile...
    }

◆ notifyDetachedFromDataManager()

void KisMementoItem::notifyDetachedFromDataManager ( )

inline

Definition at line 89 of file kis_memento_item.h.

                                         {
        // just to resemble KisTile...
    }

◆ parent()

KisMementoItemSP KisMementoItem::parent ( )

inline

Definition at line 156 of file kis_memento_item.h.

                                     {
        return m_parent;
    }

References m_parent.

◆ releaseTileData()

void KisMementoItem::releaseTileData ( )

inlineprotected

Definition at line 197 of file kis_memento_item.h.

                           {
        if (m_tileData) {
            if (m_committedFlag) {
                m_tileData->setMementoed(false);
                m_tileData->release();
            }
            else {
                m_tileData->deref();
            }
        }
    }

References KisTileData::deref(), m_committedFlag, m_tileData, KisTileData::release(), and KisTileData::setMementoed().

◆ reset()

void KisMementoItem::reset ( )

inline

Definition at line 103 of file kis_memento_item.h.

                 {
        releaseTileData();
        m_tileData = 0;
        m_committedFlag = false;
    }

References m_committedFlag, m_tileData, and releaseTileData().

◆ row()

qint32 KisMementoItem::row ( ) const

inline

Definition at line 170 of file kis_memento_item.h.

                              {
        return m_row;
    }

References m_row.

◆ setNext()

void KisMementoItem::setNext ( KisMementoItemSP next )

inline

Definition at line 161 of file kis_memento_item.h.

                                               {
        m_next = next;
    }

References m_next, and next().

◆ setParent()

void KisMementoItem::setParent ( KisMementoItemSP parent )

inline

Definition at line 153 of file kis_memento_item.h.

                                                   {
        m_parent = parent;
    }

References m_parent, and parent().

◆ tile()

KisTileSP KisMementoItem::tile ( KisMementoManager * mm )

inline

Definition at line 144 of file kis_memento_item.h.

                                                 {
        Q_ASSERT(m_tileData);
        return KisTileSP(new KisTile(m_col, m_row, m_tileData, mm));
    }

References m_col, m_row, and m_tileData.

◆ tileData()

KisTileData * KisMementoItem::tileData ( ) const

inline

Definition at line 173 of file kis_memento_item.h.

                                         {
        return m_tileData;
    }

References m_tileData.

◆ type()

enumType KisMementoItem::type ( )

inline

Definition at line 149 of file kis_memento_item.h.

                           {
        return m_type;
    }

References m_type.

Member Data Documentation

◆ m_col

qint32 KisMementoItem::m_col {0}

protected

Definition at line 214 of file kis_memento_item.h.

214{0};

◆ m_committedFlag

bool KisMementoItem::m_committedFlag {false}

protected

Definition at line 211 of file kis_memento_item.h.

211{false};

◆ m_next

KisMementoItemSP KisMementoItem::m_next

protected

Definition at line 217 of file kis_memento_item.h.

◆ m_parent

KisMementoItemSP KisMementoItem::m_parent

protected

Definition at line 218 of file kis_memento_item.h.

◆ m_row

qint32 KisMementoItem::m_row {0}

protected

Definition at line 215 of file kis_memento_item.h.

215{0};

◆ m_tileData

KisTileData* KisMementoItem::m_tileData {0}

protected

Definition at line 210 of file kis_memento_item.h.

210{0};

◆ m_type

enumType KisMementoItem::m_type {CHANGED}

protected

Definition at line 212 of file kis_memento_item.h.

212{CHANGED};

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

libs/image/tiles3/kis_memento_item.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ enumType

Constructor & Destructor Documentation

◆ KisMementoItem() [1/4]

◆ KisMementoItem() [2/4]

◆ KisMementoItem() [3/4]

◆ KisMementoItem() [4/4]

◆ ~KisMementoItem()

Member Function Documentation

◆ changeTile()

◆ col()

◆ commit()

◆ debugPrintInfo()

◆ deleteTile()

◆ next()

◆ notifyAttachedToDataManager()

◆ notifyDeadWithoutDetaching()

◆ notifyDetachedFromDataManager()

◆ parent()

◆ releaseTileData()

◆ reset()

◆ row()

◆ setNext()

◆ setParent()

◆ tile()

◆ tileData()

◆ type()

Member Data Documentation

◆ m_col

◆ m_committedFlag

◆ m_next

◆ m_parent

◆ m_row

◆ m_tileData

◆ m_type