commands.h

/*******************************************************************

Part of the Fritzing project - http://fritzing.org
Copyright (c) 2007-2019 Fritzing

Fritzing is free software: you can redistribute it and/or modify\
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Fritzing is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Fritzing.  If not, see <http://www.gnu.org/licenses/>.

********************************************************************/

#ifndef COMMANDS_H
#define COMMANDS_H

#include <QUndoCommand>
#include <QHash>
#include <QPainterPath>

#include "viewgeometry.h"
#include "viewlayer.h"
#include "routingstatus.h"
#include "utils/misc.h"
#include "items/itembase.h"
#include "mainwindow/mainwindow.h"

/////////////////////////////////////////////

class CommandProgress : public QObject {
	Q_OBJECT

public:
	CommandProgress() = default;

	void setActive(bool);
	constexpr bool active() const noexcept { return m_active; }
	void emitUndo();
	void emitRedo();

Q_SIGNALS:
	void incUndo();
	void incRedo();

protected:
	bool m_active = false;
};

/////////////////////////////////////////////
class SketchWidget;
class BaseCommand : public QUndoCommand
{
public:
	enum CrossViewType {
		SingleView,
		CrossView
	};

public:
	BaseCommand(BaseCommand::CrossViewType, SketchWidget*, QUndoCommand* parent);
	~BaseCommand();

	BaseCommand::CrossViewType crossViewType() const noexcept;
	void setCrossViewType(BaseCommand::CrossViewType);
	SketchWidget* sketchWidget() const;
	int subCommandCount() const;
	const BaseCommand * subCommand(int index) const;
	virtual QString getDebugString() const;
	const QUndoCommand * parentCommand() const;
	void addSubCommand(BaseCommand * subCommand);
	void subUndo();
	void subRedo();
	void subUndo(int index);
	void subRedo(int index);
	int index() const;
	void setUndoOnly();
	void setRedoOnly();
	void setSkipFirstRedo();
	void undo();
	void redo();

	static int totalChildCount(const QUndoCommand *);
	static CommandProgress * initProgress();
	static void clearProgress();

protected:
	virtual QString getParamString() const;

	static int nextIndex;

protected:
	BaseCommand::CrossViewType m_crossViewType;
	SketchWidget *m_sketchWidget = nullptr;
	QList<BaseCommand *> m_commands;
	QUndoCommand * m_parentCommand = nullptr;
	int m_index = 0;
	bool m_undoOnly = false;
	bool m_redoOnly = false;
	bool m_skipFirstRedo = false;

	static CommandProgress m_commandProgress;
};

/////////////////////////////////////////////

class SimulationCommand : public BaseCommand
{
public:
	SimulationCommand(BaseCommand::CrossViewType, SketchWidget * sketchWidget, QUndoCommand *parent);
	void undo();
	void redo();
private:
	MainWindow* m_mainWindow;
};

/////////////////////////////////////////////

class AddDeleteItemCommand : public SimulationCommand
{
public:
	AddDeleteItemCommand(SketchWidget * sketchWidget, BaseCommand::CrossViewType, QString moduleID, ViewLayer::ViewLayerPlacement, ViewGeometry &, qint64 id, long modelIndex, QHash<QString, QString> * localConnectors, QUndoCommand *parent);
	~AddDeleteItemCommand();

	long itemID() const;
	void setDropOrigin(SketchWidget *);
	SketchWidget * dropOrigin();

protected:
	QString getParamString() const;

protected:
	QString m_moduleID;
	long m_itemID;
	ViewGeometry m_viewGeometry;
	long m_modelIndex;
	SketchWidget * m_dropOrigin;
	ViewLayer::ViewLayerPlacement m_viewLayerPlacement;
	QHash<QString, QString> * m_localConnectors;
};

/////////////////////////////////////////////

class AddItemCommand : public AddDeleteItemCommand
{
public:
	AddItemCommand(class SketchWidget *sketchWidget, BaseCommand::CrossViewType, QString moduleID, ViewLayer::ViewLayerPlacement, ViewGeometry &, qint64 id, bool updateInfoView, long modelIndex, QUndoCommand *parent);
	void undo();
	void redo();
	void addRestoreIndexesCommand(class RestoreIndexesCommand *);

protected:
	QString getParamString() const;

protected:
	bool m_updateInfoView = false;
	bool m_module = false;
	RestoreIndexesCommand * m_restoreIndexesCommand = nullptr;
};

/////////////////////////////////////////////

class DeleteItemCommand : public AddDeleteItemCommand
{
public:
	DeleteItemCommand(SketchWidget *sketchWidget, BaseCommand::CrossViewType, QString moduleID, ViewLayer::ViewLayerPlacement, ViewGeometry &, qint64 id, long modelIndex, QHash<QString, QString>* localConnectors, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

};

/////////////////////////////////////////////

class MoveItemCommand : public SimulationCommand
{
public:
	MoveItemCommand(SketchWidget *sketchWidget, long id, ViewGeometry & oldG, ViewGeometry & newG, bool updateRatsnest, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	bool m_updateRatsnest = false;
	long m_itemID = 0;
	ViewGeometry m_old;
	ViewGeometry m_new;
};

/////////////////////////////////////////////

class SimpleMoveItemCommand : public SimulationCommand
{
public:
	SimpleMoveItemCommand(SketchWidget *sketchWidget, long id, QPointF & oldP, QPointF & newP, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID = 0;
	QPointF m_old;
	QPointF m_new;
};

/////////////////////////////////////////////

struct MoveItemThing {
	long id = 0;
	QPointF oldPos;
	QPointF newPos;
};

class MoveItemsCommand : public SimulationCommand
{
public:
	MoveItemsCommand(SketchWidget *sketchWidget, bool updateRatsnest, QUndoCommand *parent);
	void undo();
	void redo();
	void addItem(long id, const QPointF & oldPos, const QPointF & newPos);
	void addWire(long id, const QString & connectorID);

protected:
	QString getParamString() const;

protected:
	bool m_updateRatsnest;
	QHash<long, QString> m_wires;
	QList<MoveItemThing> m_items;
};

/////////////////////////////////////////////

class RotateItemCommand : public SimulationCommand
{
public:
	RotateItemCommand(SketchWidget *sketchWidget, long id, double degrees, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	virtual QString getParamString() const;

protected:
	long m_itemID;
	double m_degrees;
};

/////////////////////////////////////////////

class FlipItemCommand : public BaseCommand
{

public:
	FlipItemCommand(SketchWidget *sketchWidget, long id, Qt::Orientations orientation, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	Qt::Orientations m_orientation;
};

/////////////////////////////////////////////
class QTransform;
class TransformItemCommand : public SimulationCommand
{

public:
	TransformItemCommand(SketchWidget *sketchWidget, long id, const QTransform & oldMatrix, const class QTransform & newMatrix, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	QTransform m_oldMatrix;
	QTransform m_newMatrix;
};

/////////////////////////////////////////////

class ChangeConnectionCommand : public SimulationCommand
{
public:
	ChangeConnectionCommand(class SketchWidget * sketchWidget, BaseCommand::CrossViewType,
	                        long fromID, const QString & fromConnectorID,
	                        long toID, const QString & toConnectorID,
	                        ViewLayer::ViewLayerPlacement,
	                        bool connect, QUndoCommand * parent);
	void undo();
	void redo();
	void setUpdateConnections(bool updatem);
	void disable();

protected:
	QString getParamString() const;

protected:
	long m_fromID;
	long m_toID;
	QString m_fromConnectorID;
	QString m_toConnectorID;
	bool m_connect;
	bool m_updateConnections;
	ViewLayer::ViewLayerPlacement m_viewLayerPlacement;
	bool m_enabled;

};

/////////////////////////////////////////////

class ChangeWireCommand : public SimulationCommand
{
public:
	ChangeWireCommand(class SketchWidget *sketchWidget, long fromID,
	                  const QLineF & oldLine, const QLineF & newLine, QPointF oldPos, QPointF newPos,
	                  bool updateConnections, bool updateRatsnest,
	                  QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	bool m_updateRatsnest;
	long m_fromID;
	QLineF m_newLine;
	QLineF m_oldLine;
	QPointF m_newPos;
	QPointF m_oldPos;
	bool m_updateConnections;
};

/////////////////////////////////////////////

class ChangeWireCurveCommand : public SimulationCommand
{
public:
	ChangeWireCurveCommand(class SketchWidget *sketchWidget, long fromID,
	                       const class Bezier * oldBezier, const class Bezier * newBezier, bool wasAutoroutable,
	                       QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_fromID;
	class Bezier * m_newBezier;
	class Bezier * m_oldBezier;
	bool m_wasAutoroutable;
};

/////////////////////////////////////////////

class ChangeLegCommand : public SimulationCommand
{
public:
	ChangeLegCommand(class SketchWidget *sketchWidget, long fromID, const QString & fromConnectorID,
	                 const QPolygonF & oldLeg, const QPolygonF & newLeg, bool relative, bool active, const QString & why, QUndoCommand *parent);
	void undo();
	void redo();

	void setSimple();

protected:
	QString getParamString() const;

protected:
	QString m_fromConnectorID;
	long m_fromID;
	QPolygonF m_newLeg;
	QPolygonF m_oldLeg;
	bool m_relative;
	bool m_active;
	bool m_simple;
	QString m_why;
};

/////////////////////////////////////////////

class MoveLegBendpointCommand : public SimulationCommand
{
public:
	MoveLegBendpointCommand(class SketchWidget *sketchWidget, long fromID, const QString & fromConnectorID,
	                        int index, QPointF oldPos, QPointF newPos, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	QString m_fromConnectorID;
	long m_fromID;
	QPointF m_newPos;
	QPointF m_oldPos;
};

/////////////////////////////////////////////

class ChangeLegCurveCommand : public SimulationCommand
{
public:
	ChangeLegCurveCommand(class SketchWidget *sketchWidget, long fromID, const QString & fromConnectorID, int index,
	                      const class Bezier * oldBezier, const class Bezier * newBezier,
	                      QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_fromID;
	class Bezier * m_newBezier;
	class Bezier * m_oldBezier;
	QString m_fromConnectorID;
	int m_index;
};

/////////////////////////////////////////////

class ChangeLegBendpointCommand : public BaseCommand
{
public:
	ChangeLegBendpointCommand(class SketchWidget *sketchWidget, long fromID, const QString & fromConnectorID,
	                          int oldCount, int newCount, int index, QPointF pos,
	                          const class Bezier *, const class Bezier *, const class Bezier *, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_fromID;
	class Bezier * m_bezier0;
	class Bezier * m_bezier1;
	class Bezier * m_bezier2;
	QString m_fromConnectorID;
	int m_index;
	int m_oldCount;
	int m_newCount;
	QPointF m_pos;
};

/////////////////////////////////////////////

class RotateLegCommand : public SimulationCommand
{
public:
	RotateLegCommand(class SketchWidget *sketchWidget, long fromID, const QString & fromConnectorID,
	                 const QPolygonF & oldLeg, bool active, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	QString m_fromConnectorID;
	long m_fromID;
	QPolygonF m_oldLeg;
	bool m_active;
};

/////////////////////////////////////////////

class ChangeLayerCommand : public BaseCommand
{
public:
	ChangeLayerCommand(class SketchWidget *sketchWidget, long fromID,
	                   double oldZ, double newZ,
	                   ViewLayer::ViewLayerID oldLayer, ViewLayer::ViewLayerID newLayer,
	                   QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_fromID;
	double m_newZ;
	double m_oldZ;
	ViewLayer::ViewLayerID m_newLayer;
	ViewLayer::ViewLayerID m_oldLayer;
};

/////////////////////////////////////////////

class SelectItemCommand : public BaseCommand
{
public:
	enum SelectItemType {
		NormalSelect,
		NormalDeselect,
		SelectAll,
		DeselectAll
	};

public:
	SelectItemCommand(class SketchWidget *sketchWidget, SelectItemType type, QUndoCommand *parent);

	void undo();
	void redo();
	void addUndo(long id);
	void addRedo(long id);
	void clearRedo();
	int id() const;
	bool mergeWith(const QUndoCommand *other);
	void copyUndo(SelectItemCommand * sother);
	void copyRedo(SelectItemCommand * sother);
	void setSelectItemType(SelectItemType);
	bool updated();
	void setUpdated(bool);

protected:
	void selectAllFromStack(QList<long> & stack, bool select, bool updateInfoView);
	QString getParamString() const;

protected:
	QList<long> m_undoIDs;
	QList<long> m_redoIDs;
	SelectItemType m_type;
	bool m_updated;

protected:
	static int selectItemCommandID;
};

/////////////////////////////////////////////

class ChangeZCommand : public BaseCommand
{
public:
	ChangeZCommand(class SketchWidget *sketchWidget, QUndoCommand *parent);
	~ChangeZCommand();

	void addTriplet(long id, double oldZ, double newZ);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	static double first(RealPair *);
	static double second(RealPair *);

protected:
	QHash<long, RealPair *> m_triplets;
};

struct StickyThing {
	SketchWidget * sketchWidget;
	bool stickem;
	long fromID;
	long toID;
};

/////////////////////////////////////////////
class SketchWidget;
class CheckStickyCommand : public BaseCommand
{
public:
	enum CheckType {
		UndoOnly = 0,
		RedoOnly,
		RemoveOnly
	};

public:
	CheckStickyCommand(SketchWidget *sketchWidget, BaseCommand::CrossViewType, long itemID, bool checkCurrent, CheckType, QUndoCommand *parent);
	~CheckStickyCommand();

	void undo();
	void redo();
	void stick(SketchWidget *, long fromID, long toID, bool stickem);


protected:
	QString getParamString() const;

protected:
	long m_itemID = 0;
	QList<StickyThing *> m_stickyList;
	bool m_checkCurrent = false;
	CheckType m_checkType;
};

/////////////////////////////////////////////

class WireColorChangeCommand : public BaseCommand
{
public:
	WireColorChangeCommand(
	    SketchWidget* sketchWidget,
	    long wireId, const QString &oldColor, const QString &newColor,
	    double oldOpacity, double newOpacity,
	    QUndoCommand *parent=0);
	void undo();
	void redo();


protected:
	QString getParamString() const;

protected:
	long m_wireId;
	QString m_oldColor;
	QString m_newColor;
	double m_oldOpacity;
	double m_newOpacity;
};

/////////////////////////////////////////////

class WireWidthChangeCommand : public BaseCommand
{
public:
	WireWidthChangeCommand(
	    SketchWidget* sketchWidget,
	    long wireId, double oldWidth, double newWidth,
	    QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_wireId;
	double m_oldWidth;
	double m_newWidth;
};

/////////////////////////////////////////////

class RoutingStatusCommand : public BaseCommand
{
public:
	RoutingStatusCommand(class SketchWidget *, const RoutingStatus & oldRoutingStatus, const RoutingStatus & newRoutingStatus, QUndoCommand * parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	RoutingStatus m_oldRoutingStatus;
	RoutingStatus m_newRoutingStatus;
};

/////////////////////////////////////////////

struct RatsnestConnectThing
{
	long id;
	QString connectorID;
	bool connect;
};

class CleanUpWiresCommand : public SimulationCommand
{
public:
	enum Direction {
		UndoOnly = 0,
		RedoOnly,
		Noop
	};

public:
	CleanUpWiresCommand(class SketchWidget * sketchWidget, CleanUpWiresCommand::Direction, QUndoCommand * parent);
	void undo();
	void redo();
	void addRoutingStatus(SketchWidget *, const RoutingStatus & oldRoutingStatus, const RoutingStatus & newRoutingStatus);
	void setDirection(CleanUpWiresCommand::Direction);
	void addTrace(SketchWidget * sketchWidget, Wire * wire);
	bool hasTraces(SketchWidget *);
	void addRatsnestConnect(long id, const QString & connectorID, bool connect);
	CleanUpWiresCommand::Direction direction();

protected:
	QString getParamString() const;

protected:
	QSet<SketchWidget *> m_sketchWidgets;
	QList<RatsnestConnectThing> m_ratsnestConnectThings;
	CleanUpWiresCommand::Direction m_direction;
};

/////////////////////////////////////////////

class CleanUpRatsnestsCommand : public SimulationCommand
{
public:
	CleanUpRatsnestsCommand(class SketchWidget * sketchWidget, CleanUpWiresCommand::Direction, QUndoCommand * parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

};

/////////////////////////////////////////////

class RestoreLabelCommand : public BaseCommand
{
public:
	RestoreLabelCommand(class SketchWidget *sketchWidget, long id, QDomElement & oldLabelGeometry, QDomElement & newLabelGeometry, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	QDomElement m_oldLabelGeometry;
	QDomElement m_newLabelGeometry;
};

/////////////////////////////////////////////

class CheckPartLabelLayerVisibilityCommand : public BaseCommand
{
public:
	CheckPartLabelLayerVisibilityCommand(class SketchWidget *sketchWidget, long id, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
};

/////////////////////////////////////////////

class ShowLabelFirstTimeCommand : public BaseCommand
{
public:
	ShowLabelFirstTimeCommand(class SketchWidget *sketchWidget, CrossViewType crossView, long id, bool oldVis, bool newVis, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	bool m_oldVis;
	bool m_newVis;
};

/////////////////////////////////////////////

class MoveLabelCommand : public BaseCommand
{
public:
	MoveLabelCommand(class SketchWidget *sketchWidget, long id, QPointF oldPos, QPointF oldOffset, QPointF newPos, QPointF newOffset, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	QPointF m_oldPos;
	QPointF m_newPos;
	QPointF m_oldOffset;
	QPointF m_newOffset;
};

/////////////////////////////////////////////

class MoveLockCommand : public BaseCommand
{
public:
	MoveLockCommand(class SketchWidget *sketchWidget, long id, bool oldLock, bool newLock, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	bool m_oldLock;
	bool m_newLock;
};

/////////////////////////////////////////////

class IncLabelTextCommand : public BaseCommand
{
public:
	IncLabelTextCommand(class SketchWidget *sketchWidget, long id, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
};

/////////////////////////////////////////////

class ChangeLabelTextCommand : public BaseCommand
{
public:
	ChangeLabelTextCommand(class SketchWidget *sketchWidget, long id, const QString & oldText, const QString & newText, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	QString m_oldText;
	QString m_newText;
};

/////////////////////////////////////////////

class ChangeNoteTextCommand : public BaseCommand
{
public:
	ChangeNoteTextCommand(class SketchWidget *sketchWidget, long id, const QString & oldText, const QString & newText, QSizeF oldSize, QSizeF newSize, QUndoCommand *parent);
	void undo();
	void redo();
	int id() const;
	bool mergeWith(const QUndoCommand *other);

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	QString m_oldText;
	QString m_newText;
	QSizeF m_oldSize;
	QSizeF m_newSize;

	static int changeNoteTextCommandID;
};

/////////////////////////////////////////////

class RotateFlipLabelCommand : public BaseCommand
{
public:
	RotateFlipLabelCommand(class SketchWidget *sketchWidget, long id, double degrees, Qt::Orientations, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	double m_degrees;
	Qt::Orientations m_orientation;
};

/////////////////////////////////////////////

class ResizeNoteCommand : public BaseCommand
{
public:
	ResizeNoteCommand(class SketchWidget *sketchWidget, long id, const QSizeF & oldSize, const QSizeF & newSize, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	QSizeF m_oldSize;
	QSizeF m_newSize;
};

/////////////////////////////////////////////

class ResizeBoardCommand : public BaseCommand
{
public:
	ResizeBoardCommand(class SketchWidget *, long itemID, double oldWidth, double oldHeight, double newWidth, double newHeight, QUndoCommand * parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	double m_oldWidth;
	double m_oldHeight;
	double m_newWidth;
	double m_newHeight;
	long m_itemID;
};

/////////////////////////////////////////////

class SetResistanceCommand : public SimulationCommand
{
public:
	SetResistanceCommand(class SketchWidget *, long itemID, QString oldResistance, QString newResistance, QString oldPinSpacing, QString newPinSpacing, QUndoCommand * parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	QString m_oldResistance;
	QString m_newResistance;
	QString m_oldPinSpacing;
	QString m_newPinSpacing;
	long m_itemID;
};

/////////////////////////////////////////////

class SetPropCommand : public SimulationCommand
{
public:
	SetPropCommand(class SketchWidget *, long itemID, QString prop, QString oldValue, QString newValue, bool redraw, QUndoCommand * parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	bool m_redraw;
	QString m_prop;
	QString m_oldValue;
	QString m_newValue;
	long m_itemID;
};

/////////////////////////////////////////////

class ResizeJumperItemCommand : public BaseCommand
{
public:
	ResizeJumperItemCommand(class SketchWidget *, long itemID, QPointF oldPos, QPointF oldC0, QPointF oldC1, QPointF newPos, QPointF newC0, QPointF newC1, QUndoCommand * parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	QPointF m_oldPos;
	QPointF m_oldC0;
	QPointF m_oldC1;
	QPointF m_newPos;
	QPointF m_newC0;
	QPointF m_newC1;
	long m_itemID;
};

/////////////////////////////////////////////

class ShowLabelCommand : public BaseCommand
{
public:
	ShowLabelCommand(class SketchWidget *sketchWidget, QUndoCommand *parent);

	void undo();
	void redo();
	void add(long id, bool prev, bool post);

protected:
	QString getParamString() const;

protected:
	QHash<long, int> m_idStates;

};

/////////////////////////////////////////////

class LoadLogoImageCommand : public BaseCommand
{
public:
	LoadLogoImageCommand(class SketchWidget *sketchWidget, long id, const QString & oldSvg, const QSizeF oldAspectRatio, const QString & oldFilename, const QString & newFilename, bool addName, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	QString m_oldSvg;
	QSizeF m_oldAspectRatio;
	QString m_oldFilename;
	QString m_newFilename;
	bool m_addName;
};

/////////////////////////////////////////////

class ChangeBoardLayersCommand : public BaseCommand
{
public:
	ChangeBoardLayersCommand(class SketchWidget *sketchWidget, int oldLayers, int newLayers, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	int m_oldLayers;
	int m_newLayers;
};

/////////////////////////////////////////////

class SetDropOffsetCommand : public BaseCommand
{
public:
	SetDropOffsetCommand(class SketchWidget *sketchWidget, long id, QPointF dropOffset, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	QPointF m_dropOffset;
};

/////////////////////////////////////////////

class RenamePinsCommand : public BaseCommand
{
public:
	RenamePinsCommand(class SketchWidget *sketchWidget, long id, const QStringList & oldOnes, const QStringList & newOnes, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	QStringList m_oldLabels;
	QStringList m_newLabels;
};

/////////////////////////////////////////////

struct GFSThing {
	long id;
	QString connectorID;
	bool seed;
};

class GroundFillSeedCommand : public BaseCommand
{
public:
	GroundFillSeedCommand(class SketchWidget *sketchWidget, QUndoCommand *parent);
	void undo();
	void redo();
	void addItem(long id, const QString & connectorID, bool seed);

protected:
	QString getParamString() const;

protected:
	QList<GFSThing> m_items;
};

/////////////////////////////////////////////

class WireExtrasCommand : public BaseCommand
{
public:
	WireExtrasCommand(class SketchWidget *sketchWidget, long fromID,
	                  const QDomElement & oldExtras, const QDomElement & newExtras,
	                  QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_fromID;
	QDomElement m_oldExtras;
	QDomElement m_newExtras;

};

/////////////////////////////////////////////

class HidePartLayerCommand : public BaseCommand
{
public:
	HidePartLayerCommand(class SketchWidget *sketchWidget, long fromID,
	                     ViewLayer::ViewLayerID layerID, bool wasHidden, bool isHidden,
	                     QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_fromID;
	double m_wasHidden;
	double m_isHidden;
	ViewLayer::ViewLayerID m_layerID;
	ViewLayer::ViewLayerID m_oldLayer;
};

/////////////////////////////////////////////

class TemporaryCommand : public QUndoCommand
{

public:
	TemporaryCommand(const QString & text);
	~TemporaryCommand();

	void setEnabled(bool);

	void redo();

protected:
	bool m_enabled;
};

/////////////////////////////////////////////

class AddSubpartCommand : public BaseCommand
{
public:
	AddSubpartCommand(class SketchWidget *sketchWidget, CrossViewType crossView, long id, long subpartID, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	long m_itemID;
	long m_subpartItemID;
};

/////////////////////////////////////////////

class PackItemsCommand : public BaseCommand
{
public:
	PackItemsCommand(class SketchWidget *sketchWidget, int columns, const QList<long> & ids, QUndoCommand *parent);
	void undo();
	void redo();

protected:
	QString getParamString() const;

protected:
	int m_columns;
	QList<long> m_ids;
	bool m_firstTime;
};

/////////////////////////////////////////////

#endif // COMMANDS_H