commit.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright 2016-2017 CERN
 * Copyright (C) 2020-2021 KiCad Developers, see change_log.txt for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 * @author Maciej Suminski <[email protected]>
 *
 * This program 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 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef __COMMIT_H
#define __COMMIT_H
 
#include <set>
#include <vector>
#include <wx/string.h>
#include <undo_redo_container.h>
#include <kiid.h>
 
class EDA_ITEM;
class BASE_SCREEN;
 
enum CHANGE_TYPE {
 CHT_ADD = 1,
 CHT_REMOVE = 2,
 CHT_MODIFY = 4,
 CHT_GROUP = 8,
 CHT_UNGROUP = 16,
 CHT_TYPE = CHT_ADD | CHT_REMOVE | CHT_MODIFY | CHT_GROUP | CHT_UNGROUP,
 
 CHT_DONE = 32, 
 CHT_FLAGS = CHT_DONE
};
 
template<typename T>
CHANGE_TYPE operator|( CHANGE_TYPE aTypeA, T aTypeB )
{
 return CHANGE_TYPE( (int) aTypeA | (int) aTypeB );
}
 
template<typename T>
CHANGE_TYPE operator&( CHANGE_TYPE aTypeA, T aTypeB )
{
 return CHANGE_TYPE( (int) aTypeA & (int) aTypeB );
}
 
 
class COMMIT
{
public:
 COMMIT();
 virtual ~COMMIT();
 
 COMMIT& Add( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
 {
 return Stage( aItem, CHT_ADD, aScreen );
 }
 
 COMMIT& Added( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
 {
 return Stage( aItem, CHT_ADD | CHT_DONE, aScreen );
 }
 
 COMMIT& Remove( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
 {
 return Stage( aItem, CHT_REMOVE, aScreen );
 }
 
 COMMIT& Removed( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
 {
 return Stage( aItem, CHT_REMOVE | CHT_DONE, aScreen );
 }
 
 COMMIT& Modify( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
 {
 return Stage( aItem, CHT_MODIFY, aScreen );
 }
 
 COMMIT& Modified( EDA_ITEM* aItem, EDA_ITEM* aCopy, BASE_SCREEN *aScreen = nullptr )
 {
 return createModified( aItem, aCopy, 0, aScreen );
 }
 
 template<class Range>
 
 COMMIT& StageItems( const Range& aRange, CHANGE_TYPE aChangeType )
 {
 for( const auto& item : aRange )
 Stage( item, aChangeType );
 
 return *this;
 }
 
 virtual COMMIT& Stage( EDA_ITEM* aItem, CHANGE_TYPE aChangeType,
 BASE_SCREEN *aScreen = nullptr );
 
 virtual COMMIT& Stage( std::vector<EDA_ITEM*>& container, CHANGE_TYPE aChangeType,
 BASE_SCREEN *aScreen = nullptr );
 
 virtual COMMIT& Stage( const PICKED_ITEMS_LIST& aItems,
 UNDO_REDO aModFlag = UNDO_REDO::UNSPECIFIED,
 BASE_SCREEN *aScreen = nullptr );
 
 virtual void Push( const wxString& aMessage = wxT( "A commit" ), int aFlags = 0 ) = 0;
 
 virtual void Revert() = 0;
 
 bool Empty() const
 {
 return m_changes.empty();
 }
 
 int GetStatus( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr );
 
 EDA_ITEM* GetFirst() const { return m_changes.empty() ? nullptr : m_changes[0].m_item; }
 
protected:
 struct COMMIT_LINE
 {
 EDA_ITEM* m_item; 
 EDA_ITEM* m_copy; 
 CHANGE_TYPE m_type; 
 KIID m_parent = NilUuid(); 
 BASE_SCREEN* m_screen;
 };
 
 // Should be called in Push() & Revert() methods
 void clear()
 {
 m_changedItems.clear();
 m_deletedItems.clear();
 m_changes.clear();
 }
 
 COMMIT& createModified( EDA_ITEM* aItem, EDA_ITEM* aCopy, int aExtraFlags = 0,
 BASE_SCREEN *aScreen = nullptr );
 
 virtual void makeEntry( EDA_ITEM* aItem, CHANGE_TYPE aType, EDA_ITEM* aCopy = nullptr,
 BASE_SCREEN *aScreen = nullptr );
 
 COMMIT_LINE* findEntry( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr );
 
 virtual EDA_ITEM* parentObject( EDA_ITEM* aItem ) const = 0;
 
 virtual EDA_ITEM* makeImage( EDA_ITEM* aItem ) const = 0;
 
 CHANGE_TYPE convert( UNDO_REDO aType ) const;
 UNDO_REDO convert( CHANGE_TYPE aType ) const;
 
protected:
 std::set<EDA_ITEM*> m_changedItems;
 std::set<EDA_ITEM*> m_deletedItems;
 std::vector<COMMIT_LINE> m_changes;
};
 
#endif