generator_tool.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 Alex Shvartzkop <[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 "generator_tool.h"
 
#include <collectors.h>
#include <generators/pcb_tuning_pattern.h>
#include <generators/pcb_via_stack.h>
#include <tool/tool_manager.h>
#include <tools/pcb_selection_tool.h>
#include <tools/pcb_actions.h>
#include <router/router_tool.h>
 
#include <dialog_generators.h>
#include <properties/property.h>
#include <properties/property_mgr.h>
 
 
GENERATOR_TOOL::GENERATOR_TOOL() :
        GENERATOR_TOOL_PNS_PROXY( GENERATOR_TOOL_NAME ),
        m_mgrDialog( nullptr )
{
    m_boardItemListener = PROPERTY_MANAGER::Instance().RegisterListener(
            TYPE_HASH( BOARD_ITEM ),
            [&]( INSPECTABLE* aItem, PROPERTY_BASE* aProperty, COMMIT* aCommit )
            {
                // Special case: propagate lock from generated items to parent generator
 
                BOARD_ITEM* item = dynamic_cast<BOARD_ITEM*>( aItem );
 
                if( item && aProperty->Name() == _HKI( "Locked" ) )
                {
                    if( PCB_GENERATOR* generator = dynamic_cast<PCB_GENERATOR*>( item->GetParentGroup() ) )
                    {
                        if( aCommit->GetStatus( generator ) != CHT_MODIFY )
                            aCommit->Modify( generator );
 
                        // Must set generator to unlocked first or item->IsLocked() will just
                        // return the parent's locked state.
                        generator->SetLocked( false );
                        generator->SetLocked( item->IsLocked() );
                    }
                }
            } );
 
    m_generatorListener = PROPERTY_MANAGER::Instance().RegisterListener(
            TYPE_HASH( PCB_GENERATOR ),
            [&]( INSPECTABLE* aItem, PROPERTY_BASE* aProperty, COMMIT* aCommit )
            {
                // Special case: regenerate generators when their properties change
 
                if( PCB_GENERATOR* generator = dynamic_cast<PCB_GENERATOR*>( aItem ) )
                {
                    BOARD_COMMIT* commit = static_cast<BOARD_COMMIT*>( aCommit );
 
                    generator->EditStart( this, board(), commit );
                    generator->Update( this, board(), commit );
                    generator->EditFinish( this, board(), commit );
                }
            } );
}
 
 
GENERATOR_TOOL::~GENERATOR_TOOL()
{
    // Unregister before the rest of the object tears down so a property
    // change firing mid-destruction cannot dispatch into a half-destroyed
    // listener body.
    m_generatorListener.reset();
    m_boardItemListener.reset();
}
 
 
void GENERATOR_TOOL::Reset( RESET_REASON aReason )
{
    GENERATOR_TOOL_PNS_PROXY::Reset( aReason );
 
    if( aReason != RUN )
        m_selectedTuningPatterns.clear();
}
 
 
bool GENERATOR_TOOL::Init()
{
    auto tuningPatternCondition =
            []( const SELECTION& aSel )
            {
                for( EDA_ITEM* item : aSel )
                {
                    if( PCB_GENERATOR* generator = dynamic_cast<PCB_GENERATOR*>( item ) )
                    {
                        if( generator->GetGeneratorType() == wxS( "tuning_pattern" ) )
                            return true;
                    }
                }
 
                return false;
            };
 
    // Add the generator control menus to relevant other tools
 
    PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 
    if( selTool )
    {
        TOOL_MENU&        toolMenu = selTool->GetToolMenu();
        CONDITIONAL_MENU& menu = toolMenu.GetMenu();
 
        menu.AddItem( PCB_ACTIONS::regenerateAllTuning, tuningPatternCondition, 100 );
    }
 
    ROUTER_TOOL* routerTool = m_toolMgr->GetTool<ROUTER_TOOL>();
 
    if( routerTool )
    {
        TOOL_MENU&        toolMenu = routerTool->GetToolMenu();
        CONDITIONAL_MENU& menu = toolMenu.GetMenu();
 
        menu.AddItem( PCB_ACTIONS::regenerateAllTuning, SELECTION_CONDITIONS::ShowAlways, 100 );
    }
 
    return true;
}
 
 
void GENERATOR_TOOL::DestroyManagerDialog()
{
    if( m_mgrDialog )
    {
        m_mgrDialog->Destroy();
        m_mgrDialog = nullptr;
    }
}
 
 
int GENERATOR_TOOL::ShowGeneratorsManager( const TOOL_EVENT& aEvent )
{
    PCB_EDIT_FRAME* pcbFrame = static_cast<PCB_EDIT_FRAME*>( frame() );
 
    if( !pcbFrame )
        return 0;
 
    if( !m_mgrDialog )
    {
        m_mgrDialog = new DIALOG_GENERATORS( pcbFrame, pcbFrame );
    }
    else
    {
        m_mgrDialog->RebuildModels();
    }
 
    m_mgrDialog->Show( true );
 
    return 0;
}
 
 
int GENERATOR_TOOL::RegenerateAllOfType( const TOOL_EVENT& aEvent )
{
    wxString     generatorType = aEvent.Parameter<wxString>();
    BOARD_COMMIT commit( this );
    wxString     commitMsg;
    int          commitFlags = 0;
 
    if( generatorType == wxS( "*" ) )
        commitMsg = _( "Regenerate All" );
 
    for( PCB_GENERATOR* generator : board()->Generators() )
    {
        if( generatorType == wxS( "*" ) || generator->GetGeneratorType() == generatorType )
        {
            if( commitMsg.IsEmpty() )
                commitMsg.Printf( _( "Update %s" ), generator->GetPluralName() );
 
            generator->EditStart( this, board(), &commit );
            generator->Update( this, board(), &commit );
            generator->EditFinish( this, board(), &commit );
 
            commit.Push( commitMsg, commitFlags );
            commitFlags |= APPEND_UNDO;
        }
    }
 
    frame()->RefreshCanvas();
    return 0;
}
 
 
int GENERATOR_TOOL::MakeViaStackFromSelection( const TOOL_EVENT& aEvent )
{
    PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 
    PCB_SELECTION sel = selTool->RequestSelection(
            []( const VECTOR2I&, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* )
            {
                // Iterate from the back so we don't have to worry about removals.
                for( int i = aCollector.GetCount() - 1; i >= 0; --i )
                {
                    BOARD_ITEM* item = aCollector[i];
 
                    if( item->Type() != PCB_VIA_T && item->Type() != PCB_TRACE_T )
                        aCollector.Remove( item );
                }
            } );
 
    std::vector<BOARD_ITEM*> items;
 
    for( EDA_ITEM* item : sel )
    {
        if( item->IsBOARD_ITEM() )
            items.push_back( static_cast<BOARD_ITEM*>( item ) );
    }
 
    std::vector<BOARD_ITEM*> members;
    wxString                 error;
    PCB_VIA_STACK*           stack = PCB_VIA_STACK::CreateFromItems( items, board(), &members, &error );
 
    if( !stack )
    {
        if( error.IsEmpty() )
        {
            error = _( "A microvia stack needs two or more microvias on the same net, each spanning "
                       "one layer step, with no gap between them." );
        }
 
        frame()->ShowInfoBarWarning( error );
        return 0;
    }
 
    m_toolMgr->RunAction( ACTIONS::selectionClear );
 
    BOARD_COMMIT commit( this );
 
    commit.Add( stack );
 
    for( BOARD_ITEM* item : members )
    {
        if( EDA_GROUP* existingGroup = item->GetParentGroup() )
            commit.Modify( existingGroup->AsEdaItem(), nullptr, RECURSE_MODE::NO_RECURSE );
 
        commit.Modify( item );
        stack->AddItem( item );
    }
 
    commit.Push( _( "Create Microvia Stack" ) );
 
    selTool->AddItemToSel( stack );
    m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
    frame()->RefreshCanvas();
 
    return 0;
}
 
 
int GENERATOR_TOOL::RegenerateSelected( const TOOL_EVENT& aEvent )
{
    BOARD_COMMIT commit( this );
    int          commitFlags = 0;
 
    PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
 
    PCB_SELECTION sel = selTool->RequestSelection(
            []( const VECTOR2I& aPt, GENERAL_COLLECTOR& aCollector, PCB_SELECTION_TOOL* sTool )
            {
                // Iterate from the back so we don't have to worry about removals.
                for( int i = aCollector.GetCount() - 1; i >= 0; --i )
                {
                    BOARD_ITEM* item = aCollector[i];
 
                    if( item->Type() != PCB_GENERATOR_T )
                        aCollector.Remove( item );
                }
            } );
 
    GENERATORS generators;
 
    for( EDA_ITEM* item : sel )
    {
        if( PCB_GENERATOR* gen = dynamic_cast<PCB_GENERATOR*>( item ) )
            generators.push_back( gen );
    }
 
#ifdef GENERATOR_ORDER
    std::sort( generators.begin(), generators.end(),
               []( const PCB_GENERATOR* a, const PCB_GENERATOR* b ) -> bool
               {
                   return a->GetUpdateOrder() < b->GetUpdateOrder();
               } );
#endif
 
    for( PCB_GENERATOR* gen : generators )
    {
        gen->EditStart( this, board(), &commit );
        gen->Update( this, board(), &commit );
        gen->EditFinish( this, board(), &commit );
 
        commit.Push( _( "Regenerate Selected" ), commitFlags );
        commitFlags |= APPEND_UNDO;
    }
 
    frame()->RefreshCanvas();
    return 0;
}
 
 
int GENERATOR_TOOL::RegenerateItem( const TOOL_EVENT& aEvent )
{
    BOARD_COMMIT commit( this );
 
    PCB_GENERATOR* gen = aEvent.Parameter<PCB_GENERATOR*>();
 
    gen->EditStart( this, board(), &commit );
    gen->Update( this, board(), &commit );
    gen->EditFinish( this, board(), &commit );
 
    commit.Push( gen->GetCommitMessage() );
 
    frame()->RefreshCanvas();
    return 0;
}
 
 
int GENERATOR_TOOL::GenEditAction( const TOOL_EVENT& aEvent )
{
    BOARD_COMMIT* commit = dynamic_cast<BOARD_COMMIT*>( aEvent.Commit() );
 
    wxCHECK( commit, 0 );
 
    PCB_GENERATOR* gen = aEvent.Parameter<PCB_GENERATOR*>();
 
    if( aEvent.IsAction( &PCB_ACTIONS::genStartEdit ) )
    {
        gen->EditStart( this, board(), commit );
    }
    else if( aEvent.IsAction( &PCB_ACTIONS::genUpdateEdit ) )
    {
        gen->Update( this, board(), commit );
    }
    else if( aEvent.IsAction( &PCB_ACTIONS::genFinishEdit ) )
    {
        gen->EditFinish( this, board(), commit );
    }
    else if( aEvent.IsAction( &PCB_ACTIONS::genCancelEdit ) )
    {
        gen->EditCancel( this, board(), commit );
    }
    else if( aEvent.IsAction( &PCB_ACTIONS::genRemove ) )
    {
        gen->Remove( this, board(), commit );
    }
 
    return 0;
}
 
 
int GENERATOR_TOOL::RemoveDeselectedEmptyPatterns( const TOOL_EVENT& aEvent )
{
    std::set<KIID> selected;
 
    for( EDA_ITEM* item : m_toolMgr->GetTool<PCB_SELECTION_TOOL>()->GetSelection() )
    {
        if( dynamic_cast<PCB_TUNING_PATTERN*>( item ) )
            selected.insert( item->m_Uuid );
    }
 
    // Interactive tools share the generator router, so wait until they exit before editing copper
    if( !frame()->ToolStackIsEmpty() )
    {
        m_selectedTuningPatterns.insert( selected.begin(), selected.end() );
        return 0;
    }
 
    std::vector<PCB_TUNING_PATTERN*> emptyPatterns;
 
    for( const KIID& id : m_selectedTuningPatterns )
    {
        if( selected.contains( id ) )
            continue;
 
        auto* pattern = dynamic_cast<PCB_TUNING_PATTERN*>( board()->ResolveItem( id, true ) );
 
        if( pattern && !pattern->IsLocked() && !pattern->HasFlag( IN_EDIT ) && !pattern->HasMeanders() )
            emptyPatterns.push_back( pattern );
    }
 
    m_selectedTuningPatterns = std::move( selected );
 
    BOARD_COMMIT commit( this );
    int          commitFlags = 0;
 
    for( PCB_TUNING_PATTERN* pattern : emptyPatterns )
    {
        pattern->Remove( this, board(), &commit );
        commit.Push( _( "Remove Empty Tuning Pattern" ), commitFlags );
        commitFlags |= APPEND_UNDO;
    }
 
    return 0;
}
 
 
void GENERATOR_TOOL::setTransitions()
{
    // Generator actions
    Go( &GENERATOR_TOOL::ShowGeneratorsManager, PCB_ACTIONS::generatorsShowManager.MakeEvent() );
 
    Go( &GENERATOR_TOOL::RegenerateAllOfType,   PCB_ACTIONS::regenerateAllTuning.MakeEvent() );
    Go( &GENERATOR_TOOL::RegenerateAllOfType,   PCB_ACTIONS::regenerateAll.MakeEvent() );
    Go( &GENERATOR_TOOL::RegenerateSelected,    PCB_ACTIONS::regenerateSelected.MakeEvent() );
 
    Go( &GENERATOR_TOOL::GenEditAction,         PCB_ACTIONS::genStartEdit.MakeEvent() );
    Go( &GENERATOR_TOOL::GenEditAction,         PCB_ACTIONS::genUpdateEdit.MakeEvent() );
    Go( &GENERATOR_TOOL::GenEditAction,         PCB_ACTIONS::genFinishEdit.MakeEvent() );
    Go( &GENERATOR_TOOL::GenEditAction,         PCB_ACTIONS::genCancelEdit.MakeEvent() );
    Go( &GENERATOR_TOOL::GenEditAction,         PCB_ACTIONS::genRemove.MakeEvent() );
 
    Go( &GENERATOR_TOOL::MakeViaStackFromSelection, PCB_ACTIONS::makeViaStack.MakeEvent() );
 
    Go( &GENERATOR_TOOL::RemoveDeselectedEmptyPatterns, EVENTS::SelectedEvent );
    Go( &GENERATOR_TOOL::RemoveDeselectedEmptyPatterns, EVENTS::UnselectedEvent );
    Go( &GENERATOR_TOOL::RemoveDeselectedEmptyPatterns, EVENTS::ClearedEvent );
}