eda_draw_frame.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2004-2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2008 Wayne Stambaugh <[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 <api/api_plugin_manager.h>
#include <base_screen.h>
#include <bitmaps.h>
#include <bitmap_store.h>
#include <confirm.h>
#include <core/arraydim.h>
#include <core/kicad_algo.h>
#include <dialog_shim.h>
#include <dialogs/hotkey_cycle_popup.h>
#include <eda_draw_frame.h>
#include <eda_search_data.h>
#include <file_history.h>
#include <gal/graphics_abstraction_layer.h>
#include <id.h>
#include <kiface_base.h>
#include <kiplatform/ui.h>
#include <lockfile.h>
#include <macros.h>
#include <math/vector2wx.h>
#include <page_info.h>
#include <paths.h>
#include <pgm_base.h>
#include <reporter.h>
#include <render_settings.h>
#include <settings/app_settings.h>
#include <settings/color_settings.h>
#include <settings/common_settings.h>
#include <settings/settings_manager.h>
#include <title_block.h>
#include <tool/actions.h>
#include <tool/action_toolbar.h>
#include <tool/common_tools.h>
#include <tool/grid_helper.h>
#include <tool/grid_menu.h>
#include <tool/selection_conditions.h>
#include <tool/tool_dispatcher.h>
#include <tool/tool_manager.h>
#include <tool/tool_menu.h>
#include <tool/zoom_menu.h>
#include <trace_helpers.h>
#include <view/view.h>
#include <drawing_sheet/ds_draw_item.h>
#include <view/view_controls.h>
#include <widgets/kistatusbar.h>
#include <widgets/msgpanel.h>
#include <widgets/properties_panel.h>
#include <widgets/net_inspector_panel.h>
#include <widgets/git_commit_pane.h>
#include <widgets/filedlg_hook_new_library.h>
#include <project.h>
#include <wx/event.h>
#include <widgets/ui_common.h>
#include <widgets/search_pane.h>
#include <wx/dirdlg.h>
#include <wx/filedlg.h>
#include <wx/debug.h>
#include <wx/socket.h>
 
#include <wx/fdrepdlg.h>
#include <tool/editor_conditions.h>
 
#define FR_HISTORY_LIST_CNT     10   
 
 
BEGIN_EVENT_TABLE( EDA_DRAW_FRAME, KIWAY_PLAYER )
    EVT_UPDATE_UI( ID_ON_GRID_SELECT, EDA_DRAW_FRAME::OnUpdateSelectGrid )
    EVT_UPDATE_UI( ID_ON_ZOOM_SELECT, EDA_DRAW_FRAME::OnUpdateSelectZoom )
 
    EVT_ACTIVATE( EDA_DRAW_FRAME::onActivate )
END_EVENT_TABLE()
 
 
std::set<EDA_DRAW_PANEL_GAL::GAL_TYPE> EDA_DRAW_FRAME::m_failedCanvases;
 
 
EDA_DRAW_FRAME::EDA_DRAW_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
                                const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
                                long aStyle, const wxString& aFrameName, const EDA_IU_SCALE& aIuScale ) :
        KIWAY_PLAYER( aKiway, aParent, aFrameType, aTitle, aPos, aSize, aStyle, aFrameName, aIuScale ),
        m_socketServer( nullptr ),
        m_lastToolbarIconSize( 0 )
{
    m_gridSelectBox       = nullptr;
    m_zoomSelectBox       = nullptr;
    m_zoomCustomEntry     = wxNOT_FOUND;
    m_overrideLocksCb     = nullptr;
    m_searchPane          = nullptr;
    m_undoRedoCountMax    = DEFAULT_MAX_UNDO_ITEMS;
 
    m_canvasType          = EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE;
    m_canvas              = nullptr;
    m_toolDispatcher      = nullptr;
    m_messagePanel        = nullptr;
    m_currentScreen       = nullptr;
    m_showBorderAndTitleBlock = false;  // true to display reference sheet.
    m_gridColor           = COLOR4D( DARKGRAY );   // Default grid color
    m_drawBgColor         = COLOR4D( BLACK );   // the background color of the draw canvas:
                                                // BLACK for Pcbnew, BLACK or WHITE for Eeschema
    m_colorSettings       = nullptr;
    m_polarCoords         = false;
    m_findReplaceData     = std::make_unique<EDA_SEARCH_DATA>();
    m_hotkeyPopup         = nullptr;
    m_propertiesPanel     = nullptr;
    m_netInspectorPanel   = nullptr;
    m_gitCommitPane = nullptr;
 
    SetUserUnits( EDA_UNITS::MM );
 
    m_auimgr.SetFlags( wxAUI_MGR_DEFAULT );
 
    if( ( aStyle & wxFRAME_NO_TASKBAR ) == 0 )
    {
        CreateStatusBar( 8 )->SetDoubleBuffered( true );
 
        GetStatusBar()->SetFont( KIUI::GetStatusFont( this ) );
 
        // set the size of the status bar subwindows:
        updateStatusBarWidths();
    }
 
    m_messagePanel = new EDA_MSG_PANEL( this, -1, wxPoint( 0, m_frameSize.y ), wxDefaultSize );
    m_messagePanel->SetBackgroundColour( COLOR4D( LIGHTGRAY ).ToColour() );
    m_msgFrameHeight = m_messagePanel->GetBestSize().y;
 
    // Create child subwindows.
    GetClientSize( &m_frameSize.x, &m_frameSize.y );
    m_framePos.x   = m_framePos.y = 0;
    m_frameSize.y -= m_msgFrameHeight;
 
    m_messagePanel->SetSize( m_frameSize.x, m_msgFrameHeight );
 
    Bind( wxEVT_DPI_CHANGED,
          [&]( wxDPIChangedEvent& aEvent )
          {
              if( ( GetWindowStyle() & wxFRAME_NO_TASKBAR ) == 0 )
                  updateStatusBarWidths();
 
              wxMoveEvent dummy;
              OnMove( dummy );
 
              // we need to kludge the msg panel to the correct size again
              // especially important even for first launches as the constructor of the window
              // here usually doesn't have the correct dpi awareness yet
              m_frameSize.y += m_msgFrameHeight;
              m_msgFrameHeight = m_messagePanel->GetBestSize().y;
              m_frameSize.y -= m_msgFrameHeight;
 
              m_messagePanel->SetPosition( wxPoint( 0, m_frameSize.y ) );
              m_messagePanel->SetSize( m_frameSize.x, m_msgFrameHeight );
 
              aEvent.Skip();
          } );
}
 
 
EDA_DRAW_FRAME::~EDA_DRAW_FRAME()
{
    if( m_failedCanvases.empty() )
        saveCanvasTypeSetting( m_canvasType );
 
    delete m_actions;
    delete m_toolManager;
    delete m_toolDispatcher;
    delete m_canvas;
 
    delete m_currentScreen;
    m_currentScreen = nullptr;
 
    m_auimgr.UnInit();
 
    ReleaseFile();
}
 
 
EDA_SEARCH_DATA& EDA_DRAW_FRAME::GetFindReplaceData()
{
    return *m_findReplaceData;
}
 
 
void EDA_DRAW_FRAME::configureToolbars()
{
    EDA_BASE_FRAME::configureToolbars();
 
    // Grid selection
    auto gridSelectorFactory =
            [this]( ACTION_TOOLBAR* aToolbar )
            {
                if( !m_gridSelectBox )
                    m_gridSelectBox = new wxChoice( aToolbar, ID_ON_GRID_SELECT );
 
                UpdateGridSelectBox();
 
                aToolbar->Add( m_gridSelectBox );
            };
 
    RegisterCustomToolbarControlFactory( ACTION_TOOLBAR_CONTROLS::gridSelect, gridSelectorFactory );
 
    // Zoom selection
    auto zoomSelectorFactory =
            [this]( ACTION_TOOLBAR* aToolbar )
            {
                if( !m_zoomSelectBox )
                    m_zoomSelectBox = new wxChoice( aToolbar, ID_ON_ZOOM_SELECT );
 
                UpdateZoomSelectBox();
                aToolbar->Add( m_zoomSelectBox );
            };
 
    RegisterCustomToolbarControlFactory( ACTION_TOOLBAR_CONTROLS::zoomSelect, zoomSelectorFactory );
 
    auto overrideLocksFactory =
            [this]( ACTION_TOOLBAR* aToolbar )
            {
                if( !m_overrideLocksCb )
                {
                    m_overrideLocksCb = new wxCheckBox( aToolbar, ID_ON_OVERRIDE_LOCKS, _( "Override locks" ) );
 
                    // Clicking the checkbox takes focus off the canvas, so return it
                    m_overrideLocksCb->Bind( wxEVT_CHECKBOX,
                                             [this]( wxCommandEvent& aEvent )
                                             {
                                                 if( m_toolManager )
                                                     m_toolManager->PostEvent( EVENTS::SelectedEvent );
 
                                                 if( m_canvas )
                                                     m_canvas->SetFocus();
 
                                                 aEvent.Skip();
                                             } );
                }
 
                aToolbar->Add( m_overrideLocksCb );
            };
 
    RegisterCustomToolbarControlFactory( ACTION_TOOLBAR_CONTROLS::overrideLocks, overrideLocksFactory );
}
 
 
void EDA_DRAW_FRAME::ClearToolbarControl( int aId )
{
    switch( aId )
    {
    case ID_ON_GRID_SELECT:    m_gridSelectBox = nullptr;   break;
    case ID_ON_ZOOM_SELECT:    m_zoomSelectBox = nullptr;   break;
    case ID_ON_OVERRIDE_LOCKS: m_overrideLocksCb = nullptr; break;
    }
}
 
 
void EDA_DRAW_FRAME::ReleaseFile()
{
    if( m_file_checker )
        m_file_checker->UnlockFile();
}
 
 
bool EDA_DRAW_FRAME::LockFile( const wxString& aFileName )
{
    // We need to explicitly reset here to get the deletion before we create a new unique_ptr that
    // may be for the same file.
    m_file_checker.reset();
 
    m_file_checker = std::make_unique<LOCKFILE>( aFileName );
 
    // If the file is valid, return true.  This could mean that the file is locked or it could mean
    // that the file is read-only.
    return m_file_checker->Valid();
}
 
 
void EDA_DRAW_FRAME::unitsChangeRefresh()
{
    // Notify all tools the units have changed
    if( m_toolManager )
        m_toolManager->RunAction( ACTIONS::updateUnits );
 
    UpdateStatusBar();
    UpdateMsgPanel();
    UpdateProperties();
 
    switch( GetUserUnits() )
    {
    default:
    case EDA_UNITS::MM:   SelectToolbarAction( ACTIONS::millimetersUnits ); break;
    case EDA_UNITS::INCH: SelectToolbarAction( ACTIONS::inchesUnits );      break;
    case EDA_UNITS::MILS: SelectToolbarAction( ACTIONS::milsUnits );        break;
    }
}
 
 
void EDA_DRAW_FRAME::ToggleUserUnits()
{
    if( m_toolManager->GetTool<COMMON_TOOLS>() )
    {
        TOOL_EVENT dummy;
        m_toolManager->GetTool<COMMON_TOOLS>()->ToggleUnits( dummy );
    }
    else
    {
        SetUserUnits( GetUserUnits() == EDA_UNITS::INCH ? EDA_UNITS::MM : EDA_UNITS::INCH );
        unitsChangeRefresh();
 
        wxCommandEvent e( EDA_EVT_UNITS_CHANGED );
        ProcessEventLocally( e );
    }
}
 
 
void EDA_DRAW_FRAME::CommonSettingsChanged( int aFlags )
{
    EDA_BASE_FRAME::CommonSettingsChanged( aFlags );
 
    COMMON_SETTINGS*      settings = Pgm().GetCommonSettings();
    KIGFX::VIEW_CONTROLS* viewControls = GetCanvas()->GetViewControls();
 
    if( m_supportsAutoSave && m_autoSaveTimer->IsRunning() )
    {
        if( GetAutoSaveInterval() > 0 )
        {
            m_autoSaveTimer->Start( GetAutoSaveInterval() * 1000, wxTIMER_ONE_SHOT );
        }
        else
        {
            m_autoSaveTimer->Stop();
            m_autoSavePending = false;
        }
    }
 
    viewControls->LoadSettings();
    GetCanvas()->UpdateTouchpadGestureHandler();
 
    m_galDisplayOptions.ReadCommonConfig( *settings, this );
 
    GetToolManager()->RunAction( ACTIONS::gridPreset, GetWindowSettings( config() )->grid.last_size_idx );
    UpdateGridSelectBox();
 
    if( m_lastToolbarIconSize == 0
        || m_lastToolbarIconSize != settings->m_Appearance.toolbar_icon_size )
    {
        OnToolbarSizeChanged();
        m_lastToolbarIconSize = settings->m_Appearance.toolbar_icon_size;
    }
 
    // A rendering engine change in Preferences applies in place
    resolveCanvasType();
 
    // Version control can have just been turned on or off.
    RefreshGitCommitPane();
 
    if( m_gitCommitPane )
        m_gitCommitPane->ReloadAdvancedWindow();
 
    // Notify all tools the preferences have changed
    if( m_toolManager )
        m_toolManager->RunAction( ACTIONS::updatePreferences );
}
 
 
void EDA_DRAW_FRAME::EraseMsgBox()
{
    if( m_messagePanel )
        m_messagePanel->EraseMsgBox();
}
 
 
void EDA_DRAW_FRAME::UpdateGridSelectBox()
{
    UpdateStatusBar();
    DisplayUnitsMsg();
 
    if( m_gridSelectBox == nullptr )
        return;
 
    // Update grid values with the current units setting.
    m_gridSelectBox->Clear();
    wxArrayString gridsList;
 
    wxCHECK( config(), /* void */ );
 
    GRID_MENU::BuildChoiceList( &gridsList, GetWindowSettings( config() ), this );
 
    for( const wxString& grid : gridsList )
        m_gridSelectBox->Append( grid );
 
    m_gridSelectBox->Append( wxT( "---" ) );
    m_gridSelectBox->Append( _( "Edit Grids..." ) );
 
    m_gridSelectBox->SetSelection( GetWindowSettings( config() )->grid.last_size_idx );
}
 
 
void EDA_DRAW_FRAME::OnUpdateSelectGrid( wxUpdateUIEvent& aEvent )
{
    // No need to update the grid select box if it doesn't exist or the grid setting change
    // was made using the select box.
    if( m_gridSelectBox == nullptr )
        return;
 
    wxCHECK( config(), /* void */ );
 
    int idx = GetWindowSettings( config() )->grid.last_size_idx;
    idx = std::clamp( idx, 0, (int) m_gridSelectBox->GetCount() - 1 );
 
    if( idx != m_gridSelectBox->GetSelection() )
        m_gridSelectBox->SetSelection( idx );
}
 
 
 
void EDA_DRAW_FRAME::OnUpdateSelectZoom( wxUpdateUIEvent& aEvent )
{
    SyncZoomSelectBox();
}
 
 
void EDA_DRAW_FRAME::SyncZoomSelectBox()
{
    if( m_zoomSelectBox == nullptr )
        return;
 
    double zoom = GetCanvas()->GetGAL()->GetZoomFactor();
 
    wxCHECK( config(), /* void */ );
 
    const std::vector<double>& zoomList = GetWindowSettings( config() )->zoom_factors;
    int                        preset = wxNOT_FOUND;
 
    for( size_t jj = 0; jj < zoomList.size(); ++jj )
    {
        if( zoomList[jj] == zoom )
        {
            preset = (int) jj + 1; // index 0 is Zoom Auto
            break;
        }
    }
 
    if( preset != wxNOT_FOUND )
    {
        // Zoom is on a preset, so drop the custom entry and select the preset.
        if( m_zoomCustomEntry != wxNOT_FOUND )
        {
            m_zoomSelectBox->Delete( m_zoomCustomEntry );
            m_zoomCustomEntry = wxNOT_FOUND;
        }
 
        if( m_zoomSelectBox->GetSelection() != preset )
            m_zoomSelectBox->SetSelection( preset );
    }
    else
    {
        // Off-preset zoom, show the exact value in its own entry just below Zoom Auto.
        wxString text = wxString::Format( _( "Zoom %.2f" ), zoom );
 
        if( m_zoomCustomEntry == wxNOT_FOUND )
            m_zoomCustomEntry = m_zoomSelectBox->Insert( text, 1 );
        else if( m_zoomSelectBox->GetString( m_zoomCustomEntry ) != text )
            m_zoomSelectBox->SetString( m_zoomCustomEntry, text );
 
        if( m_zoomSelectBox->GetSelection() != m_zoomCustomEntry )
            m_zoomSelectBox->SetSelection( m_zoomCustomEntry );
    }
}
 
 
void EDA_DRAW_FRAME::OnSelectGrid( wxCommandEvent& event )
{
    wxCHECK_RET( m_gridSelectBox, wxS( "m_gridSelectBox uninitialized" ) );
 
    int idx = m_gridSelectBox->GetCurrentSelection();
 
    if( idx == int( m_gridSelectBox->GetCount() ) - 2 )
    {
        // wxWidgets will check the separator, which we don't want.
        // Re-check the current grid.
        wxUpdateUIEvent dummy;
        OnUpdateSelectGrid( dummy );
    }
    else if( idx == int( m_gridSelectBox->GetCount() ) - 1 )
    {
        // wxWidgets will check the Grid Settings... entry, which we don't want.
        // Re-check the current grid.
        wxUpdateUIEvent dummy;
        OnUpdateSelectGrid( dummy );
 
        // Give a time-slice to close the menu before opening the dialog.
        // (Only matters on some versions of GTK.)
        wxSafeYield();
 
        m_toolManager->RunAction( ACTIONS::gridProperties );
    }
    else
    {
        m_toolManager->RunAction( ACTIONS::gridPreset, idx );
    }
 
    UpdateStatusBar();
    m_canvas->Refresh();
 
    // Needed on Windows because clicking on m_gridSelectBox remove the focus from m_canvas
    // (Windows specific
    m_canvas->SetFocus();
}
 
 
bool EDA_DRAW_FRAME::GetOverrideLocks() const
{
    if( m_overrideLocksCb )
        return m_overrideLocksCb->GetValue();
 
    return false;
}
 
 
bool EDA_DRAW_FRAME::IsGridVisible()
{
    APP_SETTINGS_BASE* cfg = config();
 
    if( !cfg )
        return true;
 
    return GetWindowSettings( cfg )->grid.show;
}
 
 
void EDA_DRAW_FRAME::SetGridVisibility( bool aVisible )
{
    wxCHECK( config(), /* void */ );
 
    GetWindowSettings( config() )->grid.show = aVisible;
 
    // Update the display with the new grid
    if( GetCanvas() )
    {
        // Check to ensure these exist, since this function could be called before
        // the GAL and View have been created
        if( GetCanvas()->GetGAL() )
            GetCanvas()->GetGAL()->SetGridVisibility( aVisible );
 
        if( GetCanvas()->GetView() )
            GetCanvas()->GetView()->MarkTargetDirty( KIGFX::TARGET_NONCACHED );
 
        GetCanvas()->Refresh();
    }
}
 
 
bool EDA_DRAW_FRAME::IsGridOverridden()
{
    APP_SETTINGS_BASE* cfg = config();
 
    if( !cfg )
        return false;
 
    return GetWindowSettings( cfg )->grid.overrides_enabled;
}
 
 
void EDA_DRAW_FRAME::SetGridOverrides( bool aOverride )
{
    wxCHECK( config(), /* void */ );
 
    GetWindowSettings( config() )->grid.overrides_enabled = aOverride;
}
 
 
std::unique_ptr<GRID_HELPER> EDA_DRAW_FRAME::MakeGridHelper()
{
    return nullptr;
}
 
 
void EDA_DRAW_FRAME::UpdateZoomSelectBox()
{
    if( m_zoomSelectBox == nullptr )
        return;
 
    double zoom = m_canvas->GetGAL()->GetZoomFactor();
 
    m_zoomSelectBox->Clear();
    m_zoomSelectBox->Append( _( "Zoom Auto" ) );
    m_zoomSelectBox->SetSelection( 0 );
    m_zoomCustomEntry = wxNOT_FOUND;
 
    wxCHECK( config(), /* void */ );
 
    for( unsigned ii = 0;  ii < GetWindowSettings( config() )->zoom_factors.size();  ++ii )
    {
        double current = GetWindowSettings( config() )->zoom_factors[ii];
 
        m_zoomSelectBox->Append( wxString::Format( _( "Zoom %.2f" ), current ) );
 
        if( zoom == current )
            m_zoomSelectBox->SetSelection( (int) ii + 1 );
    }
}
 
 
void EDA_DRAW_FRAME::OnSelectZoom( wxCommandEvent& event )
{
    wxCHECK_RET( m_zoomSelectBox, wxS( "m_zoomSelectBox uninitialized" ) );
 
    int id = m_zoomSelectBox->GetCurrentSelection();
 
    if( id < 0 || id >= (int) m_zoomSelectBox->GetCount() )
        return;
 
    // Picking the custom entry means keep the current zoom, so nothing to do.
    if( id == m_zoomCustomEntry )
        return;
 
    // The custom entry pushes the presets down by one, so shift back to the real preset id.
    int preset = id;
 
    if( m_zoomCustomEntry != wxNOT_FOUND && id > m_zoomCustomEntry )
        preset = id - 1;
 
    m_toolManager->RunAction( ACTIONS::zoomPreset, preset );
    UpdateStatusBar();
    m_canvas->Refresh();
 
    // Needed on Windows (only) because clicking on m_zoomSelectBox removes the focus from m_canvas
    m_canvas->SetFocus();
}
 
 
void EDA_DRAW_FRAME::OnMove( wxMoveEvent& aEvent )
{
    // If the window is moved to a different display, the scaling factor may change
    double oldFactor = m_galDisplayOptions.m_scaleFactor;
    m_galDisplayOptions.UpdateScaleFactor();
 
    if( oldFactor != m_galDisplayOptions.m_scaleFactor && m_canvas )
    {
        // wx has not laid the frame out for the new DPI yet, so defer until the canvas has
        // reached its final size
        EDA_DRAW_PANEL_GAL* canvas = GetCanvas();
 
        canvas->CallAfter( [canvas]() { canvas->ResizeGal( true ); } );
    }
 
    aEvent.Skip();
}
 
 
void EDA_DRAW_FRAME::AddStandardSubMenus( TOOL_MENU& aToolMenu )
{
    COMMON_TOOLS*     commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
    CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
 
    aMenu.AddSeparator( 1000 );
 
    std::shared_ptr<ZOOM_MENU> zoomMenu = std::make_shared<ZOOM_MENU>( this );
    zoomMenu->SetTool( commonTools );
    aToolMenu.RegisterSubMenu( zoomMenu );
 
    std::shared_ptr<GRID_MENU> gridMenu = std::make_shared<GRID_MENU>( this );
    gridMenu->SetTool( commonTools );
    aToolMenu.RegisterSubMenu( gridMenu );
 
    aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
    aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
}
 
 
void EDA_DRAW_FRAME::DisplayToolMsg( const wxString& msg )
{
    if( m_isClosing )
        return;
 
    SetStatusText( msg, 6 );
}
 
 
void EDA_DRAW_FRAME::DisplayConstraintsMsg( const wxString& msg )
{
    if( m_isClosing )
        return;
 
    SetStatusText( msg, 7 );
}
 
 
void EDA_DRAW_FRAME::DisplayGridMsg()
{
    if( m_isClosing )
        return;
 
    wxString msg;
 
    GRID_SETTINGS& gridSettings = GetWindowSettings( config() )->grid;
    int            currentIdx = gridSettings.last_size_idx;
 
    msg.Printf( _( "grid %s" ), gridSettings.grids[currentIdx].UserUnitsMessageText( this, false ) );
 
    SetStatusText( msg, 4 );
}
 
 
void EDA_DRAW_FRAME::DisplayUnitsMsg()
{
    if( m_isClosing )
        return;
 
    wxString msg;
 
    switch( GetUserUnits() )
    {
    case EDA_UNITS::INCH: msg = _( "inches" ); break;
    case EDA_UNITS::MILS: msg = _( "mils" );   break;
    case EDA_UNITS::MM:   msg = _( "mm" );     break;
    default:              msg = _( "Units" );  break;
    }
 
    SetStatusText( msg, 5 );
}
 
 
void EDA_DRAW_FRAME::OnSize( wxSizeEvent& SizeEv )
{
    EDA_BASE_FRAME::OnSize( SizeEv );
 
    m_frameSize = GetClientSize( );
 
    SizeEv.Skip();
}
 
 
void EDA_DRAW_FRAME::updateStatusBarWidths()
{
    constexpr int numLocalFields = 8;
 
    wxStatusBar* stsbar = GetStatusBar();
    int spacer = KIUI::GetTextSize( wxT( "M" ), stsbar ).x;
 
    // Note this is a KISTATUSBAR and there are fields to the right of the ones we know about
    int totalFields = stsbar->GetFieldsCount();
 
    std::vector<int> dims = {
        // remainder of status bar on far left is set to a default or whatever is left over.
        -2,
 
        // When using GetTextSize() remember the width of character '1' is not the same
        // as the width of '0' unless the font is fixed width, and it usually won't be.
 
        // zoom:
        KIUI::GetTextSize( wxT( "Z 762000" ), stsbar ).x + spacer,
 
        // cursor coords
        KIUI::GetTextSize( wxT( "X 00000.0000  Y 00000.0000" ), stsbar ).x + spacer,
 
        // delta distances
        KIUI::GetTextSize( wxT( "dx 00000.0000  dy 00000.0000  dist 00000.0000" ), stsbar ).x + spacer,
 
        // grid size
        KIUI::GetTextSize( wxT( "grid 0000.0000 x 0000.0000" ), stsbar ).x + spacer,
 
        // units display, Inches is bigger than mm
        KIUI::GetTextSize( _( "Inches" ), stsbar ).x + spacer,
 
        // Size for the "Current Tool" panel
        -1,
 
        // constraint mode
        KIUI::GetTextSize(  _( "Constrain to H, V, 45" ), stsbar).x + spacer
    };
 
    for( int idx = numLocalFields; idx < totalFields; ++idx )
        dims.emplace_back( stsbar->GetStatusWidth( idx ) );
 
    SetStatusWidths( dims.size(), dims.data() );
}
 
 
wxStatusBar* EDA_DRAW_FRAME::OnCreateStatusBar( int number, long style, wxWindowID id, const wxString& name )
{
    return new KISTATUSBAR( number, this, id, KISTATUSBAR::STYLE_FLAGS::WARNING_ICON );
}
 
 
void EDA_DRAW_FRAME::UpdateStatusBar()
{
    if( m_isClosing )
        return;
 
    SetStatusText( GetZoomLevelIndicator(), 1 );
 
    // Update-UI events come at most every m_UpdateUIEventInterval, so the last step of a zoom
    // could leave the box one step behind the status bar until the mouse moves
    SyncZoomSelectBox();
 
    // Absolute and relative cursor positions are handled by overloading this function and
    // handling the internal to user units conversion at the appropriate level.
 
    // refresh units display
    DisplayUnitsMsg();
}
 
 
const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator() const
{
    // returns a human readable value which can be displayed as zoom
    // level indicator in dialogs.
    double zoom = m_canvas->GetGAL()->GetZoomFactor();
    return wxString::Format( wxT( "Z %.2f" ), zoom );
}
 
 
void EDA_DRAW_FRAME::LoadSettings( APP_SETTINGS_BASE* aCfg )
{
    EDA_BASE_FRAME::LoadSettings( aCfg );
 
    COMMON_SETTINGS* cmnCfg = Pgm().GetCommonSettings();
    WINDOW_SETTINGS* window = GetWindowSettings( aCfg );
 
    // Read units used in dialogs and toolbars
    SetUserUnits( static_cast<EDA_UNITS>( aCfg->m_System.units ) );
 
    m_undoRedoCountMax = aCfg->m_System.max_undo_items;
 
    m_galDisplayOptions.ReadConfig( *cmnCfg, *window, this );
 
    m_findReplaceData->findString = aCfg->m_FindReplace.find_string;
    m_findReplaceData->replaceString = aCfg->m_FindReplace.replace_string;
    m_findReplaceData->matchMode = static_cast<EDA_SEARCH_MATCH_MODE>( aCfg->m_FindReplace.match_mode );
    m_findReplaceData->matchCase = aCfg->m_FindReplace.match_case;
    m_findReplaceData->searchAndReplace = aCfg->m_FindReplace.search_and_replace;
 
    for( const wxString& s : aCfg->m_FindReplace.find_history )
        m_findStringHistoryList.Add( s );
 
    for( const wxString& s : aCfg->m_FindReplace.replace_history )
        m_replaceStringHistoryList.Add( s );
 
    m_lastToolbarIconSize = cmnCfg->m_Appearance.toolbar_icon_size;
}
 
 
void EDA_DRAW_FRAME::SaveSettings( APP_SETTINGS_BASE* aCfg )
{
    EDA_BASE_FRAME::SaveSettings( aCfg );
 
    WINDOW_SETTINGS* window = GetWindowSettings( aCfg );
 
    aCfg->m_System.units = static_cast<int>( GetUserUnits() );
    aCfg->m_System.max_undo_items = GetMaxUndoItems();
 
    m_galDisplayOptions.WriteConfig( *window );
 
    aCfg->m_FindReplace.search_and_replace = m_findReplaceData->searchAndReplace;
 
    aCfg->m_FindReplace.find_string = m_findReplaceData->findString;
    aCfg->m_FindReplace.replace_string = m_findReplaceData->replaceString;
 
    aCfg->m_FindReplace.find_history.clear();
    aCfg->m_FindReplace.replace_history.clear();
 
    for( size_t i = 0; i < m_findStringHistoryList.GetCount() && i < FR_HISTORY_LIST_CNT; i++ )
        aCfg->m_FindReplace.find_history.push_back( m_findStringHistoryList[ i ].ToStdString() );
 
    for( size_t i = 0; i < m_replaceStringHistoryList.GetCount() && i < FR_HISTORY_LIST_CNT; i++ )
        aCfg->m_FindReplace.replace_history.push_back( m_replaceStringHistoryList[ i ].ToStdString() );
 
    // Save the units used in this frame
    if( m_toolManager )
    {
        if( COMMON_TOOLS* cmnTool = m_toolManager->GetTool<COMMON_TOOLS>() )
        {
            aCfg->m_System.last_imperial_units = static_cast<int>( cmnTool->GetLastImperialUnits() );
            aCfg->m_System.last_metric_units = static_cast<int>( cmnTool->GetLastMetricUnits() );
        }
    }
}
 
 
void EDA_DRAW_FRAME::AppendMsgPanel( const wxString& aTextUpper, const wxString& aTextLower, int aPadding )
{
    if( m_messagePanel && !m_isClosing )
        m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
}
 
 
void EDA_DRAW_FRAME::ClearMsgPanel()
{
    if( m_messagePanel && !m_isClosing )
        m_messagePanel->EraseMsgBox();
}
 
 
void EDA_DRAW_FRAME::SetMsgPanel( const std::vector<MSG_PANEL_ITEM>& aList )
{
    if( m_messagePanel && !m_isClosing )
    {
        m_messagePanel->EraseMsgBox();
 
        for( const MSG_PANEL_ITEM& item : aList )
            m_messagePanel->AppendMessage( item );
    }
}
 
 
void EDA_DRAW_FRAME::SetMsgPanel( const wxString& aTextUpper, const wxString& aTextLower, int aPadding )
{
    if( m_messagePanel && !m_isClosing )
    {
        m_messagePanel->EraseMsgBox();
        m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
    }
}
 
 
void EDA_DRAW_FRAME::SetMsgPanel( EDA_ITEM* aItem )
{
    wxCHECK_RET( aItem, wxT( "Invalid EDA_ITEM pointer.  Bad programmer." ) );
 
    std::vector<MSG_PANEL_ITEM> items;
    aItem->GetMsgPanelInfo( this, items );
    SetMsgPanel( items );
}
 
 
void EDA_DRAW_FRAME::UpdateMsgPanel()
{
}
 
 
void EDA_DRAW_FRAME::ActivateGalCanvas()
{
    GetCanvas()->SetEvtHandlerEnabled( true );
    GetCanvas()->StartDrawing();
}
 
 
void EDA_DRAW_FRAME::SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType )
{
    GetCanvas()->SwitchBackend( aCanvasType );
    m_canvasType = GetCanvas()->GetBackend();
 
    ActivateGalCanvas();
}
 
 
EDA_DRAW_PANEL_GAL::GAL_TYPE EDA_DRAW_FRAME::loadCanvasTypeSetting()
{
    EDA_DRAW_PANEL_GAL::GAL_TYPE canvasType = EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL;
 
    if( COMMON_SETTINGS* cfg = Pgm().GetCommonSettings() )
        canvasType = EDA_DRAW_PANEL_GAL::ResolveStoredCanvasType( cfg->m_Graphics.canvas_type );
 
    wxString envCanvasType;
 
    if( wxGetEnv( "KICAD_SOFTWARE_RENDERING", &envCanvasType ) )
    {
        if( envCanvasType.CmpNoCase( "1" ) == 0
            || envCanvasType.CmpNoCase( "true" ) == 0
            || envCanvasType.CmpNoCase( "yes" ) == 0 )
        {
            // Force software rendering if the environment variable is set
            canvasType = EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO;
        }
    }
 
#ifdef __WXMAC__
    // Cairo doesn't handle Retina displays, so it is not a valid screen backend on Mac
    if( canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO )
        canvasType = EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL;
#endif
 
    return canvasType;
}
 
 
bool EDA_DRAW_FRAME::saveCanvasTypeSetting( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType )
{
    // Not all classes derived from EDA_DRAW_FRAME can save the canvas type, because some
    // have a fixed type, or do not have a option to set the canvas type (they inherit from
    // a parent frame)
    static std::vector<FRAME_T> s_allowedFrames = { FRAME_SCH,
                                                    FRAME_SCH_SYMBOL_EDITOR,
                                                    FRAME_PCB_EDITOR,
                                                    FRAME_FOOTPRINT_EDITOR,
                                                    FRAME_GERBER,
                                                    FRAME_PL_EDITOR };
 
    if( !alg::contains( s_allowedFrames, m_ident ) )
        return false;
 
    if( wxGetEnv( "KICAD_SOFTWARE_RENDERING", nullptr ) )
    {
        // If the environment variable is set, don't save the canvas type.
        return false;
    }
 
    if( aCanvasType < EDA_DRAW_PANEL_GAL::GAL_TYPE_NONE || aCanvasType >= EDA_DRAW_PANEL_GAL::GAL_TYPE_LAST )
    {
        wxASSERT( false );
        return false;
    }
 
    if( COMMON_SETTINGS* cfg = Pgm().GetCommonSettings() )
    {
        cfg->m_Graphics.canvas_type = static_cast<int>( aCanvasType );
        return true;
    }
 
    return false;
}
 
 
VECTOR2I EDA_DRAW_FRAME::GetNearestGridPosition( const VECTOR2I& aPosition ) const
{
    const VECTOR2I& gridOrigin = GetGridOrigin();
    VECTOR2D        gridSize = GetCanvas()->GetGAL()->GetGridSize();
 
    double xOffset = fmod( gridOrigin.x, gridSize.x );
    int    x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
    double yOffset = fmod( gridOrigin.y, gridSize.y );
    int    y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
 
    return KiROUND( x * gridSize.x + xOffset, y * gridSize.y + yOffset );
}
 
 
VECTOR2I EDA_DRAW_FRAME::GetNearestHalfGridPosition( const VECTOR2I& aPosition ) const
{
    const VECTOR2I& gridOrigin = GetGridOrigin();
    VECTOR2D        gridSize = GetCanvas()->GetGAL()->GetGridSize() / 2.0;
 
    double xOffset = fmod( gridOrigin.x, gridSize.x );
    int    x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
    double yOffset = fmod( gridOrigin.y, gridSize.y );
    int    y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
 
    return KiROUND( x * gridSize.x + xOffset, y * gridSize.y + yOffset );
}
 
 
const BOX2I EDA_DRAW_FRAME::GetDocumentExtents( bool aIncludeAllVisible ) const
{
    return BOX2I();
}
 
 
void EDA_DRAW_FRAME::HardRedraw()
{
    // To be implemented by subclasses.
}
 
 
void EDA_DRAW_FRAME::Zoom_Automatique( bool aWarpPointer )
{
    m_toolManager->RunAction( ACTIONS::zoomFitScreen );
}
 
 
std::vector<wxWindow*> EDA_DRAW_FRAME::findDialogs()
{
    std::vector<wxWindow*> dialogs;
 
    for( wxWindow* window : GetChildren() )
    {
        if( dynamic_cast<DIALOG_SHIM*>( window ) )
            dialogs.push_back( window );
    }
 
    return dialogs;
}
 
 
void EDA_DRAW_FRAME::FocusOnLocation( const VECTOR2I& aPos, bool aAllowScroll )
{
    bool               centerView = false;
    std::vector<BOX2D> dialogScreenRects;
 
    if( aAllowScroll )
    {
        BOX2D r = GetCanvas()->GetView()->GetViewport();
 
        // Center if we're off the current view, or within 10% of its edge
        r.Inflate( - r.GetWidth() / 10.0 );
 
        if( !r.Contains( aPos ) )
            centerView = true;
 
        for( wxWindow* dialog : findDialogs() )
        {
            dialogScreenRects.emplace_back( ToVECTOR2D( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ) ),
                                            ToVECTOR2D( dialog->GetSize() ) );
        }
 
        // Center if we're behind an obscuring dialog, or within 10% of its edge
        for( BOX2D rect : dialogScreenRects )
        {
            rect.Inflate( rect.GetWidth() / 10 );
 
            if( rect.Contains( GetCanvas()->GetView()->ToScreen( aPos ) ) )
                centerView = true;
        }
    }
 
    if( centerView )
    {
        try
        {
            GetCanvas()->GetView()->SetCenter( aPos, dialogScreenRects );
        }
        catch( const Clipper2Lib::Clipper2Exception& e )
        {
            wxFAIL_MSG( wxString::Format( wxT( "Clipper2 exception occurred centering object: %s" ), e.what() ) );
        }
    }
 
    GetCanvas()->GetViewControls()->SetCrossHairCursorPosition( aPos );
}
 
 
void PrintDrawingSheet( const RENDER_SETTINGS* aSettings, const PAGE_INFO& aPageInfo,
                        const wxString& aSheetName, const wxString& aSheetPath,
                        const wxString& aFileName, const TITLE_BLOCK& aTitleBlock,
                        const std::map<wxString, wxString>* aProperties, int aSheetCount,
                        const wxString& aPageNumber, double aMils2Iu, const PROJECT* aProject,
                        const wxString& aSheetLayer, bool aIsFirstPage )
{
    DS_DRAW_ITEM_LIST drawList( unityScale );
 
    drawList.SetDefaultPenSize( aSettings->GetDefaultPenWidth() );
    drawList.SetPlotterMilsToIUfactor( aMils2Iu );
    drawList.SetPageNumber( aPageNumber );
    drawList.SetSheetCount( aSheetCount );
    drawList.SetFileName( aFileName );
    drawList.SetSheetName( aSheetName );
    drawList.SetSheetPath( aSheetPath );
    drawList.SetSheetLayer( aSheetLayer );
    drawList.SetProject( aProject );
    drawList.SetIsFirstPage( aIsFirstPage );
    drawList.SetProperties( aProperties );
 
    drawList.BuildDrawItemsList( aPageInfo, aTitleBlock );
 
    // Draw item list
    drawList.Print( aSettings );
}
 
 
void EDA_DRAW_FRAME::PrintDrawingSheet( const RENDER_SETTINGS* aSettings, BASE_SCREEN* aScreen,
                                        const std::map<wxString, wxString>* aProperties,
                                        double aMils2Iu, const wxString &aFilename,
                                        const wxString &aSheetLayer )
{
    if( !m_showBorderAndTitleBlock )
        return;
 
    wxDC*   DC = aSettings->GetPrintDC();
    wxPoint origin = DC->GetDeviceOrigin();
 
    if( origin.y > 0 )
    {
        DC->SetDeviceOrigin( 0, 0 );
        DC->SetAxisOrientation( true, false );
    }
 
    ::PrintDrawingSheet( aSettings, GetPageSettings(), GetScreenDesc(), GetFullScreenDesc(),
                         aFilename, GetTitleBlock(), aProperties, aScreen->GetPageCount(),
                         aScreen->GetPageNumber(), aMils2Iu, &Prj(), aSheetLayer,
                         aScreen->GetVirtualPageNumber() == 1 );
 
    if( origin.y > 0 )
    {
        DC->SetDeviceOrigin( origin.x, origin.y );
        DC->SetAxisOrientation( true, true );
    }
}
 
 
wxString EDA_DRAW_FRAME::GetScreenDesc() const
{
    // Virtual function. Base class implementation returns an empty string.
    return wxEmptyString;
}
 
 
wxString EDA_DRAW_FRAME::GetFullScreenDesc() const
{
    // Virtual function. Base class implementation returns an empty string.
    return wxEmptyString;
}
 
 
bool EDA_DRAW_FRAME::LibraryFileBrowser( const wxString& aTitle, bool doOpen, wxFileName& aFilename,
                                         const wxString& wildcard, const wxString& ext,
                                         bool isDirectory, FILEDLG_HOOK_NEW_LIBRARY* aFileDlgHook )
{
    aFilename.SetExt( ext );
 
    wxString defaultDir = aFilename.GetPath();
 
    if( defaultDir.IsEmpty() )
        defaultDir = GetMruPath();
 
    if( isDirectory && doOpen )
    {
        wxDirDialog dlg( this, aTitle, defaultDir, wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
 
        if( dlg.ShowModal() == wxID_CANCEL )
            return false;
 
        aFilename = dlg.GetPath();
        aFilename.SetExt( ext );
    }
    else
    {
        // Ensure the file has a dummy name, otherwise GTK will display the regex from the filter
        if( aFilename.GetName().empty() )
            aFilename.SetName( wxS( "Library" ) );
 
        wxFileDialog dlg( this, aTitle, defaultDir, aFilename.GetFullName(), wildcard,
                          doOpen ? wxFD_OPEN | wxFD_FILE_MUST_EXIST
                                 : wxFD_SAVE | wxFD_CHANGE_DIR | wxFD_OVERWRITE_PROMPT );
 
        if( aFileDlgHook )
            dlg.SetCustomizeHook( *aFileDlgHook );
 
        KIPLATFORM::UI::AllowNetworkFileSystems( &dlg );
 
        if( dlg.ShowModal() == wxID_CANCEL )
            return false;
 
        aFilename = dlg.GetPath();
        aFilename.SetExt( ext );
    }
 
    SetMruPath( aFilename.GetPath() );
 
    return true;
}
 
 
void EDA_DRAW_FRAME::ShowChangedLanguage()
{
    EDA_BASE_FRAME::ShowChangedLanguage();
 
    if( m_searchPane )
    {
        wxAuiPaneInfo& search_pane_info = m_auimgr.GetPane( m_searchPane );
        search_pane_info.Caption( _( "Search" ) );
    }
 
    if( m_propertiesPanel )
    {
        wxAuiPaneInfo& properties_pane_info = m_auimgr.GetPane( m_propertiesPanel );
        properties_pane_info.Caption( _( "Properties" ) );
    }
 
    if( m_netInspectorPanel )
    {
        wxAuiPaneInfo& net_inspector_panel_info = m_auimgr.GetPane( m_netInspectorPanel );
        net_inspector_panel_info.Caption( _( "Net Inspector" ) );
    }
}
 
 
void EDA_DRAW_FRAME::UpdateProperties()
{
    if( m_isClosing || !m_propertiesPanel || !m_propertiesPanel->IsShownOnScreen() )
        return;
 
    m_propertiesPanel->UpdateData();
}
 
 
bool EDA_DRAW_FRAME::IsGitCommitPaneShown()
{
    return m_gitCommitPane && m_auimgr.GetPane( GitCommitPaneName() ).IsShown();
}
 
 
void EDA_DRAW_FRAME::ToggleGitCommitPane()
{
    if( !m_gitCommitPane )
        return;
 
    wxAuiPaneInfo& pane = m_auimgr.GetPane( GitCommitPaneName() );
    bool           show = !pane.IsShown();
 
    pane.Show( show );
 
    if( show )
        RefreshGitCommitPane();
 
    m_auimgr.Update();
}
 
 
void EDA_DRAW_FRAME::RefreshGitCommitPane()
{
    if( !IsGitCommitPaneShown() )
        return;
 
    // Gated on the preference so no editor binds a repository behind it.
    if( Pgm().GetCommonSettings()->m_Git.enableGit )
        Prj().AttachGitRepository();
 
    // Refreshed either way, or turning the preference off never reaches the panel.
    m_gitCommitPane->RefreshFileList();
}
 
 
void EDA_DRAW_FRAME::CreateHotkeyPopup()
{
    m_hotkeyPopup = new HOTKEY_CYCLE_POPUP( this );
}
 
 
COLOR_SETTINGS* EDA_DRAW_FRAME::GetColorSettings( bool aForceRefresh ) const
{
    if( !m_colorSettings || aForceRefresh )
    {
        COLOR_SETTINGS* colorSettings = ::GetColorSettings( DEFAULT_THEME );
        const_cast<EDA_DRAW_FRAME*>( this )->m_colorSettings = colorSettings;
    }
 
    return m_colorSettings;
}
 
 
void EDA_DRAW_FRAME::setupUIConditions()
{
    EDA_BASE_FRAME::setupUIConditions();
 
    ACTION_MANAGER*   mgr = m_toolManager->GetActionManager();
    EDITOR_CONDITIONS cond( this );
 
    wxASSERT( mgr );
 
    mgr->SetConditions( ACTIONS::millimetersUnits, ACTION_CONDITIONS().Check( cond.Units( EDA_UNITS::MM ) ) );
    mgr->SetConditions( ACTIONS::inchesUnits,      ACTION_CONDITIONS().Check( cond.Units( EDA_UNITS::INCH ) ) );
    mgr->SetConditions( ACTIONS::milsUnits,        ACTION_CONDITIONS().Check( cond.Units( EDA_UNITS::MILS ) ) );
}
 
 
void EDA_DRAW_FRAME::setArcModeConditions( const TOOL_ACTION&                                 aDrawArc,
                                           const std::function<bool( const SELECTION& )>& aEnable )
{
    ACTION_MANAGER*   mgr = m_toolManager->GetActionManager();
    const std::string arcToolPrefix = aDrawArc.GetName();
 
    // Every arc tool action extends the plain action's name, so one compare covers them all
    const SELECTION_CONDITION arcToolActive =
            [this, arcToolPrefix]( const SELECTION& )
            {
                return CurrentToolName().starts_with( arcToolPrefix );
            };
 
    ARC_DRAW_MODE mode = ARC_DRAW_MODE::CENTER_START_END;
 
    do
    {
        const SELECTION_CONDITION inMode =
                [this, mode]( const SELECTION& )
                {
                    APP_SETTINGS_BASE* cfg = config();
 
                    return cfg && cfg->m_ArcDrawMode == mode;
                };
 
        if( const TOOL_ACTION* action = drawArcAction( mode ) )
            mgr->SetConditions( *action, ACTION_CONDITIONS().Enable( aEnable ).Check( inMode && arcToolActive ) );
 
        mode = IncrementArcDrawMode( mode );
    } while( mode != ARC_DRAW_MODE::CENTER_START_END );
}
 
 
void EDA_DRAW_FRAME::syncToolbarSelections()
{
    APP_SETTINGS_BASE* cfg = config();
 
    // The arc group would otherwise start on its first entry and overwrite the saved mode
    if( const TOOL_ACTION* action = cfg ? drawArcAction( cfg->m_ArcDrawMode ) : nullptr )
        SelectToolbarAction( *action );
}
 
 
void EDA_DRAW_FRAME::setupUnits( APP_SETTINGS_BASE* aCfg )
{
    COMMON_TOOLS* cmnTool = m_toolManager->GetTool<COMMON_TOOLS>();
 
    if( cmnTool )
    {
        // Tell the tool what the units used last session
        cmnTool->SetLastUnits( static_cast<EDA_UNITS>( aCfg->m_System.last_imperial_units ) );
        cmnTool->SetLastUnits( static_cast<EDA_UNITS>( aCfg->m_System.last_metric_units ) );
    }
 
    // Tell the tool what units the frame is currently using
    switch( static_cast<EDA_UNITS>( aCfg->m_System.units ) )
    {
    default:
    case EDA_UNITS::MM:   m_toolManager->RunAction( ACTIONS::millimetersUnits ); break;
    case EDA_UNITS::INCH: m_toolManager->RunAction( ACTIONS::inchesUnits );      break;
    case EDA_UNITS::MILS: m_toolManager->RunAction( ACTIONS::milsUnits );        break;
    }
}
 
 
void EDA_DRAW_FRAME::GetUnitPair( EDA_UNITS& aPrimaryUnit, EDA_UNITS& aSecondaryUnits )
{
    COMMON_TOOLS* cmnTool = m_toolManager->GetTool<COMMON_TOOLS>();
 
    aPrimaryUnit    = GetUserUnits();
    aSecondaryUnits = EDA_UNITS::MILS;
 
    if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
    {
        if( cmnTool )
            aSecondaryUnits = cmnTool->GetLastMetricUnits();
        else
            aSecondaryUnits = EDA_UNITS::MM;
    }
    else
    {
        if( cmnTool )
            aSecondaryUnits = cmnTool->GetLastImperialUnits();
        else
            aSecondaryUnits = EDA_UNITS::MILS;
    }
}
 
 
void EDA_DRAW_FRAME::resolveCanvasType()
{
    m_canvasType = loadCanvasTypeSetting();
 
    // A canvas that failed this session falls back without changing the saved preference
    if( CanvasFailed( m_canvasType ) )
        m_canvasType = EDA_DRAW_PANEL_GAL::GAL_FALLBACK;
 
    if( m_canvasType != GetCanvas()->GetBackend() )
    {
        // SwitchCanvas overwrites m_canvasType with whatever backend it ended up on
        EDA_DRAW_PANEL_GAL::GAL_TYPE requested = m_canvasType;
 
        // Try to switch (will automatically fallback if necessary)
        SwitchCanvas( requested );
 
        if( GetCanvas()->GetBackend() != requested )
        {
            m_canvasType = GetCanvas()->GetBackend();
            m_failedCanvases.insert( requested ); // Store failure for other EDA_DRAW_FRAMEs
        }
    }
}
 
 
void EDA_DRAW_FRAME::handleActivateEvent( wxActivateEvent& aEvent )
{
    // Force a refresh of the message panel to ensure that the text is the right color
    // when the window activates
    if( !IsIconized() )
        m_messagePanel->Refresh();
}
 
 
void EDA_DRAW_FRAME::onActivate( wxActivateEvent& aEvent )
{
    handleActivateEvent( aEvent );
 
    aEvent.Skip();
}
 
 
bool EDA_DRAW_FRAME::SaveCanvasImageToFile( const wxString& aFileName, BITMAP_TYPE aBitmapType )
{
    wxImage image;
 
 
    if( !GetCanvas()->GetScreenshot( image ) )
    {
        wxSize     image_size = GetCanvas()->GetClientSize();
        wxClientDC dc( GetCanvas() );
        wxBitmap   bitmap( image_size.x, image_size.y );
        wxMemoryDC memdc;
 
        memdc.SelectObject( bitmap );
        memdc.Blit( 0, 0, image_size.x, image_size.y, &dc, 0, 0 );
        memdc.SelectObject( wxNullBitmap );
 
        image = bitmap.ConvertToImage();
    }
 
    wxBitmapType type = wxBITMAP_TYPE_PNG;
    switch( aBitmapType )
    {
    case BITMAP_TYPE::PNG: type = wxBITMAP_TYPE_PNG;  break;
    case BITMAP_TYPE::BMP: type = wxBITMAP_TYPE_BMP;  break;
    case BITMAP_TYPE::JPG: type = wxBITMAP_TYPE_JPEG; break;
    }
 
    bool retv = image.SaveFile( aFileName, type );
 
    image.Destroy();
    return retv;
}
 
 
bool EDA_DRAW_FRAME::IsPluginActionButtonVisible( const PLUGIN_ACTION& aAction, APP_SETTINGS_BASE* aCfg )
{
    wxCHECK( aCfg, aAction.show_button );
 
    for( const auto& [identifier, visible] : aCfg->m_Plugins.actions )
    {
        if( identifier == aAction.identifier )
            return visible;
    }
 
    return aAction.show_button;
}
 
 
std::vector<const PLUGIN_ACTION*> EDA_DRAW_FRAME::GetOrderedPluginActions( PLUGIN_ACTION_SCOPE aScope,
                                                                           APP_SETTINGS_BASE* aCfg )
{
    std::vector<const PLUGIN_ACTION*> actions;
    wxCHECK( aCfg, actions );
 
    API_PLUGIN_MANAGER& mgr = Pgm().GetPluginManager();
    std::vector<const PLUGIN_ACTION*> unsorted = mgr.GetActionsForScope( aScope );
    std::map<wxString, const PLUGIN_ACTION*> actionMap;
    std::set<const PLUGIN_ACTION*> handled;
 
    for( const PLUGIN_ACTION* action : unsorted )
        actionMap[action->identifier] = action;
 
    for( const auto& identifier : aCfg->m_Plugins.actions | std::views::keys )
    {
        if( actionMap.contains( identifier ) )
        {
            const PLUGIN_ACTION* action = actionMap[ identifier ];
            actions.emplace_back( action );
            handled.insert( action );
        }
    }
 
    for( const auto& action : actionMap | std::views::values )
    {
        if( !handled.contains( action ) )
            actions.emplace_back( action );
    }
 
    return actions;
}
 
 
size_t EDA_DRAW_FRAME::AddApiPluginMenuItems( ACTION_MENU* aMenu )
{
    wxCHECK( aMenu, 0 );
 
    API_PLUGIN_MANAGER& mgr = Pgm().GetPluginManager();
 
    mgr.MenuBindings( m_ident ).clear();
 
    std::vector<const PLUGIN_ACTION*> actions = GetOrderedPluginActions( PluginActionScope(), config() );
 
    size_t count = 0;
 
    for( const PLUGIN_ACTION* action : actions )
    {
        const std::vector<wxImage>& images =
                KIPLATFORM::UI::IsDarkTheme() && !action->icon_dark.empty() ? action->icon_dark : action->icon_light;
 
        int            iconSize = Pgm().GetCommonSettings()->m_Appearance.toolbar_icon_size;
        wxBitmapBundle icon;
 
        if( images.empty() )
        {
            icon = KiBitmapBundleDef( BITMAPS::puzzle_piece, iconSize );
        }
        else
        {
            wxVector<wxBitmap> bitmaps;
 
            for( const wxImage& img : images )
                bitmaps.push_back( wxBitmap( img ) );
 
            icon = BITMAP_STORE::MakeBitmapBundleDef( bitmaps, iconSize );
        }
 
        if( !icon.IsOk() )
            continue;
 
        wxMenuItem* item = KIUI::AddMenuItem( aMenu, wxID_ANY, action->name, action->description, icon );
 
        Connect( item->GetId(), wxEVT_COMMAND_MENU_SELECTED,
                 wxCommandEventHandler( EDA_DRAW_FRAME::OnApiPluginInvoke ) );
 
        mgr.MenuBindings( m_ident ).insert( { item->GetId(), action->identifier } );
 
        ++count;
    }
 
    return count;
}
 
 
void EDA_DRAW_FRAME::AddApiPluginTools( ACTION_TOOLBAR* aToolbar )
{
    API_PLUGIN_MANAGER& mgr = Pgm().GetPluginManager();
 
    mgr.ButtonBindings( m_ident ).clear();
 
    std::vector<const PLUGIN_ACTION*> actions = GetOrderedPluginActions( PluginActionScope(), config() );
 
    int iconSize = Pgm().GetCommonSettings()->m_Appearance.toolbar_icon_size;
 
    for( const PLUGIN_ACTION* action : actions )
    {
        if( !IsPluginActionButtonVisible( *action, config() ) )
            continue;
 
        const std::vector<wxImage>& images = KIPLATFORM::UI::IsDarkTheme() && !action->icon_dark.empty()
                                                ? action->icon_dark
                                                : action->icon_light;
 
        if( images.empty() )
            continue;
 
        wxVector<wxBitmap> bitmaps;
 
        for( const wxImage& img : images )
            bitmaps.push_back( wxBitmap( img ) );
 
        wxBitmapBundle icon = BITMAP_STORE::MakeBitmapBundleDef( bitmaps, iconSize );
 
        if( !icon.IsOk() )
            continue;
 
        wxAuiToolBarItem* button = aToolbar->AddTool( wxID_ANY, wxEmptyString, icon, action->name );
 
        Connect( button->GetId(), wxEVT_COMMAND_MENU_SELECTED,
                 wxCommandEventHandler( EDA_DRAW_FRAME::OnApiPluginInvoke ) );
 
        mgr.ButtonBindings( m_ident ).insert( { button->GetId(), action->identifier } );
    }
}
 
 
void EDA_DRAW_FRAME::OnApiPluginInvoke( wxCommandEvent& aEvent )
{
    API_PLUGIN_MANAGER& mgr = Pgm().GetPluginManager();
 
    std::optional<wxString> identifier;
 
    if( mgr.ButtonBindings( m_ident ).contains( aEvent.GetId() ) )
        identifier = mgr.ButtonBindings( m_ident ).at( aEvent.GetId() );
    else if( mgr.MenuBindings( m_ident ).contains( aEvent.GetId() ) )
        identifier = mgr.MenuBindings( m_ident ).at( aEvent.GetId() );
 
    if( !identifier )
        return;
 
    std::shared_ptr<REPORTER> reporter;
 
    if( KISTATUSBAR* statusBar = dynamic_cast<KISTATUSBAR*>( GetStatusBar() ) )
        reporter = std::make_shared<STATUSBAR_WARNING_REPORTER>( statusBar, wxS( "plugin" ) );
 
    mgr.InvokeAction( *identifier, reporter );
}