KisSavedMacroCommand Class Reference

#include <kis_saved_commands.h>

Inheritance diagram for KisSavedMacroCommand:

Classes
struct	Private

Public Member Functions
void	addCommand (KUndo2CommandSP command, KisStrokeJobData::Sequentiality sequentiality=KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::Exclusivity exclusivity=KisStrokeJobData::NORMAL)
bool	canAnnihilateWith (const KUndo2Command *command) const override
void	getCommandExecutionJobs (QVector< KisStrokeJobData * > *jobs, bool undo, bool shouldGoToHistory=true) const
int	id () const override
	KisSavedMacroCommand (const KUndo2MagicString &name, KisStrokesFacade *strokesFacade)
bool	mergeWith (const KUndo2Command *command) override
void	setMacroId (int value)
void	setOverrideInfo (const KisSavedMacroCommand *overriddenCommand, const QVector< const KUndo2Command * > &skipWhileOverride)
	~KisSavedMacroCommand () override
Public Member Functions inherited from KisSavedCommandBase
	KisSavedCommandBase (const KUndo2MagicString &name, KisStrokesFacade *strokesFacade)
void	redo () override
void	undo () override
	~KisSavedCommandBase () override
Public Member Functions inherited from KUndo2Command
QString	actionText () const
const KUndo2Command *	child (int index) const
int	childCount () const
virtual QTime	endTime () const
KUndo2CommandExtraData *	extraData () const
bool	hasParent () const
virtual bool	isMerged () const
	KUndo2Command (const KUndo2MagicString &text, KUndo2Command *parent=0)
	KUndo2Command (KUndo2Command *parent=0)
virtual QVector< KUndo2Command * >	mergeCommandsVector () const
virtual void	redoMergedCommands ()
void	setEndTime ()
virtual void	setEndTime (const QTime &time)
void	setExtraData (KUndo2CommandExtraData *data)
void	setText (const KUndo2MagicString &text)
void	setTime ()
virtual void	setTime (const QTime &time)
virtual void	setTimedID (int timedID)
KUndo2MagicString	text () const
virtual QTime	time () const
virtual int	timedId () const
virtual bool	timedMergeWith (KUndo2Command *other)
virtual void	undoMergedCommands ()
virtual	~KUndo2Command ()

Protected Member Functions
void	addCommands (KisStrokeId id, bool undo) override
Protected Member Functions inherited from KisSavedCommandBase
KisStrokesFacade *	strokesFacade ()

Private Attributes
Private *const	m_d

Detailed Description

Definition at line 87 of file kis_saved_commands.h.

Constructor & Destructor Documentation

KisSavedMacroCommand()

KisSavedMacroCommand::KisSavedMacroCommand	(	const KUndo2MagicString &	name,
		KisStrokesFacade *	strokesFacade )

Definition at line 162 of file kis_saved_commands.cpp.

    : KisSavedCommandBase(name, strokesFacade),
      m_d(new Private())
{
}

~KisSavedMacroCommand()

KisSavedMacroCommand::~KisSavedMacroCommand ( )

override

Definition at line 169 of file kis_saved_commands.cpp.

{
    delete m_d;
}

References m_d.

Member Function Documentation

addCommand()

void KisSavedMacroCommand::addCommand	(	KUndo2CommandSP	command,
		KisStrokeJobData::Sequentiality	sequentiality = KisStrokeJobData::SEQUENTIAL,
		KisStrokeJobData::Exclusivity	exclusivity = KisStrokeJobData::NORMAL )

Definition at line 298 of file kis_saved_commands.cpp.

{
    Private::SavedCommand item;
    item.command = command;
    item.sequentiality = sequentiality;
    item.exclusivity = exclusivity;
 
    m_d->commands.append(item);
}

References KisSavedMacroCommand::Private::SavedCommand::command, KisSavedMacroCommand::Private::commands, KisSavedMacroCommand::Private::SavedCommand::exclusivity, m_d, and KisSavedMacroCommand::Private::SavedCommand::sequentiality.

addCommands()

void KisSavedMacroCommand::addCommands ( KisStrokeId id, bool undo )

overrideprotectedvirtual

Implements KisSavedCommandBase.

Definition at line 344 of file kis_saved_commands.cpp.

{
    QVector<KisStrokeJobData *> jobs;
    getCommandExecutionJobs(&jobs, undo);
 
    Q_FOREACH (KisStrokeJobData *job, jobs) {
        strokesFacade()->addJob(id, job);
    }
}

References KisStrokesFacade::addJob(), getCommandExecutionJobs(), KisSavedCommandBase::strokesFacade(), and KisSavedCommandBase::undo().

canAnnihilateWith()

bool KisSavedMacroCommand::canAnnihilateWith ( const KUndo2Command * other ) const

overridevirtual

Attempts to merge this command with command and checks if the two commands compensate each other. If the function returns true, both commands are removed from the stack.

If this function returns true, calling this command's redo() followed by other redo() must have no effect.

The function itself shouldn't do any changes to the command, because after returning true, the command will be deleted as a "noop"

KUndo2QStack will only try to merge two commands if they have the same id, and the id is not -1.

The default implementation returns false.

See also

id() KUndo2QStack::push()

Reimplemented from KUndo2Command.

Definition at line 259 of file kis_saved_commands.cpp.

{
    const KisSavedMacroCommand *other =
        dynamic_cast<const KisSavedMacroCommand*>(command);
 
    if (!other || other->id() != id() || id() < 0 || other->id() < 0) return false;
 
    QVector<Private::SavedCommand> &otherCommands = other->m_d->commands;
 
    if (other->m_d->overriddenCommand) return false;
    if (m_d->commands.size() != otherCommands.size()) return false;
 
    auto it = m_d->commands.constBegin();
    auto end = m_d->commands.constEnd();
 
    auto otherIt = otherCommands.constBegin();
    auto otherEnd = otherCommands.constEnd();
 
    bool sameCommands = true;
    while (it != end && otherIt != otherEnd) {
 
        if (!it->command->canAnnihilateWith(otherIt->command.data()) ||
            it->command->id() < 0 || otherIt->command->id() < 0 ||
            it->command->id() != otherIt->command->id() ||
            it->sequentiality != otherIt->sequentiality ||
            it->exclusivity != otherIt->exclusivity) {
 
            sameCommands = false;
            break;
        }
        ++it;
        ++otherIt;
    }
 
    if (!sameCommands) return false;
 
    return true;
}

References KisSavedMacroCommand::Private::commands, id(), m_d, and KisSavedMacroCommand::Private::overriddenCommand.

getCommandExecutionJobs()

void KisSavedMacroCommand::getCommandExecutionJobs	(	QVector< KisStrokeJobData * > *	jobs,
		bool	undo,
		bool	shouldGoToHistory = true ) const

Definition at line 310 of file kis_saved_commands.cpp.

{
    QVector<Private::SavedCommand>::iterator it;
 
    if(!undo) {
        for(it = m_d->commands.begin(); it != m_d->commands.end(); it++) {
            *jobs << new KisStrokeStrategyUndoCommandBased::
                       Data(it->command,
                            undo,
                            it->sequentiality,
                            it->exclusivity,
                            shouldGoToHistory);
        }
    }
    else {
        for(it = m_d->commands.end(); it != m_d->commands.begin();) {
            --it;
 
            *jobs << new KisStrokeStrategyUndoCommandBased::
                     Data(it->command,
                          undo,
                          it->sequentiality,
                          it->exclusivity,
                          shouldGoToHistory);
        }
    }
}

References KisSavedMacroCommand::Private::commands, m_d, and KisSavedCommandBase::undo().

id()

int KisSavedMacroCommand::id ( ) const

overridevirtual

Returns the ID of this command.

A command ID is used in command compression. It must be an integer unique to this command's class, or -1 if the command doesn't support compression.

If the command supports compression this function must be overridden in the derived class to return the correct ID. The base implementation returns -1.

KUndo2QStack::push() will only try to merge two commands if they have the same ID, and the ID is not -1.

See also

mergeWith(), KUndo2QStack::push()

Reimplemented from KUndo2Command.

Definition at line 179 of file kis_saved_commands.cpp.

{
    return m_d->macroId;
}

References m_d, and KisSavedMacroCommand::Private::macroId.

mergeWith()

bool KisSavedMacroCommand::mergeWith ( const KUndo2Command * command )

overridevirtual

Attempts to merge this command with command. Returns true on success; otherwise returns false.

If this function returns true, calling this command's redo() must have the same effect as redoing both this command and command. Similarly, calling this command's undo() must have the same effect as undoing command and this command.

KUndo2QStack will only try to merge two commands if they have the same id, and the id is not -1.

The default implementation returns false.

See also

id() KUndo2QStack::push()

Reimplemented from KUndo2Command.

Definition at line 184 of file kis_saved_commands.cpp.

{
    const KisSavedMacroCommand *other =
        dynamic_cast<const KisSavedMacroCommand*>(command);
 
    if (!other || other->id() != id() || id() < 0 || other->id() < 0) return false;
 
    QVector<Private::SavedCommand> &otherCommands = other->m_d->commands;
 
    if (other->m_d->overriddenCommand == this) {
        m_d->commands.clear();
 
        Q_FOREACH (Private::SavedCommand cmd, other->m_d->commands) {
            if (!other->m_d->skipWhenOverride.contains(cmd.command.data())) {
                m_d->commands.append(cmd);
            }
        }
 
        if (other->extraData()) {
            setExtraData(other->extraData()->clone());
        } else {
            setExtraData(0);
        }
        return true;
    }
 
    if (m_d->commands.size() != otherCommands.size()) return false;
 
    auto it = m_d->commands.constBegin();
    auto end = m_d->commands.constEnd();
 
    auto otherIt = otherCommands.constBegin();
    auto otherEnd = otherCommands.constEnd();
 
    bool sameCommands = true;
    while (it != end && otherIt != otherEnd) {
        KisAsynchronouslyMergeableCommandInterface *iface1 =
            dynamic_cast<KisAsynchronouslyMergeableCommandInterface*>(it->command.data());
 
        if (!iface1 || !iface1->canMergeWith(otherIt->command.data()) ||
            it->command->id() < 0 || otherIt->command->id() < 0 ||
            it->command->id() != otherIt->command->id() ||
            it->sequentiality != otherIt->sequentiality ||
            it->exclusivity != otherIt->exclusivity) {
 
            sameCommands = false;
            break;
        }
        ++it;
        ++otherIt;
    }
 
    if (!sameCommands) return false;
 
    it = m_d->commands.constBegin();
    otherIt = otherCommands.constBegin();
 
    while (it != end && otherIt != otherEnd) {
        if (it->command->id() != -1) {
            bool result = it->command->mergeWith(otherIt->command.data());
            KIS_ASSERT_RECOVER(result) { return false; }
        }
        ++it;
        ++otherIt;
    }
 
    if (other->extraData()) {
        setExtraData(other->extraData()->clone());
    } else {
        setExtraData(0);
    }
 
    return true;
}

References KisAsynchronouslyMergeableCommandInterface::canMergeWith(), KUndo2CommandExtraData::clone(), KisSavedMacroCommand::Private::SavedCommand::command, KisSavedMacroCommand::Private::commands, KUndo2Command::extraData(), id(), KIS_ASSERT_RECOVER, m_d, KisSavedMacroCommand::Private::overriddenCommand, KUndo2Command::setExtraData(), and KisSavedMacroCommand::Private::skipWhenOverride.

setMacroId()

void KisSavedMacroCommand::setMacroId

(

int

value

)

Definition at line 174 of file kis_saved_commands.cpp.

{
    m_d->macroId = value;
}

References m_d, KisSavedMacroCommand::Private::macroId, and value().

setOverrideInfo()

void KisSavedMacroCommand::setOverrideInfo	(	const KisSavedMacroCommand *	overriddenCommand,
		const QVector< const KUndo2Command * > &	skipWhileOverride )

Definition at line 338 of file kis_saved_commands.cpp.

{
    m_d->overriddenCommand = overriddenCommand;
    m_d->skipWhenOverride = skipWhileOverride;
}

References m_d, KisSavedMacroCommand::Private::overriddenCommand, and KisSavedMacroCommand::Private::skipWhenOverride.

Member Data Documentation

m_d

Private* const KisSavedMacroCommand::m_d

private

Definition at line 111 of file kis_saved_commands.h.

---

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

• libs/image/commands_new/kis_saved_commands.h
• libs/image/commands_new/kis_saved_commands.cpp