zone_settings_bag.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2023 Ethan Chien <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 "zone_settings_bag.h"
 
#include <zone.h>
#include <memory>
#include <algorithm>
 
 
ZONE_SETTINGS_BAG::ZONE_SETTINGS_BAG( BOARD* aBoard )
{
    for( ZONE* zone : aBoard->Zones() )
    {
        if( !zone->GetIsRuleArea() && !zone->IsTeardropArea() && !zone->IsCopperThieving()
                && zone->IsOnCopperLayer() )
        {
            auto zone_clone = std::shared_ptr<ZONE>( static_cast<ZONE*>( zone->Clone() ) );
            m_zonesCloneMap.try_emplace( zone, zone_clone );
            m_clonedZoneList.push_back( zone_clone.get() );
        }
    }
 
    for( ZONE* zone : m_clonedZoneList )
    {
        m_zoneSettings[zone] = std::make_shared<ZONE_SETTINGS>();
        *m_zoneSettings[zone] << *zone;
    }
 
    std::vector<ZONE*> sortedClonedZones = m_clonedZoneList;
 
    std::sort( sortedClonedZones.begin(), sortedClonedZones.end(),
               []( ZONE* const& l, ZONE* const& r )
               {
                   return l->HigherPriority( r );
               } );
 
    unsigned currentPriority = sortedClonedZones.size() - 1;
 
    for( ZONE* zone : sortedClonedZones )
    {
        m_zonePriorities[zone] = std::make_pair<>( currentPriority, currentPriority );
        --currentPriority;
    }
}
 
 
ZONE_SETTINGS_BAG::ZONE_SETTINGS_BAG( ZONE* aZone, ZONE_SETTINGS* aSettings )
{
    m_zoneSettings[aZone] = std::make_shared<ZONE_SETTINGS>( *aSettings );
}
 
 
std::shared_ptr<ZONE_SETTINGS> ZONE_SETTINGS_BAG::GetZoneSettings( ZONE* aZone )
{
    return m_zoneSettings[aZone];
}
 
 
unsigned ZONE_SETTINGS_BAG::GetZonePriority( ZONE* aZone )
{
    return m_zonePriorities[aZone].second;
}
 
 
void ZONE_SETTINGS_BAG::SwapPriority( ZONE* aZone, ZONE* otherZone )
{
    std::swap( m_zonePriorities[aZone].second, m_zonePriorities[otherZone].second );
}
 
 
wxString ZONE_SETTINGS_BAG::GetUniqueZoneName( const BOARD& aBoard, const wxString& aBaseName, const ZONE* aZone ) const
{
    auto inUse = [&]( const wxString& aName )
    {
        for( ZONE* zone : aBoard.Zones() )
        {
            ZONE* working = zone;
 
            if( auto clone = m_zonesCloneMap.find( zone ); clone != m_zonesCloneMap.end() )
                working = clone->second.get();
 
            if( working == aZone )
                continue;
 
            auto     settings = m_zoneSettings.find( working );
            wxString name = working->GetZoneName();
 
            if( settings != m_zoneSettings.end() && settings->second )
                name = settings->second->m_Name;
 
            if( name == aName )
                return true;
        }
 
        return false;
    };
 
    return BOARD::MakeUniqueZoneName( aBaseName, inUse );
}
 
 
void ZONE_SETTINGS_BAG::SetZonePriority( ZONE* aClone, unsigned aPriority )
{
    m_zonePriorities[aClone].second = aPriority;
 
    if( m_zoneSettings.contains( aClone ) )
        m_zoneSettings[aClone]->m_ZonePriority = aPriority;
}
 
 
void ZONE_SETTINGS_BAG::RemoveZone( ZONE* aOriginalZone )
{
    auto it = m_zonesCloneMap.find( aOriginalZone );
 
    if( it != m_zonesCloneMap.end() )
    {
        ZONE* clone = it->second.get();
 
        // Remove from cloned list
        m_clonedZoneList.erase( std::remove( m_clonedZoneList.begin(), m_clonedZoneList.end(), clone ),
                                m_clonedZoneList.end() );
 
 
        // Remove from zone settings and priorities maps
        m_zoneSettings.erase( clone );
        m_zonePriorities.erase( clone );
 
        // Remove from clone map
        m_zonesCloneMap.erase( it );
    }
}
 
 
void ZONE_SETTINGS_BAG::UpdateClonedZones()
{
    for( ZONE* zone : m_clonedZoneList )
    {
        if( m_zoneSettings.contains( zone ) )
            m_zoneSettings[zone]->ExportSetting( *zone );
    }
 
    // Prevent version-control churn by not updating potentially sparse priorities if their
    // order didn't change.
    bool priorityChanged = false;
 
    for( ZONE* zone : m_clonedZoneList )
    {
        if( m_zonePriorities[zone].first != m_zonePriorities[zone].second )
        {
            priorityChanged = true;
            break;
        }
    }
 
    if( priorityChanged )
    {
        for( ZONE* zone : m_clonedZoneList )
            zone->SetAssignedPriority( m_zonePriorities[zone].second );
    }
}