#include <kis_stroke_strategy_undo_command_based.h>

Inheritance diagram for KisStrokeStrategyUndoCommandBased:

Classes
class	Data

struct	MutatedCommandInterface

Public Member Functions
void	cancelStrokeCallback () override

void	doStrokeCallback (KisStrokeJobData *data) override

void	finishStrokeCallback () override

void	initStrokeCallback () override

	KisStrokeStrategyUndoCommandBased (const KUndo2MagicString &name, bool undo, KisStrokeUndoFacade *undoFacade, KUndo2CommandSP initCommand=KUndo2CommandSP(0), KUndo2CommandSP finishCommand=KUndo2CommandSP(0))

void	setCommandExtraData (KUndo2CommandExtraData *data)

void	setMacroId (int value)

void	setSupportsWrapAroundMode (bool value)

void	setUsedWhileUndoRedo (bool value)

Public Member Functions inherited from KisRunnableBasedStrokeStrategy
	KisRunnableBasedStrokeStrategy (const KisRunnableBasedStrokeStrategy &rhs)

	KisRunnableBasedStrokeStrategy (const QLatin1String &id, const KUndo2MagicString &name=KUndo2MagicString())

KisRunnableStrokeJobsInterface *	runnableJobsInterface () const

	~KisRunnableBasedStrokeStrategy ()

Public Member Functions inherited from KisSimpleStrokeStrategy
KisStrokeJobData *	createCancelData () override

KisStrokeJobStrategy *	createCancelStrategy () override

KisStrokeJobStrategy *	createDabStrategy () override

KisStrokeJobData *	createFinishData () override

KisStrokeJobStrategy *	createFinishStrategy () override

KisStrokeJobData *	createInitData () override

KisStrokeJobStrategy *	createInitStrategy () override

KisStrokeJobData *	createResumeData () override

KisStrokeJobStrategy *	createResumeStrategy () override

KisStrokeJobData *	createSuspendData () override

KisStrokeJobStrategy *	createSuspendStrategy () override

	KisSimpleStrokeStrategy (const QLatin1String &id, const KUndo2MagicString &name=KUndo2MagicString())

virtual void	resumeStrokeCallback ()

virtual void	suspendStrokeCallback ()

Public Member Functions inherited from KisStrokeStrategy
qreal	balancingRatioOverride () const

bool	canForgetAboutMe () const

bool	clearsRedoOnStart () const

virtual KisStrokeStrategy *	createLodClone (int levelOfDetail)

KisLodPreferences	currentLodPreferences () const

bool	forceLodModeIfPossible () const

QString	id () const

bool	isAsynchronouslyCancellable () const

bool	isExclusive () const

	KisStrokeStrategy (const QLatin1String &id, const KUndo2MagicString &name=KUndo2MagicString())

KUndo2MagicString	name () const

bool	needsExplicitCancel () const

virtual void	notifyUserEndedStroke ()

virtual void	notifyUserStartedStroke ()

bool	requestsOtherStrokesToEnd () const

void	setForceLodModeIfPossible (bool forceLodModeIfPossible)

void	setMutatedJobsInterface (KisStrokesQueueMutatedJobInterface *mutatedJobsInterface, KisStrokeId strokeId)

bool	supportsWrapAroundMode () const

virtual void	tryCancelCurrentStrokeJobAsync ()
	tryCancelCurrentStrokeJobAsync is called by the strokes queue when the stroke is being cancelled. The stroke strategy may or may not handle this request and cancel the currently running long action.

virtual	~KisStrokeStrategy ()

Protected Member Functions
void	cancelStrokeCallbackImpl (QVector< KisStrokeJobData * > &mutatedJobs)

void	executeCommand (KUndo2CommandSP command, bool undo)

	KisStrokeStrategyUndoCommandBased (const KisStrokeStrategyUndoCommandBased &rhs)

void	notifyCommandDone (KUndo2CommandSP command, KisStrokeJobData::Sequentiality sequentiality, KisStrokeJobData::Exclusivity exclusivity)

virtual void	postProcessToplevelCommand (KUndo2Command *command)
	Applies some modifications (e.g. assigning extra data) to the toplevel command.

void	runAndSaveCommand (KUndo2CommandSP command, KisStrokeJobData::Sequentiality sequentiality, KisStrokeJobData::Exclusivity exclusivity)

KisStrokeUndoFacade *	undoFacade () const

Protected Member Functions inherited from KisSimpleStrokeStrategy
void	enableJob (JobType type, bool enable=true, KisStrokeJobData::Sequentiality sequentiality=KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::Exclusivity exclusivity=KisStrokeJobData::NORMAL)

	KisSimpleStrokeStrategy (const KisSimpleStrokeStrategy &rhs)

Protected Member Functions inherited from KisStrokeStrategy
void	addMutatedJob (KisStrokeJobData *data)

void	addMutatedJobs (const QVector< KisStrokeJobData * > list)

	KisStrokeStrategy (const KisStrokeStrategy &rhs)

void	setAsynchronouslyCancellable (bool value)

void	setBalancingRatioOverride (qreal value)

void	setCanForgetAboutMe (bool value)

void	setClearsRedoOnStart (bool value)

void	setExclusive (bool value)

void	setNeedsExplicitCancel (bool value)

void	setRequestsOtherStrokesToEnd (bool value)

void	setSupportsWrapAroundMode (bool value)

Private Attributes
QScopedPointer< KUndo2CommandExtraData >	m_commandExtraData

KUndo2CommandSP	m_finishCommand

KUndo2CommandSP	m_initCommand

KisSavedMacroCommand *	m_macroCommand {nullptr}

int	m_macroId

QMutex	m_mutex

bool	m_undo

KisStrokeUndoFacade *	m_undoFacade {nullptr}

Additional Inherited Members
Public Types inherited from KisSimpleStrokeStrategy
enum	JobType { JOB_INIT = 0 , JOB_CANCEL , JOB_FINISH , JOB_DOSTROKE , JOB_SUSPEND , JOB_RESUME , NJOBS }

Static Public Member Functions inherited from KisSimpleStrokeStrategy
static QLatin1String	jobTypeToString (JobType type)

Detailed Description

Definition at line 25 of file kis_stroke_strategy_undo_command_based.h.

Constructor & Destructor Documentation

◆ KisStrokeStrategyUndoCommandBased() [1/2]

KisStrokeStrategyUndoCommandBased::KisStrokeStrategyUndoCommandBased	(	const KUndo2MagicString &	name,
		bool	undo,
		KisStrokeUndoFacade *	undoFacade,
		KUndo2CommandSP	initCommand = KUndo2CommandSP(0),
		KUndo2CommandSP	finishCommand = KUndo2CommandSP(0) )

Definition at line 20 of file kis_stroke_strategy_undo_command_based.cpp.

  : KisRunnableBasedStrokeStrategy(QLatin1String("STROKE_UNDO_COMMAND_BASED"), name),
    m_undo(undo),
    m_initCommand(initCommand),
    m_finishCommand(finishCommand),
    m_undoFacade(undoFacade),
    m_macroId(-1),
    m_macroCommand(0)
{
    enableJob(KisSimpleStrokeStrategy::JOB_INIT);
    enableJob(KisSimpleStrokeStrategy::JOB_FINISH);
    enableJob(KisSimpleStrokeStrategy::JOB_CANCEL);
    enableJob(KisSimpleStrokeStrategy::JOB_DOSTROKE);
}

References KisSimpleStrokeStrategy::enableJob(), KisSimpleStrokeStrategy::JOB_CANCEL, KisSimpleStrokeStrategy::JOB_DOSTROKE, KisSimpleStrokeStrategy::JOB_FINISH, and KisSimpleStrokeStrategy::JOB_INIT.

◆ KisStrokeStrategyUndoCommandBased() [2/2]

KisStrokeStrategyUndoCommandBased::KisStrokeStrategyUndoCommandBased ( const KisStrokeStrategyUndoCommandBased & rhs )

protected

Definition at line 40 of file kis_stroke_strategy_undo_command_based.cpp.

  : KisRunnableBasedStrokeStrategy(rhs),
    m_undo(false),
    m_initCommand(rhs.m_initCommand),
    m_finishCommand(rhs.m_finishCommand),
    m_undoFacade(rhs.m_undoFacade),
    m_macroCommand(0)
{
    KIS_ASSERT_RECOVER_NOOP(!rhs.m_macroCommand &&
                            !rhs.m_undo &&
                            "After the stroke has been started, no copying must happen");
}

References KIS_ASSERT_RECOVER_NOOP, m_macroCommand, and m_undo.

Member Function Documentation

◆ cancelStrokeCallback()

void KisStrokeStrategyUndoCommandBased::cancelStrokeCallback ( )

overridevirtual

Reimplemented from KisSimpleStrokeStrategy.

Reimplemented in StrategyWithStatusPromise, MoveStrokeStrategy, MoveSelectionStrokeStrategy, and TransformStrokeStrategy.

Definition at line 103 of file kis_stroke_strategy_undo_command_based.cpp.

{
    QVector<KisStrokeJobData *> jobs;
    cancelStrokeCallbackImpl(jobs);
    addMutatedJobs(jobs);
}

References KisStrokeStrategy::addMutatedJobs(), and cancelStrokeCallbackImpl().

◆ cancelStrokeCallbackImpl()

void KisStrokeStrategyUndoCommandBased::cancelStrokeCallbackImpl ( QVector< KisStrokeJobData * > & mutatedJobs )

protected

Definition at line 110 of file kis_stroke_strategy_undo_command_based.cpp.

{
    QMutexLocker locker(&m_mutex);
    if(m_macroCommand) {
        m_macroCommand->getCommandExecutionJobs(&mutatedJobs, !m_undo);
 
        delete m_macroCommand;
        m_macroCommand = 0;
    }
}

References KisSavedMacroCommand::getCommandExecutionJobs(), m_macroCommand, m_mutex, and m_undo.

◆ doStrokeCallback()

void KisStrokeStrategyUndoCommandBased::doStrokeCallback ( KisStrokeJobData * data )

overridevirtual

Reimplemented from KisRunnableBasedStrokeStrategy.

Reimplemented in MoveStrokeStrategy, MoveSelectionStrokeStrategy, and TransformStrokeStrategy.

Definition at line 121 of file kis_stroke_strategy_undo_command_based.cpp.

{
    Data *d = dynamic_cast<Data*>(data);
 
    if (d) {
        executeCommand(d->command, d->undo);
        if (d->shouldGoToHistory) {
            notifyCommandDone(d->command,
                              d->sequentiality(),
                              d->exclusivity());
        }
    } else {
        KisRunnableBasedStrokeStrategy::doStrokeCallback(data);
    }
 
}

References KisRunnableBasedStrokeStrategy::doStrokeCallback(), executeCommand(), and notifyCommandDone().

◆ executeCommand()

void KisStrokeStrategyUndoCommandBased::executeCommand	(	KUndo2CommandSP	command,
		bool	undo )

protected

Definition at line 60 of file kis_stroke_strategy_undo_command_based.cpp.

{
    if(!command) return;
 
    if (MutatedCommandInterface *mutatedCommand = dynamic_cast<MutatedCommandInterface*>(command.data())) {
        mutatedCommand->setRunnableJobsInterface(this->runnableJobsInterface());
    }
 
    if(undo) {
        command->undo();
    } else {
        command->redo();
    }
}

References KisRunnableBasedStrokeStrategy::runnableJobsInterface().

◆ finishStrokeCallback()

void KisStrokeStrategyUndoCommandBased::finishStrokeCallback ( )

overridevirtual

Reimplemented from KisSimpleStrokeStrategy.

Reimplemented in StrategyWithStatusPromise, MoveStrokeStrategy, MoveSelectionStrokeStrategy, and TransformStrokeStrategy.

Definition at line 87 of file kis_stroke_strategy_undo_command_based.cpp.

{
    executeCommand(m_finishCommand, m_undo);
    notifyCommandDone(m_finishCommand,
                      KisStrokeJobData::SEQUENTIAL,
                      KisStrokeJobData::NORMAL);
 
    QMutexLocker locker(&m_mutex);
    if(m_macroCommand) {
        Q_ASSERT(m_undoFacade);
        postProcessToplevelCommand(m_macroCommand);
        m_undoFacade->postExecutionUndoAdapter()->addMacro(m_macroCommand);
        m_macroCommand = 0;
    }
}

References KisPostExecutionUndoAdapter::addMacro(), executeCommand(), m_finishCommand, m_macroCommand, m_mutex, m_undo, m_undoFacade, KisStrokeJobData::NORMAL, notifyCommandDone(), KisStrokeUndoFacade::postExecutionUndoAdapter(), postProcessToplevelCommand(), and KisStrokeJobData::SEQUENTIAL.

◆ initStrokeCallback()

void KisStrokeStrategyUndoCommandBased::initStrokeCallback ( )

overridevirtual

Reimplemented from KisSimpleStrokeStrategy.

Reimplemented in MoveStrokeStrategy, MoveSelectionStrokeStrategy, and TransformStrokeStrategy.

Definition at line 75 of file kis_stroke_strategy_undo_command_based.cpp.

{
    if(m_undoFacade) {
        m_macroCommand = m_undoFacade->postExecutionUndoAdapter()->createMacro(name());
    }
 
    executeCommand(m_initCommand, m_undo);
    notifyCommandDone(m_initCommand,
                      KisStrokeJobData::SEQUENTIAL,
                      KisStrokeJobData::NORMAL);
}

References KisPostExecutionUndoAdapter::createMacro(), executeCommand(), m_initCommand, m_macroCommand, m_undo, m_undoFacade, KisStrokeStrategy::name(), KisStrokeJobData::NORMAL, notifyCommandDone(), KisStrokeUndoFacade::postExecutionUndoAdapter(), and KisStrokeJobData::SEQUENTIAL.

◆ notifyCommandDone()

void KisStrokeStrategyUndoCommandBased::notifyCommandDone	(	KUndo2CommandSP	command,
		KisStrokeJobData::Sequentiality	sequentiality,
		KisStrokeJobData::Exclusivity	exclusivity )

protected

Definition at line 148 of file kis_stroke_strategy_undo_command_based.cpp.

{
    if(!command) return;
 
    QMutexLocker locker(&m_mutex);
    if(m_macroCommand) {
        m_macroCommand->addCommand(command, sequentiality, exclusivity);
    }
}

References KisSavedMacroCommand::addCommand(), m_macroCommand, and m_mutex.

◆ postProcessToplevelCommand()

void KisStrokeStrategyUndoCommandBased::postProcessToplevelCommand ( KUndo2Command * command )

protectedvirtual

Applies some modifications (e.g. assigning extra data) to the toplevel command.

Reimplemented in InplaceTransformStrokeStrategy, and TransformStrokeStrategy.

Definition at line 176 of file kis_stroke_strategy_undo_command_based.cpp.

{
    if (m_commandExtraData) {
        command->setExtraData(m_commandExtraData.take());
    }
 
    KisSavedMacroCommand *savedCommand = dynamic_cast<KisSavedMacroCommand*>(command);
    if (savedCommand) {
        savedCommand->setMacroId(m_macroId);
    }
}

References m_commandExtraData, m_macroId, KUndo2Command::setExtraData(), and KisSavedMacroCommand::setMacroId().

◆ runAndSaveCommand()

void KisStrokeStrategyUndoCommandBased::runAndSaveCommand	(	KUndo2CommandSP	command,
		KisStrokeJobData::Sequentiality	sequentiality,
		KisStrokeJobData::Exclusivity	exclusivity )

protected

Definition at line 138 of file kis_stroke_strategy_undo_command_based.cpp.

{
    if (!command) return;
 
    executeCommand(command, false);
    notifyCommandDone(command, sequentiality, exclusivity);
}

References executeCommand(), and notifyCommandDone().

◆ setCommandExtraData()

void KisStrokeStrategyUndoCommandBased::setCommandExtraData ( KUndo2CommandExtraData * data )

Set extra data that will be assigned to the command representing this action. Using extra data has the following restrictions:

1) The data must be set before the stroke has been started. Setting the data after the stroke has been started with image->startStroke(strokeId) leads to an undefined behaviour.

2) data becomes owned by the strategy/command right after setting it. Don't try to change it afterwards.

Definition at line 160 of file kis_stroke_strategy_undo_command_based.cpp.

{
    if (m_undoFacade && m_macroCommand) {
        warnKrita << "WARNING: KisStrokeStrategyUndoCommandBased::setCommandExtraData():"
                   << "the extra data is set while the stroke has already been started!"
                   << "The result is undefined, continued actions may not work!";
    }
 
    m_commandExtraData.reset(data);
}

References m_commandExtraData, m_macroCommand, m_undoFacade, and warnKrita.

◆ setMacroId()

void KisStrokeStrategyUndoCommandBased::setMacroId ( int value )

Sets the id of this action. Will be used for merging the undo commands

The value must be set before the stroke has been started. Setting the value after the stroke has been started with image->startStroke(strokeId) leads to an undefined behaviour.

Definition at line 171 of file kis_stroke_strategy_undo_command_based.cpp.

{
    m_macroId = value;
}

References m_macroId, and value().

◆ setSupportsWrapAroundMode()

void KisStrokeStrategy::setSupportsWrapAroundMode ( bool value )

The undo-command-based is a low-level strategy, so it allows changing its wraparound mode status.

WARNING: the switch must be called before the stroke has been started! Otherwise the mode will not be activated.

Definition at line 168 of file kis_stroke_strategy.cpp.

{
    m_supportsWrapAroundMode = value;
}

References KisStrokesQueueMutatedJobInterface::addMutatedJobs(), KIS_SAFE_ASSERT_RECOVER, KisStrokeStrategy::m_mutatedJobsInterface, and KisStrokeStrategy::m_strokeId.

◆ setUsedWhileUndoRedo()

void KisStrokeStrategyUndoCommandBased::setUsedWhileUndoRedo ( bool value )

Definition at line 54 of file kis_stroke_strategy_undo_command_based.cpp.

{
    setClearsRedoOnStart(!value);
    setAsynchronouslyCancellable(!value);
}

References KisStrokeStrategy::setAsynchronouslyCancellable(), KisStrokeStrategy::setClearsRedoOnStart(), and value().

◆ undoFacade()

KisStrokeUndoFacade * KisStrokeStrategyUndoCommandBased::undoFacade ( ) const

protected

Definition at line 188 of file kis_stroke_strategy_undo_command_based.cpp.

 {
     return m_undoFacade;
 }

References m_undoFacade.

Member Data Documentation

◆ m_commandExtraData

QScopedPointer<KUndo2CommandExtraData> KisStrokeStrategyUndoCommandBased::m_commandExtraData

private

Definition at line 152 of file kis_stroke_strategy_undo_command_based.h.

◆ m_finishCommand

KUndo2CommandSP KisStrokeStrategyUndoCommandBased::m_finishCommand

private

Definition at line 149 of file kis_stroke_strategy_undo_command_based.h.

◆ m_initCommand

KUndo2CommandSP KisStrokeStrategyUndoCommandBased::m_initCommand

private

Definition at line 148 of file kis_stroke_strategy_undo_command_based.h.

◆ m_macroCommand

KisSavedMacroCommand* KisStrokeStrategyUndoCommandBased::m_macroCommand {nullptr}

private

Definition at line 157 of file kis_stroke_strategy_undo_command_based.h.

157{nullptr};

◆ m_macroId

int KisStrokeStrategyUndoCommandBased::m_macroId

private

Definition at line 153 of file kis_stroke_strategy_undo_command_based.h.

◆ m_mutex

QMutex KisStrokeStrategyUndoCommandBased::m_mutex

private

Definition at line 156 of file kis_stroke_strategy_undo_command_based.h.

◆ m_undo

bool KisStrokeStrategyUndoCommandBased::m_undo

private

Definition at line 147 of file kis_stroke_strategy_undo_command_based.h.

◆ m_undoFacade

KisStrokeUndoFacade* KisStrokeStrategyUndoCommandBased::m_undoFacade {nullptr}

private

Definition at line 150 of file kis_stroke_strategy_undo_command_based.h.

150{nullptr};

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

libs/image/kis_stroke_strategy_undo_command_based.h
libs/image/kis_stroke_strategy_undo_command_based.cpp

Classes

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisStrokeStrategyUndoCommandBased() [1/2]

◆ KisStrokeStrategyUndoCommandBased() [2/2]

Member Function Documentation

◆ cancelStrokeCallback()

◆ cancelStrokeCallbackImpl()

◆ doStrokeCallback()

◆ executeCommand()

◆ finishStrokeCallback()

◆ initStrokeCallback()

◆ notifyCommandDone()

◆ postProcessToplevelCommand()

◆ runAndSaveCommand()

◆ setCommandExtraData()

◆ setMacroId()

◆ setSupportsWrapAroundMode()

◆ setUsedWhileUndoRedo()

◆ undoFacade()

Member Data Documentation

◆ m_commandExtraData

◆ m_finishCommand

◆ m_initCommand

◆ m_macroCommand

◆ m_macroId

◆ m_mutex

◆ m_undo

◆ m_undoFacade