dialog_zone_manager.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, 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
 */
 
#include <memory>
#include <optional>
#include <wx/dataview.h>
#include <wx/debug.h>
#include <wx/event.h>
#include <wx/gdicmn.h>
#include <wx/wupdlock.h>
#include <pcb_edit_frame.h>
#include <wx/string.h>
#include <board_commit.h>
#include <widgets/std_bitmap_button.h>
#include <widgets/wx_progress_reporters.h>
#include <zone.h>
#include <zone_settings_bag.h>
#include <board.h>
#include <bitmaps.h>
#include <string_utils.h>
#include <zone_filler.h>
#include <zone_utils.h>
 
#include <zone_manager/model_zones_overview.h>
#include <dialogs/panel_zone_properties.h>
#include <zone_manager/zone_preview_notebook.h>
#include "dialog_zone_manager.h"
 
 
DIALOG_ZONE_MANAGER::DIALOG_ZONE_MANAGER( PCB_BASE_FRAME* aParent ) :
        DIALOG_ZONE_MANAGER_BASE( aParent ),
        m_pcbFrame( aParent ),
        m_zoneSettingsBag( aParent->GetBoard() ),
        m_priorityDragIndex( {} ),
        m_isFillingZones( false ),
        m_zoneFillComplete( false )
{
#ifdef __APPLE__
    m_sizerZoneOP->InsertSpacer( m_sizerZoneOP->GetItemCount(), 5 );
#endif
 
    m_btnMoveTop->SetBitmap( KiBitmapBundle( BITMAPS::small_top ) );
    m_btnMoveUp->SetBitmap( KiBitmapBundle( BITMAPS::small_up ) );
    m_btnMoveDown->SetBitmap( KiBitmapBundle( BITMAPS::small_down ) );
    m_btnMoveBottom->SetBitmap( KiBitmapBundle( BITMAPS::small_bottom ) );
    m_btnAutoAssign->SetBitmap( KiBitmapBundle( BITMAPS::small_sort_desc ) );
 
    m_panelZoneProperties = new PANEL_ZONE_PROPERTIES( m_zonePanel, aParent, m_zoneSettingsBag );
    m_sizerProperties->Add( m_panelZoneProperties, 0,  wxEXPAND, 5 );
 
    m_zonePreviewNotebook = new ZONE_PREVIEW_NOTEBOOK( m_zonePanel, aParent );
    m_sizerPreview->Add( m_zonePreviewNotebook, 1, wxBOTTOM | wxLEFT | wxRIGHT | wxEXPAND, 5 );
 
    for( const auto& [k, v] : MODEL_ZONES_OVERVIEW::GetColumnNames() )
    {
        if( k == MODEL_ZONES_OVERVIEW::LAYERS )
            m_viewZonesOverview->AppendIconTextColumn( v, k, wxDATAVIEW_CELL_INERT, 140 );
        else
            m_viewZonesOverview->AppendTextColumn( v, k, wxDATAVIEW_CELL_INERT, 160 );
    }
 
    m_modelZonesOverview = new MODEL_ZONES_OVERVIEW( this, m_pcbFrame, m_zoneSettingsBag );
    m_viewZonesOverview->AssociateModel( m_modelZonesOverview.get() );
    m_viewZonesOverview->SetLayoutDirection( wxLayout_LeftToRight );
 
#if wxUSE_DRAG_AND_DROP
    m_viewZonesOverview->EnableDragSource( wxDF_UNICODETEXT );
    m_viewZonesOverview->EnableDropTarget( wxDF_UNICODETEXT );
 
    int id = m_viewZonesOverview->GetId();
    Bind( wxEVT_DATAVIEW_ITEM_BEGIN_DRAG, &DIALOG_ZONE_MANAGER::OnBeginDrag, this, id );
    Bind( wxEVT_DATAVIEW_ITEM_DROP_POSSIBLE, &DIALOG_ZONE_MANAGER::OnDropPossible, this, id );
    Bind( wxEVT_DATAVIEW_ITEM_DROP, &DIALOG_ZONE_MANAGER::OnDrop, this, id );
#endif // wxUSE_DRAG_AND_DROP
 
    Bind( EVT_ZONE_NAME_UPDATE, &DIALOG_ZONE_MANAGER::OnZoneNameUpdate, this );
    Bind( EVT_ZONE_NET_UPDATE, &DIALOG_ZONE_MANAGER::OnZoneNetUpdate, this );
    Bind( EVT_ZONES_OVERVIEW_COUNT_CHANGE, &DIALOG_ZONE_MANAGER::OnZonesTableRowCountChange, this );
    Bind( wxEVT_CHECKBOX, &DIALOG_ZONE_MANAGER::OnCheckBoxClicked, this );
    Bind( wxEVT_IDLE, &DIALOG_ZONE_MANAGER::OnIdle, this );
    Bind( wxEVT_CHAR_HOOK, &DIALOG_ZONE_MANAGER::OnDialogCharHook, this );
    Bind( wxEVT_BOOKCTRL_PAGE_CHANGED,
          [this]( wxNotebookEvent& aEvent )
          {
              Layout();
          },
          m_zonePreviewNotebook->GetId() );
 
    Layout();
    m_MainBoxSizer->Fit( this );
    finishDialogSettings();
}
 
 
DIALOG_ZONE_MANAGER::~DIALOG_ZONE_MANAGER() = default;
 
 
bool DIALOG_ZONE_MANAGER::TransferDataToWindow()
{
    m_layerFilter->Clear();
    m_layerFilter->Append( _( "All Layers" ) );
 
    LSET   usedLayers;
    BOARD* board = m_pcbFrame->GetBoard();
 
    for( ZONE* zone : m_zoneSettingsBag.GetClonedZoneList() )
        usedLayers |= zone->GetLayerSet();
 
    for( PCB_LAYER_ID layer : usedLayers.Seq() )
    {
        m_layerFilter->Append( board->GetLayerName( layer ),
                               reinterpret_cast<void*>( static_cast<intptr_t>( layer ) ) );
    }
 
    m_modelZonesOverview->SetLayerFilter( UNDEFINED_LAYER );
    m_layerFilter->SetSelection( 0 );
 
    m_modelZonesOverview->ApplyFilter( m_filterCtrl->GetValue(), m_viewZonesOverview->GetSelection() );
 
    if( m_modelZonesOverview->GetCount() )
        SelectZoneTableItem( m_modelZonesOverview->GetItem( 0 ) );
 
    return true;
}
 
 
void DIALOG_ZONE_MANAGER::PostProcessZoneViewSelChange( wxDataViewItem const& aItem )
{
    bool textCtrlHasFocus = m_filterCtrl->HasFocus();
    long filterInsertPos = m_filterCtrl->GetInsertionPoint();
 
    if( aItem.IsOk() )
    {
        m_viewZonesOverview->Select( aItem );
        m_viewZonesOverview->EnsureVisible( aItem );
        SelectZoneTableItem( aItem );
    }
    else
    {
        if( m_modelZonesOverview->GetCount() )
        {
            wxDataViewItem first_item = m_modelZonesOverview->GetItem( 0 );
            m_viewZonesOverview->Select( first_item );
            m_viewZonesOverview->EnsureVisible( first_item );
            m_zonePreviewNotebook->OnZoneSelectionChanged( m_modelZonesOverview->GetZone( first_item ) );
        }
        else
        {
            m_zonePreviewNotebook->OnZoneSelectionChanged( nullptr );
        }
    }
 
    if( textCtrlHasFocus )
    {
        m_filterCtrl->SetFocus();
        m_filterCtrl->SetInsertionPoint( filterInsertPos );
    }
}
 
 
void DIALOG_ZONE_MANAGER::GenericProcessChar( wxKeyEvent& aEvent )
{
    aEvent.Skip();
}
 
 
void DIALOG_ZONE_MANAGER::OnDialogCharHook( wxKeyEvent& aEvent )
{
    if( aEvent.GetKeyCode() == WXK_UP )
    {
        NavigateZoneSelection( -1 );
    }
    else if( aEvent.GetKeyCode() == WXK_DOWN )
    {
        NavigateZoneSelection( 1 );
    }
    else
    {
        aEvent.Skip();
    }
}
 
 
void DIALOG_ZONE_MANAGER::NavigateZoneSelection( int aDirection )
{
    unsigned count = m_modelZonesOverview->GetCount();
 
    if( count == 0 )
        return;
 
    wxDataViewItem current = m_viewZonesOverview->GetSelection();
    unsigned       currentRow = 0;
 
    if( current.IsOk() )
        currentRow = m_modelZonesOverview->GetRow( current );
 
    int newRow = (int) currentRow + aDirection;
    newRow = std::max( 0, std::min( newRow, (int) count - 1 ) );
 
    if( !current.IsOk() || (unsigned) newRow != currentRow )
        PostProcessZoneViewSelChange( m_modelZonesOverview->GetItem( (unsigned) newRow ) );
}
 
 
void DIALOG_ZONE_MANAGER::OnTableChar( wxKeyEvent& aEvent )
{
    GenericProcessChar( aEvent );
}
 
 
void DIALOG_ZONE_MANAGER::OnTableCharHook( wxKeyEvent& aEvent )
{
    GenericProcessChar( aEvent );
}
 
 
void DIALOG_ZONE_MANAGER::OnIdle( wxIdleEvent& aEvent )
{
    WXUNUSED( aEvent )
    m_viewZonesOverview->SetFocus();
    Unbind( wxEVT_IDLE, &DIALOG_ZONE_MANAGER::OnIdle, this );
}
 
 
void DIALOG_ZONE_MANAGER::onDialogResize( wxSizeEvent& event )
{
    event.Skip();
}
 
 
void DIALOG_ZONE_MANAGER::OnZoneSelectionChanged( ZONE* zone )
{
    wxWindowUpdateLocker updateLock( this );
 
    m_panelZoneProperties->SetZone( zone );
    m_zonePreviewNotebook->OnZoneSelectionChanged( zone );
 
    Layout();
}
 
 
void DIALOG_ZONE_MANAGER::OnViewZonesOverviewOnLeftUp( wxMouseEvent& aEvent )
{
    Bind( wxEVT_IDLE, &DIALOG_ZONE_MANAGER::OnIdle, this );
}
 
 
void DIALOG_ZONE_MANAGER::OnDataViewCtrlSelectionChanged( wxDataViewEvent& aEvent )
{
    SelectZoneTableItem( aEvent.GetItem() );
}
 
 
void DIALOG_ZONE_MANAGER::SelectZoneTableItem( wxDataViewItem const& aItem )
{
    ZONE* zone = m_modelZonesOverview->GetZone( aItem );
 
    if( !zone )
        return;
 
    OnZoneSelectionChanged( zone );
}
 
 
void DIALOG_ZONE_MANAGER::OnOk( wxCommandEvent& aEvt )
{
    m_panelZoneProperties->TransferZoneSettingsFromWindow();
 
    m_zoneSettingsBag.UpdateClonedZones();
 
    for( const auto& [ zone, zoneClone ] : m_zoneSettingsBag.GetZonesCloneMap() )
    {
        std::map<PCB_LAYER_ID, std::shared_ptr<SHAPE_POLY_SET>> filled_zone_to_restore;
        ZONE* internal_zone = zone; // Duplicate the zone pointer to allow capture on older MacOS (13)
 
        zone->GetLayerSet().RunOnLayers(
                [&]( PCB_LAYER_ID layer )
                {
                    std::shared_ptr<SHAPE_POLY_SET> fill = internal_zone->GetFilledPolysList( layer );
 
                    if( fill )
                        filled_zone_to_restore[layer] = fill;
                } );
 
        *zone = *zoneClone;
 
        for( const auto& [ layer, fill ] : filled_zone_to_restore )
            zone->SetFilledPolysList( layer, *fill );
    }
 
    aEvt.Skip();
}
 
 
#if wxUSE_DRAG_AND_DROP
 
void DIALOG_ZONE_MANAGER::OnBeginDrag( wxDataViewEvent& aEvent )
{
    wxTextDataObject* obj = new wxTextDataObject;
    obj->SetText( "42" ); //FIXME - Workaround for drop on GTK
    aEvent.SetDataObject( obj );
    aEvent.SetDragFlags( wxDrag_AllowMove );
    const wxDataViewItem it = aEvent.GetItem();
 
    if( it.IsOk() )
        m_priorityDragIndex = m_modelZonesOverview->GetRow( it );
}
 
 
void DIALOG_ZONE_MANAGER::OnDropPossible( wxDataViewEvent& aEvent )
{
    aEvent.SetDropEffect( wxDragMove ); // check 'move' drop effect
}
 
 
void DIALOG_ZONE_MANAGER::OnDrop( wxDataViewEvent& aEvent )
{
    if( aEvent.GetDataFormat() != wxDF_UNICODETEXT )
    {
        aEvent.Veto();
        return;
    }
 
    if( !m_priorityDragIndex.has_value() )
        return;
 
    const wxDataViewItem it = aEvent.GetItem();
 
    if( !it.IsOk() )
    {
        aEvent.Veto();
        return;
    }
 
    unsigned int                  drop_index = m_modelZonesOverview->GetRow( it );
    const std::optional<unsigned> rtn = m_modelZonesOverview->SwapZonePriority( *m_priorityDragIndex, drop_index );
 
    if( rtn.has_value() )
    {
        const wxDataViewItem item = m_modelZonesOverview->GetItem( *rtn );
 
        if( item.IsOk() )
            m_viewZonesOverview->Select( item );
    }
}
 
#endif // wxUSE_DRAG_AND_DROP
 
 
void DIALOG_ZONE_MANAGER::OnMoveTopClick( wxCommandEvent& aEvent )
{
    MoveSelectedZonePriority( ZONE_INDEX_MOVEMENT::MOVE_TO_TOP );
}
 
 
void DIALOG_ZONE_MANAGER::OnMoveUpClick( wxCommandEvent& aEvent )
{
    MoveSelectedZonePriority( ZONE_INDEX_MOVEMENT::MOVE_UP );
}
 
 
void DIALOG_ZONE_MANAGER::OnMoveDownClick( wxCommandEvent& aEvent )
{
    MoveSelectedZonePriority( ZONE_INDEX_MOVEMENT::MOVE_DOWN );
}
 
 
void DIALOG_ZONE_MANAGER::OnMoveBottomClick( wxCommandEvent& aEvent )
{
    MoveSelectedZonePriority( ZONE_INDEX_MOVEMENT::MOVE_TO_BOTTOM );
}
 
 
void DIALOG_ZONE_MANAGER::OnAutoAssignClick( wxCommandEvent& aEvent )
{
    BOARD* board = m_pcbFrame->GetBoard();
 
    // Save original priorities so we can restore them after copying to clones.
    // The dialog operates on clones; originals must stay untouched until OnOk.
    std::unordered_map<ZONE*, unsigned> savedPriorities;
 
    for( ZONE* zone : board->Zones() )
        savedPriorities[zone] = zone->GetAssignedPriority();
 
    if( AutoAssignZonePriorities( board ) )
    {
        for( auto& [original, clone] : m_zoneSettingsBag.GetZonesCloneMap() )
        {
            unsigned newPri = original->GetAssignedPriority();
            clone->SetAssignedPriority( newPri );
            m_zoneSettingsBag.SetZonePriority( clone.get(), newPri );
        }
 
        PostProcessZoneViewSelChange(
                m_modelZonesOverview->ApplyFilter( m_filterCtrl->GetValue(),
                                                   m_viewZonesOverview->GetSelection() ) );
    }
 
    for( auto& [zone, priority] : savedPriorities )
        zone->SetAssignedPriority( priority );
}
 
 
void DIALOG_ZONE_MANAGER::OnFilterCtrlCancel( wxCommandEvent& aEvent )
{
    PostProcessZoneViewSelChange( m_modelZonesOverview->ClearFilter( m_viewZonesOverview->GetSelection() ) );
    aEvent.Skip();
}
 
 
void DIALOG_ZONE_MANAGER::OnFilterCtrlSearch( wxCommandEvent& aEvent )
{
    PostProcessZoneViewSelChange( m_modelZonesOverview->ApplyFilter( aEvent.GetString(),
                                                                     m_viewZonesOverview->GetSelection() ) );
    aEvent.Skip();
}
 
 
void DIALOG_ZONE_MANAGER::OnFilterCtrlTextChange( wxCommandEvent& aEvent )
{
    PostProcessZoneViewSelChange( m_modelZonesOverview->ApplyFilter( aEvent.GetString(),
                                                                     m_viewZonesOverview->GetSelection() ) );
    aEvent.Skip();
}
 
 
void DIALOG_ZONE_MANAGER::OnFilterCtrlEnter( wxCommandEvent& aEvent )
{
    PostProcessZoneViewSelChange( m_modelZonesOverview->ApplyFilter( aEvent.GetString(),
                                                                     m_viewZonesOverview->GetSelection() ) );
    aEvent.Skip();
}
 
 
void DIALOG_ZONE_MANAGER::OnLayerFilterChanged( wxCommandEvent& aEvent )
{
    int sel = m_layerFilter->GetSelection();
 
    if( sel <= 0 )
    {
        m_modelZonesOverview->SetLayerFilter( UNDEFINED_LAYER );
    }
    else
    {
        void*        data = m_layerFilter->GetClientData( sel );
        PCB_LAYER_ID layer = static_cast<PCB_LAYER_ID>( reinterpret_cast<intptr_t>( data ) );
        m_modelZonesOverview->SetLayerFilter( layer );
    }
 
    PostProcessZoneViewSelChange(
            m_modelZonesOverview->ApplyFilter( m_filterCtrl->GetValue(),
                                               m_viewZonesOverview->GetSelection() ) );
}
 
 
void DIALOG_ZONE_MANAGER::OnUpdateDisplayedZonesClick( wxCommandEvent& aEvent )
{
    if( m_isFillingZones )
        return;
 
    m_isFillingZones = true;
 
    if( !m_panelZoneProperties->TransferZoneSettingsFromWindow() )
    {
        m_isFillingZones = false;
        return;
    }
 
    m_zoneSettingsBag.UpdateClonedZones();
 
    BOARD* board = m_pcbFrame->GetBoard();
    board->IncrementTimeStamp();
 
    // Save the original zones before swapping so we can restore them later
    ZONES originalZones = board->Zones();
 
    // Do not use a commit here since we're operating on cloned zones that are not owned by the
    // board. Using a commit would create undo entries pointing to the clones, which would cause
    // corruption when the commit is destroyed.
    m_filler = std::make_unique<ZONE_FILLER>( board, nullptr );
    auto reporter = std::make_unique<WX_PROGRESS_REPORTER>( this, _( "Fill All Zones" ), 5, PR_CAN_ABORT );
    m_filler->SetProgressReporter( reporter.get() );
 
    // TODO: replace these const_cast calls with a different solution that avoids mutating the
    // container of the board. This is relatively safe as-is because the original zones list is
    // swapped back in below, but still should be changed to avoid invalidating the board state
    // in case this code is refactored to be a non-modal dialog in the future.
    const_cast<ZONES&>( board->Zones() ) = m_zoneSettingsBag.GetClonedZoneList();
 
    m_zoneFillComplete = m_filler->Fill( board->Zones() );
    board->BuildConnectivity();
 
    m_zonePreviewNotebook->OnZoneSelectionChanged( m_panelZoneProperties->GetZone() );
 
    // Restore the original zones. The connectivity MUST be rebuilt to remove stale pointers to
    // cloned zones in case of a cancel.
    const_cast<ZONES&>( board->Zones() ) = originalZones;
    board->BuildConnectivity();
 
    m_isFillingZones = false;
}
 
 
void DIALOG_ZONE_MANAGER::OnZoneNameUpdate( wxCommandEvent& aEvent )
{
    if( ZONE* zone = m_panelZoneProperties->GetZone() )
        m_modelZonesOverview->RowChanged( m_modelZonesOverview->GetRow( m_modelZonesOverview->GetItemByZone( zone ) ) );
}
 
 
void DIALOG_ZONE_MANAGER::OnZoneNetUpdate( wxCommandEvent& aEvent )
{
    if( ZONE* zone = m_panelZoneProperties->GetZone() )
        m_modelZonesOverview->RowChanged( m_modelZonesOverview->GetRow( m_modelZonesOverview->GetItemByZone( zone ) ) );
}
 
 
void DIALOG_ZONE_MANAGER::OnZonesTableRowCountChange( wxCommandEvent& aEvent )
{
    unsigned count = aEvent.GetInt();
 
    for( STD_BITMAP_BUTTON* btn : { m_btnMoveTop, m_btnMoveUp, m_btnMoveDown, m_btnMoveBottom,
                                    m_btnAutoAssign } )
    {
        btn->Enable( count > 1 );
    }
}
 
 
void DIALOG_ZONE_MANAGER::OnCheckBoxClicked( wxCommandEvent& aEvent )
{
    const wxObject* sender = aEvent.GetEventObject();
 
    if( aEvent.GetEventObject() == m_checkName )
        m_modelZonesOverview->EnableFitterByName( aEvent.IsChecked() );
    else if( aEvent.GetEventObject() == m_checkNet )
        m_modelZonesOverview->EnableFitterByNet( aEvent.IsChecked() );
 
    if( ( sender == m_checkName || sender == m_checkNet ) && !m_filterCtrl->IsEmpty() )
        m_modelZonesOverview->ApplyFilter( m_filterCtrl->GetValue(), m_viewZonesOverview->GetSelection() );
}
 
 
void DIALOG_ZONE_MANAGER::MoveSelectedZonePriority( ZONE_INDEX_MOVEMENT aMove )
{
    if( !m_viewZonesOverview->HasSelection() )
        return;
 
    const wxDataViewItem selectedItem = m_viewZonesOverview->GetSelection();
 
    if( !selectedItem.IsOk() )
        return;
 
    const unsigned int            selectedRow = m_modelZonesOverview->GetRow( selectedItem );
    const std::optional<unsigned> new_index = m_modelZonesOverview->MoveZoneIndex( selectedRow, aMove );
 
    if( new_index.has_value() )
    {
        wxDataViewItem new_item = m_modelZonesOverview->GetItem( *new_index );
        PostProcessZoneViewSelChange( new_item );
    }
}