board_commit.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * @author Tomasz Wlostowski <[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, see <https://www.gnu.org/licenses/>.
 */
 
#include <macros.h>
#include <pgm_base.h>
#include <settings/settings_manager.h>
#include <board.h>
#include <component_classes/component_class_manager.h>
#include <footprint.h>
#include <lset.h>
#include <pad.h>
#include <pcb_group.h>
#include <pcb_track.h>
#include <pcb_shape.h>
#include <tool/tool_manager.h>
#include <tools/pcb_selection_tool.h>
#include <tools/zone_filler_tool.h>
#include <view/view.h>
#include <board_commit.h>
#include <tools/pcb_tool_base.h>
#include <tools/pcb_actions.h>
#include <connectivity/connectivity_data.h>
#include <connectivity/connectivity_algo.h>
#include <teardrop/teardrop.h>
#include <pcb_board_outline.h>
#include <pcb_drill_map.h>
#include <pcb_base_frame.h>
 
#include <functional>
#include <unordered_set>
#include <project/project_file.h>
using namespace std::placeholders;
 
 
// A no-geometry board item (net metadata or a geometric constraint) is never pushed into the
// VIEW or the connectivity graph.  VIEW::Add early-returns on an empty layer set but still
// stamps the item's view private data, which a later VIEW::Remove would mis-index.
static bool isNoGeometryItem( const BOARD_ITEM* aItem )
{
    return aItem->Type() == PCB_NETINFO_T || aItem->Type() == PCB_CONSTRAINT_T;
}
 
 
BOARD_COMMIT::BOARD_COMMIT( TOOL_BASE* aTool ) :
        COMMIT(),
        m_toolMgr( aTool->GetManager() ),
        m_isBoardEditor( false ),
        m_isFootprintEditor( false )
{
    if( PCB_TOOL_BASE* pcb_tool = dynamic_cast<PCB_TOOL_BASE*>( aTool ) )
    {
        m_isBoardEditor = pcb_tool->IsBoardEditor();
        m_isFootprintEditor = pcb_tool->IsFootprintEditor();
    }
}
 
 
BOARD_COMMIT::BOARD_COMMIT( EDA_DRAW_FRAME* aFrame ) :
        COMMIT(),
        m_toolMgr( aFrame->GetToolManager() ),
        m_isBoardEditor( aFrame->IsType( FRAME_PCB_EDITOR ) ),
        m_isFootprintEditor( aFrame->IsType( FRAME_FOOTPRINT_EDITOR ) )
{
}
 
 
BOARD_COMMIT::BOARD_COMMIT( TOOL_MANAGER* aMgr ) :
        COMMIT(),
        m_toolMgr( aMgr ),
        m_isBoardEditor( false ),
        m_isFootprintEditor( false )
{
    EDA_DRAW_FRAME* frame = dynamic_cast<EDA_DRAW_FRAME*>( aMgr->GetToolHolder() );
 
    if( frame && frame->IsType( FRAME_PCB_EDITOR ) )
        m_isBoardEditor = true;
    else if( frame && frame->IsType( FRAME_FOOTPRINT_EDITOR ) )
        m_isFootprintEditor = true;
}
 
 
BOARD_COMMIT::BOARD_COMMIT( TOOL_MANAGER* aMgr, bool aIsBoardEditor, bool aIsFootprintEditor ) :
        COMMIT(),
        m_toolMgr( aMgr ),
        m_isBoardEditor( aIsBoardEditor ),
        m_isFootprintEditor( aIsFootprintEditor )
{
}
 
 
BOARD* BOARD_COMMIT::GetBoard() const
{
    return static_cast<BOARD*>( m_toolMgr->GetModel() );
}
 
 
COMMIT& BOARD_COMMIT::Stage( EDA_ITEM* aItem, CHANGE_TYPE aChangeType, BASE_SCREEN* aScreen, RECURSE_MODE aRecurse )
{
    if( aRecurse == RECURSE_MODE::RECURSE )
    {
        if( PCB_GROUP* group = dynamic_cast<PCB_GROUP*>( aItem ) )
        {
            for( EDA_ITEM* member : group->GetItems() )
                Stage( member, aChangeType, aScreen, aRecurse );
        }
    }
 
    if( m_isBoardEditor && ( aChangeType & CHT_TYPE ) == CHT_REMOVE
            && aItem->IsBOARD_ITEM()
            && static_cast<BOARD_ITEM*>( aItem )->GetParentFootprint() )
    {
        if( m_deletedItems.find( { aItem, aScreen } ) == m_deletedItems.end() )
            makeEntry( aItem, aChangeType, makeImage( aItem ), aScreen );
 
        return *this;
    }
 
    return COMMIT::Stage( aItem, aChangeType );
}
 
 
COMMIT& BOARD_COMMIT::Stage( std::vector<EDA_ITEM*>& container, CHANGE_TYPE aChangeType, BASE_SCREEN* aScreen )
{
    return COMMIT::Stage( container, aChangeType, aScreen );
}
 
 
COMMIT& BOARD_COMMIT::Stage( const PICKED_ITEMS_LIST& aItems, UNDO_REDO aModFlag, BASE_SCREEN* aScreen )
{
    return COMMIT::Stage( aItems, aModFlag, aScreen );
}
 
 
bool BOARD_COMMIT::RemoveOrDiscard( BOARD_ITEM* aItem )
{
    COMMIT_LINE* entry = findEntry( aItem );
 
    // An add already applied to the board has to be undone through it, so only pending adds are freed
    if( !entry || entry->m_type != CHT_ADD )
    {
        Remove( aItem );
        return false;
    }
 
    if( EDA_GROUP* parentGroup = aItem->GetParentGroup() )
        parentGroup->RemoveItem( aItem );
 
    if( PCB_GROUP* group = dynamic_cast<PCB_GROUP*>( aItem ) )
        group->RemoveAll();
 
    Unstage( aItem, nullptr );
    return true;
}
 
 
void BOARD_COMMIT::propagateDamage( BOARD_ITEM* aChangedItem, std::vector<ZONE*>* aStaleZones,
                                    std::vector<BOX2I>& aStaleRuleAreas )
{
    wxCHECK( aChangedItem, /* void */ );
 
    if( aStaleZones && aChangedItem->Type() == PCB_ZONE_T )
        aStaleZones->push_back( static_cast<ZONE*>( aChangedItem ) );
 
    aChangedItem->RunOnChildren( std::bind( &BOARD_COMMIT::propagateDamage, this, _1, aStaleZones, aStaleRuleAreas ),
                                 RECURSE_MODE::NO_RECURSE );
 
    BOARD* board = static_cast<BOARD*>( m_toolMgr->GetModel() );
    BOX2I  damageBBox = aChangedItem->GetBoundingBox();
    LSET   damageLayers = aChangedItem->GetLayerSet();
 
    if( m_isBoardEditor && aChangedItem->Type() == PCB_ZONE_T )
    {
        // A named zone can have custom DRC rules targetting it.
        if( !static_cast<ZONE*>( aChangedItem )->GetZoneName().IsEmpty() )
            aStaleRuleAreas.push_back( damageBBox );
    }
 
    if( aStaleZones )
    {
        if( damageLayers.test( Edge_Cuts ) || damageLayers.test( Margin ) )
            damageLayers = LSET::PhysicalLayersMask();
        else
            damageLayers &= LSET::AllCuMask();
 
        if( damageLayers.any() )
        {
            for( ZONE* zone : board->Zones() )
            {
                if( zone->GetIsRuleArea() )
                    continue;
 
                if( ( zone->GetLayerSet() & damageLayers ).any() && zone->GetBoundingBox().Intersects( damageBBox ) )
                    aStaleZones->push_back( zone );
            }
        }
    }
}
 
 
void BOARD_COMMIT::Push( const wxString& aMessage, int aCommitFlags )
{
    KIGFX::PCB_VIEW*    view = static_cast<KIGFX::PCB_VIEW*>( m_toolMgr->GetView() );
    BOARD*              board = static_cast<BOARD*>( m_toolMgr->GetModel() );
    PCB_BASE_FRAME*     frame = dynamic_cast<PCB_BASE_FRAME*>( m_toolMgr->GetToolHolder() );
    PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
    PCB_GROUP*          enteredGroup = selTool && !( aCommitFlags & SKIP_ENTERED_GROUP ) ? selTool->GetEnteredGroup()
                                                                                         : nullptr;
    // Notification info
    PICKED_ITEMS_LIST   undoList;
    bool                itemsDeselected = false;
    bool                selectedModified = false;
 
    std::unordered_set<EDA_ITEM*> removedItems;
 
    // Dirty flags and lists
    bool                     solderMaskDirty = false;
    bool                     autofillZones = false;
    bool                     updateBoardBoundingBox = false;
    std::vector<BOARD_ITEM*> staleTeardropPadsAndVias;
    std::set<PCB_TRACK*>     staleTeardropTracks;
    std::vector<BOARD_ITEM*> dirtyCopper;
    std::set<BOARD_ITEM*>    dirtyCopperSeen;
    std::vector<ZONE*>       staleZonesStorage;
    std::vector<ZONE*>*      staleZones = nullptr;
    std::vector<BOX2I>       staleRuleAreas;
 
    if( Empty() )
        return;
 
    bool containsDrillMap = false;
    bool containsDrillChart = false;
 
    for( const COMMIT_LINE& entry : m_entries )
    {
        if( !entry.m_item || !entry.m_item->IsBOARD_ITEM() )
            continue;
 
        BOARD_ITEM* item = static_cast<BOARD_ITEM*>( entry.m_item );
 
        if( item->Type() == PCB_DRILL_CHART_T || item->Type() == PCB_DRILL_MAP_T )
        {
            containsDrillMap |= item->Type() == PCB_DRILL_MAP_T;
            containsDrillChart |= item->Type() == PCB_DRILL_CHART_T;
        }
    }
 
    undoList.SetDescription( aMessage );
 
    TEARDROP_MANAGER                   teardropMgr( board, m_toolMgr );
    std::shared_ptr<CONNECTIVITY_DATA> connectivity = board->GetConnectivity();
 
    // Note: frame == nullptr happens in QA tests
 
    std::vector<BOARD_ITEM*> bulkAddedItems;
    std::vector<BOARD_ITEM*> bulkRemovedItems;
    std::vector<BOARD_ITEM*> itemsChanged;
 
    if( m_isBoardEditor && !( aCommitFlags & ZONE_FILL_OP )
                        && ( frame && frame->GetPcbNewSettings()->m_AutoRefillZones ) )
    {
        autofillZones = true;
        staleZones = &staleZonesStorage;
 
        for( ZONE* zone : board->Zones() )
            zone->CacheBoundingBox();
    }
 
    for( COMMIT_LINE& entry : m_entries )
    {
        if( !entry.m_item || !entry.m_item->IsBOARD_ITEM() )
            continue;
 
        BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( entry.m_item );
 
        if( m_isBoardEditor )
        {
            if( boardItem->Type() == PCB_VIA_T || boardItem->Type() == PCB_FOOTPRINT_T
                    || boardItem->IsOnLayer( F_Mask ) || boardItem->IsOnLayer( B_Mask ) )
            {
                solderMaskDirty = true;
            }
 
            BOARD_ITEM* preEditItem = nullptr;
 
            if( entry.m_copy && entry.m_copy->IsBOARD_ITEM() )
                preEditItem = static_cast<BOARD_ITEM*>( entry.m_copy );
 
            if( boardItem->IsOnLayer( Edge_Cuts ) || ( preEditItem && preEditItem->IsOnLayer( Edge_Cuts ) ) )
                updateBoardBoundingBox = true;
 
            if( !( aCommitFlags & SKIP_TEARDROPS ) )
            {
                // Teardrops are fitted to the copper around them, so any changed copper item
                // can invalidate one, not only what a teardrop connects to.
                auto collectCopper =
                        [&]( BOARD_ITEM* aItem )
                        {
                            // Pours are the filler's business.  Containers have no copper of
                            // their own and their boxes sweep far more than they occupy.
                            if( aItem->Type() == PCB_ZONE_T
                                || aItem->Type() == PCB_FOOTPRINT_T
                                || aItem->Type() == PCB_GROUP_T
                                || aItem->Type() == PCB_GENERATOR_T )
                            {
                                return;
                            }
 
                            // A group and its members can both be in the commit.
                            if( ( aItem->GetLayerSet() & LSET::AllCuMask() ).any()
                                && dirtyCopperSeen.insert( aItem ).second )
                            {
                                dirtyCopper.push_back( aItem );
                            }
                        };
 
                collectCopper( boardItem );
                boardItem->RunOnChildren( collectCopper, RECURSE_MODE::RECURSE );
 
                // boardItem already carries the edit, so it cannot show where the item was.
                // The pre-edit clone is still ours here and answers a bounding box.
                if( entry.m_copy && entry.m_copy->IsBOARD_ITEM() )
                {
                    BOARD_ITEM* copy = static_cast<BOARD_ITEM*>( entry.m_copy );
 
                    collectCopper( copy );
                    copy->RunOnChildren( collectCopper, RECURSE_MODE::RECURSE );
                }
 
                if( boardItem->Type() == PCB_FOOTPRINT_T )
                {
                    for( PAD* pad : static_cast<FOOTPRINT*>( boardItem )->Pads() )
                        staleTeardropPadsAndVias.push_back( pad );
                }
                else if( boardItem->Type() == PCB_PAD_T || boardItem->Type() == PCB_VIA_T )
                {
                    staleTeardropPadsAndVias.push_back( boardItem );
                }
                else if( boardItem->Type() == PCB_TRACE_T || boardItem->Type() == PCB_ARC_T )
                {
                    PCB_TRACK* track = static_cast<PCB_TRACK*>( boardItem );
 
                    staleTeardropTracks.insert( track );
 
                    std::vector<PAD*>     connectedPads;
                    std::vector<PCB_VIA*> connectedVias;
 
                    connectivity->GetConnectedPadsAndVias( track, &connectedPads, &connectedVias );
 
                    for( PAD* pad : connectedPads )
                        staleTeardropPadsAndVias.push_back( pad );
 
                    for( PCB_VIA* via : connectedVias )
                        staleTeardropPadsAndVias.push_back( via );
                }
            }
        }
 
        if( boardItem->IsSelected() || ( m_isFootprintEditor && boardItem == board->GetFirstFootprint() ) )
            selectedModified = true;
    }
 
    // Old teardrops must be removed before connectivity is rebuilt
    if( !staleTeardropPadsAndVias.empty() || !staleTeardropTracks.empty() || !dirtyCopper.empty() )
        teardropMgr.RemoveTeardrops( *this, &staleTeardropPadsAndVias, &staleTeardropTracks, &dirtyCopper );
 
    auto updateComponentClasses =
            [this]( BOARD_ITEM* boardItem )
            {
                if( boardItem->Type() != PCB_FOOTPRINT_T )
                    return;
 
                FOOTPRINT* footprint = static_cast<FOOTPRINT*>( boardItem );
                GetBoard()->GetComponentClassManager().RebuildRequiredCaches( footprint );
            };
 
    // We don't know that anything will be added to the entered group, but it does no harm to
    // add it to the commit anyway.
    if( enteredGroup )
        Modify( enteredGroup );
 
 
    for( COMMIT_LINE& entry : m_entries )
    {
        if( !entry.m_item || !entry.m_item->IsBOARD_ITEM() )
            continue;
 
        BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( entry.m_item );
        int         changeType = entry.m_type & CHT_TYPE;
        int         changeFlags = entry.m_type & CHT_FLAGS;
 
        switch( changeType )
        {
        case CHT_ADD:
            if( enteredGroup && boardItem->IsGroupableType() && !boardItem->GetParentGroup() )
                enteredGroup->AddItem( boardItem );
 
            if( !( aCommitFlags & SKIP_UNDO ) )
                undoList.PushItem( ITEM_PICKER( nullptr, boardItem, UNDO_REDO::NEWITEM ) );
 
            if( !( changeFlags & CHT_DONE ) )
            {
                // Markers are always stored at the board level, even in the footprint editor
                if( m_isFootprintEditor && boardItem->Type() != PCB_MARKER_T )
                {
                    if( FOOTPRINT* parentFP = board->GetFirstFootprint() )
                        parentFP->Add( boardItem );
                }
                else
                {
                    board->Add( boardItem, ADD_MODE::BULK_INSERT ); // handles connectivity
                    bulkAddedItems.push_back( boardItem );
                }
            }
 
            if( boardItem->Type() != PCB_MARKER_T )
                propagateDamage( boardItem, staleZones, staleRuleAreas );
 
            if( view && !isNoGeometryItem( boardItem ) )
                view->Add( boardItem );
 
            updateComponentClasses( boardItem );
 
            break;
 
        case CHT_REMOVE:
        {
            EDA_GROUP* parentGroup = boardItem->GetParentGroup();
 
            if( !( aCommitFlags & SKIP_UNDO ) )
            {
                UNDO_REDO   status = boardItem->Type() == PCB_FIELD_T ? UNDO_REDO::CHANGED : UNDO_REDO::DELETED;
                ITEM_PICKER itemWrapper( nullptr, boardItem, status );
                itemWrapper.SetLink( entry.m_copy );
                entry.m_copy = nullptr;   // We've transferred ownership to the undo list
                undoList.PushItem( itemWrapper );
            }
 
            if( boardItem->IsSelected() )
            {
                if( selTool )
                    selTool->RemoveItemFromSel( boardItem, true /* quiet mode */ );
 
                itemsDeselected = true;
            }
 
            removedItems.insert( boardItem );
 
            if( parentGroup && !( parentGroup->AsEdaItem()->GetFlags() & STRUCT_DELETED ) )
                parentGroup->RemoveItem( boardItem );
 
            if( boardItem->Type() != PCB_MARKER_T )
                propagateDamage( boardItem, staleZones, staleRuleAreas );
 
            switch( boardItem->Type() )
            {
            case PCB_FIELD_T:
                static_cast<PCB_FIELD*>( boardItem )->SetVisible( false );
 
                if( view )
                    view->Update( boardItem );
 
                break;
 
            case PCB_TEXT_T:
            case PCB_PAD_T:
            case PCB_SHAPE_T:
            case PCB_REFERENCE_IMAGE_T:
            case PCB_GENERATOR_T:
            case PCB_TEXTBOX_T:
            case PCB_BARCODE_T:
            case PCB_TABLE_T:
            case PCB_DRILL_CHART_T:
            case PCB_DRILL_MAP_T:
            case PCB_TRACE_T:
            case PCB_ARC_T:
            case PCB_VIA_T:
            case PCB_DIM_ALIGNED_T:
            case PCB_DIM_CENTER_T:
            case PCB_DIM_RADIAL_T:
            case PCB_DIM_ORTHOGONAL_T:
            case PCB_DIM_LEADER_T:
            case PCB_TARGET_T:
            case PCB_POINT_T:
            case PCB_ZONE_T:
            case PCB_GRID_ITEM_T:
            case PCB_FOOTPRINT_T:
            case PCB_GROUP_T:
                if( view )
                    view->Remove( boardItem );
 
                if( !( changeFlags & CHT_DONE ) )
                {
                    if( m_isFootprintEditor && boardItem->Type() != PCB_MARKER_T )
                    {
                        if( FOOTPRINT* parentFP = board->GetFirstFootprint() )
                        {
                            parentFP->Remove( boardItem );
                            connectivity->Remove( boardItem );
                        }
                    }
                    else if( FOOTPRINT* parentFP = boardItem->GetParentFootprint() )
                    {
                        parentFP->Remove( boardItem );
                        connectivity->Remove( boardItem );
                    }
                    else
                    {
                        board->Remove( boardItem, REMOVE_MODE::BULK );
                        bulkRemovedItems.push_back( boardItem );
                    }
                }
 
                break;
 
            case PCB_MARKER_T:
                if( view )
                    view->Remove( boardItem );
 
                if( !( changeFlags & CHT_DONE ) )
                {
                    // Markers are always stored at the board level, even in the footprint editor
                    board->Remove( boardItem, REMOVE_MODE::BULK );
                    bulkRemovedItems.push_back( boardItem );
                }
 
                break;
 
            // No-geometry items: never in the view, so skip view->Remove.
            case PCB_CONSTRAINT_T:
                if( !( changeFlags & CHT_DONE ) )
                {
                    if( m_isFootprintEditor )
                    {
                        if( FOOTPRINT* parentFP = board->GetFirstFootprint() )
                            parentFP->Remove( boardItem );
                    }
                    else if( FOOTPRINT* parentFP = boardItem->GetParentFootprint() )
                    {
                        parentFP->Remove( boardItem );
                    }
                    else
                    {
                        board->Remove( boardItem, REMOVE_MODE::BULK );
                        bulkRemovedItems.push_back( boardItem );
                    }
                }
 
                break;
 
            // Metadata items
            case PCB_NETINFO_T:
                board->Remove( boardItem, REMOVE_MODE::BULK );
                bulkRemovedItems.push_back( boardItem );
                break;
 
            default:                // other types do not need to (or should not) be handled
                wxASSERT( false );
                break;
            }
 
            // Removed items are owned by undo/redo, but a hidden field still belongs to its footprint
            if( boardItem->Type() != PCB_FIELD_T )
                boardItem->SetFlags( UR_TRANSIENT );
 
            break;
        }
 
        case CHT_MODIFY:
        {
            BOARD_ITEM* boardItemCopy = static_cast<BOARD_ITEM*>( entry.m_copy );
 
            if( !( aCommitFlags & SKIP_UNDO ) )
            {
                ITEM_PICKER itemWrapper( nullptr, boardItem, UNDO_REDO::CHANGED );
                itemWrapper.SetLink( entry.m_copy );
                entry.m_copy = nullptr;   // We've transferred ownership to the undo list
                undoList.PushItem( itemWrapper );
            }
 
            if( !( aCommitFlags & SKIP_CONNECTIVITY ) && !isNoGeometryItem( boardItem ) )
            {
                connectivity->MarkItemNetAsDirty( boardItemCopy );
                connectivity->Update( boardItem );
            }
 
            if( boardItem->Type() != PCB_MARKER_T )
            {
                propagateDamage( boardItemCopy, staleZones, staleRuleAreas );   // before
                propagateDamage( boardItem, staleZones, staleRuleAreas );       // after
            }
 
            updateComponentClasses( boardItem );
 
            if( view && !isNoGeometryItem( boardItem ) )
                view->Update( boardItem );
 
            itemsChanged.push_back( boardItem );
            break;
        }
 
        default:
            UNIMPLEMENTED_FOR( boardItem->GetClass() );
            break;
        }
 
        // Delete any copies we still have ownership of
        delete entry.m_copy;
        entry.m_copy = nullptr;
 
        boardItem->ClearEditFlags();
        boardItem->RunOnChildren(
                [&]( BOARD_ITEM* item )
                {
                    item->ClearEditFlags();
                },
                RECURSE_MODE::RECURSE );
    } // ... and regenerate them.
 
    // Deselection above keys off the SELECTED flag on the removed item itself, but the selection
    // may separately hold an owned descendant such as a pad, field or table cell.  Descendants
    // are freed along with the removed parent, so prune them here or the selection keeps a
    // dangling pointer that the next repaint dereferences.
    if( selTool && !removedItems.empty() )
    {
        for( EDA_ITEM* selectedItem : selTool->GetSelection().GetItems() )
        {
            for( EDA_ITEM* ancestor = selectedItem; ancestor; ancestor = ancestor->GetParent() )
            {
                if( removedItems.count( ancestor ) )
                {
                    selTool->RemoveItemFromSel( selectedItem, true /* quiet mode */ );
                    itemsDeselected = true;
                    break;
                }
            }
        }
    }
 
    // Invalidate component classes
    board->GetComponentClassManager().InvalidateComponentClasses();
 
    if( m_isBoardEditor )
    {
        size_t originalCount = m_entries.size();
 
        if( aCommitFlags & SKIP_CONNECTIVITY )
        {
            connectivity->ClearRatsnest();
            connectivity->ClearLocalRatsnest();
        }
        else
        {
            connectivity->RecalculateRatsnest( this );
            board->UpdateRatsnestExclusions();
            connectivity->ClearLocalRatsnest();
 
            if( frame )
                frame->GetCanvas()->RedrawRatsnest();
 
            board->OnRatsnestChanged();
        }
 
        if( solderMaskDirty )
        {
            if( frame )
                frame->HideSolderMask();
        }
 
        if( updateBoardBoundingBox && view )
        {
            if( PCB_BOARD_OUTLINE* outline = board->BoardOutline() )
            {
                board->UpdateBoardOutline();
 
                if( view->HasItem( outline ) )
                    view->Update( outline );
                else
                    view->Add( outline );
             }
 
            RefreshDrillMapOutlines( *board, view );
        }
 
        if( PCBNEW_SETTINGS* cfg = GetAppSettings<PCBNEW_SETTINGS>( "pcbnew" ) )
        {
            if( !staleRuleAreas.empty() && (   cfg->m_Display.m_TrackClearance == SHOW_WITH_VIA_ALWAYS
                                            || cfg->m_Display.m_PadClearance ) )
            {
                if( view )
                    view->UpdateCollidingItems( staleRuleAreas, { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T, PCB_PAD_T } );
            }
        }
 
        if( !staleTeardropPadsAndVias.empty() || !staleTeardropTracks.empty() )
        {
            teardropMgr.UpdateTeardrops( *this, &staleTeardropPadsAndVias, &staleTeardropTracks );
 
            // UpdateTeardrops() can modify the ratsnest data. So rebuild this ratsnest data
            connectivity->RecalculateRatsnest( this );
        }
 
        // Log undo items for any connectivity or teardrop changes
        for( size_t i = originalCount; i < m_entries.size(); ++i )
        {
            COMMIT_LINE& entry = m_entries[i];
            BOARD_ITEM*  boardItem = nullptr;
            BOARD_ITEM*  boardItemCopy = nullptr;
 
            if( entry.m_item && entry.m_item->IsBOARD_ITEM() )
                boardItem = static_cast<BOARD_ITEM*>( entry.m_item );
 
            if( entry.m_copy && entry.m_copy->IsBOARD_ITEM() )
                boardItemCopy = static_cast<BOARD_ITEM*>( entry.m_copy );
 
            wxCHECK2( boardItem, continue );
 
            if( !( aCommitFlags & SKIP_UNDO ) )
            {
                ITEM_PICKER itemWrapper( nullptr, boardItem, convert( entry.m_type & CHT_TYPE ) );
                itemWrapper.SetLink( boardItemCopy );
                undoList.PushItem( itemWrapper );
            }
            else
            {
                delete entry.m_copy;
            }
 
            if( view && !isNoGeometryItem( boardItem ) )
            {
                if( ( entry.m_type & CHT_TYPE ) == CHT_ADD )
                    view->Add( boardItem );
                else if( ( entry.m_type & CHT_TYPE ) == CHT_REMOVE )
                    view->Remove( boardItem );
                else
                    view->Update( boardItem );
            }
        }
    }
 
    if( bulkAddedItems.size() > 0 || bulkRemovedItems.size() > 0 || itemsChanged.size() > 0 )
        board->OnItemsCompositeUpdate( bulkAddedItems, bulkRemovedItems, itemsChanged );
 
    // A shrinking table deletes the cells past its new end and the selection holds those
    // cells directly, so it has to be resolved again from what is still on the board
    if( containsDrillChart && selTool )
        selTool->RebuildSelection();
 
    if( frame )
    {
        if( !( aCommitFlags & SKIP_UNDO ) )
        {
            if( aCommitFlags & APPEND_UNDO )
                frame->AppendCopyToUndoList( undoList, UNDO_REDO::UNSPECIFIED );
            else
                frame->SaveCopyInUndoList( undoList, UNDO_REDO::UNSPECIFIED );
        }
    }
 
    m_toolMgr->PostEvent( { TC_MESSAGE, TA_MODEL_CHANGE, AS_GLOBAL } );
 
    if( itemsDeselected )
        m_toolMgr->PostEvent( EVENTS::UnselectedEvent );
 
    if( autofillZones )
    {
        ZONE_FILLER_TOOL* zoneFillerTool = m_toolMgr->GetTool<ZONE_FILLER_TOOL>();
 
        for( ZONE* zone : *staleZones )
            zoneFillerTool->DirtyZone( zone );
 
        m_toolMgr->PostAction( PCB_ACTIONS::zoneFillDirty );
    }
 
    // Rehatching only refreshes cached view geometry (consumers regenerate it lazily), and
    // dispatching it headlessly makes the tool manager query the platform cursor position
    if( view )
        m_toolMgr->PostAction( PCB_ACTIONS::rehatchShapes );
 
    if( selectedModified )
        m_toolMgr->ProcessEvent( EVENTS::SelectedItemsModified );
 
    if( frame )
    {
        if( !( aCommitFlags & SKIP_SET_DIRTY ) )
            frame->OnModify();
        else
            frame->Update3DView( true, frame->GetPcbNewSettings()->m_Display.m_Live3DRefresh );
 
        // Ensure the message panel is updated after committing changes.
        // By default (i.e. if no event posted), display the updated board info
        if( !itemsDeselected && !autofillZones && !selectedModified )
        {
            std::vector<MSG_PANEL_ITEM> msg_list;
            board->GetMsgPanelInfo( frame, msg_list );
            frame->SetMsgPanel( msg_list );
        }
    }
 
    if( containsDrillMap && frame )
        frame->RefreshDrillSymbols( KIGFX::LAYERS | KIGFX::GEOMETRY | KIGFX::REPAINT );
 
    clear();
}
 
 
EDA_ITEM* BOARD_COMMIT::undoLevelItem( EDA_ITEM* aItem ) const
{
    // Easiest way to disallow both a parent and one of its children appearing in the list
    // is to only ever add the parent when either can be legal (ie: in the board editor).
    if( m_isBoardEditor && aItem->IsBOARD_ITEM() )
    {
        if( FOOTPRINT* footprint = static_cast<BOARD_ITEM*>( aItem )->GetParentFootprint() )
            return footprint;
    }
 
    EDA_ITEM* parent = aItem->GetParent();
 
    if( parent && BaseType( parent->Type() ) == PCB_TABLE_T )
        return parent;
 
    return aItem;
}
 
 
EDA_ITEM* BOARD_COMMIT::makeImage( EDA_ITEM* aItem ) const
{
    return MakeImage( aItem );
}
 
 
EDA_ITEM* BOARD_COMMIT::MakeImage( EDA_ITEM* aItem )
{
    EDA_ITEM* clone = aItem->Clone();
    clone->SetFlags( UR_TRANSIENT );
 
    return clone;
}
 
 
void BOARD_COMMIT::Revert()
{
    RevertToCheckpoint( 0 );
}
 
 
void BOARD_COMMIT::RevertToCheckpoint( int aCheckpoint )
{
    PICKED_ITEMS_LIST                  undoList;
    KIGFX::VIEW*                       view = m_toolMgr->GetView();   // null in headless sessions
    BOARD*                             board = (BOARD*) m_toolMgr->GetModel();
    std::shared_ptr<CONNECTIVITY_DATA> connectivity = board->GetConnectivity();
 
    board->IncrementTimeStamp();   // clear caches
 
    auto updateComponentClasses =
            [this]( BOARD_ITEM* boardItem )
            {
                if( boardItem->Type() != PCB_FOOTPRINT_T )
                    return;
 
                FOOTPRINT* footprint = static_cast<FOOTPRINT*>( boardItem );
                GetBoard()->GetComponentClassManager().RebuildRequiredCaches( footprint );
            };
 
    std::vector<BOARD_ITEM*> bulkAddedItems;
    std::vector<BOARD_ITEM*> bulkRemovedItems;
    std::vector<BOARD_ITEM*> itemsChanged;
    std::vector<BOARD_ITEM*> itemsToDelete;
    bool                     containsDrillMap = false;
 
    for( int ii = aCheckpoint; ii < (int) m_entries.size(); ++ii )
    {
        COMMIT_LINE& entry = m_entries[ii];
 
        if( !entry.m_item || !entry.m_item->IsBOARD_ITEM() )
            continue;
 
        BOARD_ITEM*  boardItem = static_cast<BOARD_ITEM*>( entry.m_item );
        int          changeType = entry.m_type & CHT_TYPE;
        int          changeFlags = entry.m_type & CHT_FLAGS;
 
        if( boardItem->Type() == PCB_DRILL_CHART_T || boardItem->Type() == PCB_DRILL_MAP_T )
        {
            containsDrillMap |= boardItem->Type() == PCB_DRILL_MAP_T;
        }
 
        switch( changeType )
        {
        case CHT_ADD:
            if( changeFlags & CHT_DONE )
            {
                if( view && !isNoGeometryItem( boardItem ) )
                    view->Remove( boardItem );
 
                connectivity->Remove( boardItem );
 
                if( m_isFootprintEditor )
                {
                    if( FOOTPRINT* parentFP = board->GetFirstFootprint() )
                        parentFP->Remove( boardItem );
                }
                else if( FOOTPRINT* parentFP = boardItem->GetParentFootprint() )
                {
                    parentFP->Remove( boardItem );
                }
                else
                {
                    board->Remove( boardItem, REMOVE_MODE::BULK );
                    bulkRemovedItems.push_back( boardItem );
                }
            }
 
            if( PCB_GROUP* group = dynamic_cast<PCB_GROUP*>( boardItem ) )
                group->RemoveAll();
 
            // Defer deletion until after OnItemsCompositeUpdate so that
            // board listeners do not receive dangling pointers.
            itemsToDelete.push_back( boardItem );
            entry.m_item = nullptr;
            continue;
 
        case CHT_REMOVE:
        {
            if( !( changeFlags & CHT_DONE ) )
                break;
 
            if( view && !isNoGeometryItem( boardItem ) )
                view->Add( boardItem );
 
            if( m_isFootprintEditor )
            {
                if( FOOTPRINT* parentFP = board->GetFirstFootprint() )
                {
                    parentFP->Add( boardItem, ADD_MODE::INSERT );
                    connectivity->Add( boardItem );
                }
            }
            else if( FOOTPRINT* parentFP = boardItem->GetParentFootprint() )
            {
                parentFP->Add( boardItem, ADD_MODE::INSERT );
                connectivity->Add( boardItem );
            }
            else
            {
                board->Add( boardItem, ADD_MODE::INSERT );
                bulkAddedItems.push_back( boardItem );
            }
 
            updateComponentClasses( boardItem );
            break;
        }
 
        case CHT_MODIFY:
        {
            if( view && !isNoGeometryItem( boardItem ) )
                view->Remove( boardItem );
 
            connectivity->Remove( boardItem );
 
            wxASSERT( entry.m_copy && entry.m_copy->IsBOARD_ITEM() );
            BOARD_ITEM* boardItemCopy = static_cast<BOARD_ITEM*>( entry.m_copy );
            boardItem->SwapItemData( boardItemCopy );
 
            if( view && !isNoGeometryItem( boardItem ) )
                view->Add( boardItem );
 
            connectivity->Add( boardItem );
            itemsChanged.push_back( boardItem );
 
            updateComponentClasses( boardItem );
            break;
        }
 
        default:
            UNIMPLEMENTED_FOR( boardItem->GetClass() );
            break;
        }
 
        // Delete any copies we still have ownership of
        delete entry.m_copy;
        entry.m_copy = nullptr;
 
        boardItem->ClearEditFlags();
    }
 
    // Invalidate component classes
    board->GetComponentClassManager().InvalidateComponentClasses();
 
    if( bulkAddedItems.size() > 0 || bulkRemovedItems.size() > 0 || itemsChanged.size() > 0 )
        board->OnItemsCompositeUpdate( bulkAddedItems, bulkRemovedItems, itemsChanged );
 
    if( m_isBoardEditor )
    {
        for( BOARD_ITEM* item : itemsToDelete )
            connectivity->Remove( item );
    }
 
    for( BOARD_ITEM* item : itemsToDelete )
        delete item;
 
    if( m_isBoardEditor )
    {
        connectivity->RecalculateRatsnest();
        board->UpdateRatsnestExclusions();
        board->OnRatsnestChanged();
    }
 
    if( PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>() )
        selTool->RebuildSelection();
 
    // Property panel needs to know about the reselect
    m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 
    if( containsDrillMap )
    {
        if( PCB_BASE_FRAME* frame = dynamic_cast<PCB_BASE_FRAME*>( m_toolMgr->GetToolHolder() ) )
        {
            frame->RefreshDrillSymbols( KIGFX::LAYERS | KIGFX::GEOMETRY | KIGFX::REPAINT );
        }
    }
 
    m_entries.erase( m_entries.begin() + aCheckpoint, m_entries.end() );
}
 
 
EDA_ITEM* BOARD_COMMIT::ResolveItem( KIID& aID )
{
    if( aID == niluuid )
        return nullptr;
 
    for( COMMIT_LINE& entry : m_entries )
    {
        if( entry.m_item && entry.m_item->IsBOARD_ITEM() && entry.m_item->m_Uuid == aID )
            return entry.m_item;
    }
 
    return nullptr;
}