#include <kis_stroke.h>

Public Types
enum	Type { LEGACY , LOD0 , LODN , SUSPEND , RESUME }

Public Member Functions
void	addJob (KisStrokeJobData *data)

void	addMutatedJobs (const QVector< KisStrokeJobData * > list)

qreal	balancingRatioOverride () const

bool	canCancel () const

void	cancelStroke ()

bool	canForgetAboutMe () const

bool	clearsRedoOnStart () const

void	endStroke ()

bool	hasJobs () const

QString	id () const

bool	isAsynchronouslyCancellable () const

bool	isCancelled () const

bool	isEnded () const

bool	isExclusive () const

bool	isInitialized () const

	KisStroke (KisStrokeStrategy *strokeStrategy, Type type=LEGACY, int levelOfDetail=0)

KisStrokeSP	lodBuddy () const

KUndo2MagicString	name () const

int	nextJobLevelOfDetail () const

KisStrokeJobData::Sequentiality	nextJobSequentiality () const

qint32	numJobs () const

KisStrokeJob *	popOneJob ()

void	setLodBuddy (KisStrokeSP buddy)

bool	supportsSuspension ()

bool	supportsWrapAroundMode () const

void	suspendStroke (KisStrokeSP recipient)

Type	type () const

int	worksOnLevelOfDetail () const

	~KisStroke ()

Private Member Functions
void	clearQueueOnCancel ()

KisStrokeJob *	dequeue ()

void	enqueue (KisStrokeJobStrategy strategy, KisStrokeJobData data)

void	prepend (KisStrokeJobStrategy strategy, KisStrokeJobData data, int levelOfDetail, bool isOwnJob)

bool	sanityCheckAllJobsAreCancellable () const

QQueue< KisStrokeJob * > &	testingGetQueue ()

Private Attributes
QScopedPointer< KisStrokeJobStrategy >	m_cancelStrategy

QScopedPointer< KisStrokeJobStrategy >	m_dabStrategy

QScopedPointer< KisStrokeJobStrategy >	m_finishStrategy

QScopedPointer< KisStrokeJobStrategy >	m_initStrategy

bool	m_isCancelled

QQueue< KisStrokeJob * >	m_jobsQueue

KisStrokeSP	m_lodBuddy

QScopedPointer< KisStrokeJobStrategy >	m_resumeStrategy

bool	m_strokeEnded

bool	m_strokeInitialized

QScopedPointer< KisStrokeStrategy >	m_strokeStrategy

bool	m_strokeSuspended

QScopedPointer< KisStrokeJobStrategy >	m_suspendStrategy

Type	m_type

int	m_worksOnLevelOfDetail

Friends
class	KisStrokeStrategyUndoCommandBasedTest

class	KisStrokeTest

Detailed Description

Definition at line 21 of file kis_stroke.h.

Member Enumeration Documentation

◆ Type

enum KisStroke::Type

Enumerator
LEGACY
LOD0
LODN
SUSPEND
RESUME

Definition at line 24 of file kis_stroke.h.

              {
        LEGACY,
        LOD0,
        LODN,
        SUSPEND,
        RESUME
    };

Constructor & Destructor Documentation

◆ KisStroke()

KisStroke::KisStroke	(	KisStrokeStrategy *	strokeStrategy,
		Type	type = LEGACY,
		int	levelOfDetail = 0 )

Definition at line 12 of file kis_stroke.cpp.

    : m_strokeStrategy(strokeStrategy),
      m_strokeInitialized(false),
      m_strokeEnded(false),
      m_strokeSuspended(false),
      m_isCancelled(false),
      m_worksOnLevelOfDetail(levelOfDetail),
      m_type(type)
{
    m_initStrategy.reset(m_strokeStrategy->createInitStrategy());
    m_dabStrategy.reset(m_strokeStrategy->createDabStrategy());
    m_cancelStrategy.reset(m_strokeStrategy->createCancelStrategy());
    m_finishStrategy.reset(m_strokeStrategy->createFinishStrategy());
    m_suspendStrategy.reset(m_strokeStrategy->createSuspendStrategy());
    m_resumeStrategy.reset(m_strokeStrategy->createResumeStrategy());
 
    m_strokeStrategy->notifyUserStartedStroke();
 
    if(!m_initStrategy) {
        m_strokeInitialized = true;
    }
    else {
        enqueue(m_initStrategy.data(), m_strokeStrategy->createInitData());
    }
}

References enqueue(), m_cancelStrategy, m_dabStrategy, m_finishStrategy, m_initStrategy, m_resumeStrategy, m_strokeInitialized, m_strokeStrategy, and m_suspendStrategy.

◆ ~KisStroke()

KisStroke::~KisStroke ( )

Definition at line 38 of file kis_stroke.cpp.

{
    Q_ASSERT(m_strokeEnded);
    Q_ASSERT(m_jobsQueue.isEmpty());
}

References m_jobsQueue, and m_strokeEnded.

Member Function Documentation

◆ addJob()

void KisStroke::addJob ( KisStrokeJobData * data )

Definition at line 70 of file kis_stroke.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_NOOP(!m_strokeEnded);
    enqueue(m_dabStrategy.data(), data);
}

References enqueue(), KIS_SAFE_ASSERT_RECOVER_NOOP, m_dabStrategy, and m_strokeEnded.

◆ addMutatedJobs()

void KisStroke::addMutatedJobs ( const QVector< KisStrokeJobData * > list )

Definition at line 76 of file kis_stroke.cpp.

{
    // factory methods can return null, if no action is needed
    if (!m_dabStrategy) {
        qDeleteAll(list);
        return;
    }
 
    // Find first non-alien (non-suspend/non-resume) job
    //
    // Please note that this algorithm will stop working at the day we start
    // adding alien jobs not to the beginning of the stroke, but to other places.
    // Right now both suspend and resume jobs are added to the beginning of
    // the stroke.
 
    auto it = std::find_if(m_jobsQueue.begin(), m_jobsQueue.end(),
                           std::mem_fn(&KisStrokeJob::isOwnJob));
 
    Q_FOREACH (KisStrokeJobData *data, list) {
        it = m_jobsQueue.insert(it, new KisStrokeJob(m_dabStrategy.data(), data, worksOnLevelOfDetail(), true));
        ++it;
    }
}

References KisStrokeJob::isOwnJob(), m_dabStrategy, m_jobsQueue, and worksOnLevelOfDetail().

◆ balancingRatioOverride()

qreal KisStroke::balancingRatioOverride ( ) const

Definition at line 272 of file kis_stroke.cpp.

{
    return m_strokeStrategy->balancingRatioOverride();
}

References m_strokeStrategy.

◆ canCancel()

bool KisStroke::canCancel ( ) const

Definition at line 197 of file kis_stroke.cpp.

{
    return m_isCancelled || !m_strokeInitialized ||
        !m_jobsQueue.isEmpty() || !m_strokeEnded;
}

References m_isCancelled, m_jobsQueue, m_strokeEnded, and m_strokeInitialized.

◆ cancelStroke()

void KisStroke::cancelStroke ( )

About cancelling the stroke There may be four different states of the stroke, when cancel is requested: 1) Not initialized, has jobs – just clear the queue 2) Initialized, has jobs, not finished – clear the queue, enqueue the cancel job 5) Initialized, no jobs, not finished – enqueue the cancel job 3) Initialized, has jobs, finished – clear the queue, enqueue the cancel job 4) Initialized, no jobs, finished – it's too late to cancel anything 6) Initialized, has jobs, cancelled – cancelling twice is a permitted operation, though it does nothing

Lod0 stroke cannot be suspended and !initialized at the same time, because the suspend job is created iff the stroke has already done some meaningful work.

At the same time, LodN stroke can be prepended with a 'suspend' job even when it has not been started yet. That is obvious: we should suspend the other stroke before doing anything else.

Definition at line 157 of file kis_stroke.cpp.

{
    // case 6
    if (m_isCancelled) return;
 
    const bool effectivelyInitialized =
        m_strokeInitialized || m_strokeStrategy->needsExplicitCancel();
 
    if(!effectivelyInitialized) {
        KIS_ASSERT_RECOVER_NOOP(type() == LODN ||
                                sanityCheckAllJobsAreCancellable());
        clearQueueOnCancel();
    }
    else if(effectivelyInitialized &&
            (!m_jobsQueue.isEmpty() || !m_strokeEnded)) {
 
        m_strokeStrategy->tryCancelCurrentStrokeJobAsync();
 
        clearQueueOnCancel();
        enqueue(m_cancelStrategy.data(),
                m_strokeStrategy->createCancelData());
    }
    // else {
    //     too late ...
    // }
 
    m_isCancelled = true;
    m_strokeEnded = true;
}

References clearQueueOnCancel(), enqueue(), KIS_ASSERT_RECOVER_NOOP, LODN, m_cancelStrategy, m_isCancelled, m_jobsQueue, m_strokeEnded, m_strokeInitialized, m_strokeStrategy, sanityCheckAllJobsAreCancellable(), and type().

◆ canForgetAboutMe()

bool KisStroke::canForgetAboutMe ( ) const

Definition at line 257 of file kis_stroke.cpp.

{
    return m_strokeStrategy->canForgetAboutMe();
}

References m_strokeStrategy.

◆ clearQueueOnCancel()

void KisStroke::clearQueueOnCancel ( )

private

Definition at line 213 of file kis_stroke.cpp.

{
    QQueue<KisStrokeJob*>::iterator it = m_jobsQueue.begin();
 
    while (it != m_jobsQueue.end()) {
        if ((*it)->isCancellable()) {
            delete (*it);
            it = m_jobsQueue.erase(it);
        } else {
            ++it;
        }
    }
}

References m_jobsQueue.

◆ clearsRedoOnStart()

bool KisStroke::clearsRedoOnStart ( ) const

Definition at line 267 of file kis_stroke.cpp.

{
    return m_strokeStrategy->clearsRedoOnStart();
}

References m_strokeStrategy.

◆ dequeue()

KisStrokeJob * KisStroke::dequeue ( )

private

Definition at line 318 of file kis_stroke.cpp.

{
    return !m_jobsQueue.isEmpty() ? m_jobsQueue.dequeue() : 0;
}

References m_jobsQueue.

◆ endStroke()

void KisStroke::endStroke ( )

Definition at line 132 of file kis_stroke.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(!m_strokeEnded);
    m_strokeEnded = true;
 
    enqueue(m_finishStrategy.data(), m_strokeStrategy->createFinishData());
    m_strokeStrategy->notifyUserEndedStroke();
}

References enqueue(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_finishStrategy, m_strokeEnded, and m_strokeStrategy.

◆ enqueue()

void KisStroke::enqueue	(	KisStrokeJobStrategy *	strategy,
		KisStrokeJobData *	data )

private

Definition at line 289 of file kis_stroke.cpp.

{
    // factory methods can return null, if no action is needed
    if(!strategy) {
        delete data;
        return;
    }
 
    m_jobsQueue.enqueue(new KisStrokeJob(strategy, data, worksOnLevelOfDetail(), true));
}

References m_jobsQueue, and worksOnLevelOfDetail().

◆ hasJobs()

bool KisStroke::hasJobs ( ) const

Definition at line 122 of file kis_stroke.cpp.

{
    return !m_jobsQueue.isEmpty();
}

References m_jobsQueue.

◆ id()

QString KisStroke::id ( ) const

Definition at line 117 of file kis_stroke.cpp.

{
    return m_strokeStrategy->id();
}

References m_strokeStrategy.

◆ isAsynchronouslyCancellable()

bool KisStroke::isAsynchronouslyCancellable ( ) const

Definition at line 262 of file kis_stroke.cpp.

{
    return m_strokeStrategy->isAsynchronouslyCancellable();
}

References m_strokeStrategy.

◆ isCancelled()

bool KisStroke::isCancelled ( ) const

Definition at line 237 of file kis_stroke.cpp.

{
    return m_isCancelled;
}

References m_isCancelled.

◆ isEnded()

bool KisStroke::isEnded ( ) const

Definition at line 232 of file kis_stroke.cpp.

{
    return m_strokeEnded;
}

References m_strokeEnded.

◆ isExclusive()

bool KisStroke::isExclusive ( ) const

Definition at line 242 of file kis_stroke.cpp.

{
    return m_strokeStrategy->isExclusive();
}

References m_strokeStrategy.

◆ isInitialized()

bool KisStroke::isInitialized ( ) const

Definition at line 227 of file kis_stroke.cpp.

{
    return m_strokeInitialized;
}

References m_strokeInitialized.

◆ lodBuddy()

KisStrokeSP KisStroke::lodBuddy ( ) const

Definition at line 328 of file kis_stroke.cpp.

{
    return m_lodBuddy;
}

References m_lodBuddy.

◆ name()

KUndo2MagicString KisStroke::name ( ) const

Definition at line 112 of file kis_stroke.cpp.

{
    return m_strokeStrategy->name();
}

References m_strokeStrategy.

◆ nextJobLevelOfDetail()

int KisStroke::nextJobLevelOfDetail ( ) const

Definition at line 283 of file kis_stroke.cpp.

{
    return !m_jobsQueue.isEmpty() ?
                m_jobsQueue.head()->levelOfDetail() : worksOnLevelOfDetail();
}

References m_jobsQueue, and worksOnLevelOfDetail().

◆ nextJobSequentiality()

KisStrokeJobData::Sequentiality KisStroke::nextJobSequentiality ( ) const

Definition at line 277 of file kis_stroke.cpp.

{
    return !m_jobsQueue.isEmpty() ?
        m_jobsQueue.head()->sequentiality() : KisStrokeJobData::SEQUENTIAL;
}

References m_jobsQueue, and KisStrokeJobData::SEQUENTIAL.

◆ numJobs()

qint32 KisStroke::numJobs ( ) const

Definition at line 127 of file kis_stroke.cpp.

{
    return m_jobsQueue.size();
}

References m_jobsQueue.

◆ popOneJob()

KisStrokeJob * KisStroke::popOneJob ( )

Definition at line 100 of file kis_stroke.cpp.

{
    KisStrokeJob *job = dequeue();
 
    if(job) {
        m_strokeInitialized = true;
        m_strokeSuspended = false;
    }
 
    return job;
}

References dequeue(), m_strokeInitialized, and m_strokeSuspended.

◆ prepend()

void KisStroke::prepend	(	KisStrokeJobStrategy *	strategy,
		KisStrokeJobData *	data,
		int	levelOfDetail,
		bool	isOwnJob )

private

Definition at line 301 of file kis_stroke.cpp.

{
    // factory methods can return null, if no action is needed
    if(!strategy) {
        delete data;
        return;
    }
 
    // LOG_MERGE_FIXME:
    Q_UNUSED(levelOfDetail);
 
    m_jobsQueue.prepend(new KisStrokeJob(strategy, data, worksOnLevelOfDetail(), isOwnJob));
}

References m_jobsQueue, and worksOnLevelOfDetail().

◆ sanityCheckAllJobsAreCancellable()

bool KisStroke::sanityCheckAllJobsAreCancellable ( ) const

private

Definition at line 203 of file kis_stroke.cpp.

{
    Q_FOREACH (KisStrokeJob *item, m_jobsQueue) {
        if (!item->isCancellable()) {
            return false;
        }
    }
    return true;
}

References KisStrokeJob::isCancellable(), and m_jobsQueue.

◆ setLodBuddy()

void KisStroke::setLodBuddy ( KisStrokeSP buddy )

Definition at line 323 of file kis_stroke.cpp.

{
    m_lodBuddy = buddy;
}

References m_lodBuddy.

◆ supportsSuspension()

bool KisStroke::supportsSuspension ( )

Definition at line 44 of file kis_stroke.cpp.

{
    return !m_strokeInitialized || (m_suspendStrategy && m_resumeStrategy);
}

References m_resumeStrategy, m_strokeInitialized, and m_suspendStrategy.

◆ supportsWrapAroundMode()

bool KisStroke::supportsWrapAroundMode ( ) const

Definition at line 247 of file kis_stroke.cpp.

{
    return m_strokeStrategy->supportsWrapAroundMode();
}

References m_strokeStrategy.

◆ suspendStroke()

void KisStroke::suspendStroke ( KisStrokeSP recipient )

Definition at line 49 of file kis_stroke.cpp.

{
    if (!m_strokeInitialized || m_strokeSuspended ||
        (m_strokeEnded && !hasJobs())) {
 
        return;
    }
 
    KIS_ASSERT_RECOVER_NOOP(m_suspendStrategy && m_resumeStrategy);
 
    prepend(m_resumeStrategy.data(),
            m_strokeStrategy->createResumeData(),
            worksOnLevelOfDetail(), false);
 
    recipient->prepend(m_suspendStrategy.data(),
                       m_strokeStrategy->createSuspendData(),
                       worksOnLevelOfDetail(), false);
 
    m_strokeSuspended = true;
}

References hasJobs(), KIS_ASSERT_RECOVER_NOOP, m_resumeStrategy, m_strokeEnded, m_strokeInitialized, m_strokeStrategy, m_strokeSuspended, m_suspendStrategy, prepend(), and worksOnLevelOfDetail().

◆ testingGetQueue()

QQueue< KisStrokeJob * > & KisStroke::testingGetQueue ( )

inlineprivate

Definition at line 94 of file kis_stroke.h.

                                             {
        return m_jobsQueue;
    }

◆ type()

KisStroke::Type KisStroke::type ( ) const

Definition at line 333 of file kis_stroke.cpp.

{
    if (m_type == LOD0) {
        KIS_ASSERT_RECOVER_NOOP(m_lodBuddy && "LOD0 strokes must always have a buddy");
    } else if (m_type == LODN) {
        KIS_ASSERT_RECOVER_NOOP(m_worksOnLevelOfDetail > 0 && "LODN strokes must work on LOD > 0!");
    } else if (m_type == LEGACY) {
        KIS_ASSERT_RECOVER_NOOP(m_worksOnLevelOfDetail == 0 && "LEGACY strokes must work on LOD == 0!");
    }
 
    return m_type;
}

References KIS_ASSERT_RECOVER_NOOP, LEGACY, LOD0, LODN, m_lodBuddy, m_type, and m_worksOnLevelOfDetail.

◆ worksOnLevelOfDetail()

int KisStroke::worksOnLevelOfDetail ( ) const

Definition at line 252 of file kis_stroke.cpp.

{
    return m_worksOnLevelOfDetail;
}

References m_worksOnLevelOfDetail.

Friends And Related Symbol Documentation

◆ KisStrokeStrategyUndoCommandBasedTest

friend class KisStrokeStrategyUndoCommandBasedTest

friend

Definition at line 93 of file kis_stroke.h.

◆ KisStrokeTest

friend class KisStrokeTest

friend

Definition at line 92 of file kis_stroke.h.

Member Data Documentation

◆ m_cancelStrategy

QScopedPointer<KisStrokeJobStrategy> KisStroke::m_cancelStrategy

private

Definition at line 103 of file kis_stroke.h.

◆ m_dabStrategy

QScopedPointer<KisStrokeJobStrategy> KisStroke::m_dabStrategy

private

Definition at line 102 of file kis_stroke.h.

◆ m_finishStrategy

QScopedPointer<KisStrokeJobStrategy> KisStroke::m_finishStrategy

private

Definition at line 104 of file kis_stroke.h.

◆ m_initStrategy

QScopedPointer<KisStrokeJobStrategy> KisStroke::m_initStrategy

private

Definition at line 101 of file kis_stroke.h.

◆ m_isCancelled

bool KisStroke::m_isCancelled

private

Definition at line 112 of file kis_stroke.h.

◆ m_jobsQueue

QQueue<KisStrokeJob*> KisStroke::m_jobsQueue

private

Definition at line 108 of file kis_stroke.h.

◆ m_lodBuddy

KisStrokeSP KisStroke::m_lodBuddy

private

Definition at line 116 of file kis_stroke.h.

◆ m_resumeStrategy

QScopedPointer<KisStrokeJobStrategy> KisStroke::m_resumeStrategy

private

Definition at line 106 of file kis_stroke.h.

◆ m_strokeEnded

bool KisStroke::m_strokeEnded

private

Definition at line 110 of file kis_stroke.h.

◆ m_strokeInitialized

bool KisStroke::m_strokeInitialized

private

Definition at line 109 of file kis_stroke.h.

◆ m_strokeStrategy

QScopedPointer<KisStrokeStrategy> KisStroke::m_strokeStrategy

private

Definition at line 100 of file kis_stroke.h.

◆ m_strokeSuspended

bool KisStroke::m_strokeSuspended

private

Definition at line 111 of file kis_stroke.h.

◆ m_suspendStrategy

QScopedPointer<KisStrokeJobStrategy> KisStroke::m_suspendStrategy

private

Definition at line 105 of file kis_stroke.h.

◆ m_type

Type KisStroke::m_type

private

Definition at line 115 of file kis_stroke.h.

◆ m_worksOnLevelOfDetail

int KisStroke::m_worksOnLevelOfDetail

private

Definition at line 114 of file kis_stroke.h.

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

libs/image/kis_stroke.h
libs/image/kis_stroke.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ KisStroke()

◆ ~KisStroke()

Member Function Documentation

◆ addJob()

◆ addMutatedJobs()

◆ balancingRatioOverride()

◆ canCancel()

◆ cancelStroke()

◆ canForgetAboutMe()

◆ clearQueueOnCancel()

◆ clearsRedoOnStart()

◆ dequeue()

◆ endStroke()

◆ enqueue()

◆ hasJobs()

◆ id()

◆ isAsynchronouslyCancellable()

◆ isCancelled()

◆ isEnded()

◆ isExclusive()

◆ isInitialized()

◆ lodBuddy()

◆ name()

◆ nextJobLevelOfDetail()

◆ nextJobSequentiality()

◆ numJobs()

◆ popOneJob()

◆ prepend()

◆ sanityCheckAllJobsAreCancellable()

◆ setLodBuddy()

◆ supportsSuspension()

◆ supportsWrapAroundMode()

◆ suspendStroke()

◆ testingGetQueue()

◆ type()

◆ worksOnLevelOfDetail()

Friends And Related Symbol Documentation

◆ KisStrokeStrategyUndoCommandBasedTest

◆ KisStrokeTest

Member Data Documentation

◆ m_cancelStrategy

◆ m_dabStrategy

◆ m_finishStrategy

◆ m_initStrategy

◆ m_isCancelled

◆ m_jobsQueue

◆ m_lodBuddy

◆ m_resumeStrategy

◆ m_strokeEnded

◆ m_strokeInitialized

◆ m_strokeStrategy

◆ m_strokeSuspended

◆ m_suspendStrategy

◆ m_type

◆ m_worksOnLevelOfDetail