Don't leave Zones with "dead" nets.

When reading netlist or updating board from schematic, if the
changes leave a zone with a net with no pads then change the
zone's net to the new net of one of it's connections.

Also improves update-board-from-schematic's dry run reporting
to include zone nets and single-pad nets.

Fixes: lp:1609401
* https://bugs.launchpad.net/kicad/+bug/1609401

pcbnew/board_netlist_updater.cpp

@@ -71,6 +71,23 @@ BOARD_NETLIST_UPDATER::~BOARD_NETLIST_UPDATER()
 }
 
 
+// These functions allow inspection of pad nets during dry runs by keeping a cache of
+// current pad netnames indexed by pad.
+
+void BOARD_NETLIST_UPDATER::cacheNetname( D_PAD* aPad, const wxString& aNetname )
+{
+    m_padNets[ aPad ] = aNetname;
+}
+
+wxString BOARD_NETLIST_UPDATER::getNetname( D_PAD* aPad )
+{
+    if( m_isDryRun && m_padNets.count( aPad ) )
+        return m_padNets[ aPad ];
+    else
+        return aPad->GetNetname();
+}
+
+
 wxPoint BOARD_NETLIST_UPDATER::estimateComponentInsertionPosition()
 {
     wxPoint bestPosition;
@@ -344,6 +361,8 @@ bool BOARD_NETLIST_UPDATER::updateComponentPadConnections( MODULE* aPcbComponent
                 changed = true;
                 pad->SetNetCode( NETINFO_LIST::UNCONNECTED );
             }
+            else
+                cacheNetname( pad, wxEmptyString );
         }
         else                                 // New footprint pad has a net.
         {
@@ -355,10 +374,8 @@ bool BOARD_NETLIST_UPDATER::updateComponentPadConnections( MODULE* aPcbComponent
                 if( netinfo == nullptr )
                 {
                     // It might be a new net that has not been added to the board yet
-                    auto netIt = m_addedNets.find( netName );
+                    if( m_addedNets.count( netName ) )
-
+                        netinfo = m_addedNets[ netName ];
-                    if( netIt != m_addedNets.end() )
-                        netinfo = netIt->second;
                 }
 
                 if( netinfo == nullptr )
@@ -407,6 +424,8 @@ bool BOARD_NETLIST_UPDATER::updateComponentPadConnections( MODULE* aPcbComponent
                     changed = true;
                     pad->SetNet( netinfo );
                 }
+                else
+                    cacheNetname( pad, netName );
             }
         }
     }
@@ -420,6 +439,97 @@ bool BOARD_NETLIST_UPDATER::updateComponentPadConnections( MODULE* aPcbComponent
 }
 
 
+void BOARD_NETLIST_UPDATER::cacheCopperZoneConnections()
+{
+    for( int ii = 0; ii < m_board->GetAreaCount(); ii++ )
+    {
+        ZONE_CONTAINER* zone = m_board->GetArea( ii );
+
+        if( !zone->IsOnCopperLayer() || zone->GetIsKeepout() )
+            continue;
+
+        m_zoneConnectionsCache[ zone ] = m_board->GetConnectivity()->GetConnectedPads( zone );
+    }
+}
+
+
+bool BOARD_NETLIST_UPDATER::updateCopperZoneNets( NETLIST& aNetlist )
+{
+    wxString msg;
+    std::set<wxString> netlistNetnames;
+
+    for( int ii = 0; ii < (int) aNetlist.GetCount(); ii++ )
+    {
+        const COMPONENT* component = aNetlist.GetComponent( ii );
+        for( unsigned jj = 0; jj < component->GetNetCount(); jj++ )
+        {
+            const COMPONENT_NET& net = component->GetNet( jj );
+            netlistNetnames.insert( net.GetNetName() );
+        }
+    }
+
+    // Test copper zones to detect "dead" nets (nets without any pad):
+    for( int i = 0; i < m_board->GetAreaCount(); i++ )
+    {
+        ZONE_CONTAINER* zone = m_board->GetArea( i );
+
+        if( !zone->IsOnCopperLayer() || zone->GetIsKeepout() )
+            continue;
+
+        if( netlistNetnames.count( zone->GetNetname() ) == 0 )
+        {
+            // Look for a pad in the zone's connected-pad-cache which has been updated to
+            // a new net and use that. While this won't always be the right net, the dead
+            // net is guaranteed to be wrong.
+            wxString updatedNetname = wxEmptyString;
+
+            for( D_PAD* pad : m_zoneConnectionsCache[ zone ] )
+            {
+                if( getNetname( pad ) != zone->GetNetname() )
+                {
+                    updatedNetname = getNetname( pad );
+                    break;
+                }
+            }
+
+            if( !updatedNetname.IsEmpty() )
+            {
+                msg.Printf( _( "Reconnect copper zone from net \"%s\" to net \"%s\"." ),
+                            zone->GetNetname(), updatedNetname );
+                m_reporter->Report( msg, REPORTER::RPT_ACTION );
+
+                msg.Printf( _( "Changing copper zone net name from \"%s\" to \"%s\"." ),
+                            zone->GetNetname(), updatedNetname );
+                m_reporter->Report( msg, REPORTER::RPT_INFO );
+
+                if( !m_isDryRun )
+                {
+                    NETINFO_ITEM* netinfo = m_board->FindNet( updatedNetname );
+
+                    if( !netinfo )
+                        netinfo = m_addedNets[ updatedNetname ];
+
+                    if( netinfo )
+                    {
+                        m_commit.Modify( zone );
+                        zone->SetNet( netinfo );
+                    }
+                }
+            }
+            else
+            {
+                msg.Printf( _( "Copper zone (net \"%s\") has no pads connected." ),
+                            zone->GetNetname() );
+                m_reporter->Report( msg, REPORTER::RPT_WARNING );
+                ++m_warningCount;
+            }
+        }
+    }
+
+    return true;
+}
+
+
 bool BOARD_NETLIST_UPDATER::deleteUnusedComponents( NETLIST& aNetlist )
 {
     wxString msg;
@@ -467,28 +577,32 @@ bool BOARD_NETLIST_UPDATER::deleteSinglePadNets()
 {
     int         count = 0;
     wxString    netname;
-    wxString msg;
+    wxString    msg;
     D_PAD*      pad = NULL;
     D_PAD*      previouspad = NULL;
 
-    // We need the pad list, for next tests.
+    // We need the pad list for next tests.
-    // padlist is the list of pads, sorted by netname.
 
     m_board->BuildListOfNets();
 
-    if( m_isDryRun )
-        return false;
-
     std::vector<D_PAD*> padlist = m_board->GetPads();
 
+    if( m_isDryRun )
+    {
+        // During a dry run changes are only stored in the m_padNets cache, so we must sort
+        // the list ourselves.
+        std::sort( padlist.begin(), padlist.end(),
+            [ this ]( D_PAD* a, D_PAD* b ) -> bool { return getNetname( a ) < getNetname( b ); } );
+    }
+
     for( unsigned kk = 0; kk < padlist.size(); kk++ )
     {
         pad = padlist[kk];
 
-        if( pad->GetNetname().IsEmpty() )
+        if( getNetname( pad ).IsEmpty() )
-                continue;
+            continue;
 
-        if( netname != pad->GetNetname() )  // End of net
+        if( netname != getNetname( pad ) )  // End of net
         {
             if( previouspad && count == 1 )
             {
@@ -505,7 +619,7 @@ bool BOARD_NETLIST_UPDATER::deleteSinglePadNets()
                     if( zone->GetIsKeepout() )
                         continue;
 
-                    if( zone->GetNet() == previouspad->GetNet() )
+                    if( zone->GetNetname() == getNetname( previouspad ) )
                     {
                         count++;
                         break;
@@ -515,20 +629,23 @@ bool BOARD_NETLIST_UPDATER::deleteSinglePadNets()
                 if( count == 1 )    // Really one pad, and nothing else
                 {
                     msg.Printf( _( "Remove single pad net %s." ),
-                                GetChars( previouspad->GetNetname() ) );
+                                GetChars( getNetname( previouspad ) ) );
                     m_reporter->Report( msg, REPORTER::RPT_ACTION );
 
                     msg.Printf( _( "Remove single pad net \"%s\" on \"%s\" pad \"%s\"\n" ),
-                                GetChars( previouspad->GetNetname() ),
+                                GetChars( getNetname( previouspad ) ),
                                 GetChars( previouspad->GetParent()->GetReference() ),
                                 GetChars( previouspad->GetName() ) );
                     m_reporter->Report( msg, REPORTER::RPT_ACTION );
 
-                    previouspad->SetNetCode( NETINFO_LIST::UNCONNECTED );
+                    if( !m_isDryRun )
+                        previouspad->SetNetCode( NETINFO_LIST::UNCONNECTED );
+                    else
+                        cacheNetname( previouspad, wxEmptyString );
                 }
             }
 
-            netname = pad->GetNetname();
+            netname = getNetname( pad );
             count = 1;
         }
         else
@@ -541,7 +658,12 @@ bool BOARD_NETLIST_UPDATER::deleteSinglePadNets()
 
     // Examine last pad
     if( pad && count == 1 )
-        pad->SetNetCode( NETINFO_LIST::UNCONNECTED );
+    {
+        if( !m_isDryRun )
+            pad->SetNetCode( NETINFO_LIST::UNCONNECTED );
+        else
+            cacheNetname( pad, wxEmptyString );
+    }
 
     return true;
 }
@@ -549,15 +671,10 @@ bool BOARD_NETLIST_UPDATER::deleteSinglePadNets()
 
 bool BOARD_NETLIST_UPDATER::testConnectivity( NETLIST& aNetlist )
 {
-    // Last step: Some tests:
+    // Verify that board contains all pads in netlist: if it doesn't then footprints are
-    // verify all pads found in netlist:
+    // wrong or missing.
-    // They should exist in footprints, otherwise the footprint is wrong
+    // Note that we use references to find the footprints as they're already updated by this
-    // note also references or time stamps are updated, so we use only
+    // point (whether by-reference or by-timestamp).
-    // the reference to find a footprint
-    //
-    // Also verify if zones have acceptable nets, i.e. nets with pads.
-    // Zone with no pad belongs to a "dead" net which happens after changes in schematic
-    // when no more pad use this net name.
 
     wxString msg;
     wxString padname;
@@ -589,25 +706,6 @@ bool BOARD_NETLIST_UPDATER::testConnectivity( NETLIST& aNetlist )
         }
     }
 
-    // Test copper zones to detect "dead" nets (nets without any pad):
-    for( int i = 0; i < m_board->GetAreaCount(); i++ )
-    {
-        ZONE_CONTAINER* zone = m_board->GetArea( i );
-
-        if( !zone->IsOnCopperLayer() || zone->GetIsKeepout() )
-            continue;
-
-        int nc = m_board->GetConnectivity()->GetPadCount( zone->GetNetCode() );
-
-        if( nc == 0 )
-        {
-            msg.Printf( _( "Copper zone (net name \"%s\"): net has no pads connected." ),
-                        GetChars( zone->GetNet()->GetNetname() ) );
-            m_reporter->Report( msg, REPORTER::RPT_WARNING );
-            ++m_warningCount;
-        }
-    }
-
     return true;
 }
 
@@ -618,6 +716,8 @@ bool BOARD_NETLIST_UPDATER::UpdateNetlist( NETLIST& aNetlist )
     m_errorCount = 0;
     m_warningCount = 0;
 
+    cacheCopperZoneConnections();
+
     if( !m_isDryRun )
     {
         m_board->SetStatus( 0 );
@@ -658,7 +758,7 @@ bool BOARD_NETLIST_UPDATER::UpdateNetlist( NETLIST& aNetlist )
         }
     }
 
-    //aNetlist.GetDeleteExtraFootprints()
+    updateCopperZoneNets( aNetlist );
 
     if( m_deleteUnusedComponents )
         deleteUnusedComponents( aNetlist );

pcbnew/board_netlist_updater.h

@@ -129,11 +129,16 @@ public:
     }
 
 private:
+    void cacheNetname( D_PAD* aPad, const wxString& aNetname );
+    wxString getNetname( D_PAD* aPad );
+
     wxPoint estimateComponentInsertionPosition();
     MODULE* addNewComponent( COMPONENT* aComponent );
     MODULE* replaceComponent( NETLIST& aNetlist, MODULE* aPcbComponent, COMPONENT* aNewComponent );
     bool updateComponentParameters( MODULE* aPcbComponent, COMPONENT* aNewComponent );
     bool updateComponentPadConnections( MODULE* aPcbComponent, COMPONENT* aNewComponent );
+    void cacheCopperZoneConnections();
+    bool updateCopperZoneNets( NETLIST& aNetlist );
     bool deleteUnusedComponents( NETLIST& aNetlist );
     bool deleteSinglePadNets();
     bool testConnectivity( NETLIST& aNetlist );
@@ -142,6 +147,8 @@ private:
     BOARD* m_board;
     REPORTER* m_reporter;
 
+    std::map< ZONE_CONTAINER*, std::vector<D_PAD*> > m_zoneConnectionsCache;
+    std::map< D_PAD*, wxString > m_padNets;
     std::vector<MODULE*> m_addedComponents;
     std::map<wxString, NETINFO_ITEM*> m_addedNets;
 

pcbnew/class_board.cpp

@@ -2392,6 +2392,17 @@ void BOARD::ReplaceNetlist( NETLIST& aNetlist, bool aDeleteSinglePadNets,
     wxPoint        bestPosition;
     wxString       msg;
     std::vector<MODULE*> newFootprints;
+    std::map< ZONE_CONTAINER*, std::vector<D_PAD*> > zoneConnectionsCache;
+
+    for( int ii = 0; ii < GetAreaCount(); ii++ )
+    {
+        ZONE_CONTAINER* zone = GetArea( ii );
+
+        if( !zone->IsOnCopperLayer() || zone->GetIsKeepout() )
+            continue;
+
+        zoneConnectionsCache[ zone ] = m_connectivity->GetConnectedPads( zone );
+    }
 
     if( !IsEmpty() )
     {
@@ -2475,8 +2486,7 @@ void BOARD::ReplaceNetlist( NETLIST& aNetlist, bool aDeleteSinglePadNets,
         else                           // An existing footprint.
         {
             // Test for footprint change.
-            if( !component->GetFPID().empty() &&
+            if( !component->GetFPID().empty() && footprint->GetFPID() != component->GetFPID() )
-                footprint->GetFPID() != component->GetFPID() )
             {
                 if( aNetlist.GetReplaceFootprints() )
                 {
@@ -2756,15 +2766,10 @@ void BOARD::ReplaceNetlist( NETLIST& aNetlist, bool aDeleteSinglePadNets,
         }
     }
 
-    // Last step: Some tests:
+    // Verify that board contains all pads in netlist: if it doesn't then footprints are
-    // verify all pads found in netlist:
+    // wrong or missing.
-    // They should exist in footprints, otherwise the footprint is wrong
+    // Note that we use references to find the footprints as they're already updated by this
-    // note also references or time stamps are updated, so we use only
+    // point (whether by-reference or by-timestamp).
-    // the reference to find a footprint
-    //
-    // Also verify if zones have acceptable nets, i.e. nets with pads.
-    // Zone with no pad belongs to a "dead" net which happens after changes in schematic
-    // when no more pad use this net name.
     if( aReporter )
     {
         wxString padname;
@@ -2793,20 +2798,53 @@ void BOARD::ReplaceNetlist( NETLIST& aNetlist, bool aDeleteSinglePadNets,
                 aReporter->Report( msg, REPORTER::RPT_ERROR );
             }
         }
+    }
 
-        // Test copper zones to detect "dead" nets (nets without any pad):
+    // Test copper zones to detect "dead" nets (nets without any pad):
-        for( int ii = 0; ii < GetAreaCount(); ii++ )
+    for( int ii = 0; ii < GetAreaCount(); ii++ )
+    {
+        ZONE_CONTAINER* zone = GetArea( ii );
+
+        if( !zone->IsOnCopperLayer() || zone->GetIsKeepout() )
+            continue;
+
+        if( m_connectivity->GetPadCount( zone->GetNetCode() ) == 0 )
         {
-            ZONE_CONTAINER* zone = GetArea( ii );
+            // Look for a pad in the zone's connected-pad-cache which has been updated to
+            // a new net and use that. While this won't always be the right net, the dead
+            // net is guaranteed to be wrong.
+            NETINFO_ITEM* updatedNet = nullptr;
 
-            if( !zone->IsOnCopperLayer() || zone->GetIsKeepout() )
+            for( D_PAD* pad : zoneConnectionsCache[ zone ] )
-                continue;
-
-            if( m_connectivity->GetPadCount( zone->GetNetCode() ) == 0 )
             {
-                msg.Printf( _( "Copper zone (net name \"%s\"): net has no pads connected." ),
+                if( pad->GetNetname() != zone->GetNetname() )
-                           GetChars( zone->GetNet()->GetNetname() ) );
+                {
-                aReporter->Report( msg, REPORTER::RPT_WARNING );
+                    updatedNet = pad->GetNet();
+                    break;
+                }
+            }
+
+            if( aReporter )
+            {
+                if( updatedNet )
+                {
+                    msg.Printf( _( "Updating copper zone (net name \"%s\") to net name \"%s\"." ),
+                                zone->GetNetname(), updatedNet->GetNetname() );
+                    aReporter->Report( msg, REPORTER::RPT_ACTION );
+                }
+                else
+                {
+                    msg.Printf( _( "Copper zone (net name \"%s\") has no pads connected." ),
+                                zone->GetNetname() );
+                    aReporter->Report( msg, REPORTER::RPT_WARNING );
+                }
+            }
+
+            if( updatedNet && !aNetlist.IsDryRun() )
+            {
+                m_connectivity->Remove( zone );
+                zone->SetNet( updatedNet );
+                m_connectivity->Add( zone );
             }
         }
     }

pcbnew/dialogs/dialog_update_pcb.fbp

@@ -372,10 +372,10 @@
                 </object>
                 <object class="sizeritem" expanded="1">
                     <property name="border">5</property>
-                    <property name="flag">wxEXPAND</property>
+                    <property name="flag">wxALL|wxEXPAND</property>
                     <property name="proportion">1</property>
                     <object class="wxBoxSizer" expanded="1">
-                        <property name="minimum_size"></property>
+                        <property name="minimum_size">500,300</property>
                         <property name="name">bLowerSizer</property>
                         <property name="orient">wxVERTICAL</property>
                         <property name="permission">none</property>
@@ -416,7 +416,7 @@
                                 <property name="maximum_size"></property>
                                 <property name="min_size"></property>
                                 <property name="minimize_button">0</property>
-                                <property name="minimum_size">350,200</property>
+                                <property name="minimum_size">-1,-1</property>
                                 <property name="moveable">1</property>
                                 <property name="name">m_messagePanel</property>
                                 <property name="pane_border">1</property>
@@ -463,7 +463,7 @@
                 </object>
                 <object class="sizeritem" expanded="1">
                     <property name="border">5</property>
-                    <property name="flag">wxEXPAND</property>
+                    <property name="flag">wxALL|wxEXPAND</property>
                     <property name="proportion">0</property>
                     <object class="wxFlexGridSizer" expanded="1">
                         <property name="cols">5</property>
@@ -604,7 +604,7 @@
                                 <property name="maximum_size"></property>
                                 <property name="min_size"></property>
                                 <property name="minimize_button">0</property>
-                                <property name="minimum_size"></property>
+                                <property name="minimum_size">140,-1</property>
                                 <property name="moveable">1</property>
                                 <property name="name">m_btnPerformUpdate</property>
                                 <property name="pane_border">1</property>

pcbnew/dialogs/dialog_update_pcb_base.cpp

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version Nov 22 2017)
+// C++ code generated with wxFormBuilder (version Dec 30 2017)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO *NOT* EDIT THIS FILE!
@@ -39,13 +39,12 @@ DIALOG_UPDATE_PCB_BASE::DIALOG_UPDATE_PCB_BASE( wxWindow* parent, wxWindowID id,
 	wxBoxSizer* bLowerSizer;
 	bLowerSizer = new wxBoxSizer( wxVERTICAL );
 	
+	bLowerSizer->SetMinSize( wxSize( 500,300 ) ); 
 	m_messagePanel = new WX_HTML_REPORT_PANEL( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL );
-	m_messagePanel->SetMinSize( wxSize( 350,200 ) );
-	
 	bLowerSizer->Add( m_messagePanel, 1, wxEXPAND | wxALL, 5 );
 	
 	
-	bMainSizer->Add( bLowerSizer, 1, wxEXPAND, 5 );
+	bMainSizer->Add( bLowerSizer, 1, wxALL|wxEXPAND, 5 );
 	
 	wxFlexGridSizer* fgSizer1;
 	fgSizer1 = new wxFlexGridSizer( 1, 5, 0, 0 );
@@ -57,10 +56,12 @@ DIALOG_UPDATE_PCB_BASE::DIALOG_UPDATE_PCB_BASE( wxWindow* parent, wxWindowID id,
 	fgSizer1->Add( m_btnCancel, 1, wxALL|wxALIGN_CENTER_VERTICAL|wxALIGN_RIGHT, 5 );
 	
 	m_btnPerformUpdate = new wxButton( this, wxID_ANY, _("Update PCB"), wxDefaultPosition, wxDefaultSize, 0 );
+	m_btnPerformUpdate->SetMinSize( wxSize( 140,-1 ) );
+	
 	fgSizer1->Add( m_btnPerformUpdate, 0, wxALL|wxALIGN_RIGHT|wxALIGN_CENTER_VERTICAL, 5 );
 	
 	
-	bMainSizer->Add( fgSizer1, 0, wxEXPAND, 5 );
+	bMainSizer->Add( fgSizer1, 0, wxALL|wxEXPAND, 5 );
 	
 	
 	this->SetSizer( bMainSizer );

pcbnew/dialogs/dialog_update_pcb_base.h

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version Nov 22 2017)
+// C++ code generated with wxFormBuilder (version Dec 30 2017)
 // http://www.wxformbuilder.org/
 //
 // PLEASE DO *NOT* EDIT THIS FILE!